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.
1162 Note that the maximum number of the generated addresses from a range
1163 specification is limited to an integer value specified in
1164 .Va netif_ipexpand_max
1167 because a small typo can unexpectedly generate a large number of addresses.
1168 The default value is
1170 It can be increased by adding the following line into
1173 netif_ipexpand_max="4096"
1177 .Li 192.0.2.5-23/24 ,
1178 the address 192.0.2.5 will be configured with the
1179 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1180 the non-conflicting netmask /32 as explained in the
1183 Note that this special netmask handling is only for
1185 not for the other address families such as
1188 With the interface in question being
1190 an example could look like:
1192 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1193 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1199 .Va ipv4_addrs_ Ns Aq Ar interface
1200 variable was supported for IPv4 CIDR address notation.
1201 It is now deprecated because the functionality was integrated into
1202 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1204 .Va ipv4_addrs_ Ns Aq Ar interface
1205 is still supported for backward compatibility.
1208 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1209 entry with an address family keyword,
1210 its contents are passed to
1212 Execution stops at the first unsuccessful access, so if
1213 something like this is present:
1215 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1216 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1217 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1218 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1221 Then note that alias4 would
1223 be added since the search would
1224 stop with the missing
1227 Because of this difficult to manage behavior,
1229 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1230 variable, which has the same functionality as
1231 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1232 and can have all of entries in a variable like the following:
1234 ifconfig_ed0_aliases="\\
1235 inet 127.0.0.251 netmask 0xffffffff \\
1236 inet 127.0.0.252 netmask 0xffffffff \\
1237 inet 127.0.0.253 netmask 0xffffffff \\
1238 inet 127.0.0.254 netmask 0xffffffff"
1241 It also supports CIDR notation.
1244 .Pa /etc/start_if. Ns Aq Ar interface
1245 file is present, it is read and executed by the
1248 before configuring the interface as specified in the
1249 .Va ifconfig_ Ns Aq Ar interface
1251 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1255 .Va vlans_ Ns Aq Ar interface
1259 interface will be created for each item in the list with the
1263 If a vlan interface's name is a number,
1264 then that number is used as the vlan tag and the new vlan interface is
1266 .Ar interface . Ns Ar tag .
1268 the vlan tag must be specified via a
1271 .Va create_args_ Ns Aq Ar interface
1274 To create a vlan device named
1278 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1281 ifconfig_em0_101="inet 192.0.2.1/24"
1284 To create a vlan device named
1288 with the vlan tag 102:
1291 create_args_myvlan="vlan 102"
1295 .Va wlans_ Ns Aq Ar interface
1299 interface will be created for each item in the list with the
1303 Further wlan cloning arguments may be passed to the
1306 command by setting the
1307 .Va create_args_ Ns Aq Ar interface
1311 devices must be created for each wireless devices as of
1317 may be specified with an
1318 .Va wlandebug_ Ns Aq Ar interface
1320 The contents of this variable will be passed directly to
1324 .Va ifconfig_ Ns Aq Ar interface
1325 contains the keyword
1327 then the interface will not be configured
1329 .Pa /etc/pccard_ether
1331 .Va network_interfaces
1335 It is possible to bring up an interface with DHCP by adding
1338 .Va ifconfig_ Ns Aq Ar interface
1340 For instance, to initialize the
1343 it is possible to use something like:
1348 If you want to configure your wireless interface with
1349 .Xr wpa_supplicant 8
1350 for use with WPA, EAP/LEAP or WEP, you need to add
1353 .Va ifconfig_ Ns Aq Ar interface
1356 On the other hand, if you want to configure your wireless interface with
1361 .Va ifconfig_ Ns Aq Ar interface
1364 will use the settings from
1365 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1367 Finally, you can add
1369 options in this variable, in addition to the
1370 .Pa /etc/start_if. Ns Aq Ar interface
1372 For instance, to configure an
1374 wireless device in station mode with an address obtained
1375 via DHCP, using WPA authentication and 802.11b mode, it is
1376 possible to use something like:
1379 ifconfig_wlan0="DHCP WPA mode 11b"
1383 .Va ifconfig_ Ns Aq Ar interface
1384 form, a fallback variable
1385 .Va ifconfig_DEFAULT
1387 It will be used for all interfaces with no
1388 .Va ifconfig_ Ns Aq Ar interface
1390 This is intended to replace the no longer supported
1394 It is also possible to rename an interface by doing:
1396 ifconfig_ed0_name="net0"
1397 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1401 This variable is deprecated.
1403 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1405 .Va ipv6_activate_all_interfaces
1410 .Dq Li inet6 accept_rtadv
1412 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1414 .Va ipv6_activate_all_interfaces
1419 This variable is deprecated.
1421 .Va ip6addrctl_policy
1426 the default address selection policy table set by
1428 will be IPv6-preferred.
1432 the default address selection policy table set by
1434 will be IPv4-preferred.
1435 .It Va ipv6_activate_all_interfaces
1437 This controls initial configuration on IPv6-capable
1438 interfaces with no corresponding
1439 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1441 Note that it is not always necessary to set this variable to
1443 to use IPv6 functionality on
1445 In most cases, just configuring
1446 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1451 all interfaces which do not have a corresponding
1452 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1453 variable will be marked as
1456 This means that all of IPv6 functionality on that interface
1457 is completely disabled to enforce a security policy.
1458 If the variable is set to
1460 the flag will be cleared on all of the interfaces.
1462 In most cases, just defining an
1463 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1464 for an IPv6-capable interface should be sufficient.
1465 However, if an interface is added dynamically
1466 .Pq by some tunneling protocols such as PPP, for example ,
1467 it is often difficult to define the variable in advance.
1468 In such a case, configuring the
1470 flag can be disabled by setting this variable to
1473 For more details of the
1476 .Dq Li inet6 ifdisabled ,
1486 privacy addresses will be generated for each IPv6
1487 interface as described in RFC 4941.
1488 .It Va ipv6_network_interfaces
1490 This is the IPv6 equivalent of
1491 .Va network_interfaces .
1492 Normally manual configuration of this variable is not needed.
1494 .It Va ipv6_cpe_wanif
1496 If the variable is set to an interface name,
1500 .Dq inet6 -no_radr accept_rtadv
1501 will be added to the specified interface automatically before evaluating
1502 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1506 .Va net.inet6.ip6.rfc6204w3
1508 .Va net.inet6.ip6.no_radr
1511 This means the specified interface will accept ICMPv6 Router
1512 Advertisement messages on that link and add the discovered
1513 routers into the Default Router List.
1514 While the other interfaces can still accept RA messages if the
1515 .Dq inet6 accept_rtadv
1516 option is specified, adding
1517 routes into the Default Router List will be disabled by
1524 Note that ICMPv6 Router Advertisement messages will be
1526 .Va net.inet6.ip6.forwarding
1528 .Pq packet forwarding is enabled
1530 .Va net.inet6.ip6.rfc6204w3
1535 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1537 IPv6 functionality on an interface should be configured by
1538 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1539 instead of setting ifconfig parameters in
1540 .Va ifconfig_ Ns Aq Ar interface .
1541 If this variable is empty, all of IPv6 configurations on the
1542 specified interface by other variables such as
1543 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1546 Aliases should be set by
1547 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1553 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1554 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1557 Interfaces that have an
1558 .Dq Li inet6 accept_rtadv
1560 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1561 setting will be automatically configured by SLAAC
1562 .Pq StateLess Address AutoConfiguration
1568 Note that a link-local address will be automatically configured in
1569 addition to the configured global-scope addresses because the IPv6
1570 specifications require it on each link.
1571 The address is calculated from the MAC address by using an algorithm
1578 If only a link-local address is needed on the interface,
1579 the following configuration can be used:
1581 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1584 A link-local address can also be configured manually.
1585 This is useful for the default router address of an IPv6 router
1586 so that it does not change when the network interface
1590 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1592 .It Va ipv6_prefix_ Ns Aq Ar interface
1594 If one or more prefixes are defined in
1595 .Va ipv6_prefix_ Ns Aq Ar interface
1596 addresses based on each prefix and the EUI-64 interface index will be
1597 configured on that interface.
1598 Note that this variable will be ignored when
1599 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1602 For example, the following configuration
1604 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1607 is equivalent to the following:
1609 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1610 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1611 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1612 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1615 These Subnet-Router anycast addresses will be added only when
1616 .Va ipv6_gateway_enable
1618 .It Va ipv6_default_interface
1622 this is the default output interface for scoped addresses.
1623 This works only with ipv6_gateway_enable="NO".
1624 .It Va ip6addrctl_enable
1626 This variable is to enable configuring default address selection policy table
1628 The table can be specified in another variable
1629 .Va ip6addrctl_policy .
1631 .Va ip6addrctl_policy
1632 the following keywords can be specified:
1633 .Dq Li ipv4_prefer ,
1634 .Dq Li ipv6_prefer ,
1644 installs a pre-defined policy table described in Section 2.1
1652 is specified, it attempts to read a file
1653 .Pa /etc/ip6addrctl.conf
1655 If this file is found,
1657 reads and installs it.
1658 If not found, a policy is automatically set
1660 .Va ipv6_activate_all_interfaces
1661 variable; if the variable is set to
1663 the IPv6-preferred one is used.
1664 Otherwise IPv4-preferred.
1666 The default value of
1667 .Va ip6addrctl_enable
1669 .Va ip6addrctl_policy
1675 .It Va cloned_interfaces
1677 Set to the list of clonable network interfaces to create on this host.
1678 Further cloning arguments may be passed to the
1681 command for each interface by setting the
1682 .Va create_args_ Ns Aq Ar interface
1684 If an interface name is specified with
1687 the interface will not be destroyed even when
1689 script is invoked with
1692 This is useful when reconfiguring the interface without destroying it.
1694 .Va cloned_interfaces
1695 are automatically appended to
1696 .Va network_interfaces
1698 .It Va cloned_interfaces_sticky
1700 This variable is to globally enable functionality of
1703 .Va cloned_interfaces
1705 The default value is
1707 Even if this variable is specified to
1710 keyword can be used to override it on per interface basis.
1711 .It Va fec_interfaces
1715 Fast EtherChannel interfaces to configure on this host.
1717 .Va fecconfig_ Ns Aq Ar interface
1718 variable is assumed to exist for each value of
1720 The value of this variable is used to configure link aggregated interfaces
1721 according to the syntax of the
1722 .Cm NGM_FEC_ADD_IFACE
1726 Additionally, this option ensures that each listed interface is created
1731 before attempting to configure it.
1734 fec_interfaces="fec0"
1735 fecconfig_fec0="em0 em1"
1736 ifconfig_fec0="DHCP"
1738 .It Va gif_interfaces
1740 This variable is deprecated in favor of
1741 .Va cloned_interfaces .
1744 tunnel interfaces to configure on this host.
1746 .Va gifconfig_ Ns Aq Ar interface
1747 variable is assumed to exist for each value of
1749 The value of this variable is used to configure the link layer of the
1750 tunnel according to the syntax of the
1754 Additionally, this option ensures that each listed interface is created
1759 before attempting to configure it.
1760 .It Va sppp_interfaces
1764 interfaces to configure on this host.
1766 .Va spppconfig_ Ns Aq Ar interface
1767 variable is assumed to exist for each value of
1769 Each interface should also be configured by a general
1770 .Va ifconfig_ Ns Aq Ar interface
1774 for more information about available options.
1784 The name of the profile to use from
1785 .Pa /etc/ppp/ppp.conf .
1786 Also used for per-profile overrides of
1791 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1792 When the profile name contains any of the characters
1794 they are translated to
1796 for the proposes of the override variable names.
1799 Mode in which to run the
1802 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1804 Overrides the global
1814 See the manual for a full description.
1819 enables network address translation.
1820 Used in conjunction with
1822 allows hosts on private network addresses access to the Internet using
1823 this host as a network address translating router.
1824 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1826 Overrides the global
1830 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1832 Set the unit number to be used for this profile.
1833 See the manual description of
1838 The name of the user under which
1846 .It Va rc_conf_files
1848 This option is used to specify a list of files that will override
1850 .Pa /etc/defaults/rc.conf .
1851 The files will be read in the order in which they are specified and should
1852 include the full path to the file.
1853 By default, the files specified are
1856 .Pa /etc/rc.conf.local
1862 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1864 .It Va gptboot_enable
1868 .Pa /etc/rc.d/gptboot
1869 will log if the system successfully (or not) booted from a GPT partition,
1875 .It Va gbde_autoattach_all
1880 will attempt to automatically initialize your .bde devices in
1884 List the devices that the script should try to attach,
1889 The directory where the
1891 lockfiles are located.
1892 The default lockfile directory is
1895 The lockfile for each individual
1897 device can be overridden by setting the variable
1898 .Va gbde_lock_ Ns Aq Ar device ,
1901 is the encrypted device without the
1906 .It Va gbde_attach_attempts
1908 Number of times to attempt attaching to a
1910 device, i.e., how many times the user is asked for the pass-phrase.
1914 List of devices to automatically attach on boot.
1915 Note that .eli devices from
1917 are automatically appended to this list.
1920 Number of times user is asked for the pass-phrase.
1921 If empty, it will be taken from
1922 .Va kern.geom.eli.tries
1924 .It Va geli_default_flags
1926 Default flags to use by
1928 when configuring disk encryption.
1929 Flags can be configured for every device separately by defining
1930 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1932 .It Va geli_autodetach
1934 Specifies if GELI devices should be marked for detach on last close after
1935 file systems are mounted.
1938 This can be changed for every device separately by defining
1939 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1941 .It Va root_rw_mount
1946 After the file systems are checked at boot time, the root file system
1947 is remounted as read-write if this is set to
1949 Diskless systems that mount their root file system from a read-only remote
1950 NFS share should set this to
1954 .It Va fsck_y_enable
1959 will be run with the
1961 flag if the initial preen
1962 of the file systems fails.
1963 .It Va background_fsck
1967 the system will attempt to run
1969 in the background where possible.
1970 .It Va background_fsck_delay
1972 The amount of time in seconds to sleep before starting a background
1974 It defaults to sixty seconds to allow large applications such as
1975 the X server to start before disk I/O bandwidth is monopolized by
1977 If set to a negative number, the background file system check will be
1978 delayed indefinitely to allow the administrator to run it at a more
1980 For example it may be run from
1982 by adding a line like
1984 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1990 List of file system types that are network-based.
1991 This list should generally not be modified by end users.
1993 .Va extra_netfs_types
1995 .It Va extra_netfs_types
1997 If set to something other than
2000 this variable extends the list of file system types
2001 for which automatic mounting at startup by
2003 should be delayed until the network is initialized.
2005 a whitespace-separated list of network file system descriptor pairs,
2006 each consisting of a file system type as passed to
2008 and a human-readable, one-word description,
2011 Extending the default list in this way is only necessary
2012 when third party file system types are used.
2013 .It Va syslogd_enable
2020 .It Va syslogd_program
2025 .Pa /usr/sbin/syslogd ) .
2026 .It Va syslogd_flags
2032 these are the flags to pass to
2041 .It Va inetd_program
2046 .Pa /usr/sbin/inetd ) .
2053 these are the flags to pass to
2062 .It Va hastd_program
2074 these are the flags to pass to
2076 .It Va local_unbound_enable
2082 daemon as a local caching resolver.
2083 .It Va kerberos5_server_enable
2087 to start a Kerberos 5 authentication server
2089 .It Va kerberos5_server
2092 .Va kerberos5_server_enable
2095 this is the path to Kerberos 5 Authentication Server.
2096 .It Va kerberos5_server_flags
2099 This variable contains additional flags to be passed to the Kerberos 5
2100 authentication server.
2101 .It Va kadmind5_server_enable
2107 the Kerberos 5 Administration Daemon; set to
2110 .It Va kadmind5_server
2113 .Va kadmind5_server_enable
2116 this is the path to Kerberos 5 Administration Daemon.
2117 .It Va kpasswdd_server_enable
2123 the Kerberos 5 Password-Changing Daemon; set to
2126 .It Va kpasswdd_server
2129 .Va kpasswdd_server_enable
2132 this is the path to Kerberos 5 Password-Changing Daemon.
2139 the Kerberos 5 ticket forwarding daemon, at the boot time.
2145 .Pa /usr/libexec/kfd ) .
2152 daemon at boot time.
2159 these are the flags to pass to it.
2166 daemon at boot time.
2173 these are the flags to pass to it.
2176 manpage for more information.
2177 .It Va amd_map_program
2180 the specified program is run to get the list of
2185 maps are stored in NIS, one can set this to
2198 will be updated at boot time to reflect the kernel release
2203 will not be updated.
2204 .It Va nfs_client_enable
2208 run the NFS client daemons at boot time.
2209 .It Va nfs_access_cache
2212 .Va nfs_client_enable
2217 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2219 results should be cached.
2220 A value of 2-10 seconds will substantially reduce network
2221 traffic for many NFS operations.
2222 .It Va nfs_server_enable
2226 run the NFS server daemons at boot time.
2227 .It Va nfs_server_flags
2230 .Va nfs_server_enable
2233 these are the flags to pass to the
2236 .It Va nfsv4_server_enable
2239 .Va nfs_server_enable
2243 .Va nfsv4_server_enable
2246 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2247 .It Va nfsuserd_enable
2253 run the nfsuserd daemon, which is needed for NFSv4 in order
2254 to map between user/group names vs uid/gid numbers.
2256 .Va nfsv4_server_enable
2259 this will be forced enabled.
2260 .It Va nfsuserd_flags
2266 these are the flags to pass to the
2269 .It Va nfscbd_enable
2275 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2282 these are the flags to pass to the
2285 .It Va oldnfs_server_enable
2288 .Va oldnfs_server_enable
2291 force the NFS server daemons to run the old NFS server code
2292 that does not support NFSv4.
2293 .It Va mountd_enable
2298 .Va nfs_server_enable
2304 It is commonly needed to run CFS without real NFS used.
2311 these are the flags to pass to the
2314 .It Va weak_mountd_authentication
2318 allow services like PCNFSD to make non-privileged mount
2320 .It Va nfs_reserved_port_only
2324 provide NFS services only on a secure port.
2325 .It Va nfs_bufpackets
2327 If set to a number, indicates the number of packets worth of
2328 socket buffer space to reserve on an NFS client.
2329 The kernel default is typically 4.
2330 Using a higher number may be
2331 useful on gigabit networks to improve performance.
2332 The minimum value is
2333 2 and the maximum is 64.
2334 .It Va rpc_lockd_enable
2338 and also an NFS server or client, run
2341 .It Va rpc_lockd_flags
2344 .Va rpc_lockd_enable
2347 these are the flags to pass to the
2350 .It Va rpc_statd_enable
2354 and also an NFS server or client, run
2357 .It Va rpc_statd_flags
2360 .Va rpc_statd_enable
2363 these are the flags to pass to the
2366 .It Va rpcbind_program
2371 .Pa /usr/sbin/rpcbind ) .
2372 .It Va rpcbind_enable
2378 service at boot time.
2379 .It Va rpcbind_flags
2385 these are the flags to pass to the
2388 .It Va keyserv_enable
2394 daemon on boot for running Secure RPC.
2395 .It Va keyserv_flags
2401 these are the flags to pass to
2404 .It Va pppoed_enable
2410 daemon at boot time to provide PPP over Ethernet services.
2411 .It Va pppoed_ Ns Aq Ar provider
2414 listens to requests to this
2420 argument of the same name.
2423 Additional flags to pass to
2425 .It Va pppoed_interface
2427 The network interface to run
2430 This is mandatory when
2440 service at boot time.
2441 This command is intended for networks of
2442 machines where a consistent
2444 for all hosts must be established.
2445 This is often useful in large NFS
2446 environments where time stamps on files are expected to be consistent
2454 these are the flags to pass to the
2457 .It Va ntpdate_enable
2464 This command is intended to
2465 synchronize the system clock only
2467 from some standard reference.
2468 .It Va ntpdate_config
2470 Configuration file for
2474 .It Va ntpdate_hosts
2476 A whitespace-separated list of NTP servers to synchronize with at startup.
2477 The default is to use the servers listed in
2478 .Va ntpdate_config ,
2479 if that file exists.
2480 .It Va ntpdate_program
2485 .Pa /usr/sbin/ntpdate ) .
2486 .It Va ntpdate_flags
2492 these are the flags to pass to the
2494 command (typically a hostname).
2501 command at boot time.
2507 .Pa /usr/sbin/ntpd ) .
2521 these are the flags to pass to the
2524 .It Va ntpd_sync_on_start
2531 flag, which syncs the system's clock on startup.
2534 for more information regarding the
2537 This is a preferred alternative to using
2542 .It Va nis_client_enable
2548 service at system boot time.
2549 .It Va nis_client_flags
2552 .Va nis_client_enable
2555 these are the flags to pass to the
2558 .It Va nis_ypset_enable
2564 daemon at system boot time.
2565 .It Va nis_ypset_flags
2568 .Va nis_ypset_enable
2571 these are the flags to pass to the
2574 .It Va nis_server_enable
2580 daemon at system boot time.
2581 .It Va nis_server_flags
2584 .Va nis_server_enable
2587 these are the flags to pass to the
2590 .It Va nis_ypxfrd_enable
2596 daemon at system boot time.
2597 .It Va nis_ypxfrd_flags
2600 .Va nis_ypxfrd_enable
2603 these are the flags to pass to the
2606 .It Va nis_yppasswdd_enable
2612 daemon at system boot time.
2613 .It Va nis_yppasswdd_flags
2616 .Va nis_yppasswdd_enable
2619 these are the flags to pass to the
2622 .It Va rpc_ypupdated_enable
2628 daemon at system boot time.
2629 .It Va bsnmpd_enable
2635 daemon at system boot time.
2636 Be sure to understand the security implications of running SNMP daemon
2644 these are the flags to pass to the
2647 .It Va defaultrouter
2651 create a default route to this host name or IP address
2652 (use an IP address if this router is also required to get to the
2654 .It Va ipv6_defaultrouter
2656 The IPv6 equivalent of
2658 .It Va static_arp_pairs
2660 Set to the list of static ARP pairs that are to be added at system
2662 For each whitespace separated
2665 .Va static_arp_ Ns Aq Ar element
2666 variable is assumed to exist whose contents will later be passed to a
2671 static_arp_pairs="gw"
2672 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2674 .It Va static_ndp_pairs
2676 Set to the list of static NDP pairs that are to be added at system
2678 For each whitespace separated
2681 .Va static_ndp_ Ns Aq Ar element
2682 variable is assumed to exist whose contents will later be passed to a
2687 static_ndp_pairs="gw"
2688 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2690 .It Va static_routes
2692 Set to the list of static routes that are to be added at system
2696 then for each whitespace separated
2699 .Va route_ Ns Aq Ar element
2700 variable is assumed to exist
2701 whose contents will later be passed to a
2706 static_routes="ext mcast:gif0 gif0local:gif0"
2707 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2708 route_mcast="-net 224.0.0.0/4 -iface gif0"
2709 route_gif0local="-host 169.254.1.1 -iface lo0"
2716 the route is specific to the interface
2718 .It Va ipv6_static_routes
2720 The IPv6 equivalent of
2724 then for each whitespace separated
2727 .Va ipv6_route_ Ns Aq Ar element
2728 variable is assumed to exist
2729 whose contents will later be passed to a
2730 .Dq Nm route Cm add Fl inet6
2732 .It Va natm_static_routes
2738 If not empty then for each whitespace separated
2741 .Va route_ Ns Aq Ar element
2742 variable is assumed to exist whose contents will later be passed to a
2743 .Dq Nm atmconfig Cm natm Cm add
2745 .It Va gateway_enable
2749 configure host to act as an IP router, e.g.\& to forward packets
2751 .It Va ipv6_gateway_enable
2753 The IPv6 equivalent of
2754 .Va gateway_enable .
2755 .It Va routed_enable
2759 run a routing daemon of some sort, based on the
2764 .It Va route6d_enable
2766 The IPv6 equivalent of
2770 run a routing daemon of some sort, based on the
2775 .It Va routed_program
2781 this is the name of the routing daemon to use.
2782 .It Va route6d_program
2784 The IPv6 equivalent of
2785 .Va routed_program .
2792 these are the flags to pass to the routing daemon.
2793 .It Va route6d_flags
2795 The IPv6 equivalent of
2797 .It Va mrouted_enable
2801 run the multicast routing daemon,
2803 .It Va mroute6d_enable
2805 The IPv6 equivalent of
2806 .Va mrouted_enable .
2809 run the IPv6 multicast routing daemon.
2811 Note that multicast routing daemons are no longer included in the
2813 base system, however, both
2817 may be installed from the
2820 .It Va mrouted_flags
2826 these are the flags to pass to the
2829 .It Va mroute6d_flags
2831 The IPv6 equivalent of
2837 these are the flags passed to the IPv6 multicast routing daemon.
2838 .It Va mroute6d_program
2844 this is the path to the IPv6 multicast routing daemon.
2845 .It Va rtadvd_enable
2851 daemon at boot time.
2854 utility sends ICMPv6 Router Advertisement messages to
2855 the interfaces specified in
2856 .Va rtadvd_interfaces .
2857 This should only be enabled with great care.
2858 You may want to fine-tune
2860 .It Va rtadvd_interfaces
2866 this is the list of interfaces to use.
2867 .It Va ipxgateway_enable
2871 enable the routing of IPX traffic.
2872 .It Va ipxrouted_enable
2878 daemon at system boot time.
2879 .It Va ipxrouted_flags
2882 .Va ipxrouted_enable
2885 these are the flags to pass to the
2892 enable global proxy ARP.
2893 .It Va forward_sourceroute
2901 source-routed packets are forwarded.
2902 .It Va accept_sourceroute
2906 the system will accept source-routed packets directed at it.
2913 daemon at system boot time.
2920 these are the flags to pass to the
2923 .It Va bootparamd_enable
2929 daemon at system boot time.
2930 .It Va bootparamd_flags
2933 .Va bootparamd_enable
2936 these are the flags to pass to the
2939 .It Va stf_interface_ipv4addr
2943 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2945 Specify this entry to enable the 6to4 interface.
2946 .It Va stf_interface_ipv4plen
2948 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2949 An effective value is 0-31.
2950 .It Va stf_interface_ipv6_ifid
2952 IPv6 interface ID for
2956 .It Va stf_interface_ipv6_slaid
2958 IPv6 Site Level Aggregator for
2960 .It Va ipv6_faith_prefix
2964 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2969 .It Va ipv6_ipv4mapping
2973 this enables IPv4 mapped IPv6 address communication (like
2974 .Li ::ffff:a.b.c.d ) .
2975 .It Va rtsold_enable
2981 daemon to send ICMPv6 Router Solicitation messages.
2988 these are the flags to pass to
2992 For interfaces configured with the
2993 .Dq Li inet6 accept_rtadv
2994 keyword, these are the flags to pass to
2999 is mutually exclusive to
3007 to enable the configuration of ATM interfaces at system boot time.
3008 For all of the ATM variables described below, please refer to the
3010 manual page for further details on the available command parameters.
3011 Also refer to the files in
3012 .Pa /usr/share/examples/atm
3013 for more detailed configuration information.
3016 This is a list of physical ATM interface drivers to load.
3021 .It Va atm_netif_ Ns Aq Ar intf
3023 For the ATM physical interface
3025 this variable defines the name prefix and count for the ATM network
3026 interfaces to be created.
3027 The value will be passed as the parameters of an
3028 .Dq Nm atm Cm "set netif" Ar intf
3030 .It Va atm_sigmgr_ Ns Aq Ar intf
3032 For the ATM physical interface
3034 this variable defines the ATM signalling manager to be used.
3035 The value will be passed as the parameters of an
3036 .Dq Nm atm Cm attach Ar intf
3038 .It Va atm_prefix_ Ns Aq Ar intf
3040 For the ATM physical interface
3042 this variable defines the NSAP prefix for interfaces using a UNI signalling
3046 the prefix will automatically be set via the
3049 Otherwise, the value will be passed as the parameters of an
3050 .Dq Nm atm Cm "set prefix" Ar intf
3052 .It Va atm_macaddr_ Ns Aq Ar intf
3054 For the ATM physical interface
3056 this variable defines the MAC address for interfaces using a UNI signalling
3060 the hardware MAC address contained in the ATM interface card will be used.
3061 Otherwise, the value will be passed as the parameters of an
3062 .Dq Nm atm Cm "set mac" Ar intf
3064 .It Va atm_arpserver_ Ns Aq Ar netif
3066 For the ATM network interface
3068 this variable defines the ATM address for a host which is to provide ATMARP
3070 This variable is only applicable to interfaces using a UNI signalling
3074 this host will become an ATMARP server.
3075 The value will be passed as the parameters of an
3076 .Dq Nm atm Cm "set arpserver" Ar netif
3078 .It Va atm_scsparp_ Ns Aq Ar netif
3082 SCSP/ATMARP service for the network interface
3084 will be initiated using the
3089 This variable is only applicable if
3090 .Va atm_arpserver_ Ns Aq Ar netif
3095 Set to the list of ATM PVCs to be added at system
3097 For each whitespace separated
3100 .Va atm_pvc_ 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 pvc"
3108 Set to the list of permanent ATM ARP entries to be added
3109 at system boot time.
3110 For each whitespace separated
3113 .Va atm_arp_ Ns Aq Ar element
3114 variable is assumed to exist.
3115 The value of each of these variables
3116 will be passed as the parameters of an
3117 .Dq Nm atm Cm "add arp"
3119 .It Va natm_interfaces
3123 interfaces that will also be used for HARP through
3125 If this list is not empty all interfaces in the list will be brought up
3131 For this to work the interface drivers must be either compiled into the
3132 kernel or must reside on the root partition.
3135 The keyboard bell sound.
3142 if the default behavior is desired.
3143 For details, refer to the
3148 If set to a non-null string, the virtual console's keyboard input is
3154 no keymap is installed, otherwise the value is used to install
3155 the keymap file found in
3156 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3159 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3164 The keyboard repeat speed.
3171 if the default behavior is desired.
3176 attempt to program the function keys with the value.
3178 be a single string of the form:
3179 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3182 Can be set to the value of
3185 .Dq Li destructive ,
3188 to set the cursor behavior explicitly or choose the default behavior.
3193 no screen map is installed, otherwise the value is used to install
3194 the screen map file in
3195 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3196 This parameter is ignored when using
3198 as the console driver.
3203 the default 8x16 font value is used for screen size requests, otherwise
3205 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3207 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3208 is used (depending on the console driver being used).
3213 the default 8x14 font value is used for screen size requests, otherwise
3215 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3217 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3218 is used (depending on the console driver being used).
3223 the default 8x8 font value is used for screen size requests, otherwise
3225 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3227 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3228 is used (depending on the console driver being used).
3233 the default screen blanking interval is used, otherwise it is set
3241 this is the actual screen saver to use
3242 .Li ( blank , snake , daemon ,
3244 .It Va moused_nondefault_enable
3248 the mouse device specified on
3249 the command line is not automatically treated as enabled by the
3250 .Pa /etc/rc.d/moused
3252 Having this variable set to
3258 to be enabled as soon as it is plugged in.
3259 .It Va moused_enable
3265 daemon is started for doing cut/paste selection on the console.
3268 This is the protocol type of the mouse connected to this host.
3269 This variable must be set if
3276 is able to detect the appropriate mouse type automatically in many cases.
3277 Set this variable to
3279 to let the daemon detect it, or
3280 select one from the following list if the automatic detection fails.
3282 If the mouse is attached to the PS/2 mouse port, choose
3286 regardless of the brand and model of the mouse.
3288 mouse is attached to the bus mouse port, choose
3292 All other protocols are for serial mice and will not work with
3293 the PS/2 and bus mice.
3294 If this is a USB mouse,
3296 is the only protocol type which will work.
3298 .Bl -tag -width ".Li x10mouseremote" -compact
3300 Microsoft mouse (serial)
3302 Microsoft IntelliMouse (serial)
3304 Mouse systems Corp.\& mouse (serial)
3306 MM Series mouse (serial)
3308 Logitech mouse (serial)
3312 Logitech MouseMan and TrackMan (serial)
3314 ALPS GlidePoint (serial)
3315 .It Li thinkingmouse
3316 Kensington ThinkingMouse (serial)
3320 MM HitTablet (serial)
3321 .It Li x10mouseremote
3322 X10 MouseRemote (serial)
3324 Interlink VersaPad (serial)
3327 Even if the mouse is not in the above list, it may be compatible
3328 with one in the list.
3329 Refer to the manual page for
3331 for compatibility information.
3333 It should also be noted that while this is enabled, any
3334 other client of the mouse (such as an X server) should access
3335 the mouse through the virtual mouse device,
3337 and configure it as a
3339 type mouse, since all
3340 mouse data is converted to this single canonical format when
3343 If the client program does not support the
3349 It is the second preferred type.
3356 this is the actual port the mouse is on.
3359 for a COM1 serial mouse,
3363 for a bus mouse, for example.
3368 is set, its value is used as an additional set of flags to pass to the
3371 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3373 .Va moused_nondefault_enable
3376 daemon is started for a non-default port, the
3377 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3378 set of options has precedence over and replaces the default
3382 is the name of the non-default port, i.e.,\&
3385 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3386 it is possible to set up a different set of default flags for each
3389 For example, you can use
3393 to make your laptop's touchpad more comfortable to use,
3394 but an empty set of options for
3395 .Va moused_ums0_flags
3398 mouse has three or more buttons.
3399 .It Va mousechar_start
3403 the default mouse cursor character range
3404 .Li 0xd0 Ns - Ns Li 0xd3
3406 otherwise the range start is set
3411 Use if the default range is occupied in the language code table.
3412 .It Va allscreens_flags
3416 is run with these options for each of the virtual terminals
3420 will enable the mouse pointer on all virtual terminals
3425 .It Va allscreens_kbdflags
3429 is run with these options for each of the virtual terminals
3437 scrollback (history) buffer to 200 lines.
3444 daemon at system boot time.
3450 .Pa /usr/sbin/cron ) .
3457 these are the flags to pass to
3463 enable the special handling of transitions to and from the
3464 Daylight Saving Time in
3466 (equivalent to using the flag
3473 .Pa /usr/sbin/lpd ) .
3480 daemon at system boot time.
3487 these are the flags to pass to the
3490 .It Va chkprintcap_enable
3496 command before starting the
3499 .It Va chkprintcap_flags
3504 .Va chkprintcap_enable
3507 these are the flags to pass to the
3512 which causes missing directories to be created.
3513 .It Va mta_start_script
3515 This variable specifies the full path to the script to run to start
3516 a mail transfer agent.
3518 .Pa /etc/rc.sendmail .
3522 .Pa /etc/rc.sendmail
3523 uses are documented in the
3528 Indicates the device (usually a swap partition) to which a crash dump
3529 should be written in the event of a system crash.
3530 If the value of this variable is
3532 the first suitable swap device listed in
3534 will be used as dump device.
3535 Otherwise, the value of this variable is passed as the argument to
3537 To disable crash dumps, set this variable to
3541 When the system reboots after a crash and a crash dump is found on the
3542 device specified by the
3546 will save that crash dump and a copy of the kernel to the directory
3550 The default value is
3559 .It Va savecore_flags
3561 If crash dumps are enabled, these are the flags to pass to the
3568 to turn on user and group disk quotas on system startup via the
3570 command for all file systems marked as having quotas enabled in
3572 The kernel must be built with
3574 for disk quotas to function.
3579 to enable user and group disk quota checking via the
3582 .It Va quotacheck_flags
3592 these are the flags to pass to the
3597 which checks quotas for all file systems with quotas enabled in
3599 .It Va quotaon_flags
3605 these are the flags to pass to the
3610 which enables quotas for all file systems with quotas enabled in
3612 .It Va quotaoff_flags
3618 these are the flags to pass to the
3620 utility when shutting down the quota system.
3623 which disables quotas for all file systems with quotas enabled in
3625 .It Va accounting_enable
3629 to enable system accounting through the
3636 to enable iBCS2 (SCO) binary emulation at system initial boot
3638 .It Va ibcs2_loaders
3646 this specifies a list of additional iBCS2 loaders to enable.
3647 .It Va firstboot_sentinel
3649 This variable specifies the full path to a
3652 If a file exists with this path,
3656 keyword will be run on startup and the sentinel file will be deleted
3657 after the boot process completes.
3658 The sentinel file must be located on a writable file system which is
3659 mounted no later than
3660 .Va early_late_divider
3661 to function properly.
3668 to enable Linux/ELF binary emulation at system initial
3674 enable SysVR4 emulation at boot time.
3675 .It Va sysvipc_enable
3679 load System V IPC primitives at boot time.
3680 .It Va clear_tmp_enable
3691 to disable removing of X11 lock files,
3692 and the removal and (secure) recreation
3693 of the various socket directories for X11
3695 .It Va ldconfig_paths
3697 Set to the list of shared library paths to use with
3701 will always be added first, so it need not appear in this list.
3702 .It Va ldconfig32_paths
3704 Set to the list of 32-bit compatibility shared library paths to
3707 .It Va ldconfig_paths_aout
3709 Set to the list of shared library paths to use with
3714 .It Va ldconfig_insecure
3718 utility normally refuses to use directories
3719 which are writable by anyone except root.
3720 Set this variable to
3722 to disable that security check during system startup.
3723 .It Va ldconfig_local_dirs
3725 Set to the list of local
3728 The names of all files in the directories listed will be
3729 passed as arguments to
3731 .It Va ldconfig_local32_dirs
3733 Set to the list of local 32-bit compatibility
3736 The names of all files in the directories listed will be
3737 passed as arguments to
3738 .Dq Nm ldconfig Fl 32 .
3739 .It Va kern_securelevel_enable
3743 to set the kernel security level at system startup.
3744 .It Va kern_securelevel
3746 The kernel security level to set at startup.
3747 The allowed range of
3749 ranges from \-1 (the compile time default) to 3 (the
3753 for the list of possible security levels and their effect
3754 on system operation.
3757 Path to the SSH server program
3758 .Pa ( /usr/sbin/sshd
3766 at system boot time.
3773 these are the flags to pass to the
3778 Path to the FTP server program
3779 .Pa ( /usr/libexec/ftpd
3787 as a stand-alone daemon at system boot time.
3794 these are the additional flags to pass to the
3797 .It Va watchdogd_enable
3803 daemon at boot time.
3804 This requires that the kernel have been compiled with a
3807 .It Va watchdogd_flags
3810 .Va watchdogd_enable
3813 these are the flags passed to the
3816 .It Va devfs_rulesets
3818 List of files containing sets of rules for
3820 .It Va devfs_system_ruleset
3822 Rule name(s) to apply to the system
3825 .It Va devfs_set_rulesets
3827 Pairs of already-mounted
3829 directories and rulesets that should be applied to them.
3830 For example: /mount/dev=ruleset_name
3831 .It Va devfs_load_rulesets
3833 If set, always load the default rulesets listed in
3834 .Va devfs_rulesets .
3835 .It Va performance_cx_lowest
3837 CPU idle state to use while on AC power.
3842 should use the lowest power state available while
3844 indicates that the lowest latency state (less power savings) should be used.
3845 .It Va performance_cpu_freq
3847 CPU clock frequency to use while on AC power.
3852 should use the lowest frequency available while
3854 indicates that the highest frequency (less power savings) should be used.
3855 .It Va economy_cx_lowest
3857 CPU idle state to use when off AC power.
3862 should use the lowest power state available while
3864 indicates that the lowest latency state (less power savings) should be used.
3865 .It Va economy_cpu_freq
3867 CPU clock frequency to use when off AC power.
3872 should use the lowest frequency available while
3874 indicates that the highest frequency (less power savings) should be used.
3879 any configured jails will not be started.
3882 The configuration filename used by
3885 The default value is
3886 .Pa /etc/jail.conf .
3887 .It Va jail_parallel_start
3891 all configured jails will be started in the background (in parallel).
3895 When set, use as default value for
3896 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3901 A space separated list of names for jails.
3902 If this variable is empty,
3905 instances in the configuration file will be configured.
3906 This is purely a configuration aid to help identify and
3907 configure multiple jails.
3908 The names specified in this list will be used to
3909 identify settings common to an instance of a jail,
3910 and should contain alphanumeric characters only.
3911 The literal jail name of
3915 .It Va jail_* variables
3916 Note that older releases supported per-jail configuration via
3920 hostname of a jail named
3922 was able to be set by
3923 .Li jail_vjail_hostname .
3924 These per-jail configuration variables are now obsolete in favor of
3927 For backward compatibility,
3928 when per-jail configuration variables are defined,
3930 configuration files are created as
3931 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3934 The following per-jail parameters are handled by
3936 script out of their corresponding
3939 In addition to them, parameters in
3940 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3941 will be added to the configuration file.
3942 They must be a semi-colon
3950 .Bl -tag -width "host.hostname" -offset indent
3953 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3954 .It Li host.hostname
3956 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3957 .It Li exec.consolelog
3959 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3960 The default value is
3961 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3964 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3965 .It Li vnet.interface
3967 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3970 parameter will be enabled and cannot be specified with
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3972 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3974 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3978 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3981 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3984 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3987 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3988 The parameter name was
3990 in some older releases.
3991 .It Li exec.prestart
3993 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3994 .It Li exec.poststart
3996 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3999 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4002 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
4003 .It Li exec.poststop
4005 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
4008 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4010 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4011 contain IPv4 addresses
4014 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4016 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4017 contain IPv6 addresses
4020 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4023 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4024 .It Li devfs_ruleset
4026 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
4027 This must be an integer,
4029 .It Li mount.fdescfs
4031 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4032 .It Li allow.set_hostname
4034 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4035 .It Li allow.rawsocket
4037 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4038 .It Li allow.sysvipc
4040 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4042 .\" -----------------------------------------------------
4043 .It Va harvest_interrupt
4047 to use hardware interrupts as an entropy source.
4050 for more information.
4051 .It Va harvest_ethernet
4055 to use LAN traffic as an entropy source.
4058 for more information.
4059 .It Va harvest_p_to_p
4063 to use serial line traffic as an entropy source.
4066 for more information.
4071 to disable caching entropy via
4073 Otherwise set to the directory used to store entropy files in.
4078 to disable caching entropy through reboots.
4079 Otherwise set to the filename used to store cached entropy through
4081 This file should be located on the root file system to seed the
4083 device as early as possible in the boot process.
4084 .It Va entropy_save_sz
4086 Size of the entropy cache files saved by
4089 .It Va entropy_save_num
4091 Number of entropy cache files to save by
4105 Configuration file for
4114 .Pa /var/run/dmesg.boot
4116 .It Va rcshutdown_timeout
4118 If set, start a watchdog timer in the background which will terminate
4122 has not completed within the specified time (in seconds).
4123 Notice that in addition to this soft timeout,
4125 also applies a hard timeout for the execution of
4127 This is configured via
4130 .Va kern.init_shutdown_timeout
4131 and defaults to 120 seconds.
4132 Setting the value of
4133 .Va rcshutdown_timeout
4134 to more than 120 seconds will have no effect until the
4137 .Va kern.init_shutdown_timeout
4139 .It Va virecover_enable
4143 to prevent the system from trying to
4144 recover pre-maturely terminated
4147 .It Va ugidfw_enable
4152 .Xr mac_bsdextended 4
4153 module upon system initialization and load a default
4155 .It Va bsdextended_script
4158 .Xr mac_bsdextended 4
4159 ruleset file to load.
4160 The default value of this variable is
4161 .Pa /etc/rc.bsdextended .
4162 .It Va newsyslog_enable
4169 .It Va newsyslog_flags
4172 .Va newsyslog_enable
4175 these are the flags to pass to the
4180 which causes log files flagged with a
4183 .It Va mdconfig_md Ns Aq Ar X
4193 must be specified and either a
4195 for malloc or swap backed
4203 .Va mdconfig_md Ns Aq Ar X
4204 variables are evaluated until one variable is unset or null.
4205 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4207 Optional arguments passed to
4213 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4215 An ownership specification passed to
4224 device and the mount point will be changed.
4225 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4227 A mode string passed to
4236 device and the mount point will be changed.
4237 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4239 Files to be copied to the mount point of the
4243 after it has been mounted.
4244 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4246 Command to execute after the specified
4251 Note that the command is passed to
4257 variables can be used to reference respectively the
4259 device and the mount point.
4264 one could set the following:
4266 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4268 .It Va autobridge_interfaces
4270 Set to the list of bridge interfaces that will have newly arriving interfaces
4271 checked against to be automatically added.
4274 then for each whitespace separated
4277 .Va autobridge_ Ns Aq Ar element
4278 variable is assumed to exist which has a whitespace separated list of interface
4279 names to match, these names can use wildcards.
4282 autobridge_interfaces="bridge0"
4283 autobridge_bridge0="tap* dc0 vlan[345]"
4289 enable support for sound mixer.
4290 .It Va hcsecd_enable
4294 enable Bluetooth security daemon.
4295 .It Va hcsecd_config
4297 Configuration file for
4300 .Pa /etc/bluetooth/hcsecd.conf .
4305 enable Bluetooth Service Discovery Protocol daemon.
4313 .It Va sdpd_groupname
4317 group to run as after it initializes.
4320 .It Va sdpd_username
4324 user to run as after it initializes.
4327 .It Va bthidd_enable
4331 enable Bluetooth Human Interface Device daemon.
4332 .It Va bthidd_config
4334 Configuration file for
4337 .Pa /etc/bluetooth/bthidd.conf .
4340 Path to a file, where
4342 will store information about known HID devices.
4344 .Pa /var/db/bthidd.hids .
4345 .It Va rfcomm_pppd_server_enable
4349 enable Bluetooth RFCOMM PPP wrapper daemon.
4350 .It Va rfcomm_pppd_server_profile
4352 The name of the profile to use from
4353 .Pa /etc/ppp/ppp.conf .
4354 Multiple profiles can be specified here.
4355 Also used to specify per-profile overrides.
4356 When the profile name contains any of the characters
4358 they are translated to
4360 for the proposes of the override variable names.
4361 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4363 Overrides local address to listen on.
4369 The address can be specified as BD_ADDR or name.
4370 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4372 Overrides local RFCOMM channel to listen on.
4375 will listen on RFCOMM channel 1.
4376 Must set properly if multiple profiles used in the same time.
4377 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4381 if it should register Serial Port service on the specified RFCOMM channel.
4384 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4388 if it should register Dial-Up Networking service on the specified
4392 .It Va ubthidhci_enable
4396 change the USB Bluetooth controller from HID mode to HCI mode.
4397 You also need to specify the location of USB Bluetooth controller with the
4398 .Va ubthidhci_busnum
4402 .It Va ubthidhci_busnum
4403 Bus number where the USB Bluetooth controller is located.
4406 on your system to find this information.
4407 .It Va ubthidhci_addr
4408 Bus address of the USB Bluetooth controller.
4411 on your system to find this information.
4412 .It Va netwait_enable
4416 delays the start of network-reliant services until
4418 is up and ICMP packets to a destination defined in
4421 Link state is examined first, followed by
4423 an IP address to verify network usability.
4424 If no destination can be reached or timeouts are exceeded,
4425 network services are started anyway with no guarantee that
4426 the network is usable.
4427 Use of this variable requires both
4435 This variable contains a space-delimited list of IP addresses to
4437 DNS hostnames should not be used as resolution is not guaranteed
4438 to be functional at this point.
4439 If multiple IP addresses are specified,
4440 each will be tried until one is successful or the list is exhausted.
4441 .It Va netwait_timeout
4443 Indicates the total number of seconds to perform a
4445 against each IP address in
4447 at a rate of one ping per second.
4448 If any of the pings are successful,
4449 full network connectivity is considered reliable.
4454 Defines the name of the network interface on which watch for link.
4456 is used to monitor the interface, looking for
4457 .Dq Li status: no carrier .
4458 Once gone, the link is considered up.
4461 interface if desired.
4462 .It Va netwait_if_timeout
4464 Defines the total number of seconds to wait for link to become usable,
4465 polled at a 1-second interval.
4473 rules from the defined ruleset.
4474 The kernel must be built with
4477 .Cd "options RCTL" .
4483 This variables contains the
4489 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4490 .It Pa /etc/defaults/rc.conf
4492 .It Pa /etc/rc.conf.local
4522 .Xr newsyslog.conf 5 ,
4592 .An Jordan K. Hubbard .