[src/trunk]: src/share/man/man5 * Boolean values may be specified with any of...

[apb <apb%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/902d3a0da1ac
branches:  trunk
changeset: 747135:902d3a0da1ac
user:      apb <apb%NetBSD.org@localhost>
date:      Thu Sep 03 20:06:39 2009 +0000

description:
* Boolean values may be specified with any of YES/TRUE/ON/1 or
  NO/FALSE/OFF/0, so explain that.
* Change all "Foo:  YES or NO.  If not set to YES then ..." to
  "Foo:  Boolean value.  If false then ...".
* Some rewording for clarity.

diffstat:

 share/man/man5/rc.conf.5 |  472 ++++++++++++++--------------------------------
 1 files changed, 143 insertions(+), 329 deletions(-)

diffs (truncated from 1065 to 300 lines):

diff -r 70a9826e7c4b -r 902d3a0da1ac share/man/man5/rc.conf.5
--- a/share/man/man5/rc.conf.5  Thu Sep 03 17:15:17 2009 +0000
+++ b/share/man/man5/rc.conf.5  Thu Sep 03 20:06:39 2009 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: rc.conf.5,v 1.131 2009/07/25 21:21:20 wiz Exp $
+.\"    $NetBSD: rc.conf.5,v 1.132 2009/09/03 20:06:39 apb Exp $
 .\"
 .\" Copyright (c) 1996 Matthew R. Green
 .\" All rights reserved.
@@ -55,7 +55,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd July 25, 2009
+.Dd September 3, 2009
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -86,25 +86,6 @@
 relevant manual pages.
 Third party packages may test for additional variables.
 .Pp
-Most variables are one of two types: enabling variables or flags
-variables.
-Enabling variables, such as
-.Sy inetd ,
-are generally named after the program or the system they enable,
-and are set to
-.Sq YES
-or
-.Sq NO .
-Flags variables, such as
-.Sy inetd_flags
-have the same name with "_flags" appended, and determine what
-arguments are passed to the program if it is enabled.
-.Pp
-If a variable that
-.Xr rc 8
-expects to be set is not set, or the value is not one of the allowed
-values, a warning will be printed.
-.Pp
 By default,
 .Nm
 reads
@@ -135,14 +116,39 @@
 .Xr rc.d 8
 control variables, and thus changing the operation of the script
 without requiring editing of the script.
+.Ss Variable naming conventions and data types
+Most variables are one of two types: enabling variables or flags
+variables.
+Enabling variables, such as
+.Sy inetd ,
+are generally named after the program or the system they enable,
+and have boolean values (specified using
+.Sq Ic YES ,
+.Sq Ic TRUE ,
+.Sq Ic ON
+or
+.Sq Ic 1
+for true, and
+.Sq Ic NO ,
+.Sq Ic FALSE ,
+.Sq Ic OFF
+or
+.Sq Ic 0
+for false, with the values being case insensitive).
+Flags variables, such as
+.Sy inetd_flags
+have the same name with "_flags" appended, and determine what
+arguments are passed to the program if it is enabled.
+.Pp
+If a variable that
+.Xr rc 8
+expects to be set is not set, or the value is not one of the allowed
+values, a warning will be printed.
 .Ss Overall control
 .Bl -tag -width net_interfaces
 .It Sy do_rcshutdown
-.Sq YES
-or
-.Sq NO .
-If set to
-.Sq NO ,
+Boolean value.
+If false,
 .Xr shutdown 8
 will not run
 .Pa /etc/rc.shutdown .
@@ -159,12 +165,8 @@
 .Pa /etc/rc.shutdown
 if the timer expires before the shutdown script completes.
 .It Sy rc_configured
-.Sq YES
-or
-.Sq NO .
-If not set to
-.Sq YES
-then the system will drop into single-user mode during boot.
+Boolean value.
+If false then the system will drop into single-user mode during boot.
 .It Sy rc_fast_and_loose
 If set to a non-empty string,
 each script in
@@ -273,45 +275,28 @@
 access to the console and an unsuccessful shutdown must not make the host
 unbootable even if the file system checks would fail in preen mode.
 .It Sy no_swap
-.Sq YES
-or
-.Sq NO .
-Set the
-.Sy no_swap
-variable to
-.Sq YES
-if you have configured your system with no swap on purpose.
-If not set to
-.Sq YES ,
-and no swap devices
-are configured, the system will warn you.
+Boolean value.
+Should be true if you have deliberately configured your system with no swap.
+If false and no swap devices are configured, the system will warn you.
 .It Sy swapoff
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Remove block-type swap devices at shutdown time.
 Useful if swapping onto RAIDframe devices.
 .El
 .Ss One-time actions to perform or programs to run on boot-up
 .Bl -tag -width net_interfaces
 .It Sy accounting
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Enables process accounting with
 .Xr accton 8 .
 Requires
 .Pa /var/account/acct
 to exist.
 .It Sy clear_tmp
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Clear /tmp after reboot.
 .It Sy dmesg
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Create
 .Pa /var/run/dmesg.boot
 from the output of
@@ -319,18 +304,14 @@
 Passes
 .Sy dmesg_flags .
 .It Sy gpio
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Configure
 .Xr gpio 4
 devices .
 See
 .Xr gpio.conf 5 .
 .It Sy mixerctl
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Read
 .Xr mixerctl.conf 5
 for how to set mixer values.
@@ -339,9 +320,7 @@
 the devices whose settings are to be saved at shutdown and
 restored at start-up.
 .It Sy newsyslog
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Run
 .Nm newsyslog
 to trim logfiles before syslogd starts.
@@ -349,9 +328,7 @@
 Passes
 .Sy newsyslog_flags .
 .It Sy per_user_tmp
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Enables a per-user
 .Pa /tmp
 directory.
@@ -361,9 +338,7 @@
 temporary directories,
 .Dq Pa /private/tmp .
 .It Sy rndctl
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Runs the
 .Xr rndctl 8
 utility one or more times according to the specification in
@@ -410,9 +385,7 @@
 .Li "rndctl -c -e -t tty" ;
 .Li "rndctl -c -t net" .
 .It Sy savecore
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Runs the
 .Xr savecore 8
 utility.
@@ -423,18 +396,14 @@
 The default setting is
 .Dq Pa /var/crash .
 .It Sy tpctl
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Run
 .Xr tpctl 8
 to calibrate touch panel device.
 Passes
 .Sy tpctl_flags .
 .It Sy update_motd
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Updates the
 .Nx
 version string in the
@@ -443,17 +412,13 @@
 See
 .Xr motd 5 .
 .It Sy veriexec
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Load Veriexec fingerprints during startup.
 Read
 .Xr veriexecctl 8
 for more information.
 .It Sy virecover
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Send notification mail to users if any recoverable files exist in
 .Pa /var/tmp/vi.recover .
 Read
@@ -511,16 +476,12 @@
 .Ss Networking startup
 .Bl -tag -width net_interfaces
 .It Sy altqd
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 ALTQ configuration/monitoring daemon.
 Passes
 .Sy altqd_flags .
 .It Sy auto_ifconfig
-.Sq YES
-or
-.Sq NO .
+Boolean value.
 Sets the
 .Sy net_interfaces
 variable (see below) to the output of
@@ -530,27 +491,22 @@
 flag and suppresses warnings about interfaces in this list that
 do not have an ifconfig file or variable.
 .It Sy dhclient
-.Sq YES
-or
-.Sq NO .
-Set to
-.Sq YES
-to configure some or all network interfaces using
+Boolean value.
+Set true to configure some or all network interfaces using
 the ISC DHCP client.
 If you set
 .Sy dhclient
-to
-.Sq YES ,
-you must either have