4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the system installation utility.
45 is not to run commands or perform system startup actions
47 Instead, it is included by the
48 various generic startup scripts in
50 which conditionalize their
51 internal actions according to the settings found there.
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
60 when the system administrator wishes to override these defaults.
62 .Pa /etc/rc.conf.local
63 is used to override settings in
65 for historical reasons.
67 The sysrc(8) command provides a scripting interface to modify system
71 .Pa /etc/rc.conf.local
72 you can also place smaller configuration files for each
77 .Ao Ar dir Ac Ns Pa /rc.conf.d
78 directories specified in
80 which will be included by the
83 For jail configurations you could use the file
84 .Pa /etc/rc.conf.d/jail
85 to store jail specific configuration options.
89 .Pa /usr/local/etc/rc.d
92 .Pa /usr/local/rc.conf.d/jail
94 .Pa /opt/conf/rc.conf.d/jail
97 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
99 all of files in the directory will be loaded.
105 .Dq Ar name Ns Li = Ns Ar value
109 The following list provides a name and short description for each
110 variable that can be set in the
113 .Bl -tag -width indent-two
118 enable output of debug messages from rc scripts.
119 This variable can be helpful in diagnosing mistakes when
120 editing or integrating new scripts.
121 Beware that this produces copious output to the terminal and
127 disable informational messages from the rc scripts.
128 Informational messages are displayed when
129 a condition that is not serious enough to warrant a warning or
137 when faststart is used (e.g., at boot time).
138 .It Va early_late_divider
140 The name of the script that should be used as the
141 delimiter between the
145 stages of the boot process.
146 The early stage should contain all the services needed to
147 get the disks (local or remote) mounted so that the late
148 stage can include scripts contained in the directories
151 variable (see below).
152 Thus, the two likely candidates for this value are
154 for the typical system, and
156 if the system needs remote file
157 systems mounted to get access to the
159 directories; for example when
167 is likely to be an appropriate value.
168 Extreme care should be taken when changing this value,
169 and before changing it one should ensure that there are
170 adequate provisions to recover from a failed boot
171 (such as physical contact with the machine,
172 or reliable remote console access).
173 .It Va always_force_depends
177 scripts use the force_depend function to check whether required
178 services are already running, and to start them if necessary.
179 By default during boot time this check is bypassed if the
180 required service is enabled in
181 .Pa /etc/rc.conf[.local] .
182 Setting this option will bypass that check at boot time and
183 always test whether or not the service is actually running.
184 Enabling this option is likely to increase your boot time if
185 services are enabled that utilize the force_depend check.
186 .It Ao Ar name Ac Ns Va _chroot
189 to this directory before running the service.
190 .It Ao Ar name Ac Ns Va _user
192 Run the service under this user account.
193 .It Ao Ar name Ac Ns Va _group
195 Run the chrooted service under this system group.
197 setting, this setting has no effect if the service is not chrooted.
198 .It Ao Ar name Ac Ns Va _fib
202 value to run the service under.
203 .It Ao Ar name Ac Ns Va _nice
207 value to run the service under.
212 enable support for Automatic Power Management with
220 to handle APM event from userland.
221 This also enables support for APM.
228 these are the flags to pass to the
235 to handle device added, removed or unknown events from the kernel.
242 scripts at boot time.
245 Configuration file for
251 A whitespace-separated list of kernel modules to load right after
252 the local disks are mounted, without any
255 Loading modules at this point in the boot process is
256 much faster than doing it via
257 .Pa /boot/loader.conf
258 for those modules not necessary for mounting local disks.
259 .It Va kldxref_enable
266 to automatically rebuild
271 .It Va kldxref_clobber
281 will overwrite existing
288 .It Va kldxref_module_path
293 delimited list of paths containing
305 enable the system power control facility with the
314 these are the flags to pass to the
318 Controls the creation of a
321 Always happens if set to
323 and never happens if set to
325 If set to anything else, a memory file system is created if
329 Controls the size of a created
333 Extra options passed to the
335 utility when the memory file system for
340 which inhibits the use of softupdates on
342 so that file system space is freed without delay
343 after file truncation or deletion.
346 for other options you can use in
349 Controls the creation of a
352 Always happens if set to
354 and never happens if set to
356 If set to anything else, a memory file system is created if
360 Controls the size of a created
364 Extra options passed to the
366 utility when the memory file system for
371 which inhibits the use of softupdates on
373 so that file system space is freed without delay
374 after file truncation or deletion.
377 for other options you can use in
380 Controls the automatic population of the
383 Always happens if set to
385 and never happens if set to
387 If set to anything else, a memory file system is created if
390 Note that this process requires access to certain commands in
394 is mounted on normal systems.
395 .It Va cleanvar_enable
402 List of directories to search for startup script files.
403 .It Va script_name_sep
405 The field separator to use for breaking down the list of startup script files
406 into individual filenames.
407 The default is a space.
408 It is not necessary to change this unless there are startup scripts with names
410 .It Va hostapd_enable
419 The fully qualified domain name (FQDN) of this host on the network.
420 This should almost certainly be set to something meaningful, even if
421 there is no network connection.
424 is used to set the hostname via DHCP,
425 this variable should be set to an empty string.
428 the hostname is generally already set and this variable may absent.
429 If this value remains unset when the system is done booting
430 your console login will display the default hostname of
434 The NIS domain name of this host, or
437 .It Va dhclient_program
439 Path to the DHCP client program
440 .Pa ( /sbin/dhclient ,
445 .It Va dhclient_flags
447 Additional flags to pass to the DHCP client program.
452 manpage for a description of the command line options available.
453 .It Va dhclient_flags_ Ns Aq Ar iface
454 Additional flags to pass to the DHCP client program running on
457 When specified, this variable overrides
459 .It Va background_dhclient
463 to start the DHCP client in background.
464 This can cause trouble with applications depending on
465 a working network, but it will provide a faster startup
467 .It Va background_dhclient_ Ns Aq Ar iface
468 When specified, this variable overrides the
469 .Va background_dhclient
470 variable for interface
473 .It Va synchronous_dhclient
479 synchronously at startup.
480 This behavior can be overridden on a per-interface basis by replacing
484 .Va ifconfig_ Ns Aq Ar interface
489 .It Va defaultroute_delay
491 When set to a positive value, wait up to this long after configuring
492 DHCP interfaces at startup to give the interfaces time to receive a lease.
493 .It Va firewall_enable
497 to load firewall rules at startup.
498 If the kernel was not built with
499 .Cd "options IPFIREWALL" ,
502 kernel module will be loaded.
504 .Va ipfilter_enable .
505 .It Va firewall_script
507 This variable specifies the full path to the firewall script to run.
509 .Pa /etc/rc.firewall .
512 Names the firewall type from the selection in
513 .Pa /etc/rc.firewall ,
514 or the file which contains the local firewall ruleset.
515 Valid selections from
519 .Bl -tag -width ".Li simple" -compact
521 unrestricted IP access
523 all IP services disabled, except via
526 basic protection for a workstation
528 basic protection for a LAN.
531 If a filename is specified, the full path
533 .It Va firewall_quiet
537 to disable the display of firewall rules on the console during boot.
538 .It Va firewall_logging
542 to enable firewall event logging.
543 This is equivalent to the
544 .Dv IPFIREWALL_VERBOSE
546 .It Va firewall_logif
550 to create pseudo interface
553 For more details, see
556 .It Va firewall_flags
562 specifies a filename.
563 .It Va firewall_coscripts
565 List of executables and/or rc scripts to run after firewall starts/stops.
567 .\" ----- firewall_nat_enable setting --------------------------------
568 .It Va firewall_nat_enable
576 will automatically load the
582 .It Va firewall_nat_interface
588 This is the name of the public interface or IP address on which
589 kernel NAT should run.
590 .It Va firewall_nat_flags
592 Additional configuration parameters for kernel NAT should be placed here.
593 .It Va firewall_nat64_enable
597 will automatically load the
599 NAT64 kernel module if
603 .It Va firewall_nptv6_enable
607 will automatically load the
609 NPTv6 kernel module if
613 .It Va firewall_pmod_enable
617 will automatically load the
619 pmod kernel module if
623 .It Va dummynet_enable
627 will automatically load the
633 .\" -------------------------------------------------------------------
634 .It Va ipfw_netflow_enable
638 will enable netflow logging via
641 By default a ipfw rule is inserted and all packets are duplicated with
642 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
643 port using protocol version 5.
644 .It Va ipfw_netflow_hook
646 netflow hook name, must be numerical
649 .It Va ipfw_netflow_rule
654 .It Va ipfw_netflow_ip
656 Destination server ip for receiving netflow data
659 .It Va ipfw_netflow_port
661 Destination server port for receiving netflow data
664 .It Va ipfw_netflow_version
666 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
667 .It Va ipfw_netflow_fib
669 Only match packet in FIB
671 (default is undefined meaning all FIBs).
687 sockets must be enabled in the kernel.
688 If the kernel was not built with
689 .Cd "options IPDIVERT" ,
692 kernel module will be loaded.
693 .It Va natd_interface
695 This is the name of the public interface on which
698 The interface may be given as an interface name or as an IP address.
703 flags should be placed here.
708 flag is automatically added with the above
711 .\" ----- ipfilter_enable setting --------------------------------
712 .It Va ipfilter_enable
723 Typical usage will require putting
725 ipfilter_enable="YES"
743 can be enabled independently.
747 both require at least one of
757 options IPFILTER_DEFAULT_BLOCK
760 in the kernel configuration file is a good idea, too.
761 .\" ----- ipfilter_program setting ------------------------------
762 .It Va ipfilter_program
768 .\" ----- ipfilter_rules setting --------------------------------
769 .It Va ipfilter_rules
774 This variable contains the name of the filter rule definition file.
775 The file is expected to be readable for the
778 .\" ----- ipv6_ipfilter_rules setting ---------------------------
779 .It Va ipv6_ipfilter_rules
784 This variable contains the IPv6 filter rule definition file.
785 The file is expected to be readable for the
788 .\" ----- ipfilter_flags setting --------------------------------
789 .It Va ipfilter_flags
792 This variable contains flags passed to the
795 .\" ----- ipnat_enable setting ----------------------------------
805 network address translation.
808 for a detailed discussion.
809 .\" ----- ipnat_program setting ---------------------------------
816 .\" ----- ipnat_rules setting -----------------------------------
822 This variable contains the name of the file
823 holding the network address translation definition.
824 This file is expected to be readable for the
827 .\" ----- ipnat_flags setting -----------------------------------
831 This variable contains flags passed to the
834 .\" ----- ipmon_enable setting ----------------------------------
849 Setting this variable needs setting
856 for a detailed discussion.
857 .\" ----- ipmon_program setting ---------------------------------
864 .\" ----- ipmon_flags setting -----------------------------------
870 This variable contains flags passed to the
873 Another typical example would be
874 .Dq Fl D Pa /var/log/ipflog
877 log directly to a file bypassing
880 .Pa /etc/newsyslog.conf
881 in such case like this:
883 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
885 .\" ----- ipfs_enable setting -----------------------------------
895 saving the filter and NAT state tables during shutdown
896 and reloading them during startup again.
897 Setting this variable needs setting
906 for a detailed discussion.
912 because the raised securelevel will prevent
914 from saving the state tables at shutdown time.
915 .\" ----- ipfs_program setting ----------------------------------
922 .\" ----- ipfs_flags setting ------------------------------------
926 This variable contains flags passed to the
929 .\" ----- end of added ipf hook ---------------------------------
941 Typical usage will require putting
956 into the kernel, otherwise the
957 kernel module will be loaded.
962 ruleset configuration file
977 these flags are passed to the
979 program when loading the ruleset.
989 which logs packets from the
1002 .Pa /var/log/pflog ) .
1004 .Pa /etc/newsyslog.conf
1005 to adjust logfile rotation for this.
1006 .It Va pflog_program
1011 .Pa /sbin/pflogd ) .
1015 This variable contains additional flags passed to the
1018 .It Va pflog_instances
1020 If logging to more than one
1022 interface is desired,
1024 is set to the list of
1026 instances that should be started at system boot time.
1029 is set, for each whitespace-separated
1032 .Ao Ar element Ac Ns Va _dev
1034 .Ao Ar element Ac Ns Va _logfile
1035 elements are assumed to exist.
1036 .Ao Ar element Ac Ns Va _dev
1039 interface to be watched by the named
1042 .Ao Ar element Ac Ns Va _logfile
1043 must contain the name of the logfile that will be used by the
1046 .It Va ftpproxy_enable
1057 packet filter in translating ftp connections.
1058 .It Va ftpproxy_flags
1061 This variable contains additional flags passed to the
1064 .It Va ftpproxy_instances
1067 If multiple instances of
1069 are desired at boot time,
1070 .Va ftpproxy_instances
1071 should contain a whitespace-separated list of instance names.
1074 in the list, a variable named
1075 .Ao Ar element Ac Ns Va _flags
1076 should be defined, containing the command-line flags to be passed to the
1079 .It Va pfsync_enable
1088 state changes to other hosts over the network by means of
1093 must also be set then.
1094 .It Va pfsync_syncdev
1097 This variable specifies the name of the network interface
1099 should operate through.
1100 It must be set accordingly if
1104 .It Va pfsync_syncpeer
1107 This variable is optional.
1108 By default, state change messages are sent out on the synchronisation
1109 interface using IP multicast packets.
1110 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1112 When a peer address is specified using the
1114 option, the peer address is used as a destination for the pfsync
1115 traffic, and the traffic can then be protected using
1119 manpage for more details about using
1124 .It Va pfsync_ifconfig
1127 This variable can contain additional options to be passed to the
1129 command used to set up
1131 .It Va tcp_extensions
1138 disables certain TCP options as described by
1144 might help remedy such problems with connections as randomly hanging
1145 or other weird behavior.
1146 Some network devices are known
1147 to be broken with respect to these options.
1150 Set to 0 by default.
1154 .Va net.inet.tcp.log_in_vain
1156 .Va net.inet.udp.log_in_vain ,
1161 are set to the given value.
1162 .It Va tcp_keepalive
1169 will disable probing idle TCP connections to verify that the
1170 peer is still up and reachable.
1171 .It Va tcp_drop_synfin
1178 will cause the kernel to ignore TCP frames that have both
1179 the SYN and FIN flags set.
1180 This prevents OS fingerprinting, but may
1181 break some legitimate applications.
1182 .It Va icmp_drop_redirect
1189 will cause the kernel to ignore ICMP REDIRECT packets.
1192 for more information.
1193 .It Va icmp_log_redirect
1200 will cause the kernel to log ICMP REDIRECT packets.
1202 the log messages are not rate-limited, so this option should only be used
1203 for troubleshooting networks.
1206 for more information.
1207 .It Va icmp_bmcastecho
1211 to respond to broadcast or multicast ICMP ping packets.
1214 for more information.
1215 .It Va ip_portrange_first
1219 this is the first port in the default portrange.
1222 for more information.
1223 .It Va ip_portrange_last
1227 this is the last port in the default portrange.
1230 for more information.
1231 .It Va network_interfaces
1233 Set to the list of network interfaces to configure on this host or
1235 (the default) for all current interfaces.
1237 .Va network_interfaces
1238 variable to anything other than the default is deprecated.
1239 Interfaces that the administrator wishes to store configuration for,
1240 but not start at boot should be configured with the
1243 .Va ifconfig_ Ns Aq Ar interface
1244 variables as described below.
1247 .Va ifconfig_ Ns Aq Ar interface
1248 variable is also assumed to exist for each value of
1250 When an interface name contains any of the characters
1252 they are translated to
1255 The variable can contain arguments to
1257 as well as special case-insensitive keywords described below.
1258 Such keywords are removed before passing the value to
1260 while the order of the other arguments is preserved.
1262 It is possible to add IP alias entries using
1264 syntax with the address family keyword such as
1266 Assuming that the interface in question was
1268 it might look something like this:
1270 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1271 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1274 It also possible to configure multiple IP addresses in Classless
1275 Inter-Domain Routing
1278 whose each address component can be a range like
1279 .Li inet 192.0.2.5-23/24
1281 .Li inet6 2001:db8:1-f::1/64 .
1282 This notation allows address and prefix length part only,
1283 not the other address modifiers.
1284 Note that the maximum number of the generated addresses from a range
1285 specification is limited to an integer value specified in
1286 .Va netif_ipexpand_max
1289 because a small typo can unexpectedly generate a large number of addresses.
1290 The default value is
1292 It can be increased by adding the following line into
1295 netif_ipexpand_max="4096"
1299 .Li 192.0.2.5-23/24 ,
1300 the address 192.0.2.5 will be configured with the
1301 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1302 the non-conflicting netmask /32 as explained in the
1305 Note that this special netmask handling is only for
1307 not for the other address families such as
1310 With the interface in question being
1312 an example could look like:
1314 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1315 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1321 .Va ipv4_addrs_ Ns Aq Ar interface
1322 variable was supported for IPv4 CIDR address notation.
1323 It is now deprecated because the functionality was integrated into
1324 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1326 .Va ipv4_addrs_ Ns Aq Ar interface
1327 is still supported for backward compatibility.
1330 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1331 entry with an address family keyword,
1332 its contents are passed to
1334 Execution stops at the first unsuccessful access, so if
1335 something like this is present:
1337 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1338 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1339 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1340 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1343 Then note that alias4 would
1345 be added since the search would
1346 stop with the missing
1349 Because of this difficult to manage behavior,
1351 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1352 variable, which has the same functionality as
1353 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1354 and can have all of entries in a variable like the following:
1356 ifconfig_ed0_aliases="\\
1357 inet 127.0.0.251 netmask 0xffffffff \\
1358 inet 127.0.0.252 netmask 0xffffffff \\
1359 inet 127.0.0.253 netmask 0xffffffff \\
1360 inet 127.0.0.254 netmask 0xffffffff"
1363 It also supports CIDR notation.
1366 .Pa /etc/start_if. Ns Aq Ar interface
1367 file is present, it is read and executed by the
1370 before configuring the interface as specified in the
1371 .Va ifconfig_ Ns Aq Ar interface
1373 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1377 .Va vlans_ Ns Aq Ar interface
1381 interface will be created for each item in the list with the
1385 If a vlan interface's name is a number,
1386 then that number is used as the vlan tag and the new vlan interface is
1388 .Ar interface . Ns Ar tag .
1390 the vlan tag must be specified via a
1393 .Va create_args_ Ns Aq Ar interface
1396 To create a vlan device named
1400 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1403 ifconfig_em0_101="inet 192.0.2.1/24"
1406 To create a vlan device named
1410 with the vlan tag 102:
1413 create_args_myvlan="vlan 102"
1417 .Va wlans_ Ns Aq Ar interface
1421 interface will be created for each item in the list with the
1425 Further wlan cloning arguments may be passed to the
1428 command by setting the
1429 .Va create_args_ Ns Aq Ar interface
1433 devices must be created for each wireless devices as of
1439 may be specified with an
1440 .Va wlandebug_ Ns Aq Ar interface
1442 The contents of this variable will be passed directly to
1446 .Va ifconfig_ Ns Aq Ar interface
1447 contains the keyword
1449 then the interface will not be configured
1451 .Pa /etc/pccard_ether
1453 .Va network_interfaces
1457 It is possible to bring up an interface with DHCP by adding
1460 .Va ifconfig_ Ns Aq Ar interface
1462 For instance, to initialize the
1465 it is possible to use something like:
1470 If you want to configure your wireless interface with
1471 .Xr wpa_supplicant 8
1472 for use with WPA, EAP/LEAP or WEP, you need to add
1475 .Va ifconfig_ Ns Aq Ar interface
1478 On the other hand, if you want to configure your wireless interface with
1483 .Va ifconfig_ Ns Aq Ar interface
1486 will use the settings from
1487 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1489 Finally, you can add
1491 options in this variable, in addition to the
1492 .Pa /etc/start_if. Ns Aq Ar interface
1494 For instance, to configure an
1496 wireless device in station mode with an address obtained
1497 via DHCP, using WPA authentication and 802.11b mode, it is
1498 possible to use something like:
1501 ifconfig_wlan0="DHCP WPA mode 11b"
1505 .Va ifconfig_ Ns Aq Ar interface
1506 form, a fallback variable
1507 .Va ifconfig_DEFAULT
1509 It will be used for all interfaces with no
1510 .Va ifconfig_ Ns Aq Ar interface
1512 This is intended to replace the no longer supported
1516 It is also possible to rename an interface by doing:
1518 ifconfig_ed0_name="net0"
1519 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1523 This variable is deprecated.
1525 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1527 .Va ipv6_activate_all_interfaces
1532 .Dq Li inet6 accept_rtadv
1534 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1536 .Va ipv6_activate_all_interfaces
1541 This variable is deprecated.
1543 .Va ip6addrctl_policy
1548 the default address selection policy table set by
1550 will be IPv6-preferred.
1554 the default address selection policy table set by
1556 will be IPv4-preferred.
1557 .It Va ipv6_activate_all_interfaces
1559 This controls initial configuration on IPv6-capable
1560 interfaces with no corresponding
1561 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1563 Note that it is not always necessary to set this variable to
1565 to use IPv6 functionality on
1567 In most cases, just configuring
1568 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1573 all interfaces which do not have a corresponding
1574 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1575 variable will be marked as
1578 This means that all of IPv6 functionality on that interface
1579 is completely disabled to enforce a security policy.
1580 If the variable is set to
1582 the flag will be cleared on all of the interfaces.
1584 In most cases, just defining an
1585 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1586 for an IPv6-capable interface should be sufficient.
1587 However, if an interface is added dynamically
1588 .Pq by some tunneling protocols such as PPP, for example ,
1589 it is often difficult to define the variable in advance.
1590 In such a case, configuring the
1592 flag can be disabled by setting this variable to
1595 For more details of the
1598 .Dq Li inet6 ifdisabled ,
1608 privacy addresses will be generated for each IPv6
1609 interface as described in RFC 4941.
1610 .It Va ipv6_network_interfaces
1612 This is the IPv6 equivalent of
1613 .Va network_interfaces .
1614 Normally manual configuration of this variable is not needed.
1615 .It Va ipv6_cpe_wanif
1617 If the variable is set to an interface name,
1621 .Dq inet6 -no_radr accept_rtadv
1622 will be added to the specified interface automatically before evaluating
1623 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1627 .Va net.inet6.ip6.rfc6204w3
1629 .Va net.inet6.ip6.no_radr
1632 This means the specified interface will accept ICMPv6 Router
1633 Advertisement messages on that link and add the discovered
1634 routers into the Default Router List.
1635 While the other interfaces can still accept RA messages if the
1636 .Dq inet6 accept_rtadv
1637 option is specified, adding
1638 routes into the Default Router List will be disabled by
1645 Note that ICMPv6 Router Advertisement messages will be
1647 .Va net.inet6.ip6.forwarding
1649 .Pq packet forwarding is enabled
1651 .Va net.inet6.ip6.rfc6204w3
1656 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1658 This assigns arbitrary description to an interface.
1662 .Va net.ifdescr_maxlen
1664 This static setting may be overridden by commands
1665 started with dynamic interface configuration utilities
1668 hooks. The description can be seen with
1670 command and it may be exported with
1672 daemon using its MIB-2 module.
1673 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1675 IPv6 functionality on an interface should be configured by
1676 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1677 instead of setting ifconfig parameters in
1678 .Va ifconfig_ Ns Aq Ar interface .
1679 If this variable is empty, all of IPv6 configurations on the
1680 specified interface by other variables such as
1681 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1684 Aliases should be set by
1685 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1691 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1692 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1695 Interfaces that have an
1696 .Dq Li inet6 accept_rtadv
1698 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1699 setting will be automatically configured by SLAAC
1700 .Pq StateLess Address AutoConfiguration
1706 Note that a link-local address will be automatically configured in
1707 addition to the configured global-scope addresses because the IPv6
1708 specifications require it on each link.
1709 The address is calculated from the MAC address by using an algorithm
1716 If only a link-local address is needed on the interface,
1717 the following configuration can be used:
1719 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1722 A link-local address can also be configured manually.
1723 This is useful for the default router address of an IPv6 router
1724 so that it does not change when the network interface
1728 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1730 .It Va ipv6_prefix_ Ns Aq Ar interface
1732 If one or more prefixes are defined in
1733 .Va ipv6_prefix_ Ns Aq Ar interface
1734 addresses based on each prefix and the EUI-64 interface index will be
1735 configured on that interface.
1736 Note that this variable will be ignored when
1737 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1740 For example, the following configuration
1742 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1745 is equivalent to the following:
1747 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1748 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1749 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1750 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1753 These Subnet-Router anycast addresses will be added only when
1754 .Va ipv6_gateway_enable
1756 .It Va ipv6_default_interface
1760 this is the default output interface for scoped addresses.
1761 This works only with ipv6_gateway_enable="NO".
1762 .It Va ip6addrctl_enable
1764 This variable is to enable configuring default address selection policy table
1766 The table can be specified in another variable
1767 .Va ip6addrctl_policy .
1769 .Va ip6addrctl_policy
1770 the following keywords can be specified:
1771 .Dq Li ipv4_prefer ,
1772 .Dq Li ipv6_prefer ,
1782 installs a pre-defined policy table described in Section 2.1
1790 is specified, it attempts to read a file
1791 .Pa /etc/ip6addrctl.conf
1793 If this file is found,
1795 reads and installs it.
1796 If not found, a policy is automatically set
1798 .Va ipv6_activate_all_interfaces
1799 variable; if the variable is set to
1801 the IPv6-preferred one is used.
1802 Otherwise IPv4-preferred.
1804 The default value of
1805 .Va ip6addrctl_enable
1807 .Va ip6addrctl_policy
1813 .It Va cloned_interfaces
1815 Set to the list of clonable network interfaces to create on this host.
1816 Further cloning arguments may be passed to the
1819 command for each interface by setting the
1820 .Va create_args_ Ns Aq Ar interface
1822 If an interface name is specified with
1825 the interface will not be destroyed even when
1827 script is invoked with
1830 This is useful when reconfiguring the interface without destroying it.
1832 .Va cloned_interfaces
1833 are automatically appended to
1834 .Va network_interfaces
1836 .It Va cloned_interfaces_sticky
1838 This variable is to globally enable functionality of
1841 .Va cloned_interfaces
1843 The default value is
1845 Even if this variable is specified to
1848 keyword can be used to override it on per interface basis.
1849 .It Va gif_interfaces
1851 This variable is deprecated in favor of
1852 .Va cloned_interfaces .
1855 tunnel interfaces to configure on this host.
1858 tunnel interface, set a variable named
1859 .Va ifconfig_ Ns Aq Ar interface
1860 with the parameters for the
1862 command to configure the link level for
1867 The value of this variable is used to configure the link layer of the
1872 For example, configure two
1875 .Bd -literal -offset indent
1876 gif_interfaces="gif0 gif1"
1877 ifconfig_gif0="tunnel src_addr0 dst_addr0"
1878 ifconfig_gif1="tunnel src_addr1 dst_addr1"
1881 Additionally, this option ensures that each listed interface is created
1886 This example also works with
1887 .Va cloned_interfaces
1889 .Va gif_interfaces .
1890 .It Va sppp_interfaces
1894 interfaces to configure on this host.
1896 .Va spppconfig_ Ns Aq Ar interface
1897 variable is assumed to exist for each value of
1899 Each interface should also be configured by a general
1900 .Va ifconfig_ Ns Aq Ar interface
1904 for more information about available options.
1914 The name of the profile to use from
1915 .Pa /etc/ppp/ppp.conf .
1916 Also used for per-profile overrides of
1921 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1922 When the profile name contains any of the characters
1924 they are translated to
1926 for the proposes of the override variable names.
1929 Mode in which to run the
1932 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1934 Overrides the global
1944 See the manual for a full description.
1949 enables network address translation.
1950 Used in conjunction with
1952 allows hosts on private network addresses access to the Internet using
1953 this host as a network address translating router.
1954 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1956 Overrides the global
1960 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1962 Set the unit number to be used for this profile.
1963 See the manual description of
1968 The name of the user under which
1976 .It Va rc_conf_files
1978 This option is used to specify a list of files that will override
1980 .Pa /etc/defaults/rc.conf .
1981 The files will be read in the order in which they are specified and should
1982 include the full path to the file.
1983 By default, the files specified are
1986 .Pa /etc/rc.conf.local
1992 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1994 .It Va gptboot_enable
1998 .Pa /etc/rc.d/gptboot
1999 will log if the system successfully (or not) booted from a GPT partition,
2005 .It Va gbde_autoattach_all
2010 will attempt to automatically initialize your .bde devices in
2014 List the devices that the script should try to attach,
2019 The directory where the
2021 lockfiles are located.
2022 The default lockfile directory is
2025 The lockfile for each individual
2027 device can be overridden by setting the variable
2028 .Va gbde_lock_ Ns Aq Ar device ,
2031 is the encrypted device without the
2036 .It Va gbde_attach_attempts
2038 Number of times to attempt attaching to a
2040 device, i.e., how many times the user is asked for the pass-phrase.
2044 List of devices to automatically attach on boot.
2045 Note that .eli devices from
2047 are automatically appended to this list.
2050 List of groups containing devices to automatically attach on boot with the same
2051 keyfiles and passphrase.
2052 This must be accompanied with a corresponding
2053 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2057 Number of times user is asked for the pass-phrase.
2058 If empty, it will be taken from
2059 .Va kern.geom.eli.tries
2061 .It Va geli_default_flags
2063 Default flags to use by
2065 when configuring disk encryption.
2066 Flags can be configured for every device separately by defining the
2067 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2068 variable, and for every group separately by defining the
2069 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2071 .It Va geli_autodetach
2073 Specifies if GELI devices should be marked for detach on last close after
2074 file systems are mounted.
2077 This can be changed for every device separately by defining the
2078 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2080 .It Va root_rw_mount
2085 After the file systems are checked at boot time, the root file system
2086 is remounted as read-write if this is set to
2088 Diskless systems that mount their root file system from a read-only remote
2089 NFS share should set this to
2093 .It Va fsck_y_enable
2098 will be run with the
2100 flag if the initial preen
2101 of the file systems fails.
2102 .It Va background_fsck
2106 the system will not attempt to run
2108 in the background where possible.
2109 .It Va background_fsck_delay
2111 The amount of time in seconds to sleep before starting a background
2113 It defaults to sixty seconds to allow large applications such as
2114 the X server to start before disk I/O bandwidth is monopolized by
2116 If set to a negative number, the background file system check will be
2117 delayed indefinitely to allow the administrator to run it at a more
2119 For example it may be run from
2121 by adding a line like
2123 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2129 List of file system types that are network-based.
2130 This list should generally not be modified by end users.
2132 .Va extra_netfs_types
2134 .It Va extra_netfs_types
2136 If set to something other than
2139 this variable extends the list of file system types
2140 for which automatic mounting at startup by
2142 should be delayed until the network is initialized.
2144 a whitespace-separated list of network file system descriptor pairs,
2145 each consisting of a file system type as passed to
2147 and a human-readable, one-word description,
2150 Extending the default list in this way is only necessary
2151 when third party file system types are used.
2152 .It Va syslogd_enable
2159 .It Va syslogd_program
2164 .Pa /usr/sbin/syslogd ) .
2165 .It Va syslogd_flags
2171 these are the flags to pass to
2180 .It Va inetd_program
2185 .Pa /usr/sbin/inetd ) .
2192 these are the flags to pass to
2201 .It Va hastd_program
2213 these are the flags to pass to
2215 .It Va local_unbound_enable
2221 daemon as a local caching resolver.
2226 to start a Kerberos 5 authentication server
2234 this is the path to Kerberos 5 Authentication Server.
2238 This variable contains additional flags to be passed to the Kerberos 5
2239 authentication server.
2240 .It Va kadmind_enable
2246 the Kerberos 5 Administration Daemon; set to
2249 .It Va kadmind_program
2255 this is the path to Kerberos 5 Administration Daemon.
2256 .It Va kpasswdd_enable
2262 the Kerberos 5 Password-Changing Daemon; set to
2265 .It Va kpasswdd_program
2271 this is the path to Kerberos 5 Password-Changing Daemon.
2278 the Kerberos 5 ticket forwarding daemon, at the boot time.
2284 .Pa /usr/libexec/kfd ) .
2291 daemon at boot time.
2298 these are the flags to pass to it.
2305 daemon at boot time.
2312 these are the flags to pass to it.
2315 manpage for more information.
2316 .It Va amd_map_program
2319 the specified program is run to get the list of
2324 maps are stored in NIS, one can set this to
2337 will be updated at boot time to reflect the kernel release
2342 will not be updated.
2343 .It Va nfs_client_enable
2347 run the NFS client daemons at boot time.
2348 .It Va nfs_access_cache
2351 .Va nfs_client_enable
2356 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2358 results should be cached.
2359 A value of 2-10 seconds will substantially reduce network
2360 traffic for many NFS operations.
2361 .It Va nfs_server_enable
2365 run the NFS server daemons at boot time.
2366 .It Va nfs_server_flags
2369 .Va nfs_server_enable
2372 these are the flags to pass to the
2375 .It Va nfsv4_server_enable
2378 .Va nfs_server_enable
2382 .Va nfsv4_server_enable
2385 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2386 .It Va nfsuserd_enable
2392 run the nfsuserd daemon, which is needed for NFSv4 in order
2393 to map between user/group names vs uid/gid numbers.
2395 .Va nfsv4_server_enable
2398 this will be forced enabled.
2399 .It Va nfsuserd_flags
2405 these are the flags to pass to the
2408 .It Va nfscbd_enable
2414 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2421 these are the flags to pass to the
2424 .It Va mountd_enable
2429 .Va nfs_server_enable
2435 It is commonly needed to run CFS without real NFS used.
2442 these are the flags to pass to the
2445 .It Va weak_mountd_authentication
2449 allow services like PCNFSD to make non-privileged mount
2451 .It Va nfs_reserved_port_only
2455 provide NFS services only on a secure port.
2456 .It Va nfs_bufpackets
2458 If set to a number, indicates the number of packets worth of
2459 socket buffer space to reserve on an NFS client.
2460 The kernel default is typically 4.
2461 Using a higher number may be
2462 useful on gigabit networks to improve performance.
2463 The minimum value is
2464 2 and the maximum is 64.
2465 .It Va rpc_lockd_enable
2469 and also an NFS server or client, run
2472 .It Va rpc_lockd_flags
2475 .Va rpc_lockd_enable
2478 these are the flags to pass to the
2481 .It Va rpc_statd_enable
2485 and also an NFS server or client, run
2488 .It Va rpc_statd_flags
2491 .Va rpc_statd_enable
2494 these are the flags to pass to the
2497 .It Va rpcbind_program
2502 .Pa /usr/sbin/rpcbind ) .
2503 .It Va rpcbind_enable
2509 service at boot time.
2510 .It Va rpcbind_flags
2516 these are the flags to pass to the
2519 .It Va keyserv_enable
2525 daemon on boot for running Secure RPC.
2526 .It Va keyserv_flags
2532 these are the flags to pass to
2535 .It Va pppoed_enable
2541 daemon at boot time to provide PPP over Ethernet services.
2542 .It Va pppoed_ Ns Aq Ar provider
2545 listens to requests to this
2551 argument of the same name.
2554 Additional flags to pass to
2556 .It Va pppoed_interface
2558 The network interface to run
2561 This is mandatory when
2571 service at boot time.
2572 This command is intended for networks of
2573 machines where a consistent
2575 for all hosts must be established.
2576 This is often useful in large NFS
2577 environments where time stamps on files are expected to be consistent
2585 these are the flags to pass to the
2588 .It Va ntpdate_enable
2595 This command is intended to
2596 synchronize the system clock only
2598 from some standard reference.
2600 Note that the use of the
2601 .Va ntpd_sync_on_start
2602 variable is a preferred alternative to the
2606 is to be retired from the NTP distribution.
2607 .It Va ntpdate_config
2609 Configuration file for
2613 .It Va ntpdate_hosts
2615 A whitespace-separated list of NTP servers to synchronize with at startup.
2616 The default is to use the servers listed in
2617 .Va ntpdate_config ,
2618 if that file exists.
2619 .It Va ntpdate_program
2624 .Pa /usr/sbin/ntpdate ) .
2625 .It Va ntpdate_flags
2631 these are the flags to pass to the
2633 command (typically a hostname).
2640 command at boot time.
2646 .Pa /usr/sbin/ntpd ) .
2660 these are the flags to pass to the
2663 .It Va ntpd_sync_on_start
2670 flag, which syncs the system's clock on startup.
2673 for more information regarding the
2676 This is a preferred alternative to using
2681 .It Va nis_client_enable
2687 service at system boot time.
2688 .It Va nis_client_flags
2691 .Va nis_client_enable
2694 these are the flags to pass to the
2697 .It Va nis_ypldap_enable
2703 daemon at system boot time.
2704 .It Va nis_ypldap_flags
2707 .Va nis.ypldap_enable
2710 these are the flags to pass to the
2713 .It Va nis_ypset_enable
2719 daemon at system boot time.
2720 .It Va nis_ypset_flags
2723 .Va nis_ypset_enable
2726 these are the flags to pass to the
2729 .It Va nis_server_enable
2735 daemon at system boot time.
2736 .It Va nis_server_flags
2739 .Va nis_server_enable
2742 these are the flags to pass to the
2745 .It Va nis_ypxfrd_enable
2751 daemon at system boot time.
2752 .It Va nis_ypxfrd_flags
2755 .Va nis_ypxfrd_enable
2758 these are the flags to pass to the
2761 .It Va nis_yppasswdd_enable
2767 daemon at system boot time.
2768 .It Va nis_yppasswdd_flags
2771 .Va nis_yppasswdd_enable
2774 these are the flags to pass to the
2777 .It Va rpc_ypupdated_enable
2783 daemon at system boot time.
2784 .It Va bsnmpd_enable
2790 daemon at system boot time.
2791 Be sure to understand the security implications of running SNMP daemon
2799 these are the flags to pass to the
2802 .It Va defaultrouter
2806 create a default route to this host name or IP address
2807 (use an IP address if this router is also required to get to the
2809 .It Va ipv6_defaultrouter
2811 The IPv6 equivalent of
2813 .It Va static_arp_pairs
2815 Set to the list of static ARP pairs that are to be added at system
2817 For each whitespace separated
2820 .Va static_arp_ Ns Aq Ar element
2821 variable is assumed to exist whose contents will later be passed to a
2826 static_arp_pairs="gw"
2827 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2829 .It Va static_ndp_pairs
2831 Set to the list of static NDP pairs that are to be added at system
2833 For each whitespace separated
2836 .Va static_ndp_ Ns Aq Ar element
2837 variable is assumed to exist whose contents will later be passed to a
2842 static_ndp_pairs="gw"
2843 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2845 .It Va static_routes
2847 Set to the list of static routes that are to be added at system
2851 then for each whitespace separated
2854 .Va route_ Ns Aq Ar element
2855 variable is assumed to exist
2856 whose contents will later be passed to a
2861 static_routes="ext mcast:gif0 gif0local:gif0"
2862 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2863 route_mcast="-net 224.0.0.0/4 -iface gif0"
2864 route_gif0local="-host 169.254.1.1 -iface lo0"
2871 the route is specific to the interface
2873 .It Va ipv6_static_routes
2875 The IPv6 equivalent of
2879 then for each whitespace separated
2882 .Va ipv6_route_ Ns Aq Ar element
2883 variable is assumed to exist
2884 whose contents will later be passed to a
2885 .Dq Nm route Cm add Fl inet6
2887 .It Va gateway_enable
2891 configure host to act as an IP router, e.g.\& to forward packets
2893 .It Va ipv6_gateway_enable
2895 The IPv6 equivalent of
2896 .Va gateway_enable .
2897 .It Va routed_enable
2901 run a routing daemon of some sort, based on the
2906 .It Va route6d_enable
2908 The IPv6 equivalent of
2912 run a routing daemon of some sort, based on the
2917 .It Va routed_program
2923 this is the name of the routing daemon to use.
2924 .It Va route6d_program
2926 The IPv6 equivalent of
2927 .Va routed_program .
2934 these are the flags to pass to the routing daemon.
2935 .It Va route6d_flags
2937 The IPv6 equivalent of
2939 .It Va rtadvd_enable
2945 daemon at boot time.
2948 utility sends ICMPv6 Router Advertisement messages to
2949 the interfaces specified in
2950 .Va rtadvd_interfaces .
2951 This should only be enabled with great care.
2952 You may want to fine-tune
2954 .It Va rtadvd_interfaces
2960 this is the list of interfaces to use.
2965 enable global proxy ARP.
2966 .It Va forward_sourceroute
2974 source-routed packets are forwarded.
2975 .It Va accept_sourceroute
2979 the system will accept source-routed packets directed at it.
2986 daemon at system boot time.
2993 these are the flags to pass to the
2996 .It Va bootparamd_enable
3002 daemon at system boot time.
3003 .It Va bootparamd_flags
3006 .Va bootparamd_enable
3009 these are the flags to pass to the
3012 .It Va stf_interface_ipv4addr
3016 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
3018 Specify this entry to enable the 6to4 interface.
3019 .It Va stf_interface_ipv4plen
3021 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
3022 An effective value is 0-31.
3023 .It Va stf_interface_ipv6_ifid
3025 IPv6 interface ID for
3029 .It Va stf_interface_ipv6_slaid
3031 IPv6 Site Level Aggregator for
3033 .It Va ipv6_ipv4mapping
3037 this enables IPv4 mapped IPv6 address communication (like
3038 .Li ::ffff:a.b.c.d ) .
3039 .It Va rtsold_enable
3045 daemon to send ICMPv6 Router Solicitation messages.
3052 these are the flags to pass to
3056 For interfaces configured with the
3057 .Dq Li inet6 accept_rtadv
3058 keyword, these are the flags to pass to
3063 is mutually exclusive to
3069 The keyboard bell sound.
3076 if the default behavior is desired.
3077 For details, refer to the
3082 If set to a non-null string, the virtual console's keyboard input is
3088 no keymap is installed, otherwise the value is used to install
3089 the keymap file found in
3090 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3093 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3098 The keyboard repeat speed.
3105 if the default behavior is desired.
3110 attempt to program the function keys with the value.
3112 be a single string of the form:
3113 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3116 Can be set to the value of
3119 .Dq Li destructive ,
3122 to set the cursor behavior explicitly or choose the default behavior.
3127 no screen map is installed, otherwise the value is used to install
3128 the screen map file in
3129 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3130 This parameter is ignored when using
3132 as the console driver.
3137 the default 8x16 font value is used for screen size requests, otherwise
3139 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3141 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3142 is used (depending on the console driver being used).
3147 the default 8x14 font value is used for screen size requests, otherwise
3149 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3151 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3152 is used (depending on the console driver being used).
3157 the default 8x8 font value is used for screen size requests, otherwise
3159 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3161 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3162 is used (depending on the console driver being used).
3167 the default screen blanking interval is used, otherwise it is set
3175 this is the actual screen saver to use
3176 .Li ( blank , snake , daemon ,
3178 .It Va moused_nondefault_enable
3182 the mouse device specified on
3183 the command line is not automatically treated as enabled by the
3184 .Pa /etc/rc.d/moused
3186 Having this variable set to
3192 to be enabled as soon as it is plugged in.
3193 .It Va moused_enable
3199 daemon is started for doing cut/paste selection on the console.
3202 This is the protocol type of the mouse connected to this host.
3203 This variable must be set if
3210 is able to detect the appropriate mouse type automatically in many cases.
3211 Set this variable to
3213 to let the daemon detect it, or
3214 select one from the following list if the automatic detection fails.
3216 If the mouse is attached to the PS/2 mouse port, choose
3220 regardless of the brand and model of the mouse.
3222 mouse is attached to the bus mouse port, choose
3226 All other protocols are for serial mice and will not work with
3227 the PS/2 and bus mice.
3228 If this is a USB mouse,
3230 is the only protocol type which will work.
3232 .Bl -tag -width ".Li x10mouseremote" -compact
3234 Microsoft mouse (serial)
3236 Microsoft IntelliMouse (serial)
3238 Mouse systems Corp.\& mouse (serial)
3240 MM Series mouse (serial)
3242 Logitech mouse (serial)
3246 Logitech MouseMan and TrackMan (serial)
3248 ALPS GlidePoint (serial)
3249 .It Li thinkingmouse
3250 Kensington ThinkingMouse (serial)
3254 MM HitTablet (serial)
3255 .It Li x10mouseremote
3256 X10 MouseRemote (serial)
3258 Interlink VersaPad (serial)
3261 Even if the mouse is not in the above list, it may be compatible
3262 with one in the list.
3263 Refer to the manual page for
3265 for compatibility information.
3267 It should also be noted that while this is enabled, any
3268 other client of the mouse (such as an X server) should access
3269 the mouse through the virtual mouse device,
3271 and configure it as a
3273 type mouse, since all
3274 mouse data is converted to this single canonical format when
3277 If the client program does not support the
3283 It is the second preferred type.
3290 this is the actual port the mouse is on.
3293 for a COM1 serial mouse, or
3295 for a PS/2 mouse, for example.
3300 is set, its value is used as an additional set of flags to pass to the
3303 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3305 .Va moused_nondefault_enable
3308 daemon is started for a non-default port, the
3309 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3310 set of options has precedence over and replaces the default
3314 is the name of the non-default port, i.e.,\&
3317 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3318 it is possible to set up a different set of default flags for each
3321 For example, you can use
3325 to make your laptop's touchpad more comfortable to use,
3326 but an empty set of options for
3327 .Va moused_ums0_flags
3330 mouse has three or more buttons.
3331 .It Va mousechar_start
3335 the default mouse cursor character range
3336 .Li 0xd0 Ns - Ns Li 0xd3
3338 otherwise the range start is set
3343 Use if the default range is occupied in the language code table.
3344 .It Va allscreens_flags
3348 is run with these options for each of the virtual terminals
3352 will enable the mouse pointer on all virtual terminals
3357 .It Va allscreens_kbdflags
3361 is run with these options for each of the virtual terminals
3369 scrollback (history) buffer to 200 lines.
3376 daemon at system boot time.
3382 .Pa /usr/sbin/cron ) .
3389 these are the flags to pass to
3395 enable the special handling of transitions to and from the
3396 Daylight Saving Time in
3398 (equivalent to using the flag
3405 .Pa /usr/sbin/lpd ) .
3412 daemon at system boot time.
3419 these are the flags to pass to the
3422 .It Va chkprintcap_enable
3428 command before starting the
3431 .It Va chkprintcap_flags
3436 .Va chkprintcap_enable
3439 these are the flags to pass to the
3444 which causes missing directories to be created.
3445 .It Va mta_start_script
3447 This variable specifies the full path to the script to run to start
3448 a mail transfer agent.
3450 .Pa /etc/rc.sendmail .
3454 .Pa /etc/rc.sendmail
3455 uses are documented in the
3460 Indicates the device (usually a swap partition) to which a crash dump
3461 should be written in the event of a system crash.
3462 If the value of this variable is
3464 the first suitable swap device listed in
3466 will be used as dump device.
3467 Otherwise, the value of this variable is passed as the argument to
3469 To disable crash dumps, set this variable to
3477 as the system dump device.
3480 When the system reboots after a crash and a crash dump is found on the
3481 device specified by the
3485 will save that crash dump and a copy of the kernel to the directory
3489 The default value is
3498 .It Va savecore_enable
3502 disable automatic extraction of the crash dump from the
3504 .It Va savecore_flags
3506 If crash dumps are enabled, these are the flags to pass to the
3513 to turn on user and group disk quotas on system startup via the
3515 command for all file systems marked as having quotas enabled in
3517 The kernel must be built with
3519 for disk quotas to function.
3524 to enable user and group disk quota checking via the
3527 .It Va quotacheck_flags
3537 these are the flags to pass to the
3542 which checks quotas for all file systems with quotas enabled in
3544 .It Va quotaon_flags
3550 these are the flags to pass to the
3555 which enables quotas for all file systems with quotas enabled in
3557 .It Va quotaoff_flags
3563 these are the flags to pass to the
3565 utility when shutting down the quota system.
3568 which disables quotas for all file systems with quotas enabled in
3570 .It Va accounting_enable
3574 to enable system accounting through the
3577 .It Va firstboot_sentinel
3579 This variable specifies the full path to a
3582 If a file exists with this path,
3586 keyword will be run on startup and the sentinel file will be deleted
3587 after the boot process completes.
3588 The sentinel file must be located on a writable file system which is
3589 mounted no later than
3590 .Va early_late_divider
3591 to function properly.
3598 to enable Linux/ELF binary emulation at system initial
3600 .It Va sysvipc_enable
3604 load System V IPC primitives at boot time.
3605 .It Va clear_tmp_enable
3616 to disable removing of X11 lock files,
3617 and the removal and (secure) recreation
3618 of the various socket directories for X11
3620 .It Va ldconfig_paths
3622 Set to the list of shared library paths to use with
3626 will always be added first, so it need not appear in this list.
3627 .It Va ldconfig32_paths
3629 Set to the list of 32-bit compatibility shared library paths to
3632 .It Va ldconfig_paths_aout
3634 Set to the list of shared library paths to use with
3639 .It Va ldconfig_insecure
3643 utility normally refuses to use directories
3644 which are writable by anyone except root.
3645 Set this variable to
3647 to disable that security check during system startup.
3648 .It Va ldconfig_local_dirs
3650 Set to the list of local
3653 The names of all files in the directories listed will be
3654 passed as arguments to
3656 .It Va ldconfig_local32_dirs
3658 Set to the list of local 32-bit compatibility
3661 The names of all files in the directories listed will be
3662 passed as arguments to
3663 .Dq Nm ldconfig Fl 32 .
3664 .It Va kern_securelevel_enable
3668 to set the kernel security level at system startup.
3669 .It Va kern_securelevel
3671 The kernel security level to set at startup.
3672 The allowed range of
3674 ranges from \-1 (the compile time default) to 3 (the
3678 for the list of possible security levels and their effect
3679 on system operation.
3682 Path to the SSH server program
3683 .Pa ( /usr/sbin/sshd
3691 at system boot time.
3698 these are the flags to pass to the
3703 Path to the FTP server program
3704 .Pa ( /usr/libexec/ftpd
3712 as a stand-alone daemon at system boot time.
3719 these are the additional flags to pass to the
3722 .It Va watchdogd_enable
3728 daemon at boot time.
3729 This requires that the kernel have been compiled with a
3732 .It Va watchdogd_flags
3735 .Va watchdogd_enable
3738 these are the flags passed to the
3741 .It Va devfs_rulesets
3743 List of files containing sets of rules for
3745 .It Va devfs_system_ruleset
3747 Rule name(s) to apply to the system
3750 .It Va devfs_set_rulesets
3752 Pairs of already-mounted
3754 directories and rulesets that should be applied to them.
3755 For example: /mount/dev=ruleset_name
3756 .It Va devfs_load_rulesets
3758 If set, always load the default rulesets listed in
3759 .Va devfs_rulesets .
3760 .It Va performance_cx_lowest
3762 CPU idle state to use while on AC power.
3767 should use the lowest power state available while
3769 indicates that the lowest latency state (less power savings) should be used.
3770 .It Va performance_cpu_freq
3772 CPU clock frequency to use while on AC power.
3777 should use the lowest frequency available while
3779 indicates that the highest frequency (less power savings) should be used.
3780 .It Va economy_cx_lowest
3782 CPU idle state to use when off AC power.
3787 should use the lowest power state available while
3789 indicates that the lowest latency state (less power savings) should be used.
3790 .It Va economy_cpu_freq
3792 CPU clock frequency to use when off AC power.
3797 should use the lowest frequency available while
3799 indicates that the highest frequency (less power savings) should be used.
3804 any configured jails will not be started.
3807 The configuration filename used by
3810 The default value is
3811 .Pa /etc/jail.conf .
3812 .It Va jail_parallel_start
3816 all configured jails will be started in the background (in parallel).
3820 When set, use as default value for
3821 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3826 A space-delimited list of jail names.
3827 When left empty, all of the
3829 instances defined in the configuration file are started.
3830 The names specified in this list control the jail startup order.
3832 instances missing from
3834 must be started manually.
3837 parameter in the configuration file may override this list.
3838 .It Va jail_reverse_stop
3842 all configured jails in
3844 are stopped in reverse order.
3845 .It Va jail_* variables
3846 Note that older releases supported per-jail configuration via
3850 hostname of a jail named
3852 was able to be set by
3853 .Li jail_vjail_hostname .
3854 These per-jail configuration variables are now obsolete in favor of
3857 For backward compatibility,
3858 when per-jail configuration variables are defined,
3860 configuration files are created as
3861 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3864 The following per-jail parameters are handled by
3866 script out of their corresponding
3869 In addition to them, parameters in
3870 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3871 will be added to the configuration file.
3872 They must be a semi-colon
3880 .Bl -tag -width "host.hostname" -offset indent
3883 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3884 .It Li host.hostname
3886 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3887 .It Li exec.consolelog
3889 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3890 The default value is
3891 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3894 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3895 .It Li vnet.interface
3897 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3900 parameter will be enabled and cannot be specified with
3901 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3902 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3904 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3908 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3911 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3914 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3917 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3918 The parameter name was
3920 in some older releases.
3921 .It Li exec.prestart
3923 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3924 .It Li exec.poststart
3926 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3929 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3932 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3933 .It Li exec.poststop
3935 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3938 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3940 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3941 contain IPv4 addresses
3944 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3946 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3947 contain IPv6 addresses
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3953 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3954 .It Li devfs_ruleset
3956 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3957 This must be an integer,
3959 .It Li mount.fdescfs
3961 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3962 .It Li allow.set_hostname
3964 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3965 .It Li allow.rawsocket
3967 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3968 .It Li allow.sysvipc
3970 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3972 .\" -----------------------------------------------------
3976 representing the entropy sources
3977 you wish to harvest.
3980 for more information.
3985 to disable caching entropy via
3987 Otherwise set to the directory
3988 in which the entropy files are stored.
3992 that regularly writes and rotates
3995 will be used at boot time.
3997 .Pa /var/db/entropy .
4002 to disable caching entropy through reboots.
4003 Otherwise set to the name
4004 of a file used to store cached entropy.
4005 This file should be located
4006 on a file system that is readable
4007 before all the volumes specified in
4014 .Pa /var/db/entropy-file
4015 is found it will also be used.
4016 This will be of some use to
4018 .It Va entropy_boot_file
4023 very early caching entropy
4025 Otherwise set to the filename
4027 very early reboot cached entropy.
4028 This file should be located where
4033 The default location is
4035 .It Va entropy_save_sz
4037 Size of the entropy cache files saved by
4040 .It Va entropy_save_num
4042 Number of entropy cache files to save by
4056 Configuration file for
4065 .Pa /var/run/dmesg.boot
4067 .It Va rcshutdown_timeout
4069 If set, start a watchdog timer in the background which will terminate
4073 has not completed within the specified time (in seconds).
4074 Notice that in addition to this soft timeout,
4076 also applies a hard timeout for the execution of
4078 This is configured via
4081 .Va kern.init_shutdown_timeout
4082 and defaults to 120 seconds.
4083 Setting the value of
4084 .Va rcshutdown_timeout
4085 to more than 120 seconds will have no effect until the
4088 .Va kern.init_shutdown_timeout
4090 .It Va virecover_enable
4094 to prevent the system from trying to
4095 recover pre-maturely terminated
4098 .It Va ugidfw_enable
4103 .Xr mac_bsdextended 4
4104 module upon system initialization and load a default
4106 .It Va bsdextended_script
4109 .Xr mac_bsdextended 4
4110 ruleset file to load.
4111 The default value of this variable is
4112 .Pa /etc/rc.bsdextended .
4113 .It Va newsyslog_enable
4120 .It Va newsyslog_flags
4123 .Va newsyslog_enable
4126 these are the flags to pass to the
4131 which causes log files flagged with a
4134 .It Va mdconfig_md Ns Aq Ar X
4144 must be specified and either a
4146 for malloc or swap backed
4154 .Va mdconfig_md Ns Aq Ar X
4155 variables are evaluated until one variable is unset or null.
4156 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4158 Optional arguments passed to
4164 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4166 An ownership specification passed to
4175 device and the mount point will be changed.
4176 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4178 A mode string passed to
4187 device and the mount point will be changed.
4188 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4190 Files to be copied to the mount point of the
4194 after it has been mounted.
4195 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4197 Command to execute after the specified
4202 Note that the command is passed to
4208 variables can be used to reference respectively the
4210 device and the mount point.
4215 one could set the following:
4217 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4219 .It Va autobridge_interfaces
4221 Set to the list of bridge interfaces that will have newly arriving interfaces
4222 checked against to be automatically added.
4225 then for each whitespace separated
4228 .Va autobridge_ Ns Aq Ar element
4229 variable is assumed to exist which has a whitespace separated list of interface
4230 names to match, these names can use wildcards.
4233 autobridge_interfaces="bridge0"
4234 autobridge_bridge0="tap* dc0 vlan[345]"
4240 enable support for sound mixer.
4241 .It Va hcsecd_enable
4245 enable Bluetooth security daemon.
4246 .It Va hcsecd_config
4248 Configuration file for
4251 .Pa /etc/bluetooth/hcsecd.conf .
4256 enable Bluetooth Service Discovery Protocol daemon.
4264 .It Va sdpd_groupname
4268 group to run as after it initializes.
4271 .It Va sdpd_username
4275 user to run as after it initializes.
4278 .It Va bthidd_enable
4282 enable Bluetooth Human Interface Device daemon.
4283 .It Va bthidd_config
4285 Configuration file for
4288 .Pa /etc/bluetooth/bthidd.conf .
4291 Path to a file, where
4293 will store information about known HID devices.
4295 .Pa /var/db/bthidd.hids .
4296 .It Va rfcomm_pppd_server_enable
4300 enable Bluetooth RFCOMM PPP wrapper daemon.
4301 .It Va rfcomm_pppd_server_profile
4303 The name of the profile to use from
4304 .Pa /etc/ppp/ppp.conf .
4305 Multiple profiles can be specified here.
4306 Also used to specify per-profile overrides.
4307 When the profile name contains any of the characters
4309 they are translated to
4311 for the proposes of the override variable names.
4312 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4314 Overrides local address to listen on.
4320 The address can be specified as BD_ADDR or name.
4321 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4323 Overrides local RFCOMM channel to listen on.
4326 will listen on RFCOMM channel 1.
4327 Must set properly if multiple profiles used in the same time.
4328 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4332 if it should register Serial Port service on the specified RFCOMM channel.
4335 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4339 if it should register Dial-Up Networking service on the specified
4343 .It Va ubthidhci_enable
4347 change the USB Bluetooth controller from HID mode to HCI mode.
4348 You also need to specify the location of USB Bluetooth controller with the
4349 .Va ubthidhci_busnum
4353 .It Va ubthidhci_busnum
4354 Bus number where the USB Bluetooth controller is located.
4357 on your system to find this information.
4358 .It Va ubthidhci_addr
4359 Bus address of the USB Bluetooth controller.
4362 on your system to find this information.
4363 .It Va netwait_enable
4367 delays the start of network-reliant services until
4369 is up and ICMP packets to a destination defined in
4372 Link state is examined first, followed by
4374 an IP address to verify network usability.
4375 If no destination can be reached or timeouts are exceeded,
4376 network services are started anyway with no guarantee that
4377 the network is usable.
4378 Use of this variable requires both
4386 This variable contains a space-delimited list of IP addresses to
4388 DNS hostnames should not be used as resolution is not guaranteed
4389 to be functional at this point.
4390 If multiple IP addresses are specified,
4391 each will be tried until one is successful or the list is exhausted.
4392 .It Va netwait_timeout
4394 Indicates the total number of seconds to perform a
4396 against each IP address in
4398 at a rate of one ping per second.
4399 If any of the pings are successful,
4400 full network connectivity is considered reliable.
4405 Defines the name of the network interface on which watch for link.
4407 is used to monitor the interface, looking for
4408 .Dq Li status: no carrier .
4409 Once gone, the link is considered up.
4412 interface if desired.
4413 .It Va netwait_if_timeout
4415 Defines the total number of seconds to wait for link to become usable,
4416 polled at a 1-second interval.
4424 rules from the defined ruleset.
4425 The kernel must be built with
4428 .Cd "options RCTL" .
4434 This variables contains the
4440 A space-separated list of configuration files used by
4442 The default value is an empty string.
4443 .It Va autofs_enable
4453 daemons at boot time.
4454 .It Va automount_flags
4460 these are the flags to pass to the
4463 By default no flags are passed.
4464 .It Va automountd_flags
4470 these are the flags to pass to the
4473 By default no flags are passed.
4474 .It Va autounmountd_flags
4480 these are the flags to pass to the
4483 By default no flags are passed.
4490 daemon at boot time.
4491 .It Va iscsid_enable
4497 daemon at boot time.
4498 .It Va iscsictl_enable
4504 utility at boot time.
4505 .It Va iscsictl_flags
4511 these are the flags to pass to the
4516 which configures sessions based on the
4519 .It Va cfumass_enable
4523 create and export an USB LUN using
4528 The directory where the files exported by USB LUN are located.
4529 The default directory is
4531 .It Va service_delete_empty
4535 .Ql Li service delete
4541 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4542 .It Pa /etc/defaults/rc.conf
4544 .It Pa /etc/rc.conf.local
4574 .Xr newsyslog.conf 5 ,
4647 .An Jordan K. Hubbard .