4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the system installation utility,
46 is not to run commands or perform system startup actions
48 Instead, it is included by the
49 various generic startup scripts in
51 which conditionalize their
52 internal actions according to the settings found there.
56 file is included from the file
57 .Pa /etc/defaults/rc.conf ,
58 which specifies the default settings for all the available options.
59 Options need only be specified in
61 when the system administrator wishes to override these defaults.
63 .Pa /etc/rc.conf.local
64 is used to override settings in
66 for historical reasons.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
73 directory, which will be included by the
76 For jail configurations you could use the file
77 .Pa /etc/rc.conf.d/jail
78 to store jail specific configuration options.
84 .Dq Ar name Ns Li = Ns Ar value
88 The following list provides a name and short description for each
89 variable that can be set in the
92 .Bl -tag -width indent-two
97 enable output of debug messages from rc scripts.
98 This variable can be helpful in diagnosing mistakes when
99 editing or integrating new scripts.
100 Beware that this produces copious output to the terminal and
106 disable informational messages from the rc scripts.
107 Informational messages are displayed when
108 a condition that is not serious enough to warrant a warning or
116 when faststart is used (e.g., at boot time).
117 .It Va early_late_divider
119 The name of the script that should be used as the
120 delimiter between the
124 stages of the boot process.
125 The early stage should contain all the services needed to
126 get the disks (local or remote) mounted so that the late
127 stage can include scripts contained in the directories
130 variable (see below).
131 Thus, the two likely candidates for this value are
133 for the typical system, and
135 if the system needs remote file
136 systems mounted to get access to the
138 directories; for example when
146 is likely to be an appropriate value.
147 Extreme care should be taken when changing this value,
148 and before changing it one should ensure that there are
149 adequate provisions to recover from a failed boot
150 (such as physical contact with the machine,
151 or reliable remote console access).
156 no swapfile is installed, otherwise the value is used as the full
157 pathname to a file to use for additional swap space.
162 enable support for Automatic Power Management with
170 to handle APM event from userland.
171 This also enables support for APM.
178 these are the flags to pass to the
185 to handle device added, removed or unknown events from the kernel.
192 scripts at boot time.
195 Configuration file for
201 A list of kernel modules to load right after the local
203 Loading modules at this point in the boot process is
204 much faster than doing it via
205 .Pa /boot/loader.conf
206 for those modules not necessary for mounting local disk.
207 .It Va kldxref_enable
214 to automatically rebuild
219 .It Va kldxref_clobber
229 will overwrite existing
236 .It Va kldxref_module_path
241 delimited list of paths containing
253 enable the system power control facility with the
262 these are the flags to pass to the
266 Controls the creation of a
269 Always happens if set to
271 and never happens if set to
273 If set to anything else, a memory file system is created if
277 Controls the size of a created
281 Extra options passed to the
283 utility when the memory file system for
288 which inhibits the use of softupdates on
290 so that file system space is freed without delay
291 after file truncation or deletion.
294 for other options you can use in
297 Controls the creation of a
300 Always happens if set to
302 and never happens if set to
304 If set to anything else, a memory file system is created if
308 Controls the size of a created
312 Extra options passed to the
314 utility when the memory file system for
319 which inhibits the use of softupdates on
321 so that file system space is freed without delay
322 after file truncation or deletion.
325 for other options you can use in
328 Controls the automatic population of the
331 Always happens if set to
333 and never happens if set to
335 If set to anything else, a memory file system is created if
338 Note that this process requires access to certain commands in
342 is mounted on normal systems.
343 .It Va cleanvar_enable
350 List of directories to search for startup script files.
351 .It Va script_name_sep
353 The field separator to use for breaking down the list of startup script files
354 into individual filenames.
355 The default is a space.
356 It is not necessary to change this unless there are startup scripts with names
358 .It Va hostapd_enable
367 The fully qualified domain name (FQDN) of this host on the network.
368 This should almost certainly be set to something meaningful, even if
369 there is no network connection.
372 is used to set the hostname via DHCP,
373 this variable should be set to an empty string.
374 If this value remains unset when the system is done booting
375 your console login will display the default hostname of
379 The NIS domain name of this host, or
382 .It Va dhclient_program
384 Path to the DHCP client program
385 .Pa ( /sbin/dhclient ,
390 .It Va dhclient_flags
392 Additional flags to pass to the DHCP client program.
397 manpage for a description of the command line options available.
398 .It Va dhclient_flags_ Ns Aq Ar iface
399 Additional flags to pass to the DHCP client program running on
402 When specified, this variable overrides
404 .It Va background_dhclient
408 to start the DHCP client in background.
409 This can cause trouble with applications depending on
410 a working network, but it will provide a faster startup
412 .It Va background_dhclient_ Ns Aq Ar iface
413 When specified, this variable overrides the
414 .Va background_dhclient
415 variable for interface
418 .It Va synchronous_dhclient
424 synchronously at startup.
425 This behavior can be overridden on a per-interface basis by replacing
429 .Va ifconfig_ Ns Aq Ar interface
434 .It Va defaultroute_delay
436 When set to a positive value, wait up to this long after configuring
437 DHCP interfaces at startup to give the interfaces time to receive a lease.
438 .It Va firewall_enable
442 to load firewall rules at startup.
443 If the kernel was not built with
444 .Cd "options IPFIREWALL" ,
447 kernel module will be loaded.
449 .Va ipfilter_enable .
450 .It Va firewall_script
452 This variable specifies the full path to the firewall script to run.
454 .Pa /etc/rc.firewall .
457 Names the firewall type from the selection in
458 .Pa /etc/rc.firewall ,
459 or the file which contains the local firewall ruleset.
460 Valid selections from
464 .Bl -tag -width ".Li simple" -compact
466 unrestricted IP access
468 all IP services disabled, except via
471 basic protection for a workstation
473 basic protection for a LAN.
476 If a filename is specified, the full path
478 .It Va firewall_quiet
482 to disable the display of firewall rules on the console during boot.
483 .It Va firewall_logging
487 to enable firewall event logging.
488 This is equivalent to the
489 .Dv IPFIREWALL_VERBOSE
491 .It Va firewall_flags
497 specifies a filename.
498 .It Va firewall_coscripts
500 List of executables and/or rc scripts to run after firewall starts/stops.
502 .\" ----- firewall_nat_enable setting --------------------------------
503 .It Va firewall_nat_enable
515 .It Va firewall_nat_interface
521 This is the name of the public interface or IP address on which
522 kernel NAT should run.
523 .It Va firewall_nat_flags
525 Additional configuration parameters for kernel NAT should be placed here.
526 .It Va dummynet_enable
530 will automatically load the
536 .\" -------------------------------------------------------------------
552 sockets must be enabled in the kernel.
553 If the kernel was not built with
554 .Cd "options IPDIVERT" ,
557 kernel module will be loaded.
558 .It Va natd_interface
560 This is the name of the public interface on which
563 The interface may be given as an interface name or as an IP address.
568 flags should be placed here.
573 flag is automatically added with the above
576 .\" ----- ipfilter_enable setting --------------------------------
577 .It Va ipfilter_enable
588 Typical usage will require putting
590 ipfilter_enable="YES"
608 can be enabled independently.
612 both require at least one of
622 options IPFILTER_DEFAULT_BLOCK
625 in the kernel configuration file is a good idea, too.
626 .\" ----- ipfilter_program setting ------------------------------
627 .It Va ipfilter_program
633 .\" ----- ipfilter_rules setting --------------------------------
634 .It Va ipfilter_rules
639 This variable contains the name of the filter rule definition file.
640 The file is expected to be readable for the
643 .\" ----- ipv6_ipfilter_rules setting ---------------------------
644 .It Va ipv6_ipfilter_rules
649 This variable contains the IPv6 filter rule definition file.
650 The file is expected to be readable for the
653 .\" ----- ipfilter_flags setting --------------------------------
654 .It Va ipfilter_flags
657 This variable contains flags passed to the
660 .\" ----- ipnat_enable setting ----------------------------------
670 network address translation.
673 for a detailed discussion.
674 .\" ----- ipnat_program setting ---------------------------------
681 .\" ----- ipnat_rules setting -----------------------------------
687 This variable contains the name of the file
688 holding the network address translation definition.
689 This file is expected to be readable for the
692 .\" ----- ipnat_flags setting -----------------------------------
696 This variable contains flags passed to the
699 .\" ----- ipmon_enable setting ----------------------------------
714 Setting this variable needs setting
721 for a detailed discussion.
722 .\" ----- ipmon_program setting ---------------------------------
729 .\" ----- ipmon_flags setting -----------------------------------
735 This variable contains flags passed to the
738 Another typical example would be
739 .Dq Fl D Pa /var/log/ipflog
742 log directly to a file bypassing
745 .Pa /etc/newsyslog.conf
746 in such case like this:
748 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
750 .\" ----- ipfs_enable setting -----------------------------------
760 saving the filter and NAT state tables during shutdown
761 and reloading them during startup again.
762 Setting this variable needs setting
771 for a detailed discussion.
777 because the raised securelevel will prevent
779 from saving the state tables at shutdown time.
780 .\" ----- ipfs_program setting ----------------------------------
787 .\" ----- ipfs_flags setting ------------------------------------
791 This variable contains flags passed to the
794 .\" ----- end of added ipf hook ---------------------------------
806 Typical usage will require putting
821 into the kernel, otherwise the
822 kernel module will be loaded.
827 ruleset configuration file
842 these flags are passed to the
844 program when loading the ruleset.
854 which logs packets from the
867 .Pa /var/log/pflog ) .
869 .Pa /etc/newsyslog.conf
870 to adjust logfile rotation for this.
880 This variable contains additional flags passed to the
883 .It Va ftpproxy_enable
894 packet filter in translating ftp connections.
895 .It Va ftpproxy_flags
898 This variable contains additional flags passed to the
910 state changes to other hosts over the network by means of
915 must also be set then.
916 .It Va pfsync_syncdev
919 This variable specifies the name of the network interface
921 should operate through.
922 It must be set accordingly if
926 .It Va pfsync_syncpeer
929 This variable is optional.
930 By default, state change messages are sent out on the synchronisation
931 interface using IP multicast packets.
932 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
934 When a peer address is specified using the
936 option, the peer address is used as a destination for the pfsync
937 traffic, and the traffic can then be protected using
941 manpage for more details about using
946 .It Va pfsync_ifconfig
949 This variable can contain additional options to be passed to the
951 command used to set up
953 .It Va tcp_extensions
960 disables certain TCP options as described by
966 might help remedy such problems with connections as randomly hanging
967 or other weird behavior.
968 Some network devices are known
969 to be broken with respect to these options.
976 .Va net.inet.tcp.log_in_vain
978 .Va net.inet.udp.log_in_vain ,
983 are set to the given value.
991 will disable probing idle TCP connections to verify that the
992 peer is still up and reachable.
993 .It Va tcp_drop_synfin
1000 will cause the kernel to ignore TCP frames that have both
1001 the SYN and FIN flags set.
1002 This prevents OS fingerprinting, but may
1003 break some legitimate applications.
1004 .It Va icmp_drop_redirect
1011 will cause the kernel to ignore ICMP REDIRECT packets.
1014 for more information.
1015 .It Va icmp_log_redirect
1022 will cause the kernel to log ICMP REDIRECT packets.
1024 the log messages are not rate-limited, so this option should only be used
1025 for troubleshooting networks.
1028 for more information.
1029 .It Va icmp_bmcastecho
1033 to respond to broadcast or multicast ICMP ping packets.
1036 for more information.
1037 .It Va ip_portrange_first
1041 this is the first port in the default portrange.
1044 for more information.
1045 .It Va ip_portrange_last
1049 this is the last port in the default portrange.
1052 for more information.
1053 .It Va network_interfaces
1055 Set to the list of network interfaces to configure on this host or
1057 (the default) for all current interfaces.
1059 .Va network_interfaces
1060 variable to anything other than the default is deprecated.
1061 Interfaces that the administrator wishes to store configuration for,
1062 but not start at boot should be configured with the
1065 .Va ifconfig_ Ns Aq Ar interface
1066 variables as described below.
1069 .Va ifconfig_ Ns Aq Ar interface
1070 variable is also assumed to exist for each value of
1072 When an interface name contains any of the characters
1074 they are translated to
1077 The variable can contain arguments to
1079 as well as special case-insensitive keywords described below.
1080 Such keywords are removed before passing the value to
1082 while the order of the other arguments is preserved.
1084 One can configure more than one IPv4 address with the
1085 .Va ipv4_addrs_ Ns Aq Ar interface
1087 One or more IP addresses must be provided in Classless Inter-Domain
1088 Routing (CIDR) address notation, whose last byte can be a range like
1090 In this case the address 192.0.2.5 will be configured with the
1091 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1092 the non-conflicting netmask /32 as explained in the
1095 With the interface in question being
1097 an example could look like:
1099 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1102 It is also possible to add IP alias entries using
1105 Assuming that the interface in question was
1108 something like this:
1110 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1111 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1116 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1117 entry that is found,
1118 its contents are passed to
1120 Execution stops at the first unsuccessful access, so if
1121 something like this is present:
1123 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1124 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1125 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1126 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1129 Then note that alias4 would
1131 be added since the search would
1132 stop with the missing
1135 Due to this difficult to manage behavior, the
1136 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1140 .Pa /etc/start_if. Ns Aq Ar interface
1141 file is present, it is read and executed by the
1144 before configuring the interface as specified in the
1145 .Va ifconfig_ Ns Aq Ar interface
1147 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1151 .Va vlans_ Ns Aq Ar interface
1155 interface will be created for each item in the list with the
1159 If a vlan interface's name is a number,
1160 then that number is used as the vlan tag and the new vlan interface is
1162 .Ar interface . Ns Ar tag .
1164 the vlan tag must be specified via a
1167 .Va create_args_ Ns Aq Ar interface
1170 To create a vlan device named
1174 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1177 ifconfig_em0_101="inet 192.0.2.1/24"
1180 To create a vlan device named
1184 with the vlan tag 102:
1187 create_args_myvlan="vlan 102"
1191 .Va wlans_ Ns Aq Ar interface
1195 interface will be created for each item in the list with the
1199 Further wlan cloning arguments may be passed to the
1202 command by setting the
1203 .Va create_args_ Ns Aq Ar interface
1207 devices must be created for each wireless devices as of
1213 may be specified with an
1214 .Va wlandebug_ Ns Aq Ar interface
1216 The contents of this variable will be passed directly to
1220 .Va ifconfig_ Ns Aq Ar interface
1221 contains the keyword
1223 then the interface will not be configured
1225 .Pa /etc/pccard_ether
1227 .Va network_interfaces
1231 It is possible to bring up an interface with DHCP by adding
1234 .Va ifconfig_ Ns Aq Ar interface
1236 For instance, to initialize the
1239 it is possible to use something like:
1244 Also, if you want to configure your wireless interface with
1245 .Xr wpa_supplicant 8
1246 for use with WPA, EAP/LEAP or WEP, you need to add
1249 .Va ifconfig_ Ns Aq Ar interface
1252 Finally, you can add
1254 options in this variable, in addition to the
1255 .Pa /etc/start_if. Ns Aq Ar interface
1257 For instance, to configure an
1259 wireless device in station mode with an address obtained
1260 via DHCP, using WPA authentication and 802.11b mode, it is
1261 possible to use something like:
1264 ifconfig_wlan0="DHCP WPA mode 11b"
1268 .Va ifconfig_ Ns Aq Ar interface
1269 form, a fallback variable
1270 .Va ifconfig_DEFAULT
1272 It will be used for all interfaces with no
1273 .Va ifconfig_ Ns Aq Ar interface
1275 This is intended to replace the no longer supported
1279 It is also possible to rename an interface by doing:
1281 ifconfig_ed0_name="net0"
1282 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1288 .Dq Li inet6 accept_rtadv
1290 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1292 .Va ipv6_activate_all_interfaces
1296 This variable is deprecated. Use
1297 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1299 .Va ipv6_activate_all_interfaces
1305 the default address selection policy table set by
1307 will be IPv6-preferred.
1311 the default address selection policy table set by
1313 will be IPv4-preferred.
1315 This variable is deprecated. Use
1316 .Va ip6addrctl_policy
1318 .It Va ipv6_activate_all_interfaces
1321 all of interfaces which do not have the corrsponding
1322 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1323 variable will be marked as
1325 for security reason. This means only IPv6 functionality on that interface
1326 is completely disabled. For more details of
1329 .Dq Li inet6 ifdisabled ,
1339 privacy addresses will be generated for each IPv6
1340 interface as described in RFC 4193.
1341 .It Va ipv6_network_interfaces
1343 This is the IPv6 equivalent of
1344 .Va network_interfaces .
1345 Normally manual configuration of this variable is not needed.
1347 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1349 IPv6 functionality on an interface should be configured by
1350 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1351 instead of setting ifconfig parameters in
1352 .Va ifconfig_ Ns Aq Ar interface .
1353 Aliases should be set by
1354 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1357 keyword. For example:
1359 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1360 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1363 Interfaces that have an
1364 .Dq Li inet6 accept_rtadv
1366 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1367 setting will be automatically configured by
1369 Note that this automatic configuration is disabled if the
1370 .Va ipv6_gateway_enable
1373 .It Va ipv6_prefix_ Ns Aq Ar interface
1375 If one or more prefixes are defined in
1376 .Va ipv6_prefix_ Ns Aq Ar interface
1377 addresses based on each prefix and the EUI-64 interface index will be
1378 configured on that interface.
1379 .It Va ipv6_default_interface
1383 this is the default output interface for scoped addresses.
1384 This works only with ipv6_gateway_enable="NO".
1385 .It Va ip6addrctl_enable
1387 This variable is to enable configuring default address selection policy table
1389 The table can be specified in another variable
1390 .Va ip6addrctl_policy .
1392 .Va ip6addrctl_policy
1393 the following keywords can be specified:
1394 .Dq Li ipv4_prefer ,
1395 .Dq Li ipv6_prefer ,
1405 installs a pre-defined policy table described in Section 2.1
1413 is specified, it attempts to read a file
1414 .Pa /etc/ip6addrctl.conf
1415 first. If this file is found,
1417 reads and installs it. If not found, a policy is automatically set
1419 .Va ipv6_activate_all_interfaces
1420 variable; if the variable is set to
1422 the IPv6-preferred one is used. Otherwise IPv4-preferred.
1424 The default value of
1425 .Va ip6addrctl_enable
1427 .Va ip6addrctl_policy
1433 .It Va cloned_interfaces
1435 Set to the list of clonable network interfaces to create on this host.
1436 Further cloning arguments may be passed to the
1439 command for each interface by setting the
1440 .Va create_args_ Ns Aq Ar interface
1443 .Va cloned_interfaces
1444 are automatically appended to
1445 .Va network_interfaces
1447 .It Va fec_interfaces
1451 Fast EtherChannel interfaces to configure on this host.
1453 .Va fecconfig_ Ns Aq Ar interface
1454 variable is assumed to exist for each value of
1456 The value of this variable is used to configure link aggregated interfaces
1457 according to the syntax of the
1458 .Cm NGM_FEC_ADD_IFACE
1462 Additionally, this option ensures that each listed interface is created
1467 before attempting to configure it.
1470 fec_interfaces="fec0"
1471 fecconfig_fec0="em0 em1"
1472 ifconfig_fec0="DHCP"
1474 .It Va gif_interfaces
1478 tunnel interfaces to configure on this host.
1480 .Va gifconfig_ Ns Aq Ar interface
1481 variable is assumed to exist for each value of
1483 The value of this variable is used to configure the link layer of the
1484 tunnel according to the syntax of the
1488 Additionally, this option ensures that each listed interface is created
1493 before attempting to configure it.
1494 .It Va sppp_interfaces
1498 interfaces to configure on this host.
1500 .Va spppconfig_ Ns Aq Ar interface
1501 variable is assumed to exist for each value of
1503 Each interface should also be configured by a general
1504 .Va ifconfig_ Ns Aq Ar interface
1508 for more information about available options.
1518 The name of the profile to use from
1519 .Pa /etc/ppp/ppp.conf .
1520 Also used for per-profile overrides of
1525 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1526 When the profile name contains any of the characters
1528 they are translated to
1530 for the proposes of the override variable names.
1533 Mode in which to run the
1536 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1538 Overrides the global
1548 See the manual for a full description.
1553 enables network address translation.
1554 Used in conjunction with
1556 allows hosts on private network addresses access to the Internet using
1557 this host as a network address translating router.
1558 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1560 Overrides the global
1564 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1566 Set the unit number to be used for this profile.
1567 See the manual description of
1572 The name of the user under which
1580 .It Va rc_conf_files
1582 This option is used to specify a list of files that will override
1584 .Pa /etc/defaults/rc.conf .
1585 The files will be read in the order in which they are specified and should
1586 include the full path to the file.
1587 By default, the files specified are
1590 .Pa /etc/rc.conf.local
1596 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1598 .It Va gptboot_enable
1602 .Pa /etc/rc.d/gptboot
1603 will log if the system successfully (or not) booted from a GPT partition,
1609 .It Va gbde_autoattach_all
1614 will attempt to automatically initialize your .bde devices in
1618 List the devices that the script should try to attach,
1623 The directory where the
1625 lockfiles are located.
1626 The default lockfile directory is
1629 The lockfile for each individual
1631 device can be overridden by setting the variable
1632 .Va gbde_lock_ Ns Aq Ar device ,
1635 is the encrypted device without the
1640 .It Va gbde_attach_attempts
1642 Number of times to attempt attaching to a
1644 device, i.e., how many times the user is asked for the pass-phrase.
1648 List of devices to automatically attach on boot.
1649 Note that .eli devices from
1651 are automatically appended to this list.
1654 Number of times user is asked for the pass-phrase.
1655 If empty, it will be taken from
1656 .Va kern.geom.eli.tries
1658 .It Va geli_default_flags
1660 Default flags to use by
1662 when configuring disk encryption.
1663 Flags can be configured for every device separately by defining
1664 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1666 .It Va geli_autodetach
1668 Specifies if GELI devices should be marked for detach on last close after
1669 file systems are mounted.
1672 This can be changed for every device separately by defining
1673 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1675 .It Va geli_swap_flags
1676 Options passed to the
1678 utility when encrypted GEOM providers for swap partitions are created.
1680 .Dq Li "-e aes -l 256 -s 4096 -d" .
1681 .It Va root_rw_mount
1686 After the file systems are checked at boot time, the root file system
1687 is remounted as read-write if this is set to
1689 Diskless systems that mount their root file system from a read-only remote
1690 NFS share should set this to
1694 .It Va fsck_y_enable
1699 will be run with the
1701 flag if the initial preen
1702 of the file systems fails.
1703 .It Va background_fsck
1707 the system will attempt to run
1709 in the background where possible.
1710 .It Va background_fsck_delay
1712 The amount of time in seconds to sleep before starting a background
1714 It defaults to sixty seconds to allow large applications such as
1715 the X server to start before disk I/O bandwidth is monopolized by
1717 If set to a negative number, the background file system check will be
1718 delayed indefinitely to allow the administrator to run it at a more
1720 For example it may be run from
1722 by adding a line like
1724 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1730 List of file system types that are network-based.
1731 This list should generally not be modified by end users.
1733 .Va extra_netfs_types
1735 .It Va extra_netfs_types
1737 If set to something other than
1740 this variable extends the list of file system types
1741 for which automatic mounting at startup by
1743 should be delayed until the network is initialized.
1745 a whitespace-separated list of network file system descriptor pairs,
1746 each consisting of a file system type as passed to
1748 and a human-readable, one-word description,
1751 Extending the default list in this way is only necessary
1752 when third party file system types are used.
1753 .It Va syslogd_enable
1760 .It Va syslogd_program
1765 .Pa /usr/sbin/syslogd ) .
1766 .It Va syslogd_flags
1772 these are the flags to pass to
1781 .It Va inetd_program
1786 .Pa /usr/sbin/inetd ) .
1793 these are the flags to pass to
1802 .It Va hastd_program
1814 these are the flags to pass to
1823 .It Va named_program
1828 .Pa /usr/sbin/named ) .
1833 configuration file, (default
1834 .Pa /etc/namedb/named.conf ) .
1841 these are the flags to pass to
1847 process should be run as.
1848 .It Va named_chrootdir
1850 The root directory for a name server run in a
1852 environment (default
1856 will not be run in a
1859 .It Va named_chroot_autoupdate
1863 to disable automatic update of the
1866 .It Va named_symlink_enable
1870 to disable symlinking of
1879 loop until working name service is established.
1880 .It Va named_wait_host
1882 Name of host to lookup for the named_wait option.
1884 .It Va named_auto_forward
1886 Set to enable automatic creation of a forwarder
1887 configuration file derived from
1888 .Pa /etc/resolv.conf .
1889 .It Va named_auto_forward_only
1891 Set to change the default forwarder configuration from
1895 .It Va kerberos5_server_enable
1899 to start a Kerberos 5 authentication server
1901 .It Va kerberos5_server
1904 .Va kerberos5_server_enable
1907 this is the path to Kerberos 5 Authentication Server.
1908 .It Va kerberos5_server_flags
1911 This variable contains additional flags to be passed to the Kerberos 5
1912 authentication server.
1913 .It Va kadmind5_server_enable
1919 the Kerberos 5 Administration Daemon; set to
1922 .It Va kadmind5_server
1925 .Va kadmind5_server_enable
1928 this is the path to Kerberos 5 Administration Daemon.
1929 .It Va kpasswdd_server_enable
1935 the Kerberos 5 Password-Changing Daemon; set to
1938 .It Va kpasswdd_server
1941 .Va kpasswdd_server_enable
1944 this is the path to Kerberos 5 Password-Changing Daemon.
1951 daemon at boot time.
1958 these are the flags to pass to it.
1965 daemon at boot time.
1972 these are the flags to pass to it.
1975 manpage for more information.
1976 .It Va amd_map_program
1979 the specified program is run to get the list of
1984 maps are stored in NIS, one can set this to
1997 will be updated at boot time to reflect the kernel release
2002 will not be updated.
2003 .It Va nfs_client_enable
2007 run the NFS client daemons at boot time.
2008 .It Va nfs_access_cache
2011 .Va nfs_client_enable
2016 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2018 results should be cached.
2019 A value of 2-10 seconds will substantially reduce network
2020 traffic for many NFS operations.
2021 .It Va nfs_server_enable
2025 run the NFS server daemons at boot time.
2026 .It Va nfs_server_flags
2029 .Va nfs_server_enable
2032 these are the flags to pass to the
2035 .It Va nfsv4_server_enable
2038 .Va nfs_server_enable
2042 .Va nfsv4_server_enable
2045 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2046 .It Va nfsuserd_enable
2052 run the nfsuserd daemon, which is needed for NFSv4 in order
2053 to map between user/group names vs uid/gid numbers.
2055 .Va nfsv4_server_enable
2058 this will be forced enabled.
2059 .It Va nfsuserd_flags
2065 these are the flags to pass to the
2068 .It Va nfscbd_enable
2074 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2081 these are the flags to pass to the
2084 .It Va oldnfs_server_enable
2087 .Va oldnfs_server_enable
2090 force the NFS server daemons to run the old NFS server code
2091 that does not support NFSv4.
2092 .It Va mountd_enable
2097 .Va nfs_server_enable
2103 It is commonly needed to run CFS without real NFS used.
2110 these are the flags to pass to the
2113 .It Va weak_mountd_authentication
2117 allow services like PCNFSD to make non-privileged mount
2119 .It Va nfs_reserved_port_only
2123 provide NFS services only on a secure port.
2124 .It Va nfs_bufpackets
2126 If set to a number, indicates the number of packets worth of
2127 socket buffer space to reserve on an NFS client.
2128 The kernel default is typically 4.
2129 Using a higher number may be
2130 useful on gigabit networks to improve performance.
2131 The minimum value is
2132 2 and the maximum is 64.
2133 .It Va rpc_lockd_enable
2137 and also an NFS server or client, run
2140 .It Va rpc_lockd_flags
2143 .Va rpc_lockd_enable
2146 these are the flags to pass to the
2149 .It Va rpc_statd_enable
2153 and also an NFS server or client, run
2156 .It Va rpc_statd_flags
2159 .Va rpc_statd_enable
2162 these are the flags to pass to the
2165 .It Va rpcbind_program
2170 .Pa /usr/sbin/rpcbind ) .
2171 .It Va rpcbind_enable
2177 service at boot time.
2178 .It Va rpcbind_flags
2184 these are the flags to pass to the
2187 .It Va keyserv_enable
2193 daemon on boot for running Secure RPC.
2194 .It Va keyserv_flags
2200 these are the flags to pass to
2203 .It Va pppoed_enable
2209 daemon at boot time to provide PPP over Ethernet services.
2210 .It Va pppoed_ Ns Aq Ar provider
2213 listens to requests to this
2219 argument of the same name.
2222 Additional flags to pass to
2224 .It Va pppoed_interface
2226 The network interface to run
2229 This is mandatory when
2239 service at boot time.
2240 This command is intended for networks of
2241 machines where a consistent
2243 for all hosts must be established.
2244 This is often useful in large NFS
2245 environments where time stamps on files are expected to be consistent
2253 these are the flags to pass to the
2256 .It Va ntpdate_enable
2263 This command is intended to
2264 synchronize the system clock only
2266 from some standard reference.
2267 An option to set this up initially
2268 (from a list of known servers) is also provided by the
2270 program when the system is first installed.
2271 .It Va ntpdate_config
2273 Configuration file for
2277 .It Va ntpdate_hosts
2279 A whitespace-separated list of NTP servers to synchronize with at startup.
2280 The default is to use the servers listed in
2281 .Va ntpdate_config ,
2282 if that file exists.
2283 .It Va ntpdate_program
2288 .Pa /usr/sbin/ntpdate ) .
2289 .It Va ntpdate_flags
2295 these are the flags to pass to the
2297 command (typically a hostname).
2304 command at boot time.
2310 .Pa /usr/sbin/ntpd ) .
2324 these are the flags to pass to the
2327 .It Va ntpd_sync_on_start
2334 flag, which syncs the system's clock on startup.
2337 for more information regarding the
2340 This is a preferred alternative to using
2345 .It Va nis_client_enable
2351 service at system boot time.
2352 .It Va nis_client_flags
2355 .Va nis_client_enable
2358 these are the flags to pass to the
2361 .It Va nis_ypset_enable
2367 daemon at system boot time.
2368 .It Va nis_ypset_flags
2371 .Va nis_ypset_enable
2374 these are the flags to pass to the
2377 .It Va nis_server_enable
2383 daemon at system boot time.
2384 .It Va nis_server_flags
2387 .Va nis_server_enable
2390 these are the flags to pass to the
2393 .It Va nis_ypxfrd_enable
2399 daemon at system boot time.
2400 .It Va nis_ypxfrd_flags
2403 .Va nis_ypxfrd_enable
2406 these are the flags to pass to the
2409 .It Va nis_yppasswdd_enable
2415 daemon at system boot time.
2416 .It Va nis_yppasswdd_flags
2419 .Va nis_yppasswdd_enable
2422 these are the flags to pass to the
2425 .It Va rpc_ypupdated_enable
2431 daemon at system boot time.
2432 .It Va bsnmpd_enable
2438 daemon at system boot time.
2439 Be sure to understand the security implications of running SNMP daemon
2447 these are the flags to pass to the
2450 .It Va defaultrouter
2454 create a default route to this host name or IP address
2455 (use an IP address if this router is also required to get to the
2457 .It Va ipv6_defaultrouter
2459 The IPv6 equivalent of
2461 .It Va static_arp_pairs
2463 Set to the list of static ARP pairs that are to be added at system
2465 For each whitespace separated
2468 .Va static_arp_ Ns Aq Ar element
2469 variable is assumed to exist whose contents will later be passed to a
2474 static_arp_pairs="gw"
2475 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2477 .It Va static_routes
2479 Set to the list of static routes that are to be added at system
2483 then for each whitespace separated
2486 .Va route_ Ns Aq Ar element
2487 variable is assumed to exist
2488 whose contents will later be passed to a
2493 static_routes="mcast gif0local"
2494 route_mcast="-net 224.0.0.0/4 -iface gif0"
2495 route_gif0local="-host 169.254.1.1 -iface lo0"
2497 .It Va ipv6_static_routes
2499 The IPv6 equivalent of
2503 then for each whitespace separated
2506 .Va ipv6_route_ Ns Aq Ar element
2507 variable is assumed to exist
2508 whose contents will later be passed to a
2509 .Dq Nm route Cm add Fl inet6
2511 .It Va natm_static_routes
2517 If not empty then for each whitespace separated
2520 .Va route_ Ns Aq Ar element
2521 variable is assumed to exist whose contents will later be passed to a
2522 .Dq Nm atmconfig Cm natm Cm add
2524 .It Va gateway_enable
2528 configure host to act as an IP router, e.g.\& to forward packets
2530 .It Va ipv6_gateway_enable
2532 The IPv6 equivalent of
2533 .Va gateway_enable .
2534 .It Va routed_enable
2538 run a routing daemon of some sort, based on the
2543 .It Va route6d_enable
2545 The IPv6 equivalent of
2549 run a routing daemon of some sort, based on the
2554 .It Va routed_program
2560 this is the name of the routing daemon to use.
2561 .It Va route6d_program
2563 The IPv6 equivalent of
2564 .Va routed_program .
2571 these are the flags to pass to the routing daemon.
2572 .It Va route6d_flags
2574 The IPv6 equivalent of
2576 .It Va mrouted_enable
2580 run the multicast routing daemon,
2582 .It Va mroute6d_enable
2584 The IPv6 equivalent of
2585 .Va mrouted_enable .
2588 run the IPv6 multicast routing daemon.
2590 Note that multicast routing daemons are no longer included in the
2592 base system, however, both
2596 may be installed from the
2599 .It Va mrouted_flags
2605 these are the flags to pass to the
2608 .It Va mroute6d_flags
2610 The IPv6 equivalent of
2616 these are the flags passed to the IPv6 multicast routing daemon.
2617 .It Va mroute6d_program
2623 this is the path to the IPv6 multicast routing daemon.
2624 .It Va rtadvd_enable
2630 daemon at boot time.
2633 .Va ipv6_gateway_enable
2638 utility sends router advertisement packets to the interfaces specified in
2639 .Va rtadvd_interfaces
2640 and should only be enabled with great care.
2641 You may want to fine-tune
2643 .It Va rtadvd_interfaces
2649 this is the list of interfaces to use.
2650 .It Va ipxgateway_enable
2654 enable the routing of IPX traffic.
2655 .It Va ipxrouted_enable
2661 daemon at system boot time.
2662 .It Va ipxrouted_flags
2665 .Va ipxrouted_enable
2668 these are the flags to pass to the
2675 enable global proxy ARP.
2676 .It Va forward_sourceroute
2684 source-routed packets are forwarded.
2685 .It Va accept_sourceroute
2689 the system will accept source-routed packets directed at it.
2696 daemon at system boot time.
2703 these are the flags to pass to the
2706 .It Va bootparamd_enable
2712 daemon at system boot time.
2713 .It Va bootparamd_flags
2716 .Va bootparamd_enable
2719 these are the flags to pass to the
2722 .It Va stf_interface_ipv4addr
2726 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2728 Specify this entry to enable the 6to4 interface.
2729 .It Va stf_interface_ipv4plen
2731 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2732 An effective value is 0-31.
2733 .It Va stf_interface_ipv6_ifid
2735 IPv6 interface ID for
2739 .It Va stf_interface_ipv6_slaid
2741 IPv6 Site Level Aggregator for
2743 .It Va ipv6_faith_prefix
2747 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2752 .It Va ipv6_ipv4mapping
2756 this enables IPv4 mapped IPv6 address communication (like
2757 .Li ::ffff:a.b.c.d ) .
2762 to enable the configuration of ATM interfaces at system boot time.
2763 For all of the ATM variables described below, please refer to the
2765 manual page for further details on the available command parameters.
2766 Also refer to the files in
2767 .Pa /usr/share/examples/atm
2768 for more detailed configuration information.
2771 This is a list of physical ATM interface drivers to load.
2776 .It Va atm_netif_ Ns Aq Ar intf
2778 For the ATM physical interface
2780 this variable defines the name prefix and count for the ATM network
2781 interfaces to be created.
2782 The value will be passed as the parameters of an
2783 .Dq Nm atm Cm "set netif" Ar intf
2785 .It Va atm_sigmgr_ Ns Aq Ar intf
2787 For the ATM physical interface
2789 this variable defines the ATM signalling manager to be used.
2790 The value will be passed as the parameters of an
2791 .Dq Nm atm Cm attach Ar intf
2793 .It Va atm_prefix_ Ns Aq Ar intf
2795 For the ATM physical interface
2797 this variable defines the NSAP prefix for interfaces using a UNI signalling
2801 the prefix will automatically be set via the
2804 Otherwise, the value will be passed as the parameters of an
2805 .Dq Nm atm Cm "set prefix" Ar intf
2807 .It Va atm_macaddr_ Ns Aq Ar intf
2809 For the ATM physical interface
2811 this variable defines the MAC address for interfaces using a UNI signalling
2815 the hardware MAC address contained in the ATM interface card will be used.
2816 Otherwise, the value will be passed as the parameters of an
2817 .Dq Nm atm Cm "set mac" Ar intf
2819 .It Va atm_arpserver_ Ns Aq Ar netif
2821 For the ATM network interface
2823 this variable defines the ATM address for a host which is to provide ATMARP
2825 This variable is only applicable to interfaces using a UNI signalling
2829 this host will become an ATMARP server.
2830 The value will be passed as the parameters of an
2831 .Dq Nm atm Cm "set arpserver" Ar netif
2833 .It Va atm_scsparp_ Ns Aq Ar netif
2837 SCSP/ATMARP service for the network interface
2839 will be initiated using the
2844 This variable is only applicable if
2845 .Va atm_arpserver_ Ns Aq Ar netif
2850 Set to the list of ATM PVCs to be added at system
2852 For each whitespace separated
2855 .Va atm_pvc_ Ns Aq Ar element
2856 variable is assumed to exist.
2857 The value of each of these variables
2858 will be passed as the parameters of an
2859 .Dq Nm atm Cm "add pvc"
2863 Set to the list of permanent ATM ARP entries to be added
2864 at system boot time.
2865 For each whitespace separated
2868 .Va atm_arp_ Ns Aq Ar element
2869 variable is assumed to exist.
2870 The value of each of these variables
2871 will be passed as the parameters of an
2872 .Dq Nm atm Cm "add arp"
2874 .It Va natm_interfaces
2878 interfaces that will also be used for HARP through
2880 If this list is not empty all interfaces in the list will be brought up
2886 For this to work the interface drivers must be either compiled into the
2887 kernel or must reside on the root partition.
2890 The keyboard bell sound.
2897 if the default behavior is desired.
2898 For details, refer to the
2903 If set to a non-null string, the virtual console's keyboard input is
2909 no keymap is installed, otherwise the value is used to install
2911 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2914 The keyboard repeat speed.
2921 if the default behavior is desired.
2926 attempt to program the function keys with the value.
2928 be a single string of the form:
2929 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2932 Can be set to the value of
2935 .Dq Li destructive ,
2938 to set the cursor behavior explicitly or choose the default behavior.
2943 no screen map is installed, otherwise the value is used to install
2944 the screen map file in
2945 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2950 the default 8x16 font value is used for screen size requests, otherwise
2952 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2958 the default 8x14 font value is used for screen size requests, otherwise
2960 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2966 the default 8x8 font value is used for screen size requests, otherwise
2968 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2974 the default screen blanking interval is used, otherwise it is set
2982 this is the actual screen saver to use
2983 .Li ( blank , snake , daemon ,
2985 .It Va moused_nondefault_enable
2989 the mouse device specified on
2990 the command line is not automatically treated as enabled by the
2991 .Pa /etc/rc.d/moused
2993 Having this variable set to
2999 to be enabled as soon as it is plugged in.
3000 .It Va moused_enable
3006 daemon is started for doing cut/paste selection on the console.
3009 This is the protocol type of the mouse connected to this host.
3010 This variable must be set if
3017 is able to detect the appropriate mouse type automatically in many cases.
3018 Set this variable to
3020 to let the daemon detect it, or
3021 select one from the following list if the automatic detection fails.
3023 If the mouse is attached to the PS/2 mouse port, choose
3027 regardless of the brand and model of the mouse.
3029 mouse is attached to the bus mouse port, choose
3033 All other protocols are for serial mice and will not work with
3034 the PS/2 and bus mice.
3035 If this is a USB mouse,
3037 is the only protocol type which will work.
3039 .Bl -tag -width ".Li x10mouseremote" -compact
3041 Microsoft mouse (serial)
3043 Microsoft IntelliMouse (serial)
3045 Mouse systems Corp.\& mouse (serial)
3047 MM Series mouse (serial)
3049 Logitech mouse (serial)
3053 Logitech MouseMan and TrackMan (serial)
3055 ALPS GlidePoint (serial)
3056 .It Li thinkingmouse
3057 Kensington ThinkingMouse (serial)
3061 MM HitTablet (serial)
3062 .It Li x10mouseremote
3063 X10 MouseRemote (serial)
3065 Interlink VersaPad (serial)
3068 Even if the mouse is not in the above list, it may be compatible
3069 with one in the list.
3070 Refer to the manual page for
3072 for compatibility information.
3074 It should also be noted that while this is enabled, any
3075 other client of the mouse (such as an X server) should access
3076 the mouse through the virtual mouse device,
3078 and configure it as a
3080 type mouse, since all
3081 mouse data is converted to this single canonical format when
3084 If the client program does not support the
3090 It is the second preferred type.
3097 this is the actual port the mouse is on.
3100 for a COM1 serial mouse,
3104 for a bus mouse, for example.
3109 is set, its value is used as an additional set of flags to pass to the
3112 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3114 .Va moused_nondefault_enable
3117 daemon is started for a non-default port, the
3118 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3119 set of options has precedence over and replaces the default
3120 .Va moused_flags (where
3122 is the name of the non-default port, i.e.\&
3125 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3126 it is possible to set up a different set of default flags for each
3129 For example, you can use
3133 to make your laptop's touchpad more comfortable to use,
3134 but an empty set of options for
3135 .Va moused_ums0_flags
3138 mouse has three or more buttons.
3139 .It Va mousechar_start
3143 the default mouse cursor character range
3144 .Li 0xd0 Ns - Ns Li 0xd3
3146 otherwise the range start is set
3151 Use if the default range is occupied in the language code table.
3152 .It Va allscreens_flags
3156 is run with these options for each of the virtual terminals
3160 will enable the mouse pointer on all virtual terminals
3165 .It Va allscreens_kbdflags
3169 is run with these options for each of the virtual terminals
3175 scrollback (history) buffer to 200 lines.
3182 daemon at system boot time.
3188 .Pa /usr/sbin/cron ) .
3195 these are the flags to pass to
3201 enable the special handling of transitions to and from the
3202 Daylight Saving Time in
3204 (equivalent to using the flag
3211 .Pa /usr/sbin/lpd ) .
3218 daemon at system boot time.
3225 these are the flags to pass to the
3228 .It Va chkprintcap_enable
3234 command before starting the
3237 .It Va chkprintcap_flags
3242 .Va chkprintcap_enable
3245 these are the flags to pass to the
3250 which causes missing directories to be created.
3251 .It Va mta_start_script
3253 This variable specifies the full path to the script to run to start
3254 a mail transfer agent.
3256 .Pa /etc/rc.sendmail .
3260 .Pa /etc/rc.sendmail
3261 uses are documented in the
3266 Indicates the device (usually a swap partition) to which a crash dump
3267 should be written in the event of a system crash.
3268 If the value of this variable is
3270 the first suitable swap device listed in
3272 will be used as dump device.
3273 Otherwise, the value of this variable is passed as the argument to
3275 To disable crash dumps, set this variable to
3279 When the system reboots after a crash and a crash dump is found on the
3280 device specified by the
3284 will save that crash dump and a copy of the kernel to the directory
3288 The default value is
3297 .It Va savecore_flags
3299 If crash dumps are enabled, these are the flags to pass to the
3306 to turn on user and group disk quotas on system startup via the
3308 command for all file systems marked as having quotas enabled in
3310 The kernel must be built with
3312 for disk quotas to function.
3317 to enable user and group disk quota checking via the
3320 .It Va quotacheck_flags
3330 these are the flags to pass to the
3335 which checks quotas for all file systems with quotas enabled in
3337 .It Va quotaon_flags
3343 these are the flags to pass to the
3348 which enables quotas for all file systems with quotas enabled in
3350 .It Va quotaoff_flags
3356 these are the flags to pass to the
3358 utility when shutting down the quota system.
3361 which disables quotas for all file systems with quotas enabled in
3363 .It Va accounting_enable
3367 to enable system accounting through the
3374 to enable iBCS2 (SCO) binary emulation at system initial boot
3376 .It Va ibcs2_loaders
3384 this specifies a list of additional iBCS2 loaders to enable.
3389 to enable Linux/ELF binary emulation at system initial
3395 enable SysVR4 emulation at boot time.
3396 .It Va sysvipc_enable
3400 load System V IPC primitives at boot time.
3401 .It Va clear_tmp_enable
3412 to disable removing of X11 lock files,
3413 and the removal and (secure) recreation
3414 of the various socket directories for X11
3416 .It Va ldconfig_paths
3418 Set to the list of shared library paths to use with
3422 will always be added first, so it need not appear in this list.
3423 .It Va ldconfig32_paths
3425 Set to the list of 32-bit compatibility shared library paths to
3428 .It Va ldconfig_paths_aout
3430 Set to the list of shared library paths to use with
3435 .It Va ldconfig_insecure
3439 utility normally refuses to use directories
3440 which are writable by anyone except root.
3441 Set this variable to
3443 to disable that security check during system startup.
3444 .It Va ldconfig_local_dirs
3446 Set to the list of local
3449 The names of all files in the directories listed will be
3450 passed as arguments to
3452 .It Va ldconfig_local32_dirs
3454 Set to the list of local 32-bit compatibility
3457 The names of all files in the directories listed will be
3458 passed as arguments to
3459 .Dq Nm ldconfig Fl 32 .
3460 .It Va kern_securelevel_enable
3464 to set the kernel security level at system startup.
3465 .It Va kern_securelevel
3467 The kernel security level to set at startup.
3468 The allowed range of
3470 ranges from \-1 (the compile time default) to 3 (the
3474 for the list of possible security levels and their effect
3475 on system operation.
3478 Path to the SSH server program
3479 .Pa ( /usr/sbin/sshd
3487 at system boot time.
3494 these are the flags to pass to the
3499 Path to the FTP server program
3500 .Pa ( /usr/libexec/ftpd
3508 as a stand-alone daemon at system boot time.
3515 these are the additional flags to pass to the
3518 .It Va watchdogd_enable
3524 daemon at boot time.
3525 This requires that the kernel have been compiled with a
3528 .It Va watchdogd_flags
3531 .Va watchdogd_enable
3534 these are the flags passed to the
3537 .It Va performance_cx_lowest
3539 CPU idle state to use while on AC power.
3544 should use the lowest power state available while
3546 indicates that the lowest latency state (less power savings) should be used.
3547 .It Va performance_cpu_freq
3549 CPU clock frequency to use while on AC power.
3554 should use the lowest frequency available while
3556 indicates that the highest frequency (less power savings) should be used.
3557 .It Va economy_cx_lowest
3559 CPU idle state to use when off AC power.
3564 should use the lowest power state available while
3566 indicates that the lowest latency state (less power savings) should be used.
3567 .It Va economy_cpu_freq
3569 CPU clock frequency to use when off AC power.
3574 should use the lowest frequency available while
3576 indicates that the highest frequency (less power savings) should be used.
3581 any configured jails will not be started.
3582 .It jail_parallel_start
3586 all configured jails will be started in the background (= in parallel).
3589 A space separated list of names for jails.
3590 This is purely a configuration aid to help identify and
3591 configure multiple jails.
3592 The names specified in this list will be used to
3593 identify settings common to an instance of a jail,
3594 and should contain alphanumeric characters only.
3595 Assuming that the jail in question was named
3597 you would have the following dependent variables:
3599 jail_vjail_hostname="jail.example.com"
3600 jail_vjail_ip="192.0.2.100"
3601 jail_vjail_rootdir="/var/jails/vjail/root"
3607 When set, use as default value for
3608 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3611 .It Va jail_interface
3614 When set, use as default value for
3615 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3621 When set, use as default value for
3622 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3625 .It Va jail_mount_enable
3633 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3636 by default for every jail in
3638 .It Va jail_devfs_ruleset
3642 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3643 to given value for every jail in
3645 .It Va jail_devfs_enable
3653 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3656 by default for every jail in
3658 .It Va jail_fdescfs_enable
3666 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3669 by default for every jail in
3671 .It Va jail_procfs_enable
3679 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3682 by default for every jail in
3684 .It Va jail_exec_prestart Ns Aq Ar N
3687 When set, use as default value for
3688 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3691 .It Va jail_exec_start
3694 When set, use as default value for
3695 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3698 .It Va jail_exec_afterstart Ns Aq Ar N
3701 When set, use as default value for
3702 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3705 .It Va jail_exec_poststart Ns Aq Ar N
3708 When set, use as default value for
3709 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3712 .It Va jail_exec_prestop Ns Aq Ar N
3715 When set, use as default value for
3716 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3719 .It Va jail_exec_stop
3721 When set, use as default value for
3722 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3725 .It Va jail_exec_poststop Ns Aq Ar N
3728 When set, use as default value for
3729 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3732 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3735 Set to the root directory used by jail
3737 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3740 Set to the fully qualified domain name (FQDN) assigned to jail
3742 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3745 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3746 The argument can be a sole address or a comma separated list of addresses.
3747 Additionally each address can be prefixed by the name of an interface
3748 followed by a pipe to overwrite
3749 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3752 and/or suffixed by a netmask, prefixlen or prefix.
3753 In case no netmask, prefixlen or prefix is given,
3755 will be used for IPv4 and
3757 will be used for an IPv6 address.
3758 If no address is given for the jail then the jail will be started with
3759 no networking support.
3760 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3763 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3764 The sequence starts with
3766 and the numbers have to be strictly ascending.
3767 These entries follow the same syntax as their primary
3768 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3770 The order of the entries can be important as the first address for
3771 each address family found will be the primary address of the jail.
3777 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3782 These are flags to pass to
3784 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3787 When set, sets the interface to use when setting IP address alias.
3788 Note that the alias is created at jail startup and removed at jail shutdown.
3789 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3792 When set, the jail is started with the specified forwarding table (sometimes
3793 referred to as a routing table) via
3795 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3798 .Pa /etc/fstab. Ns Aq Ar jname
3800 This is the file system information file to use for jail
3802 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3809 mount all file systems from
3810 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3812 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3815 When set, defines the device file system ruleset file to use for jail
3817 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3824 mount the device file system inside jail
3827 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3834 mount the file-descriptor file system inside jail
3837 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3844 mount the process file system inside jail
3847 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3850 This is the command run as
3853 before jail startup, where
3856 It is run outside the jail.
3857 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3860 .Dq Li /bin/sh /etc/rc
3862 This is the command executed in a jail at jail startup.
3863 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3866 This is the command run as
3870 after jail startup, where
3873 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3876 This is the command run as
3879 after jail startup, where
3882 It is run outside the jail.
3883 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3886 This is the command run as
3889 before jail shutdown, where
3892 It is run outside the jail.
3893 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3896 .Dq Li /bin/sh /etc/rc.shutdown
3898 This is the command executed in a jail at jail shutdown.
3899 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3902 This is the command run as
3905 after jail shutdown, where
3908 It is run outside the jail.
3909 .It Va jail_set_hostname_allow
3913 do not allow the root user in a jail to set its hostname.
3914 .It Va jail_socket_unixiproute_only
3918 do not allow any sockets,
3919 besides UNIX/IP/route sockets,
3920 to be used within a jail.
3921 .It Va jail_sysvipc_allow
3925 allow applications within a jail to use System V IPC.
3926 .\" -----------------------------------------------------
3927 .It Va harvest_interrupt
3931 to use hardware interrupts as an entropy source.
3934 for more information.
3935 .It Va harvest_ethernet
3939 to use LAN traffic as an entropy source.
3942 for more information.
3943 .It Va harvest_p_to_p
3947 to use serial line traffic as an entropy source.
3950 for more information.
3955 to disable caching entropy via
3957 Otherwise set to the directory used to store entropy files in.
3962 to disable caching entropy through reboots.
3963 Otherwise set to the filename used to store cached entropy through
3965 This file should be located on the root file system to seed the
3967 device as early as possible in the boot process.
3968 .It Va entropy_save_sz
3970 Size of the entropy cache files saved by
3973 .It Va entropy_save_num
3975 Number of entropy cache files to save by
3989 Configuration file for
3998 .Pa /var/run/dmesg.boot
4000 .It Va rcshutdown_timeout
4002 If set, start a watchdog timer in the background which will terminate
4006 has not completed within the specified time (in seconds).
4007 Notice that in addition to this soft timeout,
4009 also applies a hard timeout for the execution of
4011 This is configured via
4014 .Va kern.init_shutdown_timeout
4015 and defaults to 120 seconds.
4016 Setting the value of
4017 .Va rcshutdown_timeout
4018 to more than 120 seconds will have no effect until the
4021 .Va kern.init_shutdown_timeout
4023 .It Va virecover_enable
4027 to prevent the system from trying to
4028 recover pre-maturely terminated
4031 .It Va ugidfw_enable
4036 .Xr mac_bsdextended 4
4037 module upon system initialization and load a default
4039 .It Va bsdextended_script
4042 .Xr mac_bsdextended 4
4043 ruleset file to load.
4044 The default value of this variable is
4045 .Pa /etc/rc.bsdextended .
4046 .It Va newsyslog_enable
4053 .It Va newsyslog_flags
4056 .Va newsyslog_enable
4059 these are the flags to pass to the
4064 which causes log files flagged with a
4067 .It Va mdconfig_md Ns Aq Ar X
4077 must be specified and either a
4079 for malloc or swap backed
4087 .Va mdconfig_md Ns Aq Ar X
4088 variables are evaluated until one variable is unset or null.
4089 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4091 Optional arguments passed to
4097 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4099 An ownership specification passed to
4108 device and the mount point will be changed.
4109 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4111 A mode string passed to
4120 device and the mount point will be changed.
4121 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4123 Files to be copied to the mount point of the
4127 after it has been mounted.
4128 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4130 Command to execute after the specified
4135 Note that the command is passed to
4141 variables can be used to reference respectively the
4143 device and the mount point.
4148 one could set the following:
4150 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4152 .It Va autobridge_interfaces
4154 Set to the list of bridge interfaces that will have newly arriving interfaces
4155 checked against to be automatically added.
4158 then for each whitespace separated
4161 .Va autobridge_ Ns Aq Ar element
4162 variable is assumed to exist which has a whitespace separated list of interface
4163 names to match, these names can use wildcards.
4166 autobridge_interfaces="bridge0"
4167 autobridge_bridge0="tap* dc0 vlan[345]"
4173 enable support for sound mixer.
4174 .It Va hcsecd_enable
4178 enable Bluetooth security daemon.
4179 .It Va hcsecd_config
4181 Configuration file for
4184 .Pa /etc/bluetooth/hcsecd.conf .
4189 enable Bluetooth Service Discovery Protocol daemon.
4197 .It Va sdpd_groupname
4201 group to run as after it initializes.
4204 .It Va sdpd_username
4208 user to run as after it initializes.
4211 .It Va bthidd_enable
4215 enable Bluetooth Human Interface Device daemon.
4216 .It Va bthidd_config
4218 Configuration file for
4221 .Pa /etc/bluetooth/bthidd.conf .
4224 Path to a file, where
4226 will store information about known HID devices.
4228 .Pa /var/db/bthidd.hids .
4229 .It Va rfcomm_pppd_server_enable
4233 enable Bluetooth RFCOMM PPP wrapper daemon.
4234 .It Va rfcomm_pppd_server_profile
4236 The name of the profile to use from
4237 .Pa /etc/ppp/ppp.conf .
4238 Multiple profiles can be specified here.
4239 Also used to specify per-profile overrides.
4240 When the profile name contains any of the characters
4242 they are translated to
4244 for the proposes of the override variable names.
4245 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4247 Overrides local address to listen on.
4253 The address can be specified as BD_ADDR or name.
4254 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4256 Overrides local RFCOMM channel to listen on.
4259 will listen on RFCOMM channel 1.
4260 Must set properly if multiple profiles used in the same time.
4261 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4265 if it should register Serial Port service on the specified RFCOMM channel.
4268 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4272 if it should register Dial-Up Networking service on the specified
4276 .It Va ubthidhci_enable
4280 change the USB Bluetooth controller from HID mode to HCI mode.
4281 You also need to specify the location of USB Bluetooth controller with the
4282 .Va ubthidhci_busnum
4286 .It Va ubthidhci_busnum
4287 Bus number where the USB Bluetooth controller is located.
4290 on your system to find this information.
4291 .It Va ubthidhci_addr
4292 Bus address of the USB Bluetooth controller.
4295 on your system to find this information.
4296 .It Va netwait_enable
4300 delays the start of network-reliant services until
4302 is up and ICMP packets to a destination defined in
4305 Link state is examined first, followed by
4307 an IP address to verify network usability.
4308 If no destination can be reached or timeouts are exceeded,
4309 network services are started anyway with no guarantee that
4310 the network is usable.
4311 Use of this variable requires both
4319 This variable contains a space-delimited list of IP addresses to
4321 DNS hostnames should not be used as resolution is not guaranteed
4322 to be functional at this point.
4323 If multiple IP addresses are specified,
4324 each will be tried until one is successful or the list is exhausted.
4325 .It Va netwait_timeout
4327 Indicates the total number of seconds to perform a
4329 against each IP address in
4331 at a rate of one ping per second.
4332 If any of the pings are successful,
4333 full network connectivity is considered reliable.
4338 Defines the name of the network interface on which watch for link.
4340 is used to monitor the interface, looking for
4341 .Dq Li status: no carrier .
4342 Once gone, the link is considered up.
4345 interface if desired.
4346 .It Va netwait_if_timeout
4348 Defines the total number of seconds to wait for link to become usable,
4349 polled at a 1-second interval.
4353 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4354 .It Pa /etc/defaults/rc.conf
4356 .It Pa /etc/rc.conf.local
4385 .Xr newsyslog.conf 5 ,
4454 .An Jordan K. Hubbard .
projects / FreeBSD / FreeBSD.git / blob