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. Unlike the _user
193 setting, this setting has no effect if the service is not chrooted.
194 .It Ao Ar name Ac Ns Va _fib
198 value to run the service under.
199 .It Ao Ar name Ac Ns Va _nice
203 value to run the service under.
208 enable support for Automatic Power Management with
216 to handle APM event from userland.
217 This also enables support for APM.
224 these are the flags to pass to the
231 to handle device added, removed or unknown events from the kernel.
238 scripts at boot time.
241 Configuration file for
247 A list of kernel modules to load right after the local
249 Loading modules at this point in the boot process is
250 much faster than doing it via
251 .Pa /boot/loader.conf
252 for those modules not necessary for mounting local disk.
253 .It Va kldxref_enable
260 to automatically rebuild
265 .It Va kldxref_clobber
275 will overwrite existing
282 .It Va kldxref_module_path
287 delimited list of paths containing
299 enable the system power control facility with the
308 these are the flags to pass to the
312 Controls the creation of a
315 Always happens if set to
317 and never happens if set to
319 If set to anything else, a memory file system is created if
323 Controls the size of a created
327 Extra options passed to the
329 utility when the memory file system for
334 which inhibits the use of softupdates on
336 so that file system space is freed without delay
337 after file truncation or deletion.
340 for other options you can use in
343 Controls the creation of a
346 Always happens if set to
348 and never happens if set to
350 If set to anything else, a memory file system is created if
354 Controls the size of a created
358 Extra options passed to the
360 utility when the memory file system for
365 which inhibits the use of softupdates on
367 so that file system space is freed without delay
368 after file truncation or deletion.
371 for other options you can use in
374 Controls the automatic population of the
377 Always happens if set to
379 and never happens if set to
381 If set to anything else, a memory file system is created if
384 Note that this process requires access to certain commands in
388 is mounted on normal systems.
389 .It Va cleanvar_enable
396 List of directories to search for startup script files.
397 .It Va script_name_sep
399 The field separator to use for breaking down the list of startup script files
400 into individual filenames.
401 The default is a space.
402 It is not necessary to change this unless there are startup scripts with names
404 .It Va hostapd_enable
413 The fully qualified domain name (FQDN) of this host on the network.
414 This should almost certainly be set to something meaningful, even if
415 there is no network connection.
418 is used to set the hostname via DHCP,
419 this variable should be set to an empty string.
420 If this value remains unset when the system is done booting
421 your console login will display the default hostname of
425 The NIS domain name of this host, or
428 .It Va dhclient_program
430 Path to the DHCP client program
431 .Pa ( /sbin/dhclient ,
436 .It Va dhclient_flags
438 Additional flags to pass to the DHCP client program.
443 manpage for a description of the command line options available.
444 .It Va dhclient_flags_ Ns Aq Ar iface
445 Additional flags to pass to the DHCP client program running on
448 When specified, this variable overrides
450 .It Va background_dhclient
454 to start the DHCP client in background.
455 This can cause trouble with applications depending on
456 a working network, but it will provide a faster startup
458 .It Va background_dhclient_ Ns Aq Ar iface
459 When specified, this variable overrides the
460 .Va background_dhclient
461 variable for interface
464 .It Va synchronous_dhclient
470 synchronously at startup.
471 This behavior can be overridden on a per-interface basis by replacing
475 .Va ifconfig_ Ns Aq Ar interface
480 .It Va defaultroute_delay
482 When set to a positive value, wait up to this long after configuring
483 DHCP interfaces at startup to give the interfaces time to receive a lease.
484 .It Va firewall_enable
488 to load firewall rules at startup.
489 If the kernel was not built with
490 .Cd "options IPFIREWALL" ,
493 kernel module will be loaded.
495 .Va ipfilter_enable .
496 .It Va firewall_script
498 This variable specifies the full path to the firewall script to run.
500 .Pa /etc/rc.firewall .
503 Names the firewall type from the selection in
504 .Pa /etc/rc.firewall ,
505 or the file which contains the local firewall ruleset.
506 Valid selections from
510 .Bl -tag -width ".Li simple" -compact
512 unrestricted IP access
514 all IP services disabled, except via
517 basic protection for a workstation
519 basic protection for a LAN.
522 If a filename is specified, the full path
524 .It Va firewall_quiet
528 to disable the display of firewall rules on the console during boot.
529 .It Va firewall_logging
533 to enable firewall event logging.
534 This is equivalent to the
535 .Dv IPFIREWALL_VERBOSE
537 .It Va firewall_logif
541 to create pseudo interface
544 For more details, see
547 .It Va firewall_flags
553 specifies a filename.
554 .It Va firewall_coscripts
556 List of executables and/or rc scripts to run after firewall starts/stops.
558 .\" ----- firewall_nat_enable setting --------------------------------
559 .It Va firewall_nat_enable
571 .It Va firewall_nat_interface
577 This is the name of the public interface or IP address on which
578 kernel NAT should run.
579 .It Va firewall_nat_flags
581 Additional configuration parameters for kernel NAT should be placed here.
582 .It Va dummynet_enable
586 will automatically load the
592 .\" -------------------------------------------------------------------
608 sockets must be enabled in the kernel.
609 If the kernel was not built with
610 .Cd "options IPDIVERT" ,
613 kernel module will be loaded.
614 .It Va natd_interface
616 This is the name of the public interface on which
619 The interface may be given as an interface name or as an IP address.
624 flags should be placed here.
629 flag is automatically added with the above
632 .\" ----- ipfilter_enable setting --------------------------------
633 .It Va ipfilter_enable
644 Typical usage will require putting
646 ipfilter_enable="YES"
664 can be enabled independently.
668 both require at least one of
678 options IPFILTER_DEFAULT_BLOCK
681 in the kernel configuration file is a good idea, too.
682 .\" ----- ipfilter_program setting ------------------------------
683 .It Va ipfilter_program
689 .\" ----- ipfilter_rules setting --------------------------------
690 .It Va ipfilter_rules
695 This variable contains the name of the filter rule definition file.
696 The file is expected to be readable for the
699 .\" ----- ipv6_ipfilter_rules setting ---------------------------
700 .It Va ipv6_ipfilter_rules
705 This variable contains the IPv6 filter rule definition file.
706 The file is expected to be readable for the
709 .\" ----- ipfilter_flags setting --------------------------------
710 .It Va ipfilter_flags
713 This variable contains flags passed to the
716 .\" ----- ipnat_enable setting ----------------------------------
726 network address translation.
729 for a detailed discussion.
730 .\" ----- ipnat_program setting ---------------------------------
737 .\" ----- ipnat_rules setting -----------------------------------
743 This variable contains the name of the file
744 holding the network address translation definition.
745 This file is expected to be readable for the
748 .\" ----- ipnat_flags setting -----------------------------------
752 This variable contains flags passed to the
755 .\" ----- ipmon_enable setting ----------------------------------
770 Setting this variable needs setting
777 for a detailed discussion.
778 .\" ----- ipmon_program setting ---------------------------------
785 .\" ----- ipmon_flags setting -----------------------------------
791 This variable contains flags passed to the
794 Another typical example would be
795 .Dq Fl D Pa /var/log/ipflog
798 log directly to a file bypassing
801 .Pa /etc/newsyslog.conf
802 in such case like this:
804 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
806 .\" ----- ipfs_enable setting -----------------------------------
816 saving the filter and NAT state tables during shutdown
817 and reloading them during startup again.
818 Setting this variable needs setting
827 for a detailed discussion.
833 because the raised securelevel will prevent
835 from saving the state tables at shutdown time.
836 .\" ----- ipfs_program setting ----------------------------------
843 .\" ----- ipfs_flags setting ------------------------------------
847 This variable contains flags passed to the
850 .\" ----- end of added ipf hook ---------------------------------
862 Typical usage will require putting
877 into the kernel, otherwise the
878 kernel module will be loaded.
883 ruleset configuration file
898 these flags are passed to the
900 program when loading the ruleset.
910 which logs packets from the
923 .Pa /var/log/pflog ) .
925 .Pa /etc/newsyslog.conf
926 to adjust logfile rotation for this.
936 This variable contains additional flags passed to the
939 .It Va ftpproxy_enable
950 packet filter in translating ftp connections.
951 .It Va ftpproxy_flags
954 This variable contains additional flags passed to the
966 state changes to other hosts over the network by means of
971 must also be set then.
972 .It Va pfsync_syncdev
975 This variable specifies the name of the network interface
977 should operate through.
978 It must be set accordingly if
982 .It Va pfsync_syncpeer
985 This variable is optional.
986 By default, state change messages are sent out on the synchronisation
987 interface using IP multicast packets.
988 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
990 When a peer address is specified using the
992 option, the peer address is used as a destination for the pfsync
993 traffic, and the traffic can then be protected using
997 manpage for more details about using
1002 .It Va pfsync_ifconfig
1005 This variable can contain additional options to be passed to the
1007 command used to set up
1009 .It Va tcp_extensions
1016 disables certain TCP options as described by
1022 might help remedy such problems with connections as randomly hanging
1023 or other weird behavior.
1024 Some network devices are known
1025 to be broken with respect to these options.
1028 Set to 0 by default.
1032 .Va net.inet.tcp.log_in_vain
1034 .Va net.inet.udp.log_in_vain ,
1039 are set to the given value.
1040 .It Va tcp_keepalive
1047 will disable probing idle TCP connections to verify that the
1048 peer is still up and reachable.
1049 .It Va tcp_drop_synfin
1056 will cause the kernel to ignore TCP frames that have both
1057 the SYN and FIN flags set.
1058 This prevents OS fingerprinting, but may
1059 break some legitimate applications.
1060 .It Va icmp_drop_redirect
1067 will cause the kernel to ignore ICMP REDIRECT packets.
1070 for more information.
1071 .It Va icmp_log_redirect
1078 will cause the kernel to log ICMP REDIRECT packets.
1080 the log messages are not rate-limited, so this option should only be used
1081 for troubleshooting networks.
1084 for more information.
1085 .It Va icmp_bmcastecho
1089 to respond to broadcast or multicast ICMP ping packets.
1092 for more information.
1093 .It Va ip_portrange_first
1097 this is the first port in the default portrange.
1100 for more information.
1101 .It Va ip_portrange_last
1105 this is the last port in the default portrange.
1108 for more information.
1109 .It Va network_interfaces
1111 Set to the list of network interfaces to configure on this host or
1113 (the default) for all current interfaces.
1115 .Va network_interfaces
1116 variable to anything other than the default is deprecated.
1117 Interfaces that the administrator wishes to store configuration for,
1118 but not start at boot should be configured with the
1121 .Va ifconfig_ Ns Aq Ar interface
1122 variables as described below.
1125 .Va ifconfig_ Ns Aq Ar interface
1126 variable is also assumed to exist for each value of
1128 When an interface name contains any of the characters
1130 they are translated to
1133 The variable can contain arguments to
1135 as well as special case-insensitive keywords described below.
1136 Such keywords are removed before passing the value to
1138 while the order of the other arguments is preserved.
1140 It is possible to add IP alias entries using
1142 syntax with the address family keyword such as
1144 Assuming that the interface in question was
1146 it might look something like this:
1148 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1149 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1152 It also possible to configure multiple IP addresses in Classless
1153 Inter-Domain Routing
1156 whose each address component can be a range like
1157 .Li inet 192.0.2.5-23/24
1159 .Li inet6 2001:db8:1-f::1/64 .
1160 This notation allows address and prefix length part only,
1161 not the other address modifiers.
1164 .Li 192.0.2.5-23/24 ,
1165 the address 192.0.2.5 will be configured with the
1166 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1167 the non-conflicting netmask /32 as explained in the
1170 Note that this special netmask handling is only for
1172 not for the other address families such as
1175 With the interface in question being
1177 an example could look like:
1179 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1180 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1186 .Va ipv4_addrs_ Ns Aq Ar interface
1187 variable was supported for IPv4 CIDR address notation.
1188 It is now deprecated because the functionality was integrated into
1189 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1191 .Va ipv4_addrs_ Ns Aq Ar interface
1192 is still supported for backward compatibility.
1195 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1196 entry with an address family keyword,
1197 its contents are passed to
1199 Execution stops at the first unsuccessful access, so if
1200 something like this is present:
1202 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1203 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1204 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1205 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1208 Then note that alias4 would
1210 be added since the search would
1211 stop with the missing
1214 Because of this difficult to manage behavior,
1216 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1217 variable, which has the same functionality as
1218 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1219 and can have all of entries in a variable like the following:
1221 ifconfig_ed0_aliases="\\
1222 inet 127.0.0.251 netmask 0xffffffff \\
1223 inet 127.0.0.252 netmask 0xffffffff \\
1224 inet 127.0.0.253 netmask 0xffffffff \\
1225 inet 127.0.0.254 netmask 0xffffffff"
1228 It also supports CIDR notation.
1231 .Pa /etc/start_if. Ns Aq Ar interface
1232 file is present, it is read and executed by the
1235 before configuring the interface as specified in the
1236 .Va ifconfig_ Ns Aq Ar interface
1238 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1242 .Va vlans_ Ns Aq Ar interface
1246 interface will be created for each item in the list with the
1250 If a vlan interface's name is a number,
1251 then that number is used as the vlan tag and the new vlan interface is
1253 .Ar interface . Ns Ar tag .
1255 the vlan tag must be specified via a
1258 .Va create_args_ Ns Aq Ar interface
1261 To create a vlan device named
1265 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1268 ifconfig_em0_101="inet 192.0.2.1/24"
1271 To create a vlan device named
1275 with the vlan tag 102:
1278 create_args_myvlan="vlan 102"
1282 .Va wlans_ Ns Aq Ar interface
1286 interface will be created for each item in the list with the
1290 Further wlan cloning arguments may be passed to the
1293 command by setting the
1294 .Va create_args_ Ns Aq Ar interface
1298 devices must be created for each wireless devices as of
1304 may be specified with an
1305 .Va wlandebug_ Ns Aq Ar interface
1307 The contents of this variable will be passed directly to
1311 .Va ifconfig_ Ns Aq Ar interface
1312 contains the keyword
1314 then the interface will not be configured
1316 .Pa /etc/pccard_ether
1318 .Va network_interfaces
1322 It is possible to bring up an interface with DHCP by adding
1325 .Va ifconfig_ Ns Aq Ar interface
1327 For instance, to initialize the
1330 it is possible to use something like:
1335 If you want to configure your wireless interface with
1336 .Xr wpa_supplicant 8
1337 for use with WPA, EAP/LEAP or WEP, you need to add
1340 .Va ifconfig_ Ns Aq Ar interface
1343 On the other hand, if you want to configure your wireless interface with
1348 .Va ifconfig_ Ns Aq Ar interface
1351 will use the settings from
1352 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1354 Finally, you can add
1356 options in this variable, in addition to the
1357 .Pa /etc/start_if. Ns Aq Ar interface
1359 For instance, to configure an
1361 wireless device in station mode with an address obtained
1362 via DHCP, using WPA authentication and 802.11b mode, it is
1363 possible to use something like:
1366 ifconfig_wlan0="DHCP WPA mode 11b"
1370 .Va ifconfig_ Ns Aq Ar interface
1371 form, a fallback variable
1372 .Va ifconfig_DEFAULT
1374 It will be used for all interfaces with no
1375 .Va ifconfig_ Ns Aq Ar interface
1377 This is intended to replace the no longer supported
1381 It is also possible to rename an interface by doing:
1383 ifconfig_ed0_name="net0"
1384 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1388 This variable is deprecated.
1390 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1392 .Va ipv6_activate_all_interfaces
1397 .Dq Li inet6 accept_rtadv
1399 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1401 .Va ipv6_activate_all_interfaces
1406 This variable is deprecated.
1408 .Va ip6addrctl_policy
1413 the default address selection policy table set by
1415 will be IPv6-preferred.
1419 the default address selection policy table set by
1421 will be IPv4-preferred.
1422 .It Va ipv6_activate_all_interfaces
1424 This controls initial configuration on IPv6-capable
1425 interfaces with no corresponding
1426 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1428 Note that it is not always necessary to set this variable to
1430 to use IPv6 functionality on
1432 In most cases, just configuring
1433 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1438 all interfaces which do not have a corresponding
1439 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1440 variable will be marked as
1443 This means that all of IPv6 functionality on that interface
1444 is completely disabled to enforce a security policy.
1445 If the variable is set to
1447 the flag will be cleared on all of the interfaces.
1449 In most cases, just defining an
1450 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1451 for an IPv6-capable interface should be sufficient.
1452 However, if an interface is added dynamically
1453 .Pq by some tunneling protocols such as PPP, for example ,
1454 it is often difficult to define the variable in advance.
1455 In such a case, configuring the
1457 flag can be disabled by setting this variable to
1460 For more details of the
1463 .Dq Li inet6 ifdisabled ,
1473 privacy addresses will be generated for each IPv6
1474 interface as described in RFC 4941.
1475 .It Va ipv6_network_interfaces
1477 This is the IPv6 equivalent of
1478 .Va network_interfaces .
1479 Normally manual configuration of this variable is not needed.
1481 .It Va ipv6_cpe_wanif
1483 If the variable is set to an interface name,
1487 .Dq inet6 -no_radr accept_rtadv
1488 will be added to the specified interface automatically before evaluating
1489 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1493 .Va net.inet6.ip6.rfc6204w3
1495 .Va net.inet6.ip6.no_radr
1498 This means the specified interface will accept ICMPv6 Router
1499 Advertisement messages on that link and add the discovered
1500 routers into the Default Router List.
1501 While the other interfaces can still accept RA messages if the
1502 .Dq inet6 accept_rtadv
1503 option is specified, adding
1504 routes into the Default Router List will be disabled by
1511 Note that ICMPv6 Router Advertisement messages will be
1513 .Va net.inet6.ip6.forwarding
1515 .Pq packet forwarding is enabled
1517 .Va net.inet6.ip6.rfc6204w3
1522 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1524 IPv6 functionality on an interface should be configured by
1525 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1526 instead of setting ifconfig parameters in
1527 .Va ifconfig_ Ns Aq Ar interface .
1528 If this variable is empty, all of IPv6 configurations on the
1529 specified interface by other variables such as
1530 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1533 Aliases should be set by
1534 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1540 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1541 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1544 Interfaces that have an
1545 .Dq Li inet6 accept_rtadv
1547 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1548 setting will be automatically configured by SLAAC
1549 .Pq StateLess Address AutoConfiguration
1555 Note that a link-local address will be automatically configured in
1556 addition to the configured global-scope addresses because the IPv6
1557 specifications require it on each link.
1558 The address is calculated from the MAC address by using an algorithm
1565 If only a link-local address is needed on the interface,
1566 the following configuration can be used:
1568 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1571 A link-local address can also be configured manually.
1572 This is useful for the default router address of an IPv6 router
1573 so that it does not change when the network interface
1577 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1579 .It Va ipv6_prefix_ Ns Aq Ar interface
1581 If one or more prefixes are defined in
1582 .Va ipv6_prefix_ Ns Aq Ar interface
1583 addresses based on each prefix and the EUI-64 interface index will be
1584 configured on that interface.
1585 Note that this variable will be ignored when
1586 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1589 For example, the following configuration
1591 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1594 is equivalent to the following:
1596 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1597 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1598 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1599 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1602 These Subnet-Router anycast addresses will be added only when
1603 .Va ipv6_gateway_enable
1605 .It Va ipv6_default_interface
1609 this is the default output interface for scoped addresses.
1610 This works only with ipv6_gateway_enable="NO".
1611 .It Va ip6addrctl_enable
1613 This variable is to enable configuring default address selection policy table
1615 The table can be specified in another variable
1616 .Va ip6addrctl_policy .
1618 .Va ip6addrctl_policy
1619 the following keywords can be specified:
1620 .Dq Li ipv4_prefer ,
1621 .Dq Li ipv6_prefer ,
1631 installs a pre-defined policy table described in Section 2.1
1639 is specified, it attempts to read a file
1640 .Pa /etc/ip6addrctl.conf
1642 If this file is found,
1644 reads and installs it.
1645 If not found, a policy is automatically set
1647 .Va ipv6_activate_all_interfaces
1648 variable; if the variable is set to
1650 the IPv6-preferred one is used.
1651 Otherwise IPv4-preferred.
1653 The default value of
1654 .Va ip6addrctl_enable
1656 .Va ip6addrctl_policy
1662 .It Va cloned_interfaces
1664 Set to the list of clonable network interfaces to create on this host.
1665 Further cloning arguments may be passed to the
1668 command for each interface by setting the
1669 .Va create_args_ Ns Aq Ar interface
1671 If an interface name is specified with
1674 the interface will not be destroyed even when
1676 script is invoked with
1679 This is useful when reconfiguring the interface without destroying it.
1681 .Va cloned_interfaces
1682 are automatically appended to
1683 .Va network_interfaces
1685 .It Va cloned_interfaces_sticky
1687 This variable is to globally enable functionality of
1690 .Va cloned_interfaces
1692 The default value is
1694 Even if this variable is specified to
1697 keyword can be used to override it on per interface basis.
1698 .It Va fec_interfaces
1702 Fast EtherChannel interfaces to configure on this host.
1704 .Va fecconfig_ Ns Aq Ar interface
1705 variable is assumed to exist for each value of
1707 The value of this variable is used to configure link aggregated interfaces
1708 according to the syntax of the
1709 .Cm NGM_FEC_ADD_IFACE
1713 Additionally, this option ensures that each listed interface is created
1718 before attempting to configure it.
1721 fec_interfaces="fec0"
1722 fecconfig_fec0="em0 em1"
1723 ifconfig_fec0="DHCP"
1725 .It Va gif_interfaces
1727 This variable is deprecated in favor of
1728 .Va cloned_interfaces .
1731 tunnel interfaces to configure on this host.
1733 .Va gifconfig_ Ns Aq Ar interface
1734 variable is assumed to exist for each value of
1736 The value of this variable is used to configure the link layer of the
1737 tunnel according to the syntax of the
1741 Additionally, this option ensures that each listed interface is created
1746 before attempting to configure it.
1747 .It Va sppp_interfaces
1751 interfaces to configure on this host.
1753 .Va spppconfig_ Ns Aq Ar interface
1754 variable is assumed to exist for each value of
1756 Each interface should also be configured by a general
1757 .Va ifconfig_ Ns Aq Ar interface
1761 for more information about available options.
1771 The name of the profile to use from
1772 .Pa /etc/ppp/ppp.conf .
1773 Also used for per-profile overrides of
1778 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1779 When the profile name contains any of the characters
1781 they are translated to
1783 for the proposes of the override variable names.
1786 Mode in which to run the
1789 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1791 Overrides the global
1801 See the manual for a full description.
1806 enables network address translation.
1807 Used in conjunction with
1809 allows hosts on private network addresses access to the Internet using
1810 this host as a network address translating router.
1811 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1813 Overrides the global
1817 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1819 Set the unit number to be used for this profile.
1820 See the manual description of
1825 The name of the user under which
1833 .It Va rc_conf_files
1835 This option is used to specify a list of files that will override
1837 .Pa /etc/defaults/rc.conf .
1838 The files will be read in the order in which they are specified and should
1839 include the full path to the file.
1840 By default, the files specified are
1843 .Pa /etc/rc.conf.local
1849 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1851 .It Va gptboot_enable
1855 .Pa /etc/rc.d/gptboot
1856 will log if the system successfully (or not) booted from a GPT partition,
1862 .It Va gbde_autoattach_all
1867 will attempt to automatically initialize your .bde devices in
1871 List the devices that the script should try to attach,
1876 The directory where the
1878 lockfiles are located.
1879 The default lockfile directory is
1882 The lockfile for each individual
1884 device can be overridden by setting the variable
1885 .Va gbde_lock_ Ns Aq Ar device ,
1888 is the encrypted device without the
1893 .It Va gbde_attach_attempts
1895 Number of times to attempt attaching to a
1897 device, i.e., how many times the user is asked for the pass-phrase.
1901 List of devices to automatically attach on boot.
1902 Note that .eli devices from
1904 are automatically appended to this list.
1907 Number of times user is asked for the pass-phrase.
1908 If empty, it will be taken from
1909 .Va kern.geom.eli.tries
1911 .It Va geli_default_flags
1913 Default flags to use by
1915 when configuring disk encryption.
1916 Flags can be configured for every device separately by defining
1917 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1919 .It Va geli_autodetach
1921 Specifies if GELI devices should be marked for detach on last close after
1922 file systems are mounted.
1925 This can be changed for every device separately by defining
1926 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1928 .It Va root_rw_mount
1933 After the file systems are checked at boot time, the root file system
1934 is remounted as read-write if this is set to
1936 Diskless systems that mount their root file system from a read-only remote
1937 NFS share should set this to
1941 .It Va fsck_y_enable
1946 will be run with the
1948 flag if the initial preen
1949 of the file systems fails.
1950 .It Va background_fsck
1954 the system will attempt to run
1956 in the background where possible.
1957 .It Va background_fsck_delay
1959 The amount of time in seconds to sleep before starting a background
1961 It defaults to sixty seconds to allow large applications such as
1962 the X server to start before disk I/O bandwidth is monopolized by
1964 If set to a negative number, the background file system check will be
1965 delayed indefinitely to allow the administrator to run it at a more
1967 For example it may be run from
1969 by adding a line like
1971 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1977 List of file system types that are network-based.
1978 This list should generally not be modified by end users.
1980 .Va extra_netfs_types
1982 .It Va extra_netfs_types
1984 If set to something other than
1987 this variable extends the list of file system types
1988 for which automatic mounting at startup by
1990 should be delayed until the network is initialized.
1992 a whitespace-separated list of network file system descriptor pairs,
1993 each consisting of a file system type as passed to
1995 and a human-readable, one-word description,
1998 Extending the default list in this way is only necessary
1999 when third party file system types are used.
2000 .It Va syslogd_enable
2007 .It Va syslogd_program
2012 .Pa /usr/sbin/syslogd ) .
2013 .It Va syslogd_flags
2019 these are the flags to pass to
2028 .It Va inetd_program
2033 .Pa /usr/sbin/inetd ) .
2040 these are the flags to pass to
2049 .It Va hastd_program
2061 these are the flags to pass to
2063 .It Va local_unbound_enable
2069 daemon as a local caching resolver.
2070 .It Va kerberos5_server_enable
2074 to start a Kerberos 5 authentication server
2076 .It Va kerberos5_server
2079 .Va kerberos5_server_enable
2082 this is the path to Kerberos 5 Authentication Server.
2083 .It Va kerberos5_server_flags
2086 This variable contains additional flags to be passed to the Kerberos 5
2087 authentication server.
2088 .It Va kadmind5_server_enable
2094 the Kerberos 5 Administration Daemon; set to
2097 .It Va kadmind5_server
2100 .Va kadmind5_server_enable
2103 this is the path to Kerberos 5 Administration Daemon.
2104 .It Va kpasswdd_server_enable
2110 the Kerberos 5 Password-Changing Daemon; set to
2113 .It Va kpasswdd_server
2116 .Va kpasswdd_server_enable
2119 this is the path to Kerberos 5 Password-Changing Daemon.
2126 the Kerberos 5 ticket forwarding daemon, at the boot time.
2132 .Pa /usr/libexec/kfd ) .
2139 daemon at boot time.
2146 these are the flags to pass to it.
2153 daemon at boot time.
2160 these are the flags to pass to it.
2163 manpage for more information.
2164 .It Va amd_map_program
2167 the specified program is run to get the list of
2172 maps are stored in NIS, one can set this to
2185 will be updated at boot time to reflect the kernel release
2190 will not be updated.
2191 .It Va nfs_client_enable
2195 run the NFS client daemons at boot time.
2196 .It Va nfs_access_cache
2199 .Va nfs_client_enable
2204 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2206 results should be cached.
2207 A value of 2-10 seconds will substantially reduce network
2208 traffic for many NFS operations.
2209 .It Va nfs_server_enable
2213 run the NFS server daemons at boot time.
2214 .It Va nfs_server_flags
2217 .Va nfs_server_enable
2220 these are the flags to pass to the
2223 .It Va nfsv4_server_enable
2226 .Va nfs_server_enable
2230 .Va nfsv4_server_enable
2233 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2234 .It Va nfsuserd_enable
2240 run the nfsuserd daemon, which is needed for NFSv4 in order
2241 to map between user/group names vs uid/gid numbers.
2243 .Va nfsv4_server_enable
2246 this will be forced enabled.
2247 .It Va nfsuserd_flags
2253 these are the flags to pass to the
2256 .It Va nfscbd_enable
2262 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2269 these are the flags to pass to the
2272 .It Va oldnfs_server_enable
2275 .Va oldnfs_server_enable
2278 force the NFS server daemons to run the old NFS server code
2279 that does not support NFSv4.
2280 .It Va mountd_enable
2285 .Va nfs_server_enable
2291 It is commonly needed to run CFS without real NFS used.
2298 these are the flags to pass to the
2301 .It Va weak_mountd_authentication
2305 allow services like PCNFSD to make non-privileged mount
2307 .It Va nfs_reserved_port_only
2311 provide NFS services only on a secure port.
2312 .It Va nfs_bufpackets
2314 If set to a number, indicates the number of packets worth of
2315 socket buffer space to reserve on an NFS client.
2316 The kernel default is typically 4.
2317 Using a higher number may be
2318 useful on gigabit networks to improve performance.
2319 The minimum value is
2320 2 and the maximum is 64.
2321 .It Va rpc_lockd_enable
2325 and also an NFS server or client, run
2328 .It Va rpc_lockd_flags
2331 .Va rpc_lockd_enable
2334 these are the flags to pass to the
2337 .It Va rpc_statd_enable
2341 and also an NFS server or client, run
2344 .It Va rpc_statd_flags
2347 .Va rpc_statd_enable
2350 these are the flags to pass to the
2353 .It Va rpcbind_program
2358 .Pa /usr/sbin/rpcbind ) .
2359 .It Va rpcbind_enable
2365 service at boot time.
2366 .It Va rpcbind_flags
2372 these are the flags to pass to the
2375 .It Va keyserv_enable
2381 daemon on boot for running Secure RPC.
2382 .It Va keyserv_flags
2388 these are the flags to pass to
2391 .It Va pppoed_enable
2397 daemon at boot time to provide PPP over Ethernet services.
2398 .It Va pppoed_ Ns Aq Ar provider
2401 listens to requests to this
2407 argument of the same name.
2410 Additional flags to pass to
2412 .It Va pppoed_interface
2414 The network interface to run
2417 This is mandatory when
2427 service at boot time.
2428 This command is intended for networks of
2429 machines where a consistent
2431 for all hosts must be established.
2432 This is often useful in large NFS
2433 environments where time stamps on files are expected to be consistent
2441 these are the flags to pass to the
2444 .It Va ntpdate_enable
2451 This command is intended to
2452 synchronize the system clock only
2454 from some standard reference.
2455 .It Va ntpdate_config
2457 Configuration file for
2461 .It Va ntpdate_hosts
2463 A whitespace-separated list of NTP servers to synchronize with at startup.
2464 The default is to use the servers listed in
2465 .Va ntpdate_config ,
2466 if that file exists.
2467 .It Va ntpdate_program
2472 .Pa /usr/sbin/ntpdate ) .
2473 .It Va ntpdate_flags
2479 these are the flags to pass to the
2481 command (typically a hostname).
2488 command at boot time.
2494 .Pa /usr/sbin/ntpd ) .
2508 these are the flags to pass to the
2511 .It Va ntpd_sync_on_start
2518 flag, which syncs the system's clock on startup.
2521 for more information regarding the
2524 This is a preferred alternative to using
2529 .It Va nis_client_enable
2535 service at system boot time.
2536 .It Va nis_client_flags
2539 .Va nis_client_enable
2542 these are the flags to pass to the
2545 .It Va nis_ypset_enable
2551 daemon at system boot time.
2552 .It Va nis_ypset_flags
2555 .Va nis_ypset_enable
2558 these are the flags to pass to the
2561 .It Va nis_server_enable
2567 daemon at system boot time.
2568 .It Va nis_server_flags
2571 .Va nis_server_enable
2574 these are the flags to pass to the
2577 .It Va nis_ypxfrd_enable
2583 daemon at system boot time.
2584 .It Va nis_ypxfrd_flags
2587 .Va nis_ypxfrd_enable
2590 these are the flags to pass to the
2593 .It Va nis_yppasswdd_enable
2599 daemon at system boot time.
2600 .It Va nis_yppasswdd_flags
2603 .Va nis_yppasswdd_enable
2606 these are the flags to pass to the
2609 .It Va rpc_ypupdated_enable
2615 daemon at system boot time.
2616 .It Va bsnmpd_enable
2622 daemon at system boot time.
2623 Be sure to understand the security implications of running SNMP daemon
2631 these are the flags to pass to the
2634 .It Va defaultrouter
2638 create a default route to this host name or IP address
2639 (use an IP address if this router is also required to get to the
2641 .It Va ipv6_defaultrouter
2643 The IPv6 equivalent of
2645 .It Va static_arp_pairs
2647 Set to the list of static ARP pairs that are to be added at system
2649 For each whitespace separated
2652 .Va static_arp_ Ns Aq Ar element
2653 variable is assumed to exist whose contents will later be passed to a
2658 static_arp_pairs="gw"
2659 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2661 .It Va static_ndp_pairs
2663 Set to the list of static NDP pairs that are to be added at system
2665 For each whitespace separated
2668 .Va static_ndp_ Ns Aq Ar element
2669 variable is assumed to exist whose contents will later be passed to a
2674 static_ndp_pairs="gw"
2675 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2677 .It Va static_routes
2679 Set to the list of static routes that are to be added at system
2683 then for each whitespace separated
2686 .Va route_ Ns Aq Ar element
2687 variable is assumed to exist
2688 whose contents will later be passed to a
2693 static_routes="ext mcast:gif0 gif0local:gif0"
2694 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2695 route_mcast="-net 224.0.0.0/4 -iface gif0"
2696 route_gif0local="-host 169.254.1.1 -iface lo0"
2703 the route is specific to the interface
2705 .It Va ipv6_static_routes
2707 The IPv6 equivalent of
2711 then for each whitespace separated
2714 .Va ipv6_route_ Ns Aq Ar element
2715 variable is assumed to exist
2716 whose contents will later be passed to a
2717 .Dq Nm route Cm add Fl inet6
2719 .It Va natm_static_routes
2725 If not empty then for each whitespace separated
2728 .Va route_ Ns Aq Ar element
2729 variable is assumed to exist whose contents will later be passed to a
2730 .Dq Nm atmconfig Cm natm Cm add
2732 .It Va gateway_enable
2736 configure host to act as an IP router, e.g.\& to forward packets
2738 .It Va ipv6_gateway_enable
2740 The IPv6 equivalent of
2741 .Va gateway_enable .
2742 .It Va routed_enable
2746 run a routing daemon of some sort, based on the
2751 .It Va route6d_enable
2753 The IPv6 equivalent of
2757 run a routing daemon of some sort, based on the
2762 .It Va routed_program
2768 this is the name of the routing daemon to use.
2769 .It Va route6d_program
2771 The IPv6 equivalent of
2772 .Va routed_program .
2779 these are the flags to pass to the routing daemon.
2780 .It Va route6d_flags
2782 The IPv6 equivalent of
2784 .It Va mrouted_enable
2788 run the multicast routing daemon,
2790 .It Va mroute6d_enable
2792 The IPv6 equivalent of
2793 .Va mrouted_enable .
2796 run the IPv6 multicast routing daemon.
2798 Note that multicast routing daemons are no longer included in the
2800 base system, however, both
2804 may be installed from the
2807 .It Va mrouted_flags
2813 these are the flags to pass to the
2816 .It Va mroute6d_flags
2818 The IPv6 equivalent of
2824 these are the flags passed to the IPv6 multicast routing daemon.
2825 .It Va mroute6d_program
2831 this is the path to the IPv6 multicast routing daemon.
2832 .It Va rtadvd_enable
2838 daemon at boot time.
2841 utility sends ICMPv6 Router Advertisement messages to
2842 the interfaces specified in
2843 .Va rtadvd_interfaces .
2844 This should only be enabled with great care.
2845 You may want to fine-tune
2847 .It Va rtadvd_interfaces
2853 this is the list of interfaces to use.
2854 .It Va ipxgateway_enable
2858 enable the routing of IPX traffic.
2859 .It Va ipxrouted_enable
2865 daemon at system boot time.
2866 .It Va ipxrouted_flags
2869 .Va ipxrouted_enable
2872 these are the flags to pass to the
2879 enable global proxy ARP.
2880 .It Va forward_sourceroute
2888 source-routed packets are forwarded.
2889 .It Va accept_sourceroute
2893 the system will accept source-routed packets directed at it.
2900 daemon at system boot time.
2907 these are the flags to pass to the
2910 .It Va bootparamd_enable
2916 daemon at system boot time.
2917 .It Va bootparamd_flags
2920 .Va bootparamd_enable
2923 these are the flags to pass to the
2926 .It Va stf_interface_ipv4addr
2930 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2932 Specify this entry to enable the 6to4 interface.
2933 .It Va stf_interface_ipv4plen
2935 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2936 An effective value is 0-31.
2937 .It Va stf_interface_ipv6_ifid
2939 IPv6 interface ID for
2943 .It Va stf_interface_ipv6_slaid
2945 IPv6 Site Level Aggregator for
2947 .It Va ipv6_faith_prefix
2951 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2956 .It Va ipv6_ipv4mapping
2960 this enables IPv4 mapped IPv6 address communication (like
2961 .Li ::ffff:a.b.c.d ) .
2962 .It Va rtsold_enable
2968 daemon to send ICMPv6 Router Solicitation messages.
2975 these are the flags to pass to
2979 For interfaces configured with the
2980 .Dq Li inet6 accept_rtadv
2981 keyword, these are the flags to pass to
2986 is mutually exclusive to
2994 to enable the configuration of ATM interfaces at system boot time.
2995 For all of the ATM variables described below, please refer to the
2997 manual page for further details on the available command parameters.
2998 Also refer to the files in
2999 .Pa /usr/share/examples/atm
3000 for more detailed configuration information.
3003 This is a list of physical ATM interface drivers to load.
3008 .It Va atm_netif_ Ns Aq Ar intf
3010 For the ATM physical interface
3012 this variable defines the name prefix and count for the ATM network
3013 interfaces to be created.
3014 The value will be passed as the parameters of an
3015 .Dq Nm atm Cm "set netif" Ar intf
3017 .It Va atm_sigmgr_ Ns Aq Ar intf
3019 For the ATM physical interface
3021 this variable defines the ATM signalling manager to be used.
3022 The value will be passed as the parameters of an
3023 .Dq Nm atm Cm attach Ar intf
3025 .It Va atm_prefix_ Ns Aq Ar intf
3027 For the ATM physical interface
3029 this variable defines the NSAP prefix for interfaces using a UNI signalling
3033 the prefix will automatically be set via the
3036 Otherwise, the value will be passed as the parameters of an
3037 .Dq Nm atm Cm "set prefix" Ar intf
3039 .It Va atm_macaddr_ Ns Aq Ar intf
3041 For the ATM physical interface
3043 this variable defines the MAC address for interfaces using a UNI signalling
3047 the hardware MAC address contained in the ATM interface card will be used.
3048 Otherwise, the value will be passed as the parameters of an
3049 .Dq Nm atm Cm "set mac" Ar intf
3051 .It Va atm_arpserver_ Ns Aq Ar netif
3053 For the ATM network interface
3055 this variable defines the ATM address for a host which is to provide ATMARP
3057 This variable is only applicable to interfaces using a UNI signalling
3061 this host will become an ATMARP server.
3062 The value will be passed as the parameters of an
3063 .Dq Nm atm Cm "set arpserver" Ar netif
3065 .It Va atm_scsparp_ Ns Aq Ar netif
3069 SCSP/ATMARP service for the network interface
3071 will be initiated using the
3076 This variable is only applicable if
3077 .Va atm_arpserver_ Ns Aq Ar netif
3082 Set to the list of ATM PVCs to be added at system
3084 For each whitespace separated
3087 .Va atm_pvc_ Ns Aq Ar element
3088 variable is assumed to exist.
3089 The value of each of these variables
3090 will be passed as the parameters of an
3091 .Dq Nm atm Cm "add pvc"
3095 Set to the list of permanent ATM ARP entries to be added
3096 at system boot time.
3097 For each whitespace separated
3100 .Va atm_arp_ Ns Aq Ar element
3101 variable is assumed to exist.
3102 The value of each of these variables
3103 will be passed as the parameters of an
3104 .Dq Nm atm Cm "add arp"
3106 .It Va natm_interfaces
3110 interfaces that will also be used for HARP through
3112 If this list is not empty all interfaces in the list will be brought up
3118 For this to work the interface drivers must be either compiled into the
3119 kernel or must reside on the root partition.
3122 The keyboard bell sound.
3129 if the default behavior is desired.
3130 For details, refer to the
3135 If set to a non-null string, the virtual console's keyboard input is
3141 no keymap is installed, otherwise the value is used to install
3142 the keymap file found in
3143 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3146 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3151 The keyboard repeat speed.
3158 if the default behavior is desired.
3163 attempt to program the function keys with the value.
3165 be a single string of the form:
3166 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3169 Can be set to the value of
3172 .Dq Li destructive ,
3175 to set the cursor behavior explicitly or choose the default behavior.
3180 no screen map is installed, otherwise the value is used to install
3181 the screen map file in
3182 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3183 This parameter is ignored when using
3185 as the console driver.
3190 the default 8x16 font value is used for screen size requests, otherwise
3192 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3194 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3195 is used (depending on the console driver being used).
3200 the default 8x14 font value is used for screen size requests, otherwise
3202 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3204 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3205 is used (depending on the console driver being used).
3210 the default 8x8 font value is used for screen size requests, otherwise
3212 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3214 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3215 is used (depending on the console driver being used).
3220 the default screen blanking interval is used, otherwise it is set
3228 this is the actual screen saver to use
3229 .Li ( blank , snake , daemon ,
3231 .It Va moused_nondefault_enable
3235 the mouse device specified on
3236 the command line is not automatically treated as enabled by the
3237 .Pa /etc/rc.d/moused
3239 Having this variable set to
3245 to be enabled as soon as it is plugged in.
3246 .It Va moused_enable
3252 daemon is started for doing cut/paste selection on the console.
3255 This is the protocol type of the mouse connected to this host.
3256 This variable must be set if
3263 is able to detect the appropriate mouse type automatically in many cases.
3264 Set this variable to
3266 to let the daemon detect it, or
3267 select one from the following list if the automatic detection fails.
3269 If the mouse is attached to the PS/2 mouse port, choose
3273 regardless of the brand and model of the mouse.
3275 mouse is attached to the bus mouse port, choose
3279 All other protocols are for serial mice and will not work with
3280 the PS/2 and bus mice.
3281 If this is a USB mouse,
3283 is the only protocol type which will work.
3285 .Bl -tag -width ".Li x10mouseremote" -compact
3287 Microsoft mouse (serial)
3289 Microsoft IntelliMouse (serial)
3291 Mouse systems Corp.\& mouse (serial)
3293 MM Series mouse (serial)
3295 Logitech mouse (serial)
3299 Logitech MouseMan and TrackMan (serial)
3301 ALPS GlidePoint (serial)
3302 .It Li thinkingmouse
3303 Kensington ThinkingMouse (serial)
3307 MM HitTablet (serial)
3308 .It Li x10mouseremote
3309 X10 MouseRemote (serial)
3311 Interlink VersaPad (serial)
3314 Even if the mouse is not in the above list, it may be compatible
3315 with one in the list.
3316 Refer to the manual page for
3318 for compatibility information.
3320 It should also be noted that while this is enabled, any
3321 other client of the mouse (such as an X server) should access
3322 the mouse through the virtual mouse device,
3324 and configure it as a
3326 type mouse, since all
3327 mouse data is converted to this single canonical format when
3330 If the client program does not support the
3336 It is the second preferred type.
3343 this is the actual port the mouse is on.
3346 for a COM1 serial mouse,
3350 for a bus mouse, for example.
3355 is set, its value is used as an additional set of flags to pass to the
3358 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3360 .Va moused_nondefault_enable
3363 daemon is started for a non-default port, the
3364 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3365 set of options has precedence over and replaces the default
3369 is the name of the non-default port, i.e.,\&
3372 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3373 it is possible to set up a different set of default flags for each
3376 For example, you can use
3380 to make your laptop's touchpad more comfortable to use,
3381 but an empty set of options for
3382 .Va moused_ums0_flags
3385 mouse has three or more buttons.
3386 .It Va mousechar_start
3390 the default mouse cursor character range
3391 .Li 0xd0 Ns - Ns Li 0xd3
3393 otherwise the range start is set
3398 Use if the default range is occupied in the language code table.
3399 .It Va allscreens_flags
3403 is run with these options for each of the virtual terminals
3407 will enable the mouse pointer on all virtual terminals
3412 .It Va allscreens_kbdflags
3416 is run with these options for each of the virtual terminals
3424 scrollback (history) buffer to 200 lines.
3431 daemon at system boot time.
3437 .Pa /usr/sbin/cron ) .
3444 these are the flags to pass to
3450 enable the special handling of transitions to and from the
3451 Daylight Saving Time in
3453 (equivalent to using the flag
3460 .Pa /usr/sbin/lpd ) .
3467 daemon at system boot time.
3474 these are the flags to pass to the
3477 .It Va chkprintcap_enable
3483 command before starting the
3486 .It Va chkprintcap_flags
3491 .Va chkprintcap_enable
3494 these are the flags to pass to the
3499 which causes missing directories to be created.
3500 .It Va mta_start_script
3502 This variable specifies the full path to the script to run to start
3503 a mail transfer agent.
3505 .Pa /etc/rc.sendmail .
3509 .Pa /etc/rc.sendmail
3510 uses are documented in the
3515 Indicates the device (usually a swap partition) to which a crash dump
3516 should be written in the event of a system crash.
3517 If the value of this variable is
3519 the first suitable swap device listed in
3521 will be used as dump device.
3522 Otherwise, the value of this variable is passed as the argument to
3524 To disable crash dumps, set this variable to
3528 When the system reboots after a crash and a crash dump is found on the
3529 device specified by the
3533 will save that crash dump and a copy of the kernel to the directory
3537 The default value is
3546 .It Va savecore_flags
3548 If crash dumps are enabled, these are the flags to pass to the
3555 to turn on user and group disk quotas on system startup via the
3557 command for all file systems marked as having quotas enabled in
3559 The kernel must be built with
3561 for disk quotas to function.
3566 to enable user and group disk quota checking via the
3569 .It Va quotacheck_flags
3579 these are the flags to pass to the
3584 which checks quotas for all file systems with quotas enabled in
3586 .It Va quotaon_flags
3592 these are the flags to pass to the
3597 which enables quotas for all file systems with quotas enabled in
3599 .It Va quotaoff_flags
3605 these are the flags to pass to the
3607 utility when shutting down the quota system.
3610 which disables quotas for all file systems with quotas enabled in
3612 .It Va accounting_enable
3616 to enable system accounting through the
3623 to enable iBCS2 (SCO) binary emulation at system initial boot
3625 .It Va ibcs2_loaders
3633 this specifies a list of additional iBCS2 loaders to enable.
3634 .It Va firstboot_sentinel
3636 This variable specifies the full path to a
3639 If a file exists with this path,
3643 keyword will be run on startup and the sentinel file will be deleted
3644 after the boot process completes.
3645 The sentinel file must be located on a writable file system which is
3646 mounted no later than
3647 .Va early_late_divider
3648 to function properly.
3655 to enable Linux/ELF binary emulation at system initial
3661 enable SysVR4 emulation at boot time.
3662 .It Va sysvipc_enable
3666 load System V IPC primitives at boot time.
3667 .It Va clear_tmp_enable
3678 to disable removing of X11 lock files,
3679 and the removal and (secure) recreation
3680 of the various socket directories for X11
3682 .It Va ldconfig_paths
3684 Set to the list of shared library paths to use with
3688 will always be added first, so it need not appear in this list.
3689 .It Va ldconfig32_paths
3691 Set to the list of 32-bit compatibility shared library paths to
3694 .It Va ldconfig_paths_aout
3696 Set to the list of shared library paths to use with
3701 .It Va ldconfig_insecure
3705 utility normally refuses to use directories
3706 which are writable by anyone except root.
3707 Set this variable to
3709 to disable that security check during system startup.
3710 .It Va ldconfig_local_dirs
3712 Set to the list of local
3715 The names of all files in the directories listed will be
3716 passed as arguments to
3718 .It Va ldconfig_local32_dirs
3720 Set to the list of local 32-bit compatibility
3723 The names of all files in the directories listed will be
3724 passed as arguments to
3725 .Dq Nm ldconfig Fl 32 .
3726 .It Va kern_securelevel_enable
3730 to set the kernel security level at system startup.
3731 .It Va kern_securelevel
3733 The kernel security level to set at startup.
3734 The allowed range of
3736 ranges from \-1 (the compile time default) to 3 (the
3740 for the list of possible security levels and their effect
3741 on system operation.
3744 Path to the SSH server program
3745 .Pa ( /usr/sbin/sshd
3753 at system boot time.
3760 these are the flags to pass to the
3765 Path to the FTP server program
3766 .Pa ( /usr/libexec/ftpd
3774 as a stand-alone daemon at system boot time.
3781 these are the additional flags to pass to the
3784 .It Va watchdogd_enable
3790 daemon at boot time.
3791 This requires that the kernel have been compiled with a
3794 .It Va watchdogd_flags
3797 .Va watchdogd_enable
3800 these are the flags passed to the
3803 .It Va devfs_rulesets
3805 List of files containing sets of rules for
3807 .It Va devfs_system_ruleset
3809 Rule name(s) to apply to the system
3812 .It Va devfs_set_rulesets
3814 Pairs of already-mounted
3816 directories and rulesets that should be applied to them.
3817 For example: /mount/dev=ruleset_name
3818 .It Va devfs_load_rulesets
3820 If set, always load the default rulesets listed in
3821 .Va devfs_rulesets .
3822 .It Va performance_cx_lowest
3824 CPU idle state to use while on AC power.
3829 should use the lowest power state available while
3831 indicates that the lowest latency state (less power savings) should be used.
3832 .It Va performance_cpu_freq
3834 CPU clock frequency to use while on AC power.
3839 should use the lowest frequency available while
3841 indicates that the highest frequency (less power savings) should be used.
3842 .It Va economy_cx_lowest
3844 CPU idle state to use when off AC power.
3849 should use the lowest power state available while
3851 indicates that the lowest latency state (less power savings) should be used.
3852 .It Va economy_cpu_freq
3854 CPU clock frequency to use when off AC power.
3859 should use the lowest frequency available while
3861 indicates that the highest frequency (less power savings) should be used.
3866 any configured jails will not be started.
3869 The configuration filename used by
3872 The default value is
3873 .Pa /etc/jail.conf .
3874 .It Va jail_parallel_start
3878 all configured jails will be started in the background (in parallel).
3882 When set, use as default value for
3883 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3888 A space separated list of names for jails.
3889 If this variable is empty,
3892 instances in the configuration file will be configured.
3893 This is purely a configuration aid to help identify and
3894 configure multiple jails.
3895 The names specified in this list will be used to
3896 identify settings common to an instance of a jail,
3897 and should contain alphanumeric characters only.
3898 The literal jail name of
3902 .It Va jail_* variables
3903 Note that older releases supported per-jail configuration via
3907 hostname of a jail named
3909 was able to be set by
3910 .Li jail_vjail_hostname .
3911 These per-jail configuration variables are now obsolete in favor of
3914 For backward compatibility,
3915 when per-jail configuration variables are defined,
3917 configuration files are created as
3918 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3921 The following per-jail parameters are handled by
3923 script out of their corresponding
3926 In addition to them, parameters in
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3928 will be added to the configuration file.
3929 They must be a semi-colon
3937 .Bl -tag -width "host.hostname" -offset indent
3940 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3941 .It Li host.hostname
3943 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3944 .It Li exec.consolelog
3946 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3947 The default value is
3948 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3951 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3952 .It Li vnet.interface
3954 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3957 parameter will be enabled and cannot be specified with
3958 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
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
3965 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3968 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3974 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3975 The parameter name was
3977 in some older releases.
3978 .It Li exec.prestart
3980 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3981 .It Li exec.poststart
3983 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3986 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3989 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3990 .It Li exec.poststop
3992 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3995 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3997 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3998 contain IPv4 addresses
4001 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4003 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4004 contain IPv6 addresses
4007 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4010 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4011 .It Li devfs_ruleset
4013 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
4014 This must be an integer,
4016 .It Li mount.fdescfs
4018 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4019 .It Li allow.set_hostname
4021 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4022 .It Li allow.rawsocket
4024 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4025 .It Li allow.sysvipc
4027 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4029 .\" -----------------------------------------------------
4030 .It Va harvest_interrupt
4034 to use hardware interrupts as an entropy source.
4037 for more information.
4038 .It Va harvest_ethernet
4042 to use LAN traffic as an entropy source.
4045 for more information.
4046 .It Va harvest_p_to_p
4050 to use serial line traffic as an entropy source.
4053 for more information.
4058 to disable caching entropy via
4060 Otherwise set to the directory used to store entropy files in.
4065 to disable caching entropy through reboots.
4066 Otherwise set to the filename used to store cached entropy through
4068 This file should be located on the root file system to seed the
4070 device as early as possible in the boot process.
4071 .It Va entropy_save_sz
4073 Size of the entropy cache files saved by
4076 .It Va entropy_save_num
4078 Number of entropy cache files to save by
4092 Configuration file for
4101 .Pa /var/run/dmesg.boot
4103 .It Va rcshutdown_timeout
4105 If set, start a watchdog timer in the background which will terminate
4109 has not completed within the specified time (in seconds).
4110 Notice that in addition to this soft timeout,
4112 also applies a hard timeout for the execution of
4114 This is configured via
4117 .Va kern.init_shutdown_timeout
4118 and defaults to 120 seconds.
4119 Setting the value of
4120 .Va rcshutdown_timeout
4121 to more than 120 seconds will have no effect until the
4124 .Va kern.init_shutdown_timeout
4126 .It Va virecover_enable
4130 to prevent the system from trying to
4131 recover pre-maturely terminated
4134 .It Va ugidfw_enable
4139 .Xr mac_bsdextended 4
4140 module upon system initialization and load a default
4142 .It Va bsdextended_script
4145 .Xr mac_bsdextended 4
4146 ruleset file to load.
4147 The default value of this variable is
4148 .Pa /etc/rc.bsdextended .
4149 .It Va newsyslog_enable
4156 .It Va newsyslog_flags
4159 .Va newsyslog_enable
4162 these are the flags to pass to the
4167 which causes log files flagged with a
4170 .It Va mdconfig_md Ns Aq Ar X
4180 must be specified and either a
4182 for malloc or swap backed
4190 .Va mdconfig_md Ns Aq Ar X
4191 variables are evaluated until one variable is unset or null.
4192 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4194 Optional arguments passed to
4200 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4202 An ownership specification passed to
4211 device and the mount point will be changed.
4212 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4214 A mode string passed to
4223 device and the mount point will be changed.
4224 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4226 Files to be copied to the mount point of the
4230 after it has been mounted.
4231 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4233 Command to execute after the specified
4238 Note that the command is passed to
4244 variables can be used to reference respectively the
4246 device and the mount point.
4251 one could set the following:
4253 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4255 .It Va autobridge_interfaces
4257 Set to the list of bridge interfaces that will have newly arriving interfaces
4258 checked against to be automatically added.
4261 then for each whitespace separated
4264 .Va autobridge_ Ns Aq Ar element
4265 variable is assumed to exist which has a whitespace separated list of interface
4266 names to match, these names can use wildcards.
4269 autobridge_interfaces="bridge0"
4270 autobridge_bridge0="tap* dc0 vlan[345]"
4276 enable support for sound mixer.
4277 .It Va hcsecd_enable
4281 enable Bluetooth security daemon.
4282 .It Va hcsecd_config
4284 Configuration file for
4287 .Pa /etc/bluetooth/hcsecd.conf .
4292 enable Bluetooth Service Discovery Protocol daemon.
4300 .It Va sdpd_groupname
4304 group to run as after it initializes.
4307 .It Va sdpd_username
4311 user to run as after it initializes.
4314 .It Va bthidd_enable
4318 enable Bluetooth Human Interface Device daemon.
4319 .It Va bthidd_config
4321 Configuration file for
4324 .Pa /etc/bluetooth/bthidd.conf .
4327 Path to a file, where
4329 will store information about known HID devices.
4331 .Pa /var/db/bthidd.hids .
4332 .It Va rfcomm_pppd_server_enable
4336 enable Bluetooth RFCOMM PPP wrapper daemon.
4337 .It Va rfcomm_pppd_server_profile
4339 The name of the profile to use from
4340 .Pa /etc/ppp/ppp.conf .
4341 Multiple profiles can be specified here.
4342 Also used to specify per-profile overrides.
4343 When the profile name contains any of the characters
4345 they are translated to
4347 for the proposes of the override variable names.
4348 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4350 Overrides local address to listen on.
4356 The address can be specified as BD_ADDR or name.
4357 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4359 Overrides local RFCOMM channel to listen on.
4362 will listen on RFCOMM channel 1.
4363 Must set properly if multiple profiles used in the same time.
4364 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4368 if it should register Serial Port service on the specified RFCOMM channel.
4371 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4375 if it should register Dial-Up Networking service on the specified
4379 .It Va ubthidhci_enable
4383 change the USB Bluetooth controller from HID mode to HCI mode.
4384 You also need to specify the location of USB Bluetooth controller with the
4385 .Va ubthidhci_busnum
4389 .It Va ubthidhci_busnum
4390 Bus number where the USB Bluetooth controller is located.
4393 on your system to find this information.
4394 .It Va ubthidhci_addr
4395 Bus address of the USB Bluetooth controller.
4398 on your system to find this information.
4399 .It Va netwait_enable
4403 delays the start of network-reliant services until
4405 is up and ICMP packets to a destination defined in
4408 Link state is examined first, followed by
4410 an IP address to verify network usability.
4411 If no destination can be reached or timeouts are exceeded,
4412 network services are started anyway with no guarantee that
4413 the network is usable.
4414 Use of this variable requires both
4422 This variable contains a space-delimited list of IP addresses to
4424 DNS hostnames should not be used as resolution is not guaranteed
4425 to be functional at this point.
4426 If multiple IP addresses are specified,
4427 each will be tried until one is successful or the list is exhausted.
4428 .It Va netwait_timeout
4430 Indicates the total number of seconds to perform a
4432 against each IP address in
4434 at a rate of one ping per second.
4435 If any of the pings are successful,
4436 full network connectivity is considered reliable.
4441 Defines the name of the network interface on which watch for link.
4443 is used to monitor the interface, looking for
4444 .Dq Li status: no carrier .
4445 Once gone, the link is considered up.
4448 interface if desired.
4449 .It Va netwait_if_timeout
4451 Defines the total number of seconds to wait for link to become usable,
4452 polled at a 1-second interval.
4460 rules from the defined ruleset.
4461 The kernel must be built with
4464 .Cd "options RCTL" .
4470 This variables contains the
4476 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4477 .It Pa /etc/defaults/rc.conf
4479 .It Pa /etc/rc.conf.local
4509 .Xr newsyslog.conf 5 ,
4579 .An Jordan K. Hubbard .