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