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.
72 .Dq Ar name Ns Li = Ns Ar value
76 The following list provides a name and short description for each
77 variable that can be set in the
80 .Bl -tag -width indent-two
85 enable output of debug messages from rc scripts.
86 This variable can be helpful in diagnosing mistakes when
87 editing or integrating new scripts.
88 Beware that this produces copious output to the terminal and
94 disable informational messages from the rc scripts.
95 Informational messages are displayed when
96 a condition that is not serious enough to warrant a warning or
104 when faststart is used (e.g., at boot time).
105 .It Va early_late_divider
107 The name of the script that should be used as the
108 delimiter between the
112 stages of the boot process.
113 The early stage should contain all the services needed to
114 get the disks (local or remote) mounted so that the late
115 stage can include scripts contained in the directories
118 variable (see below).
119 Thus, the two likely candidates for this value are
121 for the typical system, and
123 if the system needs remote file
124 systems mounted to get access to the
126 directories; for example when
134 is likely to be an appropriate value.
135 Extreme care should be taken when changing this value,
136 and before changing it one should ensure that there are
137 adequate provisions to recover from a failed boot
138 (such as physical contact with the machine,
139 or reliable remote console access).
144 no swapfile is installed, otherwise the value is used as the full
145 pathname to a file to use for additional swap space.
150 enable support for Automatic Power Management with
158 to handle APM event from userland.
159 This also enables support for APM.
166 these are the flags to pass to the
173 to handle device added, removed or unknown events from the kernel.
180 scripts at boot time.
183 Configuration file for
187 .It Va kldxref_enable
194 to automatically rebuild
199 .It Va kldxref_clobber
209 will overwrite existing
216 .It Va kldxref_module_path
221 delimited list of paths containing
233 enable the system power control facility with the
242 these are the flags to pass to the
246 Controls the creation of a
249 Always happens if set to
251 and never happens if set to
253 If set to anything else, a memory file system is created if
257 Controls the size of a created
261 Extra options passed to the
263 utility when the memory file system for
268 which inhibits the use of softupdates on
270 so that file system space is freed without delay
271 after file truncation or deletion.
274 for other options you can use in
277 Controls the creation of a
280 Always happens if set to
282 and never happens if set to
284 If set to anything else, a memory file system is created if
288 Controls the size of a created
292 Extra options passed to the
294 utility when the memory file system for
299 which inhibits the use of softupdates on
301 so that file system space is freed without delay
302 after file truncation or deletion.
305 for other options you can use in
308 Controls the automatic population of the
311 Always happens if set to
313 and never happens if set to
315 If set to anything else, a memory file system is created if
318 Note that this process requires access to certain commands in
322 is mounted on normal systems.
323 .It Va cleanvar_enable
330 List of directories to search for startup script files.
331 .It Va script_name_sep
333 The field separator to use for breaking down the list of startup script files
334 into individual filenames.
335 The default is a space.
336 It is not necessary to change this unless there are startup scripts with names
338 .It Va hostapd_enable
347 The fully qualified domain name (FQDN) of this host on the network.
348 This should almost certainly be set to something meaningful, even if
349 there is no network connection.
352 is used to set the hostname via DHCP,
353 this variable should be set to an empty string.
354 If this value remains unset when the system is done booting
355 your console login will display the default hostname of
359 The NIS domain name of this host, or
362 .It Va dhclient_program
364 Path to the DHCP client program
365 .Pa ( /sbin/dhclient ,
370 .It Va dhclient_flags
372 Additional flags to pass to the DHCP client program.
377 manpage for a description of the command line options available.
378 .It Va dhclient_flags_ Ns Aq Ar iface
379 Additional flags to pass to the DHCP client program running on
382 When specified, this variable overrides
384 .It Va background_dhclient
388 to start the DHCP client in background.
389 This can cause trouble with applications depending on
390 a working network, but it will provide a faster startup
392 .It Va background_dhclient_ Ns Aq Ar iface
393 When specified, this variable overrides the
394 .Va background_dhclient
395 variable for interface
398 .It Va synchronous_dhclient
404 synchronously at startup.
405 This behavior can be overridden on a per-interface basis by replacing
409 .Va ifconfig_ Ns Aq Ar interface
414 .It Va defaultroute_delay
416 When set to a positive value, wait up to this long after configuring
417 DHCP interfaces at startup to give the interfaces time to receive a lease.
418 .It Va firewall_enable
422 to load firewall rules at startup.
423 If the kernel was not built with
424 .Cd "options IPFIREWALL" ,
427 kernel module will be loaded.
429 .Va ipfilter_enable .
430 .It Va firewall_script
432 This variable specifies the full path to the firewall script to run.
434 .Pa /etc/rc.firewall .
437 Names the firewall type from the selection in
438 .Pa /etc/rc.firewall ,
439 or the file which contains the local firewall ruleset.
440 Valid selections from
444 .Bl -tag -width ".Li simple" -compact
446 unrestricted IP access
448 all IP services disabled, except via
451 basic protection for a workstation
453 basic protection for a LAN.
456 If a filename is specified, the full path
458 .It Va firewall_quiet
462 to disable the display of firewall rules on the console during boot.
463 .It Va firewall_logging
467 to enable firewall event logging.
468 This is equivalent to the
469 .Dv IPFIREWALL_VERBOSE
471 .It Va firewall_flags
477 specifies a filename.
478 .It Va firewall_coscripts
480 List of executables and/or rc scripts to run after firewall starts/stops.
482 .\" ----- firewall_nat_enable setting --------------------------------
483 .It Va firewall_nat_enable
495 .It Va firewall_nat_interface
501 This is the name of the public interface or IP address on which
502 kernel NAT should run.
503 .It Va firewall_nat_flags
505 Additional configuration parameters for kernel NAT should be placed here.
506 .It Va dummynet_enable
510 will automatically load the
516 .\" -------------------------------------------------------------------
532 sockets must be enabled in the kernel.
533 If the kernel was not built with
534 .Cd "options IPDIVERT" ,
537 kernel module will be loaded.
538 .It Va natd_interface
540 This is the name of the public interface on which
543 The interface may be given as an interface name or as an IP address.
548 flags should be placed here.
553 flag is automatically added with the above
556 .\" ----- ipfilter_enable setting --------------------------------
557 .It Va ipfilter_enable
568 Typical usage will require putting
570 ipfilter_enable="YES"
588 can be enabled independently.
592 both require at least one of
602 options IPFILTER_DEFAULT_BLOCK
605 in the kernel configuration file is a good idea, too.
606 .\" ----- ipfilter_program setting ------------------------------
607 .It Va ipfilter_program
613 .\" ----- ipfilter_rules setting --------------------------------
614 .It Va ipfilter_rules
619 This variable contains the name of the filter rule definition file.
620 The file is expected to be readable for the
623 .\" ----- ipv6_ipfilter_rules setting ---------------------------
624 .It Va ipv6_ipfilter_rules
629 This variable contains the IPv6 filter rule definition file.
630 The file is expected to be readable for the
633 .\" ----- ipfilter_flags setting --------------------------------
634 .It Va ipfilter_flags
637 This variable contains flags passed to the
640 .\" ----- ipnat_enable setting ----------------------------------
650 network address translation.
653 for a detailed discussion.
654 .\" ----- ipnat_program setting ---------------------------------
661 .\" ----- ipnat_rules setting -----------------------------------
667 This variable contains the name of the file
668 holding the network address translation definition.
669 This file is expected to be readable for the
672 .\" ----- ipnat_flags setting -----------------------------------
676 This variable contains flags passed to the
679 .\" ----- ipmon_enable setting ----------------------------------
694 Setting this variable needs setting
701 for a detailed discussion.
702 .\" ----- ipmon_program setting ---------------------------------
709 .\" ----- ipmon_flags setting -----------------------------------
715 This variable contains flags passed to the
718 Another typical example would be
719 .Dq Fl D Pa /var/log/ipflog
722 log directly to a file bypassing
725 .Pa /etc/newsyslog.conf
726 in such case like this:
728 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
730 .\" ----- ipfs_enable setting -----------------------------------
740 saving the filter and NAT state tables during shutdown
741 and reloading them during startup again.
742 Setting this variable needs setting
751 for a detailed discussion.
757 because the raised securelevel will prevent
759 from saving the state tables at shutdown time.
760 .\" ----- ipfs_program setting ----------------------------------
767 .\" ----- ipfs_flags setting ------------------------------------
771 This variable contains flags passed to the
774 .\" ----- end of added ipf hook ---------------------------------
786 Typical usage will require putting
801 into the kernel, otherwise the
802 kernel module will be loaded.
807 ruleset configuration file
822 these flags are passed to the
824 program when loading the ruleset.
834 which logs packets from the
847 .Pa /var/log/pflog ) .
849 .Pa /etc/newsyslog.conf
850 to adjust logfile rotation for this.
860 This variable contains additional flags passed to the
863 .It Va ftpproxy_enable
874 packet filter in translating ftp connections.
875 .It Va ftpproxy_flags
878 This variable contains additional flags passed to the
890 state changes to other hosts over the network by means of
895 must also be set then.
896 .It Va pfsync_syncdev
899 This variable specifies the name of the network interface
901 should operate through.
902 It must be set accordingly if
906 .It Va pfsync_syncpeer
909 This variable is optional.
910 By default, state change messages are sent out on the synchronisation
911 interface using IP multicast packets.
912 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
914 When a peer address is specified using the
916 option, the peer address is used as a destination for the pfsync
917 traffic, and the traffic can then be protected using
921 manpage for more details about using
926 .It Va pfsync_ifconfig
929 This variable can contain additional options to be passed to the
931 command used to set up
933 .It Va tcp_extensions
940 disables certain TCP options as described by
946 might help remedy such problems with connections as randomly hanging
947 or other weird behavior.
948 Some network devices are known
949 to be broken with respect to these options.
956 .Va net.inet.tcp.log_in_vain
958 .Va net.inet.udp.log_in_vain ,
963 are set to the given value.
971 will disable probing idle TCP connections to verify that the
972 peer is still up and reachable.
973 .It Va tcp_drop_synfin
980 will cause the kernel to ignore TCP frames that have both
981 the SYN and FIN flags set.
982 This prevents OS fingerprinting, but may
983 break some legitimate applications.
984 .It Va icmp_drop_redirect
991 will cause the kernel to ignore ICMP REDIRECT packets.
994 for more information.
995 .It Va icmp_log_redirect
1002 will cause the kernel to log ICMP REDIRECT packets.
1004 the log messages are not rate-limited, so this option should only be used
1005 for troubleshooting networks.
1008 for more information.
1009 .It Va icmp_bmcastecho
1013 to respond to broadcast or multicast ICMP ping packets.
1016 for more information.
1017 .It Va ip_portrange_first
1021 this is the first port in the default portrange.
1024 for more information.
1025 .It Va ip_portrange_last
1029 this is the last port in the default portrange.
1032 for more information.
1033 .It Va network_interfaces
1035 Set to the list of network interfaces to configure on this host or
1037 (the default) for all current interfaces.
1039 .Va network_interfaces
1040 variable to anything other than the default is deprecated.
1041 Interfaces that the administrator wishes to store configuration for,
1042 but not start at boot should be configured with the
1045 .Va ifconfig_ Ns Aq Ar interface
1046 variables as described below.
1049 .Va ifconfig_ Ns Aq Ar interface
1050 variable is also assumed to exist for each value of
1052 When an interface name contains any of the characters
1054 they are translated to
1057 The variable can contain arguments to
1059 as well as special case-insensitive keywords described below.
1060 Such keywords are removed before passing the value to
1062 while the order of the other arguments is preserved.
1064 One can configure more than one IPv4 address with the
1065 .Va ipv4_addrs_ Ns Aq Ar interface
1067 One or more IP addresses must be provided in Classless Inter-Domain
1068 Routing (CIDR) address notation, whose last byte can be a range like
1070 In this case the address 192.0.2.5 will be configured with the
1071 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1072 the non-conflicting netmask /32 as explained in the
1075 With the interface in question being
1077 an example could look like:
1079 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1082 It is also possible to add IP alias entries using
1085 Assuming that the interface in question was
1088 something like this:
1090 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1091 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1096 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1097 entry that is found,
1098 its contents are passed to
1100 Execution stops at the first unsuccessful access, so if
1101 something like this is present:
1103 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1104 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1105 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1106 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1109 Then note that alias4 would
1111 be added since the search would
1112 stop with the missing
1115 Due to this difficult to manage behavior, the
1116 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1120 .Pa /etc/start_if. Ns Aq Ar interface
1121 file is present, it is read and executed by the
1124 before configuring the interface as specified in the
1125 .Va ifconfig_ Ns Aq Ar interface
1127 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1131 .Va vlans_ Ns Aq Ar interface
1135 interface will be created for each item in the list with the
1139 If a vlan interface's name is a number,
1140 then that number is used as the vlan tag and the new vlan interface is
1142 .Ar interface . Ns Ar tag .
1144 the vlan tag must be specified via a
1147 .Va create_args_ Ns Aq Ar interface
1150 To create a vlan device named
1154 with the vlan tag 101:
1159 To create a vlan device named
1163 with the vlan tag 102:
1166 create_args_myvlan="vlan 102"
1170 .Va wlans_ Ns Aq Ar interface
1174 interface will be created for each item in the list with the
1178 Further wlan cloning arguments may be passed to the
1181 command by setting the
1182 .Va create_args_ Ns Aq Ar interface
1186 devices must be created for each wireless devices as of
1192 may be specified with an
1193 .Va wlandebug_ Ns Aq Ar interface
1195 The contents of this variable will be passed directly to
1199 .Va ifconfig_ Ns Aq Ar interface
1200 contains the keyword
1202 then the interface will not be configured
1204 .Pa /etc/pccard_ether
1206 .Va network_interfaces
1210 It is possible to bring up an interface with DHCP by adding
1213 .Va ifconfig_ Ns Aq Ar interface
1215 For instance, to initialize the
1218 it is possible to use something like:
1223 Also, if you want to configure your wireless interface with
1224 .Xr wpa_supplicant 8
1225 for use with WPA, EAP/LEAP or WEP, you need to add
1228 .Va ifconfig_ Ns Aq Ar interface
1231 Finally, you can add
1233 options in this variable, in addition to the
1234 .Pa /etc/start_if. Ns Aq Ar interface
1236 For instance, to configure an
1238 wireless device in station mode with an address obtained
1239 via DHCP, using WPA authentication and 802.11b mode, it is
1240 possible to use something like:
1243 ifconfig_wlan0="DHCP WPA mode 11b"
1247 .Va ifconfig_ Ns Aq Ar interface
1248 form, a fallback variable
1249 .Va ifconfig_DEFAULT
1251 It will be used for all interfaces with no
1252 .Va ifconfig_ Ns Aq Ar interface
1254 This is intended to replace the no longer supported
1258 It is also possible to rename an interface by doing:
1260 ifconfig_ed0_name="net0"
1261 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1263 .\" Remove in FreeBSD 10.x
1267 This option is deprecated.
1272 To configure IPv6 for an interface see
1273 .Va ipv6_network_interfaces
1280 IPv6 will be disabled for each interface,
1281 however the same effect can be achieved by
1282 not configuring the interface.
1283 .It Va ipv6_network_interfaces
1285 This is the IPv6 equivalent of
1286 .Va network_interfaces .
1287 Normally configuration of this variable is not needed,
1288 the value should be left as
1293 is configured in the kernel configuration for the
1295 interface will always be performed.
1296 It is not necessary to list it in
1297 .Va ipv6_network_interfaces .
1299 Example configuration to accept Router Advertisements (RA) for the
1303 ifconfig_ed0_ipv6="RTADV"
1306 To configure only a link-local address on the
1310 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1315 option is available, although not required if manual
1316 configuration is performed as described below.
1318 An IPv6 interface can be configured manually with
1319 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 .
1322 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1325 Manual configuration of an IPv6 address will also
1326 require configuration of the
1327 .Va ipv6_defaultrouter
1330 Aliases should be set by
1331 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1338 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1345 the default policy of the source address selection set by
1347 will be IPv6-preferred.
1351 the default policy of the source address selection set by
1353 will be IPv4-preferred.
1359 privacy addresses will be generated for each IPv6
1360 interface as described in RFC 4193.
1362 .It Va ipv6_prefix_ Ns Aq Ar interface
1364 If one or more prefixes are defined in
1365 .Va ipv6_prefix_ Ns Aq Ar interface
1366 addresses based on each prefix and the EUI-64 interface index will be
1367 configured on that interface.
1368 .It Va ipv6_default_interface
1372 this is the default output interface for scoped addresses.
1373 Now this works only for IPv6 link local multicast addresses.
1374 .It Va ip6addrctl_enable
1378 install default address selection policy table
1381 .Pa /etc/ip6addrctl.conf
1384 reads and installs it.
1385 If not, a pre-defined policy table will be installed.
1386 There are two pre-defined ones; IPv4-preferred and IPv6-preferred.
1391 the IPv6-preferred one is used. Default is IPv4-preferred.
1392 .It Va cloned_interfaces
1394 Set to the list of clonable network interfaces to create on this host.
1395 Further cloning arguments may be passed to the
1398 command for each interface by setting the
1399 .Va create_args_ Ns Aq Ar interface
1402 .Va cloned_interfaces
1403 are automatically appended to
1404 .Va network_interfaces
1406 .It Va fec_interfaces
1410 Fast EtherChannel interfaces to configure on this host.
1412 .Va fecconfig_ Ns Aq Ar interface
1413 variable is assumed to exist for each value of
1415 The value of this variable is used to configure link aggregated interfaces
1416 according to the syntax of the
1417 .Cm NGM_FEC_ADD_IFACE
1421 Additionally, this option ensures that each listed interface is created
1426 before attempting to configure it.
1429 fec_interfaces="fec0"
1430 fecconfig_fec0="em0 em1"
1431 ifconfig_fec0="DHCP"
1433 .It Va gif_interfaces
1437 tunnel interfaces to configure on this host.
1439 .Va gifconfig_ Ns Aq Ar interface
1440 variable is assumed to exist for each value of
1442 The value of this variable is used to configure the link layer of the
1443 tunnel according to the syntax of the
1447 Additionally, this option ensures that each listed interface is created
1452 before attempting to configure it.
1453 .It Va sppp_interfaces
1457 interfaces to configure on this host.
1459 .Va spppconfig_ Ns Aq Ar interface
1460 variable is assumed to exist for each value of
1462 Each interface should also be configured by a general
1463 .Va ifconfig_ Ns Aq Ar interface
1467 for more information about available options.
1477 The name of the profile to use from
1478 .Pa /etc/ppp/ppp.conf .
1479 Also used for per-profile overrides of
1484 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1485 When the profile name contains any of the characters
1487 they are translated to
1489 for the proposes of the override variable names.
1492 Mode in which to run the
1495 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1497 Overrides the global
1507 See the manual for a full description.
1512 enables network address translation.
1513 Used in conjunction with
1515 allows hosts on private network addresses access to the Internet using
1516 this host as a network address translating router.
1517 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1519 Overrides the global
1523 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1525 Set the unit number to be used for this profile.
1526 See the manual description of
1531 The name of the user under which
1539 .It Va rc_conf_files
1541 This option is used to specify a list of files that will override
1543 .Pa /etc/defaults/rc.conf .
1544 The files will be read in the order in which they are specified and should
1545 include the full path to the file.
1546 By default, the files specified are
1549 .Pa /etc/rc.conf.local
1555 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1557 .It Va gbde_autoattach_all
1562 will attempt to automatically initialize your .bde devices in
1566 List the devices that the script should try to attach,
1571 The directory where the
1573 lockfiles are located.
1574 The default lockfile directory is
1577 The lockfile for each individual
1579 device can be overridden by setting the variable
1580 .Va gbde_lock_ Ns Aq Ar device ,
1583 is the encrypted device without the
1588 .It Va gbde_attach_attempts
1590 Number of times to attempt attaching to a
1592 device, i.e., how many times the user is asked for the pass-phrase.
1596 List of devices to automatically attach on boot.
1597 Note that .eli devices from
1599 are automatically appended to this list.
1602 Number of times user is asked for the pass-phrase.
1603 If empty, it will be taken from
1604 .Va kern.geom.eli.tries
1606 .It Va geli_default_flags
1608 Default flags to use by
1610 when configuring disk encryption.
1611 Flags can be configured for every device separately by defining
1612 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1614 .It Va geli_autodetach
1616 Specifies if GELI devices should be marked for detach on last close after
1617 file systems are mounted.
1620 This can be changed for every device separately by defining
1621 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1623 .It Va geli_swap_flags
1624 Options passed to the
1626 utility when encrypted GEOM providers for swap partitions are created.
1628 .Dq Li "-e aes -l 256 -s 4096 -d" .
1629 .It Va root_rw_mount
1634 After the file systems are checked at boot time, the root file system
1635 is remounted as read-write if this is set to
1637 Diskless systems that mount their root file system from a read-only remote
1638 NFS share should set this to
1642 .It Va fsck_y_enable
1647 will be run with the
1649 flag if the initial preen
1650 of the file systems fails.
1651 .It Va background_fsck
1655 the system will attempt to run
1657 in the background where possible.
1658 .It Va background_fsck_delay
1660 The amount of time in seconds to sleep before starting a background
1662 It defaults to sixty seconds to allow large applications such as
1663 the X server to start before disk I/O bandwidth is monopolized by
1665 If set to a negative number, the background file system check will be
1666 delayed indefinitely to allow the administrator to run it at a more
1668 For example it may be run from
1670 by adding a line like
1672 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1678 List of file system types that are network-based.
1679 This list should generally not be modified by end users.
1681 .Va extra_netfs_types
1683 .It Va extra_netfs_types
1685 If set to something other than
1688 this variable extends the list of file system types
1689 for which automatic mounting at startup by
1691 should be delayed until the network is initialized.
1693 a whitespace-separated list of network file system descriptor pairs,
1694 each consisting of a file system type as passed to
1696 and a human-readable, one-word description,
1699 Extending the default list in this way is only necessary
1700 when third party file system types are used.
1701 .It Va syslogd_enable
1708 .It Va syslogd_program
1713 .Pa /usr/sbin/syslogd ) .
1714 .It Va syslogd_flags
1720 these are the flags to pass to
1729 .It Va inetd_program
1734 .Pa /usr/sbin/inetd ) .
1741 these are the flags to pass to
1750 .It Va hastd_program
1762 these are the flags to pass to
1771 .It Va named_program
1776 .Pa /usr/sbin/named ) .
1781 configuration file, (default
1782 .Pa /etc/namedb/named.conf ) .
1789 these are the flags to pass to
1791 .It Va named_pidfile
1793 This is the default path to the
1796 This must match the location in
1802 process should be run as.
1803 .It Va named_chrootdir
1805 The root directory for a name server run in a
1807 environment (default
1811 will not be run in a
1814 .It Va named_chroot_autoupdate
1818 to disable automatic update of the
1821 .It Va named_symlink_enable
1825 to disable symlinking of
1834 loop until working name service is established.
1835 .It Va named_wait_host
1837 Name of host to lookup for the named_wait option.
1839 .It Va named_auto_forward
1841 Set to enable automatic creation of a forwarder
1842 configuration file derived from
1843 .Pa /etc/resolv.conf .
1844 .It Va named_auto_forward_only
1846 Set to change the default forwarder configuration from
1850 .It Va kerberos5_server_enable
1854 to start a Kerberos 5 authentication server
1856 .It Va kerberos5_server
1859 .Va kerberos5_server_enable
1862 this is the path to Kerberos 5 Authentication Server.
1863 .It Va kerberos5_server_flags
1866 This variable contains additional flags to be passed to the Kerberos 5
1867 authentication server.
1868 .It Va kadmind5_server_enable
1874 the Kerberos 5 Administration Daemon; set to
1877 .It Va kadmind5_server
1880 .Va kadmind5_server_enable
1883 this is the path to Kerberos 5 Administration Daemon.
1884 .It Va kpasswdd_server_enable
1890 the Kerberos 5 Password-Changing Daemon; set to
1893 .It Va kpasswdd_server
1896 .Va kpasswdd_server_enable
1899 this is the path to Kerberos 5 Password-Changing Daemon.
1906 daemon at boot time.
1913 these are the flags to pass to it.
1920 daemon at boot time.
1927 these are the flags to pass to it.
1930 manpage for more information.
1931 .It Va amd_map_program
1934 the specified program is run to get the list of
1939 maps are stored in NIS, one can set this to
1952 will be updated at boot time to reflect the kernel release
1957 will not be updated.
1958 .It Va nfs_client_enable
1962 run the NFS client daemons at boot time.
1963 .It Va nfs_access_cache
1966 .Va nfs_client_enable
1971 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1973 results should be cached.
1974 A value of 2-10 seconds will substantially reduce network
1975 traffic for many NFS operations.
1976 .It Va nfs_server_enable
1980 run the NFS server daemons at boot time.
1981 .It Va nfs_server_flags
1984 .Va nfs_server_enable
1987 these are the flags to pass to the
1990 .It Va idmapd_enable
1994 run the ID mapping daemon for NFS version 4.
2001 these are the flags to pass to the
2004 .It Va mountd_enable
2009 .Va nfs_server_enable
2015 It is commonly needed to run CFS without real NFS used.
2022 these are the flags to pass to the
2025 .It Va weak_mountd_authentication
2029 allow services like PCNFSD to make non-privileged mount
2031 .It Va nfs_reserved_port_only
2035 provide NFS services only on a secure port.
2036 .It Va nfs_bufpackets
2038 If set to a number, indicates the number of packets worth of
2039 socket buffer space to reserve on an NFS client.
2040 The kernel default is typically 4.
2041 Using a higher number may be
2042 useful on gigabit networks to improve performance.
2043 The minimum value is
2044 2 and the maximum is 64.
2045 .It Va rpc_lockd_enable
2049 and also an NFS server or client, run
2052 .It Va rpc_lockd_flags
2055 .Va rpc_lockd_enable
2058 these are the flags to pass to the
2061 .It Va rpc_statd_enable
2065 and also an NFS server or client, run
2068 .It Va rpc_statd_flags
2071 .Va rpc_statd_enable
2074 these are the flags to pass to the
2077 .It Va rpcbind_program
2082 .Pa /usr/sbin/rpcbind ) .
2083 .It Va rpcbind_enable
2089 service at boot time.
2090 .It Va rpcbind_flags
2096 these are the flags to pass to the
2099 .It Va keyserv_enable
2105 daemon on boot for running Secure RPC.
2106 .It Va keyserv_flags
2112 these are the flags to pass to
2115 .It Va pppoed_enable
2121 daemon at boot time to provide PPP over Ethernet services.
2122 .It Va pppoed_ Ns Aq Ar provider
2125 listens to requests to this
2131 argument of the same name.
2134 Additional flags to pass to
2136 .It Va pppoed_interface
2138 The network interface to run
2141 This is mandatory when
2151 service at boot time.
2152 This command is intended for networks of
2153 machines where a consistent
2155 for all hosts must be established.
2156 This is often useful in large NFS
2157 environments where time stamps on files are expected to be consistent
2165 these are the flags to pass to the
2168 .It Va ntpdate_enable
2175 This command is intended to
2176 synchronize the system clock only
2178 from some standard reference.
2179 An option to set this up initially
2180 (from a list of known servers) is also provided by the
2182 program when the system is first installed.
2183 .It Va ntpdate_config
2185 Configuration file for
2189 .It Va ntpdate_hosts
2191 A whitespace-separated list of NTP servers to synchronize with at startup.
2192 The default is to use the servers listed in
2193 .Va ntpdate_config ,
2194 if that file exists.
2195 .It Va ntpdate_program
2200 .Pa /usr/sbin/ntpdate ) .
2201 .It Va ntpdate_flags
2207 these are the flags to pass to the
2209 command (typically a hostname).
2216 command at boot time.
2222 .Pa /usr/sbin/ntpd ) .
2236 these are the flags to pass to the
2239 .It Va ntpd_sync_on_start
2246 flag, which syncs the system's clock on startup.
2249 for more information regarding the
2252 This is a preferred alternative to using
2257 .It Va nis_client_enable
2263 service at system boot time.
2264 .It Va nis_client_flags
2267 .Va nis_client_enable
2270 these are the flags to pass to the
2273 .It Va nis_ypset_enable
2279 daemon at system boot time.
2280 .It Va nis_ypset_flags
2283 .Va nis_ypset_enable
2286 these are the flags to pass to the
2289 .It Va nis_server_enable
2295 daemon at system boot time.
2296 .It Va nis_server_flags
2299 .Va nis_server_enable
2302 these are the flags to pass to the
2305 .It Va nis_ypxfrd_enable
2311 daemon at system boot time.
2312 .It Va nis_ypxfrd_flags
2315 .Va nis_ypxfrd_enable
2318 these are the flags to pass to the
2321 .It Va nis_yppasswdd_enable
2327 daemon at system boot time.
2328 .It Va nis_yppasswdd_flags
2331 .Va nis_yppasswdd_enable
2334 these are the flags to pass to the
2337 .It Va rpc_ypupdated_enable
2343 daemon at system boot time.
2344 .It Va bsnmpd_enable
2350 daemon at system boot time.
2351 Be sure to understand the security implications of running SNMP daemon
2359 these are the flags to pass to the
2362 .It Va defaultrouter
2366 create a default route to this host name or IP address
2367 (use an IP address if this router is also required to get to the
2369 .It Va ipv6_defaultrouter
2371 The IPv6 equivalent of
2373 .It Va static_arp_pairs
2375 Set to the list of static ARP pairs that are to be added at system
2377 For each whitespace separated
2380 .Va static_arp_ Ns Aq Ar element
2381 variable is assumed to exist whose contents will later be passed to a
2386 static_arp_pairs="gw"
2387 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2389 .It Va static_routes
2391 Set to the list of static routes that are to be added at system
2395 then for each whitespace separated
2398 .Va route_ Ns Aq Ar element
2399 variable is assumed to exist
2400 whose contents will later be passed to a
2405 static_routes="mcast gif0local"
2406 route_mcast="-net 224.0.0.0/4 -iface gif0"
2407 route_gif0local="-host 169.254.1.1 -iface lo0"
2409 .It Va ipv6_static_routes
2411 The IPv6 equivalent of
2415 then for each whitespace separated
2418 .Va ipv6_route_ Ns Aq Ar element
2419 variable is assumed to exist
2420 whose contents will later be passed to a
2421 .Dq Nm route Cm add Fl inet6
2423 .It Va natm_static_routes
2429 If not empty then for each whitespace separated
2432 .Va route_ Ns Aq Ar element
2433 variable is assumed to exist whose contents will later be passed to a
2434 .Dq Nm atmconfig Cm natm Cm add
2436 .It Va gateway_enable
2440 configure host to act as an IP router, e.g.\& to forward packets
2442 .It Va ipv6_gateway_enable
2444 The IPv6 equivalent of
2445 .Va gateway_enable .
2446 .It Va routed_enable
2450 run a routing daemon of some sort, based on the
2455 .It Va route6d_enable
2457 The IPv6 equivalent of
2461 run a routing daemon of some sort, based on the
2466 .It Va routed_program
2472 this is the name of the routing daemon to use.
2473 .It Va route6d_program
2475 The IPv6 equivalent of
2476 .Va routed_program .
2483 these are the flags to pass to the routing daemon.
2484 .It Va route6d_flags
2486 The IPv6 equivalent of
2488 .It Va mrouted_enable
2492 run the multicast routing daemon,
2494 .It Va mroute6d_enable
2496 The IPv6 equivalent of
2497 .Va mrouted_enable .
2500 run the IPv6 multicast routing daemon.
2502 Note that multicast routing daemons are no longer included in the
2504 base system, however, both
2508 may be installed from the
2511 .It Va mrouted_flags
2517 these are the flags to pass to the
2520 .It Va mroute6d_flags
2522 The IPv6 equivalent of
2528 these are the flags passed to the IPv6 multicast routing daemon.
2529 .It Va mroute6d_program
2535 this is the path to the IPv6 multicast routing daemon.
2536 .It Va rtadvd_enable
2542 daemon at boot time.
2545 .Va ipv6_gateway_enable
2550 utility sends router advertisement packets to the interfaces specified in
2551 .Va rtadvd_interfaces
2552 and should only be enabled with great care.
2553 You may want to fine-tune
2555 .It Va rtadvd_interfaces
2561 this is the list of interfaces to use.
2562 .It Va ipxgateway_enable
2566 enable the routing of IPX traffic.
2567 .It Va ipxrouted_enable
2573 daemon at system boot time.
2574 .It Va ipxrouted_flags
2577 .Va ipxrouted_enable
2580 these are the flags to pass to the
2587 enable global proxy ARP.
2588 .It Va forward_sourceroute
2596 source-routed packets are forwarded.
2597 .It Va accept_sourceroute
2601 the system will accept source-routed packets directed at it.
2608 daemon at system boot time.
2615 these are the flags to pass to the
2618 .It Va bootparamd_enable
2624 daemon at system boot time.
2625 .It Va bootparamd_flags
2628 .Va bootparamd_enable
2631 these are the flags to pass to the
2634 .It Va stf_interface_ipv4addr
2638 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2640 Specify this entry to enable the 6to4 interface.
2641 .It Va stf_interface_ipv4plen
2643 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2644 An effective value is 0-31.
2645 .It Va stf_interface_ipv6_ifid
2647 IPv6 interface ID for
2651 .It Va stf_interface_ipv6_slaid
2653 IPv6 Site Level Aggregator for
2655 .It Va ipv6_faith_prefix
2659 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2664 .It Va ipv6_ipv4mapping
2668 this enables IPv4 mapped IPv6 address communication (like
2669 .Li ::ffff:a.b.c.d ) .
2674 to enable the configuration of ATM interfaces at system boot time.
2675 For all of the ATM variables described below, please refer to the
2677 manual page for further details on the available command parameters.
2678 Also refer to the files in
2679 .Pa /usr/share/examples/atm
2680 for more detailed configuration information.
2683 This is a list of physical ATM interface drivers to load.
2688 .It Va atm_netif_ Ns Aq Ar intf
2690 For the ATM physical interface
2692 this variable defines the name prefix and count for the ATM network
2693 interfaces to be created.
2694 The value will be passed as the parameters of an
2695 .Dq Nm atm Cm "set netif" Ar intf
2697 .It Va atm_sigmgr_ Ns Aq Ar intf
2699 For the ATM physical interface
2701 this variable defines the ATM signalling manager to be used.
2702 The value will be passed as the parameters of an
2703 .Dq Nm atm Cm attach Ar intf
2705 .It Va atm_prefix_ Ns Aq Ar intf
2707 For the ATM physical interface
2709 this variable defines the NSAP prefix for interfaces using a UNI signalling
2713 the prefix will automatically be set via the
2716 Otherwise, the value will be passed as the parameters of an
2717 .Dq Nm atm Cm "set prefix" Ar intf
2719 .It Va atm_macaddr_ Ns Aq Ar intf
2721 For the ATM physical interface
2723 this variable defines the MAC address for interfaces using a UNI signalling
2727 the hardware MAC address contained in the ATM interface card will be used.
2728 Otherwise, the value will be passed as the parameters of an
2729 .Dq Nm atm Cm "set mac" Ar intf
2731 .It Va atm_arpserver_ Ns Aq Ar netif
2733 For the ATM network interface
2735 this variable defines the ATM address for a host which is to provide ATMARP
2737 This variable is only applicable to interfaces using a UNI signalling
2741 this host will become an ATMARP server.
2742 The value will be passed as the parameters of an
2743 .Dq Nm atm Cm "set arpserver" Ar netif
2745 .It Va atm_scsparp_ Ns Aq Ar netif
2749 SCSP/ATMARP service for the network interface
2751 will be initiated using the
2756 This variable is only applicable if
2757 .Va atm_arpserver_ Ns Aq Ar netif
2762 Set to the list of ATM PVCs to be added at system
2764 For each whitespace separated
2767 .Va atm_pvc_ Ns Aq Ar element
2768 variable is assumed to exist.
2769 The value of each of these variables
2770 will be passed as the parameters of an
2771 .Dq Nm atm Cm "add pvc"
2775 Set to the list of permanent ATM ARP entries to be added
2776 at system boot time.
2777 For each whitespace separated
2780 .Va atm_arp_ Ns Aq Ar element
2781 variable is assumed to exist.
2782 The value of each of these variables
2783 will be passed as the parameters of an
2784 .Dq Nm atm Cm "add arp"
2786 .It Va natm_interfaces
2790 interfaces that will also be used for HARP through
2792 If this list is not empty all interfaces in the list will be brought up
2798 For this to work the interface drivers must be either compiled into the
2799 kernel or must reside on the root partition.
2802 The keyboard bell sound.
2809 if the default behavior is desired.
2810 For details, refer to the
2815 If set to a non-null string, the virtual console's keyboard input is
2821 no keymap is installed, otherwise the value is used to install
2823 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2826 The keyboard repeat speed.
2833 if the default behavior is desired.
2838 attempt to program the function keys with the value.
2840 be a single string of the form:
2841 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2844 Can be set to the value of
2847 .Dq Li destructive ,
2850 to set the cursor behavior explicitly or choose the default behavior.
2855 no screen map is installed, otherwise the value is used to install
2856 the screen map file in
2857 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2862 the default 8x16 font value is used for screen size requests, otherwise
2864 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2870 the default 8x14 font value is used for screen size requests, otherwise
2872 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2878 the default 8x8 font value is used for screen size requests, otherwise
2880 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2886 the default screen blanking interval is used, otherwise it is set
2894 this is the actual screen saver to use
2895 .Li ( blank , snake , daemon ,
2897 .It Va moused_nondefault_enable
2901 the mouse device specified on
2902 the command line is not automatically treated as enabled by the
2903 .Pa /etc/rc.d/moused
2905 Having this variable set to
2911 to be enabled as soon as it is plugged in.
2912 .It Va moused_enable
2918 daemon is started for doing cut/paste selection on the console.
2921 This is the protocol type of the mouse connected to this host.
2922 This variable must be set if
2929 is able to detect the appropriate mouse type automatically in many cases.
2930 Set this variable to
2932 to let the daemon detect it, or
2933 select one from the following list if the automatic detection fails.
2935 If the mouse is attached to the PS/2 mouse port, choose
2939 regardless of the brand and model of the mouse.
2941 mouse is attached to the bus mouse port, choose
2945 All other protocols are for serial mice and will not work with
2946 the PS/2 and bus mice.
2947 If this is a USB mouse,
2949 is the only protocol type which will work.
2951 .Bl -tag -width ".Li x10mouseremote" -compact
2953 Microsoft mouse (serial)
2955 Microsoft IntelliMouse (serial)
2957 Mouse systems Corp.\& mouse (serial)
2959 MM Series mouse (serial)
2961 Logitech mouse (serial)
2965 Logitech MouseMan and TrackMan (serial)
2967 ALPS GlidePoint (serial)
2968 .It Li thinkingmouse
2969 Kensington ThinkingMouse (serial)
2973 MM HitTablet (serial)
2974 .It Li x10mouseremote
2975 X10 MouseRemote (serial)
2977 Interlink VersaPad (serial)
2980 Even if the mouse is not in the above list, it may be compatible
2981 with one in the list.
2982 Refer to the manual page for
2984 for compatibility information.
2986 It should also be noted that while this is enabled, any
2987 other client of the mouse (such as an X server) should access
2988 the mouse through the virtual mouse device,
2990 and configure it as a
2992 type mouse, since all
2993 mouse data is converted to this single canonical format when
2996 If the client program does not support the
3002 It is the second preferred type.
3009 this is the actual port the mouse is on.
3012 for a COM1 serial mouse,
3016 for a bus mouse, for example.
3021 is set, its value is used as an additional set of flags to pass to the
3024 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3026 .Va moused_nondefault_enable
3029 daemon is started for a non-default port, the
3030 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3031 set of options has precedence over and replaces the default
3032 .Va moused_flags (where
3034 is the name of the non-default port, i.e.\&
3037 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3038 it is possible to set up a different set of default flags for each
3041 For example, you can use
3045 to make your laptop's touchpad more comfortable to use,
3046 but an empty set of options for
3047 .Va moused_ums0_flags
3050 mouse has three or more buttons.
3051 .It Va mousechar_start
3055 the default mouse cursor character range
3056 .Li 0xd0 Ns - Ns Li 0xd3
3058 otherwise the range start is set
3063 Use if the default range is occupied in the language code table.
3064 .It Va allscreens_flags
3068 is run with these options for each of the virtual terminals
3072 will enable the mouse pointer on all virtual terminals
3077 .It Va allscreens_kbdflags
3081 is run with these options for each of the virtual terminals
3087 scrollback (history) buffer to 200 lines.
3094 daemon at system boot time.
3100 .Pa /usr/sbin/cron ) .
3107 these are the flags to pass to
3113 enable the special handling of transitions to and from the
3114 Daylight Saving Time in
3116 (equivalent to using the flag
3123 .Pa /usr/sbin/lpd ) .
3130 daemon at system boot time.
3137 these are the flags to pass to the
3140 .It Va chkprintcap_enable
3146 command before starting the
3149 .It Va chkprintcap_flags
3154 .Va chkprintcap_enable
3157 these are the flags to pass to the
3162 which causes missing directories to be created.
3163 .It Va mta_start_script
3165 This variable specifies the full path to the script to run to start
3166 a mail transfer agent.
3168 .Pa /etc/rc.sendmail .
3172 .Pa /etc/rc.sendmail
3173 uses are documented in the
3178 Indicates the device (usually a swap partition) to which a crash dump
3179 should be written in the event of a system crash.
3180 If the value of this variable is
3182 the first suitable swap device listed in
3184 will be used as dump device.
3185 Otherwise, the value of this variable is passed as the argument to
3187 To disable crash dumps, set this variable to
3191 When the system reboots after a crash and a crash dump is found on the
3192 device specified by the
3196 will save that crash dump and a copy of the kernel to the directory
3200 The default value is
3209 .It Va savecore_flags
3211 If crash dumps are enabled, these are the flags to pass to the
3218 to turn on user and group disk quotas on system startup via the
3220 command for all file systems marked as having quotas enabled in
3222 The kernel must be built with
3224 for disk quotas to function.
3229 to enable user and group disk quota checking via the
3232 .It Va quotacheck_flags
3242 these are the flags to pass to the
3247 which checks quotas for all file systems with quotas enabled in
3249 .It Va quotaon_flags
3255 these are the flags to pass to the
3260 which enables quotas for all file systems with quotas enabled in
3262 .It Va quotaoff_flags
3268 these are the flags to pass to the
3270 utility when shutting down the quota system.
3273 which disables quotas for all file systems with quotas enabled in
3275 .It Va accounting_enable
3279 to enable system accounting through the
3286 to enable iBCS2 (SCO) binary emulation at system initial boot
3288 .It Va ibcs2_loaders
3296 this specifies a list of additional iBCS2 loaders to enable.
3301 to enable Linux/ELF binary emulation at system initial
3307 enable SysVR4 emulation at boot time.
3308 .It Va sysvipc_enable
3312 load System V IPC primitives at boot time.
3313 .It Va clear_tmp_enable
3324 to disable removing of X11 lock files,
3325 and the removal and (secure) recreation
3326 of the various socket directories for X11
3328 .It Va ldconfig_paths
3330 Set to the list of shared library paths to use with
3334 will always be added first, so it need not appear in this list.
3335 .It Va ldconfig32_paths
3337 Set to the list of 32-bit compatibility shared library paths to
3340 .It Va ldconfig_paths_aout
3342 Set to the list of shared library paths to use with
3347 .It Va ldconfig_insecure
3351 utility normally refuses to use directories
3352 which are writable by anyone except root.
3353 Set this variable to
3355 to disable that security check during system startup.
3356 .It Va ldconfig_local_dirs
3358 Set to the list of local
3361 The names of all files in the directories listed will be
3362 passed as arguments to
3364 .It Va ldconfig_local32_dirs
3366 Set to the list of local 32-bit compatibility
3369 The names of all files in the directories listed will be
3370 passed as arguments to
3371 .Dq Nm ldconfig Fl 32 .
3372 .It Va kern_securelevel_enable
3376 to set the kernel security level at system startup.
3377 .It Va kern_securelevel
3379 The kernel security level to set at startup.
3380 The allowed range of
3382 ranges from \-1 (the compile time default) to 3 (the
3386 for the list of possible security levels and their effect
3387 on system operation.
3390 Path to the SSH server program
3391 .Pa ( /usr/sbin/sshd
3399 at system boot time.
3406 these are the flags to pass to the
3411 Path to the FTP server program
3412 .Pa ( /usr/libexec/ftpd
3420 as a stand-alone daemon at system boot time.
3427 these are the additional flags to pass to the
3430 .It Va watchdogd_enable
3436 daemon at boot time.
3437 This requires that the kernel have been compiled with a
3440 .It Va watchdogd_flags
3443 .Va watchdogd_enable
3446 these are the flags passed to the
3449 .It Va performance_cx_lowest
3451 CPU idle state to use while on AC power.
3456 should use the lowest power state available while
3458 indicates that the lowest latency state (less power savings) should be used.
3459 .It Va performance_cpu_freq
3461 CPU clock frequency to use while on AC power.
3466 should use the lowest frequency available while
3468 indicates that the highest frequency (less power savings) should be used.
3469 .It Va economy_cx_lowest
3471 CPU idle state to use when off AC power.
3476 should use the lowest power state available while
3478 indicates that the lowest latency state (less power savings) should be used.
3479 .It Va economy_cpu_freq
3481 CPU clock frequency to use when off AC power.
3486 should use the lowest frequency available while
3488 indicates that the highest frequency (less power savings) should be used.
3493 any configured jails will not be started.
3494 .It jail_parallel_start
3498 all configured jails will be started in the background (= in parallel).
3501 A space separated list of names for jails.
3502 This is purely a configuration aid to help identify and
3503 configure multiple jails.
3504 The names specified in this list will be used to
3505 identify settings common to an instance of a jail.
3506 Assuming that the jail in question was named
3508 you would have the following dependent variables:
3510 jail_vjail_hostname="jail.example.com"
3511 jail_vjail_ip="192.0.2.100"
3512 jail_vjail_rootdir="/var/jails/vjail/root"
3518 When set, use as default value for
3519 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3522 .It Va jail_interface
3525 When set, use as default value for
3526 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3532 When set, use as default value for
3533 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3536 .It Va jail_mount_enable
3544 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3547 by default for every jail in
3549 .It Va jail_devfs_ruleset
3553 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3554 to given value for every jail in
3556 .It Va jail_devfs_enable
3564 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3567 by default for every jail in
3569 .It Va jail_fdescfs_enable
3577 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3580 by default for every jail in
3582 .It Va jail_procfs_enable
3590 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3593 by default for every jail in
3595 .It Va jail_exec_prestart Ns Aq Ar N
3598 When set, use as default value for
3599 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3602 .It Va jail_exec_start
3605 When set, use as default value for
3606 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3609 .It Va jail_exec_afterstart Ns Aq Ar N
3612 When set, use as default value for
3613 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3616 .It Va jail_exec_poststart Ns Aq Ar N
3619 When set, use as default value for
3620 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3623 .It Va jail_exec_prestop Ns Aq Ar N
3626 When set, use as default value for
3627 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3630 .It Va jail_exec_stop
3632 When set, use as default value for
3633 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3636 .It Va jail_exec_poststop Ns Aq Ar N
3639 When set, use as default value for
3640 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3643 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3646 Set to the root directory used by jail
3648 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3651 Set to the fully qualified domain name (FQDN) assigned to jail
3653 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3656 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3657 The argument can be a sole address or a comma separated list of addresses.
3658 Additionally each address can be prefixed by the name of an interface
3659 followed by a pipe to overwrite
3660 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3663 and/or suffixed by a netmask, prefixlen or prefix.
3664 In case no netmask, prefixlen or prefix is given,
3666 will be used for IPv4 and
3668 will be used for an IPv6 address.
3669 If no address is given for the jail then the jail will be started with
3670 no networking support.
3671 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3674 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3675 The sequence starts with
3677 and the numbers have to be strictly ascending.
3678 These entries follow the same syntax as their primary
3679 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3681 The order of the entries can be important as the first address for
3682 each address family found will be the primary address of the jail.
3688 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3693 These are flags to pass to
3695 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3698 When set, sets the interface to use when setting IP address alias.
3699 Note that the alias is created at jail startup and removed at jail shutdown.
3700 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3703 When set, the jail is started with the specified forwarding table (sometimes
3704 referred to as a routing table) via
3706 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3709 .Pa /etc/fstab. Ns Aq Ar jname
3711 This is the file system information file to use for jail
3713 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3720 mount all file systems from
3721 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3723 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3726 When set, defines the device file system ruleset file to use for jail
3728 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3735 mount the device file system inside jail
3738 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3745 mount the file-descriptor file system inside jail
3748 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3755 mount the process file system inside jail
3758 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3761 This is the command run as
3764 before jail startup, where
3767 It is run outside the jail.
3768 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3771 .Dq Li /bin/sh /etc/rc
3773 This is the command executed in a jail at jail startup.
3774 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3777 This is the command run as
3781 after jail startup, where
3784 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3787 This is the command run as
3790 after jail startup, where
3793 It is run outside the jail.
3794 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3797 This is the command run as
3800 before jail shutdown, where
3803 It is run outside the jail.
3804 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3807 .Dq Li /bin/sh /etc/rc.shutdown
3809 This is the command executed in a jail at jail shutdown.
3810 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3813 This is the command run as
3816 after jail shutdown, where
3819 It is run outside the jail.
3820 .It Va jail_set_hostname_allow
3824 do not allow the root user in a jail to set its hostname.
3825 .It Va jail_socket_unixiproute_only
3829 do not allow any sockets,
3830 besides UNIX/IP/route sockets,
3831 to be used within a jail.
3832 .It Va jail_sysvipc_allow
3836 allow applications within a jail to use System V IPC.
3837 .\" -----------------------------------------------------
3838 .It Va harvest_interrupt
3842 to use hardware interrupts as an entropy source.
3845 for more information.
3846 .It Va harvest_ethernet
3850 to use LAN traffic as an entropy source.
3853 for more information.
3854 .It Va harvest_p_to_p
3858 to use serial line traffic as an entropy source.
3861 for more information.
3866 to disable caching entropy via
3868 Otherwise set to the directory used to store entropy files in.
3873 to disable caching entropy through reboots.
3874 Otherwise set to the filename used to store cached entropy through
3876 This file should be located on the root file system to seed the
3878 device as early as possible in the boot process.
3879 .It Va entropy_save_sz
3881 Size of the entropy cache files saved by
3884 .It Va entropy_save_num
3886 Number of entropy cache files to save by
3900 Configuration file for
3909 .Pa /var/run/dmesg.boot
3911 .It Va rcshutdown_timeout
3913 If set, start a watchdog timer in the background which will terminate
3917 has not completed within the specified time (in seconds).
3918 Notice that in addition to this soft timeout,
3920 also applies a hard timeout for the execution of
3922 This is configured via
3925 .Va kern.init_shutdown_timeout
3926 and defaults to 120 seconds.
3927 Setting the value of
3928 .Va rcshutdown_timeout
3929 to more than 120 seconds will have no effect until the
3932 .Va kern.init_shutdown_timeout
3934 .It Va virecover_enable
3938 to prevent the system from trying to
3939 recover pre-maturely terminated
3942 .It Va ugidfw_enable
3947 .Xr mac_bsdextended 4
3948 module upon system initialization and load a default
3950 .It Va bsdextended_script
3953 .Xr mac_bsdextended 4
3954 ruleset file to load.
3955 The default value of this variable is
3956 .Pa /etc/rc.bsdextended .
3957 .It Va newsyslog_enable
3964 .It Va newsyslog_flags
3967 .Va newsyslog_enable
3970 these are the flags to pass to the
3975 which causes log files flagged with a
3978 .It Va mdconfig_md Ns Aq Ar X
3988 must be specified and either a
3990 for malloc or swap backed
3998 .Va mdconfig_md Ns Aq Ar X
3999 variables are evaluated until one variable is unset or null.
4000 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4002 Optional arguments passed to
4008 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4010 An ownership specification passed to
4019 device and the mount point will be changed.
4020 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4022 A mode string passed to
4031 device and the mount point will be changed.
4032 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4034 Files to be copied to the mount point of the
4038 after it has been mounted.
4039 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4041 Command to execute after the specified
4046 Note that the command is passed to
4052 variables can be used to reference respectively the
4054 device and the mount point.
4059 one could set the following:
4061 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4063 .It Va ramdisk_units
4065 A list of one or more ramdisk units to configure with
4069 in time to be mounted from
4073 must specify at least a
4076 .Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
4078 Note that this way to configure ramdisks has been deprecated
4081 variables (see above).
4082 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
4090 must be specified, where
4096 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs
4098 Optional arguments passed to
4100 to initialize ramdisk
4102 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner
4104 An ownership specification passed to
4106 after the specified ramdisk unit
4111 device and the mount point will be changed.
4112 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms
4114 A mode string passed to
4116 after the specified ramdisk unit
4121 device and the mount point will be changed.
4122 .It Va autobridge_interfaces
4124 Set to the list of bridge interfaces that will have newly arriving interfaces
4125 checked against to be automatically added.
4128 then for each whitespace separated
4131 .Va autobridge_ Ns Aq Ar element
4132 variable is assumed to exist which has a whitespace separated list of interface
4133 names to match, these names can use wildcards.
4136 autobridge_interfaces="bridge0"
4137 autobridge_bridge0="tap* dc0 vlan[345]"
4143 enable support for sound mixer.
4144 .It Va hcsecd_enable
4148 enable Bluetooth security daemon.
4149 .It Va hcsecd_config
4151 Configuration file for
4154 .Pa /etc/bluetooth/hcsecd.conf .
4159 enable Bluetooth Service Discovery Protocol daemon.
4167 .It Va sdpd_groupname
4171 group to run as after it initializes.
4174 .It Va sdpd_username
4178 user to run as after it initializes.
4181 .It Va bthidd_enable
4185 enable Bluetooth Human Interface Device daemon.
4186 .It Va bthidd_config
4188 Configuration file for
4191 .Pa /etc/bluetooth/bthidd.conf .
4194 Path to a file, where
4196 will store information about known HID devices.
4198 .Pa /var/db/bthidd.hids .
4199 .It Va rfcomm_pppd_server_enable
4203 enable Bluetooth RFCOMM PPP wrapper daemon.
4204 .It Va rfcomm_pppd_server_profile
4206 The name of the profile to use from
4207 .Pa /etc/ppp/ppp.conf .
4208 Multiple profiles can be specified here.
4209 Also used to specify per-profile overrides.
4210 When the profile name contains any of the characters
4212 they are translated to
4214 for the proposes of the override variable names.
4215 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4217 Overrides local address to listen on.
4223 The address can be specified as BD_ADDR or name.
4224 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4226 Overrides local RFCOMM channel to listen on.
4229 will listen on RFCOMM channel 1.
4230 Must set properly if multiple profiles used in the same time.
4231 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4235 if it should register Serial Port service on the speficied RFCOMM channel.
4238 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4242 if it should register Dial-Up Networking service on the speficied
4246 .It Va ubthidhci_enable
4250 change the USB Bluetooth controller from HID mode to HCI mode.
4251 You also need to specify the location of USB Bluetooth controller with the
4252 .Va ubthidhci_busnum
4256 .It Va ubthidhci_busnum
4257 Bus number where the USB Bluetooth controller is located.
4260 on your system to find this information.
4261 .It Va ubthidhci_addr
4262 Bus address of the USB Bluetooth controller.
4265 on your system to find this information.
4268 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4269 .It Pa /etc/defaults/rc.conf
4271 .It Pa /etc/rc.conf.local
4301 .Xr newsyslog.conf 5 ,
4368 .An Jordan K. Hubbard .
projects / FreeBSD / FreeBSD.git / blob