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 whitespace-separated list of kernel modules to load right after
252 the local disks are mounted, without any
255 Loading modules at this point in the boot process is
256 much faster than doing it via
257 .Pa /boot/loader.conf
258 for those modules not necessary for mounting local disks.
259 .It Va kldxref_enable
266 to automatically rebuild
271 .It Va kldxref_clobber
281 will overwrite existing
288 .It Va kldxref_module_path
293 delimited list of paths containing
305 enable the system power control facility with the
314 these are the flags to pass to the
318 Controls the creation of a
321 Always happens if set to
323 and never happens if set to
325 If set to anything else, a memory file system is created if
329 Controls the size of a created
333 Extra options passed to the
335 utility when the memory file system for
340 which inhibits the use of softupdates on
342 so that file system space is freed without delay
343 after file truncation or deletion.
346 for other options you can use in
349 Controls the creation of a
352 Always happens if set to
354 and never happens if set to
356 If set to anything else, a memory file system is created if
360 Controls the size of a created
364 Extra options passed to the
366 utility when the memory file system for
371 which inhibits the use of softupdates on
373 so that file system space is freed without delay
374 after file truncation or deletion.
377 for other options you can use in
380 Controls the automatic population of the
383 Always happens if set to
385 and never happens if set to
387 If set to anything else, a memory file system is created if
390 Note that this process requires access to certain commands in
394 is mounted on normal systems.
395 .It Va cleanvar_enable
402 List of directories to search for startup script files.
403 .It Va script_name_sep
405 The field separator to use for breaking down the list of startup script files
406 into individual filenames.
407 The default is a space.
408 It is not necessary to change this unless there are startup scripts with names
410 .It Va hostapd_enable
419 The fully qualified domain name (FQDN) of this host on the network.
420 This should almost certainly be set to something meaningful, even if
421 there is no network connection.
424 is used to set the hostname via DHCP,
425 this variable should be set to an empty string.
428 the hostname is generally already set and this variable may absent.
429 If this value remains unset when the system is done booting
430 your console login will display the default hostname of
434 The NIS domain name of this host, or
437 .It Va dhclient_program
439 Path to the DHCP client program
440 .Pa ( /sbin/dhclient ,
445 .It Va dhclient_flags
447 Additional flags to pass to the DHCP client program.
452 manpage for a description of the command line options available.
453 .It Va dhclient_flags_ Ns Aq Ar iface
454 Additional flags to pass to the DHCP client program running on
457 When specified, this variable overrides
459 .It Va background_dhclient
463 to start the DHCP client in background.
464 This can cause trouble with applications depending on
465 a working network, but it will provide a faster startup
467 .It Va background_dhclient_ Ns Aq Ar iface
468 When specified, this variable overrides the
469 .Va background_dhclient
470 variable for interface
473 .It Va synchronous_dhclient
479 synchronously at startup.
480 This behavior can be overridden on a per-interface basis by replacing
484 .Va ifconfig_ Ns Aq Ar interface
489 .It Va defaultroute_delay
491 When set to a positive value, wait up to this long after configuring
492 DHCP interfaces at startup to give the interfaces time to receive a lease.
493 .It Va firewall_enable
497 to load firewall rules at startup.
498 If the kernel was not built with
499 .Cd "options IPFIREWALL" ,
502 kernel module will be loaded.
504 .Va ipfilter_enable .
505 .It Va firewall_script
507 This variable specifies the full path to the firewall script to run.
509 .Pa /etc/rc.firewall .
512 Names the firewall type from the selection in
513 .Pa /etc/rc.firewall ,
514 or the file which contains the local firewall ruleset.
515 Valid selections from
519 .Bl -tag -width ".Li simple" -compact
521 unrestricted IP access
523 all IP services disabled, except via
526 basic protection for a workstation
528 basic protection for a LAN.
531 If a filename is specified, the full path
533 .It Va firewall_quiet
537 to disable the display of firewall rules on the console during boot.
538 .It Va firewall_logging
542 to enable firewall event logging.
543 This is equivalent to the
544 .Dv IPFIREWALL_VERBOSE
546 .It Va firewall_logif
550 to create pseudo interface
553 For more details, see
556 .It Va firewall_flags
562 specifies a filename.
563 .It Va firewall_coscripts
565 List of executables and/or rc scripts to run after firewall starts/stops.
567 .\" ----- firewall_nat_enable setting --------------------------------
568 .It Va firewall_nat_enable
580 .It Va firewall_nat_interface
586 This is the name of the public interface or IP address on which
587 kernel NAT should run.
588 .It Va firewall_nat_flags
590 Additional configuration parameters for kernel NAT should be placed here.
591 .It Va dummynet_enable
595 will automatically load the
601 .\" -------------------------------------------------------------------
602 .It Va ipfw_netflow_enable
606 will enable netflow logging via
609 By default a ipfw rule is inserted and all packets are duplicated with
610 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
611 port using protocol version 5.
612 .It Va ipfw_netflow_hook
614 netflow hook name, must be numerical
617 .It Va ipfw_netflow_rule
622 .It Va ipfw_netflow_ip
624 Destination server ip for receiving netflow data
627 .It Va ipfw_netflow_port
629 Destination server port for receiving netflow data
632 .It Va ipfw_netflow_version
634 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
635 .It Va ipfw_netflow_fib
637 Only match packet in FIB
639 (default is undefined meaning all FIBs).
655 sockets must be enabled in the kernel.
656 If the kernel was not built with
657 .Cd "options IPDIVERT" ,
660 kernel module will be loaded.
661 .It Va natd_interface
663 This is the name of the public interface on which
666 The interface may be given as an interface name or as an IP address.
671 flags should be placed here.
676 flag is automatically added with the above
679 .\" ----- ipfilter_enable setting --------------------------------
680 .It Va ipfilter_enable
691 Typical usage will require putting
693 ipfilter_enable="YES"
711 can be enabled independently.
715 both require at least one of
725 options IPFILTER_DEFAULT_BLOCK
728 in the kernel configuration file is a good idea, too.
729 .\" ----- ipfilter_program setting ------------------------------
730 .It Va ipfilter_program
736 .\" ----- ipfilter_rules setting --------------------------------
737 .It Va ipfilter_rules
742 This variable contains the name of the filter rule definition file.
743 The file is expected to be readable for the
746 .\" ----- ipv6_ipfilter_rules setting ---------------------------
747 .It Va ipv6_ipfilter_rules
752 This variable contains the IPv6 filter rule definition file.
753 The file is expected to be readable for the
756 .\" ----- ipfilter_flags setting --------------------------------
757 .It Va ipfilter_flags
760 This variable contains flags passed to the
763 .\" ----- ipnat_enable setting ----------------------------------
773 network address translation.
776 for a detailed discussion.
777 .\" ----- ipnat_program setting ---------------------------------
784 .\" ----- ipnat_rules setting -----------------------------------
790 This variable contains the name of the file
791 holding the network address translation definition.
792 This file is expected to be readable for the
795 .\" ----- ipnat_flags setting -----------------------------------
799 This variable contains flags passed to the
802 .\" ----- ipmon_enable setting ----------------------------------
817 Setting this variable needs setting
824 for a detailed discussion.
825 .\" ----- ipmon_program setting ---------------------------------
832 .\" ----- ipmon_flags setting -----------------------------------
838 This variable contains flags passed to the
841 Another typical example would be
842 .Dq Fl D Pa /var/log/ipflog
845 log directly to a file bypassing
848 .Pa /etc/newsyslog.conf
849 in such case like this:
851 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
853 .\" ----- ipfs_enable setting -----------------------------------
863 saving the filter and NAT state tables during shutdown
864 and reloading them during startup again.
865 Setting this variable needs setting
874 for a detailed discussion.
880 because the raised securelevel will prevent
882 from saving the state tables at shutdown time.
883 .\" ----- ipfs_program setting ----------------------------------
890 .\" ----- ipfs_flags setting ------------------------------------
894 This variable contains flags passed to the
897 .\" ----- end of added ipf hook ---------------------------------
909 Typical usage will require putting
924 into the kernel, otherwise the
925 kernel module will be loaded.
930 ruleset configuration file
945 these flags are passed to the
947 program when loading the ruleset.
957 which logs packets from the
970 .Pa /var/log/pflog ) .
972 .Pa /etc/newsyslog.conf
973 to adjust logfile rotation for this.
983 This variable contains additional flags passed to the
986 .It Va pflog_instances
988 If logging to more than one
990 interface is desired,
992 is set to the list of
994 instances that should be started at system boot time.
997 is set, for each whitespace-separated
1000 .Ao Ar element Ac Ns Va _dev
1002 .Ao Ar element Ac Ns Va _logfile
1003 elements are assumed to exist.
1004 .Ao Ar element Ac Ns Va _dev
1007 interface to be watched by the named
1010 .Ao Ar element Ac Ns Va _logfile
1011 must contain the name of the logfile that will be used by the
1014 .It Va ftpproxy_enable
1025 packet filter in translating ftp connections.
1026 .It Va ftpproxy_flags
1029 This variable contains additional flags passed to the
1032 .It Va ftpproxy_instances
1035 If multiple instances of
1037 are desired at boot time,
1038 .Va ftpproxy_instances
1039 should contain a whitespace-separated list of instance names.
1042 in the list, a variable named
1043 .Ao Ar element Ac Ns Va _flags
1044 should be defined, containing the command-line flags to be passed to the
1047 .It Va pfsync_enable
1056 state changes to other hosts over the network by means of
1061 must also be set then.
1062 .It Va pfsync_syncdev
1065 This variable specifies the name of the network interface
1067 should operate through.
1068 It must be set accordingly if
1072 .It Va pfsync_syncpeer
1075 This variable is optional.
1076 By default, state change messages are sent out on the synchronisation
1077 interface using IP multicast packets.
1078 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1080 When a peer address is specified using the
1082 option, the peer address is used as a destination for the pfsync
1083 traffic, and the traffic can then be protected using
1087 manpage for more details about using
1092 .It Va pfsync_ifconfig
1095 This variable can contain additional options to be passed to the
1097 command used to set up
1099 .It Va tcp_extensions
1106 disables certain TCP options as described by
1112 might help remedy such problems with connections as randomly hanging
1113 or other weird behavior.
1114 Some network devices are known
1115 to be broken with respect to these options.
1118 Set to 0 by default.
1122 .Va net.inet.tcp.log_in_vain
1124 .Va net.inet.udp.log_in_vain ,
1129 are set to the given value.
1130 .It Va tcp_keepalive
1137 will disable probing idle TCP connections to verify that the
1138 peer is still up and reachable.
1139 .It Va tcp_drop_synfin
1146 will cause the kernel to ignore TCP frames that have both
1147 the SYN and FIN flags set.
1148 This prevents OS fingerprinting, but may
1149 break some legitimate applications.
1150 .It Va icmp_drop_redirect
1157 will cause the kernel to ignore ICMP REDIRECT packets.
1160 for more information.
1161 .It Va icmp_log_redirect
1168 will cause the kernel to log ICMP REDIRECT packets.
1170 the log messages are not rate-limited, so this option should only be used
1171 for troubleshooting networks.
1174 for more information.
1175 .It Va icmp_bmcastecho
1179 to respond to broadcast or multicast ICMP ping packets.
1182 for more information.
1183 .It Va ip_portrange_first
1187 this is the first port in the default portrange.
1190 for more information.
1191 .It Va ip_portrange_last
1195 this is the last port in the default portrange.
1198 for more information.
1199 .It Va network_interfaces
1201 Set to the list of network interfaces to configure on this host or
1203 (the default) for all current interfaces.
1205 .Va network_interfaces
1206 variable to anything other than the default is deprecated.
1207 Interfaces that the administrator wishes to store configuration for,
1208 but not start at boot should be configured with the
1211 .Va ifconfig_ Ns Aq Ar interface
1212 variables as described below.
1215 .Va ifconfig_ Ns Aq Ar interface
1216 variable is also assumed to exist for each value of
1218 When an interface name contains any of the characters
1220 they are translated to
1223 The variable can contain arguments to
1225 as well as special case-insensitive keywords described below.
1226 Such keywords are removed before passing the value to
1228 while the order of the other arguments is preserved.
1230 It is possible to add IP alias entries using
1232 syntax with the address family keyword such as
1234 Assuming that the interface in question was
1236 it might look something like this:
1238 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1239 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1242 It also possible to configure multiple IP addresses in Classless
1243 Inter-Domain Routing
1246 whose each address component can be a range like
1247 .Li inet 192.0.2.5-23/24
1249 .Li inet6 2001:db8:1-f::1/64 .
1250 This notation allows address and prefix length part only,
1251 not the other address modifiers.
1252 Note that the maximum number of the generated addresses from a range
1253 specification is limited to an integer value specified in
1254 .Va netif_ipexpand_max
1257 because a small typo can unexpectedly generate a large number of addresses.
1258 The default value is
1260 It can be increased by adding the following line into
1263 netif_ipexpand_max="4096"
1267 .Li 192.0.2.5-23/24 ,
1268 the address 192.0.2.5 will be configured with the
1269 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1270 the non-conflicting netmask /32 as explained in the
1273 Note that this special netmask handling is only for
1275 not for the other address families such as
1278 With the interface in question being
1280 an example could look like:
1282 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1283 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1289 .Va ipv4_addrs_ Ns Aq Ar interface
1290 variable was supported for IPv4 CIDR address notation.
1291 It is now deprecated because the functionality was integrated into
1292 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1294 .Va ipv4_addrs_ Ns Aq Ar interface
1295 is still supported for backward compatibility.
1298 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1299 entry with an address family keyword,
1300 its contents are passed to
1302 Execution stops at the first unsuccessful access, so if
1303 something like this is present:
1305 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1306 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1307 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1308 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1311 Then note that alias4 would
1313 be added since the search would
1314 stop with the missing
1317 Because of this difficult to manage behavior,
1319 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1320 variable, which has the same functionality as
1321 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1322 and can have all of entries in a variable like the following:
1324 ifconfig_ed0_aliases="\\
1325 inet 127.0.0.251 netmask 0xffffffff \\
1326 inet 127.0.0.252 netmask 0xffffffff \\
1327 inet 127.0.0.253 netmask 0xffffffff \\
1328 inet 127.0.0.254 netmask 0xffffffff"
1331 It also supports CIDR notation.
1334 .Pa /etc/start_if. Ns Aq Ar interface
1335 file is present, it is read and executed by the
1338 before configuring the interface as specified in the
1339 .Va ifconfig_ Ns Aq Ar interface
1341 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1345 .Va vlans_ Ns Aq Ar interface
1349 interface will be created for each item in the list with the
1353 If a vlan interface's name is a number,
1354 then that number is used as the vlan tag and the new vlan interface is
1356 .Ar interface . Ns Ar tag .
1358 the vlan tag must be specified via a
1361 .Va create_args_ Ns Aq Ar interface
1364 To create a vlan device named
1368 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1371 ifconfig_em0_101="inet 192.0.2.1/24"
1374 To create a vlan device named
1378 with the vlan tag 102:
1381 create_args_myvlan="vlan 102"
1385 .Va wlans_ Ns Aq Ar interface
1389 interface will be created for each item in the list with the
1393 Further wlan cloning arguments may be passed to the
1396 command by setting the
1397 .Va create_args_ Ns Aq Ar interface
1401 devices must be created for each wireless devices as of
1407 may be specified with an
1408 .Va wlandebug_ Ns Aq Ar interface
1410 The contents of this variable will be passed directly to
1414 .Va ifconfig_ Ns Aq Ar interface
1415 contains the keyword
1417 then the interface will not be configured
1419 .Pa /etc/pccard_ether
1421 .Va network_interfaces
1425 It is possible to bring up an interface with DHCP by adding
1428 .Va ifconfig_ Ns Aq Ar interface
1430 For instance, to initialize the
1433 it is possible to use something like:
1438 If you want to configure your wireless interface with
1439 .Xr wpa_supplicant 8
1440 for use with WPA, EAP/LEAP or WEP, you need to add
1443 .Va ifconfig_ Ns Aq Ar interface
1446 On the other hand, if you want to configure your wireless interface with
1451 .Va ifconfig_ Ns Aq Ar interface
1454 will use the settings from
1455 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1457 Finally, you can add
1459 options in this variable, in addition to the
1460 .Pa /etc/start_if. Ns Aq Ar interface
1462 For instance, to configure an
1464 wireless device in station mode with an address obtained
1465 via DHCP, using WPA authentication and 802.11b mode, it is
1466 possible to use something like:
1469 ifconfig_wlan0="DHCP WPA mode 11b"
1473 .Va ifconfig_ Ns Aq Ar interface
1474 form, a fallback variable
1475 .Va ifconfig_DEFAULT
1477 It will be used for all interfaces with no
1478 .Va ifconfig_ Ns Aq Ar interface
1480 This is intended to replace the no longer supported
1484 It is also possible to rename an interface by doing:
1486 ifconfig_ed0_name="net0"
1487 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1491 This variable is deprecated.
1493 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1495 .Va ipv6_activate_all_interfaces
1500 .Dq Li inet6 accept_rtadv
1502 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1504 .Va ipv6_activate_all_interfaces
1509 This variable is deprecated.
1511 .Va ip6addrctl_policy
1516 the default address selection policy table set by
1518 will be IPv6-preferred.
1522 the default address selection policy table set by
1524 will be IPv4-preferred.
1525 .It Va ipv6_activate_all_interfaces
1527 This controls initial configuration on IPv6-capable
1528 interfaces with no corresponding
1529 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1531 Note that it is not always necessary to set this variable to
1533 to use IPv6 functionality on
1535 In most cases, just configuring
1536 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1541 all interfaces which do not have a corresponding
1542 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1543 variable will be marked as
1546 This means that all of IPv6 functionality on that interface
1547 is completely disabled to enforce a security policy.
1548 If the variable is set to
1550 the flag will be cleared on all of the interfaces.
1552 In most cases, just defining an
1553 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1554 for an IPv6-capable interface should be sufficient.
1555 However, if an interface is added dynamically
1556 .Pq by some tunneling protocols such as PPP, for example ,
1557 it is often difficult to define the variable in advance.
1558 In such a case, configuring the
1560 flag can be disabled by setting this variable to
1563 For more details of the
1566 .Dq Li inet6 ifdisabled ,
1576 privacy addresses will be generated for each IPv6
1577 interface as described in RFC 4941.
1578 .It Va ipv6_network_interfaces
1580 This is the IPv6 equivalent of
1581 .Va network_interfaces .
1582 Normally manual configuration of this variable is not needed.
1583 .It Va ipv6_cpe_wanif
1585 If the variable is set to an interface name,
1589 .Dq inet6 -no_radr accept_rtadv
1590 will be added to the specified interface automatically before evaluating
1591 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1595 .Va net.inet6.ip6.rfc6204w3
1597 .Va net.inet6.ip6.no_radr
1600 This means the specified interface will accept ICMPv6 Router
1601 Advertisement messages on that link and add the discovered
1602 routers into the Default Router List.
1603 While the other interfaces can still accept RA messages if the
1604 .Dq inet6 accept_rtadv
1605 option is specified, adding
1606 routes into the Default Router List will be disabled by
1613 Note that ICMPv6 Router Advertisement messages will be
1615 .Va net.inet6.ip6.forwarding
1617 .Pq packet forwarding is enabled
1619 .Va net.inet6.ip6.rfc6204w3
1624 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1626 This assigns arbitrary description to an interface.
1630 .Va net.ifdescr_maxlen
1632 This static setting may be overridden by commands
1633 started with dynamic interface configuration utilities
1636 hooks. The description can be seen with
1638 command and it may be exported with
1640 daemon using its MIB-2 module.
1641 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1643 IPv6 functionality on an interface should be configured by
1644 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1645 instead of setting ifconfig parameters in
1646 .Va ifconfig_ Ns Aq Ar interface .
1647 If this variable is empty, all of IPv6 configurations on the
1648 specified interface by other variables such as
1649 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1652 Aliases should be set by
1653 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1659 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1660 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1663 Interfaces that have an
1664 .Dq Li inet6 accept_rtadv
1666 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1667 setting will be automatically configured by SLAAC
1668 .Pq StateLess Address AutoConfiguration
1674 Note that a link-local address will be automatically configured in
1675 addition to the configured global-scope addresses because the IPv6
1676 specifications require it on each link.
1677 The address is calculated from the MAC address by using an algorithm
1684 If only a link-local address is needed on the interface,
1685 the following configuration can be used:
1687 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1690 A link-local address can also be configured manually.
1691 This is useful for the default router address of an IPv6 router
1692 so that it does not change when the network interface
1696 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1698 .It Va ipv6_prefix_ Ns Aq Ar interface
1700 If one or more prefixes are defined in
1701 .Va ipv6_prefix_ Ns Aq Ar interface
1702 addresses based on each prefix and the EUI-64 interface index will be
1703 configured on that interface.
1704 Note that this variable will be ignored when
1705 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1708 For example, the following configuration
1710 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1713 is equivalent to the following:
1715 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1716 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1717 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1718 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1721 These Subnet-Router anycast addresses will be added only when
1722 .Va ipv6_gateway_enable
1724 .It Va ipv6_default_interface
1728 this is the default output interface for scoped addresses.
1729 This works only with ipv6_gateway_enable="NO".
1730 .It Va ip6addrctl_enable
1732 This variable is to enable configuring default address selection policy table
1734 The table can be specified in another variable
1735 .Va ip6addrctl_policy .
1737 .Va ip6addrctl_policy
1738 the following keywords can be specified:
1739 .Dq Li ipv4_prefer ,
1740 .Dq Li ipv6_prefer ,
1750 installs a pre-defined policy table described in Section 2.1
1758 is specified, it attempts to read a file
1759 .Pa /etc/ip6addrctl.conf
1761 If this file is found,
1763 reads and installs it.
1764 If not found, a policy is automatically set
1766 .Va ipv6_activate_all_interfaces
1767 variable; if the variable is set to
1769 the IPv6-preferred one is used.
1770 Otherwise IPv4-preferred.
1772 The default value of
1773 .Va ip6addrctl_enable
1775 .Va ip6addrctl_policy
1781 .It Va cloned_interfaces
1783 Set to the list of clonable network interfaces to create on this host.
1784 Further cloning arguments may be passed to the
1787 command for each interface by setting the
1788 .Va create_args_ Ns Aq Ar interface
1790 If an interface name is specified with
1793 the interface will not be destroyed even when
1795 script is invoked with
1798 This is useful when reconfiguring the interface without destroying it.
1800 .Va cloned_interfaces
1801 are automatically appended to
1802 .Va network_interfaces
1804 .It Va cloned_interfaces_sticky
1806 This variable is to globally enable functionality of
1809 .Va cloned_interfaces
1811 The default value is
1813 Even if this variable is specified to
1816 keyword can be used to override it on per interface basis.
1817 .It Va gif_interfaces
1819 This variable is deprecated in favor of
1820 .Va cloned_interfaces .
1823 tunnel interfaces to configure on this host.
1826 tunnel interface, set a variable named
1827 .Va ifconfig_ Ns Aq Ar interface
1828 with the parameters for the
1830 command to configure the link level for
1835 The value of this variable is used to configure the link layer of the
1840 For example, configure two
1843 .Bd -literal -offset indent
1844 gif_interfaces="gif0 gif1"
1845 ifconfig_gif0="tunnel src_addr0 dst_addr0"
1846 ifconfig_gif1="tunnel src_addr1 dst_addr1"
1849 Additionally, this option ensures that each listed interface is created
1854 This example also works with
1855 .Va cloned_interfaces
1857 .Va gif_interfaces .
1858 .It Va sppp_interfaces
1862 interfaces to configure on this host.
1864 .Va spppconfig_ Ns Aq Ar interface
1865 variable is assumed to exist for each value of
1867 Each interface should also be configured by a general
1868 .Va ifconfig_ Ns Aq Ar interface
1872 for more information about available options.
1882 The name of the profile to use from
1883 .Pa /etc/ppp/ppp.conf .
1884 Also used for per-profile overrides of
1889 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1890 When the profile name contains any of the characters
1892 they are translated to
1894 for the proposes of the override variable names.
1897 Mode in which to run the
1900 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1902 Overrides the global
1912 See the manual for a full description.
1917 enables network address translation.
1918 Used in conjunction with
1920 allows hosts on private network addresses access to the Internet using
1921 this host as a network address translating router.
1922 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1924 Overrides the global
1928 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1930 Set the unit number to be used for this profile.
1931 See the manual description of
1936 The name of the user under which
1944 .It Va rc_conf_files
1946 This option is used to specify a list of files that will override
1948 .Pa /etc/defaults/rc.conf .
1949 The files will be read in the order in which they are specified and should
1950 include the full path to the file.
1951 By default, the files specified are
1954 .Pa /etc/rc.conf.local
1960 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1962 .It Va gptboot_enable
1966 .Pa /etc/rc.d/gptboot
1967 will log if the system successfully (or not) booted from a GPT partition,
1973 .It Va gbde_autoattach_all
1978 will attempt to automatically initialize your .bde devices in
1982 List the devices that the script should try to attach,
1987 The directory where the
1989 lockfiles are located.
1990 The default lockfile directory is
1993 The lockfile for each individual
1995 device can be overridden by setting the variable
1996 .Va gbde_lock_ Ns Aq Ar device ,
1999 is the encrypted device without the
2004 .It Va gbde_attach_attempts
2006 Number of times to attempt attaching to a
2008 device, i.e., how many times the user is asked for the pass-phrase.
2012 List of devices to automatically attach on boot.
2013 Note that .eli devices from
2015 are automatically appended to this list.
2018 List of groups containing devices to automatically attach on boot with the same
2019 keyfiles and passphrase.
2020 This must be accompanied with a corresponding
2021 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2025 Number of times user is asked for the pass-phrase.
2026 If empty, it will be taken from
2027 .Va kern.geom.eli.tries
2029 .It Va geli_default_flags
2031 Default flags to use by
2033 when configuring disk encryption.
2034 Flags can be configured for every device separately by defining the
2035 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2036 variable, and for every group separately by defining the
2037 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2039 .It Va geli_autodetach
2041 Specifies if GELI devices should be marked for detach on last close after
2042 file systems are mounted.
2045 This can be changed for every device separately by defining the
2046 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2048 .It Va root_rw_mount
2053 After the file systems are checked at boot time, the root file system
2054 is remounted as read-write if this is set to
2056 Diskless systems that mount their root file system from a read-only remote
2057 NFS share should set this to
2061 .It Va fsck_y_enable
2066 will be run with the
2068 flag if the initial preen
2069 of the file systems fails.
2070 .It Va background_fsck
2074 the system will not attempt to run
2076 in the background where possible.
2077 .It Va background_fsck_delay
2079 The amount of time in seconds to sleep before starting a background
2081 It defaults to sixty seconds to allow large applications such as
2082 the X server to start before disk I/O bandwidth is monopolized by
2084 If set to a negative number, the background file system check will be
2085 delayed indefinitely to allow the administrator to run it at a more
2087 For example it may be run from
2089 by adding a line like
2091 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2097 List of file system types that are network-based.
2098 This list should generally not be modified by end users.
2100 .Va extra_netfs_types
2102 .It Va extra_netfs_types
2104 If set to something other than
2107 this variable extends the list of file system types
2108 for which automatic mounting at startup by
2110 should be delayed until the network is initialized.
2112 a whitespace-separated list of network file system descriptor pairs,
2113 each consisting of a file system type as passed to
2115 and a human-readable, one-word description,
2118 Extending the default list in this way is only necessary
2119 when third party file system types are used.
2120 .It Va syslogd_enable
2127 .It Va syslogd_program
2132 .Pa /usr/sbin/syslogd ) .
2133 .It Va syslogd_flags
2139 these are the flags to pass to
2148 .It Va inetd_program
2153 .Pa /usr/sbin/inetd ) .
2160 these are the flags to pass to
2169 .It Va hastd_program
2181 these are the flags to pass to
2183 .It Va local_unbound_enable
2189 daemon as a local caching resolver.
2194 to start a Kerberos 5 authentication server
2202 this is the path to Kerberos 5 Authentication Server.
2206 This variable contains additional flags to be passed to the Kerberos 5
2207 authentication server.
2208 .It Va kadmind_enable
2214 the Kerberos 5 Administration Daemon; set to
2217 .It Va kadmind_program
2223 this is the path to Kerberos 5 Administration Daemon.
2224 .It Va kpasswdd_enable
2230 the Kerberos 5 Password-Changing Daemon; set to
2233 .It Va kpasswdd_program
2239 this is the path to Kerberos 5 Password-Changing Daemon.
2246 the Kerberos 5 ticket forwarding daemon, at the boot time.
2252 .Pa /usr/libexec/kfd ) .
2259 daemon at boot time.
2266 these are the flags to pass to it.
2273 daemon at boot time.
2280 these are the flags to pass to it.
2283 manpage for more information.
2284 .It Va amd_map_program
2287 the specified program is run to get the list of
2292 maps are stored in NIS, one can set this to
2305 will be updated at boot time to reflect the kernel release
2310 will not be updated.
2311 .It Va nfs_client_enable
2315 run the NFS client daemons at boot time.
2316 .It Va nfs_access_cache
2319 .Va nfs_client_enable
2324 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2326 results should be cached.
2327 A value of 2-10 seconds will substantially reduce network
2328 traffic for many NFS operations.
2329 .It Va nfs_server_enable
2333 run the NFS server daemons at boot time.
2334 .It Va nfs_server_flags
2337 .Va nfs_server_enable
2340 these are the flags to pass to the
2343 .It Va nfsv4_server_enable
2346 .Va nfs_server_enable
2350 .Va nfsv4_server_enable
2353 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2354 .It Va nfsuserd_enable
2360 run the nfsuserd daemon, which is needed for NFSv4 in order
2361 to map between user/group names vs uid/gid numbers.
2363 .Va nfsv4_server_enable
2366 this will be forced enabled.
2367 .It Va nfsuserd_flags
2373 these are the flags to pass to the
2376 .It Va nfscbd_enable
2382 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2389 these are the flags to pass to the
2392 .It Va mountd_enable
2397 .Va nfs_server_enable
2403 It is commonly needed to run CFS without real NFS used.
2410 these are the flags to pass to the
2413 .It Va weak_mountd_authentication
2417 allow services like PCNFSD to make non-privileged mount
2419 .It Va nfs_reserved_port_only
2423 provide NFS services only on a secure port.
2424 .It Va nfs_bufpackets
2426 If set to a number, indicates the number of packets worth of
2427 socket buffer space to reserve on an NFS client.
2428 The kernel default is typically 4.
2429 Using a higher number may be
2430 useful on gigabit networks to improve performance.
2431 The minimum value is
2432 2 and the maximum is 64.
2433 .It Va rpc_lockd_enable
2437 and also an NFS server or client, run
2440 .It Va rpc_lockd_flags
2443 .Va rpc_lockd_enable
2446 these are the flags to pass to the
2449 .It Va rpc_statd_enable
2453 and also an NFS server or client, run
2456 .It Va rpc_statd_flags
2459 .Va rpc_statd_enable
2462 these are the flags to pass to the
2465 .It Va rpcbind_program
2470 .Pa /usr/sbin/rpcbind ) .
2471 .It Va rpcbind_enable
2477 service at boot time.
2478 .It Va rpcbind_flags
2484 these are the flags to pass to the
2487 .It Va keyserv_enable
2493 daemon on boot for running Secure RPC.
2494 .It Va keyserv_flags
2500 these are the flags to pass to
2503 .It Va pppoed_enable
2509 daemon at boot time to provide PPP over Ethernet services.
2510 .It Va pppoed_ Ns Aq Ar provider
2513 listens to requests to this
2519 argument of the same name.
2522 Additional flags to pass to
2524 .It Va pppoed_interface
2526 The network interface to run
2529 This is mandatory when
2539 service at boot time.
2540 This command is intended for networks of
2541 machines where a consistent
2543 for all hosts must be established.
2544 This is often useful in large NFS
2545 environments where time stamps on files are expected to be consistent
2553 these are the flags to pass to the
2556 .It Va ntpdate_enable
2563 This command is intended to
2564 synchronize the system clock only
2566 from some standard reference.
2568 Note that the use of the
2569 .Va ntpd_sync_on_start
2570 variable is a preferred alternative to the
2574 is to be retired from the NTP distribution.
2575 .It Va ntpdate_config
2577 Configuration file for
2581 .It Va ntpdate_hosts
2583 A whitespace-separated list of NTP servers to synchronize with at startup.
2584 The default is to use the servers listed in
2585 .Va ntpdate_config ,
2586 if that file exists.
2587 .It Va ntpdate_program
2592 .Pa /usr/sbin/ntpdate ) .
2593 .It Va ntpdate_flags
2599 these are the flags to pass to the
2601 command (typically a hostname).
2608 command at boot time.
2614 .Pa /usr/sbin/ntpd ) .
2628 these are the flags to pass to the
2631 .It Va ntpd_sync_on_start
2638 flag, which syncs the system's clock on startup.
2641 for more information regarding the
2644 This is a preferred alternative to using
2649 .It Va nis_client_enable
2655 service at system boot time.
2656 .It Va nis_client_flags
2659 .Va nis_client_enable
2662 these are the flags to pass to the
2665 .It Va nis_ypldap_enable
2671 daemon at system boot time.
2672 .It Va nis_ypldap_flags
2675 .Va nis.ypldap_enable
2678 these are the flags to pass to the
2681 .It Va nis_ypset_enable
2687 daemon at system boot time.
2688 .It Va nis_ypset_flags
2691 .Va nis_ypset_enable
2694 these are the flags to pass to the
2697 .It Va nis_server_enable
2703 daemon at system boot time.
2704 .It Va nis_server_flags
2707 .Va nis_server_enable
2710 these are the flags to pass to the
2713 .It Va nis_ypxfrd_enable
2719 daemon at system boot time.
2720 .It Va nis_ypxfrd_flags
2723 .Va nis_ypxfrd_enable
2726 these are the flags to pass to the
2729 .It Va nis_yppasswdd_enable
2735 daemon at system boot time.
2736 .It Va nis_yppasswdd_flags
2739 .Va nis_yppasswdd_enable
2742 these are the flags to pass to the
2745 .It Va rpc_ypupdated_enable
2751 daemon at system boot time.
2752 .It Va bsnmpd_enable
2758 daemon at system boot time.
2759 Be sure to understand the security implications of running SNMP daemon
2767 these are the flags to pass to the
2770 .It Va defaultrouter
2774 create a default route to this host name or IP address
2775 (use an IP address if this router is also required to get to the
2777 .It Va ipv6_defaultrouter
2779 The IPv6 equivalent of
2781 .It Va static_arp_pairs
2783 Set to the list of static ARP pairs that are to be added at system
2785 For each whitespace separated
2788 .Va static_arp_ Ns Aq Ar element
2789 variable is assumed to exist whose contents will later be passed to a
2794 static_arp_pairs="gw"
2795 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2797 .It Va static_ndp_pairs
2799 Set to the list of static NDP pairs that are to be added at system
2801 For each whitespace separated
2804 .Va static_ndp_ Ns Aq Ar element
2805 variable is assumed to exist whose contents will later be passed to a
2810 static_ndp_pairs="gw"
2811 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2813 .It Va static_routes
2815 Set to the list of static routes that are to be added at system
2819 then for each whitespace separated
2822 .Va route_ Ns Aq Ar element
2823 variable is assumed to exist
2824 whose contents will later be passed to a
2829 static_routes="ext mcast:gif0 gif0local:gif0"
2830 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2831 route_mcast="-net 224.0.0.0/4 -iface gif0"
2832 route_gif0local="-host 169.254.1.1 -iface lo0"
2839 the route is specific to the interface
2841 .It Va ipv6_static_routes
2843 The IPv6 equivalent of
2847 then for each whitespace separated
2850 .Va ipv6_route_ Ns Aq Ar element
2851 variable is assumed to exist
2852 whose contents will later be passed to a
2853 .Dq Nm route Cm add Fl inet6
2855 .It Va gateway_enable
2859 configure host to act as an IP router, e.g.\& to forward packets
2861 .It Va ipv6_gateway_enable
2863 The IPv6 equivalent of
2864 .Va gateway_enable .
2865 .It Va routed_enable
2869 run a routing daemon of some sort, based on the
2874 .It Va route6d_enable
2876 The IPv6 equivalent of
2880 run a routing daemon of some sort, based on the
2885 .It Va routed_program
2891 this is the name of the routing daemon to use.
2892 .It Va route6d_program
2894 The IPv6 equivalent of
2895 .Va routed_program .
2902 these are the flags to pass to the routing daemon.
2903 .It Va route6d_flags
2905 The IPv6 equivalent of
2907 .It Va rtadvd_enable
2913 daemon at boot time.
2916 utility sends ICMPv6 Router Advertisement messages to
2917 the interfaces specified in
2918 .Va rtadvd_interfaces .
2919 This should only be enabled with great care.
2920 You may want to fine-tune
2922 .It Va rtadvd_interfaces
2928 this is the list of interfaces to use.
2933 enable global proxy ARP.
2934 .It Va forward_sourceroute
2942 source-routed packets are forwarded.
2943 .It Va accept_sourceroute
2947 the system will accept source-routed packets directed at it.
2954 daemon at system boot time.
2961 these are the flags to pass to the
2964 .It Va bootparamd_enable
2970 daemon at system boot time.
2971 .It Va bootparamd_flags
2974 .Va bootparamd_enable
2977 these are the flags to pass to the
2980 .It Va stf_interface_ipv4addr
2984 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2986 Specify this entry to enable the 6to4 interface.
2987 .It Va stf_interface_ipv4plen
2989 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2990 An effective value is 0-31.
2991 .It Va stf_interface_ipv6_ifid
2993 IPv6 interface ID for
2997 .It Va stf_interface_ipv6_slaid
2999 IPv6 Site Level Aggregator for
3001 .It Va ipv6_ipv4mapping
3005 this enables IPv4 mapped IPv6 address communication (like
3006 .Li ::ffff:a.b.c.d ) .
3007 .It Va rtsold_enable
3013 daemon to send ICMPv6 Router Solicitation messages.
3020 these are the flags to pass to
3024 For interfaces configured with the
3025 .Dq Li inet6 accept_rtadv
3026 keyword, these are the flags to pass to
3031 is mutually exclusive to
3037 The keyboard bell sound.
3044 if the default behavior is desired.
3045 For details, refer to the
3050 If set to a non-null string, the virtual console's keyboard input is
3056 no keymap is installed, otherwise the value is used to install
3057 the keymap file found in
3058 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3061 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3066 The keyboard repeat speed.
3073 if the default behavior is desired.
3078 attempt to program the function keys with the value.
3080 be a single string of the form:
3081 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3084 Can be set to the value of
3087 .Dq Li destructive ,
3090 to set the cursor behavior explicitly or choose the default behavior.
3095 no screen map is installed, otherwise the value is used to install
3096 the screen map file in
3097 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3098 This parameter is ignored when using
3100 as the console driver.
3105 the default 8x16 font value is used for screen size requests, otherwise
3107 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3109 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3110 is used (depending on the console driver being used).
3115 the default 8x14 font value is used for screen size requests, otherwise
3117 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3119 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3120 is used (depending on the console driver being used).
3125 the default 8x8 font value is used for screen size requests, otherwise
3127 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3129 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3130 is used (depending on the console driver being used).
3135 the default screen blanking interval is used, otherwise it is set
3143 this is the actual screen saver to use
3144 .Li ( blank , snake , daemon ,
3146 .It Va moused_nondefault_enable
3150 the mouse device specified on
3151 the command line is not automatically treated as enabled by the
3152 .Pa /etc/rc.d/moused
3154 Having this variable set to
3160 to be enabled as soon as it is plugged in.
3161 .It Va moused_enable
3167 daemon is started for doing cut/paste selection on the console.
3170 This is the protocol type of the mouse connected to this host.
3171 This variable must be set if
3178 is able to detect the appropriate mouse type automatically in many cases.
3179 Set this variable to
3181 to let the daemon detect it, or
3182 select one from the following list if the automatic detection fails.
3184 If the mouse is attached to the PS/2 mouse port, choose
3188 regardless of the brand and model of the mouse.
3190 mouse is attached to the bus mouse port, choose
3194 All other protocols are for serial mice and will not work with
3195 the PS/2 and bus mice.
3196 If this is a USB mouse,
3198 is the only protocol type which will work.
3200 .Bl -tag -width ".Li x10mouseremote" -compact
3202 Microsoft mouse (serial)
3204 Microsoft IntelliMouse (serial)
3206 Mouse systems Corp.\& mouse (serial)
3208 MM Series mouse (serial)
3210 Logitech mouse (serial)
3214 Logitech MouseMan and TrackMan (serial)
3216 ALPS GlidePoint (serial)
3217 .It Li thinkingmouse
3218 Kensington ThinkingMouse (serial)
3222 MM HitTablet (serial)
3223 .It Li x10mouseremote
3224 X10 MouseRemote (serial)
3226 Interlink VersaPad (serial)
3229 Even if the mouse is not in the above list, it may be compatible
3230 with one in the list.
3231 Refer to the manual page for
3233 for compatibility information.
3235 It should also be noted that while this is enabled, any
3236 other client of the mouse (such as an X server) should access
3237 the mouse through the virtual mouse device,
3239 and configure it as a
3241 type mouse, since all
3242 mouse data is converted to this single canonical format when
3245 If the client program does not support the
3251 It is the second preferred type.
3258 this is the actual port the mouse is on.
3261 for a COM1 serial mouse, or
3263 for a PS/2 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
3545 .It Va firstboot_sentinel
3547 This variable specifies the full path to a
3550 If a file exists with this path,
3554 keyword will be run on startup and the sentinel file will be deleted
3555 after the boot process completes.
3556 The sentinel file must be located on a writable file system which is
3557 mounted no later than
3558 .Va early_late_divider
3559 to function properly.
3566 to enable Linux/ELF binary emulation at system initial
3568 .It Va sysvipc_enable
3572 load System V IPC primitives at boot time.
3573 .It Va clear_tmp_enable
3584 to disable removing of X11 lock files,
3585 and the removal and (secure) recreation
3586 of the various socket directories for X11
3588 .It Va ldconfig_paths
3590 Set to the list of shared library paths to use with
3594 will always be added first, so it need not appear in this list.
3595 .It Va ldconfig32_paths
3597 Set to the list of 32-bit compatibility shared library paths to
3600 .It Va ldconfig_paths_aout
3602 Set to the list of shared library paths to use with
3607 .It Va ldconfig_insecure
3611 utility normally refuses to use directories
3612 which are writable by anyone except root.
3613 Set this variable to
3615 to disable that security check during system startup.
3616 .It Va ldconfig_local_dirs
3618 Set to the list of local
3621 The names of all files in the directories listed will be
3622 passed as arguments to
3624 .It Va ldconfig_local32_dirs
3626 Set to the list of local 32-bit compatibility
3629 The names of all files in the directories listed will be
3630 passed as arguments to
3631 .Dq Nm ldconfig Fl 32 .
3632 .It Va kern_securelevel_enable
3636 to set the kernel security level at system startup.
3637 .It Va kern_securelevel
3639 The kernel security level to set at startup.
3640 The allowed range of
3642 ranges from \-1 (the compile time default) to 3 (the
3646 for the list of possible security levels and their effect
3647 on system operation.
3650 Path to the SSH server program
3651 .Pa ( /usr/sbin/sshd
3659 at system boot time.
3666 these are the flags to pass to the
3671 Path to the FTP server program
3672 .Pa ( /usr/libexec/ftpd
3680 as a stand-alone daemon at system boot time.
3687 these are the additional flags to pass to the
3690 .It Va watchdogd_enable
3696 daemon at boot time.
3697 This requires that the kernel have been compiled with a
3700 .It Va watchdogd_flags
3703 .Va watchdogd_enable
3706 these are the flags passed to the
3709 .It Va devfs_rulesets
3711 List of files containing sets of rules for
3713 .It Va devfs_system_ruleset
3715 Rule name(s) to apply to the system
3718 .It Va devfs_set_rulesets
3720 Pairs of already-mounted
3722 directories and rulesets that should be applied to them.
3723 For example: /mount/dev=ruleset_name
3724 .It Va devfs_load_rulesets
3726 If set, always load the default rulesets listed in
3727 .Va devfs_rulesets .
3728 .It Va performance_cx_lowest
3730 CPU idle state to use while on AC power.
3735 should use the lowest power state available while
3737 indicates that the lowest latency state (less power savings) should be used.
3738 .It Va performance_cpu_freq
3740 CPU clock frequency to use while on AC power.
3745 should use the lowest frequency available while
3747 indicates that the highest frequency (less power savings) should be used.
3748 .It Va economy_cx_lowest
3750 CPU idle state to use when off AC power.
3755 should use the lowest power state available while
3757 indicates that the lowest latency state (less power savings) should be used.
3758 .It Va economy_cpu_freq
3760 CPU clock frequency to use when off AC power.
3765 should use the lowest frequency available while
3767 indicates that the highest frequency (less power savings) should be used.
3772 any configured jails will not be started.
3775 The configuration filename used by
3778 The default value is
3779 .Pa /etc/jail.conf .
3780 .It Va jail_parallel_start
3784 all configured jails will be started in the background (in parallel).
3788 When set, use as default value for
3789 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3794 A space-delimited list of jail names.
3795 When left empty, all of the
3797 instances defined in the configuration file are started.
3798 The names specified in this list control the jail startup order.
3800 instances missing from
3802 must be started manually.
3805 parameter in the configuration file may override this list.
3806 .It Va jail_reverse_stop
3810 all configured jails in
3812 are stopped in reverse order.
3813 .It Va jail_* variables
3814 Note that older releases supported per-jail configuration via
3818 hostname of a jail named
3820 was able to be set by
3821 .Li jail_vjail_hostname .
3822 These per-jail configuration variables are now obsolete in favor of
3825 For backward compatibility,
3826 when per-jail configuration variables are defined,
3828 configuration files are created as
3829 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3832 The following per-jail parameters are handled by
3834 script out of their corresponding
3837 In addition to them, parameters in
3838 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3839 will be added to the configuration file.
3840 They must be a semi-colon
3848 .Bl -tag -width "host.hostname" -offset indent
3851 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3852 .It Li host.hostname
3854 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3855 .It Li exec.consolelog
3857 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3858 The default value is
3859 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3862 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3863 .It Li vnet.interface
3865 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3868 parameter will be enabled and cannot be specified with
3869 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3870 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3872 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3876 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3879 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3882 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3885 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3886 The parameter name was
3888 in some older releases.
3889 .It Li exec.prestart
3891 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3892 .It Li exec.poststart
3894 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3897 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3900 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3901 .It Li exec.poststop
3903 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3906 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3908 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3909 contain IPv4 addresses
3912 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3914 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3915 contain IPv6 addresses
3918 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3921 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3922 .It Li devfs_ruleset
3924 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3925 This must be an integer,
3927 .It Li mount.fdescfs
3929 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3930 .It Li allow.set_hostname
3932 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3933 .It Li allow.rawsocket
3935 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3936 .It Li allow.sysvipc
3938 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3940 .\" -----------------------------------------------------
3944 representing the entropy sources
3945 you wish to harvest.
3948 for more information.
3953 to disable caching entropy via
3955 Otherwise set to the directory
3956 in which the entropy files are stored.
3960 that regularly writes and rotates
3963 will be used at boot time.
3965 .Pa /var/db/entropy .
3970 to disable caching entropy through reboots.
3971 Otherwise set to the name
3972 of a file used to store cached entropy.
3973 This file should be located
3974 on a file system that is readable
3975 before all the volumes specified in
3982 .Pa /var/db/entropy-file
3983 is found it will also be used.
3984 This will be of some use to
3986 .It Va entropy_boot_file
3991 very early caching entropy
3993 Otherwise set to the filename
3995 very early reboot cached entropy.
3996 This file should be located where
4001 The default location is
4003 .It Va entropy_save_sz
4005 Size of the entropy cache files saved by
4008 .It Va entropy_save_num
4010 Number of entropy cache files to save by
4024 Configuration file for
4033 .Pa /var/run/dmesg.boot
4035 .It Va rcshutdown_timeout
4037 If set, start a watchdog timer in the background which will terminate
4041 has not completed within the specified time (in seconds).
4042 Notice that in addition to this soft timeout,
4044 also applies a hard timeout for the execution of
4046 This is configured via
4049 .Va kern.init_shutdown_timeout
4050 and defaults to 120 seconds.
4051 Setting the value of
4052 .Va rcshutdown_timeout
4053 to more than 120 seconds will have no effect until the
4056 .Va kern.init_shutdown_timeout
4058 .It Va virecover_enable
4062 to prevent the system from trying to
4063 recover pre-maturely terminated
4066 .It Va ugidfw_enable
4071 .Xr mac_bsdextended 4
4072 module upon system initialization and load a default
4074 .It Va bsdextended_script
4077 .Xr mac_bsdextended 4
4078 ruleset file to load.
4079 The default value of this variable is
4080 .Pa /etc/rc.bsdextended .
4081 .It Va newsyslog_enable
4088 .It Va newsyslog_flags
4091 .Va newsyslog_enable
4094 these are the flags to pass to the
4099 which causes log files flagged with a
4102 .It Va mdconfig_md Ns Aq Ar X
4112 must be specified and either a
4114 for malloc or swap backed
4122 .Va mdconfig_md Ns Aq Ar X
4123 variables are evaluated until one variable is unset or null.
4124 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4126 Optional arguments passed to
4132 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4134 An ownership specification passed to
4143 device and the mount point will be changed.
4144 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4146 A mode string passed to
4155 device and the mount point will be changed.
4156 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4158 Files to be copied to the mount point of the
4162 after it has been mounted.
4163 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4165 Command to execute after the specified
4170 Note that the command is passed to
4176 variables can be used to reference respectively the
4178 device and the mount point.
4183 one could set the following:
4185 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4187 .It Va autobridge_interfaces
4189 Set to the list of bridge interfaces that will have newly arriving interfaces
4190 checked against to be automatically added.
4193 then for each whitespace separated
4196 .Va autobridge_ Ns Aq Ar element
4197 variable is assumed to exist which has a whitespace separated list of interface
4198 names to match, these names can use wildcards.
4201 autobridge_interfaces="bridge0"
4202 autobridge_bridge0="tap* dc0 vlan[345]"
4208 enable support for sound mixer.
4209 .It Va hcsecd_enable
4213 enable Bluetooth security daemon.
4214 .It Va hcsecd_config
4216 Configuration file for
4219 .Pa /etc/bluetooth/hcsecd.conf .
4224 enable Bluetooth Service Discovery Protocol daemon.
4232 .It Va sdpd_groupname
4236 group to run as after it initializes.
4239 .It Va sdpd_username
4243 user to run as after it initializes.
4246 .It Va bthidd_enable
4250 enable Bluetooth Human Interface Device daemon.
4251 .It Va bthidd_config
4253 Configuration file for
4256 .Pa /etc/bluetooth/bthidd.conf .
4259 Path to a file, where
4261 will store information about known HID devices.
4263 .Pa /var/db/bthidd.hids .
4264 .It Va rfcomm_pppd_server_enable
4268 enable Bluetooth RFCOMM PPP wrapper daemon.
4269 .It Va rfcomm_pppd_server_profile
4271 The name of the profile to use from
4272 .Pa /etc/ppp/ppp.conf .
4273 Multiple profiles can be specified here.
4274 Also used to specify per-profile overrides.
4275 When the profile name contains any of the characters
4277 they are translated to
4279 for the proposes of the override variable names.
4280 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4282 Overrides local address to listen on.
4288 The address can be specified as BD_ADDR or name.
4289 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4291 Overrides local RFCOMM channel to listen on.
4294 will listen on RFCOMM channel 1.
4295 Must set properly if multiple profiles used in the same time.
4296 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4300 if it should register Serial Port service on the specified RFCOMM channel.
4303 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4307 if it should register Dial-Up Networking service on the specified
4311 .It Va ubthidhci_enable
4315 change the USB Bluetooth controller from HID mode to HCI mode.
4316 You also need to specify the location of USB Bluetooth controller with the
4317 .Va ubthidhci_busnum
4321 .It Va ubthidhci_busnum
4322 Bus number where the USB Bluetooth controller is located.
4325 on your system to find this information.
4326 .It Va ubthidhci_addr
4327 Bus address of the USB Bluetooth controller.
4330 on your system to find this information.
4331 .It Va netwait_enable
4335 delays the start of network-reliant services until
4337 is up and ICMP packets to a destination defined in
4340 Link state is examined first, followed by
4342 an IP address to verify network usability.
4343 If no destination can be reached or timeouts are exceeded,
4344 network services are started anyway with no guarantee that
4345 the network is usable.
4346 Use of this variable requires both
4354 This variable contains a space-delimited list of IP addresses to
4356 DNS hostnames should not be used as resolution is not guaranteed
4357 to be functional at this point.
4358 If multiple IP addresses are specified,
4359 each will be tried until one is successful or the list is exhausted.
4360 .It Va netwait_timeout
4362 Indicates the total number of seconds to perform a
4364 against each IP address in
4366 at a rate of one ping per second.
4367 If any of the pings are successful,
4368 full network connectivity is considered reliable.
4373 Defines the name of the network interface on which watch for link.
4375 is used to monitor the interface, looking for
4376 .Dq Li status: no carrier .
4377 Once gone, the link is considered up.
4380 interface if desired.
4381 .It Va netwait_if_timeout
4383 Defines the total number of seconds to wait for link to become usable,
4384 polled at a 1-second interval.
4392 rules from the defined ruleset.
4393 The kernel must be built with
4396 .Cd "options RCTL" .
4402 This variables contains the
4408 A space-separated list of configuration files used by
4410 The default value is an empty string.
4411 .It Va autofs_enable
4421 daemons at boot time.
4422 .It Va automount_flags
4428 these are the flags to pass to the
4431 By default no flags are passed.
4432 .It Va automountd_flags
4438 these are the flags to pass to the
4441 By default no flags are passed.
4442 .It Va autounmountd_flags
4448 these are the flags to pass to the
4451 By default no flags are passed.
4458 daemon at boot time.
4459 .It Va iscsid_enable
4465 daemon at boot time.
4466 .It Va iscsictl_enable
4472 utility at boot time.
4473 .It Va iscsictl_flags
4479 these are the flags to pass to the
4484 which configures sessions based on the
4487 .It Va cfumass_enable
4491 create and export an USB LUN using
4496 The directory where the files exported by USB LUN are located.
4497 The default directory is
4499 .It Va service_delete_empty
4503 .Ql Li service delete
4509 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4510 .It Pa /etc/defaults/rc.conf
4512 .It Pa /etc/rc.conf.local
4542 .Xr newsyslog.conf 5 ,
4615 .An Jordan K. Hubbard .