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 list of kernel modules to load right after the local
253 Loading modules at this point in the boot process is
254 much faster than doing it via
255 .Pa /boot/loader.conf
256 for those modules not necessary for mounting local disk.
257 .It Va kldxref_enable
264 to automatically rebuild
269 .It Va kldxref_clobber
279 will overwrite existing
286 .It Va kldxref_module_path
291 delimited list of paths containing
303 enable the system power control facility with the
312 these are the flags to pass to the
316 Controls the creation of a
319 Always happens if set to
321 and never happens if set to
323 If set to anything else, a memory file system is created if
327 Controls the size of a created
331 Extra options passed to the
333 utility when the memory file system for
338 which inhibits the use of softupdates on
340 so that file system space is freed without delay
341 after file truncation or deletion.
344 for other options you can use in
347 Controls the creation of a
350 Always happens if set to
352 and never happens if set to
354 If set to anything else, a memory file system is created if
358 Controls the size of a created
362 Extra options passed to the
364 utility when the memory file system for
369 which inhibits the use of softupdates on
371 so that file system space is freed without delay
372 after file truncation or deletion.
375 for other options you can use in
378 Controls the automatic population of the
381 Always happens if set to
383 and never happens if set to
385 If set to anything else, a memory file system is created if
388 Note that this process requires access to certain commands in
392 is mounted on normal systems.
393 .It Va cleanvar_enable
400 List of directories to search for startup script files.
401 .It Va script_name_sep
403 The field separator to use for breaking down the list of startup script files
404 into individual filenames.
405 The default is a space.
406 It is not necessary to change this unless there are startup scripts with names
408 .It Va hostapd_enable
417 The fully qualified domain name (FQDN) of this host on the network.
418 This should almost certainly be set to something meaningful, even if
419 there is no network connection.
422 is used to set the hostname via DHCP,
423 this variable should be set to an empty string.
424 If this value remains unset when the system is done booting
425 your console login will display the default hostname of
429 The NIS domain name of this host, or
432 .It Va dhclient_program
434 Path to the DHCP client program
435 .Pa ( /sbin/dhclient ,
440 .It Va dhclient_flags
442 Additional flags to pass to the DHCP client program.
447 manpage for a description of the command line options available.
448 .It Va dhclient_flags_ Ns Aq Ar iface
449 Additional flags to pass to the DHCP client program running on
452 When specified, this variable overrides
454 .It Va background_dhclient
458 to start the DHCP client in background.
459 This can cause trouble with applications depending on
460 a working network, but it will provide a faster startup
462 .It Va background_dhclient_ Ns Aq Ar iface
463 When specified, this variable overrides the
464 .Va background_dhclient
465 variable for interface
468 .It Va synchronous_dhclient
474 synchronously at startup.
475 This behavior can be overridden on a per-interface basis by replacing
479 .Va ifconfig_ Ns Aq Ar interface
484 .It Va defaultroute_delay
486 When set to a positive value, wait up to this long after configuring
487 DHCP interfaces at startup to give the interfaces time to receive a lease.
488 .It Va firewall_enable
492 to load firewall rules at startup.
493 If the kernel was not built with
494 .Cd "options IPFIREWALL" ,
497 kernel module will be loaded.
499 .Va ipfilter_enable .
500 .It Va firewall_script
502 This variable specifies the full path to the firewall script to run.
504 .Pa /etc/rc.firewall .
507 Names the firewall type from the selection in
508 .Pa /etc/rc.firewall ,
509 or the file which contains the local firewall ruleset.
510 Valid selections from
514 .Bl -tag -width ".Li simple" -compact
516 unrestricted IP access
518 all IP services disabled, except via
521 basic protection for a workstation
523 basic protection for a LAN.
526 If a filename is specified, the full path
528 .It Va firewall_quiet
532 to disable the display of firewall rules on the console during boot.
533 .It Va firewall_logging
537 to enable firewall event logging.
538 This is equivalent to the
539 .Dv IPFIREWALL_VERBOSE
541 .It Va firewall_logif
545 to create pseudo interface
548 For more details, see
551 .It Va firewall_flags
557 specifies a filename.
558 .It Va firewall_coscripts
560 List of executables and/or rc scripts to run after firewall starts/stops.
562 .\" ----- firewall_nat_enable setting --------------------------------
563 .It Va firewall_nat_enable
575 .It Va firewall_nat_interface
581 This is the name of the public interface or IP address on which
582 kernel NAT should run.
583 .It Va firewall_nat_flags
585 Additional configuration parameters for kernel NAT should be placed here.
586 .It Va dummynet_enable
590 will automatically load the
596 .\" -------------------------------------------------------------------
597 .It Va ipfw_netflow_enable
601 will enable netflow logging via
604 By default a ipfw rule is inserted and all packets are duplicated with
605 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
606 port using protocol version 5.
607 .It Va ipfw_netflow_hook
609 netflow hook name, must be numerical
612 .It Va ipfw_netflow_rule
617 .It Va ipfw_netflow_ip
619 Destination server ip for receiving netflow data
622 .It Va ipfw_netflow_port
624 Destination server port for receiving netflow data
627 .It Va ipfw_netflow_version
629 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
630 .It Va ipfw_netflow_fib
632 Only match packet in FIB
634 (default is undefined meaning all FIBs).
650 sockets must be enabled in the kernel.
651 If the kernel was not built with
652 .Cd "options IPDIVERT" ,
655 kernel module will be loaded.
656 .It Va natd_interface
658 This is the name of the public interface on which
661 The interface may be given as an interface name or as an IP address.
666 flags should be placed here.
671 flag is automatically added with the above
674 .\" ----- ipfilter_enable setting --------------------------------
675 .It Va ipfilter_enable
686 Typical usage will require putting
688 ipfilter_enable="YES"
706 can be enabled independently.
710 both require at least one of
720 options IPFILTER_DEFAULT_BLOCK
723 in the kernel configuration file is a good idea, too.
724 .\" ----- ipfilter_program setting ------------------------------
725 .It Va ipfilter_program
731 .\" ----- ipfilter_rules setting --------------------------------
732 .It Va ipfilter_rules
737 This variable contains the name of the filter rule definition file.
738 The file is expected to be readable for the
741 .\" ----- ipv6_ipfilter_rules setting ---------------------------
742 .It Va ipv6_ipfilter_rules
747 This variable contains the IPv6 filter rule definition file.
748 The file is expected to be readable for the
751 .\" ----- ipfilter_flags setting --------------------------------
752 .It Va ipfilter_flags
755 This variable contains flags passed to the
758 .\" ----- ipnat_enable setting ----------------------------------
768 network address translation.
771 for a detailed discussion.
772 .\" ----- ipnat_program setting ---------------------------------
779 .\" ----- ipnat_rules setting -----------------------------------
785 This variable contains the name of the file
786 holding the network address translation definition.
787 This file is expected to be readable for the
790 .\" ----- ipnat_flags setting -----------------------------------
794 This variable contains flags passed to the
797 .\" ----- ipmon_enable setting ----------------------------------
812 Setting this variable needs setting
819 for a detailed discussion.
820 .\" ----- ipmon_program setting ---------------------------------
827 .\" ----- ipmon_flags setting -----------------------------------
833 This variable contains flags passed to the
836 Another typical example would be
837 .Dq Fl D Pa /var/log/ipflog
840 log directly to a file bypassing
843 .Pa /etc/newsyslog.conf
844 in such case like this:
846 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
848 .\" ----- ipfs_enable setting -----------------------------------
858 saving the filter and NAT state tables during shutdown
859 and reloading them during startup again.
860 Setting this variable needs setting
869 for a detailed discussion.
875 because the raised securelevel will prevent
877 from saving the state tables at shutdown time.
878 .\" ----- ipfs_program setting ----------------------------------
885 .\" ----- ipfs_flags setting ------------------------------------
889 This variable contains flags passed to the
892 .\" ----- end of added ipf hook ---------------------------------
904 Typical usage will require putting
919 into the kernel, otherwise the
920 kernel module will be loaded.
925 ruleset configuration file
940 these flags are passed to the
942 program when loading the ruleset.
952 which logs packets from the
965 .Pa /var/log/pflog ) .
967 .Pa /etc/newsyslog.conf
968 to adjust logfile rotation for this.
978 This variable contains additional flags passed to the
981 .It Va pflog_instances
983 If logging to more than one
985 interface is desired,
987 is set to the list of
989 instances that should be started at system boot time.
992 is set, for each whitespace-seperated
995 .Ao Ar element Ac Ns Va _dev
997 .Ao Ar element Ac Ns Va _logfile
998 elements are assumed to exist.
999 .Ao Ar element Ac Ns Va _dev
1002 interface to be watched by the named
1005 .Ao Ar element Ac Ns Va _logfile
1006 must contain the name of the logfile that will be used by the
1009 .It Va ftpproxy_enable
1020 packet filter in translating ftp connections.
1021 .It Va ftpproxy_flags
1024 This variable contains additional flags passed to the
1027 .It Va ftpproxy_instances
1030 If multiple instances of
1032 are desired at boot time,
1033 .Va ftpproxy_instances
1034 should contain a whitespace-seperated list of instance names.
1037 in the list, a variable named
1038 .Ao Ar element Ac Ns Va _flags
1039 should be defined, containing the command-line flags to be passed to the
1042 .It Va pfsync_enable
1051 state changes to other hosts over the network by means of
1056 must also be set then.
1057 .It Va pfsync_syncdev
1060 This variable specifies the name of the network interface
1062 should operate through.
1063 It must be set accordingly if
1067 .It Va pfsync_syncpeer
1070 This variable is optional.
1071 By default, state change messages are sent out on the synchronisation
1072 interface using IP multicast packets.
1073 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1075 When a peer address is specified using the
1077 option, the peer address is used as a destination for the pfsync
1078 traffic, and the traffic can then be protected using
1082 manpage for more details about using
1087 .It Va pfsync_ifconfig
1090 This variable can contain additional options to be passed to the
1092 command used to set up
1094 .It Va tcp_extensions
1101 disables certain TCP options as described by
1107 might help remedy such problems with connections as randomly hanging
1108 or other weird behavior.
1109 Some network devices are known
1110 to be broken with respect to these options.
1113 Set to 0 by default.
1117 .Va net.inet.tcp.log_in_vain
1119 .Va net.inet.udp.log_in_vain ,
1124 are set to the given value.
1125 .It Va tcp_keepalive
1132 will disable probing idle TCP connections to verify that the
1133 peer is still up and reachable.
1134 .It Va tcp_drop_synfin
1141 will cause the kernel to ignore TCP frames that have both
1142 the SYN and FIN flags set.
1143 This prevents OS fingerprinting, but may
1144 break some legitimate applications.
1145 .It Va icmp_drop_redirect
1152 will cause the kernel to ignore ICMP REDIRECT packets.
1155 for more information.
1156 .It Va icmp_log_redirect
1163 will cause the kernel to log ICMP REDIRECT packets.
1165 the log messages are not rate-limited, so this option should only be used
1166 for troubleshooting networks.
1169 for more information.
1170 .It Va icmp_bmcastecho
1174 to respond to broadcast or multicast ICMP ping packets.
1177 for more information.
1178 .It Va ip_portrange_first
1182 this is the first port in the default portrange.
1185 for more information.
1186 .It Va ip_portrange_last
1190 this is the last port in the default portrange.
1193 for more information.
1194 .It Va network_interfaces
1196 Set to the list of network interfaces to configure on this host or
1198 (the default) for all current interfaces.
1200 .Va network_interfaces
1201 variable to anything other than the default is deprecated.
1202 Interfaces that the administrator wishes to store configuration for,
1203 but not start at boot should be configured with the
1206 .Va ifconfig_ Ns Aq Ar interface
1207 variables as described below.
1210 .Va ifconfig_ Ns Aq Ar interface
1211 variable is also assumed to exist for each value of
1213 When an interface name contains any of the characters
1215 they are translated to
1218 The variable can contain arguments to
1220 as well as special case-insensitive keywords described below.
1221 Such keywords are removed before passing the value to
1223 while the order of the other arguments is preserved.
1225 It is possible to add IP alias entries using
1227 syntax with the address family keyword such as
1229 Assuming that the interface in question was
1231 it might look something like this:
1233 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1234 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1237 It also possible to configure multiple IP addresses in Classless
1238 Inter-Domain Routing
1241 whose each address component can be a range like
1242 .Li inet 192.0.2.5-23/24
1244 .Li inet6 2001:db8:1-f::1/64 .
1245 This notation allows address and prefix length part only,
1246 not the other address modifiers.
1247 Note that the maximum number of the generated addresses from a range
1248 specification is limited to an integer value specified in
1249 .Va netif_ipexpand_max
1252 because a small typo can unexpectedly generate a large number of addresses.
1253 The default value is
1255 It can be increased by adding the following line into
1258 netif_ipexpand_max="4096"
1262 .Li 192.0.2.5-23/24 ,
1263 the address 192.0.2.5 will be configured with the
1264 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1265 the non-conflicting netmask /32 as explained in the
1268 Note that this special netmask handling is only for
1270 not for the other address families such as
1273 With the interface in question being
1275 an example could look like:
1277 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1278 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1284 .Va ipv4_addrs_ Ns Aq Ar interface
1285 variable was supported for IPv4 CIDR address notation.
1286 It is now deprecated because the functionality was integrated into
1287 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1289 .Va ipv4_addrs_ Ns Aq Ar interface
1290 is still supported for backward compatibility.
1293 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1294 entry with an address family keyword,
1295 its contents are passed to
1297 Execution stops at the first unsuccessful access, so if
1298 something like this is present:
1300 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1301 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1302 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1303 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1306 Then note that alias4 would
1308 be added since the search would
1309 stop with the missing
1312 Because of this difficult to manage behavior,
1314 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1315 variable, which has the same functionality as
1316 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1317 and can have all of entries in a variable like the following:
1319 ifconfig_ed0_aliases="\\
1320 inet 127.0.0.251 netmask 0xffffffff \\
1321 inet 127.0.0.252 netmask 0xffffffff \\
1322 inet 127.0.0.253 netmask 0xffffffff \\
1323 inet 127.0.0.254 netmask 0xffffffff"
1326 It also supports CIDR notation.
1329 .Pa /etc/start_if. Ns Aq Ar interface
1330 file is present, it is read and executed by the
1333 before configuring the interface as specified in the
1334 .Va ifconfig_ Ns Aq Ar interface
1336 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1340 .Va vlans_ Ns Aq Ar interface
1344 interface will be created for each item in the list with the
1348 If a vlan interface's name is a number,
1349 then that number is used as the vlan tag and the new vlan interface is
1351 .Ar interface . Ns Ar tag .
1353 the vlan tag must be specified via a
1356 .Va create_args_ Ns Aq Ar interface
1359 To create a vlan device named
1363 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1366 ifconfig_em0_101="inet 192.0.2.1/24"
1369 To create a vlan device named
1373 with the vlan tag 102:
1376 create_args_myvlan="vlan 102"
1380 .Va wlans_ Ns Aq Ar interface
1384 interface will be created for each item in the list with the
1388 Further wlan cloning arguments may be passed to the
1391 command by setting the
1392 .Va create_args_ Ns Aq Ar interface
1396 devices must be created for each wireless devices as of
1402 may be specified with an
1403 .Va wlandebug_ Ns Aq Ar interface
1405 The contents of this variable will be passed directly to
1409 .Va ifconfig_ Ns Aq Ar interface
1410 contains the keyword
1412 then the interface will not be configured
1414 .Pa /etc/pccard_ether
1416 .Va network_interfaces
1420 It is possible to bring up an interface with DHCP by adding
1423 .Va ifconfig_ Ns Aq Ar interface
1425 For instance, to initialize the
1428 it is possible to use something like:
1433 If you want to configure your wireless interface with
1434 .Xr wpa_supplicant 8
1435 for use with WPA, EAP/LEAP or WEP, you need to add
1438 .Va ifconfig_ Ns Aq Ar interface
1441 On the other hand, if you want to configure your wireless interface with
1446 .Va ifconfig_ Ns Aq Ar interface
1449 will use the settings from
1450 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1452 Finally, you can add
1454 options in this variable, in addition to the
1455 .Pa /etc/start_if. Ns Aq Ar interface
1457 For instance, to configure an
1459 wireless device in station mode with an address obtained
1460 via DHCP, using WPA authentication and 802.11b mode, it is
1461 possible to use something like:
1464 ifconfig_wlan0="DHCP WPA mode 11b"
1468 .Va ifconfig_ Ns Aq Ar interface
1469 form, a fallback variable
1470 .Va ifconfig_DEFAULT
1472 It will be used for all interfaces with no
1473 .Va ifconfig_ Ns Aq Ar interface
1475 This is intended to replace the no longer supported
1479 It is also possible to rename an interface by doing:
1481 ifconfig_ed0_name="net0"
1482 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1486 This variable is deprecated.
1488 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1490 .Va ipv6_activate_all_interfaces
1495 .Dq Li inet6 accept_rtadv
1497 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1499 .Va ipv6_activate_all_interfaces
1504 This variable is deprecated.
1506 .Va ip6addrctl_policy
1511 the default address selection policy table set by
1513 will be IPv6-preferred.
1517 the default address selection policy table set by
1519 will be IPv4-preferred.
1520 .It Va ipv6_activate_all_interfaces
1522 This controls initial configuration on IPv6-capable
1523 interfaces with no corresponding
1524 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1526 Note that it is not always necessary to set this variable to
1528 to use IPv6 functionality on
1530 In most cases, just configuring
1531 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1536 all interfaces which do not have a corresponding
1537 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1538 variable will be marked as
1541 This means that all of IPv6 functionality on that interface
1542 is completely disabled to enforce a security policy.
1543 If the variable is set to
1545 the flag will be cleared on all of the interfaces.
1547 In most cases, just defining an
1548 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1549 for an IPv6-capable interface should be sufficient.
1550 However, if an interface is added dynamically
1551 .Pq by some tunneling protocols such as PPP, for example ,
1552 it is often difficult to define the variable in advance.
1553 In such a case, configuring the
1555 flag can be disabled by setting this variable to
1558 For more details of the
1561 .Dq Li inet6 ifdisabled ,
1571 privacy addresses will be generated for each IPv6
1572 interface as described in RFC 4941.
1573 .It Va ipv6_network_interfaces
1575 This is the IPv6 equivalent of
1576 .Va network_interfaces .
1577 Normally manual configuration of this variable is not needed.
1578 .It Va ipv6_cpe_wanif
1580 If the variable is set to an interface name,
1584 .Dq inet6 -no_radr accept_rtadv
1585 will be added to the specified interface automatically before evaluating
1586 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1590 .Va net.inet6.ip6.rfc6204w3
1592 .Va net.inet6.ip6.no_radr
1595 This means the specified interface will accept ICMPv6 Router
1596 Advertisement messages on that link and add the discovered
1597 routers into the Default Router List.
1598 While the other interfaces can still accept RA messages if the
1599 .Dq inet6 accept_rtadv
1600 option is specified, adding
1601 routes into the Default Router List will be disabled by
1608 Note that ICMPv6 Router Advertisement messages will be
1610 .Va net.inet6.ip6.forwarding
1612 .Pq packet forwarding is enabled
1614 .Va net.inet6.ip6.rfc6204w3
1619 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1621 This assigns arbitrary description to an interface.
1625 .Va net.ifdescr_maxlen
1627 This static setting may be overridden by commands
1628 started with dynamic interface configuration utilities
1631 hooks. The description can be seen with
1633 command and it may be exported with
1635 daemon using its MIB-2 module.
1636 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1638 IPv6 functionality on an interface should be configured by
1639 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1640 instead of setting ifconfig parameters in
1641 .Va ifconfig_ Ns Aq Ar interface .
1642 If this variable is empty, all of IPv6 configurations on the
1643 specified interface by other variables such as
1644 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1647 Aliases should be set by
1648 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1654 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1655 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1658 Interfaces that have an
1659 .Dq Li inet6 accept_rtadv
1661 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1662 setting will be automatically configured by SLAAC
1663 .Pq StateLess Address AutoConfiguration
1669 Note that a link-local address will be automatically configured in
1670 addition to the configured global-scope addresses because the IPv6
1671 specifications require it on each link.
1672 The address is calculated from the MAC address by using an algorithm
1679 If only a link-local address is needed on the interface,
1680 the following configuration can be used:
1682 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1685 A link-local address can also be configured manually.
1686 This is useful for the default router address of an IPv6 router
1687 so that it does not change when the network interface
1691 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1693 .It Va ipv6_prefix_ Ns Aq Ar interface
1695 If one or more prefixes are defined in
1696 .Va ipv6_prefix_ Ns Aq Ar interface
1697 addresses based on each prefix and the EUI-64 interface index will be
1698 configured on that interface.
1699 Note that this variable will be ignored when
1700 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1703 For example, the following configuration
1705 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1708 is equivalent to the following:
1710 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1711 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1712 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1713 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1716 These Subnet-Router anycast addresses will be added only when
1717 .Va ipv6_gateway_enable
1719 .It Va ipv6_default_interface
1723 this is the default output interface for scoped addresses.
1724 This works only with ipv6_gateway_enable="NO".
1725 .It Va ip6addrctl_enable
1727 This variable is to enable configuring default address selection policy table
1729 The table can be specified in another variable
1730 .Va ip6addrctl_policy .
1732 .Va ip6addrctl_policy
1733 the following keywords can be specified:
1734 .Dq Li ipv4_prefer ,
1735 .Dq Li ipv6_prefer ,
1745 installs a pre-defined policy table described in Section 2.1
1753 is specified, it attempts to read a file
1754 .Pa /etc/ip6addrctl.conf
1756 If this file is found,
1758 reads and installs it.
1759 If not found, a policy is automatically set
1761 .Va ipv6_activate_all_interfaces
1762 variable; if the variable is set to
1764 the IPv6-preferred one is used.
1765 Otherwise IPv4-preferred.
1767 The default value of
1768 .Va ip6addrctl_enable
1770 .Va ip6addrctl_policy
1776 .It Va cloned_interfaces
1778 Set to the list of clonable network interfaces to create on this host.
1779 Further cloning arguments may be passed to the
1782 command for each interface by setting the
1783 .Va create_args_ Ns Aq Ar interface
1785 If an interface name is specified with
1788 the interface will not be destroyed even when
1790 script is invoked with
1793 This is useful when reconfiguring the interface without destroying it.
1795 .Va cloned_interfaces
1796 are automatically appended to
1797 .Va network_interfaces
1799 .It Va cloned_interfaces_sticky
1801 This variable is to globally enable functionality of
1804 .Va cloned_interfaces
1806 The default value is
1808 Even if this variable is specified to
1811 keyword can be used to override it on per interface basis.
1812 .It Va gif_interfaces
1814 This variable is deprecated in favor of
1815 .Va cloned_interfaces .
1818 tunnel interfaces to configure on this host.
1820 .Va gifconfig_ Ns Aq Ar interface
1821 variable is assumed to exist for each value of
1823 The value of this variable is used to configure the link layer of the
1824 tunnel according to the syntax of the
1828 Additionally, this option ensures that each listed interface is created
1833 before attempting to configure it.
1834 .It Va sppp_interfaces
1838 interfaces to configure on this host.
1840 .Va spppconfig_ Ns Aq Ar interface
1841 variable is assumed to exist for each value of
1843 Each interface should also be configured by a general
1844 .Va ifconfig_ Ns Aq Ar interface
1848 for more information about available options.
1858 The name of the profile to use from
1859 .Pa /etc/ppp/ppp.conf .
1860 Also used for per-profile overrides of
1865 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1866 When the profile name contains any of the characters
1868 they are translated to
1870 for the proposes of the override variable names.
1873 Mode in which to run the
1876 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1878 Overrides the global
1888 See the manual for a full description.
1893 enables network address translation.
1894 Used in conjunction with
1896 allows hosts on private network addresses access to the Internet using
1897 this host as a network address translating router.
1898 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1900 Overrides the global
1904 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1906 Set the unit number to be used for this profile.
1907 See the manual description of
1912 The name of the user under which
1920 .It Va rc_conf_files
1922 This option is used to specify a list of files that will override
1924 .Pa /etc/defaults/rc.conf .
1925 The files will be read in the order in which they are specified and should
1926 include the full path to the file.
1927 By default, the files specified are
1930 .Pa /etc/rc.conf.local
1936 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1938 .It Va gptboot_enable
1942 .Pa /etc/rc.d/gptboot
1943 will log if the system successfully (or not) booted from a GPT partition,
1949 .It Va gbde_autoattach_all
1954 will attempt to automatically initialize your .bde devices in
1958 List the devices that the script should try to attach,
1963 The directory where the
1965 lockfiles are located.
1966 The default lockfile directory is
1969 The lockfile for each individual
1971 device can be overridden by setting the variable
1972 .Va gbde_lock_ Ns Aq Ar device ,
1975 is the encrypted device without the
1980 .It Va gbde_attach_attempts
1982 Number of times to attempt attaching to a
1984 device, i.e., how many times the user is asked for the pass-phrase.
1988 List of devices to automatically attach on boot.
1989 Note that .eli devices from
1991 are automatically appended to this list.
1994 Number of times user is asked for the pass-phrase.
1995 If empty, it will be taken from
1996 .Va kern.geom.eli.tries
1998 .It Va geli_default_flags
2000 Default flags to use by
2002 when configuring disk encryption.
2003 Flags can be configured for every device separately by defining
2004 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2006 .It Va geli_autodetach
2008 Specifies if GELI devices should be marked for detach on last close after
2009 file systems are mounted.
2012 This can be changed for every device separately by defining
2013 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2015 .It Va root_rw_mount
2020 After the file systems are checked at boot time, the root file system
2021 is remounted as read-write if this is set to
2023 Diskless systems that mount their root file system from a read-only remote
2024 NFS share should set this to
2028 .It Va fsck_y_enable
2033 will be run with the
2035 flag if the initial preen
2036 of the file systems fails.
2037 .It Va background_fsck
2041 the system will attempt to run
2043 in the background where possible.
2044 .It Va background_fsck_delay
2046 The amount of time in seconds to sleep before starting a background
2048 It defaults to sixty seconds to allow large applications such as
2049 the X server to start before disk I/O bandwidth is monopolized by
2051 If set to a negative number, the background file system check will be
2052 delayed indefinitely to allow the administrator to run it at a more
2054 For example it may be run from
2056 by adding a line like
2058 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2064 List of file system types that are network-based.
2065 This list should generally not be modified by end users.
2067 .Va extra_netfs_types
2069 .It Va extra_netfs_types
2071 If set to something other than
2074 this variable extends the list of file system types
2075 for which automatic mounting at startup by
2077 should be delayed until the network is initialized.
2079 a whitespace-separated list of network file system descriptor pairs,
2080 each consisting of a file system type as passed to
2082 and a human-readable, one-word description,
2085 Extending the default list in this way is only necessary
2086 when third party file system types are used.
2087 .It Va syslogd_enable
2094 .It Va syslogd_program
2099 .Pa /usr/sbin/syslogd ) .
2100 .It Va syslogd_flags
2106 these are the flags to pass to
2115 .It Va inetd_program
2120 .Pa /usr/sbin/inetd ) .
2127 these are the flags to pass to
2136 .It Va hastd_program
2148 these are the flags to pass to
2150 .It Va local_unbound_enable
2156 daemon as a local caching resolver.
2161 to start a Kerberos 5 authentication server
2169 this is the path to Kerberos 5 Authentication Server.
2173 This variable contains additional flags to be passed to the Kerberos 5
2174 authentication server.
2175 .It Va kadmind_enable
2181 the Kerberos 5 Administration Daemon; set to
2184 .It Va kadmind_program
2190 this is the path to Kerberos 5 Administration Daemon.
2191 .It Va kpasswdd_enable
2197 the Kerberos 5 Password-Changing Daemon; set to
2200 .It Va kpasswdd_program
2206 this is the path to Kerberos 5 Password-Changing Daemon.
2213 the Kerberos 5 ticket forwarding daemon, at the boot time.
2219 .Pa /usr/libexec/kfd ) .
2226 daemon at boot time.
2233 these are the flags to pass to it.
2240 daemon at boot time.
2247 these are the flags to pass to it.
2250 manpage for more information.
2251 .It Va amd_map_program
2254 the specified program is run to get the list of
2259 maps are stored in NIS, one can set this to
2272 will be updated at boot time to reflect the kernel release
2277 will not be updated.
2278 .It Va nfs_client_enable
2282 run the NFS client daemons at boot time.
2283 .It Va nfs_access_cache
2286 .Va nfs_client_enable
2291 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2293 results should be cached.
2294 A value of 2-10 seconds will substantially reduce network
2295 traffic for many NFS operations.
2296 .It Va nfs_server_enable
2300 run the NFS server daemons at boot time.
2301 .It Va nfs_server_flags
2304 .Va nfs_server_enable
2307 these are the flags to pass to the
2310 .It Va nfsv4_server_enable
2313 .Va nfs_server_enable
2317 .Va nfsv4_server_enable
2320 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2321 .It Va nfsuserd_enable
2327 run the nfsuserd daemon, which is needed for NFSv4 in order
2328 to map between user/group names vs uid/gid numbers.
2330 .Va nfsv4_server_enable
2333 this will be forced enabled.
2334 .It Va nfsuserd_flags
2340 these are the flags to pass to the
2343 .It Va nfscbd_enable
2349 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2356 these are the flags to pass to the
2359 .It Va mountd_enable
2364 .Va nfs_server_enable
2370 It is commonly needed to run CFS without real NFS used.
2377 these are the flags to pass to the
2380 .It Va weak_mountd_authentication
2384 allow services like PCNFSD to make non-privileged mount
2386 .It Va nfs_reserved_port_only
2390 provide NFS services only on a secure port.
2391 .It Va nfs_bufpackets
2393 If set to a number, indicates the number of packets worth of
2394 socket buffer space to reserve on an NFS client.
2395 The kernel default is typically 4.
2396 Using a higher number may be
2397 useful on gigabit networks to improve performance.
2398 The minimum value is
2399 2 and the maximum is 64.
2400 .It Va rpc_lockd_enable
2404 and also an NFS server or client, run
2407 .It Va rpc_lockd_flags
2410 .Va rpc_lockd_enable
2413 these are the flags to pass to the
2416 .It Va rpc_statd_enable
2420 and also an NFS server or client, run
2423 .It Va rpc_statd_flags
2426 .Va rpc_statd_enable
2429 these are the flags to pass to the
2432 .It Va rpcbind_program
2437 .Pa /usr/sbin/rpcbind ) .
2438 .It Va rpcbind_enable
2444 service at boot time.
2445 .It Va rpcbind_flags
2451 these are the flags to pass to the
2454 .It Va keyserv_enable
2460 daemon on boot for running Secure RPC.
2461 .It Va keyserv_flags
2467 these are the flags to pass to
2470 .It Va pppoed_enable
2476 daemon at boot time to provide PPP over Ethernet services.
2477 .It Va pppoed_ Ns Aq Ar provider
2480 listens to requests to this
2486 argument of the same name.
2489 Additional flags to pass to
2491 .It Va pppoed_interface
2493 The network interface to run
2496 This is mandatory when
2506 service at boot time.
2507 This command is intended for networks of
2508 machines where a consistent
2510 for all hosts must be established.
2511 This is often useful in large NFS
2512 environments where time stamps on files are expected to be consistent
2520 these are the flags to pass to the
2523 .It Va ntpdate_enable
2530 This command is intended to
2531 synchronize the system clock only
2533 from some standard reference.
2534 .It Va ntpdate_config
2536 Configuration file for
2540 .It Va ntpdate_hosts
2542 A whitespace-separated list of NTP servers to synchronize with at startup.
2543 The default is to use the servers listed in
2544 .Va ntpdate_config ,
2545 if that file exists.
2546 .It Va ntpdate_program
2551 .Pa /usr/sbin/ntpdate ) .
2552 .It Va ntpdate_flags
2558 these are the flags to pass to the
2560 command (typically a hostname).
2567 command at boot time.
2573 .Pa /usr/sbin/ntpd ) .
2587 these are the flags to pass to the
2590 .It Va ntpd_sync_on_start
2597 flag, which syncs the system's clock on startup.
2600 for more information regarding the
2603 This is a preferred alternative to using
2608 .It Va nis_client_enable
2614 service at system boot time.
2615 .It Va nis_client_flags
2618 .Va nis_client_enable
2621 these are the flags to pass to the
2624 .It Va nis_ypldap_enable
2630 daemon at system boot time.
2631 .It Va nis_ypldap_flags
2634 .Va nis.ypldap_enable
2637 these are the flags to pass to the
2640 .It Va nis_ypset_enable
2646 daemon at system boot time.
2647 .It Va nis_ypset_flags
2650 .Va nis_ypset_enable
2653 these are the flags to pass to the
2656 .It Va nis_server_enable
2662 daemon at system boot time.
2663 .It Va nis_server_flags
2666 .Va nis_server_enable
2669 these are the flags to pass to the
2672 .It Va nis_ypxfrd_enable
2678 daemon at system boot time.
2679 .It Va nis_ypxfrd_flags
2682 .Va nis_ypxfrd_enable
2685 these are the flags to pass to the
2688 .It Va nis_yppasswdd_enable
2694 daemon at system boot time.
2695 .It Va nis_yppasswdd_flags
2698 .Va nis_yppasswdd_enable
2701 these are the flags to pass to the
2704 .It Va rpc_ypupdated_enable
2710 daemon at system boot time.
2711 .It Va bsnmpd_enable
2717 daemon at system boot time.
2718 Be sure to understand the security implications of running SNMP daemon
2726 these are the flags to pass to the
2729 .It Va defaultrouter
2733 create a default route to this host name or IP address
2734 (use an IP address if this router is also required to get to the
2736 .It Va ipv6_defaultrouter
2738 The IPv6 equivalent of
2740 .It Va static_arp_pairs
2742 Set to the list of static ARP pairs that are to be added at system
2744 For each whitespace separated
2747 .Va static_arp_ Ns Aq Ar element
2748 variable is assumed to exist whose contents will later be passed to a
2753 static_arp_pairs="gw"
2754 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2756 .It Va static_ndp_pairs
2758 Set to the list of static NDP pairs that are to be added at system
2760 For each whitespace separated
2763 .Va static_ndp_ Ns Aq Ar element
2764 variable is assumed to exist whose contents will later be passed to a
2769 static_ndp_pairs="gw"
2770 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2772 .It Va static_routes
2774 Set to the list of static routes that are to be added at system
2778 then for each whitespace separated
2781 .Va route_ Ns Aq Ar element
2782 variable is assumed to exist
2783 whose contents will later be passed to a
2788 static_routes="ext mcast:gif0 gif0local:gif0"
2789 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2790 route_mcast="-net 224.0.0.0/4 -iface gif0"
2791 route_gif0local="-host 169.254.1.1 -iface lo0"
2798 the route is specific to the interface
2800 .It Va ipv6_static_routes
2802 The IPv6 equivalent of
2806 then for each whitespace separated
2809 .Va ipv6_route_ Ns Aq Ar element
2810 variable is assumed to exist
2811 whose contents will later be passed to a
2812 .Dq Nm route Cm add Fl inet6
2814 .It Va gateway_enable
2818 configure host to act as an IP router, e.g.\& to forward packets
2820 .It Va ipv6_gateway_enable
2822 The IPv6 equivalent of
2823 .Va gateway_enable .
2824 .It Va routed_enable
2828 run a routing daemon of some sort, based on the
2833 .It Va route6d_enable
2835 The IPv6 equivalent of
2839 run a routing daemon of some sort, based on the
2844 .It Va routed_program
2850 this is the name of the routing daemon to use.
2851 .It Va route6d_program
2853 The IPv6 equivalent of
2854 .Va routed_program .
2861 these are the flags to pass to the routing daemon.
2862 .It Va route6d_flags
2864 The IPv6 equivalent of
2866 .It Va rtadvd_enable
2872 daemon at boot time.
2875 utility sends ICMPv6 Router Advertisement messages to
2876 the interfaces specified in
2877 .Va rtadvd_interfaces .
2878 This should only be enabled with great care.
2879 You may want to fine-tune
2881 .It Va rtadvd_interfaces
2887 this is the list of interfaces to use.
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_ipv4mapping
2964 this enables IPv4 mapped IPv6 address communication (like
2965 .Li ::ffff:a.b.c.d ) .
2966 .It Va rtsold_enable
2972 daemon to send ICMPv6 Router Solicitation messages.
2979 these are the flags to pass to
2983 For interfaces configured with the
2984 .Dq Li inet6 accept_rtadv
2985 keyword, these are the flags to pass to
2990 is mutually exclusive to
2996 The keyboard bell sound.
3003 if the default behavior is desired.
3004 For details, refer to the
3009 If set to a non-null string, the virtual console's keyboard input is
3015 no keymap is installed, otherwise the value is used to install
3016 the keymap file found in
3017 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3020 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3025 The keyboard repeat speed.
3032 if the default behavior is desired.
3037 attempt to program the function keys with the value.
3039 be a single string of the form:
3040 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3043 Can be set to the value of
3046 .Dq Li destructive ,
3049 to set the cursor behavior explicitly or choose the default behavior.
3054 no screen map is installed, otherwise the value is used to install
3055 the screen map file in
3056 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3057 This parameter is ignored when using
3059 as the console driver.
3064 the default 8x16 font value is used for screen size requests, otherwise
3066 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3068 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3069 is used (depending on the console driver being used).
3074 the default 8x14 font value is used for screen size requests, otherwise
3076 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3078 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3079 is used (depending on the console driver being used).
3084 the default 8x8 font value is used for screen size requests, otherwise
3086 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3088 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3089 is used (depending on the console driver being used).
3094 the default screen blanking interval is used, otherwise it is set
3102 this is the actual screen saver to use
3103 .Li ( blank , snake , daemon ,
3105 .It Va moused_nondefault_enable
3109 the mouse device specified on
3110 the command line is not automatically treated as enabled by the
3111 .Pa /etc/rc.d/moused
3113 Having this variable set to
3119 to be enabled as soon as it is plugged in.
3120 .It Va moused_enable
3126 daemon is started for doing cut/paste selection on the console.
3129 This is the protocol type of the mouse connected to this host.
3130 This variable must be set if
3137 is able to detect the appropriate mouse type automatically in many cases.
3138 Set this variable to
3140 to let the daemon detect it, or
3141 select one from the following list if the automatic detection fails.
3143 If the mouse is attached to the PS/2 mouse port, choose
3147 regardless of the brand and model of the mouse.
3149 mouse is attached to the bus mouse port, choose
3153 All other protocols are for serial mice and will not work with
3154 the PS/2 and bus mice.
3155 If this is a USB mouse,
3157 is the only protocol type which will work.
3159 .Bl -tag -width ".Li x10mouseremote" -compact
3161 Microsoft mouse (serial)
3163 Microsoft IntelliMouse (serial)
3165 Mouse systems Corp.\& mouse (serial)
3167 MM Series mouse (serial)
3169 Logitech mouse (serial)
3173 Logitech MouseMan and TrackMan (serial)
3175 ALPS GlidePoint (serial)
3176 .It Li thinkingmouse
3177 Kensington ThinkingMouse (serial)
3181 MM HitTablet (serial)
3182 .It Li x10mouseremote
3183 X10 MouseRemote (serial)
3185 Interlink VersaPad (serial)
3188 Even if the mouse is not in the above list, it may be compatible
3189 with one in the list.
3190 Refer to the manual page for
3192 for compatibility information.
3194 It should also be noted that while this is enabled, any
3195 other client of the mouse (such as an X server) should access
3196 the mouse through the virtual mouse device,
3198 and configure it as a
3200 type mouse, since all
3201 mouse data is converted to this single canonical format when
3204 If the client program does not support the
3210 It is the second preferred type.
3217 this is the actual port the mouse is on.
3220 for a COM1 serial mouse,
3224 for a bus mouse, for example.
3229 is set, its value is used as an additional set of flags to pass to the
3232 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3234 .Va moused_nondefault_enable
3237 daemon is started for a non-default port, the
3238 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3239 set of options has precedence over and replaces the default
3243 is the name of the non-default port, i.e.,\&
3246 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3247 it is possible to set up a different set of default flags for each
3250 For example, you can use
3254 to make your laptop's touchpad more comfortable to use,
3255 but an empty set of options for
3256 .Va moused_ums0_flags
3259 mouse has three or more buttons.
3260 .It Va mousechar_start
3264 the default mouse cursor character range
3265 .Li 0xd0 Ns - Ns Li 0xd3
3267 otherwise the range start is set
3272 Use if the default range is occupied in the language code table.
3273 .It Va allscreens_flags
3277 is run with these options for each of the virtual terminals
3281 will enable the mouse pointer on all virtual terminals
3286 .It Va allscreens_kbdflags
3290 is run with these options for each of the virtual terminals
3298 scrollback (history) buffer to 200 lines.
3305 daemon at system boot time.
3311 .Pa /usr/sbin/cron ) .
3318 these are the flags to pass to
3324 enable the special handling of transitions to and from the
3325 Daylight Saving Time in
3327 (equivalent to using the flag
3334 .Pa /usr/sbin/lpd ) .
3341 daemon at system boot time.
3348 these are the flags to pass to the
3351 .It Va chkprintcap_enable
3357 command before starting the
3360 .It Va chkprintcap_flags
3365 .Va chkprintcap_enable
3368 these are the flags to pass to the
3373 which causes missing directories to be created.
3374 .It Va mta_start_script
3376 This variable specifies the full path to the script to run to start
3377 a mail transfer agent.
3379 .Pa /etc/rc.sendmail .
3383 .Pa /etc/rc.sendmail
3384 uses are documented in the
3389 Indicates the device (usually a swap partition) to which a crash dump
3390 should be written in the event of a system crash.
3391 If the value of this variable is
3393 the first suitable swap device listed in
3395 will be used as dump device.
3396 Otherwise, the value of this variable is passed as the argument to
3398 To disable crash dumps, set this variable to
3406 as the system dump device.
3409 When the system reboots after a crash and a crash dump is found on the
3410 device specified by the
3414 will save that crash dump and a copy of the kernel to the directory
3418 The default value is
3427 .It Va savecore_enable
3431 disable automatic extraction of the crash dump from the
3433 .It Va savecore_flags
3435 If crash dumps are enabled, these are the flags to pass to the
3442 to turn on user and group disk quotas on system startup via the
3444 command for all file systems marked as having quotas enabled in
3446 The kernel must be built with
3448 for disk quotas to function.
3453 to enable user and group disk quota checking via the
3456 .It Va quotacheck_flags
3466 these are the flags to pass to the
3471 which checks quotas for all file systems with quotas enabled in
3473 .It Va quotaon_flags
3479 these are the flags to pass to the
3484 which enables quotas for all file systems with quotas enabled in
3486 .It Va quotaoff_flags
3492 these are the flags to pass to the
3494 utility when shutting down the quota system.
3497 which disables quotas for all file systems with quotas enabled in
3499 .It Va accounting_enable
3503 to enable system accounting through the
3510 to enable iBCS2 (SCO) binary emulation at system initial boot
3512 .It Va ibcs2_loaders
3520 this specifies a list of additional iBCS2 loaders to enable.
3521 .It Va firstboot_sentinel
3523 This variable specifies the full path to a
3526 If a file exists with this path,
3530 keyword will be run on startup and the sentinel file will be deleted
3531 after the boot process completes.
3532 The sentinel file must be located on a writable file system which is
3533 mounted no later than
3534 .Va early_late_divider
3535 to function properly.
3542 to enable Linux/ELF binary emulation at system initial
3544 .It Va sysvipc_enable
3548 load System V IPC primitives at boot time.
3549 .It Va clear_tmp_enable
3560 to disable removing of X11 lock files,
3561 and the removal and (secure) recreation
3562 of the various socket directories for X11
3564 .It Va ldconfig_paths
3566 Set to the list of shared library paths to use with
3570 will always be added first, so it need not appear in this list.
3571 .It Va ldconfig32_paths
3573 Set to the list of 32-bit compatibility shared library paths to
3576 .It Va ldconfig_paths_aout
3578 Set to the list of shared library paths to use with
3583 .It Va ldconfig_insecure
3587 utility normally refuses to use directories
3588 which are writable by anyone except root.
3589 Set this variable to
3591 to disable that security check during system startup.
3592 .It Va ldconfig_local_dirs
3594 Set to the list of local
3597 The names of all files in the directories listed will be
3598 passed as arguments to
3600 .It Va ldconfig_local32_dirs
3602 Set to the list of local 32-bit compatibility
3605 The names of all files in the directories listed will be
3606 passed as arguments to
3607 .Dq Nm ldconfig Fl 32 .
3608 .It Va kern_securelevel_enable
3612 to set the kernel security level at system startup.
3613 .It Va kern_securelevel
3615 The kernel security level to set at startup.
3616 The allowed range of
3618 ranges from \-1 (the compile time default) to 3 (the
3622 for the list of possible security levels and their effect
3623 on system operation.
3626 Path to the SSH server program
3627 .Pa ( /usr/sbin/sshd
3635 at system boot time.
3642 these are the flags to pass to the
3647 Path to the FTP server program
3648 .Pa ( /usr/libexec/ftpd
3656 as a stand-alone daemon at system boot time.
3663 these are the additional flags to pass to the
3666 .It Va watchdogd_enable
3672 daemon at boot time.
3673 This requires that the kernel have been compiled with a
3676 .It Va watchdogd_flags
3679 .Va watchdogd_enable
3682 these are the flags passed to the
3685 .It Va devfs_rulesets
3687 List of files containing sets of rules for
3689 .It Va devfs_system_ruleset
3691 Rule name(s) to apply to the system
3694 .It Va devfs_set_rulesets
3696 Pairs of already-mounted
3698 directories and rulesets that should be applied to them.
3699 For example: /mount/dev=ruleset_name
3700 .It Va devfs_load_rulesets
3702 If set, always load the default rulesets listed in
3703 .Va devfs_rulesets .
3704 .It Va performance_cx_lowest
3706 CPU idle state to use while on AC power.
3711 should use the lowest power state available while
3713 indicates that the lowest latency state (less power savings) should be used.
3714 .It Va performance_cpu_freq
3716 CPU clock frequency to use while on AC power.
3721 should use the lowest frequency available while
3723 indicates that the highest frequency (less power savings) should be used.
3724 .It Va economy_cx_lowest
3726 CPU idle state to use when off AC power.
3731 should use the lowest power state available while
3733 indicates that the lowest latency state (less power savings) should be used.
3734 .It Va economy_cpu_freq
3736 CPU clock frequency to use when off AC power.
3741 should use the lowest frequency available while
3743 indicates that the highest frequency (less power savings) should be used.
3748 any configured jails will not be started.
3751 The configuration filename used by
3754 The default value is
3755 .Pa /etc/jail.conf .
3756 .It Va jail_parallel_start
3760 all configured jails will be started in the background (in parallel).
3764 When set, use as default value for
3765 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3770 A space-delimited list of jail names.
3771 When left empty, all of the
3773 instances defined in the configuration file are started.
3774 The names specified in this list control the jail startup order.
3776 instances missing from
3778 must be started manually.
3781 parameter in the configuration file may override this list.
3782 .It Va jail_reverse_stop
3786 all configured jails in
3788 are stopped in reverse order.
3789 .It Va jail_* variables
3790 Note that older releases supported per-jail configuration via
3794 hostname of a jail named
3796 was able to be set by
3797 .Li jail_vjail_hostname .
3798 These per-jail configuration variables are now obsolete in favor of
3801 For backward compatibility,
3802 when per-jail configuration variables are defined,
3804 configuration files are created as
3805 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3808 The following per-jail parameters are handled by
3810 script out of their corresponding
3813 In addition to them, parameters in
3814 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3815 will be added to the configuration file.
3816 They must be a semi-colon
3824 .Bl -tag -width "host.hostname" -offset indent
3827 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3828 .It Li host.hostname
3830 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3831 .It Li exec.consolelog
3833 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3834 The default value is
3835 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3838 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3839 .It Li vnet.interface
3841 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3844 parameter will be enabled and cannot be specified with
3845 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3846 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3848 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3852 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3855 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3858 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3861 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3862 The parameter name was
3864 in some older releases.
3865 .It Li exec.prestart
3867 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3868 .It Li exec.poststart
3870 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3873 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3876 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3877 .It Li exec.poststop
3879 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3882 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3884 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3885 contain IPv4 addresses
3888 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3890 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3891 contain IPv6 addresses
3894 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3897 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3898 .It Li devfs_ruleset
3900 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3901 This must be an integer,
3903 .It Li mount.fdescfs
3905 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3906 .It Li allow.set_hostname
3908 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3909 .It Li allow.rawsocket
3911 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3912 .It Li allow.sysvipc
3914 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3916 .\" -----------------------------------------------------
3920 representing the entropy sources
3921 you wish to harvest.
3924 for more information.
3929 to disable caching entropy via
3931 Otherwise set to the directory
3932 in which the entropy files are stored.
3936 that regularly writes and rotates
3939 will be used at boot time.
3941 .Pa /var/db/entropy .
3946 to disable caching entropy through reboots.
3947 Otherwise set to the name
3948 of a file used to store cached entropy.
3949 This file should be located
3950 on a file system that is readable
3951 before all the volumes specified in
3958 .Pa /var/db/entropy-file
3959 is found it will also be used.
3960 This will be of some use to
3962 .It Va entropy_boot_file
3967 very early caching entropy
3969 Otherwise set to the filename
3971 very early reboot cached entropy.
3972 This file should be located where
3977 The default location is
3979 .It Va entropy_save_sz
3981 Size of the entropy cache files saved by
3984 .It Va entropy_save_num
3986 Number of entropy cache files to save by
4000 Configuration file for
4009 .Pa /var/run/dmesg.boot
4011 .It Va rcshutdown_timeout
4013 If set, start a watchdog timer in the background which will terminate
4017 has not completed within the specified time (in seconds).
4018 Notice that in addition to this soft timeout,
4020 also applies a hard timeout for the execution of
4022 This is configured via
4025 .Va kern.init_shutdown_timeout
4026 and defaults to 120 seconds.
4027 Setting the value of
4028 .Va rcshutdown_timeout
4029 to more than 120 seconds will have no effect until the
4032 .Va kern.init_shutdown_timeout
4034 .It Va virecover_enable
4038 to prevent the system from trying to
4039 recover pre-maturely terminated
4042 .It Va ugidfw_enable
4047 .Xr mac_bsdextended 4
4048 module upon system initialization and load a default
4050 .It Va bsdextended_script
4053 .Xr mac_bsdextended 4
4054 ruleset file to load.
4055 The default value of this variable is
4056 .Pa /etc/rc.bsdextended .
4057 .It Va newsyslog_enable
4064 .It Va newsyslog_flags
4067 .Va newsyslog_enable
4070 these are the flags to pass to the
4075 which causes log files flagged with a
4078 .It Va mdconfig_md Ns Aq Ar X
4088 must be specified and either a
4090 for malloc or swap backed
4098 .Va mdconfig_md Ns Aq Ar X
4099 variables are evaluated until one variable is unset or null.
4100 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4102 Optional arguments passed to
4108 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4110 An ownership specification passed to
4119 device and the mount point will be changed.
4120 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4122 A mode string passed to
4131 device and the mount point will be changed.
4132 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4134 Files to be copied to the mount point of the
4138 after it has been mounted.
4139 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4141 Command to execute after the specified
4146 Note that the command is passed to
4152 variables can be used to reference respectively the
4154 device and the mount point.
4159 one could set the following:
4161 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4163 .It Va autobridge_interfaces
4165 Set to the list of bridge interfaces that will have newly arriving interfaces
4166 checked against to be automatically added.
4169 then for each whitespace separated
4172 .Va autobridge_ Ns Aq Ar element
4173 variable is assumed to exist which has a whitespace separated list of interface
4174 names to match, these names can use wildcards.
4177 autobridge_interfaces="bridge0"
4178 autobridge_bridge0="tap* dc0 vlan[345]"
4184 enable support for sound mixer.
4185 .It Va hcsecd_enable
4189 enable Bluetooth security daemon.
4190 .It Va hcsecd_config
4192 Configuration file for
4195 .Pa /etc/bluetooth/hcsecd.conf .
4200 enable Bluetooth Service Discovery Protocol daemon.
4208 .It Va sdpd_groupname
4212 group to run as after it initializes.
4215 .It Va sdpd_username
4219 user to run as after it initializes.
4222 .It Va bthidd_enable
4226 enable Bluetooth Human Interface Device daemon.
4227 .It Va bthidd_config
4229 Configuration file for
4232 .Pa /etc/bluetooth/bthidd.conf .
4235 Path to a file, where
4237 will store information about known HID devices.
4239 .Pa /var/db/bthidd.hids .
4240 .It Va rfcomm_pppd_server_enable
4244 enable Bluetooth RFCOMM PPP wrapper daemon.
4245 .It Va rfcomm_pppd_server_profile
4247 The name of the profile to use from
4248 .Pa /etc/ppp/ppp.conf .
4249 Multiple profiles can be specified here.
4250 Also used to specify per-profile overrides.
4251 When the profile name contains any of the characters
4253 they are translated to
4255 for the proposes of the override variable names.
4256 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4258 Overrides local address to listen on.
4264 The address can be specified as BD_ADDR or name.
4265 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4267 Overrides local RFCOMM channel to listen on.
4270 will listen on RFCOMM channel 1.
4271 Must set properly if multiple profiles used in the same time.
4272 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4276 if it should register Serial Port service on the specified RFCOMM channel.
4279 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4283 if it should register Dial-Up Networking service on the specified
4287 .It Va ubthidhci_enable
4291 change the USB Bluetooth controller from HID mode to HCI mode.
4292 You also need to specify the location of USB Bluetooth controller with the
4293 .Va ubthidhci_busnum
4297 .It Va ubthidhci_busnum
4298 Bus number where the USB Bluetooth controller is located.
4301 on your system to find this information.
4302 .It Va ubthidhci_addr
4303 Bus address of the USB Bluetooth controller.
4306 on your system to find this information.
4307 .It Va netwait_enable
4311 delays the start of network-reliant services until
4313 is up and ICMP packets to a destination defined in
4316 Link state is examined first, followed by
4318 an IP address to verify network usability.
4319 If no destination can be reached or timeouts are exceeded,
4320 network services are started anyway with no guarantee that
4321 the network is usable.
4322 Use of this variable requires both
4330 This variable contains a space-delimited list of IP addresses to
4332 DNS hostnames should not be used as resolution is not guaranteed
4333 to be functional at this point.
4334 If multiple IP addresses are specified,
4335 each will be tried until one is successful or the list is exhausted.
4336 .It Va netwait_timeout
4338 Indicates the total number of seconds to perform a
4340 against each IP address in
4342 at a rate of one ping per second.
4343 If any of the pings are successful,
4344 full network connectivity is considered reliable.
4349 Defines the name of the network interface on which watch for link.
4351 is used to monitor the interface, looking for
4352 .Dq Li status: no carrier .
4353 Once gone, the link is considered up.
4356 interface if desired.
4357 .It Va netwait_if_timeout
4359 Defines the total number of seconds to wait for link to become usable,
4360 polled at a 1-second interval.
4368 rules from the defined ruleset.
4369 The kernel must be built with
4372 .Cd "options RCTL" .
4378 This variables contains the
4384 A space-separated list of configuration files used by
4386 The default value is an empty string.
4387 .It Va autofs_enable
4397 daemons at boot time.
4398 .It Va automount_flags
4404 these are the flags to pass to the
4407 By default no flags are passed.
4408 .It Va automountd_flags
4414 these are the flags to pass to the
4417 By default no flags are passed.
4418 .It Va autounmountd_flags
4424 these are the flags to pass to the
4427 By default no flags are passed.
4434 daemon at boot time.
4435 .It Va iscsid_enable
4441 daemon at boot time.
4442 .It Va iscsictl_enable
4448 utility at boot time.
4449 .It Va iscsictl_flags
4455 these are the flags to pass to the
4460 which configures sessions based on the
4465 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4466 .It Pa /etc/defaults/rc.conf
4468 .It Pa /etc/rc.conf.local
4498 .Xr newsyslog.conf 5 ,
4570 .An Jordan K. Hubbard .