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