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