4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the system installation utility,
46 is not to run commands or perform system startup actions
48 Instead, it is included by the
49 various generic startup scripts in
51 which conditionalize their
52 internal actions according to the settings found there.
56 file is included from the file
57 .Pa /etc/defaults/rc.conf ,
58 which specifies the default settings for all the available options.
59 Options need only be specified in
61 when the system administrator wishes to override these defaults.
63 .Pa /etc/rc.conf.local
64 is used to override settings in
66 for historical reasons.
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
73 directory, which will be included by the
76 For jail configurations you could use the file
77 .Pa /etc/rc.conf.d/jail
78 to store jail specific configuration options.
84 .Dq Ar name Ns Li = Ns Ar value
88 The following list provides a name and short description for each
89 variable that can be set in the
92 .Bl -tag -width indent-two
97 enable output of debug messages from rc scripts.
98 This variable can be helpful in diagnosing mistakes when
99 editing or integrating new scripts.
100 Beware that this produces copious output to the terminal and
106 disable informational messages from the rc scripts.
107 Informational messages are displayed when
108 a condition that is not serious enough to warrant a warning or
116 when faststart is used (e.g., at boot time).
117 .It Va early_late_divider
119 The name of the script that should be used as the
120 delimiter between the
124 stages of the boot process.
125 The early stage should contain all the services needed to
126 get the disks (local or remote) mounted so that the late
127 stage can include scripts contained in the directories
130 variable (see below).
131 Thus, the two likely candidates for this value are
133 for the typical system, and
135 if the system needs remote file
136 systems mounted to get access to the
138 directories; for example when
146 is likely to be an appropriate value.
147 Extreme care should be taken when changing this value,
148 and before changing it one should ensure that there are
149 adequate provisions to recover from a failed boot
150 (such as physical contact with the machine,
151 or reliable remote console access).
156 no swapfile is installed, otherwise the value is used as the full
157 pathname to a file to use for additional swap space.
162 enable support for Automatic Power Management with
170 to handle APM event from userland.
171 This also enables support for APM.
178 these are the flags to pass to the
185 to handle device added, removed or unknown events from the kernel.
192 scripts at boot time.
195 Configuration file for
201 A list of kernel modules to load right after the local
203 Loading modules at this point in the boot process is
204 much faster than doing it via
205 .Pa /boot/loader.conf
206 for those modules not necessary for mounting local disk.
207 .It Va kldxref_enable
214 to automatically rebuild
219 .It Va kldxref_clobber
229 will overwrite existing
236 .It Va kldxref_module_path
241 delimited list of paths containing
253 enable the system power control facility with the
262 these are the flags to pass to the
266 Controls the creation of a
269 Always happens if set to
271 and never happens if set to
273 If set to anything else, a memory file system is created if
277 Controls the size of a created
281 Extra options passed to the
283 utility when the memory file system for
288 which inhibits the use of softupdates on
290 so that file system space is freed without delay
291 after file truncation or deletion.
294 for other options you can use in
297 Controls the creation of a
300 Always happens if set to
302 and never happens if set to
304 If set to anything else, a memory file system is created if
308 Controls the size of a created
312 Extra options passed to the
314 utility when the memory file system for
319 which inhibits the use of softupdates on
321 so that file system space is freed without delay
322 after file truncation or deletion.
325 for other options you can use in
328 Controls the automatic population of the
331 Always happens if set to
333 and never happens if set to
335 If set to anything else, a memory file system is created if
338 Note that this process requires access to certain commands in
342 is mounted on normal systems.
343 .It Va cleanvar_enable
350 List of directories to search for startup script files.
351 .It Va script_name_sep
353 The field separator to use for breaking down the list of startup script files
354 into individual filenames.
355 The default is a space.
356 It is not necessary to change this unless there are startup scripts with names
358 .It Va hostapd_enable
367 The fully qualified domain name (FQDN) of this host on the network.
368 This should almost certainly be set to something meaningful, even if
369 there is no network connection.
372 is used to set the hostname via DHCP,
373 this variable should be set to an empty string.
374 If this value remains unset when the system is done booting
375 your console login will display the default hostname of
379 The NIS domain name of this host, or
382 .It Va dhclient_program
384 Path to the DHCP client program
385 .Pa ( /sbin/dhclient ,
390 .It Va dhclient_flags
392 Additional flags to pass to the DHCP client program.
397 manpage for a description of the command line options available.
398 .It Va dhclient_flags_ Ns Aq Ar iface
399 Additional flags to pass to the DHCP client program running on
402 When specified, this variable overrides
404 .It Va background_dhclient
408 to start the DHCP client in background.
409 This can cause trouble with applications depending on
410 a working network, but it will provide a faster startup
412 .It Va background_dhclient_ Ns Aq Ar iface
413 When specified, this variable overrides the
414 .Va background_dhclient
415 variable for interface
418 .It Va synchronous_dhclient
424 synchronously at startup.
425 This behavior can be overridden on a per-interface basis by replacing
429 .Va ifconfig_ Ns Aq Ar interface
434 .It Va defaultroute_delay
436 When set to a positive value, wait up to this long after configuring
437 DHCP interfaces at startup to give the interfaces time to receive a lease.
438 .It Va firewall_enable
442 to load firewall rules at startup.
443 If the kernel was not built with
444 .Cd "options IPFIREWALL" ,
447 kernel module will be loaded.
449 .Va ipfilter_enable .
450 .It Va firewall_script
452 This variable specifies the full path to the firewall script to run.
454 .Pa /etc/rc.firewall .
457 Names the firewall type from the selection in
458 .Pa /etc/rc.firewall ,
459 or the file which contains the local firewall ruleset.
460 Valid selections from
464 .Bl -tag -width ".Li simple" -compact
466 unrestricted IP access
468 all IP services disabled, except via
471 basic protection for a workstation
473 basic protection for a LAN.
476 If a filename is specified, the full path
478 .It Va firewall_quiet
482 to disable the display of firewall rules on the console during boot.
483 .It Va firewall_logging
487 to enable firewall event logging.
488 This is equivalent to the
489 .Dv IPFIREWALL_VERBOSE
491 .It Va firewall_flags
497 specifies a filename.
498 .It Va firewall_coscripts
500 List of executables and/or rc scripts to run after firewall starts/stops.
502 .\" ----- firewall_nat_enable setting --------------------------------
503 .It Va firewall_nat_enable
515 .It Va firewall_nat_interface
521 This is the name of the public interface or IP address on which
522 kernel NAT should run.
523 .It Va firewall_nat_flags
525 Additional configuration parameters for kernel NAT should be placed here.
526 .It Va dummynet_enable
530 will automatically load the
536 .\" -------------------------------------------------------------------
552 sockets must be enabled in the kernel.
553 If the kernel was not built with
554 .Cd "options IPDIVERT" ,
557 kernel module will be loaded.
558 .It Va natd_interface
560 This is the name of the public interface on which
563 The interface may be given as an interface name or as an IP address.
568 flags should be placed here.
573 flag is automatically added with the above
576 .\" ----- ipfilter_enable setting --------------------------------
577 .It Va ipfilter_enable
588 Typical usage will require putting
590 ipfilter_enable="YES"
608 can be enabled independently.
612 both require at least one of
622 options IPFILTER_DEFAULT_BLOCK
625 in the kernel configuration file is a good idea, too.
626 .\" ----- ipfilter_program setting ------------------------------
627 .It Va ipfilter_program
633 .\" ----- ipfilter_rules setting --------------------------------
634 .It Va ipfilter_rules
639 This variable contains the name of the filter rule definition file.
640 The file is expected to be readable for the
643 .\" ----- ipv6_ipfilter_rules setting ---------------------------
644 .It Va ipv6_ipfilter_rules
649 This variable contains the IPv6 filter rule definition file.
650 The file is expected to be readable for the
653 .\" ----- ipfilter_flags setting --------------------------------
654 .It Va ipfilter_flags
657 This variable contains flags passed to the
660 .\" ----- ipnat_enable setting ----------------------------------
670 network address translation.
673 for a detailed discussion.
674 .\" ----- ipnat_program setting ---------------------------------
681 .\" ----- ipnat_rules setting -----------------------------------
687 This variable contains the name of the file
688 holding the network address translation definition.
689 This file is expected to be readable for the
692 .\" ----- ipnat_flags setting -----------------------------------
696 This variable contains flags passed to the
699 .\" ----- ipmon_enable setting ----------------------------------
714 Setting this variable needs setting
721 for a detailed discussion.
722 .\" ----- ipmon_program setting ---------------------------------
729 .\" ----- ipmon_flags setting -----------------------------------
735 This variable contains flags passed to the
738 Another typical example would be
739 .Dq Fl D Pa /var/log/ipflog
742 log directly to a file bypassing
745 .Pa /etc/newsyslog.conf
746 in such case like this:
748 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
750 .\" ----- ipfs_enable setting -----------------------------------
760 saving the filter and NAT state tables during shutdown
761 and reloading them during startup again.
762 Setting this variable needs setting
771 for a detailed discussion.
777 because the raised securelevel will prevent
779 from saving the state tables at shutdown time.
780 .\" ----- ipfs_program setting ----------------------------------
787 .\" ----- ipfs_flags setting ------------------------------------
791 This variable contains flags passed to the
794 .\" ----- end of added ipf hook ---------------------------------
806 Typical usage will require putting
821 into the kernel, otherwise the
822 kernel module will be loaded.
827 ruleset configuration file
842 these flags are passed to the
844 program when loading the ruleset.
854 which logs packets from the
867 .Pa /var/log/pflog ) .
869 .Pa /etc/newsyslog.conf
870 to adjust logfile rotation for this.
880 This variable contains additional flags passed to the
883 .It Va ftpproxy_enable
894 packet filter in translating ftp connections.
895 .It Va ftpproxy_flags
898 This variable contains additional flags passed to the
910 state changes to other hosts over the network by means of
915 must also be set then.
916 .It Va pfsync_syncdev
919 This variable specifies the name of the network interface
921 should operate through.
922 It must be set accordingly if
926 .It Va pfsync_syncpeer
929 This variable is optional.
930 By default, state change messages are sent out on the synchronisation
931 interface using IP multicast packets.
932 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
934 When a peer address is specified using the
936 option, the peer address is used as a destination for the pfsync
937 traffic, and the traffic can then be protected using
941 manpage for more details about using
946 .It Va pfsync_ifconfig
949 This variable can contain additional options to be passed to the
951 command used to set up
953 .It Va tcp_extensions
960 disables certain TCP options as described by
966 might help remedy such problems with connections as randomly hanging
967 or other weird behavior.
968 Some network devices are known
969 to be broken with respect to these options.
976 .Va net.inet.tcp.log_in_vain
978 .Va net.inet.udp.log_in_vain ,
983 are set to the given value.
991 will disable probing idle TCP connections to verify that the
992 peer is still up and reachable.
993 .It Va tcp_drop_synfin
1000 will cause the kernel to ignore TCP frames that have both
1001 the SYN and FIN flags set.
1002 This prevents OS fingerprinting, but may
1003 break some legitimate applications.
1004 .It Va icmp_drop_redirect
1011 will cause the kernel to ignore ICMP REDIRECT packets.
1014 for more information.
1015 .It Va icmp_log_redirect
1022 will cause the kernel to log ICMP REDIRECT packets.
1024 the log messages are not rate-limited, so this option should only be used
1025 for troubleshooting networks.
1028 for more information.
1029 .It Va icmp_bmcastecho
1033 to respond to broadcast or multicast ICMP ping packets.
1036 for more information.
1037 .It Va ip_portrange_first
1041 this is the first port in the default portrange.
1044 for more information.
1045 .It Va ip_portrange_last
1049 this is the last port in the default portrange.
1052 for more information.
1053 .It Va network_interfaces
1055 Set to the list of network interfaces to configure on this host or
1057 (the default) for all current interfaces.
1059 .Va network_interfaces
1060 variable to anything other than the default is deprecated.
1061 Interfaces that the administrator wishes to store configuration for,
1062 but not start at boot should be configured with the
1065 .Va ifconfig_ Ns Aq Ar interface
1066 variables as described below.
1069 .Va ifconfig_ Ns Aq Ar interface
1070 variable is also assumed to exist for each value of
1072 When an interface name contains any of the characters
1074 they are translated to
1077 The variable can contain arguments to
1079 as well as special case-insensitive keywords described below.
1080 Such keywords are removed before passing the value to
1082 while the order of the other arguments is preserved.
1084 One can configure more than one IPv4 address with the
1085 .Va ipv4_addrs_ Ns Aq Ar interface
1087 One or more IP addresses must be provided in Classless Inter-Domain
1088 Routing (CIDR) address notation, whose last byte can be a range like
1090 In this case the address 192.0.2.5 will be configured with the
1091 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1092 the non-conflicting netmask /32 as explained in the
1095 With the interface in question being
1097 an example could look like:
1099 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1102 It is also possible to add IP alias entries using
1105 Assuming that the interface in question was
1108 something like this:
1110 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1111 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1116 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1117 entry that is found,
1118 its contents are passed to
1120 Execution stops at the first unsuccessful access, so if
1121 something like this is present:
1123 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1124 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1125 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1126 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1129 Then note that alias4 would
1131 be added since the search would
1132 stop with the missing
1135 Due to this difficult to manage behavior, the
1136 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1140 .Pa /etc/start_if. Ns Aq Ar interface
1141 file is present, it is read and executed by the
1144 before configuring the interface as specified in the
1145 .Va ifconfig_ Ns Aq Ar interface
1147 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1151 .Va vlans_ Ns Aq Ar interface
1155 interface will be created for each item in the list with the
1159 If a vlan interface's name is a number,
1160 then that number is used as the vlan tag and the new vlan interface is
1162 .Ar interface . Ns Ar tag .
1164 the vlan tag must be specified via a
1167 .Va create_args_ Ns Aq Ar interface
1170 To create a vlan device named
1174 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1177 ifconfig_em0_101="inet 192.0.2.1/24"
1180 To create a vlan device named
1184 with the vlan tag 102:
1187 create_args_myvlan="vlan 102"
1191 .Va wlans_ Ns Aq Ar interface
1195 interface will be created for each item in the list with the
1199 Further wlan cloning arguments may be passed to the
1202 command by setting the
1203 .Va create_args_ Ns Aq Ar interface
1207 devices must be created for each wireless devices as of
1213 may be specified with an
1214 .Va wlandebug_ Ns Aq Ar interface
1216 The contents of this variable will be passed directly to
1220 .Va ifconfig_ Ns Aq Ar interface
1221 contains the keyword
1223 then the interface will not be configured
1225 .Pa /etc/pccard_ether
1227 .Va network_interfaces
1231 It is possible to bring up an interface with DHCP by adding
1234 .Va ifconfig_ Ns Aq Ar interface
1236 For instance, to initialize the
1239 it is possible to use something like:
1244 Also, if you want to configure your wireless interface with
1245 .Xr wpa_supplicant 8
1246 for use with WPA, EAP/LEAP or WEP, you need to add
1249 .Va ifconfig_ Ns Aq Ar interface
1252 Finally, you can add
1254 options in this variable, in addition to the
1255 .Pa /etc/start_if. Ns Aq Ar interface
1257 For instance, to configure an
1259 wireless device in station mode with an address obtained
1260 via DHCP, using WPA authentication and 802.11b mode, it is
1261 possible to use something like:
1264 ifconfig_wlan0="DHCP WPA mode 11b"
1268 .Va ifconfig_ Ns Aq Ar interface
1269 form, a fallback variable
1270 .Va ifconfig_DEFAULT
1272 It will be used for all interfaces with no
1273 .Va ifconfig_ Ns Aq Ar interface
1275 This is intended to replace the no longer supported
1279 It is also possible to rename an interface by doing:
1281 ifconfig_ed0_name="net0"
1282 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1285 This variable is deprecated.
1287 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1289 .Va ipv6_activate_all_interfaces
1295 .Dq Li inet6 accept_rtadv
1297 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1299 .Va ipv6_activate_all_interfaces
1303 This variable is deprecated.
1305 .Va ip6addrctl_policy
1311 the default address selection policy table set by
1313 will be IPv6-preferred.
1317 the default address selection policy table set by
1319 will be IPv4-preferred.
1320 .It Va ipv6_activate_all_interfaces
1322 This controls initial configuration on IPv6-capable
1323 interfaces with no corresponding
1324 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1326 Note that it is not always necessary to set this variable to
1328 to use IPv6 functionality on
1330 In most cases, just configuring
1331 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1336 all interfaces which do not have a corresponding
1337 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1338 variable will be marked as
1341 This means that all of IPv6 functionality on that interface
1342 is completely disabled to enforce a security policy.
1343 If the variable is set to
1345 the flag will be cleared on all of the interfaces.
1347 In most cases, just defining an
1348 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1349 for an IPv6-capable interface should be sufficient.
1350 However, if an interface is added dynamically
1351 .Pq by some tunneling protocols such as PPP, for example ,
1352 it is often difficult to define the variable in advance.
1353 In such a case, configuring the
1355 flag can be disabled by setting this variable to
1358 For more details of the
1361 .Dq Li inet6 ifdisabled ,
1371 privacy addresses will be generated for each IPv6
1372 interface as described in RFC 4941.
1373 .It Va ipv6_network_interfaces
1375 This is the IPv6 equivalent of
1376 .Va network_interfaces .
1377 Normally manual configuration of this variable is not needed.
1379 .It Va ipv6_cpe_wanif
1381 If the variable is set to an interface name,
1385 .Dq inet6 -no_radr accept_rtadv
1386 will be added to the specified interface automatically before evaluating
1387 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1391 .Va net.inet6.ip6.rfc6204w3
1393 .Va net.inet6.ip6.no_radr
1396 This means the specified interface will accept ICMPv6 Router
1397 Advertisement messages on that link and add the discovered
1398 routers into the Default Router List.
1399 While the other interfaces can still accept RA messages if the
1400 .Dq inet6 accept_rtadv
1401 option is specified, adding
1402 routes into the Default Router List will be disabled by
1409 Note that ICMPv6 Router Advertisement messages will be
1411 .Va net.inet6.ip6.forwarding
1413 .Pq packet fowarding is enabled
1415 .Va net.inet6.ip6.rfc6204w3
1420 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1422 IPv6 functionality on an interface should be configured by
1423 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1424 instead of setting ifconfig parameters in
1425 .Va ifconfig_ Ns Aq Ar interface .
1426 Aliases should be set by
1427 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1430 keyword. For example:
1432 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1433 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1436 Note that a link-local address will be automatically configured in
1437 addition to the configured global-scope addresses because the IPv6
1438 specifications require it on each link.
1439 The address is calculated from the MAC address by using an algorithm
1446 If only a link-local address is needed on the interface,
1447 the following configuration can be used:
1449 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1452 A link-local address can also be configured manually.
1453 This is useful for the default router address of an IPv6 router
1454 so that it does not change when the network interface
1458 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1461 Interfaces that have an
1462 .Dq Li inet6 accept_rtadv
1464 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1465 setting will be automatically configured by
1467 .It Va ipv6_prefix_ Ns Aq Ar interface
1469 If one or more prefixes are defined in
1470 .Va ipv6_prefix_ Ns Aq Ar interface
1471 addresses based on each prefix and the EUI-64 interface index will be
1472 configured on that interface.
1473 .It Va ipv6_default_interface
1477 this is the default output interface for scoped addresses.
1478 This works only with ipv6_gateway_enable="NO".
1479 .It Va ip6addrctl_enable
1481 This variable is to enable configuring default address selection policy table
1483 The table can be specified in another variable
1484 .Va ip6addrctl_policy .
1486 .Va ip6addrctl_policy
1487 the following keywords can be specified:
1488 .Dq Li ipv4_prefer ,
1489 .Dq Li ipv6_prefer ,
1499 installs a pre-defined policy table described in Section 2.1
1507 is specified, it attempts to read a file
1508 .Pa /etc/ip6addrctl.conf
1509 first. If this file is found,
1511 reads and installs it. If not found, a policy is automatically set
1513 .Va ipv6_activate_all_interfaces
1514 variable; if the variable is set to
1516 the IPv6-preferred one is used. Otherwise IPv4-preferred.
1518 The default value of
1519 .Va ip6addrctl_enable
1521 .Va ip6addrctl_policy
1527 .It Va cloned_interfaces
1529 Set to the list of clonable network interfaces to create on this host.
1530 Further cloning arguments may be passed to the
1533 command for each interface by setting the
1534 .Va create_args_ Ns Aq Ar interface
1537 .Va cloned_interfaces
1538 are automatically appended to
1539 .Va network_interfaces
1541 .It Va fec_interfaces
1545 Fast EtherChannel interfaces to configure on this host.
1547 .Va fecconfig_ Ns Aq Ar interface
1548 variable is assumed to exist for each value of
1550 The value of this variable is used to configure link aggregated interfaces
1551 according to the syntax of the
1552 .Cm NGM_FEC_ADD_IFACE
1556 Additionally, this option ensures that each listed interface is created
1561 before attempting to configure it.
1564 fec_interfaces="fec0"
1565 fecconfig_fec0="em0 em1"
1566 ifconfig_fec0="DHCP"
1568 .It Va gif_interfaces
1572 tunnel interfaces to configure on this host.
1574 .Va gifconfig_ Ns Aq Ar interface
1575 variable is assumed to exist for each value of
1577 The value of this variable is used to configure the link layer of the
1578 tunnel according to the syntax of the
1582 Additionally, this option ensures that each listed interface is created
1587 before attempting to configure it.
1588 .It Va sppp_interfaces
1592 interfaces to configure on this host.
1594 .Va spppconfig_ Ns Aq Ar interface
1595 variable is assumed to exist for each value of
1597 Each interface should also be configured by a general
1598 .Va ifconfig_ Ns Aq Ar interface
1602 for more information about available options.
1612 The name of the profile to use from
1613 .Pa /etc/ppp/ppp.conf .
1614 Also used for per-profile overrides of
1619 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1620 When the profile name contains any of the characters
1622 they are translated to
1624 for the proposes of the override variable names.
1627 Mode in which to run the
1630 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1632 Overrides the global
1642 See the manual for a full description.
1647 enables network address translation.
1648 Used in conjunction with
1650 allows hosts on private network addresses access to the Internet using
1651 this host as a network address translating router.
1652 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1654 Overrides the global
1658 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1660 Set the unit number to be used for this profile.
1661 See the manual description of
1666 The name of the user under which
1674 .It Va rc_conf_files
1676 This option is used to specify a list of files that will override
1678 .Pa /etc/defaults/rc.conf .
1679 The files will be read in the order in which they are specified and should
1680 include the full path to the file.
1681 By default, the files specified are
1684 .Pa /etc/rc.conf.local
1690 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1692 .It Va gptboot_enable
1696 .Pa /etc/rc.d/gptboot
1697 will log if the system successfully (or not) booted from a GPT partition,
1703 .It Va gbde_autoattach_all
1708 will attempt to automatically initialize your .bde devices in
1712 List the devices that the script should try to attach,
1717 The directory where the
1719 lockfiles are located.
1720 The default lockfile directory is
1723 The lockfile for each individual
1725 device can be overridden by setting the variable
1726 .Va gbde_lock_ Ns Aq Ar device ,
1729 is the encrypted device without the
1734 .It Va gbde_attach_attempts
1736 Number of times to attempt attaching to a
1738 device, i.e., how many times the user is asked for the pass-phrase.
1742 List of devices to automatically attach on boot.
1743 Note that .eli devices from
1745 are automatically appended to this list.
1748 Number of times user is asked for the pass-phrase.
1749 If empty, it will be taken from
1750 .Va kern.geom.eli.tries
1752 .It Va geli_default_flags
1754 Default flags to use by
1756 when configuring disk encryption.
1757 Flags can be configured for every device separately by defining
1758 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1760 .It Va geli_autodetach
1762 Specifies if GELI devices should be marked for detach on last close after
1763 file systems are mounted.
1766 This can be changed for every device separately by defining
1767 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1769 .It Va geli_swap_flags
1770 Options passed to the
1772 utility when encrypted GEOM providers for swap partitions are created.
1774 .Dq Li "-e aes -l 256 -s 4096 -d" .
1775 .It Va root_rw_mount
1780 After the file systems are checked at boot time, the root file system
1781 is remounted as read-write if this is set to
1783 Diskless systems that mount their root file system from a read-only remote
1784 NFS share should set this to
1788 .It Va fsck_y_enable
1793 will be run with the
1795 flag if the initial preen
1796 of the file systems fails.
1797 .It Va background_fsck
1801 the system will attempt to run
1803 in the background where possible.
1804 .It Va background_fsck_delay
1806 The amount of time in seconds to sleep before starting a background
1808 It defaults to sixty seconds to allow large applications such as
1809 the X server to start before disk I/O bandwidth is monopolized by
1811 If set to a negative number, the background file system check will be
1812 delayed indefinitely to allow the administrator to run it at a more
1814 For example it may be run from
1816 by adding a line like
1818 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1824 List of file system types that are network-based.
1825 This list should generally not be modified by end users.
1827 .Va extra_netfs_types
1829 .It Va extra_netfs_types
1831 If set to something other than
1834 this variable extends the list of file system types
1835 for which automatic mounting at startup by
1837 should be delayed until the network is initialized.
1839 a whitespace-separated list of network file system descriptor pairs,
1840 each consisting of a file system type as passed to
1842 and a human-readable, one-word description,
1845 Extending the default list in this way is only necessary
1846 when third party file system types are used.
1847 .It Va syslogd_enable
1854 .It Va syslogd_program
1859 .Pa /usr/sbin/syslogd ) .
1860 .It Va syslogd_flags
1866 these are the flags to pass to
1875 .It Va inetd_program
1880 .Pa /usr/sbin/inetd ) .
1887 these are the flags to pass to
1896 .It Va hastd_program
1908 these are the flags to pass to
1917 .It Va named_program
1922 .Pa /usr/sbin/named ) .
1927 configuration file, (default
1928 .Pa /etc/namedb/named.conf ) .
1935 these are the flags to pass to
1941 process should be run as.
1942 .It Va named_chrootdir
1944 The root directory for a name server run in a
1946 environment (default
1950 will not be run in a
1953 .It Va named_chroot_autoupdate
1957 to disable automatic update of the
1960 .It Va named_symlink_enable
1964 to disable symlinking of
1973 loop until working name service is established.
1974 .It Va named_wait_host
1976 Name of host to lookup for the named_wait option.
1978 .It Va named_auto_forward
1980 Set to enable automatic creation of a forwarder
1981 configuration file derived from
1982 .Pa /etc/resolv.conf .
1983 .It Va named_auto_forward_only
1985 Set to change the default forwarder configuration from
1989 .It Va kerberos5_server_enable
1993 to start a Kerberos 5 authentication server
1995 .It Va kerberos5_server
1998 .Va kerberos5_server_enable
2001 this is the path to Kerberos 5 Authentication Server.
2002 .It Va kerberos5_server_flags
2005 This variable contains additional flags to be passed to the Kerberos 5
2006 authentication server.
2007 .It Va kadmind5_server_enable
2013 the Kerberos 5 Administration Daemon; set to
2016 .It Va kadmind5_server
2019 .Va kadmind5_server_enable
2022 this is the path to Kerberos 5 Administration Daemon.
2023 .It Va kpasswdd_server_enable
2029 the Kerberos 5 Password-Changing Daemon; set to
2032 .It Va kpasswdd_server
2035 .Va kpasswdd_server_enable
2038 this is the path to Kerberos 5 Password-Changing Daemon.
2045 daemon at boot time.
2052 these are the flags to pass to it.
2059 daemon at boot time.
2066 these are the flags to pass to it.
2069 manpage for more information.
2070 .It Va amd_map_program
2073 the specified program is run to get the list of
2078 maps are stored in NIS, one can set this to
2091 will be updated at boot time to reflect the kernel release
2096 will not be updated.
2097 .It Va nfs_client_enable
2101 run the NFS client daemons at boot time.
2102 .It Va nfs_access_cache
2105 .Va nfs_client_enable
2110 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2112 results should be cached.
2113 A value of 2-10 seconds will substantially reduce network
2114 traffic for many NFS operations.
2115 .It Va nfs_server_enable
2119 run the NFS server daemons at boot time.
2120 .It Va nfs_server_flags
2123 .Va nfs_server_enable
2126 these are the flags to pass to the
2129 .It Va nfsv4_server_enable
2132 .Va nfs_server_enable
2136 .Va nfsv4_server_enable
2139 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2140 .It Va nfsuserd_enable
2146 run the nfsuserd daemon, which is needed for NFSv4 in order
2147 to map between user/group names vs uid/gid numbers.
2149 .Va nfsv4_server_enable
2152 this will be forced enabled.
2153 .It Va nfsuserd_flags
2159 these are the flags to pass to the
2162 .It Va nfscbd_enable
2168 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2175 these are the flags to pass to the
2178 .It Va oldnfs_server_enable
2181 .Va oldnfs_server_enable
2184 force the NFS server daemons to run the old NFS server code
2185 that does not support NFSv4.
2186 .It Va mountd_enable
2191 .Va nfs_server_enable
2197 It is commonly needed to run CFS without real NFS used.
2204 these are the flags to pass to the
2207 .It Va weak_mountd_authentication
2211 allow services like PCNFSD to make non-privileged mount
2213 .It Va nfs_reserved_port_only
2217 provide NFS services only on a secure port.
2218 .It Va nfs_bufpackets
2220 If set to a number, indicates the number of packets worth of
2221 socket buffer space to reserve on an NFS client.
2222 The kernel default is typically 4.
2223 Using a higher number may be
2224 useful on gigabit networks to improve performance.
2225 The minimum value is
2226 2 and the maximum is 64.
2227 .It Va rpc_lockd_enable
2231 and also an NFS server or client, run
2234 .It Va rpc_lockd_flags
2237 .Va rpc_lockd_enable
2240 these are the flags to pass to the
2243 .It Va rpc_statd_enable
2247 and also an NFS server or client, run
2250 .It Va rpc_statd_flags
2253 .Va rpc_statd_enable
2256 these are the flags to pass to the
2259 .It Va rpcbind_program
2264 .Pa /usr/sbin/rpcbind ) .
2265 .It Va rpcbind_enable
2271 service at boot time.
2272 .It Va rpcbind_flags
2278 these are the flags to pass to the
2281 .It Va keyserv_enable
2287 daemon on boot for running Secure RPC.
2288 .It Va keyserv_flags
2294 these are the flags to pass to
2297 .It Va pppoed_enable
2303 daemon at boot time to provide PPP over Ethernet services.
2304 .It Va pppoed_ Ns Aq Ar provider
2307 listens to requests to this
2313 argument of the same name.
2316 Additional flags to pass to
2318 .It Va pppoed_interface
2320 The network interface to run
2323 This is mandatory when
2333 service at boot time.
2334 This command is intended for networks of
2335 machines where a consistent
2337 for all hosts must be established.
2338 This is often useful in large NFS
2339 environments where time stamps on files are expected to be consistent
2347 these are the flags to pass to the
2350 .It Va ntpdate_enable
2357 This command is intended to
2358 synchronize the system clock only
2360 from some standard reference.
2361 An option to set this up initially
2362 (from a list of known servers) is also provided by the
2364 program when the system is first installed.
2365 .It Va ntpdate_config
2367 Configuration file for
2371 .It Va ntpdate_hosts
2373 A whitespace-separated list of NTP servers to synchronize with at startup.
2374 The default is to use the servers listed in
2375 .Va ntpdate_config ,
2376 if that file exists.
2377 .It Va ntpdate_program
2382 .Pa /usr/sbin/ntpdate ) .
2383 .It Va ntpdate_flags
2389 these are the flags to pass to the
2391 command (typically a hostname).
2398 command at boot time.
2404 .Pa /usr/sbin/ntpd ) .
2418 these are the flags to pass to the
2421 .It Va ntpd_sync_on_start
2428 flag, which syncs the system's clock on startup.
2431 for more information regarding the
2434 This is a preferred alternative to using
2439 .It Va nis_client_enable
2445 service at system boot time.
2446 .It Va nis_client_flags
2449 .Va nis_client_enable
2452 these are the flags to pass to the
2455 .It Va nis_ypset_enable
2461 daemon at system boot time.
2462 .It Va nis_ypset_flags
2465 .Va nis_ypset_enable
2468 these are the flags to pass to the
2471 .It Va nis_server_enable
2477 daemon at system boot time.
2478 .It Va nis_server_flags
2481 .Va nis_server_enable
2484 these are the flags to pass to the
2487 .It Va nis_ypxfrd_enable
2493 daemon at system boot time.
2494 .It Va nis_ypxfrd_flags
2497 .Va nis_ypxfrd_enable
2500 these are the flags to pass to the
2503 .It Va nis_yppasswdd_enable
2509 daemon at system boot time.
2510 .It Va nis_yppasswdd_flags
2513 .Va nis_yppasswdd_enable
2516 these are the flags to pass to the
2519 .It Va rpc_ypupdated_enable
2525 daemon at system boot time.
2526 .It Va bsnmpd_enable
2532 daemon at system boot time.
2533 Be sure to understand the security implications of running SNMP daemon
2541 these are the flags to pass to the
2544 .It Va defaultrouter
2548 create a default route to this host name or IP address
2549 (use an IP address if this router is also required to get to the
2551 .It Va ipv6_defaultrouter
2553 The IPv6 equivalent of
2555 .It Va static_arp_pairs
2557 Set to the list of static ARP pairs that are to be added at system
2559 For each whitespace separated
2562 .Va static_arp_ Ns Aq Ar element
2563 variable is assumed to exist whose contents will later be passed to a
2568 static_arp_pairs="gw"
2569 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2571 .It Va static_ndp_pairs
2573 Set to the list of static NDP pairs that are to be added at system
2575 For each whitespace separated
2578 .Va static_ndp_ Ns Aq Ar element
2579 variable is assumed to exist whose contents will later be passed to a
2584 static_ndp_pairs="gw"
2585 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2587 .It Va static_routes
2589 Set to the list of static routes that are to be added at system
2593 then for each whitespace separated
2596 .Va route_ Ns Aq Ar element
2597 variable is assumed to exist
2598 whose contents will later be passed to a
2603 static_routes="mcast gif0local"
2604 route_mcast="-net 224.0.0.0/4 -iface gif0"
2605 route_gif0local="-host 169.254.1.1 -iface lo0"
2607 .It Va ipv6_static_routes
2609 The IPv6 equivalent of
2613 then for each whitespace separated
2616 .Va ipv6_route_ Ns Aq Ar element
2617 variable is assumed to exist
2618 whose contents will later be passed to a
2619 .Dq Nm route Cm add Fl inet6
2621 .It Va natm_static_routes
2627 If not empty then for each whitespace separated
2630 .Va route_ Ns Aq Ar element
2631 variable is assumed to exist whose contents will later be passed to a
2632 .Dq Nm atmconfig Cm natm Cm add
2634 .It Va gateway_enable
2638 configure host to act as an IP router, e.g.\& to forward packets
2640 .It Va ipv6_gateway_enable
2642 The IPv6 equivalent of
2643 .Va gateway_enable .
2644 .It Va routed_enable
2648 run a routing daemon of some sort, based on the
2653 .It Va route6d_enable
2655 The IPv6 equivalent of
2659 run a routing daemon of some sort, based on the
2664 .It Va routed_program
2670 this is the name of the routing daemon to use.
2671 .It Va route6d_program
2673 The IPv6 equivalent of
2674 .Va routed_program .
2681 these are the flags to pass to the routing daemon.
2682 .It Va route6d_flags
2684 The IPv6 equivalent of
2686 .It Va mrouted_enable
2690 run the multicast routing daemon,
2692 .It Va mroute6d_enable
2694 The IPv6 equivalent of
2695 .Va mrouted_enable .
2698 run the IPv6 multicast routing daemon.
2700 Note that multicast routing daemons are no longer included in the
2702 base system, however, both
2706 may be installed from the
2709 .It Va mrouted_flags
2715 these are the flags to pass to the
2718 .It Va mroute6d_flags
2720 The IPv6 equivalent of
2726 these are the flags passed to the IPv6 multicast routing daemon.
2727 .It Va mroute6d_program
2733 this is the path to the IPv6 multicast routing daemon.
2734 .It Va rtadvd_enable
2740 daemon at boot time.
2743 utility sends ICMPv6 Router Advertisement messages to
2744 the interfaces specified in
2745 .Va rtadvd_interfaces .
2746 This should only be enabled with great care.
2747 You may want to fine-tune
2749 .It Va rtadvd_interfaces
2755 this is the list of interfaces to use.
2756 .It Va ipxgateway_enable
2760 enable the routing of IPX traffic.
2761 .It Va ipxrouted_enable
2767 daemon at system boot time.
2768 .It Va ipxrouted_flags
2771 .Va ipxrouted_enable
2774 these are the flags to pass to the
2781 enable global proxy ARP.
2782 .It Va forward_sourceroute
2790 source-routed packets are forwarded.
2791 .It Va accept_sourceroute
2795 the system will accept source-routed packets directed at it.
2802 daemon at system boot time.
2809 these are the flags to pass to the
2812 .It Va bootparamd_enable
2818 daemon at system boot time.
2819 .It Va bootparamd_flags
2822 .Va bootparamd_enable
2825 these are the flags to pass to the
2828 .It Va stf_interface_ipv4addr
2832 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2834 Specify this entry to enable the 6to4 interface.
2835 .It Va stf_interface_ipv4plen
2837 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2838 An effective value is 0-31.
2839 .It Va stf_interface_ipv6_ifid
2841 IPv6 interface ID for
2845 .It Va stf_interface_ipv6_slaid
2847 IPv6 Site Level Aggregator for
2849 .It Va ipv6_faith_prefix
2853 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2858 .It Va ipv6_ipv4mapping
2862 this enables IPv4 mapped IPv6 address communication (like
2863 .Li ::ffff:a.b.c.d ) .
2868 to enable the configuration of ATM interfaces at system boot time.
2869 For all of the ATM variables described below, please refer to the
2871 manual page for further details on the available command parameters.
2872 Also refer to the files in
2873 .Pa /usr/share/examples/atm
2874 for more detailed configuration information.
2877 This is a list of physical ATM interface drivers to load.
2882 .It Va atm_netif_ Ns Aq Ar intf
2884 For the ATM physical interface
2886 this variable defines the name prefix and count for the ATM network
2887 interfaces to be created.
2888 The value will be passed as the parameters of an
2889 .Dq Nm atm Cm "set netif" Ar intf
2891 .It Va atm_sigmgr_ Ns Aq Ar intf
2893 For the ATM physical interface
2895 this variable defines the ATM signalling manager to be used.
2896 The value will be passed as the parameters of an
2897 .Dq Nm atm Cm attach Ar intf
2899 .It Va atm_prefix_ Ns Aq Ar intf
2901 For the ATM physical interface
2903 this variable defines the NSAP prefix for interfaces using a UNI signalling
2907 the prefix will automatically be set via the
2910 Otherwise, the value will be passed as the parameters of an
2911 .Dq Nm atm Cm "set prefix" Ar intf
2913 .It Va atm_macaddr_ Ns Aq Ar intf
2915 For the ATM physical interface
2917 this variable defines the MAC address for interfaces using a UNI signalling
2921 the hardware MAC address contained in the ATM interface card will be used.
2922 Otherwise, the value will be passed as the parameters of an
2923 .Dq Nm atm Cm "set mac" Ar intf
2925 .It Va atm_arpserver_ Ns Aq Ar netif
2927 For the ATM network interface
2929 this variable defines the ATM address for a host which is to provide ATMARP
2931 This variable is only applicable to interfaces using a UNI signalling
2935 this host will become an ATMARP server.
2936 The value will be passed as the parameters of an
2937 .Dq Nm atm Cm "set arpserver" Ar netif
2939 .It Va atm_scsparp_ Ns Aq Ar netif
2943 SCSP/ATMARP service for the network interface
2945 will be initiated using the
2950 This variable is only applicable if
2951 .Va atm_arpserver_ Ns Aq Ar netif
2956 Set to the list of ATM PVCs to be added at system
2958 For each whitespace separated
2961 .Va atm_pvc_ Ns Aq Ar element
2962 variable is assumed to exist.
2963 The value of each of these variables
2964 will be passed as the parameters of an
2965 .Dq Nm atm Cm "add pvc"
2969 Set to the list of permanent ATM ARP entries to be added
2970 at system boot time.
2971 For each whitespace separated
2974 .Va atm_arp_ Ns Aq Ar element
2975 variable is assumed to exist.
2976 The value of each of these variables
2977 will be passed as the parameters of an
2978 .Dq Nm atm Cm "add arp"
2980 .It Va natm_interfaces
2984 interfaces that will also be used for HARP through
2986 If this list is not empty all interfaces in the list will be brought up
2992 For this to work the interface drivers must be either compiled into the
2993 kernel or must reside on the root partition.
2996 The keyboard bell sound.
3003 if the default behavior is desired.
3004 For details, refer to the
3009 If set to a non-null string, the virtual console's keyboard input is
3015 no keymap is installed, otherwise the value is used to install
3017 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3020 The keyboard repeat speed.
3027 if the default behavior is desired.
3032 attempt to program the function keys with the value.
3034 be a single string of the form:
3035 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3038 Can be set to the value of
3041 .Dq Li destructive ,
3044 to set the cursor behavior explicitly or choose the default behavior.
3049 no screen map is installed, otherwise the value is used to install
3050 the screen map file in
3051 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3056 the default 8x16 font value is used for screen size requests, otherwise
3058 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3064 the default 8x14 font value is used for screen size requests, otherwise
3066 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3072 the default 8x8 font value is used for screen size requests, otherwise
3074 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3080 the default screen blanking interval is used, otherwise it is set
3088 this is the actual screen saver to use
3089 .Li ( blank , snake , daemon ,
3091 .It Va moused_nondefault_enable
3095 the mouse device specified on
3096 the command line is not automatically treated as enabled by the
3097 .Pa /etc/rc.d/moused
3099 Having this variable set to
3105 to be enabled as soon as it is plugged in.
3106 .It Va moused_enable
3112 daemon is started for doing cut/paste selection on the console.
3115 This is the protocol type of the mouse connected to this host.
3116 This variable must be set if
3123 is able to detect the appropriate mouse type automatically in many cases.
3124 Set this variable to
3126 to let the daemon detect it, or
3127 select one from the following list if the automatic detection fails.
3129 If the mouse is attached to the PS/2 mouse port, choose
3133 regardless of the brand and model of the mouse.
3135 mouse is attached to the bus mouse port, choose
3139 All other protocols are for serial mice and will not work with
3140 the PS/2 and bus mice.
3141 If this is a USB mouse,
3143 is the only protocol type which will work.
3145 .Bl -tag -width ".Li x10mouseremote" -compact
3147 Microsoft mouse (serial)
3149 Microsoft IntelliMouse (serial)
3151 Mouse systems Corp.\& mouse (serial)
3153 MM Series mouse (serial)
3155 Logitech mouse (serial)
3159 Logitech MouseMan and TrackMan (serial)
3161 ALPS GlidePoint (serial)
3162 .It Li thinkingmouse
3163 Kensington ThinkingMouse (serial)
3167 MM HitTablet (serial)
3168 .It Li x10mouseremote
3169 X10 MouseRemote (serial)
3171 Interlink VersaPad (serial)
3174 Even if the mouse is not in the above list, it may be compatible
3175 with one in the list.
3176 Refer to the manual page for
3178 for compatibility information.
3180 It should also be noted that while this is enabled, any
3181 other client of the mouse (such as an X server) should access
3182 the mouse through the virtual mouse device,
3184 and configure it as a
3186 type mouse, since all
3187 mouse data is converted to this single canonical format when
3190 If the client program does not support the
3196 It is the second preferred type.
3203 this is the actual port the mouse is on.
3206 for a COM1 serial mouse,
3210 for a bus mouse, for example.
3215 is set, its value is used as an additional set of flags to pass to the
3218 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3220 .Va moused_nondefault_enable
3223 daemon is started for a non-default port, the
3224 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3225 set of options has precedence over and replaces the default
3226 .Va moused_flags (where
3228 is the name of the non-default port, i.e.\&
3231 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3232 it is possible to set up a different set of default flags for each
3235 For example, you can use
3239 to make your laptop's touchpad more comfortable to use,
3240 but an empty set of options for
3241 .Va moused_ums0_flags
3244 mouse has three or more buttons.
3245 .It Va mousechar_start
3249 the default mouse cursor character range
3250 .Li 0xd0 Ns - Ns Li 0xd3
3252 otherwise the range start is set
3257 Use if the default range is occupied in the language code table.
3258 .It Va allscreens_flags
3262 is run with these options for each of the virtual terminals
3266 will enable the mouse pointer on all virtual terminals
3271 .It Va allscreens_kbdflags
3275 is run with these options for each of the virtual terminals
3281 scrollback (history) buffer to 200 lines.
3288 daemon at system boot time.
3294 .Pa /usr/sbin/cron ) .
3301 these are the flags to pass to
3307 enable the special handling of transitions to and from the
3308 Daylight Saving Time in
3310 (equivalent to using the flag
3317 .Pa /usr/sbin/lpd ) .
3324 daemon at system boot time.
3331 these are the flags to pass to the
3334 .It Va chkprintcap_enable
3340 command before starting the
3343 .It Va chkprintcap_flags
3348 .Va chkprintcap_enable
3351 these are the flags to pass to the
3356 which causes missing directories to be created.
3357 .It Va mta_start_script
3359 This variable specifies the full path to the script to run to start
3360 a mail transfer agent.
3362 .Pa /etc/rc.sendmail .
3366 .Pa /etc/rc.sendmail
3367 uses are documented in the
3372 Indicates the device (usually a swap partition) to which a crash dump
3373 should be written in the event of a system crash.
3374 If the value of this variable is
3376 the first suitable swap device listed in
3378 will be used as dump device.
3379 Otherwise, the value of this variable is passed as the argument to
3381 To disable crash dumps, set this variable to
3385 When the system reboots after a crash and a crash dump is found on the
3386 device specified by the
3390 will save that crash dump and a copy of the kernel to the directory
3394 The default value is
3403 .It Va savecore_flags
3405 If crash dumps are enabled, these are the flags to pass to the
3412 to turn on user and group disk quotas on system startup via the
3414 command for all file systems marked as having quotas enabled in
3416 The kernel must be built with
3418 for disk quotas to function.
3423 to enable user and group disk quota checking via the
3426 .It Va quotacheck_flags
3436 these are the flags to pass to the
3441 which checks quotas for all file systems with quotas enabled in
3443 .It Va quotaon_flags
3449 these are the flags to pass to the
3454 which enables quotas for all file systems with quotas enabled in
3456 .It Va quotaoff_flags
3462 these are the flags to pass to the
3464 utility when shutting down the quota system.
3467 which disables quotas for all file systems with quotas enabled in
3469 .It Va accounting_enable
3473 to enable system accounting through the
3480 to enable iBCS2 (SCO) binary emulation at system initial boot
3482 .It Va ibcs2_loaders
3490 this specifies a list of additional iBCS2 loaders to enable.
3495 to enable Linux/ELF binary emulation at system initial
3501 enable SysVR4 emulation at boot time.
3502 .It Va sysvipc_enable
3506 load System V IPC primitives at boot time.
3507 .It Va clear_tmp_enable
3518 to disable removing of X11 lock files,
3519 and the removal and (secure) recreation
3520 of the various socket directories for X11
3522 .It Va ldconfig_paths
3524 Set to the list of shared library paths to use with
3528 will always be added first, so it need not appear in this list.
3529 .It Va ldconfig32_paths
3531 Set to the list of 32-bit compatibility shared library paths to
3534 .It Va ldconfig_paths_aout
3536 Set to the list of shared library paths to use with
3541 .It Va ldconfig_insecure
3545 utility normally refuses to use directories
3546 which are writable by anyone except root.
3547 Set this variable to
3549 to disable that security check during system startup.
3550 .It Va ldconfig_local_dirs
3552 Set to the list of local
3555 The names of all files in the directories listed will be
3556 passed as arguments to
3558 .It Va ldconfig_local32_dirs
3560 Set to the list of local 32-bit compatibility
3563 The names of all files in the directories listed will be
3564 passed as arguments to
3565 .Dq Nm ldconfig Fl 32 .
3566 .It Va kern_securelevel_enable
3570 to set the kernel security level at system startup.
3571 .It Va kern_securelevel
3573 The kernel security level to set at startup.
3574 The allowed range of
3576 ranges from \-1 (the compile time default) to 3 (the
3580 for the list of possible security levels and their effect
3581 on system operation.
3584 Path to the SSH server program
3585 .Pa ( /usr/sbin/sshd
3593 at system boot time.
3600 these are the flags to pass to the
3605 Path to the FTP server program
3606 .Pa ( /usr/libexec/ftpd
3614 as a stand-alone daemon at system boot time.
3621 these are the additional flags to pass to the
3624 .It Va watchdogd_enable
3630 daemon at boot time.
3631 This requires that the kernel have been compiled with a
3634 .It Va watchdogd_flags
3637 .Va watchdogd_enable
3640 these are the flags passed to the
3643 .It Va performance_cx_lowest
3645 CPU idle state to use while on AC power.
3650 should use the lowest power state available while
3652 indicates that the lowest latency state (less power savings) should be used.
3653 .It Va performance_cpu_freq
3655 CPU clock frequency to use while on AC power.
3660 should use the lowest frequency available while
3662 indicates that the highest frequency (less power savings) should be used.
3663 .It Va economy_cx_lowest
3665 CPU idle state to use when off AC power.
3670 should use the lowest power state available while
3672 indicates that the lowest latency state (less power savings) should be used.
3673 .It Va economy_cpu_freq
3675 CPU clock frequency to use when off AC power.
3680 should use the lowest frequency available while
3682 indicates that the highest frequency (less power savings) should be used.
3687 any configured jails will not be started.
3688 .It jail_parallel_start
3692 all configured jails will be started in the background (= in parallel).
3695 A space separated list of names for jails.
3696 This is purely a configuration aid to help identify and
3697 configure multiple jails.
3698 The names specified in this list will be used to
3699 identify settings common to an instance of a jail,
3700 and should contain alphanumeric characters only.
3701 Assuming that the jail in question was named
3703 you would have the following dependent variables:
3705 jail_vjail_hostname="jail.example.com"
3706 jail_vjail_ip="192.0.2.100"
3707 jail_vjail_rootdir="/var/jails/vjail/root"
3713 When set, use as default value for
3714 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3717 .It Va jail_interface
3720 When set, use as default value for
3721 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3727 When set, use as default value for
3728 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3731 .It Va jail_mount_enable
3739 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3742 by default for every jail in
3744 .It Va jail_devfs_ruleset
3748 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3749 to given value for every jail in
3751 .It Va jail_devfs_enable
3759 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3762 by default for every jail in
3764 .It Va jail_fdescfs_enable
3772 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3775 by default for every jail in
3777 .It Va jail_procfs_enable
3785 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3788 by default for every jail in
3790 .It Va jail_exec_prestart Ns Aq Ar N
3793 When set, use as default value for
3794 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3797 .It Va jail_exec_start
3800 When set, use as default value for
3801 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3804 .It Va jail_exec_afterstart Ns Aq Ar N
3807 When set, use as default value for
3808 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3811 .It Va jail_exec_poststart Ns Aq Ar N
3814 When set, use as default value for
3815 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3818 .It Va jail_exec_prestop Ns Aq Ar N
3821 When set, use as default value for
3822 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3825 .It Va jail_exec_stop
3827 When set, use as default value for
3828 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3831 .It Va jail_exec_poststop Ns Aq Ar N
3834 When set, use as default value for
3835 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3838 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3841 Set to the root directory used by jail
3843 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3846 Set to the fully qualified domain name (FQDN) assigned to jail
3848 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3851 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3852 The argument can be a sole address or a comma separated list of addresses.
3853 Additionally each address can be prefixed by the name of an interface
3854 followed by a pipe to overwrite
3855 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3858 and/or suffixed by a netmask, prefixlen or prefix.
3859 In case no netmask, prefixlen or prefix is given,
3861 will be used for IPv4 and
3863 will be used for an IPv6 address.
3864 If no address is given for the jail then the jail will be started with
3865 no networking support.
3866 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3869 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3870 The sequence starts with
3872 and the numbers have to be strictly ascending.
3873 These entries follow the same syntax as their primary
3874 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3876 The order of the entries can be important as the first address for
3877 each address family found will be the primary address of the jail.
3883 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3888 These are flags to pass to
3890 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3893 When set, sets the interface to use when setting IP address alias.
3894 Note that the alias is created at jail startup and removed at jail shutdown.
3895 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3898 When set, the jail is started with the specified forwarding table (sometimes
3899 referred to as a routing table) via
3901 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3904 .Pa /etc/fstab. Ns Aq Ar jname
3906 This is the file system information file to use for jail
3908 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3915 mount all file systems from
3916 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3918 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3921 When set, defines the device file system ruleset file to use for jail
3923 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3930 mount the device file system inside jail
3933 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3940 mount the file-descriptor file system inside jail
3943 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3950 mount the process file system inside jail
3953 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3956 This is the command run as
3959 before jail startup, where
3962 It is run outside the jail.
3963 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3966 .Dq Li /bin/sh /etc/rc
3968 This is the command executed in a jail at jail startup.
3969 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3972 This is the command run as
3976 after jail startup, where
3979 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3982 This is the command run as
3985 after jail startup, where
3988 It is run outside the jail.
3989 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3992 This is the command run as
3995 before jail shutdown, where
3998 It is run outside the jail.
3999 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4002 .Dq Li /bin/sh /etc/rc.shutdown
4004 This is the command executed in a jail at jail shutdown.
4005 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
4008 This is the command run as
4011 after jail shutdown, where
4014 It is run outside the jail.
4015 .It Va jail_set_hostname_allow
4019 do not allow the root user in a jail to set its hostname.
4020 .It Va jail_socket_unixiproute_only
4024 do not allow any sockets,
4025 besides UNIX/IP/route sockets,
4026 to be used within a jail.
4027 .It Va jail_sysvipc_allow
4031 allow applications within a jail to use System V IPC.
4032 .\" -----------------------------------------------------
4033 .It Va harvest_interrupt
4037 to use hardware interrupts as an entropy source.
4040 for more information.
4041 .It Va harvest_ethernet
4045 to use LAN traffic as an entropy source.
4048 for more information.
4049 .It Va harvest_p_to_p
4053 to use serial line traffic as an entropy source.
4056 for more information.
4061 to disable caching entropy via
4063 Otherwise set to the directory used to store entropy files in.
4068 to disable caching entropy through reboots.
4069 Otherwise set to the filename used to store cached entropy through
4071 This file should be located on the root file system to seed the
4073 device as early as possible in the boot process.
4074 .It Va entropy_save_sz
4076 Size of the entropy cache files saved by
4079 .It Va entropy_save_num
4081 Number of entropy cache files to save by
4095 Configuration file for
4104 .Pa /var/run/dmesg.boot
4106 .It Va rcshutdown_timeout
4108 If set, start a watchdog timer in the background which will terminate
4112 has not completed within the specified time (in seconds).
4113 Notice that in addition to this soft timeout,
4115 also applies a hard timeout for the execution of
4117 This is configured via
4120 .Va kern.init_shutdown_timeout
4121 and defaults to 120 seconds.
4122 Setting the value of
4123 .Va rcshutdown_timeout
4124 to more than 120 seconds will have no effect until the
4127 .Va kern.init_shutdown_timeout
4129 .It Va virecover_enable
4133 to prevent the system from trying to
4134 recover pre-maturely terminated
4137 .It Va ugidfw_enable
4142 .Xr mac_bsdextended 4
4143 module upon system initialization and load a default
4145 .It Va bsdextended_script
4148 .Xr mac_bsdextended 4
4149 ruleset file to load.
4150 The default value of this variable is
4151 .Pa /etc/rc.bsdextended .
4152 .It Va newsyslog_enable
4159 .It Va newsyslog_flags
4162 .Va newsyslog_enable
4165 these are the flags to pass to the
4170 which causes log files flagged with a
4173 .It Va mdconfig_md Ns Aq Ar X
4183 must be specified and either a
4185 for malloc or swap backed
4193 .Va mdconfig_md Ns Aq Ar X
4194 variables are evaluated until one variable is unset or null.
4195 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4197 Optional arguments passed to
4203 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4205 An ownership specification passed to
4214 device and the mount point will be changed.
4215 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4217 A mode string passed to
4226 device and the mount point will be changed.
4227 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4229 Files to be copied to the mount point of the
4233 after it has been mounted.
4234 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4236 Command to execute after the specified
4241 Note that the command is passed to
4247 variables can be used to reference respectively the
4249 device and the mount point.
4254 one could set the following:
4256 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4258 .It Va autobridge_interfaces
4260 Set to the list of bridge interfaces that will have newly arriving interfaces
4261 checked against to be automatically added.
4264 then for each whitespace separated
4267 .Va autobridge_ Ns Aq Ar element
4268 variable is assumed to exist which has a whitespace separated list of interface
4269 names to match, these names can use wildcards.
4272 autobridge_interfaces="bridge0"
4273 autobridge_bridge0="tap* dc0 vlan[345]"
4279 enable support for sound mixer.
4280 .It Va hcsecd_enable
4284 enable Bluetooth security daemon.
4285 .It Va hcsecd_config
4287 Configuration file for
4290 .Pa /etc/bluetooth/hcsecd.conf .
4295 enable Bluetooth Service Discovery Protocol daemon.
4303 .It Va sdpd_groupname
4307 group to run as after it initializes.
4310 .It Va sdpd_username
4314 user to run as after it initializes.
4317 .It Va bthidd_enable
4321 enable Bluetooth Human Interface Device daemon.
4322 .It Va bthidd_config
4324 Configuration file for
4327 .Pa /etc/bluetooth/bthidd.conf .
4330 Path to a file, where
4332 will store information about known HID devices.
4334 .Pa /var/db/bthidd.hids .
4335 .It Va rfcomm_pppd_server_enable
4339 enable Bluetooth RFCOMM PPP wrapper daemon.
4340 .It Va rfcomm_pppd_server_profile
4342 The name of the profile to use from
4343 .Pa /etc/ppp/ppp.conf .
4344 Multiple profiles can be specified here.
4345 Also used to specify per-profile overrides.
4346 When the profile name contains any of the characters
4348 they are translated to
4350 for the proposes of the override variable names.
4351 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4353 Overrides local address to listen on.
4359 The address can be specified as BD_ADDR or name.
4360 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4362 Overrides local RFCOMM channel to listen on.
4365 will listen on RFCOMM channel 1.
4366 Must set properly if multiple profiles used in the same time.
4367 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4371 if it should register Serial Port service on the specified RFCOMM channel.
4374 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4378 if it should register Dial-Up Networking service on the specified
4382 .It Va ubthidhci_enable
4386 change the USB Bluetooth controller from HID mode to HCI mode.
4387 You also need to specify the location of USB Bluetooth controller with the
4388 .Va ubthidhci_busnum
4392 .It Va ubthidhci_busnum
4393 Bus number where the USB Bluetooth controller is located.
4396 on your system to find this information.
4397 .It Va ubthidhci_addr
4398 Bus address of the USB Bluetooth controller.
4401 on your system to find this information.
4402 .It Va netwait_enable
4406 delays the start of network-reliant services until
4408 is up and ICMP packets to a destination defined in
4411 Link state is examined first, followed by
4413 an IP address to verify network usability.
4414 If no destination can be reached or timeouts are exceeded,
4415 network services are started anyway with no guarantee that
4416 the network is usable.
4417 Use of this variable requires both
4425 This variable contains a space-delimited list of IP addresses to
4427 DNS hostnames should not be used as resolution is not guaranteed
4428 to be functional at this point.
4429 If multiple IP addresses are specified,
4430 each will be tried until one is successful or the list is exhausted.
4431 .It Va netwait_timeout
4433 Indicates the total number of seconds to perform a
4435 against each IP address in
4437 at a rate of one ping per second.
4438 If any of the pings are successful,
4439 full network connectivity is considered reliable.
4444 Defines the name of the network interface on which watch for link.
4446 is used to monitor the interface, looking for
4447 .Dq Li status: no carrier .
4448 Once gone, the link is considered up.
4451 interface if desired.
4452 .It Va netwait_if_timeout
4454 Defines the total number of seconds to wait for link to become usable,
4455 polled at a 1-second interval.
4459 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4460 .It Pa /etc/defaults/rc.conf
4462 .It Pa /etc/rc.conf.local
4491 .Xr newsyslog.conf 5 ,
4560 .An Jordan K. Hubbard .
projects / FreeBSD / releng / 9.0.git / blob