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 pflog_instances
941 If logging to more than one
943 interface is desired,
945 is set to the list of
947 instances that should be started at system boot time. If
949 is set, for each whitespace-seperated
952 .Ao Ar element Ac Ns Va _dev
954 .Ao Ar element Ac Ns Va _logfile
955 elements are assumed to exist.
956 .Ao Ar element Ac Ns Va _dev
959 interface to be watched by the named
962 .Ao Ar element Ac Ns Va _logfile
963 must contain the name of the logfile that will be used by the
966 .It Va ftpproxy_enable
977 packet filter in translating ftp connections.
978 .It Va ftpproxy_flags
981 This variable contains additional flags passed to the
984 .It Va ftpproxy_instances
986 Empty by default. If multiple instances of
988 are desired at boot time,
989 .Va ftpproxy_instances
990 should contain a whitespace-seperated list of instance names. For each
992 in the list, a variable named
993 .Ao Ar element Ac Ns Va _flags
994 should be defined, containing the command-line flags to be passed to the
1006 state changes to other hosts over the network by means of
1011 must also be set then.
1012 .It Va pfsync_syncdev
1015 This variable specifies the name of the network interface
1017 should operate through.
1018 It must be set accordingly if
1022 .It Va pfsync_syncpeer
1025 This variable is optional.
1026 By default, state change messages are sent out on the synchronisation
1027 interface using IP multicast packets.
1028 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1030 When a peer address is specified using the
1032 option, the peer address is used as a destination for the pfsync
1033 traffic, and the traffic can then be protected using
1037 manpage for more details about using
1042 .It Va pfsync_ifconfig
1045 This variable can contain additional options to be passed to the
1047 command used to set up
1049 .It Va tcp_extensions
1056 disables certain TCP options as described by
1062 might help remedy such problems with connections as randomly hanging
1063 or other weird behavior.
1064 Some network devices are known
1065 to be broken with respect to these options.
1068 Set to 0 by default.
1072 .Va net.inet.tcp.log_in_vain
1074 .Va net.inet.udp.log_in_vain ,
1079 are set to the given value.
1080 .It Va tcp_keepalive
1087 will disable probing idle TCP connections to verify that the
1088 peer is still up and reachable.
1089 .It Va tcp_drop_synfin
1096 will cause the kernel to ignore TCP frames that have both
1097 the SYN and FIN flags set.
1098 This prevents OS fingerprinting, but may
1099 break some legitimate applications.
1100 .It Va icmp_drop_redirect
1107 will cause the kernel to ignore ICMP REDIRECT packets.
1110 for more information.
1111 .It Va icmp_log_redirect
1118 will cause the kernel to log ICMP REDIRECT packets.
1120 the log messages are not rate-limited, so this option should only be used
1121 for troubleshooting networks.
1124 for more information.
1125 .It Va icmp_bmcastecho
1129 to respond to broadcast or multicast ICMP ping packets.
1132 for more information.
1133 .It Va ip_portrange_first
1137 this is the first port in the default portrange.
1140 for more information.
1141 .It Va ip_portrange_last
1145 this is the last port in the default portrange.
1148 for more information.
1149 .It Va network_interfaces
1151 Set to the list of network interfaces to configure on this host or
1153 (the default) for all current interfaces.
1155 .Va network_interfaces
1156 variable to anything other than the default is deprecated.
1157 Interfaces that the administrator wishes to store configuration for,
1158 but not start at boot should be configured with the
1161 .Va ifconfig_ Ns Aq Ar interface
1162 variables as described below.
1165 .Va ifconfig_ Ns Aq Ar interface
1166 variable is also assumed to exist for each value of
1168 When an interface name contains any of the characters
1170 they are translated to
1173 The variable can contain arguments to
1175 as well as special case-insensitive keywords described below.
1176 Such keywords are removed before passing the value to
1178 while the order of the other arguments is preserved.
1180 It is possible to add IP alias entries using
1182 syntax with the address family keyword such as
1184 Assuming that the interface in question was
1186 it might look something like this:
1188 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1189 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1192 It also possible to configure multiple IP addresses in Classless
1193 Inter-Domain Routing
1196 whose each address component can be a range like
1197 .Li inet 192.0.2.5-23/24
1199 .Li inet6 2001:db8:1-f::1/64 .
1200 This notation allows address and prefix length part only,
1201 not the other address modifiers.
1202 Note that the maximum number of the generated addresses from a range
1203 specification is limited to an integer value specified in
1204 .Va netif_ipexpand_max
1207 because a small typo can unexpectedly generate a large number of addresses.
1208 The default value is
1210 It can be increased by adding the following line into
1213 netif_ipexpand_max="4096"
1217 .Li 192.0.2.5-23/24 ,
1218 the address 192.0.2.5 will be configured with the
1219 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1220 the non-conflicting netmask /32 as explained in the
1223 Note that this special netmask handling is only for
1225 not for the other address families such as
1228 With the interface in question being
1230 an example could look like:
1232 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1233 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1239 .Va ipv4_addrs_ Ns Aq Ar interface
1240 variable was supported for IPv4 CIDR address notation.
1241 It is now deprecated because the functionality was integrated into
1242 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1244 .Va ipv4_addrs_ Ns Aq Ar interface
1245 is still supported for backward compatibility.
1248 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1249 entry with an address family keyword,
1250 its contents are passed to
1252 Execution stops at the first unsuccessful access, so if
1253 something like this is present:
1255 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1256 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1257 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1258 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1261 Then note that alias4 would
1263 be added since the search would
1264 stop with the missing
1267 Because of this difficult to manage behavior,
1269 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1270 variable, which has the same functionality as
1271 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1272 and can have all of entries in a variable like the following:
1274 ifconfig_ed0_aliases="\\
1275 inet 127.0.0.251 netmask 0xffffffff \\
1276 inet 127.0.0.252 netmask 0xffffffff \\
1277 inet 127.0.0.253 netmask 0xffffffff \\
1278 inet 127.0.0.254 netmask 0xffffffff"
1281 It also supports CIDR notation.
1284 .Pa /etc/start_if. Ns Aq Ar interface
1285 file is present, it is read and executed by the
1288 before configuring the interface as specified in the
1289 .Va ifconfig_ Ns Aq Ar interface
1291 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1295 .Va vlans_ Ns Aq Ar interface
1299 interface will be created for each item in the list with the
1303 If a vlan interface's name is a number,
1304 then that number is used as the vlan tag and the new vlan interface is
1306 .Ar interface . Ns Ar tag .
1308 the vlan tag must be specified via a
1311 .Va create_args_ Ns Aq Ar interface
1314 To create a vlan device named
1318 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1321 ifconfig_em0_101="inet 192.0.2.1/24"
1324 To create a vlan device named
1328 with the vlan tag 102:
1331 create_args_myvlan="vlan 102"
1335 .Va wlans_ Ns Aq Ar interface
1339 interface will be created for each item in the list with the
1343 Further wlan cloning arguments may be passed to the
1346 command by setting the
1347 .Va create_args_ Ns Aq Ar interface
1351 devices must be created for each wireless devices as of
1357 may be specified with an
1358 .Va wlandebug_ Ns Aq Ar interface
1360 The contents of this variable will be passed directly to
1364 .Va ifconfig_ Ns Aq Ar interface
1365 contains the keyword
1367 then the interface will not be configured
1369 .Pa /etc/pccard_ether
1371 .Va network_interfaces
1375 It is possible to bring up an interface with DHCP by adding
1378 .Va ifconfig_ Ns Aq Ar interface
1380 For instance, to initialize the
1383 it is possible to use something like:
1388 If you want to configure your wireless interface with
1389 .Xr wpa_supplicant 8
1390 for use with WPA, EAP/LEAP or WEP, you need to add
1393 .Va ifconfig_ Ns Aq Ar interface
1396 On the other hand, if you want to configure your wireless interface with
1401 .Va ifconfig_ Ns Aq Ar interface
1404 will use the settings from
1405 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1407 Finally, you can add
1409 options in this variable, in addition to the
1410 .Pa /etc/start_if. Ns Aq Ar interface
1412 For instance, to configure an
1414 wireless device in station mode with an address obtained
1415 via DHCP, using WPA authentication and 802.11b mode, it is
1416 possible to use something like:
1419 ifconfig_wlan0="DHCP WPA mode 11b"
1423 .Va ifconfig_ Ns Aq Ar interface
1424 form, a fallback variable
1425 .Va ifconfig_DEFAULT
1427 It will be used for all interfaces with no
1428 .Va ifconfig_ Ns Aq Ar interface
1430 This is intended to replace the no longer supported
1434 It is also possible to rename an interface by doing:
1436 ifconfig_ed0_name="net0"
1437 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1441 This variable is deprecated.
1443 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1445 .Va ipv6_activate_all_interfaces
1450 .Dq Li inet6 accept_rtadv
1452 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1454 .Va ipv6_activate_all_interfaces
1459 This variable is deprecated.
1461 .Va ip6addrctl_policy
1466 the default address selection policy table set by
1468 will be IPv6-preferred.
1472 the default address selection policy table set by
1474 will be IPv4-preferred.
1475 .It Va ipv6_activate_all_interfaces
1477 This controls initial configuration on IPv6-capable
1478 interfaces with no corresponding
1479 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1481 Note that it is not always necessary to set this variable to
1483 to use IPv6 functionality on
1485 In most cases, just configuring
1486 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1491 all interfaces which do not have a corresponding
1492 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1493 variable will be marked as
1496 This means that all of IPv6 functionality on that interface
1497 is completely disabled to enforce a security policy.
1498 If the variable is set to
1500 the flag will be cleared on all of the interfaces.
1502 In most cases, just defining an
1503 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1504 for an IPv6-capable interface should be sufficient.
1505 However, if an interface is added dynamically
1506 .Pq by some tunneling protocols such as PPP, for example ,
1507 it is often difficult to define the variable in advance.
1508 In such a case, configuring the
1510 flag can be disabled by setting this variable to
1513 For more details of the
1516 .Dq Li inet6 ifdisabled ,
1526 privacy addresses will be generated for each IPv6
1527 interface as described in RFC 4941.
1528 .It Va ipv6_network_interfaces
1530 This is the IPv6 equivalent of
1531 .Va network_interfaces .
1532 Normally manual configuration of this variable is not needed.
1533 .It Va ipv6_cpe_wanif
1535 If the variable is set to an interface name,
1539 .Dq inet6 -no_radr accept_rtadv
1540 will be added to the specified interface automatically before evaluating
1541 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1545 .Va net.inet6.ip6.rfc6204w3
1547 .Va net.inet6.ip6.no_radr
1550 This means the specified interface will accept ICMPv6 Router
1551 Advertisement messages on that link and add the discovered
1552 routers into the Default Router List.
1553 While the other interfaces can still accept RA messages if the
1554 .Dq inet6 accept_rtadv
1555 option is specified, adding
1556 routes into the Default Router List will be disabled by
1563 Note that ICMPv6 Router Advertisement messages will be
1565 .Va net.inet6.ip6.forwarding
1567 .Pq packet forwarding is enabled
1569 .Va net.inet6.ip6.rfc6204w3
1574 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1576 IPv6 functionality on an interface should be configured by
1577 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1578 instead of setting ifconfig parameters in
1579 .Va ifconfig_ Ns Aq Ar interface .
1580 If this variable is empty, all of IPv6 configurations on the
1581 specified interface by other variables such as
1582 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1585 Aliases should be set by
1586 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1592 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1593 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1596 Interfaces that have an
1597 .Dq Li inet6 accept_rtadv
1599 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1600 setting will be automatically configured by SLAAC
1601 .Pq StateLess Address AutoConfiguration
1607 Note that a link-local address will be automatically configured in
1608 addition to the configured global-scope addresses because the IPv6
1609 specifications require it on each link.
1610 The address is calculated from the MAC address by using an algorithm
1617 If only a link-local address is needed on the interface,
1618 the following configuration can be used:
1620 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1623 A link-local address can also be configured manually.
1624 This is useful for the default router address of an IPv6 router
1625 so that it does not change when the network interface
1629 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1631 .It Va ipv6_prefix_ Ns Aq Ar interface
1633 If one or more prefixes are defined in
1634 .Va ipv6_prefix_ Ns Aq Ar interface
1635 addresses based on each prefix and the EUI-64 interface index will be
1636 configured on that interface.
1637 Note that this variable will be ignored when
1638 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1641 For example, the following configuration
1643 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1646 is equivalent to the following:
1648 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1649 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1650 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1651 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1654 These Subnet-Router anycast addresses will be added only when
1655 .Va ipv6_gateway_enable
1657 .It Va ipv6_default_interface
1661 this is the default output interface for scoped addresses.
1662 This works only with ipv6_gateway_enable="NO".
1663 .It Va ip6addrctl_enable
1665 This variable is to enable configuring default address selection policy table
1667 The table can be specified in another variable
1668 .Va ip6addrctl_policy .
1670 .Va ip6addrctl_policy
1671 the following keywords can be specified:
1672 .Dq Li ipv4_prefer ,
1673 .Dq Li ipv6_prefer ,
1683 installs a pre-defined policy table described in Section 2.1
1691 is specified, it attempts to read a file
1692 .Pa /etc/ip6addrctl.conf
1694 If this file is found,
1696 reads and installs it.
1697 If not found, a policy is automatically set
1699 .Va ipv6_activate_all_interfaces
1700 variable; if the variable is set to
1702 the IPv6-preferred one is used.
1703 Otherwise IPv4-preferred.
1705 The default value of
1706 .Va ip6addrctl_enable
1708 .Va ip6addrctl_policy
1714 .It Va cloned_interfaces
1716 Set to the list of clonable network interfaces to create on this host.
1717 Further cloning arguments may be passed to the
1720 command for each interface by setting the
1721 .Va create_args_ Ns Aq Ar interface
1723 If an interface name is specified with
1726 the interface will not be destroyed even when
1728 script is invoked with
1731 This is useful when reconfiguring the interface without destroying it.
1733 .Va cloned_interfaces
1734 are automatically appended to
1735 .Va network_interfaces
1737 .It Va cloned_interfaces_sticky
1739 This variable is to globally enable functionality of
1742 .Va cloned_interfaces
1744 The default value is
1746 Even if this variable is specified to
1749 keyword can be used to override it on per interface basis.
1750 .It Va gif_interfaces
1752 This variable is deprecated in favor of
1753 .Va cloned_interfaces .
1756 tunnel interfaces to configure on this host.
1758 .Va gifconfig_ Ns Aq Ar interface
1759 variable is assumed to exist for each value of
1761 The value of this variable is used to configure the link layer of the
1762 tunnel according to the syntax of the
1766 Additionally, this option ensures that each listed interface is created
1771 before attempting to configure it.
1772 .It Va sppp_interfaces
1776 interfaces to configure on this host.
1778 .Va spppconfig_ Ns Aq Ar interface
1779 variable is assumed to exist for each value of
1781 Each interface should also be configured by a general
1782 .Va ifconfig_ Ns Aq Ar interface
1786 for more information about available options.
1796 The name of the profile to use from
1797 .Pa /etc/ppp/ppp.conf .
1798 Also used for per-profile overrides of
1803 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1804 When the profile name contains any of the characters
1806 they are translated to
1808 for the proposes of the override variable names.
1811 Mode in which to run the
1814 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1816 Overrides the global
1826 See the manual for a full description.
1831 enables network address translation.
1832 Used in conjunction with
1834 allows hosts on private network addresses access to the Internet using
1835 this host as a network address translating router.
1836 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1838 Overrides the global
1842 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1844 Set the unit number to be used for this profile.
1845 See the manual description of
1850 The name of the user under which
1858 .It Va rc_conf_files
1860 This option is used to specify a list of files that will override
1862 .Pa /etc/defaults/rc.conf .
1863 The files will be read in the order in which they are specified and should
1864 include the full path to the file.
1865 By default, the files specified are
1868 .Pa /etc/rc.conf.local
1874 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1876 .It Va gptboot_enable
1880 .Pa /etc/rc.d/gptboot
1881 will log if the system successfully (or not) booted from a GPT partition,
1887 .It Va gbde_autoattach_all
1892 will attempt to automatically initialize your .bde devices in
1896 List the devices that the script should try to attach,
1901 The directory where the
1903 lockfiles are located.
1904 The default lockfile directory is
1907 The lockfile for each individual
1909 device can be overridden by setting the variable
1910 .Va gbde_lock_ Ns Aq Ar device ,
1913 is the encrypted device without the
1918 .It Va gbde_attach_attempts
1920 Number of times to attempt attaching to a
1922 device, i.e., how many times the user is asked for the pass-phrase.
1926 List of devices to automatically attach on boot.
1927 Note that .eli devices from
1929 are automatically appended to this list.
1932 Number of times user is asked for the pass-phrase.
1933 If empty, it will be taken from
1934 .Va kern.geom.eli.tries
1936 .It Va geli_default_flags
1938 Default flags to use by
1940 when configuring disk encryption.
1941 Flags can be configured for every device separately by defining
1942 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1944 .It Va geli_autodetach
1946 Specifies if GELI devices should be marked for detach on last close after
1947 file systems are mounted.
1950 This can be changed for every device separately by defining
1951 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1953 .It Va root_rw_mount
1958 After the file systems are checked at boot time, the root file system
1959 is remounted as read-write if this is set to
1961 Diskless systems that mount their root file system from a read-only remote
1962 NFS share should set this to
1966 .It Va fsck_y_enable
1971 will be run with the
1973 flag if the initial preen
1974 of the file systems fails.
1975 .It Va background_fsck
1979 the system will attempt to run
1981 in the background where possible.
1982 .It Va background_fsck_delay
1984 The amount of time in seconds to sleep before starting a background
1986 It defaults to sixty seconds to allow large applications such as
1987 the X server to start before disk I/O bandwidth is monopolized by
1989 If set to a negative number, the background file system check will be
1990 delayed indefinitely to allow the administrator to run it at a more
1992 For example it may be run from
1994 by adding a line like
1996 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2002 List of file system types that are network-based.
2003 This list should generally not be modified by end users.
2005 .Va extra_netfs_types
2007 .It Va extra_netfs_types
2009 If set to something other than
2012 this variable extends the list of file system types
2013 for which automatic mounting at startup by
2015 should be delayed until the network is initialized.
2017 a whitespace-separated list of network file system descriptor pairs,
2018 each consisting of a file system type as passed to
2020 and a human-readable, one-word description,
2023 Extending the default list in this way is only necessary
2024 when third party file system types are used.
2025 .It Va syslogd_enable
2032 .It Va syslogd_program
2037 .Pa /usr/sbin/syslogd ) .
2038 .It Va syslogd_flags
2044 these are the flags to pass to
2053 .It Va inetd_program
2058 .Pa /usr/sbin/inetd ) .
2065 these are the flags to pass to
2074 .It Va hastd_program
2086 these are the flags to pass to
2088 .It Va local_unbound_enable
2094 daemon as a local caching resolver.
2095 .It Va kerberos5_server_enable
2099 to start a Kerberos 5 authentication server
2101 .It Va kerberos5_server
2104 .Va kerberos5_server_enable
2107 this is the path to Kerberos 5 Authentication Server.
2108 .It Va kerberos5_server_flags
2111 This variable contains additional flags to be passed to the Kerberos 5
2112 authentication server.
2113 .It Va kadmind5_server_enable
2119 the Kerberos 5 Administration Daemon; set to
2122 .It Va kadmind5_server
2125 .Va kadmind5_server_enable
2128 this is the path to Kerberos 5 Administration Daemon.
2129 .It Va kpasswdd_server_enable
2135 the Kerberos 5 Password-Changing Daemon; set to
2138 .It Va kpasswdd_server
2141 .Va kpasswdd_server_enable
2144 this is the path to Kerberos 5 Password-Changing Daemon.
2151 the Kerberos 5 ticket forwarding daemon, at the boot time.
2157 .Pa /usr/libexec/kfd ) .
2164 daemon at boot time.
2171 these are the flags to pass to it.
2178 daemon at boot time.
2185 these are the flags to pass to it.
2188 manpage for more information.
2189 .It Va amd_map_program
2192 the specified program is run to get the list of
2197 maps are stored in NIS, one can set this to
2210 will be updated at boot time to reflect the kernel release
2215 will not be updated.
2216 .It Va nfs_client_enable
2220 run the NFS client daemons at boot time.
2221 .It Va nfs_access_cache
2224 .Va nfs_client_enable
2229 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2231 results should be cached.
2232 A value of 2-10 seconds will substantially reduce network
2233 traffic for many NFS operations.
2234 .It Va nfs_server_enable
2238 run the NFS server daemons at boot time.
2239 .It Va nfs_server_flags
2242 .Va nfs_server_enable
2245 these are the flags to pass to the
2248 .It Va nfsv4_server_enable
2251 .Va nfs_server_enable
2255 .Va nfsv4_server_enable
2258 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2259 .It Va nfsuserd_enable
2265 run the nfsuserd daemon, which is needed for NFSv4 in order
2266 to map between user/group names vs uid/gid numbers.
2268 .Va nfsv4_server_enable
2271 this will be forced enabled.
2272 .It Va nfsuserd_flags
2278 these are the flags to pass to the
2281 .It Va nfscbd_enable
2287 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2294 these are the flags to pass to the
2297 .It Va mountd_enable
2302 .Va nfs_server_enable
2308 It is commonly needed to run CFS without real NFS used.
2315 these are the flags to pass to the
2318 .It Va weak_mountd_authentication
2322 allow services like PCNFSD to make non-privileged mount
2324 .It Va nfs_reserved_port_only
2328 provide NFS services only on a secure port.
2329 .It Va nfs_bufpackets
2331 If set to a number, indicates the number of packets worth of
2332 socket buffer space to reserve on an NFS client.
2333 The kernel default is typically 4.
2334 Using a higher number may be
2335 useful on gigabit networks to improve performance.
2336 The minimum value is
2337 2 and the maximum is 64.
2338 .It Va rpc_lockd_enable
2342 and also an NFS server or client, run
2345 .It Va rpc_lockd_flags
2348 .Va rpc_lockd_enable
2351 these are the flags to pass to the
2354 .It Va rpc_statd_enable
2358 and also an NFS server or client, run
2361 .It Va rpc_statd_flags
2364 .Va rpc_statd_enable
2367 these are the flags to pass to the
2370 .It Va rpcbind_program
2375 .Pa /usr/sbin/rpcbind ) .
2376 .It Va rpcbind_enable
2382 service at boot time.
2383 .It Va rpcbind_flags
2389 these are the flags to pass to the
2392 .It Va keyserv_enable
2398 daemon on boot for running Secure RPC.
2399 .It Va keyserv_flags
2405 these are the flags to pass to
2408 .It Va pppoed_enable
2414 daemon at boot time to provide PPP over Ethernet services.
2415 .It Va pppoed_ Ns Aq Ar provider
2418 listens to requests to this
2424 argument of the same name.
2427 Additional flags to pass to
2429 .It Va pppoed_interface
2431 The network interface to run
2434 This is mandatory when
2444 service at boot time.
2445 This command is intended for networks of
2446 machines where a consistent
2448 for all hosts must be established.
2449 This is often useful in large NFS
2450 environments where time stamps on files are expected to be consistent
2458 these are the flags to pass to the
2461 .It Va ntpdate_enable
2468 This command is intended to
2469 synchronize the system clock only
2471 from some standard reference.
2472 .It Va ntpdate_config
2474 Configuration file for
2478 .It Va ntpdate_hosts
2480 A whitespace-separated list of NTP servers to synchronize with at startup.
2481 The default is to use the servers listed in
2482 .Va ntpdate_config ,
2483 if that file exists.
2484 .It Va ntpdate_program
2489 .Pa /usr/sbin/ntpdate ) .
2490 .It Va ntpdate_flags
2496 these are the flags to pass to the
2498 command (typically a hostname).
2505 command at boot time.
2511 .Pa /usr/sbin/ntpd ) .
2525 these are the flags to pass to the
2528 .It Va ntpd_sync_on_start
2535 flag, which syncs the system's clock on startup.
2538 for more information regarding the
2541 This is a preferred alternative to using
2546 .It Va nis_client_enable
2552 service at system boot time.
2553 .It Va nis_client_flags
2556 .Va nis_client_enable
2559 these are the flags to pass to the
2562 .It Va nis_ypset_enable
2568 daemon at system boot time.
2569 .It Va nis_ypset_flags
2572 .Va nis_ypset_enable
2575 these are the flags to pass to the
2578 .It Va nis_server_enable
2584 daemon at system boot time.
2585 .It Va nis_server_flags
2588 .Va nis_server_enable
2591 these are the flags to pass to the
2594 .It Va nis_ypxfrd_enable
2600 daemon at system boot time.
2601 .It Va nis_ypxfrd_flags
2604 .Va nis_ypxfrd_enable
2607 these are the flags to pass to the
2610 .It Va nis_yppasswdd_enable
2616 daemon at system boot time.
2617 .It Va nis_yppasswdd_flags
2620 .Va nis_yppasswdd_enable
2623 these are the flags to pass to the
2626 .It Va rpc_ypupdated_enable
2632 daemon at system boot time.
2633 .It Va bsnmpd_enable
2639 daemon at system boot time.
2640 Be sure to understand the security implications of running SNMP daemon
2648 these are the flags to pass to the
2651 .It Va defaultrouter
2655 create a default route to this host name or IP address
2656 (use an IP address if this router is also required to get to the
2658 .It Va ipv6_defaultrouter
2660 The IPv6 equivalent of
2662 .It Va static_arp_pairs
2664 Set to the list of static ARP pairs that are to be added at system
2666 For each whitespace separated
2669 .Va static_arp_ Ns Aq Ar element
2670 variable is assumed to exist whose contents will later be passed to a
2675 static_arp_pairs="gw"
2676 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2678 .It Va static_ndp_pairs
2680 Set to the list of static NDP pairs that are to be added at system
2682 For each whitespace separated
2685 .Va static_ndp_ Ns Aq Ar element
2686 variable is assumed to exist whose contents will later be passed to a
2691 static_ndp_pairs="gw"
2692 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2694 .It Va static_routes
2696 Set to the list of static routes that are to be added at system
2700 then for each whitespace separated
2703 .Va route_ Ns Aq Ar element
2704 variable is assumed to exist
2705 whose contents will later be passed to a
2710 static_routes="ext mcast:gif0 gif0local:gif0"
2711 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2712 route_mcast="-net 224.0.0.0/4 -iface gif0"
2713 route_gif0local="-host 169.254.1.1 -iface lo0"
2720 the route is specific to the interface
2722 .It Va ipv6_static_routes
2724 The IPv6 equivalent of
2728 then for each whitespace separated
2731 .Va ipv6_route_ Ns Aq Ar element
2732 variable is assumed to exist
2733 whose contents will later be passed to a
2734 .Dq Nm route Cm add Fl inet6
2736 .It Va natm_static_routes
2742 If not empty then for each whitespace separated
2745 .Va route_ Ns Aq Ar element
2746 variable is assumed to exist whose contents will later be passed to a
2747 .Dq Nm atmconfig Cm natm Cm add
2749 .It Va gateway_enable
2753 configure host to act as an IP router, e.g.\& to forward packets
2755 .It Va ipv6_gateway_enable
2757 The IPv6 equivalent of
2758 .Va gateway_enable .
2759 .It Va routed_enable
2763 run a routing daemon of some sort, based on the
2768 .It Va route6d_enable
2770 The IPv6 equivalent of
2774 run a routing daemon of some sort, based on the
2779 .It Va routed_program
2785 this is the name of the routing daemon to use.
2786 .It Va route6d_program
2788 The IPv6 equivalent of
2789 .Va routed_program .
2796 these are the flags to pass to the routing daemon.
2797 .It Va route6d_flags
2799 The IPv6 equivalent of
2801 .It Va mroute6d_enable
2805 run the IPv6 multicast routing daemon.
2807 Note that multicast routing daemons are no longer included in the
2809 base system, however, both
2813 may be installed from the
2816 .It Va mroute6d_flags
2822 these are the flags passed to the IPv6 multicast routing daemon.
2823 .It Va mroute6d_program
2829 this is the path to the IPv6 multicast routing daemon.
2830 .It Va rtadvd_enable
2836 daemon at boot time.
2839 utility sends ICMPv6 Router Advertisement messages to
2840 the interfaces specified in
2841 .Va rtadvd_interfaces .
2842 This should only be enabled with great care.
2843 You may want to fine-tune
2845 .It Va rtadvd_interfaces
2851 this is the list of interfaces to use.
2856 enable global proxy ARP.
2857 .It Va forward_sourceroute
2865 source-routed packets are forwarded.
2866 .It Va accept_sourceroute
2870 the system will accept source-routed packets directed at it.
2877 daemon at system boot time.
2884 these are the flags to pass to the
2887 .It Va bootparamd_enable
2893 daemon at system boot time.
2894 .It Va bootparamd_flags
2897 .Va bootparamd_enable
2900 these are the flags to pass to the
2903 .It Va stf_interface_ipv4addr
2907 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2909 Specify this entry to enable the 6to4 interface.
2910 .It Va stf_interface_ipv4plen
2912 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2913 An effective value is 0-31.
2914 .It Va stf_interface_ipv6_ifid
2916 IPv6 interface ID for
2920 .It Va stf_interface_ipv6_slaid
2922 IPv6 Site Level Aggregator for
2924 .It Va ipv6_ipv4mapping
2928 this enables IPv4 mapped IPv6 address communication (like
2929 .Li ::ffff:a.b.c.d ) .
2930 .It Va rtsold_enable
2936 daemon to send ICMPv6 Router Solicitation messages.
2943 these are the flags to pass to
2947 For interfaces configured with the
2948 .Dq Li inet6 accept_rtadv
2949 keyword, these are the flags to pass to
2954 is mutually exclusive to
2962 to enable the configuration of ATM interfaces at system boot time.
2963 For all of the ATM variables described below, please refer to the
2965 manual page for further details on the available command parameters.
2966 Also refer to the files in
2967 .Pa /usr/share/examples/atm
2968 for more detailed configuration information.
2971 This is a list of physical ATM interface drivers to load.
2976 .It Va atm_netif_ Ns Aq Ar intf
2978 For the ATM physical interface
2980 this variable defines the name prefix and count for the ATM network
2981 interfaces to be created.
2982 The value will be passed as the parameters of an
2983 .Dq Nm atm Cm "set netif" Ar intf
2985 .It Va atm_sigmgr_ Ns Aq Ar intf
2987 For the ATM physical interface
2989 this variable defines the ATM signalling manager to be used.
2990 The value will be passed as the parameters of an
2991 .Dq Nm atm Cm attach Ar intf
2993 .It Va atm_prefix_ Ns Aq Ar intf
2995 For the ATM physical interface
2997 this variable defines the NSAP prefix for interfaces using a UNI signalling
3001 the prefix will automatically be set via the
3004 Otherwise, the value will be passed as the parameters of an
3005 .Dq Nm atm Cm "set prefix" Ar intf
3007 .It Va atm_macaddr_ Ns Aq Ar intf
3009 For the ATM physical interface
3011 this variable defines the MAC address for interfaces using a UNI signalling
3015 the hardware MAC address contained in the ATM interface card will be used.
3016 Otherwise, the value will be passed as the parameters of an
3017 .Dq Nm atm Cm "set mac" Ar intf
3019 .It Va atm_arpserver_ Ns Aq Ar netif
3021 For the ATM network interface
3023 this variable defines the ATM address for a host which is to provide ATMARP
3025 This variable is only applicable to interfaces using a UNI signalling
3029 this host will become an ATMARP server.
3030 The value will be passed as the parameters of an
3031 .Dq Nm atm Cm "set arpserver" Ar netif
3033 .It Va atm_scsparp_ Ns Aq Ar netif
3037 SCSP/ATMARP service for the network interface
3039 will be initiated using the
3044 This variable is only applicable if
3045 .Va atm_arpserver_ Ns Aq Ar netif
3050 Set to the list of ATM PVCs to be added at system
3052 For each whitespace separated
3055 .Va atm_pvc_ Ns Aq Ar element
3056 variable is assumed to exist.
3057 The value of each of these variables
3058 will be passed as the parameters of an
3059 .Dq Nm atm Cm "add pvc"
3063 Set to the list of permanent ATM ARP entries to be added
3064 at system boot time.
3065 For each whitespace separated
3068 .Va atm_arp_ Ns Aq Ar element
3069 variable is assumed to exist.
3070 The value of each of these variables
3071 will be passed as the parameters of an
3072 .Dq Nm atm Cm "add arp"
3074 .It Va natm_interfaces
3078 interfaces that will also be used for HARP through
3080 If this list is not empty all interfaces in the list will be brought up
3086 For this to work the interface drivers must be either compiled into the
3087 kernel or must reside on the root partition.
3090 The keyboard bell sound.
3097 if the default behavior is desired.
3098 For details, refer to the
3103 If set to a non-null string, the virtual console's keyboard input is
3109 no keymap is installed, otherwise the value is used to install
3110 the keymap file found in
3111 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3114 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3119 The keyboard repeat speed.
3126 if the default behavior is desired.
3131 attempt to program the function keys with the value.
3133 be a single string of the form:
3134 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3137 Can be set to the value of
3140 .Dq Li destructive ,
3143 to set the cursor behavior explicitly or choose the default behavior.
3148 no screen map is installed, otherwise the value is used to install
3149 the screen map file in
3150 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3151 This parameter is ignored when using
3153 as the console driver.
3158 the default 8x16 font value is used for screen size requests, otherwise
3160 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3162 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3163 is used (depending on the console driver being used).
3168 the default 8x14 font value is used for screen size requests, otherwise
3170 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3172 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3173 is used (depending on the console driver being used).
3178 the default 8x8 font value is used for screen size requests, otherwise
3180 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3182 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3183 is used (depending on the console driver being used).
3188 the default screen blanking interval is used, otherwise it is set
3196 this is the actual screen saver to use
3197 .Li ( blank , snake , daemon ,
3199 .It Va moused_nondefault_enable
3203 the mouse device specified on
3204 the command line is not automatically treated as enabled by the
3205 .Pa /etc/rc.d/moused
3207 Having this variable set to
3213 to be enabled as soon as it is plugged in.
3214 .It Va moused_enable
3220 daemon is started for doing cut/paste selection on the console.
3223 This is the protocol type of the mouse connected to this host.
3224 This variable must be set if
3231 is able to detect the appropriate mouse type automatically in many cases.
3232 Set this variable to
3234 to let the daemon detect it, or
3235 select one from the following list if the automatic detection fails.
3237 If the mouse is attached to the PS/2 mouse port, choose
3241 regardless of the brand and model of the mouse.
3243 mouse is attached to the bus mouse port, choose
3247 All other protocols are for serial mice and will not work with
3248 the PS/2 and bus mice.
3249 If this is a USB mouse,
3251 is the only protocol type which will work.
3253 .Bl -tag -width ".Li x10mouseremote" -compact
3255 Microsoft mouse (serial)
3257 Microsoft IntelliMouse (serial)
3259 Mouse systems Corp.\& mouse (serial)
3261 MM Series mouse (serial)
3263 Logitech mouse (serial)
3267 Logitech MouseMan and TrackMan (serial)
3269 ALPS GlidePoint (serial)
3270 .It Li thinkingmouse
3271 Kensington ThinkingMouse (serial)
3275 MM HitTablet (serial)
3276 .It Li x10mouseremote
3277 X10 MouseRemote (serial)
3279 Interlink VersaPad (serial)
3282 Even if the mouse is not in the above list, it may be compatible
3283 with one in the list.
3284 Refer to the manual page for
3286 for compatibility information.
3288 It should also be noted that while this is enabled, any
3289 other client of the mouse (such as an X server) should access
3290 the mouse through the virtual mouse device,
3292 and configure it as a
3294 type mouse, since all
3295 mouse data is converted to this single canonical format when
3298 If the client program does not support the
3304 It is the second preferred type.
3311 this is the actual port the mouse is on.
3314 for a COM1 serial mouse,
3318 for a bus mouse, for example.
3323 is set, its value is used as an additional set of flags to pass to the
3326 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3328 .Va moused_nondefault_enable
3331 daemon is started for a non-default port, the
3332 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3333 set of options has precedence over and replaces the default
3337 is the name of the non-default port, i.e.,\&
3340 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3341 it is possible to set up a different set of default flags for each
3344 For example, you can use
3348 to make your laptop's touchpad more comfortable to use,
3349 but an empty set of options for
3350 .Va moused_ums0_flags
3353 mouse has three or more buttons.
3354 .It Va mousechar_start
3358 the default mouse cursor character range
3359 .Li 0xd0 Ns - Ns Li 0xd3
3361 otherwise the range start is set
3366 Use if the default range is occupied in the language code table.
3367 .It Va allscreens_flags
3371 is run with these options for each of the virtual terminals
3375 will enable the mouse pointer on all virtual terminals
3380 .It Va allscreens_kbdflags
3384 is run with these options for each of the virtual terminals
3392 scrollback (history) buffer to 200 lines.
3399 daemon at system boot time.
3405 .Pa /usr/sbin/cron ) .
3412 these are the flags to pass to
3418 enable the special handling of transitions to and from the
3419 Daylight Saving Time in
3421 (equivalent to using the flag
3428 .Pa /usr/sbin/lpd ) .
3435 daemon at system boot time.
3442 these are the flags to pass to the
3445 .It Va chkprintcap_enable
3451 command before starting the
3454 .It Va chkprintcap_flags
3459 .Va chkprintcap_enable
3462 these are the flags to pass to the
3467 which causes missing directories to be created.
3468 .It Va mta_start_script
3470 This variable specifies the full path to the script to run to start
3471 a mail transfer agent.
3473 .Pa /etc/rc.sendmail .
3477 .Pa /etc/rc.sendmail
3478 uses are documented in the
3483 Indicates the device (usually a swap partition) to which a crash dump
3484 should be written in the event of a system crash.
3485 If the value of this variable is
3487 the first suitable swap device listed in
3489 will be used as dump device.
3490 Otherwise, the value of this variable is passed as the argument to
3492 To disable crash dumps, set this variable to
3496 When the system reboots after a crash and a crash dump is found on the
3497 device specified by the
3501 will save that crash dump and a copy of the kernel to the directory
3505 The default value is
3514 .It Va savecore_flags
3516 If crash dumps are enabled, these are the flags to pass to the
3523 to turn on user and group disk quotas on system startup via the
3525 command for all file systems marked as having quotas enabled in
3527 The kernel must be built with
3529 for disk quotas to function.
3534 to enable user and group disk quota checking via the
3537 .It Va quotacheck_flags
3547 these are the flags to pass to the
3552 which checks quotas for all file systems with quotas enabled in
3554 .It Va quotaon_flags
3560 these are the flags to pass to the
3565 which enables quotas for all file systems with quotas enabled in
3567 .It Va quotaoff_flags
3573 these are the flags to pass to the
3575 utility when shutting down the quota system.
3578 which disables quotas for all file systems with quotas enabled in
3580 .It Va accounting_enable
3584 to enable system accounting through the
3591 to enable iBCS2 (SCO) binary emulation at system initial boot
3593 .It Va ibcs2_loaders
3601 this specifies a list of additional iBCS2 loaders to enable.
3602 .It Va firstboot_sentinel
3604 This variable specifies the full path to a
3607 If a file exists with this path,
3611 keyword will be run on startup and the sentinel file will be deleted
3612 after the boot process completes.
3613 The sentinel file must be located on a writable file system which is
3614 mounted no later than
3615 .Va early_late_divider
3616 to function properly.
3623 to enable Linux/ELF binary emulation at system initial
3629 enable SysVR4 emulation at boot time.
3630 .It Va sysvipc_enable
3634 load System V IPC primitives at boot time.
3635 .It Va clear_tmp_enable
3646 to disable removing of X11 lock files,
3647 and the removal and (secure) recreation
3648 of the various socket directories for X11
3650 .It Va ldconfig_paths
3652 Set to the list of shared library paths to use with
3656 will always be added first, so it need not appear in this list.
3657 .It Va ldconfig32_paths
3659 Set to the list of 32-bit compatibility shared library paths to
3662 .It Va ldconfig_paths_aout
3664 Set to the list of shared library paths to use with
3669 .It Va ldconfig_insecure
3673 utility normally refuses to use directories
3674 which are writable by anyone except root.
3675 Set this variable to
3677 to disable that security check during system startup.
3678 .It Va ldconfig_local_dirs
3680 Set to the list of local
3683 The names of all files in the directories listed will be
3684 passed as arguments to
3686 .It Va ldconfig_local32_dirs
3688 Set to the list of local 32-bit compatibility
3691 The names of all files in the directories listed will be
3692 passed as arguments to
3693 .Dq Nm ldconfig Fl 32 .
3694 .It Va kern_securelevel_enable
3698 to set the kernel security level at system startup.
3699 .It Va kern_securelevel
3701 The kernel security level to set at startup.
3702 The allowed range of
3704 ranges from \-1 (the compile time default) to 3 (the
3708 for the list of possible security levels and their effect
3709 on system operation.
3712 Path to the SSH server program
3713 .Pa ( /usr/sbin/sshd
3721 at system boot time.
3728 these are the flags to pass to the
3733 Path to the FTP server program
3734 .Pa ( /usr/libexec/ftpd
3742 as a stand-alone daemon at system boot time.
3749 these are the additional flags to pass to the
3752 .It Va watchdogd_enable
3758 daemon at boot time.
3759 This requires that the kernel have been compiled with a
3762 .It Va watchdogd_flags
3765 .Va watchdogd_enable
3768 these are the flags passed to the
3771 .It Va devfs_rulesets
3773 List of files containing sets of rules for
3775 .It Va devfs_system_ruleset
3777 Rule name(s) to apply to the system
3780 .It Va devfs_set_rulesets
3782 Pairs of already-mounted
3784 directories and rulesets that should be applied to them.
3785 For example: /mount/dev=ruleset_name
3786 .It Va devfs_load_rulesets
3788 If set, always load the default rulesets listed in
3789 .Va devfs_rulesets .
3790 .It Va performance_cx_lowest
3792 CPU idle state to use while on AC power.
3797 should use the lowest power state available while
3799 indicates that the lowest latency state (less power savings) should be used.
3800 .It Va performance_cpu_freq
3802 CPU clock frequency to use while on AC power.
3807 should use the lowest frequency available while
3809 indicates that the highest frequency (less power savings) should be used.
3810 .It Va economy_cx_lowest
3812 CPU idle state to use when off AC power.
3817 should use the lowest power state available while
3819 indicates that the lowest latency state (less power savings) should be used.
3820 .It Va economy_cpu_freq
3822 CPU clock frequency to use when off AC power.
3827 should use the lowest frequency available while
3829 indicates that the highest frequency (less power savings) should be used.
3834 any configured jails will not be started.
3837 The configuration filename used by
3840 The default value is
3841 .Pa /etc/jail.conf .
3842 .It Va jail_parallel_start
3846 all configured jails will be started in the background (in parallel).
3850 When set, use as default value for
3851 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3856 A space separated list of names for jails.
3857 If this variable is empty,
3860 instances in the configuration file will be configured.
3861 This is purely a configuration aid to help identify and
3862 configure multiple jails.
3863 The names specified in this list will be used to
3864 identify settings common to an instance of a jail,
3865 and should contain alphanumeric characters only.
3866 The literal jail name of
3870 .It Va jail_* variables
3871 Note that older releases supported per-jail configuration via
3875 hostname of a jail named
3877 was able to be set by
3878 .Li jail_vjail_hostname .
3879 These per-jail configuration variables are now obsolete in favor of
3882 For backward compatibility,
3883 when per-jail configuration variables are defined,
3885 configuration files are created as
3886 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3889 The following per-jail parameters are handled by
3891 script out of their corresponding
3894 In addition to them, parameters in
3895 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3896 will be added to the configuration file.
3897 They must be a semi-colon
3905 .Bl -tag -width "host.hostname" -offset indent
3908 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3909 .It Li host.hostname
3911 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3912 .It Li exec.consolelog
3914 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3915 The default value is
3916 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3919 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3920 .It Li vnet.interface
3922 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3925 parameter will be enabled and cannot be specified with
3926 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3929 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3933 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3936 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3939 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3942 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3943 The parameter name was
3945 in some older releases.
3946 .It Li exec.prestart
3948 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3949 .It Li exec.poststart
3951 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3954 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3957 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3958 .It Li exec.poststop
3960 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3963 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3965 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3966 contain IPv4 addresses
3969 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3972 contain IPv6 addresses
3975 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3978 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3979 .It Li devfs_ruleset
3981 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3982 This must be an integer,
3984 .It Li mount.fdescfs
3986 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3987 .It Li allow.set_hostname
3989 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3990 .It Li allow.rawsocket
3992 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3993 .It Li allow.sysvipc
3995 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3997 .\" -----------------------------------------------------
3998 .It Va harvest_interrupt
4002 to use hardware interrupts as an entropy source.
4005 for more information.
4006 .It Va harvest_ethernet
4010 to use LAN traffic as an entropy source.
4013 for more information.
4014 .It Va harvest_p_to_p
4018 to use serial line traffic as an entropy source.
4021 for more information.
4026 to disable caching entropy via
4028 Otherwise set to the directory used to store entropy files in.
4033 to disable caching entropy through reboots.
4034 Otherwise set to the filename used to store cached entropy through
4036 This file should be located on the root file system to seed the
4038 device as early as possible in the boot process.
4039 .It Va entropy_save_sz
4041 Size of the entropy cache files saved by
4044 .It Va entropy_save_num
4046 Number of entropy cache files to save by
4060 Configuration file for
4069 .Pa /var/run/dmesg.boot
4071 .It Va rcshutdown_timeout
4073 If set, start a watchdog timer in the background which will terminate
4077 has not completed within the specified time (in seconds).
4078 Notice that in addition to this soft timeout,
4080 also applies a hard timeout for the execution of
4082 This is configured via
4085 .Va kern.init_shutdown_timeout
4086 and defaults to 120 seconds.
4087 Setting the value of
4088 .Va rcshutdown_timeout
4089 to more than 120 seconds will have no effect until the
4092 .Va kern.init_shutdown_timeout
4094 .It Va virecover_enable
4098 to prevent the system from trying to
4099 recover pre-maturely terminated
4102 .It Va ugidfw_enable
4107 .Xr mac_bsdextended 4
4108 module upon system initialization and load a default
4110 .It Va bsdextended_script
4113 .Xr mac_bsdextended 4
4114 ruleset file to load.
4115 The default value of this variable is
4116 .Pa /etc/rc.bsdextended .
4117 .It Va newsyslog_enable
4124 .It Va newsyslog_flags
4127 .Va newsyslog_enable
4130 these are the flags to pass to the
4135 which causes log files flagged with a
4138 .It Va mdconfig_md Ns Aq Ar X
4148 must be specified and either a
4150 for malloc or swap backed
4158 .Va mdconfig_md Ns Aq Ar X
4159 variables are evaluated until one variable is unset or null.
4160 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4162 Optional arguments passed to
4168 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4170 An ownership specification passed to
4179 device and the mount point will be changed.
4180 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4182 A mode string passed to
4191 device and the mount point will be changed.
4192 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4194 Files to be copied to the mount point of the
4198 after it has been mounted.
4199 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4201 Command to execute after the specified
4206 Note that the command is passed to
4212 variables can be used to reference respectively the
4214 device and the mount point.
4219 one could set the following:
4221 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4223 .It Va autobridge_interfaces
4225 Set to the list of bridge interfaces that will have newly arriving interfaces
4226 checked against to be automatically added.
4229 then for each whitespace separated
4232 .Va autobridge_ Ns Aq Ar element
4233 variable is assumed to exist which has a whitespace separated list of interface
4234 names to match, these names can use wildcards.
4237 autobridge_interfaces="bridge0"
4238 autobridge_bridge0="tap* dc0 vlan[345]"
4244 enable support for sound mixer.
4245 .It Va hcsecd_enable
4249 enable Bluetooth security daemon.
4250 .It Va hcsecd_config
4252 Configuration file for
4255 .Pa /etc/bluetooth/hcsecd.conf .
4260 enable Bluetooth Service Discovery Protocol daemon.
4268 .It Va sdpd_groupname
4272 group to run as after it initializes.
4275 .It Va sdpd_username
4279 user to run as after it initializes.
4282 .It Va bthidd_enable
4286 enable Bluetooth Human Interface Device daemon.
4287 .It Va bthidd_config
4289 Configuration file for
4292 .Pa /etc/bluetooth/bthidd.conf .
4295 Path to a file, where
4297 will store information about known HID devices.
4299 .Pa /var/db/bthidd.hids .
4300 .It Va rfcomm_pppd_server_enable
4304 enable Bluetooth RFCOMM PPP wrapper daemon.
4305 .It Va rfcomm_pppd_server_profile
4307 The name of the profile to use from
4308 .Pa /etc/ppp/ppp.conf .
4309 Multiple profiles can be specified here.
4310 Also used to specify per-profile overrides.
4311 When the profile name contains any of the characters
4313 they are translated to
4315 for the proposes of the override variable names.
4316 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4318 Overrides local address to listen on.
4324 The address can be specified as BD_ADDR or name.
4325 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4327 Overrides local RFCOMM channel to listen on.
4330 will listen on RFCOMM channel 1.
4331 Must set properly if multiple profiles used in the same time.
4332 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4336 if it should register Serial Port service on the specified RFCOMM channel.
4339 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4343 if it should register Dial-Up Networking service on the specified
4347 .It Va ubthidhci_enable
4351 change the USB Bluetooth controller from HID mode to HCI mode.
4352 You also need to specify the location of USB Bluetooth controller with the
4353 .Va ubthidhci_busnum
4357 .It Va ubthidhci_busnum
4358 Bus number where the USB Bluetooth controller is located.
4361 on your system to find this information.
4362 .It Va ubthidhci_addr
4363 Bus address of the USB Bluetooth controller.
4366 on your system to find this information.
4367 .It Va netwait_enable
4371 delays the start of network-reliant services until
4373 is up and ICMP packets to a destination defined in
4376 Link state is examined first, followed by
4378 an IP address to verify network usability.
4379 If no destination can be reached or timeouts are exceeded,
4380 network services are started anyway with no guarantee that
4381 the network is usable.
4382 Use of this variable requires both
4390 This variable contains a space-delimited list of IP addresses to
4392 DNS hostnames should not be used as resolution is not guaranteed
4393 to be functional at this point.
4394 If multiple IP addresses are specified,
4395 each will be tried until one is successful or the list is exhausted.
4396 .It Va netwait_timeout
4398 Indicates the total number of seconds to perform a
4400 against each IP address in
4402 at a rate of one ping per second.
4403 If any of the pings are successful,
4404 full network connectivity is considered reliable.
4409 Defines the name of the network interface on which watch for link.
4411 is used to monitor the interface, looking for
4412 .Dq Li status: no carrier .
4413 Once gone, the link is considered up.
4416 interface if desired.
4417 .It Va netwait_if_timeout
4419 Defines the total number of seconds to wait for link to become usable,
4420 polled at a 1-second interval.
4428 rules from the defined ruleset.
4429 The kernel must be built with
4432 .Cd "options RCTL" .
4438 This variables contains the
4444 A space-separated list of configuration files used by
4446 The default value is an empty string.
4449 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4450 .It Pa /etc/defaults/rc.conf
4452 .It Pa /etc/rc.conf.local
4482 .Xr newsyslog.conf 5 ,
4552 .An Jordan K. Hubbard .