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 Enable support for IPv6 networking.
360 Note that this requires that the kernel has been compiled with
361 .Cd "options INET6" .
364 The NIS domain name of this host, or
367 .It Va dhclient_program
369 Path to the DHCP client program
370 .Pa ( /sbin/dhclient ,
375 .It Va dhclient_flags
377 Additional flags to pass to the DHCP client program.
382 manpage for a description of the command line options available.
383 .It Va dhclient_flags_ Ns Aq Ar iface
384 Additional flags to pass to the DHCP client program running on
387 When specified, this variable overrides
389 .It Va background_dhclient
393 to start the DHCP client in background.
394 This can cause trouble with applications depending on
395 a working network, but it will provide a faster startup
397 .It Va background_dhclient_ Ns Aq Ar iface
398 When specified, this variable overrides the
399 .Va background_dhclient
400 variable for interface
403 .It Va synchronous_dhclient
409 synchronously at startup.
410 This behavior can be overridden on a per-interface basis by replacing
414 .Va ifconfig_ Ns Aq Ar interface
419 .It Va defaultroute_delay
421 When set to a positive value, wait up to this long after configuring
422 DHCP interfaces at startup to give the interfaces time to receive a lease.
423 .It Va firewall_enable
427 to load firewall rules at startup.
428 If the kernel was not built with
429 .Cd "options IPFIREWALL" ,
432 kernel module will be loaded.
434 .Va ipfilter_enable .
435 .It Va firewall_script
437 This variable specifies the full path to the firewall script to run.
439 .Pa /etc/rc.firewall .
442 Names the firewall type from the selection in
443 .Pa /etc/rc.firewall ,
444 or the file which contains the local firewall ruleset.
445 Valid selections from
449 .Bl -tag -width ".Li simple" -compact
451 unrestricted IP access
453 all IP services disabled, except via
456 basic protection for a workstation
458 basic protection for a LAN.
461 If a filename is specified, the full path
463 .It Va firewall_quiet
467 to disable the display of firewall rules on the console during boot.
468 .It Va firewall_logging
472 to enable firewall event logging.
473 This is equivalent to the
474 .Dv IPFIREWALL_VERBOSE
476 .It Va firewall_flags
482 specifies a filename.
483 .It Va firewall_coscripts
485 List of executables and/or rc scripts to run after firewall starts/stops.
487 .\" ----- firewall_nat_enable setting --------------------------------
488 .It Va firewall_nat_enable
500 .It Va firewall_nat_interface
506 This is the name of the public interface or IP address on which
507 kernel NAT should run.
508 .It Va firewall_nat_flags
510 Additional configuration parameters for kernel NAT should be placed here.
511 .It Va dummynet_enable
515 will automatically load the
521 .\" -------------------------------------------------------------------
537 sockets must be enabled in the kernel.
538 If the kernel was not built with
539 .Cd "options IPDIVERT" ,
542 kernel module will be loaded.
543 .It Va natd_interface
545 This is the name of the public interface on which
548 The interface may be given as an interface name or as an IP address.
553 flags should be placed here.
558 flag is automatically added with the above
561 .\" ----- ipfilter_enable setting --------------------------------
562 .It Va ipfilter_enable
573 Typical usage will require putting
575 ipfilter_enable="YES"
593 can be enabled independently.
597 both require at least one of
607 options IPFILTER_DEFAULT_BLOCK
610 in the kernel configuration file is a good idea, too.
611 .\" ----- ipfilter_program setting ------------------------------
612 .It Va ipfilter_program
618 .\" ----- ipfilter_rules setting --------------------------------
619 .It Va ipfilter_rules
624 This variable contains the name of the filter rule definition file.
625 The file is expected to be readable for the
628 .\" ----- ipv6_ipfilter_rules setting ---------------------------
629 .It Va ipv6_ipfilter_rules
634 This variable contains the IPv6 filter rule definition file.
635 The file is expected to be readable for the
638 .\" ----- ipfilter_flags setting --------------------------------
639 .It Va ipfilter_flags
642 This variable contains flags passed to the
645 .\" ----- ipnat_enable setting ----------------------------------
655 network address translation.
658 for a detailed discussion.
659 .\" ----- ipnat_program setting ---------------------------------
666 .\" ----- ipnat_rules setting -----------------------------------
672 This variable contains the name of the file
673 holding the network address translation definition.
674 This file is expected to be readable for the
677 .\" ----- ipnat_flags setting -----------------------------------
681 This variable contains flags passed to the
684 .\" ----- ipmon_enable setting ----------------------------------
699 Setting this variable needs setting
706 for a detailed discussion.
707 .\" ----- ipmon_program setting ---------------------------------
714 .\" ----- ipmon_flags setting -----------------------------------
720 This variable contains flags passed to the
723 Another typical example would be
724 .Dq Fl D Pa /var/log/ipflog
727 log directly to a file bypassing
730 .Pa /etc/newsyslog.conf
731 in such case like this:
733 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
735 .\" ----- ipfs_enable setting -----------------------------------
745 saving the filter and NAT state tables during shutdown
746 and reloading them during startup again.
747 Setting this variable needs setting
756 for a detailed discussion.
762 because the raised securelevel will prevent
764 from saving the state tables at shutdown time.
765 .\" ----- ipfs_program setting ----------------------------------
772 .\" ----- ipfs_flags setting ------------------------------------
776 This variable contains flags passed to the
779 .\" ----- end of added ipf hook ---------------------------------
791 Typical usage will require putting
806 into the kernel, otherwise the
807 kernel module will be loaded.
812 ruleset configuration file
827 these flags are passed to the
829 program when loading the ruleset.
839 which logs packets from the
852 .Pa /var/log/pflog ) .
854 .Pa /etc/newsyslog.conf
855 to adjust logfile rotation for this.
865 This variable contains additional flags passed to the
868 .It Va ftpproxy_enable
879 packet filter in translating ftp connections.
880 .It Va ftpproxy_flags
883 This variable contains additional flags passed to the
895 state changes to other hosts over the network by means of
900 must also be set then.
901 .It Va pfsync_syncdev
904 This variable specifies the name of the network interface
906 should operate through.
907 It must be set accordingly if
911 .It Va pfsync_syncpeer
914 This variable is optional.
915 By default, state change messages are sent out on the synchronisation
916 interface using IP multicast packets.
917 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
919 When a peer address is specified using the
921 option, the peer address is used as a destination for the pfsync
922 traffic, and the traffic can then be protected using
926 manpage for more details about using
931 .It Va pfsync_ifconfig
934 This variable can contain additional options to be passed to the
936 command used to set up
938 .It Va tcp_extensions
945 disables certain TCP options as described by
951 might help remedy such problems with connections as randomly hanging
952 or other weird behavior.
953 Some network devices are known
954 to be broken with respect to these options.
961 .Va net.inet.tcp.log_in_vain
963 .Va net.inet.udp.log_in_vain ,
968 are set to the given value.
976 will disable probing idle TCP connections to verify that the
977 peer is still up and reachable.
978 .It Va tcp_drop_synfin
985 will cause the kernel to ignore TCP frames that have both
986 the SYN and FIN flags set.
987 This prevents OS fingerprinting, but may
988 break some legitimate applications.
989 .It Va icmp_drop_redirect
996 will cause the kernel to ignore ICMP REDIRECT packets.
999 for more information.
1000 .It Va icmp_log_redirect
1007 will cause the kernel to log ICMP REDIRECT packets.
1009 the log messages are not rate-limited, so this option should only be used
1010 for troubleshooting networks.
1013 for more information.
1014 .It Va icmp_bmcastecho
1018 to respond to broadcast or multicast ICMP ping packets.
1021 for more information.
1022 .It Va ip_portrange_first
1026 this is the first port in the default portrange.
1029 for more information.
1030 .It Va ip_portrange_last
1034 this is the last port in the default portrange.
1037 for more information.
1038 .It Va network_interfaces
1040 Set to the list of network interfaces to configure on this host or
1042 (the default) for all current interfaces.
1044 .Va network_interfaces
1045 variable to anything other than the default is deprecated.
1046 Interfaces that the administrator wishes to store configuration for,
1047 but not start at boot should be configured with the
1050 .Va ifconfig_ Ns Aq Ar interface
1051 variables as described below.
1054 .Va ifconfig_ Ns Aq Ar interface
1055 variable is also assumed to exist for each value of
1057 When an interface name contains any of the characters
1059 they are translated to
1062 The variable can contain arguments to
1064 as well as special case-insensitive keywords described below.
1065 Such keywords are removed before passing the value to
1067 while the order of the other arguments is preserved.
1069 One can configure more than one IPv4 address with the
1070 .Va ipv4_addrs_ Ns Aq Ar interface
1072 One or more IP addresses must be provided in Classless Inter-Domain
1073 Routing (CIDR) address notation, whose last byte can be a range like
1075 In this case the address 192.0.2.5 will be configured with the
1076 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1077 the non-conflicting netmask /32 as explained in the
1080 With the interface in question being
1082 an example could look like:
1084 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1087 It is also possible to add IP alias entries using
1090 Assuming that the interface in question was
1093 something like this:
1095 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1096 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1101 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1102 entry that is found,
1103 its contents are passed to
1105 Execution stops at the first unsuccessful access, so if
1106 something like this is present:
1108 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1109 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1110 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1111 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1114 Then note that alias4 would
1116 be added since the search would
1117 stop with the missing
1120 Due to this difficult to manage behavior, the
1121 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1125 .Pa /etc/start_if. Ns Aq Ar interface
1126 file is present, it is read and executed by the
1129 before configuring the interface as specified in the
1130 .Va ifconfig_ Ns Aq Ar interface
1132 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1136 .Va vlans_ Ns Aq Ar interface
1140 interface will be created for each item in the list with the
1144 If a vlan interface's name is a number,
1145 then that number is used as the vlan tag and the new vlan interface is
1147 .Ar interface . Ns Ar tag .
1149 the vlan tag must be specified via a
1152 .Va create_args_ Ns Aq Ar interface
1155 To create a vlan device named
1159 with the vlan tag 101:
1164 To create a vlan device named
1168 with the vlan tag 102:
1171 create_args_myvlan="vlan 102"
1175 .Va wlans_ Ns Aq Ar interface
1179 interface will be created for each item in the list with the
1183 Further wlan cloning arguments may be passed to the
1186 command by setting the
1187 .Va create_args_ Ns Aq Ar interface
1191 devices must be created for each wireless devices as of
1197 may be specified with an
1198 .Va wlandebug_ Ns Aq Ar interface
1200 The contents of this variable will be passed directly to
1204 .Va ifconfig_ Ns Aq Ar interface
1205 contains the keyword
1207 then the interface will not be configured
1209 .Pa /etc/pccard_ether
1211 .Va network_interfaces
1215 It is possible to bring up an interface with DHCP by adding
1218 .Va ifconfig_ Ns Aq Ar interface
1220 For instance, to initialize the
1223 it is possible to use something like:
1228 Also, if you want to configure your wireless interface with
1229 .Xr wpa_supplicant 8
1230 for use with WPA, EAP/LEAP or WEP, you need to add
1233 .Va ifconfig_ Ns Aq Ar interface
1236 Finally, you can add
1238 options in this variable, in addition to the
1239 .Pa /etc/start_if. Ns Aq Ar interface
1241 For instance, to configure an
1243 wireless device in station mode with an address obtained
1244 via DHCP, using WPA authentication and 802.11b mode, it is
1245 possible to use something like:
1248 ifconfig_wlan0="DHCP WPA mode 11b"
1252 .Va ifconfig_ Ns Aq Ar interface
1253 form, a fallback variable
1254 .Va ifconfig_DEFAULT
1256 It will be used for all interfaces with no
1257 .Va ifconfig_ Ns Aq Ar interface
1259 This is intended to replace the no longer supported
1263 It is also possible to rename an interface by doing:
1265 ifconfig_ed0_name="net0"
1266 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1268 .It Va ipv6_network_interfaces
1270 This is the IPv6 equivalent of
1271 .Va network_interfaces .
1272 Instead of setting the ifconfig variables as
1273 .Va ifconfig_ Ns Aq Ar interface
1274 they should be set as
1275 .Va ipv6_ifconfig_ Ns Aq Ar interface .
1276 Aliases should be set as
1277 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
1278 .Va ipv6_prefix_ Ns Aq Ar interface
1280 Interfaces that do not have a
1281 .Va ipv6_ifconfig_ Ns Aq Ar interface
1282 setting will be auto configured by
1285 .Va ipv6_gateway_enable
1288 Note that the IPv6 networking code does not support the
1289 .Pa /etc/start_if. Ns Aq Ar interface
1291 .It Va ipv6_default_interface
1295 this is the default output interface for scoped addresses.
1296 Now this works only for IPv6 link local multicast addresses.
1297 .It Va cloned_interfaces
1299 Set to the list of clonable network interfaces to create on this host.
1300 Further cloning arguments may be passed to the
1303 command for each interface by setting the
1304 .Va create_args_ Ns Aq Ar interface
1307 .Va cloned_interfaces
1308 are automatically appended to
1309 .Va network_interfaces
1311 .It Va fec_interfaces
1315 Fast EtherChannel interfaces to configure on this host.
1317 .Va fecconfig_ Ns Aq Ar interface
1318 variable is assumed to exist for each value of
1320 The value of this variable is used to configure link aggregated interfaces
1321 according to the syntax of the
1322 .Cm NGM_FEC_ADD_IFACE
1326 Additionally, this option ensures that each listed interface is created
1331 before attempting to configure it.
1334 fec_interfaces="fec0"
1335 fecconfig_fec0="em0 em1"
1336 ifconfig_fec0="DHCP"
1338 .It Va gif_interfaces
1342 tunnel interfaces to configure on this host.
1344 .Va gifconfig_ Ns Aq Ar interface
1345 variable is assumed to exist for each value of
1347 The value of this variable is used to configure the link layer of the
1348 tunnel according to the syntax of the
1352 Additionally, this option ensures that each listed interface is created
1357 before attempting to configure it.
1358 .It Va sppp_interfaces
1362 interfaces to configure on this host.
1364 .Va spppconfig_ Ns Aq Ar interface
1365 variable is assumed to exist for each value of
1367 Each interface should also be configured by a general
1368 .Va ifconfig_ Ns Aq Ar interface
1372 for more information about available options.
1382 The name of the profile to use from
1383 .Pa /etc/ppp/ppp.conf .
1384 Also used for per-profile overrides of
1389 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1390 When the profile name contains any of the characters
1392 they are translated to
1394 for the proposes of the override variable names.
1397 Mode in which to run the
1400 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1402 Overrides the global
1412 See the manual for a full description.
1417 enables network address translation.
1418 Used in conjunction with
1420 allows hosts on private network addresses access to the Internet using
1421 this host as a network address translating router.
1422 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1424 Overrides the global
1428 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1430 Set the unit number to be used for this profile.
1431 See the manual description of
1436 The name of the user under which
1444 .It Va rc_conf_files
1446 This option is used to specify a list of files that will override
1448 .Pa /etc/defaults/rc.conf .
1449 The files will be read in the order in which they are specified and should
1450 include the full path to the file.
1451 By default, the files specified are
1454 .Pa /etc/rc.conf.local
1460 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1462 .It Va gbde_autoattach_all
1467 will attempt to automatically initialize your .bde devices in
1471 List the devices that the script should try to attach,
1476 The directory where the
1478 lockfiles are located.
1479 The default lockfile directory is
1482 The lockfile for each individual
1484 device can be overridden by setting the variable
1485 .Va gbde_lock_ Ns Aq Ar device ,
1488 is the encrypted device without the
1493 .It Va gbde_attach_attempts
1495 Number of times to attempt attaching to a
1497 device, i.e., how many times the user is asked for the pass-phrase.
1501 List of devices to automatically attach on boot.
1502 Note that .eli devices from
1504 are automatically appended to this list.
1507 Number of times user is asked for the pass-phrase.
1508 If empty, it will be taken from
1509 .Va kern.geom.eli.tries
1511 .It Va geli_default_flags
1513 Default flags to use by
1515 when configuring disk encryption.
1516 Flags can be configured for every device separately by defining
1517 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1519 .It Va geli_autodetach
1521 Specifies if GELI devices should be marked for detach on last close after
1522 file systems are mounted.
1525 This can be changed for every device separately by defining
1526 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1528 .It Va geli_swap_flags
1529 Options passed to the
1531 utility when encrypted GEOM providers for swap partitions are created.
1533 .Dq Li "-e aes -l 256 -s 4096 -d" .
1534 .It Va root_rw_mount
1539 After the file systems are checked at boot time, the root file system
1540 is remounted as read-write if this is set to
1542 Diskless systems that mount their root file system from a read-only remote
1543 NFS share should set this to
1547 .It Va fsck_y_enable
1552 will be run with the
1554 flag if the initial preen
1555 of the file systems fails.
1556 .It Va background_fsck
1560 the system will attempt to run
1562 in the background where possible.
1563 .It Va background_fsck_delay
1565 The amount of time in seconds to sleep before starting a background
1567 It defaults to sixty seconds to allow large applications such as
1568 the X server to start before disk I/O bandwidth is monopolized by
1570 If set to a negative number, the background file system check will be
1571 delayed indefinitely to allow the administrator to run it at a more
1573 For example it may be run from
1575 by adding a line like
1577 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1583 List of file system types that are network-based.
1584 This list should generally not be modified by end users.
1586 .Va extra_netfs_types
1588 .It Va extra_netfs_types
1590 If set to something other than
1593 this variable extends the list of file system types
1594 for which automatic mounting at startup by
1596 should be delayed until the network is initialized.
1598 a whitespace-separated list of network file system descriptor pairs,
1599 each consisting of a file system type as passed to
1601 and a human-readable, one-word description,
1604 Extending the default list in this way is only necessary
1605 when third party file system types are used.
1606 .It Va syslogd_enable
1613 .It Va syslogd_program
1618 .Pa /usr/sbin/syslogd ) .
1619 .It Va syslogd_flags
1625 these are the flags to pass to
1634 .It Va inetd_program
1639 .Pa /usr/sbin/inetd ) .
1646 these are the flags to pass to
1655 .It Va hastd_program
1667 these are the flags to pass to
1676 .It Va named_program
1681 .Pa /usr/sbin/named ) .
1686 configuration file, (default
1687 .Pa /etc/namedb/named.conf ) .
1694 these are the flags to pass to
1696 .It Va named_pidfile
1698 This is the default path to the
1701 This must match the location in
1707 process should be run as.
1708 .It Va named_chrootdir
1710 The root directory for a name server run in a
1712 environment (default
1716 will not be run in a
1719 .It Va named_chroot_autoupdate
1723 to disable automatic update of the
1726 .It Va named_symlink_enable
1730 to disable symlinking of
1739 loop until working name service is established.
1740 .It Va named_wait_host
1742 Name of host to lookup for the named_wait option.
1744 .It Va named_auto_forward
1746 Set to enable automatic creation of a forwarder
1747 configuration file derived from
1748 .Pa /etc/resolv.conf .
1749 .It Va named_auto_forward_only
1751 Set to change the default forwarder configuration from
1755 .It Va kerberos5_server_enable
1759 to start a Kerberos 5 authentication server
1761 .It Va kerberos5_server
1764 .Va kerberos5_server_enable
1767 this is the path to Kerberos 5 Authentication Server.
1768 .It Va kerberos5_server_flags
1771 This variable contains additional flags to be passed to the Kerberos 5
1772 authentication server.
1773 .It Va kadmind5_server_enable
1779 the Kerberos 5 Administration Daemon; set to
1782 .It Va kadmind5_server
1785 .Va kadmind5_server_enable
1788 this is the path to Kerberos 5 Administration Daemon.
1789 .It Va kpasswdd_server_enable
1795 the Kerberos 5 Password-Changing Daemon; set to
1798 .It Va kpasswdd_server
1801 .Va kpasswdd_server_enable
1804 this is the path to Kerberos 5 Password-Changing Daemon.
1811 daemon at boot time.
1818 these are the flags to pass to it.
1825 daemon at boot time.
1832 these are the flags to pass to it.
1835 manpage for more information.
1836 .It Va amd_map_program
1839 the specified program is run to get the list of
1844 maps are stored in NIS, one can set this to
1857 will be updated at boot time to reflect the kernel release
1862 will not be updated.
1863 .It Va nfs_client_enable
1867 run the NFS client daemons at boot time.
1868 .It Va nfs_access_cache
1871 .Va nfs_client_enable
1876 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1878 results should be cached.
1879 A value of 2-10 seconds will substantially reduce network
1880 traffic for many NFS operations.
1881 .It Va nfs_server_enable
1885 run the NFS server daemons at boot time.
1886 .It Va nfs_server_flags
1889 .Va nfs_server_enable
1892 these are the flags to pass to the
1895 .It Va idmapd_enable
1899 run the ID mapping daemon for NFS version 4.
1906 these are the flags to pass to the
1909 .It Va mountd_enable
1914 .Va nfs_server_enable
1920 It is commonly needed to run CFS without real NFS used.
1927 these are the flags to pass to the
1930 .It Va weak_mountd_authentication
1934 allow services like PCNFSD to make non-privileged mount
1936 .It Va nfs_reserved_port_only
1940 provide NFS services only on a secure port.
1941 .It Va nfs_bufpackets
1943 If set to a number, indicates the number of packets worth of
1944 socket buffer space to reserve on an NFS client.
1945 The kernel default is typically 4.
1946 Using a higher number may be
1947 useful on gigabit networks to improve performance.
1948 The minimum value is
1949 2 and the maximum is 64.
1950 .It Va rpc_lockd_enable
1954 and also an NFS server or client, run
1957 .It Va rpc_lockd_flags
1960 .Va rpc_lockd_enable
1963 these are the flags to pass to the
1966 .It Va rpc_statd_enable
1970 and also an NFS server or client, run
1973 .It Va rpc_statd_flags
1976 .Va rpc_statd_enable
1979 these are the flags to pass to the
1982 .It Va rpcbind_program
1987 .Pa /usr/sbin/rpcbind ) .
1988 .It Va rpcbind_enable
1994 service at boot time.
1995 .It Va rpcbind_flags
2001 these are the flags to pass to the
2004 .It Va keyserv_enable
2010 daemon on boot for running Secure RPC.
2011 .It Va keyserv_flags
2017 these are the flags to pass to
2020 .It Va pppoed_enable
2026 daemon at boot time to provide PPP over Ethernet services.
2027 .It Va pppoed_ Ns Aq Ar provider
2030 listens to requests to this
2036 argument of the same name.
2039 Additional flags to pass to
2041 .It Va pppoed_interface
2043 The network interface to run
2046 This is mandatory when
2056 service at boot time.
2057 This command is intended for networks of
2058 machines where a consistent
2060 for all hosts must be established.
2061 This is often useful in large NFS
2062 environments where time stamps on files are expected to be consistent
2070 these are the flags to pass to the
2073 .It Va ntpdate_enable
2080 This command is intended to
2081 synchronize the system clock only
2083 from some standard reference.
2084 An option to set this up initially
2085 (from a list of known servers) is also provided by the
2087 program when the system is first installed.
2088 .It Va ntpdate_config
2090 Configuration file for
2094 .It Va ntpdate_hosts
2096 A whitespace-separated list of NTP servers to synchronize with at startup.
2097 The default is to use the servers listed in
2098 .Va ntpdate_config ,
2099 if that file exists.
2100 .It Va ntpdate_program
2105 .Pa /usr/sbin/ntpdate ) .
2106 .It Va ntpdate_flags
2112 these are the flags to pass to the
2114 command (typically a hostname).
2121 command at boot time.
2127 .Pa /usr/sbin/ntpd ) .
2141 these are the flags to pass to the
2144 .It Va ntpd_sync_on_start
2151 flag, which syncs the system's clock on startup.
2154 for more information regarding the
2157 This is a preferred alternative to using
2162 .It Va nis_client_enable
2168 service at system boot time.
2169 .It Va nis_client_flags
2172 .Va nis_client_enable
2175 these are the flags to pass to the
2178 .It Va nis_ypset_enable
2184 daemon at system boot time.
2185 .It Va nis_ypset_flags
2188 .Va nis_ypset_enable
2191 these are the flags to pass to the
2194 .It Va nis_server_enable
2200 daemon at system boot time.
2201 .It Va nis_server_flags
2204 .Va nis_server_enable
2207 these are the flags to pass to the
2210 .It Va nis_ypxfrd_enable
2216 daemon at system boot time.
2217 .It Va nis_ypxfrd_flags
2220 .Va nis_ypxfrd_enable
2223 these are the flags to pass to the
2226 .It Va nis_yppasswdd_enable
2232 daemon at system boot time.
2233 .It Va nis_yppasswdd_flags
2236 .Va nis_yppasswdd_enable
2239 these are the flags to pass to the
2242 .It Va rpc_ypupdated_enable
2248 daemon at system boot time.
2249 .It Va bsnmpd_enable
2255 daemon at system boot time.
2256 Be sure to understand the security implications of running SNMP daemon
2264 these are the flags to pass to the
2267 .It Va defaultrouter
2271 create a default route to this host name or IP address
2272 (use an IP address if this router is also required to get to the
2274 .It Va ipv6_defaultrouter
2276 The IPv6 equivalent of
2278 .It Va static_arp_pairs
2280 Set to the list of static ARP pairs that are to be added at system
2282 For each whitespace separated
2285 .Va static_arp_ Ns Aq Ar element
2286 variable is assumed to exist whose contents will later be passed to a
2291 static_arp_pairs="gw"
2292 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2294 .It Va static_routes
2296 Set to the list of static routes that are to be added at system
2300 then for each whitespace separated
2303 .Va route_ Ns Aq Ar element
2304 variable is assumed to exist
2305 whose contents will later be passed to a
2310 static_routes="mcast gif0local"
2311 route_mcast="-net 224.0.0.0/4 -iface gif0"
2312 route_gif0local="-host 169.254.1.1 -iface lo0"
2314 .It Va ipv6_static_routes
2316 The IPv6 equivalent of
2320 then for each whitespace separated
2323 .Va ipv6_route_ Ns Aq Ar element
2324 variable is assumed to exist
2325 whose contents will later be passed to a
2326 .Dq Nm route Cm add Fl inet6
2328 .It Va natm_static_routes
2334 If not empty then for each whitespace separated
2337 .Va route_ Ns Aq Ar element
2338 variable is assumed to exist whose contents will later be passed to a
2339 .Dq Nm atmconfig Cm natm Cm add
2341 .It Va gateway_enable
2345 configure host to act as an IP router, e.g.\& to forward packets
2347 .It Va ipv6_gateway_enable
2349 The IPv6 equivalent of
2350 .Va gateway_enable .
2351 .It Va router_enable
2355 run a routing daemon of some sort, based on the
2360 .It Va ipv6_router_enable
2362 The IPv6 equivalent of
2366 run a routing daemon of some sort, based on the
2370 .Va ipv6_router_flags .
2377 this is the name of the routing daemon to use.
2380 The IPv6 equivalent of
2388 these are the flags to pass to the routing daemon.
2389 .It Va ipv6_router_flags
2391 The IPv6 equivalent of
2393 .It Va mrouted_enable
2397 run the multicast routing daemon,
2399 .It Va mroute6d_enable
2401 The IPv6 equivalent of
2402 .Va mrouted_enable .
2405 run the IPv6 multicast routing daemon.
2407 Note that multicast routing daemons are no longer included in the
2409 base system, however, both
2413 may be installed from the
2416 .It Va mrouted_flags
2422 these are the flags to pass to the
2425 .It Va mroute6d_flags
2427 The IPv6 equivalent of
2433 these are the flags passed to the IPv6 multicast routing daemon.
2434 .It Va mroute6d_program
2440 this is the path to the IPv6 multicast routing daemon.
2441 .It Va rtadvd_enable
2447 daemon at boot time.
2450 .Va ipv6_gateway_enable
2455 utility sends router advertisement packets to the interfaces specified in
2456 .Va rtadvd_interfaces
2457 and should only be enabled with great care.
2458 You may want to fine-tune
2460 .It Va rtadvd_interfaces
2466 this is the list of interfaces to use.
2467 .It Va ipxgateway_enable
2471 enable the routing of IPX traffic.
2472 .It Va ipxrouted_enable
2478 daemon at system boot time.
2479 .It Va ipxrouted_flags
2482 .Va ipxrouted_enable
2485 these are the flags to pass to the
2492 enable global proxy ARP.
2493 .It Va forward_sourceroute
2501 source-routed packets are forwarded.
2502 .It Va accept_sourceroute
2506 the system will accept source-routed packets directed at it.
2513 daemon at system boot time.
2520 these are the flags to pass to the
2523 .It Va bootparamd_enable
2529 daemon at system boot time.
2530 .It Va bootparamd_flags
2533 .Va bootparamd_enable
2536 these are the flags to pass to the
2539 .It Va stf_interface_ipv4addr
2543 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2545 Specify this entry to enable the 6to4 interface.
2546 .It Va stf_interface_ipv4plen
2548 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2549 An effective value is 0-31.
2550 .It Va stf_interface_ipv6_ifid
2552 IPv6 interface ID for
2556 .It Va stf_interface_ipv6_slaid
2558 IPv6 Site Level Aggregator for
2560 .It Va ipv6_faith_prefix
2564 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2569 .It Va ipv6_ipv4mapping
2573 this enables IPv4 mapped IPv6 address communication (like
2574 .Li ::ffff:a.b.c.d ) .
2579 to enable the configuration of ATM interfaces at system boot time.
2580 For all of the ATM variables described below, please refer to the
2582 manual page for further details on the available command parameters.
2583 Also refer to the files in
2584 .Pa /usr/share/examples/atm
2585 for more detailed configuration information.
2588 This is a list of physical ATM interface drivers to load.
2593 .It Va atm_netif_ Ns Aq Ar intf
2595 For the ATM physical interface
2597 this variable defines the name prefix and count for the ATM network
2598 interfaces to be created.
2599 The value will be passed as the parameters of an
2600 .Dq Nm atm Cm "set netif" Ar intf
2602 .It Va atm_sigmgr_ Ns Aq Ar intf
2604 For the ATM physical interface
2606 this variable defines the ATM signalling manager to be used.
2607 The value will be passed as the parameters of an
2608 .Dq Nm atm Cm attach Ar intf
2610 .It Va atm_prefix_ Ns Aq Ar intf
2612 For the ATM physical interface
2614 this variable defines the NSAP prefix for interfaces using a UNI signalling
2618 the prefix will automatically be set via the
2621 Otherwise, the value will be passed as the parameters of an
2622 .Dq Nm atm Cm "set prefix" Ar intf
2624 .It Va atm_macaddr_ Ns Aq Ar intf
2626 For the ATM physical interface
2628 this variable defines the MAC address for interfaces using a UNI signalling
2632 the hardware MAC address contained in the ATM interface card will be used.
2633 Otherwise, the value will be passed as the parameters of an
2634 .Dq Nm atm Cm "set mac" Ar intf
2636 .It Va atm_arpserver_ Ns Aq Ar netif
2638 For the ATM network interface
2640 this variable defines the ATM address for a host which is to provide ATMARP
2642 This variable is only applicable to interfaces using a UNI signalling
2646 this host will become an ATMARP server.
2647 The value will be passed as the parameters of an
2648 .Dq Nm atm Cm "set arpserver" Ar netif
2650 .It Va atm_scsparp_ Ns Aq Ar netif
2654 SCSP/ATMARP service for the network interface
2656 will be initiated using the
2661 This variable is only applicable if
2662 .Va atm_arpserver_ Ns Aq Ar netif
2667 Set to the list of ATM PVCs to be added at system
2669 For each whitespace separated
2672 .Va atm_pvc_ Ns Aq Ar element
2673 variable is assumed to exist.
2674 The value of each of these variables
2675 will be passed as the parameters of an
2676 .Dq Nm atm Cm "add pvc"
2680 Set to the list of permanent ATM ARP entries to be added
2681 at system boot time.
2682 For each whitespace separated
2685 .Va atm_arp_ Ns Aq Ar element
2686 variable is assumed to exist.
2687 The value of each of these variables
2688 will be passed as the parameters of an
2689 .Dq Nm atm Cm "add arp"
2691 .It Va natm_interfaces
2695 interfaces that will also be used for HARP through
2697 If this list is not empty all interfaces in the list will be brought up
2703 For this to work the interface drivers must be either compiled into the
2704 kernel or must reside on the root partition.
2707 The keyboard bell sound.
2714 if the default behavior is desired.
2715 For details, refer to the
2720 If set to a non-null string, the virtual console's keyboard input is
2726 no keymap is installed, otherwise the value is used to install
2728 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2731 The keyboard repeat speed.
2738 if the default behavior is desired.
2743 attempt to program the function keys with the value.
2745 be a single string of the form:
2746 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2749 Can be set to the value of
2752 .Dq Li destructive ,
2755 to set the cursor behavior explicitly or choose the default behavior.
2760 no screen map is installed, otherwise the value is used to install
2761 the screen map file in
2762 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2767 the default 8x16 font value is used for screen size requests, otherwise
2769 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2775 the default 8x14 font value is used for screen size requests, otherwise
2777 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2783 the default 8x8 font value is used for screen size requests, otherwise
2785 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2791 the default screen blanking interval is used, otherwise it is set
2799 this is the actual screen saver to use
2800 .Li ( blank , snake , daemon ,
2802 .It Va moused_nondefault_enable
2806 the mouse device specified on
2807 the command line is not automatically treated as enabled by the
2808 .Pa /etc/rc.d/moused
2810 Having this variable set to
2816 to be enabled as soon as it is plugged in.
2817 .It Va moused_enable
2823 daemon is started for doing cut/paste selection on the console.
2826 This is the protocol type of the mouse connected to this host.
2827 This variable must be set if
2834 is able to detect the appropriate mouse type automatically in many cases.
2835 Set this variable to
2837 to let the daemon detect it, or
2838 select one from the following list if the automatic detection fails.
2840 If the mouse is attached to the PS/2 mouse port, choose
2844 regardless of the brand and model of the mouse.
2846 mouse is attached to the bus mouse port, choose
2850 All other protocols are for serial mice and will not work with
2851 the PS/2 and bus mice.
2852 If this is a USB mouse,
2854 is the only protocol type which will work.
2856 .Bl -tag -width ".Li x10mouseremote" -compact
2858 Microsoft mouse (serial)
2860 Microsoft IntelliMouse (serial)
2862 Mouse systems Corp.\& mouse (serial)
2864 MM Series mouse (serial)
2866 Logitech mouse (serial)
2870 Logitech MouseMan and TrackMan (serial)
2872 ALPS GlidePoint (serial)
2873 .It Li thinkingmouse
2874 Kensington ThinkingMouse (serial)
2878 MM HitTablet (serial)
2879 .It Li x10mouseremote
2880 X10 MouseRemote (serial)
2882 Interlink VersaPad (serial)
2885 Even if the mouse is not in the above list, it may be compatible
2886 with one in the list.
2887 Refer to the manual page for
2889 for compatibility information.
2891 It should also be noted that while this is enabled, any
2892 other client of the mouse (such as an X server) should access
2893 the mouse through the virtual mouse device,
2895 and configure it as a
2897 type mouse, since all
2898 mouse data is converted to this single canonical format when
2901 If the client program does not support the
2907 It is the second preferred type.
2914 this is the actual port the mouse is on.
2917 for a COM1 serial mouse,
2921 for a bus mouse, for example.
2926 is set, its value is used as an additional set of flags to pass to the
2929 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
2931 .Va moused_nondefault_enable
2934 daemon is started for a non-default port, the
2935 .Va "moused_" Ns Ar XXX Ns Va "_flags"
2936 set of options has precedence over and replaces the default
2937 .Va moused_flags (where
2939 is the name of the non-default port, i.e.\&
2942 .Va "moused_" Ns Ar XXX Ns Va "_flags"
2943 it is possible to set up a different set of default flags for each
2946 For example, you can use
2950 to make your laptop's touchpad more comfortable to use,
2951 but an empty set of options for
2952 .Va moused_ums0_flags
2955 mouse has three or more buttons.
2956 .It Va mousechar_start
2960 the default mouse cursor character range
2961 .Li 0xd0 Ns - Ns Li 0xd3
2963 otherwise the range start is set
2968 Use if the default range is occupied in the language code table.
2969 .It Va allscreens_flags
2973 is run with these options for each of the virtual terminals
2977 will enable the mouse pointer on all virtual terminals
2982 .It Va allscreens_kbdflags
2986 is run with these options for each of the virtual terminals
2992 scrollback (history) buffer to 200 lines.
2999 daemon at system boot time.
3005 .Pa /usr/sbin/cron ) .
3012 these are the flags to pass to
3018 enable the special handling of transitions to and from the
3019 Daylight Saving Time in
3021 (equivalent to using the flag
3028 .Pa /usr/sbin/lpd ) .
3035 daemon at system boot time.
3042 these are the flags to pass to the
3045 .It Va chkprintcap_enable
3051 command before starting the
3054 .It Va chkprintcap_flags
3059 .Va chkprintcap_enable
3062 these are the flags to pass to the
3067 which causes missing directories to be created.
3068 .It Va mta_start_script
3070 This variable specifies the full path to the script to run to start
3071 a mail transfer agent.
3073 .Pa /etc/rc.sendmail .
3077 .Pa /etc/rc.sendmail
3078 uses are documented in the
3083 Indicates the device (usually a swap partition) to which a crash dump
3084 should be written in the event of a system crash.
3085 If the value of this variable is
3087 the first suitable swap device listed in
3089 will be used as dump device.
3090 Otherwise, the value of this variable is passed as the argument to
3092 To disable crash dumps, set this variable to
3096 When the system reboots after a crash and a crash dump is found on the
3097 device specified by the
3101 will save that crash dump and a copy of the kernel to the directory
3105 The default value is
3114 .It Va savecore_flags
3116 If crash dumps are enabled, these are the flags to pass to the
3123 to turn on user and group disk quotas on system startup via the
3125 command for all file systems marked as having quotas enabled in
3127 The kernel must be built with
3129 for disk quotas to function.
3134 to enable user and group disk quota checking via the
3137 .It Va quotacheck_flags
3147 these are the flags to pass to the
3152 which checks quotas for all file systems with quotas enabled in
3154 .It Va quotaon_flags
3160 these are the flags to pass to the
3165 which enables quotas for all file systems with quotas enabled in
3167 .It Va quotaoff_flags
3173 these are the flags to pass to the
3175 utility when shutting down the quota system.
3178 which disables quotas for all file systems with quotas enabled in
3180 .It Va accounting_enable
3184 to enable system accounting through the
3191 to enable iBCS2 (SCO) binary emulation at system initial boot
3193 .It Va ibcs2_loaders
3201 this specifies a list of additional iBCS2 loaders to enable.
3206 to enable Linux/ELF binary emulation at system initial
3212 enable SysVR4 emulation at boot time.
3213 .It Va sysvipc_enable
3217 load System V IPC primitives at boot time.
3218 .It Va clear_tmp_enable
3229 to disable removing of X11 lock files,
3230 and the removal and (secure) recreation
3231 of the various socket directories for X11
3233 .It Va ldconfig_paths
3235 Set to the list of shared library paths to use with
3239 will always be added first, so it need not appear in this list.
3240 .It Va ldconfig32_paths
3242 Set to the list of 32-bit compatibility shared library paths to
3245 .It Va ldconfig_paths_aout
3247 Set to the list of shared library paths to use with
3252 .It Va ldconfig_insecure
3256 utility normally refuses to use directories
3257 which are writable by anyone except root.
3258 Set this variable to
3260 to disable that security check during system startup.
3261 .It Va ldconfig_local_dirs
3263 Set to the list of local
3266 The names of all files in the directories listed will be
3267 passed as arguments to
3269 .It Va ldconfig_local32_dirs
3271 Set to the list of local 32-bit compatibility
3274 The names of all files in the directories listed will be
3275 passed as arguments to
3276 .Dq Nm ldconfig Fl 32 .
3277 .It Va kern_securelevel_enable
3281 to set the kernel security level at system startup.
3282 .It Va kern_securelevel
3284 The kernel security level to set at startup.
3285 The allowed range of
3287 ranges from \-1 (the compile time default) to 3 (the
3291 for the list of possible security levels and their effect
3292 on system operation.
3295 Path to the SSH server program
3296 .Pa ( /usr/sbin/sshd
3304 at system boot time.
3311 these are the flags to pass to the
3316 Path to the FTP server program
3317 .Pa ( /usr/libexec/ftpd
3325 as a stand-alone daemon at system boot time.
3332 these are the additional flags to pass to the
3335 .It Va watchdogd_enable
3341 daemon at boot time.
3342 This requires that the kernel have been compiled with a
3345 .It Va watchdogd_flags
3348 .Va watchdogd_enable
3351 these are the flags passed to the
3354 .It Va performance_cx_lowest
3356 CPU idle state to use while on AC power.
3361 should use the lowest power state available while
3363 indicates that the lowest latency state (less power savings) should be used.
3364 .It Va performance_cpu_freq
3366 CPU clock frequency to use while on AC power.
3371 should use the lowest frequency available while
3373 indicates that the highest frequency (less power savings) should be used.
3374 .It Va economy_cx_lowest
3376 CPU idle state to use when off AC power.
3381 should use the lowest power state available while
3383 indicates that the lowest latency state (less power savings) should be used.
3384 .It Va economy_cpu_freq
3386 CPU clock frequency to use when off AC power.
3391 should use the lowest frequency available while
3393 indicates that the highest frequency (less power savings) should be used.
3398 any configured jails will not be started.
3401 A space separated list of names for jails.
3402 This is purely a configuration aid to help identify and
3403 configure multiple jails.
3404 The names specified in this list will be used to
3405 identify settings common to an instance of a jail.
3406 Assuming that the jail in question was named
3408 you would have the following dependent variables:
3410 jail_vjail_hostname="jail.example.com"
3411 jail_vjail_ip="192.0.2.100"
3412 jail_vjail_rootdir="/var/jails/vjail/root"
3418 When set, use as default value for
3419 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3422 .It Va jail_interface
3425 When set, use as default value for
3426 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3432 When set, use as default value for
3433 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3436 .It Va jail_mount_enable
3444 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3447 by default for every jail in
3449 .It Va jail_devfs_ruleset
3453 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3454 to given value for every jail in
3456 .It Va jail_devfs_enable
3464 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3467 by default for every jail in
3469 .It Va jail_fdescfs_enable
3477 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3480 by default for every jail in
3482 .It Va jail_procfs_enable
3490 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3493 by default for every jail in
3495 .It Va jail_exec_prestart Ns Aq Ar N
3498 When set, use as default value for
3499 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3502 .It Va jail_exec_start
3505 When set, use as default value for
3506 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3509 .It Va jail_exec_afterstart Ns Aq Ar N
3512 When set, use as default value for
3513 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3516 .It Va jail_exec_poststart Ns Aq Ar N
3519 When set, use as default value for
3520 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3523 .It Va jail_exec_prestop Ns Aq Ar N
3526 When set, use as default value for
3527 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3530 .It Va jail_exec_stop
3532 When set, use as default value for
3533 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3536 .It Va jail_exec_poststop Ns Aq Ar N
3539 When set, use as default value for
3540 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3543 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3546 Set to the root directory used by jail
3548 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3551 Set to the fully qualified domain name (FQDN) assigned to jail
3553 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3556 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3557 The argument can be a sole address or a comma separated list of addresses.
3558 Additionally each address can be prefixed by the name of an interface
3559 followed by a pipe to overwrite
3560 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3563 and/or suffixed by a netmask, prefixlen or prefix.
3564 In case no netmask, prefixlen or prefix is given,
3566 will be used for IPv4 and
3568 will be used for an IPv6 address.
3569 If no address is given for the jail then the jail will be started with
3570 no networking support.
3571 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3574 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3575 The sequence starts with
3577 and the numbers have to be strictly ascending.
3578 These entries follow the same syntax as their primary
3579 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3581 The order of the entries can be important as the first address for
3582 each address family found will be the primary address of the jail.
3588 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3593 These are flags to pass to
3595 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3598 When set, sets the interface to use when setting IP address alias.
3599 Note that the alias is created at jail startup and removed at jail shutdown.
3600 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3603 When set, the jail is started with the specified forwarding table (sometimes
3604 referred to as a routing table) via
3606 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3609 .Pa /etc/fstab. Ns Aq Ar jname
3611 This is the file system information file to use for jail
3613 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3620 mount all file systems from
3621 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3623 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3626 When set, defines the device file system ruleset file to use for jail
3628 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3635 mount the device file system inside jail
3638 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3645 mount the file-descriptor file system inside jail
3648 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3655 mount the process file system inside jail
3658 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3661 This is the command run as
3664 before jail startup, where
3667 It is run outside the jail.
3668 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3671 .Dq Li /bin/sh /etc/rc
3673 This is the command executed in a jail at jail startup.
3674 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3677 This is the command run as
3681 after jail startup, where
3684 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3687 This is the command run as
3690 after jail startup, where
3693 It is run outside the jail.
3694 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3697 This is the command run as
3700 before jail shutdown, where
3703 It is run outside the jail.
3704 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3707 .Dq Li /bin/sh /etc/rc.shutdown
3709 This is the command executed in a jail at jail shutdown.
3710 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3713 This is the command run as
3716 after jail shutdown, where
3719 It is run outside the jail.
3720 .It Va jail_set_hostname_allow
3724 do not allow the root user in a jail to set its hostname.
3725 .It Va jail_socket_unixiproute_only
3729 do not allow any sockets,
3730 besides UNIX/IP/route sockets,
3731 to be used within a jail.
3732 .It Va jail_sysvipc_allow
3736 allow applications within a jail to use System V IPC.
3737 .\" -----------------------------------------------------
3738 .It Va harvest_interrupt
3742 to use hardware interrupts as an entropy source.
3745 for more information.
3746 .It Va harvest_ethernet
3750 to use LAN traffic as an entropy source.
3753 for more information.
3754 .It Va harvest_p_to_p
3758 to use serial line traffic as an entropy source.
3761 for more information.
3766 to disable caching entropy via
3768 Otherwise set to the directory used to store entropy files in.
3773 to disable caching entropy through reboots.
3774 Otherwise set to the filename used to store cached entropy through
3776 This file should be located on the root file system to seed the
3778 device as early as possible in the boot process.
3779 .It Va entropy_save_sz
3781 Size of the entropy cache files saved by
3784 .It Va entropy_save_num
3786 Number of entropy cache files to save by
3800 Configuration file for
3809 .Pa /var/run/dmesg.boot
3811 .It Va rcshutdown_timeout
3813 If set, start a watchdog timer in the background which will terminate
3817 has not completed within the specified time (in seconds).
3818 Notice that in addition to this soft timeout,
3820 also applies a hard timeout for the execution of
3822 This is configured via
3825 .Va kern.init_shutdown_timeout
3826 and defaults to 120 seconds.
3827 Setting the value of
3828 .Va rcshutdown_timeout
3829 to more than 120 seconds will have no effect until the
3832 .Va kern.init_shutdown_timeout
3834 .It Va virecover_enable
3838 to prevent the system from trying to
3839 recover pre-maturely terminated
3842 .It Va ugidfw_enable
3847 .Xr mac_bsdextended 4
3848 module upon system initialization and load a default
3850 .It Va bsdextended_script
3853 .Xr mac_bsdextended 4
3854 ruleset file to load.
3855 The default value of this variable is
3856 .Pa /etc/rc.bsdextended .
3857 .It Va newsyslog_enable
3864 .It Va newsyslog_flags
3867 .Va newsyslog_enable
3870 these are the flags to pass to the
3875 which causes log files flagged with a
3878 .It Va mdconfig_md Ns Aq Ar X
3888 must be specified and either a
3890 for malloc or swap backed
3898 .Va mdconfig_md Ns Aq Ar X
3899 variables are evaluated until one variable is unset or null.
3900 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
3902 Optional arguments passed to
3908 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
3910 An ownership specification passed to
3919 device and the mount point will be changed.
3920 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
3922 A mode string passed to
3931 device and the mount point will be changed.
3932 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
3934 Files to be copied to the mount point of the
3938 after it has been mounted.
3939 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
3941 Command to execute after the specified
3946 Note that the command is passed to
3952 variables can be used to reference respectively the
3954 device and the mount point.
3959 one could set the following:
3961 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
3963 .It Va ramdisk_units
3965 A list of one or more ramdisk units to configure with
3969 in time to be mounted from
3973 must specify at least a
3976 .Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
3978 Note that this way to configure ramdisks has been deprecated
3981 variables (see above).
3982 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
3990 must be specified, where
3996 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs
3998 Optional arguments passed to
4000 to initialize ramdisk
4002 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner
4004 An ownership specification passed to
4006 after the specified ramdisk unit
4011 device and the mount point will be changed.
4012 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms
4014 A mode string passed to
4016 after the specified ramdisk unit
4021 device and the mount point will be changed.
4022 .It Va autobridge_interfaces
4024 Set to the list of bridge interfaces that will have newly arriving interfaces
4025 checked against to be automatically added.
4028 then for each whitespace separated
4031 .Va autobridge_ Ns Aq Ar element
4032 variable is assumed to exist which has a whitespace separated list of interface
4033 names to match, these names can use wildcards.
4036 autobridge_interfaces="bridge0"
4037 autobridge_bridge0="tap* dc0 vlan[345]"
4043 enable support for sound mixer.
4044 .It Va hcsecd_enable
4048 enable Bluetooth security daemon.
4049 .It Va hcsecd_config
4051 Configuration file for
4054 .Pa /etc/bluetooth/hcsecd.conf .
4059 enable Bluetooth Service Discovery Protocol daemon.
4067 .It Va sdpd_groupname
4071 group to run as after it initializes.
4074 .It Va sdpd_username
4078 user to run as after it initializes.
4081 .It Va bthidd_enable
4085 enable Bluetooth Human Interface Device daemon.
4086 .It Va bthidd_config
4088 Configuration file for
4091 .Pa /etc/bluetooth/bthidd.conf .
4094 Path to a file, where
4096 will store information about known HID devices.
4098 .Pa /var/db/bthidd.hids .
4099 .It Va rfcomm_pppd_server_enable
4103 enable Bluetooth RFCOMM PPP wrapper daemon.
4104 .It Va rfcomm_pppd_server_profile
4106 The name of the profile to use from
4107 .Pa /etc/ppp/ppp.conf .
4108 Multiple profiles can be specified here.
4109 Also used to specify per-profile overrides.
4110 When the profile name contains any of the characters
4112 they are translated to
4114 for the proposes of the override variable names.
4115 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4117 Overrides local address to listen on.
4123 The address can be specified as BD_ADDR or name.
4124 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4126 Overrides local RFCOMM channel to listen on.
4129 will listen on RFCOMM channel 1.
4130 Must set properly if multiple profiles used in the same time.
4131 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4135 if it should register Serial Port service on the speficied RFCOMM channel.
4138 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4142 if it should register Dial-Up Networking service on the speficied
4146 .It Va ubthidhci_enable
4150 change the USB Bluetooth controller from HID mode to HCI mode.
4151 You also need to specify the location of USB Bluetooth controller with the
4152 .Va ubthidhci_busnum
4156 .It Va ubthidhci_busnum
4157 Bus number where the USB Bluetooth controller is located.
4160 on your system to find this information.
4161 .It Va ubthidhci_addr
4162 Bus address of the USB Bluetooth controller.
4165 on your system to find this information.
4168 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4169 .It Pa /etc/defaults/rc.conf
4171 .It Pa /etc/rc.conf.local
4201 .Xr newsyslog.conf 5 ,
4268 .An Jordan K. Hubbard .