Merge branch 'vendor/MPFR' into gcc441
[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 June 26, 2009
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 setup NFS client parameters at boot time.
1252 .It Va nfs_access_cache
1253 .Pq Vt int
1254 If
1255 .Va nfs_client_enable
1256 is set to
1257 .Dq Li YES ,
1258 this can be set to
1259 .Dq Li 0
1260 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1261 NFS ACCESS results should be cached.
1262 A value of 2-10 seconds will substantially reduce network traffic for
1263 many NFS operations.
1264 The default is 5 seconds.
1265 Note that the attribute cache holds stat information only.
1266 The NFS data cache is independent of the attribute cache and is only
1267 invalidated when the client detects that the server has modified the
1268 underlying file.
1269 This value specifies a maximum timeout.
1270 The NFS client will automatically use a shorter timeout for files which
1271 have been recently modified.
1272 .It Va nfs_neg_cache
1273 .Pq Vt int
1274 If
1275 .Va nfs_client_enable
1276 is set to
1277 .Dq Li YES ,
1278 this can be set to
1279 .Dq Li 0
1280 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1281 filenames), or to the number of seconds for which negative lookups should
1282 be cached.
1283 A value of 2-10 seconds will substantially reduce network
1284 traffic for many NFS operations, especially source code builds.
1285 The default is 3 seconds.
1286 .It Va nfs_server_enable
1287 .Pq Vt bool
1288 If set to
1289 .Dq Li YES ,
1290 run the NFS server daemons at boot time.
1291 .It Va nfs_server_flags
1292 .Pq Vt str
1293 If
1294 .Va nfs_server_enable
1295 is set to
1296 .Dq Li YES ,
1297 these are the flags to pass to the
1298 .Xr nfsd 8
1299 daemon.
1300 .It Va mountd_enable
1301 .Pq Vt bool
1302 If set to
1303 .Dq Li YES ,
1304 and no
1305 .Va nfs_server_enable
1306 is set, start
1307 .Xr mountd 8 ,
1308 but not
1309 .Xr nfsd 8
1310 daemon.
1311 It is commonly needed to run CFS without real NFS used.
1312 .It Va mountd_flags
1313 .Pq Vt str
1314 If
1315 .Va mountd_enable
1316 is set to
1317 .Dq Li YES ,
1318 these are the flags to pass to the
1319 .Xr mountd 8
1320 daemon.
1321 .It Va weak_mountd_authentication
1322 .Pq Vt bool
1323 If set to
1324 .Dq Li YES ,
1325 allow services like PCNFSD to make non-privileged mount requests.
1326 .It Va nfs_reserved_port_only
1327 .Pq Vt bool
1328 If set to
1329 .Dq Li YES ,
1330 provide NFS services only on a secure port.
1331 .It Va nfs_bufpackets
1332 .Pq Vt int
1333 If set to a number, indicates the number of packets worth of
1334 socket buffer space to reserve on an NFS client.
1335 The kernel default is typically 4.
1336 Using a higher number may be useful on gigabit networks to improve performance.
1337 The minimum value is 2 and the maximum is 64.
1338 .It Va rpc_umntall_enable
1339 .Pq Vt bool
1340 If set to
1341 .Dq Li YES
1342 (default) and we are also an NFS client, run
1343 .Xr rpc.umntall 8
1344 at boot time to clear out old mounts on remote servers.
1345 If set to
1346 .Dq Li NO
1347 then
1348 .Xr rpc.umntall 8
1349 will not be run at boot time.
1350 .It Va rpc_lockd_enable
1351 .Pq Vt bool
1352 If set to
1353 .Dq Li YES
1354 and also an NFS server, run
1355 .Xr rpc.lockd 8
1356 at boot time.
1357 .It Va rpc_lockd_flags
1358 .Pq Vt str
1359 If
1360 .Va rpc_lockd_enable
1361 is set to
1362 .Dq Li YES ,
1363 these are the flags to pass to
1364 .Xr rpc.lockd 8 .
1365 .It Va rpc_statd_enable
1366 .Pq Vt bool
1367 If set to
1368 .Dq Li YES
1369 and also an NFS server, run
1370 .Xr rpc.statd 8
1371 at boot time.
1372 .It Va rpc_statd_flags
1373 .Pq Vt str
1374 If
1375 .Va rpc_statd_enable
1376 is set to
1377 .Dq Li YES ,
1378 these are the flags to pass to
1379 .Xr rpc.statd 8 .
1380 .It Va rpcbind_program
1381 .Pq Vt str
1382 Path to program for rpcbind daemon
1383 (default
1384 .Pa /usr/sbin/rpcbind ) .
1385 .It Va rpcbind_enable
1386 .Pq Vt bool
1387 If set to
1388 .Dq Li YES ,
1389 run
1390 .Va rpcbind_program
1391 at boot time.
1392 .It Va rpcbind_flags
1393 .Pq Vt str
1394 If
1395 .Va rpcbind_enable
1396 is set to
1397 .Dq Li YES ,
1398 these are the flags to pass to
1399 .Va rpcbind_program .
1400 .It Va keyserv_enable
1401 .Pq Vt bool
1402 If set to
1403 .Dq Li YES ,
1404 run the
1405 .Xr keyserv 8
1406 daemon on boot for running Secure RPC.
1407 .It Va keyserv_flags
1408 .Pq Vt str
1409 If
1410 .Va keyserv_enable
1411 is set to
1412 .Dq Li YES ,
1413 these are the flags to pass to
1414 .Xr keyserv 8
1415 daemon.
1416 .It Va pppoed_enable
1417 .Pq Vt bool
1418 If set to
1419 .Dq Li YES ,
1420 run the
1421 .Xr pppoed 8
1422 daemon at boot time to provide PPP over Ethernet services.
1423 .It Va pppoed_provider
1424 .Pq Vt str
1425 .Xr pppoed 8
1426 listens to requests to this provider and ultimately runs
1427 .Xr ppp 8
1428 with a
1429 .Ar system
1430 argument of the same name.
1431 .It Va pppoed_flags
1432 .Pq Vt str
1433 Additional flags to pass to
1434 .Xr pppoed 8 .
1435 .It Va pppoed_interface
1436 .Pq Vt str
1437 The network interface to run
1438 .Xr pppoed 8
1439 on.
1440 This is mandatory when
1441 .Va pppoed_enable
1442 is set to
1443 .Dq Li YES .
1444 .It Va timed_enable
1445 .Pq Vt bool
1446 If set to
1447 .Dq Li YES ,
1448 run the
1449 .Xr timed 8
1450 service at boot time.
1451 This command is intended for networks of machines where a consistent
1452 .Dq "network time"
1453 for all hosts must be established.
1454 This is often useful in large NFS environments where time stamps on
1455 files are expected to be consistent network-wide.
1456 .It Va timed_flags
1457 .Pq Vt str
1458 If
1459 .Va timed_enable
1460 is set to
1461 .Dq Li YES ,
1462 these are the flags to pass to the
1463 .Xr timed 8
1464 service.
1465 .It Va dntpd_enable
1466 .Pq Vt bool
1467 If set to
1468 .Dq Li YES ,
1469 run
1470 .Xr dntpd 8
1471 at system boot time.
1472 .It Va dntpd_program
1473 .Pq Vt str
1474 Path to
1475 .Xr dntpd 8
1476 (default
1477 .Pa /usr/sbin/dntpd ) .
1478 .It Va dntpd_flags
1479 .Pq Vt str
1480 If
1481 .Va dntpd_enable
1482 is set to
1483 .Dq Li YES ,
1484 these are the flags to pass to the
1485 .Xr dntpd 8
1486 daemon.
1487 .It Va btconfig_enable
1488 .Pq Vt bool
1489 If set to
1490 .Dq Li YES ,
1491 configure Bluetooth devices via
1492 .Xr btconfig 8
1493 at system boot time.
1494 .It Va btconfig_devices
1495 .Pq Vt str
1496 If
1497 .Va btconfig_enable
1498 is set to
1499 .Dq Li YES ,
1500 this is the list of Bluetooth devices to configure.
1501 If
1502 .Va btconfig_devices
1503 is not specified, all devices known to the system will be configured.
1504 A
1505 .Va btconfig_ Ns Aq Ar device
1506 variable can be set to specify parameters to be passed to
1507 .Ar device .
1508 .It Va btconfig_args
1509 .Pq Vt str
1510 If
1511 .Va btconfig_enable
1512 is set to
1513 .Dq Li YES ,
1514 this is the list of configuration parameters to pass to all Bluetooth
1515 devices.
1516 .It Va sdpd_enable
1517 .Pq Vt bool
1518 If set to
1519 .Dq Li YES ,
1520 run the Service Discovery Profile daemon
1521 .Xr ( sdpd 8 )
1522 at system boot time.
1523 .It Va sdpd_flags
1524 .Pq Vt str
1525 If
1526 .Va sdpd_enable
1527 is set to
1528 .Dq Li YES ,
1529 these are the flags to pass to the
1530 .Xr sdpd 8
1531 daemon.
1532 .It Va bthcid_enable
1533 .Pq Vt bool
1534 If set to
1535 .Dq Li YES ,
1536 run the Bluetooth Link Key/PIN Code Manager daemon
1537 .Xr ( bthcid 8 )
1538 at system boot time.
1539 .It Va bthcid_flags
1540 .Pq Vt str
1541 If
1542 .Va bthcid_enable
1543 is set to
1544 .Dq Li YES ,
1545 these are the flags to pass to the
1546 .Xr bthcid 8
1547 daemon.
1548 .It Va nis_client_enable
1549 .Pq Vt bool
1550 If set to
1551 .Dq Li YES ,
1552 run the
1553 .Xr ypbind 8
1554 service at system boot time.
1555 .It Va nis_client_flags
1556 .Pq Vt str
1557 If
1558 .Va nis_client_enable
1559 is set to
1560 .Dq Li YES ,
1561 these are the flags to pass to the
1562 .Xr ypbind 8
1563 service.
1564 .It Va nis_ypset_enable
1565 .Pq Vt bool
1566 If set to
1567 .Dq Li YES ,
1568 run the
1569 .Xr ypset 8
1570 daemon at system boot time.
1571 .It Va nis_ypset_flags
1572 .Pq Vt str
1573 If
1574 .Va nis_ypset_enable
1575 is set to
1576 .Dq Li YES ,
1577 these are the flags to pass to the
1578 .Xr ypset 8
1579 daemon.
1580 .It Va nis_server_enable
1581 .Pq Vt bool
1582 If set to
1583 .Dq Li YES ,
1584 run the
1585 .Xr ypserv 8
1586 daemon at system boot time.
1587 .It Va nis_server_flags
1588 .Pq Vt str
1589 If
1590 .Va nis_server_enable
1591 is set to
1592 .Dq Li YES ,
1593 these are the flags to pass to the
1594 .Xr ypserv 8
1595 daemon.
1596 .It Va nis_ypxfrd_enable
1597 .Pq Vt bool
1598 If set to
1599 .Dq Li YES ,
1600 run the
1601 .Xr rpc.ypxfrd 8
1602 daemon at system boot time.
1603 .It Va nis_ypxfrd_flags
1604 .Pq Vt str
1605 If
1606 .Va nis_ypxfrd_enable
1607 is set to
1608 .Dq Li YES ,
1609 these are the flags to pass to the
1610 .Xr rpc.ypxfrd 8
1611 daemon.
1612 .It Va nis_yppasswdd_enable
1613 .Pq Vt bool
1614 If set to
1615 .Dq Li YES ,
1616 run the
1617 .Xr rpc.yppasswdd 8
1618 daemon at system boot time.
1619 .It Va nis_yppasswdd_flags
1620 .Pq Vt str
1621 If
1622 .Va nis_yppasswdd_enable
1623 is set to
1624 .Dq Li YES ,
1625 these are the flags to pass to the
1626 .Xr rpc.yppasswdd 8
1627 daemon.
1628 .It Va rpc_ypupdated_enable
1629 .Pq Vt bool
1630 If set to
1631 .Dq Li YES ,
1632 run the
1633 .Nm rpc.ypupdated
1634 daemon at system boot time.
1635 .It Va defaultrouter
1636 .Pq Vt str
1637 If not set to
1638 .Dq Li NO ,
1639 create a default route to this host name or IP address
1640 (use an IP address if this router is also required to get to the
1641 name server!).
1642 .It Va ipv6_defaultrouter
1643 .Pq Vt str
1644 The IPv6 equivalent of
1645 .Va defaultrouter .
1646 .It Va static_routes
1647 .Pq Vt str
1648 Set to the list of static routes that are to be added at system boot time.
1649 If not set to
1650 .Dq Li NO
1651 then for each whitespace separated
1652 .Ar element
1653 in the value, a
1654 .Va route_ Ns Aq Ar element
1655 variable is assumed to exist whose contents will later be passed to a
1656 .Dq Nm route Cm add
1657 operation.
1658 .It Va ipv6_static_routes
1659 .Pq Vt str
1660 The IPv6 equivalent of
1661 .Va static_routes .
1662 If not set to
1663 .Dq Li NO
1664 then for each whitespace separated
1665 .Ar element
1666 in the value, a
1667 .Va ipv6_route_ Ns Aq Ar element
1668 variable is assumed to exist whose contents will later be passed to a
1669 .Dq Nm route Cm add Fl inet6
1670 operation.
1671 .It Va gateway_enable
1672 .Pq Vt bool
1673 If set to
1674 .Dq Li YES ,
1675 configure host to act as an IP router, e.g. to forward packets
1676 between interfaces.
1677 .It Va ipv6_gateway_enable
1678 .Pq Vt bool
1679 The IPv6 equivalent of
1680 .Va gateway_enable .
1681 .It Va router_enable
1682 .Pq Vt bool
1683 If set to
1684 .Dq Li YES ,
1685 run a routing daemon of some sort, based on the settings of
1686 .Va router_program
1687 and
1688 .Va router_flags .
1689 .It Va ipv6_router_enable
1690 .Pq Vt bool
1691 The IPv6 equivalent of
1692 .Va router_enable .
1693 If set to
1694 .Dq Li YES ,
1695 run a routing daemon of some sort, based on the settings of
1696 .Va ipv6_router_program
1697 and
1698 .Va ipv6_router_flags .
1699 .It Va router_program
1700 .Pq Vt str
1701 If
1702 .Va router_enable
1703 is set to
1704 .Dq Li YES ,
1705 this is the name of the routing daemon to use
1706 (default
1707 .Pa /sbin/routed ) .
1708 .It Va ipv6_router_program
1709 .Pq Vt str
1710 The IPv6 equivalent of
1711 .Va router_program
1712 (default
1713 .Pa /sbin/route6d ) .
1714 .It Va router_flags
1715 .Pq Vt str
1716 If
1717 .Va router_enable
1718 is set to
1719 .Dq Li YES ,
1720 these are the flags to pass to the routing daemon.
1721 .It Va ipv6_router_flags
1722 .Pq Vt str
1723 The IPv6 equivalent of
1724 .Va router_flags .
1725 .It Va mrouted_enable
1726 .Pq Vt bool
1727 If set to
1728 .Dq Li YES ,
1729 run the multicast routing daemon,
1730 .Xr mrouted 8 .
1731 .It Va mroute6d_enable
1732 .Pq Vt bool
1733 The IPv6 equivalent of
1734 .Va mrouted_enable .
1735 If set to
1736 .Dq Li YES ,
1737 run the IPv6 multicast routing daemon.
1738 Note that no IPv6 multicast routing daemon is included in the
1739 .Dx
1740 base system but
1741 .Xr pim6dd 8
1742 can be installed from the
1743 .Xr pkgsrc 7
1744 collection.
1745 .It Va mrouted_flags
1746 .Pq Vt str
1747 If
1748 .Va mrouted_enable
1749 is set to
1750 .Dq Li YES ,
1751 these are the flags to pass to the
1752 .Xr mrouted 8
1753 daemon.
1754 .It Va mroute6d_flags
1755 .Pq Vt str
1756 The IPv6 equivalent of
1757 .Va mrouted_flags .
1758 If
1759 .Va mroute6d_enable
1760 is set to
1761 .Dq Li YES ,
1762 these are the flags passed to the IPv6 multicast routing daemon.
1763 .It Va mroute6d_program
1764 .Pq Vt str
1765 If
1766 .Va mroute6d_enable
1767 is set to
1768 .Dq Li YES ,
1769 this is the path to the IPv6 multicast routing daemon.
1770 .It Va rtadvd_enable
1771 .Pq Vt bool
1772 If set to
1773 .Dq Li YES ,
1774 run the
1775 .Xr rtadvd 8
1776 daemon at boot time.
1777 .Xr rtadvd 8
1778 will only run if
1779 .Va ipv6_gateway_enable
1780 is also set to
1781 .Dq Li YES .
1782 The
1783 .Xr rtadvd 8
1784 utility sends router advertisement packets to the interfaces specified in
1785 .Va rtadvd_interfaces .
1786 .Xr rtadvd 8
1787 and should only be enabled with great care.
1788 You may want to fine-tune
1789 .Xr rtadvd.conf 5 .
1790 .It Va rtadvd_interfaces
1791 .Pq Vt str
1792 If
1793 .Va rtadvd_enable
1794 is set to
1795 .Dq Li YES
1796 this is the list of interfaces to use.
1797 .It Va rtsold_enable
1798 .Pq Vt bool
1799 If set to
1800 .Dq Li YES ,
1801 run the
1802 .Xr rtsold 8
1803 daemon at boot time.
1804 The
1805 .Xr rtsold 8
1806 daemon is used for automatic discovery of non-link local addresses.
1807 .It Va rtsold_flags
1808 .Pq Vt str
1809 If
1810 .Va rtsold_enable
1811 is set to
1812 .Dq Li YES ,
1813 these are the flags to pass to the
1814 .Xr rtsold 8
1815 daemon.
1816 .It Va ipxgateway_enable
1817 .Pq Vt bool
1818 If set to
1819 .Dq Li YES ,
1820 enable the routing of IPX traffic.
1821 .It Va ipxrouted_enable
1822 .Pq Vt bool
1823 If set to
1824 .Dq Li YES ,
1825 run the
1826 .Xr IPXrouted 8
1827 daemon at system boot time.
1828 .It Va ipxrouted_flags
1829 .Pq Vt str
1830 If
1831 .Va ipxrouted_enable
1832 is set to
1833 .Dq Li YES ,
1834 these are the flags to pass to the
1835 .Xr IPXrouted 8
1836 daemon.
1837 .It Va arpproxy_all
1838 .Pq Vt bool
1839 If set to
1840 .Dq Li YES ,
1841 enable global proxy ARP.
1842 .It Va forward_sourceroute
1843 .Pq Vt bool
1844 If set to
1845 .Dq Li YES
1846 and
1847 .Va gateway_enable
1848 is also set to
1849 .Dq Li YES ,
1850 source-routed packets are forwarded.
1851 .It Va accept_sourceroute
1852 .Pq Vt bool
1853 If set to
1854 .Dq Li YES ,
1855 the system will accept source-routed packets directed at it.
1856 .It Va rarpd_enable
1857 .Pq Vt bool
1858 If set to
1859 .Dq Li YES ,
1860 run the
1861 .Xr rarpd 8
1862 daemon at system boot time.
1863 .It Va rarpd_flags
1864 .Pq Vt str
1865 If
1866 .Va rarpd_enable
1867 is set to
1868 .Dq Li YES ,
1869 these are the flags to pass to the
1870 .Xr rarpd 8
1871 daemon.
1872 .It Va bootparamd_enable
1873 .Pq Vt bool
1874 If set to
1875 .Dq Li YES ,
1876 run the
1877 .Xr bootparamd 8
1878 daemon at system boot time.
1879 .It Va bootparamd_flags
1880 .Pq Vt str
1881 If
1882 .Va bootparamd_enable
1883 is set to
1884 .Dq Li YES ,
1885 these are the flags to pass to the
1886 .Xr bootparamd 8
1887 daemon.
1888 .It Va stf_interface_ipv4addr
1889 .Pq Vt str
1890 If not set to
1891 .Dq Li NO ,
1892 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1893 Specify this entry to enable the 6to4 interface.
1894 .It Va stf_interface_ipv4plen
1895 .Pq Vt int
1896 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1897 An effective value is 0-31.
1898 .It Va stf_interface_ipv6_ifid
1899 .Pq Vt str
1900 IPv6 interface ID for
1901 .Xr stf 4 .
1902 This can be set to
1903 .Dq Li AUTO .
1904 .It Va stf_interface_ipv6_slaid
1905 .Pq Vt str
1906 IPv6 Site Level Aggregator for
1907 .Xr stf 4 .
1908 .It Va ipv6_faith_prefix
1909 .Pq Vt str
1910 If not set to
1911 .Dq Li NO ,
1912 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1913 You also need
1914 .Xr faithd 8
1915 setup.
1916 .It Va ipv6_ipv4mapping
1917 .Pq Vt bool
1918 If set to
1919 .Dq Li YES
1920 this enables IPv4 mapped IPv6 address communication (like
1921 .Li ::ffff:a.b.c.d ) .
1922 .It Va atm_enable
1923 .Pq Vt bool
1924 Set to
1925 .Dq Li YES
1926 to enable the configuration of ATM interfaces at system boot time.
1927 For all of the ATM variables described below, please refer to the
1928 .Xr atm 8
1929 man page for further details on the available command parameters.
1930 Also refer to the files in
1931 .Pa /usr/share/examples/atm
1932 for more detailed configuration information.
1933 .It Va atm_netif_ Ns Aq Ar intf
1934 .Pq Vt str
1935 For the ATM physical interface
1936 .Ar intf ,
1937 this variable defines the name prefix and count for the ATM network
1938 interfaces to be created.
1939 The value will be passed as the parameters of an
1940 .Dq Nm atm Cm "set netif" Ar intf
1941 command.
1942 .It Va atm_sigmgr_ Ns Aq Ar intf
1943 .Pq Vt str
1944 For the ATM physical interface
1945 .Ar intf ,
1946 this variable defines the ATM signalling manager to be used.
1947 The value will be passed as the parameters of an
1948 .Dq Nm atm Cm attach Ar intf
1949 command.
1950 .It Va atm_prefix_ Ns Aq Ar intf
1951 .Pq Vt str
1952 For the ATM physical interface
1953 .Ar intf ,
1954 this variable defines the NSAP prefix for interfaces using a UNI signalling
1955 manager.
1956 If set to
1957 .Dq Li ILMI ,
1958 the prefix will automatically be set via the
1959 .Xr ilmid 8
1960 daemon.
1961 Otherwise, the value will be passed as the parameters of an
1962 .Dq Nm atm Cm "set prefix" Ar intf
1963 command.
1964 .It Va atm_macaddr_ Ns Aq Ar intf
1965 .Pq Vt str
1966 For the ATM physical interface
1967 .Ar intf ,
1968 this variable defines the MAC address for interfaces using a UNI signalling
1969 manager.
1970 If set to
1971 .Dq Li NO ,
1972 the hardware MAC address contained in the ATM interface card will be used.
1973 Otherwise, the value will be passed as the parameters of an
1974 .Dq Nm atm Cm "set mac" Ar intf
1975 command.
1976 .It Va atm_arpserver_ Ns Aq Ar netif
1977 .Pq Vt str
1978 For the ATM network interface
1979 .Ar netif ,
1980 this variable defines the ATM address for a host which is to provide ATMARP
1981 service.
1982 This variable is only applicable to interfaces using a UNI signalling manager.
1983 If set to
1984 .Dq Li local ,
1985 this host will become an ATMARP server.
1986 The value will be passed as the parameters of an
1987 .Dq Nm atm Cm "set arpserver" Ar netif
1988 command.
1989 .It Va atm_scsparp_ Ns Aq Ar netif
1990 .Pq Vt bool
1991 If set to
1992 .Dq Li YES ,
1993 SCSP/ATMARP service for the network interface
1994 .Ar netif
1995 will be initiated using the
1996 .Xr scspd 8
1997 and
1998 .Xr atmarpd 8
1999 daemons.
2000 This variable is only applicable if
2001 .Va atm_arpserver_ Ns Aq Ar netif
2002 is set to
2003 .Dq Li local .
2004 .It Va atm_arps
2005 .Pq Vt str
2006 Set to the list of permanent ATM ARP entries to be added at system boot time.
2007 For each whitespace separated
2008 .Ar element
2009 in the value, an
2010 .Va atm_arp_ Ns Aq Ar element
2011 variable is assumed to exist.
2012 The value of each of these variables will be passed as the parameters of an
2013 .Dq Nm atm Cm "add arp"
2014 command.
2015 .It Va keybell
2016 .Pq Vt str
2017 The keyboard bell sound.
2018 Set to
2019 .Dq Li normal ,
2020 .Dq Li visual ,
2021 .Dq Li off ,
2022 or
2023 .Dq Li NO
2024 if the default behavior is desired.
2025 For details, refer to the
2026 .Xr kbdcontrol 1
2027 manpage.
2028 .It Va keymap
2029 .Pq Vt str
2030 If set to
2031 .Dq Li NO ,
2032 no keymap is installed, otherwise the value is used to install
2033 the keymap file in
2034 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2035 .It Va keyrate
2036 .Pq Vt str
2037 The keyboard repeat speed.
2038 Set to
2039 .Dq Li slow ,
2040 .Dq Li normal ,
2041 .Dq Li fast ,
2042 or
2043 .Dq Li NO
2044 if the default behavior is desired.
2045 .It Va keychange
2046 .Pq Vt str
2047 If not set to
2048 .Dq Li NO ,
2049 attempt to program the function keys with the value.
2050 The value should be a single string of the form:
2051 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2052 .It Va cursor
2053 .Pq Vt str
2054 Can be set to the value of
2055 .Dq Li normal ,
2056 .Dq Li blink ,
2057 .Dq Li destructive ,
2058 or
2059 .Dq Li NO
2060 to set the cursor behavior explicitly or choose the default behavior.
2061 .It Va scrnmap
2062 .Pq Vt str
2063 If set to
2064 .Dq Li NO ,
2065 no screen map is installed, otherwise the value is used to install
2066 the screen map file in
2067 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2068 .It Va font8x16
2069 .Pq Vt str
2070 If set to
2071 .Dq Li NO ,
2072 the default 8x16 font value is used for screen size requests, otherwise
2073 the value in
2074 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2075 is used.
2076 .It Va font8x14
2077 .Pq Vt str
2078 If set to
2079 .Dq Li NO ,
2080 the default 8x14 font value is used for screen size requests, otherwise
2081 the value in
2082 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2083 is used.
2084 .It Va font8x8
2085 .Pq Vt str
2086 If set to
2087 .Dq Li NO ,
2088 the default 8x8 font value is used for screen size requests, otherwise
2089 the value in
2090 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2091 is used.
2092 .It Va blanktime
2093 .Pq Vt int
2094 If set to
2095 .Dq Li NO ,
2096 the default screen blanking interval is used, otherwise it is set to
2097 .Ar value
2098 seconds.
2099 .It Va saver
2100 .Pq Vt str
2101 If not set to
2102 .Dq Li NO ,
2103 this is the actual screen saver to use
2104 .Li ( blank , snake , daemon ,
2105 etc).
2106 .It Va moused_enable
2107 .Pq Vt str
2108 If set to
2109 .Dq Li YES ,
2110 the
2111 .Xr moused 8
2112 daemon is started for doing cut/paste selection on the console.
2113 .It Va moused_type
2114 .Pq Vt str
2115 This is the protocol type of the mouse connected to this host.
2116 This variable must be set if
2117 .Va moused_enable
2118 is set to
2119 .Dq Li YES .
2120 The
2121 .Xr moused 8
2122 daemon
2123 is able to detect the appropriate mouse type automatically in many cases.
2124 Set this variable to
2125 .Dq Li auto
2126 to let the daemon detect it, or
2127 select one from the following list if the automatic detection fails.
2128 .Pp
2129 If the mouse is attached to the PS/2 mouse port, choose
2130 .Dq Li auto
2131 or
2132 .Dq Li ps/2 ,
2133 regardless of the brand and model of the mouse.
2134 Likewise, if the mouse is attached to the bus mouse port, choose
2135 .Dq Li auto
2136 or
2137 .Dq Li busmouse .
2138 All other protocols are for serial mice and will not work with
2139 the PS/2 and bus mice.
2140 If this is a USB mouse,
2141 .Dq Li auto
2142 is the only protocol type which will work.
2143 .Pp
2144 .Bl -tag -width ".Li x10mouseremote" -compact
2145 .It Li microsoft
2146 Microsoft mouse (serial)
2147 .It Li intellimouse
2148 Microsoft IntelliMouse (serial)
2149 .It Li mousesystems
2150 Mouse systems Corp. mouse (serial)
2151 .It Li mmseries
2152 MM Series mouse (serial)
2153 .It Li logitech
2154 Logitech mouse (serial)
2155 .It Li busmouse
2156 A bus mouse
2157 .It Li mouseman
2158 Logitech MouseMan and TrackMan (serial)
2159 .It Li glidepoint
2160 ALPS GlidePoint (serial)
2161 .It Li thinkingmouse
2162 Kensington ThinkingMouse (serial)
2163 .It Li ps/2
2164 PS/2 mouse
2165 .It Li mmhittab
2166 MM HitTablet (serial)
2167 .It Li x10mouseremote
2168 X10 MouseRemote (serial)
2169 .It Li versapad
2170 Interlink VersaPad (serial)
2171 .El
2172 .Pp
2173 Even if the mouse is not in the above list, it may be compatible
2174 with one in the list.
2175 Refer to the man page for
2176 .Xr moused 8
2177 for compatibility information.
2178 .Pp
2179 It should also be noted that while this is enabled, any
2180 other client of the mouse (such as an X server) should access
2181 the mouse through the virtual mouse device,
2182 .Pa /dev/sysmouse ,
2183 and configure it as a
2184 .Dq Li sysmouse
2185 type mouse, since all
2186 mouse data is converted to this single canonical format when using
2187 .Xr moused 8 .
2188 If the client program does not support the
2189 .Dq Li sysmouse
2190 type, specify the
2191 .Dq Li mousesystems
2192 type.
2193 It is the second preferred type.
2194 .It Va moused_port
2195 .Pq Vt str
2196 If
2197 .Va moused_enable
2198 is set to
2199 .Dq Li YES ,
2200 this is the actual port the mouse is on.
2201 It might be
2202 .Pa /dev/cuaa0
2203 for a COM1 serial mouse,
2204 .Pa /dev/psm0
2205 for a PS/2 mouse or
2206 .Pa /dev/mse0
2207 for a bus mouse, for example.
2208 .It Va moused_flags
2209 .Pq Vt str
2210 If
2211 .Va moused_type
2212 is set, these are the additional flags to pass to the
2213 .Xr moused 8
2214 daemon.
2215 .It Va mousechar_start
2216 .Pq Vt int
2217 If set to
2218 .Dq Li NO ,
2219 the default mouse cursor character range
2220 .Li 0xd0 Ns - Ns Li 0xd3
2221 is used, otherwise the range start is set to
2222 .Ar value
2223 character, see
2224 .Xr vidcontrol 1 .
2225 Use if the default range is occupied in the language code table.
2226 .It Va vidhistory
2227 .Pq Vt int
2228 Set the size of the history (scrollback) buffer in lines.
2229 .It Va allscreens_flags
2230 .Pq Vt str
2231 If set,
2232 .Xr vidcontrol 1
2233 is run with these options for each of the virtual terminals
2234 .Pq Pa /dev/ttyv* .
2235 For example,
2236 .Dq Fl m Cm on
2237 will enable the mouse pointer on all virtual terminals if
2238 .Va moused_enable
2239 is set to
2240 .Dq Li YES .
2241 .It Va allscreens_kbdflags
2242 .Pq Vt str
2243 If set,
2244 .Xr kbdcontrol 1
2245 is run with these options for each of the virtual terminals
2246 .Pq Pa /dev/ttyv* .
2247 For example,
2248 .Dq Fl h Li 200
2249 will set the
2250 .Xr syscons 4
2251 scrollback (history) buffer to 200 lines.
2252 .It Va cron_enable
2253 .Pq Vt bool
2254 If set to
2255 .Dq Li YES ,
2256 run the
2257 .Xr cron 8
2258 daemon at system boot time.
2259 .It Va cron_program
2260 .Pq Vt str
2261 Path to
2262 .Xr cron 8
2263 (default
2264 .Pa /usr/sbin/cron ) .
2265 .It Va cron_flags
2266 .Pq Vt str
2267 If
2268 .Va cron_enable
2269 is set to
2270 .Dq Li YES ,
2271 these are the flags to pass to
2272 .Xr cron 8 .
2273 .It Va lpd_program
2274 .Pq Vt str
2275 Path to
2276 .Xr lpd 8
2277 (default
2278 .Pa /usr/sbin/lpd ) .
2279 .It Va lpd_enable
2280 .Pq Vt bool
2281 If set to
2282 .Dq Li YES ,
2283 run the
2284 .Xr lpd 8
2285 daemon at system boot time.
2286 .It Va lpd_flags
2287 .Pq Vt str
2288 If
2289 .Va lpd_enable
2290 is set to
2291 .Dq Li YES ,
2292 these are the flags to pass to the
2293 .Xr lpd 8
2294 daemon.
2295 .It Va nscd_enable
2296 .Pq Vt bool
2297 If set to
2298 .Dq Li YES ,
2299 run the
2300 .Xr nscd 8
2301 daemon at system boot time.
2302 .It Va mixer_enable
2303 .Pq Vt bool
2304 If set to
2305 .Dq Li YES ,
2306 preserve
2307 .Xr mixer 8
2308 settings across reboots.
2309 .It Va mta_start_script
2310 .Pq Vt str
2311 The full path to the script to run to start
2312 a mail transfer agent.
2313 The default is
2314 .Pa /etc/rc.sendmail .
2315 The
2316 .Va sendmail_*
2317 variables which
2318 .Pa /etc/rc.sendmail
2319 uses are documented in the
2320 .Xr rc.sendmail 8
2321 man page.
2322 .It Va fixbootfile
2323 .Pq Vt bool
2324 In a
2325 .Sq HAMMER ROOT with UFS /boot
2326 setup, the boot loader will not set up the
2327 .Va kern.bootfile
2328 sysctl correctly.
2329 The system will attempt to fix this on its own.
2330 Set this variable to
2331 .Dq Li NO
2332 to turn this behavior off.
2333 .It Va dumpdev
2334 .Pq Vt str
2335 Indicates the device (usually a swap partition) to which a crash dump
2336 should be written in the event of a system crash.
2337 The value of this variable is passed as the argument to
2338 .Xr dumpon 8 .
2339 To disable crash dumps, set this variable to
2340 .Dq Li NO .
2341 .It Va dumpdir
2342 .Pq Vt str
2343 When the system reboots after a crash and a crash dump is found on the
2344 device specified by the
2345 .Va dumpdev
2346 variable,
2347 .Xr savecore 8
2348 will save that crash dump and a copy of the kernel to the directory
2349 specified by the
2350 .Va dumpdir
2351 variable.
2352 The default value is
2353 .Pa /var/crash .
2354 Set to
2355 .Dq Li NO
2356 to not run
2357 .Xr savecore 8
2358 at boot time when
2359 .Va dumpdir
2360 is set.
2361 .It Va savecore_flags
2362 .Pq Vt str
2363 If crash dumps are enabled, these are the flags to pass to the
2364 .Xr savecore 8
2365 utility.
2366 .It Va enable_quotas
2367 .Pq Vt bool
2368 Set to
2369 .Dq Li YES
2370 to turn on user disk quotas on system startup via the
2371 .Xr quotaon 8
2372 command.
2373 .It Va check_quotas
2374 .Pq Vt bool
2375 Set to
2376 .Dq Li YES
2377 to enable user disk quota checking via the
2378 .Xr quotacheck 8
2379 command.
2380 .It Va accounting_enable
2381 .Pq Vt bool
2382 Set to
2383 .Dq Li YES
2384 to enable system accounting through the
2385 .Xr accton 8
2386 facility.
2387 .It Va linux_enable
2388 .Pq Vt bool
2389 Set to
2390 .Dq Li YES
2391 to enable Linux/ELF binary emulation at system initial boot time.
2392 .It Va sysvipc_enable
2393 .Pq Vt bool
2394 If set to
2395 .Dq Li YES ,
2396 load System V IPC primitives at boot time.
2397 .\" ----- cleanvar_enable setting--------------------------------
2398 .It Va cleanvar_enable
2399 .Pq Vt bool
2400 Set to
2401 .Dq Li YES
2402 to have
2403 .Pa /var/run ,
2404 .Pa /var/spool/lock
2405 and
2406 .Pa /var/spool/uucp/.Temp/*
2407 cleaned at startup.
2408 .\" ----- clear_tmp_enable setting-------------------------------
2409 .It Va clear_tmp_enable
2410 .Pq Vt bool
2411 Set to
2412 .Dq Li YES
2413 to have
2414 .Pa /tmp
2415 cleaned at startup.
2416 .\" ----- ldconfig_paths setting --------------------------------
2417 .It Va ldconfig_paths
2418 .Pq Vt str
2419 Set to the list of shared library paths to use with
2420 .Xr ldconfig 8 .
2421 NOTE:
2422 .Pa /usr/lib
2423 will always be added first, so it need not appear in this list.
2424 .It Va ldconfig_insecure
2425 .Pq Vt bool
2426 The
2427 .Xr ldconfig 8
2428 utility normally refuses to use directories
2429 which are writable by anyone except root.
2430 Set this variable to
2431 .Dq Li YES
2432 to disable that security check during system startup.
2433 .It Va kern_securelevel
2434 .Pq Vt int
2435 The kernel security level to set at startup.
2436 The allowed range of
2437 .Ar value
2438 ranges from \-1 (the compile time default) to 3 (the most secure).
2439 See
2440 .Xr init 8
2441 for the list of possible security levels and their effect on system operation.
2442 .It Va start_vinum
2443 .Pq Vt bool
2444 Set to
2445 .Dq Li YES
2446 to start
2447 .Xr vinum 8
2448 at system boot time.
2449 .It Va sshd_enable
2450 .Pq Vt bool
2451 Set to
2452 .Dq Li YES
2453 to start
2454 .Xr sshd 8
2455 at system boot time.
2456 .It Va sshd_program
2457 .Pq Vt str
2458 Path to the SSH server program
2459 (default
2460 .Pa /usr/sbin/sshd ) .
2461 .It Va sshd_flags
2462 .Pq Vt str
2463 If
2464 .Va sshd_enable
2465 is set to
2466 .Dq Li YES ,
2467 these are the flags to pass to the
2468 .Xr sshd 8
2469 daemon.
2470 .It Va ftpd_enable
2471 .Pq Vt bool
2472 Set to
2473 .Dq Li YES
2474 to start
2475 .Xr ftpd 8
2476 at system boot time.
2477 .It Va ftpd_flags
2478 .Pq Vt str
2479 If
2480 .Va ftpd_enable
2481 is set to
2482 .Dq Li YES ,
2483 these are the flags to pass to the
2484 .Xr ftpd 8
2485 daemon.
2486 .It Va usbd_enable
2487 .Pq Vt bool
2488 If set to
2489 .Dq Li YES ,
2490 run the
2491 .Xr usbd 8
2492 daemon at boot time.
2493 .It Va usbd_flags
2494 .Pq Vt str
2495 If
2496 .Va usbd_enable
2497 is set to
2498 .Dq Li YES ,
2499 these are the flags passed to
2500 .Xr usbd 8
2501 daemon.
2502 .It Va watchdogd_enable
2503 .Pq Vt bool
2504 If set to
2505 .Dq Li YES ,
2506 start the
2507 .Xr watchdogd 8
2508 daemon at boot time.
2509 This requires that the kernel have been compiled with
2510 .Cd "options WATCHDOG" .
2511 .It Va jail_enable
2512 .Pq Vt bool
2513 If set to
2514 .Dq Li NO ,
2515 any configured jails will not be started.
2516 .It Va jail_list
2517 .Pq Vt str
2518 A space separated list of names for jails.
2519 This is purely a configuration aid to help identify and
2520 configure multiple jails.
2521 The names specified in this list will be used to
2522 identify settings common to an instance of a jail.
2523 Assuming that the jail in question was named
2524 .Li vjail ,
2525 you would have the following dependent variables:
2526 .Bd -literal
2527 jail_vjail_hostname="jail.example.com"
2528 jail_vjail_ip="192.168.1.100"
2529 jail_vjail_rootdir="/var/jails/vjail/root"
2530 .Ed
2531 .Pp
2532 .It Va jail_flags
2533 .Pq Vt str
2534 Unset by default.
2535 When set, use as default value for
2536 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2537 for every jail in
2538 .Va jail_list .
2539 .It Va jail_interface
2540 .Pq Vt str
2541 Unset by default.
2542 When set, use as default value for
2543 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2544 for every jail in
2545 .Va jail_list .
2546 .It Va jail_fstab
2547 .Pq Vt str
2548 Unset by default.
2549 When set, use as default value for
2550 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2551 for every jail in
2552 .Va jail_list .
2553 .It Va jail_mount_enable
2554 .Pq Vt bool
2555 Set to
2556 .Dq Li NO
2557 by default.
2558 When set to
2559 .Dq Li YES ,
2560 sets
2561 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2562 to
2563 .Dq Li YES
2564 by default for every jail in
2565 .Va jail_list .
2566 .It Va jail_fdesc_enable
2567 .Pq Vt bool
2568 Set to
2569 .Dq Li NO
2570 by default.
2571 When set to
2572 .Dq Li YES ,
2573 sets
2574 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2575 to
2576 .Dq Li YES
2577 by default for every jail in
2578 .Va jail_list .
2579 .It Va jail_procfs_enable
2580 .Pq Vt bool
2581 Set to
2582 .Dq Li NO
2583 by default.
2584 When set to
2585 .Dq Li YES ,
2586 sets
2587 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2588 to
2589 .Dq Li YES
2590 by default for every jail in
2591 .Va jail_list .
2592 .It Va jail_exec_start
2593 .Pq Vt str
2594 Unset by default.
2595 When set, use as default value for
2596 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2597 for every jail in
2598 .Va jail_list .
2599 .It Va jail_exec_stop
2600 Unset by default.
2601 When set, use as default value for
2602 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2603 for every jail in
2604 .Va jail_list .
2605 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2606 .Pq Vt str
2607 Unset by default.
2608 Set to the root directory used by jail
2609 .Va jname .
2610 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2611 .Pq Vt str
2612 Unset by default.
2613 Set to the fully qualified domain name (FQDN) assigned to jail
2614 .Va jname .
2615 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2616 .Pq Vt str
2617 Unset by default.
2618 Set to the IP address assigned to jail
2619 .Va jname .
2620 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2621 .Pq Vt str
2622 Set to
2623 .Dq Li -l -U root
2624 by default.
2625 These are flags to pass to
2626 .Xr jail 8 .
2627 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2628 .Pq Vt str
2629 Unset by default.
2630 When set, sets the interface to use when setting IP address alias.
2631 Note that the alias is created at jail startup and removed at jail shutdown.
2632 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2633 .Pq Vt str
2634 Set to
2635 .Pa /etc/fstab. Ns Aq Ar jname
2636 by default.
2637 This is the file system information file to use for jail
2638 .Va jname .
2639 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2640 .Pq Vt bool
2641 Set to
2642 .Dq Li NO
2643 by default.
2644 When set to
2645 .Dq Li YES ,
2646 mount all file systems from
2647 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2648 at jail startup.
2649 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2650 .Pq Vt bool
2651 Set to
2652 .Dq Li NO
2653 by default.
2654 When set to
2655 .Dq Li YES ,
2656 mount the file-descriptor file system inside jail
2657 .Ar jname
2658 at jail startup.
2659 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2660 .Pq Vt bool
2661 Set to
2662 .Dq Li NO
2663 by default.
2664 When set to
2665 .Dq Li YES ,
2666 mount the process file system inside jail
2667 .Ar jname
2668 at jail startup.
2669 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2670 .Pq Vt str
2671 Set to
2672 .Dq Li /bin/sh /etc/rc
2673 by default.
2674 This is the command executed at jail startup.
2675 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2676 .Pq Vt str
2677 Set to
2678 .Dq Li /bin/sh /etc/rc.shutdown
2679 by default.
2680 This is the command executed at jail shutdown.
2681 .It Va jail_set_hostname_allow
2682 .Pq Vt bool
2683 If set to
2684 .Dq Li NO ,
2685 do not allow the root user in a jail to set its hostname.
2686 .It Va jail_socket_unixiproute_only
2687 .Pq Vt bool
2688 If set to
2689 .Dq Li YES ,
2690 do not allow any sockets,
2691 besides UNIX/IP/route sockets,
2692 to be used within a jail.
2693 .It Va jail_sysvipc_allow
2694 .Pq Vt bool
2695 If set to
2696 .Dq Li YES ,
2697 allow applications within a jail to use System V IPC.
2698 .It Va newsyslog_enable
2699 .Pq Vt bool
2700 If set to
2701 .Dq Li YES ,
2702 run
2703 .Xr newsyslog 8
2704 before syslogd starts.
2705 .It Va newsyslog_flags
2706 .Pq Vt str
2707 If
2708 .Va newsyslog_enable
2709 is set to
2710 .Dq Li YES ,
2711 these are the flags passed to
2712 .Xr newsyslog 8 .
2713 .It Va resident_enable
2714 .Pq Vt bool
2715 If set to
2716 .Dq Li YES ,
2717 make the dynamic binaries listed in
2718 .Pa /etc/resident.conf
2719 resident.
2720 .It Va varsym_enable
2721 .Pq Vt bool
2722 If set to
2723 .Dq Li YES ,
2724 process
2725 .Pa /etc/varsym.conf
2726 to set system-wide variables for variant symlinks.
2727 .It Va rand_irqs
2728 .Pq Vt str
2729 Set either to
2730 .Dq Li NO
2731 or a whitespace separated list of IRQ numbers which will be used as a source of
2732 randomness.
2733 .\" ----- isdn settings ---------------------------------
2734 .It Va isdn_enable
2735 .Pq Vt bool
2736 Set to
2737 .Dq Li NO
2738 by default.
2739 When set to
2740 .Dq Li YES ,
2741 starts the
2742 .Xr isdnd 8
2743 daemon at system boot time.
2744 .It Va isdn_flags
2745 .Pq Vt str
2746 Set to
2747 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2748 by default.
2749 Additional flags to pass to
2750 .Xr isdnd 8
2751 (but see
2752 .Va isdn_fsdev
2753 and
2754 .Va isdn_ttype
2755 for certain tunable parameters).
2756 .It Va isdn_ttype
2757 .Pq Vt str
2758 Set to
2759 .Dq Li cons25
2760 by default.
2761 The terminal type of the output device when
2762 .Xr isdnd 8
2763 operates in full-screen mode.
2764 .It Va isdn_screenflags
2765 .Pq Vt str
2766 Set to
2767 .Dq Li NO
2768 by default.
2769 The video mode for full-screen mode (only for
2770 .Xr syscons 4
2771 console driver, see
2772 .Xr vidcontrol 1
2773 for valid modes).
2774 .It Va isdn_fsdev
2775 .Pq Vt str
2776 Set to
2777 .Dq Li NO
2778 by default.
2779 The output device for
2780 .Xr isdnd 8
2781 in full-screen mode (or
2782 .Dq Li NO
2783 for daemon mode).
2784 .It Va isdn_trace
2785 .Pq Vt bool
2786 Set to
2787 .Dq Li NO
2788 by default.
2789 When set to
2790 .Dq Li YES ,
2791 enables the ISDN protocol trace utility
2792 .Xr isdntrace 8
2793 at system boot time.
2794 .It Va isdn_traceflags
2795 .Pq Vt str
2796 Set to
2797 .Dq Fl f Pa /var/tmp/isdntrace0
2798 by default.
2799 Flags for
2800 .Xr isdntrace 8 .
2801 .\" -----------------------------------------------------
2802 .It Va entropy_dir
2803 .Pq Vt str
2804 Set to
2805 .Dq Li NO
2806 to disable caching entropy via
2807 .Xr cron 8 .
2808 Otherwise set to the directory used to store entropy files in.
2809 .It Va entropy_file
2810 .Pq Vt str
2811 Set to
2812 .Dq Li NO
2813 to disable caching entropy through reboots.
2814 Otherwise set to the filename used to store cached entropy through reboots.
2815 This file should be located on the root file system to seed the
2816 .Xr random 4
2817 device as early as possible in the boot process.
2818 .It Va ipsec_enable
2819 .Pq Vt bool
2820 Set to
2821 .Dq Li YES
2822 to run
2823 .Xr setkey 8
2824 on
2825 .Va ipsec_file
2826 at boot time.
2827 .It Va ipsec_file
2828 .Pq Vt str
2829 Configuration file for
2830 .Xr setkey 8 .
2831 .It Va dmesg_enable
2832 .Pq Vt bool
2833 Set to
2834 .Dq Li YES
2835 to save
2836 .Xr dmesg 8
2837 to
2838 .Pa /var/run/dmesg.boot
2839 on boot.
2840 .It Va rcshutdown_timeout
2841 .Pq Vt int
2842 If set, start a watchdog timer in the background which will terminate
2843 .Pa rc.shutdown
2844 if
2845 .Xr shutdown 8
2846 has not completed within the specified time (in seconds).
2847 .El
2848 .Sh FILES
2849 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2850 .It Pa /etc/defaults/rc.conf
2851 .It Pa /etc/rc.conf
2852 .It Pa /etc/rc.conf.local
2853 .It Pa /etc/start_if. Ns Aq Ar interface
2854 .El
2855 .Sh SEE ALSO
2856 .Xr catman 1 ,
2857 .Xr gdb 1 ,
2858 .Xr info 1 ,
2859 .Xr kbdcontrol 1 ,
2860 .Xr varsym 1 ,
2861 .Xr vidcontrol 1 ,
2862 .Xr ip 4 ,
2863 .Xr ipf 4 ,
2864 .Xr ipfw 4 ,
2865 .Xr kld 4 ,
2866 .Xr pf 4 ,
2867 .Xr tcp 4 ,
2868 .Xr udp 4 ,
2869 .Xr exports 5 ,
2870 .Xr motd 5 ,
2871 .Xr resident.conf 5 ,
2872 .Xr varsym.conf 5 ,
2873 .Xr accton 8 ,
2874 .Xr amd 8 ,
2875 .Xr apm 8 ,
2876 .Xr atm 8 ,
2877 .Xr btconfig 8 ,
2878 .Xr bthcid 8 ,
2879 .Xr cron 8 ,
2880 .Xr devd 8 ,
2881 .Xr dhclient 8 ,
2882 .Xr dntpd 8 ,
2883 .Xr ftpd 8 ,
2884 .Xr ifconfig 8 ,
2885 .Xr inetd 8 ,
2886 .Xr isdnd 8 ,
2887 .Xr isdntrace 8 ,
2888 .Xr jail 8 ,
2889 .Xr lpd 8 ,
2890 .Xr makewhatis 8 ,
2891 .Xr mdconfig 8 ,
2892 .Xr mixer 8 ,
2893 .Xr mountd 8 ,
2894 .Xr moused 8 ,
2895 .Xr mrouted 8 ,
2896 .Xr named 8 ,
2897 .Xr nfsd 8 ,
2898 .Xr pcnfsd 8 ,
2899 .Xr pfctl 8 ,
2900 .Xr pflogd 8 ,
2901 .Xr quotacheck 8 ,
2902 .Xr quotaon 8 ,
2903 .Xr rc 8 ,
2904 .Xr rc.sendmail 8 ,
2905 .Xr resident 8 ,
2906 .Xr rndcontrol 8 ,
2907 .Xr route 8 ,
2908 .Xr routed 8 ,
2909 .Xr rpcbind 8 ,
2910 .Xr rpc.lockd 8 ,
2911 .Xr rpc.statd 8 ,
2912 .Xr rtadvd 8 ,
2913 .Xr rtsold 8 ,
2914 .Xr rwhod 8 ,
2915 .Xr savecore 8 ,
2916 .Xr sdpd 8 ,
2917 .Xr sensorsd 8 ,
2918 .Xr sshd 8 ,
2919 .Xr swapon 8 ,
2920 .Xr sysctl 8 ,
2921 .Xr syslogd 8 ,
2922 .Xr timed 8 ,
2923 .Xr usbd 8 ,
2924 .Xr vinum 8 ,
2925 .Xr yp 8 ,
2926 .Xr ypbind 8 ,
2927 .Xr ypserv 8 ,
2928 .Xr ypset 8
2929 .Sh HISTORY
2930 The
2931 .Nm
2932 file appeared in
2933 .Fx 2.2.2 .
2934 .Sh AUTHORS
2935 .An Jordan K. Hubbard .