.\" $NetBSD: rc.conf.5,v 1.71 2002/11/25 08:07:04 grant Exp $ .\" .\" Copyright (c) 1996 Matthew R. Green .\" Copyright (c) 1997 Curt J. Sampson .\" Copyright (c) 1997 Michael W. Long .\" Copyright (c) 1998-2002 The NetBSD Foundation, Inc. .\" All rights reserved. .\" .\" This document is derived from works contributed to The NetBSD Foundation .\" by Luke Mewburn. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .Dd November 25, 2002 .Dt RC.CONF 5 .Os .\" turn off hyphenation .hym 999 .Sh NAME .Nm rc.conf .Nd system startup configuration file .Sh DESCRIPTION The .Nm file specifies which services are enabled during system startup by the startup scripts invoked by .Pa /etc/rc (see .Xr rc 8 ) , and the shutdown scripts invoked by .Pa /etc/rc.shutdown . The .Nm file is a shell script that is sourced by .Xr rc 8 , meaning that .Nm must contain valid shell commands. .Pp Listed below are the standard .Nm variables that may be set, the values to which each may be set, a brief description of what each variable does, and a reference to 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 .Pa /etc/defaults/rc.conf (if it is readable) to obtain default values for various variables, and the end-user may override these by appending appropriate entries to the end of .Nm "" . .Pp .Xr rc.d 8 scripts that use .Ic load_rc_config from .Xr rc.subr 8 also support sourcing an optional end-user provided per-script override file .Pa /etc/rc.conf.d/ Ns Ar service , (where .Ar service is the contents of the .Sy name variable in the .Xr rc.d 8 script). This may contain variable overrides, including allowing the end-user to override various .Ic run_rc_command .Xr rc.d 8 control variables, and thus changing the operation of the script without requiring editing of the script. .Ss Overall control .Bl -tag -width net_interfaces .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. .It Sy rc_fast_and_loose If set to a non-empty string, each script in .Pa /etc/rc.d will be executed in the current shell rather than a sub shell. This may be faster on slow machines that have an expensive .Xr fork 2 operation. .Bl -hang .It Em Note : Use this at your own risk! A rogue command or script may inadvertently prevent boot to multiuser. .El .It Sy rc_rcorder_flags A string. Extra arguments to the .Xr rcorder 8 run by .Pa /etc/rc . .It Sy do_rcshutdown .Sq YES or .Sq NO . If set to .Sq NO , .Xr shutdown 8 will not run .Pa /etc/rc.shutdown . .It Sy rcshutdown_rcorder_flags A string. Extra arguments to the .Xr rcorder 8 run by .Pa /etc/rc.shutdown . .It Sy rcshutdown_timeout A number. If non-blank, use this as the number of seconds to run a watchdog timer for which will terminate .Pa /etc/rc.shutdown if the timer expires before the shutdown script completes. .El .Ss Basic network configuration .Bl -tag -width net_interfaces .It Sy hostname A string. Name of host. If empty or not set, then the contents of .Pa /etc/myname (if it exists) are used. .It Sy defaultroute A string. Default network route. If empty or not set, then the contents of .Pa /etc/mygate (if it exists) are used. .It Sy domainname A string. .Tn NIS (YP) domain of host. If empty or not set, then the contents of .Pa /etc/defaultdomain (if it exists) are used. .El .Ss Boottime file-system and swap configuration .Bl -tag -width net_interfaces .It Sy critical_filesystems_local A string. File systems mounted very early in the system boot before networking services are available. Usually .Pa /var is part of this, because it is needed by services such as .Xr dhclient 8 which may be required to get the network operational. .It Sy critical_filesystems_remote A string. 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 .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. .It Sy swapoff .Sq YES or .Sq NO . 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 lkm .Sq YES or .Sq NO . Runs .Pa /etc/rc.lkm . .It Sy savecore .Sq YES or .Sq NO . Runs the .Xr savecore 8 utility. Passes .Sy savecore_flags . .It Sy clear_tmp .Sq YES or .Sq NO . Clear /tmp after reboot. .It Sy update_motd .Sq YES or .Sq NO . Updates the .Nx version string in the .Pa /etc/motd file to reflect the version of the running kernel. See .Xr motd 5 . .It Sy dmesg .Sq YES or .Sq NO . Create .Pa /var/run/dmesg.boot from the output of .Xr dmesg 8 . Passes .Sy dmesg_flags . .It Sy accounting .Sq YES or .Sq NO . Enables process accounting with .Xr accton 8 . Requires .Pa /var/account/acct to exist. .It Sy newsyslog .Sq YES or .Sq NO . Run .Nm newsyslog to trim logfiles before syslogd starts. Intended for laptop users. Passes .Sy newsyslog_flags . .It Sy tpctl .Sq YES or .Sq NO . Run .Xr tpctl 8 to calibrate touch panel device. Passes .Sy tpctl_flags . .El .Ss System security setting .Bl -tag -width net_interfaces .It Sy securelevel A number. The system securelevel is set to the specified value early in the boot process, before any external logins, or other programs that run users job, are started. If set to nothing, the default action is taken, as described in .Xr init 8 , which contains definitive information about the system securelevel. Note that setting .Sy securelevel to 0 in .Nm will actually result in the system booting with securelevel set to 1, as .Xr init 8 will raise the level when .Xr rc 8 completes. .El .Ss Networking startup .Bl -tag -width net_interfaces .It Sy ipfilter .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.conf 5 . .It Sy ipnat .Sq YES or .Sq NO . 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 ipfs .Sq YES or .Sq NO . Runs .Xr ipfs 8 to save and restore information for ipnat and ipfilter state tables. The information is stored in .Pa /var/db/ipf/ipstate.ipf and .Pa /var/db/ipf/ipnat.ipf . Passes .Sy ipfs_flags . .It Sy ipsec .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 ipmon_flags Set to .Dq Li -ns by default. This variable contains flags passed to the .Xr ipmon 8 program. Another typical example would be .Dq Fl nD Pa /var/log/ipflog to have .Xr ipmon 8 log directly to a file bypassing .Xr syslogd 8 . Make sure to adjust .Pa /etc/newsyslog.conf in such case like this: .Bd -literal /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid .Ed .It Sy racoon .Sq YES or .Sq NO . Runs .Xr racoon 8 , the IKE (ISAKMP/Oakley) key management daemon. .It Sy auto_ifconfig .Sq YES or .Sq NO . Sets the .Sy net_interfaces variable (see below) to the output of .Xr ifconfig 8 with the .Dq Li -l flag and suppresses warnings about interfaces in this list that do not have an ifconfig file or variable. .It Sy net_interfaces A string. The list of network interfaces to be configured at boot time. For each interface "xxN", the system first looks for ifconfig parameters in .Pa /etc/ifconfig.xxN and then in the variable .Sy ifconfig_xxN . The contents of the file or the variable are handed to ifconfig after the interface name. If .Sy auto_ifconfig is set to "NO" and neither the file nor the variable is found, a warning is printed. Refer to .Xr ifconfig.if 5 for more details on .Pa /etc/ifconfig.xxN . .It Sy ifaliases_* A string. List of .Sq Em "address netmask" pairs to configure additional network addresses for the given configured interface .Dq * (e.g. .Sy ifaliases_le0 ) . If .Em netmask is .Dq - , then use the default netmask for the interface. .Pp .Sy ifaliases_* covers limited cases only and considered unrecommended. We recommend using .Pa /etc/ifconfig.xxN with multiple lines instead. .It Sy flushroutes .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 .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 .Sq YES , you must either have .Pa /var in .Sy critical_filesystems_local , as part of .Pa / , or direct the DHCP client to store the leases file on the root file system by modifying the .Sy dhclient_flags variable. You must not provide ifconfig information or ifaliases information for any interface that is to be configured using the DHCP client. Interface aliases can be set up in the DHCP client configuration file if needed - see .Xr dhclient.conf 5 for details. .Pp Passes .Sy dhclient_flags to the DHCP client. See .Xr dhclient 8 for complete documentation. If you wish to configure all broadcast network interfaces using the DHCP client, you can leave this blank. To configure only specific interfaces, name the interfaces to be configured on the command line. .Pp If you must run the DHCP client before mounting critical file systems, then you should specify an alternate location for the DHCP client's lease file in the .Sy dhclient_flags variable - for example, "-lf /tmp/dhclient.leases". .It Sy ntpdate .Sq YES or .Sq NO . Runs .Xr ntpdate 8 to set the system time from one of the hosts in .Sy ntpdate_hosts . If .Sy ntpdate_hosts is empty, it will attempt to find a list of hosts in .Pa /etc/ntp.conf . Passes .Sy ntpdate_flags . .It Sy ppp_peers A string. If .Sy ppp_peers is not empty, then .Pa /etc/rc.d/ppp will check each word in .Sy ppp_peers for a corresponding ppp configuration file in .Pa /etc/ppp/peers and will call .Xr pppd 8 with the .Dq call Sy peer option. .It Sy ip6mode A string. An IPv6 node can be a router .Pq nodes that forward packet for others or a host .Pq nodes that do not forward . A host can be autoconfigured based on the information advertised by adjacent IPv6 routers. By setting .Sy ip6mode to .Dq Li router , .Dq Li host , or .Dq Li autohost , you can configure your node as a router, a non-autoconfigured host, or an autoconfigured host. Invalid values will be ignored, and the node will be configured as a non-autoconfigured host. You may want to check .Sy rtsol and .Sy rtsold as well, if you set the variable to .Dq Li autohost . .It Sy ip6sitelocal .Sq YES or .Sq NO . If you intend to use IPv6 site-local addresses in your site, set it to .Sq YES . Otherwise, reject routes will get installed on boot to avoid misconfiguration relating to site-local addresses. .It Sy rtsol .Sq YES or .Sq NO . Run .Xr rtsol 8 , router solicitation command for IPv6 hosts. On nomadic hosts like notebook computers, you may want to enable .Sy rtsold as well. Passes .Sy rtsol_flags . This is only for autoconfigured IPv6 hosts, so set .Sy ip6mode to .Dq Li autohost if you use it. .It Sy ifwatchd .Sq YES or .Sq NO . Monitor dynamic interfaces and perform actions upon address changes. Passes .Sy ifwatchd_flags . .It Sy altq .Sq YES or .Sq NO . ALTQ configuration/monitoring daemon. Passes .Sy altqd_flags . .El .Ss Daemons required by other daemons .Bl -tag -width net_interfaces .It Sy inetd .Sq YES or .Sq NO . Runs the .Xr inetd 8 daemon to start network server processes (as listed in .Pa /etc/inetd.conf ) as necessary. Passes .Sy inetd_flags . The .Dq Li -l flag turns on libwrap connection logging. .It Sy rpcbind .Sq YES or .Sq NO . The .Xr rpcbind 8 daemon is required for any .Xr rpc 3 services. These include NFS, .Tn NIS , .Xr bootparamd 8 , .Xr rstatd 8 , .Xr rusersd 8 , and .Xr rwalld 8 . Passes .Sy rpcbind_flags . .El .Ss Commonly used daemons .Bl -tag -width net_interfaces .It Sy syslogd .Sq YES or .Sq NO . Runs .Xr syslogd 8 and passes .Sy syslogd_flags . .It Sy cron .Sq YES or .Sq NO . Run .Xr cron 8 . .It Sy named .Sq YES or .Sq NO . Runs .Xr named 8 and passes .Sy named_flags . .It Sy named_chrootdir A string. If non-blank and .Sy named is .Sq YES , run .Xr named 8 as the unprivileged user and group .Sq named , .Xr chroot 2 Ns ed to .Sy named_chrootdir . .Pa Sy named_chrootdir Ns /var/run/log will be added to the list of log sockets that .Xr syslogd 8 listens to. .It Sy timed .Sq YES or .Sq NO . Runs .Xr timed 8 and passes .Sy timed_flags . The .Dq Li -M option allows .Xr timed 8 to be a master time source as well as a slave. If you are also running .Xr ntpd 8 , only one machine running both should have the .Dq Li -M flag given to .Xr timed 8 . .It Sy ntpd .Sq YES or .Sq NO . Runs .Xr ntpd 8 and passes .Sy ntpd_flags . .It Sy ntpd_chrootdir A string. If non-blank and .Sy ntpd is .Sq YES , run .Xr ntpd 8 as the unprivileged user and group .Sq ntpd , .Xr chroot 2 Ns ed to .Sy ntpd_chrootdir . .Pa Sy ntpd_chrootdir Ns Pa /var/run/log will be added to the list of log sockets that .Xr syslogd 8 listens to. This option requires that the kernel has .Dl pseudo-device clockctl compiled in, and that .Pa /dev/clockctl is present. .It Sy sendmail .Sq YES or .Sq NO . Runs .Xr sendmail 8 and passes .Sy sendmail_flags . .It Sy postfix .Sq YES or .Sq NO . Starts .Xr postfix 1 mail system. .It Sy lpd .Sq YES or .Sq NO . Runs .Xr lpd 8 and passes .Sy lpd_flags . The .Dq Li -l flag will turn on extra logging. .It Sy sshd .Sq YES or .Sq NO . Runs .Xr sshd 8 and passes .Sy sshd_flags . .El .Ss Routing daemons .Bl -tag -width net_interfaces .It Sy routed .Sq YES or .Sq NO . Runs .Xr routed 8 , the RIP routing protocol daemon. Passes .Sy routed_flags . .\" This should be .\" .Sq NO .\" if .\" .Sy gated .\" is .\" .Sq YES . .It Sy mrouted .Sq YES or .Sq NO . Runs .Xr mrouted 8 , the DVMRP multicast routing protocol daemon. Passes .Sy mrouted_flags . .It Sy route6d .Sq YES or .Sq NO . Runs .Xr route6d 8 , the RIPng routing protocol daemon for IPv6. Passes .Sy route6d_flags . .It Sy rtsold .Sq YES or .Sq NO . Runs .Xr rtsold 8 , the IPv6 router solicitation daemon. .Xr rtsold 8 periodically transmits router solicitation packets to find IPv6 routers on the network. This configuration is mainly for nomadic hosts like notebook computers. Stationary hosts should work fine with just .Sy rtsol . Passes .Sy rtsold_flags . This is only for autoconfigured IPv6 hosts, so set .Sy ip6mode to .Dq Li autohost if you use it. .El .Ss Daemons used to boot other hosts over a network .Bl -tag -width net_interfaces .It Sy rarpd .Sq YES or .Sq NO . Runs .Xr rarpd 8 , the reverse ARP daemon, often used to boot .Nx and Sun workstations. Passes .Sy rarpd_flags . .It Sy bootparamd .Sq YES or .Sq NO . Runs .Xr bootparamd 8 , the boot parameter server, with .Sy bootparamd_flags as options. Used to boot .Nx and .Tn "SunOS 4.x" systems. .It Sy dhcpd .Sq YES or .Sq NO . Runs .Xr dhcpd 8 , the Dynamic Host Configuration Protocol (DHCP) daemon, for assigning IP addresses to hosts and passing boot information. Passes .Sy dhcpd_flags . .It Sy dhcrelay .Sq YES or .Sq NO . Runs .Xr dhcrelay 8 . Passes .Sy dhcrelay_flags . .It Sy rbootd .Sq YES or .Sq NO . Runs .Xr rbootd 8 , the .Tn HP boot protocol daemon; used for booting .Tn HP workstations. Passes .Sy rbootd_flags . .It Sy mopd .Sq YES or .Sq NO . Runs .Xr mopd 8 , the .Tn DEC .Tn MOP protocol daemon; used for booting .Tn VAX and other .Tn DEC machines. Passes .Sy mopd_flags . .It Sy ndbootd .Sq YES or .Sq NO . Runs .Xr ndbootd 8 , the Sun Network Disk (ND) Protocol server. Passes .Sy ndbootd_flags . .It Sy rtadvd .Sq YES or .Sq NO . Runs .Xr rtadvd 8 , the IPv6 router advertisement daemon, which is used to advertise information about the subnet to IPv6 end hosts. Passes .Sy rtadvd_flags . This is only for IPv6 routers, so set .Sy ip6mode to .Dq Li router if you use it. .El .Ss X Window System daemons .Bl -tag -width net_interfaces .It Sy xfs .Sq YES or .Sq NO . Runs the .Xr xfs 1 X11 font server, which supplies local X font files to X terminals. .It Sy xdm .Sq YES or .Sq NO . Runs the .Xr xdm 1 X display manager. These X daemons are available only with the optional X distribution of .Nx . .El .Ss NIS (YP) daemons .Bl -tag -width net_interfaces .It Sy ypbind .Sq YES or .Sq NO . Runs .Xr ypbind 8 , which lets .Tn NIS (YP) clients use information from a .Tn NIS server. Passes .Sy ypbind_flags . .It Sy ypserv .Sq YES or .Sq NO . Runs .Xr ypserv 8 , the .Tn NIS (YP) server for distributing information from certain files in .Pa /etc . Passes .Sy ypserv_flags . The .Dq Li -d flag causes it to use DNS for lookups in .Pa /etc/hosts that fail. .It Sy yppasswdd .Sq YES or .Sq NO . Runs .Xr yppasswdd 8 , which allows remote .Tn NIS users to update password on master server. Passes .Sy yppasswdd_flags . .El .Ss NFS daemons and parameters .Bl -tag -width net_interfaces .It Sy mountd .Sq YES or .Sq NO . Runs .Xr mountd 8 and passes .Sy mountd_flags . .It Sy nfs_client .Sq YES or .Sq NO . The number of local NFS asynchronous I/O server is now controlled via .Xr sysctl 8 . .It Sy nfs_server .Sq YES or .Sq NO . Sets up a host to be a NFS server by running .Xr nfsd 8 and passing .Sy nfsd_flags . .It Sy lockd .Sq YES or .Sq NO . Runs .Xr rpc.lockd 8 if .Sy nfs_server and/or .Sy nfs_client are set to .Sq YES . Passes .Sy lockd_flags . .It Sy statd .Sq YES or .Sq NO . Runs .Xr rpc.statd 8 , a status monitoring daemon used when .Xr rpc.lockd 8 is running, if .Sy nfs_server and/or .Sy nfs_client are set to .Sq YES . Passes .Sy statd_flags . .It Sy amd .Sq YES or .Sq NO . Runs .Xr amd 8 , the automounter daemon, which automatically mounts NFS file systems whenever a file or directory within that file system is accessed. Passes .Sy amd_flags . .It Sy amd_dir A string. The .Xr amd 8 mount directory. Used only if .Sy amd is set to .Sq YES . .El .Ss Other daemons .Bl -tag -width net_interfaces .It Sy kdc .Sq YES or .Sq NO . Runs the .Xr kdc 8 Kerberos v4 and v5 server. This should be run on Kerberos master and slave servers. .It Sy isdnd .Sq YES or .Sq NO . Runs .Xr isdnd 8 , the isdn4bsd ISDN connection management daemon. Passes .Sy isdnd_flags . .It Sy isdn_autoupdown .Sq YES or .Sq NO . Set all configured ISDN interfaces to .Dq up . If .Sy isdn_interfaces is not blank, only the listed interfaces will be modified. Used only if .Sy isdnd is set to .Sq YES . .It Sy rwhod .Sq YES or .Sq NO . Runs .Xr rwhod 8 to support the .Xr rwho 1 and .Xr ruptime 1 commands. .El .Ss Hardware daemons .Bl -tag -width net_interfaces .It Sy apmd .Sq YES or .Sq NO . Runs .Xr apmd 8 and passes .Sy apmd_flags . .It Sy poffd .Sq YES or .Sq NO . Runs .Xr poffd 8 x68k shutdown daemon (only for .Nx Ns /x86k ) . Passes .Sy poffd_flags . .It Sy screenblank .Sq YES or .Sq NO . Runs .Xr screenblank 1 and passes .Sy screenblank_flags . .It Sy moused .Sq YES or .Sq NO . Runs .Xr moused 8 , to pass serial mouse data to the wscons mouse mux. Passes .Sy moused_flags . .It Sy wscons .Sq YES or .Sq NO . Configures the .Xr wscons 4 console driver, from the configuration file .Pa /etc/wscons.conf . .It Sy wsmoused .Sq YES or .Sq NO . Runs .Xr wsmoused 8 , to provide copy and paste text support in wscons displays. Passes .Sy wsmoused_flags . .El .Sh FILES .Bl -tag -width /etc/defaults/rc.conf -compact .It Pa /etc/rc.conf The file .Nm resides in .Pa /etc . .It Pa /etc/defaults/rc.conf Default settings for .Nm "" , sourced by .Nm before the end-user configuration section. .It Pa /etc/rc.conf.d/ Ns Ar foo .Ar foo Ns No -specific .Nm overrides. .El .Sh SEE ALSO .Xr ifconfig.if 5 , .Xr boot 8 , .Xr rc 8 , .Xr rc.subr 8 , .Xr sysctl 8 .Sh HISTORY The .Nm file appeared in .Nx 1.3 .