Reordering the rc.conf manual page
Tom Rhodes
trhodes at FreeBSD.org
Thu Sep 15 10:24:15 UTC 2005
Hi,
I've done some simple reordering of our rc.conf.5 manual page.
I've only spent about 15 minutes on it because, well, to be honest,
I don't want to redo the entire file and have it rejected.
I've included a patch. It causes a few "empty line" warnings,
but still gives you the general idea. Comments and suggestions
are very welcome.
--
Tom Rhodes
Index: rc.conf.5
===================================================================
RCS file: /home/ncvs/src/share/man/man5/rc.conf.5,v
retrieving revision 1.263
diff -u -r1.263 rc.conf.5
--- rc.conf.5 8 Sep 2005 09:22:21 -0000 1.263
+++ rc.conf.5 15 Sep 2005 10:05:49 -0000
@@ -47,7 +49,7 @@
directly.
Instead, it is included by the
various generic startup scripts in
-.Pa /etc
+.Pa /etc/rc.d
which conditionalize their
internal actions according to the settings found there.
.Pp
@@ -71,7 +73,13 @@
The following list provides a name and short description for each
variable that can be set in the
.Nm
-file:
+file, classified by section.
+When an configuration variable exists which may fit into
+two or more catagories, it will be listed with those which
+contain the most likeness.
+.Ss DEBUG
+Configuration variables which enable or disable debugging
+messages or controls are defined below:
.Bl -tag -width indent-two
.It Va rc_debug
.Pq Vt bool
@@ -90,221 +98,11 @@
Informational messages are displayed when
a condition that is not serious enough to warrant a warning or
an error occurs.
-.It Va swapfile
-.Pq Vt str
-If set to
-.Dq Li NO ,
-no swapfile is installed, otherwise the value is used as the full
-pathname to a file to use for additional swap space.
-.It Va apm_enable
-.Pq Vt bool
-If set to
-.Dq Li YES ,
-enable support for Automatic Power Management with
-the
-.Xr apm 8
-command.
-.It Va apmd_enable
-.Pq Vt bool
-Run
-.Xr apmd 8
-to handle APM event from userland.
-This also enables support for APM.
-.It Va apmd_flags
-.Pq Vt str
-If
-.Va apmd_enable
-is set to
-.Dq Li YES ,
-these are the flags to pass to the
-.Xr apmd 8
-daemon.
-.It Va devd_enable
-.Pq Vt bool
-Run
-.Xr devd 8
-to handle device added, removed or unknown events from the kernel.
-.It Va kldxref_enable
-.Pq Vt bool
-Set to
-.Dq Li NO
-by default.
-Set to
-.Dq Li YES
-to automatically rebuild
-.Pa linker.hints
-files with
-.Xr kldxref 8
-at boot time.
-.It Va kldxref_clobber
-.Pq Vt bool
-Set to
-.Dq Li NO
-by default.
-If
-.Va kldxref_enable
-is true,
-setting to
-.Dq Li YES
-will overwrite existing
-.Pa linker.hints
-files at boot time.
-Otherwise,
-only missing
-.Pa linker.hints
-files are generated.
-.It Va kldxref_module_path
-.Pq Vt str
-Empty by default.
-A semi-colon
-.Pq Ql \&;
-delimited list of paths containing
-.Xr kld 4
-modules.
-If empty,
-the contents of the
-.Va kern.module_path
-.Xr sysctl 8
-are used.
-.It Va pccard_enable
-.Pq Vt bool
-If set to
-.Dq Li YES ,
-enable PCCARD support at boot time.
-.It Va pccard_mem
-.Pq Vt str
-Set to PCCARD controller memory address or
-.Dq Li DEFAULT
-for the default value.
-.It Va pccard_beep
-.Pq Vt int
-If 0,
-set the PCCARD controller to silent mode.
-If 1,
-set it to beep mode.
-If 2,
-set it to melody mode.
-.It Va pccard_conf
-.Pq Vt str
-Path to the configuration file for the
-.Xr pccardd 8
-daemon (e.g.\&
-.Pa /etc/pccard.conf.sample ) .
-.It Va pccardd_flags
-.Pq Vt str
-If
-.Va pccard_enable
-is set to
-.Dq Li YES ,
-these are the flags to pass to the
-.Xr pccardd 8
-daemon.
-.It Va powerd_enable
-.Pq Vt bool
-If set to
-.Dq Li YES ,
-enable the system power control facility with the
-.Xr powerd 8
-daemon.
-.It Va powerd_flags
-.Pq Vt str
-If
-.Va powerd_enable
-is set to
-.Dq Li YES ,
-these are the flags to pass to the
-.Xr powerd 8
-daemon.
-.It Va tmpmfs
-Controls the creation of a
-.Pa /tmp
-memory file system.
-Always happens if set to
-.Dq Li YES
-and never happens if set to
-.Dq Li NO .
-If set to anything else, a memory file system is created if
-.Pa /tmp
-is not writable.
-.It Va tmpsize
-Controls the size of a created
-.Pa /tmp
-memory file system.
-.It Va tmpmfs_flags
-Extra options passed to the
-.Xr mdmfs 8
-utility when the memory file system for
-.Pa /tmp
-is created.
-The default is
-.Dq Li -S -M ,
-which inhibits the use of softupdates on
-.Pa /tmp
-to waste as little space as possible
-and creates a pure memory backed disk, which will never be swapped out,
-for maximum performance and system stability at low memory conditions.
-See
-.Xr mdmfs 8
-for other options you can use in
-.Va tmpmfs_flags .
-.It Va varmfs
-Controls the creation of a
-.Pa /var
-memory file system.
-Always happens if set to
-.Dq Li YES
-and never happens if set to
-.Dq Li NO .
-If set to anything else, a memory file system is created if
-.Pa /var
-is not writable.
-.It Va varsize
-Controls the size of a created
-.Pa /var
-memory file system.
-.It Va varmfs_flags
-Extra options passed to the
-.Xr mdmfs 8
-utility when the memory file system for
-.Pa /var
-is created.
-The default is
-.Dq Li -S -M ,
-which inhibits the use of softupdates on
-.Pa /var
-to waste as little space as possible
-and creates a pure memory backed disk, which will never be swapped out,
-for maximum performance and system stability at low memory conditions.
-See
-.Xr mdmfs 8
-for other options you can use in
-.Va varmfs_flags .
-.It Va populate_var
-Controls the automatic population of the
-.Pa /var
-file system.
-Always happens if set to
-.Dq Li YES
-and never happens if set to
-.Dq Li NO .
-If set to anything else, a memory file system is created if
-.Pa /var
-is not writable.
-Note that this process requires access to certain commands in
-.Pa /usr
-before
-.Pa /usr
-is mounted on normal systems.
-.It Va local_startup
-.Pq Vt str
-List of directories to search for startup script files.
-.It Va script_name_sep
-.Pq Vt str
-The field separator to use for breaking down the list of startup
script files -into individual filenames.
-The default is a space.
-It is not necessary to change this unless there are startup scripts
with names -containing spaces.
+.El
+.Ss NETWORK SERVICES
+Configuration variables which control network services such
+as NFS are defined below:
+.Bl -tag -width indent-two
.It Va hostname
.Pq Vt str
The fully qualified domain name (FQDN) of this host on the network.
@@ -339,7 +137,7 @@
.Ox
DHCP client, see the
.Xr dhclient 8
-manpage for a description of the command line options available.
+manual page for a description of the command line options available.
.It Va background_dhclient
.Pq Vt bool
Set to
@@ -348,6 +146,171 @@
This can cause trouble with applications depending on
a working network, but it will provide a faster startup
in many cases.
+.It Va natd_enable
+.Pq Vt bool
+Set to
+.Dq Li YES
+to enable
+.Xr natd 8 .
+.Va firewall_enable
+must also be set to
+.Dq Li YES ,
+and
+.Xr divert 4
+sockets must be enabled in the kernel.
+If the kernel was not built with
+.Cd "options IPDIVERT" ,
+the
+.Pa ipdivert.ko
+kernel module will be loaded.
+.It Va natd_interface
+.Pq Vt str
+This is the name of the public interface on which
+.Xr natd 8
+should run.
+The interface may be given as an interface name or as an IP address.
+.It Va natd_flags
+.Pq Vt str
+Additional
+.Xr natd 8
+flags should be placed here.
+The
+.Fl n
+or
+.Fl a
+flag is automatically added with the above
+.Va natd_interface
+as an argument.
+.El
+.Ss NETWORK INTERFACES
+Configuration variables that allow the system to utilize
+network interfaces are defined below:
+.Bl -tag -width indent-two
+.It Va network_interfaces
+.Pq Vt str
+Set to the list of network interfaces to configure on this host or
+.Dq Li "AUTO"
+(the default) for all current interfaces.
+For example, if the only network devices in the system are the loopback
+device
+.Pq Li lo0
+and a NIC using the
+.Xr ed 4
+driver,
+this could be set to
+.Dq Li "lo0 ed0" .
+An
+.Va ifconfig_ Ns Aq Ar interface
+variable is also assumed to exist for each value of
+.Ar interface .
+If the
+.Va ifconfig_ Ns Aq Ar interface
+contains the keyword
+.Dq Li "NOAUTO"
+then the interface will not be configured by
+at boot or by
+.Pa /etc/pccard_ether
+when
+.Va network_interfaces
+is set to
+.Dq Li "AUTO" .
+It is also possible to add IP alias entries here in cases where
+multiple IP addresses registered against a single interface
+are desired.
+Assuming that the interface in question was
+.Li ed0 ,
+it might look
+something like this:
+.Bd -literal
+ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
+ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
+.Ed
+.Pp
+And so on.
+For each
+.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
+entry that is found,
+its contents are passed to
+.Xr ifconfig 8 .
+Execution stops at the first unsuccessful access, so if
+something like this is present:
+.Bd -literal
+ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
+ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
+ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
+ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
+.Ed
+.Pp
+Then note that alias4 would
+.Em not
+be added since the search would
+stop with the missing alias3 entry.
+.Pp
+If the
+.Pa /etc/start_if. Ns Aq Ar interface
+file is present, it is read and executed by the
+.Xr sh 1
+interpreter
+before configuring the interface as specified in the
+.Va ifconfig_ Ns Aq Ar interface
+and
+.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
+variables.
+.Pp
+It is possible to bring up an interface with DHCP by adding
+.Dq Li DHCP
+to the
+.Va ifconfig_ Ns Aq Ar interface
+variable.
+For instance, to initialize the
+.Li ed0
+device via DHCP,
+it is possible to use something like:
+.Bd -literal
+ifconfig_ed0="DHCP"
+.Ed
+.Pp
+Also, if your interface needs WPA authentication, it is possible to add
+.Dq Li WPA
+to the
+.Va ifconfig_ Ns Aq Ar interface
+variable.
+.Pp
+Finally, you can add
+.Xr ifconfig 8
+options in this variable, in addition to the
+.Pa /etc/start_if. Ns Aq Ar interface
+file.
+For instance, to initialize the
+.Li wi0
+device via DHCP, using WPA authentication and 802.11b mode, it is
+possible to use something like:
+.Bd -literal
+ifconfig_wi0="DHCP WPA mode 11b"
+.Ed
+.Pp
+In addition to the
+.Va ifconfig_ Ns Aq Ar interface
+form, a fallback variable
+.Va ifconfig_DEFAULT
+may be configured.
+It will be used for all interfaces no
+.Va ifconfig_ Ns Aq Ar interface
+variable.
+This is intended to replace the no longer supported
+.Va pccard_ifconfig
+variable.
+.Pp
+It is also possible to rename interface by doing:
+.Bd -literal
+ifconfig_ed0_name="net0"
+ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
+.Ed
+.El
+.Ss SECURITY
+Configuration variables which enable security mechanisms are
+defined below:
+.Bl -tag -width indent-two
.It Va firewall_enable
.Pq Vt bool
Set to
@@ -444,41 +407,231 @@
.Pq Vt str
Path to
.Xr natd 8 .
-.It Va natd_enable
+.El
+.Ss GENERAL
+.Bl -tag -width indent-two
+.It Va swapfile
+.Pq Vt str
+If set to
+.Dq Li NO ,
+no swapfile is installed, otherwise the value is used as the full
+pathname to a file to use for additional swap space.
+.It Va apm_enable
+.Pq Vt bool
+If set to
+.Dq Li YES ,
+enable support for Automatic Power Management with
+the
+.Xr apm 8
+command.
+.It Va apmd_enable
+.Pq Vt bool
+Run
+.Xr apmd 8
+to handle APM event from userland.
+This also enables support for APM.
+.It Va apmd_flags
+.Pq Vt str
+If
+.Va apmd_enable
+is set to
+.Dq Li YES ,
+these are the flags to pass to the
+.Xr apmd 8
+daemon.
+.It Va devd_enable
+.Pq Vt bool
+Run
+.Xr devd 8
+to handle device added, removed or unknown events from the kernel.
+.It Va kldxref_enable
+.Pq Vt bool
+Set to
+.Dq Li NO
+by default.
+.\" XXX PERHAPS A DEVICES CATAGORY?
+Set to
+.Dq Li YES
+to automatically rebuild
+.Pa linker.hints
+files with
+.Xr kldxref 8
+at boot time.
+.It Va kldxref_clobber
+.Pq Vt bool
+Set to
+.Dq Li NO
+by default.
+If
+.Va kldxref_enable
+is true,
+setting to
+.Dq Li YES
+will overwrite existing
+.Pa linker.hints
+files at boot time.
+Otherwise,
+only missing
+.Pa linker.hints
+files are generated.
+.It Va kldxref_module_path
+.Pq Vt str
+Empty by default.
+A semi-colon
+.Pq Ql \&;
+delimited list of paths containing
+.Xr kld 4
+modules.
+If empty,
+the contents of the
+.Va kern.module_path
+.Xr sysctl 8
+are used.
+.It Va pccard_enable
+.Pq Vt bool
+If set to
+.Dq Li YES ,
+enable PCCARD support at boot time.
+.It Va pccard_mem
+.Pq Vt str
+Set to PCCARD controller memory address or
+.Dq Li DEFAULT
+for the default value.
+.It Va pccard_beep
+.Pq Vt int
+If 0,
+set the PCCARD controller to silent mode.
+If 1,
+set it to beep mode.
+If 2,
+set it to melody mode.
+.It Va pccard_conf
+.Pq Vt str
+Path to the configuration file for the
+.Xr pccardd 8
+daemon (e.g.\&
+.Pa /etc/pccard.conf.sample ) .
+.It Va pccardd_flags
+.Pq Vt str
+If
+.Va pccard_enable
+is set to
+.Dq Li YES ,
+these are the flags to pass to the
+.Xr pccardd 8
+daemon.
+.It Va powerd_enable
.Pq Vt bool
-Set to
-.Dq Li YES
-to enable
-.Xr natd 8 .
-.Va firewall_enable
-must also be set to
+If set to
.Dq Li YES ,
-and
-.Xr divert 4
-sockets must be enabled in the kernel.
-If the kernel was not built with
-.Cd "options IPDIVERT" ,
-the
-.Pa ipdivert.ko
-kernel module will be loaded.
-.It Va natd_interface
+enable the system power control facility with the
+.Xr powerd 8
+daemon.
+.It Va powerd_flags
.Pq Vt str
-This is the name of the public interface on which
-.Xr natd 8
-should run.
-The interface may be given as an interface name or as an IP address.
-.It Va natd_flags
+If
+.Va powerd_enable
+is set to
+.Dq Li YES ,
+these are the flags to pass to the
+.Xr powerd 8
+daemon.
+.It Va tmpmfs
+Controls the creation of a
+.Pa /tmp
+memory file system.
+Always happens if set to
+.Dq Li YES
+and never happens if set to
+.Dq Li NO .
+If set to anything else, a memory file system is created if
+.Pa /tmp
+is not writable.
+.It Va tmpsize
+Controls the size of a created
+.Pa /tmp
+memory file system.
+.It Va tmpmfs_flags
+Extra options passed to the
+.Xr mdmfs 8
+utility when the memory file system for
+.Pa /tmp
+is created.
+The default is
+.Dq Li -S -M ,
+which inhibits the use of softupdates on
+.Pa /tmp
+to waste as little space as possible
+and creates a pure memory backed disk, which will never be swapped out,
+for maximum performance and system stability at low memory conditions.
+See
+.Xr mdmfs 8
+for other options you can use in
+.Va tmpmfs_flags .
+.It Va varmfs
+Controls the creation of a
+.Pa /var
+memory file system.
+Always happens if set to
+.Dq Li YES
+and never happens if set to
+.Dq Li NO .
+If set to anything else, a memory file system is created if
+.Pa /var
+is not writable.
+.It Va varsize
+Controls the size of a created
+.Pa /var
+memory file system.
+.It Va varmfs_flags
+Extra options passed to the
+.Xr mdmfs 8
+utility when the memory file system for
+.Pa /var
+is created.
+The default is
+.Dq Li -S -M ,
+which inhibits the use of softupdates on
+.Pa /var
+to waste as little space as possible
+and creates a pure memory backed disk, which will never be swapped out,
+for maximum performance and system stability at low memory conditions.
+See
+.Xr mdmfs 8
+for other options you can use in
+.Va varmfs_flags .
+.It Va populate_var
+Controls the automatic population of the
+.Pa /var
+file system.
+Always happens if set to
+.Dq Li YES
+and never happens if set to
+.Dq Li NO .
+If set to anything else, a memory file system is created if
+.Pa /var
+is not writable.
+Note that this process requires access to certain commands in
+.Pa /usr
+before
+.Pa /usr
+is mounted on normal systems.
+.It Va local_startup
.Pq Vt str
-Additional
-.Xr natd 8
-flags should be placed here.
-The
-.Fl n
-or
-.Fl a
-flag is automatically added with the above
-.Va natd_interface
-as an argument.
+List of directories to search for startup script files.
+.It Va script_name_sep
+.Pq Vt str
+The field separator to use for breaking down the list of startup
script files +into individual filenames.
+The default is a space.
+It is not necessary to change this unless there are startup scripts
with names +containing spaces.
+
+
+
+
+
+
.\" ----- ipfilter_enable setting --------------------------------
.It Va ipfilter_enable
.Pq Vt bool
@@ -889,126 +1042,10 @@
Refer to
.Xr ip 4
for more information.
-.It Va network_interfaces
-.Pq Vt str
-Set to the list of network interfaces to configure on this host or
-.Dq Li "AUTO"
-(the default) for all current interfaces.
-For example, if the only network devices in the system are the loopback
-device
-.Pq Li lo0
-and a NIC using the
-.Xr ed 4
-driver,
-this could be set to
-.Dq Li "lo0 ed0" .
-An
-.Va ifconfig_ Ns Aq Ar interface
-variable is also assumed to exist for each value of
-.Ar interface .
-If the
-.Va ifconfig_ Ns Aq Ar interface
-contains the keyword
-.Dq Li "NOAUTO"
-then the interface will not be configured by
-at boot or by
-.Pa /etc/pccard_ether
-when
-.Va network_interfaces
-is set to
-.Dq Li "AUTO" .
-It is also possible to add IP alias entries here in cases where
-multiple IP addresses registered against a single interface
-are desired.
-Assuming that the interface in question was
-.Li ed0 ,
-it might look
-something like this:
-.Bd -literal
-ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
-ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
-.Ed
-.Pp
-And so on.
-For each
-.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
-entry that is found,
-its contents are passed to
-.Xr ifconfig 8 .
-Execution stops at the first unsuccessful access, so if
-something like this is present:
-.Bd -literal
-ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
-ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
-ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
-ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
-.Ed
-.Pp
-Then note that alias4 would
-.Em not
-be added since the search would
-stop with the missing alias3 entry.
-.Pp
-If the
-.Pa /etc/start_if. Ns Aq Ar interface
-file is present, it is read and executed by the
-.Xr sh 1
-interpreter
-before configuring the interface as specified in the
-.Va ifconfig_ Ns Aq Ar interface
-and
-.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
-variables.
-.Pp
-It is possible to bring up an interface with DHCP by adding
-.Dq Li DHCP
-to the
-.Va ifconfig_ Ns Aq Ar interface
-variable.
-For instance, to initialize the
-.Li ed0
-device via DHCP,
-it is possible to use something like:
-.Bd -literal
-ifconfig_ed0="DHCP"
-.Ed
-.Pp
-Also, if your interface needs WPA authentication, it is possible to add
-.Dq Li WPA
-to the
-.Va ifconfig_ Ns Aq Ar interface
-variable.
-.Pp
-Finally, you can add
-.Xr ifconfig 8
-options in this variable, in addition to the
-.Pa /etc/start_if. Ns Aq Ar interface
-file.
-For instance, to initialize the
-.Li wi0
-device via DHCP, using WPA authentication and 802.11b mode, it is
-possible to use something like:
-.Bd -literal
-ifconfig_wi0="DHCP WPA mode 11b"
-.Ed
-.Pp
-In addition to the
-.Va ifconfig_ Ns Aq Ar interface
-form, a fallback variable
-.Va ifconfig_DEFAULT
-may be configured.
-It will be used for all interfaces no
-.Va ifconfig_ Ns Aq Ar interface
-variable.
-This is intended to replace the no longer supported
-.Va pccard_ifconfig
-variable.
-.Pp
-It is also possible to rename interface by doing:
-.Bd -literal
-ifconfig_ed0_name="net0"
-ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
-.Ed
+
+
+
+
.It Va ipv6_network_interfaces
.Pq Vt str
This is the IPv6 equivalent of
More information about the freebsd-doc
mailing list