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