rc.d: rename vfs_accounting to vfs_quota
[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.\"
62f17e14 27.Dd March 11, 2012
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
62f17e14
SW
678wlans_wi0="wlan0"
679ifconfig_wlan0="up DHCP WPA mode 11b"
f26c267a
SW
680.Ed
681.Pp
717e8ef7
TN
682.\"
683.It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
684.Pq Vt str
685Configuration to establish an additional network address for
686.Dq interface .
687Assuming that the interface in question was
688.Li ed0 ,
689it might look something like this:
690.Bd -literal
691ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
692ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
693.Ed
694.Pp
695And so on.
696For each
697.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
698entry that is found, its contents are passed to
699.Xr ifconfig 8 .
700Execution stops at the first unsuccessful access, so if
701something like this is present:
702.Bd -literal
703ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
704ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
705ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
706ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
707.Ed
708.Pp
709Then note that alias4 would
710.Em not
711be added since the search would stop with the missing alias3 entry.
712.Pp
713.\"
714.It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
715.Pq Vt str
716New name for
717.Dq interface .
718It is possible to rename interface by doing:
f26c267a
SW
719.Bd -literal
720ifconfig_ed0_name="net0"
721ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
722.Ed
717e8ef7
TN
723.It Va network_interfaces
724.Pq Vt str
725The list of network interfaces to configure on this host,
726or
727.Dq Li auto
728to configure all network interfaces
729(default
730.Dq Li auto ) .
731For example, if the only network devices to be configured are the loopback device
732.Pq Li lo0
733and a NIC using the
734.Xr ed 4
735driver, this could be set to
736.Dq Li "lo0 ed0" .
737An
738.Va ifconfig_ Ns Aq Ar interface
739variable is assumed to exist for each value of
740.Ar interface .
445243bf
RG
741.It Va ipv6_network_interfaces
742.Pq Vt str
743This is the IPv6 equivalent of
744.Va network_interfaces .
745Instead of setting the ifconfig variables as
746.Va ifconfig_ Ns Aq Ar interface
747they should be set as
748.Va ipv6_ifconfig_ Ns Aq Ar interface .
749Aliases should be set as
750.Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
445243bf
RG
751Interfaces that do not have a
752.Va ipv6_ifconfig_ Ns Aq Ar interface
753setting will be auto configured by
754.Xr rtsol 8
755if the
756.Va ipv6_gateway_enable
757is set to
758.Dq Li NO .
759Note that the IPv6 networking code does not support the
760.Pa /etc/start_if. Ns Aq Ar interface
761files.
717e8ef7
TN
762.It Va ipv6_prefix_ Ns Aq Ar interface
763.Pq Vt str
764Assign prefix to
765.Ar interface ,
766prefixlen 64 is used.
445243bf
RG
767.It Va ipv6_default_interface
768.Pq Vt str
769If not set to
770.Dq Li NO ,
771this is the default output interface for scoped addresses.
772Now this works only for IPv6 link local multicast addresses.
984263bc
MD
773.It Va cloned_interfaces
774.Pq Vt str
775Set to the list of clonable network interfaces to create on this host.
776Entries in
777.Va cloned_interfaces
778are automatically appended to
779.Va network_interfaces
780for configuration.
781.It Va gif_interfaces
782.Pq Vt str
783Set to the list of
784.Xr gif 4
785tunnel interfaces to configure on this host.
786A
787.Va gifconfig_ Ns Aq Ar interface
788variable is assumed to exist for each value of
789.Ar interface .
790The value of this variable is used to configure the link layer of the
791tunnel according to the syntax of the
792.Cm tunnel
793option to
794.Xr ifconfig 8 .
225e0ed5 795Additionally, this option ensures that each listed interface is created via the
984263bc
MD
796.Cm create
797option to
798.Xr ifconfig 8
799before attempting to configure it.
445243bf
RG
800.It Va sppp_interfaces
801.Pq Vt str
802Set to the list of
803.Xr sppp 4
804interfaces to configure on this host.
805A
806.Va spppconfig_ Ns Aq Ar interface
807variable is assumed to exist for each value of
808.Ar interface .
809Each interface should also be configured by a general
810.Va ifconfig_ Ns Aq Ar interface
811setting.
812Refer to
813.Xr spppcontrol 8
814for more information about available options.
984263bc
MD
815.It Va ppp_enable
816.Pq Vt bool
817If set to
445243bf 818.Dq Li YES ,
984263bc
MD
819run the
820.Xr ppp 8
821daemon.
822.It Va ppp_mode
823.Pq Vt str
824Mode in which to run the
825.Xr ppp 8
445243bf
RG
826daemon.
827Accepted modes are
828.Dq Li auto ,
829.Dq Li ddial ,
830.Dq Li direct
984263bc 831and
445243bf 832.Dq Li dedicated .
984263bc
MD
833See the manual for a full description.
834.It Va ppp_nat
835.Pq Vt bool
836If set to
445243bf
RG
837.Dq Li YES ,
838enables network address translation.
984263bc
MD
839Used in conjunction with
840.Va gateway_enable
841allows hosts on private network addresses access to the Internet using
842this host as a network address translating router.
843.It Va ppp_profile
844.Pq Vt str
845The name of the profile to use from
846.Pa /etc/ppp/ppp.conf .
847.It Va ppp_user
848.Pq Vt str
445243bf
RG
849The name of the user under which
850.Xr ppp 8
851should be started.
225e0ed5 852By default,
445243bf
RG
853.Xr ppp 8
854is started as
855.Dq Li root .
984263bc
MD
856.It Va rc_conf_files
857.Pq Vt str
858This option is used to specify a list of files that will override
859the settings in
860.Pa /etc/defaults/rc.conf .
861The files will be read in the order in which they are specified and should
862include the full path to the file.
863By default, the files specified are
864.Pa /etc/rc.conf
865and
866.Pa /etc/rc.conf.local
867.It Va fsck_y_enable
868.Pq Vt bool
869If set to
445243bf 870.Dq Li YES ,
984263bc 871.Xr fsck 8
445243bf
RG
872will be run with the
873.Fl y
225e0ed5 874flag if the initial preen of the file systems fails.
445243bf
RG
875.It Va netfs_types
876.Pq Vt str
877List of file system types that are network-based.
878This list should generally not be modified by end users.
879Use
880.Va extra_netfs_types
881instead.
882.It Va extra_netfs_types
883.Pq Vt str
884If set to something other than
885.Dq Li NO
225e0ed5 886(the default), this variable extends the list of file system types
445243bf
RG
887for which automatic mounting at startup by
888.Xr rc 8
889should be delayed until the network is initialized.
890It should contain
891a whitespace-separated list of network file system descriptor pairs,
892each consisting of a file system type as passed to
893.Xr mount 8
225e0ed5 894and a human-readable, one-word description, joined with a colon
445243bf
RG
895.Pq Ql \&: .
896Extending the default list in this way is only necessary
897when third party file system types are used.
a46854c7
MS
898.It Va devfs_config_files
899.Pq Vt str
900This option is used to specify a list of configuration files containing
901.Xr devfs 5
902rules that will be applied by
903.Xr devfsctl 8
904in the order in which they are specified and must include the full path
905to the file.
984263bc
MD
906.It Va syslogd_enable
907.Pq Vt bool
908If set to
445243bf 909.Dq Li YES ,
984263bc
MD
910run the
911.Xr syslogd 8
912daemon.
913.It Va syslogd_program
914.Pq Vt str
915Path to
916.Xr syslogd 8
917(default
918.Pa /usr/sbin/syslogd ) .
919.It Va syslogd_flags
920.Pq Vt str
921If
922.Va syslogd_enable
923is set to
445243bf 924.Dq Li YES ,
984263bc
MD
925these are the flags to pass to
926.Xr syslogd 8 .
927.It Va inetd_enable
928.Pq Vt bool
929If set to
445243bf 930.Dq Li YES ,
984263bc
MD
931run the
932.Xr inetd 8
933daemon.
934.It Va inetd_program
935.Pq Vt str
936Path to
937.Xr inetd 8
938(default
939.Pa /usr/sbin/inetd ) .
940.It Va inetd_flags
941.Pq Vt str
942If
943.Va inetd_enable
944is set to
445243bf 945.Dq Li YES ,
984263bc
MD
946these are the flags to pass to
947.Xr inetd 8 .
984263bc
MD
948.It Va rwhod_enable
949.Pq Vt bool
950If set to
445243bf 951.Dq Li YES ,
984263bc
MD
952run the
953.Xr rwhod 8
954daemon at boot time.
955.It Va rwhod_flags
956.Pq Vt str
957If
958.Va rwhod_enable
959is set to
445243bf 960.Dq Li YES ,
984263bc
MD
961these are the flags to pass to it.
962.It Va amd_enable
963.Pq Vt bool
964If set to
445243bf 965.Dq Li YES ,
984263bc
MD
966run the
967.Xr amd 8
968daemon at boot time.
969.It Va amd_flags
970.Pq Vt str
971If
972.Va amd_enable
973is set to
445243bf 974.Dq Li YES ,
984263bc
MD
975these are the flags to pass to it.
976See the
977.Xr amd 8
445243bf 978manpage for more information.
984263bc
MD
979.It Va amd_map_program
980.Pq Vt str
225e0ed5 981If set, the specified program is run to get the list of
984263bc
MD
982.Xr amd 8
983maps.
984For example, if the
985.Xr amd 8
225e0ed5 986maps are stored in NIS, one can set this to run
984263bc
MD
987.Xr ypcat 1
988to get a list of
989.Xr amd 8
990maps from the
991.Pa amd.master
992NIS map.
993.It Va update_motd
994.Pq Vt bool
995If set to
445243bf 996.Dq Li YES ,
984263bc 997.Pa /etc/motd
225e0ed5 998will be updated at boot time to reflect the kernel release being run.
445243bf
RG
999If set to
1000.Dq Li NO ,
984263bc 1001.Pa /etc/motd
445243bf 1002will not be updated.
984263bc
MD
1003.It Va nfs_client_enable
1004.Pq Vt bool
1005If set to
445243bf 1006.Dq Li YES ,
14791e19 1007setup NFS client parameters at boot time.
984263bc
MD
1008.It Va nfs_access_cache
1009.Pq Vt int
1010If
1011.Va nfs_client_enable
1012is set to
445243bf 1013.Dq Li YES ,
984263bc 1014this can be set to
445243bf 1015.Dq Li 0
984263bc 1016to disable NFS ACCESS RPC caching, or to the number of seconds for which
225e0ed5 1017NFS ACCESS results should be cached.
d615ff4f 1018A value of 2-10 seconds will substantially reduce network traffic for
225e0ed5
SW
1019many NFS operations.
1020The default is 5 seconds.
1021Note that the attribute cache holds stat information only.
1022The NFS data cache is independent of the attribute cache and is only
1023invalidated when the client detects that the server has modified the
1024underlying file.
1025This value specifies a maximum timeout.
1026The NFS client will automatically use a shorter timeout for files which
1027have been recently modified.
d615ff4f
MD
1028.It Va nfs_neg_cache
1029.Pq Vt int
1030If
1031.Va nfs_client_enable
1032is set to
1033.Dq Li YES ,
1034this can be set to
1035.Dq Li 0
3f5e28f4 1036to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
d615ff4f
MD
1037filenames), or to the number of seconds for which negative lookups should
1038be cached.
984263bc 1039A value of 2-10 seconds will substantially reduce network
225e0ed5
SW
1040traffic for many NFS operations, especially source code builds.
1041The default is 3 seconds.
984263bc
MD
1042.It Va nfs_server_enable
1043.Pq Vt bool
1044If set to
445243bf 1045.Dq Li YES ,
984263bc
MD
1046run the NFS server daemons at boot time.
1047.It Va nfs_server_flags
1048.Pq Vt str
1049If
1050.Va nfs_server_enable
1051is set to
445243bf 1052.Dq Li YES ,
984263bc
MD
1053these are the flags to pass to the
1054.Xr nfsd 8
1055daemon.
445243bf 1056.It Va mountd_enable
984263bc
MD
1057.Pq Vt bool
1058If set to
445243bf 1059.Dq Li YES ,
984263bc
MD
1060and no
1061.Va nfs_server_enable
1062is set, start
1063.Xr mountd 8 ,
1064but not
1065.Xr nfsd 8
1066daemon.
1067It is commonly needed to run CFS without real NFS used.
1068.It Va mountd_flags
1069.Pq Vt str
1070If
1071.Va mountd_enable
1072is set to
1073.Dq Li YES ,
1074these are the flags to pass to the
445243bf 1075.Xr mountd 8
984263bc
MD
1076daemon.
1077.It Va weak_mountd_authentication
1078.Pq Vt bool
1079If set to
445243bf 1080.Dq Li YES ,
225e0ed5 1081allow services like PCNFSD to make non-privileged mount requests.
984263bc
MD
1082.It Va nfs_reserved_port_only
1083.Pq Vt bool
1084If set to
445243bf 1085.Dq Li YES ,
984263bc
MD
1086provide NFS services only on a secure port.
1087.It Va nfs_bufpackets
1088.Pq Vt int
1089If set to a number, indicates the number of packets worth of
1090socket buffer space to reserve on an NFS client.
1091The kernel default is typically 4.
225e0ed5
SW
1092Using a higher number may be useful on gigabit networks to improve performance.
1093The minimum value is 2 and the maximum is 64.
72067a39
MD
1094.It Va rpc_umntall_enable
1095.Pq Vt bool
1096If set to
1097.Dq Li YES
1098(default) and we are also an NFS client, run
1099.Xr rpc.umntall 8
1100at boot time to clear out old mounts on remote servers.
1101If set to
1102.Dq Li NO
1103then
1104.Xr rpc.umntall 8
1105will not be run at boot time.
984263bc
MD
1106.It Va rpc_lockd_enable
1107.Pq Vt bool
1108If set to
445243bf 1109.Dq Li YES
984263bc
MD
1110and also an NFS server, run
1111.Xr rpc.lockd 8
1112at boot time.
52163b73
SW
1113.It Va rpc_lockd_flags
1114.Pq Vt str
1115If
1116.Va rpc_lockd_enable
1117is set to
1118.Dq Li YES ,
1119these are the flags to pass to
1120.Xr rpc.lockd 8 .
984263bc
MD
1121.It Va rpc_statd_enable
1122.Pq Vt bool
1123If set to
445243bf 1124.Dq Li YES
984263bc
MD
1125and also an NFS server, run
1126.Xr rpc.statd 8
1127at boot time.
52163b73
SW
1128.It Va rpc_statd_flags
1129.Pq Vt str
1130If
1131.Va rpc_statd_enable
1132is set to
1133.Dq Li YES ,
1134these are the flags to pass to
1135.Xr rpc.statd 8 .
445243bf 1136.It Va rpcbind_program
984263bc 1137.Pq Vt str
717e8ef7 1138Path to program for rpcbind daemon
984263bc 1139(default
3b813696 1140.Pa /usr/sbin/rpcbind ) .
445243bf 1141.It Va rpcbind_enable
984263bc
MD
1142.Pq Vt bool
1143If set to
445243bf 1144.Dq Li YES ,
717e8ef7
TN
1145run
1146.Va rpcbind_program
1147at boot time.
445243bf 1148.It Va rpcbind_flags
984263bc
MD
1149.Pq Vt str
1150If
445243bf 1151.Va rpcbind_enable
984263bc 1152is set to
445243bf 1153.Dq Li YES ,
717e8ef7
TN
1154these are the flags to pass to
1155.Va rpcbind_program .
445243bf 1156.It Va keyserv_enable
984263bc
MD
1157.Pq Vt bool
1158If set to
445243bf
RG
1159.Dq Li YES ,
1160run the
1161.Xr keyserv 8
1162daemon on boot for running Secure RPC.
1163.It Va keyserv_flags
984263bc
MD
1164.Pq Vt str
1165If
445243bf 1166.Va keyserv_enable
984263bc 1167is set to
445243bf
RG
1168.Dq Li YES ,
1169these are the flags to pass to
1170.Xr keyserv 8
984263bc
MD
1171daemon.
1172.It Va pppoed_enable
1173.Pq Vt bool
1174If set to
445243bf
RG
1175.Dq Li YES ,
1176run the
984263bc
MD
1177.Xr pppoed 8
1178daemon at boot time to provide PPP over Ethernet services.
850afac2 1179.It Va pppoed_provider
984263bc
MD
1180.Pq Vt str
1181.Xr pppoed 8
850afac2 1182listens to requests to this provider and ultimately runs
984263bc
MD
1183.Xr ppp 8
1184with a
1185.Ar system
1186argument of the same name.
1187.It Va pppoed_flags
1188.Pq Vt str
1189Additional flags to pass to
1190.Xr pppoed 8 .
1191.It Va pppoed_interface
1192.Pq Vt str
445243bf
RG
1193The network interface to run
1194.Xr pppoed 8
1195on.
1196This is mandatory when
984263bc
MD
1197.Va pppoed_enable
1198is set to
445243bf 1199.Dq Li YES .
984263bc 1200.It Va timed_enable
445243bf
RG
1201.Pq Vt bool
1202If set to
1203.Dq Li YES ,
1204run the
984263bc 1205.Xr timed 8
445243bf 1206service at boot time.
225e0ed5 1207This command is intended for networks of machines where a consistent
445243bf
RG
1208.Dq "network time"
1209for all hosts must be established.
225e0ed5
SW
1210This is often useful in large NFS environments where time stamps on
1211files are expected to be consistent network-wide.
984263bc
MD
1212.It Va timed_flags
1213.Pq Vt str
1214If
1215.Va timed_enable
1216is set to
445243bf 1217.Dq Li YES ,
984263bc
MD
1218these are the flags to pass to the
1219.Xr timed 8
1220service.
850afac2
SW
1221.It Va dntpd_enable
1222.Pq Vt bool
1223If set to
1224.Dq Li YES ,
1225run
1226.Xr dntpd 8
1227at system boot time.
1228.It Va dntpd_program
1229.Pq Vt str
1230Path to
1231.Xr dntpd 8
1232(default
1233.Pa /usr/sbin/dntpd ) .
1234.It Va dntpd_flags
1235.Pq Vt str
1236If
1237.Va dntpd_enable
1238is set to
1239.Dq Li YES ,
1240these are the flags to pass to the
1241.Xr dntpd 8
1242daemon.
5f834906
SW
1243.It Va btconfig_enable
1244.Pq Vt bool
1245If set to
1246.Dq Li YES ,
1247configure Bluetooth devices via
1248.Xr btconfig 8
1249at system boot time.
1250.It Va btconfig_devices
1251.Pq Vt str
1252If
1253.Va btconfig_enable
1254is set to
1255.Dq Li YES ,
1256this is the list of Bluetooth devices to configure.
1257If
1258.Va btconfig_devices
1259is not specified, all devices known to the system will be configured.
1260A
1261.Va btconfig_ Ns Aq Ar device
1262variable can be set to specify parameters to be passed to
1263.Ar device .
1264.It Va btconfig_args
1265.Pq Vt str
1266If
1267.Va btconfig_enable
1268is set to
1269.Dq Li YES ,
1270this is the list of configuration parameters to pass to all Bluetooth
1271devices.
1272.It Va sdpd_enable
1273.Pq Vt bool
1274If set to
1275.Dq Li YES ,
1276run the Service Discovery Profile daemon
1277.Xr ( sdpd 8 )
1278at system boot time.
1279.It Va sdpd_flags
1280.Pq Vt str
1281If
1282.Va sdpd_enable
1283is set to
1284.Dq Li YES ,
1285these are the flags to pass to the
1286.Xr sdpd 8
1287daemon.
ec4e37b7
HT
1288.It Va bthcid_enable
1289.Pq Vt bool
1290If set to
1291.Dq Li YES ,
1292run the Bluetooth Link Key/PIN Code Manager daemon
1293.Xr ( bthcid 8 )
1294at system boot time.
1295.It Va bthcid_flags
1296.Pq Vt str
1297If
1298.Va bthcid_enable
1299is set to
1300.Dq Li YES ,
1301these are the flags to pass to the
1302.Xr bthcid 8
1303daemon.
984263bc
MD
1304.It Va nis_client_enable
1305.Pq Vt bool
1306If set to
445243bf
RG
1307.Dq Li YES ,
1308run the
984263bc
MD
1309.Xr ypbind 8
1310service at system boot time.
1311.It Va nis_client_flags
1312.Pq Vt str
1313If
1314.Va nis_client_enable
1315is set to
445243bf 1316.Dq Li YES ,
984263bc
MD
1317these are the flags to pass to the
1318.Xr ypbind 8
1319service.
1320.It Va nis_ypset_enable
1321.Pq Vt bool
1322If set to
445243bf
RG
1323.Dq Li YES ,
1324run the
984263bc
MD
1325.Xr ypset 8
1326daemon at system boot time.
1327.It Va nis_ypset_flags
1328.Pq Vt str
1329If
1330.Va nis_ypset_enable
1331is set to
445243bf 1332.Dq Li YES ,
984263bc
MD
1333these are the flags to pass to the
1334.Xr ypset 8
1335daemon.
1336.It Va nis_server_enable
1337.Pq Vt bool
1338If set to
445243bf
RG
1339.Dq Li YES ,
1340run the
984263bc
MD
1341.Xr ypserv 8
1342daemon at system boot time.
1343.It Va nis_server_flags
1344.Pq Vt str
1345If
1346.Va nis_server_enable
1347is set to
445243bf 1348.Dq Li YES ,
984263bc
MD
1349these are the flags to pass to the
1350.Xr ypserv 8
1351daemon.
1352.It Va nis_ypxfrd_enable
1353.Pq Vt bool
1354If set to
445243bf
RG
1355.Dq Li YES ,
1356run the
984263bc
MD
1357.Xr rpc.ypxfrd 8
1358daemon at system boot time.
1359.It Va nis_ypxfrd_flags
1360.Pq Vt str
1361If
1362.Va nis_ypxfrd_enable
1363is set to
445243bf 1364.Dq Li YES ,
984263bc
MD
1365these are the flags to pass to the
1366.Xr rpc.ypxfrd 8
1367daemon.
1368.It Va nis_yppasswdd_enable
1369.Pq Vt bool
1370If set to
445243bf
RG
1371.Dq Li YES ,
1372run the
984263bc
MD
1373.Xr rpc.yppasswdd 8
1374daemon at system boot time.
1375.It Va nis_yppasswdd_flags
1376.Pq Vt str
1377If
1378.Va nis_yppasswdd_enable
1379is set to
445243bf 1380.Dq Li YES ,
984263bc
MD
1381these are the flags to pass to the
1382.Xr rpc.yppasswdd 8
1383daemon.
445243bf
RG
1384.It Va rpc_ypupdated_enable
1385.Pq Vt bool
1386If set to
1387.Dq Li YES ,
1388run the
1389.Nm rpc.ypupdated
1390daemon at system boot time.
984263bc
MD
1391.It Va defaultrouter
1392.Pq Vt str
1393If not set to
445243bf
RG
1394.Dq Li NO ,
1395create a default route to this host name or IP address
984263bc
MD
1396(use an IP address if this router is also required to get to the
1397name server!).
445243bf
RG
1398.It Va ipv6_defaultrouter
1399.Pq Vt str
1400The IPv6 equivalent of
1401.Va defaultrouter .
984263bc
MD
1402.It Va static_routes
1403.Pq Vt str
225e0ed5 1404Set to the list of static routes that are to be added at system boot time.
445243bf
RG
1405If not set to
1406.Dq Li NO
984263bc
MD
1407then for each whitespace separated
1408.Ar element
1409in the value, a
1410.Va route_ Ns Aq Ar element
225e0ed5 1411variable is assumed to exist whose contents will later be passed to a
445243bf
RG
1412.Dq Nm route Cm add
1413operation.
314c92ec
SW
1414.It Va change_routes
1415.Pq Vt str
1416Set to the list of static routes that are to be changed at system boot time
1417(such as those added by the kernel).
1418If not set to
1419.Dq Li NO
1420then for each whitespace separated
1421.Ar element
1422in the value, a
1423.Va change_route_ Ns Aq Ar element
1424variable is assumed to exist whose contents will later be passed to a
1425.Dq Nm route Cm change
1426operation.
445243bf
RG
1427.It Va ipv6_static_routes
1428.Pq Vt str
1429The IPv6 equivalent of
1430.Va static_routes .
1431If not set to
1432.Dq Li NO
1433then for each whitespace separated
1434.Ar element
1435in the value, a
1436.Va ipv6_route_ Ns Aq Ar element
225e0ed5 1437variable is assumed to exist whose contents will later be passed to a
445243bf 1438.Dq Nm route Cm add Fl inet6
984263bc
MD
1439operation.
1440.It Va gateway_enable
1441.Pq Vt bool
1442If set to
445243bf
RG
1443.Dq Li YES ,
1444configure host to act as an IP router, e.g. to forward packets
984263bc 1445between interfaces.
445243bf
RG
1446.It Va ipv6_gateway_enable
1447.Pq Vt bool
1448The IPv6 equivalent of
1449.Va gateway_enable .
984263bc
MD
1450.It Va router_enable
1451.Pq Vt bool
1452If set to
445243bf 1453.Dq Li YES ,
225e0ed5 1454run a routing daemon of some sort, based on the settings of
221b91ff 1455.Va router_program
984263bc
MD
1456and
1457.Va router_flags .
445243bf
RG
1458.It Va ipv6_router_enable
1459.Pq Vt bool
1460The IPv6 equivalent of
1461.Va router_enable .
1462If set to
1463.Dq Li YES ,
225e0ed5 1464run a routing daemon of some sort, based on the settings of
221b91ff 1465.Va ipv6_router_program
445243bf
RG
1466and
1467.Va ipv6_router_flags .
221b91ff 1468.It Va router_program
984263bc
MD
1469.Pq Vt str
1470If
1471.Va router_enable
1472is set to
445243bf 1473.Dq Li YES ,
717e8ef7
TN
1474this is the name of the routing daemon to use
1475(default
1476.Pa /sbin/routed ) .
221b91ff 1477.It Va ipv6_router_program
445243bf
RG
1478.Pq Vt str
1479The IPv6 equivalent of
717e8ef7
TN
1480.Va router_program
1481(default
1482.Pa /sbin/route6d ) .
984263bc
MD
1483.It Va router_flags
1484.Pq Vt str
1485If
1486.Va router_enable
1487is set to
445243bf 1488.Dq Li YES ,
984263bc 1489these are the flags to pass to the routing daemon.
445243bf
RG
1490.It Va ipv6_router_flags
1491.Pq Vt str
1492The IPv6 equivalent of
1493.Va router_flags .
984263bc
MD
1494.It Va mrouted_enable
1495.Pq Vt bool
1496If set to
445243bf
RG
1497.Dq Li YES ,
1498run the multicast routing daemon,
984263bc 1499.Xr mrouted 8 .
445243bf
RG
1500.It Va mroute6d_enable
1501.Pq Vt bool
1502The IPv6 equivalent of
1503.Va mrouted_enable .
1504If set to
1505.Dq Li YES ,
1506run the IPv6 multicast routing daemon.
1507Note that no IPv6 multicast routing daemon is included in the
9bb2a92d 1508.Dx
445243bf
RG
1509base system but
1510.Xr pim6dd 8
28feafc7
SW
1511can be installed from the
1512.Xr pkgsrc 7
1513collection.
984263bc
MD
1514.It Va mrouted_flags
1515.Pq Vt str
1516If
1517.Va mrouted_enable
1518is set to
445243bf
RG
1519.Dq Li YES ,
1520these are the flags to pass to the
1521.Xr mrouted 8
1522daemon.
1523.It Va mroute6d_flags
1524.Pq Vt str
1525The IPv6 equivalent of
1526.Va mrouted_flags .
1527If
1528.Va mroute6d_enable
1529is set to
1530.Dq Li YES ,
1531these are the flags passed to the IPv6 multicast routing daemon.
1532.It Va mroute6d_program
1533.Pq Vt str
1534If
1535.Va mroute6d_enable
1536is set to
1537.Dq Li YES ,
1538this is the path to the IPv6 multicast routing daemon.
1539.It Va rtadvd_enable
1540.Pq Vt bool
1541If set to
1542.Dq Li YES ,
1543run the
1544.Xr rtadvd 8
1545daemon at boot time.
1546.Xr rtadvd 8
1547will only run if
1548.Va ipv6_gateway_enable
1549is also set to
1550.Dq Li YES .
1551The
1552.Xr rtadvd 8
1553utility sends router advertisement packets to the interfaces specified in
1554.Va rtadvd_interfaces .
1555.Xr rtadvd 8
1556and should only be enabled with great care.
1557You may want to fine-tune
1558.Xr rtadvd.conf 5 .
1559.It Va rtadvd_interfaces
1560.Pq Vt str
1561If
1562.Va rtadvd_enable
1563is set to
1564.Dq Li YES
1565this is the list of interfaces to use.
bdbd8a5b
SW
1566.It Va rtsold_enable
1567.Pq Vt bool
1568If set to
1569.Dq Li YES ,
1570run the
1571.Xr rtsold 8
1572daemon at boot time.
1573The
1574.Xr rtsold 8
1575daemon is used for automatic discovery of non-link local addresses.
1576.It Va rtsold_flags
1577.Pq Vt str
1578If
1579.Va rtsold_enable
1580is set to
1581.Dq Li YES ,
1582these are the flags to pass to the
1583.Xr rtsold 8
1584daemon.
984263bc
MD
1585.It Va ipxgateway_enable
1586.Pq Vt bool
1587If set to
445243bf
RG
1588.Dq Li YES ,
1589enable the routing of IPX traffic.
984263bc
MD
1590.It Va ipxrouted_enable
1591.Pq Vt bool
1592If set to
445243bf
RG
1593.Dq Li YES ,
1594run the
984263bc
MD
1595.Xr IPXrouted 8
1596daemon at system boot time.
1597.It Va ipxrouted_flags
1598.Pq Vt str
1599If
1600.Va ipxrouted_enable
1601is set to
445243bf 1602.Dq Li YES ,
984263bc
MD
1603these are the flags to pass to the
1604.Xr IPXrouted 8
1605daemon.
1606.It Va arpproxy_all
1607.Pq Vt bool
1608If set to
445243bf
RG
1609.Dq Li YES ,
1610enable global proxy ARP.
984263bc
MD
1611.It Va forward_sourceroute
1612.Pq Vt bool
1613If set to
445243bf
RG
1614.Dq Li YES
1615and
984263bc
MD
1616.Va gateway_enable
1617is also set to
445243bf
RG
1618.Dq Li YES ,
1619source-routed packets are forwarded.
984263bc
MD
1620.It Va accept_sourceroute
1621.Pq Vt bool
1622If set to
445243bf
RG
1623.Dq Li YES ,
1624the system will accept source-routed packets directed at it.
984263bc
MD
1625.It Va rarpd_enable
1626.Pq Vt bool
1627If set to
445243bf
RG
1628.Dq Li YES ,
1629run the
984263bc
MD
1630.Xr rarpd 8
1631daemon at system boot time.
1632.It Va rarpd_flags
1633.Pq Vt str
1634If
1635.Va rarpd_enable
1636is set to
445243bf 1637.Dq Li YES ,
984263bc
MD
1638these are the flags to pass to the
1639.Xr rarpd 8
1640daemon.
445243bf
RG
1641.It Va bootparamd_enable
1642.Pq Vt bool
1643If set to
1644.Dq Li YES ,
1645run the
1646.Xr bootparamd 8
1647daemon at system boot time.
1648.It Va bootparamd_flags
1649.Pq Vt str
1650If
1651.Va bootparamd_enable
1652is set to
1653.Dq Li YES ,
1654these are the flags to pass to the
1655.Xr bootparamd 8
1656daemon.
1657.It Va stf_interface_ipv4addr
1658.Pq Vt str
1659If not set to
1660.Dq Li NO ,
225e0ed5 1661this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
445243bf
RG
1662Specify this entry to enable the 6to4 interface.
1663.It Va stf_interface_ipv4plen
1664.Pq Vt int
1665Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1666An effective value is 0-31.
1667.It Va stf_interface_ipv6_ifid
1668.Pq Vt str
1669IPv6 interface ID for
1670.Xr stf 4 .
1671This can be set to
1672.Dq Li AUTO .
1673.It Va stf_interface_ipv6_slaid
1674.Pq Vt str
1675IPv6 Site Level Aggregator for
1676.Xr stf 4 .
1677.It Va ipv6_faith_prefix
1678.Pq Vt str
1679If not set to
1680.Dq Li NO ,
225e0ed5 1681this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
445243bf
RG
1682You also need
1683.Xr faithd 8
1684setup.
1685.It Va ipv6_ipv4mapping
1686.Pq Vt bool
1687If set to
1688.Dq Li YES
1689this enables IPv4 mapped IPv6 address communication (like
1690.Li ::ffff:a.b.c.d ) .
984263bc
MD
1691.It Va atm_enable
1692.Pq Vt bool
1693Set to
445243bf 1694.Dq Li YES
984263bc
MD
1695to enable the configuration of ATM interfaces at system boot time.
1696For all of the ATM variables described below, please refer to the
1697.Xr atm 8
1698man page for further details on the available command parameters.
1699Also refer to the files in
1700.Pa /usr/share/examples/atm
1701for more detailed configuration information.
445243bf 1702.It Va atm_netif_ Ns Aq Ar intf
984263bc
MD
1703.Pq Vt str
1704For the ATM physical interface
445243bf
RG
1705.Ar intf ,
1706this variable defines the name prefix and count for the ATM network
1707interfaces to be created.
984263bc 1708The value will be passed as the parameters of an
445243bf 1709.Dq Nm atm Cm "set netif" Ar intf
984263bc 1710command.
445243bf 1711.It Va atm_sigmgr_ Ns Aq Ar intf
984263bc
MD
1712.Pq Vt str
1713For the ATM physical interface
445243bf 1714.Ar intf ,
984263bc
MD
1715this variable defines the ATM signalling manager to be used.
1716The value will be passed as the parameters of an
445243bf 1717.Dq Nm atm Cm attach Ar intf
984263bc 1718command.
445243bf 1719.It Va atm_prefix_ Ns Aq Ar intf
984263bc
MD
1720.Pq Vt str
1721For the ATM physical interface
445243bf 1722.Ar intf ,
984263bc 1723this variable defines the NSAP prefix for interfaces using a UNI signalling
445243bf
RG
1724manager.
1725If set to
1726.Dq Li ILMI ,
1727the prefix will automatically be set via the
984263bc 1728.Xr ilmid 8
445243bf
RG
1729daemon.
1730Otherwise, the value will be passed as the parameters of an
1731.Dq Nm atm Cm "set prefix" Ar intf
984263bc 1732command.
445243bf 1733.It Va atm_macaddr_ Ns Aq Ar intf
984263bc
MD
1734.Pq Vt str
1735For the ATM physical interface
445243bf 1736.Ar intf ,
984263bc 1737this variable defines the MAC address for interfaces using a UNI signalling
445243bf
RG
1738manager.
1739If set to
1740.Dq Li NO ,
1741the hardware MAC address contained in the ATM interface card will be used.
984263bc 1742Otherwise, the value will be passed as the parameters of an
445243bf 1743.Dq Nm atm Cm "set mac" Ar intf
984263bc 1744command.
445243bf 1745.It Va atm_arpserver_ Ns Aq Ar netif
984263bc
MD
1746.Pq Vt str
1747For the ATM network interface
445243bf 1748.Ar netif ,
984263bc 1749this variable defines the ATM address for a host which is to provide ATMARP
445243bf 1750service.
225e0ed5 1751This variable is only applicable to interfaces using a UNI signalling manager.
445243bf
RG
1752If set to
1753.Dq Li local ,
1754this host will become an ATMARP server.
984263bc 1755The value will be passed as the parameters of an
445243bf 1756.Dq Nm atm Cm "set arpserver" Ar netif
984263bc 1757command.
445243bf 1758.It Va atm_scsparp_ Ns Aq Ar netif
984263bc
MD
1759.Pq Vt bool
1760If set to
445243bf
RG
1761.Dq Li YES ,
1762SCSP/ATMARP service for the network interface
1763.Ar netif
984263bc
MD
1764will be initiated using the
1765.Xr scspd 8
1766and
1767.Xr atmarpd 8
445243bf
RG
1768daemons.
1769This variable is only applicable if
984263bc 1770.Va atm_arpserver_ Ns Aq Ar netif
445243bf
RG
1771is set to
1772.Dq Li local .
984263bc
MD
1773.It Va atm_arps
1774.Pq Vt str
225e0ed5 1775Set to the list of permanent ATM ARP entries to be added at system boot time.
445243bf 1776For each whitespace separated
984263bc
MD
1777.Ar element
1778in the value, an
1779.Va atm_arp_ Ns Aq Ar element
445243bf 1780variable is assumed to exist.
225e0ed5 1781The value of each of these variables will be passed as the parameters of an
445243bf 1782.Dq Nm atm Cm "add arp"
984263bc 1783command.
445243bf
RG
1784.It Va keybell
1785.Pq Vt str
1786The keyboard bell sound.
1787Set to
1788.Dq Li normal ,
1789.Dq Li visual ,
1790.Dq Li off ,
1791or
1792.Dq Li NO
1793if the default behavior is desired.
1794For details, refer to the
1795.Xr kbdcontrol 1
1796manpage.
984263bc
MD
1797.It Va keymap
1798.Pq Vt str
1799If set to
445243bf
RG
1800.Dq Li NO ,
1801no keymap is installed, otherwise the value is used to install
984263bc 1802the keymap file in
445243bf 1803.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
984263bc
MD
1804.It Va keyrate
1805.Pq Vt str
445243bf
RG
1806The keyboard repeat speed.
1807Set to
1808.Dq Li slow ,
1809.Dq Li normal ,
1810.Dq Li fast ,
984263bc 1811or
445243bf 1812.Dq Li NO
984263bc
MD
1813if the default behavior is desired.
1814.It Va keychange
1815.Pq Vt str
1816If not set to
445243bf
RG
1817.Dq Li NO ,
1818attempt to program the function keys with the value.
225e0ed5 1819The value should be a single string of the form:
445243bf 1820.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
984263bc
MD
1821.It Va cursor
1822.Pq Vt str
1823Can be set to the value of
445243bf
RG
1824.Dq Li normal ,
1825.Dq Li blink ,
1826.Dq Li destructive ,
984263bc 1827or
445243bf 1828.Dq Li NO
984263bc
MD
1829to set the cursor behavior explicitly or choose the default behavior.
1830.It Va scrnmap
1831.Pq Vt str
1832If set to
445243bf
RG
1833.Dq Li NO ,
1834no screen map is installed, otherwise the value is used to install
984263bc 1835the screen map file in
445243bf 1836.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
984263bc
MD
1837.It Va font8x16
1838.Pq Vt str
1839If set to
445243bf
RG
1840.Dq Li NO ,
1841the default 8x16 font value is used for screen size requests, otherwise
984263bc 1842the value in
445243bf 1843.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1844is used.
1845.It Va font8x14
1846.Pq Vt str
1847If set to
445243bf
RG
1848.Dq Li NO ,
1849the default 8x14 font value is used for screen size requests, otherwise
984263bc 1850the value in
445243bf 1851.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1852is used.
1853.It Va font8x8
1854.Pq Vt str
1855If set to
445243bf
RG
1856.Dq Li NO ,
1857the default 8x8 font value is used for screen size requests, otherwise
984263bc 1858the value in
445243bf 1859.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1860is used.
1861.It Va blanktime
1862.Pq Vt int
1863If set to
445243bf 1864.Dq Li NO ,
225e0ed5 1865the default screen blanking interval is used, otherwise it is set to
984263bc
MD
1866.Ar value
1867seconds.
1868.It Va saver
1869.Pq Vt str
1870If not set to
445243bf
RG
1871.Dq Li NO ,
1872this is the actual screen saver to use
1873.Li ( blank , snake , daemon ,
1874etc).
984263bc
MD
1875.It Va moused_enable
1876.Pq Vt str
1877If set to
445243bf 1878.Dq Li YES ,
984263bc
MD
1879the
1880.Xr moused 8
1881daemon is started for doing cut/paste selection on the console.
1882.It Va moused_type
1883.Pq Vt str
1884This is the protocol type of the mouse connected to this host.
1885This variable must be set if
1886.Va moused_enable
1887is set to
445243bf 1888.Dq Li YES .
984263bc
MD
1889The
1890.Xr moused 8
1891daemon
1892is able to detect the appropriate mouse type automatically in many cases.
1893Set this variable to
445243bf 1894.Dq Li auto
984263bc
MD
1895to let the daemon detect it, or
1896select one from the following list if the automatic detection fails.
1897.Pp
1898If the mouse is attached to the PS/2 mouse port, choose
445243bf 1899.Dq Li auto
984263bc 1900or
445243bf
RG
1901.Dq Li ps/2 ,
1902regardless of the brand and model of the mouse.
225e0ed5 1903Likewise, if the mouse is attached to the bus mouse port, choose
445243bf 1904.Dq Li auto
984263bc 1905or
445243bf 1906.Dq Li busmouse .
984263bc
MD
1907All other protocols are for serial mice and will not work with
1908the PS/2 and bus mice.
1909If this is a USB mouse,
445243bf 1910.Dq Li auto
984263bc 1911is the only protocol type which will work.
445243bf
RG
1912.Pp
1913.Bl -tag -width ".Li x10mouseremote" -compact
1914.It Li microsoft
1915Microsoft mouse (serial)
1916.It Li intellimouse
1917Microsoft IntelliMouse (serial)
1918.It Li mousesystems
1919Mouse systems Corp. mouse (serial)
1920.It Li mmseries
1921MM Series mouse (serial)
1922.It Li logitech
1923Logitech mouse (serial)
1924.It Li busmouse
1925A bus mouse
1926.It Li mouseman
1927Logitech MouseMan and TrackMan (serial)
1928.It Li glidepoint
1929ALPS GlidePoint (serial)
1930.It Li thinkingmouse
1931Kensington ThinkingMouse (serial)
1932.It Li ps/2
1933PS/2 mouse
1934.It Li mmhittab
1935MM HitTablet (serial)
1936.It Li x10mouseremote
1937X10 MouseRemote (serial)
1938.It Li versapad
1939Interlink VersaPad (serial)
1940.El
984263bc
MD
1941.Pp
1942Even if the mouse is not in the above list, it may be compatible
1943with one in the list.
1944Refer to the man page for
1945.Xr moused 8
1946for compatibility information.
1947.Pp
1948It should also be noted that while this is enabled, any
1949other client of the mouse (such as an X server) should access
445243bf
RG
1950the mouse through the virtual mouse device,
1951.Pa /dev/sysmouse ,
1952and configure it as a
1953.Dq Li sysmouse
1954type mouse, since all
225e0ed5 1955mouse data is converted to this single canonical format when using
984263bc 1956.Xr moused 8 .
445243bf
RG
1957If the client program does not support the
1958.Dq Li sysmouse
225e0ed5 1959type, specify the
445243bf
RG
1960.Dq Li mousesystems
1961type.
984263bc
MD
1962It is the second preferred type.
1963.It Va moused_port
1964.Pq Vt str
1965If
1966.Va moused_enable
1967is set to
445243bf 1968.Dq Li YES ,
984263bc
MD
1969this is the actual port the mouse is on.
1970It might be
1971.Pa /dev/cuaa0
ad9f8794 1972for a COM1 serial mouse or
984263bc 1973.Pa /dev/psm0
ad9f8794 1974for a PS/2 mouse, for example.
984263bc
MD
1975.It Va moused_flags
1976.Pq Vt str
1977If
1978.Va moused_type
1979is set, these are the additional flags to pass to the
1980.Xr moused 8
1981daemon.
445243bf
RG
1982.It Va mousechar_start
1983.Pq Vt int
1984If set to
1985.Dq Li NO ,
1986the default mouse cursor character range
1987.Li 0xd0 Ns - Ns Li 0xd3
225e0ed5 1988is used, otherwise the range start is set to
445243bf
RG
1989.Ar value
1990character, see
1991.Xr vidcontrol 1 .
1992Use if the default range is occupied in the language code table.
850afac2
SW
1993.It Va vidhistory
1994.Pq Vt int
1995Set the size of the history (scrollback) buffer in lines.
984263bc
MD
1996.It Va allscreens_flags
1997.Pq Vt str
1998If set,
1999.Xr vidcontrol 1
2000is run with these options for each of the virtual terminals
2001.Pq Pa /dev/ttyv* .
2002For example,
445243bf 2003.Dq Fl m Cm on
225e0ed5 2004will enable the mouse pointer on all virtual terminals if
984263bc
MD
2005.Va moused_enable
2006is set to
445243bf
RG
2007.Dq Li YES .
2008.It Va allscreens_kbdflags
2009.Pq Vt str
2010If set,
2011.Xr kbdcontrol 1
2012is run with these options for each of the virtual terminals
2013.Pq Pa /dev/ttyv* .
2014For example,
2015.Dq Fl h Li 200
2016will set the
2017.Xr syscons 4
2018scrollback (history) buffer to 200 lines.
984263bc
MD
2019.It Va cron_enable
2020.Pq Vt bool
2021If set to
445243bf
RG
2022.Dq Li YES ,
2023run the
984263bc
MD
2024.Xr cron 8
2025daemon at system boot time.
2026.It Va cron_program
2027.Pq Vt str
2028Path to
2029.Xr cron 8
2030(default
2031.Pa /usr/sbin/cron ) .
2032.It Va cron_flags
2033.Pq Vt str
2034If
2035.Va cron_enable
2036is set to
445243bf 2037.Dq Li YES ,
984263bc
MD
2038these are the flags to pass to
2039.Xr cron 8 .
2040.It Va lpd_program
2041.Pq Vt str
2042Path to
2043.Xr lpd 8
2044(default
2045.Pa /usr/sbin/lpd ) .
2046.It Va lpd_enable
2047.Pq Vt bool
2048If set to
445243bf
RG
2049.Dq Li YES ,
2050run the
984263bc
MD
2051.Xr lpd 8
2052daemon at system boot time.
2053.It Va lpd_flags
2054.Pq Vt str
2055If
2056.Va lpd_enable
2057is set to
445243bf 2058.Dq Li YES ,
984263bc
MD
2059these are the flags to pass to the
2060.Xr lpd 8
2061daemon.
52163b73
SW
2062.It Va nscd_enable
2063.Pq Vt bool
2064If set to
2065.Dq Li YES ,
2066run the
2067.Xr nscd 8
2068daemon at system boot time.
850afac2
SW
2069.It Va mixer_enable
2070.Pq Vt bool
2071If set to
2072.Dq Li YES ,
2073preserve
2074.Xr mixer 8
2075settings across reboots.
984263bc
MD
2076.It Va mta_start_script
2077.Pq Vt str
717e8ef7 2078The full path to the script to run to start
984263bc
MD
2079a mail transfer agent.
2080The default is
2081.Pa /etc/rc.sendmail .
2082The
2083.Va sendmail_*
2084variables which
2085.Pa /etc/rc.sendmail
2086uses are documented in the
2087.Xr rc.sendmail 8
2088man page.
a12bb799
SW
2089.It Va fixbootfile
2090.Pq Vt bool
2091In a
2092.Sq HAMMER ROOT with UFS /boot
2093setup, the boot loader will not set up the
2094.Va kern.bootfile
2095sysctl correctly.
2096The system will attempt to fix this on its own.
2097Set this variable to
2098.Dq Li NO
2099to turn this behavior off.
984263bc
MD
2100.It Va dumpdev
2101.Pq Vt str
2102Indicates the device (usually a swap partition) to which a crash dump
2103should be written in the event of a system crash.
2104The value of this variable is passed as the argument to
f8e9b4ce
MD
2105.Xr dumpon 8
2106and
2107.Xr savecore 8 .
984263bc 2108To disable crash dumps, set this variable to
445243bf 2109.Dq Li NO .
984263bc
MD
2110.It Va dumpdir
2111.Pq Vt str
2112When the system reboots after a crash and a crash dump is found on the
2113device specified by the
2114.Va dumpdev
2115variable,
2116.Xr savecore 8
2117will save that crash dump and a copy of the kernel to the directory
2118specified by the
2119.Va dumpdir
2120variable.
2121The default value is
445243bf 2122.Pa /var/crash .
984263bc 2123Set to
445243bf 2124.Dq Li NO
984263bc
MD
2125to not run
2126.Xr savecore 8
2127at boot time when
2128.Va dumpdir
2129is set.
2130.It Va savecore_flags
2131.Pq Vt str
2132If crash dumps are enabled, these are the flags to pass to the
2133.Xr savecore 8
2134utility.
7fb3111b
AH
2135.It Va crashinfo_enable
2136.Pq Vt bool
2137Set to
2138.Dq Li YES
2139to turn on automatic crash dump summary generation using the utility
2140specified by the
2141.Va crashinfo_program
2142variable.
2143.It Va crashinfo_program
2144.Pq Vt str
2145Program to run to generate a crash dump summary if the variable
2146.Va crashinfo_enable
2147is set to
2148.Dq Li YES .
2149The default value is
2150.Pa /usr/sbin/crashinfo .
984263bc
MD
2151.It Va enable_quotas
2152.Pq Vt bool
2153Set to
445243bf 2154.Dq Li YES
984263bc
MD
2155to turn on user disk quotas on system startup via the
2156.Xr quotaon 8
2157command.
2158.It Va check_quotas
2159.Pq Vt bool
2160Set to
445243bf 2161.Dq Li YES
984263bc
MD
2162to enable user disk quota checking via the
2163.Xr quotacheck 8
2164command.
2165.It Va accounting_enable
2166.Pq Vt bool
2167Set to
445243bf 2168.Dq Li YES
984263bc
MD
2169to enable system accounting through the
2170.Xr accton 8
2171facility.
984263bc
MD
2172.It Va linux_enable
2173.Pq Vt bool
2174Set to
445243bf 2175.Dq Li YES
225e0ed5 2176to enable Linux/ELF binary emulation at system initial boot time.
445243bf
RG
2177.It Va sysvipc_enable
2178.Pq Vt bool
2179If set to
2180.Dq Li YES ,
2181load System V IPC primitives at boot time.
de5b97b6
MD
2182.\" ----- cleanvar_enable setting--------------------------------
2183.It Va cleanvar_enable
2184.Pq Vt bool
2185Set to
2186.Dq Li YES
2187to have
2188.Pa /var/run ,
2189.Pa /var/spool/lock
2190and
2191.Pa /var/spool/uucp/.Temp/*
2192cleaned at startup.
2193.\" ----- clear_tmp_enable setting-------------------------------
984263bc
MD
2194.It Va clear_tmp_enable
2195.Pq Vt bool
2196Set to
445243bf 2197.Dq Li YES
984263bc
MD
2198to have
2199.Pa /tmp
2200cleaned at startup.
de5b97b6 2201.\" ----- ldconfig_paths setting --------------------------------
984263bc
MD
2202.It Va ldconfig_paths
2203.Pq Vt str
2204Set to the list of shared library paths to use with
2205.Xr ldconfig 8 .
2206NOTE:
2207.Pa /usr/lib
2208will always be added first, so it need not appear in this list.
2209.It Va ldconfig_insecure
2210.Pq Vt bool
2211The
2212.Xr ldconfig 8
2213utility normally refuses to use directories
2214which are writable by anyone except root.
2215Set this variable to
445243bf 2216.Dq Li YES
984263bc 2217to disable that security check during system startup.
984263bc
MD
2218.It Va kern_securelevel
2219.Pq Vt int
2220The kernel security level to set at startup.
2221The allowed range of
2222.Ar value
225e0ed5 2223ranges from \-1 (the compile time default) to 3 (the most secure).
445243bf 2224See
984263bc 2225.Xr init 8
225e0ed5 2226for the list of possible security levels and their effect on system operation.
984263bc
MD
2227.It Va start_vinum
2228.Pq Vt bool
2229Set to
445243bf 2230.Dq Li YES
984263bc
MD
2231to start
2232.Xr vinum 8
2233at system boot time.
984263bc
MD
2234.It Va sshd_enable
2235.Pq Vt bool
2236Set to
445243bf 2237.Dq Li YES
984263bc
MD
2238to start
2239.Xr sshd 8
2240at system boot time.
850afac2
SW
2241.It Va sshd_program
2242.Pq Vt str
2243Path to the SSH server program
717e8ef7
TN
2244(default
2245.Pa /usr/sbin/sshd ) .
984263bc
MD
2246.It Va sshd_flags
2247.Pq Vt str
2248If
2249.Va sshd_enable
2250is set to
445243bf 2251.Dq Li YES ,
984263bc
MD
2252these are the flags to pass to the
2253.Xr sshd 8
2254daemon.
850afac2
SW
2255.It Va ftpd_enable
2256.Pq Vt bool
2257Set to
2258.Dq Li YES
2259to start
2260.Xr ftpd 8
2261at system boot time.
2262.It Va ftpd_flags
2263.Pq Vt str
2264If
2265.Va ftpd_enable
2266is set to
2267.Dq Li YES ,
2268these are the flags to pass to the
2269.Xr ftpd 8
2270daemon.
445243bf
RG
2271.It Va usbd_enable
2272.Pq Vt bool
2273If set to
2274.Dq Li YES ,
2275run the
2276.Xr usbd 8
2277daemon at boot time.
2278.It Va usbd_flags
2279.Pq Vt str
2280If
2281.Va usbd_enable
2282is set to
2283.Dq Li YES ,
2284these are the flags passed to
2285.Xr usbd 8
2286daemon.
2287.It Va watchdogd_enable
2288.Pq Vt bool
2289If set to
2290.Dq Li YES ,
2291start the
2292.Xr watchdogd 8
2293daemon at boot time.
2294This requires that the kernel have been compiled with
2295.Cd "options WATCHDOG" .
2296.It Va jail_enable
2297.Pq Vt bool
2298If set to
2299.Dq Li NO ,
2300any configured jails will not be started.
2301.It Va jail_list
2302.Pq Vt str
2303A space separated list of names for jails.
2304This is purely a configuration aid to help identify and
2305configure multiple jails.
2306The names specified in this list will be used to
2307identify settings common to an instance of a jail.
2308Assuming that the jail in question was named
2309.Li vjail ,
56be8454 2310you would have the following dependent variables:
445243bf
RG
2311.Bd -literal
2312jail_vjail_hostname="jail.example.com"
2313jail_vjail_ip="192.168.1.100"
2314jail_vjail_rootdir="/var/jails/vjail/root"
445243bf
RG
2315.Ed
2316.Pp
b58abc5e
SW
2317.It Va jail_flags
2318.Pq Vt str
2319Unset by default.
2320When set, use as default value for
2321.Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2322for every jail in
2323.Va jail_list .
2324.It Va jail_interface
2325.Pq Vt str
2326Unset by default.
2327When set, use as default value for
2328.Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2329for every jail in
2330.Va jail_list .
2331.It Va jail_fstab
2332.Pq Vt str
2333Unset by default.
2334When set, use as default value for
2335.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2336for every jail in
2337.Va jail_list .
2338.It Va jail_mount_enable
2339.Pq Vt bool
2340Set to
2341.Dq Li NO
2342by default.
2343When set to
2344.Dq Li YES ,
2345sets
2346.Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2347to
2348.Dq Li YES
2349by default for every jail in
2350.Va jail_list .
2351.It Va jail_fdesc_enable
2352.Pq Vt bool
2353Set to
2354.Dq Li NO
2355by default.
2356When set to
2357.Dq Li YES ,
2358sets
2359.Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2360to
2361.Dq Li YES
2362by default for every jail in
2363.Va jail_list .
2364.It Va jail_procfs_enable
2365.Pq Vt bool
2366Set to
2367.Dq Li NO
2368by default.
2369When set to
2370.Dq Li YES ,
2371sets
36c417a0 2372.Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
b58abc5e
SW
2373to
2374.Dq Li YES
2375by default for every jail in
2376.Va jail_list .
f8ff0183
AHJ
2377.It Va jail_devfs_enable
2378.Pq Vt bool
2379Set to
2380.Dq Li NO
2381by default.
2382When set to
2383.Dq Li YES ,
2384sets
2385.Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2386to
2387.Dq Li YES
2388by default for every jail in
2389.Va jail_list .
b58abc5e
SW
2390.It Va jail_exec_start
2391.Pq Vt str
2392Unset by default.
2393When set, use as default value for
2394.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2395for every jail in
2396.Va jail_list .
2397.It Va jail_exec_stop
2398Unset by default.
2399When set, use as default value for
2400.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2401for every jail in
2402.Va jail_list .
2403.It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2404.Pq Vt str
2405Unset by default.
2406Set to the root directory used by jail
2407.Va jname .
2408.It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2409.Pq Vt str
2410Unset by default.
2411Set to the fully qualified domain name (FQDN) assigned to jail
2412.Va jname .
2413.It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2414.Pq Vt str
2415Unset by default.
2416Set to the IP address assigned to jail
2417.Va jname .
2418.It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2419.Pq Vt str
2420Set to
2421.Dq Li -l -U root
2422by default.
2423These are flags to pass to
20ab1ccc 2424.Xr jail 8 .
b58abc5e
SW
2425.It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2426.Pq Vt str
2427Unset by default.
2428When set, sets the interface to use when setting IP address alias.
2429Note that the alias is created at jail startup and removed at jail shutdown.
2430.It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2431.Pq Vt str
2432Set to
2433.Pa /etc/fstab. Ns Aq Ar jname
2434by default.
2435This is the file system information file to use for jail
2436.Va jname .
2437.It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2438.Pq Vt bool
2439Set to
2440.Dq Li NO
2441by default.
2442When set to
2443.Dq Li YES ,
2444mount all file systems from
2445.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2446at jail startup.
2447.It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2448.Pq Vt bool
2449Set to
2450.Dq Li NO
2451by default.
2452When set to
2453.Dq Li YES ,
2454mount the file-descriptor file system inside jail
2455.Ar jname
2456at jail startup.
2457.It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2458.Pq Vt bool
2459Set to
2460.Dq Li NO
2461by default.
2462When set to
2463.Dq Li YES ,
2464mount the process file system inside jail
2465.Ar jname
2466at jail startup.
f8ff0183
AHJ
2467.It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2468.Pq Vt bool
2469Set to
2470.Dq Li NO
2471by default.
2472When set to
2473.Dq Li YES ,
2474mount the device file system inside jail
2475.Ar jname
2476at jail startup.
b58abc5e
SW
2477.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2478.Pq Vt str
2479Set to
2480.Dq Li /bin/sh /etc/rc
2481by default.
2482This is the command executed at jail startup.
2483.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2484.Pq Vt str
2485Set to
2486.Dq Li /bin/sh /etc/rc.shutdown
2487by default.
2488This is the command executed at jail shutdown.
445243bf
RG
2489.It Va jail_set_hostname_allow
2490.Pq Vt bool
2491If set to
2492.Dq Li NO ,
2493do not allow the root user in a jail to set its hostname.
2494.It Va jail_socket_unixiproute_only
2495.Pq Vt bool
2496If set to
b58abc5e
SW
2497.Dq Li YES ,
2498do not allow any sockets,
2499besides UNIX/IP/route sockets,
2500to be used within a jail.
445243bf
RG
2501.It Va jail_sysvipc_allow
2502.Pq Vt bool
2503If set to
2504.Dq Li YES ,
2505allow applications within a jail to use System V IPC.
0e132b2a
AH
2506.It Va lvm_enable
2507.Pq Vt bool
2508If set to
2509.Dq Li YES
2510LVM volumes will be discovered and configured on boot.
842eea5b
SW
2511.It Va newsyslog_enable
2512.Pq Vt bool
2513If set to
2514.Dq Li YES ,
2515run
2516.Xr newsyslog 8
2517before syslogd starts.
2518.It Va newsyslog_flags
2519.Pq Vt str
2520If
2521.Va newsyslog_enable
2522is set to
2523.Dq Li YES ,
2524these are the flags passed to
2525.Xr newsyslog 8 .
850afac2
SW
2526.It Va resident_enable
2527.Pq Vt bool
2528If set to
2529.Dq Li YES ,
2530make the dynamic binaries listed in
2531.Pa /etc/resident.conf
2532resident.
2533.It Va varsym_enable
2534.Pq Vt bool
2535If set to
2536.Dq Li YES ,
2537process
2538.Pa /etc/varsym.conf
2539to set system-wide variables for variant symlinks.
705d55f1 2540.It Va rand_irqs
850afac2
SW
2541.Pq Vt str
2542Set either to
2543.Dq Li NO
2544or a whitespace separated list of IRQ numbers which will be used as a source of
2545randomness.
984263bc 2546.\" -----------------------------------------------------
445243bf
RG
2547.It Va entropy_dir
2548.Pq Vt str
2549Set to
2550.Dq Li NO
2551to disable caching entropy via
2552.Xr cron 8 .
2553Otherwise set to the directory used to store entropy files in.
2554.It Va entropy_file
2555.Pq Vt str
2556Set to
2557.Dq Li NO
2558to disable caching entropy through reboots.
225e0ed5 2559Otherwise set to the filename used to store cached entropy through reboots.
445243bf
RG
2560This file should be located on the root file system to seed the
2561.Xr random 4
2562device as early as possible in the boot process.
445243bf
RG
2563.It Va ipsec_enable
2564.Pq Vt bool
2565Set to
2566.Dq Li YES
2567to run
2568.Xr setkey 8
2569on
2570.Va ipsec_file
2571at boot time.
2572.It Va ipsec_file
2573.Pq Vt str
2574Configuration file for
2575.Xr setkey 8 .
2576.It Va dmesg_enable
2577.Pq Vt bool
2578Set to
2579.Dq Li YES
2580to save
2581.Xr dmesg 8
2582to
2583.Pa /var/run/dmesg.boot
2584on boot.
2585.It Va rcshutdown_timeout
2586.Pq Vt int
2587If set, start a watchdog timer in the background which will terminate
2588.Pa rc.shutdown
2589if
2590.Xr shutdown 8
2591has not completed within the specified time (in seconds).
0e132b2a
AH
2592.It Va udevd_enable
2593.Pq Vt bool
2594If set to
2595.Dq Li YES ,
2596the udevd daemon will be started on boot.
7f180e19 2597.It Va vfs_quota_enable
9be2bba0
FT
2598.Pq Vt bool
2599If set to
2600.Dq Li YES ,
7f180e19
FT
2601vfs quota rc.d scripts will be run on boot.
2602.It Va vfs_quota_sync
9be2bba0
FT
2603.Pq Vt str
2604List of mount points whose counters are to be synchronized with on-disk
2605usage during system startup. See also
2606.Xr vquota 8 .
ff625697
AHJ
2607.It Va vknetd_enable
2608.Pq Vt bool
b7610907 2609If set to
ff625697
AHJ
2610.Dq Li YES ,
2611.Xr vknetd 8
2612will be started on boot.
2613.It Va vknetd_flags
2614.Pq Vt bool
2615Additional flags passed to
2616.Xr vknetd 8 .
2617Usually address/cidrbits is specified here.
2618When no flags are passed, default option
2619.Fl U
2620will be used.
2feb07f7
SW
2621.It Va vkernel_enable
2622.Pq Vt bool
2623If set to
2624.Dq Li NO ,
2625any configured vkernels will not be started.
fa568972
R
2626.It Va vkernel_kill_timeout
2627.Pq Vt int
2628This defines the default number of seconds that we will wait for the
2629vkernel to shut down on it's own. If after this time it's still alive,
2630it will be killed with SIGKILL.
2631.It Va vkernel_bin
2632.Pq Vt str
2633Defines the default path to the vkernel binary.
2feb07f7
SW
2634.It Va vkernel_list
2635.Pq Vt str
2636A space separated list of names for vkernels.
2637This is purely a configuration aid to help identify and
2638configure multiple vkernels.
2639The names specified in this list will be used to
2640identify settings common to a vkernel instance.
2641Assuming that the vkernel in question was named
2642.Li example ,
2643you would have the following dependent variables
2644(filled with reference values in this text):
2645.Bd -literal
2646vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2647vkernel_example_memsize="64m"
2648vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2649vkernel_example_iface_list="auto:bridge0"
2650vkernel_example_logfile="/dev/null"
2651vkernel_example_flags="-U"
fa568972 2652vkernel_example_kill_timeout="45"
2feb07f7
SW
2653.Ed
2654.Pp
fa568972 2655The last five are optional.
2feb07f7
SW
2656They default to an empty string if not set, except for logfile which defaults to
2657.Pa /dev/null
2658if it is not set.
984263bc
MD
2659.El
2660.Sh FILES
717e8ef7 2661.Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
984263bc
MD
2662.It Pa /etc/defaults/rc.conf
2663.It Pa /etc/rc.conf
2664.It Pa /etc/rc.conf.local
717e8ef7 2665.It Pa /etc/start_if. Ns Aq Ar interface
984263bc
MD
2666.El
2667.Sh SEE ALSO
2668.Xr catman 1 ,
2669.Xr gdb 1 ,
2670.Xr info 1 ,
445243bf 2671.Xr kbdcontrol 1 ,
850afac2 2672.Xr varsym 1 ,
984263bc 2673.Xr vidcontrol 1 ,
445243bf 2674.Xr ip 4 ,
27e9fed5 2675.Xr ipfw 4 ,
445243bf 2676.Xr kld 4 ,
27e9fed5 2677.Xr pf 4 ,
984263bc
MD
2678.Xr tcp 4 ,
2679.Xr udp 4 ,
2680.Xr exports 5 ,
2681.Xr motd 5 ,
850afac2
SW
2682.Xr resident.conf 5 ,
2683.Xr varsym.conf 5 ,
984263bc
MD
2684.Xr accton 8 ,
2685.Xr amd 8 ,
2686.Xr apm 8 ,
2687.Xr atm 8 ,
5f834906 2688.Xr btconfig 8 ,
ec4e37b7 2689.Xr bthcid 8 ,
984263bc 2690.Xr cron 8 ,
4b8c406a 2691.Xr devd 8 ,
984263bc 2692.Xr dhclient 8 ,
c54db4b1 2693.Xr dntpd 8 ,
850afac2 2694.Xr ftpd 8 ,
984263bc
MD
2695.Xr ifconfig 8 ,
2696.Xr inetd 8 ,
b58abc5e 2697.Xr jail 8 ,
984263bc 2698.Xr lpd 8 ,
375d1659 2699.Xr makewhatis 8 ,
850afac2 2700.Xr mixer 8 ,
984263bc
MD
2701.Xr mountd 8 ,
2702.Xr moused 8 ,
2703.Xr mrouted 8 ,
2704.Xr named 8 ,
2705.Xr nfsd 8 ,
984263bc 2706.Xr pcnfsd 8 ,
27e9fed5
SW
2707.Xr pfctl 8 ,
2708.Xr pflogd 8 ,
984263bc
MD
2709.Xr quotacheck 8 ,
2710.Xr quotaon 8 ,
2711.Xr rc 8 ,
2712.Xr rc.sendmail 8 ,
850afac2
SW
2713.Xr resident 8 ,
2714.Xr rndcontrol 8 ,
984263bc
MD
2715.Xr route 8 ,
2716.Xr routed 8 ,
3b813696 2717.Xr rpcbind 8 ,
984263bc
MD
2718.Xr rpc.lockd 8 ,
2719.Xr rpc.statd 8 ,
717e8ef7 2720.Xr rtadvd 8 ,
bdbd8a5b 2721.Xr rtsold 8 ,
984263bc
MD
2722.Xr rwhod 8 ,
2723.Xr savecore 8 ,
5f834906 2724.Xr sdpd 8 ,
eb3a3472 2725.Xr sensorsd 8 ,
984263bc
MD
2726.Xr sshd 8 ,
2727.Xr swapon 8 ,
2728.Xr sysctl 8 ,
2729.Xr syslogd 8 ,
2730.Xr timed 8 ,
445243bf 2731.Xr usbd 8 ,
984263bc 2732.Xr vinum 8 ,
984263bc
MD
2733.Xr yp 8 ,
2734.Xr ypbind 8 ,
2735.Xr ypserv 8 ,
2736.Xr ypset 8
2737.Sh HISTORY
2738The
2739.Nm
2740file appeared in
2741.Fx 2.2.2 .
2742.Sh AUTHORS
2743.An Jordan K. Hubbard .