xref: /netbsd-src/share/man/man5/rc.conf.5 (revision 9ddb6ab554e70fb9bbd90c3d96b812bc57755a14)
1.\"	$NetBSD: rc.conf.5,v 1.151 2012/01/08 04:01:12 dholland Exp $
2.\"
3.\" Copyright (c) 1996 Matthew R. Green
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Copyright (c) 1997 Curt J. Sampson
28.\" Copyright (c) 1997 Michael W. Long
29.\" Copyright (c) 1998-2010 The NetBSD Foundation, Inc.
30.\" All rights reserved.
31.\"
32.\" This document is derived from works contributed to The NetBSD Foundation
33.\" by Luke Mewburn.
34.\"
35.\" Redistribution and use in source and binary forms, with or without
36.\" modification, are permitted provided that the following conditions
37.\" are met:
38.\" 1. Redistributions of source code must retain the above copyright
39.\"    notice, this list of conditions and the following disclaimer.
40.\" 2. Redistributions in binary form must reproduce the above copyright
41.\"    notice, this list of conditions and the following disclaimer in the
42.\"    documentation and/or other materials provided with the distribution.
43.\" 3. The name of the author may not be used to endorse or promote products
44.\"    derived from this software without specific prior written permission.
45.\"
46.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
47.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
50.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
51.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
52.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
53.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
54.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56.\" SUCH DAMAGE.
57.\"
58.Dd June 1, 2011
59.Dt RC.CONF 5
60.Os
61.Sh NAME
62.Nm rc.conf
63.Nd system startup configuration file
64.Sh DESCRIPTION
65The
66.Nm
67file specifies which services are enabled during system startup by
68the startup scripts invoked by
69.Pa /etc/rc
70(see
71.Xr rc 8 ) ,
72and the shutdown scripts invoked by
73.Pa /etc/rc.shutdown .
74The
75.Nm
76file is a shell script that is sourced by
77.Xr rc 8 ,
78meaning that
79.Nm
80must contain valid shell commands.
81.Pp
82Listed below are the standard
83.Nm
84variables that may be set, the values to which each may be set,
85a brief description of what each variable does, and a reference to
86relevant manual pages.
87Third party packages may test for additional variables.
88.Pp
89By default,
90.Nm
91reads
92.Pa /etc/defaults/rc.conf
93(if it is readable)
94to obtain default values for various variables, and the end-user
95may override these by appending appropriate entries to the end of
96.Nm .
97.Pp
98.Xr rc.d 8
99scripts that use
100.Ic load_rc_config
101from
102.Xr rc.subr 8
103also support sourcing an optional end-user provided per-script override
104file
105.Pa /etc/rc.conf.d/ Ns Ar service ,
106(where
107.Ar service
108is the contents of the
109.Sy name
110variable in the
111.Xr rc.d 8
112script).
113This may contain variable overrides, including allowing the end-user
114to override various
115.Ic run_rc_command
116.Xr rc.d 8
117control variables, and thus changing the operation of the script
118without requiring editing of the script.
119.Ss Variable naming conventions and data types
120Most variables are one of two types: enabling variables or flags
121variables.
122Enabling variables, such as
123.Sy inetd ,
124are generally named after the program or the system they enable,
125and have boolean values (specified using
126.Sq Ic YES ,
127.Sq Ic TRUE ,
128.Sq Ic ON
129or
130.Sq Ic 1
131for true, and
132.Sq Ic NO ,
133.Sq Ic FALSE ,
134.Sq Ic OFF
135or
136.Sq Ic 0
137for false, with the values being case insensitive).
138Flags variables, such as
139.Sy inetd_flags
140have the same name with "_flags" appended, and determine what
141arguments are passed to the program if it is enabled.
142.Pp
143If a variable that
144.Xr rc 8
145expects to be set is not set, or the value is not one of the allowed
146values, a warning will be printed.
147.Ss Overall control
148.Bl -tag -width net_interfaces
149.It Sy do_rcshutdown
150Boolean value.
151If false,
152.Xr shutdown 8
153will not run
154.Pa /etc/rc.shutdown .
155.It Sy rcshutdown_rcorder_flags
156A string.
157Extra arguments to the
158.Xr rcorder 8
159run by
160.Pa /etc/rc.shutdown .
161.It Sy rcshutdown_timeout
162A number.
163If non-blank, use this as the number of seconds to run a watchdog timer for
164which will terminate
165.Pa /etc/rc.shutdown
166if the timer expires before the shutdown script completes.
167.It Sy rc_configured
168Boolean value.
169If false then the system will drop into single-user mode during boot.
170.It Sy rc_fast_and_loose
171If set to a non-empty string,
172each script in
173.Pa /etc/rc.d
174will be executed in the current shell rather than a sub shell.
175This may be faster on slow machines that have an expensive
176.Xr fork 2
177operation.
178.Bl -hang
179.It Em Note :
180Use this at your own risk!
181A rogue command or script may inadvertently prevent boot to multiuser.
182.El
183.It Sy rc_rcorder_flags
184A string.
185Extra arguments to the
186.Xr rcorder 8
187run by
188.Pa /etc/rc .
189.It Sy rc_directories
190A string.
191Space separated list of directories searched for rc scripts.
192The default is
193.Pa /etc/rc.d .
194All directories in
195.Ev rc_directories
196must be located in the root filesystem, otherwise they will be silently
197skipped.
198.It Sy rc_silent
199Boolean value.
200If true then the usual output is suppressed, and
201.Xr rc 8
202invokes the command specified in the
203.Va rc_silent_cmd
204variable once for each line of suppressed output.
205The default value of
206.Va rc_silent
207is set from the
208.Dv AB_SILENT
209flag in the kernel's
210.Va boothowto
211variable (see
212.Xr boot 8 ,
213.Xr reboot 2 ) .
214.It Sy rc_silent_cmd
215A command to be executed once per line of suppressed output, when
216.Va rc_silent
217is true.
218The default value of
219.Va rc_silent_cmd
220is
221.Dq twiddle ,
222which will display a spinning symbol instead of each line of output.
223Another useful value is
224.Dq \&: ,
225which will display nothing at all.
226.El
227.Ss Basic network configuration
228.Bl -tag -width net_interfaces
229.It Sy defaultroute
230A string.
231Default IPv4 network route.
232If empty or not set, then the contents of
233.Pa /etc/mygate
234(if it exists) are used.
235.It Sy defaultroute6
236A string.
237Default IPv6 network route.
238If empty or not set, then the contents of
239.Pa /etc/mygate6
240(if it exists) are used.
241.It Sy domainname
242A string.
243.Tn NIS
244(YP) domain of host.
245If empty or not set, then the contents of
246.Pa /etc/defaultdomain
247(if it exists) are used.
248.It Sy force_down_interfaces
249A space separated list of interface names.
250These interfaces will be configured down when going from multiuser to singleuser
251mode or on system shutdown.
252.Pp
253This is important for some stateful interfaces, for example PPP over ISDN
254connections that cost money by connection time or PPPoE interfaces which
255have no direct means of noticing
256.Dq disconnect
257events.
258.Pp
259All active
260.Xr pppoe 4
261and
262.Xr ippp 4
263interfaces will be automatically added to this list.
264.It Sy hostname
265A string.
266Name of host.
267If empty or not set, then the contents of
268.Pa /etc/myname
269(if it exists) are used.
270.El
271.Ss Boottime file-system and swap configuration
272.Bl -tag -width net_interfaces
273.It Sy critical_filesystems_local
274A string.
275File systems mounted very early in the system boot before networking
276services are available.
277Usually
278.Pa /var
279is part of this, because it is needed by services such as
280.Xr dhclient 8
281which may be required to get the network operational.
282The default is
283.Dq "OPTIONAL:/var" ,
284where the
285.Dq OPTIONAL:
286prefix means that it's not an error if the file system is not
287present in
288.Xr fstab 5 .
289.It Sy critical_filesystems_remote
290A string.
291File systems such as
292.Pa /usr
293that may require network services to be available to mount,
294that must be available early in the system boot for general services to use.
295The default is
296.Dq "OPTIONAL:/usr" ,
297where the
298.Dq OPTIONAL:
299prefix means that it is not an error if the file system is not
300present in
301.Xr fstab 5 .
302.It Sy fsck_flags
303A string.
304A file system is checked with
305.Xr fsck 8
306during boot before mounting it.
307This option may be used to override the default command-line options
308passed to the
309.Xr fsck 8
310program.
311.Pp
312When set to
313.Fl y ,
314.Xr fsck 8
315assumes yes as the answer to all operator questions during file system checks.
316This might be important with hosts where the administrator does not have
317access to the console and an unsuccessful shutdown must not make the host
318unbootable even if the file system checks would fail in preen mode.
319.It Sy no_swap
320Boolean value.
321Should be true if you have deliberately configured your system with no swap.
322If false and no swap devices are configured, the system will warn you.
323.It Sy swapoff
324Boolean value.
325Remove block-type swap devices at shutdown time.
326Useful if swapping onto RAIDframe devices.
327.El
328.Ss One-time actions to perform or programs to run on boot-up
329.Bl -tag -width net_interfaces
330.It Sy accounting
331Boolean value.
332Enables process accounting with
333.Xr accton 8 .
334Requires
335.Pa /var/account/acct
336to exist.
337.It Sy ccd
338Boolean value.
339Configures concatenated disk devices according to
340.Xr ccd.conf 5 .
341.It Sy cgd
342Boolean value.
343Configures cryptographic disk devices.
344Requires
345.Pa /etc/cgd/cgd.conf .
346See
347.Xr cgdconfig 8
348for additional details.
349.It Sy clear_tmp
350Boolean value.
351Clear
352.Pa /tmp
353after reboot.
354.It Sy dmesg
355Boolean value.
356Create
357.Pa /var/run/dmesg.boot
358from the output of
359.Xr dmesg 8 .
360Passes
361.Sy dmesg_flags .
362.It Sy envsys
363Boolean value.
364Sets preferences for the environmental systems framework,
365.Xr envsys 4 .
366Requires
367.Pa /etc/envsys.conf ,
368which is described in
369.Xr envsys.conf 5 .
370.It Sy gpio
371Boolean value.
372Configure
373.Xr gpio 4
374devices.
375See
376.Xr gpio.conf 5 .
377.It Sy ldconfig
378Boolean value.
379Configures
380.Xr a.out 5
381runtime link editor directory cache.
382.It Sy mixerctl
383Boolean value.
384Read
385.Xr mixerctl.conf 5
386for how to set mixer values.
387List in
388.Sy mixerctl_mixers
389the devices whose settings are to be saved at shutdown and
390restored at start-up.
391.It Sy newsyslog
392Boolean value.
393Run
394.Nm newsyslog
395to trim logfiles before syslogd starts.
396Intended for laptop users.
397Passes
398.Sy newsyslog_flags .
399.It Sy per_user_tmp
400Boolean value.
401Enables a per-user
402.Pa /tmp
403directory.
404.Sy per_user_tmp_dir
405can be used to override the default location of the
406.Dq real
407temporary directories,
408.Dq Pa /private/tmp .
409See
410.Xr security 7
411for additional details.
412.It Sy quota
413Boolean value.
414Checks and enables quotas by running
415.Xr quotacheck 8
416and
417.Xr quotaon 8 .
418.It Sy raidframe
419Boolean value.
420Configures
421.Xr raid 4 ,
422RAIDframe disk devices.
423See
424.Xr raidctl 8
425for additional details.
426.It Sy rndctl
427Boolean value.
428Runs the
429.Xr rndctl 8
430utility one or more times according to the specification in
431.Sy rndctl_flags .
432.Pp
433If
434.Sy rndctl_flags
435does not contain a semicolon
436.Pq Ql \&;
437then it is expected to contain zero or more flags,
438followed by one or more device or type names.
439The
440.Xr rndctl 8
441command will be executed once for each device or type name.
442If the specified flags do not include any of
443.Fl c , C , e ,
444or
445.Fl E ,
446then the flags
447.Fl c
448and
449.Fl e
450are added, to specify that entropy from the relevant device or type
451should be both collected and estimated.
452If the specified flags do not include either of
453.Fl d
454or
455.Fl t ,
456then the flag
457.Fl d
458is added, to specify that the non-flag arguments are device names,
459not type names.
460.Pp
461.Sy rndctl_flags
462may contain multiple semicolon-separated segments, in which each
463segment contains flags and device or type names as described above.
464This allows different flags to be associated with different
465device or type names.
466For example, given
467.Li rndctl_flags="wd0 wd1; -t tty; -c -t net" ,
468the following commands will be executed:
469.Li "rndctl -c -e -d wd0" ;
470.Li "rndctl -c -e -d wd1" ;
471.Li "rndctl -c -e -t tty" ;
472.Li "rndctl -c -t net" .
473.It Sy rtclocaltime
474Boolean value.
475Sets the real time clock to local time by adjusting the
476.Xr sysctl 7
477value of
478.Pa kern.rtc_offset .
479The offset from UTC is calculated automatically according
480to the time zone information in the file
481.Pa /etc/localtime .
482.It Sy savecore
483Boolean value.
484Runs the
485.Xr savecore 8
486utility.
487Passes
488.Sy savecore_flags .
489The directory where crash dumps are stored is specified by
490.Sy savecore_dir .
491The default setting is
492.Dq Pa /var/crash .
493.It Sy sysdb
494Boolean value.
495Builds various system databases, including
496.Pa /var/run/dev.db ,
497.Pa /etc/spwd.db ,
498.Pa /var/db/netgroup.db ,
499.Pa /var/db/services.db ,
500and entries for
501.Xr utmp 5 .
502.It Sy tpctl
503Boolean value.
504Run
505.Xr tpctl 8
506to calibrate touch panel device.
507Passes
508.Sy tpctl_flags .
509.It Sy update_motd
510Boolean value.
511Updates the
512.Nx
513version string in the
514.Pa /etc/motd
515file to reflect the version of the running kernel.
516See
517.Xr motd 5 .
518.It Sy veriexec
519Boolean value.
520Load Veriexec fingerprints during startup.
521Read
522.Xr veriexecctl 8
523for more information.
524.It Sy virecover
525Boolean value.
526Send notification mail to users if any recoverable files exist in
527.Pa /var/tmp/vi.recover .
528Read
529.Xr virecover 8
530for more information.
531.It Sy wdogctl
532Boolean value.
533Configures watchdog timers.
534Passes
535.Sy wdogctl_flags .
536Refer to
537.Xr wdogctl 8
538for information on how to configure a timer.
539.El
540.Ss System security setting
541.Bl -tag -width net_interfaces
542.It Sy securelevel
543A number.
544The system securelevel is set to the specified value early
545in the boot process, before any external logins, or other programs
546that run users job, are started.
547If set to nothing, the default action is taken, as described in
548.Xr init 8
549and
550.Xr secmodel_securelevel 9 ,
551which contains definitive information about the system securelevel.
552Note that setting
553.Sy securelevel
554to 0 in
555.Nm
556will actually result in the system booting with securelevel set to 1, as
557.Xr init 8
558will raise the level when
559.Xr rc 8
560completes.
561.It Sy permit_nonalpha
562Allow passwords to include non-alpha characters, usually to allow
563NIS/YP netgroups.
564.It Sy veriexec_strict
565A number.
566Controls the strict level of Veriexec.
567Level 0 is learning mode, used when building the signatures file.
568It will only output messages but will not enforce anything.
569Level 1 will only prevent access to files with a fingerprint
570mismatch.
571Level 2 will also deny writing to and removing of
572monitored files, as well as enforce access type (as specified in
573the signatures file).
574Level 3 will take a step further and prevent
575access to files that are not monitored.
576.It Sy veriexec_verbose
577A number.
578Controls the verbosity of Veriexec.
579Recommended operation is at level 0, verbose output (mostly used when
580building the signatures file) is at level 1.
581Level 2 is for debugging only and should not be used.
582.It Sy veriexec_flags
583A string.
584Flags to pass to the
585.Nm veriexecctl
586command.
587.El
588.Ss Networking startup
589.Bl -tag -width net_interfaces
590.It Sy altqd
591Boolean value.
592ALTQ configuration/monitoring daemon.
593Passes
594.Sy altqd_flags .
595.It Sy auto_ifconfig
596Boolean value.
597Sets the
598.Sy net_interfaces
599variable (see below) to the output of
600.Xr ifconfig 8
601with the
602.Dq Li -l
603flag and suppresses warnings about interfaces in this list that
604do not have an ifconfig file or variable.
605.It Sy dhclient
606Boolean value.
607Set true to configure some or all network interfaces using
608the ISC DHCP client.
609If you set
610.Sy dhclient
611true, then
612.Pa /var
613must be in
614.Sy critical_filesystems_local ,
615or
616.Pa /var
617must be on the root file system,
618or you must modify the
619.Sy dhclient_flags
620variable to direct the DHCP client to store the leases file
621in some other directory on the root file system.
622You must not provide ifconfig information or ifaliases
623information for any interface that is to be configured using the DHCP client.
624Interface aliases can be set up in the DHCP client configuration
625file if needed - see
626.Xr dhclient.conf 5
627for details.
628.Pp
629Passes
630.Sy dhclient_flags
631to the DHCP client.
632See
633.Xr dhclient 8
634for complete documentation.
635If you wish to configure all broadcast
636network interfaces using the DHCP client, you can leave this blank.
637To configure only specific interfaces, name the interfaces to be configured
638on the command line.
639.Pp
640If you must run the DHCP client before mounting critical file systems,
641then you should specify an alternate location for the DHCP client's lease
642file in the
643.Sy dhclient_flags
644variable - for example, "-lf /tmp/dhclient.leases".
645.It Sy dhcpcd_flags
646Additional arguments to pass to
647.Xr dhcpcd 8
648when requesting configuration via
649.Sy ifconfig_xxN
650or
651.Pa /etc/ifconfig.xxN .
652.It Sy flushroutes
653Boolean value.
654Flushes the route table on networking startup.
655Useful when coming up to multiuser mode after going down to
656single-user mode.
657.It Sy ftp_proxy
658Boolean value.
659Runs
660.Xr ftp-proxy 8 ,
661the proxy daemon for the Internet File Transfer Protocol.
662.It Sy hostapd
663Boolean value.
664Runs
665.Xr hostapd 8 ,
666the authenticator for IEEE 802.11 networks.
667.It Sy ifaliases_*
668A string.
669List of
670.Sq Em "address netmask"
671pairs to configure additional network addresses for the given
672configured interface
673.Dq *
674(e.g.
675.Sy ifaliases_le0 ) .
676If
677.Em netmask
678is
679.Dq - ,
680then use the default netmask for the interface.
681.Pp
682.Sy ifaliases_*
683covers limited cases only and is considered unrecommended.
684We recommend using
685.Sy ifconfig_nnX
686variables or
687.Pa /etc/ifconfig.xxN
688files with multiple lines instead.
689.It Sy ifwatchd
690Boolean value.
691Monitor dynamic interfaces and perform actions upon address changes.
692Passes
693.Sy ifwatchd_flags .
694.It Sy ip6mode
695A string.
696An IPv6 node can be a router
697.Pq nodes that forward packet for others
698or a host
699.Pq nodes that do not forward .
700A host can be autoconfigured
701based on the information advertised by adjacent IPv6 routers.
702By setting
703.Sy ip6mode
704to
705.Dq Li router ,
706.Dq Li host ,
707or
708.Dq Li autohost ,
709you can configure your node as a router,
710a non-autoconfigured host, or an autoconfigured host.
711Invalid values will be ignored, and the node will be configured as
712a non-autoconfigured host.
713You may want to check
714.Sy rtsol
715and
716.Sy rtsold
717as well, if you set the variable to
718.Dq Li autohost .
719.It Sy ip6uniquelocal
720Boolean value.
721If
722.Sy ip6mode
723is equal to
724.Dq Li router ,
725and
726.Sy ip6uniquelocal
727is false,
728a reject route will be installed on boot to avoid misconfiguration relating
729to unique-local addresses.
730If
731.Sy ip6uniquelocal
732is true, the reject route won't be installed.
733.It Sy ipfilter
734Boolean value.
735Runs
736.Xr ipf 8
737to load in packet filter specifications from
738.Pa /etc/ipf.conf
739at network boot time, before any interfaces are configured.
740Passes
741.Sy ipfilter_flags .
742See
743.Xr ipf.conf 5 .
744.It Sy ipfs
745Boolean value.
746Runs
747.Xr ipfs 8
748to save and restore information for ipnat and ipfilter state tables.
749The information is stored in
750.Pa /var/db/ipf/ipstate.ipf
751and
752.Pa /var/db/ipf/ipnat.ipf .
753Passes
754.Sy ipfs_flags .
755.It Sy ipmon
756Boolean value.
757Runs
758.Xr ipmon 8
759to read
760.Xr ipf 8
761packet log information and log it to a file or the system log.
762Passes
763.Sy ipmon_flags .
764.It Sy ipmon_flags
765A string.
766Specifies arguments to supply to
767.Xr ipmon 8 .
768Defaults to
769.Dq Li -ns .
770A typical example would be
771.Dq Fl nD Pa /var/log/ipflog
772to have
773.Xr ipmon 8
774log directly to a file bypassing
775.Xr syslogd 8 .
776If the
777.Dq -D
778argument is used, remember to modify
779.Pa /etc/newsyslog.conf
780accordingly; for example:
781.Bd -literal
782/var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
783.Ed
784.It Sy ipnat
785Boolean value.
786Runs
787.Xr ipnat 8
788to load in the IP network address translation (NAT) rules from
789.Pa /etc/ipnat.conf
790at network boot time, before any interfaces are configured.
791See
792.Xr ipnat.conf 5 .
793.It Sy ipsec
794Boolean value.
795Runs
796.Xr setkey 8
797to load in IPsec manual keys and policies from
798.Pa /etc/ipsec.conf
799at network boot time, before any interfaces are configured.
800.It Sy net_interfaces
801A string.
802The list of network interfaces to be configured at boot time.
803For each interface "xxN", the system first looks for ifconfig
804parameters in the variable
805.Sy ifconfig_xxN ,
806and then in the file
807.Pa /etc/ifconfig.xxN .
808If
809.Sy auto_ifconfig
810is false, and neither the variable nor the file is found,
811a warning is printed.
812Information in either the variable or the file is parsed identically,
813except that, if an
814.Sy ifconfig_xxN
815variable contains a single line with embedded semicolons,
816then the value is split into multiple lines prior to further parsing,
817treating the semicolon as a line separator.
818.Pp
819One common case is to set
820.Sy ifconfig_xxN Ns Li \&= Ns Qq dhcp ,
821which will cause
822.Xr dhcpcd 8
823to be started for the interface.
824Another common case it to set the
825.Sy ifconfig_xxN
826variable to a set of arguments to be passed to an
827.Xr ifconfig 8
828command after the interface name.
829Refer to
830.Xr ifconfig.if 5
831for more details on
832.Pa /etc/ifconfig.xxN
833files, and note that the information there also applies to
834.Sy ifconfig_xxN
835variables (after the variables are split into lines).
836.It Sy ntpdate
837Boolean value.
838Runs
839.Xr ntpdate 8
840to set the system time from one of the hosts in
841.Sy ntpdate_hosts .
842If
843.Sy ntpdate_hosts
844is empty, it will attempt to find a list of hosts in
845.Pa /etc/ntp.conf .
846Passes
847.Sy ntpdate_flags .
848.It Sy pf
849Boolean value.
850Enable
851.Xr pf 4
852at network boot time:
853Load the initial configuration
854.Xr pf.boot.conf 5
855before the network is up.
856After the network has been configured, then load the final ruleset
857.Xr pf.conf 5 .
858.It Sy pf_rules
859A string.
860The path of the
861.Xr pf.conf 5
862ruleset that will be used when loading the final ruleset.
863.It Sy pflogd
864Boolean value.
865Run
866.Xr pflogd 8
867for dumping packet filter logging information to a file.
868.It Sy ppp_peers
869A string.
870If
871.Sy ppp_peers
872is not empty, then
873.Pa /etc/rc.d/ppp
874will check each word in
875.Sy ppp_peers
876for a corresponding ppp configuration file in
877.Pa /etc/ppp/peers
878and will call
879.Xr pppd 8
880with the
881.Dq call Sy peer
882option.
883.It Sy racoon
884Boolean value.
885Runs
886.Xr racoon 8 ,
887the IKE (ISAKMP/Oakley) key management daemon.
888.It Sy rtsol
889Boolean value.
890Run
891.Xr rtsol 8 ,
892router solicitation command for IPv6 hosts.
893On nomadic hosts like notebook computers, you may want to enable
894.Sy rtsold
895as well.
896Passes
897.Sy rtsol_flags .
898This is only for autoconfigured IPv6 hosts, so set
899.Sy ip6mode
900to
901.Dq Li autohost
902if you use it.
903.It Sy wpa_supplicant
904Boolean value.
905Run
906.Xr wpa_supplicant 8 ,
907WPA/802.11i Supplicant for wireless network devices.
908If you set
909.Sy wpa_supplicant
910true, then
911.Pa /usr
912must be in
913.Sy critical_filesystems_local ,
914or
915.Pa /usr
916must be on the root file system.
917.El
918.Ss Daemons required by other daemons
919.Bl -tag -width net_interfaces
920.It Sy inetd
921Boolean value.
922Runs the
923.Xr inetd 8
924daemon to start network server processes (as listed in
925.Pa /etc/inetd.conf )
926as necessary.
927Passes
928.Sy inetd_flags .
929The
930.Dq Li -l
931flag turns on libwrap connection logging.
932.It Sy rpcbind
933Boolean value.
934The
935.Xr rpcbind 8
936daemon is required for any
937.Xr rpc 3
938services.
939These include NFS,
940.Tn NIS ,
941.Xr rpc.bootparamd 8 ,
942.Xr rpc.rstatd 8 ,
943.Xr rpc.rusersd 8 ,
944and
945.Xr rpc.rwalld 8 .
946Passes
947.Sy rpcbind_flags .
948.El
949.Ss Commonly used daemons
950.Bl -tag -width net_interfaces
951.It Sy cron
952Boolean value.
953Run
954.Xr cron 8 .
955.It Sy ftpd
956Runs the
957.Xr ftpd 8
958daemon and passes
959.Sy ftpd_flags .
960.It Sy httpd
961Boolean value.
962Runs the
963.Xr httpd 8
964daemon and passes
965.Sy httpd_flags .
966.It Sy httpd_wwwdir
967A string.
968The
969.Xr httpd 8
970WWW root directory.
971Used only if
972.Sy httpd
973is true.
974The default setting is
975.Dq Pa /var/www .
976.It Sy httpd_wwwuser
977A string.
978If non-blank and
979.Sy httpd
980is true, run
981.Xr httpd 8
982and cause it to switch to the specified user after initialization.
983It is preferred to
984.Sy httpd_user
985because
986.Xr httpd 8
987is requiring extra privileges to start listening on default port 80.
988The default setting is
989.Dq Dv _httpd .
990.It Sy lpd
991Boolean value.
992Runs
993.Xr lpd 8
994and passes
995.Sy lpd_flags .
996The
997.Dq Li -l
998flag will turn on extra logging.
999.It Sy mdnsd
1000Boolean value.
1001Runs
1002.Xr mdnsd 8 .
1003.It Sy named
1004Boolean value.
1005Runs
1006.Xr named 8
1007and passes
1008.Sy named_flags .
1009.It Sy named_chrootdir
1010A string.
1011If non-blank and
1012.Sy named
1013is true, run
1014.Xr named 8
1015as the unprivileged user and group
1016.Sq named ,
1017.Xr chroot 2 Ns ed
1018to
1019.Sy named_chrootdir .
1020.Sy named_chrootdir Ns Pa /var/run/log
1021will be added to the list of log sockets that
1022.Xr syslogd 8
1023listens to.
1024.It Sy ntpd
1025Boolean value.
1026Runs
1027.Xr ntpd 8
1028and passes
1029.Sy ntpd_flags .
1030.It Sy ntpd_chrootdir
1031A string.
1032If non-blank and
1033.Sy ntpd
1034is true, run
1035.Xr ntpd 8
1036as the unprivileged user and group
1037.Sq ntpd ,
1038.Xr chroot 2 Ns ed
1039to
1040.Sy ntpd_chrootdir .
1041.Sy ntpd_chrootdir Ns Pa /var/run/log
1042will be added to the list of log sockets that
1043.Xr syslogd 8
1044listens to.
1045This option requires that the kernel has
1046.Dl pseudo-device clockctl
1047compiled in, and that
1048.Pa /dev/clockctl
1049is present.
1050.It Sy postfix
1051Boolean value.
1052Starts
1053.Xr postfix 1
1054mail system.
1055.It Sy sshd
1056Boolean value.
1057Runs
1058.Xr sshd 8
1059and passes
1060.Sy sshd_flags .
1061.It Sy syslogd
1062Boolean value.
1063Runs
1064.Xr syslogd 8
1065and passes
1066.Sy syslogd_flags .
1067.It Sy timed
1068Boolean value.
1069Runs
1070.Xr timed 8
1071and passes
1072.Sy timed_flags .
1073The
1074.Dq Li -M
1075option allows
1076.Xr timed 8
1077to be a master time source as well as a slave.
1078If you are also running
1079.Xr ntpd 8 ,
1080only one machine running both should have the
1081.Dq Li -M
1082flag given to
1083.Xr timed 8 .
1084.El
1085.Ss Routing daemons
1086.Bl -tag -width net_interfaces
1087.It Sy mrouted
1088Boolean value.
1089Runs
1090.Xr mrouted 8 ,
1091the DVMRP multicast routing protocol daemon.
1092Passes
1093.Sy mrouted_flags .
1094.It Sy route6d
1095Boolean value.
1096Runs
1097.Xr route6d 8 ,
1098the RIPng routing protocol daemon for IPv6.
1099Passes
1100.Sy route6d_flags .
1101.It Sy routed
1102Boolean value.
1103Runs
1104.Xr routed 8 ,
1105the RIP routing protocol daemon.
1106Passes
1107.Sy routed_flags .
1108.\" This should be false
1109.\" if
1110.\" .Sy gated
1111.\" is true.
1112.It Sy rtsold
1113Boolean value.
1114Runs
1115.Xr rtsold 8 ,
1116the IPv6 router solicitation daemon.
1117.Xr rtsold 8
1118periodically transmits router solicitation packets
1119to find IPv6 routers on the network.
1120This configuration is mainly for nomadic hosts like notebook computers.
1121Stationary hosts should work fine with just
1122.Sy rtsol .
1123Passes
1124.Sy rtsold_flags .
1125This is only for autoconfigured IPv6 hosts, so set
1126.Sy ip6mode
1127to
1128.Dq Li autohost
1129if you use it.
1130.El
1131.Ss Daemons used to boot other hosts over a network
1132.Bl -tag -width net_interfaces
1133.It Sy bootparamd
1134Boolean value.
1135Runs
1136.Xr bootparamd 8 ,
1137the boot parameter server, with
1138.Sy bootparamd_flags
1139as options.
1140Used to boot
1141.Nx
1142and
1143.Tn "SunOS 4.x"
1144systems.
1145.It Sy dhcpd
1146Boolean value.
1147Runs
1148.Xr dhcpd 8 ,
1149the Dynamic Host Configuration Protocol (DHCP) daemon,
1150for assigning IP addresses to hosts and passing boot information.
1151Passes
1152.Sy dhcpd_flags .
1153.It Sy dhcrelay
1154Boolean value.
1155Runs
1156.Xr dhcrelay 8 .
1157Passes
1158.Sy dhcrelay_flags .
1159.It Sy mopd
1160Boolean value.
1161Runs
1162.Xr mopd 8 ,
1163the
1164.Tn DEC
1165.Tn MOP
1166protocol daemon; used for booting
1167.Tn VAX
1168and other
1169.Tn DEC
1170machines.
1171Passes
1172.Sy mopd_flags .
1173.It Sy ndbootd
1174Boolean value.
1175Runs
1176.Xr ndbootd 8 ,
1177the Sun Network Disk (ND) Protocol server.
1178Passes
1179.Sy ndbootd_flags .
1180.It Sy rarpd
1181Boolean value.
1182Runs
1183.Xr rarpd 8 ,
1184the reverse ARP daemon, often used to boot
1185.Nx
1186and Sun workstations.
1187Passes
1188.Sy rarpd_flags .
1189.It Sy rbootd
1190Boolean value.
1191Runs
1192.Xr rbootd 8 ,
1193the
1194.Tn HP
1195boot protocol daemon; used for booting
1196.Tn HP
1197workstations.
1198Passes
1199.Sy rbootd_flags .
1200.It Sy rtadvd
1201Boolean value.
1202Runs
1203.Xr rtadvd 8 ,
1204the IPv6 router advertisement daemon, which is used to advertise
1205information about the subnet to IPv6 end hosts.
1206Passes
1207.Sy rtadvd_flags .
1208This is only for IPv6 routers, so set
1209.Sy ip6mode
1210to
1211.Dq Li router
1212if you use it.
1213.El
1214.Ss X Window System daemons
1215.Bl -tag -width net_interfaces
1216.It Sy xdm
1217Boolean value.
1218Runs the
1219.Xr xdm 1
1220X display manager.
1221These X daemons are available only with the optional X distribution of
1222.Nx .
1223.It Sy xfs
1224Boolean value.
1225Runs the
1226.Xr xfs 1
1227X11 font server, which supplies local X font files to X terminals.
1228.El
1229.Ss NIS (YP) daemons
1230.Bl -tag -width net_interfaces
1231.It Sy ypbind
1232Boolean value.
1233Runs
1234.Xr ypbind 8 ,
1235which lets
1236.Tn NIS
1237(YP) clients use information from a
1238.Tn NIS
1239server.
1240Passes
1241.Sy ypbind_flags .
1242.It Sy yppasswdd
1243Boolean value.
1244Runs
1245.Xr yppasswdd 8 ,
1246which allows remote
1247.Tn NIS
1248users to update password on master server.
1249Passes
1250.Sy yppasswdd_flags .
1251.It Sy ypserv
1252Boolean value.
1253Runs
1254.Xr ypserv 8 ,
1255the
1256.Tn NIS
1257(YP) server for distributing information from certain files in
1258.Pa /etc .
1259Passes
1260.Sy ypserv_flags .
1261The
1262.Dq Li -d
1263flag causes it to use DNS for lookups in
1264.Pa /etc/hosts
1265that fail.
1266.El
1267.Ss NFS daemons and parameters
1268.Bl -tag -width net_interfaces
1269.It Sy amd
1270Boolean value.
1271Runs
1272.Xr amd 8 ,
1273the automounter daemon, which automatically mounts NFS file systems
1274whenever a file or directory within that file system is accessed.
1275Passes
1276.Sy amd_flags .
1277.It Sy amd_dir
1278A string.
1279The
1280.Xr amd 8
1281mount directory.
1282Used only if
1283.Sy amd
1284is true.
1285.It Sy lockd
1286Boolean value.
1287Runs
1288.Xr rpc.lockd 8
1289if
1290.Sy nfs_server
1291and/or
1292.Sy nfs_client
1293are true.
1294Passes
1295.Sy lockd_flags .
1296.It Sy mountd
1297Boolean value.
1298Runs
1299.Xr mountd 8
1300and passes
1301.Sy mountd_flags .
1302.It Sy nfs_client
1303Boolean value.
1304The number of local NFS asynchronous I/O server is now controlled via
1305.Xr sysctl 8 .
1306.It Sy nfs_server
1307Boolean value.
1308Sets up a host to be a NFS server by running
1309.Xr nfsd 8
1310and passing
1311.Sy nfsd_flags .
1312.It Sy statd
1313Boolean value.
1314Runs
1315.Xr rpc.statd 8 ,
1316a status monitoring daemon used when
1317.Xr rpc.lockd 8
1318is running, if
1319.Sy nfs_server
1320and/or
1321.Sy nfs_client
1322are true.
1323Passes
1324.Sy statd_flags .
1325.El
1326.Ss Bluetooth support
1327.Bl -tag -width net_interfaces
1328.It Sy bluetooth
1329Boolean value.
1330Configure Bluetooth support, comprising the following tasks:
1331.Bl -dash -compact
1332.It
1333attach serial Bluetooth controllers as listed in the
1334.Pa /etc/bluetooth/btdevctl.conf
1335configuration file.
1336.It
1337enable Bluetooth controllers with useful defaults, plus
1338additional options as detailed below.
1339.It
1340optionally, start
1341.Xr bthcid 8 ,
1342the Bluetooth Link Key/PIN Code manager, passing
1343.Sy bthcid_flags .
1344.It
1345configure local Bluetooth drivers as listed in the
1346.Pa /etc/bluetooth/btdevctl.conf
1347configuration file.
1348.It
1349optionally, start
1350.Xr sdpd 8 ,
1351the Service Discovery server, passing
1352.Sy sdpd_flags .
1353.El
1354.It Sy btconfig_devices
1355A string.
1356An optional list of Bluetooth controllers to configure.
1357.It Sy btconfig_{dev}
1358A string.
1359Additional configuration options for specific Bluetooth controllers.
1360.It Sy btconfig_args
1361A string.
1362Additional configuration options for Bluetooth controllers without
1363specific options as above.
1364.It Sy bthcid
1365Boolean value.
1366If set to false, disable starting the Bluetooth Link Key/PIN Code manager.
1367.It Sy sdpd
1368Boolean value.
1369If set to false, disable starting the Bluetooth Service Discovery server.
1370.El
1371.Ss Other daemons
1372.Bl -tag -width net_interfaces
1373.It Sy identd
1374Boolean value.
1375Runs
1376.Xr identd 8 ,
1377the daemon for the user identification protocol.
1378Passes
1379.Sy identd_flags .
1380.It Sy iscsi_target
1381Boolean value.
1382Runs the server for iSCSI requests,
1383.Xr iscsi-target 8 .
1384Passes
1385.Sy iscsi_target_flags .
1386.It Sy isdnd
1387Boolean value.
1388Runs
1389.Xr isdnd 8 ,
1390the isdn4bsd ISDN connection management daemon.
1391Passes
1392.Sy isdnd_flags .
1393.It Sy isdn_autoupdown
1394Boolean value.
1395Set all configured ISDN interfaces to
1396.Dq up .
1397If
1398.Sy isdn_interfaces
1399is not blank, only the listed interfaces will be modified.
1400Used only if
1401.Sy isdnd
1402is true.
1403.It Sy kdc
1404Boolean value.
1405Runs the
1406.Xr kdc 8
1407Kerberos v4 and v5 server.
1408This should be run on Kerberos master and slave servers.
1409.It Sy rwhod
1410Boolean value.
1411Runs
1412.Xr rwhod 8
1413to support the
1414.Xr rwho 1
1415and
1416.Xr ruptime 1
1417commands.
1418.El
1419.Ss Hardware daemons
1420.Bl -tag -width net_interfaces
1421.It Sy apmd
1422Boolean value.
1423Runs
1424.Xr apmd 8
1425and passes
1426.Sy apmd_flags .
1427.It Sy irdaattach
1428Boolean value.
1429Runs
1430.Xr irdaattach 8
1431and passes
1432.Sy irdaattach_flags .
1433.It Sy moused
1434Boolean value.
1435Runs
1436.Xr moused 8 ,
1437to pass serial mouse data to the wscons mouse mux.
1438Passes
1439.Sy moused_flags .
1440.It Sy screenblank
1441Boolean value.
1442Runs
1443.Xr screenblank 1
1444and passes
1445.Sy screenblank_flags .
1446.It Sy wscons
1447Boolean value.
1448Configures the
1449.Xr wscons 4
1450console driver, from the configuration file
1451.Pa /etc/wscons.conf .
1452.It Sy wsmoused
1453Boolean value.
1454Runs
1455.Xr wsmoused 8 ,
1456to provide copy and paste text support in wscons displays.
1457Passes
1458.Sy wsmoused_flags .
1459.El
1460.Sh FILES
1461.Bl -tag -width /etc/defaults/rc.conf -compact
1462.It Pa /etc/rc.conf
1463The file
1464.Nm
1465resides in
1466.Pa /etc .
1467.It Pa /etc/defaults/rc.conf
1468Default settings for
1469.Nm ,
1470sourced by
1471.Nm
1472before the end-user configuration section.
1473.It Pa /etc/rc.conf.d/ Ns Ar foo
1474.Ar foo Ns No -specific
1475.Nm
1476overrides.
1477.El
1478.Sh SEE ALSO
1479.Xr boot 8 ,
1480.Xr rc 8 ,
1481.Xr rc.d 8 ,
1482.Xr rc.subr 8 ,
1483.Xr rcorder 8
1484.Sh HISTORY
1485The
1486.Nm
1487file appeared in
1488.Nx 1.3 .
1489