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