From robert@fledge.watson.org Wed Oct 13 22:35:20 1999
Return-Path: <robert@fledge.watson.org>
Received: from fledge.watson.org (fledge.watson.org [204.156.12.50])
	by hub.freebsd.org (Postfix) with ESMTP id 4A6E414F5A
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 13 Oct 1999 22:35:19 -0700 (PDT)
	(envelope-from robert@fledge.watson.org)
Received: (from robert@localhost)
	by fledge.watson.org (8.9.3/8.9.3) id BAA29323;
	Thu, 14 Oct 1999 01:35:19 -0400 (EDT)
	(envelope-from robert)
Message-Id: <199910140535.BAA29323@fledge.watson.org>
Date: Thu, 14 Oct 1999 01:35:19 -0400 (EDT)
From: robert@fledge.watson.org
Reply-To: robert+freebsd@cyrus.watson.org
To: FreeBSD-gnats-submit@freebsd.org
Cc: robert+freebsd@cyrus.watson.org
Subject: hostname(1) doesn't mention rc.conf
X-Send-Pr-Version: 3.2

>Number:         14319
>Category:       docs
>Synopsis:       hostname(1) doesn't mention rc.conf
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Oct 13 22:40:01 PDT 1999
>Closed-Date:    Tue Dec 21 17:30:35 PST 1999
>Last-Modified:  Tue Dec 21 17:31:05 PST 1999
>Originator:     Robert Watson
>Release:        FreeBSD 3.3-RELEASE i386
>Organization:
>Environment:

man hostname

>Description:

Man page mentions rc.network, but doesn't mention that rc.conf and
variable hostname are the correct way to configure the system hostname.

>How-To-Repeat:

man hostname | grep rc.conf

>Fix:
	
Sorry, no patches, just a confused novice user on my hands who couldn't
figure out how to make the hostname change stick across boots.  :-)

There are probably other man pages that don't mention the preferred way
to configure cross-boot params (such as domainname(1), apmd(3), ...)
Ideally, these should probably all mention rc.conf, and possibly their
relevant parameters.



>Release-Note:
>Audit-Trail:

From: William Richard <wdr@tdl.com>
To: freebsd-gnats-submit@freebsd.org, robert+freebsd@cyrus.watson.org
Cc:  
Subject: Re: docs/14319: hostname(1) doesn't mention rc.conf
Date: Mon, 20 Dec 1999 16:37:51 -0800

 Here's a patch:
 
 *** hostname.1.old      Mon Dec 20 15:11:53 1999
 --- hostname.1  Mon Dec 20 16:33:58 1999
 ***************
 *** 50,55 ****
 --- 50,59 ----
   .Pa /etc/rc.network ,
   normally run at boot
   time.
 + The preferred method of setting the hostname is by defining the variable
 + .Va hostname
 + in
 + .Pa /etc/rc.conf .
   .Pp
   Options:
   .Bl -tag -width flag
 ***************
 *** 58,64 ****
   name.
   .El
   .Sh SEE ALSO
 ! .Xr gethostname 3
   .Sh HISTORY
   The
   .Nm
 --- 62,69 ----
   name.
   .El
   .Sh SEE ALSO
 ! .Xr gethostname 3 , 
 ! .Xr rc.conf 5
   .Sh HISTORY
   The
   .Nm
 

From: John Baldwin <jhb@FreeBSD.org>
To: William Richard <wdr@tdl.com>
Cc: freebsd-gnats-submit@FreeBSD.org
Subject: Re: docs/14319: hostname(1) doesn't mention rc.conf
Date: Mon, 20 Dec 1999 20:47:14 -0500 (EST)

 On 21-Dec-99 William Richard wrote:
 > The following reply was made to PR docs/14319; it has been noted by GNATS.
 >
 >  Here's a patch:
 >  
 >  *** hostname.1.old      Mon Dec 20 15:11:53 1999
 >  --- hostname.1  Mon Dec 20 16:33:58 1999
 >  ***************
 >  *** 50,55 ****
 >  --- 50,59 ----
 >    .Pa /etc/rc.network ,
 >    normally run at boot
 >    time.
 >  + The preferred method of setting the hostname is by defining the variable
 >  + .Va hostname
 >  + in
 >  + .Pa /etc/rc.conf .
 
 How about this wording:
 
 The hostname should be set by defining the
 .Va hostname
 variable in
 .Pa /etc/rc.conf .
 
 - or -
 
 The preferred method of setting the hostname is defining the variable
 .Va hostname
 in
 .Pa /etc/cr.conf .
 
 I don't think 'by defining...' is a valid direct object, it needs to be an
 infinitive (IIRC), i.e. 'to define' or a gerund, i.e. 'defining'.  (I may have
 the terms messed up, but I believe the examples are accurate).
 
 -- 
 
 John Baldwin <jhb@FreeBSD.org> -- http://www.FreeBSD.org/~jhb/
 PGP Key: http://www.cslab.vt.edu/~jobaldwi/pgpkey.asc
 "Power Users Use the Power to Serve!"  -  http://www.FreeBSD.org/
 

