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.
66 .Pa /etc/rc.conf.local
67 you can also place smaller configuration files for each
71 directory, which will be included by the
74 For jail configurations you could use the file
75 .Pa /etc/rc.conf.d/jail
76 to store jail specific configuration options.
81 The following list provides a name and short description for each
82 variable that can be set in the
99 These values are case insensitive.
102 postfix in the name of a variable for starting a service can be
105 .Bl -tag -width indent-two
110 enable output of debug messages from rc scripts.
111 This variable can be helpful in diagnosing mistakes when
112 editing or integrating new scripts.
113 Beware that this produces copious output to the terminal and
119 disable informational messages from the rc scripts.
120 Informational messages are displayed when
121 a condition that is not serious enough to warrant a warning or an error occurs.
126 no swapfile is installed, otherwise the value is used as the full
127 pathname to a file to use for additional swap space.
130 driver is needed for a swapfile and will be loaded if it is not
131 already compiled into the kernel or loaded via
137 enable support for Automatic Power Management with the
144 to handle APM event from userland.
145 This also enables support for APM.
152 these are the flags to pass to the
158 to monitor the status of batteries present in the system.
159 This also enables support for APM.
166 these are the flags to pass to the
173 to handle device added, removed or unknown events from the kernel.
180 these are the flags to pass to the
192 a CPU speed control daemon.
193 .It Va sensorsd_enable
202 a sensors monitoring and logging daemon.
203 .It Va sensorsd_flags
206 Additional flags passed to the
209 .It Va hotplugd_enable
218 a devices hot plugging monitoring daemon.
219 .It Va hotplugd_flags
222 Additional flags passed to the
225 .It Va pccard_ifconfig
227 List of arguments to be passed to
229 at boot time or on insertion of the card (e.g.\&
230 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
231 for a fixed address or
234 .It Va pccard_ether_delay
236 Set the delay before starting
239 .Pa /etc/pccard_ether
241 This defaults to 5 seconds to work around a bug in the
243 driver which can lead to system hangs when using some newer
246 .It Va removable_interfaces
248 List of removable network interfaces to be supported by
249 .Pa /etc/pccard_ether .
252 List of directories to search for startup script files.
253 .It Va script_name_sep
255 The field separator to use for breaking down the list of startup script files
256 into individual filenames.
257 The default is a space.
258 It is not necessary to change this unless there are startup scripts with names
260 .It Va hostapd_enable
269 The fully qualified domain name (FQDN) of this host on the network.
270 This should almost certainly be set to something meaningful, even if
271 there is no network connection.
274 is used to set the hostname via DHCP,
275 this variable should be set to an empty string.
278 Enable support for IPv6 networking.
279 Note that this requires that the kernel have been compiled with
280 .Cd "options INET6" .
283 The NIS domain name of this host, or
286 .It Va dhclient_program
288 Path to the DHCP client program
290 .Pa /sbin/dhclient ) .
291 .It Va dhclient_flags
293 Additional flags to pass to the DHCP client program.
301 If the kernel was not built with
305 kernel module will be loaded.
307 .Va firewall_enable .
312 ruleset definition file.
323 these are the flags to pass to
325 when loading the ruleset.
332 which logs packets from
340 this specifies the path of the log file.
351 these are the flags to pass to
353 .It Va firewall_enable
357 to load firewall rules at startup.
358 If the kernel was not built with
359 .Cd "options IPFIREWALL" ,
362 kernel module will be loaded.
365 .It Va ipv6_firewall_enable
367 The IPv6 equivalent of
368 .Va firewall_enable .
371 to load IPv6 firewall rules at startup.
372 If the kernel was not built with
373 .Cd "options IPV6FIREWALL" ,
376 kernel module will be loaded.
377 .It Va firewall_script
379 The full path to the firewall script to run
381 .Pa /etc/rc.firewall ) .
382 .It Va ipv6_firewall_script
384 The IPv6 equivalent of
385 .Va firewall_script .
388 Names the firewall type from the selection in
389 .Pa /etc/rc.firewall ,
390 or the file which contains the local firewall ruleset.
391 Valid selections from
395 .Bl -tag -width ".Li simple" -compact
397 unrestricted IP access
399 all IP services disabled, except via
402 basic protection for a workstation on a LAN
408 If a filename is specified, the full path must be given.
409 .It Va firewall_trusted_nets
411 List of trusted networks (if
415 .It Va firewall_trusted_interfaces
417 List of trusted network interfaces (if
421 .It Va firewall_allowed_icmp_types
423 List of allowed ICMP types (if
427 .It Va firewall_open_tcp_ports
429 List of TCP ports to open (if
433 .It Va firewall_open_udp_ports
435 List of UDP ports to open (if
439 .It Va ipv6_firewall_type
441 The IPv6 equivalent of
443 .It Va firewall_quiet
447 to disable the display of firewall rules on the console during boot.
448 .It Va ipv6_firewall_quiet
450 The IPv6 equivalent of
452 .It Va firewall_logging
456 to enable firewall event logging.
457 This is equivalent to the
458 .Dv IPFIREWALL_VERBOSE
460 .It Va ipv6_firewall_logging
462 The IPv6 equivalent of
463 .Va firewall_logging .
464 .It Va firewall_flags
470 specifies a filename.
471 .It Va ipv6_firewall_flags
473 The IPv6 equivalent of
490 sockets must be enabled in the kernel.
491 .It Va natd_interface
493 This is the name of the public interface on which
496 The interface may be given as an interface name or as an IP address.
501 flags should be placed here.
506 flag is automatically added with the above
509 .It Va tcp_extensions
516 disables certain TCP options as described by
522 might help remedy such problems with connections as randomly hanging
523 or other weird behavior.
524 Some network devices are known to be broken with respect to these options.
531 .Va net.inet.tcp.log_in_vain
533 .Va net.inet.udp.log_in_vain ,
538 are set to the given value.
546 will disable probing idle TCP connections to verify that the
547 peer is still up and reachable.
548 .It Va tcp_drop_synfin
555 will cause the kernel to ignore TCP frames that have both
556 the SYN and FIN flags set.
557 This prevents OS fingerprinting, but may break some legitimate applications.
558 This option is only available if the kernel was built with the
561 .It Va icmp_drop_redirect
568 will cause the kernel to ignore ICMP REDIRECT packets.
571 for more information.
572 .It Va icmp_log_redirect
579 will cause the kernel to log ICMP REDIRECT packets.
581 the log messages are not rate-limited, so this option should only be used
582 for troubleshooting networks.
585 for more information.
586 .It Va icmp_bmcastecho
590 to respond to broadcast or multicast ICMP ping packets.
593 for more information.
594 .It Va ip_portrange_first
598 this is the first port in the default portrange.
601 for more information.
602 .It Va ip_portrange_last
606 this is the last port in the default portrange.
609 for more information.
611 .It Va ifconfig_ Ns Aq Ar interface
615 Typically includes IP address.
616 Assuming that the interface in question was
618 it might look something like this:
620 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
624 .Pa /etc/start_if. Ns Aq Ar interface
625 file is present, it is read and executed by the
627 interpreter before configuring the interface as specified in the
628 .Va ifconfig_ Ns Aq Ar interface
630 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
633 It is possible to bring up an interface with DHCP by adding
636 .Va ifconfig_ Ns Aq Ar interface
638 For instance, to initialize the
640 device via DHCP, it is possible to use something like:
646 .Va wlans_ Ns Aq Ar interface
650 interface will be created for each item in the list with the
654 Further wlan cloning arguments may be passed to the
657 command by setting the
658 .Va create_args_ Ns Aq Ar interface
662 devices must be created for each wireless devices as of
668 may be specified with an
669 .Va wlandebug_ Ns Aq Ar interface
671 The contents of this variable will be passed directly to
674 Also, if your interface needs WPA authentication, it is possible to add
677 .Va ifconfig_ Ns Aq Ar interface
680 .Xr wpa_supplicant 8 .
682 .Xr wpa_supplicant.conf 5
683 for configuring authentication information.
687 options in this variable, in addition to the
688 .Pa /etc/start_if. Ns Aq Ar interface
690 For instance, to initialize the
692 device via DHCP, using WPA authentication and 802.11b mode, it is
693 possible to use something like:
696 ifconfig_wlan0="up DHCP WPA mode 11b"
698 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
700 Configuration to establish an additional network address for
702 Assuming that the interface in question was
704 it might look something like this:
706 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
707 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
712 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
713 entry that is found, its contents are passed to
715 Execution stops at the first unsuccessful access, so if
716 something like this is present:
718 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
719 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
720 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
721 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
724 Then note that alias4 would
726 be added since the search would stop with the missing alias3 entry.
727 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
731 It is possible to rename interface by doing:
733 ifconfig_ed0_name="net0"
734 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
736 .It Va network_interfaces
738 The list of network interfaces to configure on this host,
741 to configure all network interfaces
744 For example, if the only network devices to be configured are the loopback device
748 driver, this could be set to
751 .Va ifconfig_ Ns Aq Ar interface
752 variable is assumed to exist for each value of
754 .It Va ipv6_network_interfaces
756 This is the IPv6 equivalent of
757 .Va network_interfaces .
758 Instead of setting the ifconfig variables as
759 .Va ifconfig_ Ns Aq Ar interface
760 they should be set as
761 .Va ipv6_ifconfig_ Ns Aq Ar interface .
762 Aliases should be set as
763 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
764 Interfaces that do not have a
765 .Va ipv6_ifconfig_ Ns Aq Ar interface
766 setting will be auto configured by
769 .Va ipv6_gateway_enable
772 Note that the IPv6 networking code does not support the
773 .Pa /etc/start_if. Ns Aq Ar interface
775 .It Va ipv6_prefix_ Ns Aq Ar interface
779 prefixlen 64 is used.
780 .It Va ipv6_default_interface
784 this is the default output interface for scoped addresses.
785 Now this works only for IPv6 link local multicast addresses.
786 .It Va cloned_interfaces
788 Set to the list of clonable network interfaces to create on this host.
790 .Va cloned_interfaces
791 are automatically appended to
792 .Va network_interfaces
794 .It Va gif_interfaces
798 tunnel interfaces to configure on this host.
800 .Va gifconfig_ Ns Aq Ar interface
801 variable is assumed to exist for each value of
803 The value of this variable is used to configure the link layer of the
804 tunnel according to the syntax of the
808 Additionally, this option ensures that each listed interface is created via the
812 before attempting to configure it.
813 .It Va sppp_interfaces
817 interfaces to configure on this host.
819 .Va spppconfig_ Ns Aq Ar interface
820 variable is assumed to exist for each value of
822 Each interface should also be configured by a general
823 .Va ifconfig_ Ns Aq Ar interface
827 for more information about available options.
837 Mode in which to run the
846 See the manual for a full description.
851 enables network address translation.
852 Used in conjunction with
854 allows hosts on private network addresses access to the Internet using
855 this host as a network address translating router.
858 The name of the profile to use from
859 .Pa /etc/ppp/ppp.conf .
862 The name of the user under which
871 This option is used to specify a list of files that will override
873 .Pa /etc/defaults/rc.conf .
874 The files will be read in the order in which they are specified and should
875 include the full path to the file.
876 By default, the files specified are
879 .Pa /etc/rc.conf.local
887 flag if the initial preen of the file systems fails.
890 List of file system types that are network-based.
891 This list should generally not be modified by end users.
893 .Va extra_netfs_types
895 .It Va extra_netfs_types
897 If set to something other than
899 (the default), this variable extends the list of file system types
900 for which automatic mounting at startup by
902 should be delayed until the network is initialized.
904 a whitespace-separated list of network file system descriptor pairs,
905 each consisting of a file system type as passed to
907 and a human-readable, one-word description, joined with a colon
909 Extending the default list in this way is only necessary
910 when third party file system types are used.
911 .It Va devfs_config_files
913 This option is used to specify a list of configuration files containing
915 rules that will be applied by
917 in the order in which they are specified and must include the full path
919 .It Va syslogd_enable
926 .It Va syslogd_program
931 .Pa /usr/sbin/syslogd ) .
938 these are the flags to pass to
952 .Pa /usr/sbin/inetd ) .
959 these are the flags to pass to
974 these are the flags to pass to it.
988 these are the flags to pass to it.
991 manpage for more information.
992 .It Va amd_map_program
994 If set, the specified program is run to get the list of
999 maps are stored in NIS, one can set this to run
1011 will be updated at boot time to reflect the kernel release being run.
1015 will not be updated.
1016 .It Va nfs_client_enable
1020 setup NFS client parameters at boot time.
1021 .It Va nfs_access_cache
1024 .Va nfs_client_enable
1029 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1030 NFS ACCESS results should be cached.
1031 A value of 2-10 seconds will substantially reduce network traffic for
1032 many NFS operations.
1033 The default is 5 seconds.
1034 Note that the attribute cache holds stat information only.
1035 The NFS data cache is independent of the attribute cache and is only
1036 invalidated when the client detects that the server has modified the
1038 This value specifies a maximum timeout.
1039 The NFS client will automatically use a shorter timeout for files which
1040 have been recently modified.
1041 .It Va nfs_neg_cache
1044 .Va nfs_client_enable
1049 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1050 filenames), or to the number of seconds for which negative lookups should
1052 A value of 2-10 seconds will substantially reduce network
1053 traffic for many NFS operations, especially source code builds.
1054 The default is 3 seconds.
1055 .It Va nfs_server_enable
1059 run the NFS server daemons at boot time.
1060 .It Va nfs_server_flags
1063 .Va nfs_server_enable
1066 these are the flags to pass to the
1069 .It Va mountd_enable
1074 .Va nfs_server_enable
1080 It is commonly needed to run CFS without real NFS used.
1087 these are the flags to pass to the
1090 .It Va weak_mountd_authentication
1094 allow services like PCNFSD to make non-privileged mount requests.
1095 .It Va nfs_reserved_port_only
1099 provide NFS services only on a secure port.
1100 .It Va nfs_bufpackets
1102 If set to a number, indicates the number of packets worth of
1103 socket buffer space to reserve on an NFS client.
1104 The kernel default is typically 4.
1105 Using a higher number may be useful on gigabit networks to improve performance.
1106 The minimum value is 2 and the maximum is 64.
1107 .It Va rpc_umntall_enable
1111 (default) and we are also an NFS client, run
1113 at boot time to clear out old mounts on remote servers.
1118 will not be run at boot time.
1119 .It Va rpc_lockd_enable
1123 and also an NFS server, run
1126 .It Va rpc_lockd_flags
1129 .Va rpc_lockd_enable
1132 these are the flags to pass to
1134 .It Va rpc_statd_enable
1138 and also an NFS server, run
1141 .It Va rpc_statd_flags
1144 .Va rpc_statd_enable
1147 these are the flags to pass to
1149 .It Va rpcbind_program
1151 Path to program for rpcbind daemon
1153 .Pa /usr/sbin/rpcbind ) .
1154 .It Va rpcbind_enable
1161 .It Va rpcbind_flags
1167 these are the flags to pass to
1168 .Va rpcbind_program .
1169 .It Va keyserv_enable
1175 daemon on boot for running Secure RPC.
1176 .It Va keyserv_flags
1182 these are the flags to pass to
1185 .It Va pppoed_enable
1191 daemon at boot time to provide PPP over Ethernet services.
1192 .It Va pppoed_provider
1195 listens to requests to this provider and ultimately runs
1199 argument of the same name.
1202 Additional flags to pass to
1204 .It Va pppoed_interface
1206 The network interface to run
1209 This is mandatory when
1219 service at boot time.
1220 This command is intended for networks of machines where a consistent
1222 for all hosts must be established.
1223 This is often useful in large NFS environments where time stamps on
1224 files are expected to be consistent network-wide.
1231 these are the flags to pass to the
1240 at system boot time.
1241 .It Va dntpd_program
1246 .Pa /usr/sbin/dntpd ) .
1253 these are the flags to pass to the
1256 .It Va btconfig_enable
1260 configure Bluetooth devices via
1262 at system boot time.
1263 .It Va btconfig_devices
1269 this is the list of Bluetooth devices to configure.
1271 .Va btconfig_devices
1272 is not specified, all devices known to the system will be configured.
1274 .Va btconfig_ Ns Aq Ar device
1275 variable can be set to specify parameters to be passed to
1277 .It Va btconfig_args
1283 this is the list of configuration parameters to pass to all Bluetooth
1289 run the Service Discovery Profile daemon
1291 at system boot time.
1298 these are the flags to pass to the
1301 .It Va bthcid_enable
1305 run the Bluetooth Link Key/PIN Code Manager daemon
1307 at system boot time.
1314 these are the flags to pass to the
1317 .It Va nis_client_enable
1323 service at system boot time.
1324 .It Va nis_client_flags
1327 .Va nis_client_enable
1330 these are the flags to pass to the
1333 .It Va nis_ypset_enable
1339 daemon at system boot time.
1340 .It Va nis_ypset_flags
1343 .Va nis_ypset_enable
1346 these are the flags to pass to the
1349 .It Va nis_server_enable
1355 daemon at system boot time.
1356 .It Va nis_server_flags
1359 .Va nis_server_enable
1362 these are the flags to pass to the
1365 .It Va nis_ypxfrd_enable
1371 daemon at system boot time.
1372 .It Va nis_ypxfrd_flags
1375 .Va nis_ypxfrd_enable
1378 these are the flags to pass to the
1381 .It Va nis_yppasswdd_enable
1387 daemon at system boot time.
1388 .It Va nis_yppasswdd_flags
1391 .Va nis_yppasswdd_enable
1394 these are the flags to pass to the
1397 .It Va rpc_ypupdated_enable
1403 daemon at system boot time.
1404 .It Va defaultrouter
1408 create a default route to this host name or IP address
1409 (use an IP address if this router is also required to get to the
1411 .It Va ipv6_defaultrouter
1413 The IPv6 equivalent of
1415 .It Va static_routes
1417 Set to the list of static routes that are to be added at system boot time.
1420 then for each whitespace separated
1423 .Va route_ Ns Aq Ar element
1424 variable is assumed to exist whose contents will later be passed to a
1427 .It Va change_routes
1429 Set to the list of static routes that are to be changed at system boot time
1430 (such as those added by the kernel).
1433 then for each whitespace separated
1436 .Va change_route_ Ns Aq Ar element
1437 variable is assumed to exist whose contents will later be passed to a
1438 .Dq Nm route Cm change
1440 .It Va ipv6_static_routes
1442 The IPv6 equivalent of
1446 then for each whitespace separated
1449 .Va ipv6_route_ Ns Aq Ar element
1450 variable is assumed to exist whose contents will later be passed to a
1451 .Dq Nm route Cm add Fl inet6
1453 .It Va gateway_enable
1457 configure host to act as an IP router, e.g. to forward packets
1459 .It Va ipv6_gateway_enable
1461 The IPv6 equivalent of
1462 .Va gateway_enable .
1463 .It Va router_enable
1467 run a routing daemon of some sort, based on the settings of
1471 .It Va ipv6_router_enable
1473 The IPv6 equivalent of
1477 run a routing daemon of some sort, based on the settings of
1478 .Va ipv6_router_program
1480 .Va ipv6_router_flags .
1481 .It Va router_program
1487 this is the name of the routing daemon to use
1489 .Pa /sbin/routed ) .
1490 .It Va ipv6_router_program
1492 The IPv6 equivalent of
1495 .Pa /sbin/route6d ) .
1502 these are the flags to pass to the routing daemon.
1503 .It Va ipv6_router_flags
1505 The IPv6 equivalent of
1507 .It Va mrouted_enable
1511 run the multicast routing daemon,
1513 .It Va mroute6d_enable
1515 The IPv6 equivalent of
1516 .Va mrouted_enable .
1519 run the IPv6 multicast routing daemon.
1520 Note that no IPv6 multicast routing daemon is included in the
1524 can be installed from the
1527 .It Va mrouted_flags
1533 these are the flags to pass to the
1536 .It Va mroute6d_flags
1538 The IPv6 equivalent of
1544 these are the flags passed to the IPv6 multicast routing daemon.
1545 .It Va mroute6d_program
1551 this is the path to the IPv6 multicast routing daemon.
1552 .It Va rtadvd_enable
1558 daemon at boot time.
1561 .Va ipv6_gateway_enable
1566 utility sends router advertisement packets to the interfaces specified in
1567 .Va rtadvd_interfaces .
1569 and should only be enabled with great care.
1570 You may want to fine-tune
1572 .It Va rtadvd_interfaces
1578 this is the list of interfaces to use.
1579 .It Va rtsold_enable
1585 daemon at boot time.
1588 daemon is used for automatic discovery of non-link local addresses.
1595 these are the flags to pass to the
1598 .It Va ipxgateway_enable
1602 enable the routing of IPX traffic.
1603 .It Va ipxrouted_enable
1609 daemon at system boot time.
1610 .It Va ipxrouted_flags
1613 .Va ipxrouted_enable
1616 these are the flags to pass to the
1623 enable global proxy ARP.
1624 .It Va forward_sourceroute
1632 source-routed packets are forwarded.
1633 .It Va accept_sourceroute
1637 the system will accept source-routed packets directed at it.
1644 daemon at system boot time.
1651 these are the flags to pass to the
1654 .It Va bootparamd_enable
1660 daemon at system boot time.
1661 .It Va bootparamd_flags
1664 .Va bootparamd_enable
1667 these are the flags to pass to the
1670 .It Va stf_interface_ipv4addr
1674 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1675 Specify this entry to enable the 6to4 interface.
1676 .It Va stf_interface_ipv4plen
1678 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1679 An effective value is 0-31.
1680 .It Va stf_interface_ipv6_ifid
1682 IPv6 interface ID for
1686 .It Va stf_interface_ipv6_slaid
1688 IPv6 Site Level Aggregator for
1690 .It Va ipv6_faith_prefix
1694 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1698 .It Va ipv6_ipv4mapping
1702 this enables IPv4 mapped IPv6 address communication (like
1703 .Li ::ffff:a.b.c.d ) .
1708 to enable the configuration of ATM interfaces at system boot time.
1709 For all of the ATM variables described below, please refer to the
1711 man page for further details on the available command parameters.
1712 Also refer to the files in
1713 .Pa /usr/share/examples/atm
1714 for more detailed configuration information.
1715 .It Va atm_netif_ Ns Aq Ar intf
1717 For the ATM physical interface
1719 this variable defines the name prefix and count for the ATM network
1720 interfaces to be created.
1721 The value will be passed as the parameters of an
1722 .Dq Nm atm Cm "set netif" Ar intf
1724 .It Va atm_sigmgr_ Ns Aq Ar intf
1726 For the ATM physical interface
1728 this variable defines the ATM signalling manager to be used.
1729 The value will be passed as the parameters of an
1730 .Dq Nm atm Cm attach Ar intf
1732 .It Va atm_prefix_ Ns Aq Ar intf
1734 For the ATM physical interface
1736 this variable defines the NSAP prefix for interfaces using a UNI signalling
1740 the prefix will automatically be set via the
1743 Otherwise, the value will be passed as the parameters of an
1744 .Dq Nm atm Cm "set prefix" Ar intf
1746 .It Va atm_macaddr_ Ns Aq Ar intf
1748 For the ATM physical interface
1750 this variable defines the MAC address for interfaces using a UNI signalling
1754 the hardware MAC address contained in the ATM interface card will be used.
1755 Otherwise, the value will be passed as the parameters of an
1756 .Dq Nm atm Cm "set mac" Ar intf
1758 .It Va atm_arpserver_ Ns Aq Ar netif
1760 For the ATM network interface
1762 this variable defines the ATM address for a host which is to provide ATMARP
1764 This variable is only applicable to interfaces using a UNI signalling manager.
1767 this host will become an ATMARP server.
1768 The value will be passed as the parameters of an
1769 .Dq Nm atm Cm "set arpserver" Ar netif
1771 .It Va atm_scsparp_ Ns Aq Ar netif
1775 SCSP/ATMARP service for the network interface
1777 will be initiated using the
1782 This variable is only applicable if
1783 .Va atm_arpserver_ Ns Aq Ar netif
1788 Set to the list of permanent ATM ARP entries to be added at system boot time.
1789 For each whitespace separated
1792 .Va atm_arp_ Ns Aq Ar element
1793 variable is assumed to exist.
1794 The value of each of these variables will be passed as the parameters of an
1795 .Dq Nm atm Cm "add arp"
1799 The keyboard bell sound.
1806 if the default behavior is desired.
1807 For details, refer to the
1814 no keymap is installed, otherwise the value is used to install
1816 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1819 The keyboard repeat speed.
1826 if the default behavior is desired.
1831 attempt to program the function keys with the value.
1832 The value should be a single string of the form:
1833 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1836 Can be set to the value of
1839 .Dq Li destructive ,
1842 to set the cursor behavior explicitly or choose the default behavior.
1847 no screen map is installed, otherwise the value is used to install
1848 the screen map file in
1849 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1854 the default 8x16 font value is used for screen size requests, otherwise
1856 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1862 the default 8x14 font value is used for screen size requests, otherwise
1864 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1870 the default 8x8 font value is used for screen size requests, otherwise
1872 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1878 the default screen blanking interval is used, otherwise it is set to
1885 this is the actual screen saver to use
1886 .Li ( blank , snake , daemon ,
1888 .It Va moused_enable
1894 daemon is started for doing cut/paste selection on the console.
1897 This is the protocol type of the mouse connected to this host.
1898 This variable must be set if
1905 is able to detect the appropriate mouse type automatically in many cases.
1906 Set this variable to
1908 to let the daemon detect it, or
1909 select one from the following list if the automatic detection fails.
1911 If the mouse is attached to the PS/2 mouse port, choose
1915 regardless of the brand and model of the mouse.
1916 Likewise, if the mouse is attached to the bus mouse port, choose
1920 All other protocols are for serial mice and will not work with
1921 the PS/2 and bus mice.
1922 If this is a USB mouse,
1924 is the only protocol type which will work.
1926 .Bl -tag -width ".Li x10mouseremote" -compact
1928 Microsoft mouse (serial)
1930 Microsoft IntelliMouse (serial)
1932 Mouse systems Corp. mouse (serial)
1934 MM Series mouse (serial)
1936 Logitech mouse (serial)
1940 Logitech MouseMan and TrackMan (serial)
1942 ALPS GlidePoint (serial)
1943 .It Li thinkingmouse
1944 Kensington ThinkingMouse (serial)
1948 MM HitTablet (serial)
1949 .It Li x10mouseremote
1950 X10 MouseRemote (serial)
1952 Interlink VersaPad (serial)
1955 Even if the mouse is not in the above list, it may be compatible
1956 with one in the list.
1957 Refer to the man page for
1959 for compatibility information.
1961 It should also be noted that while this is enabled, any
1962 other client of the mouse (such as an X server) should access
1963 the mouse through the virtual mouse device,
1965 and configure it as a
1967 type mouse, since all
1968 mouse data is converted to this single canonical format when using
1970 If the client program does not support the
1975 It is the second preferred type.
1982 this is the actual port the mouse is on.
1985 for a COM1 serial mouse or
1987 for a PS/2 mouse, for example.
1992 is set, these are the additional flags to pass to the
1995 .It Va mousechar_start
1999 the default mouse cursor character range
2000 .Li 0xd0 Ns - Ns Li 0xd3
2001 is used, otherwise the range start is set to
2005 Use if the default range is occupied in the language code table.
2008 Set the size of the history (scrollback) buffer in lines.
2009 .It Va allscreens_flags
2013 is run with these options for each of the virtual terminals
2017 will enable the mouse pointer on all virtual terminals if
2021 .It Va allscreens_kbdflags
2025 is run with these options for each of the virtual terminals
2031 scrollback (history) buffer to 200 lines.
2038 daemon at system boot time.
2044 .Pa /usr/sbin/cron ) .
2051 these are the flags to pass to
2058 .Pa /usr/sbin/lpd ) .
2065 daemon at system boot time.
2072 these are the flags to pass to the
2081 daemon at system boot time.
2088 settings across reboots.
2089 .It Va mta_start_script
2091 The full path to the script to run to start
2092 a mail transfer agent.
2094 .Pa /etc/rc.sendmail .
2098 .Pa /etc/rc.sendmail
2099 uses are documented in the
2105 .Sq HAMMER ROOT with UFS /boot
2106 setup, the boot loader will not set up the
2109 The system will attempt to fix this on its own.
2110 Set this variable to
2112 to turn this behavior off.
2115 Indicates the device (usually a swap partition) to which a crash dump
2116 should be written in the event of a system crash.
2117 The value of this variable is passed as the argument to
2121 To disable crash dumps, set this variable to
2125 When the system reboots after a crash and a crash dump is found on the
2126 device specified by the
2130 will save that crash dump and a copy of the kernel to the directory
2134 The default value is
2143 .It Va savecore_flags
2145 If crash dumps are enabled, these are the flags to pass to the
2148 .It Va crashinfo_enable
2152 to turn on automatic crash dump summary generation using the utility
2154 .Va crashinfo_program
2156 .It Va crashinfo_program
2158 Program to run to generate a crash dump summary if the variable
2159 .Va crashinfo_enable
2162 The default value is
2163 .Pa /usr/sbin/crashinfo .
2164 .It Va enable_quotas
2168 to turn on user disk quotas on system startup via the
2175 to enable user disk quota checking via the
2178 .It Va accounting_enable
2182 to enable system accounting through the
2189 to enable Linux/ELF binary emulation at system initial boot time.
2190 .It Va sysvipc_enable
2194 load System V IPC primitives at boot time.
2195 .\" ----- cleanvar_enable setting--------------------------------
2196 .It Va cleanvar_enable
2204 .Pa /var/spool/uucp/.Temp/*
2206 .\" ----- clear_tmp_enable setting-------------------------------
2207 .It Va clear_tmp_enable
2214 .\" ----- ldconfig_paths setting --------------------------------
2215 .It Va ldconfig_paths
2217 Set to the list of shared library paths to use with
2221 will always be added first, so it need not appear in this list.
2222 .It Va ldconfig_insecure
2226 utility normally refuses to use directories
2227 which are writable by anyone except root.
2228 Set this variable to
2230 to disable that security check during system startup.
2231 .It Va ldconfig_local_dirs
2233 Set to the list of local
2236 The names of all files in the directories listed will be
2237 passed as arguments to
2239 .It Va kern_securelevel
2241 The kernel security level to set at startup.
2242 The allowed range of
2244 ranges from \-1 (the compile time default) to 3 (the most secure).
2247 for the list of possible security levels and their effect on system operation.
2254 at system boot time.
2261 at system boot time.
2264 Path to the SSH server program
2266 .Pa /usr/sbin/sshd ) .
2273 these are the flags to pass to the
2282 at system boot time.
2289 these are the flags to pass to the
2298 daemon at boot time.
2305 these are the flags passed to
2308 .It Va watchdogd_enable
2314 daemon at boot time.
2315 This requires that the kernel have been compiled with
2316 .Cd "options WATCHDOG" .
2321 any configured jails will not be started.
2324 A space separated list of names for jails.
2325 This is purely a configuration aid to help identify and
2326 configure multiple jails.
2327 The names specified in this list will be used to
2328 identify settings common to an instance of a jail.
2329 Assuming that the jail in question was named
2331 you would have the following dependent variables:
2333 jail_vjail_hostname="jail.example.com"
2334 jail_vjail_ip="192.168.1.100"
2335 jail_vjail_rootdir="/var/jails/vjail/root"
2340 When set, use as default value for
2341 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2344 .It Va jail_interface
2347 When set, use as default value for
2348 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2354 When set, use as default value for
2355 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2358 .It Va jail_mount_enable
2366 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2369 by default for every jail in
2371 .It Va jail_fdesc_enable
2379 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2382 by default for every jail in
2384 .It Va jail_procfs_enable
2392 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2395 by default for every jail in
2397 .It Va jail_devfs_enable
2405 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2408 by default for every jail in
2410 .It Va jail_exec_start
2413 When set, use as default value for
2414 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2417 .It Va jail_exec_stop
2419 When set, use as default value for
2420 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2423 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2426 Set to the root directory used by jail
2428 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2431 Set to the fully qualified domain name (FQDN) assigned to jail
2433 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2436 Set to the IP address assigned to jail
2438 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2443 These are flags to pass to
2445 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2448 When set, sets the interface to use when setting IP address alias.
2449 Note that the alias is created at jail startup and removed at jail shutdown.
2450 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2453 .Pa /etc/fstab. Ns Aq Ar jname
2455 This is the file system information file to use for jail
2457 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2464 mount all file systems from
2465 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2467 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2474 mount the file-descriptor file system inside jail
2477 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2484 mount the process file system inside jail
2487 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2494 mount the device file system inside jail
2497 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2500 .Dq Li /bin/sh /etc/rc
2502 This is the command executed at jail startup.
2503 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2506 .Dq Li /bin/sh /etc/rc.shutdown
2508 This is the command executed at jail shutdown.
2509 .It Va jail_set_hostname_allow
2513 do not allow the root user in a jail to set its hostname.
2514 .It Va jail_socket_unixiproute_only
2518 do not allow any sockets,
2519 besides UNIX/IP/route sockets,
2520 to be used within a jail.
2521 .It Va jail_sysvipc_allow
2525 allow applications within a jail to use System V IPC.
2530 LVM volumes will be discovered and configured on boot.
2531 .It Va newsyslog_enable
2537 before syslogd starts.
2538 .It Va newsyslog_flags
2541 .Va newsyslog_enable
2544 these are the flags passed to
2546 .It Va resident_enable
2550 make the dynamic binaries listed in
2551 .Pa /etc/resident.conf
2553 .It Va varsym_enable
2558 .Pa /etc/varsym.conf
2559 to set system-wide variables for variant symlinks.
2564 or a whitespace separated list of IRQ numbers which will be used as a source of
2566 .\" -----------------------------------------------------
2571 to disable caching entropy via
2573 Otherwise set to the directory used to store entropy files in.
2578 to disable caching entropy through reboots.
2579 Otherwise set to the filename used to store cached entropy through reboots.
2580 This file should be located on the root file system to seed the
2582 device as early as possible in the boot process.
2594 Configuration file for
2603 .Pa /var/run/dmesg.boot
2605 .It Va rcshutdown_timeout
2607 If set, start a watchdog timer in the background which will terminate
2611 has not completed within the specified time (in seconds).
2612 Notice that in addition to this soft timeout,
2614 also applies a hard timeout for the execution of
2616 This is configured via
2619 .Va kern.init_shutdown_timeout
2620 and defaults to 120 seconds. Setting the value of
2621 .Va rcshutdown_timeout
2622 to more than 120 seconds will have no effect until the
2625 .Va kern.init_shutdown_timeout
2631 the udevd daemon will be started on boot.
2632 .It Va vfs_quota_enable
2636 vfs quota rc.d scripts will be run on boot.
2637 .It Va vfs_quota_sync
2639 List of mount points whose counters are to be synchronized with on-disk
2640 usage during system startup. See also
2642 .It Va vknetd_enable
2647 will be started on boot.
2650 Additional flags passed to
2652 Usually address/cidrbits is specified here.
2653 When no flags are passed, default option
2656 .It Va vkernel_enable
2660 any configured vkernels will not be started.
2661 .It Va vkernel_kill_timeout
2663 This defines the default number of seconds that we will wait for the
2664 vkernel to shut down on it's own. If after this time it's still alive,
2665 it will be killed with SIGKILL.
2668 Defines the default path to the vkernel binary.
2671 A space separated list of names for vkernels.
2672 This is purely a configuration aid to help identify and
2673 configure multiple vkernels.
2674 The names specified in this list will be used to
2675 identify settings common to a vkernel instance.
2676 Assuming that the vkernel in question was named
2678 you would have the following dependent variables
2679 (filled with reference values in this text):
2681 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2682 vkernel_example_memsize="64m"
2683 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2684 vkernel_example_iface_list="auto:bridge0"
2685 vkernel_example_logfile="/dev/null"
2686 vkernel_example_flags="-U"
2687 vkernel_example_kill_timeout="45"
2690 The last five are optional.
2691 They default to an empty string if not set, except for logfile which defaults to
2696 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2697 .It Pa /etc/defaults/rc.conf
2699 .It Pa /etc/rc.conf.local
2700 .It Pa /etc/start_if. Ns Aq Ar interface
2717 .Xr resident.conf 5 ,
2778 .An Jordan K. Hubbard .