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