From 452947c3170dccf9fedd350d6d6c02b2a278c430 Mon Sep 17 00:00:00 2001 From: ru Date: Sun, 17 Mar 2002 14:52:54 +0000 Subject: mdoc(7) police: tidy up. --- share/man/man5/rc.conf.5 | 849 ++++++++++++++++++++++++++--------------------- 1 file changed, 472 insertions(+), 377 deletions(-) (limited to 'share') diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 73a78a3..e62bfab 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -35,15 +35,17 @@ The file .Nm contains descriptive information about the local host name, configuration details for any potential network interfaces and which services should be -started up at system initial boot time. In new installations, the +started up at system initial boot time. +In new installations, the .Nm -file is generally initialized by the system installation utility: -.Pa /stand/sysinstall . +file is generally initialized by the system installation utility, +.Xr sysinstall 8 . .Pp The purpose of .Nm is not to run commands or perform system startup actions -directly. Instead, it is included by the +directly. +Instead, it is included by the various generic startup scripts in .Pa /etc which conditionalize their @@ -54,8 +56,7 @@ The file is included from the file .Pa /etc/defaults/rc.conf , which specifies the default settings for all the available options. -Options -need only be specified in +Options need only be specified in .Pa /etc/rc.conf when the system administrator wishes to override these defaults. The file @@ -64,24 +65,24 @@ is used to override settings in .Pa /etc/rc.conf for historical reasons. See the -.Dq rc_conf_files -option below. +.Va rc_conf_files +variable below. .Pp The following list provides a name and short description for each variable that can be set in the .Nm file: -.Bl -tag -width Ar +.Bl -tag -width indent-two .It Va swapfile .Pq Vt str If set to -.Dq NO -then no swapfile is installed, otherwise the value is used as the full +.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 YES , +.Dq Li YES , enable support for Automatic Power Management with the .Xr apm 8 @@ -91,33 +92,36 @@ command. Run .Xr apmd 8 to handle APM event from userland. -This also enable support for APM. +This also enables support for APM. .It Va apmd_flags .Pq Vt str If .Va apmd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr apmd 8 daemon. .It Va pccard_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , enable PCCARD support at boot time. .It Va pccard_mem .Pq Vt str Set to PCCARD controller memory address or -.Dq DEFAULT +.Dq Li DEFAULT for the default value. .It Va pccard_ifconfig .Pq Vt str List of arguments to be passed to .Xr ifconfig 8 at boot time or on -insertion of the card (e.g. "inet 192.168.1.1 netmask 255.255.255.0" -for a fixed address or "DHCP" for a DHCP client). +insertion of the card (e.g.\& +.Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0 +for a fixed address or +.Dq Li DHCP +for a DHCP client). .It Va pccard_beep .Pq Vt int If 0, @@ -137,7 +141,7 @@ daemon (e.g.\& If .Va pccard_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr pccardd 8 daemon. @@ -169,7 +173,7 @@ It is not necessary to change this unless there are startup scripts with names containing spaces. .It Va hostname .Pq Vt str -The Fully Qualified Domain Name of this host on the network. +The fully qualified domain name (FQDN) of this host on the network. This should almost certainly be set to something meaningful, even if there is no network connection. If @@ -179,7 +183,7 @@ this variable should be set to an empty string. .It Va nisdomainname .Pq Vt str The NIS domain name of this host, or -.Dq NO +.Dq Li NO if NIS is not used. .It Va dhcp_program .Pq Vt str @@ -192,15 +196,16 @@ is the default). Additional flags to pass to the DHCP client program. For the ISC DHCP client, see the .Xr dhclient 8 -page for a description of the command line options available. +manpage for a description of the command line options available. .It Va firewall_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to load firewall rules at startup. If the kernel was not built with -.Dv IPFIREWALL , -the ipfw +.Cd "options IPFIREWALL" , +the +.Pa ipfw.ko kernel module will be loaded. See also .Va ipfilter_enable . @@ -213,29 +218,35 @@ The default is .Pq Vt str Names the firewall type from the selection in .Pa /etc/rc.firewall , -or the file which contains the local firewall ruleset. Valid selections -from -.Pa /etc/rc.firewall , -are -.Dq open -- unrestricted IP access; -.Dq closed -- all IP services disabled, except via lo0; -.Dq client -- basic protection for a workstation; -.Dq simple -- basic protection for a LAN. If a filename is specified, the full path +or the file which contains the local firewall ruleset. +Valid selections from +.Pa /etc/rc.firewall +are: +.Pp +.Bl -tag -width ".Li simple" -compact +.It Li open +unrestricted IP access +.It Li closed +all IP services disabled, except via +.Dq Li lo0 +.It Li client +basic protection for a workstation +.It Li simple +basic protection for a LAN. +.El +.Pp +If a filename is specified, the full path must be given. .It Va firewall_quiet .Pq Vt bool Set to -.Dq YES -to disable the display of ipfw rules on the console during boot. +.Dq Li YES +to disable the display of firewall rules on the console during boot. .It Va firewall_logging .Pq Vt bool Set to -.Dq YES -to enable ipfw event logging. +.Dq Li YES +to enable firewall event logging. This is equivalent to the .Dv IPFIREWALL_VERBOSE kernel option. @@ -253,21 +264,27 @@ Path to .It Va natd_enable .Pq Vt bool Set to -.Dq YES -to enable natd. +.Dq Li YES +to enable +.Xr natd 8 . .Va firewall_enable must also be set to -.Dq YES , +.Dq Li YES , and .Xr divert 4 sockets must be enabled in the kernel. .It Va natd_interface .Pq Vt str -This is the name of the public interface on which natd should run. +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 natd flags should be placed here. The +Additional +.Xr natd 8 +flags should be placed here. +The .Fl n or .Fl a @@ -278,10 +295,10 @@ as an argument. .It Va ipfilter_enable .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. Setting this to -.Dq YES +.Dq Li YES enables .Xr ipf 8 packet filtering. @@ -318,9 +335,9 @@ to be enabled. .Pp Having .Bd -literal -options IPFILTER -options IPFILTER_LOG -options IPFILTER_DEFAULT_BLOCK +options IPFILTER +options IPFILTER_LOG +options IPFILTER_DEFAULT_BLOCK .Ed .Pp in the kernel configuration file is a good idea, too. @@ -335,7 +352,7 @@ Path to .It Va ipfilter_rules .Pq Vt str Set to -.Dq /etc/ipf.rules +.Pa /etc/ipf.rules by default. This variable contains the name of the filter rule definition file. The file is expected to be readable for the @@ -352,10 +369,10 @@ program. .It Va ipnat_enable .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. Set it to -.Dq YES +.Dq Li YES to enable .Xr ipnat 1 network address translation. @@ -373,7 +390,7 @@ Path to .It Va ipnat_rules .Pq Vt str Set to -.Dq /etc/ipnat.rules +.Pa /etc/ipnat.rules by default. This variable contains the name of the file holding the network address translation definition. @@ -391,10 +408,10 @@ program. .It Va ipmon_enable .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. Set it to -.Dq YES +.Dq Li YES to enable .Xr ipmon 8 monitoring (logging @@ -421,13 +438,13 @@ Path to .It Va ipmon_flags .Pq Vt str Set to -.Dq -Ds +.Dq Li -Ds by default. This variable contains flags passed to the .Xr ipmon 8 program. Another typical example would be -.Dq -D /var/log/ipflog +.Dq Fl D Pa /var/log/ipflog to have .Xr ipmon 8 log directly to a file bypassing @@ -442,10 +459,10 @@ in such case like this: .It Va ipfs_enable .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. Set it to -.Dq YES +.Dq Li YES to enable .Xr ipfs 8 saving the filter and NAT state tables during shutdown @@ -455,7 +472,7 @@ Setting this variable needs setting or .Va ipnat_enable to -.Dq YES +.Dq Li YES too. See .Va ipfilter_enable @@ -486,14 +503,16 @@ program. .It Va tcp_extensions .Pq Vt bool Set to -.Dq YES +.Dq Li YES by default. -Setting this to NO disables certain TCP options as described by +Setting this to +.Dq Li NO +disables certain TCP options as described by .Rs -.%T RFC 1323 +.%T "RFC 1323" .Re Setting this to -.Dq NO +.Dq Li NO might help remedy such problems with connections as randomly hanging or other weird behavior. Some network devices are known @@ -504,9 +523,9 @@ Set to 0 by default. The .Xr sysctl 8 variables, -.Sy net.inet.tcp.log_in_vain +.Va net.inet.tcp.log_in_vain and -.Sy net.inet.udp.log_in_vain +.Va net.inet.udp.log_in_vain , as described in .Xr tcp 4 and @@ -515,16 +534,20 @@ are set to the given value. .It Va tcp_keepalive .Pq Vt bool Set to -.Dq YES +.Dq Li YES by default. -Setting to NO will disable probing idle TCP connections to verify that the +Setting to +.Dq Li NO +will disable probing idle TCP connections to verify that the peer is still up and reachable. .It Va tcp_drop_synfin .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. -Setting to YES will cause the kernel to ignore TCP frames that have both +Setting to +.Dq Li YES +will cause the kernel to ignore TCP frames that have both the SYN and FIN flags set. This prevents OS fingerprinting, but may break some legitimate applications. @@ -535,15 +558,19 @@ option. .It Va icmp_drop_redirect .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. -Setting to YES will cause the kernel to ignore ICMP REDIRECT packets. +Setting to +.Dq Li YES +will cause the kernel to ignore ICMP REDIRECT packets. .It Va icmp_log_redirect .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. -Setting to YES will cause the kernel to log ICMP REDIRECT packets. +Setting to +.Dq Li YES +will cause the kernel to log ICMP REDIRECT packets. Note that the log messages are not rate-limited, so this option should only be used for troubleshooting networks. @@ -552,10 +579,12 @@ for troubleshooting networks. Set to the list of network interfaces to configure on this host. For example, if the only network devices in the system are the loopback device -(lo0) -and a NIC using the ed0 driver, +.Pq Li lo0 +and a NIC using the +.Xr ed 4 +driver, this could be set to -.Dq "lo0 ed0" +.Dq Li "lo0 ed0" . An .Va ifconfig_ Ns Aq Ar interface variable is also assumed to exist for each value of @@ -563,7 +592,9 @@ variable is also assumed to exist for each value of 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 ed0, it might look +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" @@ -593,8 +624,10 @@ stop with the missing alias3 entry. It is possible to bring up an interface with DHCP by setting the .Va ifconfig_ Ns Aq Ar interface variable to -.Dq DHCP . -For instance, to initialize the ed0 device via DHCP, +.Dq Li DHCP . +For instance, to initialize the +.Li ed0 +device via DHCP, it is possible to use something like: .Bd -literal ifconfig_ed0="DHCP" @@ -630,7 +663,7 @@ before attempting to configure it. .It Va ppp_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr ppp 8 daemon. @@ -638,18 +671,19 @@ daemon. .Pq Vt str Mode in which to run the .Xr ppp 8 -daemon. Accepted modes are -.Dq auto , -.Dq ddial , -.Dq direct +daemon. +Accepted modes are +.Dq Li auto , +.Dq Li ddial , +.Dq Li direct and -.Dq dedicated . +.Dq Li dedicated . See the manual for a full description. .It Va ppp_nat .Pq Vt bool If set to -.Dq YES , -enables packet aliasing. +.Dq Li YES , +enables network address translation. Used in conjunction with .Va gateway_enable allows hosts on private network addresses access to the Internet using @@ -660,10 +694,14 @@ The name of the profile to use from .Pa /etc/ppp/ppp.conf . .It Va ppp_user .Pq Vt str -The name of the user under which ppp should be started. +The name of the user under which +.Xr ppp 8 +should be started. By -default, ppp is started as -.Dq root . +default, +.Xr ppp 8 +is started as +.Dq Li root . .It Va rc_conf_files .Pq Vt str This option is used to specify a list of files that will override @@ -678,21 +716,23 @@ and .It Va fsck_y_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , .Xr fsck 8 -will be run with the -y flag if the initial preen +will be run with the +.Fl y +flag if the initial preen of the filesystems fails. .It Va background_fsck .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , the system will attempt to run .Xr fsck 8 in the background where possible. .It Va extra_netfs_types .Pq Vt str If set to something other than -.Dq NO +.Dq Li NO (the default), this variable extends the list of filesystem types for which automatic mounting at startup by @@ -710,7 +750,7 @@ when third party filesystem types are used. .It Va syslogd_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr syslogd 8 daemon. @@ -725,13 +765,13 @@ Path to If .Va syslogd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to .Xr syslogd 8 . .It Va inetd_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr inetd 8 daemon. @@ -746,13 +786,13 @@ Path to If .Va inetd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to .Xr inetd 8 . .It Va named_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr named 8 daemon. @@ -767,33 +807,33 @@ Path to If .Va named_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to .Xr named 8 . .It Va kerberos4_server_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start a Kerberos IV authentication server at boot time. .It Va kadmind4_server_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start .Xr kadmind 8 , the Kerberos IV Administration Daemon; set to -.Dq NO +.Dq Li NO on a slave server. .It Va kerberos_stash .Pq Vt str If -.Dq YES , +.Dq Li YES , instruct the Kerberos servers to use the stashed master key instead of prompting for it (only if .Va kerberos_server_enable is set to -.Dq YES , +.Dq Li YES , and is used for both .Xr kerberos 1 and @@ -801,22 +841,22 @@ and .It Va kerberos5_server_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start a Kerberos 5 authentication server at boot time. .It Va kadmind5_server_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start .Xr k5admind 8 , the Kerberos 5 Administration Daemon; set to -.Dq NO +.Dq Li NO on a slave server. .It Va rwhod_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr rwhod 8 daemon at boot time. @@ -825,12 +865,12 @@ daemon at boot time. If .Va rwhod_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to it. .It Va amd_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr amd 8 daemon at boot time. @@ -839,12 +879,11 @@ daemon at boot time. If .Va amd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to it. See the .Xr amd 8 -.Xr info 1 -page for more information. +manpage for more information. .It Va amd_map_program .Pq Vt str If set, @@ -864,26 +903,27 @@ NIS map. .It Va update_motd .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , .Pa /etc/motd will be updated at boot time to reflect the kernel release -being run. If set to -.Dq NO , +being run. +If set to +.Dq Li NO , .Pa /etc/motd -will not be updated +will not be updated. .It Va nfs_client_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the NFS client daemons at boot time. .It Va nfs_access_cache .Pq Vt int If .Va nfs_client_enable is set to -.Dq YES , +.Dq Li YES , this can be set to -.Dq 0 +.Dq Li 0 to disable NFS ACCESS RPC caching, or to the number of seconds for which NFS ACCESS results should be cached. @@ -892,21 +932,21 @@ traffic for many NFS operations. .It Va nfs_server_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the NFS server daemons at boot time. .It Va nfs_server_flags .Pq Vt str If .Va nfs_server_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr nfsd 8 daemon. .It Va single_mountd_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , and no .Va nfs_server_enable is set, start @@ -918,33 +958,36 @@ It is commonly needed to run CFS without real NFS used. .It Va weak_mountd_authentication .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , allow services like PCNFSD to make non-privileged mount requests. .It Va nfs_privport .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , provide NFS services only on a secure port. .It Va nfs_bufpackets .Pq Vt int If set to a number, indicates the number of packets worth of -socket buffer space to reserve on an NFS client. If set to -.Dq DEFAULT , -the kernel default is used (typically 4). Using a higher number may be -useful on gigabit networks to improve performance. The minimum value is +socket buffer space to reserve on an NFS client. +If set to +.Dq Li DEFAULT , +the kernel default is used (typically 4). +Using a higher number may be +useful on gigabit networks to improve performance. +The minimum value is 2 and the maximum is 64. .It Va rpc_lockd_enable .Pq Vt bool If set to -.Dq YES +.Dq Li YES and also an NFS server, run .Xr rpc.lockd 8 at boot time. .It Va rpc_statd_enable .Pq Vt bool If set to -.Dq YES +.Dq Li YES and also an NFS server, run .Xr rpc.statd 8 at boot time. @@ -957,7 +1000,7 @@ Path to .It Va portmap_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , run the .Xr rpcbind 8 service at boot time. @@ -966,15 +1009,15 @@ service at boot time. If .Va portmap_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr rpcbind 8 daemon. .It Va xtend_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr xtend 8 daemon at boot time. .It Va xtend_flags @@ -982,15 +1025,15 @@ daemon at boot time. If .Va xtend_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr xtend 8 daemon. .It Va pppoed_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr pppoed 8 daemon at boot time to provide PPP over Ethernet services. .It Va pppoed_ Ns Ar provider @@ -1009,20 +1052,25 @@ Additional flags to pass to .Xr pppoed 8 . .It Va pppoed_interface .Pq Vt str -The network interface to run pppoed on. This is mandatory when +The network interface to run +.Xr pppoed 8 +on. +This is mandatory when .Va pppoed_enable is set to -.Dq YES . +.Dq Li YES . .It Va timed_enable .Pq Vt boot -If -.Dq YES -then run the +If set to +.Dq Li YES , +run the .Xr timed 8 -service at boot time. This command is intended for networks of +service at boot time. +This command is intended for networks of machines where a consistent -.Qq "network time" -for all hosts must be established. This is often useful in large NFS +.Dq "network time" +for all hosts must be established. +This is often useful in large NFS environments where time stamps on files are expected to be consistent network-wide. .It Va timed_flags @@ -1030,20 +1078,24 @@ network-wide. If .Va timed_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr timed 8 service. .It Va ntpdate_enable .Pq Vt bool If set to -.Dq YES , -run ntpdate at system startup. This command is intended to +.Dq Li YES , +run +.Xr ntpdate 8 +at system startup. +This command is intended to synchronize the system clock only .Em once -from some standard reference. An option to set this up initially +from some standard reference. +An option to set this up initially (from a list of known servers) is also provided by the -.Pa /stand/sysinstall +.Xr sysinstall 8 program when the system is first installed. .It Va ntpdate_program .Pq Vt str @@ -1056,15 +1108,15 @@ Path to If .Va ntpdate_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr ntpdate 8 command (typically a hostname). .It Va xntpd_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr ntpd 8 command at boot time. .It Va xntpd_program @@ -1078,15 +1130,15 @@ Path to If .Va xntpd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr ntpd 8 daemon. .It Va nis_client_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr ypbind 8 service at system boot time. .It Va nis_client_flags @@ -1094,15 +1146,15 @@ service at system boot time. If .Va nis_client_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr ypbind 8 service. .It Va nis_ypset_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr ypset 8 daemon at system boot time. .It Va nis_ypset_flags @@ -1110,15 +1162,15 @@ daemon at system boot time. If .Va nis_ypset_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr ypset 8 daemon. .It Va nis_server_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr ypserv 8 daemon at system boot time. .It Va nis_server_flags @@ -1126,15 +1178,15 @@ daemon at system boot time. If .Va nis_server_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr ypserv 8 daemon. .It Va nis_ypxfrd_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr rpc.ypxfrd 8 daemon at system boot time. .It Va nis_ypxfrd_flags @@ -1142,15 +1194,15 @@ daemon at system boot time. If .Va nis_ypxfrd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr rpc.ypxfrd 8 daemon. .It Va nis_yppasswdd_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr rpc.yppasswdd 8 daemon at system boot time. .It Va nis_yppasswdd_flags @@ -1158,41 +1210,42 @@ daemon at system boot time. If .Va nis_yppasswdd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr rpc.yppasswdd 8 daemon. .It Va defaultrouter .Pq Vt str If not set to -.Dq NO -then create a default route to this host name or IP address +.Dq Li NO , +create a default route to this host name or IP address (use an IP address if this router is also required to get to the name server!). .It Va static_routes .Pq Vt str Set to the list of static routes that are to be added at system -boot time. If not set to -.Dq NO +boot time. +If not set to +.Dq Li NO then for each whitespace separated .Ar element in the value, a .Va route_ Ns Aq Ar element variable is assumed to exist whose contents will later be passed to a -.Dq route add +.Dq Nm route Cm add operation. .It Va gateway_enable .Pq Vt bool If set to -.Dq YES , -then configure host to at as an IP router, e.g. to forward packets +.Dq Li YES , +configure host to act as an IP router, e.g. to forward packets between interfaces. .It Va router_enable .Pq Vt bool If set to -.Dq YES -then run a routing daemon of some sort, based on the +.Dq Li YES , +run a routing daemon of some sort, based on the settings of .Va router and @@ -1202,38 +1255,40 @@ and If .Va router_enable is set to -.Dq YES , +.Dq Li YES , this is the name of the routing daemon to use. .It Va router_flags .Pq Vt str If .Va router_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the routing daemon. .It Va mrouted_enable .Pq Vt bool If set to -.Dq YES -then run the multicast routing daemon, +.Dq Li YES , +run the multicast routing daemon, .Xr mrouted 8 . .It Va mrouted_flags .Pq Vt str If .Va mrouted_enable is set to -.Dq YES , -these are the flags to pass to the multicast routing daemon. +.Dq Li YES , +these are the flags to pass to the +.Xr mrouted 8 +daemon. .It Va ipxgateway_enable .Pq Vt bool If set to -.Dq YES -then enable the routing of IPX traffic. +.Dq Li YES , +enable the routing of IPX traffic. .It Va ipxrouted_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr IPXrouted 8 daemon at system boot time. .It Va ipxrouted_flags @@ -1241,34 +1296,34 @@ daemon at system boot time. If .Va ipxrouted_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr IPXrouted 8 daemon. .It Va arpproxy_all .Pq Vt bool If set to -.Dq YES -then enable global proxy ARP. +.Dq Li YES , +enable global proxy ARP. .It Va forward_sourceroute .Pq Vt bool If set to -.Dq YES -then when +.Dq Li YES +and .Va gateway_enable is also set to -.Dq YES , -source routed packets are forwarded. +.Dq Li YES , +source-routed packets are forwarded. .It Va accept_sourceroute .Pq Vt bool If set to -.Dq YES -then the system will accept source routed packets directed at it. +.Dq Li YES , +the system will accept source-routed packets directed at it. .It Va rarpd_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr rarpd 8 daemon at system boot time. .It Va rarpd_flags @@ -1276,14 +1331,14 @@ daemon at system boot time. If .Va rarpd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr rarpd 8 daemon. .It Va atm_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable the configuration of ATM interfaces at system boot time. For all of the ATM variables described below, please refer to the .Xr atm 8 @@ -1291,175 +1346,188 @@ man page for further details on the available command parameters. Also refer to the files in .Pa /usr/share/examples/atm for more detailed configuration information. -.It Va atm_netif_ +.It Va atm_netif_ Ns Aq Ar intf .Pq Vt str For the ATM physical interface -.Va , -this variable defines the name prefix and count for the ATM network interfaces to be created. +.Ar intf , +this variable defines the name prefix and count for the ATM network +interfaces to be created. The value will be passed as the parameters of an -.Dq atm set netif Va +.Dq Nm atm Cm "set netif" Ar intf command. -.It Va atm_sigmgr_ +.It Va atm_sigmgr_ Ns Aq Ar intf .Pq Vt str For the ATM physical interface -.Va , +.Ar intf , this variable defines the ATM signalling manager to be used. The value will be passed as the parameters of an -.Dq atm attach Va +.Dq Nm atm Cm attach Ar intf command. -.It Va atm_prefix_ +.It Va atm_prefix_ Ns Aq Ar intf .Pq Vt str For the ATM physical interface -.Va , +.Ar intf , this variable defines the NSAP prefix for interfaces using a UNI signalling -manager. If set to -.Em ILMI , -then the prefix will automatically be set via the +manager. +If set to +.Dq Li ILMI , +the prefix will automatically be set via the .Xr ilmid 8 -daemon. Otherwise, the value will be passed as the parameters of an -.Dq atm set prefix Va +daemon. +Otherwise, the value will be passed as the parameters of an +.Dq Nm atm Cm "set prefix" Ar intf command. -.It Va atm_macaddr_ +.It Va atm_macaddr_ Ns Aq Ar intf .Pq Vt str For the ATM physical interface -.Va , +.Ar intf , this variable defines the MAC address for interfaces using a UNI signalling -manager. If set to -.Dq NO , -then the hardware MAC address contained in the ATM interface card will be used. +manager. +If set to +.Dq Li NO , +the hardware MAC address contained in the ATM interface card will be used. Otherwise, the value will be passed as the parameters of an -.Dq atm set mac Va +.Dq Nm atm Cm "set mac" Ar intf command. -.It Va atm_arpserver_ +.It Va atm_arpserver_ Ns Aq Ar netif .Pq Vt str For the ATM network interface -.Va , +.Ar netif , this variable defines the ATM address for a host which is to provide ATMARP -service. This variable is only applicable to interfaces using a UNI signalling -manager. If set to -.Em local , -then this host will become an ATMARP server. +service. +This variable is only applicable to interfaces using a UNI signalling +manager. +If set to +.Dq Li local , +this host will become an ATMARP server. The value will be passed as the parameters of an -.Dq atm set arpserver Va +.Dq Nm atm Cm "set arpserver" Ar netif command. -.It Va atm_scsparp_ +.It Va atm_scsparp_ Ns Aq Ar netif .Pq Vt bool If set to -.Dq YES , -then SCSP/ATMARP service for the network interface -.Va +.Dq Li YES , +SCSP/ATMARP service for the network interface +.Ar netif will be initiated using the .Xr scspd 8 and .Xr atmarpd 8 -daemons. This variable is only applicable if -.So +daemons. +This variable is only applicable if .Va atm_arpserver_ Ns Aq Ar netif -.No = Ns Qq local -.Sc -is defined. +is set to +.Dq Li local . .It Va atm_pvcs .Pq Vt str Set to the list of ATM PVCs to be added at system -boot time. For each whitespace separated +boot time. +For each whitespace separated .Ar element in the value, an .Va atm_pvc_ Ns Aq Ar element -variable is assumed to exist. The value of each of these variables +variable is assumed to exist. +The value of each of these variables will be passed as the parameters of an -.Dq atm add pvc +.Dq Nm atm Cm "add pvc" command. .It Va atm_arps .Pq Vt str Set to the list of permanent ATM ARP entries to be added -at system boot time. For each whitespace separated +at system boot time. +For each whitespace separated .Ar element in the value, an .Va atm_arp_ Ns Aq Ar element -variable is assumed to exist. The value of each of these variables +variable is assumed to exist. +The value of each of these variables will be passed as the parameters of an -.Dq atm add arp +.Dq Nm atm Cm "add arp" command. .It Va keymap .Pq Vt str If set to -.Dq NO -then no keymap is installed, otherwise the value is used to install +.Dq Li NO , +no keymap is installed, otherwise the value is used to install the keymap file in -.Pa /usr/share/syscons/keymaps/.kbd +.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd . .It Va keyrate .Pq Vt str -The keyboard repeat speed. Set to -.Dq slow , -.Dq normal , -.Dq fast +The keyboard repeat speed. +Set to +.Dq Li slow , +.Dq Li normal , +.Dq Li fast , or -.Dq NO +.Dq Li NO if the default behavior is desired. .It Va keychange .Pq Vt str If not set to -.Dq NO , -attempt to program the function keys with the value. The value should +.Dq Li NO , +attempt to program the function keys with the value. +The value should be a single string of the form: -.Qq Ar " [ ]..." +.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... . .It Va cursor .Pq Vt str Can be set to the value of -.Dq normal , -.Dq blink , -.Dq destructive +.Dq Li normal , +.Dq Li blink , +.Dq Li destructive , or -.Dq NO +.Dq Li NO to set the cursor behavior explicitly or choose the default behavior. .It Va scrnmap .Pq Vt str If set to -.Dq NO -then no screen map is installed, otherwise the value is used to install +.Dq Li NO , +no screen map is installed, otherwise the value is used to install the screen map file in -.Pa /usr/share/syscons/scrnmaps/ . +.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value . .It Va font8x16 .Pq Vt str If set to -.Dq NO -then the default 8x16 font value is used for screen size requests, otherwise +.Dq Li NO , +the default 8x16 font value is used for screen size requests, otherwise the value in -.Pa /usr/share/syscons/fonts/ +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value is used. .It Va font8x14 .Pq Vt str If set to -.Dq NO -then the default 8x14 font value is used for screen size requests, otherwise +.Dq Li NO , +the default 8x14 font value is used for screen size requests, otherwise the value in -.Pa /usr/share/syscons/fonts/ +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value is used. .It Va font8x8 .Pq Vt str If set to -.Dq NO -then the default 8x8 font value is used for screen size requests, otherwise +.Dq Li NO , +the default 8x8 font value is used for screen size requests, otherwise the value in -.Pa /usr/share/syscons/fonts/ +.Pa /usr/share/syscons/fonts/ Ns Aq Ar value is used. .It Va blanktime .Pq Vt int If set to -.Dq NO -then the default screen blanking interval is used, otherwise it is set +.Dq Li NO , +the default screen blanking interval is used, otherwise it is set to .Ar value seconds. .It Va saver .Pq Vt str If not set to -.Dq NO , -this is the actual screen saver to use (blank, snake, daemon, etc). +.Dq Li NO , +this is the actual screen saver to use +.Li ( blank , snake , daemon , +etc). .It Va moused_enable .Pq Vt str If set to -.Dq YES , +.Dq Li YES , the .Xr moused 8 daemon is started for doing cut/paste selection on the console. @@ -1469,45 +1537,60 @@ This is the protocol type of the mouse connected to this host. This variable must be set if .Va moused_enable is set to -.Dq YES . +.Dq Li YES . The .Xr moused 8 daemon is able to detect the appropriate mouse type automatically in many cases. Set this variable to -.Dq auto +.Dq Li auto to let the daemon detect it, or select one from the following list if the automatic detection fails. .Pp If the mouse is attached to the PS/2 mouse port, choose -.Dq auto +.Dq Li auto or -.Dq ps/2 , -regardless of the brand and model of the mouse. Likewise, if the +.Dq Li ps/2 , +regardless of the brand and model of the mouse. +Likewise, if the mouse is attached to the bus mouse port, choose -.Dq auto +.Dq Li auto or -.Dq busmouse . +.Dq Li busmouse . All other protocols are for serial mice and will not work with the PS/2 and bus mice. If this is a USB mouse, -.Dq auto +.Dq Li auto is the only protocol type which will work. -.Bd -literal -microsoft Microsoft mouse (serial) -intellimouse Microsoft IntelliMouse (serial) -mousesystems Mouse systems Corp mouse (serial) -mmseries MM Series mouse (serial) -logitech Logitech mouse (serial) -busmouse A bus mouse -mouseman Logitech MouseMan and TrackMan (serial) -glidepoint ALPS GlidePoint (serial) -thinkingmouse Kensington ThinkingMouse (serial) -ps/2 PS/2 mouse -mmhittab MM HitTablet (serial) -x10mouseremote X10 MouseRemote (serial) -versapad Interlink VersaPad (serial) -.Ed +.Pp +.Bl -tag -width ".Li x10mouseremote" -compact +.It Li microsoft +Microsoft mouse (serial) +.It Li intellimouse +Microsoft IntelliMouse (serial) +.It Li mousesystems +Mouse systems Corp. mouse (serial) +.It Li mmseries +MM Series mouse (serial) +.It Li logitech +Logitech mouse (serial) +.It Li busmouse +A bus mouse +.It Li mouseman +Logitech MouseMan and TrackMan (serial) +.It Li glidepoint +ALPS GlidePoint (serial) +.It Li thinkingmouse +Kensington ThinkingMouse (serial) +.It Li ps/2 +PS/2 mouse +.It Li mmhittab +MM HitTablet (serial) +.It Li x10mouseremote +X10 MouseRemote (serial) +.It Li versapad +Interlink VersaPad (serial) +.El .Pp Even if the mouse is not in the above list, it may be compatible with one in the list. @@ -1517,21 +1600,27 @@ for compatibility information. .Pp It should also be noted that while this is enabled, any other client of the mouse (such as an X server) should access -the mouse through the virtual mouse device: -.Pa /dev/sysmouse -and configure it as a sysmouse type mouse, since all +the mouse through the virtual mouse device, +.Pa /dev/sysmouse , +and configure it as a +.Dq Li sysmouse +type mouse, since all mouse data is converted to this single canonical format when using .Xr moused 8 . -If the client program does not support the sysmouse type, -specify the mousesystems type. +If the client program does not support the +.Dq Li sysmouse +type, +specify the +.Dq Li mousesystems +type. It is the second preferred type. .It Va moused_port .Pq Vt str If .Va moused_enable is set to -.Dq YES , +.Dq Li YES , this is the actual port the mouse is on. It might be .Pa /dev/cuaa0 @@ -1550,8 +1639,10 @@ daemon. .It Va mousechar_start .Pq Vt int If set to -.Dq NO -then the default mouse cursor character range 0xd0-0xd3 is used, +.Dq Li NO , +the default mouse cursor character range +.Li 0xd0 Ns - Ns Li 0xd3 +is used, otherwise the range start is set to .Ar value @@ -1565,12 +1656,12 @@ If set, is run with these options for each of the virtual terminals .Pq Pa /dev/ttyv* . For example, -.Dq -m on +.Dq Fl m Cm on will enable the mouse pointer on all virtual terminals if .Va moused_enable is set to -.Dq YES . +.Dq Li YES . .It Va allscreens_kbdflags .Pq Vt str If set, @@ -1578,15 +1669,15 @@ If set, is run with these options for each of the virtual terminals .Pq Pa /dev/ttyv* . For example, -.Dq Li -h 200 +.Dq Fl h Li 200 will set the .Xr syscons 4 scrollback (history) buffer to 200 lines. .It Va cron_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr cron 8 daemon at system boot time. .It Va cron_program @@ -1600,7 +1691,7 @@ Path to If .Va cron_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to .Xr cron 8 . .It Va lpd_program @@ -1612,8 +1703,8 @@ Path to .It Va lpd_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr lpd 8 daemon at system boot time. .It Va lpd_flags @@ -1621,15 +1712,15 @@ daemon at system boot time. If .Va lpd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr lpd 8 daemon. .It Va sendmail_enable .Pq Vt bool If set to -.Dq YES -then run the +.Dq Li YES , +run the .Xr sendmail 8 daemon at system boot time. .It Va sendmail_flags @@ -1637,19 +1728,19 @@ daemon at system boot time. If .Va sendmail_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr sendmail 8 daemon. .It Va sendmail_submit_enable .Pq Vt bool If set to -.Dq YES +.Dq Li YES and .Va sendmail_enable is set to -.Dq NO -then run +.Dq Li NO , +run .Xr sendmail 8 using .Va sendmail_submit_flags @@ -1657,16 +1748,17 @@ instead of .Va sendmail_flags . This is intended to allow local mail submission via a localhost-only listening SMTP service required for running -.Xr sendmail 8 as a non-set-user-ID binary. +.Xr sendmail 8 +as a non-set-user-ID binary. .It Va sendmail_outbound_enable .Pq Vt bool If set to -.Dq YES +.Dq Li YES and .Va sendmail_enable is set to -.Dq NO -then run +.Dq Li NO , +run .Xr sendmail 8 using .Va sendmail_outbound_flags @@ -1679,30 +1771,31 @@ for systems that do not offer a listening SMTP service. If .Va sendmail_enable is set to -.Dq NO +.Dq Li NO and .Va sendmail_outbound_enable is set to -.Dq YES -then these are the flags to pass to the +.Dq Li YES , +these are the flags to pass to the .Xr sendmail 8 daemon. .It Va sendmail_msp_queue_enable .Pq Vt bool If set to -.Dq YES , +.Dq Li YES , start a client (MSP) queue runner .Xr sendmail 8 daemon at system boot time. As of sendmail 8.12, a separate queue is used for command line -submissions. The client queue runner assures that nothing is +submissions. +The client queue runner assures that nothing is left behind in the submission queue. .It Va sendmail_msp_queue_flags .Pq Vt str If .Va sendmail_msp_queue_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr sendmail 8 daemon. @@ -1713,7 +1806,7 @@ should be written in the event of a system crash. The value of this variable is passed as the argument to .Xr dumpon 8 . To disable crash dumps, set this variable to -.Dq NO . +.Dq Li NO . .It Va dumpdir .Pq Vt str When the system reboots after a crash and a crash dump is found on the @@ -1726,9 +1819,9 @@ specified by the .Va dumpdir variable. The default value is -.Dq /var/crash . +.Pa /var/crash . Set to -.Dq NO +.Dq Li NO to not run .Xr savecore 8 at boot time when @@ -1737,56 +1830,56 @@ is set. .It Va enable_quotas .Pq Vt bool Set to -.Dq YES +.Dq Li YES to turn on user disk quotas on system startup via the .Xr quotaon 8 command. .It Va check_quotas .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable user disk quota checking via the .Xr quotacheck 8 command. .It Va accounting_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable system accounting through the .Xr accton 8 facility. .It Va ibcs2_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable iBCS2 (SCO) binary emulation at system initial boot time. .It Va ibcs2_loaders .Pq Vt str If not set to -.Dq NO +.Dq Li NO and if .Va ibcs2_enable is set to -.Dq YES , +.Dq Li YES , this specifies a list of additional iBCS2 loaders to enable. .It Va linux_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable Linux/ELF binary emulation at system initial boot time. .It Va osf1_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to enable OSF/1 (Digital UNIX) binary emulation at system initial boot time. (alpha) .It Va clear_tmp_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to have .Pa /tmp cleaned at startup. @@ -1804,28 +1897,29 @@ The utility normally refuses to use directories which are writable by anyone except root. Set this variable to -.Dq YES +.Dq Li YES to disable that security check during system startup. .It Va kern_securelevel_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to set the kernel security level at system startup. .It Va kern_securelevel .Pq Vt int The kernel security level to set at startup. The allowed range of .Ar value -ranges from -1 (the compile time default) to 3 (the -most secure). See +ranges from \-1 (the compile time default) to 3 (the +most secure). +See .Xr init 8 for the list of possible security levels and their effect on system operation. .It Va lomac_enable .Pq Vt bool Set to -.Dq YES -to enable Low Watermark Mandatory Access Control (LOMAC) at boot-time. +.Dq Li YES +to enable Low Watermark Mandatory Access Control (LOMAC) at boot time. This security model enforces integrity constraints for system processes; see .Xr lomac 4 @@ -1834,7 +1928,7 @@ on system operation. .It Va start_vinum .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start .Xr vinum 8 at system boot time. @@ -1846,7 +1940,7 @@ is the default). .It Va sshd_enable .Pq Vt bool Set to -.Dq YES +.Dq Li YES to start .Xr sshd 8 at system boot time. @@ -1855,31 +1949,32 @@ at system boot time. If .Va sshd_enable is set to -.Dq YES , +.Dq Li YES , these are the flags to pass to the .Xr sshd 8 daemon. .It Va unaligned_print .Pq Vt bool If set to -.Dq NO -then unaligned access warnings will not be printed. +.Dq Li NO , +unaligned access warnings will not be printed. (alpha) .\" ----- isdn settings --------------------------------- .It Va isdn_enable .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. When set to -.Dq YES , -starts the isdn daemon -.Pa /usr/sbin/isdnd +.Dq Li YES , +starts the +.Xr isdnd 8 +daemon at system boot time. .It Va isdn_flags .Pq Vt str Set to -.Dq -dn -d0x1f9 +.Dq Fl d Ns Cm n Fl d Ns Li 0x1f9 by default. Additional flags to pass to .Xr isdnd 8 @@ -1891,17 +1986,17 @@ for certain tunable parameters). .It Va isdn_ttype .Pq Vt str Set to -.Dq cons25 +.Dq Li cons25 by default. The terminal type of the output device when .Xr isdnd 8 -operates in fullscreen mode. +operates in full-screen mode. .It Va isdn_screenflags .Pq Vt str Set to -.Dq NO +.Dq Li NO by default. -The video mode for fullscreen mode (only for +The video mode for full-screen mode (only for .Xr syscons 4 console driver, see .Xr vidcontrol 1 @@ -1909,34 +2004,34 @@ for valid modes). .It Va isdn_fsdev .Pq Vt str Set to -.Dq NO +.Dq Li NO by default. The output device for .Xr isdnd 8 -in fullscreen mode (or -.Dq NO +in full-screen mode (or +.Dq Li NO for daemon mode). .It Va isdn_trace .Pq Vt bool Set to -.Dq NO +.Dq Li NO by default. When set to -.Dq YES , +.Dq Li YES , enables the ISDN protocol trace utility -.Pa /usr/sbin/isdntrace +.Xr isdntrace 8 at system boot time. .It Va isdn_traceflags .Pq Vt str Set to -.Dq -f /var/tmp/isdntrace0 +.Dq Fl f Pa /var/tmp/isdntrace0 by default. Flags for -.Pa /usr/sbin/isdntrace . +.Xr isdntrace 8 . .\" ----------------------------------------------------- .El .Sh FILES -.Bl -tag -width /etc/defaults/rc.conf -compact +.Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact .It Pa /etc/defaults/rc.conf .It Pa /etc/rc.conf .It Pa /etc/rc.conf.local -- cgit v1.1