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