4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd system configuration information
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
41 file is generally initialized by the system installation utility.
45 is not to run commands or perform system startup actions
47 Instead, it is included by the
48 various generic startup scripts in
50 which conditionalize their
51 internal actions according to the settings found there.
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
60 when the system administrator wishes to override these defaults.
62 .Pa /etc/rc.conf.local
63 is used to override settings in
65 for historical reasons.
67 The sysrc(8) command provides a scripting interface to modify system
71 .Pa /etc/rc.conf.local
72 you can also place smaller configuration files for each
77 .Ao Ar dir Ac Ns Pa /rc.conf.d
78 directories specified in
80 which will be included by the
83 For jail configurations you could use the file
84 .Pa /etc/rc.conf.d/jail
85 to store jail specific configuration options.
89 .Pa /usr/local/etc/rc.d
92 .Pa /usr/local/rc.conf.d/jail
94 .Pa /opt/conf/rc.conf.d/jail
97 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
99 all of files in the directory will be loaded.
105 .Dq Ar name Ns Li = Ns Ar value
109 The following list provides a name and short description for each
110 variable that can be set in the
113 .Bl -tag -width indent-two
118 enable output of debug messages from rc scripts.
119 This variable can be helpful in diagnosing mistakes when
120 editing or integrating new scripts.
121 Beware that this produces copious output to the terminal and
127 disable informational messages from the rc scripts.
128 Informational messages are displayed when
129 a condition that is not serious enough to warrant a warning or
137 when faststart is used (e.g., at boot time).
138 .It Va early_late_divider
140 The name of the script that should be used as the
141 delimiter between the
145 stages of the boot process.
146 The early stage should contain all the services needed to
147 get the disks (local or remote) mounted so that the late
148 stage can include scripts contained in the directories
151 variable (see below).
152 Thus, the two likely candidates for this value are
154 for the typical system, and
156 if the system needs remote file
157 systems mounted to get access to the
159 directories; for example when
167 is likely to be an appropriate value.
168 Extreme care should be taken when changing this value,
169 and before changing it one should ensure that there are
170 adequate provisions to recover from a failed boot
171 (such as physical contact with the machine,
172 or reliable remote console access).
173 .It Va always_force_depends
177 scripts use the force_depend function to check whether required
178 services are already running, and to start them if necessary.
179 By default during boot time this check is bypassed if the
180 required service is enabled in
181 .Pa /etc/rc.conf[.local] .
182 Setting this option will bypass that check at boot time and
183 always test whether or not the service is actually running.
184 Enabling this option is likely to increase your boot time if
185 services are enabled that utilize the force_depend check.
186 .It Ao Ar name Ac Ns Va _chroot
189 to this directory before running the service.
190 .It Ao Ar name Ac Ns Va _user
192 Run the service under this user account.
193 .It Ao Ar name Ac Ns Va _group
195 Run the chrooted service under this system group.
197 setting, this setting has no effect if the service is not chrooted.
198 .It Ao Ar name Ac Ns Va _fib
202 value to run the service under.
203 .It Ao Ar name Ac Ns Va _nice
207 value to run the service under.
212 enable support for Automatic Power Management with
220 to handle APM event from userland.
221 This also enables support for APM.
228 these are the flags to pass to the
235 to handle device added, removed or unknown events from the kernel.
242 scripts at boot time.
245 Configuration file for
251 A list of kernel modules to load right after the local
253 Loading modules at this point in the boot process is
254 much faster than doing it via
255 .Pa /boot/loader.conf
256 for those modules not necessary for mounting local disk.
257 .It Va kldxref_enable
264 to automatically rebuild
269 .It Va kldxref_clobber
279 will overwrite existing
286 .It Va kldxref_module_path
291 delimited list of paths containing
303 enable the system power control facility with the
312 these are the flags to pass to the
316 Controls the creation of a
319 Always happens if set to
321 and never happens if set to
323 If set to anything else, a memory file system is created if
327 Controls the size of a created
331 Extra options passed to the
333 utility when the memory file system for
338 which inhibits the use of softupdates on
340 so that file system space is freed without delay
341 after file truncation or deletion.
344 for other options you can use in
347 Controls the creation of a
350 Always happens if set to
352 and never happens if set to
354 If set to anything else, a memory file system is created if
358 Controls the size of a created
362 Extra options passed to the
364 utility when the memory file system for
369 which inhibits the use of softupdates on
371 so that file system space is freed without delay
372 after file truncation or deletion.
375 for other options you can use in
378 Controls the automatic population of the
381 Always happens if set to
383 and never happens if set to
385 If set to anything else, a memory file system is created if
388 Note that this process requires access to certain commands in
392 is mounted on normal systems.
393 .It Va cleanvar_enable
400 List of directories to search for startup script files.
401 .It Va script_name_sep
403 The field separator to use for breaking down the list of startup script files
404 into individual filenames.
405 The default is a space.
406 It is not necessary to change this unless there are startup scripts with names
408 .It Va hostapd_enable
417 The fully qualified domain name (FQDN) of this host on the network.
418 This should almost certainly be set to something meaningful, even if
419 there is no network connection.
422 is used to set the hostname via DHCP,
423 this variable should be set to an empty string.
426 the hostname is generally already set and this variable may absent.
427 If this value remains unset when the system is done booting
428 your console login will display the default hostname of
432 The NIS domain name of this host, or
435 .It Va dhclient_program
437 Path to the DHCP client program
438 .Pa ( /sbin/dhclient ,
443 .It Va dhclient_flags
445 Additional flags to pass to the DHCP client program.
450 manpage for a description of the command line options available.
451 .It Va dhclient_flags_ Ns Aq Ar iface
452 Additional flags to pass to the DHCP client program running on
455 When specified, this variable overrides
457 .It Va background_dhclient
461 to start the DHCP client in background.
462 This can cause trouble with applications depending on
463 a working network, but it will provide a faster startup
465 .It Va background_dhclient_ Ns Aq Ar iface
466 When specified, this variable overrides the
467 .Va background_dhclient
468 variable for interface
471 .It Va synchronous_dhclient
477 synchronously at startup.
478 This behavior can be overridden on a per-interface basis by replacing
482 .Va ifconfig_ Ns Aq Ar interface
487 .It Va defaultroute_delay
489 When set to a positive value, wait up to this long after configuring
490 DHCP interfaces at startup to give the interfaces time to receive a lease.
491 .It Va firewall_enable
495 to load firewall rules at startup.
496 If the kernel was not built with
497 .Cd "options IPFIREWALL" ,
500 kernel module will be loaded.
502 .Va ipfilter_enable .
503 .It Va firewall_script
505 This variable specifies the full path to the firewall script to run.
507 .Pa /etc/rc.firewall .
510 Names the firewall type from the selection in
511 .Pa /etc/rc.firewall ,
512 or the file which contains the local firewall ruleset.
513 Valid selections from
517 .Bl -tag -width ".Li simple" -compact
519 unrestricted IP access
521 all IP services disabled, except via
524 basic protection for a workstation
526 basic protection for a LAN.
529 If a filename is specified, the full path
531 .It Va firewall_quiet
535 to disable the display of firewall rules on the console during boot.
536 .It Va firewall_logging
540 to enable firewall event logging.
541 This is equivalent to the
542 .Dv IPFIREWALL_VERBOSE
544 .It Va firewall_logif
548 to create pseudo interface
551 For more details, see
554 .It Va firewall_flags
560 specifies a filename.
561 .It Va firewall_coscripts
563 List of executables and/or rc scripts to run after firewall starts/stops.
565 .\" ----- firewall_nat_enable setting --------------------------------
566 .It Va firewall_nat_enable
574 will automatically load the
580 .It Va firewall_nat_interface
586 This is the name of the public interface or IP address on which
587 kernel NAT should run.
588 .It Va firewall_nat_flags
590 Additional configuration parameters for kernel NAT should be placed here.
591 .It Va firewall_nat64_enable
595 will automatically load the
597 NAT64 kernel module if
601 .It Va firewall_nptv6_enable
605 will automatically load the
607 NPTv6 kernel module if
611 .It Va firewall_pmod_enable
615 will automatically load the
617 pmod kernel module if
621 .It Va dummynet_enable
625 will automatically load the
631 .\" -------------------------------------------------------------------
632 .It Va ipfw_netflow_enable
636 will enable netflow logging via
639 By default a ipfw rule is inserted and all packets are duplicated with
640 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
641 port using protocol version 5.
642 .It Va ipfw_netflow_hook
644 netflow hook name, must be numerical
647 .It Va ipfw_netflow_rule
652 .It Va ipfw_netflow_ip
654 Destination server ip for receiving netflow data
657 .It Va ipfw_netflow_port
659 Destination server port for receiving netflow data
662 .It Va ipfw_netflow_version
664 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
665 .It Va ipfw_netflow_fib
667 Only match packet in FIB
669 (default is undefined meaning all FIBs).
685 sockets must be enabled in the kernel.
686 If the kernel was not built with
687 .Cd "options IPDIVERT" ,
690 kernel module will be loaded.
691 .It Va natd_interface
693 This is the name of the public interface on which
696 The interface may be given as an interface name or as an IP address.
701 flags should be placed here.
706 flag is automatically added with the above
709 .\" ----- ipfilter_enable setting --------------------------------
710 .It Va ipfilter_enable
721 Typical usage will require putting
723 ipfilter_enable="YES"
741 can be enabled independently.
745 both require at least one of
755 options IPFILTER_DEFAULT_BLOCK
758 in the kernel configuration file is a good idea, too.
759 .\" ----- ipfilter_program setting ------------------------------
760 .It Va ipfilter_program
766 .\" ----- ipfilter_rules setting --------------------------------
767 .It Va ipfilter_rules
772 This variable contains the name of the filter rule definition file.
773 The file is expected to be readable for the
776 .\" ----- ipv6_ipfilter_rules setting ---------------------------
777 .It Va ipv6_ipfilter_rules
782 This variable contains the IPv6 filter rule definition file.
783 The file is expected to be readable for the
786 .\" ----- ipfilter_flags setting --------------------------------
787 .It Va ipfilter_flags
790 This variable contains flags passed to the
793 .\" ----- ipnat_enable setting ----------------------------------
803 network address translation.
806 for a detailed discussion.
807 .\" ----- ipnat_program setting ---------------------------------
814 .\" ----- ipnat_rules setting -----------------------------------
820 This variable contains the name of the file
821 holding the network address translation definition.
822 This file is expected to be readable for the
825 .\" ----- ipnat_flags setting -----------------------------------
829 This variable contains flags passed to the
832 .\" ----- ipmon_enable setting ----------------------------------
847 Setting this variable needs setting
854 for a detailed discussion.
855 .\" ----- ipmon_program setting ---------------------------------
862 .\" ----- ipmon_flags setting -----------------------------------
868 This variable contains flags passed to the
871 Another typical example would be
872 .Dq Fl D Pa /var/log/ipflog
875 log directly to a file bypassing
878 .Pa /etc/newsyslog.conf
879 in such case like this:
881 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
883 .\" ----- ipfs_enable setting -----------------------------------
893 saving the filter and NAT state tables during shutdown
894 and reloading them during startup again.
895 Setting this variable needs setting
904 for a detailed discussion.
910 because the raised securelevel will prevent
912 from saving the state tables at shutdown time.
913 .\" ----- ipfs_program setting ----------------------------------
920 .\" ----- ipfs_flags setting ------------------------------------
924 This variable contains flags passed to the
927 .\" ----- end of added ipf hook ---------------------------------
939 Typical usage will require putting
954 into the kernel, otherwise the
955 kernel module will be loaded.
960 ruleset configuration file
975 these flags are passed to the
977 program when loading the ruleset.
987 which logs packets from the
1000 .Pa /var/log/pflog ) .
1002 .Pa /etc/newsyslog.conf
1003 to adjust logfile rotation for this.
1004 .It Va pflog_program
1009 .Pa /sbin/pflogd ) .
1013 This variable contains additional flags passed to the
1016 .It Va pflog_instances
1018 If logging to more than one
1020 interface is desired,
1022 is set to the list of
1024 instances that should be started at system boot time.
1027 is set, for each whitespace-separated
1030 .Ao Ar element Ac Ns Va _dev
1032 .Ao Ar element Ac Ns Va _logfile
1033 elements are assumed to exist.
1034 .Ao Ar element Ac Ns Va _dev
1037 interface to be watched by the named
1040 .Ao Ar element Ac Ns Va _logfile
1041 must contain the name of the logfile that will be used by the
1044 .It Va ftpproxy_enable
1055 packet filter in translating ftp connections.
1056 .It Va ftpproxy_flags
1059 This variable contains additional flags passed to the
1062 .It Va ftpproxy_instances
1065 If multiple instances of
1067 are desired at boot time,
1068 .Va ftpproxy_instances
1069 should contain a whitespace-separated list of instance names.
1072 in the list, a variable named
1073 .Ao Ar element Ac Ns Va _flags
1074 should be defined, containing the command-line flags to be passed to the
1077 .It Va pfsync_enable
1086 state changes to other hosts over the network by means of
1091 must also be set then.
1092 .It Va pfsync_syncdev
1095 This variable specifies the name of the network interface
1097 should operate through.
1098 It must be set accordingly if
1102 .It Va pfsync_syncpeer
1105 This variable is optional.
1106 By default, state change messages are sent out on the synchronisation
1107 interface using IP multicast packets.
1108 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1110 When a peer address is specified using the
1112 option, the peer address is used as a destination for the pfsync
1113 traffic, and the traffic can then be protected using
1117 manpage for more details about using
1122 .It Va pfsync_ifconfig
1125 This variable can contain additional options to be passed to the
1127 command used to set up
1129 .It Va tcp_extensions
1136 disables certain TCP options as described by
1142 might help remedy such problems with connections as randomly hanging
1143 or other weird behavior.
1144 Some network devices are known
1145 to be broken with respect to these options.
1148 Set to 0 by default.
1152 .Va net.inet.tcp.log_in_vain
1154 .Va net.inet.udp.log_in_vain ,
1159 are set to the given value.
1160 .It Va tcp_keepalive
1167 will disable probing idle TCP connections to verify that the
1168 peer is still up and reachable.
1169 .It Va tcp_drop_synfin
1176 will cause the kernel to ignore TCP frames that have both
1177 the SYN and FIN flags set.
1178 This prevents OS fingerprinting, but may
1179 break some legitimate applications.
1180 .It Va icmp_drop_redirect
1187 will cause the kernel to ignore ICMP REDIRECT packets.
1190 for more information.
1191 .It Va icmp_log_redirect
1198 will cause the kernel to log ICMP REDIRECT packets.
1200 the log messages are not rate-limited, so this option should only be used
1201 for troubleshooting networks.
1204 for more information.
1205 .It Va icmp_bmcastecho
1209 to respond to broadcast or multicast ICMP ping packets.
1212 for more information.
1213 .It Va ip_portrange_first
1217 this is the first port in the default portrange.
1220 for more information.
1221 .It Va ip_portrange_last
1225 this is the last port in the default portrange.
1228 for more information.
1229 .It Va network_interfaces
1231 Set to the list of network interfaces to configure on this host or
1233 (the default) for all current interfaces.
1235 .Va network_interfaces
1236 variable to anything other than the default is deprecated.
1237 Interfaces that the administrator wishes to store configuration for,
1238 but not start at boot should be configured with the
1241 .Va ifconfig_ Ns Aq Ar interface
1242 variables as described below.
1245 .Va ifconfig_ Ns Aq Ar interface
1246 variable is also assumed to exist for each value of
1248 When an interface name contains any of the characters
1250 they are translated to
1253 The variable can contain arguments to
1255 as well as special case-insensitive keywords described below.
1256 Such keywords are removed before passing the value to
1258 while the order of the other arguments is preserved.
1260 It is possible to add IP alias entries using
1262 syntax with the address family keyword such as
1264 Assuming that the interface in question was
1266 it might look something like this:
1268 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1269 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1272 It also possible to configure multiple IP addresses in Classless
1273 Inter-Domain Routing
1276 whose each address component can be a range like
1277 .Li inet 192.0.2.5-23/24
1279 .Li inet6 2001:db8:1-f::1/64 .
1280 This notation allows address and prefix length part only,
1281 not the other address modifiers.
1282 Note that the maximum number of the generated addresses from a range
1283 specification is limited to an integer value specified in
1284 .Va netif_ipexpand_max
1287 because a small typo can unexpectedly generate a large number of addresses.
1288 The default value is
1290 It can be increased by adding the following line into
1293 netif_ipexpand_max="4096"
1297 .Li 192.0.2.5-23/24 ,
1298 the address 192.0.2.5 will be configured with the
1299 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1300 the non-conflicting netmask /32 as explained in the
1303 Note that this special netmask handling is only for
1305 not for the other address families such as
1308 With the interface in question being
1310 an example could look like:
1312 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1313 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1319 .Va ipv4_addrs_ Ns Aq Ar interface
1320 variable was supported for IPv4 CIDR address notation.
1321 It is now deprecated because the functionality was integrated into
1322 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1324 .Va ipv4_addrs_ Ns Aq Ar interface
1325 is still supported for backward compatibility.
1328 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1329 entry with an address family keyword,
1330 its contents are passed to
1332 Execution stops at the first unsuccessful access, so if
1333 something like this is present:
1335 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1336 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1337 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1338 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1341 Then note that alias4 would
1343 be added since the search would
1344 stop with the missing
1347 Because of this difficult to manage behavior,
1349 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1350 variable, which has the same functionality as
1351 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1352 and can have all of entries in a variable like the following:
1354 ifconfig_ed0_aliases="\\
1355 inet 127.0.0.251 netmask 0xffffffff \\
1356 inet 127.0.0.252 netmask 0xffffffff \\
1357 inet 127.0.0.253 netmask 0xffffffff \\
1358 inet 127.0.0.254 netmask 0xffffffff"
1361 It also supports CIDR notation.
1364 .Pa /etc/start_if. Ns Aq Ar interface
1365 file is present, it is read and executed by the
1368 before configuring the interface as specified in the
1369 .Va ifconfig_ Ns Aq Ar interface
1371 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1375 .Va vlans_ Ns Aq Ar interface
1379 interface will be created for each item in the list with the
1383 If a vlan interface's name is a number,
1384 then that number is used as the vlan tag and the new vlan interface is
1386 .Ar interface . Ns Ar tag .
1388 the vlan tag must be specified via a
1391 .Va create_args_ Ns Aq Ar interface
1394 To create a vlan device named
1398 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1401 ifconfig_em0_101="inet 192.0.2.1/24"
1404 To create a vlan device named
1408 with the vlan tag 102:
1411 create_args_myvlan="vlan 102"
1415 .Va wlans_ Ns Aq Ar interface
1419 interface will be created for each item in the list with the
1423 Further wlan cloning arguments may be passed to the
1426 command by setting the
1427 .Va create_args_ Ns Aq Ar interface
1431 devices must be created for each wireless devices as of
1437 may be specified with an
1438 .Va wlandebug_ Ns Aq Ar interface
1440 The contents of this variable will be passed directly to
1444 .Va ifconfig_ Ns Aq Ar interface
1445 contains the keyword
1447 then the interface will not be configured
1449 .Pa /etc/pccard_ether
1451 .Va network_interfaces
1455 It is possible to bring up an interface with DHCP by adding
1458 .Va ifconfig_ Ns Aq Ar interface
1460 For instance, to initialize the
1463 it is possible to use something like:
1468 If you want to configure your wireless interface with
1469 .Xr wpa_supplicant 8
1470 for use with WPA, EAP/LEAP or WEP, you need to add
1473 .Va ifconfig_ Ns Aq Ar interface
1476 On the other hand, if you want to configure your wireless interface with
1481 .Va ifconfig_ Ns Aq Ar interface
1484 will use the settings from
1485 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1487 Finally, you can add
1489 options in this variable, in addition to the
1490 .Pa /etc/start_if. Ns Aq Ar interface
1492 For instance, to configure an
1494 wireless device in station mode with an address obtained
1495 via DHCP, using WPA authentication and 802.11b mode, it is
1496 possible to use something like:
1499 ifconfig_wlan0="DHCP WPA mode 11b"
1503 .Va ifconfig_ Ns Aq Ar interface
1504 form, a fallback variable
1505 .Va ifconfig_DEFAULT
1507 It will be used for all interfaces with no
1508 .Va ifconfig_ Ns Aq Ar interface
1510 This is intended to replace the no longer supported
1514 It is also possible to rename an interface by doing:
1516 ifconfig_ed0_name="net0"
1517 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1521 This variable is deprecated.
1523 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1525 .Va ipv6_activate_all_interfaces
1530 .Dq Li inet6 accept_rtadv
1532 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1534 .Va ipv6_activate_all_interfaces
1539 This variable is deprecated.
1541 .Va ip6addrctl_policy
1546 the default address selection policy table set by
1548 will be IPv6-preferred.
1552 the default address selection policy table set by
1554 will be IPv4-preferred.
1555 .It Va ipv6_activate_all_interfaces
1557 This controls initial configuration on IPv6-capable
1558 interfaces with no corresponding
1559 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1561 Note that it is not always necessary to set this variable to
1563 to use IPv6 functionality on
1565 In most cases, just configuring
1566 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1571 all interfaces which do not have a corresponding
1572 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1573 variable will be marked as
1576 This means that all of IPv6 functionality on that interface
1577 is completely disabled to enforce a security policy.
1578 If the variable is set to
1580 the flag will be cleared on all of the interfaces.
1582 In most cases, just defining an
1583 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1584 for an IPv6-capable interface should be sufficient.
1585 However, if an interface is added dynamically
1586 .Pq by some tunneling protocols such as PPP, for example ,
1587 it is often difficult to define the variable in advance.
1588 In such a case, configuring the
1590 flag can be disabled by setting this variable to
1593 For more details of the
1596 .Dq Li inet6 ifdisabled ,
1606 privacy addresses will be generated for each IPv6
1607 interface as described in RFC 4941.
1608 .It Va ipv6_network_interfaces
1610 This is the IPv6 equivalent of
1611 .Va network_interfaces .
1612 Normally manual configuration of this variable is not needed.
1613 .It Va ipv6_cpe_wanif
1615 If the variable is set to an interface name,
1619 .Dq inet6 -no_radr accept_rtadv
1620 will be added to the specified interface automatically before evaluating
1621 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1625 .Va net.inet6.ip6.rfc6204w3
1627 .Va net.inet6.ip6.no_radr
1630 This means the specified interface will accept ICMPv6 Router
1631 Advertisement messages on that link and add the discovered
1632 routers into the Default Router List.
1633 While the other interfaces can still accept RA messages if the
1634 .Dq inet6 accept_rtadv
1635 option is specified, adding
1636 routes into the Default Router List will be disabled by
1643 Note that ICMPv6 Router Advertisement messages will be
1645 .Va net.inet6.ip6.forwarding
1647 .Pq packet forwarding is enabled
1649 .Va net.inet6.ip6.rfc6204w3
1654 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1656 This assigns arbitrary description to an interface.
1660 .Va net.ifdescr_maxlen
1662 This static setting may be overridden by commands
1663 started with dynamic interface configuration utilities
1666 hooks. The description can be seen with
1668 command and it may be exported with
1670 daemon using its MIB-2 module.
1671 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1673 IPv6 functionality on an interface should be configured by
1674 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1675 instead of setting ifconfig parameters in
1676 .Va ifconfig_ Ns Aq Ar interface .
1677 If this variable is empty, all of IPv6 configurations on the
1678 specified interface by other variables such as
1679 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1682 Aliases should be set by
1683 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1689 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1690 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1693 Interfaces that have an
1694 .Dq Li inet6 accept_rtadv
1696 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1697 setting will be automatically configured by SLAAC
1698 .Pq StateLess Address AutoConfiguration
1704 Note that a link-local address will be automatically configured in
1705 addition to the configured global-scope addresses because the IPv6
1706 specifications require it on each link.
1707 The address is calculated from the MAC address by using an algorithm
1714 If only a link-local address is needed on the interface,
1715 the following configuration can be used:
1717 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1720 A link-local address can also be configured manually.
1721 This is useful for the default router address of an IPv6 router
1722 so that it does not change when the network interface
1726 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1728 .It Va ipv6_prefix_ Ns Aq Ar interface
1730 If one or more prefixes are defined in
1731 .Va ipv6_prefix_ Ns Aq Ar interface
1732 addresses based on each prefix and the EUI-64 interface index will be
1733 configured on that interface.
1734 Note that this variable will be ignored when
1735 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1738 For example, the following configuration
1740 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1743 is equivalent to the following:
1745 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1746 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1747 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1748 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1751 These Subnet-Router anycast addresses will be added only when
1752 .Va ipv6_gateway_enable
1754 .It Va ipv6_default_interface
1758 this is the default output interface for scoped addresses.
1759 This works only with ipv6_gateway_enable="NO".
1760 .It Va ip6addrctl_enable
1762 This variable is to enable configuring default address selection policy table
1764 The table can be specified in another variable
1765 .Va ip6addrctl_policy .
1767 .Va ip6addrctl_policy
1768 the following keywords can be specified:
1769 .Dq Li ipv4_prefer ,
1770 .Dq Li ipv6_prefer ,
1780 installs a pre-defined policy table described in Section 2.1
1788 is specified, it attempts to read a file
1789 .Pa /etc/ip6addrctl.conf
1791 If this file is found,
1793 reads and installs it.
1794 If not found, a policy is automatically set
1796 .Va ipv6_activate_all_interfaces
1797 variable; if the variable is set to
1799 the IPv6-preferred one is used.
1800 Otherwise IPv4-preferred.
1802 The default value of
1803 .Va ip6addrctl_enable
1805 .Va ip6addrctl_policy
1811 .It Va cloned_interfaces
1813 Set to the list of clonable network interfaces to create on this host.
1814 Further cloning arguments may be passed to the
1817 command for each interface by setting the
1818 .Va create_args_ Ns Aq Ar interface
1820 If an interface name is specified with
1823 the interface will not be destroyed even when
1825 script is invoked with
1828 This is useful when reconfiguring the interface without destroying it.
1830 .Va cloned_interfaces
1831 are automatically appended to
1832 .Va network_interfaces
1834 .It Va cloned_interfaces_sticky
1836 This variable is to globally enable functionality of
1839 .Va cloned_interfaces
1841 The default value is
1843 Even if this variable is specified to
1846 keyword can be used to override it on per interface basis.
1847 .It Va gif_interfaces
1849 This variable is deprecated in favor of
1850 .Va cloned_interfaces .
1853 tunnel interfaces to configure on this host.
1856 tunnel interface, set a variable named
1857 .Va ifconfig_ Ns Aq Ar interface
1858 with the parameters for the
1860 command to configure the link level for
1865 The value of this variable is used to configure the link layer of the
1870 For example, configure two
1873 .Bd -literal -offset indent
1874 gif_interfaces="gif0 gif1"
1875 ifconfig_gif0="tunnel src_addr0 dst_addr0"
1876 ifconfig_gif1="tunnel src_addr1 dst_addr1"
1879 Additionally, this option ensures that each listed interface is created
1884 This example also works with
1885 .Va cloned_interfaces
1887 .Va gif_interfaces .
1888 .It Va sppp_interfaces
1892 interfaces to configure on this host.
1894 .Va spppconfig_ Ns Aq Ar interface
1895 variable is assumed to exist for each value of
1897 Each interface should also be configured by a general
1898 .Va ifconfig_ Ns Aq Ar interface
1902 for more information about available options.
1912 The name of the profile to use from
1913 .Pa /etc/ppp/ppp.conf .
1914 Also used for per-profile overrides of
1919 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1920 When the profile name contains any of the characters
1922 they are translated to
1924 for the proposes of the override variable names.
1927 Mode in which to run the
1930 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1932 Overrides the global
1942 See the manual for a full description.
1947 enables network address translation.
1948 Used in conjunction with
1950 allows hosts on private network addresses access to the Internet using
1951 this host as a network address translating router.
1952 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1954 Overrides the global
1958 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1960 Set the unit number to be used for this profile.
1961 See the manual description of
1966 The name of the user under which
1974 .It Va rc_conf_files
1976 This option is used to specify a list of files that will override
1978 .Pa /etc/defaults/rc.conf .
1979 The files will be read in the order in which they are specified and should
1980 include the full path to the file.
1981 By default, the files specified are
1984 .Pa /etc/rc.conf.local
1990 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1992 .It Va gptboot_enable
1996 .Pa /etc/rc.d/gptboot
1997 will log if the system successfully (or not) booted from a GPT partition,
2003 .It Va gbde_autoattach_all
2008 will attempt to automatically initialize your .bde devices in
2012 List the devices that the script should try to attach,
2017 The directory where the
2019 lockfiles are located.
2020 The default lockfile directory is
2023 The lockfile for each individual
2025 device can be overridden by setting the variable
2026 .Va gbde_lock_ Ns Aq Ar device ,
2029 is the encrypted device without the
2034 .It Va gbde_attach_attempts
2036 Number of times to attempt attaching to a
2038 device, i.e., how many times the user is asked for the pass-phrase.
2042 List of devices to automatically attach on boot.
2043 Note that .eli devices from
2045 are automatically appended to this list.
2048 List of groups containing devices to automatically attach on boot with the same
2049 keyfiles and passphrase.
2050 This must be accompanied with a corresponding
2051 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2055 Number of times user is asked for the pass-phrase.
2056 If empty, it will be taken from
2057 .Va kern.geom.eli.tries
2059 .It Va geli_default_flags
2061 Default flags to use by
2063 when configuring disk encryption.
2064 Flags can be configured for every device separately by defining the
2065 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2066 variable, and for every group separately by defining the
2067 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2069 .It Va geli_autodetach
2071 Specifies if GELI devices should be marked for detach on last close after
2072 file systems are mounted.
2075 This can be changed for every device separately by defining the
2076 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2078 .It Va root_rw_mount
2083 After the file systems are checked at boot time, the root file system
2084 is remounted as read-write if this is set to
2086 Diskless systems that mount their root file system from a read-only remote
2087 NFS share should set this to
2091 .It Va fsck_y_enable
2096 will be run with the
2098 flag if the initial preen
2099 of the file systems fails.
2100 .It Va background_fsck
2104 the system will not attempt to run
2106 in the background where possible.
2107 .It Va background_fsck_delay
2109 The amount of time in seconds to sleep before starting a background
2111 It defaults to sixty seconds to allow large applications such as
2112 the X server to start before disk I/O bandwidth is monopolized by
2114 If set to a negative number, the background file system check will be
2115 delayed indefinitely to allow the administrator to run it at a more
2117 For example it may be run from
2119 by adding a line like
2121 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2127 List of file system types that are network-based.
2128 This list should generally not be modified by end users.
2130 .Va extra_netfs_types
2132 .It Va extra_netfs_types
2134 If set to something other than
2137 this variable extends the list of file system types
2138 for which automatic mounting at startup by
2140 should be delayed until the network is initialized.
2142 a whitespace-separated list of network file system descriptor pairs,
2143 each consisting of a file system type as passed to
2145 and a human-readable, one-word description,
2148 Extending the default list in this way is only necessary
2149 when third party file system types are used.
2150 .It Va syslogd_enable
2157 .It Va syslogd_program
2162 .Pa /usr/sbin/syslogd ) .
2163 .It Va syslogd_flags
2169 these are the flags to pass to
2178 .It Va inetd_program
2183 .Pa /usr/sbin/inetd ) .
2190 these are the flags to pass to
2199 .It Va hastd_program
2211 these are the flags to pass to
2213 .It Va local_unbound_enable
2219 daemon as a local caching resolver.
2224 to start a Kerberos 5 authentication server
2232 this is the path to Kerberos 5 Authentication Server.
2236 This variable contains additional flags to be passed to the Kerberos 5
2237 authentication server.
2238 .It Va kadmind_enable
2244 the Kerberos 5 Administration Daemon; set to
2247 .It Va kadmind_program
2253 this is the path to Kerberos 5 Administration Daemon.
2254 .It Va kpasswdd_enable
2260 the Kerberos 5 Password-Changing Daemon; set to
2263 .It Va kpasswdd_program
2269 this is the path to Kerberos 5 Password-Changing Daemon.
2276 the Kerberos 5 ticket forwarding daemon, at the boot time.
2282 .Pa /usr/libexec/kfd ) .
2289 daemon at boot time.
2296 these are the flags to pass to it.
2303 daemon at boot time.
2310 these are the flags to pass to it.
2313 manpage for more information.
2314 .It Va amd_map_program
2317 the specified program is run to get the list of
2322 maps are stored in NIS, one can set this to
2335 will be updated at boot time to reflect the kernel release
2340 will not be updated.
2341 .It Va nfs_client_enable
2345 run the NFS client daemons at boot time.
2346 .It Va nfs_access_cache
2349 .Va nfs_client_enable
2354 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2356 results should be cached.
2357 A value of 2-10 seconds will substantially reduce network
2358 traffic for many NFS operations.
2359 .It Va nfs_server_enable
2363 run the NFS server daemons at boot time.
2364 .It Va nfs_server_flags
2367 .Va nfs_server_enable
2370 these are the flags to pass to the
2373 .It Va nfsv4_server_enable
2376 .Va nfs_server_enable
2380 .Va nfsv4_server_enable
2383 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2384 .It Va nfsuserd_enable
2390 run the nfsuserd daemon, which is needed for NFSv4 in order
2391 to map between user/group names vs uid/gid numbers.
2393 .Va nfsv4_server_enable
2396 this will be forced enabled.
2397 .It Va nfsuserd_flags
2403 these are the flags to pass to the
2406 .It Va nfscbd_enable
2412 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2419 these are the flags to pass to the
2422 .It Va mountd_enable
2427 .Va nfs_server_enable
2433 It is commonly needed to run CFS without real NFS used.
2440 these are the flags to pass to the
2443 .It Va weak_mountd_authentication
2447 allow services like PCNFSD to make non-privileged mount
2449 .It Va nfs_reserved_port_only
2453 provide NFS services only on a secure port.
2454 .It Va nfs_bufpackets
2456 If set to a number, indicates the number of packets worth of
2457 socket buffer space to reserve on an NFS client.
2458 The kernel default is typically 4.
2459 Using a higher number may be
2460 useful on gigabit networks to improve performance.
2461 The minimum value is
2462 2 and the maximum is 64.
2463 .It Va rpc_lockd_enable
2467 and also an NFS server or client, run
2470 .It Va rpc_lockd_flags
2473 .Va rpc_lockd_enable
2476 these are the flags to pass to the
2479 .It Va rpc_statd_enable
2483 and also an NFS server or client, run
2486 .It Va rpc_statd_flags
2489 .Va rpc_statd_enable
2492 these are the flags to pass to the
2495 .It Va rpcbind_program
2500 .Pa /usr/sbin/rpcbind ) .
2501 .It Va rpcbind_enable
2507 service at boot time.
2508 .It Va rpcbind_flags
2514 these are the flags to pass to the
2517 .It Va keyserv_enable
2523 daemon on boot for running Secure RPC.
2524 .It Va keyserv_flags
2530 these are the flags to pass to
2533 .It Va pppoed_enable
2539 daemon at boot time to provide PPP over Ethernet services.
2540 .It Va pppoed_ Ns Aq Ar provider
2543 listens to requests to this
2549 argument of the same name.
2552 Additional flags to pass to
2554 .It Va pppoed_interface
2556 The network interface to run
2559 This is mandatory when
2569 service at boot time.
2570 This command is intended for networks of
2571 machines where a consistent
2573 for all hosts must be established.
2574 This is often useful in large NFS
2575 environments where time stamps on files are expected to be consistent
2583 these are the flags to pass to the
2586 .It Va ntpdate_enable
2593 This command is intended to
2594 synchronize the system clock only
2596 from some standard reference.
2598 Note that the use of the
2599 .Va ntpd_sync_on_start
2600 variable is a preferred alternative to the
2604 is to be retired from the NTP distribution.
2605 .It Va ntpdate_config
2607 Configuration file for
2611 .It Va ntpdate_hosts
2613 A whitespace-separated list of NTP servers to synchronize with at startup.
2614 The default is to use the servers listed in
2615 .Va ntpdate_config ,
2616 if that file exists.
2617 .It Va ntpdate_program
2622 .Pa /usr/sbin/ntpdate ) .
2623 .It Va ntpdate_flags
2629 these are the flags to pass to the
2631 command (typically a hostname).
2638 command at boot time.
2644 .Pa /usr/sbin/ntpd ) .
2658 these are the flags to pass to the
2661 .It Va ntpd_sync_on_start
2668 flag, which syncs the system's clock on startup.
2671 for more information regarding the
2674 This is a preferred alternative to using
2679 .It Va nis_client_enable
2685 service at system boot time.
2686 .It Va nis_client_flags
2689 .Va nis_client_enable
2692 these are the flags to pass to the
2695 .It Va nis_ypldap_enable
2701 daemon at system boot time.
2702 .It Va nis_ypldap_flags
2705 .Va nis.ypldap_enable
2708 these are the flags to pass to the
2711 .It Va nis_ypset_enable
2717 daemon at system boot time.
2718 .It Va nis_ypset_flags
2721 .Va nis_ypset_enable
2724 these are the flags to pass to the
2727 .It Va nis_server_enable
2733 daemon at system boot time.
2734 .It Va nis_server_flags
2737 .Va nis_server_enable
2740 these are the flags to pass to the
2743 .It Va nis_ypxfrd_enable
2749 daemon at system boot time.
2750 .It Va nis_ypxfrd_flags
2753 .Va nis_ypxfrd_enable
2756 these are the flags to pass to the
2759 .It Va nis_yppasswdd_enable
2765 daemon at system boot time.
2766 .It Va nis_yppasswdd_flags
2769 .Va nis_yppasswdd_enable
2772 these are the flags to pass to the
2775 .It Va rpc_ypupdated_enable
2781 daemon at system boot time.
2782 .It Va bsnmpd_enable
2788 daemon at system boot time.
2789 Be sure to understand the security implications of running SNMP daemon
2797 these are the flags to pass to the
2800 .It Va defaultrouter
2804 create a default route to this host name or IP address
2805 (use an IP address if this router is also required to get to the
2807 .It Va ipv6_defaultrouter
2809 The IPv6 equivalent of
2811 .It Va static_arp_pairs
2813 Set to the list of static ARP pairs that are to be added at system
2815 For each whitespace separated
2818 .Va static_arp_ Ns Aq Ar element
2819 variable is assumed to exist whose contents will later be passed to a
2824 static_arp_pairs="gw"
2825 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2827 .It Va static_ndp_pairs
2829 Set to the list of static NDP pairs that are to be added at system
2831 For each whitespace separated
2834 .Va static_ndp_ Ns Aq Ar element
2835 variable is assumed to exist whose contents will later be passed to a
2840 static_ndp_pairs="gw"
2841 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2843 .It Va static_routes
2845 Set to the list of static routes that are to be added at system
2849 then for each whitespace separated
2852 .Va route_ Ns Aq Ar element
2853 variable is assumed to exist
2854 whose contents will later be passed to a
2859 static_routes="ext mcast:gif0 gif0local:gif0"
2860 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2861 route_mcast="-net 224.0.0.0/4 -iface gif0"
2862 route_gif0local="-host 169.254.1.1 -iface lo0"
2869 the route is specific to the interface
2871 .It Va ipv6_static_routes
2873 The IPv6 equivalent of
2877 then for each whitespace separated
2880 .Va ipv6_route_ Ns Aq Ar element
2881 variable is assumed to exist
2882 whose contents will later be passed to a
2883 .Dq Nm route Cm add Fl inet6
2885 .It Va gateway_enable
2889 configure host to act as an IP router, e.g.\& to forward packets
2891 .It Va ipv6_gateway_enable
2893 The IPv6 equivalent of
2894 .Va gateway_enable .
2895 .It Va routed_enable
2899 run a routing daemon of some sort, based on the
2904 .It Va route6d_enable
2906 The IPv6 equivalent of
2910 run a routing daemon of some sort, based on the
2915 .It Va routed_program
2921 this is the name of the routing daemon to use.
2922 .It Va route6d_program
2924 The IPv6 equivalent of
2925 .Va routed_program .
2932 these are the flags to pass to the routing daemon.
2933 .It Va route6d_flags
2935 The IPv6 equivalent of
2937 .It Va rtadvd_enable
2943 daemon at boot time.
2946 utility sends ICMPv6 Router Advertisement messages to
2947 the interfaces specified in
2948 .Va rtadvd_interfaces .
2949 This should only be enabled with great care.
2950 You may want to fine-tune
2952 .It Va rtadvd_interfaces
2958 this is the list of interfaces to use.
2963 enable global proxy ARP.
2964 .It Va forward_sourceroute
2972 source-routed packets are forwarded.
2973 .It Va accept_sourceroute
2977 the system will accept source-routed packets directed at it.
2984 daemon at system boot time.
2991 these are the flags to pass to the
2994 .It Va bootparamd_enable
3000 daemon at system boot time.
3001 .It Va bootparamd_flags
3004 .Va bootparamd_enable
3007 these are the flags to pass to the
3010 .It Va stf_interface_ipv4addr
3014 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
3016 Specify this entry to enable the 6to4 interface.
3017 .It Va stf_interface_ipv4plen
3019 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
3020 An effective value is 0-31.
3021 .It Va stf_interface_ipv6_ifid
3023 IPv6 interface ID for
3027 .It Va stf_interface_ipv6_slaid
3029 IPv6 Site Level Aggregator for
3031 .It Va ipv6_ipv4mapping
3035 this enables IPv4 mapped IPv6 address communication (like
3036 .Li ::ffff:a.b.c.d ) .
3037 .It Va rtsold_enable
3043 daemon to send ICMPv6 Router Solicitation messages.
3050 these are the flags to pass to
3054 For interfaces configured with the
3055 .Dq Li inet6 accept_rtadv
3056 keyword, these are the flags to pass to
3061 is mutually exclusive to
3067 The keyboard bell sound.
3074 if the default behavior is desired.
3075 For details, refer to the
3080 If set to a non-null string, the virtual console's keyboard input is
3086 no keymap is installed, otherwise the value is used to install
3087 the keymap file found in
3088 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3091 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3096 The keyboard repeat speed.
3103 if the default behavior is desired.
3108 attempt to program the function keys with the value.
3110 be a single string of the form:
3111 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3114 Can be set to the value of
3117 .Dq Li destructive ,
3120 to set the cursor behavior explicitly or choose the default behavior.
3125 no screen map is installed, otherwise the value is used to install
3126 the screen map file in
3127 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3128 This parameter is ignored when using
3130 as the console driver.
3135 the default 8x16 font value is used for screen size requests, otherwise
3137 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3139 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3140 is used (depending on the console driver being used).
3145 the default 8x14 font value is used for screen size requests, otherwise
3147 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3149 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3150 is used (depending on the console driver being used).
3155 the default 8x8 font value is used for screen size requests, otherwise
3157 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3159 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3160 is used (depending on the console driver being used).
3165 the default screen blanking interval is used, otherwise it is set
3173 this is the actual screen saver to use
3174 .Li ( blank , snake , daemon ,
3176 .It Va moused_nondefault_enable
3180 the mouse device specified on
3181 the command line is not automatically treated as enabled by the
3182 .Pa /etc/rc.d/moused
3184 Having this variable set to
3190 to be enabled as soon as it is plugged in.
3191 .It Va moused_enable
3197 daemon is started for doing cut/paste selection on the console.
3200 This is the protocol type of the mouse connected to this host.
3201 This variable must be set if
3208 is able to detect the appropriate mouse type automatically in many cases.
3209 Set this variable to
3211 to let the daemon detect it, or
3212 select one from the following list if the automatic detection fails.
3214 If the mouse is attached to the PS/2 mouse port, choose
3218 regardless of the brand and model of the mouse.
3220 mouse is attached to the bus mouse port, choose
3224 All other protocols are for serial mice and will not work with
3225 the PS/2 and bus mice.
3226 If this is a USB mouse,
3228 is the only protocol type which will work.
3230 .Bl -tag -width ".Li x10mouseremote" -compact
3232 Microsoft mouse (serial)
3234 Microsoft IntelliMouse (serial)
3236 Mouse systems Corp.\& mouse (serial)
3238 MM Series mouse (serial)
3240 Logitech mouse (serial)
3244 Logitech MouseMan and TrackMan (serial)
3246 ALPS GlidePoint (serial)
3247 .It Li thinkingmouse
3248 Kensington ThinkingMouse (serial)
3252 MM HitTablet (serial)
3253 .It Li x10mouseremote
3254 X10 MouseRemote (serial)
3256 Interlink VersaPad (serial)
3259 Even if the mouse is not in the above list, it may be compatible
3260 with one in the list.
3261 Refer to the manual page for
3263 for compatibility information.
3265 It should also be noted that while this is enabled, any
3266 other client of the mouse (such as an X server) should access
3267 the mouse through the virtual mouse device,
3269 and configure it as a
3271 type mouse, since all
3272 mouse data is converted to this single canonical format when
3275 If the client program does not support the
3281 It is the second preferred type.
3288 this is the actual port the mouse is on.
3291 for a COM1 serial mouse,
3295 for a bus mouse, for example.
3300 is set, its value is used as an additional set of flags to pass to the
3303 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3305 .Va moused_nondefault_enable
3308 daemon is started for a non-default port, the
3309 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3310 set of options has precedence over and replaces the default
3314 is the name of the non-default port, i.e.,\&
3317 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3318 it is possible to set up a different set of default flags for each
3321 For example, you can use
3325 to make your laptop's touchpad more comfortable to use,
3326 but an empty set of options for
3327 .Va moused_ums0_flags
3330 mouse has three or more buttons.
3331 .It Va mousechar_start
3335 the default mouse cursor character range
3336 .Li 0xd0 Ns - Ns Li 0xd3
3338 otherwise the range start is set
3343 Use if the default range is occupied in the language code table.
3344 .It Va allscreens_flags
3348 is run with these options for each of the virtual terminals
3352 will enable the mouse pointer on all virtual terminals
3357 .It Va allscreens_kbdflags
3361 is run with these options for each of the virtual terminals
3369 scrollback (history) buffer to 200 lines.
3376 daemon at system boot time.
3382 .Pa /usr/sbin/cron ) .
3389 these are the flags to pass to
3395 enable the special handling of transitions to and from the
3396 Daylight Saving Time in
3398 (equivalent to using the flag
3405 .Pa /usr/sbin/lpd ) .
3412 daemon at system boot time.
3419 these are the flags to pass to the
3422 .It Va chkprintcap_enable
3428 command before starting the
3431 .It Va chkprintcap_flags
3436 .Va chkprintcap_enable
3439 these are the flags to pass to the
3444 which causes missing directories to be created.
3445 .It Va mta_start_script
3447 This variable specifies the full path to the script to run to start
3448 a mail transfer agent.
3450 .Pa /etc/rc.sendmail .
3454 .Pa /etc/rc.sendmail
3455 uses are documented in the
3460 Indicates the device (usually a swap partition) to which a crash dump
3461 should be written in the event of a system crash.
3462 If the value of this variable is
3464 the first suitable swap device listed in
3466 will be used as dump device.
3467 Otherwise, the value of this variable is passed as the argument to
3469 To disable crash dumps, set this variable to
3477 as the system dump device.
3480 When the system reboots after a crash and a crash dump is found on the
3481 device specified by the
3485 will save that crash dump and a copy of the kernel to the directory
3489 The default value is
3498 .It Va savecore_enable
3502 disable automatic extraction of the crash dump from the
3504 .It Va savecore_flags
3506 If crash dumps are enabled, these are the flags to pass to the
3513 to turn on user and group disk quotas on system startup via the
3515 command for all file systems marked as having quotas enabled in
3517 The kernel must be built with
3519 for disk quotas to function.
3524 to enable user and group disk quota checking via the
3527 .It Va quotacheck_flags
3537 these are the flags to pass to the
3542 which checks quotas for all file systems with quotas enabled in
3544 .It Va quotaon_flags
3550 these are the flags to pass to the
3555 which enables quotas for all file systems with quotas enabled in
3557 .It Va quotaoff_flags
3563 these are the flags to pass to the
3565 utility when shutting down the quota system.
3568 which disables quotas for all file systems with quotas enabled in
3570 .It Va accounting_enable
3574 to enable system accounting through the
3581 to enable iBCS2 (SCO) binary emulation at system initial boot
3583 .It Va ibcs2_loaders
3591 this specifies a list of additional iBCS2 loaders to enable.
3592 .It Va firstboot_sentinel
3594 This variable specifies the full path to a
3597 If a file exists with this path,
3601 keyword will be run on startup and the sentinel file will be deleted
3602 after the boot process completes.
3603 The sentinel file must be located on a writable file system which is
3604 mounted no later than
3605 .Va early_late_divider
3606 to function properly.
3613 to enable Linux/ELF binary emulation at system initial
3615 .It Va sysvipc_enable
3619 load System V IPC primitives at boot time.
3620 .It Va clear_tmp_enable
3631 to disable removing of X11 lock files,
3632 and the removal and (secure) recreation
3633 of the various socket directories for X11
3635 .It Va ldconfig_paths
3637 Set to the list of shared library paths to use with
3641 will always be added first, so it need not appear in this list.
3642 .It Va ldconfig32_paths
3644 Set to the list of 32-bit compatibility shared library paths to
3647 .It Va ldconfig_paths_aout
3649 Set to the list of shared library paths to use with
3654 .It Va ldconfig_insecure
3658 utility normally refuses to use directories
3659 which are writable by anyone except root.
3660 Set this variable to
3662 to disable that security check during system startup.
3663 .It Va ldconfig_local_dirs
3665 Set to the list of local
3668 The names of all files in the directories listed will be
3669 passed as arguments to
3671 .It Va ldconfig_local32_dirs
3673 Set to the list of local 32-bit compatibility
3676 The names of all files in the directories listed will be
3677 passed as arguments to
3678 .Dq Nm ldconfig Fl 32 .
3679 .It Va kern_securelevel_enable
3683 to set the kernel security level at system startup.
3684 .It Va kern_securelevel
3686 The kernel security level to set at startup.
3687 The allowed range of
3689 ranges from \-1 (the compile time default) to 3 (the
3693 for the list of possible security levels and their effect
3694 on system operation.
3697 Path to the SSH server program
3698 .Pa ( /usr/sbin/sshd
3706 at system boot time.
3713 these are the flags to pass to the
3718 Path to the FTP server program
3719 .Pa ( /usr/libexec/ftpd
3727 as a stand-alone daemon at system boot time.
3734 these are the additional flags to pass to the
3737 .It Va watchdogd_enable
3743 daemon at boot time.
3744 This requires that the kernel have been compiled with a
3747 .It Va watchdogd_flags
3750 .Va watchdogd_enable
3753 these are the flags passed to the
3756 .It Va devfs_rulesets
3758 List of files containing sets of rules for
3760 .It Va devfs_system_ruleset
3762 Rule name(s) to apply to the system
3765 .It Va devfs_set_rulesets
3767 Pairs of already-mounted
3769 directories and rulesets that should be applied to them.
3770 For example: /mount/dev=ruleset_name
3771 .It Va devfs_load_rulesets
3773 If set, always load the default rulesets listed in
3774 .Va devfs_rulesets .
3775 .It Va performance_cx_lowest
3777 CPU idle state to use while on AC power.
3782 should use the lowest power state available while
3784 indicates that the lowest latency state (less power savings) should be used.
3785 .It Va performance_cpu_freq
3787 CPU clock frequency to use while on AC power.
3792 should use the lowest frequency available while
3794 indicates that the highest frequency (less power savings) should be used.
3795 .It Va economy_cx_lowest
3797 CPU idle state to use when off AC power.
3802 should use the lowest power state available while
3804 indicates that the lowest latency state (less power savings) should be used.
3805 .It Va economy_cpu_freq
3807 CPU clock frequency to use when off AC power.
3812 should use the lowest frequency available while
3814 indicates that the highest frequency (less power savings) should be used.
3819 any configured jails will not be started.
3822 The configuration filename used by
3825 The default value is
3826 .Pa /etc/jail.conf .
3827 .It Va jail_parallel_start
3831 all configured jails will be started in the background (in parallel).
3835 When set, use as default value for
3836 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3841 A space-delimited list of jail names.
3842 When left empty, all of the
3844 instances defined in the configuration file are started.
3845 The names specified in this list control the jail startup order.
3847 instances missing from
3849 must be started manually.
3852 parameter in the configuration file may override this list.
3853 .It Va jail_reverse_stop
3857 all configured jails in
3859 are stopped in reverse order.
3860 .It Va jail_* variables
3861 Note that older releases supported per-jail configuration via
3865 hostname of a jail named
3867 was able to be set by
3868 .Li jail_vjail_hostname .
3869 These per-jail configuration variables are now obsolete in favor of
3872 For backward compatibility,
3873 when per-jail configuration variables are defined,
3875 configuration files are created as
3876 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3879 The following per-jail parameters are handled by
3881 script out of their corresponding
3884 In addition to them, parameters in
3885 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3886 will be added to the configuration file.
3887 They must be a semi-colon
3895 .Bl -tag -width "host.hostname" -offset indent
3898 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3899 .It Li host.hostname
3901 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3902 .It Li exec.consolelog
3904 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3905 The default value is
3906 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3909 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3910 .It Li vnet.interface
3912 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3915 parameter will be enabled and cannot be specified with
3916 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3917 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3919 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3923 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3926 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3929 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3932 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3933 The parameter name was
3935 in some older releases.
3936 .It Li exec.prestart
3938 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3939 .It Li exec.poststart
3941 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3944 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3947 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3948 .It Li exec.poststop
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3953 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3955 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3956 contain IPv4 addresses
3959 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3961 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3962 contain IPv6 addresses
3965 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3968 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3969 .It Li devfs_ruleset
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3972 This must be an integer,
3974 .It Li mount.fdescfs
3976 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3977 .It Li allow.set_hostname
3979 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3980 .It Li allow.rawsocket
3982 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3983 .It Li allow.sysvipc
3985 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3987 .\" -----------------------------------------------------
3991 representing the entropy sources
3992 you wish to harvest.
3995 for more information.
4000 to disable caching entropy via
4002 Otherwise set to the directory
4003 in which the entropy files are stored.
4007 that regularly writes and rotates
4010 will be used at boot time.
4012 .Pa /var/db/entropy .
4017 to disable caching entropy through reboots.
4018 Otherwise set to the name
4019 of a file used to store cached entropy.
4020 This file should be located
4021 on a file system that is readable
4022 before all the volumes specified in
4029 .Pa /var/db/entropy-file
4030 is found it will also be used.
4031 This will be of some use to
4033 .It Va entropy_boot_file
4038 very early caching entropy
4040 Otherwise set to the filename
4042 very early reboot cached entropy.
4043 This file should be located where
4048 The default location is
4050 .It Va entropy_save_sz
4052 Size of the entropy cache files saved by
4055 .It Va entropy_save_num
4057 Number of entropy cache files to save by
4071 Configuration file for
4080 .Pa /var/run/dmesg.boot
4082 .It Va rcshutdown_timeout
4084 If set, start a watchdog timer in the background which will terminate
4088 has not completed within the specified time (in seconds).
4089 Notice that in addition to this soft timeout,
4091 also applies a hard timeout for the execution of
4093 This is configured via
4096 .Va kern.init_shutdown_timeout
4097 and defaults to 120 seconds.
4098 Setting the value of
4099 .Va rcshutdown_timeout
4100 to more than 120 seconds will have no effect until the
4103 .Va kern.init_shutdown_timeout
4105 .It Va virecover_enable
4109 to prevent the system from trying to
4110 recover pre-maturely terminated
4113 .It Va ugidfw_enable
4118 .Xr mac_bsdextended 4
4119 module upon system initialization and load a default
4121 .It Va bsdextended_script
4124 .Xr mac_bsdextended 4
4125 ruleset file to load.
4126 The default value of this variable is
4127 .Pa /etc/rc.bsdextended .
4128 .It Va newsyslog_enable
4135 .It Va newsyslog_flags
4138 .Va newsyslog_enable
4141 these are the flags to pass to the
4146 which causes log files flagged with a
4149 .It Va mdconfig_md Ns Aq Ar X
4159 must be specified and either a
4161 for malloc or swap backed
4169 .Va mdconfig_md Ns Aq Ar X
4170 variables are evaluated until one variable is unset or null.
4171 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4173 Optional arguments passed to
4179 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4181 An ownership specification passed to
4190 device and the mount point will be changed.
4191 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4193 A mode string passed to
4202 device and the mount point will be changed.
4203 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4205 Files to be copied to the mount point of the
4209 after it has been mounted.
4210 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4212 Command to execute after the specified
4217 Note that the command is passed to
4223 variables can be used to reference respectively the
4225 device and the mount point.
4230 one could set the following:
4232 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4234 .It Va autobridge_interfaces
4236 Set to the list of bridge interfaces that will have newly arriving interfaces
4237 checked against to be automatically added.
4240 then for each whitespace separated
4243 .Va autobridge_ Ns Aq Ar element
4244 variable is assumed to exist which has a whitespace separated list of interface
4245 names to match, these names can use wildcards.
4248 autobridge_interfaces="bridge0"
4249 autobridge_bridge0="tap* dc0 vlan[345]"
4255 enable support for sound mixer.
4256 .It Va hcsecd_enable
4260 enable Bluetooth security daemon.
4261 .It Va hcsecd_config
4263 Configuration file for
4266 .Pa /etc/bluetooth/hcsecd.conf .
4271 enable Bluetooth Service Discovery Protocol daemon.
4279 .It Va sdpd_groupname
4283 group to run as after it initializes.
4286 .It Va sdpd_username
4290 user to run as after it initializes.
4293 .It Va bthidd_enable
4297 enable Bluetooth Human Interface Device daemon.
4298 .It Va bthidd_config
4300 Configuration file for
4303 .Pa /etc/bluetooth/bthidd.conf .
4306 Path to a file, where
4308 will store information about known HID devices.
4310 .Pa /var/db/bthidd.hids .
4311 .It Va rfcomm_pppd_server_enable
4315 enable Bluetooth RFCOMM PPP wrapper daemon.
4316 .It Va rfcomm_pppd_server_profile
4318 The name of the profile to use from
4319 .Pa /etc/ppp/ppp.conf .
4320 Multiple profiles can be specified here.
4321 Also used to specify per-profile overrides.
4322 When the profile name contains any of the characters
4324 they are translated to
4326 for the proposes of the override variable names.
4327 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4329 Overrides local address to listen on.
4335 The address can be specified as BD_ADDR or name.
4336 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4338 Overrides local RFCOMM channel to listen on.
4341 will listen on RFCOMM channel 1.
4342 Must set properly if multiple profiles used in the same time.
4343 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4347 if it should register Serial Port service on the specified RFCOMM channel.
4350 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4354 if it should register Dial-Up Networking service on the specified
4358 .It Va ubthidhci_enable
4362 change the USB Bluetooth controller from HID mode to HCI mode.
4363 You also need to specify the location of USB Bluetooth controller with the
4364 .Va ubthidhci_busnum
4368 .It Va ubthidhci_busnum
4369 Bus number where the USB Bluetooth controller is located.
4372 on your system to find this information.
4373 .It Va ubthidhci_addr
4374 Bus address of the USB Bluetooth controller.
4377 on your system to find this information.
4378 .It Va netwait_enable
4382 delays the start of network-reliant services until
4384 is up and ICMP packets to a destination defined in
4387 Link state is examined first, followed by
4389 an IP address to verify network usability.
4390 If no destination can be reached or timeouts are exceeded,
4391 network services are started anyway with no guarantee that
4392 the network is usable.
4393 Use of this variable requires both
4401 This variable contains a space-delimited list of IP addresses to
4403 DNS hostnames should not be used as resolution is not guaranteed
4404 to be functional at this point.
4405 If multiple IP addresses are specified,
4406 each will be tried until one is successful or the list is exhausted.
4407 .It Va netwait_timeout
4409 Indicates the total number of seconds to perform a
4411 against each IP address in
4413 at a rate of one ping per second.
4414 If any of the pings are successful,
4415 full network connectivity is considered reliable.
4420 Defines the name of the network interface on which watch for link.
4422 is used to monitor the interface, looking for
4423 .Dq Li status: no carrier .
4424 Once gone, the link is considered up.
4427 interface if desired.
4428 .It Va netwait_if_timeout
4430 Defines the total number of seconds to wait for link to become usable,
4431 polled at a 1-second interval.
4439 rules from the defined ruleset.
4440 The kernel must be built with
4443 .Cd "options RCTL" .
4449 This variables contains the
4455 A space-separated list of configuration files used by
4457 The default value is an empty string.
4458 .It Va autofs_enable
4468 daemons at boot time.
4469 .It Va automount_flags
4475 these are the flags to pass to the
4478 By default no flags are passed.
4479 .It Va automountd_flags
4485 these are the flags to pass to the
4488 By default no flags are passed.
4489 .It Va autounmountd_flags
4495 these are the flags to pass to the
4498 By default no flags are passed.
4505 daemon at boot time.
4506 .It Va iscsid_enable
4512 daemon at boot time.
4513 .It Va iscsictl_enable
4519 utility at boot time.
4520 .It Va iscsictl_flags
4526 these are the flags to pass to the
4531 which configures sessions based on the
4534 .It Va cfumass_enable
4538 create and export an USB LUN using
4543 The directory where the files exported by USB LUN are located.
4544 The default directory is
4546 .It Va service_delete_empty
4550 .Ql Li service delete
4556 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4557 .It Pa /etc/defaults/rc.conf
4559 .It Pa /etc/rc.conf.local
4589 .Xr newsyslog.conf 5 ,
4662 .An Jordan K. Hubbard .