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