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