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.
45 is not to run commands or perform system startup actions
47 Instead, it is included by the
48 various generic startup scripts in
50 which conditionalize their
51 internal actions according to the settings found there.
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
60 when the system administrator wishes to override these defaults.
62 .Pa /etc/defaults/vendor.conf
63 allows vendors to override
67 .Pa /etc/rc.conf.local
68 is used to override settings in
70 for historical reasons.
72 The sysrc(8) command provides a scripting interface to modify system
76 .Pa /etc/rc.conf.local
77 you can also place smaller configuration files for each
82 .Ao Ar dir Ac Ns Pa /rc.conf.d
83 directories specified in
85 which will be included by the
88 For jail configurations you could use the file
89 .Pa /etc/rc.conf.d/jail
90 to store jail specific configuration options.
94 .Pa /usr/local/etc/rc.d
97 .Pa /usr/local/rc.conf.d/jail
99 .Pa /opt/conf/rc.conf.d/jail
102 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
104 all of files in the directory will be loaded.
110 .Dq Ar name Ns Li = Ns Ar value
114 The following list provides a name and short description for each
115 variable that can be set in the
118 .Bl -tag -width indent-two
123 enable output of debug messages from rc scripts.
124 This variable can be helpful in diagnosing mistakes when
125 editing or integrating new scripts.
126 Beware that this produces copious output to the terminal and
132 disable informational messages from the rc scripts.
133 Informational messages are displayed when
134 a condition that is not serious enough to warrant a warning or
142 when faststart is used (e.g., at boot time).
143 .It Va early_late_divider
145 The name of the script that should be used as the
146 delimiter between the
150 stages of the boot process.
151 The early stage should contain all the services needed to
152 get the disks (local or remote) mounted so that the late
153 stage can include scripts contained in the directories
156 variable (see below).
157 Thus, the two likely candidates for this value are
159 for the typical system, and
161 if the system needs remote file
162 systems mounted to get access to the
164 directories; for example when
172 is likely to be an appropriate value.
173 Extreme care should be taken when changing this value,
174 and before changing it one should ensure that there are
175 adequate provisions to recover from a failed boot
176 (such as physical contact with the machine,
177 or reliable remote console access).
178 .It Va always_force_depends
182 scripts use the force_depend function to check whether required
183 services are already running, and to start them if necessary.
184 By default during boot time this check is bypassed if the
185 required service is enabled in
186 .Pa /etc/rc.conf[.local] .
187 Setting this option will bypass that check at boot time and
188 always test whether or not the service is actually running.
189 Enabling this option is likely to increase your boot time if
190 services are enabled that utilize the force_depend check.
191 .It Ao Ar name Ac Ns Va _chroot
194 to this directory before running the service.
195 .It Ao Ar name Ac Ns Va _user
197 Run the service under this user account.
198 .It Ao Ar name Ac Ns Va _group
200 Run the chrooted service under this system group.
202 setting, this setting has no effect if the service is not chrooted.
203 .It Ao Ar name Ac Ns Va _fib
207 value to run the service under.
208 .It Ao Ar name Ac Ns Va _nice
212 value to run the service under.
217 enable support for Automatic Power Management with
225 to handle APM event from userland.
226 This also enables support for APM.
233 these are the flags to pass to the
240 to handle device added, removed or unknown events from the kernel.
247 scripts at boot time.
250 Configuration file for
254 .It Va devmatch_enable
258 disable auto-loading of kernel modules with
260 .It Va devmatch_blacklist
262 A whitespace-separated list of kernel modules to be ignored by
266 A whitespace-separated list of kernel modules to load right after
267 the local disks are mounted, without any
270 Loading modules at this point in the boot process is
271 much faster than doing it via
272 .Pa /boot/loader.conf
273 for those modules not necessary for mounting local disks.
274 .It Va kldxref_enable
281 to automatically rebuild
286 .It Va kldxref_clobber
296 will overwrite existing
303 .It Va kldxref_module_path
308 delimited list of paths containing
320 enable the system power control facility with the
329 these are the flags to pass to the
333 Controls the creation of a
336 Always happens if set to
338 and never happens if set to
340 If set to anything else, a memory file system is created if
344 Controls the size of a created
348 Extra options passed to the
350 utility when the memory file system for
355 which inhibits the use of softupdates on
357 so that file system space is freed without delay
358 after file truncation or deletion.
361 for other options you can use in
364 Controls the creation of a
367 Always happens if set to
369 and never happens if set to
371 If set to anything else, a memory file system is created if
375 Controls the size of a created
379 Extra options passed to the
381 utility when the memory file system for
386 which inhibits the use of softupdates on
388 so that file system space is freed without delay
389 after file truncation or deletion.
392 for other options you can use in
395 Controls the automatic population of the
398 Always happens if set to
400 and never happens if set to
402 If set to anything else, a memory file system is created if
405 Note that this process requires access to certain commands in
409 is mounted on normal systems.
410 .It Va cleanvar_enable
417 List of directories to search for startup script files.
418 .It Va script_name_sep
420 The field separator to use for breaking down the list of startup script files
421 into individual filenames.
422 The default is a space.
423 It is not necessary to change this unless there are startup scripts with names
425 .It Va hostapd_enable
434 The fully qualified domain name (FQDN) of this host on the network.
435 This should almost certainly be set to something meaningful, even if
436 there is no network connection.
439 is used to set the hostname via DHCP,
440 this variable should be set to an empty string.
443 the hostname is generally already set and this variable may be absent.
444 If this value remains unset when the system is done booting
445 your console login will display the default hostname of
449 The NIS domain name of this host, or
452 .It Va dhclient_program
454 Path to the DHCP client program
455 .Pa ( /sbin/dhclient ,
460 .It Va dhclient_flags
462 Additional flags to pass to the DHCP client program.
467 manpage for a description of the command line options available.
468 .It Va dhclient_flags_ Ns Aq Ar iface
469 Additional flags to pass to the DHCP client program running on
472 When specified, this variable overrides
474 .It Va background_dhclient
478 to start the DHCP client in background.
479 This can cause trouble with applications depending on
480 a working network, but it will provide a faster startup
482 .It Va background_dhclient_ Ns Aq Ar iface
483 When specified, this variable overrides the
484 .Va background_dhclient
485 variable for interface
488 .It Va synchronous_dhclient
494 synchronously at startup.
495 This behavior can be overridden on a per-interface basis by replacing
499 .Va ifconfig_ Ns Aq Ar interface
504 .It Va defaultroute_delay
506 When set to a positive value, wait up to this long after configuring
507 DHCP interfaces at startup to give the interfaces time to receive a lease.
508 .It Va firewall_enable
512 to load firewall rules at startup.
513 If the kernel was not built with
514 .Cd "options IPFIREWALL" ,
517 kernel module will be loaded.
519 .Va ipfilter_enable .
520 .It Va firewall_script
522 This variable specifies the full path to the firewall script to run.
524 .Pa /etc/rc.firewall .
527 Names the firewall type from the selection in
528 .Pa /etc/rc.firewall ,
529 or the file which contains the local firewall ruleset.
530 Valid selections from
534 .Bl -tag -width ".Li simple" -compact
536 unrestricted IP access
538 all IP services disabled, except via
541 basic protection for a workstation
543 basic protection for a LAN.
546 If a filename is specified, the full path
548 .It Va firewall_quiet
552 to disable the display of firewall rules on the console during boot.
553 .It Va firewall_logging
557 to enable firewall event logging.
558 This is equivalent to the
559 .Dv IPFIREWALL_VERBOSE
561 .It Va firewall_logif
565 to create pseudo interface
568 For more details, see
571 .It Va firewall_flags
577 specifies a filename.
578 .It Va firewall_coscripts
580 List of executables and/or rc scripts to run after firewall starts/stops.
582 .\" ----- firewall_nat_enable setting --------------------------------
583 .It Va firewall_nat_enable
591 will automatically load the
597 .It Va firewall_nat_interface
603 This is the name of the public interface or IP address on which
604 kernel NAT should run.
605 .It Va firewall_nat_flags
607 Additional configuration parameters for kernel NAT should be placed here.
608 .It Va firewall_nat64_enable
612 will automatically load the
614 NAT64 kernel module if
618 .It Va firewall_nptv6_enable
622 will automatically load the
624 NPTv6 kernel module if
628 .It Va firewall_pmod_enable
632 will automatically load the
634 pmod kernel module if
638 .It Va dummynet_enable
642 will automatically load the
648 .\" -------------------------------------------------------------------
649 .It Va ipfw_netflow_enable
653 will enable netflow logging via
656 By default a ipfw rule is inserted and all packets are duplicated with
657 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
658 port using protocol version 5.
659 .It Va ipfw_netflow_hook
661 netflow hook name, must be numerical
664 .It Va ipfw_netflow_rule
669 .It Va ipfw_netflow_ip
671 Destination server ip for receiving netflow data
674 .It Va ipfw_netflow_port
676 Destination server port for receiving netflow data
679 .It Va ipfw_netflow_version
681 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
682 .It Va ipfw_netflow_fib
684 Only match packet in FIB
686 (default is undefined meaning all FIBs).
702 sockets must be enabled in the kernel.
703 If the kernel was not built with
704 .Cd "options IPDIVERT" ,
707 kernel module will be loaded.
708 .It Va natd_interface
710 This is the name of the public interface on which
713 The interface may be given as an interface name or as an IP address.
718 flags should be placed here.
723 flag is automatically added with the above
726 .\" ----- ipfilter_enable setting --------------------------------
727 .It Va ipfilter_enable
738 Typical usage will require putting
740 ipfilter_enable="YES"
758 can be enabled independently.
762 both require at least one of
772 options IPFILTER_DEFAULT_BLOCK
775 in the kernel configuration file is a good idea, too.
776 .\" ----- ipfilter_program setting ------------------------------
777 .It Va ipfilter_program
783 .\" ----- ipfilter_rules setting --------------------------------
784 .It Va ipfilter_rules
789 This variable contains the name of the filter rule definition file.
790 The file is expected to be readable for the
793 .\" ----- ipv6_ipfilter_rules setting ---------------------------
794 .It Va ipv6_ipfilter_rules
799 This variable contains the IPv6 filter rule definition file.
800 The file is expected to be readable for the
803 .\" ----- ipfilter_flags setting --------------------------------
804 .It Va ipfilter_flags
807 This variable contains flags passed to the
810 .\" ----- ipnat_enable setting ----------------------------------
820 network address translation.
823 for a detailed discussion.
824 .\" ----- ipnat_program setting ---------------------------------
831 .\" ----- ipnat_rules setting -----------------------------------
837 This variable contains the name of the file
838 holding the network address translation definition.
839 This file is expected to be readable for the
842 .\" ----- ipnat_flags setting -----------------------------------
846 This variable contains flags passed to the
849 .\" ----- ipmon_enable setting ----------------------------------
864 Setting this variable needs setting
871 for a detailed discussion.
872 .\" ----- ipmon_program setting ---------------------------------
879 .\" ----- ipmon_flags setting -----------------------------------
885 This variable contains flags passed to the
888 Another typical example would be
889 .Dq Fl D Pa /var/log/ipflog
892 log directly to a file bypassing
895 .Pa /etc/newsyslog.conf
896 in such case like this:
898 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
900 .\" ----- ipfs_enable setting -----------------------------------
910 saving the filter and NAT state tables during shutdown
911 and reloading them during startup again.
912 Setting this variable needs setting
921 for a detailed discussion.
927 because the raised securelevel will prevent
929 from saving the state tables at shutdown time.
930 .\" ----- ipfs_program setting ----------------------------------
937 .\" ----- ipfs_flags setting ------------------------------------
941 This variable contains flags passed to the
944 .\" ----- end of added ipf hook ---------------------------------
956 Typical usage will require putting
971 into the kernel, otherwise the
972 kernel module will be loaded.
977 ruleset configuration file
992 these flags are passed to the
994 program when loading the ruleset.
1004 which logs packets from the
1007 .It Va pflog_logfile
1017 .Pa /var/log/pflog ) .
1019 .Pa /etc/newsyslog.conf
1020 to adjust logfile rotation for this.
1021 .It Va pflog_program
1026 .Pa /sbin/pflogd ) .
1030 This variable contains additional flags passed to the
1033 .It Va pflog_instances
1035 If logging to more than one
1037 interface is desired,
1039 is set to the list of
1041 instances that should be started at system boot time.
1044 is set, for each whitespace-separated
1047 .Ao Ar element Ac Ns Va _dev
1049 .Ao Ar element Ac Ns Va _logfile
1050 elements are assumed to exist.
1051 .Ao Ar element Ac Ns Va _dev
1054 interface to be watched by the named
1057 .Ao Ar element Ac Ns Va _logfile
1058 must contain the name of the logfile that will be used by the
1061 .It Va ftpproxy_enable
1072 packet filter in translating ftp connections.
1073 .It Va ftpproxy_flags
1076 This variable contains additional flags passed to the
1079 .It Va ftpproxy_instances
1082 If multiple instances of
1084 are desired at boot time,
1085 .Va ftpproxy_instances
1086 should contain a whitespace-separated list of instance names.
1089 in the list, a variable named
1090 .Ao Ar element Ac Ns Va _flags
1091 should be defined, containing the command-line flags to be passed to the
1094 .It Va pfsync_enable
1103 state changes to other hosts over the network by means of
1108 must also be set then.
1109 .It Va pfsync_syncdev
1112 This variable specifies the name of the network interface
1114 should operate through.
1115 It must be set accordingly if
1119 .It Va pfsync_syncpeer
1122 This variable is optional.
1123 By default, state change messages are sent out on the synchronisation
1124 interface using IP multicast packets.
1125 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1127 When a peer address is specified using the
1129 option, the peer address is used as a destination for the pfsync
1130 traffic, and the traffic can then be protected using
1134 manpage for more details about using
1139 .It Va pfsync_ifconfig
1142 This variable can contain additional options to be passed to the
1144 command used to set up
1146 .It Va tcp_extensions
1153 disables certain TCP options as described by
1159 might help remedy such problems with connections as randomly hanging
1160 or other weird behavior.
1161 Some network devices are known
1162 to be broken with respect to these options.
1165 Set to 0 by default.
1169 .Va net.inet.tcp.log_in_vain
1171 .Va net.inet.udp.log_in_vain ,
1176 are set to the given value.
1177 .It Va tcp_keepalive
1184 will disable probing idle TCP connections to verify that the
1185 peer is still up and reachable.
1186 .It Va tcp_drop_synfin
1193 will cause the kernel to ignore TCP frames that have both
1194 the SYN and FIN flags set.
1195 This prevents OS fingerprinting, but may
1196 break some legitimate applications.
1197 .It Va icmp_drop_redirect
1202 This setting will be identical to
1204 if a dynamicrouting daemon is enabled, because redirect processing may
1205 cause performance issues for large routing tables.
1206 If no such service is enabled, this setting behaves like a
1210 will cause the kernel to ignore ICMP REDIRECT packets.
1213 will cause the kernel to process ICMP REDIRECT packets.
1216 for more information.
1217 .It Va icmp_log_redirect
1224 will cause the kernel to log ICMP REDIRECT packets.
1226 the log messages are not rate-limited, so this option should only be used
1227 for troubleshooting networks.
1230 for more information.
1231 .It Va icmp_bmcastecho
1235 to respond to broadcast or multicast ICMP ping packets.
1238 for more information.
1239 .It Va ip_portrange_first
1243 this is the first port in the default portrange.
1246 for more information.
1247 .It Va ip_portrange_last
1251 this is the last port in the default portrange.
1254 for more information.
1255 .It Va network_interfaces
1257 Set to the list of network interfaces to configure on this host or
1259 (the default) for all current interfaces.
1261 .Va network_interfaces
1262 variable to anything other than the default is deprecated.
1263 Interfaces that the administrator wishes to store configuration for,
1264 but not start at boot should be configured with the
1267 .Va ifconfig_ Ns Aq Ar interface
1268 variables as described below.
1271 .Va ifconfig_ Ns Aq Ar interface
1272 variable is also assumed to exist for each value of
1274 When an interface name contains any of the characters
1276 they are translated to
1279 The variable can contain arguments to
1281 as well as special case-insensitive keywords described below.
1282 Such keywords are removed before passing the value to
1284 while the order of the other arguments is preserved.
1286 It is possible to add IP alias entries using
1288 syntax with the address family keyword such as
1290 Assuming that the interface in question was
1292 it might look something like this:
1294 ifconfig_em0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1295 ifconfig_em0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1298 It also possible to configure multiple IP addresses in Classless
1299 Inter-Domain Routing
1302 whose each address component can be a range like
1303 .Li inet 192.0.2.5-23/24
1305 .Li inet6 2001:db8:1-f::1/64 .
1306 This notation allows address and prefix length part only,
1307 not the other address modifiers.
1308 Note that the maximum number of the generated addresses from a range
1309 specification is limited to an integer value specified in
1310 .Va netif_ipexpand_max
1313 because a small typo can unexpectedly generate a large number of addresses.
1314 The default value is
1316 It can be increased by adding the following line into
1319 netif_ipexpand_max="4096"
1323 .Li 192.0.2.5-23/24 ,
1324 the address 192.0.2.5 will be configured with the
1325 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1326 the non-conflicting netmask /32 as explained in the
1329 Note that this special netmask handling is only for
1331 not for the other address families such as
1334 With the interface in question being
1336 an example could look like:
1338 ifconfig_em0_alias2="inet 192.0.2.129/27"
1339 ifconfig_em0_alias3="inet 192.0.2.1-5/28"
1344 Note that deprecated
1345 .Va ipv4_addrs_ Ns Aq Ar interface
1346 variable was supported for IPv4 CIDR address notation.
1348 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1349 variable replaces it, though
1350 .Va ipv4_addrs_ Ns Aq Ar interface
1351 is still supported for backward compatibility.
1354 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1355 entry with an address family keyword,
1356 its contents are passed to
1358 Execution stops at the first unsuccessful access, so if
1359 something like this is present:
1361 ifconfig_em0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1362 ifconfig_em0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1363 ifconfig_em0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1364 ifconfig_em0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1367 Then note that alias4 would
1369 be added since the search would
1370 stop with the missing
1373 Because of this difficult to manage behavior,
1375 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1376 variable, which has the same functionality as
1377 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1378 and can have all of entries in a variable like the following:
1380 ifconfig_em0_aliases="\\
1381 inet 127.0.0.251 netmask 0xffffffff \\
1382 inet 127.0.0.252 netmask 0xffffffff \\
1383 inet 127.0.0.253 netmask 0xffffffff \\
1384 inet 127.0.0.254 netmask 0xffffffff"
1387 It also supports CIDR notation.
1390 .Pa /etc/start_if. Ns Aq Ar interface
1391 file is present, it is read and executed by the
1394 before configuring the interface as specified in the
1395 .Va ifconfig_ Ns Aq Ar interface
1397 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1401 .Va vlans_ Ns Aq Ar interface
1405 interface will be created for each item in the list with the
1409 If a vlan interface's name is a number,
1410 then that number is used as the vlan tag and the new vlan interface is
1412 .Ar interface . Ns Ar tag .
1414 the vlan tag must be specified via a
1417 .Va create_args_ Ns Aq Ar interface
1420 To create a vlan device named
1424 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1427 ifconfig_em0_101="inet 192.0.2.1/24"
1430 To create a vlan device named
1434 with the vlan tag 102:
1437 create_args_myvlan="vlan 102"
1441 .Va wlans_ Ns Aq Ar interface
1445 interface will be created for each item in the list with the
1449 Further wlan cloning arguments may be passed to the
1452 command by setting the
1453 .Va create_args_ Ns Aq Ar interface
1457 devices must be created for each wireless devices as of
1463 may be specified with an
1464 .Va wlandebug_ Ns Aq Ar interface
1466 The contents of this variable will be passed directly to
1470 .Va ifconfig_ Ns Aq Ar interface
1471 contains the keyword
1473 then the interface will not be configured
1475 .Pa /etc/pccard_ether
1477 .Va network_interfaces
1481 It is possible to bring up an interface with DHCP by adding
1484 .Va ifconfig_ Ns Aq Ar interface
1486 For instance, to initialize the
1489 it is possible to use something like:
1494 If you want to configure your wireless interface with
1495 .Xr wpa_supplicant 8
1496 for use with WPA, EAP/LEAP or WEP, you need to add
1499 .Va ifconfig_ Ns Aq Ar interface
1502 On the other hand, if you want to configure your wireless interface with
1507 .Va ifconfig_ Ns Aq Ar interface
1510 will use the settings from
1511 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1513 Finally, you can add
1515 options in this variable, in addition to the
1516 .Pa /etc/start_if. Ns Aq Ar interface
1518 For instance, to configure an
1520 wireless device in station mode with an address obtained
1521 via DHCP, using WPA authentication and 802.11b mode, it is
1522 possible to use something like:
1525 ifconfig_wlan0="DHCP WPA mode 11b"
1529 .Va ifconfig_ Ns Aq Ar interface
1530 form, a fallback variable
1531 .Va ifconfig_DEFAULT
1533 It will be used for all interfaces with no
1534 .Va ifconfig_ Ns Aq Ar interface
1536 This is intended to replace the no longer supported
1540 It is also possible to rename an interface by doing:
1542 ifconfig_em0_name="net0"
1543 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1547 This variable is deprecated.
1549 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1551 .Va ipv6_activate_all_interfaces
1556 .Dq Li inet6 accept_rtadv
1558 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1560 .Va ipv6_activate_all_interfaces
1565 This variable is deprecated.
1567 .Va ip6addrctl_policy
1572 the default address selection policy table set by
1574 will be IPv6-preferred.
1578 the default address selection policy table set by
1580 will be IPv4-preferred.
1581 .It Va ipv6_activate_all_interfaces
1583 This controls initial configuration on IPv6-capable
1584 interfaces with no corresponding
1585 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1587 Note that it is not always necessary to set this variable to
1589 to use IPv6 functionality on
1591 In most cases, just configuring
1592 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1597 all interfaces which do not have a corresponding
1598 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1599 variable will be marked as
1602 This means that all of IPv6 functionality on that interface
1603 is completely disabled to enforce a security policy.
1604 If the variable is set to
1606 the flag will be cleared on all of the interfaces.
1608 In most cases, just defining an
1609 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1610 for an IPv6-capable interface should be sufficient.
1611 However, if an interface is added dynamically
1612 .Pq by some tunneling protocols such as PPP, for example ,
1613 it is often difficult to define the variable in advance.
1614 In such a case, configuring the
1616 flag can be disabled by setting this variable to
1619 For more details of the
1622 .Dq Li inet6 ifdisabled ,
1632 privacy addresses will be generated for each IPv6
1633 interface as described in RFC 4941.
1634 .It Va ipv6_network_interfaces
1636 This is the IPv6 equivalent of
1637 .Va network_interfaces .
1638 Normally manual configuration of this variable is not needed.
1639 .It Va ipv6_cpe_wanif
1641 If the variable is set to an interface name,
1645 .Dq inet6 -no_radr accept_rtadv
1646 will be added to the specified interface automatically before evaluating
1647 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1651 .Va net.inet6.ip6.rfc6204w3
1653 .Va net.inet6.ip6.no_radr
1656 This means the specified interface will accept ICMPv6 Router
1657 Advertisement messages on that link and add the discovered
1658 routers into the Default Router List.
1659 While the other interfaces can still accept RA messages if the
1660 .Dq inet6 accept_rtadv
1661 option is specified, adding
1662 routes into the Default Router List will be disabled by
1669 Note that ICMPv6 Router Advertisement messages will be
1671 .Va net.inet6.ip6.forwarding
1673 .Pq packet forwarding is enabled
1675 .Va net.inet6.ip6.rfc6204w3
1680 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1682 This assigns arbitrary description to an interface.
1686 .Va net.ifdescr_maxlen
1688 This static setting may be overridden by commands
1689 started with dynamic interface configuration utilities
1693 The description can be seen with
1695 command and it may be exported with
1697 daemon using its MIB-2 module.
1698 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1700 IPv6 functionality on an interface should be configured by
1701 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1702 instead of setting ifconfig parameters in
1703 .Va ifconfig_ Ns Aq Ar interface .
1704 If this variable is empty, all of IPv6 configurations on the
1705 specified interface by other variables such as
1706 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1709 Aliases should be set by
1710 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1716 ifconfig_em0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1717 ifconfig_em0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1720 Interfaces that have an
1721 .Dq Li inet6 accept_rtadv
1723 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1724 setting will be automatically configured by SLAAC
1725 .Pq StateLess Address AutoConfiguration
1731 Note that a link-local address will be automatically configured in
1732 addition to the configured global-scope addresses because the IPv6
1733 specifications require it on each link.
1734 The address is calculated from the MAC address by using an algorithm
1741 If only a link-local address is needed on the interface,
1742 the following configuration can be used:
1744 ifconfig_em0_ipv6="inet6 auto_linklocal"
1747 A link-local address can also be configured manually.
1748 This is useful for the default router address of an IPv6 router
1749 so that it does not change when the network interface
1753 ifconfig_em0_ipv6="inet6 fe80::1 prefixlen 64"
1755 .It Va ipv6_prefix_ Ns Aq Ar interface
1757 If one or more prefixes are defined in
1758 .Va ipv6_prefix_ Ns Aq Ar interface
1759 addresses based on each prefix and the EUI-64 interface index will be
1760 configured on that interface.
1761 Note that this variable will be ignored when
1762 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1765 For example, the following configuration
1767 ipv6_prefix_em0="2001:db8:1:0 2001:db8:2:0"
1770 is equivalent to the following:
1772 ifconfig_em0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1773 ifconfig_em0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1774 ifconfig_em0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1775 ifconfig_em0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1778 These Subnet-Router anycast addresses will be added only when
1779 .Va ipv6_gateway_enable
1781 .It Va ipv6_default_interface
1785 this is the default output interface for scoped addresses.
1786 This works only with ipv6_gateway_enable="NO".
1787 .It Va ip6addrctl_enable
1789 This variable is to enable configuring default address selection policy table
1791 The table can be specified in another variable
1792 .Va ip6addrctl_policy .
1794 .Va ip6addrctl_policy
1795 the following keywords can be specified:
1796 .Dq Li ipv4_prefer ,
1797 .Dq Li ipv6_prefer ,
1807 installs a pre-defined policy table described in Section 10.3
1815 is specified, it attempts to read a file
1816 .Pa /etc/ip6addrctl.conf
1818 If this file is found,
1820 reads and installs it.
1821 If not found, a policy is automatically set
1823 .Va ipv6_activate_all_interfaces
1824 variable; if the variable is set to
1826 the IPv6-preferred one is used.
1827 Otherwise IPv4-preferred.
1829 The default value of
1830 .Va ip6addrctl_enable
1832 .Va ip6addrctl_policy
1838 .It Va cloned_interfaces
1840 Set to the list of clonable network interfaces to create on this host.
1841 Further cloning arguments may be passed to the
1844 command for each interface by setting the
1845 .Va create_args_ Ns Aq Ar interface
1847 If an interface name is specified with
1850 the interface will not be destroyed even when
1852 script is invoked with
1855 This is useful when reconfiguring the interface without destroying it.
1857 .Va cloned_interfaces
1858 are automatically appended to
1859 .Va network_interfaces
1861 .It Va cloned_interfaces_sticky
1863 This variable is to globally enable functionality of
1866 .Va cloned_interfaces
1868 The default value is
1870 Even if this variable is specified to
1873 keyword can be used to override it on per interface basis.
1874 .It Va gif_interfaces
1877 tunnel interfaces to configure on this host.
1879 .Va gifconfig_ Ns Aq Ar interface
1880 variable is assumed to exist for each value of
1882 The value of this variable is used to configure the link layer of the
1887 Additionally, this option ensures that each listed interface is created
1892 before attempting to configure it.
1894 For example, configure two
1898 gif_interfaces="gif0 gif1"
1899 gifconfig_gif0="100.64.0.1 100.64.0.2"
1900 ifconfig_gif0="inet 10.0.0.1 10.0.0.2 netmask 255.255.255.252"
1901 gifconfig_gif1="inet6 2a00::1 2a01::1"
1902 ifconfig_gif1="inet 10.1.0.1 10.1.0.2 netmask 255.255.255.252"
1904 .It Va sppp_interfaces
1908 interfaces to configure on this host.
1910 .Va spppconfig_ Ns Aq Ar interface
1911 variable is assumed to exist for each value of
1913 Each interface should also be configured by a general
1914 .Va ifconfig_ Ns Aq Ar interface
1918 for more information about available options.
1928 The name of the profile to use from
1929 .Pa /etc/ppp/ppp.conf .
1930 Also used for per-profile overrides of
1935 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1936 When the profile name contains any of the characters
1938 they are translated to
1940 for the proposes of the override variable names.
1943 Mode in which to run the
1946 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1948 Overrides the global
1958 See the manual for a full description.
1963 enables network address translation.
1964 Used in conjunction with
1966 allows hosts on private network addresses access to the Internet using
1967 this host as a network address translating router.
1970 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1972 Overrides the global
1976 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1978 Set the unit number to be used for this profile.
1979 See the manual description of
1984 The name of the user under which
1992 .It Va rc_conf_files
1994 This option is used to specify a list of files that will override
1996 .Pa /etc/defaults/rc.conf .
1997 The files will be read in the order in which they are specified and should
1998 include the full path to the file.
1999 By default, the files specified are
2002 .Pa /etc/rc.conf.local
2008 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
2010 .It Va gptboot_enable
2014 .Pa /etc/rc.d/gptboot
2015 will log if the system successfully (or not) booted from a GPT partition,
2021 .It Va gbde_autoattach_all
2026 will attempt to automatically initialize your .bde devices in
2030 List the devices that the script should try to attach,
2035 The directory where the
2037 lockfiles are located.
2038 The default lockfile directory is
2041 The lockfile for each individual
2043 device can be overridden by setting the variable
2044 .Va gbde_lock_ Ns Aq Ar device ,
2047 is the encrypted device without the
2052 .It Va gbde_attach_attempts
2054 Number of times to attempt attaching to a
2056 device, i.e., how many times the user is asked for the pass-phrase.
2060 List of devices to automatically attach on boot.
2061 Note that .eli devices from
2063 are automatically appended to this list.
2066 List of groups containing devices to automatically attach on boot with the same
2067 keyfiles and passphrase.
2068 This must be accompanied with a corresponding
2069 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2073 Number of times user is asked for the pass-phrase.
2074 If empty, it will be taken from
2075 .Va kern.geom.eli.tries
2077 .It Va geli_default_flags
2079 Default flags to use by
2081 when configuring disk encryption.
2082 Flags can be configured for every device separately by defining the
2083 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2084 variable, and for every group separately by defining the
2085 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2087 .It Va geli_autodetach
2089 Specifies if GELI devices should be marked for detach on last close after
2090 file systems are mounted.
2093 This can be changed for every device separately by defining the
2094 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2096 .It Va root_rw_mount
2101 After the file systems are checked at boot time, the root file system
2102 is remounted as read-write if this is set to
2104 Diskless systems that mount their root file system from a read-only remote
2105 NFS share should set this to
2109 .It Va fsck_y_enable
2114 will be run with the
2116 flag if the initial preen
2117 of the file systems fails.
2118 .It Va background_fsck
2122 the system will not attempt to run
2124 in the background where possible.
2125 .It Va background_fsck_delay
2127 The amount of time in seconds to sleep before starting a background
2129 It defaults to sixty seconds to allow large applications such as
2130 the X server to start before disk I/O bandwidth is monopolized by
2132 If set to a negative number, the background file system check will be
2133 delayed indefinitely to allow the administrator to run it at a more
2135 For example it may be run from
2137 by adding a line like
2139 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2145 List of file system types that are network-based.
2146 This list should generally not be modified by end users.
2148 .Va extra_netfs_types
2150 .It Va extra_netfs_types
2152 If set to something other than
2155 this variable extends the list of file system types
2156 for which automatic mounting at startup by
2158 should be delayed until the network is initialized.
2160 a whitespace-separated list of network file system descriptor pairs,
2161 each consisting of a file system type as passed to
2163 and a human-readable, one-word description,
2166 Extending the default list in this way is only necessary
2167 when third party file system types are used.
2168 .It Va syslogd_enable
2175 .It Va syslogd_program
2180 .Pa /usr/sbin/syslogd ) .
2181 .It Va syslogd_flags
2187 these are the flags to pass to
2196 .It Va inetd_program
2201 .Pa /usr/sbin/inetd ) .
2208 these are the flags to pass to
2217 .It Va hastd_program
2229 these are the flags to pass to
2231 .It Va local_unbound_enable
2237 daemon as a local caching resolver.
2242 to start a Kerberos 5 authentication server
2250 this is the path to Kerberos 5 Authentication Server.
2254 This variable contains additional flags to be passed to the Kerberos 5
2255 authentication server.
2256 .It Va kadmind_enable
2262 the Kerberos 5 Administration Daemon; set to
2265 .It Va kadmind_program
2271 this is the path to Kerberos 5 Administration Daemon.
2272 .It Va kpasswdd_enable
2278 the Kerberos 5 Password-Changing Daemon; set to
2281 .It Va kpasswdd_program
2287 this is the path to Kerberos 5 Password-Changing Daemon.
2294 the Kerberos 5 ticket forwarding daemon, at the boot time.
2300 .Pa /usr/libexec/kfd ) .
2307 daemon at boot time.
2314 these are the flags to pass to it.
2321 daemon at boot time.
2328 these are the flags to pass to it.
2331 manpage for more information.
2332 .It Va amd_map_program
2335 the specified program is run to get the list of
2340 maps are stored in NIS, one can set this to
2353 will be updated at boot time to reflect the kernel release
2358 will not be updated.
2359 .It Va nfs_client_enable
2363 run the NFS client daemons at boot time.
2364 .It Va nfs_access_cache
2367 .Va nfs_client_enable
2372 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2374 results should be cached.
2375 A value of 2-10 seconds will substantially reduce network
2376 traffic for many NFS operations.
2377 .It Va nfs_server_enable
2381 run the NFS server daemons at boot time.
2382 .It Va nfs_server_flags
2385 .Va nfs_server_enable
2388 these are the flags to pass to the
2391 .It Va nfsv4_server_enable
2394 .Va nfs_server_enable
2398 .Va nfsv4_server_enable
2401 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2402 .It Va nfsuserd_enable
2408 run the nfsuserd daemon, which is needed for NFSv4 in order
2409 to map between user/group names vs uid/gid numbers.
2411 .Va nfsv4_server_enable
2414 this will be forced enabled.
2415 .It Va nfsuserd_flags
2421 these are the flags to pass to the
2424 .It Va nfscbd_enable
2430 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2437 these are the flags to pass to the
2440 .It Va mountd_enable
2445 .Va nfs_server_enable
2451 It is commonly needed to run CFS without real NFS used.
2458 these are the flags to pass to the
2461 .It Va weak_mountd_authentication
2465 allow services like PCNFSD to make non-privileged mount
2467 .It Va nfs_reserved_port_only
2471 provide NFS services only on a secure port.
2472 .It Va nfs_bufpackets
2474 If set to a number, indicates the number of packets worth of
2475 socket buffer space to reserve on an NFS client.
2476 The kernel default is typically 4.
2477 Using a higher number may be
2478 useful on gigabit networks to improve performance.
2479 The minimum value is
2480 2 and the maximum is 64.
2481 .It Va rpc_lockd_enable
2485 and also an NFS server or client, run
2488 .It Va rpc_lockd_flags
2491 .Va rpc_lockd_enable
2494 these are the flags to pass to the
2497 .It Va rpc_statd_enable
2501 and also an NFS server or client, run
2504 .It Va rpc_statd_flags
2507 .Va rpc_statd_enable
2510 these are the flags to pass to the
2513 .It Va rpcbind_program
2518 .Pa /usr/sbin/rpcbind ) .
2519 .It Va rpcbind_enable
2525 service at boot time.
2526 .It Va rpcbind_flags
2532 these are the flags to pass to the
2535 .It Va keyserv_enable
2541 daemon on boot for running Secure RPC.
2542 .It Va keyserv_flags
2548 these are the flags to pass to
2551 .It Va pppoed_enable
2557 daemon at boot time to provide PPP over Ethernet services.
2558 .It Va pppoed_ Ns Aq Ar provider
2561 listens to requests to this
2567 argument of the same name.
2570 Additional flags to pass to
2572 .It Va pppoed_interface
2574 The network interface to run
2577 This is mandatory when
2587 service at boot time.
2588 This command is intended for networks of
2589 machines where a consistent
2591 for all hosts must be established.
2592 This is often useful in large NFS
2593 environments where time stamps on files are expected to be consistent
2601 these are the flags to pass to the
2604 .It Va ntpdate_enable
2611 This command is intended to
2612 synchronize the system clock only
2614 from some standard reference.
2616 Note that the use of the
2617 .Va ntpd_sync_on_start
2618 variable is a preferred alternative to the
2622 is to be retired from the NTP distribution.
2623 .It Va ntpdate_config
2625 Configuration file for
2629 .It Va ntpdate_hosts
2631 A whitespace-separated list of NTP servers to synchronize with at startup.
2632 The default is to use the servers listed in
2633 .Va ntpdate_config ,
2634 if that file exists.
2635 .It Va ntpdate_program
2640 .Pa /usr/sbin/ntpdate ) .
2641 .It Va ntpdate_flags
2647 these are the flags to pass to the
2649 command (typically a hostname).
2656 command at boot time.
2662 .Pa /usr/sbin/ntpd ) .
2676 these are the flags to pass to the
2679 .It Va ntpd_sync_on_start
2686 flag, which syncs the system's clock on startup.
2689 for more information regarding the
2692 This is a preferred alternative to using
2697 .It Va nis_client_enable
2703 service at system boot time.
2704 .It Va nis_client_flags
2707 .Va nis_client_enable
2710 these are the flags to pass to the
2713 .It Va nis_ypldap_enable
2719 daemon at system boot time.
2720 .It Va nis_ypldap_flags
2723 .Va nis.ypldap_enable
2726 these are the flags to pass to the
2729 .It Va nis_ypset_enable
2735 daemon at system boot time.
2736 .It Va nis_ypset_flags
2739 .Va nis_ypset_enable
2742 these are the flags to pass to the
2745 .It Va nis_server_enable
2751 daemon at system boot time.
2752 .It Va nis_server_flags
2755 .Va nis_server_enable
2758 these are the flags to pass to the
2761 .It Va nis_ypxfrd_enable
2767 daemon at system boot time.
2768 .It Va nis_ypxfrd_flags
2771 .Va nis_ypxfrd_enable
2774 these are the flags to pass to the
2777 .It Va nis_yppasswdd_enable
2783 daemon at system boot time.
2784 .It Va nis_yppasswdd_flags
2787 .Va nis_yppasswdd_enable
2790 these are the flags to pass to the
2793 .It Va rpc_ypupdated_enable
2799 daemon at system boot time.
2800 .It Va bsnmpd_enable
2806 daemon at system boot time.
2807 Be sure to understand the security implications of running SNMP daemon
2815 these are the flags to pass to the
2818 .It Va defaultrouter
2822 create a default route to this host name or IP address
2823 (use an IP address if this router is also required to get to the
2825 .It Va ipv6_defaultrouter
2827 The IPv6 equivalent of
2829 .It Va static_arp_pairs
2831 Set to the list of static ARP pairs that are to be added at system
2833 For each whitespace separated
2836 .Va static_arp_ Ns Aq Ar element
2837 variable is assumed to exist whose contents will later be passed to a
2842 static_arp_pairs="gw"
2843 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2845 .It Va static_ndp_pairs
2847 Set to the list of static NDP pairs that are to be added at system
2849 For each whitespace separated
2852 .Va static_ndp_ Ns Aq Ar element
2853 variable is assumed to exist whose contents will later be passed to a
2858 static_ndp_pairs="gw"
2859 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2861 .It Va static_routes
2863 Set to the list of static routes that are to be added at system
2867 then for each whitespace separated
2870 .Va route_ Ns Aq Ar element
2871 variable is assumed to exist
2872 whose contents will later be passed to a
2877 static_routes="ext mcast:gif0 gif0local:gif0"
2878 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2879 route_mcast="-net 224.0.0.0/4 -iface gif0"
2880 route_gif0local="-host 169.254.1.1 -iface lo0"
2887 the route is specific to the interface
2889 .It Va ipv6_static_routes
2891 The IPv6 equivalent of
2895 then for each whitespace separated
2898 .Va ipv6_route_ Ns Aq Ar element
2899 variable is assumed to exist
2900 whose contents will later be passed to a
2901 .Dq Nm route Cm add Fl inet6
2903 .It Va gateway_enable
2907 configure host to act as an IP router, e.g.\& to forward packets
2909 .It Va ipv6_gateway_enable
2911 The IPv6 equivalent of
2912 .Va gateway_enable .
2913 .It Va routed_enable
2917 run a routing daemon of some sort, based on the
2922 .It Va route6d_enable
2924 The IPv6 equivalent of
2928 run a routing daemon of some sort, based on the
2933 .It Va routed_program
2939 this is the name of the routing daemon to use.
2940 .It Va route6d_program
2942 The IPv6 equivalent of
2943 .Va routed_program .
2950 these are the flags to pass to the routing daemon.
2951 .It Va route6d_flags
2953 The IPv6 equivalent of
2955 .It Va rtadvd_enable
2961 daemon at boot time.
2964 utility sends ICMPv6 Router Advertisement messages to
2965 the interfaces specified in
2966 .Va rtadvd_interfaces .
2967 This should only be enabled with great care.
2968 You may want to fine-tune
2970 .It Va rtadvd_interfaces
2976 this is the list of interfaces to use.
2981 enable global proxy ARP.
2982 .It Va forward_sourceroute
2990 source-routed packets are forwarded.
2991 .It Va accept_sourceroute
2995 the system will accept source-routed packets directed at it.
3002 daemon at system boot time.
3009 these are the flags to pass to the
3012 .It Va bootparamd_enable
3018 daemon at system boot time.
3019 .It Va bootparamd_flags
3022 .Va bootparamd_enable
3025 these are the flags to pass to the
3028 .It Va stf_interface_ipv4addr
3032 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
3034 Specify this entry to enable the 6to4 interface.
3035 .It Va stf_interface_ipv4plen
3037 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
3038 An effective value is 0-31.
3039 .It Va stf_interface_ipv6_ifid
3041 IPv6 interface ID for
3045 .It Va stf_interface_ipv6_slaid
3047 IPv6 Site Level Aggregator for
3049 .It Va ipv6_ipv4mapping
3053 this enables IPv4 mapped IPv6 address communication (like
3054 .Li ::ffff:a.b.c.d ) .
3055 .It Va rtsold_enable
3061 daemon to send ICMPv6 Router Solicitation messages.
3068 these are the flags to pass to
3072 For interfaces configured with the
3073 .Dq Li inet6 accept_rtadv
3074 keyword, these are the flags to pass to
3079 is mutually exclusive to
3085 The keyboard bell sound.
3092 if the default behavior is desired.
3093 For details, refer to the
3098 If set to a non-null string, the virtual console's keyboard input is
3104 no keymap is installed, otherwise the value is used to install
3105 the keymap file found in
3106 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3109 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3114 The keyboard repeat speed.
3121 if the default behavior is desired.
3126 attempt to program the function keys with the value.
3128 be a single string of the form:
3129 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3132 Can be set to the value of
3135 .Dq Li destructive ,
3138 to set the cursor behavior explicitly or choose the default behavior.
3143 no screen map is installed, otherwise the value is used to install
3144 the screen map file in
3145 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3146 This parameter is ignored when using
3148 as the console driver.
3153 the default 8x16 font value is used for screen size requests, otherwise
3155 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3157 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3158 is used (depending on the console driver being used).
3163 the default 8x14 font value is used for screen size requests, otherwise
3165 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3167 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3168 is used (depending on the console driver being used).
3173 the default 8x8 font value is used for screen size requests, otherwise
3175 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3177 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3178 is used (depending on the console driver being used).
3183 the default screen blanking interval is used, otherwise it is set
3191 this is the actual screen saver to use
3192 .Li ( blank , snake , daemon ,
3194 .It Va moused_nondefault_enable
3198 the mouse device specified on
3199 the command line is not automatically treated as enabled by the
3200 .Pa /etc/rc.d/moused
3202 Having this variable set to
3208 to be enabled as soon as it is plugged in.
3209 .It Va moused_enable
3215 daemon is started for doing cut/paste selection on the console.
3218 This is the protocol type of the mouse connected to this host.
3219 This variable must be set if
3226 is able to detect the appropriate mouse type automatically in many cases.
3227 Set this variable to
3229 to let the daemon detect it, or
3230 select one from the following list if the automatic detection fails.
3232 If the mouse is attached to the PS/2 mouse port, choose
3236 regardless of the brand and model of the mouse.
3238 mouse is attached to the bus mouse port, choose
3242 All other protocols are for serial mice and will not work with
3243 the PS/2 and bus mice.
3244 If this is a USB mouse,
3246 is the only protocol type which will work.
3248 .Bl -tag -width ".Li x10mouseremote" -compact
3250 Microsoft mouse (serial)
3252 Microsoft IntelliMouse (serial)
3254 Mouse systems Corp.\& mouse (serial)
3256 MM Series mouse (serial)
3258 Logitech mouse (serial)
3262 Logitech MouseMan and TrackMan (serial)
3264 ALPS GlidePoint (serial)
3265 .It Li thinkingmouse
3266 Kensington ThinkingMouse (serial)
3270 MM HitTablet (serial)
3271 .It Li x10mouseremote
3272 X10 MouseRemote (serial)
3274 Interlink VersaPad (serial)
3277 Even if the mouse is not in the above list, it may be compatible
3278 with one in the list.
3279 Refer to the manual page for
3281 for compatibility information.
3283 It should also be noted that while this is enabled, any
3284 other client of the mouse (such as an X server) should access
3285 the mouse through the virtual mouse device,
3287 and configure it as a
3289 type mouse, since all
3290 mouse data is converted to this single canonical format when
3293 If the client program does not support the
3299 It is the second preferred type.
3306 this is the actual port the mouse is on.
3309 for a COM1 serial mouse, or
3311 for a PS/2 mouse, for example.
3316 is set, its value is used as an additional set of flags to pass to the
3319 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3321 .Va moused_nondefault_enable
3324 daemon is started for a non-default port, the
3325 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3326 set of options has precedence over and replaces the default
3330 is the name of the non-default port, i.e.,\&
3333 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3334 it is possible to set up a different set of default flags for each
3337 For example, you can use
3341 to make your laptop's touchpad more comfortable to use,
3342 but an empty set of options for
3343 .Va moused_ums0_flags
3346 mouse has three or more buttons.
3347 .It Va mousechar_start
3351 the default mouse cursor character range
3352 .Li 0xd0 Ns - Ns Li 0xd3
3354 otherwise the range start is set
3359 Use if the default range is occupied in the language code table.
3360 .It Va allscreens_flags
3364 is run with these options for each of the virtual terminals
3368 will enable the mouse pointer on all virtual terminals
3373 .It Va allscreens_kbdflags
3377 is run with these options for each of the virtual terminals
3385 scrollback (history) buffer to 200 lines.
3392 daemon at system boot time.
3398 .Pa /usr/sbin/cron ) .
3405 these are the flags to pass to
3411 enable the special handling of transitions to and from the
3412 Daylight Saving Time in
3414 (equivalent to using the flag
3421 .Pa /usr/sbin/lpd ) .
3428 daemon at system boot time.
3435 these are the flags to pass to the
3438 .It Va chkprintcap_enable
3444 command before starting the
3447 .It Va chkprintcap_flags
3452 .Va chkprintcap_enable
3455 these are the flags to pass to the
3460 which causes missing directories to be created.
3461 .It Va mta_start_script
3463 This variable specifies the full path to the script to run to start
3464 a mail transfer agent.
3466 .Pa /etc/rc.sendmail .
3470 .Pa /etc/rc.sendmail
3471 uses are documented in the
3476 Indicates the device (usually a swap partition) to which a crash dump
3477 should be written in the event of a system crash.
3478 If the value of this variable is
3480 the first suitable swap device listed in
3482 will be used as dump device.
3483 Otherwise, the value of this variable is passed as the argument to
3487 To disable crash dumps, set this variable to
3495 as the system dump device.
3498 When the system reboots after a crash and a crash dump is found on the
3499 device specified by the
3503 will save that crash dump and a copy of the kernel to the directory
3507 The default value is
3516 .It Va savecore_enable
3520 disable automatic extraction of the crash dump from the
3522 .It Va savecore_flags
3524 If crash dumps are enabled, these are the flags to pass to the
3531 to turn on user and group disk quotas on system startup via the
3533 command for all file systems marked as having quotas enabled in
3535 The kernel must be built with
3537 for disk quotas to function.
3542 to enable user and group disk quota checking via the
3545 .It Va quotacheck_flags
3555 these are the flags to pass to the
3560 which checks quotas for all file systems with quotas enabled in
3562 .It Va quotaon_flags
3568 these are the flags to pass to the
3573 which enables quotas for all file systems with quotas enabled in
3575 .It Va quotaoff_flags
3581 these are the flags to pass to the
3583 utility when shutting down the quota system.
3586 which disables quotas for all file systems with quotas enabled in
3588 .It Va accounting_enable
3592 to enable system accounting through the
3595 .It Va firstboot_sentinel
3597 This variable specifies the full path to a
3600 If a file exists with this path,
3604 keyword will be run on startup and the sentinel file will be deleted
3605 after the boot process completes.
3606 The sentinel file must be located on a writable file system which is
3607 mounted no later than
3608 .Va early_late_divider
3609 to function properly.
3616 to enable Linux/ELF binary emulation at system initial
3618 .It Va sysvipc_enable
3622 load System V IPC primitives at boot time.
3623 .It Va clear_tmp_enable
3634 to disable removing of X11 lock files,
3635 and the removal and (secure) recreation
3636 of the various socket directories for X11
3638 .It Va ldconfig_paths
3640 Set to the list of shared library paths to use with
3646 will always be added first, so they need not appear in this list.
3647 .It Va ldconfig32_paths
3649 Set to the list of 32-bit compatibility shared library paths to
3652 .It Va ldconfig_insecure
3656 utility normally refuses to use directories
3657 which are writable by anyone except root.
3658 Set this variable to
3660 to disable that security check during system startup.
3661 .It Va ldconfig_local_dirs
3663 Set to the list of local
3666 The names of all files in the directories listed will be
3667 passed as arguments to
3669 .It Va ldconfig_local32_dirs
3671 Set to the list of local 32-bit compatibility
3674 The names of all files in the directories listed will be
3675 passed as arguments to
3676 .Dq Nm ldconfig Fl 32 .
3677 .It Va kern_securelevel_enable
3681 to set the kernel security level at system startup.
3682 .It Va kern_securelevel
3684 The kernel security level to set at startup.
3685 The allowed range of
3687 ranges from \-1 (the compile time default) to 3 (the
3691 for the list of possible security levels and their effect
3692 on system operation.
3695 Path to the SSH server program
3696 .Pa ( /usr/sbin/sshd
3704 at system boot time.
3711 these are the flags to pass to the
3716 Path to the FTP server program
3717 .Pa ( /usr/libexec/ftpd
3725 as a stand-alone daemon at system boot time.
3732 these are the additional flags to pass to the
3735 .It Va watchdogd_enable
3741 daemon at boot time.
3742 This requires that the kernel have been compiled with a
3745 .It Va watchdogd_flags
3748 .Va watchdogd_enable
3751 these are the flags passed to the
3754 .It Va watchdogd_timeout
3757 .Va watchdogd_enable
3760 this is a timeout that will be used by the
3763 If this option is set, it overrides
3766 .Va watchdogd_flags .
3767 .It Va watchdogd_shutdown_timeout
3770 .Va watchdogd_enable
3773 this is a timeout that will be set by the
3775 daemon when it exits during the system shutdown.
3776 This timeout will not be set when returning to the single-user mode
3777 or when the watchdogd service is stopped individually using the
3779 command or the rc.d script.
3780 Note that the timeout will be applied if
3782 is stopped outside of
3785 If this option is set, it overrides
3788 .Va watchdogd_flags .
3789 .It Va devfs_rulesets
3791 List of files containing sets of rules for
3793 .It Va devfs_system_ruleset
3795 Rule name(s) to apply to the system
3798 .It Va devfs_set_rulesets
3800 Pairs of already-mounted
3802 directories and rulesets that should be applied to them.
3803 For example: /mount/dev=ruleset_name
3804 .It Va devfs_load_rulesets
3806 If set, always load the default rulesets listed in
3807 .Va devfs_rulesets .
3808 .It Va performance_cx_lowest
3810 CPU idle state to use while on AC power.
3815 should use the lowest power state available while
3817 indicates that the lowest latency state (less power savings) should be used.
3818 .It Va performance_cpu_freq
3820 CPU clock frequency to use while on AC power.
3825 should use the lowest frequency available while
3827 indicates that the highest frequency (less power savings) should be used.
3828 .It Va economy_cx_lowest
3830 CPU idle state to use when off AC power.
3835 should use the lowest power state available while
3837 indicates that the lowest latency state (less power savings) should be used.
3838 .It Va economy_cpu_freq
3840 CPU clock frequency to use when off AC power.
3845 should use the lowest frequency available while
3847 indicates that the highest frequency (less power savings) should be used.
3852 any configured jails will not be started.
3855 The configuration filename used by
3858 The default value is
3859 .Pa /etc/jail.conf .
3860 .It Va jail_parallel_start
3864 all configured jails will be started in the background (in parallel).
3868 When set, use as default value for
3869 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3874 A space-delimited list of jail names.
3875 When left empty, all of the
3877 instances defined in the configuration file are started.
3878 The names specified in this list control the jail startup order.
3880 instances missing from
3882 must be started manually.
3885 parameter in the configuration file may override this list.
3886 .It Va jail_reverse_stop
3890 all configured jails in
3892 are stopped in reverse order.
3893 .It Va jail_ Ns * variables
3894 Note that older releases supported per-jail configuration via
3898 hostname of a jail named
3900 was able to be set by
3901 .Li jail_vjail_hostname .
3902 These per-jail configuration variables are now obsolete in favor of
3905 For backward compatibility,
3906 when per-jail configuration variables are defined,
3908 configuration files are created as
3909 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3912 The following per-jail parameters are handled by
3914 script out of their corresponding
3917 In addition to them, parameters in
3918 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3919 will be added to the configuration file.
3920 They must be a semi-colon
3928 .Bl -tag -width "host.hostname" -offset indent
3931 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3932 .It Li host.hostname
3934 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3935 .It Li exec.consolelog
3937 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3938 The default value is
3939 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3942 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3943 .It Li vnet.interface
3945 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3948 parameter will be enabled and cannot be specified with
3949 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3952 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3956 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3959 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3962 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3965 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3966 The parameter name was
3968 in some older releases.
3969 .It Li exec.prestart
3971 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3972 .It Li exec.poststart
3974 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3977 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3980 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3981 .It Li exec.poststop
3983 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3986 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3988 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3989 contain IPv4 addresses
3992 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3994 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3995 contain IPv6 addresses
3998 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4001 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4002 .It Li devfs_ruleset
4004 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
4005 This must be an integer,
4007 .It Li mount.fdescfs
4009 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4010 .It Li allow.set_hostname
4012 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4013 .It Li allow.rawsocket
4015 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4016 .It Li allow.sysvipc
4018 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4020 .\" -----------------------------------------------------
4024 representing the entropy sources
4025 you wish to harvest.
4028 for more information.
4033 to disable caching entropy via
4035 Otherwise set to the directory
4036 in which the entropy files are stored.
4040 that regularly writes and rotates
4043 will be used at boot time.
4045 .Pa /var/db/entropy .
4050 to disable caching entropy through reboots.
4051 Otherwise set to the name
4052 of a file used to store cached entropy.
4053 This file should be located
4054 on a file system that is readable
4055 before all the volumes specified in
4062 .Pa /var/db/entropy-file
4063 is found it will also be used.
4064 This will be of some use to
4066 .It Va entropy_boot_file
4071 very early caching entropy
4073 Otherwise set to the filename
4075 very early reboot cached entropy.
4076 This file should be located where
4081 The default location is
4083 .It Va entropy_save_sz
4085 Size of the entropy cache files saved by
4088 .It Va entropy_save_num
4090 Number of entropy cache files to save by
4104 Configuration file for
4113 .Pa /var/run/dmesg.boot
4115 .It Va rcshutdown_timeout
4117 If set, start a watchdog timer in the background which will terminate
4121 has not completed within the specified time (in seconds).
4122 Notice that in addition to this soft timeout,
4124 also applies a hard timeout for the execution of
4126 This is configured via
4129 .Va kern.init_shutdown_timeout
4130 and defaults to 120 seconds.
4131 Setting the value of
4132 .Va rcshutdown_timeout
4133 to more than 120 seconds will have no effect until the
4136 .Va kern.init_shutdown_timeout
4138 .It Va virecover_enable
4142 to prevent the system from trying to
4143 recover pre-maturely terminated
4146 .It Va ugidfw_enable
4151 .Xr mac_bsdextended 4
4152 module upon system initialization and load a default
4154 .It Va bsdextended_script
4157 .Xr mac_bsdextended 4
4158 ruleset file to load.
4159 The default value of this variable is
4160 .Pa /etc/rc.bsdextended .
4161 .It Va newsyslog_enable
4168 .It Va newsyslog_flags
4171 .Va newsyslog_enable
4174 these are the flags to pass to the
4179 which causes log files flagged with a
4182 .It Va mdconfig_md Ns Aq Ar X
4192 must be specified and either a
4194 for malloc or swap backed
4202 .Va mdconfig_md Ns Aq Ar X
4203 variables are evaluated until one variable is unset or null.
4204 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4206 Optional arguments passed to
4212 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4214 An ownership specification passed to
4223 device and the mount point will be changed.
4224 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4226 A mode string passed to
4235 device and the mount point will be changed.
4236 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4238 Files to be copied to the mount point of the
4242 after it has been mounted.
4243 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4245 Command to execute after the specified
4250 Note that the command is passed to
4256 variables can be used to reference respectively the
4258 device and the mount point.
4263 one could set the following:
4265 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4267 .It Va autobridge_interfaces
4269 Set to the list of bridge interfaces that will have newly arriving interfaces
4270 checked against to be automatically added.
4273 then for each whitespace separated
4276 .Va autobridge_ Ns Aq Ar element
4277 variable is assumed to exist which has a whitespace separated list of interface
4278 names to match, these names can use wildcards.
4281 autobridge_interfaces="bridge0"
4282 autobridge_bridge0="tap* dc0 vlan[345]"
4288 enable support for sound mixer.
4289 .It Va hcsecd_enable
4293 enable Bluetooth security daemon.
4294 .It Va hcsecd_config
4296 Configuration file for
4299 .Pa /etc/bluetooth/hcsecd.conf .
4304 enable Bluetooth Service Discovery Protocol daemon.
4312 .It Va sdpd_groupname
4316 group to run as after it initializes.
4319 .It Va sdpd_username
4323 user to run as after it initializes.
4326 .It Va bthidd_enable
4330 enable Bluetooth Human Interface Device daemon.
4331 .It Va bthidd_config
4333 Configuration file for
4336 .Pa /etc/bluetooth/bthidd.conf .
4339 Path to a file, where
4341 will store information about known HID devices.
4343 .Pa /var/db/bthidd.hids .
4344 .It Va rfcomm_pppd_server_enable
4348 enable Bluetooth RFCOMM PPP wrapper daemon.
4349 .It Va rfcomm_pppd_server_profile
4351 The name of the profile to use from
4352 .Pa /etc/ppp/ppp.conf .
4353 Multiple profiles can be specified here.
4354 Also used to specify per-profile overrides.
4355 When the profile name contains any of the characters
4357 they are translated to
4359 for the proposes of the override variable names.
4360 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4362 Overrides local address to listen on.
4368 The address can be specified as BD_ADDR or name.
4369 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4371 Overrides local RFCOMM channel to listen on.
4374 will listen on RFCOMM channel 1.
4375 Must set properly if multiple profiles used in the same time.
4376 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4380 if it should register Serial Port service on the specified RFCOMM channel.
4383 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4387 if it should register Dial-Up Networking service on the specified
4391 .It Va ubthidhci_enable
4395 change the USB Bluetooth controller from HID mode to HCI mode.
4396 You also need to specify the location of USB Bluetooth controller with the
4397 .Va ubthidhci_busnum
4401 .It Va ubthidhci_busnum
4402 Bus number where the USB Bluetooth controller is located.
4405 on your system to find this information.
4406 .It Va ubthidhci_addr
4407 Bus address of the USB Bluetooth controller.
4410 on your system to find this information.
4411 .It Va netwait_enable
4415 delays the start of network-reliant services until
4417 is up and ICMP packets to a destination defined in
4420 Link state is examined first, followed by
4422 an IP address to verify network usability.
4423 If no destination can be reached or timeouts are exceeded,
4424 network services are started anyway with no guarantee that
4425 the network is usable.
4426 Use of this variable requires both
4434 This variable contains a space-delimited list of IP addresses to
4436 DNS hostnames should not be used as resolution is not guaranteed
4437 to be functional at this point.
4438 If multiple IP addresses are specified,
4439 each will be tried until one is successful or the list is exhausted.
4440 .It Va netwait_timeout
4442 Indicates the total number of seconds to perform a
4444 against each IP address in
4446 at a rate of one ping per second.
4447 If any of the pings are successful,
4448 full network connectivity is considered reliable.
4453 Defines the name of the network interface on which watch for link.
4455 is used to monitor the interface, looking for
4456 .Dq Li status: no carrier .
4457 Once gone, the link is considered up.
4460 interface if desired.
4461 .It Va netwait_if_timeout
4463 Defines the total number of seconds to wait for link to become usable,
4464 polled at a 1-second interval.
4472 rules from the defined ruleset.
4473 The kernel must be built with
4476 .Cd "options RCTL" .
4482 This variables contains the
4488 A space-separated list of configuration files used by
4490 The default value is an empty string.
4491 .It Va autofs_enable
4501 daemons at boot time.
4502 .It Va automount_flags
4508 these are the flags to pass to the
4511 By default no flags are passed.
4512 .It Va automountd_flags
4518 these are the flags to pass to the
4521 By default no flags are passed.
4522 .It Va autounmountd_flags
4528 these are the flags to pass to the
4531 By default no flags are passed.
4538 daemon at boot time.
4539 .It Va iscsid_enable
4545 daemon at boot time.
4546 .It Va iscsictl_enable
4552 utility at boot time.
4553 .It Va iscsictl_flags
4559 these are the flags to pass to the
4564 which configures sessions based on the
4567 .It Va cfumass_enable
4571 create and export an USB LUN using
4576 The directory where the files exported by USB LUN are located.
4577 The default directory is
4579 .It Va service_delete_empty
4583 .Ql Li service delete
4587 .It Va zfs_bootonce_activate
4591 and a boot environment marked bootonce is successfully booted,
4592 it will be made permanently active.
4595 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4596 .It Pa /etc/defaults/rc.conf
4597 .It Pa /etc/defaults/vendor.conf
4599 .It Pa /etc/rc.conf.local
4629 .Xr newsyslog.conf 5 ,
4702 .An Jordan K. Hubbard .