i386 removal, part 1/x: Remove 'real' APM and associated stuff.
[dragonfly.git] / share / man / man5 / rc.conf.5
CommitLineData
984263bc
MD
1.\" Copyright (c) 1995
2.\" Jordan K. Hubbard
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
445243bf 25.\" $FreeBSD: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $
2feb07f7 26.\"
2352f0a1 27.Dd June 20, 2015
984263bc
MD
28.Dt RC.CONF 5
29.Os
30.Sh NAME
31.Nm rc.conf
32.Nd system configuration information
33.Sh DESCRIPTION
34The file
35.Nm
36contains descriptive information about the local host name, configuration
37details for any potential network interfaces and which services should be
445243bf
RG
38started up at system initial boot time.
39In new installations, the
984263bc 40.Nm
d566b9ec 41file is generally initialized by the installer.
984263bc
MD
42.Pp
43The purpose of
44.Nm
225e0ed5
SW
45is not to run commands or perform system startup actions directly.
46Instead, it is included by the various generic startup scripts in
984263bc
MD
47.Pa /etc
48which conditionalize their
49internal actions according to the settings found there.
50.Pp
51The
717e8ef7
TN
52.Pa /etc/defaults/rc.conf
53file specifies the default settings for all the available options,
54the
984263bc 55.Pa /etc/rc.conf
717e8ef7 56file specifies override settings.
445243bf 57Options need only be specified in
984263bc 58.Pa /etc/rc.conf
717e8ef7 59when the system administrator wishes to override the defaults.
984263bc
MD
60The file
61.Pa /etc/rc.conf.local
62is used to override settings in
63.Pa /etc/rc.conf
64for historical reasons.
e28efee1
SW
65In addition to
66.Pa /etc/rc.conf.local
67you can also place smaller configuration files for each
68.Xr rc 8
69script in the
70.Pa /etc/rc.conf.d
71directory, which will be included by the
72.Va load_rc_config
73function.
74For jail configurations you could use the file
75.Pa /etc/rc.conf.d/jail
76to store jail specific configuration options.
77Also see the
445243bf
RG
78.Va rc_conf_files
79variable below.
984263bc
MD
80.Pp
81The following list provides a name and short description for each
82variable that can be set in the
83.Nm
10efbc86
SW
84file.
85To set a variable of
86.Vt bool
87type, specify either
88.Dq Li YES ,
89.Dq Li TRUE ,
90.Dq Li ON ,
91or
92.Dq Li 1 .
93To unset, specify
94.Dq Li NO ,
95.Dq Li FALSE ,
96.Dq Li OFF ,
97or
98.Dq Li 0 .
99These values are case insensitive.
100The
101.Va _enable
f0cc8c84 102postfix in the name of a variable for starting a service can be
10efbc86
SW
103omitted (as in
104.Nx ) .
445243bf
RG
105.Bl -tag -width indent-two
106.It Va rc_debug
107.Pq Vt bool
108If set to
109.Dq Li YES ,
110enable output of debug messages from rc scripts.
111This variable can be helpful in diagnosing mistakes when
112editing or integrating new scripts.
113Beware that this produces copious output to the terminal and
114.Xr syslog 3 .
115.It Va rc_info
116.Pq Vt bool
117If set to
118.Dq Li NO ,
119disable informational messages from the rc scripts.
120Informational messages are displayed when
225e0ed5 121a condition that is not serious enough to warrant a warning or an error occurs.
212bd1a8
SW
122.It Va rc_startmsgs
123.Pq Vt bool
124If set to
125.Dq Li YES ,
126show
127.Dq Starting foo:
128when faststart is used (e.g., at boot time).
984263bc
MD
129.It Va swapfile
130.Pq Vt str
131If set to
445243bf
RG
132.Dq Li NO ,
133no swapfile is installed, otherwise the value is used as the full
984263bc 134pathname to a file to use for additional swap space.
3b12ce42
SW
135The
136.Xr vn 4
137driver is needed for a swapfile and will be loaded if it is not
138already compiled into the kernel or loaded via
139.Xr loader.conf 5 .
4b8c406a
SW
140.It Va devd_enable
141.Pq Vt bool
142Run
143.Xr devd 8
144to handle device added, removed or unknown events from the kernel.
145.It Va devd_flags
146.Pq Vt str
147If
148.Va devd_enable
149is set to
150.Dq Li YES ,
151these are the flags to pass to the
152.Xr devd 8
153daemon.
8861c912
SW
154.It Va powerd_enable
155.Pq Vt bool
156Set to
157.Dq Li NO
158by default.
159Setting this to
160.Dq Li YES
161enables
162.Xr powerd 8 ,
163a CPU speed control daemon.
eb3a3472
HT
164.It Va sensorsd_enable
165.Pq Vt bool
166Set to
167.Dq Li NO
168by default.
169Setting this to
170.Dq Li YES
171enables
172.Xr sensorsd 8 ,
173a sensors monitoring and logging daemon.
174.It Va sensorsd_flags
175.Pq Vt str
176Empty by default.
717e8ef7 177Additional flags passed to the
eb3a3472
HT
178.Xr sensorsd 8
179program.
d74b417d
SW
180.It Va sysvipcd_enable
181.Pq Vt bool
182Set to
183.Dq Li NO
184by default.
185Setting this to
186.Dq Li YES
187enables
188.Xr sysvipcd 8 ,
68e12e71
SW
189a daemon needed for the userspace implementation of the XSI Interprocess
190Communication functions.
d74b417d
SW
191.It Va sysvipcd_flags
192.Pq Vt str
193Empty by default.
194Additional flags passed to the
195.Xr sysvipcd 8
196program.
01b70f3f
SW
197.It Va hotplugd_enable
198.Pq Vt bool
199Set to
200.Dq Li NO
201by default.
202Setting this to
203.Dq Li YES
204enables
205.Xr hotplugd 8 ,
206a devices hot plugging monitoring daemon.
207.It Va hotplugd_flags
208.Pq Vt str
209Empty by default.
210Additional flags passed to the
211.Xr hotplugd 8
212program.
984263bc
MD
213.It Va pccard_ifconfig
214.Pq Vt str
215List of arguments to be passed to
216.Xr ifconfig 8
225e0ed5 217at boot time or on insertion of the card (e.g.\&
445243bf
RG
218.Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
219for a fixed address or
220.Dq Li DHCP
221for a DHCP client).
984263bc
MD
222.It Va pccard_ether_delay
223.Pq Vt str
224Set the delay before starting
225.Xr dhclient 8
445243bf
RG
226in the
227.Pa /etc/pccard_ether
984263bc
MD
228script.
229This defaults to 5 seconds to work around a bug in the
230.Xr ed 4
231driver which can lead to system hangs when using some newer
232.Xr ed 4
233based cards.
445243bf
RG
234.It Va removable_interfaces
235.Pq Vt str
236List of removable network interfaces to be supported by
237.Pa /etc/pccard_ether .
984263bc
MD
238.It Va local_startup
239.Pq Vt str
240List of directories to search for startup script files.
241.It Va script_name_sep
242.Pq Vt str
243The field separator to use for breaking down the list of startup script files
244into individual filenames.
245The default is a space.
246It is not necessary to change this unless there are startup scripts with names
247containing spaces.
5c8b08ff
SW
248.It Va hostapd_enable
249.Pq Vt bool
250Set to
251.Dq Li YES
252to start
253.Xr hostapd 8
254at system boot time.
984263bc
MD
255.It Va hostname
256.Pq Vt str
445243bf 257The fully qualified domain name (FQDN) of this host on the network.
984263bc
MD
258This should almost certainly be set to something meaningful, even if
259there is no network connection.
260If
261.Xr dhclient 8
262is used to set the hostname via DHCP,
263this variable should be set to an empty string.
445243bf
RG
264.It Va ipv6_enable
265.Pq Vt bool
266Enable support for IPv6 networking.
267Note that this requires that the kernel have been compiled with
268.Cd "options INET6" .
984263bc
MD
269.It Va nisdomainname
270.Pq Vt str
271The NIS domain name of this host, or
445243bf 272.Dq Li NO
984263bc 273if NIS is not used.
445243bf 274.It Va dhclient_program
984263bc
MD
275.Pq Vt str
276Path to the DHCP client program
717e8ef7
TN
277(default
278.Pa /sbin/dhclient ) .
445243bf 279.It Va dhclient_flags
984263bc
MD
280.Pq Vt str
281Additional flags to pass to the DHCP client program.
27e9fed5
SW
282.It Va pf_enable
283.Pq Vt bool
284Set to
285.Dq Li YES
286to load
287.Xr pf 4
288at startup.
289If the kernel was not built with
290.Cd "device pf" ,
291the
292.Pa pf.ko
293kernel module will be loaded.
294See also
1cb3b2e4 295.Va firewall_enable .
27e9fed5
SW
296.It Va pf_rules
297.Pq Vt str
298Path to the
299.Xr pf 4
300ruleset definition file.
301.It Va pf_program
302.Pq Vt str
303Path to
304.Xr pfctl 8 .
305.It Va pf_flags
306.Pq Vt str
307If
308.Va pf_enable
309is set to
310.Dq Li YES ,
311these are the flags to pass to
312.Xr pfctl 8
313when loading the ruleset.
314.It Va pflog_enable
315.Pq Vt bool
316Set this to
317.Dq Li YES
318to enable
319.Xr pflogd 8
320which logs packets from
321.Xr pf 4 .
322.It Va pflog_logfile
323.Pq Vt str
324If
325.Va pflog_enable
326is set to
327.Dq Li YES
328this specifies the path of the log file.
329.It Va pflog_program
330.Pq Vt str
331Path to
332.Xr pflogd 8 .
333.It Va pflog_flags
334.Pq Vt str
335If
336.Va pflog_enable
337is set to
338.Dq Li YES ,
339these are the flags to pass to
340.Xr pflogd 8 .
984263bc
MD
341.It Va firewall_enable
342.Pq Vt bool
343Set to
445243bf 344.Dq Li YES
984263bc
MD
345to load firewall rules at startup.
346If the kernel was not built with
445243bf
RG
347.Cd "options IPFIREWALL" ,
348the
349.Pa ipfw.ko
984263bc
MD
350kernel module will be loaded.
351See also
1cb3b2e4 352.Va pf_enable .
445243bf
RG
353.It Va ipv6_firewall_enable
354.Pq Vt bool
355The IPv6 equivalent of
356.Va firewall_enable .
357Set to
358.Dq Li YES
359to load IPv6 firewall rules at startup.
360If the kernel was not built with
361.Cd "options IPV6FIREWALL" ,
362the
363.Pa ip6fw.ko
364kernel module will be loaded.
984263bc
MD
365.It Va firewall_script
366.Pq Vt str
717e8ef7
TN
367The full path to the firewall script to run
368(default
369.Pa /etc/rc.firewall ) .
445243bf
RG
370.It Va ipv6_firewall_script
371.Pq Vt str
372The IPv6 equivalent of
373.Va firewall_script .
984263bc
MD
374.It Va firewall_type
375.Pq Vt str
376Names the firewall type from the selection in
377.Pa /etc/rc.firewall ,
445243bf
RG
378or the file which contains the local firewall ruleset.
379Valid selections from
380.Pa /etc/rc.firewall
381are:
382.Pp
383.Bl -tag -width ".Li simple" -compact
384.It Li open
385unrestricted IP access
386.It Li closed
387all IP services disabled, except via
388.Dq Li lo0
389.It Li client
d7b5790d 390basic protection for a workstation on a LAN
445243bf 391.It Li simple
d7b5790d
SW
392alias for
393.Li client .
445243bf
RG
394.El
395.Pp
225e0ed5 396If a filename is specified, the full path must be given.
d7b5790d 397.It Va firewall_trusted_nets
9534e380 398.Pq Vt str
d7b5790d
SW
399List of trusted networks (if
400.Va firewall_type
401is set to
402.Li client ) .
403.It Va firewall_trusted_interfaces
9534e380 404.Pq Vt str
d7b5790d
SW
405List of trusted network interfaces (if
406.Va firewall_type
407is set to
408.Li client ) .
409.It Va firewall_allowed_icmp_types
9534e380 410.Pq Vt str
d7b5790d
SW
411List of allowed ICMP types (if
412.Va firewall_type
413is set to
414.Li client ) .
415.It Va firewall_open_tcp_ports
9534e380 416.Pq Vt str
d7b5790d
SW
417List of TCP ports to open (if
418.Va firewall_type
419is set to
420.Li client ) .
421.It Va firewall_open_udp_ports
9534e380 422.Pq Vt str
d7b5790d
SW
423List of UDP ports to open (if
424.Va firewall_type
425is set to
426.Li client ) .
445243bf
RG
427.It Va ipv6_firewall_type
428.Pq Vt str
429The IPv6 equivalent of
430.Va firewall_type .
984263bc
MD
431.It Va firewall_quiet
432.Pq Vt bool
433Set to
445243bf
RG
434.Dq Li YES
435to disable the display of firewall rules on the console during boot.
436.It Va ipv6_firewall_quiet
437.Pq Vt bool
438The IPv6 equivalent of
439.Va firewall_quiet .
984263bc
MD
440.It Va firewall_logging
441.Pq Vt bool
442Set to
445243bf
RG
443.Dq Li YES
444to enable firewall event logging.
984263bc
MD
445This is equivalent to the
446.Dv IPFIREWALL_VERBOSE
447kernel option.
445243bf
RG
448.It Va ipv6_firewall_logging
449.Pq Vt bool
450The IPv6 equivalent of
451.Va firewall_logging .
984263bc
MD
452.It Va firewall_flags
453.Pq Vt str
454Flags passed to
455.Xr ipfw 8
456if
457.Va firewall_type
458specifies a filename.
445243bf
RG
459.It Va ipv6_firewall_flags
460.Pq Vt str
461The IPv6 equivalent of
462.Va firewall_flags .
984263bc
MD
463.It Va natd_program
464.Pq Vt str
465Path to
466.Xr natd 8 .
467.It Va natd_enable
468.Pq Vt bool
469Set to
445243bf
RG
470.Dq Li YES
471to enable
472.Xr natd 8 .
984263bc
MD
473.Va firewall_enable
474must also be set to
445243bf 475.Dq Li YES ,
984263bc
MD
476and
477.Xr divert 4
478sockets must be enabled in the kernel.
479.It Va natd_interface
480.Pq Vt str
445243bf
RG
481This is the name of the public interface on which
482.Xr natd 8
483should run.
984263bc
MD
484The interface may be given as an interface name or as an IP address.
485.It Va natd_flags
486.Pq Vt str
445243bf
RG
487Additional
488.Xr natd 8
489flags should be placed here.
490The
984263bc
MD
491.Fl n
492or
493.Fl a
494flag is automatically added with the above
495.Va natd_interface
496as an argument.
984263bc
MD
497.It Va tcp_extensions
498.Pq Vt bool
499Set to
445243bf 500.Dq Li YES
984263bc 501by default.
445243bf
RG
502Setting this to
503.Dq Li NO
504disables certain TCP options as described by
984263bc 505.Rs
445243bf 506.%T "RFC 1323"
984263bc
MD
507.Re
508Setting this to
445243bf 509.Dq Li NO
984263bc
MD
510might help remedy such problems with connections as randomly hanging
511or other weird behavior.
225e0ed5 512Some network devices are known to be broken with respect to these options.
984263bc
MD
513.It Va log_in_vain
514.Pq Vt int
515Set to 0 by default.
516The
517.Xr sysctl 8
518variables,
445243bf 519.Va net.inet.tcp.log_in_vain
984263bc 520and
445243bf 521.Va net.inet.udp.log_in_vain ,
984263bc
MD
522as described in
523.Xr tcp 4
524and
525.Xr udp 4 ,
526are set to the given value.
527.It Va tcp_keepalive
528.Pq Vt bool
529Set to
445243bf 530.Dq Li YES
984263bc 531by default.
445243bf
RG
532Setting to
533.Dq Li NO
534will disable probing idle TCP connections to verify that the
984263bc
MD
535peer is still up and reachable.
536.It Va tcp_drop_synfin
537.Pq Vt bool
538Set to
445243bf 539.Dq Li NO
984263bc 540by default.
445243bf
RG
541Setting to
542.Dq Li YES
543will cause the kernel to ignore TCP frames that have both
984263bc 544the SYN and FIN flags set.
225e0ed5
SW
545This prevents OS fingerprinting, but may break some legitimate applications.
546This option is only available if the kernel was built with the
984263bc
MD
547.Dv TCP_DROP_SYNFIN
548option.
549.It Va icmp_drop_redirect
550.Pq Vt bool
551Set to
445243bf 552.Dq Li NO
984263bc 553by default.
445243bf
RG
554Setting to
555.Dq Li YES
556will cause the kernel to ignore ICMP REDIRECT packets.
557Refer to
558.Xr icmp 4
559for more information.
984263bc
MD
560.It Va icmp_log_redirect
561.Pq Vt bool
562Set to
445243bf 563.Dq Li NO
984263bc 564by default.
445243bf
RG
565Setting to
566.Dq Li YES
567will cause the kernel to log ICMP REDIRECT packets.
984263bc
MD
568Note that
569the log messages are not rate-limited, so this option should only be used
570for troubleshooting networks.
445243bf
RG
571Refer to
572.Xr icmp 4
573for more information.
574.It Va icmp_bmcastecho
575.Pq Vt bool
576Set to
577.Dq Li YES
578to respond to broadcast or multicast ICMP ping packets.
579Refer to
580.Xr icmp 4
581for more information.
582.It Va ip_portrange_first
583.Pq Vt int
584If not set to
585.Dq Li NO ,
586this is the first port in the default portrange.
587Refer to
588.Xr ip 4
589for more information.
590.It Va ip_portrange_last
591.Pq Vt int
592If not set to
593.Dq Li NO ,
594this is the last port in the default portrange.
595Refer to
596.Xr ip 4
597for more information.
717e8ef7
TN
598.\"
599.It Va ifconfig_ Ns Aq Ar interface
984263bc 600.Pq Vt str
717e8ef7
TN
601Configuration for
602.Dq interface .
603Typically includes IP address.
445243bf
RG
604Assuming that the interface in question was
605.Li ed0 ,
225e0ed5 606it might look something like this:
984263bc 607.Bd -literal
717e8ef7 608ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
984263bc
MD
609.Ed
610.Pp
445243bf
RG
611If the
612.Pa /etc/start_if. Ns Aq Ar interface
613file is present, it is read and executed by the
614.Xr sh 1
225e0ed5 615interpreter before configuring the interface as specified in the
445243bf
RG
616.Va ifconfig_ Ns Aq Ar interface
617and
618.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
619variables.
620.Pp
f26c267a
SW
621It is possible to bring up an interface with DHCP by adding
622.Dq Li DHCP
623to the
984263bc 624.Va ifconfig_ Ns Aq Ar interface
f26c267a 625variable.
445243bf
RG
626For instance, to initialize the
627.Li ed0
225e0ed5 628device via DHCP, it is possible to use something like:
984263bc
MD
629.Bd -literal
630ifconfig_ed0="DHCP"
631.Ed
f26c267a 632.Pp
4fe6477b 633If a
ccb8cebe
AH
634.Va vlans_ Ns Aq Ar interface
635variable is set,
636a
637.Xr vlan 4
638interface will be created for each item in the list with the
639.Ar vlandev
640argument set to
641.Ar interface .
642If a vlan interface's name is a number,
643then that number is used as the vlan tag and the new vlan interface is
644named
645.Ar interface . Ns Ar tag .
646Otherwise,
647the vlan tag must be specified via a
648.Va vlan
649parameter in the
650.Va create_args_ Ns Aq Ar interface
651variable.
652.Pp
653To create a vlan device named
654.Li em0.101
655on
656.Li em0
657with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
658.Bd -literal
659vlans_em0="101"
660ifconfig_em0_101="inet 192.0.2.1/24"
661.Ed
662.Pp
663To create a vlan device named
664.Li myvlan
665on
666.Li em0
667with the vlan tag 102:
668.Bd -literal
669vlans_em0="myvlan"
670create_args_myvlan="vlan 102"
671.Ed
672.Pp
673If a
4fe6477b
MS
674.Va wlans_ Ns Aq Ar interface
675variable is set,
676an
677.Xr wlan 4
678interface will be created for each item in the list with the
679.Ar wlandev
680argument set to
681.Ar interface .
682Further wlan cloning arguments may be passed to the
683.Xr ifconfig 8
684.Cm create
685command by setting the
686.Va create_args_ Ns Aq Ar interface
687variable.
688One or more
689.Xr wlan 4
690devices must be created for each wireless devices as of
691.Dx 2.5 .
692Debugging flags for
693.Xr wlan 4
694devices as set by
695.Xr wlandebug 8
696may be specified with an
697.Va wlandebug_ Ns Aq Ar interface
698variable.
699The contents of this variable will be passed directly to
700.Xr wlandebug 8 .
701.Pp
f26c267a
SW
702Also, if your interface needs WPA authentication, it is possible to add
703.Dq Li WPA
704to the
705.Va ifconfig_ Ns Aq Ar interface
706variable.
e7e53421 707This will start
bd3478c4 708.Xr wpa_supplicant 8 .
e7e53421
MS
709See
710.Xr wpa_supplicant.conf 5
711for configuring authentication information.
f26c267a
SW
712.Pp
713Finally, you can add
714.Xr ifconfig 8
715options in this variable, in addition to the
716.Pa /etc/start_if. Ns Aq Ar interface
717file.
718For instance, to initialize the
719.Li wi0
720device via DHCP, using WPA authentication and 802.11b mode, it is
721possible to use something like:
722.Bd -literal
62f17e14
SW
723wlans_wi0="wlan0"
724ifconfig_wlan0="up DHCP WPA mode 11b"
f26c267a 725.Ed
717e8ef7
TN
726.It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
727.Pq Vt str
728Configuration to establish an additional network address for
729.Dq interface .
730Assuming that the interface in question was
731.Li ed0 ,
732it might look something like this:
733.Bd -literal
734ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
735ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
736.Ed
737.Pp
738And so on.
739For each
740.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
741entry that is found, its contents are passed to
742.Xr ifconfig 8 .
743Execution stops at the first unsuccessful access, so if
744something like this is present:
745.Bd -literal
746ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
747ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
748ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
749ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
750.Ed
751.Pp
752Then note that alias4 would
753.Em not
754be added since the search would stop with the missing alias3 entry.
717e8ef7
TN
755.It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
756.Pq Vt str
757New name for
758.Dq interface .
759It is possible to rename interface by doing:
f26c267a
SW
760.Bd -literal
761ifconfig_ed0_name="net0"
762ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
763.Ed
717e8ef7
TN
764.It Va network_interfaces
765.Pq Vt str
766The list of network interfaces to configure on this host,
767or
768.Dq Li auto
769to configure all network interfaces
770(default
771.Dq Li auto ) .
772For example, if the only network devices to be configured are the loopback device
773.Pq Li lo0
774and a NIC using the
775.Xr ed 4
776driver, this could be set to
777.Dq Li "lo0 ed0" .
778An
779.Va ifconfig_ Ns Aq Ar interface
780variable is assumed to exist for each value of
781.Ar interface .
445243bf
RG
782.It Va ipv6_network_interfaces
783.Pq Vt str
784This is the IPv6 equivalent of
785.Va network_interfaces .
786Instead of setting the ifconfig variables as
787.Va ifconfig_ Ns Aq Ar interface
788they should be set as
789.Va ipv6_ifconfig_ Ns Aq Ar interface .
790Aliases should be set as
791.Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
445243bf
RG
792Interfaces that do not have a
793.Va ipv6_ifconfig_ Ns Aq Ar interface
794setting will be auto configured by
795.Xr rtsol 8
796if the
797.Va ipv6_gateway_enable
798is set to
799.Dq Li NO .
800Note that the IPv6 networking code does not support the
801.Pa /etc/start_if. Ns Aq Ar interface
802files.
717e8ef7
TN
803.It Va ipv6_prefix_ Ns Aq Ar interface
804.Pq Vt str
805Assign prefix to
806.Ar interface ,
807prefixlen 64 is used.
445243bf
RG
808.It Va ipv6_default_interface
809.Pq Vt str
810If not set to
811.Dq Li NO ,
812this is the default output interface for scoped addresses.
813Now this works only for IPv6 link local multicast addresses.
984263bc
MD
814.It Va cloned_interfaces
815.Pq Vt str
816Set to the list of clonable network interfaces to create on this host.
817Entries in
818.Va cloned_interfaces
819are automatically appended to
820.Va network_interfaces
821for configuration.
822.It Va gif_interfaces
823.Pq Vt str
824Set to the list of
825.Xr gif 4
826tunnel interfaces to configure on this host.
827A
828.Va gifconfig_ Ns Aq Ar interface
829variable is assumed to exist for each value of
830.Ar interface .
831The value of this variable is used to configure the link layer of the
832tunnel according to the syntax of the
833.Cm tunnel
834option to
835.Xr ifconfig 8 .
225e0ed5 836Additionally, this option ensures that each listed interface is created via the
984263bc
MD
837.Cm create
838option to
839.Xr ifconfig 8
840before attempting to configure it.
445243bf
RG
841.It Va sppp_interfaces
842.Pq Vt str
843Set to the list of
844.Xr sppp 4
845interfaces to configure on this host.
846A
847.Va spppconfig_ Ns Aq Ar interface
848variable is assumed to exist for each value of
849.Ar interface .
850Each interface should also be configured by a general
851.Va ifconfig_ Ns Aq Ar interface
852setting.
853Refer to
854.Xr spppcontrol 8
855for more information about available options.
984263bc
MD
856.It Va ppp_enable
857.Pq Vt bool
858If set to
445243bf 859.Dq Li YES ,
984263bc
MD
860run the
861.Xr ppp 8
862daemon.
863.It Va ppp_mode
864.Pq Vt str
865Mode in which to run the
866.Xr ppp 8
445243bf
RG
867daemon.
868Accepted modes are
869.Dq Li auto ,
870.Dq Li ddial ,
871.Dq Li direct
984263bc 872and
445243bf 873.Dq Li dedicated .
984263bc
MD
874See the manual for a full description.
875.It Va ppp_nat
876.Pq Vt bool
877If set to
445243bf
RG
878.Dq Li YES ,
879enables network address translation.
984263bc
MD
880Used in conjunction with
881.Va gateway_enable
882allows hosts on private network addresses access to the Internet using
883this host as a network address translating router.
884.It Va ppp_profile
885.Pq Vt str
886The name of the profile to use from
887.Pa /etc/ppp/ppp.conf .
519061ed
AH
888Also used for per-profile overrides of
889.Va ppp_ Ns Ao Ar profile Ac Ns _unit .
890Where the profile contains any of the characters
891.Dq Li .-/+
892they are translated to
893.Dq Li _
894for the purposes of the override variable names.
895.It Va ppp_ Ns Ao Ar profile Ac Ns _unit
896.Pq Vt int
897Set the unit number to be used for this profile.
898See the manual description of
899.Fl unit Ns Ar N
900in
901.Xr ppp 8
902for details.
984263bc
MD
903.It Va ppp_user
904.Pq Vt str
445243bf
RG
905The name of the user under which
906.Xr ppp 8
907should be started.
225e0ed5 908By default,
445243bf
RG
909.Xr ppp 8
910is started as
911.Dq Li root .
984263bc
MD
912.It Va rc_conf_files
913.Pq Vt str
914This option is used to specify a list of files that will override
915the settings in
916.Pa /etc/defaults/rc.conf .
917The files will be read in the order in which they are specified and should
918include the full path to the file.
919By default, the files specified are
920.Pa /etc/rc.conf
921and
922.Pa /etc/rc.conf.local
923.It Va fsck_y_enable
924.Pq Vt bool
925If set to
445243bf 926.Dq Li YES ,
984263bc 927.Xr fsck 8
445243bf
RG
928will be run with the
929.Fl y
225e0ed5 930flag if the initial preen of the file systems fails.
445243bf
RG
931.It Va netfs_types
932.Pq Vt str
933List of file system types that are network-based.
934This list should generally not be modified by end users.
935Use
936.Va extra_netfs_types
937instead.
938.It Va extra_netfs_types
939.Pq Vt str
940If set to something other than
941.Dq Li NO
225e0ed5 942(the default), this variable extends the list of file system types
445243bf
RG
943for which automatic mounting at startup by
944.Xr rc 8
945should be delayed until the network is initialized.
946It should contain
947a whitespace-separated list of network file system descriptor pairs,
948each consisting of a file system type as passed to
949.Xr mount 8
225e0ed5 950and a human-readable, one-word description, joined with a colon
445243bf
RG
951.Pq Ql \&: .
952Extending the default list in this way is only necessary
953when third party file system types are used.
a46854c7
MS
954.It Va devfs_config_files
955.Pq Vt str
956This option is used to specify a list of configuration files containing
957.Xr devfs 5
958rules that will be applied by
959.Xr devfsctl 8
960in the order in which they are specified and must include the full path
961to the file.
984263bc
MD
962.It Va syslogd_enable
963.Pq Vt bool
964If set to
445243bf 965.Dq Li YES ,
984263bc
MD
966run the
967.Xr syslogd 8
968daemon.
969.It Va syslogd_program
970.Pq Vt str
971Path to
972.Xr syslogd 8
973(default
974.Pa /usr/sbin/syslogd ) .
975.It Va syslogd_flags
976.Pq Vt str
977If
978.Va syslogd_enable
979is set to
445243bf 980.Dq Li YES ,
984263bc
MD
981these are the flags to pass to
982.Xr syslogd 8 .
983.It Va inetd_enable
984.Pq Vt bool
985If set to
445243bf 986.Dq Li YES ,
984263bc
MD
987run the
988.Xr inetd 8
989daemon.
990.It Va inetd_program
991.Pq Vt str
992Path to
993.Xr inetd 8
994(default
995.Pa /usr/sbin/inetd ) .
996.It Va inetd_flags
997.Pq Vt str
998If
999.Va inetd_enable
1000is set to
445243bf 1001.Dq Li YES ,
984263bc
MD
1002these are the flags to pass to
1003.Xr inetd 8 .
984263bc
MD
1004.It Va rwhod_enable
1005.Pq Vt bool
1006If set to
445243bf 1007.Dq Li YES ,
984263bc
MD
1008run the
1009.Xr rwhod 8
1010daemon at boot time.
1011.It Va rwhod_flags
1012.Pq Vt str
1013If
1014.Va rwhod_enable
1015is set to
445243bf 1016.Dq Li YES ,
984263bc
MD
1017these are the flags to pass to it.
1018.It Va amd_enable
1019.Pq Vt bool
1020If set to
445243bf 1021.Dq Li YES ,
984263bc
MD
1022run the
1023.Xr amd 8
1024daemon at boot time.
1025.It Va amd_flags
1026.Pq Vt str
1027If
1028.Va amd_enable
1029is set to
445243bf 1030.Dq Li YES ,
984263bc
MD
1031these are the flags to pass to it.
1032See the
1033.Xr amd 8
445243bf 1034manpage for more information.
984263bc
MD
1035.It Va amd_map_program
1036.Pq Vt str
225e0ed5 1037If set, the specified program is run to get the list of
984263bc
MD
1038.Xr amd 8
1039maps.
1040For example, if the
1041.Xr amd 8
225e0ed5 1042maps are stored in NIS, one can set this to run
984263bc
MD
1043.Xr ypcat 1
1044to get a list of
1045.Xr amd 8
1046maps from the
1047.Pa amd.master
1048NIS map.
1049.It Va update_motd
1050.Pq Vt bool
1051If set to
445243bf 1052.Dq Li YES ,
984263bc 1053.Pa /etc/motd
225e0ed5 1054will be updated at boot time to reflect the kernel release being run.
445243bf
RG
1055If set to
1056.Dq Li NO ,
984263bc 1057.Pa /etc/motd
445243bf 1058will not be updated.
984263bc
MD
1059.It Va nfs_client_enable
1060.Pq Vt bool
1061If set to
445243bf 1062.Dq Li YES ,
14791e19 1063setup NFS client parameters at boot time.
984263bc
MD
1064.It Va nfs_access_cache
1065.Pq Vt int
1066If
1067.Va nfs_client_enable
1068is set to
445243bf 1069.Dq Li YES ,
984263bc 1070this can be set to
445243bf 1071.Dq Li 0
984263bc 1072to disable NFS ACCESS RPC caching, or to the number of seconds for which
225e0ed5 1073NFS ACCESS results should be cached.
d615ff4f 1074A value of 2-10 seconds will substantially reduce network traffic for
225e0ed5
SW
1075many NFS operations.
1076The default is 5 seconds.
1077Note that the attribute cache holds stat information only.
1078The NFS data cache is independent of the attribute cache and is only
1079invalidated when the client detects that the server has modified the
1080underlying file.
1081This value specifies a maximum timeout.
1082The NFS client will automatically use a shorter timeout for files which
1083have been recently modified.
d615ff4f
MD
1084.It Va nfs_neg_cache
1085.Pq Vt int
1086If
1087.Va nfs_client_enable
1088is set to
1089.Dq Li YES ,
1090this can be set to
1091.Dq Li 0
3f5e28f4 1092to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
d615ff4f
MD
1093filenames), or to the number of seconds for which negative lookups should
1094be cached.
984263bc 1095A value of 2-10 seconds will substantially reduce network
225e0ed5
SW
1096traffic for many NFS operations, especially source code builds.
1097The default is 3 seconds.
984263bc
MD
1098.It Va nfs_server_enable
1099.Pq Vt bool
1100If set to
445243bf 1101.Dq Li YES ,
984263bc
MD
1102run the NFS server daemons at boot time.
1103.It Va nfs_server_flags
1104.Pq Vt str
1105If
1106.Va nfs_server_enable
1107is set to
445243bf 1108.Dq Li YES ,
984263bc
MD
1109these are the flags to pass to the
1110.Xr nfsd 8
1111daemon.
445243bf 1112.It Va mountd_enable
984263bc
MD
1113.Pq Vt bool
1114If set to
445243bf 1115.Dq Li YES ,
984263bc
MD
1116and no
1117.Va nfs_server_enable
1118is set, start
1119.Xr mountd 8 ,
1120but not
1121.Xr nfsd 8
1122daemon.
1123It is commonly needed to run CFS without real NFS used.
1124.It Va mountd_flags
1125.Pq Vt str
1126If
1127.Va mountd_enable
1128is set to
1129.Dq Li YES ,
1130these are the flags to pass to the
445243bf 1131.Xr mountd 8
984263bc
MD
1132daemon.
1133.It Va weak_mountd_authentication
1134.Pq Vt bool
1135If set to
445243bf 1136.Dq Li YES ,
225e0ed5 1137allow services like PCNFSD to make non-privileged mount requests.
984263bc
MD
1138.It Va nfs_reserved_port_only
1139.Pq Vt bool
1140If set to
445243bf 1141.Dq Li YES ,
984263bc
MD
1142provide NFS services only on a secure port.
1143.It Va nfs_bufpackets
1144.Pq Vt int
1145If set to a number, indicates the number of packets worth of
1146socket buffer space to reserve on an NFS client.
1147The kernel default is typically 4.
225e0ed5
SW
1148Using a higher number may be useful on gigabit networks to improve performance.
1149The minimum value is 2 and the maximum is 64.
72067a39
MD
1150.It Va rpc_umntall_enable
1151.Pq Vt bool
1152If set to
1153.Dq Li YES
1154(default) and we are also an NFS client, run
1155.Xr rpc.umntall 8
1156at boot time to clear out old mounts on remote servers.
1157If set to
1158.Dq Li NO
1159then
1160.Xr rpc.umntall 8
1161will not be run at boot time.
984263bc
MD
1162.It Va rpc_lockd_enable
1163.Pq Vt bool
1164If set to
445243bf 1165.Dq Li YES
984263bc
MD
1166and also an NFS server, run
1167.Xr rpc.lockd 8
1168at boot time.
52163b73
SW
1169.It Va rpc_lockd_flags
1170.Pq Vt str
1171If
1172.Va rpc_lockd_enable
1173is set to
1174.Dq Li YES ,
1175these are the flags to pass to
1176.Xr rpc.lockd 8 .
984263bc
MD
1177.It Va rpc_statd_enable
1178.Pq Vt bool
1179If set to
445243bf 1180.Dq Li YES
984263bc
MD
1181and also an NFS server, run
1182.Xr rpc.statd 8
1183at boot time.
52163b73
SW
1184.It Va rpc_statd_flags
1185.Pq Vt str
1186If
1187.Va rpc_statd_enable
1188is set to
1189.Dq Li YES ,
1190these are the flags to pass to
1191.Xr rpc.statd 8 .
445243bf 1192.It Va rpcbind_program
984263bc 1193.Pq Vt str
717e8ef7 1194Path to program for rpcbind daemon
984263bc 1195(default
3b813696 1196.Pa /usr/sbin/rpcbind ) .
445243bf 1197.It Va rpcbind_enable
984263bc
MD
1198.Pq Vt bool
1199If set to
445243bf 1200.Dq Li YES ,
717e8ef7
TN
1201run
1202.Va rpcbind_program
1203at boot time.
445243bf 1204.It Va rpcbind_flags
984263bc
MD
1205.Pq Vt str
1206If
445243bf 1207.Va rpcbind_enable
984263bc 1208is set to
445243bf 1209.Dq Li YES ,
717e8ef7
TN
1210these are the flags to pass to
1211.Va rpcbind_program .
445243bf 1212.It Va keyserv_enable
984263bc
MD
1213.Pq Vt bool
1214If set to
445243bf
RG
1215.Dq Li YES ,
1216run the
1217.Xr keyserv 8
1218daemon on boot for running Secure RPC.
1219.It Va keyserv_flags
984263bc
MD
1220.Pq Vt str
1221If
445243bf 1222.Va keyserv_enable
984263bc 1223is set to
445243bf
RG
1224.Dq Li YES ,
1225these are the flags to pass to
1226.Xr keyserv 8
984263bc
MD
1227daemon.
1228.It Va pppoed_enable
1229.Pq Vt bool
1230If set to
445243bf
RG
1231.Dq Li YES ,
1232run the
984263bc
MD
1233.Xr pppoed 8
1234daemon at boot time to provide PPP over Ethernet services.
850afac2 1235.It Va pppoed_provider
984263bc
MD
1236.Pq Vt str
1237.Xr pppoed 8
850afac2 1238listens to requests to this provider and ultimately runs
984263bc
MD
1239.Xr ppp 8
1240with a
1241.Ar system
1242argument of the same name.
1243.It Va pppoed_flags
1244.Pq Vt str
1245Additional flags to pass to
1246.Xr pppoed 8 .
1247.It Va pppoed_interface
1248.Pq Vt str
445243bf
RG
1249The network interface to run
1250.Xr pppoed 8
1251on.
1252This is mandatory when
984263bc
MD
1253.Va pppoed_enable
1254is set to
445243bf 1255.Dq Li YES .
984263bc 1256.It Va timed_enable
445243bf
RG
1257.Pq Vt bool
1258If set to
1259.Dq Li YES ,
1260run the
984263bc 1261.Xr timed 8
445243bf 1262service at boot time.
225e0ed5 1263This command is intended for networks of machines where a consistent
445243bf
RG
1264.Dq "network time"
1265for all hosts must be established.
225e0ed5
SW
1266This is often useful in large NFS environments where time stamps on
1267files are expected to be consistent network-wide.
984263bc
MD
1268.It Va timed_flags
1269.Pq Vt str
1270If
1271.Va timed_enable
1272is set to
445243bf 1273.Dq Li YES ,
984263bc
MD
1274these are the flags to pass to the
1275.Xr timed 8
1276service.
850afac2
SW
1277.It Va dntpd_enable
1278.Pq Vt bool
1279If set to
1280.Dq Li YES ,
1281run
1282.Xr dntpd 8
1283at system boot time.
1284.It Va dntpd_program
1285.Pq Vt str
1286Path to
1287.Xr dntpd 8
1288(default
1289.Pa /usr/sbin/dntpd ) .
1290.It Va dntpd_flags
1291.Pq Vt str
1292If
1293.Va dntpd_enable
1294is set to
1295.Dq Li YES ,
1296these are the flags to pass to the
1297.Xr dntpd 8
1298daemon.
5f834906
SW
1299.It Va btconfig_enable
1300.Pq Vt bool
1301If set to
1302.Dq Li YES ,
1303configure Bluetooth devices via
1304.Xr btconfig 8
1305at system boot time.
1306.It Va btconfig_devices
1307.Pq Vt str
1308If
1309.Va btconfig_enable
1310is set to
1311.Dq Li YES ,
1312this is the list of Bluetooth devices to configure.
1313If
1314.Va btconfig_devices
1315is not specified, all devices known to the system will be configured.
1316A
1317.Va btconfig_ Ns Aq Ar device
1318variable can be set to specify parameters to be passed to
1319.Ar device .
1320.It Va btconfig_args
1321.Pq Vt str
1322If
1323.Va btconfig_enable
1324is set to
1325.Dq Li YES ,
1326this is the list of configuration parameters to pass to all Bluetooth
1327devices.
1328.It Va sdpd_enable
1329.Pq Vt bool
1330If set to
1331.Dq Li YES ,
1332run the Service Discovery Profile daemon
1333.Xr ( sdpd 8 )
1334at system boot time.
1335.It Va sdpd_flags
1336.Pq Vt str
1337If
1338.Va sdpd_enable
1339is set to
1340.Dq Li YES ,
1341these are the flags to pass to the
1342.Xr sdpd 8
1343daemon.
ec4e37b7
HT
1344.It Va bthcid_enable
1345.Pq Vt bool
1346If set to
1347.Dq Li YES ,
1348run the Bluetooth Link Key/PIN Code Manager daemon
1349.Xr ( bthcid 8 )
1350at system boot time.
1351.It Va bthcid_flags
1352.Pq Vt str
1353If
1354.Va bthcid_enable
1355is set to
1356.Dq Li YES ,
1357these are the flags to pass to the
1358.Xr bthcid 8
1359daemon.
984263bc
MD
1360.It Va nis_client_enable
1361.Pq Vt bool
1362If set to
445243bf
RG
1363.Dq Li YES ,
1364run the
984263bc
MD
1365.Xr ypbind 8
1366service at system boot time.
1367.It Va nis_client_flags
1368.Pq Vt str
1369If
1370.Va nis_client_enable
1371is set to
445243bf 1372.Dq Li YES ,
984263bc
MD
1373these are the flags to pass to the
1374.Xr ypbind 8
1375service.
1376.It Va nis_ypset_enable
1377.Pq Vt bool
1378If set to
445243bf
RG
1379.Dq Li YES ,
1380run the
984263bc
MD
1381.Xr ypset 8
1382daemon at system boot time.
1383.It Va nis_ypset_flags
1384.Pq Vt str
1385If
1386.Va nis_ypset_enable
1387is set to
445243bf 1388.Dq Li YES ,
984263bc
MD
1389these are the flags to pass to the
1390.Xr ypset 8
1391daemon.
1392.It Va nis_server_enable
1393.Pq Vt bool
1394If set to
445243bf
RG
1395.Dq Li YES ,
1396run the
984263bc
MD
1397.Xr ypserv 8
1398daemon at system boot time.
1399.It Va nis_server_flags
1400.Pq Vt str
1401If
1402.Va nis_server_enable
1403is set to
445243bf 1404.Dq Li YES ,
984263bc
MD
1405these are the flags to pass to the
1406.Xr ypserv 8
1407daemon.
1408.It Va nis_ypxfrd_enable
1409.Pq Vt bool
1410If set to
445243bf
RG
1411.Dq Li YES ,
1412run the
984263bc
MD
1413.Xr rpc.ypxfrd 8
1414daemon at system boot time.
1415.It Va nis_ypxfrd_flags
1416.Pq Vt str
1417If
1418.Va nis_ypxfrd_enable
1419is set to
445243bf 1420.Dq Li YES ,
984263bc
MD
1421these are the flags to pass to the
1422.Xr rpc.ypxfrd 8
1423daemon.
1424.It Va nis_yppasswdd_enable
1425.Pq Vt bool
1426If set to
445243bf
RG
1427.Dq Li YES ,
1428run the
984263bc
MD
1429.Xr rpc.yppasswdd 8
1430daemon at system boot time.
1431.It Va nis_yppasswdd_flags
1432.Pq Vt str
1433If
1434.Va nis_yppasswdd_enable
1435is set to
445243bf 1436.Dq Li YES ,
984263bc
MD
1437these are the flags to pass to the
1438.Xr rpc.yppasswdd 8
1439daemon.
445243bf
RG
1440.It Va rpc_ypupdated_enable
1441.Pq Vt bool
1442If set to
1443.Dq Li YES ,
1444run the
1445.Nm rpc.ypupdated
1446daemon at system boot time.
984263bc
MD
1447.It Va defaultrouter
1448.Pq Vt str
1449If not set to
445243bf
RG
1450.Dq Li NO ,
1451create a default route to this host name or IP address
984263bc
MD
1452(use an IP address if this router is also required to get to the
1453name server!).
445243bf
RG
1454.It Va ipv6_defaultrouter
1455.Pq Vt str
1456The IPv6 equivalent of
1457.Va defaultrouter .
984263bc
MD
1458.It Va static_routes
1459.Pq Vt str
225e0ed5 1460Set to the list of static routes that are to be added at system boot time.
445243bf
RG
1461If not set to
1462.Dq Li NO
984263bc
MD
1463then for each whitespace separated
1464.Ar element
1465in the value, a
1466.Va route_ Ns Aq Ar element
225e0ed5 1467variable is assumed to exist whose contents will later be passed to a
445243bf
RG
1468.Dq Nm route Cm add
1469operation.
314c92ec
SW
1470.It Va change_routes
1471.Pq Vt str
1472Set to the list of static routes that are to be changed at system boot time
1473(such as those added by the kernel).
1474If not set to
1475.Dq Li NO
1476then for each whitespace separated
1477.Ar element
1478in the value, a
1479.Va change_route_ Ns Aq Ar element
1480variable is assumed to exist whose contents will later be passed to a
1481.Dq Nm route Cm change
1482operation.
445243bf
RG
1483.It Va ipv6_static_routes
1484.Pq Vt str
1485The IPv6 equivalent of
1486.Va static_routes .
1487If not set to
1488.Dq Li NO
1489then for each whitespace separated
1490.Ar element
1491in the value, a
1492.Va ipv6_route_ Ns Aq Ar element
225e0ed5 1493variable is assumed to exist whose contents will later be passed to a
445243bf 1494.Dq Nm route Cm add Fl inet6
984263bc
MD
1495operation.
1496.It Va gateway_enable
1497.Pq Vt bool
1498If set to
445243bf
RG
1499.Dq Li YES ,
1500configure host to act as an IP router, e.g. to forward packets
984263bc 1501between interfaces.
445243bf
RG
1502.It Va ipv6_gateway_enable
1503.Pq Vt bool
1504The IPv6 equivalent of
1505.Va gateway_enable .
984263bc
MD
1506.It Va router_enable
1507.Pq Vt bool
1508If set to
445243bf 1509.Dq Li YES ,
225e0ed5 1510run a routing daemon of some sort, based on the settings of
221b91ff 1511.Va router_program
984263bc
MD
1512and
1513.Va router_flags .
445243bf
RG
1514.It Va ipv6_router_enable
1515.Pq Vt bool
1516The IPv6 equivalent of
1517.Va router_enable .
1518If set to
1519.Dq Li YES ,
225e0ed5 1520run a routing daemon of some sort, based on the settings of
221b91ff 1521.Va ipv6_router_program
445243bf
RG
1522and
1523.Va ipv6_router_flags .
221b91ff 1524.It Va router_program
984263bc
MD
1525.Pq Vt str
1526If
1527.Va router_enable
1528is set to
445243bf 1529.Dq Li YES ,
717e8ef7
TN
1530this is the name of the routing daemon to use
1531(default
1532.Pa /sbin/routed ) .
221b91ff 1533.It Va ipv6_router_program
445243bf
RG
1534.Pq Vt str
1535The IPv6 equivalent of
717e8ef7
TN
1536.Va router_program
1537(default
1538.Pa /sbin/route6d ) .
984263bc
MD
1539.It Va router_flags
1540.Pq Vt str
1541If
1542.Va router_enable
1543is set to
445243bf 1544.Dq Li YES ,
984263bc 1545these are the flags to pass to the routing daemon.
445243bf
RG
1546.It Va ipv6_router_flags
1547.Pq Vt str
1548The IPv6 equivalent of
1549.Va router_flags .
984263bc
MD
1550.It Va mrouted_enable
1551.Pq Vt bool
1552If set to
445243bf
RG
1553.Dq Li YES ,
1554run the multicast routing daemon,
984263bc 1555.Xr mrouted 8 .
445243bf
RG
1556.It Va mroute6d_enable
1557.Pq Vt bool
1558The IPv6 equivalent of
1559.Va mrouted_enable .
1560If set to
1561.Dq Li YES ,
1562run the IPv6 multicast routing daemon.
1563Note that no IPv6 multicast routing daemon is included in the
9bb2a92d 1564.Dx
445243bf
RG
1565base system but
1566.Xr pim6dd 8
28feafc7 1567can be installed from the
61c8838f
SW
1568.Xr dports 7
1569collection
1570.Pa ( net/mcast-tools ) .
984263bc
MD
1571.It Va mrouted_flags
1572.Pq Vt str
1573If
1574.Va mrouted_enable
1575is set to
445243bf
RG
1576.Dq Li YES ,
1577these are the flags to pass to the
1578.Xr mrouted 8
1579daemon.
1580.It Va mroute6d_flags
1581.Pq Vt str
1582The IPv6 equivalent of
1583.Va mrouted_flags .
1584If
1585.Va mroute6d_enable
1586is set to
1587.Dq Li YES ,
1588these are the flags passed to the IPv6 multicast routing daemon.
1589.It Va mroute6d_program
1590.Pq Vt str
1591If
1592.Va mroute6d_enable
1593is set to
1594.Dq Li YES ,
1595this is the path to the IPv6 multicast routing daemon.
1596.It Va rtadvd_enable
1597.Pq Vt bool
1598If set to
1599.Dq Li YES ,
1600run the
1601.Xr rtadvd 8
1602daemon at boot time.
1603.Xr rtadvd 8
1604will only run if
1605.Va ipv6_gateway_enable
1606is also set to
1607.Dq Li YES .
1608The
1609.Xr rtadvd 8
1610utility sends router advertisement packets to the interfaces specified in
1611.Va rtadvd_interfaces .
1612.Xr rtadvd 8
1613and should only be enabled with great care.
1614You may want to fine-tune
1615.Xr rtadvd.conf 5 .
1616.It Va rtadvd_interfaces
1617.Pq Vt str
1618If
1619.Va rtadvd_enable
1620is set to
1621.Dq Li YES
1622this is the list of interfaces to use.
bdbd8a5b
SW
1623.It Va rtsold_enable
1624.Pq Vt bool
1625If set to
1626.Dq Li YES ,
1627run the
1628.Xr rtsold 8
1629daemon at boot time.
1630The
1631.Xr rtsold 8
1632daemon is used for automatic discovery of non-link local addresses.
1633.It Va rtsold_flags
1634.Pq Vt str
1635If
1636.Va rtsold_enable
1637is set to
1638.Dq Li YES ,
1639these are the flags to pass to the
1640.Xr rtsold 8
1641daemon.
984263bc
MD
1642.It Va arpproxy_all
1643.Pq Vt bool
1644If set to
445243bf
RG
1645.Dq Li YES ,
1646enable global proxy ARP.
984263bc
MD
1647.It Va forward_sourceroute
1648.Pq Vt bool
1649If set to
445243bf
RG
1650.Dq Li YES
1651and
984263bc
MD
1652.Va gateway_enable
1653is also set to
445243bf
RG
1654.Dq Li YES ,
1655source-routed packets are forwarded.
984263bc
MD
1656.It Va accept_sourceroute
1657.Pq Vt bool
1658If set to
445243bf
RG
1659.Dq Li YES ,
1660the system will accept source-routed packets directed at it.
984263bc
MD
1661.It Va rarpd_enable
1662.Pq Vt bool
1663If set to
445243bf
RG
1664.Dq Li YES ,
1665run the
984263bc
MD
1666.Xr rarpd 8
1667daemon at system boot time.
1668.It Va rarpd_flags
1669.Pq Vt str
1670If
1671.Va rarpd_enable
1672is set to
445243bf 1673.Dq Li YES ,
984263bc
MD
1674these are the flags to pass to the
1675.Xr rarpd 8
1676daemon.
445243bf
RG
1677.It Va bootparamd_enable
1678.Pq Vt bool
1679If set to
1680.Dq Li YES ,
1681run the
1682.Xr bootparamd 8
1683daemon at system boot time.
1684.It Va bootparamd_flags
1685.Pq Vt str
1686If
1687.Va bootparamd_enable
1688is set to
1689.Dq Li YES ,
1690these are the flags to pass to the
1691.Xr bootparamd 8
1692daemon.
1693.It Va stf_interface_ipv4addr
1694.Pq Vt str
1695If not set to
1696.Dq Li NO ,
225e0ed5 1697this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
445243bf
RG
1698Specify this entry to enable the 6to4 interface.
1699.It Va stf_interface_ipv4plen
1700.Pq Vt int
1701Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1702An effective value is 0-31.
1703.It Va stf_interface_ipv6_ifid
1704.Pq Vt str
1705IPv6 interface ID for
1706.Xr stf 4 .
1707This can be set to
1708.Dq Li AUTO .
1709.It Va stf_interface_ipv6_slaid
1710.Pq Vt str
1711IPv6 Site Level Aggregator for
1712.Xr stf 4 .
1713.It Va ipv6_faith_prefix
1714.Pq Vt str
1715If not set to
1716.Dq Li NO ,
225e0ed5 1717this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
445243bf
RG
1718You also need
1719.Xr faithd 8
1720setup.
445243bf
RG
1721.It Va keybell
1722.Pq Vt str
1723The keyboard bell sound.
1724Set to
1725.Dq Li normal ,
1726.Dq Li visual ,
1727.Dq Li off ,
1728or
1729.Dq Li NO
1730if the default behavior is desired.
1731For details, refer to the
1732.Xr kbdcontrol 1
1733manpage.
984263bc
MD
1734.It Va keymap
1735.Pq Vt str
1736If set to
445243bf
RG
1737.Dq Li NO ,
1738no keymap is installed, otherwise the value is used to install
984263bc 1739the keymap file in
445243bf 1740.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
984263bc
MD
1741.It Va keyrate
1742.Pq Vt str
445243bf
RG
1743The keyboard repeat speed.
1744Set to
1745.Dq Li slow ,
1746.Dq Li normal ,
1747.Dq Li fast ,
984263bc 1748or
445243bf 1749.Dq Li NO
984263bc
MD
1750if the default behavior is desired.
1751.It Va keychange
1752.Pq Vt str
1753If not set to
445243bf
RG
1754.Dq Li NO ,
1755attempt to program the function keys with the value.
225e0ed5 1756The value should be a single string of the form:
445243bf 1757.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
984263bc
MD
1758.It Va cursor
1759.Pq Vt str
1760Can be set to the value of
445243bf
RG
1761.Dq Li normal ,
1762.Dq Li blink ,
1763.Dq Li destructive ,
984263bc 1764or
445243bf 1765.Dq Li NO
984263bc
MD
1766to set the cursor behavior explicitly or choose the default behavior.
1767.It Va scrnmap
1768.Pq Vt str
1769If set to
445243bf
RG
1770.Dq Li NO ,
1771no screen map is installed, otherwise the value is used to install
984263bc 1772the screen map file in
445243bf 1773.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
984263bc
MD
1774.It Va font8x16
1775.Pq Vt str
1776If set to
445243bf
RG
1777.Dq Li NO ,
1778the default 8x16 font value is used for screen size requests, otherwise
984263bc 1779the value in
445243bf 1780.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1781is used.
1782.It Va font8x14
1783.Pq Vt str
1784If set to
445243bf
RG
1785.Dq Li NO ,
1786the default 8x14 font value is used for screen size requests, otherwise
984263bc 1787the value in
445243bf 1788.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1789is used.
1790.It Va font8x8
1791.Pq Vt str
1792If set to
445243bf
RG
1793.Dq Li NO ,
1794the default 8x8 font value is used for screen size requests, otherwise
984263bc 1795the value in
445243bf 1796.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1797is used.
1798.It Va blanktime
1799.Pq Vt int
1800If set to
445243bf 1801.Dq Li NO ,
225e0ed5 1802the default screen blanking interval is used, otherwise it is set to
984263bc
MD
1803.Ar value
1804seconds.
1805.It Va saver
1806.Pq Vt str
1807If not set to
445243bf
RG
1808.Dq Li NO ,
1809this is the actual screen saver to use
1810.Li ( blank , snake , daemon ,
1811etc).
9463ea91
SW
1812.It Va moused_nondefault_enable
1813.Pq Vt str
1814If set to
1815.Dq Li NO ,
1816the mouse device specified on
1817the command line is not automatically treated as enabled by the
1818.Pa /etc/rc.d/moused
1819script.
1820Having this variable set to
1821.Dq Li YES
1822allows a
1823.Xr usb 4
1824mouse,
1825for example,
1826to be enabled as soon as it is plugged in.
984263bc
MD
1827.It Va moused_enable
1828.Pq Vt str
1829If set to
445243bf 1830.Dq Li YES ,
984263bc
MD
1831the
1832.Xr moused 8
1833daemon is started for doing cut/paste selection on the console.
1834.It Va moused_type
1835.Pq Vt str
1836This is the protocol type of the mouse connected to this host.
1837This variable must be set if
1838.Va moused_enable
1839is set to
445243bf 1840.Dq Li YES .
984263bc
MD
1841The
1842.Xr moused 8
1843daemon
1844is able to detect the appropriate mouse type automatically in many cases.
1845Set this variable to
445243bf 1846.Dq Li auto
984263bc
MD
1847to let the daemon detect it, or
1848select one from the following list if the automatic detection fails.
1849.Pp
1850If the mouse is attached to the PS/2 mouse port, choose
445243bf 1851.Dq Li auto
984263bc 1852or
445243bf
RG
1853.Dq Li ps/2 ,
1854regardless of the brand and model of the mouse.
225e0ed5 1855Likewise, if the mouse is attached to the bus mouse port, choose
445243bf 1856.Dq Li auto
984263bc 1857or
445243bf 1858.Dq Li busmouse .
984263bc
MD
1859All other protocols are for serial mice and will not work with
1860the PS/2 and bus mice.
1861If this is a USB mouse,
445243bf 1862.Dq Li auto
984263bc 1863is the only protocol type which will work.
445243bf
RG
1864.Pp
1865.Bl -tag -width ".Li x10mouseremote" -compact
1866.It Li microsoft
1867Microsoft mouse (serial)
1868.It Li intellimouse
1869Microsoft IntelliMouse (serial)
1870.It Li mousesystems
1871Mouse systems Corp. mouse (serial)
1872.It Li mmseries
1873MM Series mouse (serial)
1874.It Li logitech
1875Logitech mouse (serial)
1876.It Li busmouse
1877A bus mouse
1878.It Li mouseman
1879Logitech MouseMan and TrackMan (serial)
1880.It Li glidepoint
1881ALPS GlidePoint (serial)
1882.It Li thinkingmouse
1883Kensington ThinkingMouse (serial)
1884.It Li ps/2
1885PS/2 mouse
1886.It Li mmhittab
1887MM HitTablet (serial)
1888.It Li x10mouseremote
1889X10 MouseRemote (serial)
1890.It Li versapad
1891Interlink VersaPad (serial)
1892.El
984263bc
MD
1893.Pp
1894Even if the mouse is not in the above list, it may be compatible
1895with one in the list.
1896Refer to the man page for
1897.Xr moused 8
1898for compatibility information.
1899.Pp
1900It should also be noted that while this is enabled, any
1901other client of the mouse (such as an X server) should access
445243bf
RG
1902the mouse through the virtual mouse device,
1903.Pa /dev/sysmouse ,
1904and configure it as a
1905.Dq Li sysmouse
1906type mouse, since all
225e0ed5 1907mouse data is converted to this single canonical format when using
984263bc 1908.Xr moused 8 .
445243bf
RG
1909If the client program does not support the
1910.Dq Li sysmouse
225e0ed5 1911type, specify the
445243bf
RG
1912.Dq Li mousesystems
1913type.
984263bc
MD
1914It is the second preferred type.
1915.It Va moused_port
1916.Pq Vt str
1917If
1918.Va moused_enable
1919is set to
445243bf 1920.Dq Li YES ,
984263bc
MD
1921this is the actual port the mouse is on.
1922It might be
1923.Pa /dev/cuaa0
ad9f8794 1924for a COM1 serial mouse or
984263bc 1925.Pa /dev/psm0
ad9f8794 1926for a PS/2 mouse, for example.
984263bc
MD
1927.It Va moused_flags
1928.Pq Vt str
1929If
1930.Va moused_type
1931is set, these are the additional flags to pass to the
1932.Xr moused 8
1933daemon.
445243bf
RG
1934.It Va mousechar_start
1935.Pq Vt int
1936If set to
1937.Dq Li NO ,
1938the default mouse cursor character range
1939.Li 0xd0 Ns - Ns Li 0xd3
225e0ed5 1940is used, otherwise the range start is set to
445243bf
RG
1941.Ar value
1942character, see
1943.Xr vidcontrol 1 .
1944Use if the default range is occupied in the language code table.
850afac2
SW
1945.It Va vidhistory
1946.Pq Vt int
1947Set the size of the history (scrollback) buffer in lines.
984263bc
MD
1948.It Va allscreens_flags
1949.Pq Vt str
1950If set,
1951.Xr vidcontrol 1
1952is run with these options for each of the virtual terminals
1953.Pq Pa /dev/ttyv* .
1954For example,
445243bf 1955.Dq Fl m Cm on
225e0ed5 1956will enable the mouse pointer on all virtual terminals if
984263bc
MD
1957.Va moused_enable
1958is set to
445243bf
RG
1959.Dq Li YES .
1960.It Va allscreens_kbdflags
1961.Pq Vt str
1962If set,
1963.Xr kbdcontrol 1
1964is run with these options for each of the virtual terminals
1965.Pq Pa /dev/ttyv* .
1966For example,
1967.Dq Fl h Li 200
1968will set the
1969.Xr syscons 4
1970scrollback (history) buffer to 200 lines.
984263bc
MD
1971.It Va cron_enable
1972.Pq Vt bool
1973If set to
445243bf
RG
1974.Dq Li YES ,
1975run the
984263bc
MD
1976.Xr cron 8
1977daemon at system boot time.
1978.It Va cron_program
1979.Pq Vt str
1980Path to
1981.Xr cron 8
1982(default
1983.Pa /usr/sbin/cron ) .
1984.It Va cron_flags
1985.Pq Vt str
1986If
1987.Va cron_enable
1988is set to
445243bf 1989.Dq Li YES ,
984263bc
MD
1990these are the flags to pass to
1991.Xr cron 8 .
1992.It Va lpd_program
1993.Pq Vt str
1994Path to
1995.Xr lpd 8
1996(default
1997.Pa /usr/sbin/lpd ) .
1998.It Va lpd_enable
1999.Pq Vt bool
2000If set to
445243bf
RG
2001.Dq Li YES ,
2002run the
984263bc
MD
2003.Xr lpd 8
2004daemon at system boot time.
2005.It Va lpd_flags
2006.Pq Vt str
2007If
2008.Va lpd_enable
2009is set to
445243bf 2010.Dq Li YES ,
984263bc
MD
2011these are the flags to pass to the
2012.Xr lpd 8
2013daemon.
52163b73
SW
2014.It Va nscd_enable
2015.Pq Vt bool
2016If set to
2017.Dq Li YES ,
2018run the
2019.Xr nscd 8
2020daemon at system boot time.
850afac2
SW
2021.It Va mixer_enable
2022.Pq Vt bool
2023If set to
2024.Dq Li YES ,
2025preserve
2026.Xr mixer 8
2027settings across reboots.
984263bc
MD
2028.It Va mta_start_script
2029.Pq Vt str
717e8ef7 2030The full path to the script to run to start
984263bc
MD
2031a mail transfer agent.
2032The default is
2033.Pa /etc/rc.sendmail .
2034The
2035.Va sendmail_*
2036variables which
2037.Pa /etc/rc.sendmail
2038uses are documented in the
2039.Xr rc.sendmail 8
2040man page.
a12bb799
SW
2041.It Va fixbootfile
2042.Pq Vt bool
2043In a
2044.Sq HAMMER ROOT with UFS /boot
2045setup, the boot loader will not set up the
2046.Va kern.bootfile
2047sysctl correctly.
2048The system will attempt to fix this on its own.
2049Set this variable to
2050.Dq Li NO
2051to turn this behavior off.
984263bc
MD
2052.It Va dumpdev
2053.Pq Vt str
2054Indicates the device (usually a swap partition) to which a crash dump
2055should be written in the event of a system crash.
2056The value of this variable is passed as the argument to
f8e9b4ce
MD
2057.Xr dumpon 8
2058and
2059.Xr savecore 8 .
984263bc 2060To disable crash dumps, set this variable to
445243bf 2061.Dq Li NO .
984263bc
MD
2062.It Va dumpdir
2063.Pq Vt str
2064When the system reboots after a crash and a crash dump is found on the
2065device specified by the
2066.Va dumpdev
2067variable,
2068.Xr savecore 8
2069will save that crash dump and a copy of the kernel to the directory
2070specified by the
2071.Va dumpdir
2072variable.
2073The default value is
445243bf 2074.Pa /var/crash .
984263bc 2075Set to
445243bf 2076.Dq Li NO
984263bc
MD
2077to not run
2078.Xr savecore 8
2079at boot time when
2080.Va dumpdir
2081is set.
2082.It Va savecore_flags
2083.Pq Vt str
2084If crash dumps are enabled, these are the flags to pass to the
2085.Xr savecore 8
2086utility.
7fb3111b
AH
2087.It Va crashinfo_enable
2088.Pq Vt bool
2089Set to
2090.Dq Li YES
2091to turn on automatic crash dump summary generation using the utility
2092specified by the
2093.Va crashinfo_program
2094variable.
2095.It Va crashinfo_program
2096.Pq Vt str
2097Program to run to generate a crash dump summary if the variable
2098.Va crashinfo_enable
2099is set to
2100.Dq Li YES .
2101The default value is
2102.Pa /usr/sbin/crashinfo .
984263bc
MD
2103.It Va enable_quotas
2104.Pq Vt bool
2105Set to
445243bf 2106.Dq Li YES
984263bc
MD
2107to turn on user disk quotas on system startup via the
2108.Xr quotaon 8
2109command.
2110.It Va check_quotas
2111.Pq Vt bool
2112Set to
445243bf 2113.Dq Li YES
984263bc
MD
2114to enable user disk quota checking via the
2115.Xr quotacheck 8
2116command.
2117.It Va accounting_enable
2118.Pq Vt bool
2119Set to
445243bf 2120.Dq Li YES
984263bc
MD
2121to enable system accounting through the
2122.Xr accton 8
2123facility.
984263bc
MD
2124.It Va linux_enable
2125.Pq Vt bool
2126Set to
445243bf 2127.Dq Li YES
225e0ed5 2128to enable Linux/ELF binary emulation at system initial boot time.
de5b97b6
MD
2129.\" ----- cleanvar_enable setting--------------------------------
2130.It Va cleanvar_enable
2131.Pq Vt bool
2132Set to
2133.Dq Li YES
2134to have
2135.Pa /var/run ,
2136.Pa /var/spool/lock
2137and
2138.Pa /var/spool/uucp/.Temp/*
2139cleaned at startup.
2140.\" ----- clear_tmp_enable setting-------------------------------
984263bc
MD
2141.It Va clear_tmp_enable
2142.Pq Vt bool
2143Set to
445243bf 2144.Dq Li YES
984263bc
MD
2145to have
2146.Pa /tmp
2147cleaned at startup.
de5b97b6 2148.\" ----- ldconfig_paths setting --------------------------------
984263bc
MD
2149.It Va ldconfig_paths
2150.Pq Vt str
2151Set to the list of shared library paths to use with
2152.Xr ldconfig 8 .
2153NOTE:
2154.Pa /usr/lib
2155will always be added first, so it need not appear in this list.
2156.It Va ldconfig_insecure
2157.Pq Vt bool
2158The
2159.Xr ldconfig 8
2160utility normally refuses to use directories
2161which are writable by anyone except root.
2162Set this variable to
445243bf 2163.Dq Li YES
984263bc 2164to disable that security check during system startup.
6496b71f
PA
2165.It Va ldconfig_local_dirs
2166.Pq Vt str
2167Set to the list of local
2168.Xr ldconfig 8
2169directories.
2170The names of all files in the directories listed will be
2171passed as arguments to
2172.Xr ldconfig 8 .
984263bc
MD
2173.It Va kern_securelevel
2174.Pq Vt int
2175The kernel security level to set at startup.
2176The allowed range of
2177.Ar value
225e0ed5 2178ranges from \-1 (the compile time default) to 3 (the most secure).
445243bf 2179See
984263bc 2180.Xr init 8
225e0ed5 2181for the list of possible security levels and their effect on system operation.
984263bc
MD
2182.It Va start_vinum
2183.Pq Vt bool
2184Set to
445243bf 2185.Dq Li YES
984263bc
MD
2186to start
2187.Xr vinum 8
2188at system boot time.
984263bc
MD
2189.It Va sshd_enable
2190.Pq Vt bool
2191Set to
445243bf 2192.Dq Li YES
984263bc
MD
2193to start
2194.Xr sshd 8
2195at system boot time.
850afac2
SW
2196.It Va sshd_program
2197.Pq Vt str
2198Path to the SSH server program
717e8ef7
TN
2199(default
2200.Pa /usr/sbin/sshd ) .
984263bc
MD
2201.It Va sshd_flags
2202.Pq Vt str
2203If
2204.Va sshd_enable
2205is set to
445243bf 2206.Dq Li YES ,
984263bc
MD
2207these are the flags to pass to the
2208.Xr sshd 8
2209daemon.
850afac2
SW
2210.It Va ftpd_enable
2211.Pq Vt bool
2212Set to
2213.Dq Li YES
2214to start
2215.Xr ftpd 8
2216at system boot time.
2217.It Va ftpd_flags
2218.Pq Vt str
2219If
2220.Va ftpd_enable
2221is set to
2222.Dq Li YES ,
2223these are the flags to pass to the
2224.Xr ftpd 8
2225daemon.
445243bf
RG
2226.It Va watchdogd_enable
2227.Pq Vt bool
2228If set to
2229.Dq Li YES ,
2230start the
2231.Xr watchdogd 8
2232daemon at boot time.
2233This requires that the kernel have been compiled with
2234.Cd "options WATCHDOG" .
2235.It Va jail_enable
2236.Pq Vt bool
2237If set to
2238.Dq Li NO ,
2239any configured jails will not be started.
2240.It Va jail_list
2241.Pq Vt str
2242A space separated list of names for jails.
2243This is purely a configuration aid to help identify and
2244configure multiple jails.
2245The names specified in this list will be used to
2246identify settings common to an instance of a jail.
2247Assuming that the jail in question was named
2248.Li vjail ,
56be8454 2249you would have the following dependent variables:
445243bf
RG
2250.Bd -literal
2251jail_vjail_hostname="jail.example.com"
2252jail_vjail_ip="192.168.1.100"
2253jail_vjail_rootdir="/var/jails/vjail/root"
445243bf 2254.Ed
b58abc5e
SW
2255.It Va jail_flags
2256.Pq Vt str
2257Unset by default.
2258When set, use as default value for
2259.Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2260for every jail in
2261.Va jail_list .
2262.It Va jail_interface
2263.Pq Vt str
2264Unset by default.
2265When set, use as default value for
2266.Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2267for every jail in
2268.Va jail_list .
2269.It Va jail_fstab
2270.Pq Vt str
2271Unset by default.
2272When set, use as default value for
2273.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2274for every jail in
2275.Va jail_list .
2276.It Va jail_mount_enable
2277.Pq Vt bool
2278Set to
2279.Dq Li NO
2280by default.
2281When set to
2282.Dq Li YES ,
2283sets
2284.Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2285to
2286.Dq Li YES
2287by default for every jail in
2288.Va jail_list .
b58abc5e
SW
2289.It Va jail_procfs_enable
2290.Pq Vt bool
2291Set to
2292.Dq Li NO
2293by default.
2294When set to
2295.Dq Li YES ,
2296sets
36c417a0 2297.Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
b58abc5e
SW
2298to
2299.Dq Li YES
2300by default for every jail in
2301.Va jail_list .
f8ff0183
AHJ
2302.It Va jail_devfs_enable
2303.Pq Vt bool
2304Set to
2305.Dq Li NO
2306by default.
2307When set to
2308.Dq Li YES ,
2309sets
2310.Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2311to
2312.Dq Li YES
2313by default for every jail in
2314.Va jail_list .
b58abc5e
SW
2315.It Va jail_exec_start
2316.Pq Vt str
2317Unset by default.
2318When set, use as default value for
2319.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2320for every jail in
2321.Va jail_list .
2322.It Va jail_exec_stop
2323Unset by default.
2324When set, use as default value for
2325.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2326for every jail in
2327.Va jail_list .
2328.It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2329.Pq Vt str
2330Unset by default.
2331Set to the root directory used by jail
2332.Va jname .
2333.It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2334.Pq Vt str
2335Unset by default.
2336Set to the fully qualified domain name (FQDN) assigned to jail
2337.Va jname .
2338.It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2339.Pq Vt str
2340Unset by default.
2341Set to the IP address assigned to jail
2342.Va jname .
2343.It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2344.Pq Vt str
2345Set to
2346.Dq Li -l -U root
2347by default.
2348These are flags to pass to
20ab1ccc 2349.Xr jail 8 .
b58abc5e
SW
2350.It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2351.Pq Vt str
2352Unset by default.
2353When set, sets the interface to use when setting IP address alias.
2354Note that the alias is created at jail startup and removed at jail shutdown.
2355.It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2356.Pq Vt str
2357Set to
2358.Pa /etc/fstab. Ns Aq Ar jname
2359by default.
2360This is the file system information file to use for jail
2361.Va jname .
2362.It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2363.Pq Vt bool
2364Set to
2365.Dq Li NO
2366by default.
2367When set to
2368.Dq Li YES ,
2369mount all file systems from
2370.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2371at jail startup.
b58abc5e
SW
2372.It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2373.Pq Vt bool
2374Set to
2375.Dq Li NO
2376by default.
2377When set to
2378.Dq Li YES ,
2379mount the process file system inside jail
2380.Ar jname
2381at jail startup.
f8ff0183
AHJ
2382.It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2383.Pq Vt bool
2384Set to
2385.Dq Li NO
2386by default.
2387When set to
2388.Dq Li YES ,
2389mount the device file system inside jail
2390.Ar jname
2391at jail startup.
b58abc5e
SW
2392.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2393.Pq Vt str
2394Set to
2395.Dq Li /bin/sh /etc/rc
2396by default.
2397This is the command executed at jail startup.
2398.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2399.Pq Vt str
2400Set to
2401.Dq Li /bin/sh /etc/rc.shutdown
2402by default.
2403This is the command executed at jail shutdown.
445243bf
RG
2404.It Va jail_set_hostname_allow
2405.Pq Vt bool
2406If set to
2407.Dq Li NO ,
2408do not allow the root user in a jail to set its hostname.
2409.It Va jail_socket_unixiproute_only
2410.Pq Vt bool
2411If set to
b58abc5e
SW
2412.Dq Li YES ,
2413do not allow any sockets,
2414besides UNIX/IP/route sockets,
2415to be used within a jail.
445243bf
RG
2416.It Va jail_sysvipc_allow
2417.Pq Vt bool
2418If set to
2419.Dq Li YES ,
2420allow applications within a jail to use System V IPC.
0e132b2a
AH
2421.It Va lvm_enable
2422.Pq Vt bool
2423If set to
2424.Dq Li YES
2425LVM volumes will be discovered and configured on boot.
842eea5b
SW
2426.It Va newsyslog_enable
2427.Pq Vt bool
2428If set to
2429.Dq Li YES ,
2430run
2431.Xr newsyslog 8
2432before syslogd starts.
2433.It Va newsyslog_flags
2434.Pq Vt str
2435If
2436.Va newsyslog_enable
2437is set to
2438.Dq Li YES ,
2439these are the flags passed to
2440.Xr newsyslog 8 .
850afac2
SW
2441.It Va resident_enable
2442.Pq Vt bool
2443If set to
2444.Dq Li YES ,
2445make the dynamic binaries listed in
2446.Pa /etc/resident.conf
2447resident.
2448.It Va varsym_enable
2449.Pq Vt bool
2450If set to
2451.Dq Li YES ,
2452process
2453.Pa /etc/varsym.conf
2454to set system-wide variables for variant symlinks.
705d55f1 2455.It Va rand_irqs
850afac2
SW
2456.Pq Vt str
2457Set either to
2458.Dq Li NO
2459or a whitespace separated list of IRQ numbers which will be used as a source of
2460randomness.
984263bc 2461.\" -----------------------------------------------------
445243bf
RG
2462.It Va entropy_dir
2463.Pq Vt str
2464Set to
2465.Dq Li NO
2466to disable caching entropy via
2467.Xr cron 8 .
2468Otherwise set to the directory used to store entropy files in.
2469.It Va entropy_file
2470.Pq Vt str
2471Set to
2472.Dq Li NO
2473to disable caching entropy through reboots.
225e0ed5 2474Otherwise set to the filename used to store cached entropy through reboots.
445243bf
RG
2475This file should be located on the root file system to seed the
2476.Xr random 4
2477device as early as possible in the boot process.
ceccfc6b
AH
2478.It Va entropy_save_sz
2479.Pq Vt int
2480Determines the size of the entropy cache files used for entropy cached
2481through reboots and also entropy cached via
2482.Xr cron 8 .
2483The entropy is fed to the system in blocks of 512 bytes, so this number
2484should be large enough to fill as many of the entropy pools in the kernel
2485CSPRNG as possible.
2486By default, it is set to 16384, which should be able to seed all 32 entropy
2487pools in the Fortuna CSPRNG.
445243bf
RG
2488.It Va ipsec_enable
2489.Pq Vt bool
2490Set to
2491.Dq Li YES
2492to run
2493.Xr setkey 8
2494on
2495.Va ipsec_file
2496at boot time.
2497.It Va ipsec_file
2498.Pq Vt str
2499Configuration file for
2500.Xr setkey 8 .
2501.It Va dmesg_enable
2502.Pq Vt bool
2503Set to
2504.Dq Li YES
2505to save
2506.Xr dmesg 8
2507to
2508.Pa /var/run/dmesg.boot
2509on boot.
2510.It Va rcshutdown_timeout
2511.Pq Vt int
2512If set, start a watchdog timer in the background which will terminate
2513.Pa rc.shutdown
2514if
2515.Xr shutdown 8
2516has not completed within the specified time (in seconds).
699c19e3
SW
2517Notice that in addition to this soft timeout,
2518.Xr init 8
2519also applies a hard timeout for the execution of
2520.Pa rc.shutdown .
2521This is configured via
2522.Xr sysctl 8
2523variable
2524.Va kern.init_shutdown_timeout
2525and defaults to 120 seconds. Setting the value of
2526.Va rcshutdown_timeout
2527to more than 120 seconds will have no effect until the
2528.Xr sysctl 8
2529variable
2530.Va kern.init_shutdown_timeout
2531is also increased.
0e132b2a
AH
2532.It Va udevd_enable
2533.Pq Vt bool
2534If set to
2535.Dq Li YES ,
2536the udevd daemon will be started on boot.
7f180e19 2537.It Va vfs_quota_enable
9be2bba0
FT
2538.Pq Vt bool
2539If set to
2540.Dq Li YES ,
7f180e19
FT
2541vfs quota rc.d scripts will be run on boot.
2542.It Va vfs_quota_sync
9be2bba0
FT
2543.Pq Vt str
2544List of mount points whose counters are to be synchronized with on-disk
2545usage during system startup. See also
2546.Xr vquota 8 .
ff625697
AHJ
2547.It Va vknetd_enable
2548.Pq Vt bool
b7610907 2549If set to
ff625697
AHJ
2550.Dq Li YES ,
2551.Xr vknetd 8
2552will be started on boot.
2553.It Va vknetd_flags
2554.Pq Vt bool
2555Additional flags passed to
2556.Xr vknetd 8 .
2557Usually address/cidrbits is specified here.
2558When no flags are passed, default option
2559.Fl U
2560will be used.
2feb07f7
SW
2561.It Va vkernel_enable
2562.Pq Vt bool
2563If set to
2564.Dq Li NO ,
2565any configured vkernels will not be started.
fa568972
R
2566.It Va vkernel_kill_timeout
2567.Pq Vt int
2568This defines the default number of seconds that we will wait for the
2569vkernel to shut down on it's own. If after this time it's still alive,
2570it will be killed with SIGKILL.
2571.It Va vkernel_bin
2572.Pq Vt str
2573Defines the default path to the vkernel binary.
2feb07f7
SW
2574.It Va vkernel_list
2575.Pq Vt str
2576A space separated list of names for vkernels.
2577This is purely a configuration aid to help identify and
2578configure multiple vkernels.
2579The names specified in this list will be used to
2580identify settings common to a vkernel instance.
2581Assuming that the vkernel in question was named
2582.Li example ,
2583you would have the following dependent variables
2584(filled with reference values in this text):
2585.Bd -literal
2586vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2587vkernel_example_memsize="64m"
2588vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2589vkernel_example_iface_list="auto:bridge0"
2590vkernel_example_logfile="/dev/null"
2591vkernel_example_flags="-U"
fa568972 2592vkernel_example_kill_timeout="45"
2feb07f7
SW
2593.Ed
2594.Pp
fa568972 2595The last five are optional.
2feb07f7
SW
2596They default to an empty string if not set, except for logfile which defaults to
2597.Pa /dev/null
2598if it is not set.
984263bc
MD
2599.El
2600.Sh FILES
717e8ef7 2601.Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
984263bc
MD
2602.It Pa /etc/defaults/rc.conf
2603.It Pa /etc/rc.conf
2604.It Pa /etc/rc.conf.local
717e8ef7 2605.It Pa /etc/start_if. Ns Aq Ar interface
984263bc
MD
2606.El
2607.Sh SEE ALSO
2608.Xr catman 1 ,
2609.Xr gdb 1 ,
2610.Xr info 1 ,
445243bf 2611.Xr kbdcontrol 1 ,
850afac2 2612.Xr varsym 1 ,
984263bc 2613.Xr vidcontrol 1 ,
445243bf 2614.Xr ip 4 ,
27e9fed5 2615.Xr ipfw 4 ,
445243bf 2616.Xr kld 4 ,
27e9fed5 2617.Xr pf 4 ,
984263bc
MD
2618.Xr tcp 4 ,
2619.Xr udp 4 ,
ccb8cebe 2620.Xr vlan 4 ,
984263bc
MD
2621.Xr exports 5 ,
2622.Xr motd 5 ,
850afac2
SW
2623.Xr resident.conf 5 ,
2624.Xr varsym.conf 5 ,
984263bc
MD
2625.Xr accton 8 ,
2626.Xr amd 8 ,
5f834906 2627.Xr btconfig 8 ,
ec4e37b7 2628.Xr bthcid 8 ,
984263bc 2629.Xr cron 8 ,
4b8c406a 2630.Xr devd 8 ,
984263bc 2631.Xr dhclient 8 ,
c54db4b1 2632.Xr dntpd 8 ,
850afac2 2633.Xr ftpd 8 ,
984263bc
MD
2634.Xr ifconfig 8 ,
2635.Xr inetd 8 ,
b58abc5e 2636.Xr jail 8 ,
984263bc 2637.Xr lpd 8 ,
375d1659 2638.Xr makewhatis 8 ,
850afac2 2639.Xr mixer 8 ,
984263bc
MD
2640.Xr mountd 8 ,
2641.Xr moused 8 ,
2642.Xr mrouted 8 ,
2643.Xr named 8 ,
2644.Xr nfsd 8 ,
984263bc 2645.Xr pcnfsd 8 ,
27e9fed5
SW
2646.Xr pfctl 8 ,
2647.Xr pflogd 8 ,
984263bc
MD
2648.Xr quotacheck 8 ,
2649.Xr quotaon 8 ,
2650.Xr rc 8 ,
2651.Xr rc.sendmail 8 ,
850afac2
SW
2652.Xr resident 8 ,
2653.Xr rndcontrol 8 ,
984263bc
MD
2654.Xr route 8 ,
2655.Xr routed 8 ,
3b813696 2656.Xr rpcbind 8 ,
984263bc
MD
2657.Xr rpc.lockd 8 ,
2658.Xr rpc.statd 8 ,
717e8ef7 2659.Xr rtadvd 8 ,
bdbd8a5b 2660.Xr rtsold 8 ,
984263bc
MD
2661.Xr rwhod 8 ,
2662.Xr savecore 8 ,
5f834906 2663.Xr sdpd 8 ,
eb3a3472 2664.Xr sensorsd 8 ,
984263bc
MD
2665.Xr sshd 8 ,
2666.Xr swapon 8 ,
2667.Xr sysctl 8 ,
2668.Xr syslogd 8 ,
57de1762 2669.Xr sysvipcd 8 ,
984263bc
MD
2670.Xr timed 8 ,
2671.Xr vinum 8 ,
984263bc
MD
2672.Xr yp 8 ,
2673.Xr ypbind 8 ,
2674.Xr ypserv 8 ,
2675.Xr ypset 8
2676.Sh HISTORY
2677The
2678.Nm
2679file appeared in
2680.Fx 2.2.2 .
2681.Sh AUTHORS
2682.An Jordan K. Hubbard .