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/rc.conf.local
63 is used to override settings in
65 for historical reasons.
67 The sysrc(8) command provides a scripting interface to modify system
71 .Pa /etc/rc.conf.local
72 you can also place smaller configuration files for each
77 .Ao Ar dir Ac Ns Pa /rc.conf.d
78 directories specified in
80 which will be included by the
83 For jail configurations you could use the file
84 .Pa /etc/rc.conf.d/jail
85 to store jail specific configuration options.
89 .Pa /usr/local/etc/rc.d
92 .Pa /usr/local/rc.conf.d/jail
94 .Pa /opt/conf/rc.conf.d/jail
97 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
99 all of files in the directory will be loaded.
105 .Dq Ar name Ns Li = Ns Ar value
109 The following list provides a name and short description for each
110 variable that can be set in the
113 .Bl -tag -width indent-two
118 enable output of debug messages from rc scripts.
119 This variable can be helpful in diagnosing mistakes when
120 editing or integrating new scripts.
121 Beware that this produces copious output to the terminal and
127 disable informational messages from the rc scripts.
128 Informational messages are displayed when
129 a condition that is not serious enough to warrant a warning or
137 when faststart is used (e.g., at boot time).
138 .It Va early_late_divider
140 The name of the script that should be used as the
141 delimiter between the
145 stages of the boot process.
146 The early stage should contain all the services needed to
147 get the disks (local or remote) mounted so that the late
148 stage can include scripts contained in the directories
151 variable (see below).
152 Thus, the two likely candidates for this value are
154 for the typical system, and
156 if the system needs remote file
157 systems mounted to get access to the
159 directories; for example when
167 is likely to be an appropriate value.
168 Extreme care should be taken when changing this value,
169 and before changing it one should ensure that there are
170 adequate provisions to recover from a failed boot
171 (such as physical contact with the machine,
172 or reliable remote console access).
173 .It Va always_force_depends
177 scripts use the force_depend function to check whether required
178 services are already running, and to start them if necessary.
179 By default during boot time this check is bypassed if the
180 required service is enabled in
181 .Pa /etc/rc.conf[.local] .
182 Setting this option will bypass that check at boot time and
183 always test whether or not the service is actually running.
184 Enabling this option is likely to increase your boot time if
185 services are enabled that utilize the force_depend check.
186 .It Ao Ar name Ac Ns Va _chroot
189 to this directory before running the service.
190 .It Ao Ar name Ac Ns Va _user
192 Run the service under this user account.
193 .It Ao Ar name Ac Ns Va _group
195 Run the chrooted service under this system group.
197 setting, this setting has no effect if the service is not chrooted.
198 .It Ao Ar name Ac Ns Va _fib
202 value to run the service under.
203 .It Ao Ar name Ac Ns Va _nice
207 value to run the service under.
212 enable support for Automatic Power Management with
220 to handle APM event from userland.
221 This also enables support for APM.
228 these are the flags to pass to the
235 to handle device added, removed or unknown events from the kernel.
242 scripts at boot time.
245 Configuration file for
251 A list of kernel modules to load right after the local
253 Loading modules at this point in the boot process is
254 much faster than doing it via
255 .Pa /boot/loader.conf
256 for those modules not necessary for mounting local disk.
257 .It Va kldxref_enable
264 to automatically rebuild
269 .It Va kldxref_clobber
279 will overwrite existing
286 .It Va kldxref_module_path
291 delimited list of paths containing
303 enable the system power control facility with the
312 these are the flags to pass to the
316 Controls the creation of a
319 Always happens if set to
321 and never happens if set to
323 If set to anything else, a memory file system is created if
327 Controls the size of a created
331 Extra options passed to the
333 utility when the memory file system for
338 which inhibits the use of softupdates on
340 so that file system space is freed without delay
341 after file truncation or deletion.
344 for other options you can use in
347 Controls the creation of a
350 Always happens if set to
352 and never happens if set to
354 If set to anything else, a memory file system is created if
358 Controls the size of a created
362 Extra options passed to the
364 utility when the memory file system for
369 which inhibits the use of softupdates on
371 so that file system space is freed without delay
372 after file truncation or deletion.
375 for other options you can use in
378 Controls the automatic population of the
381 Always happens if set to
383 and never happens if set to
385 If set to anything else, a memory file system is created if
388 Note that this process requires access to certain commands in
392 is mounted on normal systems.
393 .It Va cleanvar_enable
400 List of directories to search for startup script files.
401 .It Va script_name_sep
403 The field separator to use for breaking down the list of startup script files
404 into individual filenames.
405 The default is a space.
406 It is not necessary to change this unless there are startup scripts with names
408 .It Va hostapd_enable
417 The fully qualified domain name (FQDN) of this host on the network.
418 This should almost certainly be set to something meaningful, even if
419 there is no network connection.
422 is used to set the hostname via DHCP,
423 this variable should be set to an empty string.
426 the hostname is generally already set and this variable may absent.
427 If this value remains unset when the system is done booting
428 your console login will display the default hostname of
432 The NIS domain name of this host, or
435 .It Va dhclient_program
437 Path to the DHCP client program
438 .Pa ( /sbin/dhclient ,
443 .It Va dhclient_flags
445 Additional flags to pass to the DHCP client program.
450 manpage for a description of the command line options available.
451 .It Va dhclient_flags_ Ns Aq Ar iface
452 Additional flags to pass to the DHCP client program running on
455 When specified, this variable overrides
457 .It Va background_dhclient
461 to start the DHCP client in background.
462 This can cause trouble with applications depending on
463 a working network, but it will provide a faster startup
465 .It Va background_dhclient_ Ns Aq Ar iface
466 When specified, this variable overrides the
467 .Va background_dhclient
468 variable for interface
471 .It Va synchronous_dhclient
477 synchronously at startup.
478 This behavior can be overridden on a per-interface basis by replacing
482 .Va ifconfig_ Ns Aq Ar interface
487 .It Va defaultroute_delay
489 When set to a positive value, wait up to this long after configuring
490 DHCP interfaces at startup to give the interfaces time to receive a lease.
491 .It Va firewall_enable
495 to load firewall rules at startup.
496 If the kernel was not built with
497 .Cd "options IPFIREWALL" ,
500 kernel module will be loaded.
502 .Va ipfilter_enable .
503 .It Va firewall_script
505 This variable specifies the full path to the firewall script to run.
507 .Pa /etc/rc.firewall .
510 Names the firewall type from the selection in
511 .Pa /etc/rc.firewall ,
512 or the file which contains the local firewall ruleset.
513 Valid selections from
517 .Bl -tag -width ".Li simple" -compact
519 unrestricted IP access
521 all IP services disabled, except via
524 basic protection for a workstation
526 basic protection for a LAN.
529 If a filename is specified, the full path
531 .It Va firewall_quiet
535 to disable the display of firewall rules on the console during boot.
536 .It Va firewall_logging
540 to enable firewall event logging.
541 This is equivalent to the
542 .Dv IPFIREWALL_VERBOSE
544 .It Va firewall_logif
548 to create pseudo interface
551 For more details, see
554 .It Va firewall_flags
560 specifies a filename.
561 .It Va firewall_coscripts
563 List of executables and/or rc scripts to run after firewall starts/stops.
565 .\" ----- firewall_nat_enable setting --------------------------------
566 .It Va firewall_nat_enable
578 .It Va firewall_nat_interface
584 This is the name of the public interface or IP address on which
585 kernel NAT should run.
586 .It Va firewall_nat_flags
588 Additional configuration parameters for kernel NAT should be placed here.
589 .It Va dummynet_enable
593 will automatically load the
599 .\" -------------------------------------------------------------------
600 .It Va ipfw_netflow_enable
604 will enable netflow logging via
607 By default a ipfw rule is inserted and all packets are duplicated with
608 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
609 port using protocol version 5.
610 .It Va ipfw_netflow_hook
612 netflow hook name, must be numerical
615 .It Va ipfw_netflow_rule
620 .It Va ipfw_netflow_ip
622 Destination server ip for receiving netflow data
625 .It Va ipfw_netflow_port
627 Destination server port for receiving netflow data
630 .It Va ipfw_netflow_version
632 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
633 .It Va ipfw_netflow_fib
635 Only match packet in FIB
637 (default is undefined meaning all FIBs).
653 sockets must be enabled in the kernel.
654 If the kernel was not built with
655 .Cd "options IPDIVERT" ,
658 kernel module will be loaded.
659 .It Va natd_interface
661 This is the name of the public interface on which
664 The interface may be given as an interface name or as an IP address.
669 flags should be placed here.
674 flag is automatically added with the above
677 .\" ----- ipfilter_enable setting --------------------------------
678 .It Va ipfilter_enable
689 Typical usage will require putting
691 ipfilter_enable="YES"
709 can be enabled independently.
713 both require at least one of
723 options IPFILTER_DEFAULT_BLOCK
726 in the kernel configuration file is a good idea, too.
727 .\" ----- ipfilter_program setting ------------------------------
728 .It Va ipfilter_program
734 .\" ----- ipfilter_rules setting --------------------------------
735 .It Va ipfilter_rules
740 This variable contains the name of the filter rule definition file.
741 The file is expected to be readable for the
744 .\" ----- ipv6_ipfilter_rules setting ---------------------------
745 .It Va ipv6_ipfilter_rules
750 This variable contains the IPv6 filter rule definition file.
751 The file is expected to be readable for the
754 .\" ----- ipfilter_flags setting --------------------------------
755 .It Va ipfilter_flags
758 This variable contains flags passed to the
761 .\" ----- ipnat_enable setting ----------------------------------
771 network address translation.
774 for a detailed discussion.
775 .\" ----- ipnat_program setting ---------------------------------
782 .\" ----- ipnat_rules setting -----------------------------------
788 This variable contains the name of the file
789 holding the network address translation definition.
790 This file is expected to be readable for the
793 .\" ----- ipnat_flags setting -----------------------------------
797 This variable contains flags passed to the
800 .\" ----- ipmon_enable setting ----------------------------------
815 Setting this variable needs setting
822 for a detailed discussion.
823 .\" ----- ipmon_program setting ---------------------------------
830 .\" ----- ipmon_flags setting -----------------------------------
836 This variable contains flags passed to the
839 Another typical example would be
840 .Dq Fl D Pa /var/log/ipflog
843 log directly to a file bypassing
846 .Pa /etc/newsyslog.conf
847 in such case like this:
849 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
851 .\" ----- ipfs_enable setting -----------------------------------
861 saving the filter and NAT state tables during shutdown
862 and reloading them during startup again.
863 Setting this variable needs setting
872 for a detailed discussion.
878 because the raised securelevel will prevent
880 from saving the state tables at shutdown time.
881 .\" ----- ipfs_program setting ----------------------------------
888 .\" ----- ipfs_flags setting ------------------------------------
892 This variable contains flags passed to the
895 .\" ----- end of added ipf hook ---------------------------------
907 Typical usage will require putting
922 into the kernel, otherwise the
923 kernel module will be loaded.
928 ruleset configuration file
943 these flags are passed to the
945 program when loading the ruleset.
955 which logs packets from the
968 .Pa /var/log/pflog ) .
970 .Pa /etc/newsyslog.conf
971 to adjust logfile rotation for this.
981 This variable contains additional flags passed to the
984 .It Va pflog_instances
986 If logging to more than one
988 interface is desired,
990 is set to the list of
992 instances that should be started at system boot time.
995 is set, for each whitespace-separated
998 .Ao Ar element Ac Ns Va _dev
1000 .Ao Ar element Ac Ns Va _logfile
1001 elements are assumed to exist.
1002 .Ao Ar element Ac Ns Va _dev
1005 interface to be watched by the named
1008 .Ao Ar element Ac Ns Va _logfile
1009 must contain the name of the logfile that will be used by the
1012 .It Va ftpproxy_enable
1023 packet filter in translating ftp connections.
1024 .It Va ftpproxy_flags
1027 This variable contains additional flags passed to the
1030 .It Va ftpproxy_instances
1033 If multiple instances of
1035 are desired at boot time,
1036 .Va ftpproxy_instances
1037 should contain a whitespace-separated list of instance names.
1040 in the list, a variable named
1041 .Ao Ar element Ac Ns Va _flags
1042 should be defined, containing the command-line flags to be passed to the
1045 .It Va pfsync_enable
1054 state changes to other hosts over the network by means of
1059 must also be set then.
1060 .It Va pfsync_syncdev
1063 This variable specifies the name of the network interface
1065 should operate through.
1066 It must be set accordingly if
1070 .It Va pfsync_syncpeer
1073 This variable is optional.
1074 By default, state change messages are sent out on the synchronisation
1075 interface using IP multicast packets.
1076 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1078 When a peer address is specified using the
1080 option, the peer address is used as a destination for the pfsync
1081 traffic, and the traffic can then be protected using
1085 manpage for more details about using
1090 .It Va pfsync_ifconfig
1093 This variable can contain additional options to be passed to the
1095 command used to set up
1097 .It Va tcp_extensions
1104 disables certain TCP options as described by
1110 might help remedy such problems with connections as randomly hanging
1111 or other weird behavior.
1112 Some network devices are known
1113 to be broken with respect to these options.
1116 Set to 0 by default.
1120 .Va net.inet.tcp.log_in_vain
1122 .Va net.inet.udp.log_in_vain ,
1127 are set to the given value.
1128 .It Va tcp_keepalive
1135 will disable probing idle TCP connections to verify that the
1136 peer is still up and reachable.
1137 .It Va tcp_drop_synfin
1144 will cause the kernel to ignore TCP frames that have both
1145 the SYN and FIN flags set.
1146 This prevents OS fingerprinting, but may
1147 break some legitimate applications.
1148 .It Va icmp_drop_redirect
1155 will cause the kernel to ignore ICMP REDIRECT packets.
1158 for more information.
1159 .It Va icmp_log_redirect
1166 will cause the kernel to log ICMP REDIRECT packets.
1168 the log messages are not rate-limited, so this option should only be used
1169 for troubleshooting networks.
1172 for more information.
1173 .It Va icmp_bmcastecho
1177 to respond to broadcast or multicast ICMP ping packets.
1180 for more information.
1181 .It Va ip_portrange_first
1185 this is the first port in the default portrange.
1188 for more information.
1189 .It Va ip_portrange_last
1193 this is the last port in the default portrange.
1196 for more information.
1197 .It Va network_interfaces
1199 Set to the list of network interfaces to configure on this host or
1201 (the default) for all current interfaces.
1203 .Va network_interfaces
1204 variable to anything other than the default is deprecated.
1205 Interfaces that the administrator wishes to store configuration for,
1206 but not start at boot should be configured with the
1209 .Va ifconfig_ Ns Aq Ar interface
1210 variables as described below.
1213 .Va ifconfig_ Ns Aq Ar interface
1214 variable is also assumed to exist for each value of
1216 When an interface name contains any of the characters
1218 they are translated to
1221 The variable can contain arguments to
1223 as well as special case-insensitive keywords described below.
1224 Such keywords are removed before passing the value to
1226 while the order of the other arguments is preserved.
1228 It is possible to add IP alias entries using
1230 syntax with the address family keyword such as
1232 Assuming that the interface in question was
1234 it might look something like this:
1236 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1237 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1240 It also possible to configure multiple IP addresses in Classless
1241 Inter-Domain Routing
1244 whose each address component can be a range like
1245 .Li inet 192.0.2.5-23/24
1247 .Li inet6 2001:db8:1-f::1/64 .
1248 This notation allows address and prefix length part only,
1249 not the other address modifiers.
1250 Note that the maximum number of the generated addresses from a range
1251 specification is limited to an integer value specified in
1252 .Va netif_ipexpand_max
1255 because a small typo can unexpectedly generate a large number of addresses.
1256 The default value is
1258 It can be increased by adding the following line into
1261 netif_ipexpand_max="4096"
1265 .Li 192.0.2.5-23/24 ,
1266 the address 192.0.2.5 will be configured with the
1267 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1268 the non-conflicting netmask /32 as explained in the
1271 Note that this special netmask handling is only for
1273 not for the other address families such as
1276 With the interface in question being
1278 an example could look like:
1280 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1281 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1287 .Va ipv4_addrs_ Ns Aq Ar interface
1288 variable was supported for IPv4 CIDR address notation.
1289 It is now deprecated because the functionality was integrated into
1290 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1292 .Va ipv4_addrs_ Ns Aq Ar interface
1293 is still supported for backward compatibility.
1296 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1297 entry with an address family keyword,
1298 its contents are passed to
1300 Execution stops at the first unsuccessful access, so if
1301 something like this is present:
1303 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1304 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1305 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1306 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1309 Then note that alias4 would
1311 be added since the search would
1312 stop with the missing
1315 Because of this difficult to manage behavior,
1317 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1318 variable, which has the same functionality as
1319 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1320 and can have all of entries in a variable like the following:
1322 ifconfig_ed0_aliases="\\
1323 inet 127.0.0.251 netmask 0xffffffff \\
1324 inet 127.0.0.252 netmask 0xffffffff \\
1325 inet 127.0.0.253 netmask 0xffffffff \\
1326 inet 127.0.0.254 netmask 0xffffffff"
1329 It also supports CIDR notation.
1332 .Pa /etc/start_if. Ns Aq Ar interface
1333 file is present, it is read and executed by the
1336 before configuring the interface as specified in the
1337 .Va ifconfig_ Ns Aq Ar interface
1339 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1343 .Va vlans_ Ns Aq Ar interface
1347 interface will be created for each item in the list with the
1351 If a vlan interface's name is a number,
1352 then that number is used as the vlan tag and the new vlan interface is
1354 .Ar interface . Ns Ar tag .
1356 the vlan tag must be specified via a
1359 .Va create_args_ Ns Aq Ar interface
1362 To create a vlan device named
1366 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1369 ifconfig_em0_101="inet 192.0.2.1/24"
1372 To create a vlan device named
1376 with the vlan tag 102:
1379 create_args_myvlan="vlan 102"
1383 .Va wlans_ Ns Aq Ar interface
1387 interface will be created for each item in the list with the
1391 Further wlan cloning arguments may be passed to the
1394 command by setting the
1395 .Va create_args_ Ns Aq Ar interface
1399 devices must be created for each wireless devices as of
1405 may be specified with an
1406 .Va wlandebug_ Ns Aq Ar interface
1408 The contents of this variable will be passed directly to
1412 .Va ifconfig_ Ns Aq Ar interface
1413 contains the keyword
1415 then the interface will not be configured
1417 .Pa /etc/pccard_ether
1419 .Va network_interfaces
1423 It is possible to bring up an interface with DHCP by adding
1426 .Va ifconfig_ Ns Aq Ar interface
1428 For instance, to initialize the
1431 it is possible to use something like:
1436 If you want to configure your wireless interface with
1437 .Xr wpa_supplicant 8
1438 for use with WPA, EAP/LEAP or WEP, you need to add
1441 .Va ifconfig_ Ns Aq Ar interface
1444 On the other hand, if you want to configure your wireless interface with
1449 .Va ifconfig_ Ns Aq Ar interface
1452 will use the settings from
1453 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1455 Finally, you can add
1457 options in this variable, in addition to the
1458 .Pa /etc/start_if. Ns Aq Ar interface
1460 For instance, to configure an
1462 wireless device in station mode with an address obtained
1463 via DHCP, using WPA authentication and 802.11b mode, it is
1464 possible to use something like:
1467 ifconfig_wlan0="DHCP WPA mode 11b"
1471 .Va ifconfig_ Ns Aq Ar interface
1472 form, a fallback variable
1473 .Va ifconfig_DEFAULT
1475 It will be used for all interfaces with no
1476 .Va ifconfig_ Ns Aq Ar interface
1478 This is intended to replace the no longer supported
1482 It is also possible to rename an interface by doing:
1484 ifconfig_ed0_name="net0"
1485 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1489 This variable is deprecated.
1491 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1493 .Va ipv6_activate_all_interfaces
1498 .Dq Li inet6 accept_rtadv
1500 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1502 .Va ipv6_activate_all_interfaces
1507 This variable is deprecated.
1509 .Va ip6addrctl_policy
1514 the default address selection policy table set by
1516 will be IPv6-preferred.
1520 the default address selection policy table set by
1522 will be IPv4-preferred.
1523 .It Va ipv6_activate_all_interfaces
1525 This controls initial configuration on IPv6-capable
1526 interfaces with no corresponding
1527 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1529 Note that it is not always necessary to set this variable to
1531 to use IPv6 functionality on
1533 In most cases, just configuring
1534 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1539 all interfaces which do not have a corresponding
1540 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1541 variable will be marked as
1544 This means that all of IPv6 functionality on that interface
1545 is completely disabled to enforce a security policy.
1546 If the variable is set to
1548 the flag will be cleared on all of the interfaces.
1550 In most cases, just defining an
1551 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1552 for an IPv6-capable interface should be sufficient.
1553 However, if an interface is added dynamically
1554 .Pq by some tunneling protocols such as PPP, for example ,
1555 it is often difficult to define the variable in advance.
1556 In such a case, configuring the
1558 flag can be disabled by setting this variable to
1561 For more details of the
1564 .Dq Li inet6 ifdisabled ,
1574 privacy addresses will be generated for each IPv6
1575 interface as described in RFC 4941.
1576 .It Va ipv6_network_interfaces
1578 This is the IPv6 equivalent of
1579 .Va network_interfaces .
1580 Normally manual configuration of this variable is not needed.
1581 .It Va ipv6_cpe_wanif
1583 If the variable is set to an interface name,
1587 .Dq inet6 -no_radr accept_rtadv
1588 will be added to the specified interface automatically before evaluating
1589 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1593 .Va net.inet6.ip6.rfc6204w3
1595 .Va net.inet6.ip6.no_radr
1598 This means the specified interface will accept ICMPv6 Router
1599 Advertisement messages on that link and add the discovered
1600 routers into the Default Router List.
1601 While the other interfaces can still accept RA messages if the
1602 .Dq inet6 accept_rtadv
1603 option is specified, adding
1604 routes into the Default Router List will be disabled by
1611 Note that ICMPv6 Router Advertisement messages will be
1613 .Va net.inet6.ip6.forwarding
1615 .Pq packet forwarding is enabled
1617 .Va net.inet6.ip6.rfc6204w3
1622 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1624 This assigns arbitrary description to an interface.
1628 .Va net.ifdescr_maxlen
1630 This static setting may be overridden by commands
1631 started with dynamic interface configuration utilities
1634 hooks. The description can be seen with
1636 command and it may be exported with
1638 daemon using its MIB-2 module.
1639 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1641 IPv6 functionality on an interface should be configured by
1642 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1643 instead of setting ifconfig parameters in
1644 .Va ifconfig_ Ns Aq Ar interface .
1645 If this variable is empty, all of IPv6 configurations on the
1646 specified interface by other variables such as
1647 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1650 Aliases should be set by
1651 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1657 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1658 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1661 Interfaces that have an
1662 .Dq Li inet6 accept_rtadv
1664 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1665 setting will be automatically configured by SLAAC
1666 .Pq StateLess Address AutoConfiguration
1672 Note that a link-local address will be automatically configured in
1673 addition to the configured global-scope addresses because the IPv6
1674 specifications require it on each link.
1675 The address is calculated from the MAC address by using an algorithm
1682 If only a link-local address is needed on the interface,
1683 the following configuration can be used:
1685 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1688 A link-local address can also be configured manually.
1689 This is useful for the default router address of an IPv6 router
1690 so that it does not change when the network interface
1694 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1696 .It Va ipv6_prefix_ Ns Aq Ar interface
1698 If one or more prefixes are defined in
1699 .Va ipv6_prefix_ Ns Aq Ar interface
1700 addresses based on each prefix and the EUI-64 interface index will be
1701 configured on that interface.
1702 Note that this variable will be ignored when
1703 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1706 For example, the following configuration
1708 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1711 is equivalent to the following:
1713 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1714 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1715 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1716 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1719 These Subnet-Router anycast addresses will be added only when
1720 .Va ipv6_gateway_enable
1722 .It Va ipv6_default_interface
1726 this is the default output interface for scoped addresses.
1727 This works only with ipv6_gateway_enable="NO".
1728 .It Va ip6addrctl_enable
1730 This variable is to enable configuring default address selection policy table
1732 The table can be specified in another variable
1733 .Va ip6addrctl_policy .
1735 .Va ip6addrctl_policy
1736 the following keywords can be specified:
1737 .Dq Li ipv4_prefer ,
1738 .Dq Li ipv6_prefer ,
1748 installs a pre-defined policy table described in Section 2.1
1756 is specified, it attempts to read a file
1757 .Pa /etc/ip6addrctl.conf
1759 If this file is found,
1761 reads and installs it.
1762 If not found, a policy is automatically set
1764 .Va ipv6_activate_all_interfaces
1765 variable; if the variable is set to
1767 the IPv6-preferred one is used.
1768 Otherwise IPv4-preferred.
1770 The default value of
1771 .Va ip6addrctl_enable
1773 .Va ip6addrctl_policy
1779 .It Va cloned_interfaces
1781 Set to the list of clonable network interfaces to create on this host.
1782 Further cloning arguments may be passed to the
1785 command for each interface by setting the
1786 .Va create_args_ Ns Aq Ar interface
1788 If an interface name is specified with
1791 the interface will not be destroyed even when
1793 script is invoked with
1796 This is useful when reconfiguring the interface without destroying it.
1798 .Va cloned_interfaces
1799 are automatically appended to
1800 .Va network_interfaces
1802 .It Va cloned_interfaces_sticky
1804 This variable is to globally enable functionality of
1807 .Va cloned_interfaces
1809 The default value is
1811 Even if this variable is specified to
1814 keyword can be used to override it on per interface basis.
1815 .It Va gif_interfaces
1817 This variable is deprecated in favor of
1818 .Va cloned_interfaces .
1821 tunnel interfaces to configure on this host.
1824 tunnel interface, set a variable named
1825 .Va ifconfig_ Ns Aq Ar interface
1826 with the parameters for the
1828 command to configure the link level for
1833 The value of this variable is used to configure the link layer of the
1838 For example, configure two
1841 .Bd -literal -offset indent
1842 gif_interfaces="gif0 gif1"
1843 ifconfig_gif0="tunnel src_addr0 dst_addr0"
1844 ifconfig_gif1="tunnel src_addr1 dst_addr1"
1847 Additionally, this option ensures that each listed interface is created
1852 This example also works with
1853 .Va cloned_interfaces
1855 .Va gif_interfaces .
1856 .It Va sppp_interfaces
1860 interfaces to configure on this host.
1862 .Va spppconfig_ Ns Aq Ar interface
1863 variable is assumed to exist for each value of
1865 Each interface should also be configured by a general
1866 .Va ifconfig_ Ns Aq Ar interface
1870 for more information about available options.
1880 The name of the profile to use from
1881 .Pa /etc/ppp/ppp.conf .
1882 Also used for per-profile overrides of
1887 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1888 When the profile name contains any of the characters
1890 they are translated to
1892 for the proposes of the override variable names.
1895 Mode in which to run the
1898 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1900 Overrides the global
1910 See the manual for a full description.
1915 enables network address translation.
1916 Used in conjunction with
1918 allows hosts on private network addresses access to the Internet using
1919 this host as a network address translating router.
1920 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1922 Overrides the global
1926 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1928 Set the unit number to be used for this profile.
1929 See the manual description of
1934 The name of the user under which
1942 .It Va rc_conf_files
1944 This option is used to specify a list of files that will override
1946 .Pa /etc/defaults/rc.conf .
1947 The files will be read in the order in which they are specified and should
1948 include the full path to the file.
1949 By default, the files specified are
1952 .Pa /etc/rc.conf.local
1958 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1960 .It Va gptboot_enable
1964 .Pa /etc/rc.d/gptboot
1965 will log if the system successfully (or not) booted from a GPT partition,
1971 .It Va gbde_autoattach_all
1976 will attempt to automatically initialize your .bde devices in
1980 List the devices that the script should try to attach,
1985 The directory where the
1987 lockfiles are located.
1988 The default lockfile directory is
1991 The lockfile for each individual
1993 device can be overridden by setting the variable
1994 .Va gbde_lock_ Ns Aq Ar device ,
1997 is the encrypted device without the
2002 .It Va gbde_attach_attempts
2004 Number of times to attempt attaching to a
2006 device, i.e., how many times the user is asked for the pass-phrase.
2010 List of devices to automatically attach on boot.
2011 Note that .eli devices from
2013 are automatically appended to this list.
2016 List of groups containing devices to automatically attach on boot with the same
2017 keyfiles and passphrase.
2018 This must be accompanied with a corresponding
2019 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2023 Number of times user is asked for the pass-phrase.
2024 If empty, it will be taken from
2025 .Va kern.geom.eli.tries
2027 .It Va geli_default_flags
2029 Default flags to use by
2031 when configuring disk encryption.
2032 Flags can be configured for every device separately by defining the
2033 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2034 variable, and for every group separately by defining the
2035 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2037 .It Va geli_autodetach
2039 Specifies if GELI devices should be marked for detach on last close after
2040 file systems are mounted.
2043 This can be changed for every device separately by defining the
2044 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2046 .It Va root_rw_mount
2051 After the file systems are checked at boot time, the root file system
2052 is remounted as read-write if this is set to
2054 Diskless systems that mount their root file system from a read-only remote
2055 NFS share should set this to
2059 .It Va fsck_y_enable
2064 will be run with the
2066 flag if the initial preen
2067 of the file systems fails.
2068 .It Va background_fsck
2072 the system will not attempt to run
2074 in the background where possible.
2075 .It Va background_fsck_delay
2077 The amount of time in seconds to sleep before starting a background
2079 It defaults to sixty seconds to allow large applications such as
2080 the X server to start before disk I/O bandwidth is monopolized by
2082 If set to a negative number, the background file system check will be
2083 delayed indefinitely to allow the administrator to run it at a more
2085 For example it may be run from
2087 by adding a line like
2089 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2095 List of file system types that are network-based.
2096 This list should generally not be modified by end users.
2098 .Va extra_netfs_types
2100 .It Va extra_netfs_types
2102 If set to something other than
2105 this variable extends the list of file system types
2106 for which automatic mounting at startup by
2108 should be delayed until the network is initialized.
2110 a whitespace-separated list of network file system descriptor pairs,
2111 each consisting of a file system type as passed to
2113 and a human-readable, one-word description,
2116 Extending the default list in this way is only necessary
2117 when third party file system types are used.
2118 .It Va syslogd_enable
2125 .It Va syslogd_program
2130 .Pa /usr/sbin/syslogd ) .
2131 .It Va syslogd_flags
2137 these are the flags to pass to
2146 .It Va inetd_program
2151 .Pa /usr/sbin/inetd ) .
2158 these are the flags to pass to
2167 .It Va hastd_program
2179 these are the flags to pass to
2181 .It Va local_unbound_enable
2187 daemon as a local caching resolver.
2192 to start a Kerberos 5 authentication server
2200 this is the path to Kerberos 5 Authentication Server.
2204 This variable contains additional flags to be passed to the Kerberos 5
2205 authentication server.
2206 .It Va kadmind_enable
2212 the Kerberos 5 Administration Daemon; set to
2215 .It Va kadmind_program
2221 this is the path to Kerberos 5 Administration Daemon.
2222 .It Va kpasswdd_enable
2228 the Kerberos 5 Password-Changing Daemon; set to
2231 .It Va kpasswdd_program
2237 this is the path to Kerberos 5 Password-Changing Daemon.
2244 the Kerberos 5 ticket forwarding daemon, at the boot time.
2250 .Pa /usr/libexec/kfd ) .
2257 daemon at boot time.
2264 these are the flags to pass to it.
2271 daemon at boot time.
2278 these are the flags to pass to it.
2281 manpage for more information.
2282 .It Va amd_map_program
2285 the specified program is run to get the list of
2290 maps are stored in NIS, one can set this to
2303 will be updated at boot time to reflect the kernel release
2308 will not be updated.
2309 .It Va nfs_client_enable
2313 run the NFS client daemons at boot time.
2314 .It Va nfs_access_cache
2317 .Va nfs_client_enable
2322 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2324 results should be cached.
2325 A value of 2-10 seconds will substantially reduce network
2326 traffic for many NFS operations.
2327 .It Va nfs_server_enable
2331 run the NFS server daemons at boot time.
2332 .It Va nfs_server_flags
2335 .Va nfs_server_enable
2338 these are the flags to pass to the
2341 .It Va nfsv4_server_enable
2344 .Va nfs_server_enable
2348 .Va nfsv4_server_enable
2351 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2352 .It Va nfsuserd_enable
2358 run the nfsuserd daemon, which is needed for NFSv4 in order
2359 to map between user/group names vs uid/gid numbers.
2361 .Va nfsv4_server_enable
2364 this will be forced enabled.
2365 .It Va nfsuserd_flags
2371 these are the flags to pass to the
2374 .It Va nfscbd_enable
2380 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2387 these are the flags to pass to the
2390 .It Va mountd_enable
2395 .Va nfs_server_enable
2401 It is commonly needed to run CFS without real NFS used.
2408 these are the flags to pass to the
2411 .It Va weak_mountd_authentication
2415 allow services like PCNFSD to make non-privileged mount
2417 .It Va nfs_reserved_port_only
2421 provide NFS services only on a secure port.
2422 .It Va nfs_bufpackets
2424 If set to a number, indicates the number of packets worth of
2425 socket buffer space to reserve on an NFS client.
2426 The kernel default is typically 4.
2427 Using a higher number may be
2428 useful on gigabit networks to improve performance.
2429 The minimum value is
2430 2 and the maximum is 64.
2431 .It Va rpc_lockd_enable
2435 and also an NFS server or client, run
2438 .It Va rpc_lockd_flags
2441 .Va rpc_lockd_enable
2444 these are the flags to pass to the
2447 .It Va rpc_statd_enable
2451 and also an NFS server or client, run
2454 .It Va rpc_statd_flags
2457 .Va rpc_statd_enable
2460 these are the flags to pass to the
2463 .It Va rpcbind_program
2468 .Pa /usr/sbin/rpcbind ) .
2469 .It Va rpcbind_enable
2475 service at boot time.
2476 .It Va rpcbind_flags
2482 these are the flags to pass to the
2485 .It Va keyserv_enable
2491 daemon on boot for running Secure RPC.
2492 .It Va keyserv_flags
2498 these are the flags to pass to
2501 .It Va pppoed_enable
2507 daemon at boot time to provide PPP over Ethernet services.
2508 .It Va pppoed_ Ns Aq Ar provider
2511 listens to requests to this
2517 argument of the same name.
2520 Additional flags to pass to
2522 .It Va pppoed_interface
2524 The network interface to run
2527 This is mandatory when
2537 service at boot time.
2538 This command is intended for networks of
2539 machines where a consistent
2541 for all hosts must be established.
2542 This is often useful in large NFS
2543 environments where time stamps on files are expected to be consistent
2551 these are the flags to pass to the
2554 .It Va ntpdate_enable
2561 This command is intended to
2562 synchronize the system clock only
2564 from some standard reference.
2566 Note that the use of the
2567 .Va ntpd_sync_on_start
2568 variable is a preferred alternative to the
2572 is to be retired from the NTP distribution.
2573 .It Va ntpdate_config
2575 Configuration file for
2579 .It Va ntpdate_hosts
2581 A whitespace-separated list of NTP servers to synchronize with at startup.
2582 The default is to use the servers listed in
2583 .Va ntpdate_config ,
2584 if that file exists.
2585 .It Va ntpdate_program
2590 .Pa /usr/sbin/ntpdate ) .
2591 .It Va ntpdate_flags
2597 these are the flags to pass to the
2599 command (typically a hostname).
2606 command at boot time.
2612 .Pa /usr/sbin/ntpd ) .
2626 these are the flags to pass to the
2629 .It Va ntpd_sync_on_start
2636 flag, which syncs the system's clock on startup.
2639 for more information regarding the
2642 This is a preferred alternative to using
2647 .It Va nis_client_enable
2653 service at system boot time.
2654 .It Va nis_client_flags
2657 .Va nis_client_enable
2660 these are the flags to pass to the
2663 .It Va nis_ypldap_enable
2669 daemon at system boot time.
2670 .It Va nis_ypldap_flags
2673 .Va nis.ypldap_enable
2676 these are the flags to pass to the
2679 .It Va nis_ypset_enable
2685 daemon at system boot time.
2686 .It Va nis_ypset_flags
2689 .Va nis_ypset_enable
2692 these are the flags to pass to the
2695 .It Va nis_server_enable
2701 daemon at system boot time.
2702 .It Va nis_server_flags
2705 .Va nis_server_enable
2708 these are the flags to pass to the
2711 .It Va nis_ypxfrd_enable
2717 daemon at system boot time.
2718 .It Va nis_ypxfrd_flags
2721 .Va nis_ypxfrd_enable
2724 these are the flags to pass to the
2727 .It Va nis_yppasswdd_enable
2733 daemon at system boot time.
2734 .It Va nis_yppasswdd_flags
2737 .Va nis_yppasswdd_enable
2740 these are the flags to pass to the
2743 .It Va rpc_ypupdated_enable
2749 daemon at system boot time.
2750 .It Va bsnmpd_enable
2756 daemon at system boot time.
2757 Be sure to understand the security implications of running SNMP daemon
2765 these are the flags to pass to the
2768 .It Va defaultrouter
2772 create a default route to this host name or IP address
2773 (use an IP address if this router is also required to get to the
2775 .It Va ipv6_defaultrouter
2777 The IPv6 equivalent of
2779 .It Va static_arp_pairs
2781 Set to the list of static ARP pairs that are to be added at system
2783 For each whitespace separated
2786 .Va static_arp_ Ns Aq Ar element
2787 variable is assumed to exist whose contents will later be passed to a
2792 static_arp_pairs="gw"
2793 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2795 .It Va static_ndp_pairs
2797 Set to the list of static NDP pairs that are to be added at system
2799 For each whitespace separated
2802 .Va static_ndp_ Ns Aq Ar element
2803 variable is assumed to exist whose contents will later be passed to a
2808 static_ndp_pairs="gw"
2809 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2811 .It Va static_routes
2813 Set to the list of static routes that are to be added at system
2817 then for each whitespace separated
2820 .Va route_ Ns Aq Ar element
2821 variable is assumed to exist
2822 whose contents will later be passed to a
2827 static_routes="ext mcast:gif0 gif0local:gif0"
2828 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2829 route_mcast="-net 224.0.0.0/4 -iface gif0"
2830 route_gif0local="-host 169.254.1.1 -iface lo0"
2837 the route is specific to the interface
2839 .It Va ipv6_static_routes
2841 The IPv6 equivalent of
2845 then for each whitespace separated
2848 .Va ipv6_route_ Ns Aq Ar element
2849 variable is assumed to exist
2850 whose contents will later be passed to a
2851 .Dq Nm route Cm add Fl inet6
2853 .It Va gateway_enable
2857 configure host to act as an IP router, e.g.\& to forward packets
2859 .It Va ipv6_gateway_enable
2861 The IPv6 equivalent of
2862 .Va gateway_enable .
2863 .It Va routed_enable
2867 run a routing daemon of some sort, based on the
2872 .It Va route6d_enable
2874 The IPv6 equivalent of
2878 run a routing daemon of some sort, based on the
2883 .It Va routed_program
2889 this is the name of the routing daemon to use.
2890 .It Va route6d_program
2892 The IPv6 equivalent of
2893 .Va routed_program .
2900 these are the flags to pass to the routing daemon.
2901 .It Va route6d_flags
2903 The IPv6 equivalent of
2905 .It Va rtadvd_enable
2911 daemon at boot time.
2914 utility sends ICMPv6 Router Advertisement messages to
2915 the interfaces specified in
2916 .Va rtadvd_interfaces .
2917 This should only be enabled with great care.
2918 You may want to fine-tune
2920 .It Va rtadvd_interfaces
2926 this is the list of interfaces to use.
2931 enable global proxy ARP.
2932 .It Va forward_sourceroute
2940 source-routed packets are forwarded.
2941 .It Va accept_sourceroute
2945 the system will accept source-routed packets directed at it.
2952 daemon at system boot time.
2959 these are the flags to pass to the
2962 .It Va bootparamd_enable
2968 daemon at system boot time.
2969 .It Va bootparamd_flags
2972 .Va bootparamd_enable
2975 these are the flags to pass to the
2978 .It Va stf_interface_ipv4addr
2982 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2984 Specify this entry to enable the 6to4 interface.
2985 .It Va stf_interface_ipv4plen
2987 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2988 An effective value is 0-31.
2989 .It Va stf_interface_ipv6_ifid
2991 IPv6 interface ID for
2995 .It Va stf_interface_ipv6_slaid
2997 IPv6 Site Level Aggregator for
2999 .It Va ipv6_ipv4mapping
3003 this enables IPv4 mapped IPv6 address communication (like
3004 .Li ::ffff:a.b.c.d ) .
3005 .It Va rtsold_enable
3011 daemon to send ICMPv6 Router Solicitation messages.
3018 these are the flags to pass to
3022 For interfaces configured with the
3023 .Dq Li inet6 accept_rtadv
3024 keyword, these are the flags to pass to
3029 is mutually exclusive to
3035 The keyboard bell sound.
3042 if the default behavior is desired.
3043 For details, refer to the
3048 If set to a non-null string, the virtual console's keyboard input is
3054 no keymap is installed, otherwise the value is used to install
3055 the keymap file found in
3056 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3059 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3064 The keyboard repeat speed.
3071 if the default behavior is desired.
3076 attempt to program the function keys with the value.
3078 be a single string of the form:
3079 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3082 Can be set to the value of
3085 .Dq Li destructive ,
3088 to set the cursor behavior explicitly or choose the default behavior.
3093 no screen map is installed, otherwise the value is used to install
3094 the screen map file in
3095 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3096 This parameter is ignored when using
3098 as the console driver.
3103 the default 8x16 font value is used for screen size requests, otherwise
3105 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3107 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3108 is used (depending on the console driver being used).
3113 the default 8x14 font value is used for screen size requests, otherwise
3115 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3117 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3118 is used (depending on the console driver being used).
3123 the default 8x8 font value is used for screen size requests, otherwise
3125 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3127 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3128 is used (depending on the console driver being used).
3133 the default screen blanking interval is used, otherwise it is set
3141 this is the actual screen saver to use
3142 .Li ( blank , snake , daemon ,
3144 .It Va moused_nondefault_enable
3148 the mouse device specified on
3149 the command line is not automatically treated as enabled by the
3150 .Pa /etc/rc.d/moused
3152 Having this variable set to
3158 to be enabled as soon as it is plugged in.
3159 .It Va moused_enable
3165 daemon is started for doing cut/paste selection on the console.
3168 This is the protocol type of the mouse connected to this host.
3169 This variable must be set if
3176 is able to detect the appropriate mouse type automatically in many cases.
3177 Set this variable to
3179 to let the daemon detect it, or
3180 select one from the following list if the automatic detection fails.
3182 If the mouse is attached to the PS/2 mouse port, choose
3186 regardless of the brand and model of the mouse.
3188 mouse is attached to the bus mouse port, choose
3192 All other protocols are for serial mice and will not work with
3193 the PS/2 and bus mice.
3194 If this is a USB mouse,
3196 is the only protocol type which will work.
3198 .Bl -tag -width ".Li x10mouseremote" -compact
3200 Microsoft mouse (serial)
3202 Microsoft IntelliMouse (serial)
3204 Mouse systems Corp.\& mouse (serial)
3206 MM Series mouse (serial)
3208 Logitech mouse (serial)
3212 Logitech MouseMan and TrackMan (serial)
3214 ALPS GlidePoint (serial)
3215 .It Li thinkingmouse
3216 Kensington ThinkingMouse (serial)
3220 MM HitTablet (serial)
3221 .It Li x10mouseremote
3222 X10 MouseRemote (serial)
3224 Interlink VersaPad (serial)
3227 Even if the mouse is not in the above list, it may be compatible
3228 with one in the list.
3229 Refer to the manual page for
3231 for compatibility information.
3233 It should also be noted that while this is enabled, any
3234 other client of the mouse (such as an X server) should access
3235 the mouse through the virtual mouse device,
3237 and configure it as a
3239 type mouse, since all
3240 mouse data is converted to this single canonical format when
3243 If the client program does not support the
3249 It is the second preferred type.
3256 this is the actual port the mouse is on.
3259 for a COM1 serial mouse,
3263 for a bus mouse, for example.
3268 is set, its value is used as an additional set of flags to pass to the
3271 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3273 .Va moused_nondefault_enable
3276 daemon is started for a non-default port, the
3277 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3278 set of options has precedence over and replaces the default
3282 is the name of the non-default port, i.e.,\&
3285 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3286 it is possible to set up a different set of default flags for each
3289 For example, you can use
3293 to make your laptop's touchpad more comfortable to use,
3294 but an empty set of options for
3295 .Va moused_ums0_flags
3298 mouse has three or more buttons.
3299 .It Va mousechar_start
3303 the default mouse cursor character range
3304 .Li 0xd0 Ns - Ns Li 0xd3
3306 otherwise the range start is set
3311 Use if the default range is occupied in the language code table.
3312 .It Va allscreens_flags
3316 is run with these options for each of the virtual terminals
3320 will enable the mouse pointer on all virtual terminals
3325 .It Va allscreens_kbdflags
3329 is run with these options for each of the virtual terminals
3337 scrollback (history) buffer to 200 lines.
3344 daemon at system boot time.
3350 .Pa /usr/sbin/cron ) .
3357 these are the flags to pass to
3363 enable the special handling of transitions to and from the
3364 Daylight Saving Time in
3366 (equivalent to using the flag
3373 .Pa /usr/sbin/lpd ) .
3380 daemon at system boot time.
3387 these are the flags to pass to the
3390 .It Va chkprintcap_enable
3396 command before starting the
3399 .It Va chkprintcap_flags
3404 .Va chkprintcap_enable
3407 these are the flags to pass to the
3412 which causes missing directories to be created.
3413 .It Va mta_start_script
3415 This variable specifies the full path to the script to run to start
3416 a mail transfer agent.
3418 .Pa /etc/rc.sendmail .
3422 .Pa /etc/rc.sendmail
3423 uses are documented in the
3428 Indicates the device (usually a swap partition) to which a crash dump
3429 should be written in the event of a system crash.
3430 If the value of this variable is
3432 the first suitable swap device listed in
3434 will be used as dump device.
3435 Otherwise, the value of this variable is passed as the argument to
3437 To disable crash dumps, set this variable to
3445 as the system dump device.
3448 When the system reboots after a crash and a crash dump is found on the
3449 device specified by the
3453 will save that crash dump and a copy of the kernel to the directory
3457 The default value is
3466 .It Va savecore_enable
3470 disable automatic extraction of the crash dump from the
3472 .It Va savecore_flags
3474 If crash dumps are enabled, these are the flags to pass to the
3481 to turn on user and group disk quotas on system startup via the
3483 command for all file systems marked as having quotas enabled in
3485 The kernel must be built with
3487 for disk quotas to function.
3492 to enable user and group disk quota checking via the
3495 .It Va quotacheck_flags
3505 these are the flags to pass to the
3510 which checks quotas for all file systems with quotas enabled in
3512 .It Va quotaon_flags
3518 these are the flags to pass to the
3523 which enables quotas for all file systems with quotas enabled in
3525 .It Va quotaoff_flags
3531 these are the flags to pass to the
3533 utility when shutting down the quota system.
3536 which disables quotas for all file systems with quotas enabled in
3538 .It Va accounting_enable
3542 to enable system accounting through the
3549 to enable iBCS2 (SCO) binary emulation at system initial boot
3551 .It Va ibcs2_loaders
3559 this specifies a list of additional iBCS2 loaders to enable.
3560 .It Va firstboot_sentinel
3562 This variable specifies the full path to a
3565 If a file exists with this path,
3569 keyword will be run on startup and the sentinel file will be deleted
3570 after the boot process completes.
3571 The sentinel file must be located on a writable file system which is
3572 mounted no later than
3573 .Va early_late_divider
3574 to function properly.
3581 to enable Linux/ELF binary emulation at system initial
3583 .It Va sysvipc_enable
3587 load System V IPC primitives at boot time.
3588 .It Va clear_tmp_enable
3599 to disable removing of X11 lock files,
3600 and the removal and (secure) recreation
3601 of the various socket directories for X11
3603 .It Va ldconfig_paths
3605 Set to the list of shared library paths to use with
3609 will always be added first, so it need not appear in this list.
3610 .It Va ldconfig32_paths
3612 Set to the list of 32-bit compatibility shared library paths to
3615 .It Va ldconfig_paths_aout
3617 Set to the list of shared library paths to use with
3622 .It Va ldconfig_insecure
3626 utility normally refuses to use directories
3627 which are writable by anyone except root.
3628 Set this variable to
3630 to disable that security check during system startup.
3631 .It Va ldconfig_local_dirs
3633 Set to the list of local
3636 The names of all files in the directories listed will be
3637 passed as arguments to
3639 .It Va ldconfig_local32_dirs
3641 Set to the list of local 32-bit compatibility
3644 The names of all files in the directories listed will be
3645 passed as arguments to
3646 .Dq Nm ldconfig Fl 32 .
3647 .It Va kern_securelevel_enable
3651 to set the kernel security level at system startup.
3652 .It Va kern_securelevel
3654 The kernel security level to set at startup.
3655 The allowed range of
3657 ranges from \-1 (the compile time default) to 3 (the
3661 for the list of possible security levels and their effect
3662 on system operation.
3665 Path to the SSH server program
3666 .Pa ( /usr/sbin/sshd
3674 at system boot time.
3681 these are the flags to pass to the
3686 Path to the FTP server program
3687 .Pa ( /usr/libexec/ftpd
3695 as a stand-alone daemon at system boot time.
3702 these are the additional flags to pass to the
3705 .It Va watchdogd_enable
3711 daemon at boot time.
3712 This requires that the kernel have been compiled with a
3715 .It Va watchdogd_flags
3718 .Va watchdogd_enable
3721 these are the flags passed to the
3724 .It Va devfs_rulesets
3726 List of files containing sets of rules for
3728 .It Va devfs_system_ruleset
3730 Rule name(s) to apply to the system
3733 .It Va devfs_set_rulesets
3735 Pairs of already-mounted
3737 directories and rulesets that should be applied to them.
3738 For example: /mount/dev=ruleset_name
3739 .It Va devfs_load_rulesets
3741 If set, always load the default rulesets listed in
3742 .Va devfs_rulesets .
3743 .It Va performance_cx_lowest
3745 CPU idle state to use while on AC power.
3750 should use the lowest power state available while
3752 indicates that the lowest latency state (less power savings) should be used.
3753 .It Va performance_cpu_freq
3755 CPU clock frequency to use while on AC power.
3760 should use the lowest frequency available while
3762 indicates that the highest frequency (less power savings) should be used.
3763 .It Va economy_cx_lowest
3765 CPU idle state to use when off AC power.
3770 should use the lowest power state available while
3772 indicates that the lowest latency state (less power savings) should be used.
3773 .It Va economy_cpu_freq
3775 CPU clock frequency to use when off AC power.
3780 should use the lowest frequency available while
3782 indicates that the highest frequency (less power savings) should be used.
3787 any configured jails will not be started.
3790 The configuration filename used by
3793 The default value is
3794 .Pa /etc/jail.conf .
3795 .It Va jail_parallel_start
3799 all configured jails will be started in the background (in parallel).
3803 When set, use as default value for
3804 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3809 A space-delimited list of jail names.
3810 When left empty, all of the
3812 instances defined in the configuration file are started.
3813 The names specified in this list control the jail startup order.
3815 instances missing from
3817 must be started manually.
3820 parameter in the configuration file may override this list.
3821 .It Va jail_reverse_stop
3825 all configured jails in
3827 are stopped in reverse order.
3828 .It Va jail_* variables
3829 Note that older releases supported per-jail configuration via
3833 hostname of a jail named
3835 was able to be set by
3836 .Li jail_vjail_hostname .
3837 These per-jail configuration variables are now obsolete in favor of
3840 For backward compatibility,
3841 when per-jail configuration variables are defined,
3843 configuration files are created as
3844 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3847 The following per-jail parameters are handled by
3849 script out of their corresponding
3852 In addition to them, parameters in
3853 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3854 will be added to the configuration file.
3855 They must be a semi-colon
3863 .Bl -tag -width "host.hostname" -offset indent
3866 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3867 .It Li host.hostname
3869 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3870 .It Li exec.consolelog
3872 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3873 The default value is
3874 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3877 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3878 .It Li vnet.interface
3880 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3883 parameter will be enabled and cannot be specified with
3884 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3885 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3887 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3891 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3894 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3897 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3900 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3901 The parameter name was
3903 in some older releases.
3904 .It Li exec.prestart
3906 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3907 .It Li exec.poststart
3909 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3912 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3915 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3916 .It Li exec.poststop
3918 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3921 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3923 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3924 contain IPv4 addresses
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3929 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3930 contain IPv6 addresses
3933 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3936 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3937 .It Li devfs_ruleset
3939 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3940 This must be an integer,
3942 .It Li mount.fdescfs
3944 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3945 .It Li allow.set_hostname
3947 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3948 .It Li allow.rawsocket
3950 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3951 .It Li allow.sysvipc
3953 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3955 .\" -----------------------------------------------------
3959 representing the entropy sources
3960 you wish to harvest.
3963 for more information.
3968 to disable caching entropy via
3970 Otherwise set to the directory
3971 in which the entropy files are stored.
3975 that regularly writes and rotates
3978 will be used at boot time.
3980 .Pa /var/db/entropy .
3985 to disable caching entropy through reboots.
3986 Otherwise set to the name
3987 of a file used to store cached entropy.
3988 This file should be located
3989 on a file system that is readable
3990 before all the volumes specified in
3997 .Pa /var/db/entropy-file
3998 is found it will also be used.
3999 This will be of some use to
4001 .It Va entropy_boot_file
4006 very early caching entropy
4008 Otherwise set to the filename
4010 very early reboot cached entropy.
4011 This file should be located where
4016 The default location is
4018 .It Va entropy_save_sz
4020 Size of the entropy cache files saved by
4023 .It Va entropy_save_num
4025 Number of entropy cache files to save by
4039 Configuration file for
4048 .Pa /var/run/dmesg.boot
4050 .It Va rcshutdown_timeout
4052 If set, start a watchdog timer in the background which will terminate
4056 has not completed within the specified time (in seconds).
4057 Notice that in addition to this soft timeout,
4059 also applies a hard timeout for the execution of
4061 This is configured via
4064 .Va kern.init_shutdown_timeout
4065 and defaults to 120 seconds.
4066 Setting the value of
4067 .Va rcshutdown_timeout
4068 to more than 120 seconds will have no effect until the
4071 .Va kern.init_shutdown_timeout
4073 .It Va virecover_enable
4077 to prevent the system from trying to
4078 recover pre-maturely terminated
4081 .It Va ugidfw_enable
4086 .Xr mac_bsdextended 4
4087 module upon system initialization and load a default
4089 .It Va bsdextended_script
4092 .Xr mac_bsdextended 4
4093 ruleset file to load.
4094 The default value of this variable is
4095 .Pa /etc/rc.bsdextended .
4096 .It Va newsyslog_enable
4103 .It Va newsyslog_flags
4106 .Va newsyslog_enable
4109 these are the flags to pass to the
4114 which causes log files flagged with a
4117 .It Va mdconfig_md Ns Aq Ar X
4127 must be specified and either a
4129 for malloc or swap backed
4137 .Va mdconfig_md Ns Aq Ar X
4138 variables are evaluated until one variable is unset or null.
4139 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4141 Optional arguments passed to
4147 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4149 An ownership specification passed to
4158 device and the mount point will be changed.
4159 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4161 A mode string passed to
4170 device and the mount point will be changed.
4171 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4173 Files to be copied to the mount point of the
4177 after it has been mounted.
4178 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4180 Command to execute after the specified
4185 Note that the command is passed to
4191 variables can be used to reference respectively the
4193 device and the mount point.
4198 one could set the following:
4200 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4202 .It Va autobridge_interfaces
4204 Set to the list of bridge interfaces that will have newly arriving interfaces
4205 checked against to be automatically added.
4208 then for each whitespace separated
4211 .Va autobridge_ Ns Aq Ar element
4212 variable is assumed to exist which has a whitespace separated list of interface
4213 names to match, these names can use wildcards.
4216 autobridge_interfaces="bridge0"
4217 autobridge_bridge0="tap* dc0 vlan[345]"
4223 enable support for sound mixer.
4224 .It Va hcsecd_enable
4228 enable Bluetooth security daemon.
4229 .It Va hcsecd_config
4231 Configuration file for
4234 .Pa /etc/bluetooth/hcsecd.conf .
4239 enable Bluetooth Service Discovery Protocol daemon.
4247 .It Va sdpd_groupname
4251 group to run as after it initializes.
4254 .It Va sdpd_username
4258 user to run as after it initializes.
4261 .It Va bthidd_enable
4265 enable Bluetooth Human Interface Device daemon.
4266 .It Va bthidd_config
4268 Configuration file for
4271 .Pa /etc/bluetooth/bthidd.conf .
4274 Path to a file, where
4276 will store information about known HID devices.
4278 .Pa /var/db/bthidd.hids .
4279 .It Va rfcomm_pppd_server_enable
4283 enable Bluetooth RFCOMM PPP wrapper daemon.
4284 .It Va rfcomm_pppd_server_profile
4286 The name of the profile to use from
4287 .Pa /etc/ppp/ppp.conf .
4288 Multiple profiles can be specified here.
4289 Also used to specify per-profile overrides.
4290 When the profile name contains any of the characters
4292 they are translated to
4294 for the proposes of the override variable names.
4295 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4297 Overrides local address to listen on.
4303 The address can be specified as BD_ADDR or name.
4304 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4306 Overrides local RFCOMM channel to listen on.
4309 will listen on RFCOMM channel 1.
4310 Must set properly if multiple profiles used in the same time.
4311 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4315 if it should register Serial Port service on the specified RFCOMM channel.
4318 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4322 if it should register Dial-Up Networking service on the specified
4326 .It Va ubthidhci_enable
4330 change the USB Bluetooth controller from HID mode to HCI mode.
4331 You also need to specify the location of USB Bluetooth controller with the
4332 .Va ubthidhci_busnum
4336 .It Va ubthidhci_busnum
4337 Bus number where the USB Bluetooth controller is located.
4340 on your system to find this information.
4341 .It Va ubthidhci_addr
4342 Bus address of the USB Bluetooth controller.
4345 on your system to find this information.
4346 .It Va netwait_enable
4350 delays the start of network-reliant services until
4352 is up and ICMP packets to a destination defined in
4355 Link state is examined first, followed by
4357 an IP address to verify network usability.
4358 If no destination can be reached or timeouts are exceeded,
4359 network services are started anyway with no guarantee that
4360 the network is usable.
4361 Use of this variable requires both
4369 This variable contains a space-delimited list of IP addresses to
4371 DNS hostnames should not be used as resolution is not guaranteed
4372 to be functional at this point.
4373 If multiple IP addresses are specified,
4374 each will be tried until one is successful or the list is exhausted.
4375 .It Va netwait_timeout
4377 Indicates the total number of seconds to perform a
4379 against each IP address in
4381 at a rate of one ping per second.
4382 If any of the pings are successful,
4383 full network connectivity is considered reliable.
4388 Defines the name of the network interface on which watch for link.
4390 is used to monitor the interface, looking for
4391 .Dq Li status: no carrier .
4392 Once gone, the link is considered up.
4395 interface if desired.
4396 .It Va netwait_if_timeout
4398 Defines the total number of seconds to wait for link to become usable,
4399 polled at a 1-second interval.
4407 rules from the defined ruleset.
4408 The kernel must be built with
4411 .Cd "options RCTL" .
4417 This variables contains the
4423 A space-separated list of configuration files used by
4425 The default value is an empty string.
4426 .It Va autofs_enable
4436 daemons at boot time.
4437 .It Va automount_flags
4443 these are the flags to pass to the
4446 By default no flags are passed.
4447 .It Va automountd_flags
4453 these are the flags to pass to the
4456 By default no flags are passed.
4457 .It Va autounmountd_flags
4463 these are the flags to pass to the
4466 By default no flags are passed.
4473 daemon at boot time.
4474 .It Va iscsid_enable
4480 daemon at boot time.
4481 .It Va iscsictl_enable
4487 utility at boot time.
4488 .It Va iscsictl_flags
4494 these are the flags to pass to the
4499 which configures sessions based on the
4502 .It Va cfumass_enable
4506 create and export an USB LUN using
4511 The directory where the files exported by USB LUN are located.
4512 The default directory is
4516 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4517 .It Pa /etc/defaults/rc.conf
4519 .It Pa /etc/rc.conf.local
4549 .Xr newsyslog.conf 5 ,
4621 .An Jordan K. Hubbard .