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