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