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 fowarding 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
1452 keyword. For example:
1454 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1455 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1458 Interfaces that have an
1459 .Dq Li inet6 accept_rtadv
1461 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1462 setting will be automatically configured by SLAAC
1463 .Pq StateLess Address AutoConfiguration
1469 Note that a link-local address will be automatically configured in
1470 addition to the configured global-scope addresses because the IPv6
1471 specifications require it on each link.
1472 The address is calculated from the MAC address by using an algorithm
1479 If only a link-local address is needed on the interface,
1480 the following configuration can be used:
1482 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1485 A link-local address can also be configured manually.
1486 This is useful for the default router address of an IPv6 router
1487 so that it does not change when the network interface
1491 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1493 .It Va ipv6_prefix_ Ns Aq Ar interface
1495 If one or more prefixes are defined in
1496 .Va ipv6_prefix_ Ns Aq Ar interface
1497 addresses based on each prefix and the EUI-64 interface index will be
1498 configured on that interface.
1499 Note that this variable will be ignored when
1500 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1503 For example, the following configuration
1505 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1508 is equivalent to the following:
1510 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1511 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1512 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1513 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1516 These Subnet-Router anycast addresses will be added only when
1517 .Va ipv6_gateway_enable
1519 .It Va ipv6_default_interface
1523 this is the default output interface for scoped addresses.
1524 This works only with ipv6_gateway_enable="NO".
1525 .It Va ip6addrctl_enable
1527 This variable is to enable configuring default address selection policy table
1529 The table can be specified in another variable
1530 .Va ip6addrctl_policy .
1532 .Va ip6addrctl_policy
1533 the following keywords can be specified:
1534 .Dq Li ipv4_prefer ,
1535 .Dq Li ipv6_prefer ,
1545 installs a pre-defined policy table described in Section 2.1
1553 is specified, it attempts to read a file
1554 .Pa /etc/ip6addrctl.conf
1555 first. If this file is found,
1557 reads and installs it. If not found, a policy is automatically set
1559 .Va ipv6_activate_all_interfaces
1560 variable; if the variable is set to
1562 the IPv6-preferred one is used. Otherwise IPv4-preferred.
1564 The default value of
1565 .Va ip6addrctl_enable
1567 .Va ip6addrctl_policy
1573 .It Va cloned_interfaces
1575 Set to the list of clonable network interfaces to create on this host.
1576 Further cloning arguments may be passed to the
1579 command for each interface by setting the
1580 .Va create_args_ Ns Aq Ar interface
1583 .Va cloned_interfaces
1584 are automatically appended to
1585 .Va network_interfaces
1587 .It Va fec_interfaces
1591 Fast EtherChannel interfaces to configure on this host.
1593 .Va fecconfig_ Ns Aq Ar interface
1594 variable is assumed to exist for each value of
1596 The value of this variable is used to configure link aggregated interfaces
1597 according to the syntax of the
1598 .Cm NGM_FEC_ADD_IFACE
1602 Additionally, this option ensures that each listed interface is created
1607 before attempting to configure it.
1610 fec_interfaces="fec0"
1611 fecconfig_fec0="em0 em1"
1612 ifconfig_fec0="DHCP"
1614 .It Va gif_interfaces
1618 tunnel interfaces to configure on this host.
1620 .Va gifconfig_ Ns Aq Ar interface
1621 variable is assumed to exist for each value of
1623 The value of this variable is used to configure the link layer of the
1624 tunnel according to the syntax of the
1628 Additionally, this option ensures that each listed interface is created
1633 before attempting to configure it.
1634 .It Va sppp_interfaces
1638 interfaces to configure on this host.
1640 .Va spppconfig_ Ns Aq Ar interface
1641 variable is assumed to exist for each value of
1643 Each interface should also be configured by a general
1644 .Va ifconfig_ Ns Aq Ar interface
1648 for more information about available options.
1658 The name of the profile to use from
1659 .Pa /etc/ppp/ppp.conf .
1660 Also used for per-profile overrides of
1665 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1666 When the profile name contains any of the characters
1668 they are translated to
1670 for the proposes of the override variable names.
1673 Mode in which to run the
1676 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1678 Overrides the global
1688 See the manual for a full description.
1693 enables network address translation.
1694 Used in conjunction with
1696 allows hosts on private network addresses access to the Internet using
1697 this host as a network address translating router.
1698 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1700 Overrides the global
1704 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1706 Set the unit number to be used for this profile.
1707 See the manual description of
1712 The name of the user under which
1720 .It Va rc_conf_files
1722 This option is used to specify a list of files that will override
1724 .Pa /etc/defaults/rc.conf .
1725 The files will be read in the order in which they are specified and should
1726 include the full path to the file.
1727 By default, the files specified are
1730 .Pa /etc/rc.conf.local
1736 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1738 .It Va gptboot_enable
1742 .Pa /etc/rc.d/gptboot
1743 will log if the system successfully (or not) booted from a GPT partition,
1749 .It Va gbde_autoattach_all
1754 will attempt to automatically initialize your .bde devices in
1758 List the devices that the script should try to attach,
1763 The directory where the
1765 lockfiles are located.
1766 The default lockfile directory is
1769 The lockfile for each individual
1771 device can be overridden by setting the variable
1772 .Va gbde_lock_ Ns Aq Ar device ,
1775 is the encrypted device without the
1780 .It Va gbde_attach_attempts
1782 Number of times to attempt attaching to a
1784 device, i.e., how many times the user is asked for the pass-phrase.
1788 List of devices to automatically attach on boot.
1789 Note that .eli devices from
1791 are automatically appended to this list.
1794 Number of times user is asked for the pass-phrase.
1795 If empty, it will be taken from
1796 .Va kern.geom.eli.tries
1798 .It Va geli_default_flags
1800 Default flags to use by
1802 when configuring disk encryption.
1803 Flags can be configured for every device separately by defining
1804 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1806 .It Va geli_autodetach
1808 Specifies if GELI devices should be marked for detach on last close after
1809 file systems are mounted.
1812 This can be changed for every device separately by defining
1813 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1815 .It Va geli_swap_flags
1816 Options passed to the
1818 utility when encrypted GEOM providers for swap partitions are created.
1820 .Dq Li "-e aes -l 256 -s 4096 -d" .
1821 .It Va root_rw_mount
1826 After the file systems are checked at boot time, the root file system
1827 is remounted as read-write if this is set to
1829 Diskless systems that mount their root file system from a read-only remote
1830 NFS share should set this to
1834 .It Va fsck_y_enable
1839 will be run with the
1841 flag if the initial preen
1842 of the file systems fails.
1843 .It Va background_fsck
1847 the system will attempt to run
1849 in the background where possible.
1850 .It Va background_fsck_delay
1852 The amount of time in seconds to sleep before starting a background
1854 It defaults to sixty seconds to allow large applications such as
1855 the X server to start before disk I/O bandwidth is monopolized by
1857 If set to a negative number, the background file system check will be
1858 delayed indefinitely to allow the administrator to run it at a more
1860 For example it may be run from
1862 by adding a line like
1864 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1870 List of file system types that are network-based.
1871 This list should generally not be modified by end users.
1873 .Va extra_netfs_types
1875 .It Va extra_netfs_types
1877 If set to something other than
1880 this variable extends the list of file system types
1881 for which automatic mounting at startup by
1883 should be delayed until the network is initialized.
1885 a whitespace-separated list of network file system descriptor pairs,
1886 each consisting of a file system type as passed to
1888 and a human-readable, one-word description,
1891 Extending the default list in this way is only necessary
1892 when third party file system types are used.
1893 .It Va syslogd_enable
1900 .It Va syslogd_program
1905 .Pa /usr/sbin/syslogd ) .
1906 .It Va syslogd_flags
1912 these are the flags to pass to
1921 .It Va inetd_program
1926 .Pa /usr/sbin/inetd ) .
1933 these are the flags to pass to
1942 .It Va hastd_program
1954 these are the flags to pass to
1963 .It Va named_program
1968 .Pa /usr/sbin/named ) .
1973 configuration file, (default
1974 .Pa /etc/namedb/named.conf ) .
1981 these are the flags to pass to
1987 process should be run as.
1988 .It Va named_chrootdir
1990 The root directory for a name server run in a
1992 environment (default
1996 will not be run in a
1999 .It Va named_chroot_autoupdate
2003 to disable automatic update of the
2006 .It Va named_symlink_enable
2010 to disable symlinking of
2019 loop until working name service is established.
2020 .It Va named_wait_host
2022 Name of host to lookup for the named_wait option.
2024 .It Va named_auto_forward
2026 Set to enable automatic creation of a forwarder
2027 configuration file derived from
2028 .Pa /etc/resolv.conf .
2029 .It Va named_auto_forward_only
2031 Set to change the default forwarder configuration from
2035 .It Va kerberos5_server_enable
2039 to start a Kerberos 5 authentication server
2041 .It Va kerberos5_server
2044 .Va kerberos5_server_enable
2047 this is the path to Kerberos 5 Authentication Server.
2048 .It Va kerberos5_server_flags
2051 This variable contains additional flags to be passed to the Kerberos 5
2052 authentication server.
2053 .It Va kadmind5_server_enable
2059 the Kerberos 5 Administration Daemon; set to
2062 .It Va kadmind5_server
2065 .Va kadmind5_server_enable
2068 this is the path to Kerberos 5 Administration Daemon.
2069 .It Va kpasswdd_server_enable
2075 the Kerberos 5 Password-Changing Daemon; set to
2078 .It Va kpasswdd_server
2081 .Va kpasswdd_server_enable
2084 this is the path to Kerberos 5 Password-Changing Daemon.
2091 daemon at boot time.
2098 these are the flags to pass to it.
2105 daemon at boot time.
2112 these are the flags to pass to it.
2115 manpage for more information.
2116 .It Va amd_map_program
2119 the specified program is run to get the list of
2124 maps are stored in NIS, one can set this to
2137 will be updated at boot time to reflect the kernel release
2142 will not be updated.
2143 .It Va nfs_client_enable
2147 run the NFS client daemons at boot time.
2148 .It Va nfs_access_cache
2151 .Va nfs_client_enable
2156 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2158 results should be cached.
2159 A value of 2-10 seconds will substantially reduce network
2160 traffic for many NFS operations.
2161 .It Va nfs_server_enable
2165 run the NFS server daemons at boot time.
2166 .It Va nfs_server_flags
2169 .Va nfs_server_enable
2172 these are the flags to pass to the
2175 .It Va nfsv4_server_enable
2178 .Va nfs_server_enable
2182 .Va nfsv4_server_enable
2185 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2186 .It Va nfsuserd_enable
2192 run the nfsuserd daemon, which is needed for NFSv4 in order
2193 to map between user/group names vs uid/gid numbers.
2195 .Va nfsv4_server_enable
2198 this will be forced enabled.
2199 .It Va nfsuserd_flags
2205 these are the flags to pass to the
2208 .It Va nfscbd_enable
2214 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2221 these are the flags to pass to the
2224 .It Va oldnfs_server_enable
2227 .Va oldnfs_server_enable
2230 force the NFS server daemons to run the old NFS server code
2231 that does not support NFSv4.
2232 .It Va mountd_enable
2237 .Va nfs_server_enable
2243 It is commonly needed to run CFS without real NFS used.
2250 these are the flags to pass to the
2253 .It Va weak_mountd_authentication
2257 allow services like PCNFSD to make non-privileged mount
2259 .It Va nfs_reserved_port_only
2263 provide NFS services only on a secure port.
2264 .It Va nfs_bufpackets
2266 If set to a number, indicates the number of packets worth of
2267 socket buffer space to reserve on an NFS client.
2268 The kernel default is typically 4.
2269 Using a higher number may be
2270 useful on gigabit networks to improve performance.
2271 The minimum value is
2272 2 and the maximum is 64.
2273 .It Va rpc_lockd_enable
2277 and also an NFS server or client, run
2280 .It Va rpc_lockd_flags
2283 .Va rpc_lockd_enable
2286 these are the flags to pass to the
2289 .It Va rpc_statd_enable
2293 and also an NFS server or client, run
2296 .It Va rpc_statd_flags
2299 .Va rpc_statd_enable
2302 these are the flags to pass to the
2305 .It Va rpcbind_program
2310 .Pa /usr/sbin/rpcbind ) .
2311 .It Va rpcbind_enable
2317 service at boot time.
2318 .It Va rpcbind_flags
2324 these are the flags to pass to the
2327 .It Va keyserv_enable
2333 daemon on boot for running Secure RPC.
2334 .It Va keyserv_flags
2340 these are the flags to pass to
2343 .It Va pppoed_enable
2349 daemon at boot time to provide PPP over Ethernet services.
2350 .It Va pppoed_ Ns Aq Ar provider
2353 listens to requests to this
2359 argument of the same name.
2362 Additional flags to pass to
2364 .It Va pppoed_interface
2366 The network interface to run
2369 This is mandatory when
2379 service at boot time.
2380 This command is intended for networks of
2381 machines where a consistent
2383 for all hosts must be established.
2384 This is often useful in large NFS
2385 environments where time stamps on files are expected to be consistent
2393 these are the flags to pass to the
2396 .It Va ntpdate_enable
2403 This command is intended to
2404 synchronize the system clock only
2406 from some standard reference.
2407 An option to set this up initially
2408 (from a list of known servers) is also provided by the
2410 program when the system is first installed.
2411 .It Va ntpdate_config
2413 Configuration file for
2417 .It Va ntpdate_hosts
2419 A whitespace-separated list of NTP servers to synchronize with at startup.
2420 The default is to use the servers listed in
2421 .Va ntpdate_config ,
2422 if that file exists.
2423 .It Va ntpdate_program
2428 .Pa /usr/sbin/ntpdate ) .
2429 .It Va ntpdate_flags
2435 these are the flags to pass to the
2437 command (typically a hostname).
2444 command at boot time.
2450 .Pa /usr/sbin/ntpd ) .
2464 these are the flags to pass to the
2467 .It Va ntpd_sync_on_start
2474 flag, which syncs the system's clock on startup.
2477 for more information regarding the
2480 This is a preferred alternative to using
2485 .It Va nis_client_enable
2491 service at system boot time.
2492 .It Va nis_client_flags
2495 .Va nis_client_enable
2498 these are the flags to pass to the
2501 .It Va nis_ypset_enable
2507 daemon at system boot time.
2508 .It Va nis_ypset_flags
2511 .Va nis_ypset_enable
2514 these are the flags to pass to the
2517 .It Va nis_server_enable
2523 daemon at system boot time.
2524 .It Va nis_server_flags
2527 .Va nis_server_enable
2530 these are the flags to pass to the
2533 .It Va nis_ypxfrd_enable
2539 daemon at system boot time.
2540 .It Va nis_ypxfrd_flags
2543 .Va nis_ypxfrd_enable
2546 these are the flags to pass to the
2549 .It Va nis_yppasswdd_enable
2555 daemon at system boot time.
2556 .It Va nis_yppasswdd_flags
2559 .Va nis_yppasswdd_enable
2562 these are the flags to pass to the
2565 .It Va rpc_ypupdated_enable
2571 daemon at system boot time.
2572 .It Va bsnmpd_enable
2578 daemon at system boot time.
2579 Be sure to understand the security implications of running SNMP daemon
2587 these are the flags to pass to the
2590 .It Va defaultrouter
2594 create a default route to this host name or IP address
2595 (use an IP address if this router is also required to get to the
2597 .It Va ipv6_defaultrouter
2599 The IPv6 equivalent of
2601 .It Va static_arp_pairs
2603 Set to the list of static ARP pairs that are to be added at system
2605 For each whitespace separated
2608 .Va static_arp_ Ns Aq Ar element
2609 variable is assumed to exist whose contents will later be passed to a
2614 static_arp_pairs="gw"
2615 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2617 .It Va static_ndp_pairs
2619 Set to the list of static NDP pairs that are to be added at system
2621 For each whitespace separated
2624 .Va static_ndp_ Ns Aq Ar element
2625 variable is assumed to exist whose contents will later be passed to a
2630 static_ndp_pairs="gw"
2631 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2633 .It Va static_routes
2635 Set to the list of static routes that are to be added at system
2639 then for each whitespace separated
2642 .Va route_ Ns Aq Ar element
2643 variable is assumed to exist
2644 whose contents will later be passed to a
2649 static_routes="mcast gif0local"
2650 route_mcast="-net 224.0.0.0/4 -iface gif0"
2651 route_gif0local="-host 169.254.1.1 -iface lo0"
2653 .It Va ipv6_static_routes
2655 The IPv6 equivalent of
2659 then for each whitespace separated
2662 .Va ipv6_route_ Ns Aq Ar element
2663 variable is assumed to exist
2664 whose contents will later be passed to a
2665 .Dq Nm route Cm add Fl inet6
2667 .It Va natm_static_routes
2673 If not empty then for each whitespace separated
2676 .Va route_ Ns Aq Ar element
2677 variable is assumed to exist whose contents will later be passed to a
2678 .Dq Nm atmconfig Cm natm Cm add
2680 .It Va gateway_enable
2684 configure host to act as an IP router, e.g.\& to forward packets
2686 .It Va ipv6_gateway_enable
2688 The IPv6 equivalent of
2689 .Va gateway_enable .
2690 .It Va routed_enable
2694 run a routing daemon of some sort, based on the
2699 .It Va route6d_enable
2701 The IPv6 equivalent of
2705 run a routing daemon of some sort, based on the
2710 .It Va routed_program
2716 this is the name of the routing daemon to use.
2717 .It Va route6d_program
2719 The IPv6 equivalent of
2720 .Va routed_program .
2727 these are the flags to pass to the routing daemon.
2728 .It Va route6d_flags
2730 The IPv6 equivalent of
2732 .It Va mrouted_enable
2736 run the multicast routing daemon,
2738 .It Va mroute6d_enable
2740 The IPv6 equivalent of
2741 .Va mrouted_enable .
2744 run the IPv6 multicast routing daemon.
2746 Note that multicast routing daemons are no longer included in the
2748 base system, however, both
2752 may be installed from the
2755 .It Va mrouted_flags
2761 these are the flags to pass to the
2764 .It Va mroute6d_flags
2766 The IPv6 equivalent of
2772 these are the flags passed to the IPv6 multicast routing daemon.
2773 .It Va mroute6d_program
2779 this is the path to the IPv6 multicast routing daemon.
2780 .It Va rtadvd_enable
2786 daemon at boot time.
2789 utility sends ICMPv6 Router Advertisement messages to
2790 the interfaces specified in
2791 .Va rtadvd_interfaces .
2792 This should only be enabled with great care.
2793 You may want to fine-tune
2795 .It Va rtadvd_interfaces
2801 this is the list of interfaces to use.
2802 .It Va ipxgateway_enable
2806 enable the routing of IPX traffic.
2807 .It Va ipxrouted_enable
2813 daemon at system boot time.
2814 .It Va ipxrouted_flags
2817 .Va ipxrouted_enable
2820 these are the flags to pass to the
2827 enable global proxy ARP.
2828 .It Va forward_sourceroute
2836 source-routed packets are forwarded.
2837 .It Va accept_sourceroute
2841 the system will accept source-routed packets directed at it.
2848 daemon at system boot time.
2855 these are the flags to pass to the
2858 .It Va bootparamd_enable
2864 daemon at system boot time.
2865 .It Va bootparamd_flags
2868 .Va bootparamd_enable
2871 these are the flags to pass to the
2874 .It Va stf_interface_ipv4addr
2878 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2880 Specify this entry to enable the 6to4 interface.
2881 .It Va stf_interface_ipv4plen
2883 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2884 An effective value is 0-31.
2885 .It Va stf_interface_ipv6_ifid
2887 IPv6 interface ID for
2891 .It Va stf_interface_ipv6_slaid
2893 IPv6 Site Level Aggregator for
2895 .It Va ipv6_faith_prefix
2899 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2904 .It Va ipv6_ipv4mapping
2908 this enables IPv4 mapped IPv6 address communication (like
2909 .Li ::ffff:a.b.c.d ) .
2914 to enable the configuration of ATM interfaces at system boot time.
2915 For all of the ATM variables described below, please refer to the
2917 manual page for further details on the available command parameters.
2918 Also refer to the files in
2919 .Pa /usr/share/examples/atm
2920 for more detailed configuration information.
2923 This is a list of physical ATM interface drivers to load.
2928 .It Va atm_netif_ Ns Aq Ar intf
2930 For the ATM physical interface
2932 this variable defines the name prefix and count for the ATM network
2933 interfaces to be created.
2934 The value will be passed as the parameters of an
2935 .Dq Nm atm Cm "set netif" Ar intf
2937 .It Va atm_sigmgr_ Ns Aq Ar intf
2939 For the ATM physical interface
2941 this variable defines the ATM signalling manager to be used.
2942 The value will be passed as the parameters of an
2943 .Dq Nm atm Cm attach Ar intf
2945 .It Va atm_prefix_ Ns Aq Ar intf
2947 For the ATM physical interface
2949 this variable defines the NSAP prefix for interfaces using a UNI signalling
2953 the prefix will automatically be set via the
2956 Otherwise, the value will be passed as the parameters of an
2957 .Dq Nm atm Cm "set prefix" Ar intf
2959 .It Va atm_macaddr_ Ns Aq Ar intf
2961 For the ATM physical interface
2963 this variable defines the MAC address for interfaces using a UNI signalling
2967 the hardware MAC address contained in the ATM interface card will be used.
2968 Otherwise, the value will be passed as the parameters of an
2969 .Dq Nm atm Cm "set mac" Ar intf
2971 .It Va atm_arpserver_ Ns Aq Ar netif
2973 For the ATM network interface
2975 this variable defines the ATM address for a host which is to provide ATMARP
2977 This variable is only applicable to interfaces using a UNI signalling
2981 this host will become an ATMARP server.
2982 The value will be passed as the parameters of an
2983 .Dq Nm atm Cm "set arpserver" Ar netif
2985 .It Va atm_scsparp_ Ns Aq Ar netif
2989 SCSP/ATMARP service for the network interface
2991 will be initiated using the
2996 This variable is only applicable if
2997 .Va atm_arpserver_ Ns Aq Ar netif
3002 Set to the list of ATM PVCs to be added at system
3004 For each whitespace separated
3007 .Va atm_pvc_ 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 pvc"
3015 Set to the list of permanent ATM ARP entries to be added
3016 at system boot time.
3017 For each whitespace separated
3020 .Va atm_arp_ Ns Aq Ar element
3021 variable is assumed to exist.
3022 The value of each of these variables
3023 will be passed as the parameters of an
3024 .Dq Nm atm Cm "add arp"
3026 .It Va natm_interfaces
3030 interfaces that will also be used for HARP through
3032 If this list is not empty all interfaces in the list will be brought up
3038 For this to work the interface drivers must be either compiled into the
3039 kernel or must reside on the root partition.
3042 The keyboard bell sound.
3049 if the default behavior is desired.
3050 For details, refer to the
3055 If set to a non-null string, the virtual console's keyboard input is
3061 no keymap is installed, otherwise the value is used to install
3063 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3066 The keyboard repeat speed.
3073 if the default behavior is desired.
3078 attempt to program the function keys with the value.
3080 be a single string of the form:
3081 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3084 Can be set to the value of
3087 .Dq Li destructive ,
3090 to set the cursor behavior explicitly or choose the default behavior.
3095 no screen map is installed, otherwise the value is used to install
3096 the screen map file in
3097 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3102 the default 8x16 font value is used for screen size requests, otherwise
3104 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3110 the default 8x14 font value is used for screen size requests, otherwise
3112 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3118 the default 8x8 font value is used for screen size requests, otherwise
3120 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3126 the default screen blanking interval is used, otherwise it is set
3134 this is the actual screen saver to use
3135 .Li ( blank , snake , daemon ,
3137 .It Va moused_nondefault_enable
3141 the mouse device specified on
3142 the command line is not automatically treated as enabled by the
3143 .Pa /etc/rc.d/moused
3145 Having this variable set to
3151 to be enabled as soon as it is plugged in.
3152 .It Va moused_enable
3158 daemon is started for doing cut/paste selection on the console.
3161 This is the protocol type of the mouse connected to this host.
3162 This variable must be set if
3169 is able to detect the appropriate mouse type automatically in many cases.
3170 Set this variable to
3172 to let the daemon detect it, or
3173 select one from the following list if the automatic detection fails.
3175 If the mouse is attached to the PS/2 mouse port, choose
3179 regardless of the brand and model of the mouse.
3181 mouse is attached to the bus mouse port, choose
3185 All other protocols are for serial mice and will not work with
3186 the PS/2 and bus mice.
3187 If this is a USB mouse,
3189 is the only protocol type which will work.
3191 .Bl -tag -width ".Li x10mouseremote" -compact
3193 Microsoft mouse (serial)
3195 Microsoft IntelliMouse (serial)
3197 Mouse systems Corp.\& mouse (serial)
3199 MM Series mouse (serial)
3201 Logitech mouse (serial)
3205 Logitech MouseMan and TrackMan (serial)
3207 ALPS GlidePoint (serial)
3208 .It Li thinkingmouse
3209 Kensington ThinkingMouse (serial)
3213 MM HitTablet (serial)
3214 .It Li x10mouseremote
3215 X10 MouseRemote (serial)
3217 Interlink VersaPad (serial)
3220 Even if the mouse is not in the above list, it may be compatible
3221 with one in the list.
3222 Refer to the manual page for
3224 for compatibility information.
3226 It should also be noted that while this is enabled, any
3227 other client of the mouse (such as an X server) should access
3228 the mouse through the virtual mouse device,
3230 and configure it as a
3232 type mouse, since all
3233 mouse data is converted to this single canonical format when
3236 If the client program does not support the
3242 It is the second preferred type.
3249 this is the actual port the mouse is on.
3252 for a COM1 serial mouse,
3256 for a bus mouse, for example.
3261 is set, its value is used as an additional set of flags to pass to the
3264 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3266 .Va moused_nondefault_enable
3269 daemon is started for a non-default port, the
3270 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3271 set of options has precedence over and replaces the default
3272 .Va moused_flags (where
3274 is the name of the non-default port, i.e.\&
3277 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3278 it is possible to set up a different set of default flags for each
3281 For example, you can use
3285 to make your laptop's touchpad more comfortable to use,
3286 but an empty set of options for
3287 .Va moused_ums0_flags
3290 mouse has three or more buttons.
3291 .It Va mousechar_start
3295 the default mouse cursor character range
3296 .Li 0xd0 Ns - Ns Li 0xd3
3298 otherwise the range start is set
3303 Use if the default range is occupied in the language code table.
3304 .It Va allscreens_flags
3308 is run with these options for each of the virtual terminals
3312 will enable the mouse pointer on all virtual terminals
3317 .It Va allscreens_kbdflags
3321 is run with these options for each of the virtual terminals
3327 scrollback (history) buffer to 200 lines.
3334 daemon at system boot time.
3340 .Pa /usr/sbin/cron ) .
3347 these are the flags to pass to
3353 enable the special handling of transitions to and from the
3354 Daylight Saving Time in
3356 (equivalent to using the flag
3363 .Pa /usr/sbin/lpd ) .
3370 daemon at system boot time.
3377 these are the flags to pass to the
3380 .It Va chkprintcap_enable
3386 command before starting the
3389 .It Va chkprintcap_flags
3394 .Va chkprintcap_enable
3397 these are the flags to pass to the
3402 which causes missing directories to be created.
3403 .It Va mta_start_script
3405 This variable specifies the full path to the script to run to start
3406 a mail transfer agent.
3408 .Pa /etc/rc.sendmail .
3412 .Pa /etc/rc.sendmail
3413 uses are documented in the
3418 Indicates the device (usually a swap partition) to which a crash dump
3419 should be written in the event of a system crash.
3420 If the value of this variable is
3422 the first suitable swap device listed in
3424 will be used as dump device.
3425 Otherwise, the value of this variable is passed as the argument to
3427 To disable crash dumps, set this variable to
3431 When the system reboots after a crash and a crash dump is found on the
3432 device specified by the
3436 will save that crash dump and a copy of the kernel to the directory
3440 The default value is
3449 .It Va savecore_flags
3451 If crash dumps are enabled, these are the flags to pass to the
3458 to turn on user and group disk quotas on system startup via the
3460 command for all file systems marked as having quotas enabled in
3462 The kernel must be built with
3464 for disk quotas to function.
3469 to enable user and group disk quota checking via the
3472 .It Va quotacheck_flags
3482 these are the flags to pass to the
3487 which checks quotas for all file systems with quotas enabled in
3489 .It Va quotaon_flags
3495 these are the flags to pass to the
3500 which enables quotas for all file systems with quotas enabled in
3502 .It Va quotaoff_flags
3508 these are the flags to pass to the
3510 utility when shutting down the quota system.
3513 which disables quotas for all file systems with quotas enabled in
3515 .It Va accounting_enable
3519 to enable system accounting through the
3526 to enable iBCS2 (SCO) binary emulation at system initial boot
3528 .It Va ibcs2_loaders
3536 this specifies a list of additional iBCS2 loaders to enable.
3541 to enable Linux/ELF binary emulation at system initial
3547 enable SysVR4 emulation at boot time.
3548 .It Va sysvipc_enable
3552 load System V IPC primitives at boot time.
3553 .It Va clear_tmp_enable
3564 to disable removing of X11 lock files,
3565 and the removal and (secure) recreation
3566 of the various socket directories for X11
3568 .It Va ldconfig_paths
3570 Set to the list of shared library paths to use with
3574 will always be added first, so it need not appear in this list.
3575 .It Va ldconfig32_paths
3577 Set to the list of 32-bit compatibility shared library paths to
3580 .It Va ldconfig_paths_aout
3582 Set to the list of shared library paths to use with
3587 .It Va ldconfig_insecure
3591 utility normally refuses to use directories
3592 which are writable by anyone except root.
3593 Set this variable to
3595 to disable that security check during system startup.
3596 .It Va ldconfig_local_dirs
3598 Set to the list of local
3601 The names of all files in the directories listed will be
3602 passed as arguments to
3604 .It Va ldconfig_local32_dirs
3606 Set to the list of local 32-bit compatibility
3609 The names of all files in the directories listed will be
3610 passed as arguments to
3611 .Dq Nm ldconfig Fl 32 .
3612 .It Va kern_securelevel_enable
3616 to set the kernel security level at system startup.
3617 .It Va kern_securelevel
3619 The kernel security level to set at startup.
3620 The allowed range of
3622 ranges from \-1 (the compile time default) to 3 (the
3626 for the list of possible security levels and their effect
3627 on system operation.
3630 Path to the SSH server program
3631 .Pa ( /usr/sbin/sshd
3639 at system boot time.
3646 these are the flags to pass to the
3651 Path to the FTP server program
3652 .Pa ( /usr/libexec/ftpd
3660 as a stand-alone daemon at system boot time.
3667 these are the additional flags to pass to the
3670 .It Va watchdogd_enable
3676 daemon at boot time.
3677 This requires that the kernel have been compiled with a
3680 .It Va watchdogd_flags
3683 .Va watchdogd_enable
3686 these are the flags passed to the
3689 .It Va devfs_rulesets
3691 List of files containing sets of rules for
3693 .It Va devfs_system_ruleset
3695 Rule name(s) to apply to the system
3698 .It Va devfs_set_rulesets
3700 Pairs of already-mounted
3702 directories and rulesets that should be applied to them.
3703 For example: /mount/dev=ruleset_name
3704 .It Va devfs_load_rulesets
3706 If set, always load the default rulesets listed in
3707 .Va devfs_rulesets .
3708 .It Va performance_cx_lowest
3710 CPU idle state to use while on AC power.
3715 should use the lowest power state available while
3717 indicates that the lowest latency state (less power savings) should be used.
3718 .It Va performance_cpu_freq
3720 CPU clock frequency to use while on AC power.
3725 should use the lowest frequency available while
3727 indicates that the highest frequency (less power savings) should be used.
3728 .It Va economy_cx_lowest
3730 CPU idle state to use when off AC power.
3735 should use the lowest power state available while
3737 indicates that the lowest latency state (less power savings) should be used.
3738 .It Va economy_cpu_freq
3740 CPU clock frequency to use when off AC power.
3745 should use the lowest frequency available while
3747 indicates that the highest frequency (less power savings) should be used.
3752 any configured jails will not be started.
3753 .It jail_parallel_start
3757 all configured jails will be started in the background (= in parallel).
3760 A space separated list of names for jails.
3761 This is purely a configuration aid to help identify and
3762 configure multiple jails.
3763 The names specified in this list will be used to
3764 identify settings common to an instance of a jail,
3765 and should contain alphanumeric characters only.
3766 Assuming that the jail in question was named
3768 you would have the following dependent variables:
3770 jail_vjail_hostname="jail.example.com"
3771 jail_vjail_ip="192.0.2.100"
3772 jail_vjail_rootdir="/var/jails/vjail/root"
3778 When set, use as default value for
3779 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3782 .It Va jail_interface
3785 When set, use as default value for
3786 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3792 When set, use as default value for
3793 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3796 .It Va jail_mount_enable
3804 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3807 by default for every jail in
3809 .It Va jail_devfs_ruleset
3813 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3814 to given value for every jail in
3816 .It Va jail_devfs_enable
3824 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3827 by default for every jail in
3829 .It Va jail_fdescfs_enable
3837 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3840 by default for every jail in
3842 .It Va jail_procfs_enable
3850 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3853 by default for every jail in
3855 .It Va jail_exec_prestart Ns Aq Ar N
3858 When set, use as default value for
3859 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3862 .It Va jail_exec_start
3865 When set, use as default value for
3866 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3869 .It Va jail_exec_afterstart Ns Aq Ar N
3872 When set, use as default value for
3873 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3876 .It Va jail_exec_poststart Ns Aq Ar N
3879 When set, use as default value for
3880 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3883 .It Va jail_exec_prestop Ns Aq Ar N
3886 When set, use as default value for
3887 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3890 .It Va jail_exec_stop
3892 When set, use as default value for
3893 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3896 .It Va jail_exec_poststop Ns Aq Ar N
3899 When set, use as default value for
3900 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3903 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3906 Set to the root directory used by jail
3908 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3911 Set to the fully qualified domain name (FQDN) assigned to jail
3913 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3916 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3917 The argument can be a sole address or a comma separated list of addresses.
3918 Additionally each address can be prefixed by the name of an interface
3919 followed by a pipe to overwrite
3920 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3923 and/or suffixed by a netmask, prefixlen or prefix.
3924 In case no netmask, prefixlen or prefix is given,
3926 will be used for IPv4 and
3928 will be used for an IPv6 address.
3929 If no address is given for the jail then the jail will be started with
3930 no networking support.
3931 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3934 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3935 The sequence starts with
3937 and the numbers have to be strictly ascending.
3938 These entries follow the same syntax as their primary
3939 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3941 The order of the entries can be important as the first address for
3942 each address family found will be the primary address of the jail.
3948 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3953 These are flags to pass to
3955 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3958 When set, sets the interface to use when setting IP address alias.
3959 Note that the alias is created at jail startup and removed at jail shutdown.
3960 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3963 When set, the jail is started with the specified forwarding table (sometimes
3964 referred to as a routing table) via
3966 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3969 .Pa /etc/fstab. Ns Aq Ar jname
3971 This is the file system information file to use for jail
3973 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3980 mount all file systems from
3981 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3983 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3986 When set, defines the device file system ruleset file to use for jail
3988 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3995 mount the device file system inside jail
3998 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4005 mount the file-descriptor file system inside jail
4008 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
4015 mount the process file system inside jail
4018 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
4021 This is the command run as
4024 before jail startup, where
4027 It is run outside the jail.
4028 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
4031 .Dq Li /bin/sh /etc/rc
4033 This is the command executed in a jail at jail startup.
4034 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
4037 This is the command run as
4041 after jail startup, where
4044 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
4047 This is the command run as
4050 after jail startup, where
4053 It is run outside the jail.
4054 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
4057 This is the command run as
4060 before jail shutdown, where
4063 It is run outside the jail.
4064 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4067 .Dq Li /bin/sh /etc/rc.shutdown
4069 This is the command executed in a jail at jail shutdown.
4070 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
4073 This is the command run as
4076 after jail shutdown, where
4079 It is run outside the jail.
4080 .It Va jail_set_hostname_allow
4084 do not allow the root user in a jail to set its hostname.
4085 .It Va jail_socket_unixiproute_only
4089 do not allow any sockets,
4090 besides UNIX/IP/route sockets,
4091 to be used within a jail.
4092 .It Va jail_sysvipc_allow
4096 allow applications within a jail to use System V IPC.
4097 .\" -----------------------------------------------------
4098 .It Va harvest_interrupt
4102 to use hardware interrupts as an entropy source.
4105 for more information.
4106 .It Va harvest_ethernet
4110 to use LAN traffic as an entropy source.
4113 for more information.
4114 .It Va harvest_p_to_p
4118 to use serial line traffic as an entropy source.
4121 for more information.
4126 to disable caching entropy via
4128 Otherwise set to the directory used to store entropy files in.
4133 to disable caching entropy through reboots.
4134 Otherwise set to the filename used to store cached entropy through
4136 This file should be located on the root file system to seed the
4138 device as early as possible in the boot process.
4139 .It Va entropy_save_sz
4141 Size of the entropy cache files saved by
4144 .It Va entropy_save_num
4146 Number of entropy cache files to save by
4160 Configuration file for
4169 .Pa /var/run/dmesg.boot
4171 .It Va rcshutdown_timeout
4173 If set, start a watchdog timer in the background which will terminate
4177 has not completed within the specified time (in seconds).
4178 Notice that in addition to this soft timeout,
4180 also applies a hard timeout for the execution of
4182 This is configured via
4185 .Va kern.init_shutdown_timeout
4186 and defaults to 120 seconds.
4187 Setting the value of
4188 .Va rcshutdown_timeout
4189 to more than 120 seconds will have no effect until the
4192 .Va kern.init_shutdown_timeout
4194 .It Va virecover_enable
4198 to prevent the system from trying to
4199 recover pre-maturely terminated
4202 .It Va ugidfw_enable
4207 .Xr mac_bsdextended 4
4208 module upon system initialization and load a default
4210 .It Va bsdextended_script
4213 .Xr mac_bsdextended 4
4214 ruleset file to load.
4215 The default value of this variable is
4216 .Pa /etc/rc.bsdextended .
4217 .It Va newsyslog_enable
4224 .It Va newsyslog_flags
4227 .Va newsyslog_enable
4230 these are the flags to pass to the
4235 which causes log files flagged with a
4238 .It Va mdconfig_md Ns Aq Ar X
4248 must be specified and either a
4250 for malloc or swap backed
4258 .Va mdconfig_md Ns Aq Ar X
4259 variables are evaluated until one variable is unset or null.
4260 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4262 Optional arguments passed to
4268 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4270 An ownership specification passed to
4279 device and the mount point will be changed.
4280 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4282 A mode string passed to
4291 device and the mount point will be changed.
4292 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4294 Files to be copied to the mount point of the
4298 after it has been mounted.
4299 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4301 Command to execute after the specified
4306 Note that the command is passed to
4312 variables can be used to reference respectively the
4314 device and the mount point.
4319 one could set the following:
4321 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4323 .It Va autobridge_interfaces
4325 Set to the list of bridge interfaces that will have newly arriving interfaces
4326 checked against to be automatically added.
4329 then for each whitespace separated
4332 .Va autobridge_ Ns Aq Ar element
4333 variable is assumed to exist which has a whitespace separated list of interface
4334 names to match, these names can use wildcards.
4337 autobridge_interfaces="bridge0"
4338 autobridge_bridge0="tap* dc0 vlan[345]"
4344 enable support for sound mixer.
4345 .It Va hcsecd_enable
4349 enable Bluetooth security daemon.
4350 .It Va hcsecd_config
4352 Configuration file for
4355 .Pa /etc/bluetooth/hcsecd.conf .
4360 enable Bluetooth Service Discovery Protocol daemon.
4368 .It Va sdpd_groupname
4372 group to run as after it initializes.
4375 .It Va sdpd_username
4379 user to run as after it initializes.
4382 .It Va bthidd_enable
4386 enable Bluetooth Human Interface Device daemon.
4387 .It Va bthidd_config
4389 Configuration file for
4392 .Pa /etc/bluetooth/bthidd.conf .
4395 Path to a file, where
4397 will store information about known HID devices.
4399 .Pa /var/db/bthidd.hids .
4400 .It Va rfcomm_pppd_server_enable
4404 enable Bluetooth RFCOMM PPP wrapper daemon.
4405 .It Va rfcomm_pppd_server_profile
4407 The name of the profile to use from
4408 .Pa /etc/ppp/ppp.conf .
4409 Multiple profiles can be specified here.
4410 Also used to specify per-profile overrides.
4411 When the profile name contains any of the characters
4413 they are translated to
4415 for the proposes of the override variable names.
4416 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4418 Overrides local address to listen on.
4424 The address can be specified as BD_ADDR or name.
4425 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4427 Overrides local RFCOMM channel to listen on.
4430 will listen on RFCOMM channel 1.
4431 Must set properly if multiple profiles used in the same time.
4432 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4436 if it should register Serial Port service on the specified RFCOMM channel.
4439 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4443 if it should register Dial-Up Networking service on the specified
4447 .It Va ubthidhci_enable
4451 change the USB Bluetooth controller from HID mode to HCI mode.
4452 You also need to specify the location of USB Bluetooth controller with the
4453 .Va ubthidhci_busnum
4457 .It Va ubthidhci_busnum
4458 Bus number where the USB Bluetooth controller is located.
4461 on your system to find this information.
4462 .It Va ubthidhci_addr
4463 Bus address of the USB Bluetooth controller.
4466 on your system to find this information.
4467 .It Va netwait_enable
4471 delays the start of network-reliant services until
4473 is up and ICMP packets to a destination defined in
4476 Link state is examined first, followed by
4478 an IP address to verify network usability.
4479 If no destination can be reached or timeouts are exceeded,
4480 network services are started anyway with no guarantee that
4481 the network is usable.
4482 Use of this variable requires both
4490 This variable contains a space-delimited list of IP addresses to
4492 DNS hostnames should not be used as resolution is not guaranteed
4493 to be functional at this point.
4494 If multiple IP addresses are specified,
4495 each will be tried until one is successful or the list is exhausted.
4496 .It Va netwait_timeout
4498 Indicates the total number of seconds to perform a
4500 against each IP address in
4502 at a rate of one ping per second.
4503 If any of the pings are successful,
4504 full network connectivity is considered reliable.
4509 Defines the name of the network interface on which watch for link.
4511 is used to monitor the interface, looking for
4512 .Dq Li status: no carrier .
4513 Once gone, the link is considered up.
4516 interface if desired.
4517 .It Va netwait_if_timeout
4519 Defines the total number of seconds to wait for link to become usable,
4520 polled at a 1-second interval.
4524 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4525 .It Pa /etc/defaults/rc.conf
4527 .It Pa /etc/rc.conf.local
4556 .Xr newsyslog.conf 5 ,
4626 .An Jordan K. Hubbard .
projects / FreeBSD / FreeBSD.git / blob