[src/trunk]: src/share/man/man5 * update to match etc/rc.conf

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

details:   https://anonhg.NetBSD.org/src/rev/7da5c3ba1751
branches:  trunk
changeset: 495316:7da5c3ba1751
user:      lukem <lukem%NetBSD.org@localhost>
date:      Wed Jul 26 06:34:47 2000 +0000

description:
* update to match etc/rc.conf
* clean up formatting

diffstat:

 share/man/man5/rc.conf.5 |  402 ++++++++++++++++++++++++++++++++--------------
 1 files changed, 282 insertions(+), 120 deletions(-)

diffs (truncated from 790 to 300 lines):

diff -r 5393f6a7664e -r 7da5c3ba1751 share/man/man5/rc.conf.5
--- a/share/man/man5/rc.conf.5  Wed Jul 26 05:29:15 2000 +0000
+++ b/share/man/man5/rc.conf.5  Wed Jul 26 06:34:47 2000 +0000
@@ -1,9 +1,9 @@
-.\"    $NetBSD: rc.conf.5,v 1.34 2000/07/03 07:16:04 enami Exp $
+.\"    $NetBSD: rc.conf.5,v 1.35 2000/07/26 06:34:47 lukem Exp $
 .\"
 .\" Copyright (c) 1996 Matthew R. Green
 .\" Copyright (c) 1997 Curt J. Sampson
 .\" Copyright (c) 1997 Michael W. Long
-.\" Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
+.\" Copyright (c) 1998-2000 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This document is derived from works contributed to The NetBSD Foundation
@@ -32,7 +32,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd November 23, 1999
+.Dd July 26, 2000
 .Dt RC.CONF 5
 .Os
 .\" turn off hyphenation
@@ -44,7 +44,7 @@
 The
 .Nm
 file specifies which services are enabled during system startup by
-the startup script
+the startup scripts invoked by
 .Pa /etc/rc .
 The
 .Nm
@@ -65,7 +65,10 @@
 Enabling variables, such as
 .Sy inetd ,
 are generally named after the program or the system they enable,
-and are set to "YES" or "NO".
+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
@@ -75,7 +78,19 @@
 .Pa /etc/rc
 expects to be set is not set, or the value is not one of the allowed
 values, a warning will be printed.
-.Pp
+.Ss Overall control:
+.Bl -tag -width net_interfaces
+.It Sy rc_configured
+If this is not set to
+.Sq YES
+then the system will drop into single-user mode during boot.
+.It Sy do_rcshutdown
+If set to
+.Sq NO ,
+.Xr shutdown 8
+will not run
+.Pa /etc/rc.shutdown .
+.El
 .Ss Basic network configuration:
 .Bl -tag -width net_interfaces
 .It Sy hostname
@@ -95,51 +110,58 @@
 .Pa /etc/mygate
 (if it exists) are used.
 .El
-.Pp
 .Ss Boottime file-system and swap configuration:
-.Bl -tag -width critfs_require_network
-.It Sy critical_filesystems
-File systems mounted very early in the system boot, except for the
-.Pa /usr
-and
+.Bl -tag -width net_interfaces
+.It Sy critical_filesystems_beforenet
+File systems mounted very early in the system boot before networking
+services are available.
+Usually
 .Pa /var
-file-systems.
-.It Sy critfs_require_network
-YES or NO.
-Set the 
-.Sy critfs_require_network
-variable to YES if the network must be configured before critical filesystems
-can be mounted.
-This should be set to NO if you are using the DHCP client,
-because the DHCP client needs to store its lease database in the
-.Pa /var/db 
-directory.
+is part of this, because it is needed by services such as
+.Xr dhclient 1
+which may be required to get the network operational.
+.It Sy critical_filesystems
+File systems such as
+.Pa /usr
+that may require network services to be available to mount,
+that must be available early in the system boot for general services to use.
 .It Sy no_swap
 Set the
 .Sy no_swap
-variable to YES if you have configured your system with no swap on purpose.
-If not set, or set to anything other than YES, and no swap devices
+variable to
+.Sq YES
+if you have configured your system with no swap on purpose.
+If not set, or set to anything other than
+.Sq YES ,
+and no swap devices
 are configured, the system will warn you.
 .El
