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