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,
46 is not to run commands or perform system startup actions
48 Instead, it is included by the
49 various generic startup scripts in
51 which conditionalize their
52 internal actions according to the settings found there.
56 file is included from the file
57 .Pa /etc/defaults/rc.conf ,
58 which specifies the default settings for all the available options.
59 Options need only be specified in
61 when the system administrator wishes to override these defaults.
63 .Pa /etc/rc.conf.local
64 is used to override settings in
66 for historical reasons.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
73 directory, which will be included by the
76 For jail configurations you could use the file
77 .Pa /etc/rc.conf.d/jail
78 to store jail specific configuration options.
84 .Dq Ar name Ns Li = Ns Ar value
88 The following list provides a name and short description for each
89 variable that can be set in the
92 .Bl -tag -width indent-two
97 enable output of debug messages from rc scripts.
98 This variable can be helpful in diagnosing mistakes when
99 editing or integrating new scripts.
100 Beware that this produces copious output to the terminal and
106 disable informational messages from the rc scripts.
107 Informational messages are displayed when
108 a condition that is not serious enough to warrant a warning or
116 when faststart is used (e.g., at boot time).
117 .It Va early_late_divider
119 The name of the script that should be used as the
120 delimiter between the
124 stages of the boot process.
125 The early stage should contain all the services needed to
126 get the disks (local or remote) mounted so that the late
127 stage can include scripts contained in the directories
130 variable (see below).
131 Thus, the two likely candidates for this value are
133 for the typical system, and
135 if the system needs remote file
136 systems mounted to get access to the
138 directories; for example when
146 is likely to be an appropriate value.
147 Extreme care should be taken when changing this value,
148 and before changing it one should ensure that there are
149 adequate provisions to recover from a failed boot
150 (such as physical contact with the machine,
151 or reliable remote console access).
156 no swapfile is installed, otherwise the value is used as the full
157 pathname to a file to use for additional swap space.
162 enable support for Automatic Power Management with
170 to handle APM event from userland.
171 This also enables support for APM.
178 these are the flags to pass to the
185 to handle device added, removed or unknown events from the kernel.
192 scripts at boot time.
195 Configuration file for
201 A list of kernel modules to load right after the local
203 Loading modules at this point in the boot process is
204 much faster than doing it via
205 .Pa /boot/loader.conf
206 for those modules not necessary for mounting local disk.
207 .It Va kldxref_enable
214 to automatically rebuild
219 .It Va kldxref_clobber
229 will overwrite existing
236 .It Va kldxref_module_path
241 delimited list of paths containing
253 enable the system power control facility with the
262 these are the flags to pass to the
266 Controls the creation of a
269 Always happens if set to
271 and never happens if set to
273 If set to anything else, a memory file system is created if
277 Controls the size of a created
281 Extra options passed to the
283 utility when the memory file system for
288 which inhibits the use of softupdates on
290 so that file system space is freed without delay
291 after file truncation or deletion.
294 for other options you can use in
297 Controls the creation of a
300 Always happens if set to
302 and never happens if set to
304 If set to anything else, a memory file system is created if
308 Controls the size of a created
312 Extra options passed to the
314 utility when the memory file system for
319 which inhibits the use of softupdates on
321 so that file system space is freed without delay
322 after file truncation or deletion.
325 for other options you can use in
328 Controls the automatic population of the
331 Always happens if set to
333 and never happens if set to
335 If set to anything else, a memory file system is created if
338 Note that this process requires access to certain commands in
342 is mounted on normal systems.
343 .It Va cleanvar_enable
350 List of directories to search for startup script files.
351 .It Va script_name_sep
353 The field separator to use for breaking down the list of startup script files
354 into individual filenames.
355 The default is a space.
356 It is not necessary to change this unless there are startup scripts with names
358 .It Va hostapd_enable
367 The fully qualified domain name (FQDN) of this host on the network.
368 This should almost certainly be set to something meaningful, even if
369 there is no network connection.
372 is used to set the hostname via DHCP,
373 this variable should be set to an empty string.
374 If this value remains unset when the system is done booting
375 your console login will display the default hostname of
379 The NIS domain name of this host, or
382 .It Va dhclient_program
384 Path to the DHCP client program
385 .Pa ( /sbin/dhclient ,
390 .It Va dhclient_flags
392 Additional flags to pass to the DHCP client program.
397 manpage for a description of the command line options available.
398 .It Va dhclient_flags_ Ns Aq Ar iface
399 Additional flags to pass to the DHCP client program running on
402 When specified, this variable overrides
404 .It Va background_dhclient
408 to start the DHCP client in background.
409 This can cause trouble with applications depending on
410 a working network, but it will provide a faster startup
412 .It Va background_dhclient_ Ns Aq Ar iface
413 When specified, this variable overrides the
414 .Va background_dhclient
415 variable for interface
418 .It Va synchronous_dhclient
424 synchronously at startup.
425 This behavior can be overridden on a per-interface basis by replacing
429 .Va ifconfig_ Ns Aq Ar interface
434 .It Va defaultroute_delay
436 When set to a positive value, wait up to this long after configuring
437 DHCP interfaces at startup to give the interfaces time to receive a lease.
438 .It Va firewall_enable
442 to load firewall rules at startup.
443 If the kernel was not built with
444 .Cd "options IPFIREWALL" ,
447 kernel module will be loaded.
449 .Va ipfilter_enable .
450 .It Va firewall_script
452 This variable specifies the full path to the firewall script to run.
454 .Pa /etc/rc.firewall .
457 Names the firewall type from the selection in
458 .Pa /etc/rc.firewall ,
459 or the file which contains the local firewall ruleset.
460 Valid selections from
464 .Bl -tag -width ".Li simple" -compact
466 unrestricted IP access
468 all IP services disabled, except via
471 basic protection for a workstation
473 basic protection for a LAN.
476 If a filename is specified, the full path
478 .It Va firewall_quiet
482 to disable the display of firewall rules on the console during boot.
483 .It Va firewall_logging
487 to enable firewall event logging.
488 This is equivalent to the
489 .Dv IPFIREWALL_VERBOSE
491 .It Va firewall_flags
497 specifies a filename.
498 .It Va firewall_coscripts
500 List of executables and/or rc scripts to run after firewall starts/stops.
502 .\" ----- firewall_nat_enable setting --------------------------------
503 .It Va firewall_nat_enable
515 .It Va firewall_nat_interface
521 This is the name of the public interface or IP address on which
522 kernel NAT should run.
523 .It Va firewall_nat_flags
525 Additional configuration parameters for kernel NAT should be placed here.
526 .It Va dummynet_enable
530 will automatically load the
536 .\" -------------------------------------------------------------------
552 sockets must be enabled in the kernel.
553 If the kernel was not built with
554 .Cd "options IPDIVERT" ,
557 kernel module will be loaded.
558 .It Va natd_interface
560 This is the name of the public interface on which
563 The interface may be given as an interface name or as an IP address.
568 flags should be placed here.
573 flag is automatically added with the above
576 .\" ----- ipfilter_enable setting --------------------------------
577 .It Va ipfilter_enable
588 Typical usage will require putting
590 ipfilter_enable="YES"
608 can be enabled independently.
612 both require at least one of
622 options IPFILTER_DEFAULT_BLOCK
625 in the kernel configuration file is a good idea, too.
626 .\" ----- ipfilter_program setting ------------------------------
627 .It Va ipfilter_program
633 .\" ----- ipfilter_rules setting --------------------------------
634 .It Va ipfilter_rules
639 This variable contains the name of the filter rule definition file.
640 The file is expected to be readable for the
643 .\" ----- ipv6_ipfilter_rules setting ---------------------------
644 .It Va ipv6_ipfilter_rules
649 This variable contains the IPv6 filter rule definition file.
650 The file is expected to be readable for the
653 .\" ----- ipfilter_flags setting --------------------------------
654 .It Va ipfilter_flags
657 This variable contains flags passed to the
660 .\" ----- ipnat_enable setting ----------------------------------
670 network address translation.
673 for a detailed discussion.
674 .\" ----- ipnat_program setting ---------------------------------
681 .\" ----- ipnat_rules setting -----------------------------------
687 This variable contains the name of the file
688 holding the network address translation definition.
689 This file is expected to be readable for the
692 .\" ----- ipnat_flags setting -----------------------------------
696 This variable contains flags passed to the
699 .\" ----- ipmon_enable setting ----------------------------------
714 Setting this variable needs setting
721 for a detailed discussion.
722 .\" ----- ipmon_program setting ---------------------------------
729 .\" ----- ipmon_flags setting -----------------------------------
735 This variable contains flags passed to the
738 Another typical example would be
739 .Dq Fl D Pa /var/log/ipflog
742 log directly to a file bypassing
745 .Pa /etc/newsyslog.conf
746 in such case like this:
748 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
750 .\" ----- ipfs_enable setting -----------------------------------
760 saving the filter and NAT state tables during shutdown
761 and reloading them during startup again.
762 Setting this variable needs setting
771 for a detailed discussion.
777 because the raised securelevel will prevent
779 from saving the state tables at shutdown time.
780 .\" ----- ipfs_program setting ----------------------------------
787 .\" ----- ipfs_flags setting ------------------------------------
791 This variable contains flags passed to the
794 .\" ----- end of added ipf hook ---------------------------------
806 Typical usage will require putting
821 into the kernel, otherwise the
822 kernel module will be loaded.
827 ruleset configuration file
842 these flags are passed to the
844 program when loading the ruleset.
854 which logs packets from the
867 .Pa /var/log/pflog ) .
869 .Pa /etc/newsyslog.conf
870 to adjust logfile rotation for this.
880 This variable contains additional flags passed to the
883 .It Va ftpproxy_enable
894 packet filter in translating ftp connections.
895 .It Va ftpproxy_flags
898 This variable contains additional flags passed to the
910 state changes to other hosts over the network by means of
915 must also be set then.
916 .It Va pfsync_syncdev
919 This variable specifies the name of the network interface
921 should operate through.
922 It must be set accordingly if
926 .It Va pfsync_syncpeer
929 This variable is optional.
930 By default, state change messages are sent out on the synchronisation
931 interface using IP multicast packets.
932 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
934 When a peer address is specified using the
936 option, the peer address is used as a destination for the pfsync
937 traffic, and the traffic can then be protected using
941 manpage for more details about using
946 .It Va pfsync_ifconfig
949 This variable can contain additional options to be passed to the
951 command used to set up
953 .It Va tcp_extensions
960 disables certain TCP options as described by
966 might help remedy such problems with connections as randomly hanging
967 or other weird behavior.
968 Some network devices are known
969 to be broken with respect to these options.
976 .Va net.inet.tcp.log_in_vain
978 .Va net.inet.udp.log_in_vain ,
983 are set to the given value.
991 will disable probing idle TCP connections to verify that the
992 peer is still up and reachable.
993 .It Va tcp_drop_synfin
1000 will cause the kernel to ignore TCP frames that have both
1001 the SYN and FIN flags set.
1002 This prevents OS fingerprinting, but may
1003 break some legitimate applications.
1004 .It Va icmp_drop_redirect
1011 will cause the kernel to ignore ICMP REDIRECT packets.
1014 for more information.
1015 .It Va icmp_log_redirect
1022 will cause the kernel to log ICMP REDIRECT packets.
1024 the log messages are not rate-limited, so this option should only be used
1025 for troubleshooting networks.
1028 for more information.
1029 .It Va icmp_bmcastecho
1033 to respond to broadcast or multicast ICMP ping packets.
1036 for more information.
1037 .It Va ip_portrange_first
1041 this is the first port in the default portrange.
1044 for more information.
1045 .It Va ip_portrange_last
1049 this is the last port in the default portrange.
1052 for more information.
1053 .It Va network_interfaces
1055 Set to the list of network interfaces to configure on this host or
1057 (the default) for all current interfaces.
1059 .Va network_interfaces
1060 variable to anything other than the default is deprecated.
1061 Interfaces that the administrator wishes to store configuration for,
1062 but not start at boot should be configured with the
1065 .Va ifconfig_ Ns Aq Ar interface
1066 variables as described below.
1069 .Va ifconfig_ Ns Aq Ar interface
1070 variable is also assumed to exist for each value of
1072 When an interface name contains any of the characters
1074 they are translated to
1077 The variable can contain arguments to
1079 as well as special case-insensitive keywords described below.
1080 Such keywords are removed before passing the value to
1082 while the order of the other arguments is preserved.
1084 One can configure more than one IPv4 address with the
1085 .Va ipv4_addrs_ Ns Aq Ar interface
1087 One or more IP addresses must be provided in Classless Inter-Domain
1088 Routing (CIDR) address notation, whose last byte can be a range like
1090 In this case the address 192.0.2.5 will be configured with the
1091 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1092 the non-conflicting netmask /32 as explained in the
1095 With the interface in question being
1097 an example could look like:
1099 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1102 It is also possible to add IP alias entries using
1107 Assuming that the interface in question was
1110 something like this:
1112 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1113 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1118 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1121 keyword that is found,
1122 its contents are passed to
1124 Execution stops at the first unsuccessful access, so if
1125 something like this is present:
1127 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1128 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1129 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1130 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1133 Then note that alias4 would
1135 be added since the search would
1136 stop with the missing
1139 Due to this difficult to manage behavior, the
1140 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1144 .Pa /etc/start_if. Ns Aq Ar interface
1145 file is present, it is read and executed by the
1148 before configuring the interface as specified in the
1149 .Va ifconfig_ Ns Aq Ar interface
1151 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1155 .Va vlans_ Ns Aq Ar interface
1159 interface will be created for each item in the list with the
1163 If a vlan interface's name is a number,
1164 then that number is used as the vlan tag and the new vlan interface is
1166 .Ar interface . Ns Ar tag .
1168 the vlan tag must be specified via a
1171 .Va create_args_ Ns Aq Ar interface
1174 To create a vlan device named
1178 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1181 ifconfig_em0_101="inet 192.0.2.1/24"
1184 To create a vlan device named
1188 with the vlan tag 102:
1191 create_args_myvlan="vlan 102"
1195 .Va wlans_ Ns Aq Ar interface
1199 interface will be created for each item in the list with the
1203 Further wlan cloning arguments may be passed to the
1206 command by setting the
1207 .Va create_args_ Ns Aq Ar interface
1211 devices must be created for each wireless devices as of
1217 may be specified with an
1218 .Va wlandebug_ Ns Aq Ar interface
1220 The contents of this variable will be passed directly to
1224 .Va ifconfig_ Ns Aq Ar interface
1225 contains the keyword
1227 then the interface will not be configured
1229 .Pa /etc/pccard_ether
1231 .Va network_interfaces
1235 It is possible to bring up an interface with DHCP by adding
1238 .Va ifconfig_ Ns Aq Ar interface
1240 For instance, to initialize the
1243 it is possible to use something like:
1248 Also, if you want to configure your wireless interface with
1249 .Xr wpa_supplicant 8
1250 for use with WPA, EAP/LEAP or WEP, you need to add
1253 .Va ifconfig_ Ns Aq Ar interface
1256 Finally, you can add
1258 options in this variable, in addition to the
1259 .Pa /etc/start_if. Ns Aq Ar interface
1261 For instance, to configure an
1263 wireless device in station mode with an address obtained
1264 via DHCP, using WPA authentication and 802.11b mode, it is
1265 possible to use something like:
1268 ifconfig_wlan0="DHCP WPA mode 11b"
1272 .Va ifconfig_ Ns Aq Ar interface
1273 form, a fallback variable
1274 .Va ifconfig_DEFAULT
1276 It will be used for all interfaces with no
1277 .Va ifconfig_ Ns Aq Ar interface
1279 This is intended to replace the no longer supported
1283 It is also possible to rename an interface by doing:
1285 ifconfig_ed0_name="net0"
1286 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1289 This variable is deprecated.
1291 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1293 .Va ipv6_activate_all_interfaces
1299 .Dq Li inet6 accept_rtadv
1301 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1303 .Va ipv6_activate_all_interfaces
1307 This variable is deprecated.
1309 .Va ip6addrctl_policy
1315 the default address selection policy table set by
1317 will be IPv6-preferred.
1321 the default address selection policy table set by
1323 will be IPv4-preferred.
1324 .It Va ipv6_activate_all_interfaces
1326 This controls initial configuration on IPv6-capable
1327 interfaces with no corresponding
1328 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1330 Note that it is not always necessary to set this variable to
1332 to use IPv6 functionality on
1334 In most cases, just configuring
1335 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1340 all interfaces which do not have a corresponding
1341 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1342 variable will be marked as
1345 This means that all of IPv6 functionality on that interface
1346 is completely disabled to enforce a security policy.
1347 If the variable is set to
1349 the flag will be cleared on all of the interfaces.
1351 In most cases, just defining an
1352 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1353 for an IPv6-capable interface should be sufficient.
1354 However, if an interface is added dynamically
1355 .Pq by some tunneling protocols such as PPP, for example ,
1356 it is often difficult to define the variable in advance.
1357 In such a case, configuring the
1359 flag can be disabled by setting this variable to
1362 For more details of the
1365 .Dq Li inet6 ifdisabled ,
1375 privacy addresses will be generated for each IPv6
1376 interface as described in RFC 4941.
1377 .It Va ipv6_network_interfaces
1379 This is the IPv6 equivalent of
1380 .Va network_interfaces .
1381 Normally manual configuration of this variable is not needed.
1383 .It Va ipv6_cpe_wanif
1385 If the variable is set to an interface name,
1389 .Dq inet6 -no_radr accept_rtadv
1390 will be added to the specified interface automatically before evaluating
1391 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1395 .Va net.inet6.ip6.rfc6204w3
1397 .Va net.inet6.ip6.no_radr
1400 This means the specified interface will accept ICMPv6 Router
1401 Advertisement messages on that link and add the discovered
1402 routers into the Default Router List.
1403 While the other interfaces can still accept RA messages if the
1404 .Dq inet6 accept_rtadv
1405 option is specified, adding
1406 routes into the Default Router List will be disabled by
1413 Note that ICMPv6 Router Advertisement messages will be
1415 .Va net.inet6.ip6.forwarding
1417 .Pq packet fowarding is enabled
1419 .Va net.inet6.ip6.rfc6204w3
1424 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1426 IPv6 functionality on an interface should be configured by
1427 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1428 instead of setting ifconfig parameters in
1429 .Va ifconfig_ Ns Aq Ar interface .
1430 If this variable is empty, all of IPv6 configurations on the
1431 specified interface by other variables such as
1432 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1435 Aliases should be set by
1436 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1439 keyword. For example:
1441 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1442 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1445 Interfaces that have an
1446 .Dq Li inet6 accept_rtadv
1448 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1449 setting will be automatically configured by SLAAC
1450 .Pq StateLess Address AutoConfiguration
1456 Note that a link-local address will be automatically configured in
1457 addition to the configured global-scope addresses because the IPv6
1458 specifications require it on each link.
1459 The address is calculated from the MAC address by using an algorithm
1466 If only a link-local address is needed on the interface,
1467 the following configuration can be used:
1469 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1472 A link-local address can also be configured manually.
1473 This is useful for the default router address of an IPv6 router
1474 so that it does not change when the network interface
1478 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1480 .It Va ipv6_prefix_ Ns Aq Ar interface
1482 If one or more prefixes are defined in
1483 .Va ipv6_prefix_ Ns Aq Ar interface
1484 addresses based on each prefix and the EUI-64 interface index will be
1485 configured on that interface.
1486 Note that this variable will be ignored when
1487 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1490 For example, the following configuration
1492 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1495 is equivalent to the following:
1497 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1498 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1499 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1500 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1503 These Subnet-Router anycast addresses will be added only when
1504 .Va ipv6_gateway_enable
1506 .It Va ipv6_default_interface
1510 this is the default output interface for scoped addresses.
1511 This works only with ipv6_gateway_enable="NO".
1512 .It Va ip6addrctl_enable
1514 This variable is to enable configuring default address selection policy table
1516 The table can be specified in another variable
1517 .Va ip6addrctl_policy .
1519 .Va ip6addrctl_policy
1520 the following keywords can be specified:
1521 .Dq Li ipv4_prefer ,
1522 .Dq Li ipv6_prefer ,
1532 installs a pre-defined policy table described in Section 2.1
1540 is specified, it attempts to read a file
1541 .Pa /etc/ip6addrctl.conf
1542 first. If this file is found,
1544 reads and installs it. If not found, a policy is automatically set
1546 .Va ipv6_activate_all_interfaces
1547 variable; if the variable is set to
1549 the IPv6-preferred one is used. Otherwise IPv4-preferred.
1551 The default value of
1552 .Va ip6addrctl_enable
1554 .Va ip6addrctl_policy
1560 .It Va cloned_interfaces
1562 Set to the list of clonable network interfaces to create on this host.
1563 Further cloning arguments may be passed to the
1566 command for each interface by setting the
1567 .Va create_args_ Ns Aq Ar interface
1570 .Va cloned_interfaces
1571 are automatically appended to
1572 .Va network_interfaces
1574 .It Va fec_interfaces
1578 Fast EtherChannel interfaces to configure on this host.
1580 .Va fecconfig_ Ns Aq Ar interface
1581 variable is assumed to exist for each value of
1583 The value of this variable is used to configure link aggregated interfaces
1584 according to the syntax of the
1585 .Cm NGM_FEC_ADD_IFACE
1589 Additionally, this option ensures that each listed interface is created
1594 before attempting to configure it.
1597 fec_interfaces="fec0"
1598 fecconfig_fec0="em0 em1"
1599 ifconfig_fec0="DHCP"
1601 .It Va gif_interfaces
1605 tunnel interfaces to configure on this host.
1607 .Va gifconfig_ Ns Aq Ar interface
1608 variable is assumed to exist for each value of
1610 The value of this variable is used to configure the link layer of the
1611 tunnel according to the syntax of the
1615 Additionally, this option ensures that each listed interface is created
1620 before attempting to configure it.
1621 .It Va sppp_interfaces
1625 interfaces to configure on this host.
1627 .Va spppconfig_ Ns Aq Ar interface
1628 variable is assumed to exist for each value of
1630 Each interface should also be configured by a general
1631 .Va ifconfig_ Ns Aq Ar interface
1635 for more information about available options.
1645 The name of the profile to use from
1646 .Pa /etc/ppp/ppp.conf .
1647 Also used for per-profile overrides of
1652 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1653 When the profile name contains any of the characters
1655 they are translated to
1657 for the proposes of the override variable names.
1660 Mode in which to run the
1663 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1665 Overrides the global
1675 See the manual for a full description.
1680 enables network address translation.
1681 Used in conjunction with
1683 allows hosts on private network addresses access to the Internet using
1684 this host as a network address translating router.
1685 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1687 Overrides the global
1691 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1693 Set the unit number to be used for this profile.
1694 See the manual description of
1699 The name of the user under which
1707 .It Va rc_conf_files
1709 This option is used to specify a list of files that will override
1711 .Pa /etc/defaults/rc.conf .
1712 The files will be read in the order in which they are specified and should
1713 include the full path to the file.
1714 By default, the files specified are
1717 .Pa /etc/rc.conf.local
1723 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1725 .It Va gptboot_enable
1729 .Pa /etc/rc.d/gptboot
1730 will log if the system successfully (or not) booted from a GPT partition,
1736 .It Va gbde_autoattach_all
1741 will attempt to automatically initialize your .bde devices in
1745 List the devices that the script should try to attach,
1750 The directory where the
1752 lockfiles are located.
1753 The default lockfile directory is
1756 The lockfile for each individual
1758 device can be overridden by setting the variable
1759 .Va gbde_lock_ Ns Aq Ar device ,
1762 is the encrypted device without the
1767 .It Va gbde_attach_attempts
1769 Number of times to attempt attaching to a
1771 device, i.e., how many times the user is asked for the pass-phrase.
1775 List of devices to automatically attach on boot.
1776 Note that .eli devices from
1778 are automatically appended to this list.
1781 Number of times user is asked for the pass-phrase.
1782 If empty, it will be taken from
1783 .Va kern.geom.eli.tries
1785 .It Va geli_default_flags
1787 Default flags to use by
1789 when configuring disk encryption.
1790 Flags can be configured for every device separately by defining
1791 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1793 .It Va geli_autodetach
1795 Specifies if GELI devices should be marked for detach on last close after
1796 file systems are mounted.
1799 This can be changed for every device separately by defining
1800 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1802 .It Va geli_swap_flags
1803 Options passed to the
1805 utility when encrypted GEOM providers for swap partitions are created.
1807 .Dq Li "-e aes -l 256 -s 4096 -d" .
1808 .It Va root_rw_mount
1813 After the file systems are checked at boot time, the root file system
1814 is remounted as read-write if this is set to
1816 Diskless systems that mount their root file system from a read-only remote
1817 NFS share should set this to
1821 .It Va fsck_y_enable
1826 will be run with the
1828 flag if the initial preen
1829 of the file systems fails.
1830 .It Va background_fsck
1834 the system will attempt to run
1836 in the background where possible.
1837 .It Va background_fsck_delay
1839 The amount of time in seconds to sleep before starting a background
1841 It defaults to sixty seconds to allow large applications such as
1842 the X server to start before disk I/O bandwidth is monopolized by
1844 If set to a negative number, the background file system check will be
1845 delayed indefinitely to allow the administrator to run it at a more
1847 For example it may be run from
1849 by adding a line like
1851 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1857 List of file system types that are network-based.
1858 This list should generally not be modified by end users.
1860 .Va extra_netfs_types
1862 .It Va extra_netfs_types
1864 If set to something other than
1867 this variable extends the list of file system types
1868 for which automatic mounting at startup by
1870 should be delayed until the network is initialized.
1872 a whitespace-separated list of network file system descriptor pairs,
1873 each consisting of a file system type as passed to
1875 and a human-readable, one-word description,
1878 Extending the default list in this way is only necessary
1879 when third party file system types are used.
1880 .It Va syslogd_enable
1887 .It Va syslogd_program
1892 .Pa /usr/sbin/syslogd ) .
1893 .It Va syslogd_flags
1899 these are the flags to pass to
1908 .It Va inetd_program
1913 .Pa /usr/sbin/inetd ) .
1920 these are the flags to pass to
1929 .It Va hastd_program
1941 these are the flags to pass to
1950 .It Va named_program
1955 .Pa /usr/sbin/named ) .
1960 configuration file, (default
1961 .Pa /etc/namedb/named.conf ) .
1968 these are the flags to pass to
1974 process should be run as.
1975 .It Va named_chrootdir
1977 The root directory for a name server run in a
1979 environment (default
1983 will not be run in a
1986 .It Va named_chroot_autoupdate
1990 to disable automatic update of the
1993 .It Va named_symlink_enable
1997 to disable symlinking of
2006 loop until working name service is established.
2007 .It Va named_wait_host
2009 Name of host to lookup for the named_wait option.
2011 .It Va named_auto_forward
2013 Set to enable automatic creation of a forwarder
2014 configuration file derived from
2015 .Pa /etc/resolv.conf .
2016 .It Va named_auto_forward_only
2018 Set to change the default forwarder configuration from
2022 .It Va kerberos5_server_enable
2026 to start a Kerberos 5 authentication server
2028 .It Va kerberos5_server
2031 .Va kerberos5_server_enable
2034 this is the path to Kerberos 5 Authentication Server.
2035 .It Va kerberos5_server_flags
2038 This variable contains additional flags to be passed to the Kerberos 5
2039 authentication server.
2040 .It Va kadmind5_server_enable
2046 the Kerberos 5 Administration Daemon; set to
2049 .It Va kadmind5_server
2052 .Va kadmind5_server_enable
2055 this is the path to Kerberos 5 Administration Daemon.
2056 .It Va kpasswdd_server_enable
2062 the Kerberos 5 Password-Changing Daemon; set to
2065 .It Va kpasswdd_server
2068 .Va kpasswdd_server_enable
2071 this is the path to Kerberos 5 Password-Changing Daemon.
2078 daemon at boot time.
2085 these are the flags to pass to it.
2092 daemon at boot time.
2099 these are the flags to pass to it.
2102 manpage for more information.
2103 .It Va amd_map_program
2106 the specified program is run to get the list of
2111 maps are stored in NIS, one can set this to
2124 will be updated at boot time to reflect the kernel release
2129 will not be updated.
2130 .It Va nfs_client_enable
2134 run the NFS client daemons at boot time.
2135 .It Va nfs_access_cache
2138 .Va nfs_client_enable
2143 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2145 results should be cached.
2146 A value of 2-10 seconds will substantially reduce network
2147 traffic for many NFS operations.
2148 .It Va nfs_server_enable
2152 run the NFS server daemons at boot time.
2153 .It Va nfs_server_flags
2156 .Va nfs_server_enable
2159 these are the flags to pass to the
2162 .It Va nfsv4_server_enable
2165 .Va nfs_server_enable
2169 .Va nfsv4_server_enable
2172 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2173 .It Va nfsuserd_enable
2179 run the nfsuserd daemon, which is needed for NFSv4 in order
2180 to map between user/group names vs uid/gid numbers.
2182 .Va nfsv4_server_enable
2185 this will be forced enabled.
2186 .It Va nfsuserd_flags
2192 these are the flags to pass to the
2195 .It Va nfscbd_enable
2201 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2208 these are the flags to pass to the
2211 .It Va oldnfs_server_enable
2214 .Va oldnfs_server_enable
2217 force the NFS server daemons to run the old NFS server code
2218 that does not support NFSv4.
2219 .It Va mountd_enable
2224 .Va nfs_server_enable
2230 It is commonly needed to run CFS without real NFS used.
2237 these are the flags to pass to the
2240 .It Va weak_mountd_authentication
2244 allow services like PCNFSD to make non-privileged mount
2246 .It Va nfs_reserved_port_only
2250 provide NFS services only on a secure port.
2251 .It Va nfs_bufpackets
2253 If set to a number, indicates the number of packets worth of
2254 socket buffer space to reserve on an NFS client.
2255 The kernel default is typically 4.
2256 Using a higher number may be
2257 useful on gigabit networks to improve performance.
2258 The minimum value is
2259 2 and the maximum is 64.
2260 .It Va rpc_lockd_enable
2264 and also an NFS server or client, run
2267 .It Va rpc_lockd_flags
2270 .Va rpc_lockd_enable
2273 these are the flags to pass to the
2276 .It Va rpc_statd_enable
2280 and also an NFS server or client, run
2283 .It Va rpc_statd_flags
2286 .Va rpc_statd_enable
2289 these are the flags to pass to the
2292 .It Va rpcbind_program
2297 .Pa /usr/sbin/rpcbind ) .
2298 .It Va rpcbind_enable
2304 service at boot time.
2305 .It Va rpcbind_flags
2311 these are the flags to pass to the
2314 .It Va keyserv_enable
2320 daemon on boot for running Secure RPC.
2321 .It Va keyserv_flags
2327 these are the flags to pass to
2330 .It Va pppoed_enable
2336 daemon at boot time to provide PPP over Ethernet services.
2337 .It Va pppoed_ Ns Aq Ar provider
2340 listens to requests to this
2346 argument of the same name.
2349 Additional flags to pass to
2351 .It Va pppoed_interface
2353 The network interface to run
2356 This is mandatory when
2366 service at boot time.
2367 This command is intended for networks of
2368 machines where a consistent
2370 for all hosts must be established.
2371 This is often useful in large NFS
2372 environments where time stamps on files are expected to be consistent
2380 these are the flags to pass to the
2383 .It Va ntpdate_enable
2390 This command is intended to
2391 synchronize the system clock only
2393 from some standard reference.
2394 An option to set this up initially
2395 (from a list of known servers) is also provided by the
2397 program when the system is first installed.
2398 .It Va ntpdate_config
2400 Configuration file for
2404 .It Va ntpdate_hosts
2406 A whitespace-separated list of NTP servers to synchronize with at startup.
2407 The default is to use the servers listed in
2408 .Va ntpdate_config ,
2409 if that file exists.
2410 .It Va ntpdate_program
2415 .Pa /usr/sbin/ntpdate ) .
2416 .It Va ntpdate_flags
2422 these are the flags to pass to the
2424 command (typically a hostname).
2431 command at boot time.
2437 .Pa /usr/sbin/ntpd ) .
2451 these are the flags to pass to the
2454 .It Va ntpd_sync_on_start
2461 flag, which syncs the system's clock on startup.
2464 for more information regarding the
2467 This is a preferred alternative to using
2472 .It Va nis_client_enable
2478 service at system boot time.
2479 .It Va nis_client_flags
2482 .Va nis_client_enable
2485 these are the flags to pass to the
2488 .It Va nis_ypset_enable
2494 daemon at system boot time.
2495 .It Va nis_ypset_flags
2498 .Va nis_ypset_enable
2501 these are the flags to pass to the
2504 .It Va nis_server_enable
2510 daemon at system boot time.
2511 .It Va nis_server_flags
2514 .Va nis_server_enable
2517 these are the flags to pass to the
2520 .It Va nis_ypxfrd_enable
2526 daemon at system boot time.
2527 .It Va nis_ypxfrd_flags
2530 .Va nis_ypxfrd_enable
2533 these are the flags to pass to the
2536 .It Va nis_yppasswdd_enable
2542 daemon at system boot time.
2543 .It Va nis_yppasswdd_flags
2546 .Va nis_yppasswdd_enable
2549 these are the flags to pass to the
2552 .It Va rpc_ypupdated_enable
2558 daemon at system boot time.
2559 .It Va bsnmpd_enable
2565 daemon at system boot time.
2566 Be sure to understand the security implications of running SNMP daemon
2574 these are the flags to pass to the
2577 .It Va defaultrouter
2581 create a default route to this host name or IP address
2582 (use an IP address if this router is also required to get to the
2584 .It Va ipv6_defaultrouter
2586 The IPv6 equivalent of
2588 .It Va static_arp_pairs
2590 Set to the list of static ARP pairs that are to be added at system
2592 For each whitespace separated
2595 .Va static_arp_ Ns Aq Ar element
2596 variable is assumed to exist whose contents will later be passed to a
2601 static_arp_pairs="gw"
2602 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2604 .It Va static_ndp_pairs
2606 Set to the list of static NDP pairs that are to be added at system
2608 For each whitespace separated
2611 .Va static_ndp_ Ns Aq Ar element
2612 variable is assumed to exist whose contents will later be passed to a
2617 static_ndp_pairs="gw"
2618 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2620 .It Va static_routes
2622 Set to the list of static routes that are to be added at system
2626 then for each whitespace separated
2629 .Va route_ Ns Aq Ar element
2630 variable is assumed to exist
2631 whose contents will later be passed to a
2636 static_routes="mcast gif0local"
2637 route_mcast="-net 224.0.0.0/4 -iface gif0"
2638 route_gif0local="-host 169.254.1.1 -iface lo0"
2640 .It Va ipv6_static_routes
2642 The IPv6 equivalent of
2646 then for each whitespace separated
2649 .Va ipv6_route_ Ns Aq Ar element
2650 variable is assumed to exist
2651 whose contents will later be passed to a
2652 .Dq Nm route Cm add Fl inet6
2654 .It Va natm_static_routes
2660 If not empty then for each whitespace separated
2663 .Va route_ Ns Aq Ar element
2664 variable is assumed to exist whose contents will later be passed to a
2665 .Dq Nm atmconfig Cm natm Cm add
2667 .It Va gateway_enable
2671 configure host to act as an IP router, e.g.\& to forward packets
2673 .It Va ipv6_gateway_enable
2675 The IPv6 equivalent of
2676 .Va gateway_enable .
2677 .It Va routed_enable
2681 run a routing daemon of some sort, based on the
2686 .It Va route6d_enable
2688 The IPv6 equivalent of
2692 run a routing daemon of some sort, based on the
2697 .It Va routed_program
2703 this is the name of the routing daemon to use.
2704 .It Va route6d_program
2706 The IPv6 equivalent of
2707 .Va routed_program .
2714 these are the flags to pass to the routing daemon.
2715 .It Va route6d_flags
2717 The IPv6 equivalent of
2719 .It Va mrouted_enable
2723 run the multicast routing daemon,
2725 .It Va mroute6d_enable
2727 The IPv6 equivalent of
2728 .Va mrouted_enable .
2731 run the IPv6 multicast routing daemon.
2733 Note that multicast routing daemons are no longer included in the
2735 base system, however, both
2739 may be installed from the
2742 .It Va mrouted_flags
2748 these are the flags to pass to the
2751 .It Va mroute6d_flags
2753 The IPv6 equivalent of
2759 these are the flags passed to the IPv6 multicast routing daemon.
2760 .It Va mroute6d_program
2766 this is the path to the IPv6 multicast routing daemon.
2767 .It Va rtadvd_enable
2773 daemon at boot time.
2776 utility sends ICMPv6 Router Advertisement messages to
2777 the interfaces specified in
2778 .Va rtadvd_interfaces .
2779 This should only be enabled with great care.
2780 You may want to fine-tune
2782 .It Va rtadvd_interfaces
2788 this is the list of interfaces to use.
2789 .It Va ipxgateway_enable
2793 enable the routing of IPX traffic.
2794 .It Va ipxrouted_enable
2800 daemon at system boot time.
2801 .It Va ipxrouted_flags
2804 .Va ipxrouted_enable
2807 these are the flags to pass to the
2814 enable global proxy ARP.
2815 .It Va forward_sourceroute
2823 source-routed packets are forwarded.
2824 .It Va accept_sourceroute
2828 the system will accept source-routed packets directed at it.
2835 daemon at system boot time.
2842 these are the flags to pass to the
2845 .It Va bootparamd_enable
2851 daemon at system boot time.
2852 .It Va bootparamd_flags
2855 .Va bootparamd_enable
2858 these are the flags to pass to the
2861 .It Va stf_interface_ipv4addr
2865 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2867 Specify this entry to enable the 6to4 interface.
2868 .It Va stf_interface_ipv4plen
2870 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2871 An effective value is 0-31.
2872 .It Va stf_interface_ipv6_ifid
2874 IPv6 interface ID for
2878 .It Va stf_interface_ipv6_slaid
2880 IPv6 Site Level Aggregator for
2882 .It Va ipv6_faith_prefix
2886 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2891 .It Va ipv6_ipv4mapping
2895 this enables IPv4 mapped IPv6 address communication (like
2896 .Li ::ffff:a.b.c.d ) .
2901 to enable the configuration of ATM interfaces at system boot time.
2902 For all of the ATM variables described below, please refer to the
2904 manual page for further details on the available command parameters.
2905 Also refer to the files in
2906 .Pa /usr/share/examples/atm
2907 for more detailed configuration information.
2910 This is a list of physical ATM interface drivers to load.
2915 .It Va atm_netif_ Ns Aq Ar intf
2917 For the ATM physical interface
2919 this variable defines the name prefix and count for the ATM network
2920 interfaces to be created.
2921 The value will be passed as the parameters of an
2922 .Dq Nm atm Cm "set netif" Ar intf
2924 .It Va atm_sigmgr_ Ns Aq Ar intf
2926 For the ATM physical interface
2928 this variable defines the ATM signalling manager to be used.
2929 The value will be passed as the parameters of an
2930 .Dq Nm atm Cm attach Ar intf
2932 .It Va atm_prefix_ Ns Aq Ar intf
2934 For the ATM physical interface
2936 this variable defines the NSAP prefix for interfaces using a UNI signalling
2940 the prefix will automatically be set via the
2943 Otherwise, the value will be passed as the parameters of an
2944 .Dq Nm atm Cm "set prefix" Ar intf
2946 .It Va atm_macaddr_ Ns Aq Ar intf
2948 For the ATM physical interface
2950 this variable defines the MAC address for interfaces using a UNI signalling
2954 the hardware MAC address contained in the ATM interface card will be used.
2955 Otherwise, the value will be passed as the parameters of an
2956 .Dq Nm atm Cm "set mac" Ar intf
2958 .It Va atm_arpserver_ Ns Aq Ar netif
2960 For the ATM network interface
2962 this variable defines the ATM address for a host which is to provide ATMARP
2964 This variable is only applicable to interfaces using a UNI signalling
2968 this host will become an ATMARP server.
2969 The value will be passed as the parameters of an
2970 .Dq Nm atm Cm "set arpserver" Ar netif
2972 .It Va atm_scsparp_ Ns Aq Ar netif
2976 SCSP/ATMARP service for the network interface
2978 will be initiated using the
2983 This variable is only applicable if
2984 .Va atm_arpserver_ Ns Aq Ar netif
2989 Set to the list of ATM PVCs to be added at system
2991 For each whitespace separated
2994 .Va atm_pvc_ Ns Aq Ar element
2995 variable is assumed to exist.
2996 The value of each of these variables
2997 will be passed as the parameters of an
2998 .Dq Nm atm Cm "add pvc"
3002 Set to the list of permanent ATM ARP entries to be added
3003 at system boot time.
3004 For each whitespace separated
3007 .Va atm_arp_ Ns Aq Ar element
3008 variable is assumed to exist.
3009 The value of each of these variables
3010 will be passed as the parameters of an
3011 .Dq Nm atm Cm "add arp"
3013 .It Va natm_interfaces
3017 interfaces that will also be used for HARP through
3019 If this list is not empty all interfaces in the list will be brought up
3025 For this to work the interface drivers must be either compiled into the
3026 kernel or must reside on the root partition.
3029 The keyboard bell sound.
3036 if the default behavior is desired.
3037 For details, refer to the
3042 If set to a non-null string, the virtual console's keyboard input is
3048 no keymap is installed, otherwise the value is used to install
3050 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3053 The keyboard repeat speed.
3060 if the default behavior is desired.
3065 attempt to program the function keys with the value.
3067 be a single string of the form:
3068 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3071 Can be set to the value of
3074 .Dq Li destructive ,
3077 to set the cursor behavior explicitly or choose the default behavior.
3082 no screen map is installed, otherwise the value is used to install
3083 the screen map file in
3084 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3089 the default 8x16 font value is used for screen size requests, otherwise
3091 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3097 the default 8x14 font value is used for screen size requests, otherwise
3099 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3105 the default 8x8 font value is used for screen size requests, otherwise
3107 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3113 the default screen blanking interval is used, otherwise it is set
3121 this is the actual screen saver to use
3122 .Li ( blank , snake , daemon ,
3124 .It Va moused_nondefault_enable
3128 the mouse device specified on
3129 the command line is not automatically treated as enabled by the
3130 .Pa /etc/rc.d/moused
3132 Having this variable set to
3138 to be enabled as soon as it is plugged in.
3139 .It Va moused_enable
3145 daemon is started for doing cut/paste selection on the console.
3148 This is the protocol type of the mouse connected to this host.
3149 This variable must be set if
3156 is able to detect the appropriate mouse type automatically in many cases.
3157 Set this variable to
3159 to let the daemon detect it, or
3160 select one from the following list if the automatic detection fails.
3162 If the mouse is attached to the PS/2 mouse port, choose
3166 regardless of the brand and model of the mouse.
3168 mouse is attached to the bus mouse port, choose
3172 All other protocols are for serial mice and will not work with
3173 the PS/2 and bus mice.
3174 If this is a USB mouse,
3176 is the only protocol type which will work.
3178 .Bl -tag -width ".Li x10mouseremote" -compact
3180 Microsoft mouse (serial)
3182 Microsoft IntelliMouse (serial)
3184 Mouse systems Corp.\& mouse (serial)
3186 MM Series mouse (serial)
3188 Logitech mouse (serial)
3192 Logitech MouseMan and TrackMan (serial)
3194 ALPS GlidePoint (serial)
3195 .It Li thinkingmouse
3196 Kensington ThinkingMouse (serial)
3200 MM HitTablet (serial)
3201 .It Li x10mouseremote
3202 X10 MouseRemote (serial)
3204 Interlink VersaPad (serial)
3207 Even if the mouse is not in the above list, it may be compatible
3208 with one in the list.
3209 Refer to the manual page for
3211 for compatibility information.
3213 It should also be noted that while this is enabled, any
3214 other client of the mouse (such as an X server) should access
3215 the mouse through the virtual mouse device,
3217 and configure it as a
3219 type mouse, since all
3220 mouse data is converted to this single canonical format when
3223 If the client program does not support the
3229 It is the second preferred type.
3236 this is the actual port the mouse is on.
3239 for a COM1 serial mouse,
3243 for a bus mouse, for example.
3248 is set, its value is used as an additional set of flags to pass to the
3251 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3253 .Va moused_nondefault_enable
3256 daemon is started for a non-default port, the
3257 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3258 set of options has precedence over and replaces the default
3259 .Va moused_flags (where
3261 is the name of the non-default port, i.e.\&
3264 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3265 it is possible to set up a different set of default flags for each
3268 For example, you can use
3272 to make your laptop's touchpad more comfortable to use,
3273 but an empty set of options for
3274 .Va moused_ums0_flags
3277 mouse has three or more buttons.
3278 .It Va mousechar_start
3282 the default mouse cursor character range
3283 .Li 0xd0 Ns - Ns Li 0xd3
3285 otherwise the range start is set
3290 Use if the default range is occupied in the language code table.
3291 .It Va allscreens_flags
3295 is run with these options for each of the virtual terminals
3299 will enable the mouse pointer on all virtual terminals
3304 .It Va allscreens_kbdflags
3308 is run with these options for each of the virtual terminals
3314 scrollback (history) buffer to 200 lines.
3321 daemon at system boot time.
3327 .Pa /usr/sbin/cron ) .
3334 these are the flags to pass to
3340 enable the special handling of transitions to and from the
3341 Daylight Saving Time in
3343 (equivalent to using the flag
3350 .Pa /usr/sbin/lpd ) .
3357 daemon at system boot time.
3364 these are the flags to pass to the
3367 .It Va chkprintcap_enable
3373 command before starting the
3376 .It Va chkprintcap_flags
3381 .Va chkprintcap_enable
3384 these are the flags to pass to the
3389 which causes missing directories to be created.
3390 .It Va mta_start_script
3392 This variable specifies the full path to the script to run to start
3393 a mail transfer agent.
3395 .Pa /etc/rc.sendmail .
3399 .Pa /etc/rc.sendmail
3400 uses are documented in the
3405 Indicates the device (usually a swap partition) to which a crash dump
3406 should be written in the event of a system crash.
3407 If the value of this variable is
3409 the first suitable swap device listed in
3411 will be used as dump device.
3412 Otherwise, the value of this variable is passed as the argument to
3414 To disable crash dumps, set this variable to
3418 When the system reboots after a crash and a crash dump is found on the
3419 device specified by the
3423 will save that crash dump and a copy of the kernel to the directory
3427 The default value is
3436 .It Va savecore_flags
3438 If crash dumps are enabled, these are the flags to pass to the
3445 to turn on user and group disk quotas on system startup via the
3447 command for all file systems marked as having quotas enabled in
3449 The kernel must be built with
3451 for disk quotas to function.
3456 to enable user and group disk quota checking via the
3459 .It Va quotacheck_flags
3469 these are the flags to pass to the
3474 which checks quotas for all file systems with quotas enabled in
3476 .It Va quotaon_flags
3482 these are the flags to pass to the
3487 which enables quotas for all file systems with quotas enabled in
3489 .It Va quotaoff_flags
3495 these are the flags to pass to the
3497 utility when shutting down the quota system.
3500 which disables quotas for all file systems with quotas enabled in
3502 .It Va accounting_enable
3506 to enable system accounting through the
3513 to enable iBCS2 (SCO) binary emulation at system initial boot
3515 .It Va ibcs2_loaders
3523 this specifies a list of additional iBCS2 loaders to enable.
3528 to enable Linux/ELF binary emulation at system initial
3534 enable SysVR4 emulation at boot time.
3535 .It Va sysvipc_enable
3539 load System V IPC primitives at boot time.
3540 .It Va clear_tmp_enable
3551 to disable removing of X11 lock files,
3552 and the removal and (secure) recreation
3553 of the various socket directories for X11
3555 .It Va ldconfig_paths
3557 Set to the list of shared library paths to use with
3561 will always be added first, so it need not appear in this list.
3562 .It Va ldconfig32_paths
3564 Set to the list of 32-bit compatibility shared library paths to
3567 .It Va ldconfig_paths_aout
3569 Set to the list of shared library paths to use with
3574 .It Va ldconfig_insecure
3578 utility normally refuses to use directories
3579 which are writable by anyone except root.
3580 Set this variable to
3582 to disable that security check during system startup.
3583 .It Va ldconfig_local_dirs
3585 Set to the list of local
3588 The names of all files in the directories listed will be
3589 passed as arguments to
3591 .It Va ldconfig_local32_dirs
3593 Set to the list of local 32-bit compatibility
3596 The names of all files in the directories listed will be
3597 passed as arguments to
3598 .Dq Nm ldconfig Fl 32 .
3599 .It Va kern_securelevel_enable
3603 to set the kernel security level at system startup.
3604 .It Va kern_securelevel
3606 The kernel security level to set at startup.
3607 The allowed range of
3609 ranges from \-1 (the compile time default) to 3 (the
3613 for the list of possible security levels and their effect
3614 on system operation.
3617 Path to the SSH server program
3618 .Pa ( /usr/sbin/sshd
3626 at system boot time.
3633 these are the flags to pass to the
3638 Path to the FTP server program
3639 .Pa ( /usr/libexec/ftpd
3647 as a stand-alone daemon at system boot time.
3654 these are the additional flags to pass to the
3657 .It Va watchdogd_enable
3663 daemon at boot time.
3664 This requires that the kernel have been compiled with a
3667 .It Va watchdogd_flags
3670 .Va watchdogd_enable
3673 these are the flags passed to the
3676 .It Va performance_cx_lowest
3678 CPU idle state to use while on AC power.
3683 should use the lowest power state available while
3685 indicates that the lowest latency state (less power savings) should be used.
3686 .It Va performance_cpu_freq
3688 CPU clock frequency to use while on AC power.
3693 should use the lowest frequency available while
3695 indicates that the highest frequency (less power savings) should be used.
3696 .It Va economy_cx_lowest
3698 CPU idle state to use when off AC power.
3703 should use the lowest power state available while
3705 indicates that the lowest latency state (less power savings) should be used.
3706 .It Va economy_cpu_freq
3708 CPU clock frequency to use when off AC power.
3713 should use the lowest frequency available while
3715 indicates that the highest frequency (less power savings) should be used.
3720 any configured jails will not be started.
3721 .It jail_parallel_start
3725 all configured jails will be started in the background (= in parallel).
3728 A space separated list of names for jails.
3729 This is purely a configuration aid to help identify and
3730 configure multiple jails.
3731 The names specified in this list will be used to
3732 identify settings common to an instance of a jail,
3733 and should contain alphanumeric characters only.
3734 Assuming that the jail in question was named
3736 you would have the following dependent variables:
3738 jail_vjail_hostname="jail.example.com"
3739 jail_vjail_ip="192.0.2.100"
3740 jail_vjail_rootdir="/var/jails/vjail/root"
3746 When set, use as default value for
3747 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3750 .It Va jail_interface
3753 When set, use as default value for
3754 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3760 When set, use as default value for
3761 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3764 .It Va jail_mount_enable
3772 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3775 by default for every jail in
3777 .It Va jail_devfs_ruleset
3781 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3782 to given value for every jail in
3784 .It Va jail_devfs_enable
3792 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3795 by default for every jail in
3797 .It Va jail_fdescfs_enable
3805 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3808 by default for every jail in
3810 .It Va jail_procfs_enable
3818 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3821 by default for every jail in
3823 .It Va jail_exec_prestart Ns Aq Ar N
3826 When set, use as default value for
3827 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3830 .It Va jail_exec_start
3833 When set, use as default value for
3834 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3837 .It Va jail_exec_afterstart Ns Aq Ar N
3840 When set, use as default value for
3841 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3844 .It Va jail_exec_poststart Ns Aq Ar N
3847 When set, use as default value for
3848 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3851 .It Va jail_exec_prestop Ns Aq Ar N
3854 When set, use as default value for
3855 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3858 .It Va jail_exec_stop
3860 When set, use as default value for
3861 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3864 .It Va jail_exec_poststop Ns Aq Ar N
3867 When set, use as default value for
3868 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3871 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3874 Set to the root directory used by jail
3876 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3879 Set to the fully qualified domain name (FQDN) assigned to jail
3881 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3884 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3885 The argument can be a sole address or a comma separated list of addresses.
3886 Additionally each address can be prefixed by the name of an interface
3887 followed by a pipe to overwrite
3888 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3891 and/or suffixed by a netmask, prefixlen or prefix.
3892 In case no netmask, prefixlen or prefix is given,
3894 will be used for IPv4 and
3896 will be used for an IPv6 address.
3897 If no address is given for the jail then the jail will be started with
3898 no networking support.
3899 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3902 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3903 The sequence starts with
3905 and the numbers have to be strictly ascending.
3906 These entries follow the same syntax as their primary
3907 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3909 The order of the entries can be important as the first address for
3910 each address family found will be the primary address of the jail.
3916 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3921 These are flags to pass to
3923 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3926 When set, sets the interface to use when setting IP address alias.
3927 Note that the alias is created at jail startup and removed at jail shutdown.
3928 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3931 When set, the jail is started with the specified forwarding table (sometimes
3932 referred to as a routing table) via
3934 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3937 .Pa /etc/fstab. Ns Aq Ar jname
3939 This is the file system information file to use for jail
3941 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3948 mount all file systems from
3949 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3951 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3954 When set, defines the device file system ruleset file to use for jail
3956 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3963 mount the device file system inside jail
3966 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3973 mount the file-descriptor file system inside jail
3976 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3983 mount the process file system inside jail
3986 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3989 This is the command run as
3992 before jail startup, where
3995 It is run outside the jail.
3996 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3999 .Dq Li /bin/sh /etc/rc
4001 This is the command executed in a jail at jail startup.
4002 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
4005 This is the command run as
4009 after jail startup, where
4012 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
4015 This is the command run as
4018 after jail startup, where
4021 It is run outside the jail.
4022 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
4025 This is the command run as
4028 before jail shutdown, where
4031 It is run outside the jail.
4032 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4035 .Dq Li /bin/sh /etc/rc.shutdown
4037 This is the command executed in a jail at jail shutdown.
4038 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
4041 This is the command run as
4044 after jail shutdown, where
4047 It is run outside the jail.
4048 .It Va jail_set_hostname_allow
4052 do not allow the root user in a jail to set its hostname.
4053 .It Va jail_socket_unixiproute_only
4057 do not allow any sockets,
4058 besides UNIX/IP/route sockets,
4059 to be used within a jail.
4060 .It Va jail_sysvipc_allow
4064 allow applications within a jail to use System V IPC.
4065 .\" -----------------------------------------------------
4066 .It Va harvest_interrupt
4070 to use hardware interrupts as an entropy source.
4073 for more information.
4074 .It Va harvest_ethernet
4078 to use LAN traffic as an entropy source.
4081 for more information.
4082 .It Va harvest_p_to_p
4086 to use serial line traffic as an entropy source.
4089 for more information.
4094 to disable caching entropy via
4096 Otherwise set to the directory used to store entropy files in.
4101 to disable caching entropy through reboots.
4102 Otherwise set to the filename used to store cached entropy through
4104 This file should be located on the root file system to seed the
4106 device as early as possible in the boot process.
4107 .It Va entropy_save_sz
4109 Size of the entropy cache files saved by
4112 .It Va entropy_save_num
4114 Number of entropy cache files to save by
4128 Configuration file for
4137 .Pa /var/run/dmesg.boot
4139 .It Va rcshutdown_timeout
4141 If set, start a watchdog timer in the background which will terminate
4145 has not completed within the specified time (in seconds).
4146 Notice that in addition to this soft timeout,
4148 also applies a hard timeout for the execution of
4150 This is configured via
4153 .Va kern.init_shutdown_timeout
4154 and defaults to 120 seconds.
4155 Setting the value of
4156 .Va rcshutdown_timeout
4157 to more than 120 seconds will have no effect until the
4160 .Va kern.init_shutdown_timeout
4162 .It Va virecover_enable
4166 to prevent the system from trying to
4167 recover pre-maturely terminated
4170 .It Va ugidfw_enable
4175 .Xr mac_bsdextended 4
4176 module upon system initialization and load a default
4178 .It Va bsdextended_script
4181 .Xr mac_bsdextended 4
4182 ruleset file to load.
4183 The default value of this variable is
4184 .Pa /etc/rc.bsdextended .
4185 .It Va newsyslog_enable
4192 .It Va newsyslog_flags
4195 .Va newsyslog_enable
4198 these are the flags to pass to the
4203 which causes log files flagged with a
4206 .It Va mdconfig_md Ns Aq Ar X
4216 must be specified and either a
4218 for malloc or swap backed
4226 .Va mdconfig_md Ns Aq Ar X
4227 variables are evaluated until one variable is unset or null.
4228 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4230 Optional arguments passed to
4236 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4238 An ownership specification passed to
4247 device and the mount point will be changed.
4248 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4250 A mode string passed to
4259 device and the mount point will be changed.
4260 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4262 Files to be copied to the mount point of the
4266 after it has been mounted.
4267 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4269 Command to execute after the specified
4274 Note that the command is passed to
4280 variables can be used to reference respectively the
4282 device and the mount point.
4287 one could set the following:
4289 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4291 .It Va autobridge_interfaces
4293 Set to the list of bridge interfaces that will have newly arriving interfaces
4294 checked against to be automatically added.
4297 then for each whitespace separated
4300 .Va autobridge_ Ns Aq Ar element
4301 variable is assumed to exist which has a whitespace separated list of interface
4302 names to match, these names can use wildcards.
4305 autobridge_interfaces="bridge0"
4306 autobridge_bridge0="tap* dc0 vlan[345]"
4312 enable support for sound mixer.
4313 .It Va hcsecd_enable
4317 enable Bluetooth security daemon.
4318 .It Va hcsecd_config
4320 Configuration file for
4323 .Pa /etc/bluetooth/hcsecd.conf .
4328 enable Bluetooth Service Discovery Protocol daemon.
4336 .It Va sdpd_groupname
4340 group to run as after it initializes.
4343 .It Va sdpd_username
4347 user to run as after it initializes.
4350 .It Va bthidd_enable
4354 enable Bluetooth Human Interface Device daemon.
4355 .It Va bthidd_config
4357 Configuration file for
4360 .Pa /etc/bluetooth/bthidd.conf .
4363 Path to a file, where
4365 will store information about known HID devices.
4367 .Pa /var/db/bthidd.hids .
4368 .It Va rfcomm_pppd_server_enable
4372 enable Bluetooth RFCOMM PPP wrapper daemon.
4373 .It Va rfcomm_pppd_server_profile
4375 The name of the profile to use from
4376 .Pa /etc/ppp/ppp.conf .
4377 Multiple profiles can be specified here.
4378 Also used to specify per-profile overrides.
4379 When the profile name contains any of the characters
4381 they are translated to
4383 for the proposes of the override variable names.
4384 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4386 Overrides local address to listen on.
4392 The address can be specified as BD_ADDR or name.
4393 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4395 Overrides local RFCOMM channel to listen on.
4398 will listen on RFCOMM channel 1.
4399 Must set properly if multiple profiles used in the same time.
4400 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4404 if it should register Serial Port service on the specified RFCOMM channel.
4407 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4411 if it should register Dial-Up Networking service on the specified
4415 .It Va ubthidhci_enable
4419 change the USB Bluetooth controller from HID mode to HCI mode.
4420 You also need to specify the location of USB Bluetooth controller with the
4421 .Va ubthidhci_busnum
4425 .It Va ubthidhci_busnum
4426 Bus number where the USB Bluetooth controller is located.
4429 on your system to find this information.
4430 .It Va ubthidhci_addr
4431 Bus address of the USB Bluetooth controller.
4434 on your system to find this information.
4435 .It Va netwait_enable
4439 delays the start of network-reliant services until
4441 is up and ICMP packets to a destination defined in
4444 Link state is examined first, followed by
4446 an IP address to verify network usability.
4447 If no destination can be reached or timeouts are exceeded,
4448 network services are started anyway with no guarantee that
4449 the network is usable.
4450 Use of this variable requires both
4458 This variable contains a space-delimited list of IP addresses to
4460 DNS hostnames should not be used as resolution is not guaranteed
4461 to be functional at this point.
4462 If multiple IP addresses are specified,
4463 each will be tried until one is successful or the list is exhausted.
4464 .It Va netwait_timeout
4466 Indicates the total number of seconds to perform a
4468 against each IP address in
4470 at a rate of one ping per second.
4471 If any of the pings are successful,
4472 full network connectivity is considered reliable.
4477 Defines the name of the network interface on which watch for link.
4479 is used to monitor the interface, looking for
4480 .Dq Li status: no carrier .
4481 Once gone, the link is considered up.
4484 interface if desired.
4485 .It Va netwait_if_timeout
4487 Defines the total number of seconds to wait for link to become usable,
4488 polled at a 1-second interval.
4492 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4493 .It Pa /etc/defaults/rc.conf
4495 .It Pa /etc/rc.conf.local
4524 .Xr newsyslog.conf 5 ,
4593 .An Jordan K. Hubbard .
projects / FreeBSD / releng / 9.0.git / blob