-.Pp
 .Ss One-time actions to perform or programs to run on boot-up:
 .Bl -tag -width net_interfaces
 .It Sy lkm
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Runs
 .Pa /etc/rc.lkm .
 .It Sy savecore
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Runs the
 .Xr savecore 8
 utility.
 Passes
 .Sy savecore_flags .
 .It Sy clear_tmp
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Clear /tmp after reboot.
 .It Sy update_motd
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Updates the
 .Nx
 version string in the
@@ -148,7 +170,9 @@
 See
 .Xr motd 5 .
 .It Sy dmesg
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Create
 .Pa /var/run/dmesg.boot
 from the output of
@@ -156,16 +180,17 @@
 Passes
 .Sy dmesg_flags .
 .It Sy accounting
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Enables process accounting with
 .Xr accton 8 .
 Requires
 .Pa /var/account/acct
 to exist.
 .El
-.Pp
 .Ss System security setting:
-.Bl -tag -width securelevel
+.Bl -tag -width net_interfaces
 .It Sy securelevel
 A number.
 The system securelevel is set to the specified value early
@@ -175,27 +200,51 @@
 .Xr init 8 ,
 which contains definative information about the system securelevel.
 .El
-.Pp
 .Ss Networking startup:
 .Bl -tag -width net_interfaces
 .It Sy ipfilter
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Runs
 .Xr ipf 8
 to load in packet filter specifications from
 .Pa /etc/ipf.conf
 at network boot time, before any interfaces are configured.
 See
-.Xr ipf 5 .
+.Xr ipf.conf 5 .
+.It Sy ipnat
+Runs
+.Xr ipnat 8
+to load in the IP network address translation (NAT) rules from
+.Pa /etc/ipnat.conf
+at network boot time, before any interfaces are configured.
+See
+.Xr ipnat.conf 5 .
 .It Sy ipsec
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Runs
 .Xr setkey 8
 to load in IPsec manual keys and policies from
 .Pa /etc/ipsec.conf
 at network boot time, before any interfaces are configured.
+.It Sy ipmon
+.Sq YES
+or
+.Sq NO .
+Runs
+.Xr ipmon 8
+to read
+.Xr ipf 8
+packet log information and log it to a file or the system log.
+Passes
+.Sy ipmon_flags .
 .It Sy auto_ifconfig
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Sets the
 .Sy net_interfaces
 variable (see below) to the output of
@@ -237,19 +286,31 @@
 .Pa /etc/ifconfig.xxN
 with multiple lines instead.
 .It Sy flushroutes
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Flushes the route table on networking startup.
 Useful when coming up to multiuser mode after going down to
 single-user mode.
 .It Sy dhclient
-YES or NO.
-Set to YES to configure some or all network interfaces using
+.Sq YES
+or
+.Sq NO .
+Set to
+.Sq YES
+to configure some or all network interfaces using
 the DHCP client.
 If you set
 .Sy dhclient
-to YES, you must either set 
-.Sy critfs_require_network
-to NO or direct the DHCP client to store the leases file on the root
+to
+.Sq YES ,
+you must either have
+.Pa /var
+in
+.Sy critical_filesystems_beforenet ,
+as part of
+.Pa / ,
+or direct the DHCP client to store the leases file on the root
 filesystem by modifying the
 .Sy dhclient_flags
 variable.
@@ -259,8 +320,10 @@
 file if needed - see
 .Xr dhclient.conf 5
 for details.
-.It Sy dhclient_flags
-Flags to pass to the DHCP client.
+.Pp
+Passes
+.Sy dhclient_flags
+to the DHCP client.
 See
 .Xr dhclient 8
 for complete documentation.
@@ -275,7 +338,9 @@
 .Sy dhclient_flags
 variable - for example, "-lf /tmp/dhclient.leases".
 .It Sy ntpdate
-YES or NO.
+.Sq YES
+or
+.Sq NO .
 Runs
 .Xr ntpdate 8
 to set the system time from one of the hosts in