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