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.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
74 .Ao Ar dir Ac Ns Pa /rc.conf.d
75 directories specified in
77 which will be included by the
80 For jail configurations you could use the file
81 .Pa /etc/rc.conf.d/jail
82 to store jail specific configuration options.
86 .Pa /usr/local/etc/rc.d
89 .Pa /usr/local/rc.conf.d/jail
91 .Pa /opt/conf/rc.conf.d/jail
94 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
96 all of files in the directory will be loaded.
102 .Dq Ar name Ns Li = Ns Ar value
106 The following list provides a name and short description for each
107 variable that can be set in the
110 .Bl -tag -width indent-two
115 enable output of debug messages from rc scripts.
116 This variable can be helpful in diagnosing mistakes when
117 editing or integrating new scripts.
118 Beware that this produces copious output to the terminal and
124 disable informational messages from the rc scripts.
125 Informational messages are displayed when
126 a condition that is not serious enough to warrant a warning or
134 when faststart is used (e.g., at boot time).
135 .It Va early_late_divider
137 The name of the script that should be used as the
138 delimiter between the
142 stages of the boot process.
143 The early stage should contain all the services needed to
144 get the disks (local or remote) mounted so that the late
145 stage can include scripts contained in the directories
148 variable (see below).
149 Thus, the two likely candidates for this value are
151 for the typical system, and
153 if the system needs remote file
154 systems mounted to get access to the
156 directories; for example when
164 is likely to be an appropriate value.
165 Extreme care should be taken when changing this value,
166 and before changing it one should ensure that there are
167 adequate provisions to recover from a failed boot
168 (such as physical contact with the machine,
169 or reliable remote console access).
170 .It Va always_force_depends
174 scripts use the force_depend function to check whether required
175 services are already running, and to start them if necessary.
176 By default during boot time this check is bypassed if the
177 required service is enabled in
178 .Pa /etc/rc.conf[.local] .
179 Setting this option will bypass that check at boot time and
180 always test whether or not the service is actually running.
181 Enabling this option is likely to increase your boot time if
182 services are enabled that utilize the force_depend check.
183 .It Ao Ar name Ac Ns Va _chroot
186 to this directory before running the service.
187 .It Ao Ar name Ac Ns Va _user
189 Run the service under this user account.
190 .It Ao Ar name Ac Ns Va _group
192 Run the chrooted service under this system group.
194 setting, this setting has no effect if the service is not chrooted.
195 .It Ao Ar name Ac Ns Va _fib
199 value to run the service under.
200 .It Ao Ar name Ac Ns Va _nice
204 value to run the service under.
209 enable support for Automatic Power Management with
217 to handle APM event from userland.
218 This also enables support for APM.
225 these are the flags to pass to the
232 to handle device added, removed or unknown events from the kernel.
239 scripts at boot time.
242 Configuration file for
248 A list of kernel modules to load right after the local
250 Loading modules at this point in the boot process is
251 much faster than doing it via
252 .Pa /boot/loader.conf
253 for those modules not necessary for mounting local disk.
254 .It Va kldxref_enable
261 to automatically rebuild
266 .It Va kldxref_clobber
276 will overwrite existing
283 .It Va kldxref_module_path
288 delimited list of paths containing
300 enable the system power control facility with the
309 these are the flags to pass to the
313 Controls the creation of a
316 Always happens if set to
318 and never happens if set to
320 If set to anything else, a memory file system is created if
324 Controls the size of a created
328 Extra options passed to the
330 utility when the memory file system for
335 which inhibits the use of softupdates on
337 so that file system space is freed without delay
338 after file truncation or deletion.
341 for other options you can use in
344 Controls the creation of a
347 Always happens if set to
349 and never happens if set to
351 If set to anything else, a memory file system is created if
355 Controls the size of a created
359 Extra options passed to the
361 utility when the memory file system for
366 which inhibits the use of softupdates on
368 so that file system space is freed without delay
369 after file truncation or deletion.
372 for other options you can use in
375 Controls the automatic population of the
378 Always happens if set to
380 and never happens if set to
382 If set to anything else, a memory file system is created if
385 Note that this process requires access to certain commands in
389 is mounted on normal systems.
390 .It Va cleanvar_enable
397 List of directories to search for startup script files.
398 .It Va script_name_sep
400 The field separator to use for breaking down the list of startup script files
401 into individual filenames.
402 The default is a space.
403 It is not necessary to change this unless there are startup scripts with names
405 .It Va hostapd_enable
414 The fully qualified domain name (FQDN) of this host on the network.
415 This should almost certainly be set to something meaningful, even if
416 there is no network connection.
419 is used to set the hostname via DHCP,
420 this variable should be set to an empty string.
421 If this value remains unset when the system is done booting
422 your console login will display the default hostname of
426 The NIS domain name of this host, or
429 .It Va dhclient_program
431 Path to the DHCP client program
432 .Pa ( /sbin/dhclient ,
437 .It Va dhclient_flags
439 Additional flags to pass to the DHCP client program.
444 manpage for a description of the command line options available.
445 .It Va dhclient_flags_ Ns Aq Ar iface
446 Additional flags to pass to the DHCP client program running on
449 When specified, this variable overrides
451 .It Va background_dhclient
455 to start the DHCP client in background.
456 This can cause trouble with applications depending on
457 a working network, but it will provide a faster startup
459 .It Va background_dhclient_ Ns Aq Ar iface
460 When specified, this variable overrides the
461 .Va background_dhclient
462 variable for interface
465 .It Va synchronous_dhclient
471 synchronously at startup.
472 This behavior can be overridden on a per-interface basis by replacing
476 .Va ifconfig_ Ns Aq Ar interface
481 .It Va defaultroute_delay
483 When set to a positive value, wait up to this long after configuring
484 DHCP interfaces at startup to give the interfaces time to receive a lease.
485 .It Va firewall_enable
489 to load firewall rules at startup.
490 If the kernel was not built with
491 .Cd "options IPFIREWALL" ,
494 kernel module will be loaded.
496 .Va ipfilter_enable .
497 .It Va firewall_script
499 This variable specifies the full path to the firewall script to run.
501 .Pa /etc/rc.firewall .
504 Names the firewall type from the selection in
505 .Pa /etc/rc.firewall ,
506 or the file which contains the local firewall ruleset.
507 Valid selections from
511 .Bl -tag -width ".Li simple" -compact
513 unrestricted IP access
515 all IP services disabled, except via
518 basic protection for a workstation
520 basic protection for a LAN.
523 If a filename is specified, the full path
525 .It Va firewall_quiet
529 to disable the display of firewall rules on the console during boot.
530 .It Va firewall_logging
534 to enable firewall event logging.
535 This is equivalent to the
536 .Dv IPFIREWALL_VERBOSE
538 .It Va firewall_logif
542 to create pseudo interface
545 For more details, see
548 .It Va firewall_flags
554 specifies a filename.
555 .It Va firewall_coscripts
557 List of executables and/or rc scripts to run after firewall starts/stops.
559 .\" ----- firewall_nat_enable setting --------------------------------
560 .It Va firewall_nat_enable
572 .It Va firewall_nat_interface
578 This is the name of the public interface or IP address on which
579 kernel NAT should run.
580 .It Va firewall_nat_flags
582 Additional configuration parameters for kernel NAT should be placed here.
583 .It Va dummynet_enable
587 will automatically load the
593 .\" -------------------------------------------------------------------
609 sockets must be enabled in the kernel.
610 If the kernel was not built with
611 .Cd "options IPDIVERT" ,
614 kernel module will be loaded.
615 .It Va natd_interface
617 This is the name of the public interface on which
620 The interface may be given as an interface name or as an IP address.
625 flags should be placed here.
630 flag is automatically added with the above
633 .\" ----- ipfilter_enable setting --------------------------------
634 .It Va ipfilter_enable
645 Typical usage will require putting
647 ipfilter_enable="YES"
665 can be enabled independently.
669 both require at least one of
679 options IPFILTER_DEFAULT_BLOCK
682 in the kernel configuration file is a good idea, too.
683 .\" ----- ipfilter_program setting ------------------------------
684 .It Va ipfilter_program
690 .\" ----- ipfilter_rules setting --------------------------------
691 .It Va ipfilter_rules
696 This variable contains the name of the filter rule definition file.
697 The file is expected to be readable for the
700 .\" ----- ipv6_ipfilter_rules setting ---------------------------
701 .It Va ipv6_ipfilter_rules
706 This variable contains the IPv6 filter rule definition file.
707 The file is expected to be readable for the
710 .\" ----- ipfilter_flags setting --------------------------------
711 .It Va ipfilter_flags
714 This variable contains flags passed to the
717 .\" ----- ipnat_enable setting ----------------------------------
727 network address translation.
730 for a detailed discussion.
731 .\" ----- ipnat_program setting ---------------------------------
738 .\" ----- ipnat_rules setting -----------------------------------
744 This variable contains the name of the file
745 holding the network address translation definition.
746 This file is expected to be readable for the
749 .\" ----- ipnat_flags setting -----------------------------------
753 This variable contains flags passed to the
756 .\" ----- ipmon_enable setting ----------------------------------
771 Setting this variable needs setting
778 for a detailed discussion.
779 .\" ----- ipmon_program setting ---------------------------------
786 .\" ----- ipmon_flags setting -----------------------------------
792 This variable contains flags passed to the
795 Another typical example would be
796 .Dq Fl D Pa /var/log/ipflog
799 log directly to a file bypassing
802 .Pa /etc/newsyslog.conf
803 in such case like this:
805 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
807 .\" ----- ipfs_enable setting -----------------------------------
817 saving the filter and NAT state tables during shutdown
818 and reloading them during startup again.
819 Setting this variable needs setting
828 for a detailed discussion.
834 because the raised securelevel will prevent
836 from saving the state tables at shutdown time.
837 .\" ----- ipfs_program setting ----------------------------------
844 .\" ----- ipfs_flags setting ------------------------------------
848 This variable contains flags passed to the
851 .\" ----- end of added ipf hook ---------------------------------
863 Typical usage will require putting
878 into the kernel, otherwise the
879 kernel module will be loaded.
884 ruleset configuration file
899 these flags are passed to the
901 program when loading the ruleset.
911 which logs packets from the
924 .Pa /var/log/pflog ) .
926 .Pa /etc/newsyslog.conf
927 to adjust logfile rotation for this.
937 This variable contains additional flags passed to the
940 .It Va pflog_instances
942 If logging to more than one
944 interface is desired,
946 is set to the list of
948 instances that should be started at system boot time.
951 is set, for each whitespace-seperated
954 .Ao Ar element Ac Ns Va _dev
956 .Ao Ar element Ac Ns Va _logfile
957 elements are assumed to exist.
958 .Ao Ar element Ac Ns Va _dev
961 interface to be watched by the named
964 .Ao Ar element Ac Ns Va _logfile
965 must contain the name of the logfile that will be used by the
968 .It Va ftpproxy_enable
979 packet filter in translating ftp connections.
980 .It Va ftpproxy_flags
983 This variable contains additional flags passed to the
986 .It Va ftpproxy_instances
989 If multiple instances of
991 are desired at boot time,
992 .Va ftpproxy_instances
993 should contain a whitespace-seperated list of instance names.
996 in the list, a variable named
997 .Ao Ar element Ac Ns Va _flags
998 should be defined, containing the command-line flags to be passed to the
1001 .It Va pfsync_enable
1010 state changes to other hosts over the network by means of
1015 must also be set then.
1016 .It Va pfsync_syncdev
1019 This variable specifies the name of the network interface
1021 should operate through.
1022 It must be set accordingly if
1026 .It Va pfsync_syncpeer
1029 This variable is optional.
1030 By default, state change messages are sent out on the synchronisation
1031 interface using IP multicast packets.
1032 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1034 When a peer address is specified using the
1036 option, the peer address is used as a destination for the pfsync
1037 traffic, and the traffic can then be protected using
1041 manpage for more details about using
1046 .It Va pfsync_ifconfig
1049 This variable can contain additional options to be passed to the
1051 command used to set up
1053 .It Va tcp_extensions
1060 disables certain TCP options as described by
1066 might help remedy such problems with connections as randomly hanging
1067 or other weird behavior.
1068 Some network devices are known
1069 to be broken with respect to these options.
1072 Set to 0 by default.
1076 .Va net.inet.tcp.log_in_vain
1078 .Va net.inet.udp.log_in_vain ,
1083 are set to the given value.
1084 .It Va tcp_keepalive
1091 will disable probing idle TCP connections to verify that the
1092 peer is still up and reachable.
1093 .It Va tcp_drop_synfin
1100 will cause the kernel to ignore TCP frames that have both
1101 the SYN and FIN flags set.
1102 This prevents OS fingerprinting, but may
1103 break some legitimate applications.
1104 .It Va icmp_drop_redirect
1111 will cause the kernel to ignore ICMP REDIRECT packets.
1114 for more information.
1115 .It Va icmp_log_redirect
1122 will cause the kernel to log ICMP REDIRECT packets.
1124 the log messages are not rate-limited, so this option should only be used
1125 for troubleshooting networks.
1128 for more information.
1129 .It Va icmp_bmcastecho
1133 to respond to broadcast or multicast ICMP ping packets.
1136 for more information.
1137 .It Va ip_portrange_first
1141 this is the first port in the default portrange.
1144 for more information.
1145 .It Va ip_portrange_last
1149 this is the last port in the default portrange.
1152 for more information.
1153 .It Va network_interfaces
1155 Set to the list of network interfaces to configure on this host or
1157 (the default) for all current interfaces.
1159 .Va network_interfaces
1160 variable to anything other than the default is deprecated.
1161 Interfaces that the administrator wishes to store configuration for,
1162 but not start at boot should be configured with the
1165 .Va ifconfig_ Ns Aq Ar interface
1166 variables as described below.
1169 .Va ifconfig_ Ns Aq Ar interface
1170 variable is also assumed to exist for each value of
1172 When an interface name contains any of the characters
1174 they are translated to
1177 The variable can contain arguments to
1179 as well as special case-insensitive keywords described below.
1180 Such keywords are removed before passing the value to
1182 while the order of the other arguments is preserved.
1184 It is possible to add IP alias entries using
1186 syntax with the address family keyword such as
1188 Assuming that the interface in question was
1190 it might look something like this:
1192 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1193 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1196 It also possible to configure multiple IP addresses in Classless
1197 Inter-Domain Routing
1200 whose each address component can be a range like
1201 .Li inet 192.0.2.5-23/24
1203 .Li inet6 2001:db8:1-f::1/64 .
1204 This notation allows address and prefix length part only,
1205 not the other address modifiers.
1206 Note that the maximum number of the generated addresses from a range
1207 specification is limited to an integer value specified in
1208 .Va netif_ipexpand_max
1211 because a small typo can unexpectedly generate a large number of addresses.
1212 The default value is
1214 It can be increased by adding the following line into
1217 netif_ipexpand_max="4096"
1221 .Li 192.0.2.5-23/24 ,
1222 the address 192.0.2.5 will be configured with the
1223 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1224 the non-conflicting netmask /32 as explained in the
1227 Note that this special netmask handling is only for
1229 not for the other address families such as
1232 With the interface in question being
1234 an example could look like:
1236 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1237 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1243 .Va ipv4_addrs_ Ns Aq Ar interface
1244 variable was supported for IPv4 CIDR address notation.
1245 It is now deprecated because the functionality was integrated into
1246 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1248 .Va ipv4_addrs_ Ns Aq Ar interface
1249 is still supported for backward compatibility.
1252 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1253 entry with an address family keyword,
1254 its contents are passed to
1256 Execution stops at the first unsuccessful access, so if
1257 something like this is present:
1259 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1260 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1261 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1262 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1265 Then note that alias4 would
1267 be added since the search would
1268 stop with the missing
1271 Because of this difficult to manage behavior,
1273 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1274 variable, which has the same functionality as
1275 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1276 and can have all of entries in a variable like the following:
1278 ifconfig_ed0_aliases="\\
1279 inet 127.0.0.251 netmask 0xffffffff \\
1280 inet 127.0.0.252 netmask 0xffffffff \\
1281 inet 127.0.0.253 netmask 0xffffffff \\
1282 inet 127.0.0.254 netmask 0xffffffff"
1285 It also supports CIDR notation.
1288 .Pa /etc/start_if. Ns Aq Ar interface
1289 file is present, it is read and executed by the
1292 before configuring the interface as specified in the
1293 .Va ifconfig_ Ns Aq Ar interface
1295 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1299 .Va vlans_ Ns Aq Ar interface
1303 interface will be created for each item in the list with the
1307 If a vlan interface's name is a number,
1308 then that number is used as the vlan tag and the new vlan interface is
1310 .Ar interface . Ns Ar tag .
1312 the vlan tag must be specified via a
1315 .Va create_args_ Ns Aq Ar interface
1318 To create a vlan device named
1322 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1325 ifconfig_em0_101="inet 192.0.2.1/24"
1328 To create a vlan device named
1332 with the vlan tag 102:
1335 create_args_myvlan="vlan 102"
1339 .Va wlans_ Ns Aq Ar interface
1343 interface will be created for each item in the list with the
1347 Further wlan cloning arguments may be passed to the
1350 command by setting the
1351 .Va create_args_ Ns Aq Ar interface
1355 devices must be created for each wireless devices as of
1361 may be specified with an
1362 .Va wlandebug_ Ns Aq Ar interface
1364 The contents of this variable will be passed directly to
1368 .Va ifconfig_ Ns Aq Ar interface
1369 contains the keyword
1371 then the interface will not be configured
1373 .Pa /etc/pccard_ether
1375 .Va network_interfaces
1379 It is possible to bring up an interface with DHCP by adding
1382 .Va ifconfig_ Ns Aq Ar interface
1384 For instance, to initialize the
1387 it is possible to use something like:
1392 If you want to configure your wireless interface with
1393 .Xr wpa_supplicant 8
1394 for use with WPA, EAP/LEAP or WEP, you need to add
1397 .Va ifconfig_ Ns Aq Ar interface
1400 On the other hand, if you want to configure your wireless interface with
1405 .Va ifconfig_ Ns Aq Ar interface
1408 will use the settings from
1409 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1411 Finally, you can add
1413 options in this variable, in addition to the
1414 .Pa /etc/start_if. Ns Aq Ar interface
1416 For instance, to configure an
1418 wireless device in station mode with an address obtained
1419 via DHCP, using WPA authentication and 802.11b mode, it is
1420 possible to use something like:
1423 ifconfig_wlan0="DHCP WPA mode 11b"
1427 .Va ifconfig_ Ns Aq Ar interface
1428 form, a fallback variable
1429 .Va ifconfig_DEFAULT
1431 It will be used for all interfaces with no
1432 .Va ifconfig_ Ns Aq Ar interface
1434 This is intended to replace the no longer supported
1438 It is also possible to rename an interface by doing:
1440 ifconfig_ed0_name="net0"
1441 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1445 This variable is deprecated.
1447 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1449 .Va ipv6_activate_all_interfaces
1454 .Dq Li inet6 accept_rtadv
1456 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1458 .Va ipv6_activate_all_interfaces
1463 This variable is deprecated.
1465 .Va ip6addrctl_policy
1470 the default address selection policy table set by
1472 will be IPv6-preferred.
1476 the default address selection policy table set by
1478 will be IPv4-preferred.
1479 .It Va ipv6_activate_all_interfaces
1481 This controls initial configuration on IPv6-capable
1482 interfaces with no corresponding
1483 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1485 Note that it is not always necessary to set this variable to
1487 to use IPv6 functionality on
1489 In most cases, just configuring
1490 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1495 all interfaces which do not have a corresponding
1496 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1497 variable will be marked as
1500 This means that all of IPv6 functionality on that interface
1501 is completely disabled to enforce a security policy.
1502 If the variable is set to
1504 the flag will be cleared on all of the interfaces.
1506 In most cases, just defining an
1507 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1508 for an IPv6-capable interface should be sufficient.
1509 However, if an interface is added dynamically
1510 .Pq by some tunneling protocols such as PPP, for example ,
1511 it is often difficult to define the variable in advance.
1512 In such a case, configuring the
1514 flag can be disabled by setting this variable to
1517 For more details of the
1520 .Dq Li inet6 ifdisabled ,
1530 privacy addresses will be generated for each IPv6
1531 interface as described in RFC 4941.
1532 .It Va ipv6_network_interfaces
1534 This is the IPv6 equivalent of
1535 .Va network_interfaces .
1536 Normally manual configuration of this variable is not needed.
1537 .It Va ipv6_cpe_wanif
1539 If the variable is set to an interface name,
1543 .Dq inet6 -no_radr accept_rtadv
1544 will be added to the specified interface automatically before evaluating
1545 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1549 .Va net.inet6.ip6.rfc6204w3
1551 .Va net.inet6.ip6.no_radr
1554 This means the specified interface will accept ICMPv6 Router
1555 Advertisement messages on that link and add the discovered
1556 routers into the Default Router List.
1557 While the other interfaces can still accept RA messages if the
1558 .Dq inet6 accept_rtadv
1559 option is specified, adding
1560 routes into the Default Router List will be disabled by
1567 Note that ICMPv6 Router Advertisement messages will be
1569 .Va net.inet6.ip6.forwarding
1571 .Pq packet forwarding is enabled
1573 .Va net.inet6.ip6.rfc6204w3
1578 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1580 IPv6 functionality on an interface should be configured by
1581 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1582 instead of setting ifconfig parameters in
1583 .Va ifconfig_ Ns Aq Ar interface .
1584 If this variable is empty, all of IPv6 configurations on the
1585 specified interface by other variables such as
1586 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1589 Aliases should be set by
1590 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1596 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1597 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1600 Interfaces that have an
1601 .Dq Li inet6 accept_rtadv
1603 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1604 setting will be automatically configured by SLAAC
1605 .Pq StateLess Address AutoConfiguration
1611 Note that a link-local address will be automatically configured in
1612 addition to the configured global-scope addresses because the IPv6
1613 specifications require it on each link.
1614 The address is calculated from the MAC address by using an algorithm
1621 If only a link-local address is needed on the interface,
1622 the following configuration can be used:
1624 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1627 A link-local address can also be configured manually.
1628 This is useful for the default router address of an IPv6 router
1629 so that it does not change when the network interface
1633 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1635 .It Va ipv6_prefix_ Ns Aq Ar interface
1637 If one or more prefixes are defined in
1638 .Va ipv6_prefix_ Ns Aq Ar interface
1639 addresses based on each prefix and the EUI-64 interface index will be
1640 configured on that interface.
1641 Note that this variable will be ignored when
1642 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1645 For example, the following configuration
1647 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1650 is equivalent to the following:
1652 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1653 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1654 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1655 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1658 These Subnet-Router anycast addresses will be added only when
1659 .Va ipv6_gateway_enable
1661 .It Va ipv6_default_interface
1665 this is the default output interface for scoped addresses.
1666 This works only with ipv6_gateway_enable="NO".
1667 .It Va ip6addrctl_enable
1669 This variable is to enable configuring default address selection policy table
1671 The table can be specified in another variable
1672 .Va ip6addrctl_policy .
1674 .Va ip6addrctl_policy
1675 the following keywords can be specified:
1676 .Dq Li ipv4_prefer ,
1677 .Dq Li ipv6_prefer ,
1687 installs a pre-defined policy table described in Section 2.1
1695 is specified, it attempts to read a file
1696 .Pa /etc/ip6addrctl.conf
1698 If this file is found,
1700 reads and installs it.
1701 If not found, a policy is automatically set
1703 .Va ipv6_activate_all_interfaces
1704 variable; if the variable is set to
1706 the IPv6-preferred one is used.
1707 Otherwise IPv4-preferred.
1709 The default value of
1710 .Va ip6addrctl_enable
1712 .Va ip6addrctl_policy
1718 .It Va cloned_interfaces
1720 Set to the list of clonable network interfaces to create on this host.
1721 Further cloning arguments may be passed to the
1724 command for each interface by setting the
1725 .Va create_args_ Ns Aq Ar interface
1727 If an interface name is specified with
1730 the interface will not be destroyed even when
1732 script is invoked with
1735 This is useful when reconfiguring the interface without destroying it.
1737 .Va cloned_interfaces
1738 are automatically appended to
1739 .Va network_interfaces
1741 .It Va cloned_interfaces_sticky
1743 This variable is to globally enable functionality of
1746 .Va cloned_interfaces
1748 The default value is
1750 Even if this variable is specified to
1753 keyword can be used to override it on per interface basis.
1754 .It Va gif_interfaces
1756 This variable is deprecated in favor of
1757 .Va cloned_interfaces .
1760 tunnel interfaces to configure on this host.
1762 .Va gifconfig_ Ns Aq Ar interface
1763 variable is assumed to exist for each value of
1765 The value of this variable is used to configure the link layer of the
1766 tunnel according to the syntax of the
1770 Additionally, this option ensures that each listed interface is created
1775 before attempting to configure it.
1776 .It Va sppp_interfaces
1780 interfaces to configure on this host.
1782 .Va spppconfig_ Ns Aq Ar interface
1783 variable is assumed to exist for each value of
1785 Each interface should also be configured by a general
1786 .Va ifconfig_ Ns Aq Ar interface
1790 for more information about available options.
1800 The name of the profile to use from
1801 .Pa /etc/ppp/ppp.conf .
1802 Also used for per-profile overrides of
1807 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1808 When the profile name contains any of the characters
1810 they are translated to
1812 for the proposes of the override variable names.
1815 Mode in which to run the
1818 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1820 Overrides the global
1830 See the manual for a full description.
1835 enables network address translation.
1836 Used in conjunction with
1838 allows hosts on private network addresses access to the Internet using
1839 this host as a network address translating router.
1840 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1842 Overrides the global
1846 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1848 Set the unit number to be used for this profile.
1849 See the manual description of
1854 The name of the user under which
1862 .It Va rc_conf_files
1864 This option is used to specify a list of files that will override
1866 .Pa /etc/defaults/rc.conf .
1867 The files will be read in the order in which they are specified and should
1868 include the full path to the file.
1869 By default, the files specified are
1872 .Pa /etc/rc.conf.local
1878 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1880 .It Va gptboot_enable
1884 .Pa /etc/rc.d/gptboot
1885 will log if the system successfully (or not) booted from a GPT partition,
1891 .It Va gbde_autoattach_all
1896 will attempt to automatically initialize your .bde devices in
1900 List the devices that the script should try to attach,
1905 The directory where the
1907 lockfiles are located.
1908 The default lockfile directory is
1911 The lockfile for each individual
1913 device can be overridden by setting the variable
1914 .Va gbde_lock_ Ns Aq Ar device ,
1917 is the encrypted device without the
1922 .It Va gbde_attach_attempts
1924 Number of times to attempt attaching to a
1926 device, i.e., how many times the user is asked for the pass-phrase.
1930 List of devices to automatically attach on boot.
1931 Note that .eli devices from
1933 are automatically appended to this list.
1936 Number of times user is asked for the pass-phrase.
1937 If empty, it will be taken from
1938 .Va kern.geom.eli.tries
1940 .It Va geli_default_flags
1942 Default flags to use by
1944 when configuring disk encryption.
1945 Flags can be configured for every device separately by defining
1946 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1948 .It Va geli_autodetach
1950 Specifies if GELI devices should be marked for detach on last close after
1951 file systems are mounted.
1954 This can be changed for every device separately by defining
1955 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1957 .It Va root_rw_mount
1962 After the file systems are checked at boot time, the root file system
1963 is remounted as read-write if this is set to
1965 Diskless systems that mount their root file system from a read-only remote
1966 NFS share should set this to
1970 .It Va fsck_y_enable
1975 will be run with the
1977 flag if the initial preen
1978 of the file systems fails.
1979 .It Va background_fsck
1983 the system will attempt to run
1985 in the background where possible.
1986 .It Va background_fsck_delay
1988 The amount of time in seconds to sleep before starting a background
1990 It defaults to sixty seconds to allow large applications such as
1991 the X server to start before disk I/O bandwidth is monopolized by
1993 If set to a negative number, the background file system check will be
1994 delayed indefinitely to allow the administrator to run it at a more
1996 For example it may be run from
1998 by adding a line like
2000 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2006 List of file system types that are network-based.
2007 This list should generally not be modified by end users.
2009 .Va extra_netfs_types
2011 .It Va extra_netfs_types
2013 If set to something other than
2016 this variable extends the list of file system types
2017 for which automatic mounting at startup by
2019 should be delayed until the network is initialized.
2021 a whitespace-separated list of network file system descriptor pairs,
2022 each consisting of a file system type as passed to
2024 and a human-readable, one-word description,
2027 Extending the default list in this way is only necessary
2028 when third party file system types are used.
2029 .It Va syslogd_enable
2036 .It Va syslogd_program
2041 .Pa /usr/sbin/syslogd ) .
2042 .It Va syslogd_flags
2048 these are the flags to pass to
2057 .It Va inetd_program
2062 .Pa /usr/sbin/inetd ) .
2069 these are the flags to pass to
2078 .It Va hastd_program
2090 these are the flags to pass to
2092 .It Va local_unbound_enable
2098 daemon as a local caching resolver.
2103 to start a Kerberos 5 authentication server
2111 this is the path to Kerberos 5 Authentication Server.
2115 This variable contains additional flags to be passed to the Kerberos 5
2116 authentication server.
2117 .It Va kadmind_enable
2123 the Kerberos 5 Administration Daemon; set to
2126 .It Va kadmind_program
2132 this is the path to Kerberos 5 Administration Daemon.
2133 .It Va kpasswdd_enable
2139 the Kerberos 5 Password-Changing Daemon; set to
2142 .It Va kpasswdd_program
2148 this is the path to Kerberos 5 Password-Changing Daemon.
2155 the Kerberos 5 ticket forwarding daemon, at the boot time.
2161 .Pa /usr/libexec/kfd ) .
2168 daemon at boot time.
2175 these are the flags to pass to it.
2182 daemon at boot time.
2189 these are the flags to pass to it.
2192 manpage for more information.
2193 .It Va amd_map_program
2196 the specified program is run to get the list of
2201 maps are stored in NIS, one can set this to
2214 will be updated at boot time to reflect the kernel release
2219 will not be updated.
2220 .It Va nfs_client_enable
2224 run the NFS client daemons at boot time.
2225 .It Va nfs_access_cache
2228 .Va nfs_client_enable
2233 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2235 results should be cached.
2236 A value of 2-10 seconds will substantially reduce network
2237 traffic for many NFS operations.
2238 .It Va nfs_server_enable
2242 run the NFS server daemons at boot time.
2243 .It Va nfs_server_flags
2246 .Va nfs_server_enable
2249 these are the flags to pass to the
2252 .It Va nfsv4_server_enable
2255 .Va nfs_server_enable
2259 .Va nfsv4_server_enable
2262 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2263 .It Va nfsuserd_enable
2269 run the nfsuserd daemon, which is needed for NFSv4 in order
2270 to map between user/group names vs uid/gid numbers.
2272 .Va nfsv4_server_enable
2275 this will be forced enabled.
2276 .It Va nfsuserd_flags
2282 these are the flags to pass to the
2285 .It Va nfscbd_enable
2291 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2298 these are the flags to pass to the
2301 .It Va mountd_enable
2306 .Va nfs_server_enable
2312 It is commonly needed to run CFS without real NFS used.
2319 these are the flags to pass to the
2322 .It Va weak_mountd_authentication
2326 allow services like PCNFSD to make non-privileged mount
2328 .It Va nfs_reserved_port_only
2332 provide NFS services only on a secure port.
2333 .It Va nfs_bufpackets
2335 If set to a number, indicates the number of packets worth of
2336 socket buffer space to reserve on an NFS client.
2337 The kernel default is typically 4.
2338 Using a higher number may be
2339 useful on gigabit networks to improve performance.
2340 The minimum value is
2341 2 and the maximum is 64.
2342 .It Va rpc_lockd_enable
2346 and also an NFS server or client, run
2349 .It Va rpc_lockd_flags
2352 .Va rpc_lockd_enable
2355 these are the flags to pass to the
2358 .It Va rpc_statd_enable
2362 and also an NFS server or client, run
2365 .It Va rpc_statd_flags
2368 .Va rpc_statd_enable
2371 these are the flags to pass to the
2374 .It Va rpcbind_program
2379 .Pa /usr/sbin/rpcbind ) .
2380 .It Va rpcbind_enable
2386 service at boot time.
2387 .It Va rpcbind_flags
2393 these are the flags to pass to the
2396 .It Va keyserv_enable
2402 daemon on boot for running Secure RPC.
2403 .It Va keyserv_flags
2409 these are the flags to pass to
2412 .It Va pppoed_enable
2418 daemon at boot time to provide PPP over Ethernet services.
2419 .It Va pppoed_ Ns Aq Ar provider
2422 listens to requests to this
2428 argument of the same name.
2431 Additional flags to pass to
2433 .It Va pppoed_interface
2435 The network interface to run
2438 This is mandatory when
2448 service at boot time.
2449 This command is intended for networks of
2450 machines where a consistent
2452 for all hosts must be established.
2453 This is often useful in large NFS
2454 environments where time stamps on files are expected to be consistent
2462 these are the flags to pass to the
2465 .It Va ntpdate_enable
2472 This command is intended to
2473 synchronize the system clock only
2475 from some standard reference.
2476 .It Va ntpdate_config
2478 Configuration file for
2482 .It Va ntpdate_hosts
2484 A whitespace-separated list of NTP servers to synchronize with at startup.
2485 The default is to use the servers listed in
2486 .Va ntpdate_config ,
2487 if that file exists.
2488 .It Va ntpdate_program
2493 .Pa /usr/sbin/ntpdate ) .
2494 .It Va ntpdate_flags
2500 these are the flags to pass to the
2502 command (typically a hostname).
2509 command at boot time.
2515 .Pa /usr/sbin/ntpd ) .
2529 these are the flags to pass to the
2532 .It Va ntpd_sync_on_start
2539 flag, which syncs the system's clock on startup.
2542 for more information regarding the
2545 This is a preferred alternative to using
2550 .It Va nis_client_enable
2556 service at system boot time.
2557 .It Va nis_client_flags
2560 .Va nis_client_enable
2563 these are the flags to pass to the
2566 .It Va nis_ypldap_enable
2572 daemon at system boot time.
2573 .It Va nis_ypldap_flags
2576 .Va nis.ypldap_enable
2579 these are the flags to pass to the
2582 .It Va nis_ypset_enable
2588 daemon at system boot time.
2589 .It Va nis_ypset_flags
2592 .Va nis_ypset_enable
2595 these are the flags to pass to the
2598 .It Va nis_server_enable
2604 daemon at system boot time.
2605 .It Va nis_server_flags
2608 .Va nis_server_enable
2611 these are the flags to pass to the
2614 .It Va nis_ypxfrd_enable
2620 daemon at system boot time.
2621 .It Va nis_ypxfrd_flags
2624 .Va nis_ypxfrd_enable
2627 these are the flags to pass to the
2630 .It Va nis_yppasswdd_enable
2636 daemon at system boot time.
2637 .It Va nis_yppasswdd_flags
2640 .Va nis_yppasswdd_enable
2643 these are the flags to pass to the
2646 .It Va rpc_ypupdated_enable
2652 daemon at system boot time.
2653 .It Va bsnmpd_enable
2659 daemon at system boot time.
2660 Be sure to understand the security implications of running SNMP daemon
2668 these are the flags to pass to the
2671 .It Va defaultrouter
2675 create a default route to this host name or IP address
2676 (use an IP address if this router is also required to get to the
2678 .It Va ipv6_defaultrouter
2680 The IPv6 equivalent of
2682 .It Va static_arp_pairs
2684 Set to the list of static ARP pairs that are to be added at system
2686 For each whitespace separated
2689 .Va static_arp_ Ns Aq Ar element
2690 variable is assumed to exist whose contents will later be passed to a
2695 static_arp_pairs="gw"
2696 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2698 .It Va static_ndp_pairs
2700 Set to the list of static NDP pairs that are to be added at system
2702 For each whitespace separated
2705 .Va static_ndp_ Ns Aq Ar element
2706 variable is assumed to exist whose contents will later be passed to a
2711 static_ndp_pairs="gw"
2712 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2714 .It Va static_routes
2716 Set to the list of static routes that are to be added at system
2720 then for each whitespace separated
2723 .Va route_ Ns Aq Ar element
2724 variable is assumed to exist
2725 whose contents will later be passed to a
2730 static_routes="ext mcast:gif0 gif0local:gif0"
2731 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2732 route_mcast="-net 224.0.0.0/4 -iface gif0"
2733 route_gif0local="-host 169.254.1.1 -iface lo0"
2740 the route is specific to the interface
2742 .It Va ipv6_static_routes
2744 The IPv6 equivalent of
2748 then for each whitespace separated
2751 .Va ipv6_route_ Ns Aq Ar element
2752 variable is assumed to exist
2753 whose contents will later be passed to a
2754 .Dq Nm route Cm add Fl inet6
2756 .It Va natm_static_routes
2762 If not empty then for each whitespace separated
2765 .Va route_ Ns Aq Ar element
2766 variable is assumed to exist whose contents will later be passed to a
2767 .Dq Nm atmconfig Cm natm Cm add
2769 .It Va gateway_enable
2773 configure host to act as an IP router, e.g.\& to forward packets
2775 .It Va ipv6_gateway_enable
2777 The IPv6 equivalent of
2778 .Va gateway_enable .
2779 .It Va routed_enable
2783 run a routing daemon of some sort, based on the
2788 .It Va route6d_enable
2790 The IPv6 equivalent of
2794 run a routing daemon of some sort, based on the
2799 .It Va routed_program
2805 this is the name of the routing daemon to use.
2806 .It Va route6d_program
2808 The IPv6 equivalent of
2809 .Va routed_program .
2816 these are the flags to pass to the routing daemon.
2817 .It Va route6d_flags
2819 The IPv6 equivalent of
2821 .It Va rtadvd_enable
2827 daemon at boot time.
2830 utility sends ICMPv6 Router Advertisement messages to
2831 the interfaces specified in
2832 .Va rtadvd_interfaces .
2833 This should only be enabled with great care.
2834 You may want to fine-tune
2836 .It Va rtadvd_interfaces
2842 this is the list of interfaces to use.
2847 enable global proxy ARP.
2848 .It Va forward_sourceroute
2856 source-routed packets are forwarded.
2857 .It Va accept_sourceroute
2861 the system will accept source-routed packets directed at it.
2868 daemon at system boot time.
2875 these are the flags to pass to the
2878 .It Va bootparamd_enable
2884 daemon at system boot time.
2885 .It Va bootparamd_flags
2888 .Va bootparamd_enable
2891 these are the flags to pass to the
2894 .It Va stf_interface_ipv4addr
2898 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2900 Specify this entry to enable the 6to4 interface.
2901 .It Va stf_interface_ipv4plen
2903 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2904 An effective value is 0-31.
2905 .It Va stf_interface_ipv6_ifid
2907 IPv6 interface ID for
2911 .It Va stf_interface_ipv6_slaid
2913 IPv6 Site Level Aggregator for
2915 .It Va ipv6_ipv4mapping
2919 this enables IPv4 mapped IPv6 address communication (like
2920 .Li ::ffff:a.b.c.d ) .
2921 .It Va rtsold_enable
2927 daemon to send ICMPv6 Router Solicitation messages.
2934 these are the flags to pass to
2938 For interfaces configured with the
2939 .Dq Li inet6 accept_rtadv
2940 keyword, these are the flags to pass to
2945 is mutually exclusive to
2953 to enable the configuration of ATM interfaces at system boot time.
2954 For all of the ATM variables described below, please refer to the
2956 manual page for further details on the available command parameters.
2957 Also refer to the files in
2958 .Pa /usr/share/examples/atm
2959 for more detailed configuration information.
2962 This is a list of physical ATM interface drivers to load.
2967 .It Va atm_netif_ Ns Aq Ar intf
2969 For the ATM physical interface
2971 this variable defines the name prefix and count for the ATM network
2972 interfaces to be created.
2973 The value will be passed as the parameters of an
2974 .Dq Nm atm Cm "set netif" Ar intf
2976 .It Va atm_sigmgr_ Ns Aq Ar intf
2978 For the ATM physical interface
2980 this variable defines the ATM signalling manager to be used.
2981 The value will be passed as the parameters of an
2982 .Dq Nm atm Cm attach Ar intf
2984 .It Va atm_prefix_ Ns Aq Ar intf
2986 For the ATM physical interface
2988 this variable defines the NSAP prefix for interfaces using a UNI signalling
2992 the prefix will automatically be set via the
2995 Otherwise, the value will be passed as the parameters of an
2996 .Dq Nm atm Cm "set prefix" Ar intf
2998 .It Va atm_macaddr_ Ns Aq Ar intf
3000 For the ATM physical interface
3002 this variable defines the MAC address for interfaces using a UNI signalling
3006 the hardware MAC address contained in the ATM interface card will be used.
3007 Otherwise, the value will be passed as the parameters of an
3008 .Dq Nm atm Cm "set mac" Ar intf
3010 .It Va atm_arpserver_ Ns Aq Ar netif
3012 For the ATM network interface
3014 this variable defines the ATM address for a host which is to provide ATMARP
3016 This variable is only applicable to interfaces using a UNI signalling
3020 this host will become an ATMARP server.
3021 The value will be passed as the parameters of an
3022 .Dq Nm atm Cm "set arpserver" Ar netif
3024 .It Va atm_scsparp_ Ns Aq Ar netif
3028 SCSP/ATMARP service for the network interface
3030 will be initiated using the
3035 This variable is only applicable if
3036 .Va atm_arpserver_ Ns Aq Ar netif
3041 Set to the list of ATM PVCs to be added at system
3043 For each whitespace separated
3046 .Va atm_pvc_ Ns Aq Ar element
3047 variable is assumed to exist.
3048 The value of each of these variables
3049 will be passed as the parameters of an
3050 .Dq Nm atm Cm "add pvc"
3054 Set to the list of permanent ATM ARP entries to be added
3055 at system boot time.
3056 For each whitespace separated
3059 .Va atm_arp_ Ns Aq Ar element
3060 variable is assumed to exist.
3061 The value of each of these variables
3062 will be passed as the parameters of an
3063 .Dq Nm atm Cm "add arp"
3065 .It Va natm_interfaces
3069 interfaces that will also be used for HARP through
3071 If this list is not empty all interfaces in the list will be brought up
3077 For this to work the interface drivers must be either compiled into the
3078 kernel or must reside on the root partition.
3081 The keyboard bell sound.
3088 if the default behavior is desired.
3089 For details, refer to the
3094 If set to a non-null string, the virtual console's keyboard input is
3100 no keymap is installed, otherwise the value is used to install
3101 the keymap file found in
3102 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3105 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3110 The keyboard repeat speed.
3117 if the default behavior is desired.
3122 attempt to program the function keys with the value.
3124 be a single string of the form:
3125 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3128 Can be set to the value of
3131 .Dq Li destructive ,
3134 to set the cursor behavior explicitly or choose the default behavior.
3139 no screen map is installed, otherwise the value is used to install
3140 the screen map file in
3141 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3142 This parameter is ignored when using
3144 as the console driver.
3149 the default 8x16 font value is used for screen size requests, otherwise
3151 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3153 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3154 is used (depending on the console driver being used).
3159 the default 8x14 font value is used for screen size requests, otherwise
3161 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3163 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3164 is used (depending on the console driver being used).
3169 the default 8x8 font value is used for screen size requests, otherwise
3171 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3173 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3174 is used (depending on the console driver being used).
3179 the default screen blanking interval is used, otherwise it is set
3187 this is the actual screen saver to use
3188 .Li ( blank , snake , daemon ,
3190 .It Va moused_nondefault_enable
3194 the mouse device specified on
3195 the command line is not automatically treated as enabled by the
3196 .Pa /etc/rc.d/moused
3198 Having this variable set to
3204 to be enabled as soon as it is plugged in.
3205 .It Va moused_enable
3211 daemon is started for doing cut/paste selection on the console.
3214 This is the protocol type of the mouse connected to this host.
3215 This variable must be set if
3222 is able to detect the appropriate mouse type automatically in many cases.
3223 Set this variable to
3225 to let the daemon detect it, or
3226 select one from the following list if the automatic detection fails.
3228 If the mouse is attached to the PS/2 mouse port, choose
3232 regardless of the brand and model of the mouse.
3234 mouse is attached to the bus mouse port, choose
3238 All other protocols are for serial mice and will not work with
3239 the PS/2 and bus mice.
3240 If this is a USB mouse,
3242 is the only protocol type which will work.
3244 .Bl -tag -width ".Li x10mouseremote" -compact
3246 Microsoft mouse (serial)
3248 Microsoft IntelliMouse (serial)
3250 Mouse systems Corp.\& mouse (serial)
3252 MM Series mouse (serial)
3254 Logitech mouse (serial)
3258 Logitech MouseMan and TrackMan (serial)
3260 ALPS GlidePoint (serial)
3261 .It Li thinkingmouse
3262 Kensington ThinkingMouse (serial)
3266 MM HitTablet (serial)
3267 .It Li x10mouseremote
3268 X10 MouseRemote (serial)
3270 Interlink VersaPad (serial)
3273 Even if the mouse is not in the above list, it may be compatible
3274 with one in the list.
3275 Refer to the manual page for
3277 for compatibility information.
3279 It should also be noted that while this is enabled, any
3280 other client of the mouse (such as an X server) should access
3281 the mouse through the virtual mouse device,
3283 and configure it as a
3285 type mouse, since all
3286 mouse data is converted to this single canonical format when
3289 If the client program does not support the
3295 It is the second preferred type.
3302 this is the actual port the mouse is on.
3305 for a COM1 serial mouse,
3309 for a bus mouse, for example.
3314 is set, its value is used as an additional set of flags to pass to the
3317 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3319 .Va moused_nondefault_enable
3322 daemon is started for a non-default port, the
3323 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3324 set of options has precedence over and replaces the default
3328 is the name of the non-default port, i.e.,\&
3331 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3332 it is possible to set up a different set of default flags for each
3335 For example, you can use
3339 to make your laptop's touchpad more comfortable to use,
3340 but an empty set of options for
3341 .Va moused_ums0_flags
3344 mouse has three or more buttons.
3345 .It Va mousechar_start
3349 the default mouse cursor character range
3350 .Li 0xd0 Ns - Ns Li 0xd3
3352 otherwise the range start is set
3357 Use if the default range is occupied in the language code table.
3358 .It Va allscreens_flags
3362 is run with these options for each of the virtual terminals
3366 will enable the mouse pointer on all virtual terminals
3371 .It Va allscreens_kbdflags
3375 is run with these options for each of the virtual terminals
3383 scrollback (history) buffer to 200 lines.
3390 daemon at system boot time.
3396 .Pa /usr/sbin/cron ) .
3403 these are the flags to pass to
3409 enable the special handling of transitions to and from the
3410 Daylight Saving Time in
3412 (equivalent to using the flag
3419 .Pa /usr/sbin/lpd ) .
3426 daemon at system boot time.
3433 these are the flags to pass to the
3436 .It Va chkprintcap_enable
3442 command before starting the
3445 .It Va chkprintcap_flags
3450 .Va chkprintcap_enable
3453 these are the flags to pass to the
3458 which causes missing directories to be created.
3459 .It Va mta_start_script
3461 This variable specifies the full path to the script to run to start
3462 a mail transfer agent.
3464 .Pa /etc/rc.sendmail .
3468 .Pa /etc/rc.sendmail
3469 uses are documented in the
3474 Indicates the device (usually a swap partition) to which a crash dump
3475 should be written in the event of a system crash.
3476 If the value of this variable is
3478 the first suitable swap device listed in
3480 will be used as dump device.
3481 Otherwise, the value of this variable is passed as the argument to
3483 To disable crash dumps, set this variable to
3487 When the system reboots after a crash and a crash dump is found on the
3488 device specified by the
3492 will save that crash dump and a copy of the kernel to the directory
3496 The default value is
3507 Path to a public key.
3510 to encrypt a one-time key for a crash dump.
3511 The public key has to match a private key used by
3513 to decrypt a crash dump after reboot.
3517 .It Va savecore_enable
3521 disable automatic extraction of the crash dump from the
3523 .It Va savecore_flags
3525 If crash dumps are enabled, these are the flags to pass to the
3532 to turn on user and group disk quotas on system startup via the
3534 command for all file systems marked as having quotas enabled in
3536 The kernel must be built with
3538 for disk quotas to function.
3543 to enable user and group disk quota checking via the
3546 .It Va quotacheck_flags
3556 these are the flags to pass to the
3561 which checks quotas for all file systems with quotas enabled in
3563 .It Va quotaon_flags
3569 these are the flags to pass to the
3574 which enables quotas for all file systems with quotas enabled in
3576 .It Va quotaoff_flags
3582 these are the flags to pass to the
3584 utility when shutting down the quota system.
3587 which disables quotas for all file systems with quotas enabled in
3589 .It Va accounting_enable
3593 to enable system accounting through the
3600 to enable iBCS2 (SCO) binary emulation at system initial boot
3602 .It Va ibcs2_loaders
3610 this specifies a list of additional iBCS2 loaders to enable.
3611 .It Va firstboot_sentinel
3613 This variable specifies the full path to a
3616 If a file exists with this path,
3620 keyword will be run on startup and the sentinel file will be deleted
3621 after the boot process completes.
3622 The sentinel file must be located on a writable file system which is
3623 mounted no later than
3624 .Va early_late_divider
3625 to function properly.
3632 to enable Linux/ELF binary emulation at system initial
3638 enable SysVR4 emulation at boot time.
3639 .It Va sysvipc_enable
3643 load System V IPC primitives at boot time.
3644 .It Va clear_tmp_enable
3655 to disable removing of X11 lock files,
3656 and the removal and (secure) recreation
3657 of the various socket directories for X11
3659 .It Va ldconfig_paths
3661 Set to the list of shared library paths to use with
3665 will always be added first, so it need not appear in this list.
3666 .It Va ldconfig32_paths
3668 Set to the list of 32-bit compatibility shared library paths to
3671 .It Va ldconfig_paths_aout
3673 Set to the list of shared library paths to use with
3678 .It Va ldconfig_insecure
3682 utility normally refuses to use directories
3683 which are writable by anyone except root.
3684 Set this variable to
3686 to disable that security check during system startup.
3687 .It Va ldconfig_local_dirs
3689 Set to the list of local
3692 The names of all files in the directories listed will be
3693 passed as arguments to
3695 .It Va ldconfig_local32_dirs
3697 Set to the list of local 32-bit compatibility
3700 The names of all files in the directories listed will be
3701 passed as arguments to
3702 .Dq Nm ldconfig Fl 32 .
3703 .It Va kern_securelevel_enable
3707 to set the kernel security level at system startup.
3708 .It Va kern_securelevel
3710 The kernel security level to set at startup.
3711 The allowed range of
3713 ranges from \-1 (the compile time default) to 3 (the
3717 for the list of possible security levels and their effect
3718 on system operation.
3721 Path to the SSH server program
3722 .Pa ( /usr/sbin/sshd
3730 at system boot time.
3737 these are the flags to pass to the
3742 Path to the FTP server program
3743 .Pa ( /usr/libexec/ftpd
3751 as a stand-alone daemon at system boot time.
3758 these are the additional flags to pass to the
3761 .It Va watchdogd_enable
3767 daemon at boot time.
3768 This requires that the kernel have been compiled with a
3771 .It Va watchdogd_flags
3774 .Va watchdogd_enable
3777 these are the flags passed to the
3780 .It Va devfs_rulesets
3782 List of files containing sets of rules for
3784 .It Va devfs_system_ruleset
3786 Rule name(s) to apply to the system
3789 .It Va devfs_set_rulesets
3791 Pairs of already-mounted
3793 directories and rulesets that should be applied to them.
3794 For example: /mount/dev=ruleset_name
3795 .It Va devfs_load_rulesets
3797 If set, always load the default rulesets listed in
3798 .Va devfs_rulesets .
3799 .It Va performance_cx_lowest
3801 CPU idle state to use while on AC power.
3806 should use the lowest power state available while
3808 indicates that the lowest latency state (less power savings) should be used.
3809 .It Va performance_cpu_freq
3811 CPU clock frequency to use while on AC power.
3816 should use the lowest frequency available while
3818 indicates that the highest frequency (less power savings) should be used.
3819 .It Va economy_cx_lowest
3821 CPU idle state to use when off AC power.
3826 should use the lowest power state available while
3828 indicates that the lowest latency state (less power savings) should be used.
3829 .It Va economy_cpu_freq
3831 CPU clock frequency to use when off AC power.
3836 should use the lowest frequency available while
3838 indicates that the highest frequency (less power savings) should be used.
3843 any configured jails will not be started.
3846 The configuration filename used by
3849 The default value is
3850 .Pa /etc/jail.conf .
3851 .It Va jail_parallel_start
3855 all configured jails will be started in the background (in parallel).
3859 When set, use as default value for
3860 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3865 A space-delimited list of jail names.
3866 When left empty, all of the
3868 instances defined in the configuration file are started.
3869 The names specified in this list control the jail startup order.
3871 instances missing from
3873 must be started manually.
3876 parameter in the configuration file may override this list.
3877 .It Va jail_reverse_stop
3881 all configured jails in
3883 are stopped in reverse order.
3884 .It Va jail_* variables
3885 Note that older releases supported per-jail configuration via
3889 hostname of a jail named
3891 was able to be set by
3892 .Li jail_vjail_hostname .
3893 These per-jail configuration variables are now obsolete in favor of
3896 For backward compatibility,
3897 when per-jail configuration variables are defined,
3899 configuration files are created as
3900 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3903 The following per-jail parameters are handled by
3905 script out of their corresponding
3908 In addition to them, parameters in
3909 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3910 will be added to the configuration file.
3911 They must be a semi-colon
3919 .Bl -tag -width "host.hostname" -offset indent
3922 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3923 .It Li host.hostname
3925 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3926 .It Li exec.consolelog
3928 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3929 The default value is
3930 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3933 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3934 .It Li vnet.interface
3936 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3939 parameter will be enabled and cannot be specified with
3940 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3941 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3943 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3947 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3953 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3956 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3957 The parameter name was
3959 in some older releases.
3960 .It Li exec.prestart
3962 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3963 .It Li exec.poststart
3965 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3968 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3972 .It Li exec.poststop
3974 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3977 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3979 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3980 contain IPv4 addresses
3983 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3985 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3986 contain IPv6 addresses
3989 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3992 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3993 .It Li devfs_ruleset
3995 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3996 This must be an integer,
3998 .It Li mount.fdescfs
4000 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4001 .It Li allow.set_hostname
4003 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4004 .It Li allow.rawsocket
4006 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4007 .It Li allow.sysvipc
4009 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4011 .\" -----------------------------------------------------
4015 representing the entropy sources
4016 you wish to harvest.
4019 for more information.
4024 to disable caching entropy via
4026 Otherwise set to the directory
4027 in which the entropy files are stored.
4031 that regularly writes and rotates
4034 will be used at boot time.
4036 .Pa /var/db/entropy .
4041 to disable caching entropy through reboots.
4042 Otherwise set to the name
4043 of a file used to store cached entropy.
4044 This file should be located
4045 on a file system that is readable
4046 before all the volumes specified in
4053 .Pa /var/db/entropy-file
4054 is found it will also be used.
4055 This will be of some use to
4057 .It Va entropy_boot_file
4062 very early caching entropy
4064 Otherwise set to the filename
4066 very early reboot cached entropy.
4067 This file should be located where
4072 The default location is
4074 .It Va entropy_save_sz
4076 Size of the entropy cache files saved by
4079 .It Va entropy_save_num
4081 Number of entropy cache files to save by
4095 Configuration file for
4104 .Pa /var/run/dmesg.boot
4106 .It Va rcshutdown_timeout
4108 If set, start a watchdog timer in the background which will terminate
4112 has not completed within the specified time (in seconds).
4113 Notice that in addition to this soft timeout,
4115 also applies a hard timeout for the execution of
4117 This is configured via
4120 .Va kern.init_shutdown_timeout
4121 and defaults to 120 seconds.
4122 Setting the value of
4123 .Va rcshutdown_timeout
4124 to more than 120 seconds will have no effect until the
4127 .Va kern.init_shutdown_timeout
4129 .It Va virecover_enable
4133 to prevent the system from trying to
4134 recover pre-maturely terminated
4137 .It Va ugidfw_enable
4142 .Xr mac_bsdextended 4
4143 module upon system initialization and load a default
4145 .It Va bsdextended_script
4148 .Xr mac_bsdextended 4
4149 ruleset file to load.
4150 The default value of this variable is
4151 .Pa /etc/rc.bsdextended .
4152 .It Va newsyslog_enable
4159 .It Va newsyslog_flags
4162 .Va newsyslog_enable
4165 these are the flags to pass to the
4170 which causes log files flagged with a
4173 .It Va mdconfig_md Ns Aq Ar X
4183 must be specified and either a
4185 for malloc or swap backed
4193 .Va mdconfig_md Ns Aq Ar X
4194 variables are evaluated until one variable is unset or null.
4195 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4197 Optional arguments passed to
4203 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4205 An ownership specification passed to
4214 device and the mount point will be changed.
4215 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4217 A mode string passed to
4226 device and the mount point will be changed.
4227 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4229 Files to be copied to the mount point of the
4233 after it has been mounted.
4234 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4236 Command to execute after the specified
4241 Note that the command is passed to
4247 variables can be used to reference respectively the
4249 device and the mount point.
4254 one could set the following:
4256 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4258 .It Va autobridge_interfaces
4260 Set to the list of bridge interfaces that will have newly arriving interfaces
4261 checked against to be automatically added.
4264 then for each whitespace separated
4267 .Va autobridge_ Ns Aq Ar element
4268 variable is assumed to exist which has a whitespace separated list of interface
4269 names to match, these names can use wildcards.
4272 autobridge_interfaces="bridge0"
4273 autobridge_bridge0="tap* dc0 vlan[345]"
4279 enable support for sound mixer.
4280 .It Va hcsecd_enable
4284 enable Bluetooth security daemon.
4285 .It Va hcsecd_config
4287 Configuration file for
4290 .Pa /etc/bluetooth/hcsecd.conf .
4295 enable Bluetooth Service Discovery Protocol daemon.
4303 .It Va sdpd_groupname
4307 group to run as after it initializes.
4310 .It Va sdpd_username
4314 user to run as after it initializes.
4317 .It Va bthidd_enable
4321 enable Bluetooth Human Interface Device daemon.
4322 .It Va bthidd_config
4324 Configuration file for
4327 .Pa /etc/bluetooth/bthidd.conf .
4330 Path to a file, where
4332 will store information about known HID devices.
4334 .Pa /var/db/bthidd.hids .
4335 .It Va rfcomm_pppd_server_enable
4339 enable Bluetooth RFCOMM PPP wrapper daemon.
4340 .It Va rfcomm_pppd_server_profile
4342 The name of the profile to use from
4343 .Pa /etc/ppp/ppp.conf .
4344 Multiple profiles can be specified here.
4345 Also used to specify per-profile overrides.
4346 When the profile name contains any of the characters
4348 they are translated to
4350 for the proposes of the override variable names.
4351 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4353 Overrides local address to listen on.
4359 The address can be specified as BD_ADDR or name.
4360 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4362 Overrides local RFCOMM channel to listen on.
4365 will listen on RFCOMM channel 1.
4366 Must set properly if multiple profiles used in the same time.
4367 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4371 if it should register Serial Port service on the specified RFCOMM channel.
4374 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4378 if it should register Dial-Up Networking service on the specified
4382 .It Va ubthidhci_enable
4386 change the USB Bluetooth controller from HID mode to HCI mode.
4387 You also need to specify the location of USB Bluetooth controller with the
4388 .Va ubthidhci_busnum
4392 .It Va ubthidhci_busnum
4393 Bus number where the USB Bluetooth controller is located.
4396 on your system to find this information.
4397 .It Va ubthidhci_addr
4398 Bus address of the USB Bluetooth controller.
4401 on your system to find this information.
4402 .It Va netwait_enable
4406 delays the start of network-reliant services until
4408 is up and ICMP packets to a destination defined in
4411 Link state is examined first, followed by
4413 an IP address to verify network usability.
4414 If no destination can be reached or timeouts are exceeded,
4415 network services are started anyway with no guarantee that
4416 the network is usable.
4417 Use of this variable requires both
4425 This variable contains a space-delimited list of IP addresses to
4427 DNS hostnames should not be used as resolution is not guaranteed
4428 to be functional at this point.
4429 If multiple IP addresses are specified,
4430 each will be tried until one is successful or the list is exhausted.
4431 .It Va netwait_timeout
4433 Indicates the total number of seconds to perform a
4435 against each IP address in
4437 at a rate of one ping per second.
4438 If any of the pings are successful,
4439 full network connectivity is considered reliable.
4444 Defines the name of the network interface on which watch for link.
4446 is used to monitor the interface, looking for
4447 .Dq Li status: no carrier .
4448 Once gone, the link is considered up.
4451 interface if desired.
4452 .It Va netwait_if_timeout
4454 Defines the total number of seconds to wait for link to become usable,
4455 polled at a 1-second interval.
4463 rules from the defined ruleset.
4464 The kernel must be built with
4467 .Cd "options RCTL" .
4473 This variables contains the
4479 A space-separated list of configuration files used by
4481 The default value is an empty string.
4482 .It Va autofs_enable
4492 daemons at boot time.
4493 .It Va automount_flags
4499 these are the flags to pass to the
4502 By default no flags are passed.
4503 .It Va automountd_flags
4509 these are the flags to pass to the
4512 By default no flags are passed.
4513 .It Va autounmountd_flags
4519 these are the flags to pass to the
4522 By default no flags are passed.
4529 daemon at boot time.
4530 .It Va iscsid_enable
4536 daemon at boot time.
4537 .It Va iscsictl_enable
4543 utility at boot time.
4544 .It Va iscsictl_flags
4550 these are the flags to pass to the
4555 which configures sessions based on the
4560 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4561 .It Pa /etc/defaults/rc.conf
4563 .It Pa /etc/rc.conf.local
4594 .Xr newsyslog.conf 5 ,
4666 .An Jordan K. Hubbard .