4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the system installation utility,
46 is not to run commands or perform system startup actions
48 Instead, it is included by the
49 various generic startup scripts in
51 which conditionalize their
52 internal actions according to the settings found there.
56 file is included from the file
57 .Pa /etc/defaults/rc.conf ,
58 which specifies the default settings for all the available options.
59 Options need only be specified in
61 when the system administrator wishes to override these defaults.
63 .Pa /etc/rc.conf.local
64 is used to override settings in
66 for historical reasons.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
73 directory, which will be included by the
76 For jail configurations you could use the file
77 .Pa /etc/rc.conf.d/jail
78 to store jail specific configuration options.
84 .Dq Ar name Ns Li = Ns Ar value
88 The following list provides a name and short description for each
89 variable that can be set in the
92 .Bl -tag -width indent-two
97 enable output of debug messages from rc scripts.
98 This variable can be helpful in diagnosing mistakes when
99 editing or integrating new scripts.
100 Beware that this produces copious output to the terminal and
106 disable informational messages from the rc scripts.
107 Informational messages are displayed when
108 a condition that is not serious enough to warrant a warning or
116 when faststart is used (e.g., at boot time).
117 .It Va early_late_divider
119 The name of the script that should be used as the
120 delimiter between the
124 stages of the boot process.
125 The early stage should contain all the services needed to
126 get the disks (local or remote) mounted so that the late
127 stage can include scripts contained in the directories
130 variable (see below).
131 Thus, the two likely candidates for this value are
133 for the typical system, and
135 if the system needs remote file
136 systems mounted to get access to the
138 directories; for example when
146 is likely to be an appropriate value.
147 Extreme care should be taken when changing this value,
148 and before changing it one should ensure that there are
149 adequate provisions to recover from a failed boot
150 (such as physical contact with the machine,
151 or reliable remote console access).
152 .It Va always_force_depends
156 scripts use the force_depend function to check whether required
157 services are already running, and to start them if necessary.
158 By default during boot time this check is bypassed if the
159 required service is enabled in
160 .Pa /etc/rc.conf[.local] .
161 Setting this option will bypass that check at boot time and
162 always test whether or not the service is actually running.
163 Enabling this option is likely to increase your boot time if
164 services are enabled that utilize the force_depend check.
169 no swapfile is installed, otherwise the value is used as the full
170 pathname to a file to use for additional swap space.
171 .It Ao Ar name Ac Ns Va _chroot
174 to this directory before running the service.
175 .It Ao Ar name Ac Ns Va _user
177 Run the service under this user account.
178 .It Ao Ar name Ac Ns Va _group
180 Run the chrooted service under this system group. Unlike the _user
181 setting, this setting has no effect if the service is not chrooted.
182 .It Ao Ar name Ac Ns Va _fib
186 value to run the service under.
187 .It Ao Ar name Ac Ns Va _nice
191 value to run the service under.
196 enable support for Automatic Power Management with
204 to handle APM event from userland.
205 This also enables support for APM.
212 these are the flags to pass to the
219 to handle device added, removed or unknown events from the kernel.
226 scripts at boot time.
229 Configuration file for
235 A list of kernel modules to load right after the local
237 Loading modules at this point in the boot process is
238 much faster than doing it via
239 .Pa /boot/loader.conf
240 for those modules not necessary for mounting local disk.
241 .It Va kldxref_enable
248 to automatically rebuild
253 .It Va kldxref_clobber
263 will overwrite existing
270 .It Va kldxref_module_path
275 delimited list of paths containing
287 enable the system power control facility with the
296 these are the flags to pass to the
300 Controls the creation of a
303 Always happens if set to
305 and never happens if set to
307 If set to anything else, a memory file system is created if
311 Controls the size of a created
315 Extra options passed to the
317 utility when the memory file system for
322 which inhibits the use of softupdates on
324 so that file system space is freed without delay
325 after file truncation or deletion.
328 for other options you can use in
331 Controls the creation of a
334 Always happens if set to
336 and never happens if set to
338 If set to anything else, a memory file system is created if
342 Controls the size of a created
346 Extra options passed to the
348 utility when the memory file system for
353 which inhibits the use of softupdates on
355 so that file system space is freed without delay
356 after file truncation or deletion.
359 for other options you can use in
362 Controls the automatic population of the
365 Always happens if set to
367 and never happens if set to
369 If set to anything else, a memory file system is created if
372 Note that this process requires access to certain commands in
376 is mounted on normal systems.
377 .It Va cleanvar_enable
384 List of directories to search for startup script files.
385 .It Va script_name_sep
387 The field separator to use for breaking down the list of startup script files
388 into individual filenames.
389 The default is a space.
390 It is not necessary to change this unless there are startup scripts with names
392 .It Va hostapd_enable
401 The fully qualified domain name (FQDN) of this host on the network.
402 This should almost certainly be set to something meaningful, even if
403 there is no network connection.
406 is used to set the hostname via DHCP,
407 this variable should be set to an empty string.
408 If this value remains unset when the system is done booting
409 your console login will display the default hostname of
413 The NIS domain name of this host, or
416 .It Va dhclient_program
418 Path to the DHCP client program
419 .Pa ( /sbin/dhclient ,
424 .It Va dhclient_flags
426 Additional flags to pass to the DHCP client program.
431 manpage for a description of the command line options available.
432 .It Va dhclient_flags_ Ns Aq Ar iface
433 Additional flags to pass to the DHCP client program running on
436 When specified, this variable overrides
438 .It Va background_dhclient
442 to start the DHCP client in background.
443 This can cause trouble with applications depending on
444 a working network, but it will provide a faster startup
446 .It Va background_dhclient_ Ns Aq Ar iface
447 When specified, this variable overrides the
448 .Va background_dhclient
449 variable for interface
452 .It Va synchronous_dhclient
458 synchronously at startup.
459 This behavior can be overridden on a per-interface basis by replacing
463 .Va ifconfig_ Ns Aq Ar interface
468 .It Va defaultroute_delay
470 When set to a positive value, wait up to this long after configuring
471 DHCP interfaces at startup to give the interfaces time to receive a lease.
472 .It Va firewall_enable
476 to load firewall rules at startup.
477 If the kernel was not built with
478 .Cd "options IPFIREWALL" ,
481 kernel module will be loaded.
483 .Va ipfilter_enable .
484 .It Va firewall_script
486 This variable specifies the full path to the firewall script to run.
488 .Pa /etc/rc.firewall .
491 Names the firewall type from the selection in
492 .Pa /etc/rc.firewall ,
493 or the file which contains the local firewall ruleset.
494 Valid selections from
498 .Bl -tag -width ".Li simple" -compact
500 unrestricted IP access
502 all IP services disabled, except via
505 basic protection for a workstation
507 basic protection for a LAN.
510 If a filename is specified, the full path
512 .It Va firewall_quiet
516 to disable the display of firewall rules on the console during boot.
517 .It Va firewall_logging
521 to enable firewall event logging.
522 This is equivalent to the
523 .Dv IPFIREWALL_VERBOSE
525 .It Va firewall_logif
529 to create pseudo interface
532 For more details, see
535 .It Va firewall_flags
541 specifies a filename.
542 .It Va firewall_coscripts
544 List of executables and/or rc scripts to run after firewall starts/stops.
546 .\" ----- firewall_nat_enable setting --------------------------------
547 .It Va firewall_nat_enable
559 .It Va firewall_nat_interface
565 This is the name of the public interface or IP address on which
566 kernel NAT should run.
567 .It Va firewall_nat_flags
569 Additional configuration parameters for kernel NAT should be placed here.
570 .It Va dummynet_enable
574 will automatically load the
580 .\" -------------------------------------------------------------------
596 sockets must be enabled in the kernel.
597 If the kernel was not built with
598 .Cd "options IPDIVERT" ,
601 kernel module will be loaded.
602 .It Va natd_interface
604 This is the name of the public interface on which
607 The interface may be given as an interface name or as an IP address.
612 flags should be placed here.
617 flag is automatically added with the above
620 .\" ----- ipfilter_enable setting --------------------------------
621 .It Va ipfilter_enable
632 Typical usage will require putting
634 ipfilter_enable="YES"
652 can be enabled independently.
656 both require at least one of
666 options IPFILTER_DEFAULT_BLOCK
669 in the kernel configuration file is a good idea, too.
670 .\" ----- ipfilter_program setting ------------------------------
671 .It Va ipfilter_program
677 .\" ----- ipfilter_rules setting --------------------------------
678 .It Va ipfilter_rules
683 This variable contains the name of the filter rule definition file.
684 The file is expected to be readable for the
687 .\" ----- ipv6_ipfilter_rules setting ---------------------------
688 .It Va ipv6_ipfilter_rules
693 This variable contains the IPv6 filter rule definition file.
694 The file is expected to be readable for the
697 .\" ----- ipfilter_flags setting --------------------------------
698 .It Va ipfilter_flags
701 This variable contains flags passed to the
704 .\" ----- ipnat_enable setting ----------------------------------
714 network address translation.
717 for a detailed discussion.
718 .\" ----- ipnat_program setting ---------------------------------
725 .\" ----- ipnat_rules setting -----------------------------------
731 This variable contains the name of the file
732 holding the network address translation definition.
733 This file is expected to be readable for the
736 .\" ----- ipnat_flags setting -----------------------------------
740 This variable contains flags passed to the
743 .\" ----- ipmon_enable setting ----------------------------------
758 Setting this variable needs setting
765 for a detailed discussion.
766 .\" ----- ipmon_program setting ---------------------------------
773 .\" ----- ipmon_flags setting -----------------------------------
779 This variable contains flags passed to the
782 Another typical example would be
783 .Dq Fl D Pa /var/log/ipflog
786 log directly to a file bypassing
789 .Pa /etc/newsyslog.conf
790 in such case like this:
792 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
794 .\" ----- ipfs_enable setting -----------------------------------
804 saving the filter and NAT state tables during shutdown
805 and reloading them during startup again.
806 Setting this variable needs setting
815 for a detailed discussion.
821 because the raised securelevel will prevent
823 from saving the state tables at shutdown time.
824 .\" ----- ipfs_program setting ----------------------------------
831 .\" ----- ipfs_flags setting ------------------------------------
835 This variable contains flags passed to the
838 .\" ----- end of added ipf hook ---------------------------------
850 Typical usage will require putting
865 into the kernel, otherwise the
866 kernel module will be loaded.
871 ruleset configuration file
886 these flags are passed to the
888 program when loading the ruleset.
898 which logs packets from the
911 .Pa /var/log/pflog ) .
913 .Pa /etc/newsyslog.conf
914 to adjust logfile rotation for this.
924 This variable contains additional flags passed to the
927 .It Va ftpproxy_enable
938 packet filter in translating ftp connections.
939 .It Va ftpproxy_flags
942 This variable contains additional flags passed to the
954 state changes to other hosts over the network by means of
959 must also be set then.
960 .It Va pfsync_syncdev
963 This variable specifies the name of the network interface
965 should operate through.
966 It must be set accordingly if
970 .It Va pfsync_syncpeer
973 This variable is optional.
974 By default, state change messages are sent out on the synchronisation
975 interface using IP multicast packets.
976 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
978 When a peer address is specified using the
980 option, the peer address is used as a destination for the pfsync
981 traffic, and the traffic can then be protected using
985 manpage for more details about using
990 .It Va pfsync_ifconfig
993 This variable can contain additional options to be passed to the
995 command used to set up
997 .It Va tcp_extensions
1004 disables certain TCP options as described by
1010 might help remedy such problems with connections as randomly hanging
1011 or other weird behavior.
1012 Some network devices are known
1013 to be broken with respect to these options.
1016 Set to 0 by default.
1020 .Va net.inet.tcp.log_in_vain
1022 .Va net.inet.udp.log_in_vain ,
1027 are set to the given value.
1028 .It Va tcp_keepalive
1035 will disable probing idle TCP connections to verify that the
1036 peer is still up and reachable.
1037 .It Va tcp_drop_synfin
1044 will cause the kernel to ignore TCP frames that have both
1045 the SYN and FIN flags set.
1046 This prevents OS fingerprinting, but may
1047 break some legitimate applications.
1048 .It Va icmp_drop_redirect
1055 will cause the kernel to ignore ICMP REDIRECT packets.
1058 for more information.
1059 .It Va icmp_log_redirect
1066 will cause the kernel to log ICMP REDIRECT packets.
1068 the log messages are not rate-limited, so this option should only be used
1069 for troubleshooting networks.
1072 for more information.
1073 .It Va icmp_bmcastecho
1077 to respond to broadcast or multicast ICMP ping packets.
1080 for more information.
1081 .It Va ip_portrange_first
1085 this is the first port in the default portrange.
1088 for more information.
1089 .It Va ip_portrange_last
1093 this is the last port in the default portrange.
1096 for more information.
1097 .It Va network_interfaces
1099 Set to the list of network interfaces to configure on this host or
1101 (the default) for all current interfaces.
1103 .Va network_interfaces
1104 variable to anything other than the default is deprecated.
1105 Interfaces that the administrator wishes to store configuration for,
1106 but not start at boot should be configured with the
1109 .Va ifconfig_ Ns Aq Ar interface
1110 variables as described below.
1113 .Va ifconfig_ Ns Aq Ar interface
1114 variable is also assumed to exist for each value of
1116 When an interface name contains any of the characters
1118 they are translated to
1121 The variable can contain arguments to
1123 as well as special case-insensitive keywords described below.
1124 Such keywords are removed before passing the value to
1126 while the order of the other arguments is preserved.
1128 One can configure more than one IPv4 address with the
1129 .Va ipv4_addrs_ Ns Aq Ar interface
1131 One or more IP addresses must be provided in Classless Inter-Domain
1132 Routing (CIDR) address notation, whose last byte can be a range like
1134 In this case the address 192.0.2.5 will be configured with the
1135 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1136 the non-conflicting netmask /32 as explained in the
1139 With the interface in question being
1141 an example could look like:
1143 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1146 It is also possible to add IP alias entries using
1151 Assuming that the interface in question was
1154 something like this:
1156 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1157 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1162 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1165 keyword that is found,
1166 its contents are passed to
1168 Execution stops at the first unsuccessful access, so if
1169 something like this is present:
1171 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1172 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1173 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1174 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1177 Then note that alias4 would
1179 be added since the search would
1180 stop with the missing
1183 Due to this difficult to manage behavior, the
1184 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1188 .Pa /etc/start_if. Ns Aq Ar interface
1189 file is present, it is read and executed by the
1192 before configuring the interface as specified in the
1193 .Va ifconfig_ Ns Aq Ar interface
1195 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1199 .Va vlans_ Ns Aq Ar interface
1203 interface will be created for each item in the list with the
1207 If a vlan interface's name is a number,
1208 then that number is used as the vlan tag and the new vlan interface is
1210 .Ar interface . Ns Ar tag .
1212 the vlan tag must be specified via a
1215 .Va create_args_ Ns Aq Ar interface
1218 To create a vlan device named
1222 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1225 ifconfig_em0_101="inet 192.0.2.1/24"
1228 To create a vlan device named
1232 with the vlan tag 102:
1235 create_args_myvlan="vlan 102"
1239 .Va wlans_ Ns Aq Ar interface
1243 interface will be created for each item in the list with the
1247 Further wlan cloning arguments may be passed to the
1250 command by setting the
1251 .Va create_args_ Ns Aq Ar interface
1255 devices must be created for each wireless devices as of
1261 may be specified with an
1262 .Va wlandebug_ Ns Aq Ar interface
1264 The contents of this variable will be passed directly to
1268 .Va ifconfig_ Ns Aq Ar interface
1269 contains the keyword
1271 then the interface will not be configured
1273 .Pa /etc/pccard_ether
1275 .Va network_interfaces
1279 It is possible to bring up an interface with DHCP by adding
1282 .Va ifconfig_ Ns Aq Ar interface
1284 For instance, to initialize the
1287 it is possible to use something like:
1292 Also, if you want to configure your wireless interface with
1293 .Xr wpa_supplicant 8
1294 for use with WPA, EAP/LEAP or WEP, you need to add
1297 .Va ifconfig_ Ns Aq Ar interface
1300 Finally, you can add
1302 options in this variable, in addition to the
1303 .Pa /etc/start_if. Ns Aq Ar interface
1305 For instance, to configure an
1307 wireless device in station mode with an address obtained
1308 via DHCP, using WPA authentication and 802.11b mode, it is
1309 possible to use something like:
1312 ifconfig_wlan0="DHCP WPA mode 11b"
1316 .Va ifconfig_ Ns Aq Ar interface
1317 form, a fallback variable
1318 .Va ifconfig_DEFAULT
1320 It will be used for all interfaces with no
1321 .Va ifconfig_ Ns Aq Ar interface
1323 This is intended to replace the no longer supported
1327 It is also possible to rename an interface by doing:
1329 ifconfig_ed0_name="net0"
1330 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1334 This variable is deprecated.
1336 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1338 .Va ipv6_activate_all_interfaces
1343 .Dq Li inet6 accept_rtadv
1345 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1347 .Va ipv6_activate_all_interfaces
1352 This variable is deprecated.
1354 .Va ip6addrctl_policy
1359 the default address selection policy table set by
1361 will be IPv6-preferred.
1365 the default address selection policy table set by
1367 will be IPv4-preferred.
1368 .It Va ipv6_activate_all_interfaces
1370 This controls initial configuration on IPv6-capable
1371 interfaces with no corresponding
1372 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1374 Note that it is not always necessary to set this variable to
1376 to use IPv6 functionality on
1378 In most cases, just configuring
1379 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1384 all interfaces which do not have a corresponding
1385 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1386 variable will be marked as
1389 This means that all of IPv6 functionality on that interface
1390 is completely disabled to enforce a security policy.
1391 If the variable is set to
1393 the flag will be cleared on all of the interfaces.
1395 In most cases, just defining an
1396 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1397 for an IPv6-capable interface should be sufficient.
1398 However, if an interface is added dynamically
1399 .Pq by some tunneling protocols such as PPP, for example ,
1400 it is often difficult to define the variable in advance.
1401 In such a case, configuring the
1403 flag can be disabled by setting this variable to
1406 For more details of the
1409 .Dq Li inet6 ifdisabled ,
1419 privacy addresses will be generated for each IPv6
1420 interface as described in RFC 4941.
1421 .It Va ipv6_network_interfaces
1423 This is the IPv6 equivalent of
1424 .Va network_interfaces .
1425 Normally manual configuration of this variable is not needed.
1427 .It Va ipv6_cpe_wanif
1429 If the variable is set to an interface name,
1433 .Dq inet6 -no_radr accept_rtadv
1434 will be added to the specified interface automatically before evaluating
1435 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1439 .Va net.inet6.ip6.rfc6204w3
1441 .Va net.inet6.ip6.no_radr
1444 This means the specified interface will accept ICMPv6 Router
1445 Advertisement messages on that link and add the discovered
1446 routers into the Default Router List.
1447 While the other interfaces can still accept RA messages if the
1448 .Dq inet6 accept_rtadv
1449 option is specified, adding
1450 routes into the Default Router List will be disabled by
1457 Note that ICMPv6 Router Advertisement messages will be
1459 .Va net.inet6.ip6.forwarding
1461 .Pq packet forwarding is enabled
1463 .Va net.inet6.ip6.rfc6204w3
1468 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1470 IPv6 functionality on an interface should be configured by
1471 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1472 instead of setting ifconfig parameters in
1473 .Va ifconfig_ Ns Aq Ar interface .
1474 If this variable is empty, all of IPv6 configurations on the
1475 specified interface by other variables such as
1476 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1479 Aliases should be set by
1480 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1486 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1487 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1490 Interfaces that have an
1491 .Dq Li inet6 accept_rtadv
1493 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1494 setting will be automatically configured by SLAAC
1495 .Pq StateLess Address AutoConfiguration
1501 Note that a link-local address will be automatically configured in
1502 addition to the configured global-scope addresses because the IPv6
1503 specifications require it on each link.
1504 The address is calculated from the MAC address by using an algorithm
1511 If only a link-local address is needed on the interface,
1512 the following configuration can be used:
1514 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1517 A link-local address can also be configured manually.
1518 This is useful for the default router address of an IPv6 router
1519 so that it does not change when the network interface
1523 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1525 .It Va ipv6_prefix_ Ns Aq Ar interface
1527 If one or more prefixes are defined in
1528 .Va ipv6_prefix_ Ns Aq Ar interface
1529 addresses based on each prefix and the EUI-64 interface index will be
1530 configured on that interface.
1531 Note that this variable will be ignored when
1532 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1535 For example, the following configuration
1537 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1540 is equivalent to the following:
1542 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1543 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1544 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1545 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1548 These Subnet-Router anycast addresses will be added only when
1549 .Va ipv6_gateway_enable
1551 .It Va ipv6_default_interface
1555 this is the default output interface for scoped addresses.
1556 This works only with ipv6_gateway_enable="NO".
1557 .It Va ip6addrctl_enable
1559 This variable is to enable configuring default address selection policy table
1561 The table can be specified in another variable
1562 .Va ip6addrctl_policy .
1564 .Va ip6addrctl_policy
1565 the following keywords can be specified:
1566 .Dq Li ipv4_prefer ,
1567 .Dq Li ipv6_prefer ,
1577 installs a pre-defined policy table described in Section 2.1
1585 is specified, it attempts to read a file
1586 .Pa /etc/ip6addrctl.conf
1588 If this file is found,
1590 reads and installs it.
1591 If not found, a policy is automatically set
1593 .Va ipv6_activate_all_interfaces
1594 variable; if the variable is set to
1596 the IPv6-preferred one is used.
1597 Otherwise IPv4-preferred.
1599 The default value of
1600 .Va ip6addrctl_enable
1602 .Va ip6addrctl_policy
1608 .It Va cloned_interfaces
1610 Set to the list of clonable network interfaces to create on this host.
1611 Further cloning arguments may be passed to the
1614 command for each interface by setting the
1615 .Va create_args_ Ns Aq Ar interface
1618 .Va cloned_interfaces
1619 are automatically appended to
1620 .Va network_interfaces
1622 .It Va fec_interfaces
1626 Fast EtherChannel interfaces to configure on this host.
1628 .Va fecconfig_ Ns Aq Ar interface
1629 variable is assumed to exist for each value of
1631 The value of this variable is used to configure link aggregated interfaces
1632 according to the syntax of the
1633 .Cm NGM_FEC_ADD_IFACE
1637 Additionally, this option ensures that each listed interface is created
1642 before attempting to configure it.
1645 fec_interfaces="fec0"
1646 fecconfig_fec0="em0 em1"
1647 ifconfig_fec0="DHCP"
1649 .It Va gif_interfaces
1653 tunnel interfaces to configure on this host.
1655 .Va gifconfig_ Ns Aq Ar interface
1656 variable is assumed to exist for each value of
1658 The value of this variable is used to configure the link layer of the
1659 tunnel according to the syntax of the
1663 Additionally, this option ensures that each listed interface is created
1668 before attempting to configure it.
1669 .It Va sppp_interfaces
1673 interfaces to configure on this host.
1675 .Va spppconfig_ Ns Aq Ar interface
1676 variable is assumed to exist for each value of
1678 Each interface should also be configured by a general
1679 .Va ifconfig_ Ns Aq Ar interface
1683 for more information about available options.
1693 The name of the profile to use from
1694 .Pa /etc/ppp/ppp.conf .
1695 Also used for per-profile overrides of
1700 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1701 When the profile name contains any of the characters
1703 they are translated to
1705 for the proposes of the override variable names.
1708 Mode in which to run the
1711 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1713 Overrides the global
1723 See the manual for a full description.
1728 enables network address translation.
1729 Used in conjunction with
1731 allows hosts on private network addresses access to the Internet using
1732 this host as a network address translating router.
1733 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1735 Overrides the global
1739 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1741 Set the unit number to be used for this profile.
1742 See the manual description of
1747 The name of the user under which
1755 .It Va rc_conf_files
1757 This option is used to specify a list of files that will override
1759 .Pa /etc/defaults/rc.conf .
1760 The files will be read in the order in which they are specified and should
1761 include the full path to the file.
1762 By default, the files specified are
1765 .Pa /etc/rc.conf.local
1771 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1773 .It Va gptboot_enable
1777 .Pa /etc/rc.d/gptboot
1778 will log if the system successfully (or not) booted from a GPT partition,
1784 .It Va gbde_autoattach_all
1789 will attempt to automatically initialize your .bde devices in
1793 List the devices that the script should try to attach,
1798 The directory where the
1800 lockfiles are located.
1801 The default lockfile directory is
1804 The lockfile for each individual
1806 device can be overridden by setting the variable
1807 .Va gbde_lock_ Ns Aq Ar device ,
1810 is the encrypted device without the
1815 .It Va gbde_attach_attempts
1817 Number of times to attempt attaching to a
1819 device, i.e., how many times the user is asked for the pass-phrase.
1823 List of devices to automatically attach on boot.
1824 Note that .eli devices from
1826 are automatically appended to this list.
1829 Number of times user is asked for the pass-phrase.
1830 If empty, it will be taken from
1831 .Va kern.geom.eli.tries
1833 .It Va geli_default_flags
1835 Default flags to use by
1837 when configuring disk encryption.
1838 Flags can be configured for every device separately by defining
1839 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1841 .It Va geli_autodetach
1843 Specifies if GELI devices should be marked for detach on last close after
1844 file systems are mounted.
1847 This can be changed for every device separately by defining
1848 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1850 .It Va geli_swap_flags
1851 Options passed to the
1853 utility when encrypted GEOM providers for swap partitions are created.
1855 .Dq Li "-e aes -l 256 -s 4096 -d" .
1856 .It Va root_rw_mount
1861 After the file systems are checked at boot time, the root file system
1862 is remounted as read-write if this is set to
1864 Diskless systems that mount their root file system from a read-only remote
1865 NFS share should set this to
1869 .It Va fsck_y_enable
1874 will be run with the
1876 flag if the initial preen
1877 of the file systems fails.
1878 .It Va background_fsck
1882 the system will attempt to run
1884 in the background where possible.
1885 .It Va background_fsck_delay
1887 The amount of time in seconds to sleep before starting a background
1889 It defaults to sixty seconds to allow large applications such as
1890 the X server to start before disk I/O bandwidth is monopolized by
1892 If set to a negative number, the background file system check will be
1893 delayed indefinitely to allow the administrator to run it at a more
1895 For example it may be run from
1897 by adding a line like
1899 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1905 List of file system types that are network-based.
1906 This list should generally not be modified by end users.
1908 .Va extra_netfs_types
1910 .It Va extra_netfs_types
1912 If set to something other than
1915 this variable extends the list of file system types
1916 for which automatic mounting at startup by
1918 should be delayed until the network is initialized.
1920 a whitespace-separated list of network file system descriptor pairs,
1921 each consisting of a file system type as passed to
1923 and a human-readable, one-word description,
1926 Extending the default list in this way is only necessary
1927 when third party file system types are used.
1928 .It Va syslogd_enable
1935 .It Va syslogd_program
1940 .Pa /usr/sbin/syslogd ) .
1941 .It Va syslogd_flags
1947 these are the flags to pass to
1956 .It Va inetd_program
1961 .Pa /usr/sbin/inetd ) .
1968 these are the flags to pass to
1977 .It Va hastd_program
1989 these are the flags to pass to
1998 .It Va named_program
2003 .Pa /usr/sbin/named ) .
2008 configuration file, (default
2009 .Pa /etc/namedb/named.conf ) .
2016 these are the flags to pass to
2022 process should be run as.
2023 .It Va named_chrootdir
2025 The root directory for a name server run in a
2027 environment (default
2031 will not be run in a
2034 .It Va named_chroot_autoupdate
2038 to disable automatic update of the
2041 .It Va named_symlink_enable
2045 to disable symlinking of
2054 loop until working name service is established.
2055 .It Va named_wait_host
2057 Name of host to lookup for the named_wait option.
2059 .It Va named_auto_forward
2061 Set to enable automatic creation of a forwarder
2062 configuration file derived from
2063 .Pa /etc/resolv.conf .
2064 .It Va named_auto_forward_only
2066 Set to change the default forwarder configuration from
2070 .It Va kerberos5_server_enable
2074 to start a Kerberos 5 authentication server
2076 .It Va kerberos5_server
2079 .Va kerberos5_server_enable
2082 this is the path to Kerberos 5 Authentication Server.
2083 .It Va kerberos5_server_flags
2086 This variable contains additional flags to be passed to the Kerberos 5
2087 authentication server.
2088 .It Va kadmind5_server_enable
2094 the Kerberos 5 Administration Daemon; set to
2097 .It Va kadmind5_server
2100 .Va kadmind5_server_enable
2103 this is the path to Kerberos 5 Administration Daemon.
2104 .It Va kpasswdd_server_enable
2110 the Kerberos 5 Password-Changing Daemon; set to
2113 .It Va kpasswdd_server
2116 .Va kpasswdd_server_enable
2119 this is the path to Kerberos 5 Password-Changing Daemon.
2126 the Kerberos 5 ticket forwarding daemon, at the boot time.
2132 .Pa /usr/libexec/kfd ) .
2139 daemon at boot time.
2146 these are the flags to pass to it.
2153 daemon at boot time.
2160 these are the flags to pass to it.
2163 manpage for more information.
2164 .It Va amd_map_program
2167 the specified program is run to get the list of
2172 maps are stored in NIS, one can set this to
2185 will be updated at boot time to reflect the kernel release
2190 will not be updated.
2191 .It Va nfs_client_enable
2195 run the NFS client daemons at boot time.
2196 .It Va nfs_access_cache
2199 .Va nfs_client_enable
2204 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2206 results should be cached.
2207 A value of 2-10 seconds will substantially reduce network
2208 traffic for many NFS operations.
2209 .It Va nfs_server_enable
2213 run the NFS server daemons at boot time.
2214 .It Va nfs_server_flags
2217 .Va nfs_server_enable
2220 these are the flags to pass to the
2223 .It Va nfsv4_server_enable
2226 .Va nfs_server_enable
2230 .Va nfsv4_server_enable
2233 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2234 .It Va nfsuserd_enable
2240 run the nfsuserd daemon, which is needed for NFSv4 in order
2241 to map between user/group names vs uid/gid numbers.
2243 .Va nfsv4_server_enable
2246 this will be forced enabled.
2247 .It Va nfsuserd_flags
2253 these are the flags to pass to the
2256 .It Va nfscbd_enable
2262 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2269 these are the flags to pass to the
2272 .It Va oldnfs_server_enable
2275 .Va oldnfs_server_enable
2278 force the NFS server daemons to run the old NFS server code
2279 that does not support NFSv4.
2280 .It Va mountd_enable
2285 .Va nfs_server_enable
2291 It is commonly needed to run CFS without real NFS used.
2298 these are the flags to pass to the
2301 .It Va weak_mountd_authentication
2305 allow services like PCNFSD to make non-privileged mount
2307 .It Va nfs_reserved_port_only
2311 provide NFS services only on a secure port.
2312 .It Va nfs_bufpackets
2314 If set to a number, indicates the number of packets worth of
2315 socket buffer space to reserve on an NFS client.
2316 The kernel default is typically 4.
2317 Using a higher number may be
2318 useful on gigabit networks to improve performance.
2319 The minimum value is
2320 2 and the maximum is 64.
2321 .It Va rpc_lockd_enable
2325 and also an NFS server or client, run
2328 .It Va rpc_lockd_flags
2331 .Va rpc_lockd_enable
2334 these are the flags to pass to the
2337 .It Va rpc_statd_enable
2341 and also an NFS server or client, run
2344 .It Va rpc_statd_flags
2347 .Va rpc_statd_enable
2350 these are the flags to pass to the
2353 .It Va rpcbind_program
2358 .Pa /usr/sbin/rpcbind ) .
2359 .It Va rpcbind_enable
2365 service at boot time.
2366 .It Va rpcbind_flags
2372 these are the flags to pass to the
2375 .It Va keyserv_enable
2381 daemon on boot for running Secure RPC.
2382 .It Va keyserv_flags
2388 these are the flags to pass to
2391 .It Va pppoed_enable
2397 daemon at boot time to provide PPP over Ethernet services.
2398 .It Va pppoed_ Ns Aq Ar provider
2401 listens to requests to this
2407 argument of the same name.
2410 Additional flags to pass to
2412 .It Va pppoed_interface
2414 The network interface to run
2417 This is mandatory when
2427 service at boot time.
2428 This command is intended for networks of
2429 machines where a consistent
2431 for all hosts must be established.
2432 This is often useful in large NFS
2433 environments where time stamps on files are expected to be consistent
2441 these are the flags to pass to the
2444 .It Va ntpdate_enable
2451 This command is intended to
2452 synchronize the system clock only
2454 from some standard reference.
2455 An option to set this up initially
2456 (from a list of known servers) is also provided by the
2458 program when the system is first installed.
2459 .It Va ntpdate_config
2461 Configuration file for
2465 .It Va ntpdate_hosts
2467 A whitespace-separated list of NTP servers to synchronize with at startup.
2468 The default is to use the servers listed in
2469 .Va ntpdate_config ,
2470 if that file exists.
2471 .It Va ntpdate_program
2476 .Pa /usr/sbin/ntpdate ) .
2477 .It Va ntpdate_flags
2483 these are the flags to pass to the
2485 command (typically a hostname).
2492 command at boot time.
2498 .Pa /usr/sbin/ntpd ) .
2512 these are the flags to pass to the
2515 .It Va ntpd_sync_on_start
2522 flag, which syncs the system's clock on startup.
2525 for more information regarding the
2528 This is a preferred alternative to using
2533 .It Va nis_client_enable
2539 service at system boot time.
2540 .It Va nis_client_flags
2543 .Va nis_client_enable
2546 these are the flags to pass to the
2549 .It Va nis_ypset_enable
2555 daemon at system boot time.
2556 .It Va nis_ypset_flags
2559 .Va nis_ypset_enable
2562 these are the flags to pass to the
2565 .It Va nis_server_enable
2571 daemon at system boot time.
2572 .It Va nis_server_flags
2575 .Va nis_server_enable
2578 these are the flags to pass to the
2581 .It Va nis_ypxfrd_enable
2587 daemon at system boot time.
2588 .It Va nis_ypxfrd_flags
2591 .Va nis_ypxfrd_enable
2594 these are the flags to pass to the
2597 .It Va nis_yppasswdd_enable
2603 daemon at system boot time.
2604 .It Va nis_yppasswdd_flags
2607 .Va nis_yppasswdd_enable
2610 these are the flags to pass to the
2613 .It Va rpc_ypupdated_enable
2619 daemon at system boot time.
2620 .It Va bsnmpd_enable
2626 daemon at system boot time.
2627 Be sure to understand the security implications of running SNMP daemon
2635 these are the flags to pass to the
2638 .It Va defaultrouter
2642 create a default route to this host name or IP address
2643 (use an IP address if this router is also required to get to the
2645 .It Va ipv6_defaultrouter
2647 The IPv6 equivalent of
2649 .It Va static_arp_pairs
2651 Set to the list of static ARP pairs that are to be added at system
2653 For each whitespace separated
2656 .Va static_arp_ Ns Aq Ar element
2657 variable is assumed to exist whose contents will later be passed to a
2662 static_arp_pairs="gw"
2663 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2665 .It Va static_ndp_pairs
2667 Set to the list of static NDP pairs that are to be added at system
2669 For each whitespace separated
2672 .Va static_ndp_ Ns Aq Ar element
2673 variable is assumed to exist whose contents will later be passed to a
2678 static_ndp_pairs="gw"
2679 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2681 .It Va static_routes
2683 Set to the list of static routes that are to be added at system
2687 then for each whitespace separated
2690 .Va route_ Ns Aq Ar element
2691 variable is assumed to exist
2692 whose contents will later be passed to a
2697 static_routes="mcast gif0local"
2698 route_mcast="-net 224.0.0.0/4 -iface gif0"
2699 route_gif0local="-host 169.254.1.1 -iface lo0"
2701 .It Va ipv6_static_routes
2703 The IPv6 equivalent of
2707 then for each whitespace separated
2710 .Va ipv6_route_ Ns Aq Ar element
2711 variable is assumed to exist
2712 whose contents will later be passed to a
2713 .Dq Nm route Cm add Fl inet6
2715 .It Va natm_static_routes
2721 If not empty then for each whitespace separated
2724 .Va route_ Ns Aq Ar element
2725 variable is assumed to exist whose contents will later be passed to a
2726 .Dq Nm atmconfig Cm natm Cm add
2728 .It Va gateway_enable
2732 configure host to act as an IP router, e.g.\& to forward packets
2734 .It Va ipv6_gateway_enable
2736 The IPv6 equivalent of
2737 .Va gateway_enable .
2738 .It Va routed_enable
2742 run a routing daemon of some sort, based on the
2747 .It Va route6d_enable
2749 The IPv6 equivalent of
2753 run a routing daemon of some sort, based on the
2758 .It Va routed_program
2764 this is the name of the routing daemon to use.
2765 .It Va route6d_program
2767 The IPv6 equivalent of
2768 .Va routed_program .
2775 these are the flags to pass to the routing daemon.
2776 .It Va route6d_flags
2778 The IPv6 equivalent of
2780 .It Va mrouted_enable
2784 run the multicast routing daemon,
2786 .It Va mroute6d_enable
2788 The IPv6 equivalent of
2789 .Va mrouted_enable .
2792 run the IPv6 multicast routing daemon.
2794 Note that multicast routing daemons are no longer included in the
2796 base system, however, both
2800 may be installed from the
2803 .It Va mrouted_flags
2809 these are the flags to pass to the
2812 .It Va mroute6d_flags
2814 The IPv6 equivalent of
2820 these are the flags passed to the IPv6 multicast routing daemon.
2821 .It Va mroute6d_program
2827 this is the path to the IPv6 multicast routing daemon.
2828 .It Va rtadvd_enable
2834 daemon at boot time.
2837 utility sends ICMPv6 Router Advertisement messages to
2838 the interfaces specified in
2839 .Va rtadvd_interfaces .
2840 This should only be enabled with great care.
2841 You may want to fine-tune
2843 .It Va rtadvd_interfaces
2849 this is the list of interfaces to use.
2850 .It Va ipxgateway_enable
2854 enable the routing of IPX traffic.
2855 .It Va ipxrouted_enable
2861 daemon at system boot time.
2862 .It Va ipxrouted_flags
2865 .Va ipxrouted_enable
2868 these are the flags to pass to the
2875 enable global proxy ARP.
2876 .It Va forward_sourceroute
2884 source-routed packets are forwarded.
2885 .It Va accept_sourceroute
2889 the system will accept source-routed packets directed at it.
2896 daemon at system boot time.
2903 these are the flags to pass to the
2906 .It Va bootparamd_enable
2912 daemon at system boot time.
2913 .It Va bootparamd_flags
2916 .Va bootparamd_enable
2919 these are the flags to pass to the
2922 .It Va stf_interface_ipv4addr
2926 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2928 Specify this entry to enable the 6to4 interface.
2929 .It Va stf_interface_ipv4plen
2931 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2932 An effective value is 0-31.
2933 .It Va stf_interface_ipv6_ifid
2935 IPv6 interface ID for
2939 .It Va stf_interface_ipv6_slaid
2941 IPv6 Site Level Aggregator for
2943 .It Va ipv6_faith_prefix
2947 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2952 .It Va ipv6_ipv4mapping
2956 this enables IPv4 mapped IPv6 address communication (like
2957 .Li ::ffff:a.b.c.d ) .
2958 .It Va rtsold_enable
2964 daemon to send ICMPv6 Router Solicitation messages.
2971 these are the flags to pass to
2975 For interfaces configured with the
2976 .Dq Li inet6 accept_rtadv
2977 keyword, these are the flags to pass to
2982 is mutually exclusive to
2990 to enable the configuration of ATM interfaces at system boot time.
2991 For all of the ATM variables described below, please refer to the
2993 manual page for further details on the available command parameters.
2994 Also refer to the files in
2995 .Pa /usr/share/examples/atm
2996 for more detailed configuration information.
2999 This is a list of physical ATM interface drivers to load.
3004 .It Va atm_netif_ Ns Aq Ar intf
3006 For the ATM physical interface
3008 this variable defines the name prefix and count for the ATM network
3009 interfaces to be created.
3010 The value will be passed as the parameters of an
3011 .Dq Nm atm Cm "set netif" Ar intf
3013 .It Va atm_sigmgr_ Ns Aq Ar intf
3015 For the ATM physical interface
3017 this variable defines the ATM signalling manager to be used.
3018 The value will be passed as the parameters of an
3019 .Dq Nm atm Cm attach Ar intf
3021 .It Va atm_prefix_ Ns Aq Ar intf
3023 For the ATM physical interface
3025 this variable defines the NSAP prefix for interfaces using a UNI signalling
3029 the prefix will automatically be set via the
3032 Otherwise, the value will be passed as the parameters of an
3033 .Dq Nm atm Cm "set prefix" Ar intf
3035 .It Va atm_macaddr_ Ns Aq Ar intf
3037 For the ATM physical interface
3039 this variable defines the MAC address for interfaces using a UNI signalling
3043 the hardware MAC address contained in the ATM interface card will be used.
3044 Otherwise, the value will be passed as the parameters of an
3045 .Dq Nm atm Cm "set mac" Ar intf
3047 .It Va atm_arpserver_ Ns Aq Ar netif
3049 For the ATM network interface
3051 this variable defines the ATM address for a host which is to provide ATMARP
3053 This variable is only applicable to interfaces using a UNI signalling
3057 this host will become an ATMARP server.
3058 The value will be passed as the parameters of an
3059 .Dq Nm atm Cm "set arpserver" Ar netif
3061 .It Va atm_scsparp_ Ns Aq Ar netif
3065 SCSP/ATMARP service for the network interface
3067 will be initiated using the
3072 This variable is only applicable if
3073 .Va atm_arpserver_ Ns Aq Ar netif
3078 Set to the list of ATM PVCs to be added at system
3080 For each whitespace separated
3083 .Va atm_pvc_ Ns Aq Ar element
3084 variable is assumed to exist.
3085 The value of each of these variables
3086 will be passed as the parameters of an
3087 .Dq Nm atm Cm "add pvc"
3091 Set to the list of permanent ATM ARP entries to be added
3092 at system boot time.
3093 For each whitespace separated
3096 .Va atm_arp_ Ns Aq Ar element
3097 variable is assumed to exist.
3098 The value of each of these variables
3099 will be passed as the parameters of an
3100 .Dq Nm atm Cm "add arp"
3102 .It Va natm_interfaces
3106 interfaces that will also be used for HARP through
3108 If this list is not empty all interfaces in the list will be brought up
3114 For this to work the interface drivers must be either compiled into the
3115 kernel or must reside on the root partition.
3118 The keyboard bell sound.
3125 if the default behavior is desired.
3126 For details, refer to the
3131 If set to a non-null string, the virtual console's keyboard input is
3137 no keymap is installed, otherwise the value is used to install
3139 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3142 The keyboard repeat speed.
3149 if the default behavior is desired.
3154 attempt to program the function keys with the value.
3156 be a single string of the form:
3157 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3160 Can be set to the value of
3163 .Dq Li destructive ,
3166 to set the cursor behavior explicitly or choose the default behavior.
3171 no screen map is installed, otherwise the value is used to install
3172 the screen map file in
3173 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3178 the default 8x16 font value is used for screen size requests, otherwise
3180 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3186 the default 8x14 font value is used for screen size requests, otherwise
3188 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3194 the default 8x8 font value is used for screen size requests, otherwise
3196 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3202 the default screen blanking interval is used, otherwise it is set
3210 this is the actual screen saver to use
3211 .Li ( blank , snake , daemon ,
3213 .It Va moused_nondefault_enable
3217 the mouse device specified on
3218 the command line is not automatically treated as enabled by the
3219 .Pa /etc/rc.d/moused
3221 Having this variable set to
3227 to be enabled as soon as it is plugged in.
3228 .It Va moused_enable
3234 daemon is started for doing cut/paste selection on the console.
3237 This is the protocol type of the mouse connected to this host.
3238 This variable must be set if
3245 is able to detect the appropriate mouse type automatically in many cases.
3246 Set this variable to
3248 to let the daemon detect it, or
3249 select one from the following list if the automatic detection fails.
3251 If the mouse is attached to the PS/2 mouse port, choose
3255 regardless of the brand and model of the mouse.
3257 mouse is attached to the bus mouse port, choose
3261 All other protocols are for serial mice and will not work with
3262 the PS/2 and bus mice.
3263 If this is a USB mouse,
3265 is the only protocol type which will work.
3267 .Bl -tag -width ".Li x10mouseremote" -compact
3269 Microsoft mouse (serial)
3271 Microsoft IntelliMouse (serial)
3273 Mouse systems Corp.\& mouse (serial)
3275 MM Series mouse (serial)
3277 Logitech mouse (serial)
3281 Logitech MouseMan and TrackMan (serial)
3283 ALPS GlidePoint (serial)
3284 .It Li thinkingmouse
3285 Kensington ThinkingMouse (serial)
3289 MM HitTablet (serial)
3290 .It Li x10mouseremote
3291 X10 MouseRemote (serial)
3293 Interlink VersaPad (serial)
3296 Even if the mouse is not in the above list, it may be compatible
3297 with one in the list.
3298 Refer to the manual page for
3300 for compatibility information.
3302 It should also be noted that while this is enabled, any
3303 other client of the mouse (such as an X server) should access
3304 the mouse through the virtual mouse device,
3306 and configure it as a
3308 type mouse, since all
3309 mouse data is converted to this single canonical format when
3312 If the client program does not support the
3318 It is the second preferred type.
3325 this is the actual port the mouse is on.
3328 for a COM1 serial mouse,
3332 for a bus mouse, for example.
3337 is set, its value is used as an additional set of flags to pass to the
3340 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3342 .Va moused_nondefault_enable
3345 daemon is started for a non-default port, the
3346 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3347 set of options has precedence over and replaces the default
3351 is the name of the non-default port, i.e.,\&
3354 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3355 it is possible to set up a different set of default flags for each
3358 For example, you can use
3362 to make your laptop's touchpad more comfortable to use,
3363 but an empty set of options for
3364 .Va moused_ums0_flags
3367 mouse has three or more buttons.
3368 .It Va mousechar_start
3372 the default mouse cursor character range
3373 .Li 0xd0 Ns - Ns Li 0xd3
3375 otherwise the range start is set
3380 Use if the default range is occupied in the language code table.
3381 .It Va allscreens_flags
3385 is run with these options for each of the virtual terminals
3389 will enable the mouse pointer on all virtual terminals
3394 .It Va allscreens_kbdflags
3398 is run with these options for each of the virtual terminals
3404 scrollback (history) buffer to 200 lines.
3411 daemon at system boot time.
3417 .Pa /usr/sbin/cron ) .
3424 these are the flags to pass to
3430 enable the special handling of transitions to and from the
3431 Daylight Saving Time in
3433 (equivalent to using the flag
3440 .Pa /usr/sbin/lpd ) .
3447 daemon at system boot time.
3454 these are the flags to pass to the
3457 .It Va chkprintcap_enable
3463 command before starting the
3466 .It Va chkprintcap_flags
3471 .Va chkprintcap_enable
3474 these are the flags to pass to the
3479 which causes missing directories to be created.
3480 .It Va mta_start_script
3482 This variable specifies the full path to the script to run to start
3483 a mail transfer agent.
3485 .Pa /etc/rc.sendmail .
3489 .Pa /etc/rc.sendmail
3490 uses are documented in the
3495 Indicates the device (usually a swap partition) to which a crash dump
3496 should be written in the event of a system crash.
3497 If the value of this variable is
3499 the first suitable swap device listed in
3501 will be used as dump device.
3502 Otherwise, the value of this variable is passed as the argument to
3504 To disable crash dumps, set this variable to
3508 When the system reboots after a crash and a crash dump is found on the
3509 device specified by the
3513 will save that crash dump and a copy of the kernel to the directory
3517 The default value is
3526 .It Va savecore_flags
3528 If crash dumps are enabled, these are the flags to pass to the
3535 to turn on user and group disk quotas on system startup via the
3537 command for all file systems marked as having quotas enabled in
3539 The kernel must be built with
3541 for disk quotas to function.
3546 to enable user and group disk quota checking via the
3549 .It Va quotacheck_flags
3559 these are the flags to pass to the
3564 which checks quotas for all file systems with quotas enabled in
3566 .It Va quotaon_flags
3572 these are the flags to pass to the
3577 which enables quotas for all file systems with quotas enabled in
3579 .It Va quotaoff_flags
3585 these are the flags to pass to the
3587 utility when shutting down the quota system.
3590 which disables quotas for all file systems with quotas enabled in
3592 .It Va accounting_enable
3596 to enable system accounting through the
3603 to enable iBCS2 (SCO) binary emulation at system initial boot
3605 .It Va ibcs2_loaders
3613 this specifies a list of additional iBCS2 loaders to enable.
3618 to enable Linux/ELF binary emulation at system initial
3624 enable SysVR4 emulation at boot time.
3625 .It Va sysvipc_enable
3629 load System V IPC primitives at boot time.
3630 .It Va clear_tmp_enable
3641 to disable removing of X11 lock files,
3642 and the removal and (secure) recreation
3643 of the various socket directories for X11
3645 .It Va ldconfig_paths
3647 Set to the list of shared library paths to use with
3651 will always be added first, so it need not appear in this list.
3652 .It Va ldconfig32_paths
3654 Set to the list of 32-bit compatibility shared library paths to
3657 .It Va ldconfig_paths_aout
3659 Set to the list of shared library paths to use with
3664 .It Va ldconfig_insecure
3668 utility normally refuses to use directories
3669 which are writable by anyone except root.
3670 Set this variable to
3672 to disable that security check during system startup.
3673 .It Va ldconfig_local_dirs
3675 Set to the list of local
3678 The names of all files in the directories listed will be
3679 passed as arguments to
3681 .It Va ldconfig_local32_dirs
3683 Set to the list of local 32-bit compatibility
3686 The names of all files in the directories listed will be
3687 passed as arguments to
3688 .Dq Nm ldconfig Fl 32 .
3689 .It Va kern_securelevel_enable
3693 to set the kernel security level at system startup.
3694 .It Va kern_securelevel
3696 The kernel security level to set at startup.
3697 The allowed range of
3699 ranges from \-1 (the compile time default) to 3 (the
3703 for the list of possible security levels and their effect
3704 on system operation.
3707 Path to the SSH server program
3708 .Pa ( /usr/sbin/sshd
3716 at system boot time.
3723 these are the flags to pass to the
3728 Path to the FTP server program
3729 .Pa ( /usr/libexec/ftpd
3737 as a stand-alone daemon at system boot time.
3744 these are the additional flags to pass to the
3747 .It Va watchdogd_enable
3753 daemon at boot time.
3754 This requires that the kernel have been compiled with a
3757 .It Va watchdogd_flags
3760 .Va watchdogd_enable
3763 these are the flags passed to the
3766 .It Va devfs_rulesets
3768 List of files containing sets of rules for
3770 .It Va devfs_system_ruleset
3772 Rule name(s) to apply to the system
3775 .It Va devfs_set_rulesets
3777 Pairs of already-mounted
3779 directories and rulesets that should be applied to them.
3780 For example: /mount/dev=ruleset_name
3781 .It Va devfs_load_rulesets
3783 If set, always load the default rulesets listed in
3784 .Va devfs_rulesets .
3785 .It Va performance_cx_lowest
3787 CPU idle state to use while on AC power.
3792 should use the lowest power state available while
3794 indicates that the lowest latency state (less power savings) should be used.
3795 .It Va performance_cpu_freq
3797 CPU clock frequency to use while on AC power.
3802 should use the lowest frequency available while
3804 indicates that the highest frequency (less power savings) should be used.
3805 .It Va economy_cx_lowest
3807 CPU idle state to use when off AC power.
3812 should use the lowest power state available while
3814 indicates that the lowest latency state (less power savings) should be used.
3815 .It Va economy_cpu_freq
3817 CPU clock frequency to use when off AC power.
3822 should use the lowest frequency available while
3824 indicates that the highest frequency (less power savings) should be used.
3829 any configured jails will not be started.
3830 .It Va jail_parallel_start
3834 all configured jails will be started in the background (in parallel).
3837 A space separated list of names for jails.
3838 This is purely a configuration aid to help identify and
3839 configure multiple jails.
3840 The names specified in this list will be used to
3841 identify settings common to an instance of a jail,
3842 and should contain alphanumeric characters only.
3843 Assuming that the jail in question was named
3845 you would have the following dependent variables:
3847 jail_vjail_hostname="jail.example.com"
3848 jail_vjail_ip="192.0.2.100"
3849 jail_vjail_rootdir="/var/jails/vjail/root"
3855 When set, use as default value for
3856 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3859 .It Va jail_interface
3862 When set, use as default value for
3863 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3869 When set, use as default value for
3870 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3873 .It Va jail_mount_enable
3881 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3884 by default for every jail in
3886 .It Va jail_devfs_ruleset
3890 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3891 to given value for every jail in
3893 .It Va jail_devfs_enable
3901 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3904 by default for every jail in
3906 .It Va jail_fdescfs_enable
3914 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3917 by default for every jail in
3919 .It Va jail_procfs_enable
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3930 by default for every jail in
3932 .It Va jail_exec_prestart Ns Aq Ar N
3935 When set, use as default value for
3936 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3939 .It Va jail_exec_start
3942 When set, use as default value for
3943 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3946 .It Va jail_exec_afterstart Ns Aq Ar N
3949 When set, use as default value for
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3953 .It Va jail_exec_poststart Ns Aq Ar N
3956 When set, use as default value for
3957 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3960 .It Va jail_exec_prestop Ns Aq Ar N
3963 When set, use as default value for
3964 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3967 .It Va jail_exec_stop
3969 When set, use as default value for
3970 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3973 .It Va jail_exec_poststop Ns Aq Ar N
3976 When set, use as default value for
3977 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3980 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3983 Set to the root directory used by jail
3985 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3988 Set to the fully qualified domain name (FQDN) assigned to jail
3990 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3993 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3994 The argument can be a sole address or a comma separated list of addresses.
3995 Additionally each address can be prefixed by the name of an interface
3996 followed by a pipe to overwrite
3997 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
4000 and/or suffixed by a netmask, prefixlen or prefix.
4001 In case no netmask, prefixlen or prefix is given,
4003 will be used for IPv4 and
4005 will be used for an IPv6 address.
4006 If no address is given for the jail then the jail will be started with
4007 no networking support.
4008 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4011 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
4012 The sequence starts with
4014 and the numbers have to be strictly ascending.
4015 These entries follow the same syntax as their primary
4016 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4018 The order of the entries can be important as the first address for
4019 each address family found will be the primary address of the jail.
4025 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
4030 These are flags to pass to
4032 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
4035 When set, sets the interface to use when setting IP address alias.
4036 Note that the alias is created at jail startup and removed at jail shutdown.
4037 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
4040 When set, the jail is started with the specified forwarding table (sometimes
4041 referred to as a routing table) via
4043 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
4046 .Pa /etc/fstab. Ns Aq Ar jname
4048 This is the file system information file to use for jail
4050 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4057 mount all file systems from
4058 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
4060 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
4063 When set, defines the device file system ruleset file to use for jail
4065 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4072 mount the device file system inside jail
4075 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4082 mount the file-descriptor file system inside jail
4085 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
4092 mount the process file system inside jail
4095 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
4098 This is the command run as
4101 before jail startup, where
4104 It is run outside the jail.
4105 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
4108 .Dq Li /bin/sh /etc/rc
4110 This is the command executed in a jail at jail startup.
4111 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
4114 This is the command run as
4118 after jail startup, where
4121 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
4124 This is the command run as
4127 after jail startup, where
4130 It is run outside the jail.
4131 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
4134 This is the command run as
4137 before jail shutdown, where
4140 It is run outside the jail.
4141 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4144 .Dq Li /bin/sh /etc/rc.shutdown
4146 This is the command executed in a jail at jail shutdown.
4147 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
4150 This is the command run as
4153 after jail shutdown, where
4156 It is run outside the jail.
4157 .It Va jail_set_hostname_allow
4161 do not allow the root user in a jail to set its hostname.
4162 .It Va jail_socket_unixiproute_only
4166 do not allow any sockets,
4167 besides UNIX/IP/route sockets,
4168 to be used within a jail.
4169 .It Va jail_sysvipc_allow
4173 allow applications within a jail to use System V IPC.
4174 .\" -----------------------------------------------------
4175 .It Va harvest_interrupt
4179 to use hardware interrupts as an entropy source.
4182 for more information.
4183 .It Va harvest_ethernet
4187 to use LAN traffic as an entropy source.
4190 for more information.
4191 .It Va harvest_p_to_p
4195 to use serial line traffic as an entropy source.
4198 for more information.
4203 to disable caching entropy via
4205 Otherwise set to the directory used to store entropy files in.
4210 to disable caching entropy through reboots.
4211 Otherwise set to the filename used to store cached entropy through
4213 This file should be located on the root file system to seed the
4215 device as early as possible in the boot process.
4216 .It Va entropy_save_sz
4218 Size of the entropy cache files saved by
4221 .It Va entropy_save_num
4223 Number of entropy cache files to save by
4237 Configuration file for
4246 .Pa /var/run/dmesg.boot
4248 .It Va rcshutdown_timeout
4250 If set, start a watchdog timer in the background which will terminate
4254 has not completed within the specified time (in seconds).
4255 Notice that in addition to this soft timeout,
4257 also applies a hard timeout for the execution of
4259 This is configured via
4262 .Va kern.init_shutdown_timeout
4263 and defaults to 120 seconds.
4264 Setting the value of
4265 .Va rcshutdown_timeout
4266 to more than 120 seconds will have no effect until the
4269 .Va kern.init_shutdown_timeout
4271 .It Va virecover_enable
4275 to prevent the system from trying to
4276 recover pre-maturely terminated
4279 .It Va ugidfw_enable
4284 .Xr mac_bsdextended 4
4285 module upon system initialization and load a default
4287 .It Va bsdextended_script
4290 .Xr mac_bsdextended 4
4291 ruleset file to load.
4292 The default value of this variable is
4293 .Pa /etc/rc.bsdextended .
4294 .It Va newsyslog_enable
4301 .It Va newsyslog_flags
4304 .Va newsyslog_enable
4307 these are the flags to pass to the
4312 which causes log files flagged with a
4315 .It Va mdconfig_md Ns Aq Ar X
4325 must be specified and either a
4327 for malloc or swap backed
4335 .Va mdconfig_md Ns Aq Ar X
4336 variables are evaluated until one variable is unset or null.
4337 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4339 Optional arguments passed to
4345 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4347 An ownership specification passed to
4356 device and the mount point will be changed.
4357 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4359 A mode string passed to
4368 device and the mount point will be changed.
4369 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4371 Files to be copied to the mount point of the
4375 after it has been mounted.
4376 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4378 Command to execute after the specified
4383 Note that the command is passed to
4389 variables can be used to reference respectively the
4391 device and the mount point.
4396 one could set the following:
4398 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4400 .It Va autobridge_interfaces
4402 Set to the list of bridge interfaces that will have newly arriving interfaces
4403 checked against to be automatically added.
4406 then for each whitespace separated
4409 .Va autobridge_ Ns Aq Ar element
4410 variable is assumed to exist which has a whitespace separated list of interface
4411 names to match, these names can use wildcards.
4414 autobridge_interfaces="bridge0"
4415 autobridge_bridge0="tap* dc0 vlan[345]"
4421 enable support for sound mixer.
4422 .It Va hcsecd_enable
4426 enable Bluetooth security daemon.
4427 .It Va hcsecd_config
4429 Configuration file for
4432 .Pa /etc/bluetooth/hcsecd.conf .
4437 enable Bluetooth Service Discovery Protocol daemon.
4445 .It Va sdpd_groupname
4449 group to run as after it initializes.
4452 .It Va sdpd_username
4456 user to run as after it initializes.
4459 .It Va bthidd_enable
4463 enable Bluetooth Human Interface Device daemon.
4464 .It Va bthidd_config
4466 Configuration file for
4469 .Pa /etc/bluetooth/bthidd.conf .
4472 Path to a file, where
4474 will store information about known HID devices.
4476 .Pa /var/db/bthidd.hids .
4477 .It Va rfcomm_pppd_server_enable
4481 enable Bluetooth RFCOMM PPP wrapper daemon.
4482 .It Va rfcomm_pppd_server_profile
4484 The name of the profile to use from
4485 .Pa /etc/ppp/ppp.conf .
4486 Multiple profiles can be specified here.
4487 Also used to specify per-profile overrides.
4488 When the profile name contains any of the characters
4490 they are translated to
4492 for the proposes of the override variable names.
4493 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4495 Overrides local address to listen on.
4501 The address can be specified as BD_ADDR or name.
4502 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4504 Overrides local RFCOMM channel to listen on.
4507 will listen on RFCOMM channel 1.
4508 Must set properly if multiple profiles used in the same time.
4509 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4513 if it should register Serial Port service on the specified RFCOMM channel.
4516 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4520 if it should register Dial-Up Networking service on the specified
4524 .It Va ubthidhci_enable
4528 change the USB Bluetooth controller from HID mode to HCI mode.
4529 You also need to specify the location of USB Bluetooth controller with the
4530 .Va ubthidhci_busnum
4534 .It Va ubthidhci_busnum
4535 Bus number where the USB Bluetooth controller is located.
4538 on your system to find this information.
4539 .It Va ubthidhci_addr
4540 Bus address of the USB Bluetooth controller.
4543 on your system to find this information.
4544 .It Va netwait_enable
4548 delays the start of network-reliant services until
4550 is up and ICMP packets to a destination defined in
4553 Link state is examined first, followed by
4555 an IP address to verify network usability.
4556 If no destination can be reached or timeouts are exceeded,
4557 network services are started anyway with no guarantee that
4558 the network is usable.
4559 Use of this variable requires both
4567 This variable contains a space-delimited list of IP addresses to
4569 DNS hostnames should not be used as resolution is not guaranteed
4570 to be functional at this point.
4571 If multiple IP addresses are specified,
4572 each will be tried until one is successful or the list is exhausted.
4573 .It Va netwait_timeout
4575 Indicates the total number of seconds to perform a
4577 against each IP address in
4579 at a rate of one ping per second.
4580 If any of the pings are successful,
4581 full network connectivity is considered reliable.
4586 Defines the name of the network interface on which watch for link.
4588 is used to monitor the interface, looking for
4589 .Dq Li status: no carrier .
4590 Once gone, the link is considered up.
4593 interface if desired.
4594 .It Va netwait_if_timeout
4596 Defines the total number of seconds to wait for link to become usable,
4597 polled at a 1-second interval.
4601 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4602 .It Pa /etc/defaults/rc.conf
4604 .It Pa /etc/rc.conf.local
4633 .Xr newsyslog.conf 5 ,
4703 .An Jordan K. Hubbard .