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