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