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"
700 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
702 Configuration to establish an additional network address for
704 Assuming that the interface in question was
706 it might look something like this:
708 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
709 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
714 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
715 entry that is found, its contents are passed to
717 Execution stops at the first unsuccessful access, so if
718 something like this is present:
720 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
721 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
722 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
723 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
726 Then note that alias4 would
728 be added since the search would stop with the missing alias3 entry.
731 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
735 It is possible to rename interface by doing:
737 ifconfig_ed0_name="net0"
738 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
740 .It Va network_interfaces
742 The list of network interfaces to configure on this host,
745 to configure all network interfaces
748 For example, if the only network devices to be configured are the loopback device
752 driver, this could be set to
755 .Va ifconfig_ Ns Aq Ar interface
756 variable is assumed to exist for each value of
758 .It Va ipv6_network_interfaces
760 This is the IPv6 equivalent of
761 .Va network_interfaces .
762 Instead of setting the ifconfig variables as
763 .Va ifconfig_ Ns Aq Ar interface
764 they should be set as
765 .Va ipv6_ifconfig_ Ns Aq Ar interface .
766 Aliases should be set as
767 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
768 Interfaces that do not have a
769 .Va ipv6_ifconfig_ Ns Aq Ar interface
770 setting will be auto configured by
773 .Va ipv6_gateway_enable
776 Note that the IPv6 networking code does not support the
777 .Pa /etc/start_if. Ns Aq Ar interface
779 .It Va ipv6_prefix_ Ns Aq Ar interface
783 prefixlen 64 is used.
784 .It Va ipv6_default_interface
788 this is the default output interface for scoped addresses.
789 Now this works only for IPv6 link local multicast addresses.
790 .It Va cloned_interfaces
792 Set to the list of clonable network interfaces to create on this host.
794 .Va cloned_interfaces
795 are automatically appended to
796 .Va network_interfaces
798 .It Va gif_interfaces
802 tunnel interfaces to configure on this host.
804 .Va gifconfig_ Ns Aq Ar interface
805 variable is assumed to exist for each value of
807 The value of this variable is used to configure the link layer of the
808 tunnel according to the syntax of the
812 Additionally, this option ensures that each listed interface is created via the
816 before attempting to configure it.
817 .It Va sppp_interfaces
821 interfaces to configure on this host.
823 .Va spppconfig_ Ns Aq Ar interface
824 variable is assumed to exist for each value of
826 Each interface should also be configured by a general
827 .Va ifconfig_ Ns Aq Ar interface
831 for more information about available options.
841 Mode in which to run the
850 See the manual for a full description.
855 enables network address translation.
856 Used in conjunction with
858 allows hosts on private network addresses access to the Internet using
859 this host as a network address translating router.
862 The name of the profile to use from
863 .Pa /etc/ppp/ppp.conf .
866 The name of the user under which
875 This option is used to specify a list of files that will override
877 .Pa /etc/defaults/rc.conf .
878 The files will be read in the order in which they are specified and should
879 include the full path to the file.
880 By default, the files specified are
883 .Pa /etc/rc.conf.local
891 flag if the initial preen of the file systems fails.
894 List of file system types that are network-based.
895 This list should generally not be modified by end users.
897 .Va extra_netfs_types
899 .It Va extra_netfs_types
901 If set to something other than
903 (the default), this variable extends the list of file system types
904 for which automatic mounting at startup by
906 should be delayed until the network is initialized.
908 a whitespace-separated list of network file system descriptor pairs,
909 each consisting of a file system type as passed to
911 and a human-readable, one-word description, joined with a colon
913 Extending the default list in this way is only necessary
914 when third party file system types are used.
915 .It Va devfs_config_files
917 This option is used to specify a list of configuration files containing
919 rules that will be applied by
921 in the order in which they are specified and must include the full path
923 .It Va syslogd_enable
930 .It Va syslogd_program
935 .Pa /usr/sbin/syslogd ) .
942 these are the flags to pass to
956 .Pa /usr/sbin/inetd ) .
963 these are the flags to pass to
978 these are the flags to pass to it.
992 these are the flags to pass to it.
995 manpage for more information.
996 .It Va amd_map_program
998 If set, the specified program is run to get the list of
1003 maps are stored in NIS, one can set this to run
1015 will be updated at boot time to reflect the kernel release being run.
1019 will not be updated.
1020 .It Va nfs_client_enable
1024 setup NFS client parameters at boot time.
1025 .It Va nfs_access_cache
1028 .Va nfs_client_enable
1033 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1034 NFS ACCESS results should be cached.
1035 A value of 2-10 seconds will substantially reduce network traffic for
1036 many NFS operations.
1037 The default is 5 seconds.
1038 Note that the attribute cache holds stat information only.
1039 The NFS data cache is independent of the attribute cache and is only
1040 invalidated when the client detects that the server has modified the
1042 This value specifies a maximum timeout.
1043 The NFS client will automatically use a shorter timeout for files which
1044 have been recently modified.
1045 .It Va nfs_neg_cache
1048 .Va nfs_client_enable
1053 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1054 filenames), or to the number of seconds for which negative lookups should
1056 A value of 2-10 seconds will substantially reduce network
1057 traffic for many NFS operations, especially source code builds.
1058 The default is 3 seconds.
1059 .It Va nfs_server_enable
1063 run the NFS server daemons at boot time.
1064 .It Va nfs_server_flags
1067 .Va nfs_server_enable
1070 these are the flags to pass to the
1073 .It Va mountd_enable
1078 .Va nfs_server_enable
1084 It is commonly needed to run CFS without real NFS used.
1091 these are the flags to pass to the
1094 .It Va weak_mountd_authentication
1098 allow services like PCNFSD to make non-privileged mount requests.
1099 .It Va nfs_reserved_port_only
1103 provide NFS services only on a secure port.
1104 .It Va nfs_bufpackets
1106 If set to a number, indicates the number of packets worth of
1107 socket buffer space to reserve on an NFS client.
1108 The kernel default is typically 4.
1109 Using a higher number may be useful on gigabit networks to improve performance.
1110 The minimum value is 2 and the maximum is 64.
1111 .It Va rpc_umntall_enable
1115 (default) and we are also an NFS client, run
1117 at boot time to clear out old mounts on remote servers.
1122 will not be run at boot time.
1123 .It Va rpc_lockd_enable
1127 and also an NFS server, run
1130 .It Va rpc_lockd_flags
1133 .Va rpc_lockd_enable
1136 these are the flags to pass to
1138 .It Va rpc_statd_enable
1142 and also an NFS server, run
1145 .It Va rpc_statd_flags
1148 .Va rpc_statd_enable
1151 these are the flags to pass to
1153 .It Va rpcbind_program
1155 Path to program for rpcbind daemon
1157 .Pa /usr/sbin/rpcbind ) .
1158 .It Va rpcbind_enable
1165 .It Va rpcbind_flags
1171 these are the flags to pass to
1172 .Va rpcbind_program .
1173 .It Va keyserv_enable
1179 daemon on boot for running Secure RPC.
1180 .It Va keyserv_flags
1186 these are the flags to pass to
1189 .It Va pppoed_enable
1195 daemon at boot time to provide PPP over Ethernet services.
1196 .It Va pppoed_provider
1199 listens to requests to this provider and ultimately runs
1203 argument of the same name.
1206 Additional flags to pass to
1208 .It Va pppoed_interface
1210 The network interface to run
1213 This is mandatory when
1223 service at boot time.
1224 This command is intended for networks of machines where a consistent
1226 for all hosts must be established.
1227 This is often useful in large NFS environments where time stamps on
1228 files are expected to be consistent network-wide.
1235 these are the flags to pass to the
1244 at system boot time.
1245 .It Va dntpd_program
1250 .Pa /usr/sbin/dntpd ) .
1257 these are the flags to pass to the
1260 .It Va btconfig_enable
1264 configure Bluetooth devices via
1266 at system boot time.
1267 .It Va btconfig_devices
1273 this is the list of Bluetooth devices to configure.
1275 .Va btconfig_devices
1276 is not specified, all devices known to the system will be configured.
1278 .Va btconfig_ Ns Aq Ar device
1279 variable can be set to specify parameters to be passed to
1281 .It Va btconfig_args
1287 this is the list of configuration parameters to pass to all Bluetooth
1293 run the Service Discovery Profile daemon
1295 at system boot time.
1302 these are the flags to pass to the
1305 .It Va bthcid_enable
1309 run the Bluetooth Link Key/PIN Code Manager daemon
1311 at system boot time.
1318 these are the flags to pass to the
1321 .It Va nis_client_enable
1327 service at system boot time.
1328 .It Va nis_client_flags
1331 .Va nis_client_enable
1334 these are the flags to pass to the
1337 .It Va nis_ypset_enable
1343 daemon at system boot time.
1344 .It Va nis_ypset_flags
1347 .Va nis_ypset_enable
1350 these are the flags to pass to the
1353 .It Va nis_server_enable
1359 daemon at system boot time.
1360 .It Va nis_server_flags
1363 .Va nis_server_enable
1366 these are the flags to pass to the
1369 .It Va nis_ypxfrd_enable
1375 daemon at system boot time.
1376 .It Va nis_ypxfrd_flags
1379 .Va nis_ypxfrd_enable
1382 these are the flags to pass to the
1385 .It Va nis_yppasswdd_enable
1391 daemon at system boot time.
1392 .It Va nis_yppasswdd_flags
1395 .Va nis_yppasswdd_enable
1398 these are the flags to pass to the
1401 .It Va rpc_ypupdated_enable
1407 daemon at system boot time.
1408 .It Va defaultrouter
1412 create a default route to this host name or IP address
1413 (use an IP address if this router is also required to get to the
1415 .It Va ipv6_defaultrouter
1417 The IPv6 equivalent of
1419 .It Va static_routes
1421 Set to the list of static routes that are to be added at system boot time.
1424 then for each whitespace separated
1427 .Va route_ Ns Aq Ar element
1428 variable is assumed to exist whose contents will later be passed to a
1431 .It Va change_routes
1433 Set to the list of static routes that are to be changed at system boot time
1434 (such as those added by the kernel).
1437 then for each whitespace separated
1440 .Va change_route_ Ns Aq Ar element
1441 variable is assumed to exist whose contents will later be passed to a
1442 .Dq Nm route Cm change
1444 .It Va ipv6_static_routes
1446 The IPv6 equivalent of
1450 then for each whitespace separated
1453 .Va ipv6_route_ Ns Aq Ar element
1454 variable is assumed to exist whose contents will later be passed to a
1455 .Dq Nm route Cm add Fl inet6
1457 .It Va gateway_enable
1461 configure host to act as an IP router, e.g. to forward packets
1463 .It Va ipv6_gateway_enable
1465 The IPv6 equivalent of
1466 .Va gateway_enable .
1467 .It Va router_enable
1471 run a routing daemon of some sort, based on the settings of
1475 .It Va ipv6_router_enable
1477 The IPv6 equivalent of
1481 run a routing daemon of some sort, based on the settings of
1482 .Va ipv6_router_program
1484 .Va ipv6_router_flags .
1485 .It Va router_program
1491 this is the name of the routing daemon to use
1493 .Pa /sbin/routed ) .
1494 .It Va ipv6_router_program
1496 The IPv6 equivalent of
1499 .Pa /sbin/route6d ) .
1506 these are the flags to pass to the routing daemon.
1507 .It Va ipv6_router_flags
1509 The IPv6 equivalent of
1511 .It Va mrouted_enable
1515 run the multicast routing daemon,
1517 .It Va mroute6d_enable
1519 The IPv6 equivalent of
1520 .Va mrouted_enable .
1523 run the IPv6 multicast routing daemon.
1524 Note that no IPv6 multicast routing daemon is included in the
1528 can be installed from the
1531 .It Va mrouted_flags
1537 these are the flags to pass to the
1540 .It Va mroute6d_flags
1542 The IPv6 equivalent of
1548 these are the flags passed to the IPv6 multicast routing daemon.
1549 .It Va mroute6d_program
1555 this is the path to the IPv6 multicast routing daemon.
1556 .It Va rtadvd_enable
1562 daemon at boot time.
1565 .Va ipv6_gateway_enable
1570 utility sends router advertisement packets to the interfaces specified in
1571 .Va rtadvd_interfaces .
1573 and should only be enabled with great care.
1574 You may want to fine-tune
1576 .It Va rtadvd_interfaces
1582 this is the list of interfaces to use.
1583 .It Va rtsold_enable
1589 daemon at boot time.
1592 daemon is used for automatic discovery of non-link local addresses.
1599 these are the flags to pass to the
1602 .It Va ipxgateway_enable
1606 enable the routing of IPX traffic.
1607 .It Va ipxrouted_enable
1613 daemon at system boot time.
1614 .It Va ipxrouted_flags
1617 .Va ipxrouted_enable
1620 these are the flags to pass to the
1627 enable global proxy ARP.
1628 .It Va forward_sourceroute
1636 source-routed packets are forwarded.
1637 .It Va accept_sourceroute
1641 the system will accept source-routed packets directed at it.
1648 daemon at system boot time.
1655 these are the flags to pass to the
1658 .It Va bootparamd_enable
1664 daemon at system boot time.
1665 .It Va bootparamd_flags
1668 .Va bootparamd_enable
1671 these are the flags to pass to the
1674 .It Va stf_interface_ipv4addr
1678 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1679 Specify this entry to enable the 6to4 interface.
1680 .It Va stf_interface_ipv4plen
1682 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1683 An effective value is 0-31.
1684 .It Va stf_interface_ipv6_ifid
1686 IPv6 interface ID for
1690 .It Va stf_interface_ipv6_slaid
1692 IPv6 Site Level Aggregator for
1694 .It Va ipv6_faith_prefix
1698 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1702 .It Va ipv6_ipv4mapping
1706 this enables IPv4 mapped IPv6 address communication (like
1707 .Li ::ffff:a.b.c.d ) .
1712 to enable the configuration of ATM interfaces at system boot time.
1713 For all of the ATM variables described below, please refer to the
1715 man page for further details on the available command parameters.
1716 Also refer to the files in
1717 .Pa /usr/share/examples/atm
1718 for more detailed configuration information.
1719 .It Va atm_netif_ Ns Aq Ar intf
1721 For the ATM physical interface
1723 this variable defines the name prefix and count for the ATM network
1724 interfaces to be created.
1725 The value will be passed as the parameters of an
1726 .Dq Nm atm Cm "set netif" Ar intf
1728 .It Va atm_sigmgr_ Ns Aq Ar intf
1730 For the ATM physical interface
1732 this variable defines the ATM signalling manager to be used.
1733 The value will be passed as the parameters of an
1734 .Dq Nm atm Cm attach Ar intf
1736 .It Va atm_prefix_ Ns Aq Ar intf
1738 For the ATM physical interface
1740 this variable defines the NSAP prefix for interfaces using a UNI signalling
1744 the prefix will automatically be set via the
1747 Otherwise, the value will be passed as the parameters of an
1748 .Dq Nm atm Cm "set prefix" Ar intf
1750 .It Va atm_macaddr_ Ns Aq Ar intf
1752 For the ATM physical interface
1754 this variable defines the MAC address for interfaces using a UNI signalling
1758 the hardware MAC address contained in the ATM interface card will be used.
1759 Otherwise, the value will be passed as the parameters of an
1760 .Dq Nm atm Cm "set mac" Ar intf
1762 .It Va atm_arpserver_ Ns Aq Ar netif
1764 For the ATM network interface
1766 this variable defines the ATM address for a host which is to provide ATMARP
1768 This variable is only applicable to interfaces using a UNI signalling manager.
1771 this host will become an ATMARP server.
1772 The value will be passed as the parameters of an
1773 .Dq Nm atm Cm "set arpserver" Ar netif
1775 .It Va atm_scsparp_ Ns Aq Ar netif
1779 SCSP/ATMARP service for the network interface
1781 will be initiated using the
1786 This variable is only applicable if
1787 .Va atm_arpserver_ Ns Aq Ar netif
1792 Set to the list of permanent ATM ARP entries to be added at system boot time.
1793 For each whitespace separated
1796 .Va atm_arp_ Ns Aq Ar element
1797 variable is assumed to exist.
1798 The value of each of these variables will be passed as the parameters of an
1799 .Dq Nm atm Cm "add arp"
1803 The keyboard bell sound.
1810 if the default behavior is desired.
1811 For details, refer to the
1818 no keymap is installed, otherwise the value is used to install
1820 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1823 The keyboard repeat speed.
1830 if the default behavior is desired.
1835 attempt to program the function keys with the value.
1836 The value should be a single string of the form:
1837 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1840 Can be set to the value of
1843 .Dq Li destructive ,
1846 to set the cursor behavior explicitly or choose the default behavior.
1851 no screen map is installed, otherwise the value is used to install
1852 the screen map file in
1853 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1858 the default 8x16 font value is used for screen size requests, otherwise
1860 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1866 the default 8x14 font value is used for screen size requests, otherwise
1868 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1874 the default 8x8 font value is used for screen size requests, otherwise
1876 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1882 the default screen blanking interval is used, otherwise it is set to
1889 this is the actual screen saver to use
1890 .Li ( blank , snake , daemon ,
1892 .It Va moused_enable
1898 daemon is started for doing cut/paste selection on the console.
1901 This is the protocol type of the mouse connected to this host.
1902 This variable must be set if
1909 is able to detect the appropriate mouse type automatically in many cases.
1910 Set this variable to
1912 to let the daemon detect it, or
1913 select one from the following list if the automatic detection fails.
1915 If the mouse is attached to the PS/2 mouse port, choose
1919 regardless of the brand and model of the mouse.
1920 Likewise, if the mouse is attached to the bus mouse port, choose
1924 All other protocols are for serial mice and will not work with
1925 the PS/2 and bus mice.
1926 If this is a USB mouse,
1928 is the only protocol type which will work.
1930 .Bl -tag -width ".Li x10mouseremote" -compact
1932 Microsoft mouse (serial)
1934 Microsoft IntelliMouse (serial)
1936 Mouse systems Corp. mouse (serial)
1938 MM Series mouse (serial)
1940 Logitech mouse (serial)
1944 Logitech MouseMan and TrackMan (serial)
1946 ALPS GlidePoint (serial)
1947 .It Li thinkingmouse
1948 Kensington ThinkingMouse (serial)
1952 MM HitTablet (serial)
1953 .It Li x10mouseremote
1954 X10 MouseRemote (serial)
1956 Interlink VersaPad (serial)
1959 Even if the mouse is not in the above list, it may be compatible
1960 with one in the list.
1961 Refer to the man page for
1963 for compatibility information.
1965 It should also be noted that while this is enabled, any
1966 other client of the mouse (such as an X server) should access
1967 the mouse through the virtual mouse device,
1969 and configure it as a
1971 type mouse, since all
1972 mouse data is converted to this single canonical format when using
1974 If the client program does not support the
1979 It is the second preferred type.
1986 this is the actual port the mouse is on.
1989 for a COM1 serial mouse or
1991 for a PS/2 mouse, for example.
1996 is set, these are the additional flags to pass to the
1999 .It Va mousechar_start
2003 the default mouse cursor character range
2004 .Li 0xd0 Ns - Ns Li 0xd3
2005 is used, otherwise the range start is set to
2009 Use if the default range is occupied in the language code table.
2012 Set the size of the history (scrollback) buffer in lines.
2013 .It Va allscreens_flags
2017 is run with these options for each of the virtual terminals
2021 will enable the mouse pointer on all virtual terminals if
2025 .It Va allscreens_kbdflags
2029 is run with these options for each of the virtual terminals
2035 scrollback (history) buffer to 200 lines.
2042 daemon at system boot time.
2048 .Pa /usr/sbin/cron ) .
2055 these are the flags to pass to
2062 .Pa /usr/sbin/lpd ) .
2069 daemon at system boot time.
2076 these are the flags to pass to the
2085 daemon at system boot time.
2092 settings across reboots.
2093 .It Va mta_start_script
2095 The full path to the script to run to start
2096 a mail transfer agent.
2098 .Pa /etc/rc.sendmail .
2102 .Pa /etc/rc.sendmail
2103 uses are documented in the
2109 .Sq HAMMER ROOT with UFS /boot
2110 setup, the boot loader will not set up the
2113 The system will attempt to fix this on its own.
2114 Set this variable to
2116 to turn this behavior off.
2119 Indicates the device (usually a swap partition) to which a crash dump
2120 should be written in the event of a system crash.
2121 The value of this variable is passed as the argument to
2125 To disable crash dumps, set this variable to
2129 When the system reboots after a crash and a crash dump is found on the
2130 device specified by the
2134 will save that crash dump and a copy of the kernel to the directory
2138 The default value is
2147 .It Va savecore_flags
2149 If crash dumps are enabled, these are the flags to pass to the
2152 .It Va crashinfo_enable
2156 to turn on automatic crash dump summary generation using the utility
2158 .Va crashinfo_program
2160 .It Va crashinfo_program
2162 Program to run to generate a crash dump summary if the variable
2163 .Va crashinfo_enable
2166 The default value is
2167 .Pa /usr/sbin/crashinfo .
2168 .It Va enable_quotas
2172 to turn on user disk quotas on system startup via the
2179 to enable user disk quota checking via the
2182 .It Va accounting_enable
2186 to enable system accounting through the
2193 to enable Linux/ELF binary emulation at system initial boot time.
2194 .It Va sysvipc_enable
2198 load System V IPC primitives at boot time.
2199 .\" ----- cleanvar_enable setting--------------------------------
2200 .It Va cleanvar_enable
2208 .Pa /var/spool/uucp/.Temp/*
2210 .\" ----- clear_tmp_enable setting-------------------------------
2211 .It Va clear_tmp_enable
2218 .\" ----- ldconfig_paths setting --------------------------------
2219 .It Va ldconfig_paths
2221 Set to the list of shared library paths to use with
2225 will always be added first, so it need not appear in this list.
2226 .It Va ldconfig_insecure
2230 utility normally refuses to use directories
2231 which are writable by anyone except root.
2232 Set this variable to
2234 to disable that security check during system startup.
2235 .It Va ldconfig_local_dirs
2237 Set to the list of local
2240 The names of all files in the directories listed will be
2241 passed as arguments to
2243 .It Va kern_securelevel
2245 The kernel security level to set at startup.
2246 The allowed range of
2248 ranges from \-1 (the compile time default) to 3 (the most secure).
2251 for the list of possible security levels and their effect on system operation.
2258 at system boot time.
2265 at system boot time.
2268 Path to the SSH server program
2270 .Pa /usr/sbin/sshd ) .
2277 these are the flags to pass to the
2286 at system boot time.
2293 these are the flags to pass to the
2302 daemon at boot time.
2309 these are the flags passed to
2312 .It Va watchdogd_enable
2318 daemon at boot time.
2319 This requires that the kernel have been compiled with
2320 .Cd "options WATCHDOG" .
2325 any configured jails will not be started.
2328 A space separated list of names for jails.
2329 This is purely a configuration aid to help identify and
2330 configure multiple jails.
2331 The names specified in this list will be used to
2332 identify settings common to an instance of a jail.
2333 Assuming that the jail in question was named
2335 you would have the following dependent variables:
2337 jail_vjail_hostname="jail.example.com"
2338 jail_vjail_ip="192.168.1.100"
2339 jail_vjail_rootdir="/var/jails/vjail/root"
2345 When set, use as default value for
2346 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2349 .It Va jail_interface
2352 When set, use as default value for
2353 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2359 When set, use as default value for
2360 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2363 .It Va jail_mount_enable
2371 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2374 by default for every jail in
2376 .It Va jail_fdesc_enable
2384 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2387 by default for every jail in
2389 .It Va jail_procfs_enable
2397 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2400 by default for every jail in
2402 .It Va jail_devfs_enable
2410 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2413 by default for every jail in
2415 .It Va jail_exec_start
2418 When set, use as default value for
2419 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2422 .It Va jail_exec_stop
2424 When set, use as default value for
2425 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2428 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2431 Set to the root directory used by jail
2433 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2436 Set to the fully qualified domain name (FQDN) assigned to jail
2438 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2441 Set to the IP address assigned to jail
2443 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2448 These are flags to pass to
2450 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2453 When set, sets the interface to use when setting IP address alias.
2454 Note that the alias is created at jail startup and removed at jail shutdown.
2455 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2458 .Pa /etc/fstab. Ns Aq Ar jname
2460 This is the file system information file to use for jail
2462 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2469 mount all file systems from
2470 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2472 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2479 mount the file-descriptor file system inside jail
2482 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2489 mount the process file system inside jail
2492 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2499 mount the device file system inside jail
2502 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2505 .Dq Li /bin/sh /etc/rc
2507 This is the command executed at jail startup.
2508 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2511 .Dq Li /bin/sh /etc/rc.shutdown
2513 This is the command executed at jail shutdown.
2514 .It Va jail_set_hostname_allow
2518 do not allow the root user in a jail to set its hostname.
2519 .It Va jail_socket_unixiproute_only
2523 do not allow any sockets,
2524 besides UNIX/IP/route sockets,
2525 to be used within a jail.
2526 .It Va jail_sysvipc_allow
2530 allow applications within a jail to use System V IPC.
2535 LVM volumes will be discovered and configured on boot.
2536 .It Va newsyslog_enable
2542 before syslogd starts.
2543 .It Va newsyslog_flags
2546 .Va newsyslog_enable
2549 these are the flags passed to
2551 .It Va resident_enable
2555 make the dynamic binaries listed in
2556 .Pa /etc/resident.conf
2558 .It Va varsym_enable
2563 .Pa /etc/varsym.conf
2564 to set system-wide variables for variant symlinks.
2569 or a whitespace separated list of IRQ numbers which will be used as a source of
2571 .\" -----------------------------------------------------
2576 to disable caching entropy via
2578 Otherwise set to the directory used to store entropy files in.
2583 to disable caching entropy through reboots.
2584 Otherwise set to the filename used to store cached entropy through reboots.
2585 This file should be located on the root file system to seed the
2587 device as early as possible in the boot process.
2599 Configuration file for
2608 .Pa /var/run/dmesg.boot
2610 .It Va rcshutdown_timeout
2612 If set, start a watchdog timer in the background which will terminate
2616 has not completed within the specified time (in seconds).
2617 Notice that in addition to this soft timeout,
2619 also applies a hard timeout for the execution of
2621 This is configured via
2624 .Va kern.init_shutdown_timeout
2625 and defaults to 120 seconds. Setting the value of
2626 .Va rcshutdown_timeout
2627 to more than 120 seconds will have no effect until the
2630 .Va kern.init_shutdown_timeout
2636 the udevd daemon will be started on boot.
2637 .It Va vfs_quota_enable
2641 vfs quota rc.d scripts will be run on boot.
2642 .It Va vfs_quota_sync
2644 List of mount points whose counters are to be synchronized with on-disk
2645 usage during system startup. See also
2647 .It Va vknetd_enable
2652 will be started on boot.
2655 Additional flags passed to
2657 Usually address/cidrbits is specified here.
2658 When no flags are passed, default option
2661 .It Va vkernel_enable
2665 any configured vkernels will not be started.
2666 .It Va vkernel_kill_timeout
2668 This defines the default number of seconds that we will wait for the
2669 vkernel to shut down on it's own. If after this time it's still alive,
2670 it will be killed with SIGKILL.
2673 Defines the default path to the vkernel binary.
2676 A space separated list of names for vkernels.
2677 This is purely a configuration aid to help identify and
2678 configure multiple vkernels.
2679 The names specified in this list will be used to
2680 identify settings common to a vkernel instance.
2681 Assuming that the vkernel in question was named
2683 you would have the following dependent variables
2684 (filled with reference values in this text):
2686 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2687 vkernel_example_memsize="64m"
2688 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2689 vkernel_example_iface_list="auto:bridge0"
2690 vkernel_example_logfile="/dev/null"
2691 vkernel_example_flags="-U"
2692 vkernel_example_kill_timeout="45"
2695 The last five are optional.
2696 They default to an empty string if not set, except for logfile which defaults to
2701 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2702 .It Pa /etc/defaults/rc.conf
2704 .It Pa /etc/rc.conf.local
2705 .It Pa /etc/start_if. Ns Aq Ar interface
2722 .Xr resident.conf 5 ,
2783 .An Jordan K. Hubbard .