4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the system installation utility.
45 is not to run commands or perform system startup actions
47 Instead, it is included by the
48 various generic startup scripts in
50 which conditionalize their
51 internal actions according to the settings found there.
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
60 when the system administrator wishes to override these defaults.
62 .Pa /etc/rc.conf.local
63 is used to override settings in
65 for historical reasons.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
74 .Ao Ar dir Ac Ns Pa /rc.conf.d
75 directories specified in
77 which will be included by the
80 For jail configurations you could use the file
81 .Pa /etc/rc.conf.d/jail
82 to store jail specific configuration options.
86 .Pa /usr/local/etc/rc.d
89 .Pa /usr/local/rc.conf.d/jail
91 .Pa /opt/conf/rc.conf.d/jail
94 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
96 all of files in the directory will be loaded.
102 .Dq Ar name Ns Li = Ns Ar value
106 The following list provides a name and short description for each
107 variable that can be set in the
110 .Bl -tag -width indent-two
115 enable output of debug messages from rc scripts.
116 This variable can be helpful in diagnosing mistakes when
117 editing or integrating new scripts.
118 Beware that this produces copious output to the terminal and
124 disable informational messages from the rc scripts.
125 Informational messages are displayed when
126 a condition that is not serious enough to warrant a warning or
134 when faststart is used (e.g., at boot time).
135 .It Va early_late_divider
137 The name of the script that should be used as the
138 delimiter between the
142 stages of the boot process.
143 The early stage should contain all the services needed to
144 get the disks (local or remote) mounted so that the late
145 stage can include scripts contained in the directories
148 variable (see below).
149 Thus, the two likely candidates for this value are
151 for the typical system, and
153 if the system needs remote file
154 systems mounted to get access to the
156 directories; for example when
164 is likely to be an appropriate value.
165 Extreme care should be taken when changing this value,
166 and before changing it one should ensure that there are
167 adequate provisions to recover from a failed boot
168 (such as physical contact with the machine,
169 or reliable remote console access).
170 .It Va always_force_depends
174 scripts use the force_depend function to check whether required
175 services are already running, and to start them if necessary.
176 By default during boot time this check is bypassed if the
177 required service is enabled in
178 .Pa /etc/rc.conf[.local] .
179 Setting this option will bypass that check at boot time and
180 always test whether or not the service is actually running.
181 Enabling this option is likely to increase your boot time if
182 services are enabled that utilize the force_depend check.
183 .It Ao Ar name Ac Ns Va _chroot
186 to this directory before running the service.
187 .It Ao Ar name Ac Ns Va _user
189 Run the service under this user account.
190 .It Ao Ar name Ac Ns Va _group
192 Run the chrooted service under this system group.
194 setting, this setting has no effect if the service is not chrooted.
195 .It Ao Ar name Ac Ns Va _fib
199 value to run the service under.
200 .It Ao Ar name Ac Ns Va _nice
204 value to run the service under.
209 enable support for Automatic Power Management with
217 to handle APM event from userland.
218 This also enables support for APM.
225 these are the flags to pass to the
232 to handle device added, removed or unknown events from the kernel.
239 scripts at boot time.
242 Configuration file for
248 A list of kernel modules to load right after the local
250 Loading modules at this point in the boot process is
251 much faster than doing it via
252 .Pa /boot/loader.conf
253 for those modules not necessary for mounting local disk.
254 .It Va kldxref_enable
261 to automatically rebuild
266 .It Va kldxref_clobber
276 will overwrite existing
283 .It Va kldxref_module_path
288 delimited list of paths containing
300 enable the system power control facility with the
309 these are the flags to pass to the
313 Controls the creation of a
316 Always happens if set to
318 and never happens if set to
320 If set to anything else, a memory file system is created if
324 Controls the size of a created
328 Extra options passed to the
330 utility when the memory file system for
335 which inhibits the use of softupdates on
337 so that file system space is freed without delay
338 after file truncation or deletion.
341 for other options you can use in
344 Controls the creation of a
347 Always happens if set to
349 and never happens if set to
351 If set to anything else, a memory file system is created if
355 Controls the size of a created
359 Extra options passed to the
361 utility when the memory file system for
366 which inhibits the use of softupdates on
368 so that file system space is freed without delay
369 after file truncation or deletion.
372 for other options you can use in
375 Controls the automatic population of the
378 Always happens if set to
380 and never happens if set to
382 If set to anything else, a memory file system is created if
385 Note that this process requires access to certain commands in
389 is mounted on normal systems.
390 .It Va cleanvar_enable
397 List of directories to search for startup script files.
398 .It Va script_name_sep
400 The field separator to use for breaking down the list of startup script files
401 into individual filenames.
402 The default is a space.
403 It is not necessary to change this unless there are startup scripts with names
405 .It Va hostapd_enable
414 The fully qualified domain name (FQDN) of this host on the network.
415 This should almost certainly be set to something meaningful, even if
416 there is no network connection.
419 is used to set the hostname via DHCP,
420 this variable should be set to an empty string.
421 If this value remains unset when the system is done booting
422 your console login will display the default hostname of
426 The NIS domain name of this host, or
429 .It Va dhclient_program
431 Path to the DHCP client program
432 .Pa ( /sbin/dhclient ,
437 .It Va dhclient_flags
439 Additional flags to pass to the DHCP client program.
444 manpage for a description of the command line options available.
445 .It Va dhclient_flags_ Ns Aq Ar iface
446 Additional flags to pass to the DHCP client program running on
449 When specified, this variable overrides
451 .It Va background_dhclient
455 to start the DHCP client in background.
456 This can cause trouble with applications depending on
457 a working network, but it will provide a faster startup
459 .It Va background_dhclient_ Ns Aq Ar iface
460 When specified, this variable overrides the
461 .Va background_dhclient
462 variable for interface
465 .It Va synchronous_dhclient
471 synchronously at startup.
472 This behavior can be overridden on a per-interface basis by replacing
476 .Va ifconfig_ Ns Aq Ar interface
481 .It Va defaultroute_delay
483 When set to a positive value, wait up to this long after configuring
484 DHCP interfaces at startup to give the interfaces time to receive a lease.
485 .It Va firewall_enable
489 to load firewall rules at startup.
490 If the kernel was not built with
491 .Cd "options IPFIREWALL" ,
494 kernel module will be loaded.
496 .Va ipfilter_enable .
497 .It Va firewall_script
499 This variable specifies the full path to the firewall script to run.
501 .Pa /etc/rc.firewall .
504 Names the firewall type from the selection in
505 .Pa /etc/rc.firewall ,
506 or the file which contains the local firewall ruleset.
507 Valid selections from
511 .Bl -tag -width ".Li simple" -compact
513 unrestricted IP access
515 all IP services disabled, except via
518 basic protection for a workstation
520 basic protection for a LAN.
523 If a filename is specified, the full path
525 .It Va firewall_quiet
529 to disable the display of firewall rules on the console during boot.
530 .It Va firewall_logging
534 to enable firewall event logging.
535 This is equivalent to the
536 .Dv IPFIREWALL_VERBOSE
538 .It Va firewall_logif
542 to create pseudo interface
545 For more details, see
548 .It Va firewall_flags
554 specifies a filename.
555 .It Va firewall_coscripts
557 List of executables and/or rc scripts to run after firewall starts/stops.
559 .\" ----- firewall_nat_enable setting --------------------------------
560 .It Va firewall_nat_enable
572 .It Va firewall_nat_interface
578 This is the name of the public interface or IP address on which
579 kernel NAT should run.
580 .It Va firewall_nat_flags
582 Additional configuration parameters for kernel NAT should be placed here.
583 .It Va dummynet_enable
587 will automatically load the
593 .\" -------------------------------------------------------------------
609 sockets must be enabled in the kernel.
610 If the kernel was not built with
611 .Cd "options IPDIVERT" ,
614 kernel module will be loaded.
615 .It Va natd_interface
617 This is the name of the public interface on which
620 The interface may be given as an interface name or as an IP address.
625 flags should be placed here.
630 flag is automatically added with the above
633 .\" ----- ipfilter_enable setting --------------------------------
634 .It Va ipfilter_enable
645 Typical usage will require putting
647 ipfilter_enable="YES"
665 can be enabled independently.
669 both require at least one of
679 options IPFILTER_DEFAULT_BLOCK
682 in the kernel configuration file is a good idea, too.
683 .\" ----- ipfilter_program setting ------------------------------
684 .It Va ipfilter_program
690 .\" ----- ipfilter_rules setting --------------------------------
691 .It Va ipfilter_rules
696 This variable contains the name of the filter rule definition file.
697 The file is expected to be readable for the
700 .\" ----- ipv6_ipfilter_rules setting ---------------------------
701 .It Va ipv6_ipfilter_rules
706 This variable contains the IPv6 filter rule definition file.
707 The file is expected to be readable for the
710 .\" ----- ipfilter_flags setting --------------------------------
711 .It Va ipfilter_flags
714 This variable contains flags passed to the
717 .\" ----- ipnat_enable setting ----------------------------------
727 network address translation.
730 for a detailed discussion.
731 .\" ----- ipnat_program setting ---------------------------------
738 .\" ----- ipnat_rules setting -----------------------------------
744 This variable contains the name of the file
745 holding the network address translation definition.
746 This file is expected to be readable for the
749 .\" ----- ipnat_flags setting -----------------------------------
753 This variable contains flags passed to the
756 .\" ----- ipmon_enable setting ----------------------------------
771 Setting this variable needs setting
778 for a detailed discussion.
779 .\" ----- ipmon_program setting ---------------------------------
786 .\" ----- ipmon_flags setting -----------------------------------
792 This variable contains flags passed to the
795 Another typical example would be
796 .Dq Fl D Pa /var/log/ipflog
799 log directly to a file bypassing
802 .Pa /etc/newsyslog.conf
803 in such case like this:
805 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
807 .\" ----- ipfs_enable setting -----------------------------------
817 saving the filter and NAT state tables during shutdown
818 and reloading them during startup again.
819 Setting this variable needs setting
828 for a detailed discussion.
834 because the raised securelevel will prevent
836 from saving the state tables at shutdown time.
837 .\" ----- ipfs_program setting ----------------------------------
844 .\" ----- ipfs_flags setting ------------------------------------
848 This variable contains flags passed to the
851 .\" ----- end of added ipf hook ---------------------------------
863 Typical usage will require putting
878 into the kernel, otherwise the
879 kernel module will be loaded.
884 ruleset configuration file
899 these flags are passed to the
901 program when loading the ruleset.
911 which logs packets from the
924 .Pa /var/log/pflog ) .
926 .Pa /etc/newsyslog.conf
927 to adjust logfile rotation for this.
937 This variable contains additional flags passed to the
940 .It Va pflog_instances
942 If logging to more than one
944 interface is desired,
946 is set to the list of
948 instances that should be started at system boot time.
951 is set, for each whitespace-seperated
954 .Ao Ar element Ac Ns Va _dev
956 .Ao Ar element Ac Ns Va _logfile
957 elements are assumed to exist.
958 .Ao Ar element Ac Ns Va _dev
961 interface to be watched by the named
964 .Ao Ar element Ac Ns Va _logfile
965 must contain the name of the logfile that will be used by the
968 .It Va ftpproxy_enable
979 packet filter in translating ftp connections.
980 .It Va ftpproxy_flags
983 This variable contains additional flags passed to the
986 .It Va ftpproxy_instances
989 If multiple instances of
991 are desired at boot time,
992 .Va ftpproxy_instances
993 should contain a whitespace-seperated list of instance names.
996 in the list, a variable named
997 .Ao Ar element Ac Ns Va _flags
998 should be defined, containing the command-line flags to be passed to the
1001 .It Va pfsync_enable
1010 state changes to other hosts over the network by means of
1015 must also be set then.
1016 .It Va pfsync_syncdev
1019 This variable specifies the name of the network interface
1021 should operate through.
1022 It must be set accordingly if
1026 .It Va pfsync_syncpeer
1029 This variable is optional.
1030 By default, state change messages are sent out on the synchronisation
1031 interface using IP multicast packets.
1032 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1034 When a peer address is specified using the
1036 option, the peer address is used as a destination for the pfsync
1037 traffic, and the traffic can then be protected using
1041 manpage for more details about using
1046 .It Va pfsync_ifconfig
1049 This variable can contain additional options to be passed to the
1051 command used to set up
1053 .It Va tcp_extensions
1060 disables certain TCP options as described by
1066 might help remedy such problems with connections as randomly hanging
1067 or other weird behavior.
1068 Some network devices are known
1069 to be broken with respect to these options.
1072 Set to 0 by default.
1076 .Va net.inet.tcp.log_in_vain
1078 .Va net.inet.udp.log_in_vain ,
1083 are set to the given value.
1084 .It Va tcp_keepalive
1091 will disable probing idle TCP connections to verify that the
1092 peer is still up and reachable.
1093 .It Va tcp_drop_synfin
1100 will cause the kernel to ignore TCP frames that have both
1101 the SYN and FIN flags set.
1102 This prevents OS fingerprinting, but may
1103 break some legitimate applications.
1104 .It Va icmp_drop_redirect
1111 will cause the kernel to ignore ICMP REDIRECT packets.
1114 for more information.
1115 .It Va icmp_log_redirect
1122 will cause the kernel to log ICMP REDIRECT packets.
1124 the log messages are not rate-limited, so this option should only be used
1125 for troubleshooting networks.
1128 for more information.
1129 .It Va icmp_bmcastecho
1133 to respond to broadcast or multicast ICMP ping packets.
1136 for more information.
1137 .It Va ip_portrange_first
1141 this is the first port in the default portrange.
1144 for more information.
1145 .It Va ip_portrange_last
1149 this is the last port in the default portrange.
1152 for more information.
1153 .It Va network_interfaces
1155 Set to the list of network interfaces to configure on this host or
1157 (the default) for all current interfaces.
1159 .Va network_interfaces
1160 variable to anything other than the default is deprecated.
1161 Interfaces that the administrator wishes to store configuration for,
1162 but not start at boot should be configured with the
1165 .Va ifconfig_ Ns Aq Ar interface
1166 variables as described below.
1169 .Va ifconfig_ Ns Aq Ar interface
1170 variable is also assumed to exist for each value of
1172 When an interface name contains any of the characters
1174 they are translated to
1177 The variable can contain arguments to
1179 as well as special case-insensitive keywords described below.
1180 Such keywords are removed before passing the value to
1182 while the order of the other arguments is preserved.
1184 It is possible to add IP alias entries using
1186 syntax with the address family keyword such as
1188 Assuming that the interface in question was
1190 it might look something like this:
1192 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1193 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1196 It also possible to configure multiple IP addresses in Classless
1197 Inter-Domain Routing
1200 whose each address component can be a range like
1201 .Li inet 192.0.2.5-23/24
1203 .Li inet6 2001:db8:1-f::1/64 .
1204 This notation allows address and prefix length part only,
1205 not the other address modifiers.
1206 Note that the maximum number of the generated addresses from a range
1207 specification is limited to an integer value specified in
1208 .Va netif_ipexpand_max
1211 because a small typo can unexpectedly generate a large number of addresses.
1212 The default value is
1214 It can be increased by adding the following line into
1217 netif_ipexpand_max="4096"
1221 .Li 192.0.2.5-23/24 ,
1222 the address 192.0.2.5 will be configured with the
1223 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1224 the non-conflicting netmask /32 as explained in the
1227 Note that this special netmask handling is only for
1229 not for the other address families such as
1232 With the interface in question being
1234 an example could look like:
1236 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1237 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1243 .Va ipv4_addrs_ Ns Aq Ar interface
1244 variable was supported for IPv4 CIDR address notation.
1245 It is now deprecated because the functionality was integrated into
1246 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1248 .Va ipv4_addrs_ Ns Aq Ar interface
1249 is still supported for backward compatibility.
1252 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1253 entry with an address family keyword,
1254 its contents are passed to
1256 Execution stops at the first unsuccessful access, so if
1257 something like this is present:
1259 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1260 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1261 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1262 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1265 Then note that alias4 would
1267 be added since the search would
1268 stop with the missing
1271 Because of this difficult to manage behavior,
1273 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1274 variable, which has the same functionality as
1275 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1276 and can have all of entries in a variable like the following:
1278 ifconfig_ed0_aliases="\\
1279 inet 127.0.0.251 netmask 0xffffffff \\
1280 inet 127.0.0.252 netmask 0xffffffff \\
1281 inet 127.0.0.253 netmask 0xffffffff \\
1282 inet 127.0.0.254 netmask 0xffffffff"
1285 It also supports CIDR notation.
1288 .Pa /etc/start_if. Ns Aq Ar interface
1289 file is present, it is read and executed by the
1292 before configuring the interface as specified in the
1293 .Va ifconfig_ Ns Aq Ar interface
1295 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1299 .Va vlans_ Ns Aq Ar interface
1303 interface will be created for each item in the list with the
1307 If a vlan interface's name is a number,
1308 then that number is used as the vlan tag and the new vlan interface is
1310 .Ar interface . Ns Ar tag .
1312 the vlan tag must be specified via a
1315 .Va create_args_ Ns Aq Ar interface
1318 To create a vlan device named
1322 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1325 ifconfig_em0_101="inet 192.0.2.1/24"
1328 To create a vlan device named
1332 with the vlan tag 102:
1335 create_args_myvlan="vlan 102"
1339 .Va wlans_ Ns Aq Ar interface
1343 interface will be created for each item in the list with the
1347 Further wlan cloning arguments may be passed to the
1350 command by setting the
1351 .Va create_args_ Ns Aq Ar interface
1355 devices must be created for each wireless devices as of
1361 may be specified with an
1362 .Va wlandebug_ Ns Aq Ar interface
1364 The contents of this variable will be passed directly to
1368 .Va ifconfig_ Ns Aq Ar interface
1369 contains the keyword
1371 then the interface will not be configured
1373 .Pa /etc/pccard_ether
1375 .Va network_interfaces
1379 It is possible to bring up an interface with DHCP by adding
1382 .Va ifconfig_ Ns Aq Ar interface
1384 For instance, to initialize the
1387 it is possible to use something like:
1392 If you want to configure your wireless interface with
1393 .Xr wpa_supplicant 8
1394 for use with WPA, EAP/LEAP or WEP, you need to add
1397 .Va ifconfig_ Ns Aq Ar interface
1400 On the other hand, if you want to configure your wireless interface with
1405 .Va ifconfig_ Ns Aq Ar interface
1408 will use the settings from
1409 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1411 Finally, you can add
1413 options in this variable, in addition to the
1414 .Pa /etc/start_if. Ns Aq Ar interface
1416 For instance, to configure an
1418 wireless device in station mode with an address obtained
1419 via DHCP, using WPA authentication and 802.11b mode, it is
1420 possible to use something like:
1423 ifconfig_wlan0="DHCP WPA mode 11b"
1427 .Va ifconfig_ Ns Aq Ar interface
1428 form, a fallback variable
1429 .Va ifconfig_DEFAULT
1431 It will be used for all interfaces with no
1432 .Va ifconfig_ Ns Aq Ar interface
1434 This is intended to replace the no longer supported
1438 It is also possible to rename an interface by doing:
1440 ifconfig_ed0_name="net0"
1441 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1445 This variable is deprecated.
1447 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1449 .Va ipv6_activate_all_interfaces
1454 .Dq Li inet6 accept_rtadv
1456 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1458 .Va ipv6_activate_all_interfaces
1463 This variable is deprecated.
1465 .Va ip6addrctl_policy
1470 the default address selection policy table set by
1472 will be IPv6-preferred.
1476 the default address selection policy table set by
1478 will be IPv4-preferred.
1479 .It Va ipv6_activate_all_interfaces
1481 This controls initial configuration on IPv6-capable
1482 interfaces with no corresponding
1483 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1485 Note that it is not always necessary to set this variable to
1487 to use IPv6 functionality on
1489 In most cases, just configuring
1490 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1495 all interfaces which do not have a corresponding
1496 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1497 variable will be marked as
1500 This means that all of IPv6 functionality on that interface
1501 is completely disabled to enforce a security policy.
1502 If the variable is set to
1504 the flag will be cleared on all of the interfaces.
1506 In most cases, just defining an
1507 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1508 for an IPv6-capable interface should be sufficient.
1509 However, if an interface is added dynamically
1510 .Pq by some tunneling protocols such as PPP, for example ,
1511 it is often difficult to define the variable in advance.
1512 In such a case, configuring the
1514 flag can be disabled by setting this variable to
1517 For more details of the
1520 .Dq Li inet6 ifdisabled ,
1530 privacy addresses will be generated for each IPv6
1531 interface as described in RFC 4941.
1532 .It Va ipv6_network_interfaces
1534 This is the IPv6 equivalent of
1535 .Va network_interfaces .
1536 Normally manual configuration of this variable is not needed.
1537 .It Va ipv6_cpe_wanif
1539 If the variable is set to an interface name,
1543 .Dq inet6 -no_radr accept_rtadv
1544 will be added to the specified interface automatically before evaluating
1545 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1549 .Va net.inet6.ip6.rfc6204w3
1551 .Va net.inet6.ip6.no_radr
1554 This means the specified interface will accept ICMPv6 Router
1555 Advertisement messages on that link and add the discovered
1556 routers into the Default Router List.
1557 While the other interfaces can still accept RA messages if the
1558 .Dq inet6 accept_rtadv
1559 option is specified, adding
1560 routes into the Default Router List will be disabled by
1567 Note that ICMPv6 Router Advertisement messages will be
1569 .Va net.inet6.ip6.forwarding
1571 .Pq packet forwarding is enabled
1573 .Va net.inet6.ip6.rfc6204w3
1578 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1580 IPv6 functionality on an interface should be configured by
1581 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1582 instead of setting ifconfig parameters in
1583 .Va ifconfig_ Ns Aq Ar interface .
1584 If this variable is empty, all of IPv6 configurations on the
1585 specified interface by other variables such as
1586 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1589 Aliases should be set by
1590 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1596 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1597 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1600 Interfaces that have an
1601 .Dq Li inet6 accept_rtadv
1603 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1604 setting will be automatically configured by SLAAC
1605 .Pq StateLess Address AutoConfiguration
1611 Note that a link-local address will be automatically configured in
1612 addition to the configured global-scope addresses because the IPv6
1613 specifications require it on each link.
1614 The address is calculated from the MAC address by using an algorithm
1621 If only a link-local address is needed on the interface,
1622 the following configuration can be used:
1624 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1627 A link-local address can also be configured manually.
1628 This is useful for the default router address of an IPv6 router
1629 so that it does not change when the network interface
1633 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1635 .It Va ipv6_prefix_ Ns Aq Ar interface
1637 If one or more prefixes are defined in
1638 .Va ipv6_prefix_ Ns Aq Ar interface
1639 addresses based on each prefix and the EUI-64 interface index will be
1640 configured on that interface.
1641 Note that this variable will be ignored when
1642 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1645 For example, the following configuration
1647 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1650 is equivalent to the following:
1652 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1653 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1654 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1655 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1658 These Subnet-Router anycast addresses will be added only when
1659 .Va ipv6_gateway_enable
1661 .It Va ipv6_default_interface
1665 this is the default output interface for scoped addresses.
1666 This works only with ipv6_gateway_enable="NO".
1667 .It Va ip6addrctl_enable
1669 This variable is to enable configuring default address selection policy table
1671 The table can be specified in another variable
1672 .Va ip6addrctl_policy .
1674 .Va ip6addrctl_policy
1675 the following keywords can be specified:
1676 .Dq Li ipv4_prefer ,
1677 .Dq Li ipv6_prefer ,
1687 installs a pre-defined policy table described in Section 2.1
1695 is specified, it attempts to read a file
1696 .Pa /etc/ip6addrctl.conf
1698 If this file is found,
1700 reads and installs it.
1701 If not found, a policy is automatically set
1703 .Va ipv6_activate_all_interfaces
1704 variable; if the variable is set to
1706 the IPv6-preferred one is used.
1707 Otherwise IPv4-preferred.
1709 The default value of
1710 .Va ip6addrctl_enable
1712 .Va ip6addrctl_policy
1718 .It Va cloned_interfaces
1720 Set to the list of clonable network interfaces to create on this host.
1721 Further cloning arguments may be passed to the
1724 command for each interface by setting the
1725 .Va create_args_ Ns Aq Ar interface
1727 If an interface name is specified with
1730 the interface will not be destroyed even when
1732 script is invoked with
1735 This is useful when reconfiguring the interface without destroying it.
1737 .Va cloned_interfaces
1738 are automatically appended to
1739 .Va network_interfaces
1741 .It Va cloned_interfaces_sticky
1743 This variable is to globally enable functionality of
1746 .Va cloned_interfaces
1748 The default value is
1750 Even if this variable is specified to
1753 keyword can be used to override it on per interface basis.
1754 .It Va gif_interfaces
1756 This variable is deprecated in favor of
1757 .Va cloned_interfaces .
1760 tunnel interfaces to configure on this host.
1762 .Va gifconfig_ Ns Aq Ar interface
1763 variable is assumed to exist for each value of
1765 The value of this variable is used to configure the link layer of the
1766 tunnel according to the syntax of the
1770 Additionally, this option ensures that each listed interface is created
1775 before attempting to configure it.
1776 .It Va sppp_interfaces
1780 interfaces to configure on this host.
1782 .Va spppconfig_ Ns Aq Ar interface
1783 variable is assumed to exist for each value of
1785 Each interface should also be configured by a general
1786 .Va ifconfig_ Ns Aq Ar interface
1790 for more information about available options.
1800 The name of the profile to use from
1801 .Pa /etc/ppp/ppp.conf .
1802 Also used for per-profile overrides of
1807 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1808 When the profile name contains any of the characters
1810 they are translated to
1812 for the proposes of the override variable names.
1815 Mode in which to run the
1818 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1820 Overrides the global
1830 See the manual for a full description.
1835 enables network address translation.
1836 Used in conjunction with
1838 allows hosts on private network addresses access to the Internet using
1839 this host as a network address translating router.
1840 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1842 Overrides the global
1846 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1848 Set the unit number to be used for this profile.
1849 See the manual description of
1854 The name of the user under which
1862 .It Va rc_conf_files
1864 This option is used to specify a list of files that will override
1866 .Pa /etc/defaults/rc.conf .
1867 The files will be read in the order in which they are specified and should
1868 include the full path to the file.
1869 By default, the files specified are
1872 .Pa /etc/rc.conf.local
1878 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1880 .It Va gptboot_enable
1884 .Pa /etc/rc.d/gptboot
1885 will log if the system successfully (or not) booted from a GPT partition,
1891 .It Va gbde_autoattach_all
1896 will attempt to automatically initialize your .bde devices in
1900 List the devices that the script should try to attach,
1905 The directory where the
1907 lockfiles are located.
1908 The default lockfile directory is
1911 The lockfile for each individual
1913 device can be overridden by setting the variable
1914 .Va gbde_lock_ Ns Aq Ar device ,
1917 is the encrypted device without the
1922 .It Va gbde_attach_attempts
1924 Number of times to attempt attaching to a
1926 device, i.e., how many times the user is asked for the pass-phrase.
1930 List of devices to automatically attach on boot.
1931 Note that .eli devices from
1933 are automatically appended to this list.
1936 Number of times user is asked for the pass-phrase.
1937 If empty, it will be taken from
1938 .Va kern.geom.eli.tries
1940 .It Va geli_default_flags
1942 Default flags to use by
1944 when configuring disk encryption.
1945 Flags can be configured for every device separately by defining
1946 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1948 .It Va geli_autodetach
1950 Specifies if GELI devices should be marked for detach on last close after
1951 file systems are mounted.
1954 This can be changed for every device separately by defining
1955 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1957 .It Va root_rw_mount
1962 After the file systems are checked at boot time, the root file system
1963 is remounted as read-write if this is set to
1965 Diskless systems that mount their root file system from a read-only remote
1966 NFS share should set this to
1970 .It Va fsck_y_enable
1975 will be run with the
1977 flag if the initial preen
1978 of the file systems fails.
1979 .It Va background_fsck
1983 the system will attempt to run
1985 in the background where possible.
1986 .It Va background_fsck_delay
1988 The amount of time in seconds to sleep before starting a background
1990 It defaults to sixty seconds to allow large applications such as
1991 the X server to start before disk I/O bandwidth is monopolized by
1993 If set to a negative number, the background file system check will be
1994 delayed indefinitely to allow the administrator to run it at a more
1996 For example it may be run from
1998 by adding a line like
2000 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2006 List of file system types that are network-based.
2007 This list should generally not be modified by end users.
2009 .Va extra_netfs_types
2011 .It Va extra_netfs_types
2013 If set to something other than
2016 this variable extends the list of file system types
2017 for which automatic mounting at startup by
2019 should be delayed until the network is initialized.
2021 a whitespace-separated list of network file system descriptor pairs,
2022 each consisting of a file system type as passed to
2024 and a human-readable, one-word description,
2027 Extending the default list in this way is only necessary
2028 when third party file system types are used.
2029 .It Va syslogd_enable
2036 .It Va syslogd_program
2041 .Pa /usr/sbin/syslogd ) .
2042 .It Va syslogd_flags
2048 these are the flags to pass to
2057 .It Va inetd_program
2062 .Pa /usr/sbin/inetd ) .
2069 these are the flags to pass to
2078 .It Va hastd_program
2090 these are the flags to pass to
2092 .It Va local_unbound_enable
2098 daemon as a local caching resolver.
2103 to start a Kerberos 5 authentication server
2111 this is the path to Kerberos 5 Authentication Server.
2115 This variable contains additional flags to be passed to the Kerberos 5
2116 authentication server.
2117 .It Va kadmind_enable
2123 the Kerberos 5 Administration Daemon; set to
2126 .It Va kadmind_program
2132 this is the path to Kerberos 5 Administration Daemon.
2133 .It Va kpasswdd_enable
2139 the Kerberos 5 Password-Changing Daemon; set to
2142 .It Va kpasswdd_program
2148 this is the path to Kerberos 5 Password-Changing Daemon.
2155 the Kerberos 5 ticket forwarding daemon, at the boot time.
2161 .Pa /usr/libexec/kfd ) .
2168 daemon at boot time.
2175 these are the flags to pass to it.
2182 daemon at boot time.
2189 these are the flags to pass to it.
2192 manpage for more information.
2193 .It Va amd_map_program
2196 the specified program is run to get the list of
2201 maps are stored in NIS, one can set this to
2214 will be updated at boot time to reflect the kernel release
2219 will not be updated.
2220 .It Va nfs_client_enable
2224 run the NFS client daemons at boot time.
2225 .It Va nfs_access_cache
2228 .Va nfs_client_enable
2233 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2235 results should be cached.
2236 A value of 2-10 seconds will substantially reduce network
2237 traffic for many NFS operations.
2238 .It Va nfs_server_enable
2242 run the NFS server daemons at boot time.
2243 .It Va nfs_server_flags
2246 .Va nfs_server_enable
2249 these are the flags to pass to the
2252 .It Va nfsv4_server_enable
2255 .Va nfs_server_enable
2259 .Va nfsv4_server_enable
2262 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2263 .It Va nfsuserd_enable
2269 run the nfsuserd daemon, which is needed for NFSv4 in order
2270 to map between user/group names vs uid/gid numbers.
2272 .Va nfsv4_server_enable
2275 this will be forced enabled.
2276 .It Va nfsuserd_flags
2282 these are the flags to pass to the
2285 .It Va nfscbd_enable
2291 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2298 these are the flags to pass to the
2301 .It Va mountd_enable
2306 .Va nfs_server_enable
2312 It is commonly needed to run CFS without real NFS used.
2319 these are the flags to pass to the
2322 .It Va weak_mountd_authentication
2326 allow services like PCNFSD to make non-privileged mount
2328 .It Va nfs_reserved_port_only
2332 provide NFS services only on a secure port.
2333 .It Va nfs_bufpackets
2335 If set to a number, indicates the number of packets worth of
2336 socket buffer space to reserve on an NFS client.
2337 The kernel default is typically 4.
2338 Using a higher number may be
2339 useful on gigabit networks to improve performance.
2340 The minimum value is
2341 2 and the maximum is 64.
2342 .It Va rpc_lockd_enable
2346 and also an NFS server or client, run
2349 .It Va rpc_lockd_flags
2352 .Va rpc_lockd_enable
2355 these are the flags to pass to the
2358 .It Va rpc_statd_enable
2362 and also an NFS server or client, run
2365 .It Va rpc_statd_flags
2368 .Va rpc_statd_enable
2371 these are the flags to pass to the
2374 .It Va rpcbind_program
2379 .Pa /usr/sbin/rpcbind ) .
2380 .It Va rpcbind_enable
2386 service at boot time.
2387 .It Va rpcbind_flags
2393 these are the flags to pass to the
2396 .It Va keyserv_enable
2402 daemon on boot for running Secure RPC.
2403 .It Va keyserv_flags
2409 these are the flags to pass to
2412 .It Va pppoed_enable
2418 daemon at boot time to provide PPP over Ethernet services.
2419 .It Va pppoed_ Ns Aq Ar provider
2422 listens to requests to this
2428 argument of the same name.
2431 Additional flags to pass to
2433 .It Va pppoed_interface
2435 The network interface to run
2438 This is mandatory when
2448 service at boot time.
2449 This command is intended for networks of
2450 machines where a consistent
2452 for all hosts must be established.
2453 This is often useful in large NFS
2454 environments where time stamps on files are expected to be consistent
2462 these are the flags to pass to the
2465 .It Va ntpdate_enable
2472 This command is intended to
2473 synchronize the system clock only
2475 from some standard reference.
2476 .It Va ntpdate_config
2478 Configuration file for
2482 .It Va ntpdate_hosts
2484 A whitespace-separated list of NTP servers to synchronize with at startup.
2485 The default is to use the servers listed in
2486 .Va ntpdate_config ,
2487 if that file exists.
2488 .It Va ntpdate_program
2493 .Pa /usr/sbin/ntpdate ) .
2494 .It Va ntpdate_flags
2500 these are the flags to pass to the
2502 command (typically a hostname).
2509 command at boot time.
2515 .Pa /usr/sbin/ntpd ) .
2529 these are the flags to pass to the
2532 .It Va ntpd_sync_on_start
2539 flag, which syncs the system's clock on startup.
2542 for more information regarding the
2545 This is a preferred alternative to using
2550 .It Va nis_client_enable
2556 service at system boot time.
2557 .It Va nis_client_flags
2560 .Va nis_client_enable
2563 these are the flags to pass to the
2566 .It Va nis_ypldap_enable
2572 daemon at system boot time.
2573 .It Va nis_ypldap_flags
2576 .Va nis.ypldap_enable
2579 these are the flags to pass to the
2582 .It Va nis_ypset_enable
2588 daemon at system boot time.
2589 .It Va nis_ypset_flags
2592 .Va nis_ypset_enable
2595 these are the flags to pass to the
2598 .It Va nis_server_enable
2604 daemon at system boot time.
2605 .It Va nis_server_flags
2608 .Va nis_server_enable
2611 these are the flags to pass to the
2614 .It Va nis_ypxfrd_enable
2620 daemon at system boot time.
2621 .It Va nis_ypxfrd_flags
2624 .Va nis_ypxfrd_enable
2627 these are the flags to pass to the
2630 .It Va nis_yppasswdd_enable
2636 daemon at system boot time.
2637 .It Va nis_yppasswdd_flags
2640 .Va nis_yppasswdd_enable
2643 these are the flags to pass to the
2646 .It Va rpc_ypupdated_enable
2652 daemon at system boot time.
2653 .It Va bsnmpd_enable
2659 daemon at system boot time.
2660 Be sure to understand the security implications of running SNMP daemon
2668 these are the flags to pass to the
2671 .It Va defaultrouter
2675 create a default route to this host name or IP address
2676 (use an IP address if this router is also required to get to the
2678 .It Va ipv6_defaultrouter
2680 The IPv6 equivalent of
2682 .It Va static_arp_pairs
2684 Set to the list of static ARP pairs that are to be added at system
2686 For each whitespace separated
2689 .Va static_arp_ Ns Aq Ar element
2690 variable is assumed to exist whose contents will later be passed to a
2695 static_arp_pairs="gw"
2696 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2698 .It Va static_ndp_pairs
2700 Set to the list of static NDP pairs that are to be added at system
2702 For each whitespace separated
2705 .Va static_ndp_ Ns Aq Ar element
2706 variable is assumed to exist whose contents will later be passed to a
2711 static_ndp_pairs="gw"
2712 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2714 .It Va static_routes
2716 Set to the list of static routes that are to be added at system
2720 then for each whitespace separated
2723 .Va route_ Ns Aq Ar element
2724 variable is assumed to exist
2725 whose contents will later be passed to a
2730 static_routes="ext mcast:gif0 gif0local:gif0"
2731 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2732 route_mcast="-net 224.0.0.0/4 -iface gif0"
2733 route_gif0local="-host 169.254.1.1 -iface lo0"
2740 the route is specific to the interface
2742 .It Va ipv6_static_routes
2744 The IPv6 equivalent of
2748 then for each whitespace separated
2751 .Va ipv6_route_ Ns Aq Ar element
2752 variable is assumed to exist
2753 whose contents will later be passed to a
2754 .Dq Nm route Cm add Fl inet6
2756 .It Va gateway_enable
2760 configure host to act as an IP router, e.g.\& to forward packets
2762 .It Va ipv6_gateway_enable
2764 The IPv6 equivalent of
2765 .Va gateway_enable .
2766 .It Va routed_enable
2770 run a routing daemon of some sort, based on the
2775 .It Va route6d_enable
2777 The IPv6 equivalent of
2781 run a routing daemon of some sort, based on the
2786 .It Va routed_program
2792 this is the name of the routing daemon to use.
2793 .It Va route6d_program
2795 The IPv6 equivalent of
2796 .Va routed_program .
2803 these are the flags to pass to the routing daemon.
2804 .It Va route6d_flags
2806 The IPv6 equivalent of
2808 .It Va rtadvd_enable
2814 daemon at boot time.
2817 utility sends ICMPv6 Router Advertisement messages to
2818 the interfaces specified in
2819 .Va rtadvd_interfaces .
2820 This should only be enabled with great care.
2821 You may want to fine-tune
2823 .It Va rtadvd_interfaces
2829 this is the list of interfaces to use.
2834 enable global proxy ARP.
2835 .It Va forward_sourceroute
2843 source-routed packets are forwarded.
2844 .It Va accept_sourceroute
2848 the system will accept source-routed packets directed at it.
2855 daemon at system boot time.
2862 these are the flags to pass to the
2865 .It Va bootparamd_enable
2871 daemon at system boot time.
2872 .It Va bootparamd_flags
2875 .Va bootparamd_enable
2878 these are the flags to pass to the
2881 .It Va stf_interface_ipv4addr
2885 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2887 Specify this entry to enable the 6to4 interface.
2888 .It Va stf_interface_ipv4plen
2890 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2891 An effective value is 0-31.
2892 .It Va stf_interface_ipv6_ifid
2894 IPv6 interface ID for
2898 .It Va stf_interface_ipv6_slaid
2900 IPv6 Site Level Aggregator for
2902 .It Va ipv6_ipv4mapping
2906 this enables IPv4 mapped IPv6 address communication (like
2907 .Li ::ffff:a.b.c.d ) .
2908 .It Va rtsold_enable
2914 daemon to send ICMPv6 Router Solicitation messages.
2921 these are the flags to pass to
2925 For interfaces configured with the
2926 .Dq Li inet6 accept_rtadv
2927 keyword, these are the flags to pass to
2932 is mutually exclusive to
2938 The keyboard bell sound.
2945 if the default behavior is desired.
2946 For details, refer to the
2951 If set to a non-null string, the virtual console's keyboard input is
2957 no keymap is installed, otherwise the value is used to install
2958 the keymap file found in
2959 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
2962 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
2967 The keyboard repeat speed.
2974 if the default behavior is desired.
2979 attempt to program the function keys with the value.
2981 be a single string of the form:
2982 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2985 Can be set to the value of
2988 .Dq Li destructive ,
2991 to set the cursor behavior explicitly or choose the default behavior.
2996 no screen map is installed, otherwise the value is used to install
2997 the screen map file in
2998 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2999 This parameter is ignored when using
3001 as the console driver.
3006 the default 8x16 font value is used for screen size requests, otherwise
3008 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3010 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3011 is used (depending on the console driver being used).
3016 the default 8x14 font value is used for screen size requests, otherwise
3018 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3020 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3021 is used (depending on the console driver being used).
3026 the default 8x8 font value is used for screen size requests, otherwise
3028 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3030 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3031 is used (depending on the console driver being used).
3036 the default screen blanking interval is used, otherwise it is set
3044 this is the actual screen saver to use
3045 .Li ( blank , snake , daemon ,
3047 .It Va moused_nondefault_enable
3051 the mouse device specified on
3052 the command line is not automatically treated as enabled by the
3053 .Pa /etc/rc.d/moused
3055 Having this variable set to
3061 to be enabled as soon as it is plugged in.
3062 .It Va moused_enable
3068 daemon is started for doing cut/paste selection on the console.
3071 This is the protocol type of the mouse connected to this host.
3072 This variable must be set if
3079 is able to detect the appropriate mouse type automatically in many cases.
3080 Set this variable to
3082 to let the daemon detect it, or
3083 select one from the following list if the automatic detection fails.
3085 If the mouse is attached to the PS/2 mouse port, choose
3089 regardless of the brand and model of the mouse.
3091 mouse is attached to the bus mouse port, choose
3095 All other protocols are for serial mice and will not work with
3096 the PS/2 and bus mice.
3097 If this is a USB mouse,
3099 is the only protocol type which will work.
3101 .Bl -tag -width ".Li x10mouseremote" -compact
3103 Microsoft mouse (serial)
3105 Microsoft IntelliMouse (serial)
3107 Mouse systems Corp.\& mouse (serial)
3109 MM Series mouse (serial)
3111 Logitech mouse (serial)
3115 Logitech MouseMan and TrackMan (serial)
3117 ALPS GlidePoint (serial)
3118 .It Li thinkingmouse
3119 Kensington ThinkingMouse (serial)
3123 MM HitTablet (serial)
3124 .It Li x10mouseremote
3125 X10 MouseRemote (serial)
3127 Interlink VersaPad (serial)
3130 Even if the mouse is not in the above list, it may be compatible
3131 with one in the list.
3132 Refer to the manual page for
3134 for compatibility information.
3136 It should also be noted that while this is enabled, any
3137 other client of the mouse (such as an X server) should access
3138 the mouse through the virtual mouse device,
3140 and configure it as a
3142 type mouse, since all
3143 mouse data is converted to this single canonical format when
3146 If the client program does not support the
3152 It is the second preferred type.
3159 this is the actual port the mouse is on.
3162 for a COM1 serial mouse,
3166 for a bus mouse, for example.
3171 is set, its value is used as an additional set of flags to pass to the
3174 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3176 .Va moused_nondefault_enable
3179 daemon is started for a non-default port, the
3180 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3181 set of options has precedence over and replaces the default
3185 is the name of the non-default port, i.e.,\&
3188 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3189 it is possible to set up a different set of default flags for each
3192 For example, you can use
3196 to make your laptop's touchpad more comfortable to use,
3197 but an empty set of options for
3198 .Va moused_ums0_flags
3201 mouse has three or more buttons.
3202 .It Va mousechar_start
3206 the default mouse cursor character range
3207 .Li 0xd0 Ns - Ns Li 0xd3
3209 otherwise the range start is set
3214 Use if the default range is occupied in the language code table.
3215 .It Va allscreens_flags
3219 is run with these options for each of the virtual terminals
3223 will enable the mouse pointer on all virtual terminals
3228 .It Va allscreens_kbdflags
3232 is run with these options for each of the virtual terminals
3240 scrollback (history) buffer to 200 lines.
3247 daemon at system boot time.
3253 .Pa /usr/sbin/cron ) .
3260 these are the flags to pass to
3266 enable the special handling of transitions to and from the
3267 Daylight Saving Time in
3269 (equivalent to using the flag
3276 .Pa /usr/sbin/lpd ) .
3283 daemon at system boot time.
3290 these are the flags to pass to the
3293 .It Va chkprintcap_enable
3299 command before starting the
3302 .It Va chkprintcap_flags
3307 .Va chkprintcap_enable
3310 these are the flags to pass to the
3315 which causes missing directories to be created.
3316 .It Va mta_start_script
3318 This variable specifies the full path to the script to run to start
3319 a mail transfer agent.
3321 .Pa /etc/rc.sendmail .
3325 .Pa /etc/rc.sendmail
3326 uses are documented in the
3331 Indicates the device (usually a swap partition) to which a crash dump
3332 should be written in the event of a system crash.
3333 If the value of this variable is
3335 the first suitable swap device listed in
3337 will be used as dump device.
3338 Otherwise, the value of this variable is passed as the argument to
3340 To disable crash dumps, set this variable to
3344 When the system reboots after a crash and a crash dump is found on the
3345 device specified by the
3349 will save that crash dump and a copy of the kernel to the directory
3353 The default value is
3364 Path to a public key.
3367 to encrypt a one-time key for a crash dump.
3368 The public key has to match a private key used by
3370 to decrypt a crash dump after reboot.
3374 .It Va savecore_enable
3378 disable automatic extraction of the crash dump from the
3380 .It Va savecore_flags
3382 If crash dumps are enabled, these are the flags to pass to the
3389 to turn on user and group disk quotas on system startup via the
3391 command for all file systems marked as having quotas enabled in
3393 The kernel must be built with
3395 for disk quotas to function.
3400 to enable user and group disk quota checking via the
3403 .It Va quotacheck_flags
3413 these are the flags to pass to the
3418 which checks quotas for all file systems with quotas enabled in
3420 .It Va quotaon_flags
3426 these are the flags to pass to the
3431 which enables quotas for all file systems with quotas enabled in
3433 .It Va quotaoff_flags
3439 these are the flags to pass to the
3441 utility when shutting down the quota system.
3444 which disables quotas for all file systems with quotas enabled in
3446 .It Va accounting_enable
3450 to enable system accounting through the
3457 to enable iBCS2 (SCO) binary emulation at system initial boot
3459 .It Va ibcs2_loaders
3467 this specifies a list of additional iBCS2 loaders to enable.
3468 .It Va firstboot_sentinel
3470 This variable specifies the full path to a
3473 If a file exists with this path,
3477 keyword will be run on startup and the sentinel file will be deleted
3478 after the boot process completes.
3479 The sentinel file must be located on a writable file system which is
3480 mounted no later than
3481 .Va early_late_divider
3482 to function properly.
3489 to enable Linux/ELF binary emulation at system initial
3491 .It Va sysvipc_enable
3495 load System V IPC primitives at boot time.
3496 .It Va clear_tmp_enable
3507 to disable removing of X11 lock files,
3508 and the removal and (secure) recreation
3509 of the various socket directories for X11
3511 .It Va ldconfig_paths
3513 Set to the list of shared library paths to use with
3517 will always be added first, so it need not appear in this list.
3518 .It Va ldconfig32_paths
3520 Set to the list of 32-bit compatibility shared library paths to
3523 .It Va ldconfig_paths_aout
3525 Set to the list of shared library paths to use with
3530 .It Va ldconfig_insecure
3534 utility normally refuses to use directories
3535 which are writable by anyone except root.
3536 Set this variable to
3538 to disable that security check during system startup.
3539 .It Va ldconfig_local_dirs
3541 Set to the list of local
3544 The names of all files in the directories listed will be
3545 passed as arguments to
3547 .It Va ldconfig_local32_dirs
3549 Set to the list of local 32-bit compatibility
3552 The names of all files in the directories listed will be
3553 passed as arguments to
3554 .Dq Nm ldconfig Fl 32 .
3555 .It Va kern_securelevel_enable
3559 to set the kernel security level at system startup.
3560 .It Va kern_securelevel
3562 The kernel security level to set at startup.
3563 The allowed range of
3565 ranges from \-1 (the compile time default) to 3 (the
3569 for the list of possible security levels and their effect
3570 on system operation.
3573 Path to the SSH server program
3574 .Pa ( /usr/sbin/sshd
3582 at system boot time.
3589 these are the flags to pass to the
3594 Path to the FTP server program
3595 .Pa ( /usr/libexec/ftpd
3603 as a stand-alone daemon at system boot time.
3610 these are the additional flags to pass to the
3613 .It Va watchdogd_enable
3619 daemon at boot time.
3620 This requires that the kernel have been compiled with a
3623 .It Va watchdogd_flags
3626 .Va watchdogd_enable
3629 these are the flags passed to the
3632 .It Va devfs_rulesets
3634 List of files containing sets of rules for
3636 .It Va devfs_system_ruleset
3638 Rule name(s) to apply to the system
3641 .It Va devfs_set_rulesets
3643 Pairs of already-mounted
3645 directories and rulesets that should be applied to them.
3646 For example: /mount/dev=ruleset_name
3647 .It Va devfs_load_rulesets
3649 If set, always load the default rulesets listed in
3650 .Va devfs_rulesets .
3651 .It Va performance_cx_lowest
3653 CPU idle state to use while on AC power.
3658 should use the lowest power state available while
3660 indicates that the lowest latency state (less power savings) should be used.
3661 .It Va performance_cpu_freq
3663 CPU clock frequency to use while on AC power.
3668 should use the lowest frequency available while
3670 indicates that the highest frequency (less power savings) should be used.
3671 .It Va economy_cx_lowest
3673 CPU idle state to use when off AC power.
3678 should use the lowest power state available while
3680 indicates that the lowest latency state (less power savings) should be used.
3681 .It Va economy_cpu_freq
3683 CPU clock frequency to use when off AC power.
3688 should use the lowest frequency available while
3690 indicates that the highest frequency (less power savings) should be used.
3695 any configured jails will not be started.
3698 The configuration filename used by
3701 The default value is
3702 .Pa /etc/jail.conf .
3703 .It Va jail_parallel_start
3707 all configured jails will be started in the background (in parallel).
3711 When set, use as default value for
3712 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3717 A space-delimited list of jail names.
3718 When left empty, all of the
3720 instances defined in the configuration file are started.
3721 The names specified in this list control the jail startup order.
3723 instances missing from
3725 must be started manually.
3728 parameter in the configuration file may override this list.
3729 .It Va jail_reverse_stop
3733 all configured jails in
3735 are stopped in reverse order.
3736 .It Va jail_* variables
3737 Note that older releases supported per-jail configuration via
3741 hostname of a jail named
3743 was able to be set by
3744 .Li jail_vjail_hostname .
3745 These per-jail configuration variables are now obsolete in favor of
3748 For backward compatibility,
3749 when per-jail configuration variables are defined,
3751 configuration files are created as
3752 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3755 The following per-jail parameters are handled by
3757 script out of their corresponding
3760 In addition to them, parameters in
3761 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3762 will be added to the configuration file.
3763 They must be a semi-colon
3771 .Bl -tag -width "host.hostname" -offset indent
3774 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3775 .It Li host.hostname
3777 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3778 .It Li exec.consolelog
3780 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3781 The default value is
3782 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3785 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3786 .It Li vnet.interface
3788 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3791 parameter will be enabled and cannot be specified with
3792 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3793 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3795 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3799 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3802 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3805 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3808 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3809 The parameter name was
3811 in some older releases.
3812 .It Li exec.prestart
3814 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3815 .It Li exec.poststart
3817 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3820 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3823 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3824 .It Li exec.poststop
3826 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3829 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3831 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3832 contain IPv4 addresses
3835 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3837 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3838 contain IPv6 addresses
3841 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3844 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3845 .It Li devfs_ruleset
3847 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3848 This must be an integer,
3850 .It Li mount.fdescfs
3852 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3853 .It Li allow.set_hostname
3855 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3856 .It Li allow.rawsocket
3858 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3859 .It Li allow.sysvipc
3861 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3863 .\" -----------------------------------------------------
3867 representing the entropy sources
3868 you wish to harvest.
3871 for more information.
3876 to disable caching entropy via
3878 Otherwise set to the directory
3879 in which the entropy files are stored.
3883 that regularly writes and rotates
3886 will be used at boot time.
3888 .Pa /var/db/entropy .
3893 to disable caching entropy through reboots.
3894 Otherwise set to the name
3895 of a file used to store cached entropy.
3896 This file should be located
3897 on a file system that is readable
3898 before all the volumes specified in
3905 .Pa /var/db/entropy-file
3906 is found it will also be used.
3907 This will be of some use to
3909 .It Va entropy_boot_file
3914 very early caching entropy
3916 Otherwise set to the filename
3918 very early reboot cached entropy.
3919 This file should be located where
3924 The default location is
3926 .It Va entropy_save_sz
3928 Size of the entropy cache files saved by
3931 .It Va entropy_save_num
3933 Number of entropy cache files to save by
3947 Configuration file for
3956 .Pa /var/run/dmesg.boot
3958 .It Va rcshutdown_timeout
3960 If set, start a watchdog timer in the background which will terminate
3964 has not completed within the specified time (in seconds).
3965 Notice that in addition to this soft timeout,
3967 also applies a hard timeout for the execution of
3969 This is configured via
3972 .Va kern.init_shutdown_timeout
3973 and defaults to 120 seconds.
3974 Setting the value of
3975 .Va rcshutdown_timeout
3976 to more than 120 seconds will have no effect until the
3979 .Va kern.init_shutdown_timeout
3981 .It Va virecover_enable
3985 to prevent the system from trying to
3986 recover pre-maturely terminated
3989 .It Va ugidfw_enable
3994 .Xr mac_bsdextended 4
3995 module upon system initialization and load a default
3997 .It Va bsdextended_script
4000 .Xr mac_bsdextended 4
4001 ruleset file to load.
4002 The default value of this variable is
4003 .Pa /etc/rc.bsdextended .
4004 .It Va newsyslog_enable
4011 .It Va newsyslog_flags
4014 .Va newsyslog_enable
4017 these are the flags to pass to the
4022 which causes log files flagged with a
4025 .It Va mdconfig_md Ns Aq Ar X
4035 must be specified and either a
4037 for malloc or swap backed
4045 .Va mdconfig_md Ns Aq Ar X
4046 variables are evaluated until one variable is unset or null.
4047 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4049 Optional arguments passed to
4055 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4057 An ownership specification passed to
4066 device and the mount point will be changed.
4067 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4069 A mode string passed to
4078 device and the mount point will be changed.
4079 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4081 Files to be copied to the mount point of the
4085 after it has been mounted.
4086 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4088 Command to execute after the specified
4093 Note that the command is passed to
4099 variables can be used to reference respectively the
4101 device and the mount point.
4106 one could set the following:
4108 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4110 .It Va autobridge_interfaces
4112 Set to the list of bridge interfaces that will have newly arriving interfaces
4113 checked against to be automatically added.
4116 then for each whitespace separated
4119 .Va autobridge_ Ns Aq Ar element
4120 variable is assumed to exist which has a whitespace separated list of interface
4121 names to match, these names can use wildcards.
4124 autobridge_interfaces="bridge0"
4125 autobridge_bridge0="tap* dc0 vlan[345]"
4131 enable support for sound mixer.
4132 .It Va hcsecd_enable
4136 enable Bluetooth security daemon.
4137 .It Va hcsecd_config
4139 Configuration file for
4142 .Pa /etc/bluetooth/hcsecd.conf .
4147 enable Bluetooth Service Discovery Protocol daemon.
4155 .It Va sdpd_groupname
4159 group to run as after it initializes.
4162 .It Va sdpd_username
4166 user to run as after it initializes.
4169 .It Va bthidd_enable
4173 enable Bluetooth Human Interface Device daemon.
4174 .It Va bthidd_config
4176 Configuration file for
4179 .Pa /etc/bluetooth/bthidd.conf .
4182 Path to a file, where
4184 will store information about known HID devices.
4186 .Pa /var/db/bthidd.hids .
4187 .It Va rfcomm_pppd_server_enable
4191 enable Bluetooth RFCOMM PPP wrapper daemon.
4192 .It Va rfcomm_pppd_server_profile
4194 The name of the profile to use from
4195 .Pa /etc/ppp/ppp.conf .
4196 Multiple profiles can be specified here.
4197 Also used to specify per-profile overrides.
4198 When the profile name contains any of the characters
4200 they are translated to
4202 for the proposes of the override variable names.
4203 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4205 Overrides local address to listen on.
4211 The address can be specified as BD_ADDR or name.
4212 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4214 Overrides local RFCOMM channel to listen on.
4217 will listen on RFCOMM channel 1.
4218 Must set properly if multiple profiles used in the same time.
4219 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4223 if it should register Serial Port service on the specified RFCOMM channel.
4226 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4230 if it should register Dial-Up Networking service on the specified
4234 .It Va ubthidhci_enable
4238 change the USB Bluetooth controller from HID mode to HCI mode.
4239 You also need to specify the location of USB Bluetooth controller with the
4240 .Va ubthidhci_busnum
4244 .It Va ubthidhci_busnum
4245 Bus number where the USB Bluetooth controller is located.
4248 on your system to find this information.
4249 .It Va ubthidhci_addr
4250 Bus address of the USB Bluetooth controller.
4253 on your system to find this information.
4254 .It Va netwait_enable
4258 delays the start of network-reliant services until
4260 is up and ICMP packets to a destination defined in
4263 Link state is examined first, followed by
4265 an IP address to verify network usability.
4266 If no destination can be reached or timeouts are exceeded,
4267 network services are started anyway with no guarantee that
4268 the network is usable.
4269 Use of this variable requires both
4277 This variable contains a space-delimited list of IP addresses to
4279 DNS hostnames should not be used as resolution is not guaranteed
4280 to be functional at this point.
4281 If multiple IP addresses are specified,
4282 each will be tried until one is successful or the list is exhausted.
4283 .It Va netwait_timeout
4285 Indicates the total number of seconds to perform a
4287 against each IP address in
4289 at a rate of one ping per second.
4290 If any of the pings are successful,
4291 full network connectivity is considered reliable.
4296 Defines the name of the network interface on which watch for link.
4298 is used to monitor the interface, looking for
4299 .Dq Li status: no carrier .
4300 Once gone, the link is considered up.
4303 interface if desired.
4304 .It Va netwait_if_timeout
4306 Defines the total number of seconds to wait for link to become usable,
4307 polled at a 1-second interval.
4315 rules from the defined ruleset.
4316 The kernel must be built with
4319 .Cd "options RCTL" .
4325 This variables contains the
4331 A space-separated list of configuration files used by
4333 The default value is an empty string.
4334 .It Va autofs_enable
4344 daemons at boot time.
4345 .It Va automount_flags
4351 these are the flags to pass to the
4354 By default no flags are passed.
4355 .It Va automountd_flags
4361 these are the flags to pass to the
4364 By default no flags are passed.
4365 .It Va autounmountd_flags
4371 these are the flags to pass to the
4374 By default no flags are passed.
4381 daemon at boot time.
4382 .It Va iscsid_enable
4388 daemon at boot time.
4389 .It Va iscsictl_enable
4395 utility at boot time.
4396 .It Va iscsictl_flags
4402 these are the flags to pass to the
4407 which configures sessions based on the
4412 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4413 .It Pa /etc/defaults/rc.conf
4415 .It Pa /etc/rc.conf.local
4446 .Xr newsyslog.conf 5 ,
4517 .An Jordan K. Hubbard .