From: William Richard <wdr@tdl.com>
To: freebsd-gnats-submit@freebsd.org
Cc:  
Subject: Re: docs/14319: hostname(1) doesn't mention rc.conf
Date: Mon, 20 Dec 1999 17:52:23 -0800

 Whoops!  This diff should point to src/bin/hostname/hostname.1.
 Darn.
 

From: William Richard <wdr@tdl.com>
To: freebsd-gnats-submit@freebsd.org
Cc:  
Subject: Re: docs/14319: hostname(1) doesn't mention rc.conf
Date: Mon, 20 Dec 1999 18:52:54 -0800

 How about this:
 
 *** src/bin/hostname/hostname.1.old     Sun Aug 29 07:12:37 1999
 --- src/bin/hostname/hostname.1 Mon Dec 20 18:46:18 1999
 ***************
 *** 51,56 ****
 --- 51,61 ----
   normally run at boot
   time.
   .Pp
 + The canonical way to define the hostname at boot time is with the
 + .Va hostname
 + variable in
 + .Pa /etc/rc.conf .
 + .Pp
   Options:
   .Bl -tag -width flag
   .It Fl s
 ***************
 *** 58,64 ****
   name.
   .El
   .Sh SEE ALSO
 ! .Xr gethostname 3
   .Sh HISTORY
   The
   .Nm
 --- 63,70 ----
   name.
   .El
   .Sh SEE ALSO
 ! .Xr gethostname 3 ,
 ! .Xr rc.conf 5
   .Sh HISTORY
   The
   .Nm
 

From: Robert Watson <robert@cyrus.watson.org>
To: William Richard <wdr@tdl.com>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/14319: hostname(1) doesn't mention rc.conf
Date: Mon, 20 Dec 1999 22:34:50 -0500 (EST)

 Wow, I'd forgotten about that PR. :-)  Is this solution committed?  If
 not, I'll go ahead and do that.
 
 On Mon, 20 Dec 1999, William Richard wrote:
 
 > Here's a patch:
 > 
 > *** hostname.1.old      Mon Dec 20 15:11:53 1999
 > --- hostname.1  Mon Dec 20 16:33:58 1999
 > ***************
 > *** 50,55 ****
 > --- 50,59 ----
 >   .Pa /etc/rc.network ,
 >   normally run at boot
 >   time.
 > + The preferred method of setting the hostname is by defining the variable
 > + .Va hostname
 > + in
 > + .Pa /etc/rc.conf .
 >   .Pp
 >   Options:
 >   .Bl -tag -width flag
 > ***************
 > *** 58,64 ****
 >   name.
 >   .El
 >   .Sh SEE ALSO
 > ! .Xr gethostname 3
 >   .Sh HISTORY
 >   The
 >   .Nm
 > --- 62,69 ----
 >   name.
 >   .El
 >   .Sh SEE ALSO
 > ! .Xr gethostname 3 , 
 > ! .Xr rc.conf 5
 >   .Sh HISTORY
 >   The
 >   .Nm
 > 
 
 
   Robert N M Watson 
 
 robert@fledge.watson.org              http://www.watson.org/~robert/
 PGP key fingerprint: AF B5 5F FF A6 4A 79 37  ED 5F 55 E9 58 04 6A B1
 TIS Labs at Network Associates, Safeport Network Services
 
 
State-Changed-From-To: open->closed 
State-Changed-By: jhb 
State-Changed-When: Tue Dec 21 17:30:35 PST 1999 
State-Changed-Why:  
Fix was committed in rev 1.10. 
>Unformatted:
