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.
424 If this value remains unset when the system is done booting
425 your console login will display the default hostname of
429 The NIS domain name of this host, or
432 .It Va dhclient_program
434 Path to the DHCP client program
435 .Pa ( /sbin/dhclient ,
440 .It Va dhclient_flags
442 Additional flags to pass to the DHCP client program.
447 manpage for a description of the command line options available.
448 .It Va dhclient_flags_ Ns Aq Ar iface
449 Additional flags to pass to the DHCP client program running on
452 When specified, this variable overrides
454 .It Va background_dhclient
458 to start the DHCP client in background.
459 This can cause trouble with applications depending on
460 a working network, but it will provide a faster startup
462 .It Va background_dhclient_ Ns Aq Ar iface
463 When specified, this variable overrides the
464 .Va background_dhclient
465 variable for interface
468 .It Va synchronous_dhclient
474 synchronously at startup.
475 This behavior can be overridden on a per-interface basis by replacing
479 .Va ifconfig_ Ns Aq Ar interface
484 .It Va defaultroute_delay
486 When set to a positive value, wait up to this long after configuring
487 DHCP interfaces at startup to give the interfaces time to receive a lease.
488 .It Va firewall_enable
492 to load firewall rules at startup.
493 If the kernel was not built with
494 .Cd "options IPFIREWALL" ,
497 kernel module will be loaded.
499 .Va ipfilter_enable .
500 .It Va firewall_script
502 This variable specifies the full path to the firewall script to run.
504 .Pa /etc/rc.firewall .
507 Names the firewall type from the selection in
508 .Pa /etc/rc.firewall ,
509 or the file which contains the local firewall ruleset.
510 Valid selections from
514 .Bl -tag -width ".Li simple" -compact
516 unrestricted IP access
518 all IP services disabled, except via
521 basic protection for a workstation
523 basic protection for a LAN.
526 If a filename is specified, the full path
528 .It Va firewall_quiet
532 to disable the display of firewall rules on the console during boot.
533 .It Va firewall_logging
537 to enable firewall event logging.
538 This is equivalent to the
539 .Dv IPFIREWALL_VERBOSE
541 .It Va firewall_logif
545 to create pseudo interface
548 For more details, see
551 .It Va firewall_flags
557 specifies a filename.
558 .It Va firewall_coscripts
560 List of executables and/or rc scripts to run after firewall starts/stops.
562 .\" ----- firewall_nat_enable setting --------------------------------
563 .It Va firewall_nat_enable
575 .It Va firewall_nat_interface
581 This is the name of the public interface or IP address on which
582 kernel NAT should run.
583 .It Va firewall_nat_flags
585 Additional configuration parameters for kernel NAT should be placed here.
586 .It Va dummynet_enable
590 will automatically load the
596 .\" -------------------------------------------------------------------
597 .It Va ipfw_netflow_enable
601 will enable netflow logging via
604 By default a ipfw rule is inserted and all packets are duplicated with
605 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
606 port using protocol version 5.
607 .It Va ipfw_netflow_hook
609 netflow hook name, must be numerical
612 .It Va ipfw_netflow_rule
617 .It Va ipfw_netflow_ip
619 Destination server ip for receiving netflow data
622 .It Va ipfw_netflow_port
624 Destination server port for receiving netflow data
627 .It Va ipfw_netflow_version
629 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
630 .It Va ipfw_netflow_fib
632 Only match packet in FIB
634 (default is undefined meaning all FIBs).
650 sockets must be enabled in the kernel.
651 If the kernel was not built with
652 .Cd "options IPDIVERT" ,
655 kernel module will be loaded.
656 .It Va natd_interface
658 This is the name of the public interface on which
661 The interface may be given as an interface name or as an IP address.
666 flags should be placed here.
671 flag is automatically added with the above
674 .\" ----- ipfilter_enable setting --------------------------------
675 .It Va ipfilter_enable
686 Typical usage will require putting
688 ipfilter_enable="YES"
706 can be enabled independently.
710 both require at least one of
720 options IPFILTER_DEFAULT_BLOCK
723 in the kernel configuration file is a good idea, too.
724 .\" ----- ipfilter_program setting ------------------------------
725 .It Va ipfilter_program
731 .\" ----- ipfilter_rules setting --------------------------------
732 .It Va ipfilter_rules
737 This variable contains the name of the filter rule definition file.
738 The file is expected to be readable for the
741 .\" ----- ipv6_ipfilter_rules setting ---------------------------
742 .It Va ipv6_ipfilter_rules
747 This variable contains the IPv6 filter rule definition file.
748 The file is expected to be readable for the
751 .\" ----- ipfilter_flags setting --------------------------------
752 .It Va ipfilter_flags
755 This variable contains flags passed to the
758 .\" ----- ipnat_enable setting ----------------------------------
768 network address translation.
771 for a detailed discussion.
772 .\" ----- ipnat_program setting ---------------------------------
779 .\" ----- ipnat_rules setting -----------------------------------
785 This variable contains the name of the file
786 holding the network address translation definition.
787 This file is expected to be readable for the
790 .\" ----- ipnat_flags setting -----------------------------------
794 This variable contains flags passed to the
797 .\" ----- ipmon_enable setting ----------------------------------
812 Setting this variable needs setting
819 for a detailed discussion.
820 .\" ----- ipmon_program setting ---------------------------------
827 .\" ----- ipmon_flags setting -----------------------------------
833 This variable contains flags passed to the
836 Another typical example would be
837 .Dq Fl D Pa /var/log/ipflog
840 log directly to a file bypassing
843 .Pa /etc/newsyslog.conf
844 in such case like this:
846 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
848 .\" ----- ipfs_enable setting -----------------------------------
858 saving the filter and NAT state tables during shutdown
859 and reloading them during startup again.
860 Setting this variable needs setting
869 for a detailed discussion.
875 because the raised securelevel will prevent
877 from saving the state tables at shutdown time.
878 .\" ----- ipfs_program setting ----------------------------------
885 .\" ----- ipfs_flags setting ------------------------------------
889 This variable contains flags passed to the
892 .\" ----- end of added ipf hook ---------------------------------
904 Typical usage will require putting
919 into the kernel, otherwise the
920 kernel module will be loaded.
925 ruleset configuration file
940 these flags are passed to the
942 program when loading the ruleset.
952 which logs packets from the
965 .Pa /var/log/pflog ) .
967 .Pa /etc/newsyslog.conf
968 to adjust logfile rotation for this.
978 This variable contains additional flags passed to the
981 .It Va pflog_instances
983 If logging to more than one
985 interface is desired,
987 is set to the list of
989 instances that should be started at system boot time.
992 is set, for each whitespace-separated
995 .Ao Ar element Ac Ns Va _dev
997 .Ao Ar element Ac Ns Va _logfile
998 elements are assumed to exist.
999 .Ao Ar element Ac Ns Va _dev
1002 interface to be watched by the named
1005 .Ao Ar element Ac Ns Va _logfile
1006 must contain the name of the logfile that will be used by the
1009 .It Va ftpproxy_enable
1020 packet filter in translating ftp connections.
1021 .It Va ftpproxy_flags
1024 This variable contains additional flags passed to the
1027 .It Va ftpproxy_instances
1030 If multiple instances of
1032 are desired at boot time,
1033 .Va ftpproxy_instances
1034 should contain a whitespace-separated list of instance names.
1037 in the list, a variable named
1038 .Ao Ar element Ac Ns Va _flags
1039 should be defined, containing the command-line flags to be passed to the
1042 .It Va pfsync_enable
1051 state changes to other hosts over the network by means of
1056 must also be set then.
1057 .It Va pfsync_syncdev
1060 This variable specifies the name of the network interface
1062 should operate through.
1063 It must be set accordingly if
1067 .It Va pfsync_syncpeer
1070 This variable is optional.
1071 By default, state change messages are sent out on the synchronisation
1072 interface using IP multicast packets.
1073 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1075 When a peer address is specified using the
1077 option, the peer address is used as a destination for the pfsync
1078 traffic, and the traffic can then be protected using
1082 manpage for more details about using
1087 .It Va pfsync_ifconfig
1090 This variable can contain additional options to be passed to the
1092 command used to set up
1094 .It Va tcp_extensions
1101 disables certain TCP options as described by
1107 might help remedy such problems with connections as randomly hanging
1108 or other weird behavior.
1109 Some network devices are known
1110 to be broken with respect to these options.
1113 Set to 0 by default.
1117 .Va net.inet.tcp.log_in_vain
1119 .Va net.inet.udp.log_in_vain ,
1124 are set to the given value.
1125 .It Va tcp_keepalive
1132 will disable probing idle TCP connections to verify that the
1133 peer is still up and reachable.
1134 .It Va tcp_drop_synfin
1141 will cause the kernel to ignore TCP frames that have both
1142 the SYN and FIN flags set.
1143 This prevents OS fingerprinting, but may
1144 break some legitimate applications.
1145 .It Va icmp_drop_redirect
1152 will cause the kernel to ignore ICMP REDIRECT packets.
1155 for more information.
1156 .It Va icmp_log_redirect
1163 will cause the kernel to log ICMP REDIRECT packets.
1165 the log messages are not rate-limited, so this option should only be used
1166 for troubleshooting networks.
1169 for more information.
1170 .It Va icmp_bmcastecho
1174 to respond to broadcast or multicast ICMP ping packets.
1177 for more information.
1178 .It Va ip_portrange_first
1182 this is the first port in the default portrange.
1185 for more information.
1186 .It Va ip_portrange_last
1190 this is the last port in the default portrange.
1193 for more information.
1194 .It Va network_interfaces
1196 Set to the list of network interfaces to configure on this host or
1198 (the default) for all current interfaces.
1200 .Va network_interfaces
1201 variable to anything other than the default is deprecated.
1202 Interfaces that the administrator wishes to store configuration for,
1203 but not start at boot should be configured with the
1206 .Va ifconfig_ Ns Aq Ar interface
1207 variables as described below.
1210 .Va ifconfig_ Ns Aq Ar interface
1211 variable is also assumed to exist for each value of
1213 When an interface name contains any of the characters
1215 they are translated to
1218 The variable can contain arguments to
1220 as well as special case-insensitive keywords described below.
1221 Such keywords are removed before passing the value to
1223 while the order of the other arguments is preserved.
1225 It is possible to add IP alias entries using
1227 syntax with the address family keyword such as
1229 Assuming that the interface in question was
1231 it might look something like this:
1233 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1234 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1237 It also possible to configure multiple IP addresses in Classless
1238 Inter-Domain Routing
1241 whose each address component can be a range like
1242 .Li inet 192.0.2.5-23/24
1244 .Li inet6 2001:db8:1-f::1/64 .
1245 This notation allows address and prefix length part only,
1246 not the other address modifiers.
1247 Note that the maximum number of the generated addresses from a range
1248 specification is limited to an integer value specified in
1249 .Va netif_ipexpand_max
1252 because a small typo can unexpectedly generate a large number of addresses.
1253 The default value is
1255 It can be increased by adding the following line into
1258 netif_ipexpand_max="4096"
1262 .Li 192.0.2.5-23/24 ,
1263 the address 192.0.2.5 will be configured with the
1264 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1265 the non-conflicting netmask /32 as explained in the
1268 Note that this special netmask handling is only for
1270 not for the other address families such as
1273 With the interface in question being
1275 an example could look like:
1277 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1278 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1284 .Va ipv4_addrs_ Ns Aq Ar interface
1285 variable was supported for IPv4 CIDR address notation.
1286 It is now deprecated because the functionality was integrated into
1287 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1289 .Va ipv4_addrs_ Ns Aq Ar interface
1290 is still supported for backward compatibility.
1293 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1294 entry with an address family keyword,
1295 its contents are passed to
1297 Execution stops at the first unsuccessful access, so if
1298 something like this is present:
1300 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1301 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1302 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1303 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1306 Then note that alias4 would
1308 be added since the search would
1309 stop with the missing
1312 Because of this difficult to manage behavior,
1314 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1315 variable, which has the same functionality as
1316 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1317 and can have all of entries in a variable like the following:
1319 ifconfig_ed0_aliases="\\
1320 inet 127.0.0.251 netmask 0xffffffff \\
1321 inet 127.0.0.252 netmask 0xffffffff \\
1322 inet 127.0.0.253 netmask 0xffffffff \\
1323 inet 127.0.0.254 netmask 0xffffffff"
1326 It also supports CIDR notation.
1329 .Pa /etc/start_if. Ns Aq Ar interface
1330 file is present, it is read and executed by the
1333 before configuring the interface as specified in the
1334 .Va ifconfig_ Ns Aq Ar interface
1336 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1340 .Va vlans_ Ns Aq Ar interface
1344 interface will be created for each item in the list with the
1348 If a vlan interface's name is a number,
1349 then that number is used as the vlan tag and the new vlan interface is
1351 .Ar interface . Ns Ar tag .
1353 the vlan tag must be specified via a
1356 .Va create_args_ Ns Aq Ar interface
1359 To create a vlan device named
1363 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1366 ifconfig_em0_101="inet 192.0.2.1/24"
1369 To create a vlan device named
1373 with the vlan tag 102:
1376 create_args_myvlan="vlan 102"
1380 .Va wlans_ Ns Aq Ar interface
1384 interface will be created for each item in the list with the
1388 Further wlan cloning arguments may be passed to the
1391 command by setting the
1392 .Va create_args_ Ns Aq Ar interface
1396 devices must be created for each wireless devices as of
1402 may be specified with an
1403 .Va wlandebug_ Ns Aq Ar interface
1405 The contents of this variable will be passed directly to
1409 .Va ifconfig_ Ns Aq Ar interface
1410 contains the keyword
1412 then the interface will not be configured
1414 .Pa /etc/pccard_ether
1416 .Va network_interfaces
1420 It is possible to bring up an interface with DHCP by adding
1423 .Va ifconfig_ Ns Aq Ar interface
1425 For instance, to initialize the
1428 it is possible to use something like:
1433 If you want to configure your wireless interface with
1434 .Xr wpa_supplicant 8
1435 for use with WPA, EAP/LEAP or WEP, you need to add
1438 .Va ifconfig_ Ns Aq Ar interface
1441 On the other hand, if you want to configure your wireless interface with
1446 .Va ifconfig_ Ns Aq Ar interface
1449 will use the settings from
1450 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1452 Finally, you can add
1454 options in this variable, in addition to the
1455 .Pa /etc/start_if. Ns Aq Ar interface
1457 For instance, to configure an
1459 wireless device in station mode with an address obtained
1460 via DHCP, using WPA authentication and 802.11b mode, it is
1461 possible to use something like:
1464 ifconfig_wlan0="DHCP WPA mode 11b"
1468 .Va ifconfig_ Ns Aq Ar interface
1469 form, a fallback variable
1470 .Va ifconfig_DEFAULT
1472 It will be used for all interfaces with no
1473 .Va ifconfig_ Ns Aq Ar interface
1475 This is intended to replace the no longer supported
1479 It is also possible to rename an interface by doing:
1481 ifconfig_ed0_name="net0"
1482 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1486 This variable is deprecated.
1488 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1490 .Va ipv6_activate_all_interfaces
1495 .Dq Li inet6 accept_rtadv
1497 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1499 .Va ipv6_activate_all_interfaces
1504 This variable is deprecated.
1506 .Va ip6addrctl_policy
1511 the default address selection policy table set by
1513 will be IPv6-preferred.
1517 the default address selection policy table set by
1519 will be IPv4-preferred.
1520 .It Va ipv6_activate_all_interfaces
1522 This controls initial configuration on IPv6-capable
1523 interfaces with no corresponding
1524 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1526 Note that it is not always necessary to set this variable to
1528 to use IPv6 functionality on
1530 In most cases, just configuring
1531 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1536 all interfaces which do not have a corresponding
1537 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1538 variable will be marked as
1541 This means that all of IPv6 functionality on that interface
1542 is completely disabled to enforce a security policy.
1543 If the variable is set to
1545 the flag will be cleared on all of the interfaces.
1547 In most cases, just defining an
1548 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1549 for an IPv6-capable interface should be sufficient.
1550 However, if an interface is added dynamically
1551 .Pq by some tunneling protocols such as PPP, for example ,
1552 it is often difficult to define the variable in advance.
1553 In such a case, configuring the
1555 flag can be disabled by setting this variable to
1558 For more details of the
1561 .Dq Li inet6 ifdisabled ,
1571 privacy addresses will be generated for each IPv6
1572 interface as described in RFC 4941.
1573 .It Va ipv6_network_interfaces
1575 This is the IPv6 equivalent of
1576 .Va network_interfaces .
1577 Normally manual configuration of this variable is not needed.
1578 .It Va ipv6_cpe_wanif
1580 If the variable is set to an interface name,
1584 .Dq inet6 -no_radr accept_rtadv
1585 will be added to the specified interface automatically before evaluating
1586 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1590 .Va net.inet6.ip6.rfc6204w3
1592 .Va net.inet6.ip6.no_radr
1595 This means the specified interface will accept ICMPv6 Router
1596 Advertisement messages on that link and add the discovered
1597 routers into the Default Router List.
1598 While the other interfaces can still accept RA messages if the
1599 .Dq inet6 accept_rtadv
1600 option is specified, adding
1601 routes into the Default Router List will be disabled by
1608 Note that ICMPv6 Router Advertisement messages will be
1610 .Va net.inet6.ip6.forwarding
1612 .Pq packet forwarding is enabled
1614 .Va net.inet6.ip6.rfc6204w3
1619 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1621 This assigns arbitrary description to an interface.
1625 .Va net.ifdescr_maxlen
1627 This static setting may be overridden by commands
1628 started with dynamic interface configuration utilities
1631 hooks. The description can be seen with
1633 command and it may be exported with
1635 daemon using its MIB-2 module.
1636 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1638 IPv6 functionality on an interface should be configured by
1639 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1640 instead of setting ifconfig parameters in
1641 .Va ifconfig_ Ns Aq Ar interface .
1642 If this variable is empty, all of IPv6 configurations on the
1643 specified interface by other variables such as
1644 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1647 Aliases should be set by
1648 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1654 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1655 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1658 Interfaces that have an
1659 .Dq Li inet6 accept_rtadv
1661 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1662 setting will be automatically configured by SLAAC
1663 .Pq StateLess Address AutoConfiguration
1669 Note that a link-local address will be automatically configured in
1670 addition to the configured global-scope addresses because the IPv6
1671 specifications require it on each link.
1672 The address is calculated from the MAC address by using an algorithm
1679 If only a link-local address is needed on the interface,
1680 the following configuration can be used:
1682 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1685 A link-local address can also be configured manually.
1686 This is useful for the default router address of an IPv6 router
1687 so that it does not change when the network interface
1691 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1693 .It Va ipv6_prefix_ Ns Aq Ar interface
1695 If one or more prefixes are defined in
1696 .Va ipv6_prefix_ Ns Aq Ar interface
1697 addresses based on each prefix and the EUI-64 interface index will be
1698 configured on that interface.
1699 Note that this variable will be ignored when
1700 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1703 For example, the following configuration
1705 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1708 is equivalent to the following:
1710 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1711 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1712 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1713 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1716 These Subnet-Router anycast addresses will be added only when
1717 .Va ipv6_gateway_enable
1719 .It Va ipv6_default_interface
1723 this is the default output interface for scoped addresses.
1724 This works only with ipv6_gateway_enable="NO".
1725 .It Va ip6addrctl_enable
1727 This variable is to enable configuring default address selection policy table
1729 The table can be specified in another variable
1730 .Va ip6addrctl_policy .
1732 .Va ip6addrctl_policy
1733 the following keywords can be specified:
1734 .Dq Li ipv4_prefer ,
1735 .Dq Li ipv6_prefer ,
1745 installs a pre-defined policy table described in Section 2.1
1753 is specified, it attempts to read a file
1754 .Pa /etc/ip6addrctl.conf
1756 If this file is found,
1758 reads and installs it.
1759 If not found, a policy is automatically set
1761 .Va ipv6_activate_all_interfaces
1762 variable; if the variable is set to
1764 the IPv6-preferred one is used.
1765 Otherwise IPv4-preferred.
1767 The default value of
1768 .Va ip6addrctl_enable
1770 .Va ip6addrctl_policy
1776 .It Va cloned_interfaces
1778 Set to the list of clonable network interfaces to create on this host.
1779 Further cloning arguments may be passed to the
1782 command for each interface by setting the
1783 .Va create_args_ Ns Aq Ar interface
1785 If an interface name is specified with
1788 the interface will not be destroyed even when
1790 script is invoked with
1793 This is useful when reconfiguring the interface without destroying it.
1795 .Va cloned_interfaces
1796 are automatically appended to
1797 .Va network_interfaces
1799 .It Va cloned_interfaces_sticky
1801 This variable is to globally enable functionality of
1804 .Va cloned_interfaces
1806 The default value is
1808 Even if this variable is specified to
1811 keyword can be used to override it on per interface basis.
1812 .It Va gif_interfaces
1814 This variable is deprecated in favor of
1815 .Va cloned_interfaces .
1818 tunnel interfaces to configure on this host.
1821 tunnel interface, set a variable named
1822 .Va ifconfig_ Ns Aq Ar interface
1823 with the parameters for the
1825 command to configure the link level for
1830 The value of this variable is used to configure the link layer of the
1835 For example, configure two
1838 .Bd -literal -offset indent
1839 gif_interfaces="gif0 gif1"
1840 ifconfig_gif0="tunnel src_addr0 dst_addr0"
1841 ifconfig_gif1="tunnel src_addr1 dst_addr1"
1844 Additionally, this option ensures that each listed interface is created
1849 This example also works with
1850 .Va cloned_interfaces
1852 .Va gif_interfaces .
1853 .It Va sppp_interfaces
1857 interfaces to configure on this host.
1859 .Va spppconfig_ Ns Aq Ar interface
1860 variable is assumed to exist for each value of
1862 Each interface should also be configured by a general
1863 .Va ifconfig_ Ns Aq Ar interface
1867 for more information about available options.
1877 The name of the profile to use from
1878 .Pa /etc/ppp/ppp.conf .
1879 Also used for per-profile overrides of
1884 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1885 When the profile name contains any of the characters
1887 they are translated to
1889 for the proposes of the override variable names.
1892 Mode in which to run the
1895 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1897 Overrides the global
1907 See the manual for a full description.
1912 enables network address translation.
1913 Used in conjunction with
1915 allows hosts on private network addresses access to the Internet using
1916 this host as a network address translating router.
1917 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1919 Overrides the global
1923 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1925 Set the unit number to be used for this profile.
1926 See the manual description of
1931 The name of the user under which
1939 .It Va rc_conf_files
1941 This option is used to specify a list of files that will override
1943 .Pa /etc/defaults/rc.conf .
1944 The files will be read in the order in which they are specified and should
1945 include the full path to the file.
1946 By default, the files specified are
1949 .Pa /etc/rc.conf.local
1955 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1957 .It Va gptboot_enable
1961 .Pa /etc/rc.d/gptboot
1962 will log if the system successfully (or not) booted from a GPT partition,
1968 .It Va gbde_autoattach_all
1973 will attempt to automatically initialize your .bde devices in
1977 List the devices that the script should try to attach,
1982 The directory where the
1984 lockfiles are located.
1985 The default lockfile directory is
1988 The lockfile for each individual
1990 device can be overridden by setting the variable
1991 .Va gbde_lock_ Ns Aq Ar device ,
1994 is the encrypted device without the
1999 .It Va gbde_attach_attempts
2001 Number of times to attempt attaching to a
2003 device, i.e., how many times the user is asked for the pass-phrase.
2007 List of devices to automatically attach on boot.
2008 Note that .eli devices from
2010 are automatically appended to this list.
2013 Number of times user is asked for the pass-phrase.
2014 If empty, it will be taken from
2015 .Va kern.geom.eli.tries
2017 .It Va geli_default_flags
2019 Default flags to use by
2021 when configuring disk encryption.
2022 Flags can be configured for every device separately by defining
2023 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2025 .It Va geli_autodetach
2027 Specifies if GELI devices should be marked for detach on last close after
2028 file systems are mounted.
2031 This can be changed for every device separately by defining
2032 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2034 .It Va root_rw_mount
2039 After the file systems are checked at boot time, the root file system
2040 is remounted as read-write if this is set to
2042 Diskless systems that mount their root file system from a read-only remote
2043 NFS share should set this to
2047 .It Va fsck_y_enable
2052 will be run with the
2054 flag if the initial preen
2055 of the file systems fails.
2056 .It Va background_fsck
2060 the system will not attempt to run
2062 in the background where possible.
2063 .It Va background_fsck_delay
2065 The amount of time in seconds to sleep before starting a background
2067 It defaults to sixty seconds to allow large applications such as
2068 the X server to start before disk I/O bandwidth is monopolized by
2070 If set to a negative number, the background file system check will be
2071 delayed indefinitely to allow the administrator to run it at a more
2073 For example it may be run from
2075 by adding a line like
2077 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2083 List of file system types that are network-based.
2084 This list should generally not be modified by end users.
2086 .Va extra_netfs_types
2088 .It Va extra_netfs_types
2090 If set to something other than
2093 this variable extends the list of file system types
2094 for which automatic mounting at startup by
2096 should be delayed until the network is initialized.
2098 a whitespace-separated list of network file system descriptor pairs,
2099 each consisting of a file system type as passed to
2101 and a human-readable, one-word description,
2104 Extending the default list in this way is only necessary
2105 when third party file system types are used.
2106 .It Va syslogd_enable
2113 .It Va syslogd_program
2118 .Pa /usr/sbin/syslogd ) .
2119 .It Va syslogd_flags
2125 these are the flags to pass to
2134 .It Va inetd_program
2139 .Pa /usr/sbin/inetd ) .
2146 these are the flags to pass to
2155 .It Va hastd_program
2167 these are the flags to pass to
2169 .It Va local_unbound_enable
2175 daemon as a local caching resolver.
2180 to start a Kerberos 5 authentication server
2188 this is the path to Kerberos 5 Authentication Server.
2192 This variable contains additional flags to be passed to the Kerberos 5
2193 authentication server.
2194 .It Va kadmind_enable
2200 the Kerberos 5 Administration Daemon; set to
2203 .It Va kadmind_program
2209 this is the path to Kerberos 5 Administration Daemon.
2210 .It Va kpasswdd_enable
2216 the Kerberos 5 Password-Changing Daemon; set to
2219 .It Va kpasswdd_program
2225 this is the path to Kerberos 5 Password-Changing Daemon.
2232 the Kerberos 5 ticket forwarding daemon, at the boot time.
2238 .Pa /usr/libexec/kfd ) .
2245 daemon at boot time.
2252 these are the flags to pass to it.
2259 daemon at boot time.
2266 these are the flags to pass to it.
2269 manpage for more information.
2270 .It Va amd_map_program
2273 the specified program is run to get the list of
2278 maps are stored in NIS, one can set this to
2291 will be updated at boot time to reflect the kernel release
2296 will not be updated.
2297 .It Va nfs_client_enable
2301 run the NFS client daemons at boot time.
2302 .It Va nfs_access_cache
2305 .Va nfs_client_enable
2310 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2312 results should be cached.
2313 A value of 2-10 seconds will substantially reduce network
2314 traffic for many NFS operations.
2315 .It Va nfs_server_enable
2319 run the NFS server daemons at boot time.
2320 .It Va nfs_server_flags
2323 .Va nfs_server_enable
2326 these are the flags to pass to the
2329 .It Va nfsv4_server_enable
2332 .Va nfs_server_enable
2336 .Va nfsv4_server_enable
2339 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2340 .It Va nfsuserd_enable
2346 run the nfsuserd daemon, which is needed for NFSv4 in order
2347 to map between user/group names vs uid/gid numbers.
2349 .Va nfsv4_server_enable
2352 this will be forced enabled.
2353 .It Va nfsuserd_flags
2359 these are the flags to pass to the
2362 .It Va nfscbd_enable
2368 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2375 these are the flags to pass to the
2378 .It Va mountd_enable
2383 .Va nfs_server_enable
2389 It is commonly needed to run CFS without real NFS used.
2396 these are the flags to pass to the
2399 .It Va weak_mountd_authentication
2403 allow services like PCNFSD to make non-privileged mount
2405 .It Va nfs_reserved_port_only
2409 provide NFS services only on a secure port.
2410 .It Va nfs_bufpackets
2412 If set to a number, indicates the number of packets worth of
2413 socket buffer space to reserve on an NFS client.
2414 The kernel default is typically 4.
2415 Using a higher number may be
2416 useful on gigabit networks to improve performance.
2417 The minimum value is
2418 2 and the maximum is 64.
2419 .It Va rpc_lockd_enable
2423 and also an NFS server or client, run
2426 .It Va rpc_lockd_flags
2429 .Va rpc_lockd_enable
2432 these are the flags to pass to the
2435 .It Va rpc_statd_enable
2439 and also an NFS server or client, run
2442 .It Va rpc_statd_flags
2445 .Va rpc_statd_enable
2448 these are the flags to pass to the
2451 .It Va rpcbind_program
2456 .Pa /usr/sbin/rpcbind ) .
2457 .It Va rpcbind_enable
2463 service at boot time.
2464 .It Va rpcbind_flags
2470 these are the flags to pass to the
2473 .It Va keyserv_enable
2479 daemon on boot for running Secure RPC.
2480 .It Va keyserv_flags
2486 these are the flags to pass to
2489 .It Va pppoed_enable
2495 daemon at boot time to provide PPP over Ethernet services.
2496 .It Va pppoed_ Ns Aq Ar provider
2499 listens to requests to this
2505 argument of the same name.
2508 Additional flags to pass to
2510 .It Va pppoed_interface
2512 The network interface to run
2515 This is mandatory when
2525 service at boot time.
2526 This command is intended for networks of
2527 machines where a consistent
2529 for all hosts must be established.
2530 This is often useful in large NFS
2531 environments where time stamps on files are expected to be consistent
2539 these are the flags to pass to the
2542 .It Va ntpdate_enable
2549 This command is intended to
2550 synchronize the system clock only
2552 from some standard reference.
2553 .It Va ntpdate_config
2555 Configuration file for
2559 .It Va ntpdate_hosts
2561 A whitespace-separated list of NTP servers to synchronize with at startup.
2562 The default is to use the servers listed in
2563 .Va ntpdate_config ,
2564 if that file exists.
2565 .It Va ntpdate_program
2570 .Pa /usr/sbin/ntpdate ) .
2571 .It Va ntpdate_flags
2577 these are the flags to pass to the
2579 command (typically a hostname).
2586 command at boot time.
2592 .Pa /usr/sbin/ntpd ) .
2606 these are the flags to pass to the
2609 .It Va ntpd_sync_on_start
2616 flag, which syncs the system's clock on startup.
2619 for more information regarding the
2622 This is a preferred alternative to using
2627 .It Va nis_client_enable
2633 service at system boot time.
2634 .It Va nis_client_flags
2637 .Va nis_client_enable
2640 these are the flags to pass to the
2643 .It Va nis_ypldap_enable
2649 daemon at system boot time.
2650 .It Va nis_ypldap_flags
2653 .Va nis.ypldap_enable
2656 these are the flags to pass to the
2659 .It Va nis_ypset_enable
2665 daemon at system boot time.
2666 .It Va nis_ypset_flags
2669 .Va nis_ypset_enable
2672 these are the flags to pass to the
2675 .It Va nis_server_enable
2681 daemon at system boot time.
2682 .It Va nis_server_flags
2685 .Va nis_server_enable
2688 these are the flags to pass to the
2691 .It Va nis_ypxfrd_enable
2697 daemon at system boot time.
2698 .It Va nis_ypxfrd_flags
2701 .Va nis_ypxfrd_enable
2704 these are the flags to pass to the
2707 .It Va nis_yppasswdd_enable
2713 daemon at system boot time.
2714 .It Va nis_yppasswdd_flags
2717 .Va nis_yppasswdd_enable
2720 these are the flags to pass to the
2723 .It Va rpc_ypupdated_enable
2729 daemon at system boot time.
2730 .It Va bsnmpd_enable
2736 daemon at system boot time.
2737 Be sure to understand the security implications of running SNMP daemon
2745 these are the flags to pass to the
2748 .It Va defaultrouter
2752 create a default route to this host name or IP address
2753 (use an IP address if this router is also required to get to the
2755 .It Va ipv6_defaultrouter
2757 The IPv6 equivalent of
2759 .It Va static_arp_pairs
2761 Set to the list of static ARP pairs that are to be added at system
2763 For each whitespace separated
2766 .Va static_arp_ Ns Aq Ar element
2767 variable is assumed to exist whose contents will later be passed to a
2772 static_arp_pairs="gw"
2773 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2775 .It Va static_ndp_pairs
2777 Set to the list of static NDP pairs that are to be added at system
2779 For each whitespace separated
2782 .Va static_ndp_ Ns Aq Ar element
2783 variable is assumed to exist whose contents will later be passed to a
2788 static_ndp_pairs="gw"
2789 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2791 .It Va static_routes
2793 Set to the list of static routes that are to be added at system
2797 then for each whitespace separated
2800 .Va route_ Ns Aq Ar element
2801 variable is assumed to exist
2802 whose contents will later be passed to a
2807 static_routes="ext mcast:gif0 gif0local:gif0"
2808 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2809 route_mcast="-net 224.0.0.0/4 -iface gif0"
2810 route_gif0local="-host 169.254.1.1 -iface lo0"
2817 the route is specific to the interface
2819 .It Va ipv6_static_routes
2821 The IPv6 equivalent of
2825 then for each whitespace separated
2828 .Va ipv6_route_ Ns Aq Ar element
2829 variable is assumed to exist
2830 whose contents will later be passed to a
2831 .Dq Nm route Cm add Fl inet6
2833 .It Va gateway_enable
2837 configure host to act as an IP router, e.g.\& to forward packets
2839 .It Va ipv6_gateway_enable
2841 The IPv6 equivalent of
2842 .Va gateway_enable .
2843 .It Va routed_enable
2847 run a routing daemon of some sort, based on the
2852 .It Va route6d_enable
2854 The IPv6 equivalent of
2858 run a routing daemon of some sort, based on the
2863 .It Va routed_program
2869 this is the name of the routing daemon to use.
2870 .It Va route6d_program
2872 The IPv6 equivalent of
2873 .Va routed_program .
2880 these are the flags to pass to the routing daemon.
2881 .It Va route6d_flags
2883 The IPv6 equivalent of
2885 .It Va rtadvd_enable
2891 daemon at boot time.
2894 utility sends ICMPv6 Router Advertisement messages to
2895 the interfaces specified in
2896 .Va rtadvd_interfaces .
2897 This should only be enabled with great care.
2898 You may want to fine-tune
2900 .It Va rtadvd_interfaces
2906 this is the list of interfaces to use.
2911 enable global proxy ARP.
2912 .It Va forward_sourceroute
2920 source-routed packets are forwarded.
2921 .It Va accept_sourceroute
2925 the system will accept source-routed packets directed at it.
2932 daemon at system boot time.
2939 these are the flags to pass to the
2942 .It Va bootparamd_enable
2948 daemon at system boot time.
2949 .It Va bootparamd_flags
2952 .Va bootparamd_enable
2955 these are the flags to pass to the
2958 .It Va stf_interface_ipv4addr
2962 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2964 Specify this entry to enable the 6to4 interface.
2965 .It Va stf_interface_ipv4plen
2967 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2968 An effective value is 0-31.
2969 .It Va stf_interface_ipv6_ifid
2971 IPv6 interface ID for
2975 .It Va stf_interface_ipv6_slaid
2977 IPv6 Site Level Aggregator for
2979 .It Va ipv6_ipv4mapping
2983 this enables IPv4 mapped IPv6 address communication (like
2984 .Li ::ffff:a.b.c.d ) .
2985 .It Va rtsold_enable
2991 daemon to send ICMPv6 Router Solicitation messages.
2998 these are the flags to pass to
3002 For interfaces configured with the
3003 .Dq Li inet6 accept_rtadv
3004 keyword, these are the flags to pass to
3009 is mutually exclusive to
3015 The keyboard bell sound.
3022 if the default behavior is desired.
3023 For details, refer to the
3028 If set to a non-null string, the virtual console's keyboard input is
3034 no keymap is installed, otherwise the value is used to install
3035 the keymap file found in
3036 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3039 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3044 The keyboard repeat speed.
3051 if the default behavior is desired.
3056 attempt to program the function keys with the value.
3058 be a single string of the form:
3059 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3062 Can be set to the value of
3065 .Dq Li destructive ,
3068 to set the cursor behavior explicitly or choose the default behavior.
3073 no screen map is installed, otherwise the value is used to install
3074 the screen map file in
3075 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3076 This parameter is ignored when using
3078 as the console driver.
3083 the default 8x16 font value is used for screen size requests, otherwise
3085 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3087 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3088 is used (depending on the console driver being used).
3093 the default 8x14 font value is used for screen size requests, otherwise
3095 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3097 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3098 is used (depending on the console driver being used).
3103 the default 8x8 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 screen blanking interval is used, otherwise it is set
3121 this is the actual screen saver to use
3122 .Li ( blank , snake , daemon ,
3124 .It Va moused_nondefault_enable
3128 the mouse device specified on
3129 the command line is not automatically treated as enabled by the
3130 .Pa /etc/rc.d/moused
3132 Having this variable set to
3138 to be enabled as soon as it is plugged in.
3139 .It Va moused_enable
3145 daemon is started for doing cut/paste selection on the console.
3148 This is the protocol type of the mouse connected to this host.
3149 This variable must be set if
3156 is able to detect the appropriate mouse type automatically in many cases.
3157 Set this variable to
3159 to let the daemon detect it, or
3160 select one from the following list if the automatic detection fails.
3162 If the mouse is attached to the PS/2 mouse port, choose
3166 regardless of the brand and model of the mouse.
3168 mouse is attached to the bus mouse port, choose
3172 All other protocols are for serial mice and will not work with
3173 the PS/2 and bus mice.
3174 If this is a USB mouse,
3176 is the only protocol type which will work.
3178 .Bl -tag -width ".Li x10mouseremote" -compact
3180 Microsoft mouse (serial)
3182 Microsoft IntelliMouse (serial)
3184 Mouse systems Corp.\& mouse (serial)
3186 MM Series mouse (serial)
3188 Logitech mouse (serial)
3192 Logitech MouseMan and TrackMan (serial)
3194 ALPS GlidePoint (serial)
3195 .It Li thinkingmouse
3196 Kensington ThinkingMouse (serial)
3200 MM HitTablet (serial)
3201 .It Li x10mouseremote
3202 X10 MouseRemote (serial)
3204 Interlink VersaPad (serial)
3207 Even if the mouse is not in the above list, it may be compatible
3208 with one in the list.
3209 Refer to the manual page for
3211 for compatibility information.
3213 It should also be noted that while this is enabled, any
3214 other client of the mouse (such as an X server) should access
3215 the mouse through the virtual mouse device,
3217 and configure it as a
3219 type mouse, since all
3220 mouse data is converted to this single canonical format when
3223 If the client program does not support the
3229 It is the second preferred type.
3236 this is the actual port the mouse is on.
3239 for a COM1 serial mouse,
3243 for a bus mouse, for example.
3248 is set, its value is used as an additional set of flags to pass to the
3251 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3253 .Va moused_nondefault_enable
3256 daemon is started for a non-default port, the
3257 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3258 set of options has precedence over and replaces the default
3262 is the name of the non-default port, i.e.,\&
3265 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3266 it is possible to set up a different set of default flags for each
3269 For example, you can use
3273 to make your laptop's touchpad more comfortable to use,
3274 but an empty set of options for
3275 .Va moused_ums0_flags
3278 mouse has three or more buttons.
3279 .It Va mousechar_start
3283 the default mouse cursor character range
3284 .Li 0xd0 Ns - Ns Li 0xd3
3286 otherwise the range start is set
3291 Use if the default range is occupied in the language code table.
3292 .It Va allscreens_flags
3296 is run with these options for each of the virtual terminals
3300 will enable the mouse pointer on all virtual terminals
3305 .It Va allscreens_kbdflags
3309 is run with these options for each of the virtual terminals
3317 scrollback (history) buffer to 200 lines.
3324 daemon at system boot time.
3330 .Pa /usr/sbin/cron ) .
3337 these are the flags to pass to
3343 enable the special handling of transitions to and from the
3344 Daylight Saving Time in
3346 (equivalent to using the flag
3353 .Pa /usr/sbin/lpd ) .
3360 daemon at system boot time.
3367 these are the flags to pass to the
3370 .It Va chkprintcap_enable
3376 command before starting the
3379 .It Va chkprintcap_flags
3384 .Va chkprintcap_enable
3387 these are the flags to pass to the
3392 which causes missing directories to be created.
3393 .It Va mta_start_script
3395 This variable specifies the full path to the script to run to start
3396 a mail transfer agent.
3398 .Pa /etc/rc.sendmail .
3402 .Pa /etc/rc.sendmail
3403 uses are documented in the
3408 Indicates the device (usually a swap partition) to which a crash dump
3409 should be written in the event of a system crash.
3410 If the value of this variable is
3412 the first suitable swap device listed in
3414 will be used as dump device.
3415 Otherwise, the value of this variable is passed as the argument to
3417 To disable crash dumps, set this variable to
3425 as the system dump device.
3428 When the system reboots after a crash and a crash dump is found on the
3429 device specified by the
3433 will save that crash dump and a copy of the kernel to the directory
3437 The default value is
3446 .It Va savecore_enable
3450 disable automatic extraction of the crash dump from the
3452 .It Va savecore_flags
3454 If crash dumps are enabled, these are the flags to pass to the
3461 to turn on user and group disk quotas on system startup via the
3463 command for all file systems marked as having quotas enabled in
3465 The kernel must be built with
3467 for disk quotas to function.
3472 to enable user and group disk quota checking via the
3475 .It Va quotacheck_flags
3485 these are the flags to pass to the
3490 which checks quotas for all file systems with quotas enabled in
3492 .It Va quotaon_flags
3498 these are the flags to pass to the
3503 which enables quotas for all file systems with quotas enabled in
3505 .It Va quotaoff_flags
3511 these are the flags to pass to the
3513 utility when shutting down the quota system.
3516 which disables quotas for all file systems with quotas enabled in
3518 .It Va accounting_enable
3522 to enable system accounting through the
3529 to enable iBCS2 (SCO) binary emulation at system initial boot
3531 .It Va ibcs2_loaders
3539 this specifies a list of additional iBCS2 loaders to enable.
3540 .It Va firstboot_sentinel
3542 This variable specifies the full path to a
3545 If a file exists with this path,
3549 keyword will be run on startup and the sentinel file will be deleted
3550 after the boot process completes.
3551 The sentinel file must be located on a writable file system which is
3552 mounted no later than
3553 .Va early_late_divider
3554 to function properly.
3561 to enable Linux/ELF binary emulation at system initial
3563 .It Va sysvipc_enable
3567 load System V IPC primitives at boot time.
3568 .It Va clear_tmp_enable
3579 to disable removing of X11 lock files,
3580 and the removal and (secure) recreation
3581 of the various socket directories for X11
3583 .It Va ldconfig_paths
3585 Set to the list of shared library paths to use with
3589 will always be added first, so it need not appear in this list.
3590 .It Va ldconfig32_paths
3592 Set to the list of 32-bit compatibility shared library paths to
3595 .It Va ldconfig_paths_aout
3597 Set to the list of shared library paths to use with
3602 .It Va ldconfig_insecure
3606 utility normally refuses to use directories
3607 which are writable by anyone except root.
3608 Set this variable to
3610 to disable that security check during system startup.
3611 .It Va ldconfig_local_dirs
3613 Set to the list of local
3616 The names of all files in the directories listed will be
3617 passed as arguments to
3619 .It Va ldconfig_local32_dirs
3621 Set to the list of local 32-bit compatibility
3624 The names of all files in the directories listed will be
3625 passed as arguments to
3626 .Dq Nm ldconfig Fl 32 .
3627 .It Va kern_securelevel_enable
3631 to set the kernel security level at system startup.
3632 .It Va kern_securelevel
3634 The kernel security level to set at startup.
3635 The allowed range of
3637 ranges from \-1 (the compile time default) to 3 (the
3641 for the list of possible security levels and their effect
3642 on system operation.
3645 Path to the SSH server program
3646 .Pa ( /usr/sbin/sshd
3654 at system boot time.
3661 these are the flags to pass to the
3666 Path to the FTP server program
3667 .Pa ( /usr/libexec/ftpd
3675 as a stand-alone daemon at system boot time.
3682 these are the additional flags to pass to the
3685 .It Va watchdogd_enable
3691 daemon at boot time.
3692 This requires that the kernel have been compiled with a
3695 .It Va watchdogd_flags
3698 .Va watchdogd_enable
3701 these are the flags passed to the
3704 .It Va devfs_rulesets
3706 List of files containing sets of rules for
3708 .It Va devfs_system_ruleset
3710 Rule name(s) to apply to the system
3713 .It Va devfs_set_rulesets
3715 Pairs of already-mounted
3717 directories and rulesets that should be applied to them.
3718 For example: /mount/dev=ruleset_name
3719 .It Va devfs_load_rulesets
3721 If set, always load the default rulesets listed in
3722 .Va devfs_rulesets .
3723 .It Va performance_cx_lowest
3725 CPU idle state to use while on AC power.
3730 should use the lowest power state available while
3732 indicates that the lowest latency state (less power savings) should be used.
3733 .It Va performance_cpu_freq
3735 CPU clock frequency to use while on AC power.
3740 should use the lowest frequency available while
3742 indicates that the highest frequency (less power savings) should be used.
3743 .It Va economy_cx_lowest
3745 CPU idle state to use when off 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 economy_cpu_freq
3755 CPU clock frequency to use when off AC power.
3760 should use the lowest frequency available while
3762 indicates that the highest frequency (less power savings) should be used.
3767 any configured jails will not be started.
3770 The configuration filename used by
3773 The default value is
3774 .Pa /etc/jail.conf .
3775 .It Va jail_parallel_start
3779 all configured jails will be started in the background (in parallel).
3783 When set, use as default value for
3784 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3789 A space-delimited list of jail names.
3790 When left empty, all of the
3792 instances defined in the configuration file are started.
3793 The names specified in this list control the jail startup order.
3795 instances missing from
3797 must be started manually.
3800 parameter in the configuration file may override this list.
3801 .It Va jail_reverse_stop
3805 all configured jails in
3807 are stopped in reverse order.
3808 .It Va jail_* variables
3809 Note that older releases supported per-jail configuration via
3813 hostname of a jail named
3815 was able to be set by
3816 .Li jail_vjail_hostname .
3817 These per-jail configuration variables are now obsolete in favor of
3820 For backward compatibility,
3821 when per-jail configuration variables are defined,
3823 configuration files are created as
3824 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3827 The following per-jail parameters are handled by
3829 script out of their corresponding
3832 In addition to them, parameters in
3833 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3834 will be added to the configuration file.
3835 They must be a semi-colon
3843 .Bl -tag -width "host.hostname" -offset indent
3846 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3847 .It Li host.hostname
3849 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3850 .It Li exec.consolelog
3852 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3853 The default value is
3854 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3857 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3858 .It Li vnet.interface
3860 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3863 parameter will be enabled and cannot be specified with
3864 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3865 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3867 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3871 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3874 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3877 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3880 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3881 The parameter name was
3883 in some older releases.
3884 .It Li exec.prestart
3886 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3887 .It Li exec.poststart
3889 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3892 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3895 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3896 .It Li exec.poststop
3898 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3901 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3903 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3904 contain IPv4 addresses
3907 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3909 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3910 contain IPv6 addresses
3913 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3916 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3917 .It Li devfs_ruleset
3919 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3920 This must be an integer,
3922 .It Li mount.fdescfs
3924 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3925 .It Li allow.set_hostname
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3928 .It Li allow.rawsocket
3930 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3931 .It Li allow.sysvipc
3933 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3935 .\" -----------------------------------------------------
3939 representing the entropy sources
3940 you wish to harvest.
3943 for more information.
3948 to disable caching entropy via
3950 Otherwise set to the directory
3951 in which the entropy files are stored.
3955 that regularly writes and rotates
3958 will be used at boot time.
3960 .Pa /var/db/entropy .
3965 to disable caching entropy through reboots.
3966 Otherwise set to the name
3967 of a file used to store cached entropy.
3968 This file should be located
3969 on a file system that is readable
3970 before all the volumes specified in
3977 .Pa /var/db/entropy-file
3978 is found it will also be used.
3979 This will be of some use to
3981 .It Va entropy_boot_file
3986 very early caching entropy
3988 Otherwise set to the filename
3990 very early reboot cached entropy.
3991 This file should be located where
3996 The default location is
3998 .It Va entropy_save_sz
4000 Size of the entropy cache files saved by
4003 .It Va entropy_save_num
4005 Number of entropy cache files to save by
4019 Configuration file for
4028 .Pa /var/run/dmesg.boot
4030 .It Va rcshutdown_timeout
4032 If set, start a watchdog timer in the background which will terminate
4036 has not completed within the specified time (in seconds).
4037 Notice that in addition to this soft timeout,
4039 also applies a hard timeout for the execution of
4041 This is configured via
4044 .Va kern.init_shutdown_timeout
4045 and defaults to 120 seconds.
4046 Setting the value of
4047 .Va rcshutdown_timeout
4048 to more than 120 seconds will have no effect until the
4051 .Va kern.init_shutdown_timeout
4053 .It Va virecover_enable
4057 to prevent the system from trying to
4058 recover pre-maturely terminated
4061 .It Va ugidfw_enable
4066 .Xr mac_bsdextended 4
4067 module upon system initialization and load a default
4069 .It Va bsdextended_script
4072 .Xr mac_bsdextended 4
4073 ruleset file to load.
4074 The default value of this variable is
4075 .Pa /etc/rc.bsdextended .
4076 .It Va newsyslog_enable
4083 .It Va newsyslog_flags
4086 .Va newsyslog_enable
4089 these are the flags to pass to the
4094 which causes log files flagged with a
4097 .It Va mdconfig_md Ns Aq Ar X
4107 must be specified and either a
4109 for malloc or swap backed
4117 .Va mdconfig_md Ns Aq Ar X
4118 variables are evaluated until one variable is unset or null.
4119 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4121 Optional arguments passed to
4127 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4129 An ownership specification passed to
4138 device and the mount point will be changed.
4139 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4141 A mode string passed to
4150 device and the mount point will be changed.
4151 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4153 Files to be copied to the mount point of the
4157 after it has been mounted.
4158 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4160 Command to execute after the specified
4165 Note that the command is passed to
4171 variables can be used to reference respectively the
4173 device and the mount point.
4178 one could set the following:
4180 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4182 .It Va autobridge_interfaces
4184 Set to the list of bridge interfaces that will have newly arriving interfaces
4185 checked against to be automatically added.
4188 then for each whitespace separated
4191 .Va autobridge_ Ns Aq Ar element
4192 variable is assumed to exist which has a whitespace separated list of interface
4193 names to match, these names can use wildcards.
4196 autobridge_interfaces="bridge0"
4197 autobridge_bridge0="tap* dc0 vlan[345]"
4203 enable support for sound mixer.
4204 .It Va hcsecd_enable
4208 enable Bluetooth security daemon.
4209 .It Va hcsecd_config
4211 Configuration file for
4214 .Pa /etc/bluetooth/hcsecd.conf .
4219 enable Bluetooth Service Discovery Protocol daemon.
4227 .It Va sdpd_groupname
4231 group to run as after it initializes.
4234 .It Va sdpd_username
4238 user to run as after it initializes.
4241 .It Va bthidd_enable
4245 enable Bluetooth Human Interface Device daemon.
4246 .It Va bthidd_config
4248 Configuration file for
4251 .Pa /etc/bluetooth/bthidd.conf .
4254 Path to a file, where
4256 will store information about known HID devices.
4258 .Pa /var/db/bthidd.hids .
4259 .It Va rfcomm_pppd_server_enable
4263 enable Bluetooth RFCOMM PPP wrapper daemon.
4264 .It Va rfcomm_pppd_server_profile
4266 The name of the profile to use from
4267 .Pa /etc/ppp/ppp.conf .
4268 Multiple profiles can be specified here.
4269 Also used to specify per-profile overrides.
4270 When the profile name contains any of the characters
4272 they are translated to
4274 for the proposes of the override variable names.
4275 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4277 Overrides local address to listen on.
4283 The address can be specified as BD_ADDR or name.
4284 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4286 Overrides local RFCOMM channel to listen on.
4289 will listen on RFCOMM channel 1.
4290 Must set properly if multiple profiles used in the same time.
4291 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4295 if it should register Serial Port service on the specified RFCOMM channel.
4298 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4302 if it should register Dial-Up Networking service on the specified
4306 .It Va ubthidhci_enable
4310 change the USB Bluetooth controller from HID mode to HCI mode.
4311 You also need to specify the location of USB Bluetooth controller with the
4312 .Va ubthidhci_busnum
4316 .It Va ubthidhci_busnum
4317 Bus number where the USB Bluetooth controller is located.
4320 on your system to find this information.
4321 .It Va ubthidhci_addr
4322 Bus address of the USB Bluetooth controller.
4325 on your system to find this information.
4326 .It Va netwait_enable
4330 delays the start of network-reliant services until
4332 is up and ICMP packets to a destination defined in
4335 Link state is examined first, followed by
4337 an IP address to verify network usability.
4338 If no destination can be reached or timeouts are exceeded,
4339 network services are started anyway with no guarantee that
4340 the network is usable.
4341 Use of this variable requires both
4349 This variable contains a space-delimited list of IP addresses to
4351 DNS hostnames should not be used as resolution is not guaranteed
4352 to be functional at this point.
4353 If multiple IP addresses are specified,
4354 each will be tried until one is successful or the list is exhausted.
4355 .It Va netwait_timeout
4357 Indicates the total number of seconds to perform a
4359 against each IP address in
4361 at a rate of one ping per second.
4362 If any of the pings are successful,
4363 full network connectivity is considered reliable.
4368 Defines the name of the network interface on which watch for link.
4370 is used to monitor the interface, looking for
4371 .Dq Li status: no carrier .
4372 Once gone, the link is considered up.
4375 interface if desired.
4376 .It Va netwait_if_timeout
4378 Defines the total number of seconds to wait for link to become usable,
4379 polled at a 1-second interval.
4387 rules from the defined ruleset.
4388 The kernel must be built with
4391 .Cd "options RCTL" .
4397 This variables contains the
4403 A space-separated list of configuration files used by
4405 The default value is an empty string.
4406 .It Va autofs_enable
4416 daemons at boot time.
4417 .It Va automount_flags
4423 these are the flags to pass to the
4426 By default no flags are passed.
4427 .It Va automountd_flags
4433 these are the flags to pass to the
4436 By default no flags are passed.
4437 .It Va autounmountd_flags
4443 these are the flags to pass to the
4446 By default no flags are passed.
4453 daemon at boot time.
4454 .It Va iscsid_enable
4460 daemon at boot time.
4461 .It Va iscsictl_enable
4467 utility at boot time.
4468 .It Va iscsictl_flags
4474 these are the flags to pass to the
4479 which configures sessions based on the
4484 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4485 .It Pa /etc/defaults/rc.conf
4487 .It Pa /etc/rc.conf.local
4517 .Xr newsyslog.conf 5 ,
4589 .An Jordan K. Hubbard .