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