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
25 .\" $FreeBSD: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $
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 installer.
45 is not to run commands or perform system startup actions directly.
46 Instead, it is included by the various generic startup scripts in
48 which conditionalize their
49 internal actions according to the settings found there.
52 .Pa /etc/defaults/rc.conf
53 file specifies the default settings for all the available options,
56 file specifies override settings.
57 Options need only be specified in
59 when the system administrator wishes to override the defaults.
61 .Pa /etc/rc.conf.local
62 is used to override settings in
64 for historical reasons.
69 The following list provides a name and short description for each
70 variable that can be set in the
87 These values are case insensitive.
90 postfix in the name of a variable for starting a service can be
93 .Bl -tag -width indent-two
98 enable output of debug messages from rc scripts.
99 This variable can be helpful in diagnosing mistakes when
100 editing or integrating new scripts.
101 Beware that this produces copious output to the terminal and
107 disable informational messages from the rc scripts.
108 Informational messages are displayed when
109 a condition that is not serious enough to warrant a warning or an error occurs.
114 no swapfile is installed, otherwise the value is used as the full
115 pathname to a file to use for additional swap space.
120 enable support for Automatic Power Management with the
127 to handle APM event from userland.
128 This also enables support for APM.
135 these are the flags to pass to the
141 to monitor the status of batteries present in the system.
142 This also enables support for APM.
149 these are the flags to pass to the
156 to handle device added, removed or unknown events from the kernel.
163 these are the flags to pass to the
175 a CPU speed control daemon.
176 .It Va sensorsd_enable
185 a sensors monitoring and logging daemon.
186 .It Va sensorsd_flags
189 Additional flags passed to the
192 .It Va hotplugd_enable
201 a devices hot plugging monitoring daemon.
202 .It Va hotplugd_flags
205 Additional flags passed to the
208 .It Va pccard_ifconfig
210 List of arguments to be passed to
212 at boot time or on insertion of the card (e.g.\&
213 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
214 for a fixed address or
217 .It Va pccard_ether_delay
219 Set the delay before starting
222 .Pa /etc/pccard_ether
224 This defaults to 5 seconds to work around a bug in the
226 driver which can lead to system hangs when using some newer
229 .It Va removable_interfaces
231 List of removable network interfaces to be supported by
232 .Pa /etc/pccard_ether .
235 List of directories to search for startup script files.
236 .It Va script_name_sep
238 The field separator to use for breaking down the list of startup script files
239 into individual filenames.
240 The default is a space.
241 It is not necessary to change this unless there are startup scripts with names
243 .It Va hostapd_enable
252 The fully qualified domain name (FQDN) of this host on the network.
253 This should almost certainly be set to something meaningful, even if
254 there is no network connection.
257 is used to set the hostname via DHCP,
258 this variable should be set to an empty string.
261 Enable support for IPv6 networking.
262 Note that this requires that the kernel have been compiled with
263 .Cd "options INET6" .
266 The NIS domain name of this host, or
269 .It Va dhclient_program
271 Path to the DHCP client program
273 .Pa /sbin/dhclient ) .
274 .It Va dhclient_flags
276 Additional flags to pass to the DHCP client program.
284 If the kernel was not built with
288 kernel module will be loaded.
290 .Va firewall_enable .
295 ruleset definition file.
306 these are the flags to pass to
308 when loading the ruleset.
315 which logs packets from
323 this specifies the path of the log file.
334 these are the flags to pass to
336 .It Va firewall_enable
340 to load firewall rules at startup.
341 If the kernel was not built with
342 .Cd "options IPFIREWALL" ,
345 kernel module will be loaded.
348 .It Va ipv6_firewall_enable
350 The IPv6 equivalent of
351 .Va firewall_enable .
354 to load IPv6 firewall rules at startup.
355 If the kernel was not built with
356 .Cd "options IPV6FIREWALL" ,
359 kernel module will be loaded.
360 .It Va firewall_script
362 The full path to the firewall script to run
364 .Pa /etc/rc.firewall ) .
365 .It Va ipv6_firewall_script
367 The IPv6 equivalent of
368 .Va firewall_script .
371 Names the firewall type from the selection in
372 .Pa /etc/rc.firewall ,
373 or the file which contains the local firewall ruleset.
374 Valid selections from
378 .Bl -tag -width ".Li simple" -compact
380 unrestricted IP access
382 all IP services disabled, except via
385 basic protection for a workstation on a LAN
391 If a filename is specified, the full path must be given.
392 .It Va firewall_trusted_nets
394 List of trusted networks (if
398 .It Va firewall_trusted_interfaces
400 List of trusted network interfaces (if
404 .It Va firewall_allowed_icmp_types
406 List of allowed ICMP types (if
410 .It Va firewall_open_tcp_ports
412 List of TCP ports to open (if
416 .It Va firewall_open_udp_ports
418 List of UDP ports to open (if
422 .It Va ipv6_firewall_type
424 The IPv6 equivalent of
426 .It Va firewall_quiet
430 to disable the display of firewall rules on the console during boot.
431 .It Va ipv6_firewall_quiet
433 The IPv6 equivalent of
435 .It Va firewall_logging
439 to enable firewall event logging.
440 This is equivalent to the
441 .Dv IPFIREWALL_VERBOSE
443 .It Va ipv6_firewall_logging
445 The IPv6 equivalent of
446 .Va firewall_logging .
447 .It Va firewall_flags
453 specifies a filename.
454 .It Va ipv6_firewall_flags
456 The IPv6 equivalent of
473 sockets must be enabled in the kernel.
474 .It Va natd_interface
476 This is the name of the public interface on which
479 The interface may be given as an interface name or as an IP address.
484 flags should be placed here.
489 flag is automatically added with the above
492 .It Va tcp_extensions
499 disables certain TCP options as described by
505 might help remedy such problems with connections as randomly hanging
506 or other weird behavior.
507 Some network devices are known to be broken with respect to these options.
514 .Va net.inet.tcp.log_in_vain
516 .Va net.inet.udp.log_in_vain ,
521 are set to the given value.
529 will disable probing idle TCP connections to verify that the
530 peer is still up and reachable.
531 .It Va tcp_drop_synfin
538 will cause the kernel to ignore TCP frames that have both
539 the SYN and FIN flags set.
540 This prevents OS fingerprinting, but may break some legitimate applications.
541 This option is only available if the kernel was built with the
544 .It Va icmp_drop_redirect
551 will cause the kernel to ignore ICMP REDIRECT packets.
554 for more information.
555 .It Va icmp_log_redirect
562 will cause the kernel to log ICMP REDIRECT packets.
564 the log messages are not rate-limited, so this option should only be used
565 for troubleshooting networks.
568 for more information.
569 .It Va icmp_bmcastecho
573 to respond to broadcast or multicast ICMP ping packets.
576 for more information.
577 .It Va ip_portrange_first
581 this is the first port in the default portrange.
584 for more information.
585 .It Va ip_portrange_last
589 this is the last port in the default portrange.
592 for more information.
594 .It Va ifconfig_ Ns Aq Ar interface
598 Typically includes IP address.
599 Assuming that the interface in question was
601 it might look something like this:
603 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
607 .Pa /etc/start_if. Ns Aq Ar interface
608 file is present, it is read and executed by the
610 interpreter before configuring the interface as specified in the
611 .Va ifconfig_ Ns Aq Ar interface
613 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
616 It is possible to bring up an interface with DHCP by adding
619 .Va ifconfig_ Ns Aq Ar interface
621 For instance, to initialize the
623 device via DHCP, it is possible to use something like:
629 .Va wlans_ Ns Aq Ar interface
633 interface will be created for each item in the list with the
637 Further wlan cloning arguments may be passed to the
640 command by setting the
641 .Va create_args_ Ns Aq Ar interface
645 devices must be created for each wireless devices as of
651 may be specified with an
652 .Va wlandebug_ Ns Aq Ar interface
654 The contents of this variable will be passed directly to
657 Also, if your interface needs WPA authentication, it is possible to add
660 .Va ifconfig_ Ns Aq Ar interface
663 .Xr wpa_supplicant 8 .
665 .Xr wpa_supplicant.conf 5
666 for configuring authentication information.
670 options in this variable, in addition to the
671 .Pa /etc/start_if. Ns Aq Ar interface
673 For instance, to initialize the
675 device via DHCP, using WPA authentication and 802.11b mode, it is
676 possible to use something like:
679 ifconfig_wlan0="up DHCP WPA mode 11b"
683 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
685 Configuration to establish an additional network address for
687 Assuming that the interface in question was
689 it might look something like this:
691 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
692 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
697 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
698 entry that is found, its contents are passed to
700 Execution stops at the first unsuccessful access, so if
701 something like this is present:
703 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
704 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
705 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
706 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
709 Then note that alias4 would
711 be added since the search would stop with the missing alias3 entry.
714 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
718 It is possible to rename interface by doing:
720 ifconfig_ed0_name="net0"
721 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
723 .It Va network_interfaces
725 The list of network interfaces to configure on this host,
728 to configure all network interfaces
731 For example, if the only network devices to be configured are the loopback device
735 driver, this could be set to
738 .Va ifconfig_ Ns Aq Ar interface
739 variable is assumed to exist for each value of
741 .It Va ipv6_network_interfaces
743 This is the IPv6 equivalent of
744 .Va network_interfaces .
745 Instead of setting the ifconfig variables as
746 .Va ifconfig_ Ns Aq Ar interface
747 they should be set as
748 .Va ipv6_ifconfig_ Ns Aq Ar interface .
749 Aliases should be set as
750 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
751 Interfaces that do not have a
752 .Va ipv6_ifconfig_ Ns Aq Ar interface
753 setting will be auto configured by
756 .Va ipv6_gateway_enable
759 Note that the IPv6 networking code does not support the
760 .Pa /etc/start_if. Ns Aq Ar interface
762 .It Va ipv6_prefix_ Ns Aq Ar interface
766 prefixlen 64 is used.
767 .It Va ipv6_default_interface
771 this is the default output interface for scoped addresses.
772 Now this works only for IPv6 link local multicast addresses.
773 .It Va cloned_interfaces
775 Set to the list of clonable network interfaces to create on this host.
777 .Va cloned_interfaces
778 are automatically appended to
779 .Va network_interfaces
781 .It Va gif_interfaces
785 tunnel interfaces to configure on this host.
787 .Va gifconfig_ Ns Aq Ar interface
788 variable is assumed to exist for each value of
790 The value of this variable is used to configure the link layer of the
791 tunnel according to the syntax of the
795 Additionally, this option ensures that each listed interface is created via the
799 before attempting to configure it.
800 .It Va sppp_interfaces
804 interfaces to configure on this host.
806 .Va spppconfig_ Ns Aq Ar interface
807 variable is assumed to exist for each value of
809 Each interface should also be configured by a general
810 .Va ifconfig_ Ns Aq Ar interface
814 for more information about available options.
824 Mode in which to run the
833 See the manual for a full description.
838 enables network address translation.
839 Used in conjunction with
841 allows hosts on private network addresses access to the Internet using
842 this host as a network address translating router.
845 The name of the profile to use from
846 .Pa /etc/ppp/ppp.conf .
849 The name of the user under which
858 This option is used to specify a list of files that will override
860 .Pa /etc/defaults/rc.conf .
861 The files will be read in the order in which they are specified and should
862 include the full path to the file.
863 By default, the files specified are
866 .Pa /etc/rc.conf.local
874 flag if the initial preen of the file systems fails.
877 List of file system types that are network-based.
878 This list should generally not be modified by end users.
880 .Va extra_netfs_types
882 .It Va extra_netfs_types
884 If set to something other than
886 (the default), this variable extends the list of file system types
887 for which automatic mounting at startup by
889 should be delayed until the network is initialized.
891 a whitespace-separated list of network file system descriptor pairs,
892 each consisting of a file system type as passed to
894 and a human-readable, one-word description, joined with a colon
896 Extending the default list in this way is only necessary
897 when third party file system types are used.
898 .It Va devfs_config_files
900 This option is used to specify a list of configuration files containing
902 rules that will be applied by
904 in the order in which they are specified and must include the full path
906 .It Va syslogd_enable
913 .It Va syslogd_program
918 .Pa /usr/sbin/syslogd ) .
925 these are the flags to pass to
939 .Pa /usr/sbin/inetd ) .
946 these are the flags to pass to
961 these are the flags to pass to it.
975 these are the flags to pass to it.
978 manpage for more information.
979 .It Va amd_map_program
981 If set, the specified program is run to get the list of
986 maps are stored in NIS, one can set this to run
998 will be updated at boot time to reflect the kernel release being run.
1002 will not be updated.
1003 .It Va nfs_client_enable
1007 setup NFS client parameters at boot time.
1008 .It Va nfs_access_cache
1011 .Va nfs_client_enable
1016 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1017 NFS ACCESS results should be cached.
1018 A value of 2-10 seconds will substantially reduce network traffic for
1019 many NFS operations.
1020 The default is 5 seconds.
1021 Note that the attribute cache holds stat information only.
1022 The NFS data cache is independent of the attribute cache and is only
1023 invalidated when the client detects that the server has modified the
1025 This value specifies a maximum timeout.
1026 The NFS client will automatically use a shorter timeout for files which
1027 have been recently modified.
1028 .It Va nfs_neg_cache
1031 .Va nfs_client_enable
1036 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1037 filenames), or to the number of seconds for which negative lookups should
1039 A value of 2-10 seconds will substantially reduce network
1040 traffic for many NFS operations, especially source code builds.
1041 The default is 3 seconds.
1042 .It Va nfs_server_enable
1046 run the NFS server daemons at boot time.
1047 .It Va nfs_server_flags
1050 .Va nfs_server_enable
1053 these are the flags to pass to the
1056 .It Va mountd_enable
1061 .Va nfs_server_enable
1067 It is commonly needed to run CFS without real NFS used.
1074 these are the flags to pass to the
1077 .It Va weak_mountd_authentication
1081 allow services like PCNFSD to make non-privileged mount requests.
1082 .It Va nfs_reserved_port_only
1086 provide NFS services only on a secure port.
1087 .It Va nfs_bufpackets
1089 If set to a number, indicates the number of packets worth of
1090 socket buffer space to reserve on an NFS client.
1091 The kernel default is typically 4.
1092 Using a higher number may be useful on gigabit networks to improve performance.
1093 The minimum value is 2 and the maximum is 64.
1094 .It Va rpc_umntall_enable
1098 (default) and we are also an NFS client, run
1100 at boot time to clear out old mounts on remote servers.
1105 will not be run at boot time.
1106 .It Va rpc_lockd_enable
1110 and also an NFS server, run
1113 .It Va rpc_lockd_flags
1116 .Va rpc_lockd_enable
1119 these are the flags to pass to
1121 .It Va rpc_statd_enable
1125 and also an NFS server, run
1128 .It Va rpc_statd_flags
1131 .Va rpc_statd_enable
1134 these are the flags to pass to
1136 .It Va rpcbind_program
1138 Path to program for rpcbind daemon
1140 .Pa /usr/sbin/rpcbind ) .
1141 .It Va rpcbind_enable
1148 .It Va rpcbind_flags
1154 these are the flags to pass to
1155 .Va rpcbind_program .
1156 .It Va keyserv_enable
1162 daemon on boot for running Secure RPC.
1163 .It Va keyserv_flags
1169 these are the flags to pass to
1172 .It Va pppoed_enable
1178 daemon at boot time to provide PPP over Ethernet services.
1179 .It Va pppoed_provider
1182 listens to requests to this provider and ultimately runs
1186 argument of the same name.
1189 Additional flags to pass to
1191 .It Va pppoed_interface
1193 The network interface to run
1196 This is mandatory when
1206 service at boot time.
1207 This command is intended for networks of machines where a consistent
1209 for all hosts must be established.
1210 This is often useful in large NFS environments where time stamps on
1211 files are expected to be consistent network-wide.
1218 these are the flags to pass to the
1227 at system boot time.
1228 .It Va dntpd_program
1233 .Pa /usr/sbin/dntpd ) .
1240 these are the flags to pass to the
1243 .It Va btconfig_enable
1247 configure Bluetooth devices via
1249 at system boot time.
1250 .It Va btconfig_devices
1256 this is the list of Bluetooth devices to configure.
1258 .Va btconfig_devices
1259 is not specified, all devices known to the system will be configured.
1261 .Va btconfig_ Ns Aq Ar device
1262 variable can be set to specify parameters to be passed to
1264 .It Va btconfig_args
1270 this is the list of configuration parameters to pass to all Bluetooth
1276 run the Service Discovery Profile daemon
1278 at system boot time.
1285 these are the flags to pass to the
1288 .It Va bthcid_enable
1292 run the Bluetooth Link Key/PIN Code Manager daemon
1294 at system boot time.
1301 these are the flags to pass to the
1304 .It Va nis_client_enable
1310 service at system boot time.
1311 .It Va nis_client_flags
1314 .Va nis_client_enable
1317 these are the flags to pass to the
1320 .It Va nis_ypset_enable
1326 daemon at system boot time.
1327 .It Va nis_ypset_flags
1330 .Va nis_ypset_enable
1333 these are the flags to pass to the
1336 .It Va nis_server_enable
1342 daemon at system boot time.
1343 .It Va nis_server_flags
1346 .Va nis_server_enable
1349 these are the flags to pass to the
1352 .It Va nis_ypxfrd_enable
1358 daemon at system boot time.
1359 .It Va nis_ypxfrd_flags
1362 .Va nis_ypxfrd_enable
1365 these are the flags to pass to the
1368 .It Va nis_yppasswdd_enable
1374 daemon at system boot time.
1375 .It Va nis_yppasswdd_flags
1378 .Va nis_yppasswdd_enable
1381 these are the flags to pass to the
1384 .It Va rpc_ypupdated_enable
1390 daemon at system boot time.
1391 .It Va defaultrouter
1395 create a default route to this host name or IP address
1396 (use an IP address if this router is also required to get to the
1398 .It Va ipv6_defaultrouter
1400 The IPv6 equivalent of
1402 .It Va static_routes
1404 Set to the list of static routes that are to be added at system boot time.
1407 then for each whitespace separated
1410 .Va route_ Ns Aq Ar element
1411 variable is assumed to exist whose contents will later be passed to a
1414 .It Va change_routes
1416 Set to the list of static routes that are to be changed at system boot time
1417 (such as those added by the kernel).
1420 then for each whitespace separated
1423 .Va change_route_ Ns Aq Ar element
1424 variable is assumed to exist whose contents will later be passed to a
1425 .Dq Nm route Cm change
1427 .It Va ipv6_static_routes
1429 The IPv6 equivalent of
1433 then for each whitespace separated
1436 .Va ipv6_route_ Ns Aq Ar element
1437 variable is assumed to exist whose contents will later be passed to a
1438 .Dq Nm route Cm add Fl inet6
1440 .It Va gateway_enable
1444 configure host to act as an IP router, e.g. to forward packets
1446 .It Va ipv6_gateway_enable
1448 The IPv6 equivalent of
1449 .Va gateway_enable .
1450 .It Va router_enable
1454 run a routing daemon of some sort, based on the settings of
1458 .It Va ipv6_router_enable
1460 The IPv6 equivalent of
1464 run a routing daemon of some sort, based on the settings of
1465 .Va ipv6_router_program
1467 .Va ipv6_router_flags .
1468 .It Va router_program
1474 this is the name of the routing daemon to use
1476 .Pa /sbin/routed ) .
1477 .It Va ipv6_router_program
1479 The IPv6 equivalent of
1482 .Pa /sbin/route6d ) .
1489 these are the flags to pass to the routing daemon.
1490 .It Va ipv6_router_flags
1492 The IPv6 equivalent of
1494 .It Va mrouted_enable
1498 run the multicast routing daemon,
1500 .It Va mroute6d_enable
1502 The IPv6 equivalent of
1503 .Va mrouted_enable .
1506 run the IPv6 multicast routing daemon.
1507 Note that no IPv6 multicast routing daemon is included in the
1511 can be installed from the
1514 .It Va mrouted_flags
1520 these are the flags to pass to the
1523 .It Va mroute6d_flags
1525 The IPv6 equivalent of
1531 these are the flags passed to the IPv6 multicast routing daemon.
1532 .It Va mroute6d_program
1538 this is the path to the IPv6 multicast routing daemon.
1539 .It Va rtadvd_enable
1545 daemon at boot time.
1548 .Va ipv6_gateway_enable
1553 utility sends router advertisement packets to the interfaces specified in
1554 .Va rtadvd_interfaces .
1556 and should only be enabled with great care.
1557 You may want to fine-tune
1559 .It Va rtadvd_interfaces
1565 this is the list of interfaces to use.
1566 .It Va rtsold_enable
1572 daemon at boot time.
1575 daemon is used for automatic discovery of non-link local addresses.
1582 these are the flags to pass to the
1585 .It Va ipxgateway_enable
1589 enable the routing of IPX traffic.
1590 .It Va ipxrouted_enable
1596 daemon at system boot time.
1597 .It Va ipxrouted_flags
1600 .Va ipxrouted_enable
1603 these are the flags to pass to the
1610 enable global proxy ARP.
1611 .It Va forward_sourceroute
1619 source-routed packets are forwarded.
1620 .It Va accept_sourceroute
1624 the system will accept source-routed packets directed at it.
1631 daemon at system boot time.
1638 these are the flags to pass to the
1641 .It Va bootparamd_enable
1647 daemon at system boot time.
1648 .It Va bootparamd_flags
1651 .Va bootparamd_enable
1654 these are the flags to pass to the
1657 .It Va stf_interface_ipv4addr
1661 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1662 Specify this entry to enable the 6to4 interface.
1663 .It Va stf_interface_ipv4plen
1665 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1666 An effective value is 0-31.
1667 .It Va stf_interface_ipv6_ifid
1669 IPv6 interface ID for
1673 .It Va stf_interface_ipv6_slaid
1675 IPv6 Site Level Aggregator for
1677 .It Va ipv6_faith_prefix
1681 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1685 .It Va ipv6_ipv4mapping
1689 this enables IPv4 mapped IPv6 address communication (like
1690 .Li ::ffff:a.b.c.d ) .
1695 to enable the configuration of ATM interfaces at system boot time.
1696 For all of the ATM variables described below, please refer to the
1698 man page for further details on the available command parameters.
1699 Also refer to the files in
1700 .Pa /usr/share/examples/atm
1701 for more detailed configuration information.
1702 .It Va atm_netif_ Ns Aq Ar intf
1704 For the ATM physical interface
1706 this variable defines the name prefix and count for the ATM network
1707 interfaces to be created.
1708 The value will be passed as the parameters of an
1709 .Dq Nm atm Cm "set netif" Ar intf
1711 .It Va atm_sigmgr_ Ns Aq Ar intf
1713 For the ATM physical interface
1715 this variable defines the ATM signalling manager to be used.
1716 The value will be passed as the parameters of an
1717 .Dq Nm atm Cm attach Ar intf
1719 .It Va atm_prefix_ Ns Aq Ar intf
1721 For the ATM physical interface
1723 this variable defines the NSAP prefix for interfaces using a UNI signalling
1727 the prefix will automatically be set via the
1730 Otherwise, the value will be passed as the parameters of an
1731 .Dq Nm atm Cm "set prefix" Ar intf
1733 .It Va atm_macaddr_ Ns Aq Ar intf
1735 For the ATM physical interface
1737 this variable defines the MAC address for interfaces using a UNI signalling
1741 the hardware MAC address contained in the ATM interface card will be used.
1742 Otherwise, the value will be passed as the parameters of an
1743 .Dq Nm atm Cm "set mac" Ar intf
1745 .It Va atm_arpserver_ Ns Aq Ar netif
1747 For the ATM network interface
1749 this variable defines the ATM address for a host which is to provide ATMARP
1751 This variable is only applicable to interfaces using a UNI signalling manager.
1754 this host will become an ATMARP server.
1755 The value will be passed as the parameters of an
1756 .Dq Nm atm Cm "set arpserver" Ar netif
1758 .It Va atm_scsparp_ Ns Aq Ar netif
1762 SCSP/ATMARP service for the network interface
1764 will be initiated using the
1769 This variable is only applicable if
1770 .Va atm_arpserver_ Ns Aq Ar netif
1775 Set to the list of permanent ATM ARP entries to be added at system boot time.
1776 For each whitespace separated
1779 .Va atm_arp_ Ns Aq Ar element
1780 variable is assumed to exist.
1781 The value of each of these variables will be passed as the parameters of an
1782 .Dq Nm atm Cm "add arp"
1786 The keyboard bell sound.
1793 if the default behavior is desired.
1794 For details, refer to the
1801 no keymap is installed, otherwise the value is used to install
1803 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1806 The keyboard repeat speed.
1813 if the default behavior is desired.
1818 attempt to program the function keys with the value.
1819 The value should be a single string of the form:
1820 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1823 Can be set to the value of
1826 .Dq Li destructive ,
1829 to set the cursor behavior explicitly or choose the default behavior.
1834 no screen map is installed, otherwise the value is used to install
1835 the screen map file in
1836 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1841 the default 8x16 font value is used for screen size requests, otherwise
1843 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1849 the default 8x14 font value is used for screen size requests, otherwise
1851 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1857 the default 8x8 font value is used for screen size requests, otherwise
1859 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1865 the default screen blanking interval is used, otherwise it is set to
1872 this is the actual screen saver to use
1873 .Li ( blank , snake , daemon ,
1875 .It Va moused_enable
1881 daemon is started for doing cut/paste selection on the console.
1884 This is the protocol type of the mouse connected to this host.
1885 This variable must be set if
1892 is able to detect the appropriate mouse type automatically in many cases.
1893 Set this variable to
1895 to let the daemon detect it, or
1896 select one from the following list if the automatic detection fails.
1898 If the mouse is attached to the PS/2 mouse port, choose
1902 regardless of the brand and model of the mouse.
1903 Likewise, if the mouse is attached to the bus mouse port, choose
1907 All other protocols are for serial mice and will not work with
1908 the PS/2 and bus mice.
1909 If this is a USB mouse,
1911 is the only protocol type which will work.
1913 .Bl -tag -width ".Li x10mouseremote" -compact
1915 Microsoft mouse (serial)
1917 Microsoft IntelliMouse (serial)
1919 Mouse systems Corp. mouse (serial)
1921 MM Series mouse (serial)
1923 Logitech mouse (serial)
1927 Logitech MouseMan and TrackMan (serial)
1929 ALPS GlidePoint (serial)
1930 .It Li thinkingmouse
1931 Kensington ThinkingMouse (serial)
1935 MM HitTablet (serial)
1936 .It Li x10mouseremote
1937 X10 MouseRemote (serial)
1939 Interlink VersaPad (serial)
1942 Even if the mouse is not in the above list, it may be compatible
1943 with one in the list.
1944 Refer to the man page for
1946 for compatibility information.
1948 It should also be noted that while this is enabled, any
1949 other client of the mouse (such as an X server) should access
1950 the mouse through the virtual mouse device,
1952 and configure it as a
1954 type mouse, since all
1955 mouse data is converted to this single canonical format when using
1957 If the client program does not support the
1962 It is the second preferred type.
1969 this is the actual port the mouse is on.
1972 for a COM1 serial mouse or
1974 for a PS/2 mouse, for example.
1979 is set, these are the additional flags to pass to the
1982 .It Va mousechar_start
1986 the default mouse cursor character range
1987 .Li 0xd0 Ns - Ns Li 0xd3
1988 is used, otherwise the range start is set to
1992 Use if the default range is occupied in the language code table.
1995 Set the size of the history (scrollback) buffer in lines.
1996 .It Va allscreens_flags
2000 is run with these options for each of the virtual terminals
2004 will enable the mouse pointer on all virtual terminals if
2008 .It Va allscreens_kbdflags
2012 is run with these options for each of the virtual terminals
2018 scrollback (history) buffer to 200 lines.
2025 daemon at system boot time.
2031 .Pa /usr/sbin/cron ) .
2038 these are the flags to pass to
2045 .Pa /usr/sbin/lpd ) .
2052 daemon at system boot time.
2059 these are the flags to pass to the
2068 daemon at system boot time.
2075 settings across reboots.
2076 .It Va mta_start_script
2078 The full path to the script to run to start
2079 a mail transfer agent.
2081 .Pa /etc/rc.sendmail .
2085 .Pa /etc/rc.sendmail
2086 uses are documented in the
2092 .Sq HAMMER ROOT with UFS /boot
2093 setup, the boot loader will not set up the
2096 The system will attempt to fix this on its own.
2097 Set this variable to
2099 to turn this behavior off.
2102 Indicates the device (usually a swap partition) to which a crash dump
2103 should be written in the event of a system crash.
2104 The value of this variable is passed as the argument to
2108 To disable crash dumps, set this variable to
2112 When the system reboots after a crash and a crash dump is found on the
2113 device specified by the
2117 will save that crash dump and a copy of the kernel to the directory
2121 The default value is
2130 .It Va savecore_flags
2132 If crash dumps are enabled, these are the flags to pass to the
2135 .It Va crashinfo_enable
2139 to turn on automatic crash dump summary generation using the utility
2141 .Va crashinfo_program
2143 .It Va crashinfo_program
2145 Program to run to generate a crash dump summary if the variable
2146 .Va crashinfo_enable
2149 The default value is
2150 .Pa /usr/sbin/crashinfo .
2151 .It Va enable_quotas
2155 to turn on user disk quotas on system startup via the
2162 to enable user disk quota checking via the
2165 .It Va accounting_enable
2169 to enable system accounting through the
2176 to enable Linux/ELF binary emulation at system initial boot time.
2177 .It Va sysvipc_enable
2181 load System V IPC primitives at boot time.
2182 .\" ----- cleanvar_enable setting--------------------------------
2183 .It Va cleanvar_enable
2191 .Pa /var/spool/uucp/.Temp/*
2193 .\" ----- clear_tmp_enable setting-------------------------------
2194 .It Va clear_tmp_enable
2201 .\" ----- ldconfig_paths setting --------------------------------
2202 .It Va ldconfig_paths
2204 Set to the list of shared library paths to use with
2208 will always be added first, so it need not appear in this list.
2209 .It Va ldconfig_insecure
2213 utility normally refuses to use directories
2214 which are writable by anyone except root.
2215 Set this variable to
2217 to disable that security check during system startup.
2218 .It Va kern_securelevel
2220 The kernel security level to set at startup.
2221 The allowed range of
2223 ranges from \-1 (the compile time default) to 3 (the most secure).
2226 for the list of possible security levels and their effect on system operation.
2233 at system boot time.
2240 at system boot time.
2243 Path to the SSH server program
2245 .Pa /usr/sbin/sshd ) .
2252 these are the flags to pass to the
2261 at system boot time.
2268 these are the flags to pass to the
2277 daemon at boot time.
2284 these are the flags passed to
2287 .It Va watchdogd_enable
2293 daemon at boot time.
2294 This requires that the kernel have been compiled with
2295 .Cd "options WATCHDOG" .
2300 any configured jails will not be started.
2303 A space separated list of names for jails.
2304 This is purely a configuration aid to help identify and
2305 configure multiple jails.
2306 The names specified in this list will be used to
2307 identify settings common to an instance of a jail.
2308 Assuming that the jail in question was named
2310 you would have the following dependent variables:
2312 jail_vjail_hostname="jail.example.com"
2313 jail_vjail_ip="192.168.1.100"
2314 jail_vjail_rootdir="/var/jails/vjail/root"
2320 When set, use as default value for
2321 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2324 .It Va jail_interface
2327 When set, use as default value for
2328 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2334 When set, use as default value for
2335 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2338 .It Va jail_mount_enable
2346 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2349 by default for every jail in
2351 .It Va jail_fdesc_enable
2359 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2362 by default for every jail in
2364 .It Va jail_procfs_enable
2372 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2375 by default for every jail in
2377 .It Va jail_devfs_enable
2385 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2388 by default for every jail in
2390 .It Va jail_exec_start
2393 When set, use as default value for
2394 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2397 .It Va jail_exec_stop
2399 When set, use as default value for
2400 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2403 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2406 Set to the root directory used by jail
2408 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2411 Set to the fully qualified domain name (FQDN) assigned to jail
2413 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2416 Set to the IP address assigned to jail
2418 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2423 These are flags to pass to
2425 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2428 When set, sets the interface to use when setting IP address alias.
2429 Note that the alias is created at jail startup and removed at jail shutdown.
2430 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2433 .Pa /etc/fstab. Ns Aq Ar jname
2435 This is the file system information file to use for jail
2437 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2444 mount all file systems from
2445 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2447 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2454 mount the file-descriptor file system inside jail
2457 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2464 mount the process file system inside jail
2467 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2474 mount the device file system inside jail
2477 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2480 .Dq Li /bin/sh /etc/rc
2482 This is the command executed at jail startup.
2483 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2486 .Dq Li /bin/sh /etc/rc.shutdown
2488 This is the command executed at jail shutdown.
2489 .It Va jail_set_hostname_allow
2493 do not allow the root user in a jail to set its hostname.
2494 .It Va jail_socket_unixiproute_only
2498 do not allow any sockets,
2499 besides UNIX/IP/route sockets,
2500 to be used within a jail.
2501 .It Va jail_sysvipc_allow
2505 allow applications within a jail to use System V IPC.
2510 LVM volumes will be discovered and configured on boot.
2511 .It Va newsyslog_enable
2517 before syslogd starts.
2518 .It Va newsyslog_flags
2521 .Va newsyslog_enable
2524 these are the flags passed to
2526 .It Va resident_enable
2530 make the dynamic binaries listed in
2531 .Pa /etc/resident.conf
2533 .It Va varsym_enable
2538 .Pa /etc/varsym.conf
2539 to set system-wide variables for variant symlinks.
2544 or a whitespace separated list of IRQ numbers which will be used as a source of
2546 .\" -----------------------------------------------------
2551 to disable caching entropy via
2553 Otherwise set to the directory used to store entropy files in.
2558 to disable caching entropy through reboots.
2559 Otherwise set to the filename used to store cached entropy through reboots.
2560 This file should be located on the root file system to seed the
2562 device as early as possible in the boot process.
2574 Configuration file for
2583 .Pa /var/run/dmesg.boot
2585 .It Va rcshutdown_timeout
2587 If set, start a watchdog timer in the background which will terminate
2591 has not completed within the specified time (in seconds).
2596 the udevd daemon will be started on boot.
2597 .It Va vfs_quota_enable
2601 vfs quota rc.d scripts will be run on boot.
2602 .It Va vfs_quota_sync
2604 List of mount points whose counters are to be synchronized with on-disk
2605 usage during system startup. See also
2607 .It Va vknetd_enable
2612 will be started on boot.
2615 Additional flags passed to
2617 Usually address/cidrbits is specified here.
2618 When no flags are passed, default option
2621 .It Va vkernel_enable
2625 any configured vkernels will not be started.
2626 .It Va vkernel_kill_timeout
2628 This defines the default number of seconds that we will wait for the
2629 vkernel to shut down on it's own. If after this time it's still alive,
2630 it will be killed with SIGKILL.
2633 Defines the default path to the vkernel binary.
2636 A space separated list of names for vkernels.
2637 This is purely a configuration aid to help identify and
2638 configure multiple vkernels.
2639 The names specified in this list will be used to
2640 identify settings common to a vkernel instance.
2641 Assuming that the vkernel in question was named
2643 you would have the following dependent variables
2644 (filled with reference values in this text):
2646 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2647 vkernel_example_memsize="64m"
2648 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2649 vkernel_example_iface_list="auto:bridge0"
2650 vkernel_example_logfile="/dev/null"
2651 vkernel_example_flags="-U"
2652 vkernel_example_kill_timeout="45"
2655 The last five are optional.
2656 They default to an empty string if not set, except for logfile which defaults to
2661 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2662 .It Pa /etc/defaults/rc.conf
2664 .It Pa /etc/rc.conf.local
2665 .It Pa /etc/start_if. Ns Aq Ar interface
2682 .Xr resident.conf 5 ,
2743 .An Jordan K. Hubbard .