NetBSD Problem Report #40062

From www@NetBSD.org  Sat Nov 29 01:07:10 2008
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by narn.NetBSD.org (Postfix) with ESMTP id 4B79663B8BD
	for <gnats-bugs@gnats.netbsd.org>; Sat, 29 Nov 2008 01:07:10 +0000 (UTC)
Message-Id: <20081129010710.1087D63B11D@narn.NetBSD.org>
Date: Sat, 29 Nov 2008 01:07:10 +0000 (UTC)
From: bughunting@xs4all.nl
Reply-To: bughunting@xs4all.nl
To: gnats-bugs@NetBSD.org
Subject: Manpage afterboot(8) needs improvements
X-Send-Pr-Version: www-1.0

>Number:         40062
>Category:       misc
>Synopsis:       Manpage afterboot(8) needs improvements
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Nov 29 01:10:00 +0000 2008
>Closed-Date:    Wed Feb 10 04:02:10 +0000 2010
>Last-Modified:  Wed Feb 10 04:02:10 +0000 2010
>Originator:     Bug Hunting
>Release:        5.99.3
>Organization:
>Environment:
>Description:
Manpage afterboot(8) needs improvements:
- the case of the `YES' and `NO' keywords are, in most locations,
  not in sync with those given in the rc.conf(5) manpage;
- the manpage could use some additional minor improvements.

It is in the attached patch proposed to replace the `.Cm' mdoc(7)
macros by `.Dq', as the mdoc(7) manpage states that the former is
meant for (interactive) command flags, which is not what
`PermitRootLogin' and `GATEWAY' actually are.
>How-To-Repeat:
"man 8 afterboot"; look up the appropriate sections.
Optionally compare with the rc.conf(5) manpage.
>Fix:
Apply the following patch:

$ diff -u /usr/src/share/man/man8/afterboot.8 afterboot.8.new  
--- /usr/src/share/man/man8/afterboot.8 2008-10-21 10:43:15.000000000 +0200
+++ afterboot.8.new     2008-11-29 01:43:31.000000000 +0100
@@ -99,11 +99,13 @@
 .Dq Ic root .
 You can do so on the console, or over the network using
 .Xr ssh 1 .
-If you have enabled the ssh daemon and wish to allow root logins over
+If you have enabled the SSH daemon (see
+.Xr sshd(8) )
+and wish to allow root logins over
 the network, edit the
 .Pa /etc/ssh/sshd_config
 file and set
-.Cm PermitRootLogin
+.Dq PermitRootLogin
 to
 .Dq yes
 (see
@@ -337,16 +339,16 @@
 .Dl net.inet6.ip6.forwarding=1
 .Pp
 As an alternative, compile a new kernel with the
-.Cm GATEWAY
+.Dq GATEWAY
 option.
 Packets are not forwarded by default, due to RFC requirements.
-.Ss Secure Shell (ssh)
+.Ss Secure Shell (SSH)
 By default, all services are disabled in a fresh
 .Nx
-installation, and ssh is no exception.
+installation, and SSH is no exception.
 You may wish to enable it so you can remotely control your system.
 Set
-.Dq Va sshd=yes
+.Dq Va sshd=YES
 in
 .Pa /etc/rc.conf
 and then starting the server with the command
@@ -377,7 +379,7 @@
 .Pp
 If using a caching name server add the line "nameserver 127.0.0.1" first.
 To get a local caching name server to run
-you will need to set "named=yes" in
+you will need to set "named=YES" in
 .Pa /etc/rc.conf
 and create the
 .Pa named.conf
@@ -542,8 +544,8 @@
 .Pa /etc/rc.conf
 contains the following:
 .Pp
-.Dl ntpdate=yes
-.Dl ntpd=yes
+.Dl ntpdate=YES
+.Dl ntpd=YES
 .Pp
 See
 .Xr date 1 ,
@@ -648,10 +650,12 @@
 the X Display Manager.
 To do this, set the variable
 .Dq xdm
-to yes in
+to
+.Dq YES
+in
 .Pa /etc/rc.conf ,
 i.e.:
-.Dq xdm=yes
+.Dq xdm=YES .
 .Ss Printers
 Edit
 .Pa /etc/printcap
@@ -699,7 +703,7 @@
 .Pa /etc/postfix/main.cf
 and enable the daemon in
 .Pa /etc/rc.conf
-using "postfix=yes".
+using "postfix=YES".
 It is very important to configure
 .Pa /etc/mailer.conf
 to point to Postfix binaries.
@@ -713,7 +717,7 @@
 as needed.
 You will have to make sure
 .Pa /etc/rc.conf
-has "dhcpd=yes"
+has "dhcpd=YES"
 or run
 .Xr dhcpd 8
 manually.
@@ -725,15 +729,15 @@
 as needed.
 You will have to turn it on in
 .Pa /etc/rc.conf
-by adding "bootparamd=yes".
+by adding "bootparamd=YES".
 .Ss NFS server
 If this is an NFS server, make sure
 .Pa /etc/rc.conf
 has:
 .Bd -literal -offset indent
-nfs_server=yes
-mountd=yes
-rpcbind=yes
+nfs_server=YES
+mountd=YES
+rpcbind=YES
 .Ed
 .Pp
 Edit

>Release-Note:

>Audit-Trail:
From: Soren Jacobsen <snj@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/40062 CVS commit: src/share/man/man8
Date: Wed, 10 Feb 2010 03:38:22 +0000

 Module Name:	src
 Committed By:	snj
 Date:		Wed Feb 10 03:38:22 UTC 2010

 Modified Files:
 	src/share/man/man8: afterboot.8

 Log Message:
 Some markup and capitalization nits, from Bug Hunting in PR misc/40062.
 While here, give xdm its own subsection instead of awkwardly lumping it
 in with the rc.conf section.


 To generate a diff of this commit:
 cvs rdiff -u -r1.43 -r1.44 src/share/man/man8/afterboot.8

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

State-Changed-From-To: open->closed
State-Changed-By: snj@NetBSD.org
State-Changed-When: Wed, 10 Feb 2010 04:02:10 +0000
State-Changed-Why:
Applied.  Thanks!


>Unformatted:

Home	PR Database Search