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).
152 .It Va always_force_depends
156 scripts use the force_depend function to check whether required
157 services are already running, and to start them if necessary.
158 By default during boot time this check is bypassed if the
159 required service is enabled in
160 .Pa /etc/rc.conf[.local] .
161 Setting this option will bypass that check at boot time and
162 always test whether or not the service is actually running.
163 Enabling this option is likely to increase your boot time if
164 services are enabled that utilize the force_depend check.
169 no swapfile is installed, otherwise the value is used as the full
170 pathname to a file to use for additional swap space.
175 enable support for Automatic Power Management with
183 to handle APM event from userland.
184 This also enables support for APM.
191 these are the flags to pass to the
198 to handle device added, removed or unknown events from the kernel.
205 scripts at boot time.
208 Configuration file for
214 A list of kernel modules to load right after the local
216 Loading modules at this point in the boot process is
217 much faster than doing it via
218 .Pa /boot/loader.conf
219 for those modules not necessary for mounting local disk.
220 .It Va kldxref_enable
227 to automatically rebuild
232 .It Va kldxref_clobber
242 will overwrite existing
249 .It Va kldxref_module_path
254 delimited list of paths containing
266 enable the system power control facility with the
275 these are the flags to pass to the
279 Controls the creation of a
282 Always happens if set to
284 and never happens if set to
286 If set to anything else, a memory file system is created if
290 Controls the size of a created
294 Extra options passed to the
296 utility when the memory file system for
301 which inhibits the use of softupdates on
303 so that file system space is freed without delay
304 after file truncation or deletion.
307 for other options you can use in
310 Controls the creation of a
313 Always happens if set to
315 and never happens if set to
317 If set to anything else, a memory file system is created if
321 Controls the size of a created
325 Extra options passed to the
327 utility when the memory file system for
332 which inhibits the use of softupdates on
334 so that file system space is freed without delay
335 after file truncation or deletion.
338 for other options you can use in
341 Controls the automatic population of the
344 Always happens if set to
346 and never happens if set to
348 If set to anything else, a memory file system is created if
351 Note that this process requires access to certain commands in
355 is mounted on normal systems.
356 .It Va cleanvar_enable
363 List of directories to search for startup script files.
364 .It Va script_name_sep
366 The field separator to use for breaking down the list of startup script files
367 into individual filenames.
368 The default is a space.
369 It is not necessary to change this unless there are startup scripts with names
371 .It Va hostapd_enable
380 The fully qualified domain name (FQDN) of this host on the network.
381 This should almost certainly be set to something meaningful, even if
382 there is no network connection.
385 is used to set the hostname via DHCP,
386 this variable should be set to an empty string.
387 If this value remains unset when the system is done booting
388 your console login will display the default hostname of
392 The NIS domain name of this host, or
395 .It Va dhclient_program
397 Path to the DHCP client program
398 .Pa ( /sbin/dhclient ,
403 .It Va dhclient_flags
405 Additional flags to pass to the DHCP client program.
410 manpage for a description of the command line options available.
411 .It Va dhclient_flags_ Ns Aq Ar iface
412 Additional flags to pass to the DHCP client program running on
415 When specified, this variable overrides
417 .It Va background_dhclient
421 to start the DHCP client in background.
422 This can cause trouble with applications depending on
423 a working network, but it will provide a faster startup
425 .It Va background_dhclient_ Ns Aq Ar iface
426 When specified, this variable overrides the
427 .Va background_dhclient
428 variable for interface
431 .It Va synchronous_dhclient
437 synchronously at startup.
438 This behavior can be overridden on a per-interface basis by replacing
442 .Va ifconfig_ Ns Aq Ar interface
447 .It Va defaultroute_delay
449 When set to a positive value, wait up to this long after configuring
450 DHCP interfaces at startup to give the interfaces time to receive a lease.
451 .It Va firewall_enable
455 to load firewall rules at startup.
456 If the kernel was not built with
457 .Cd "options IPFIREWALL" ,
460 kernel module will be loaded.
462 .Va ipfilter_enable .
463 .It Va firewall_script
465 This variable specifies the full path to the firewall script to run.
467 .Pa /etc/rc.firewall .
470 Names the firewall type from the selection in
471 .Pa /etc/rc.firewall ,
472 or the file which contains the local firewall ruleset.
473 Valid selections from
477 .Bl -tag -width ".Li simple" -compact
479 unrestricted IP access
481 all IP services disabled, except via
484 basic protection for a workstation
486 basic protection for a LAN.
489 If a filename is specified, the full path
491 .It Va firewall_quiet
495 to disable the display of firewall rules on the console during boot.
496 .It Va firewall_logging
500 to enable firewall event logging.
501 This is equivalent to the
502 .Dv IPFIREWALL_VERBOSE
504 .It Va firewall_flags
510 specifies a filename.
511 .It Va firewall_coscripts
513 List of executables and/or rc scripts to run after firewall starts/stops.
515 .\" ----- firewall_nat_enable setting --------------------------------
516 .It Va firewall_nat_enable
528 .It Va firewall_nat_interface
534 This is the name of the public interface or IP address on which
535 kernel NAT should run.
536 .It Va firewall_nat_flags
538 Additional configuration parameters for kernel NAT should be placed here.
539 .It Va dummynet_enable
543 will automatically load the
549 .\" -------------------------------------------------------------------
565 sockets must be enabled in the kernel.
566 If the kernel was not built with
567 .Cd "options IPDIVERT" ,
570 kernel module will be loaded.
571 .It Va natd_interface
573 This is the name of the public interface on which
576 The interface may be given as an interface name or as an IP address.
581 flags should be placed here.
586 flag is automatically added with the above
589 .\" ----- ipfilter_enable setting --------------------------------
590 .It Va ipfilter_enable
601 Typical usage will require putting
603 ipfilter_enable="YES"
621 can be enabled independently.
625 both require at least one of
635 options IPFILTER_DEFAULT_BLOCK
638 in the kernel configuration file is a good idea, too.
639 .\" ----- ipfilter_program setting ------------------------------
640 .It Va ipfilter_program
646 .\" ----- ipfilter_rules setting --------------------------------
647 .It Va ipfilter_rules
652 This variable contains the name of the filter rule definition file.
653 The file is expected to be readable for the
656 .\" ----- ipv6_ipfilter_rules setting ---------------------------
657 .It Va ipv6_ipfilter_rules
662 This variable contains the IPv6 filter rule definition file.
663 The file is expected to be readable for the
666 .\" ----- ipfilter_flags setting --------------------------------
667 .It Va ipfilter_flags
670 This variable contains flags passed to the
673 .\" ----- ipnat_enable setting ----------------------------------
683 network address translation.
686 for a detailed discussion.
687 .\" ----- ipnat_program setting ---------------------------------
694 .\" ----- ipnat_rules setting -----------------------------------
700 This variable contains the name of the file
701 holding the network address translation definition.
702 This file is expected to be readable for the
705 .\" ----- ipnat_flags setting -----------------------------------
709 This variable contains flags passed to the
712 .\" ----- ipmon_enable setting ----------------------------------
727 Setting this variable needs setting
734 for a detailed discussion.
735 .\" ----- ipmon_program setting ---------------------------------
742 .\" ----- ipmon_flags setting -----------------------------------
748 This variable contains flags passed to the
751 Another typical example would be
752 .Dq Fl D Pa /var/log/ipflog
755 log directly to a file bypassing
758 .Pa /etc/newsyslog.conf
759 in such case like this:
761 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
763 .\" ----- ipfs_enable setting -----------------------------------
773 saving the filter and NAT state tables during shutdown
774 and reloading them during startup again.
775 Setting this variable needs setting
784 for a detailed discussion.
790 because the raised securelevel will prevent
792 from saving the state tables at shutdown time.
793 .\" ----- ipfs_program setting ----------------------------------
800 .\" ----- ipfs_flags setting ------------------------------------
804 This variable contains flags passed to the
807 .\" ----- end of added ipf hook ---------------------------------
819 Typical usage will require putting
834 into the kernel, otherwise the
835 kernel module will be loaded.
840 ruleset configuration file
855 these flags are passed to the
857 program when loading the ruleset.
867 which logs packets from the
880 .Pa /var/log/pflog ) .
882 .Pa /etc/newsyslog.conf
883 to adjust logfile rotation for this.
893 This variable contains additional flags passed to the
896 .It Va ftpproxy_enable
907 packet filter in translating ftp connections.
908 .It Va ftpproxy_flags
911 This variable contains additional flags passed to the
923 state changes to other hosts over the network by means of
928 must also be set then.
929 .It Va pfsync_syncdev
932 This variable specifies the name of the network interface
934 should operate through.
935 It must be set accordingly if
939 .It Va pfsync_syncpeer
942 This variable is optional.
943 By default, state change messages are sent out on the synchronisation
944 interface using IP multicast packets.
945 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
947 When a peer address is specified using the
949 option, the peer address is used as a destination for the pfsync
950 traffic, and the traffic can then be protected using
954 manpage for more details about using
959 .It Va pfsync_ifconfig
962 This variable can contain additional options to be passed to the
964 command used to set up
966 .It Va tcp_extensions
973 disables certain TCP options as described by
979 might help remedy such problems with connections as randomly hanging
980 or other weird behavior.
981 Some network devices are known
982 to be broken with respect to these options.
989 .Va net.inet.tcp.log_in_vain
991 .Va net.inet.udp.log_in_vain ,
996 are set to the given value.
1004 will disable probing idle TCP connections to verify that the
1005 peer is still up and reachable.
1006 .It Va tcp_drop_synfin
1013 will cause the kernel to ignore TCP frames that have both
1014 the SYN and FIN flags set.
1015 This prevents OS fingerprinting, but may
1016 break some legitimate applications.
1017 .It Va icmp_drop_redirect
1024 will cause the kernel to ignore ICMP REDIRECT packets.
1027 for more information.
1028 .It Va icmp_log_redirect
1035 will cause the kernel to log ICMP REDIRECT packets.
1037 the log messages are not rate-limited, so this option should only be used
1038 for troubleshooting networks.
1041 for more information.
1042 .It Va icmp_bmcastecho
1046 to respond to broadcast or multicast ICMP ping packets.
1049 for more information.
1050 .It Va ip_portrange_first
1054 this is the first port in the default portrange.
1057 for more information.
1058 .It Va ip_portrange_last
1062 this is the last port in the default portrange.
1065 for more information.
1066 .It Va network_interfaces
1068 Set to the list of network interfaces to configure on this host or
1070 (the default) for all current interfaces.
1072 .Va network_interfaces
1073 variable to anything other than the default is deprecated.
1074 Interfaces that the administrator wishes to store configuration for,
1075 but not start at boot should be configured with the
1078 .Va ifconfig_ Ns Aq Ar interface
1079 variables as described below.
1082 .Va ifconfig_ Ns Aq Ar interface
1083 variable is also assumed to exist for each value of
1085 When an interface name contains any of the characters
1087 they are translated to
1090 The variable can contain arguments to
1092 as well as special case-insensitive keywords described below.
1093 Such keywords are removed before passing the value to
1095 while the order of the other arguments is preserved.
1097 One can configure more than one IPv4 address with the
1098 .Va ipv4_addrs_ Ns Aq Ar interface
1100 One or more IP addresses must be provided in Classless Inter-Domain
1101 Routing (CIDR) address notation, whose last byte can be a range like
1103 In this case the address 192.0.2.5 will be configured with the
1104 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1105 the non-conflicting netmask /32 as explained in the
1108 With the interface in question being
1110 an example could look like:
1112 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1115 It is also possible to add IP alias entries using
1120 Assuming that the interface in question was
1123 something like this:
1125 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1126 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1131 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1134 keyword that is found,
1135 its contents are passed to
1137 Execution stops at the first unsuccessful access, so if
1138 something like this is present:
1140 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1141 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1142 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1143 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1146 Then note that alias4 would
1148 be added since the search would
1149 stop with the missing
1152 Due to this difficult to manage behavior, the
1153 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1157 .Pa /etc/start_if. Ns Aq Ar interface
1158 file is present, it is read and executed by the
1161 before configuring the interface as specified in the
1162 .Va ifconfig_ Ns Aq Ar interface
1164 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1168 .Va vlans_ Ns Aq Ar interface
1172 interface will be created for each item in the list with the
1176 If a vlan interface's name is a number,
1177 then that number is used as the vlan tag and the new vlan interface is
1179 .Ar interface . Ns Ar tag .
1181 the vlan tag must be specified via a
1184 .Va create_args_ Ns Aq Ar interface
1187 To create a vlan device named
1191 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1194 ifconfig_em0_101="inet 192.0.2.1/24"
1197 To create a vlan device named
1201 with the vlan tag 102:
1204 create_args_myvlan="vlan 102"
1208 .Va wlans_ Ns Aq Ar interface
1212 interface will be created for each item in the list with the
1216 Further wlan cloning arguments may be passed to the
1219 command by setting the
1220 .Va create_args_ Ns Aq Ar interface
1224 devices must be created for each wireless devices as of
1230 may be specified with an
1231 .Va wlandebug_ Ns Aq Ar interface
1233 The contents of this variable will be passed directly to
1237 .Va ifconfig_ Ns Aq Ar interface
1238 contains the keyword
1240 then the interface will not be configured
1242 .Pa /etc/pccard_ether
1244 .Va network_interfaces
1248 It is possible to bring up an interface with DHCP by adding
1251 .Va ifconfig_ Ns Aq Ar interface
1253 For instance, to initialize the
1256 it is possible to use something like:
1261 Also, if you want to configure your wireless interface with
1262 .Xr wpa_supplicant 8
1263 for use with WPA, EAP/LEAP or WEP, you need to add
1266 .Va ifconfig_ Ns Aq Ar interface
1269 Finally, you can add
1271 options in this variable, in addition to the
1272 .Pa /etc/start_if. Ns Aq Ar interface
1274 For instance, to configure an
1276 wireless device in station mode with an address obtained
1277 via DHCP, using WPA authentication and 802.11b mode, it is
1278 possible to use something like:
1281 ifconfig_wlan0="DHCP WPA mode 11b"
1285 .Va ifconfig_ Ns Aq Ar interface
1286 form, a fallback variable
1287 .Va ifconfig_DEFAULT
1289 It will be used for all interfaces with no
1290 .Va ifconfig_ Ns Aq Ar interface
1292 This is intended to replace the no longer supported
1296 It is also possible to rename an interface by doing:
1298 ifconfig_ed0_name="net0"
1299 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1302 This variable is deprecated.
1304 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1306 .Va ipv6_activate_all_interfaces
1312 .Dq Li inet6 accept_rtadv
1314 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1316 .Va ipv6_activate_all_interfaces
1320 This variable is deprecated.
1322 .Va ip6addrctl_policy
1328 the default address selection policy table set by
1330 will be IPv6-preferred.
1334 the default address selection policy table set by
1336 will be IPv4-preferred.
1337 .It Va ipv6_activate_all_interfaces
1339 This controls initial configuration on IPv6-capable
1340 interfaces with no corresponding
1341 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1343 Note that it is not always necessary to set this variable to
1345 to use IPv6 functionality on
1347 In most cases, just configuring
1348 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1353 all interfaces which do not have a corresponding
1354 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1355 variable will be marked as
1358 This means that all of IPv6 functionality on that interface
1359 is completely disabled to enforce a security policy.
1360 If the variable is set to
1362 the flag will be cleared on all of the interfaces.
1364 In most cases, just defining an
1365 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1366 for an IPv6-capable interface should be sufficient.
1367 However, if an interface is added dynamically
1368 .Pq by some tunneling protocols such as PPP, for example ,
1369 it is often difficult to define the variable in advance.
1370 In such a case, configuring the
1372 flag can be disabled by setting this variable to
1375 For more details of the
1378 .Dq Li inet6 ifdisabled ,
1388 privacy addresses will be generated for each IPv6
1389 interface as described in RFC 4941.
1390 .It Va ipv6_network_interfaces
1392 This is the IPv6 equivalent of
1393 .Va network_interfaces .
1394 Normally manual configuration of this variable is not needed.
1396 .It Va ipv6_cpe_wanif
1398 If the variable is set to an interface name,
1402 .Dq inet6 -no_radr accept_rtadv
1403 will be added to the specified interface automatically before evaluating
1404 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1408 .Va net.inet6.ip6.rfc6204w3
1410 .Va net.inet6.ip6.no_radr
1413 This means the specified interface will accept ICMPv6 Router
1414 Advertisement messages on that link and add the discovered
1415 routers into the Default Router List.
1416 While the other interfaces can still accept RA messages if the
1417 .Dq inet6 accept_rtadv
1418 option is specified, adding
1419 routes into the Default Router List will be disabled by
1426 Note that ICMPv6 Router Advertisement messages will be
1428 .Va net.inet6.ip6.forwarding
1430 .Pq packet forwarding is enabled
1432 .Va net.inet6.ip6.rfc6204w3
1437 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1439 IPv6 functionality on an interface should be configured by
1440 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1441 instead of setting ifconfig parameters in
1442 .Va ifconfig_ Ns Aq Ar interface .
1443 If this variable is empty, all of IPv6 configurations on the
1444 specified interface by other variables such as
1445 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1448 Aliases should be set by
1449 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1455 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1456 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1459 Interfaces that have an
1460 .Dq Li inet6 accept_rtadv
1462 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1463 setting will be automatically configured by SLAAC
1464 .Pq StateLess Address AutoConfiguration
1470 Note that a link-local address will be automatically configured in
1471 addition to the configured global-scope addresses because the IPv6
1472 specifications require it on each link.
1473 The address is calculated from the MAC address by using an algorithm
1480 If only a link-local address is needed on the interface,
1481 the following configuration can be used:
1483 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1486 A link-local address can also be configured manually.
1487 This is useful for the default router address of an IPv6 router
1488 so that it does not change when the network interface
1492 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1494 .It Va ipv6_prefix_ Ns Aq Ar interface
1496 If one or more prefixes are defined in
1497 .Va ipv6_prefix_ Ns Aq Ar interface
1498 addresses based on each prefix and the EUI-64 interface index will be
1499 configured on that interface.
1500 Note that this variable will be ignored when
1501 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1504 For example, the following configuration
1506 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1509 is equivalent to the following:
1511 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1512 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1513 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1514 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1517 These Subnet-Router anycast addresses will be added only when
1518 .Va ipv6_gateway_enable
1520 .It Va ipv6_default_interface
1524 this is the default output interface for scoped addresses.
1525 This works only with ipv6_gateway_enable="NO".
1526 .It Va ip6addrctl_enable
1528 This variable is to enable configuring default address selection policy table
1530 The table can be specified in another variable
1531 .Va ip6addrctl_policy .
1533 .Va ip6addrctl_policy
1534 the following keywords can be specified:
1535 .Dq Li ipv4_prefer ,
1536 .Dq Li ipv6_prefer ,
1546 installs a pre-defined policy table described in Section 2.1
1554 is specified, it attempts to read a file
1555 .Pa /etc/ip6addrctl.conf
1557 If this file is found,
1559 reads and installs it.
1560 If not found, a policy is automatically set
1562 .Va ipv6_activate_all_interfaces
1563 variable; if the variable is set to
1565 the IPv6-preferred one is used.
1566 Otherwise IPv4-preferred.
1568 The default value of
1569 .Va ip6addrctl_enable
1571 .Va ip6addrctl_policy
1577 .It Va cloned_interfaces
1579 Set to the list of clonable network interfaces to create on this host.
1580 Further cloning arguments may be passed to the
1583 command for each interface by setting the
1584 .Va create_args_ Ns Aq Ar interface
1587 .Va cloned_interfaces
1588 are automatically appended to
1589 .Va network_interfaces
1591 .It Va fec_interfaces
1595 Fast EtherChannel interfaces to configure on this host.
1597 .Va fecconfig_ Ns Aq Ar interface
1598 variable is assumed to exist for each value of
1600 The value of this variable is used to configure link aggregated interfaces
1601 according to the syntax of the
1602 .Cm NGM_FEC_ADD_IFACE
1606 Additionally, this option ensures that each listed interface is created
1611 before attempting to configure it.
1614 fec_interfaces="fec0"
1615 fecconfig_fec0="em0 em1"
1616 ifconfig_fec0="DHCP"
1618 .It Va gif_interfaces
1622 tunnel interfaces to configure on this host.
1624 .Va gifconfig_ Ns Aq Ar interface
1625 variable is assumed to exist for each value of
1627 The value of this variable is used to configure the link layer of the
1628 tunnel according to the syntax of the
1632 Additionally, this option ensures that each listed interface is created
1637 before attempting to configure it.
1638 .It Va sppp_interfaces
1642 interfaces to configure on this host.
1644 .Va spppconfig_ Ns Aq Ar interface
1645 variable is assumed to exist for each value of
1647 Each interface should also be configured by a general
1648 .Va ifconfig_ Ns Aq Ar interface
1652 for more information about available options.
1662 The name of the profile to use from
1663 .Pa /etc/ppp/ppp.conf .
1664 Also used for per-profile overrides of
1669 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1670 When the profile name contains any of the characters
1672 they are translated to
1674 for the proposes of the override variable names.
1677 Mode in which to run the
1680 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1682 Overrides the global
1692 See the manual for a full description.
1697 enables network address translation.
1698 Used in conjunction with
1700 allows hosts on private network addresses access to the Internet using
1701 this host as a network address translating router.
1702 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1704 Overrides the global
1708 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1710 Set the unit number to be used for this profile.
1711 See the manual description of
1716 The name of the user under which
1724 .It Va rc_conf_files
1726 This option is used to specify a list of files that will override
1728 .Pa /etc/defaults/rc.conf .
1729 The files will be read in the order in which they are specified and should
1730 include the full path to the file.
1731 By default, the files specified are
1734 .Pa /etc/rc.conf.local
1740 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1742 .It Va gptboot_enable
1746 .Pa /etc/rc.d/gptboot
1747 will log if the system successfully (or not) booted from a GPT partition,
1753 .It Va gbde_autoattach_all
1758 will attempt to automatically initialize your .bde devices in
1762 List the devices that the script should try to attach,
1767 The directory where the
1769 lockfiles are located.
1770 The default lockfile directory is
1773 The lockfile for each individual
1775 device can be overridden by setting the variable
1776 .Va gbde_lock_ Ns Aq Ar device ,
1779 is the encrypted device without the
1784 .It Va gbde_attach_attempts
1786 Number of times to attempt attaching to a
1788 device, i.e., how many times the user is asked for the pass-phrase.
1792 List of devices to automatically attach on boot.
1793 Note that .eli devices from
1795 are automatically appended to this list.
1798 Number of times user is asked for the pass-phrase.
1799 If empty, it will be taken from
1800 .Va kern.geom.eli.tries
1802 .It Va geli_default_flags
1804 Default flags to use by
1806 when configuring disk encryption.
1807 Flags can be configured for every device separately by defining
1808 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1810 .It Va geli_autodetach
1812 Specifies if GELI devices should be marked for detach on last close after
1813 file systems are mounted.
1816 This can be changed for every device separately by defining
1817 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1819 .It Va geli_swap_flags
1820 Options passed to the
1822 utility when encrypted GEOM providers for swap partitions are created.
1824 .Dq Li "-e aes -l 256 -s 4096 -d" .
1825 .It Va root_rw_mount
1830 After the file systems are checked at boot time, the root file system
1831 is remounted as read-write if this is set to
1833 Diskless systems that mount their root file system from a read-only remote
1834 NFS share should set this to
1838 .It Va fsck_y_enable
1843 will be run with the
1845 flag if the initial preen
1846 of the file systems fails.
1847 .It Va background_fsck
1851 the system will attempt to run
1853 in the background where possible.
1854 .It Va background_fsck_delay
1856 The amount of time in seconds to sleep before starting a background
1858 It defaults to sixty seconds to allow large applications such as
1859 the X server to start before disk I/O bandwidth is monopolized by
1861 If set to a negative number, the background file system check will be
1862 delayed indefinitely to allow the administrator to run it at a more
1864 For example it may be run from
1866 by adding a line like
1868 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1874 List of file system types that are network-based.
1875 This list should generally not be modified by end users.
1877 .Va extra_netfs_types
1879 .It Va extra_netfs_types
1881 If set to something other than
1884 this variable extends the list of file system types
1885 for which automatic mounting at startup by
1887 should be delayed until the network is initialized.
1889 a whitespace-separated list of network file system descriptor pairs,
1890 each consisting of a file system type as passed to
1892 and a human-readable, one-word description,
1895 Extending the default list in this way is only necessary
1896 when third party file system types are used.
1897 .It Va syslogd_enable
1904 .It Va syslogd_program
1909 .Pa /usr/sbin/syslogd ) .
1910 .It Va syslogd_flags
1916 these are the flags to pass to
1925 .It Va inetd_program
1930 .Pa /usr/sbin/inetd ) .
1937 these are the flags to pass to
1946 .It Va hastd_program
1958 these are the flags to pass to
1967 .It Va named_program
1972 .Pa /usr/sbin/named ) .
1977 configuration file, (default
1978 .Pa /etc/namedb/named.conf ) .
1985 these are the flags to pass to
1991 process should be run as.
1992 .It Va named_chrootdir
1994 The root directory for a name server run in a
1996 environment (default
2000 will not be run in a
2003 .It Va named_chroot_autoupdate
2007 to disable automatic update of the
2010 .It Va named_symlink_enable
2014 to disable symlinking of
2023 loop until working name service is established.
2024 .It Va named_wait_host
2026 Name of host to lookup for the named_wait option.
2028 .It Va named_auto_forward
2030 Set to enable automatic creation of a forwarder
2031 configuration file derived from
2032 .Pa /etc/resolv.conf .
2033 .It Va named_auto_forward_only
2035 Set to change the default forwarder configuration from
2039 .It Va kerberos5_server_enable
2043 to start a Kerberos 5 authentication server
2045 .It Va kerberos5_server
2048 .Va kerberos5_server_enable
2051 this is the path to Kerberos 5 Authentication Server.
2052 .It Va kerberos5_server_flags
2055 This variable contains additional flags to be passed to the Kerberos 5
2056 authentication server.
2057 .It Va kadmind5_server_enable
2063 the Kerberos 5 Administration Daemon; set to
2066 .It Va kadmind5_server
2069 .Va kadmind5_server_enable
2072 this is the path to Kerberos 5 Administration Daemon.
2073 .It Va kpasswdd_server_enable
2079 the Kerberos 5 Password-Changing Daemon; set to
2082 .It Va kpasswdd_server
2085 .Va kpasswdd_server_enable
2088 this is the path to Kerberos 5 Password-Changing Daemon.
2095 the Kerberos 5 ticket forwarding daemon, at the boot time.
2101 .Pa /usr/libexec/kfd ) .
2108 daemon at boot time.
2115 these are the flags to pass to it.
2122 daemon at boot time.
2129 these are the flags to pass to it.
2132 manpage for more information.
2133 .It Va amd_map_program
2136 the specified program is run to get the list of
2141 maps are stored in NIS, one can set this to
2154 will be updated at boot time to reflect the kernel release
2159 will not be updated.
2160 .It Va nfs_client_enable
2164 run the NFS client daemons at boot time.
2165 .It Va nfs_access_cache
2168 .Va nfs_client_enable
2173 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2175 results should be cached.
2176 A value of 2-10 seconds will substantially reduce network
2177 traffic for many NFS operations.
2178 .It Va nfs_server_enable
2182 run the NFS server daemons at boot time.
2183 .It Va nfs_server_flags
2186 .Va nfs_server_enable
2189 these are the flags to pass to the
2192 .It Va nfsv4_server_enable
2195 .Va nfs_server_enable
2199 .Va nfsv4_server_enable
2202 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2203 .It Va nfsuserd_enable
2209 run the nfsuserd daemon, which is needed for NFSv4 in order
2210 to map between user/group names vs uid/gid numbers.
2212 .Va nfsv4_server_enable
2215 this will be forced enabled.
2216 .It Va nfsuserd_flags
2222 these are the flags to pass to the
2225 .It Va nfscbd_enable
2231 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2238 these are the flags to pass to the
2241 .It Va oldnfs_server_enable
2244 .Va oldnfs_server_enable
2247 force the NFS server daemons to run the old NFS server code
2248 that does not support NFSv4.
2249 .It Va mountd_enable
2254 .Va nfs_server_enable
2260 It is commonly needed to run CFS without real NFS used.
2267 these are the flags to pass to the
2270 .It Va weak_mountd_authentication
2274 allow services like PCNFSD to make non-privileged mount
2276 .It Va nfs_reserved_port_only
2280 provide NFS services only on a secure port.
2281 .It Va nfs_bufpackets
2283 If set to a number, indicates the number of packets worth of
2284 socket buffer space to reserve on an NFS client.
2285 The kernel default is typically 4.
2286 Using a higher number may be
2287 useful on gigabit networks to improve performance.
2288 The minimum value is
2289 2 and the maximum is 64.
2290 .It Va rpc_lockd_enable
2294 and also an NFS server or client, run
2297 .It Va rpc_lockd_flags
2300 .Va rpc_lockd_enable
2303 these are the flags to pass to the
2306 .It Va rpc_statd_enable
2310 and also an NFS server or client, run
2313 .It Va rpc_statd_flags
2316 .Va rpc_statd_enable
2319 these are the flags to pass to the
2322 .It Va rpcbind_program
2327 .Pa /usr/sbin/rpcbind ) .
2328 .It Va rpcbind_enable
2334 service at boot time.
2335 .It Va rpcbind_flags
2341 these are the flags to pass to the
2344 .It Va keyserv_enable
2350 daemon on boot for running Secure RPC.
2351 .It Va keyserv_flags
2357 these are the flags to pass to
2360 .It Va pppoed_enable
2366 daemon at boot time to provide PPP over Ethernet services.
2367 .It Va pppoed_ Ns Aq Ar provider
2370 listens to requests to this
2376 argument of the same name.
2379 Additional flags to pass to
2381 .It Va pppoed_interface
2383 The network interface to run
2386 This is mandatory when
2396 service at boot time.
2397 This command is intended for networks of
2398 machines where a consistent
2400 for all hosts must be established.
2401 This is often useful in large NFS
2402 environments where time stamps on files are expected to be consistent
2410 these are the flags to pass to the
2413 .It Va ntpdate_enable
2420 This command is intended to
2421 synchronize the system clock only
2423 from some standard reference.
2424 An option to set this up initially
2425 (from a list of known servers) is also provided by the
2427 program when the system is first installed.
2428 .It Va ntpdate_config
2430 Configuration file for
2434 .It Va ntpdate_hosts
2436 A whitespace-separated list of NTP servers to synchronize with at startup.
2437 The default is to use the servers listed in
2438 .Va ntpdate_config ,
2439 if that file exists.
2440 .It Va ntpdate_program
2445 .Pa /usr/sbin/ntpdate ) .
2446 .It Va ntpdate_flags
2452 these are the flags to pass to the
2454 command (typically a hostname).
2461 command at boot time.
2467 .Pa /usr/sbin/ntpd ) .
2481 these are the flags to pass to the
2484 .It Va ntpd_sync_on_start
2491 flag, which syncs the system's clock on startup.
2494 for more information regarding the
2497 This is a preferred alternative to using
2502 .It Va nis_client_enable
2508 service at system boot time.
2509 .It Va nis_client_flags
2512 .Va nis_client_enable
2515 these are the flags to pass to the
2518 .It Va nis_ypset_enable
2524 daemon at system boot time.
2525 .It Va nis_ypset_flags
2528 .Va nis_ypset_enable
2531 these are the flags to pass to the
2534 .It Va nis_server_enable
2540 daemon at system boot time.
2541 .It Va nis_server_flags
2544 .Va nis_server_enable
2547 these are the flags to pass to the
2550 .It Va nis_ypxfrd_enable
2556 daemon at system boot time.
2557 .It Va nis_ypxfrd_flags
2560 .Va nis_ypxfrd_enable
2563 these are the flags to pass to the
2566 .It Va nis_yppasswdd_enable
2572 daemon at system boot time.
2573 .It Va nis_yppasswdd_flags
2576 .Va nis_yppasswdd_enable
2579 these are the flags to pass to the
2582 .It Va rpc_ypupdated_enable
2588 daemon at system boot time.
2589 .It Va bsnmpd_enable
2595 daemon at system boot time.
2596 Be sure to understand the security implications of running SNMP daemon
2604 these are the flags to pass to the
2607 .It Va defaultrouter
2611 create a default route to this host name or IP address
2612 (use an IP address if this router is also required to get to the
2614 .It Va ipv6_defaultrouter
2616 The IPv6 equivalent of
2618 .It Va static_arp_pairs
2620 Set to the list of static ARP pairs that are to be added at system
2622 For each whitespace separated
2625 .Va static_arp_ Ns Aq Ar element
2626 variable is assumed to exist whose contents will later be passed to a
2631 static_arp_pairs="gw"
2632 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2634 .It Va static_ndp_pairs
2636 Set to the list of static NDP pairs that are to be added at system
2638 For each whitespace separated
2641 .Va static_ndp_ Ns Aq Ar element
2642 variable is assumed to exist whose contents will later be passed to a
2647 static_ndp_pairs="gw"
2648 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2650 .It Va static_routes
2652 Set to the list of static routes that are to be added at system
2656 then for each whitespace separated
2659 .Va route_ Ns Aq Ar element
2660 variable is assumed to exist
2661 whose contents will later be passed to a
2666 static_routes="mcast gif0local"
2667 route_mcast="-net 224.0.0.0/4 -iface gif0"
2668 route_gif0local="-host 169.254.1.1 -iface lo0"
2670 .It Va ipv6_static_routes
2672 The IPv6 equivalent of
2676 then for each whitespace separated
2679 .Va ipv6_route_ Ns Aq Ar element
2680 variable is assumed to exist
2681 whose contents will later be passed to a
2682 .Dq Nm route Cm add Fl inet6
2684 .It Va natm_static_routes
2690 If not empty then for each whitespace separated
2693 .Va route_ Ns Aq Ar element
2694 variable is assumed to exist whose contents will later be passed to a
2695 .Dq Nm atmconfig Cm natm Cm add
2697 .It Va gateway_enable
2701 configure host to act as an IP router, e.g.\& to forward packets
2703 .It Va ipv6_gateway_enable
2705 The IPv6 equivalent of
2706 .Va gateway_enable .
2707 .It Va routed_enable
2711 run a routing daemon of some sort, based on the
2716 .It Va route6d_enable
2718 The IPv6 equivalent of
2722 run a routing daemon of some sort, based on the
2727 .It Va routed_program
2733 this is the name of the routing daemon to use.
2734 .It Va route6d_program
2736 The IPv6 equivalent of
2737 .Va routed_program .
2744 these are the flags to pass to the routing daemon.
2745 .It Va route6d_flags
2747 The IPv6 equivalent of
2749 .It Va mrouted_enable
2753 run the multicast routing daemon,
2755 .It Va mroute6d_enable
2757 The IPv6 equivalent of
2758 .Va mrouted_enable .
2761 run the IPv6 multicast routing daemon.
2763 Note that multicast routing daemons are no longer included in the
2765 base system, however, both
2769 may be installed from the
2772 .It Va mrouted_flags
2778 these are the flags to pass to the
2781 .It Va mroute6d_flags
2783 The IPv6 equivalent of
2789 these are the flags passed to the IPv6 multicast routing daemon.
2790 .It Va mroute6d_program
2796 this is the path to the IPv6 multicast routing daemon.
2797 .It Va rtadvd_enable
2803 daemon at boot time.
2806 utility sends ICMPv6 Router Advertisement messages to
2807 the interfaces specified in
2808 .Va rtadvd_interfaces .
2809 This should only be enabled with great care.
2810 You may want to fine-tune
2812 .It Va rtadvd_interfaces
2818 this is the list of interfaces to use.
2819 .It Va ipxgateway_enable
2823 enable the routing of IPX traffic.
2824 .It Va ipxrouted_enable
2830 daemon at system boot time.
2831 .It Va ipxrouted_flags
2834 .Va ipxrouted_enable
2837 these are the flags to pass to the
2844 enable global proxy ARP.
2845 .It Va forward_sourceroute
2853 source-routed packets are forwarded.
2854 .It Va accept_sourceroute
2858 the system will accept source-routed packets directed at it.
2865 daemon at system boot time.
2872 these are the flags to pass to the
2875 .It Va bootparamd_enable
2881 daemon at system boot time.
2882 .It Va bootparamd_flags
2885 .Va bootparamd_enable
2888 these are the flags to pass to the
2891 .It Va stf_interface_ipv4addr
2895 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2897 Specify this entry to enable the 6to4 interface.
2898 .It Va stf_interface_ipv4plen
2900 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2901 An effective value is 0-31.
2902 .It Va stf_interface_ipv6_ifid
2904 IPv6 interface ID for
2908 .It Va stf_interface_ipv6_slaid
2910 IPv6 Site Level Aggregator for
2912 .It Va ipv6_faith_prefix
2916 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2921 .It Va ipv6_ipv4mapping
2925 this enables IPv4 mapped IPv6 address communication (like
2926 .Li ::ffff:a.b.c.d ) .
2931 to enable the configuration of ATM interfaces at system boot time.
2932 For all of the ATM variables described below, please refer to the
2934 manual page for further details on the available command parameters.
2935 Also refer to the files in
2936 .Pa /usr/share/examples/atm
2937 for more detailed configuration information.
2940 This is a list of physical ATM interface drivers to load.
2945 .It Va atm_netif_ Ns Aq Ar intf
2947 For the ATM physical interface
2949 this variable defines the name prefix and count for the ATM network
2950 interfaces to be created.
2951 The value will be passed as the parameters of an
2952 .Dq Nm atm Cm "set netif" Ar intf
2954 .It Va atm_sigmgr_ Ns Aq Ar intf
2956 For the ATM physical interface
2958 this variable defines the ATM signalling manager to be used.
2959 The value will be passed as the parameters of an
2960 .Dq Nm atm Cm attach Ar intf
2962 .It Va atm_prefix_ Ns Aq Ar intf
2964 For the ATM physical interface
2966 this variable defines the NSAP prefix for interfaces using a UNI signalling
2970 the prefix will automatically be set via the
2973 Otherwise, the value will be passed as the parameters of an
2974 .Dq Nm atm Cm "set prefix" Ar intf
2976 .It Va atm_macaddr_ Ns Aq Ar intf
2978 For the ATM physical interface
2980 this variable defines the MAC address for interfaces using a UNI signalling
2984 the hardware MAC address contained in the ATM interface card will be used.
2985 Otherwise, the value will be passed as the parameters of an
2986 .Dq Nm atm Cm "set mac" Ar intf
2988 .It Va atm_arpserver_ Ns Aq Ar netif
2990 For the ATM network interface
2992 this variable defines the ATM address for a host which is to provide ATMARP
2994 This variable is only applicable to interfaces using a UNI signalling
2998 this host will become an ATMARP server.
2999 The value will be passed as the parameters of an
3000 .Dq Nm atm Cm "set arpserver" Ar netif
3002 .It Va atm_scsparp_ Ns Aq Ar netif
3006 SCSP/ATMARP service for the network interface
3008 will be initiated using the
3013 This variable is only applicable if
3014 .Va atm_arpserver_ Ns Aq Ar netif
3019 Set to the list of ATM PVCs to be added at system
3021 For each whitespace separated
3024 .Va atm_pvc_ Ns Aq Ar element
3025 variable is assumed to exist.
3026 The value of each of these variables
3027 will be passed as the parameters of an
3028 .Dq Nm atm Cm "add pvc"
3032 Set to the list of permanent ATM ARP entries to be added
3033 at system boot time.
3034 For each whitespace separated
3037 .Va atm_arp_ Ns Aq Ar element
3038 variable is assumed to exist.
3039 The value of each of these variables
3040 will be passed as the parameters of an
3041 .Dq Nm atm Cm "add arp"
3043 .It Va natm_interfaces
3047 interfaces that will also be used for HARP through
3049 If this list is not empty all interfaces in the list will be brought up
3055 For this to work the interface drivers must be either compiled into the
3056 kernel or must reside on the root partition.
3059 The keyboard bell sound.
3066 if the default behavior is desired.
3067 For details, refer to the
3072 If set to a non-null string, the virtual console's keyboard input is
3078 no keymap is installed, otherwise the value is used to install
3080 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3083 The keyboard repeat speed.
3090 if the default behavior is desired.
3095 attempt to program the function keys with the value.
3097 be a single string of the form:
3098 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3101 Can be set to the value of
3104 .Dq Li destructive ,
3107 to set the cursor behavior explicitly or choose the default behavior.
3112 no screen map is installed, otherwise the value is used to install
3113 the screen map file in
3114 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3119 the default 8x16 font value is used for screen size requests, otherwise
3121 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3127 the default 8x14 font value is used for screen size requests, otherwise
3129 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3135 the default 8x8 font value is used for screen size requests, otherwise
3137 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3143 the default screen blanking interval is used, otherwise it is set
3151 this is the actual screen saver to use
3152 .Li ( blank , snake , daemon ,
3154 .It Va moused_nondefault_enable
3158 the mouse device specified on
3159 the command line is not automatically treated as enabled by the
3160 .Pa /etc/rc.d/moused
3162 Having this variable set to
3168 to be enabled as soon as it is plugged in.
3169 .It Va moused_enable
3175 daemon is started for doing cut/paste selection on the console.
3178 This is the protocol type of the mouse connected to this host.
3179 This variable must be set if
3186 is able to detect the appropriate mouse type automatically in many cases.
3187 Set this variable to
3189 to let the daemon detect it, or
3190 select one from the following list if the automatic detection fails.
3192 If the mouse is attached to the PS/2 mouse port, choose
3196 regardless of the brand and model of the mouse.
3198 mouse is attached to the bus mouse port, choose
3202 All other protocols are for serial mice and will not work with
3203 the PS/2 and bus mice.
3204 If this is a USB mouse,
3206 is the only protocol type which will work.
3208 .Bl -tag -width ".Li x10mouseremote" -compact
3210 Microsoft mouse (serial)
3212 Microsoft IntelliMouse (serial)
3214 Mouse systems Corp.\& mouse (serial)
3216 MM Series mouse (serial)
3218 Logitech mouse (serial)
3222 Logitech MouseMan and TrackMan (serial)
3224 ALPS GlidePoint (serial)
3225 .It Li thinkingmouse
3226 Kensington ThinkingMouse (serial)
3230 MM HitTablet (serial)
3231 .It Li x10mouseremote
3232 X10 MouseRemote (serial)
3234 Interlink VersaPad (serial)
3237 Even if the mouse is not in the above list, it may be compatible
3238 with one in the list.
3239 Refer to the manual page for
3241 for compatibility information.
3243 It should also be noted that while this is enabled, any
3244 other client of the mouse (such as an X server) should access
3245 the mouse through the virtual mouse device,
3247 and configure it as a
3249 type mouse, since all
3250 mouse data is converted to this single canonical format when
3253 If the client program does not support the
3259 It is the second preferred type.
3266 this is the actual port the mouse is on.
3269 for a COM1 serial mouse,
3273 for a bus mouse, for example.
3278 is set, its value is used as an additional set of flags to pass to the
3281 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3283 .Va moused_nondefault_enable
3286 daemon is started for a non-default port, the
3287 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3288 set of options has precedence over and replaces the default
3289 .Va moused_flags (where
3291 is the name of the non-default port, i.e.\&
3294 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3295 it is possible to set up a different set of default flags for each
3298 For example, you can use
3302 to make your laptop's touchpad more comfortable to use,
3303 but an empty set of options for
3304 .Va moused_ums0_flags
3307 mouse has three or more buttons.
3308 .It Va mousechar_start
3312 the default mouse cursor character range
3313 .Li 0xd0 Ns - Ns Li 0xd3
3315 otherwise the range start is set
3320 Use if the default range is occupied in the language code table.
3321 .It Va allscreens_flags
3325 is run with these options for each of the virtual terminals
3329 will enable the mouse pointer on all virtual terminals
3334 .It Va allscreens_kbdflags
3338 is run with these options for each of the virtual terminals
3344 scrollback (history) buffer to 200 lines.
3351 daemon at system boot time.
3357 .Pa /usr/sbin/cron ) .
3364 these are the flags to pass to
3370 enable the special handling of transitions to and from the
3371 Daylight Saving Time in
3373 (equivalent to using the flag
3380 .Pa /usr/sbin/lpd ) .
3387 daemon at system boot time.
3394 these are the flags to pass to the
3397 .It Va chkprintcap_enable
3403 command before starting the
3406 .It Va chkprintcap_flags
3411 .Va chkprintcap_enable
3414 these are the flags to pass to the
3419 which causes missing directories to be created.
3420 .It Va mta_start_script
3422 This variable specifies the full path to the script to run to start
3423 a mail transfer agent.
3425 .Pa /etc/rc.sendmail .
3429 .Pa /etc/rc.sendmail
3430 uses are documented in the
3435 Indicates the device (usually a swap partition) to which a crash dump
3436 should be written in the event of a system crash.
3437 If the value of this variable is
3439 the first suitable swap device listed in
3441 will be used as dump device.
3442 Otherwise, the value of this variable is passed as the argument to
3444 To disable crash dumps, set this variable to
3448 When the system reboots after a crash and a crash dump is found on the
3449 device specified by the
3453 will save that crash dump and a copy of the kernel to the directory
3457 The default value is
3466 .It Va savecore_flags
3468 If crash dumps are enabled, these are the flags to pass to the
3475 to turn on user and group disk quotas on system startup via the
3477 command for all file systems marked as having quotas enabled in
3479 The kernel must be built with
3481 for disk quotas to function.
3486 to enable user and group disk quota checking via the
3489 .It Va quotacheck_flags
3499 these are the flags to pass to the
3504 which checks quotas for all file systems with quotas enabled in
3506 .It Va quotaon_flags
3512 these are the flags to pass to the
3517 which enables quotas for all file systems with quotas enabled in
3519 .It Va quotaoff_flags
3525 these are the flags to pass to the
3527 utility when shutting down the quota system.
3530 which disables quotas for all file systems with quotas enabled in
3532 .It Va accounting_enable
3536 to enable system accounting through the
3543 to enable iBCS2 (SCO) binary emulation at system initial boot
3545 .It Va ibcs2_loaders
3553 this specifies a list of additional iBCS2 loaders to enable.
3558 to enable Linux/ELF binary emulation at system initial
3564 enable SysVR4 emulation at boot time.
3565 .It Va sysvipc_enable
3569 load System V IPC primitives at boot time.
3570 .It Va clear_tmp_enable
3581 to disable removing of X11 lock files,
3582 and the removal and (secure) recreation
3583 of the various socket directories for X11
3585 .It Va ldconfig_paths
3587 Set to the list of shared library paths to use with
3591 will always be added first, so it need not appear in this list.
3592 .It Va ldconfig32_paths
3594 Set to the list of 32-bit compatibility shared library paths to
3597 .It Va ldconfig_paths_aout
3599 Set to the list of shared library paths to use with
3604 .It Va ldconfig_insecure
3608 utility normally refuses to use directories
3609 which are writable by anyone except root.
3610 Set this variable to
3612 to disable that security check during system startup.
3613 .It Va ldconfig_local_dirs
3615 Set to the list of local
3618 The names of all files in the directories listed will be
3619 passed as arguments to
3621 .It Va ldconfig_local32_dirs
3623 Set to the list of local 32-bit compatibility
3626 The names of all files in the directories listed will be
3627 passed as arguments to
3628 .Dq Nm ldconfig Fl 32 .
3629 .It Va kern_securelevel_enable
3633 to set the kernel security level at system startup.
3634 .It Va kern_securelevel
3636 The kernel security level to set at startup.
3637 The allowed range of
3639 ranges from \-1 (the compile time default) to 3 (the
3643 for the list of possible security levels and their effect
3644 on system operation.
3647 Path to the SSH server program
3648 .Pa ( /usr/sbin/sshd
3656 at system boot time.
3663 these are the flags to pass to the
3668 Path to the FTP server program
3669 .Pa ( /usr/libexec/ftpd
3677 as a stand-alone daemon at system boot time.
3684 these are the additional flags to pass to the
3687 .It Va watchdogd_enable
3693 daemon at boot time.
3694 This requires that the kernel have been compiled with a
3697 .It Va watchdogd_flags
3700 .Va watchdogd_enable
3703 these are the flags passed to the
3706 .It Va devfs_rulesets
3708 List of files containing sets of rules for
3710 .It Va devfs_system_ruleset
3712 Rule name(s) to apply to the system
3715 .It Va devfs_set_rulesets
3717 Pairs of already-mounted
3719 directories and rulesets that should be applied to them.
3720 For example: /mount/dev=ruleset_name
3721 .It Va devfs_load_rulesets
3723 If set, always load the default rulesets listed in
3724 .Va devfs_rulesets .
3725 .It Va performance_cx_lowest
3727 CPU idle state to use while on AC power.
3732 should use the lowest power state available while
3734 indicates that the lowest latency state (less power savings) should be used.
3735 .It Va performance_cpu_freq
3737 CPU clock frequency to use while on AC power.
3742 should use the lowest frequency available while
3744 indicates that the highest frequency (less power savings) should be used.
3745 .It Va economy_cx_lowest
3747 CPU idle state to use when off AC power.
3752 should use the lowest power state available while
3754 indicates that the lowest latency state (less power savings) should be used.
3755 .It Va economy_cpu_freq
3757 CPU clock frequency to use when off AC power.
3762 should use the lowest frequency available while
3764 indicates that the highest frequency (less power savings) should be used.
3769 any configured jails will not be started.
3770 .It Va jail_parallel_start
3774 all configured jails will be started in the background (in parallel).
3777 A space separated list of names for jails.
3778 This is purely a configuration aid to help identify and
3779 configure multiple jails.
3780 The names specified in this list will be used to
3781 identify settings common to an instance of a jail,
3782 and should contain alphanumeric characters only.
3783 Assuming that the jail in question was named
3785 you would have the following dependent variables:
3787 jail_vjail_hostname="jail.example.com"
3788 jail_vjail_ip="192.0.2.100"
3789 jail_vjail_rootdir="/var/jails/vjail/root"
3795 When set, use as default value for
3796 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3799 .It Va jail_interface
3802 When set, use as default value for
3803 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3809 When set, use as default value for
3810 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3813 .It Va jail_mount_enable
3821 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3824 by default for every jail in
3826 .It Va jail_devfs_ruleset
3830 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3831 to given value for every jail in
3833 .It Va jail_devfs_enable
3841 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3844 by default for every jail in
3846 .It Va jail_fdescfs_enable
3854 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3857 by default for every jail in
3859 .It Va jail_procfs_enable
3867 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3870 by default for every jail in
3872 .It Va jail_exec_prestart Ns Aq Ar N
3875 When set, use as default value for
3876 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3879 .It Va jail_exec_start
3882 When set, use as default value for
3883 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3886 .It Va jail_exec_afterstart Ns Aq Ar N
3889 When set, use as default value for
3890 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3893 .It Va jail_exec_poststart Ns Aq Ar N
3896 When set, use as default value for
3897 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3900 .It Va jail_exec_prestop Ns Aq Ar N
3903 When set, use as default value for
3904 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3907 .It Va jail_exec_stop
3909 When set, use as default value for
3910 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3913 .It Va jail_exec_poststop Ns Aq Ar N
3916 When set, use as default value for
3917 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3920 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3923 Set to the root directory used by jail
3925 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3928 Set to the fully qualified domain name (FQDN) assigned to jail
3930 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3933 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3934 The argument can be a sole address or a comma separated list of addresses.
3935 Additionally each address can be prefixed by the name of an interface
3936 followed by a pipe to overwrite
3937 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3940 and/or suffixed by a netmask, prefixlen or prefix.
3941 In case no netmask, prefixlen or prefix is given,
3943 will be used for IPv4 and
3945 will be used for an IPv6 address.
3946 If no address is given for the jail then the jail will be started with
3947 no networking support.
3948 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3951 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3952 The sequence starts with
3954 and the numbers have to be strictly ascending.
3955 These entries follow the same syntax as their primary
3956 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3958 The order of the entries can be important as the first address for
3959 each address family found will be the primary address of the jail.
3965 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3970 These are flags to pass to
3972 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3975 When set, sets the interface to use when setting IP address alias.
3976 Note that the alias is created at jail startup and removed at jail shutdown.
3977 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3980 When set, the jail is started with the specified forwarding table (sometimes
3981 referred to as a routing table) via
3983 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3986 .Pa /etc/fstab. Ns Aq Ar jname
3988 This is the file system information file to use for jail
3990 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3997 mount all file systems from
3998 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
4000 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
4003 When set, defines the device file system ruleset file to use for jail
4005 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4012 mount the device file system inside jail
4015 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4022 mount the file-descriptor file system inside jail
4025 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
4032 mount the process file system inside jail
4035 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
4038 This is the command run as
4041 before jail startup, where
4044 It is run outside the jail.
4045 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
4048 .Dq Li /bin/sh /etc/rc
4050 This is the command executed in a jail at jail startup.
4051 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
4054 This is the command run as
4058 after jail startup, where
4061 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
4064 This is the command run as
4067 after jail startup, where
4070 It is run outside the jail.
4071 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
4074 This is the command run as
4077 before jail shutdown, where
4080 It is run outside the jail.
4081 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4084 .Dq Li /bin/sh /etc/rc.shutdown
4086 This is the command executed in a jail at jail shutdown.
4087 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
4090 This is the command run as
4093 after jail shutdown, where
4096 It is run outside the jail.
4097 .It Va jail_set_hostname_allow
4101 do not allow the root user in a jail to set its hostname.
4102 .It Va jail_socket_unixiproute_only
4106 do not allow any sockets,
4107 besides UNIX/IP/route sockets,
4108 to be used within a jail.
4109 .It Va jail_sysvipc_allow
4113 allow applications within a jail to use System V IPC.
4114 .\" -----------------------------------------------------
4115 .It Va harvest_interrupt
4119 to use hardware interrupts as an entropy source.
4122 for more information.
4123 .It Va harvest_ethernet
4127 to use LAN traffic as an entropy source.
4130 for more information.
4131 .It Va harvest_p_to_p
4135 to use serial line traffic as an entropy source.
4138 for more information.
4143 to disable caching entropy via
4145 Otherwise set to the directory used to store entropy files in.
4150 to disable caching entropy through reboots.
4151 Otherwise set to the filename used to store cached entropy through
4153 This file should be located on the root file system to seed the
4155 device as early as possible in the boot process.
4156 .It Va entropy_save_sz
4158 Size of the entropy cache files saved by
4161 .It Va entropy_save_num
4163 Number of entropy cache files to save by
4177 Configuration file for
4186 .Pa /var/run/dmesg.boot
4188 .It Va rcshutdown_timeout
4190 If set, start a watchdog timer in the background which will terminate
4194 has not completed within the specified time (in seconds).
4195 Notice that in addition to this soft timeout,
4197 also applies a hard timeout for the execution of
4199 This is configured via
4202 .Va kern.init_shutdown_timeout
4203 and defaults to 120 seconds.
4204 Setting the value of
4205 .Va rcshutdown_timeout
4206 to more than 120 seconds will have no effect until the
4209 .Va kern.init_shutdown_timeout
4211 .It Va virecover_enable
4215 to prevent the system from trying to
4216 recover pre-maturely terminated
4219 .It Va ugidfw_enable
4224 .Xr mac_bsdextended 4
4225 module upon system initialization and load a default
4227 .It Va bsdextended_script
4230 .Xr mac_bsdextended 4
4231 ruleset file to load.
4232 The default value of this variable is
4233 .Pa /etc/rc.bsdextended .
4234 .It Va newsyslog_enable
4241 .It Va newsyslog_flags
4244 .Va newsyslog_enable
4247 these are the flags to pass to the
4252 which causes log files flagged with a
4255 .It Va mdconfig_md Ns Aq Ar X
4265 must be specified and either a
4267 for malloc or swap backed
4275 .Va mdconfig_md Ns Aq Ar X
4276 variables are evaluated until one variable is unset or null.
4277 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4279 Optional arguments passed to
4285 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4287 An ownership specification passed to
4296 device and the mount point will be changed.
4297 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4299 A mode string passed to
4308 device and the mount point will be changed.
4309 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4311 Files to be copied to the mount point of the
4315 after it has been mounted.
4316 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4318 Command to execute after the specified
4323 Note that the command is passed to
4329 variables can be used to reference respectively the
4331 device and the mount point.
4336 one could set the following:
4338 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4340 .It Va autobridge_interfaces
4342 Set to the list of bridge interfaces that will have newly arriving interfaces
4343 checked against to be automatically added.
4346 then for each whitespace separated
4349 .Va autobridge_ Ns Aq Ar element
4350 variable is assumed to exist which has a whitespace separated list of interface
4351 names to match, these names can use wildcards.
4354 autobridge_interfaces="bridge0"
4355 autobridge_bridge0="tap* dc0 vlan[345]"
4361 enable support for sound mixer.
4362 .It Va hcsecd_enable
4366 enable Bluetooth security daemon.
4367 .It Va hcsecd_config
4369 Configuration file for
4372 .Pa /etc/bluetooth/hcsecd.conf .
4377 enable Bluetooth Service Discovery Protocol daemon.
4385 .It Va sdpd_groupname
4389 group to run as after it initializes.
4392 .It Va sdpd_username
4396 user to run as after it initializes.
4399 .It Va bthidd_enable
4403 enable Bluetooth Human Interface Device daemon.
4404 .It Va bthidd_config
4406 Configuration file for
4409 .Pa /etc/bluetooth/bthidd.conf .
4412 Path to a file, where
4414 will store information about known HID devices.
4416 .Pa /var/db/bthidd.hids .
4417 .It Va rfcomm_pppd_server_enable
4421 enable Bluetooth RFCOMM PPP wrapper daemon.
4422 .It Va rfcomm_pppd_server_profile
4424 The name of the profile to use from
4425 .Pa /etc/ppp/ppp.conf .
4426 Multiple profiles can be specified here.
4427 Also used to specify per-profile overrides.
4428 When the profile name contains any of the characters
4430 they are translated to
4432 for the proposes of the override variable names.
4433 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4435 Overrides local address to listen on.
4441 The address can be specified as BD_ADDR or name.
4442 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4444 Overrides local RFCOMM channel to listen on.
4447 will listen on RFCOMM channel 1.
4448 Must set properly if multiple profiles used in the same time.
4449 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4453 if it should register Serial Port service on the specified RFCOMM channel.
4456 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4460 if it should register Dial-Up Networking service on the specified
4464 .It Va ubthidhci_enable
4468 change the USB Bluetooth controller from HID mode to HCI mode.
4469 You also need to specify the location of USB Bluetooth controller with the
4470 .Va ubthidhci_busnum
4474 .It Va ubthidhci_busnum
4475 Bus number where the USB Bluetooth controller is located.
4478 on your system to find this information.
4479 .It Va ubthidhci_addr
4480 Bus address of the USB Bluetooth controller.
4483 on your system to find this information.
4484 .It Va netwait_enable
4488 delays the start of network-reliant services until
4490 is up and ICMP packets to a destination defined in
4493 Link state is examined first, followed by
4495 an IP address to verify network usability.
4496 If no destination can be reached or timeouts are exceeded,
4497 network services are started anyway with no guarantee that
4498 the network is usable.
4499 Use of this variable requires both
4507 This variable contains a space-delimited list of IP addresses to
4509 DNS hostnames should not be used as resolution is not guaranteed
4510 to be functional at this point.
4511 If multiple IP addresses are specified,
4512 each will be tried until one is successful or the list is exhausted.
4513 .It Va netwait_timeout
4515 Indicates the total number of seconds to perform a
4517 against each IP address in
4519 at a rate of one ping per second.
4520 If any of the pings are successful,
4521 full network connectivity is considered reliable.
4526 Defines the name of the network interface on which watch for link.
4528 is used to monitor the interface, looking for
4529 .Dq Li status: no carrier .
4530 Once gone, the link is considered up.
4533 interface if desired.
4534 .It Va netwait_if_timeout
4536 Defines the total number of seconds to wait for link to become usable,
4537 polled at a 1-second interval.
4541 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4542 .It Pa /etc/defaults/rc.conf
4544 .It Pa /etc/rc.conf.local
4573 .Xr newsyslog.conf 5 ,
4643 .An Jordan K. Hubbard .
projects / FreeBSD / FreeBSD.git / blob