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