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