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