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