kernel: Remove some old ISA only drivers.
[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.\"
36c417a0 27.Dd June 30, 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.
1413.It Va ipv6_static_routes
1414.Pq Vt str
1415The IPv6 equivalent of
1416.Va static_routes .
1417If not set to
1418.Dq Li NO
1419then for each whitespace separated
1420.Ar element
1421in the value, a
1422.Va ipv6_route_ Ns Aq Ar element
225e0ed5 1423variable is assumed to exist whose contents will later be passed to a
445243bf 1424.Dq Nm route Cm add Fl inet6
984263bc
MD
1425operation.
1426.It Va gateway_enable
1427.Pq Vt bool
1428If set to
445243bf
RG
1429.Dq Li YES ,
1430configure host to act as an IP router, e.g. to forward packets
984263bc 1431between interfaces.
445243bf
RG
1432.It Va ipv6_gateway_enable
1433.Pq Vt bool
1434The IPv6 equivalent of
1435.Va gateway_enable .
984263bc
MD
1436.It Va router_enable
1437.Pq Vt bool
1438If set to
445243bf 1439.Dq Li YES ,
225e0ed5 1440run a routing daemon of some sort, based on the settings of
221b91ff 1441.Va router_program
984263bc
MD
1442and
1443.Va router_flags .
445243bf
RG
1444.It Va ipv6_router_enable
1445.Pq Vt bool
1446The IPv6 equivalent of
1447.Va router_enable .
1448If set to
1449.Dq Li YES ,
225e0ed5 1450run a routing daemon of some sort, based on the settings of
221b91ff 1451.Va ipv6_router_program
445243bf
RG
1452and
1453.Va ipv6_router_flags .
221b91ff 1454.It Va router_program
984263bc
MD
1455.Pq Vt str
1456If
1457.Va router_enable
1458is set to
445243bf 1459.Dq Li YES ,
717e8ef7
TN
1460this is the name of the routing daemon to use
1461(default
1462.Pa /sbin/routed ) .
221b91ff 1463.It Va ipv6_router_program
445243bf
RG
1464.Pq Vt str
1465The IPv6 equivalent of
717e8ef7
TN
1466.Va router_program
1467(default
1468.Pa /sbin/route6d ) .
984263bc
MD
1469.It Va router_flags
1470.Pq Vt str
1471If
1472.Va router_enable
1473is set to
445243bf 1474.Dq Li YES ,
984263bc 1475these are the flags to pass to the routing daemon.
445243bf
RG
1476.It Va ipv6_router_flags
1477.Pq Vt str
1478The IPv6 equivalent of
1479.Va router_flags .
984263bc
MD
1480.It Va mrouted_enable
1481.Pq Vt bool
1482If set to
445243bf
RG
1483.Dq Li YES ,
1484run the multicast routing daemon,
984263bc 1485.Xr mrouted 8 .
445243bf
RG
1486.It Va mroute6d_enable
1487.Pq Vt bool
1488The IPv6 equivalent of
1489.Va mrouted_enable .
1490If set to
1491.Dq Li YES ,
1492run the IPv6 multicast routing daemon.
1493Note that no IPv6 multicast routing daemon is included in the
9bb2a92d 1494.Dx
445243bf
RG
1495base system but
1496.Xr pim6dd 8
28feafc7
SW
1497can be installed from the
1498.Xr pkgsrc 7
1499collection.
984263bc
MD
1500.It Va mrouted_flags
1501.Pq Vt str
1502If
1503.Va mrouted_enable
1504is set to
445243bf
RG
1505.Dq Li YES ,
1506these are the flags to pass to the
1507.Xr mrouted 8
1508daemon.
1509.It Va mroute6d_flags
1510.Pq Vt str
1511The IPv6 equivalent of
1512.Va mrouted_flags .
1513If
1514.Va mroute6d_enable
1515is set to
1516.Dq Li YES ,
1517these are the flags passed to the IPv6 multicast routing daemon.
1518.It Va mroute6d_program
1519.Pq Vt str
1520If
1521.Va mroute6d_enable
1522is set to
1523.Dq Li YES ,
1524this is the path to the IPv6 multicast routing daemon.
1525.It Va rtadvd_enable
1526.Pq Vt bool
1527If set to
1528.Dq Li YES ,
1529run the
1530.Xr rtadvd 8
1531daemon at boot time.
1532.Xr rtadvd 8
1533will only run if
1534.Va ipv6_gateway_enable
1535is also set to
1536.Dq Li YES .
1537The
1538.Xr rtadvd 8
1539utility sends router advertisement packets to the interfaces specified in
1540.Va rtadvd_interfaces .
1541.Xr rtadvd 8
1542and should only be enabled with great care.
1543You may want to fine-tune
1544.Xr rtadvd.conf 5 .
1545.It Va rtadvd_interfaces
1546.Pq Vt str
1547If
1548.Va rtadvd_enable
1549is set to
1550.Dq Li YES
1551this is the list of interfaces to use.
bdbd8a5b
SW
1552.It Va rtsold_enable
1553.Pq Vt bool
1554If set to
1555.Dq Li YES ,
1556run the
1557.Xr rtsold 8
1558daemon at boot time.
1559The
1560.Xr rtsold 8
1561daemon is used for automatic discovery of non-link local addresses.
1562.It Va rtsold_flags
1563.Pq Vt str
1564If
1565.Va rtsold_enable
1566is set to
1567.Dq Li YES ,
1568these are the flags to pass to the
1569.Xr rtsold 8
1570daemon.
984263bc
MD
1571.It Va ipxgateway_enable
1572.Pq Vt bool
1573If set to
445243bf
RG
1574.Dq Li YES ,
1575enable the routing of IPX traffic.
984263bc
MD
1576.It Va ipxrouted_enable
1577.Pq Vt bool
1578If set to
445243bf
RG
1579.Dq Li YES ,
1580run the
984263bc
MD
1581.Xr IPXrouted 8
1582daemon at system boot time.
1583.It Va ipxrouted_flags
1584.Pq Vt str
1585If
1586.Va ipxrouted_enable
1587is set to
445243bf 1588.Dq Li YES ,
984263bc
MD
1589these are the flags to pass to the
1590.Xr IPXrouted 8
1591daemon.
1592.It Va arpproxy_all
1593.Pq Vt bool
1594If set to
445243bf
RG
1595.Dq Li YES ,
1596enable global proxy ARP.
984263bc
MD
1597.It Va forward_sourceroute
1598.Pq Vt bool
1599If set to
445243bf
RG
1600.Dq Li YES
1601and
984263bc
MD
1602.Va gateway_enable
1603is also set to
445243bf
RG
1604.Dq Li YES ,
1605source-routed packets are forwarded.
984263bc
MD
1606.It Va accept_sourceroute
1607.Pq Vt bool
1608If set to
445243bf
RG
1609.Dq Li YES ,
1610the system will accept source-routed packets directed at it.
984263bc
MD
1611.It Va rarpd_enable
1612.Pq Vt bool
1613If set to
445243bf
RG
1614.Dq Li YES ,
1615run the
984263bc
MD
1616.Xr rarpd 8
1617daemon at system boot time.
1618.It Va rarpd_flags
1619.Pq Vt str
1620If
1621.Va rarpd_enable
1622is set to
445243bf 1623.Dq Li YES ,
984263bc
MD
1624these are the flags to pass to the
1625.Xr rarpd 8
1626daemon.
445243bf
RG
1627.It Va bootparamd_enable
1628.Pq Vt bool
1629If set to
1630.Dq Li YES ,
1631run the
1632.Xr bootparamd 8
1633daemon at system boot time.
1634.It Va bootparamd_flags
1635.Pq Vt str
1636If
1637.Va bootparamd_enable
1638is set to
1639.Dq Li YES ,
1640these are the flags to pass to the
1641.Xr bootparamd 8
1642daemon.
1643.It Va stf_interface_ipv4addr
1644.Pq Vt str
1645If not set to
1646.Dq Li NO ,
225e0ed5 1647this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
445243bf
RG
1648Specify this entry to enable the 6to4 interface.
1649.It Va stf_interface_ipv4plen
1650.Pq Vt int
1651Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1652An effective value is 0-31.
1653.It Va stf_interface_ipv6_ifid
1654.Pq Vt str
1655IPv6 interface ID for
1656.Xr stf 4 .
1657This can be set to
1658.Dq Li AUTO .
1659.It Va stf_interface_ipv6_slaid
1660.Pq Vt str
1661IPv6 Site Level Aggregator for
1662.Xr stf 4 .
1663.It Va ipv6_faith_prefix
1664.Pq Vt str
1665If not set to
1666.Dq Li NO ,
225e0ed5 1667this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
445243bf
RG
1668You also need
1669.Xr faithd 8
1670setup.
1671.It Va ipv6_ipv4mapping
1672.Pq Vt bool
1673If set to
1674.Dq Li YES
1675this enables IPv4 mapped IPv6 address communication (like
1676.Li ::ffff:a.b.c.d ) .
984263bc
MD
1677.It Va atm_enable
1678.Pq Vt bool
1679Set to
445243bf 1680.Dq Li YES
984263bc
MD
1681to enable the configuration of ATM interfaces at system boot time.
1682For all of the ATM variables described below, please refer to the
1683.Xr atm 8
1684man page for further details on the available command parameters.
1685Also refer to the files in
1686.Pa /usr/share/examples/atm
1687for more detailed configuration information.
445243bf 1688.It Va atm_netif_ Ns Aq Ar intf
984263bc
MD
1689.Pq Vt str
1690For the ATM physical interface
445243bf
RG
1691.Ar intf ,
1692this variable defines the name prefix and count for the ATM network
1693interfaces to be created.
984263bc 1694The value will be passed as the parameters of an
445243bf 1695.Dq Nm atm Cm "set netif" Ar intf
984263bc 1696command.
445243bf 1697.It Va atm_sigmgr_ Ns Aq Ar intf
984263bc
MD
1698.Pq Vt str
1699For the ATM physical interface
445243bf 1700.Ar intf ,
984263bc
MD
1701this variable defines the ATM signalling manager to be used.
1702The value will be passed as the parameters of an
445243bf 1703.Dq Nm atm Cm attach Ar intf
984263bc 1704command.
445243bf 1705.It Va atm_prefix_ Ns Aq Ar intf
984263bc
MD
1706.Pq Vt str
1707For the ATM physical interface
445243bf 1708.Ar intf ,
984263bc 1709this variable defines the NSAP prefix for interfaces using a UNI signalling
445243bf
RG
1710manager.
1711If set to
1712.Dq Li ILMI ,
1713the prefix will automatically be set via the
984263bc 1714.Xr ilmid 8
445243bf
RG
1715daemon.
1716Otherwise, the value will be passed as the parameters of an
1717.Dq Nm atm Cm "set prefix" Ar intf
984263bc 1718command.
445243bf 1719.It Va atm_macaddr_ Ns Aq Ar intf
984263bc
MD
1720.Pq Vt str
1721For the ATM physical interface
445243bf 1722.Ar intf ,
984263bc 1723this variable defines the MAC address for interfaces using a UNI signalling
445243bf
RG
1724manager.
1725If set to
1726.Dq Li NO ,
1727the hardware MAC address contained in the ATM interface card will be used.
984263bc 1728Otherwise, the value will be passed as the parameters of an
445243bf 1729.Dq Nm atm Cm "set mac" Ar intf
984263bc 1730command.
445243bf 1731.It Va atm_arpserver_ Ns Aq Ar netif
984263bc
MD
1732.Pq Vt str
1733For the ATM network interface
445243bf 1734.Ar netif ,
984263bc 1735this variable defines the ATM address for a host which is to provide ATMARP
445243bf 1736service.
225e0ed5 1737This variable is only applicable to interfaces using a UNI signalling manager.
445243bf
RG
1738If set to
1739.Dq Li local ,
1740this host will become an ATMARP server.
984263bc 1741The value will be passed as the parameters of an
445243bf 1742.Dq Nm atm Cm "set arpserver" Ar netif
984263bc 1743command.
445243bf 1744.It Va atm_scsparp_ Ns Aq Ar netif
984263bc
MD
1745.Pq Vt bool
1746If set to
445243bf
RG
1747.Dq Li YES ,
1748SCSP/ATMARP service for the network interface
1749.Ar netif
984263bc
MD
1750will be initiated using the
1751.Xr scspd 8
1752and
1753.Xr atmarpd 8
445243bf
RG
1754daemons.
1755This variable is only applicable if
984263bc 1756.Va atm_arpserver_ Ns Aq Ar netif
445243bf
RG
1757is set to
1758.Dq Li local .
984263bc
MD
1759.It Va atm_arps
1760.Pq Vt str
225e0ed5 1761Set to the list of permanent ATM ARP entries to be added at system boot time.
445243bf 1762For each whitespace separated
984263bc
MD
1763.Ar element
1764in the value, an
1765.Va atm_arp_ Ns Aq Ar element
445243bf 1766variable is assumed to exist.
225e0ed5 1767The value of each of these variables will be passed as the parameters of an
445243bf 1768.Dq Nm atm Cm "add arp"
984263bc 1769command.
445243bf
RG
1770.It Va keybell
1771.Pq Vt str
1772The keyboard bell sound.
1773Set to
1774.Dq Li normal ,
1775.Dq Li visual ,
1776.Dq Li off ,
1777or
1778.Dq Li NO
1779if the default behavior is desired.
1780For details, refer to the
1781.Xr kbdcontrol 1
1782manpage.
984263bc
MD
1783.It Va keymap
1784.Pq Vt str
1785If set to
445243bf
RG
1786.Dq Li NO ,
1787no keymap is installed, otherwise the value is used to install
984263bc 1788the keymap file in
445243bf 1789.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
984263bc
MD
1790.It Va keyrate
1791.Pq Vt str
445243bf
RG
1792The keyboard repeat speed.
1793Set to
1794.Dq Li slow ,
1795.Dq Li normal ,
1796.Dq Li fast ,
984263bc 1797or
445243bf 1798.Dq Li NO
984263bc
MD
1799if the default behavior is desired.
1800.It Va keychange
1801.Pq Vt str
1802If not set to
445243bf
RG
1803.Dq Li NO ,
1804attempt to program the function keys with the value.
225e0ed5 1805The value should be a single string of the form:
445243bf 1806.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
984263bc
MD
1807.It Va cursor
1808.Pq Vt str
1809Can be set to the value of
445243bf
RG
1810.Dq Li normal ,
1811.Dq Li blink ,
1812.Dq Li destructive ,
984263bc 1813or
445243bf 1814.Dq Li NO
984263bc
MD
1815to set the cursor behavior explicitly or choose the default behavior.
1816.It Va scrnmap
1817.Pq Vt str
1818If set to
445243bf
RG
1819.Dq Li NO ,
1820no screen map is installed, otherwise the value is used to install
984263bc 1821the screen map file in
445243bf 1822.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
984263bc
MD
1823.It Va font8x16
1824.Pq Vt str
1825If set to
445243bf
RG
1826.Dq Li NO ,
1827the default 8x16 font value is used for screen size requests, otherwise
984263bc 1828the value in
445243bf 1829.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1830is used.
1831.It Va font8x14
1832.Pq Vt str
1833If set to
445243bf
RG
1834.Dq Li NO ,
1835the default 8x14 font value is used for screen size requests, otherwise
984263bc 1836the value in
445243bf 1837.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1838is used.
1839.It Va font8x8
1840.Pq Vt str
1841If set to
445243bf
RG
1842.Dq Li NO ,
1843the default 8x8 font value is used for screen size requests, otherwise
984263bc 1844the value in
445243bf 1845.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
984263bc
MD
1846is used.
1847.It Va blanktime
1848.Pq Vt int
1849If set to
445243bf 1850.Dq Li NO ,
225e0ed5 1851the default screen blanking interval is used, otherwise it is set to
984263bc
MD
1852.Ar value
1853seconds.
1854.It Va saver
1855.Pq Vt str
1856If not set to
445243bf
RG
1857.Dq Li NO ,
1858this is the actual screen saver to use
1859.Li ( blank , snake , daemon ,
1860etc).
984263bc
MD
1861.It Va moused_enable
1862.Pq Vt str
1863If set to
445243bf 1864.Dq Li YES ,
984263bc
MD
1865the
1866.Xr moused 8
1867daemon is started for doing cut/paste selection on the console.
1868.It Va moused_type
1869.Pq Vt str
1870This is the protocol type of the mouse connected to this host.
1871This variable must be set if
1872.Va moused_enable
1873is set to
445243bf 1874.Dq Li YES .
984263bc
MD
1875The
1876.Xr moused 8
1877daemon
1878is able to detect the appropriate mouse type automatically in many cases.
1879Set this variable to
445243bf 1880.Dq Li auto
984263bc
MD
1881to let the daemon detect it, or
1882select one from the following list if the automatic detection fails.
1883.Pp
1884If the mouse is attached to the PS/2 mouse port, choose
445243bf 1885.Dq Li auto
984263bc 1886or
445243bf
RG
1887.Dq Li ps/2 ,
1888regardless of the brand and model of the mouse.
225e0ed5 1889Likewise, if the mouse is attached to the bus mouse port, choose
445243bf 1890.Dq Li auto
984263bc 1891or
445243bf 1892.Dq Li busmouse .
984263bc
MD
1893All other protocols are for serial mice and will not work with
1894the PS/2 and bus mice.
1895If this is a USB mouse,
445243bf 1896.Dq Li auto
984263bc 1897is the only protocol type which will work.
445243bf
RG
1898.Pp
1899.Bl -tag -width ".Li x10mouseremote" -compact
1900.It Li microsoft
1901Microsoft mouse (serial)
1902.It Li intellimouse
1903Microsoft IntelliMouse (serial)
1904.It Li mousesystems
1905Mouse systems Corp. mouse (serial)
1906.It Li mmseries
1907MM Series mouse (serial)
1908.It Li logitech
1909Logitech mouse (serial)
1910.It Li busmouse
1911A bus mouse
1912.It Li mouseman
1913Logitech MouseMan and TrackMan (serial)
1914.It Li glidepoint
1915ALPS GlidePoint (serial)
1916.It Li thinkingmouse
1917Kensington ThinkingMouse (serial)
1918.It Li ps/2
1919PS/2 mouse
1920.It Li mmhittab
1921MM HitTablet (serial)
1922.It Li x10mouseremote
1923X10 MouseRemote (serial)
1924.It Li versapad
1925Interlink VersaPad (serial)
1926.El
984263bc
MD
1927.Pp
1928Even if the mouse is not in the above list, it may be compatible
1929with one in the list.
1930Refer to the man page for
1931.Xr moused 8
1932for compatibility information.
1933.Pp
1934It should also be noted that while this is enabled, any
1935other client of the mouse (such as an X server) should access
445243bf
RG
1936the mouse through the virtual mouse device,
1937.Pa /dev/sysmouse ,
1938and configure it as a
1939.Dq Li sysmouse
1940type mouse, since all
225e0ed5 1941mouse data is converted to this single canonical format when using
984263bc 1942.Xr moused 8 .
445243bf
RG
1943If the client program does not support the
1944.Dq Li sysmouse
225e0ed5 1945type, specify the
445243bf
RG
1946.Dq Li mousesystems
1947type.
984263bc
MD
1948It is the second preferred type.
1949.It Va moused_port
1950.Pq Vt str
1951If
1952.Va moused_enable
1953is set to
445243bf 1954.Dq Li YES ,
984263bc
MD
1955this is the actual port the mouse is on.
1956It might be
1957.Pa /dev/cuaa0
ad9f8794 1958for a COM1 serial mouse or
984263bc 1959.Pa /dev/psm0
ad9f8794 1960for a PS/2 mouse, for example.
984263bc
MD
1961.It Va moused_flags
1962.Pq Vt str
1963If
1964.Va moused_type
1965is set, these are the additional flags to pass to the
1966.Xr moused 8
1967daemon.
445243bf
RG
1968.It Va mousechar_start
1969.Pq Vt int
1970If set to
1971.Dq Li NO ,
1972the default mouse cursor character range
1973.Li 0xd0 Ns - Ns Li 0xd3
225e0ed5 1974is used, otherwise the range start is set to
445243bf
RG
1975.Ar value
1976character, see
1977.Xr vidcontrol 1 .
1978Use if the default range is occupied in the language code table.
850afac2
SW
1979.It Va vidhistory
1980.Pq Vt int
1981Set the size of the history (scrollback) buffer in lines.
984263bc
MD
1982.It Va allscreens_flags
1983.Pq Vt str
1984If set,
1985.Xr vidcontrol 1
1986is run with these options for each of the virtual terminals
1987.Pq Pa /dev/ttyv* .
1988For example,
445243bf 1989.Dq Fl m Cm on
225e0ed5 1990will enable the mouse pointer on all virtual terminals if
984263bc
MD
1991.Va moused_enable
1992is set to
445243bf
RG
1993.Dq Li YES .
1994.It Va allscreens_kbdflags
1995.Pq Vt str
1996If set,
1997.Xr kbdcontrol 1
1998is run with these options for each of the virtual terminals
1999.Pq Pa /dev/ttyv* .
2000For example,
2001.Dq Fl h Li 200
2002will set the
2003.Xr syscons 4
2004scrollback (history) buffer to 200 lines.
984263bc
MD
2005.It Va cron_enable
2006.Pq Vt bool
2007If set to
445243bf
RG
2008.Dq Li YES ,
2009run the
984263bc
MD
2010.Xr cron 8
2011daemon at system boot time.
2012.It Va cron_program
2013.Pq Vt str
2014Path to
2015.Xr cron 8
2016(default
2017.Pa /usr/sbin/cron ) .
2018.It Va cron_flags
2019.Pq Vt str
2020If
2021.Va cron_enable
2022is set to
445243bf 2023.Dq Li YES ,
984263bc
MD
2024these are the flags to pass to
2025.Xr cron 8 .
2026.It Va lpd_program
2027.Pq Vt str
2028Path to
2029.Xr lpd 8
2030(default
2031.Pa /usr/sbin/lpd ) .
2032.It Va lpd_enable
2033.Pq Vt bool
2034If set to
445243bf
RG
2035.Dq Li YES ,
2036run the
984263bc
MD
2037.Xr lpd 8
2038daemon at system boot time.
2039.It Va lpd_flags
2040.Pq Vt str
2041If
2042.Va lpd_enable
2043is set to
445243bf 2044.Dq Li YES ,
984263bc
MD
2045these are the flags to pass to the
2046.Xr lpd 8
2047daemon.
52163b73
SW
2048.It Va nscd_enable
2049.Pq Vt bool
2050If set to
2051.Dq Li YES ,
2052run the
2053.Xr nscd 8
2054daemon at system boot time.
850afac2
SW
2055.It Va mixer_enable
2056.Pq Vt bool
2057If set to
2058.Dq Li YES ,
2059preserve
2060.Xr mixer 8
2061settings across reboots.
984263bc
MD
2062.It Va mta_start_script
2063.Pq Vt str
717e8ef7 2064The full path to the script to run to start
984263bc
MD
2065a mail transfer agent.
2066The default is
2067.Pa /etc/rc.sendmail .
2068The
2069.Va sendmail_*
2070variables which
2071.Pa /etc/rc.sendmail
2072uses are documented in the
2073.Xr rc.sendmail 8
2074man page.
a12bb799
SW
2075.It Va fixbootfile
2076.Pq Vt bool
2077In a
2078.Sq HAMMER ROOT with UFS /boot
2079setup, the boot loader will not set up the
2080.Va kern.bootfile
2081sysctl correctly.
2082The system will attempt to fix this on its own.
2083Set this variable to
2084.Dq Li NO
2085to turn this behavior off.
984263bc
MD
2086.It Va dumpdev
2087.Pq Vt str
2088Indicates the device (usually a swap partition) to which a crash dump
2089should be written in the event of a system crash.
2090The value of this variable is passed as the argument to
f8e9b4ce
MD
2091.Xr dumpon 8
2092and
2093.Xr savecore 8 .
984263bc 2094To disable crash dumps, set this variable to
445243bf 2095.Dq Li NO .
984263bc
MD
2096.It Va dumpdir
2097.Pq Vt str
2098When the system reboots after a crash and a crash dump is found on the
2099device specified by the
2100.Va dumpdev
2101variable,
2102.Xr savecore 8
2103will save that crash dump and a copy of the kernel to the directory
2104specified by the
2105.Va dumpdir
2106variable.
2107The default value is
445243bf 2108.Pa /var/crash .
984263bc 2109Set to
445243bf 2110.Dq Li NO
984263bc
MD
2111to not run
2112.Xr savecore 8
2113at boot time when
2114.Va dumpdir
2115is set.
2116.It Va savecore_flags
2117.Pq Vt str
2118If crash dumps are enabled, these are the flags to pass to the
2119.Xr savecore 8
2120utility.
7fb3111b
AH
2121.It Va crashinfo_enable
2122.Pq Vt bool
2123Set to
2124.Dq Li YES
2125to turn on automatic crash dump summary generation using the utility
2126specified by the
2127.Va crashinfo_program
2128variable.
2129.It Va crashinfo_program
2130.Pq Vt str
2131Program to run to generate a crash dump summary if the variable
2132.Va crashinfo_enable
2133is set to
2134.Dq Li YES .
2135The default value is
2136.Pa /usr/sbin/crashinfo .
984263bc
MD
2137.It Va enable_quotas
2138.Pq Vt bool
2139Set to
445243bf 2140.Dq Li YES
984263bc
MD
2141to turn on user disk quotas on system startup via the
2142.Xr quotaon 8
2143command.
2144.It Va check_quotas
2145.Pq Vt bool
2146Set to
445243bf 2147.Dq Li YES
984263bc
MD
2148to enable user disk quota checking via the
2149.Xr quotacheck 8
2150command.
2151.It Va accounting_enable
2152.Pq Vt bool
2153Set to
445243bf 2154.Dq Li YES
984263bc
MD
2155to enable system accounting through the
2156.Xr accton 8
2157facility.
984263bc
MD
2158.It Va linux_enable
2159.Pq Vt bool
2160Set to
445243bf 2161.Dq Li YES
225e0ed5 2162to enable Linux/ELF binary emulation at system initial boot time.
445243bf
RG
2163.It Va sysvipc_enable
2164.Pq Vt bool
2165If set to
2166.Dq Li YES ,
2167load System V IPC primitives at boot time.
de5b97b6
MD
2168.\" ----- cleanvar_enable setting--------------------------------
2169.It Va cleanvar_enable
2170.Pq Vt bool
2171Set to
2172.Dq Li YES
2173to have
2174.Pa /var/run ,
2175.Pa /var/spool/lock
2176and
2177.Pa /var/spool/uucp/.Temp/*
2178cleaned at startup.
2179.\" ----- clear_tmp_enable setting-------------------------------
984263bc
MD
2180.It Va clear_tmp_enable
2181.Pq Vt bool
2182Set to
445243bf 2183.Dq Li YES
984263bc
MD
2184to have
2185.Pa /tmp
2186cleaned at startup.
de5b97b6 2187.\" ----- ldconfig_paths setting --------------------------------
984263bc
MD
2188.It Va ldconfig_paths
2189.Pq Vt str
2190Set to the list of shared library paths to use with
2191.Xr ldconfig 8 .
2192NOTE:
2193.Pa /usr/lib
2194will always be added first, so it need not appear in this list.
2195.It Va ldconfig_insecure
2196.Pq Vt bool
2197The
2198.Xr ldconfig 8
2199utility normally refuses to use directories
2200which are writable by anyone except root.
2201Set this variable to
445243bf 2202.Dq Li YES
984263bc 2203to disable that security check during system startup.
984263bc
MD
2204.It Va kern_securelevel
2205.Pq Vt int
2206The kernel security level to set at startup.
2207The allowed range of
2208.Ar value
225e0ed5 2209ranges from \-1 (the compile time default) to 3 (the most secure).
445243bf 2210See
984263bc 2211.Xr init 8
225e0ed5 2212for the list of possible security levels and their effect on system operation.
984263bc
MD
2213.It Va start_vinum
2214.Pq Vt bool
2215Set to
445243bf 2216.Dq Li YES
984263bc
MD
2217to start
2218.Xr vinum 8
2219at system boot time.
984263bc
MD
2220.It Va sshd_enable
2221.Pq Vt bool
2222Set to
445243bf 2223.Dq Li YES
984263bc
MD
2224to start
2225.Xr sshd 8
2226at system boot time.
850afac2
SW
2227.It Va sshd_program
2228.Pq Vt str
2229Path to the SSH server program
717e8ef7
TN
2230(default
2231.Pa /usr/sbin/sshd ) .
984263bc
MD
2232.It Va sshd_flags
2233.Pq Vt str
2234If
2235.Va sshd_enable
2236is set to
445243bf 2237.Dq Li YES ,
984263bc
MD
2238these are the flags to pass to the
2239.Xr sshd 8
2240daemon.
850afac2
SW
2241.It Va ftpd_enable
2242.Pq Vt bool
2243Set to
2244.Dq Li YES
2245to start
2246.Xr ftpd 8
2247at system boot time.
2248.It Va ftpd_flags
2249.Pq Vt str
2250If
2251.Va ftpd_enable
2252is set to
2253.Dq Li YES ,
2254these are the flags to pass to the
2255.Xr ftpd 8
2256daemon.
445243bf
RG
2257.It Va usbd_enable
2258.Pq Vt bool
2259If set to
2260.Dq Li YES ,
2261run the
2262.Xr usbd 8
2263daemon at boot time.
2264.It Va usbd_flags
2265.Pq Vt str
2266If
2267.Va usbd_enable
2268is set to
2269.Dq Li YES ,
2270these are the flags passed to
2271.Xr usbd 8
2272daemon.
2273.It Va watchdogd_enable
2274.Pq Vt bool
2275If set to
2276.Dq Li YES ,
2277start the
2278.Xr watchdogd 8
2279daemon at boot time.
2280This requires that the kernel have been compiled with
2281.Cd "options WATCHDOG" .
2282.It Va jail_enable
2283.Pq Vt bool
2284If set to
2285.Dq Li NO ,
2286any configured jails will not be started.
2287.It Va jail_list
2288.Pq Vt str
2289A space separated list of names for jails.
2290This is purely a configuration aid to help identify and
2291configure multiple jails.
2292The names specified in this list will be used to
2293identify settings common to an instance of a jail.
2294Assuming that the jail in question was named
2295.Li vjail ,
56be8454 2296you would have the following dependent variables:
445243bf
RG
2297.Bd -literal
2298jail_vjail_hostname="jail.example.com"
2299jail_vjail_ip="192.168.1.100"
2300jail_vjail_rootdir="/var/jails/vjail/root"
445243bf
RG
2301.Ed
2302.Pp
b58abc5e
SW
2303.It Va jail_flags
2304.Pq Vt str
2305Unset by default.
2306When set, use as default value for
2307.Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2308for every jail in
2309.Va jail_list .
2310.It Va jail_interface
2311.Pq Vt str
2312Unset by default.
2313When set, use as default value for
2314.Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2315for every jail in
2316.Va jail_list .
2317.It Va jail_fstab
2318.Pq Vt str
2319Unset by default.
2320When set, use as default value for
2321.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2322for every jail in
2323.Va jail_list .
2324.It Va jail_mount_enable
2325.Pq Vt bool
2326Set to
2327.Dq Li NO
2328by default.
2329When set to
2330.Dq Li YES ,
2331sets
2332.Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2333to
2334.Dq Li YES
2335by default for every jail in
2336.Va jail_list .
2337.It Va jail_fdesc_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 _fdesc_enable
2346to
2347.Dq Li YES
2348by default for every jail in
2349.Va jail_list .
2350.It Va jail_procfs_enable
2351.Pq Vt bool
2352Set to
2353.Dq Li NO
2354by default.
2355When set to
2356.Dq Li YES ,
2357sets
36c417a0 2358.Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
b58abc5e
SW
2359to
2360.Dq Li YES
2361by default for every jail in
2362.Va jail_list .
f8ff0183
AHJ
2363.It Va jail_devfs_enable
2364.Pq Vt bool
2365Set to
2366.Dq Li NO
2367by default.
2368When set to
2369.Dq Li YES ,
2370sets
2371.Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2372to
2373.Dq Li YES
2374by default for every jail in
2375.Va jail_list .
b58abc5e
SW
2376.It Va jail_exec_start
2377.Pq Vt str
2378Unset by default.
2379When set, use as default value for
2380.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2381for every jail in
2382.Va jail_list .
2383.It Va jail_exec_stop
2384Unset by default.
2385When set, use as default value for
2386.Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2387for every jail in
2388.Va jail_list .
2389.It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2390.Pq Vt str
2391Unset by default.
2392Set to the root directory used by jail
2393.Va jname .
2394.It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2395.Pq Vt str
2396Unset by default.
2397Set to the fully qualified domain name (FQDN) assigned to jail
2398.Va jname .
2399.It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2400.Pq Vt str
2401Unset by default.
2402Set to the IP address assigned to jail
2403.Va jname .
2404.It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2405.Pq Vt str
2406Set to
2407.Dq Li -l -U root
2408by default.
2409These are flags to pass to
20ab1ccc 2410.Xr jail 8 .
b58abc5e
SW
2411.It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2412.Pq Vt str
2413Unset by default.
2414When set, sets the interface to use when setting IP address alias.
2415Note that the alias is created at jail startup and removed at jail shutdown.
2416.It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2417.Pq Vt str
2418Set to
2419.Pa /etc/fstab. Ns Aq Ar jname
2420by default.
2421This is the file system information file to use for jail
2422.Va jname .
2423.It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2424.Pq Vt bool
2425Set to
2426.Dq Li NO
2427by default.
2428When set to
2429.Dq Li YES ,
2430mount all file systems from
2431.Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2432at jail startup.
2433.It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2434.Pq Vt bool
2435Set to
2436.Dq Li NO
2437by default.
2438When set to
2439.Dq Li YES ,
2440mount the file-descriptor file system inside jail
2441.Ar jname
2442at jail startup.
2443.It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2444.Pq Vt bool
2445Set to
2446.Dq Li NO
2447by default.
2448When set to
2449.Dq Li YES ,
2450mount the process file system inside jail
2451.Ar jname
2452at jail startup.
f8ff0183
AHJ
2453.It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2454.Pq Vt bool
2455Set to
2456.Dq Li NO
2457by default.
2458When set to
2459.Dq Li YES ,
2460mount the device file system inside jail
2461.Ar jname
2462at jail startup.
b58abc5e
SW
2463.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2464.Pq Vt str
2465Set to
2466.Dq Li /bin/sh /etc/rc
2467by default.
2468This is the command executed at jail startup.
2469.It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2470.Pq Vt str
2471Set to
2472.Dq Li /bin/sh /etc/rc.shutdown
2473by default.
2474This is the command executed at jail shutdown.
445243bf
RG
2475.It Va jail_set_hostname_allow
2476.Pq Vt bool
2477If set to
2478.Dq Li NO ,
2479do not allow the root user in a jail to set its hostname.
2480.It Va jail_socket_unixiproute_only
2481.Pq Vt bool
2482If set to
b58abc5e
SW
2483.Dq Li YES ,
2484do not allow any sockets,
2485besides UNIX/IP/route sockets,
2486to be used within a jail.
445243bf
RG
2487.It Va jail_sysvipc_allow
2488.Pq Vt bool
2489If set to
2490.Dq Li YES ,
2491allow applications within a jail to use System V IPC.
0e132b2a
AH
2492.It Va lvm_enable
2493.Pq Vt bool
2494If set to
2495.Dq Li YES
2496LVM volumes will be discovered and configured on boot.
842eea5b
SW
2497.It Va newsyslog_enable
2498.Pq Vt bool
2499If set to
2500.Dq Li YES ,
2501run
2502.Xr newsyslog 8
2503before syslogd starts.
2504.It Va newsyslog_flags
2505.Pq Vt str
2506If
2507.Va newsyslog_enable
2508is set to
2509.Dq Li YES ,
2510these are the flags passed to
2511.Xr newsyslog 8 .
850afac2
SW
2512.It Va resident_enable
2513.Pq Vt bool
2514If set to
2515.Dq Li YES ,
2516make the dynamic binaries listed in
2517.Pa /etc/resident.conf
2518resident.
2519.It Va varsym_enable
2520.Pq Vt bool
2521If set to
2522.Dq Li YES ,
2523process
2524.Pa /etc/varsym.conf
2525to set system-wide variables for variant symlinks.
705d55f1 2526.It Va rand_irqs
850afac2
SW
2527.Pq Vt str
2528Set either to
2529.Dq Li NO
2530or a whitespace separated list of IRQ numbers which will be used as a source of
2531randomness.
984263bc
MD
2532.\" ----- isdn settings ---------------------------------
2533.It Va isdn_enable
2534.Pq Vt bool
2535Set to
445243bf 2536.Dq Li NO
984263bc
MD
2537by default.
2538When set to
445243bf
RG
2539.Dq Li YES ,
2540starts the
2541.Xr isdnd 8
225e0ed5 2542daemon at system boot time.
984263bc
MD
2543.It Va isdn_flags
2544.Pq Vt str
2545Set to
445243bf 2546.Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
984263bc
MD
2547by default.
2548Additional flags to pass to
2549.Xr isdnd 8
2550(but see
2551.Va isdn_fsdev
2552and
2553.Va isdn_ttype
2554for certain tunable parameters).
2555.It Va isdn_ttype
2556.Pq Vt str
2557Set to
445243bf 2558.Dq Li cons25
984263bc
MD
2559by default.
2560The terminal type of the output device when
2561.Xr isdnd 8
445243bf 2562operates in full-screen mode.
984263bc
MD
2563.It Va isdn_screenflags
2564.Pq Vt str
2565Set to
445243bf 2566.Dq Li NO
984263bc 2567by default.
445243bf 2568The video mode for full-screen mode (only for
984263bc
MD
2569.Xr syscons 4
2570console driver, see
2571.Xr vidcontrol 1
2572for valid modes).
2573.It Va isdn_fsdev
2574.Pq Vt str
2575Set to
445243bf 2576.Dq Li NO
984263bc
MD
2577by default.
2578The output device for
2579.Xr isdnd 8
445243bf
RG
2580in full-screen mode (or
2581.Dq Li NO
984263bc
MD
2582for daemon mode).
2583.It Va isdn_trace
2584.Pq Vt bool
2585Set to
445243bf 2586.Dq Li NO
984263bc
MD
2587by default.
2588When set to
445243bf 2589.Dq Li YES ,
984263bc 2590enables the ISDN protocol trace utility
445243bf 2591.Xr isdntrace 8
984263bc
MD
2592at system boot time.
2593.It Va isdn_traceflags
2594.Pq Vt str
2595Set to
445243bf 2596.Dq Fl f Pa /var/tmp/isdntrace0
984263bc
MD
2597by default.
2598Flags for
445243bf 2599.Xr isdntrace 8 .
984263bc 2600.\" -----------------------------------------------------
445243bf
RG
2601.It Va entropy_dir
2602.Pq Vt str
2603Set to
2604.Dq Li NO
2605to disable caching entropy via
2606.Xr cron 8 .
2607Otherwise set to the directory used to store entropy files in.
2608.It Va entropy_file
2609.Pq Vt str
2610Set to
2611.Dq Li NO
2612to disable caching entropy through reboots.
225e0ed5 2613Otherwise set to the filename used to store cached entropy through reboots.
445243bf
RG
2614This file should be located on the root file system to seed the
2615.Xr random 4
2616device as early as possible in the boot process.
445243bf
RG
2617.It Va ipsec_enable
2618.Pq Vt bool
2619Set to
2620.Dq Li YES
2621to run
2622.Xr setkey 8
2623on
2624.Va ipsec_file
2625at boot time.
2626.It Va ipsec_file
2627.Pq Vt str
2628Configuration file for
2629.Xr setkey 8 .
2630.It Va dmesg_enable
2631.Pq Vt bool
2632Set to
2633.Dq Li YES
2634to save
2635.Xr dmesg 8
2636to
2637.Pa /var/run/dmesg.boot
2638on boot.
2639.It Va rcshutdown_timeout
2640.Pq Vt int
2641If set, start a watchdog timer in the background which will terminate
2642.Pa rc.shutdown
2643if
2644.Xr shutdown 8
2645has not completed within the specified time (in seconds).
0e132b2a
AH
2646.It Va udevd_enable
2647.Pq Vt bool
2648If set to
2649.Dq Li YES ,
2650the udevd daemon will be started on boot.
2feb07f7
SW
2651.It Va vkernel_enable
2652.Pq Vt bool
2653If set to
2654.Dq Li NO ,
2655any configured vkernels will not be started.
fa568972
R
2656.It Va vkernel_kill_timeout
2657.Pq Vt int
2658This defines the default number of seconds that we will wait for the
2659vkernel to shut down on it's own. If after this time it's still alive,
2660it will be killed with SIGKILL.
2661.It Va vkernel_bin
2662.Pq Vt str
2663Defines the default path to the vkernel binary.
2feb07f7
SW
2664.It Va vkernel_list
2665.Pq Vt str
2666A space separated list of names for vkernels.
2667This is purely a configuration aid to help identify and
2668configure multiple vkernels.
2669The names specified in this list will be used to
2670identify settings common to a vkernel instance.
2671Assuming that the vkernel in question was named
2672.Li example ,
2673you would have the following dependent variables
2674(filled with reference values in this text):
2675.Bd -literal
2676vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2677vkernel_example_memsize="64m"
2678vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2679vkernel_example_iface_list="auto:bridge0"
2680vkernel_example_logfile="/dev/null"
2681vkernel_example_flags="-U"
fa568972 2682vkernel_example_kill_timeout="45"
2feb07f7
SW
2683.Ed
2684.Pp
fa568972 2685The last five are optional.
2feb07f7
SW
2686They default to an empty string if not set, except for logfile which defaults to
2687.Pa /dev/null
2688if it is not set.
984263bc
MD
2689.El
2690.Sh FILES
717e8ef7 2691.Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
984263bc
MD
2692.It Pa /etc/defaults/rc.conf
2693.It Pa /etc/rc.conf
2694.It Pa /etc/rc.conf.local
717e8ef7 2695.It Pa /etc/start_if. Ns Aq Ar interface
984263bc
MD
2696.El
2697.Sh SEE ALSO
2698.Xr catman 1 ,
2699.Xr gdb 1 ,
2700.Xr info 1 ,
445243bf 2701.Xr kbdcontrol 1 ,
850afac2 2702.Xr varsym 1 ,
984263bc 2703.Xr vidcontrol 1 ,
445243bf 2704.Xr ip 4 ,
27e9fed5 2705.Xr ipfw 4 ,
445243bf 2706.Xr kld 4 ,
27e9fed5 2707.Xr pf 4 ,
984263bc
MD
2708.Xr tcp 4 ,
2709.Xr udp 4 ,
2710.Xr exports 5 ,
2711.Xr motd 5 ,
850afac2
SW
2712.Xr resident.conf 5 ,
2713.Xr varsym.conf 5 ,
984263bc
MD
2714.Xr accton 8 ,
2715.Xr amd 8 ,
2716.Xr apm 8 ,
2717.Xr atm 8 ,
5f834906 2718.Xr btconfig 8 ,
ec4e37b7 2719.Xr bthcid 8 ,
984263bc 2720.Xr cron 8 ,
4b8c406a 2721.Xr devd 8 ,
984263bc 2722.Xr dhclient 8 ,
c54db4b1 2723.Xr dntpd 8 ,
850afac2 2724.Xr ftpd 8 ,
984263bc
MD
2725.Xr ifconfig 8 ,
2726.Xr inetd 8 ,
2727.Xr isdnd 8 ,
2728.Xr isdntrace 8 ,
b58abc5e 2729.Xr jail 8 ,
984263bc 2730.Xr lpd 8 ,
375d1659 2731.Xr makewhatis 8 ,
850afac2 2732.Xr mixer 8 ,
984263bc
MD
2733.Xr mountd 8 ,
2734.Xr moused 8 ,
2735.Xr mrouted 8 ,
2736.Xr named 8 ,
2737.Xr nfsd 8 ,
984263bc 2738.Xr pcnfsd 8 ,
27e9fed5
SW
2739.Xr pfctl 8 ,
2740.Xr pflogd 8 ,
984263bc
MD
2741.Xr quotacheck 8 ,
2742.Xr quotaon 8 ,
2743.Xr rc 8 ,
2744.Xr rc.sendmail 8 ,
850afac2
SW
2745.Xr resident 8 ,
2746.Xr rndcontrol 8 ,
984263bc
MD
2747.Xr route 8 ,
2748.Xr routed 8 ,
3b813696 2749.Xr rpcbind 8 ,
984263bc
MD
2750.Xr rpc.lockd 8 ,
2751.Xr rpc.statd 8 ,
717e8ef7 2752.Xr rtadvd 8 ,
bdbd8a5b 2753.Xr rtsold 8 ,
984263bc
MD
2754.Xr rwhod 8 ,
2755.Xr savecore 8 ,
5f834906 2756.Xr sdpd 8 ,
eb3a3472 2757.Xr sensorsd 8 ,
984263bc
MD
2758.Xr sshd 8 ,
2759.Xr swapon 8 ,
2760.Xr sysctl 8 ,
2761.Xr syslogd 8 ,
2762.Xr timed 8 ,
445243bf 2763.Xr usbd 8 ,
984263bc 2764.Xr vinum 8 ,
984263bc
MD
2765.Xr yp 8 ,
2766.Xr ypbind 8 ,
2767.Xr ypserv 8 ,
2768.Xr ypset 8
2769.Sh HISTORY
2770The
2771.Nm
2772file appeared in
2773.Fx 2.2.2 .
2774.Sh AUTHORS
2775.An Jordan K. Hubbard .