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