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.
128 when faststart is used (e.g., at boot time).
133 no swapfile is installed, otherwise the value is used as the full
134 pathname to a file to use for additional swap space.
137 driver is needed for a swapfile and will be loaded if it is not
138 already compiled into the kernel or loaded via
144 enable support for Automatic Power Management with the
151 to handle APM event from userland.
152 This also enables support for APM.
159 these are the flags to pass to the
165 to monitor the status of batteries present in the system.
166 This also enables support for APM.
173 these are the flags to pass to the
180 to handle device added, removed or unknown events from the kernel.
187 these are the flags to pass to the
199 a CPU speed control daemon.
200 .It Va sensorsd_enable
209 a sensors monitoring and logging daemon.
210 .It Va sensorsd_flags
213 Additional flags passed to the
216 .It Va sysvipcd_enable
225 a sensors monitoring and logging daemon.
226 .It Va sysvipcd_flags
229 Additional flags passed to the
232 .It Va hotplugd_enable
241 a devices hot plugging monitoring daemon.
242 .It Va hotplugd_flags
245 Additional flags passed to the
248 .It Va pccard_ifconfig
250 List of arguments to be passed to
252 at boot time or on insertion of the card (e.g.\&
253 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
254 for a fixed address or
257 .It Va pccard_ether_delay
259 Set the delay before starting
262 .Pa /etc/pccard_ether
264 This defaults to 5 seconds to work around a bug in the
266 driver which can lead to system hangs when using some newer
269 .It Va removable_interfaces
271 List of removable network interfaces to be supported by
272 .Pa /etc/pccard_ether .
275 List of directories to search for startup script files.
276 .It Va script_name_sep
278 The field separator to use for breaking down the list of startup script files
279 into individual filenames.
280 The default is a space.
281 It is not necessary to change this unless there are startup scripts with names
283 .It Va hostapd_enable
292 The fully qualified domain name (FQDN) of this host on the network.
293 This should almost certainly be set to something meaningful, even if
294 there is no network connection.
297 is used to set the hostname via DHCP,
298 this variable should be set to an empty string.
301 Enable support for IPv6 networking.
302 Note that this requires that the kernel have been compiled with
303 .Cd "options INET6" .
306 The NIS domain name of this host, or
309 .It Va dhclient_program
311 Path to the DHCP client program
313 .Pa /sbin/dhclient ) .
314 .It Va dhclient_flags
316 Additional flags to pass to the DHCP client program.
324 If the kernel was not built with
328 kernel module will be loaded.
330 .Va firewall_enable .
335 ruleset definition file.
346 these are the flags to pass to
348 when loading the ruleset.
355 which logs packets from
363 this specifies the path of the log file.
374 these are the flags to pass to
376 .It Va firewall_enable
380 to load firewall rules at startup.
381 If the kernel was not built with
382 .Cd "options IPFIREWALL" ,
385 kernel module will be loaded.
388 .It Va ipv6_firewall_enable
390 The IPv6 equivalent of
391 .Va firewall_enable .
394 to load IPv6 firewall rules at startup.
395 If the kernel was not built with
396 .Cd "options IPV6FIREWALL" ,
399 kernel module will be loaded.
400 .It Va firewall_script
402 The full path to the firewall script to run
404 .Pa /etc/rc.firewall ) .
405 .It Va ipv6_firewall_script
407 The IPv6 equivalent of
408 .Va firewall_script .
411 Names the firewall type from the selection in
412 .Pa /etc/rc.firewall ,
413 or the file which contains the local firewall ruleset.
414 Valid selections from
418 .Bl -tag -width ".Li simple" -compact
420 unrestricted IP access
422 all IP services disabled, except via
425 basic protection for a workstation on a LAN
431 If a filename is specified, the full path must be given.
432 .It Va firewall_trusted_nets
434 List of trusted networks (if
438 .It Va firewall_trusted_interfaces
440 List of trusted network interfaces (if
444 .It Va firewall_allowed_icmp_types
446 List of allowed ICMP types (if
450 .It Va firewall_open_tcp_ports
452 List of TCP ports to open (if
456 .It Va firewall_open_udp_ports
458 List of UDP ports to open (if
462 .It Va ipv6_firewall_type
464 The IPv6 equivalent of
466 .It Va firewall_quiet
470 to disable the display of firewall rules on the console during boot.
471 .It Va ipv6_firewall_quiet
473 The IPv6 equivalent of
475 .It Va firewall_logging
479 to enable firewall event logging.
480 This is equivalent to the
481 .Dv IPFIREWALL_VERBOSE
483 .It Va ipv6_firewall_logging
485 The IPv6 equivalent of
486 .Va firewall_logging .
487 .It Va firewall_flags
493 specifies a filename.
494 .It Va ipv6_firewall_flags
496 The IPv6 equivalent of
513 sockets must be enabled in the kernel.
514 .It Va natd_interface
516 This is the name of the public interface on which
519 The interface may be given as an interface name or as an IP address.
524 flags should be placed here.
529 flag is automatically added with the above
532 .It Va tcp_extensions
539 disables certain TCP options as described by
545 might help remedy such problems with connections as randomly hanging
546 or other weird behavior.
547 Some network devices are known to be broken with respect to these options.
554 .Va net.inet.tcp.log_in_vain
556 .Va net.inet.udp.log_in_vain ,
561 are set to the given value.
569 will disable probing idle TCP connections to verify that the
570 peer is still up and reachable.
571 .It Va tcp_drop_synfin
578 will cause the kernel to ignore TCP frames that have both
579 the SYN and FIN flags set.
580 This prevents OS fingerprinting, but may break some legitimate applications.
581 This option is only available if the kernel was built with the
584 .It Va icmp_drop_redirect
591 will cause the kernel to ignore ICMP REDIRECT packets.
594 for more information.
595 .It Va icmp_log_redirect
602 will cause the kernel to log ICMP REDIRECT packets.
604 the log messages are not rate-limited, so this option should only be used
605 for troubleshooting networks.
608 for more information.
609 .It Va icmp_bmcastecho
613 to respond to broadcast or multicast ICMP ping packets.
616 for more information.
617 .It Va ip_portrange_first
621 this is the first port in the default portrange.
624 for more information.
625 .It Va ip_portrange_last
629 this is the last port in the default portrange.
632 for more information.
634 .It Va ifconfig_ Ns Aq Ar interface
638 Typically includes IP address.
639 Assuming that the interface in question was
641 it might look something like this:
643 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
647 .Pa /etc/start_if. Ns Aq Ar interface
648 file is present, it is read and executed by the
650 interpreter before configuring the interface as specified in the
651 .Va ifconfig_ Ns Aq Ar interface
653 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
656 It is possible to bring up an interface with DHCP by adding
659 .Va ifconfig_ Ns Aq Ar interface
661 For instance, to initialize the
663 device via DHCP, it is possible to use something like:
669 .Va vlans_ Ns Aq Ar interface
673 interface will be created for each item in the list with the
677 If a vlan interface's name is a number,
678 then that number is used as the vlan tag and the new vlan interface is
680 .Ar interface . Ns Ar tag .
682 the vlan tag must be specified via a
685 .Va create_args_ Ns Aq Ar interface
688 To create a vlan device named
692 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
695 ifconfig_em0_101="inet 192.0.2.1/24"
698 To create a vlan device named
702 with the vlan tag 102:
705 create_args_myvlan="vlan 102"
709 .Va wlans_ Ns Aq Ar interface
713 interface will be created for each item in the list with the
717 Further wlan cloning arguments may be passed to the
720 command by setting the
721 .Va create_args_ Ns Aq Ar interface
725 devices must be created for each wireless devices as of
731 may be specified with an
732 .Va wlandebug_ Ns Aq Ar interface
734 The contents of this variable will be passed directly to
737 Also, if your interface needs WPA authentication, it is possible to add
740 .Va ifconfig_ Ns Aq Ar interface
743 .Xr wpa_supplicant 8 .
745 .Xr wpa_supplicant.conf 5
746 for configuring authentication information.
750 options in this variable, in addition to the
751 .Pa /etc/start_if. Ns Aq Ar interface
753 For instance, to initialize the
755 device via DHCP, using WPA authentication and 802.11b mode, it is
756 possible to use something like:
759 ifconfig_wlan0="up DHCP WPA mode 11b"
761 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
763 Configuration to establish an additional network address for
765 Assuming that the interface in question was
767 it might look something like this:
769 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
770 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
775 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
776 entry that is found, its contents are passed to
778 Execution stops at the first unsuccessful access, so if
779 something like this is present:
781 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
782 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
783 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
784 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
787 Then note that alias4 would
789 be added since the search would stop with the missing alias3 entry.
790 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
794 It is possible to rename interface by doing:
796 ifconfig_ed0_name="net0"
797 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
799 .It Va network_interfaces
801 The list of network interfaces to configure on this host,
804 to configure all network interfaces
807 For example, if the only network devices to be configured are the loopback device
811 driver, this could be set to
814 .Va ifconfig_ Ns Aq Ar interface
815 variable is assumed to exist for each value of
817 .It Va ipv6_network_interfaces
819 This is the IPv6 equivalent of
820 .Va network_interfaces .
821 Instead of setting the ifconfig variables as
822 .Va ifconfig_ Ns Aq Ar interface
823 they should be set as
824 .Va ipv6_ifconfig_ Ns Aq Ar interface .
825 Aliases should be set as
826 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
827 Interfaces that do not have a
828 .Va ipv6_ifconfig_ Ns Aq Ar interface
829 setting will be auto configured by
832 .Va ipv6_gateway_enable
835 Note that the IPv6 networking code does not support the
836 .Pa /etc/start_if. Ns Aq Ar interface
838 .It Va ipv6_prefix_ Ns Aq Ar interface
842 prefixlen 64 is used.
843 .It Va ipv6_default_interface
847 this is the default output interface for scoped addresses.
848 Now this works only for IPv6 link local multicast addresses.
849 .It Va cloned_interfaces
851 Set to the list of clonable network interfaces to create on this host.
853 .Va cloned_interfaces
854 are automatically appended to
855 .Va network_interfaces
857 .It Va gif_interfaces
861 tunnel interfaces to configure on this host.
863 .Va gifconfig_ Ns Aq Ar interface
864 variable is assumed to exist for each value of
866 The value of this variable is used to configure the link layer of the
867 tunnel according to the syntax of the
871 Additionally, this option ensures that each listed interface is created via the
875 before attempting to configure it.
876 .It Va sppp_interfaces
880 interfaces to configure on this host.
882 .Va spppconfig_ Ns Aq Ar interface
883 variable is assumed to exist for each value of
885 Each interface should also be configured by a general
886 .Va ifconfig_ Ns Aq Ar interface
890 for more information about available options.
900 Mode in which to run the
909 See the manual for a full description.
914 enables network address translation.
915 Used in conjunction with
917 allows hosts on private network addresses access to the Internet using
918 this host as a network address translating router.
921 The name of the profile to use from
922 .Pa /etc/ppp/ppp.conf .
923 Also used for per-profile overrides of
924 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
925 Where the profile contains any of the characters
927 they are translated to
929 for the purposes of the override variable names.
930 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
932 Set the unit number to be used for this profile.
933 See the manual description of
940 The name of the user under which
949 This option is used to specify a list of files that will override
951 .Pa /etc/defaults/rc.conf .
952 The files will be read in the order in which they are specified and should
953 include the full path to the file.
954 By default, the files specified are
957 .Pa /etc/rc.conf.local
965 flag if the initial preen of the file systems fails.
968 List of file system types that are network-based.
969 This list should generally not be modified by end users.
971 .Va extra_netfs_types
973 .It Va extra_netfs_types
975 If set to something other than
977 (the default), this variable extends the list of file system types
978 for which automatic mounting at startup by
980 should be delayed until the network is initialized.
982 a whitespace-separated list of network file system descriptor pairs,
983 each consisting of a file system type as passed to
985 and a human-readable, one-word description, joined with a colon
987 Extending the default list in this way is only necessary
988 when third party file system types are used.
989 .It Va devfs_config_files
991 This option is used to specify a list of configuration files containing
993 rules that will be applied by
995 in the order in which they are specified and must include the full path
997 .It Va syslogd_enable
1004 .It Va syslogd_program
1009 .Pa /usr/sbin/syslogd ) .
1010 .It Va syslogd_flags
1016 these are the flags to pass to
1025 .It Va inetd_program
1030 .Pa /usr/sbin/inetd ) .
1037 these are the flags to pass to
1045 daemon at boot time.
1052 these are the flags to pass to it.
1059 daemon at boot time.
1066 these are the flags to pass to it.
1069 manpage for more information.
1070 .It Va amd_map_program
1072 If set, the specified program is run to get the list of
1077 maps are stored in NIS, one can set this to run
1089 will be updated at boot time to reflect the kernel release being run.
1093 will not be updated.
1094 .It Va nfs_client_enable
1098 setup NFS client parameters at boot time.
1099 .It Va nfs_access_cache
1102 .Va nfs_client_enable
1107 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1108 NFS ACCESS results should be cached.
1109 A value of 2-10 seconds will substantially reduce network traffic for
1110 many NFS operations.
1111 The default is 5 seconds.
1112 Note that the attribute cache holds stat information only.
1113 The NFS data cache is independent of the attribute cache and is only
1114 invalidated when the client detects that the server has modified the
1116 This value specifies a maximum timeout.
1117 The NFS client will automatically use a shorter timeout for files which
1118 have been recently modified.
1119 .It Va nfs_neg_cache
1122 .Va nfs_client_enable
1127 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1128 filenames), or to the number of seconds for which negative lookups should
1130 A value of 2-10 seconds will substantially reduce network
1131 traffic for many NFS operations, especially source code builds.
1132 The default is 3 seconds.
1133 .It Va nfs_server_enable
1137 run the NFS server daemons at boot time.
1138 .It Va nfs_server_flags
1141 .Va nfs_server_enable
1144 these are the flags to pass to the
1147 .It Va mountd_enable
1152 .Va nfs_server_enable
1158 It is commonly needed to run CFS without real NFS used.
1165 these are the flags to pass to the
1168 .It Va weak_mountd_authentication
1172 allow services like PCNFSD to make non-privileged mount requests.
1173 .It Va nfs_reserved_port_only
1177 provide NFS services only on a secure port.
1178 .It Va nfs_bufpackets
1180 If set to a number, indicates the number of packets worth of
1181 socket buffer space to reserve on an NFS client.
1182 The kernel default is typically 4.
1183 Using a higher number may be useful on gigabit networks to improve performance.
1184 The minimum value is 2 and the maximum is 64.
1185 .It Va rpc_umntall_enable
1189 (default) and we are also an NFS client, run
1191 at boot time to clear out old mounts on remote servers.
1196 will not be run at boot time.
1197 .It Va rpc_lockd_enable
1201 and also an NFS server, run
1204 .It Va rpc_lockd_flags
1207 .Va rpc_lockd_enable
1210 these are the flags to pass to
1212 .It Va rpc_statd_enable
1216 and also an NFS server, run
1219 .It Va rpc_statd_flags
1222 .Va rpc_statd_enable
1225 these are the flags to pass to
1227 .It Va rpcbind_program
1229 Path to program for rpcbind daemon
1231 .Pa /usr/sbin/rpcbind ) .
1232 .It Va rpcbind_enable
1239 .It Va rpcbind_flags
1245 these are the flags to pass to
1246 .Va rpcbind_program .
1247 .It Va keyserv_enable
1253 daemon on boot for running Secure RPC.
1254 .It Va keyserv_flags
1260 these are the flags to pass to
1263 .It Va pppoed_enable
1269 daemon at boot time to provide PPP over Ethernet services.
1270 .It Va pppoed_provider
1273 listens to requests to this provider and ultimately runs
1277 argument of the same name.
1280 Additional flags to pass to
1282 .It Va pppoed_interface
1284 The network interface to run
1287 This is mandatory when
1297 service at boot time.
1298 This command is intended for networks of machines where a consistent
1300 for all hosts must be established.
1301 This is often useful in large NFS environments where time stamps on
1302 files are expected to be consistent network-wide.
1309 these are the flags to pass to the
1318 at system boot time.
1319 .It Va dntpd_program
1324 .Pa /usr/sbin/dntpd ) .
1331 these are the flags to pass to the
1334 .It Va btconfig_enable
1338 configure Bluetooth devices via
1340 at system boot time.
1341 .It Va btconfig_devices
1347 this is the list of Bluetooth devices to configure.
1349 .Va btconfig_devices
1350 is not specified, all devices known to the system will be configured.
1352 .Va btconfig_ Ns Aq Ar device
1353 variable can be set to specify parameters to be passed to
1355 .It Va btconfig_args
1361 this is the list of configuration parameters to pass to all Bluetooth
1367 run the Service Discovery Profile daemon
1369 at system boot time.
1376 these are the flags to pass to the
1379 .It Va bthcid_enable
1383 run the Bluetooth Link Key/PIN Code Manager daemon
1385 at system boot time.
1392 these are the flags to pass to the
1395 .It Va nis_client_enable
1401 service at system boot time.
1402 .It Va nis_client_flags
1405 .Va nis_client_enable
1408 these are the flags to pass to the
1411 .It Va nis_ypset_enable
1417 daemon at system boot time.
1418 .It Va nis_ypset_flags
1421 .Va nis_ypset_enable
1424 these are the flags to pass to the
1427 .It Va nis_server_enable
1433 daemon at system boot time.
1434 .It Va nis_server_flags
1437 .Va nis_server_enable
1440 these are the flags to pass to the
1443 .It Va nis_ypxfrd_enable
1449 daemon at system boot time.
1450 .It Va nis_ypxfrd_flags
1453 .Va nis_ypxfrd_enable
1456 these are the flags to pass to the
1459 .It Va nis_yppasswdd_enable
1465 daemon at system boot time.
1466 .It Va nis_yppasswdd_flags
1469 .Va nis_yppasswdd_enable
1472 these are the flags to pass to the
1475 .It Va rpc_ypupdated_enable
1481 daemon at system boot time.
1482 .It Va defaultrouter
1486 create a default route to this host name or IP address
1487 (use an IP address if this router is also required to get to the
1489 .It Va ipv6_defaultrouter
1491 The IPv6 equivalent of
1493 .It Va static_routes
1495 Set to the list of static routes that are to be added at system boot time.
1498 then for each whitespace separated
1501 .Va route_ Ns Aq Ar element
1502 variable is assumed to exist whose contents will later be passed to a
1505 .It Va change_routes
1507 Set to the list of static routes that are to be changed at system boot time
1508 (such as those added by the kernel).
1511 then for each whitespace separated
1514 .Va change_route_ Ns Aq Ar element
1515 variable is assumed to exist whose contents will later be passed to a
1516 .Dq Nm route Cm change
1518 .It Va ipv6_static_routes
1520 The IPv6 equivalent of
1524 then for each whitespace separated
1527 .Va ipv6_route_ Ns Aq Ar element
1528 variable is assumed to exist whose contents will later be passed to a
1529 .Dq Nm route Cm add Fl inet6
1531 .It Va gateway_enable
1535 configure host to act as an IP router, e.g. to forward packets
1537 .It Va ipv6_gateway_enable
1539 The IPv6 equivalent of
1540 .Va gateway_enable .
1541 .It Va router_enable
1545 run a routing daemon of some sort, based on the settings of
1549 .It Va ipv6_router_enable
1551 The IPv6 equivalent of
1555 run a routing daemon of some sort, based on the settings of
1556 .Va ipv6_router_program
1558 .Va ipv6_router_flags .
1559 .It Va router_program
1565 this is the name of the routing daemon to use
1567 .Pa /sbin/routed ) .
1568 .It Va ipv6_router_program
1570 The IPv6 equivalent of
1573 .Pa /sbin/route6d ) .
1580 these are the flags to pass to the routing daemon.
1581 .It Va ipv6_router_flags
1583 The IPv6 equivalent of
1585 .It Va mrouted_enable
1589 run the multicast routing daemon,
1591 .It Va mroute6d_enable
1593 The IPv6 equivalent of
1594 .Va mrouted_enable .
1597 run the IPv6 multicast routing daemon.
1598 Note that no IPv6 multicast routing daemon is included in the
1602 can be installed from the
1605 .It Va mrouted_flags
1611 these are the flags to pass to the
1614 .It Va mroute6d_flags
1616 The IPv6 equivalent of
1622 these are the flags passed to the IPv6 multicast routing daemon.
1623 .It Va mroute6d_program
1629 this is the path to the IPv6 multicast routing daemon.
1630 .It Va rtadvd_enable
1636 daemon at boot time.
1639 .Va ipv6_gateway_enable
1644 utility sends router advertisement packets to the interfaces specified in
1645 .Va rtadvd_interfaces .
1647 and should only be enabled with great care.
1648 You may want to fine-tune
1650 .It Va rtadvd_interfaces
1656 this is the list of interfaces to use.
1657 .It Va rtsold_enable
1663 daemon at boot time.
1666 daemon is used for automatic discovery of non-link local addresses.
1673 these are the flags to pass to the
1680 enable global proxy ARP.
1681 .It Va forward_sourceroute
1689 source-routed packets are forwarded.
1690 .It Va accept_sourceroute
1694 the system will accept source-routed packets directed at it.
1701 daemon at system boot time.
1708 these are the flags to pass to the
1711 .It Va bootparamd_enable
1717 daemon at system boot time.
1718 .It Va bootparamd_flags
1721 .Va bootparamd_enable
1724 these are the flags to pass to the
1727 .It Va stf_interface_ipv4addr
1731 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1732 Specify this entry to enable the 6to4 interface.
1733 .It Va stf_interface_ipv4plen
1735 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1736 An effective value is 0-31.
1737 .It Va stf_interface_ipv6_ifid
1739 IPv6 interface ID for
1743 .It Va stf_interface_ipv6_slaid
1745 IPv6 Site Level Aggregator for
1747 .It Va ipv6_faith_prefix
1751 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1755 .It Va ipv6_ipv4mapping
1759 this enables IPv4 mapped IPv6 address communication (like
1760 .Li ::ffff:a.b.c.d ) .
1763 The keyboard bell sound.
1770 if the default behavior is desired.
1771 For details, refer to the
1778 no keymap is installed, otherwise the value is used to install
1780 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1783 The keyboard repeat speed.
1790 if the default behavior is desired.
1795 attempt to program the function keys with the value.
1796 The value should be a single string of the form:
1797 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1800 Can be set to the value of
1803 .Dq Li destructive ,
1806 to set the cursor behavior explicitly or choose the default behavior.
1811 no screen map is installed, otherwise the value is used to install
1812 the screen map file in
1813 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1818 the default 8x16 font value is used for screen size requests, otherwise
1820 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1826 the default 8x14 font value is used for screen size requests, otherwise
1828 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1834 the default 8x8 font value is used for screen size requests, otherwise
1836 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1842 the default screen blanking interval is used, otherwise it is set to
1849 this is the actual screen saver to use
1850 .Li ( blank , snake , daemon ,
1852 .It Va moused_nondefault_enable
1856 the mouse device specified on
1857 the command line is not automatically treated as enabled by the
1858 .Pa /etc/rc.d/moused
1860 Having this variable set to
1866 to be enabled as soon as it is plugged in.
1867 .It Va moused_enable
1873 daemon is started for doing cut/paste selection on the console.
1876 This is the protocol type of the mouse connected to this host.
1877 This variable must be set if
1884 is able to detect the appropriate mouse type automatically in many cases.
1885 Set this variable to
1887 to let the daemon detect it, or
1888 select one from the following list if the automatic detection fails.
1890 If the mouse is attached to the PS/2 mouse port, choose
1894 regardless of the brand and model of the mouse.
1895 Likewise, if the mouse is attached to the bus mouse port, choose
1899 All other protocols are for serial mice and will not work with
1900 the PS/2 and bus mice.
1901 If this is a USB mouse,
1903 is the only protocol type which will work.
1905 .Bl -tag -width ".Li x10mouseremote" -compact
1907 Microsoft mouse (serial)
1909 Microsoft IntelliMouse (serial)
1911 Mouse systems Corp. mouse (serial)
1913 MM Series mouse (serial)
1915 Logitech mouse (serial)
1919 Logitech MouseMan and TrackMan (serial)
1921 ALPS GlidePoint (serial)
1922 .It Li thinkingmouse
1923 Kensington ThinkingMouse (serial)
1927 MM HitTablet (serial)
1928 .It Li x10mouseremote
1929 X10 MouseRemote (serial)
1931 Interlink VersaPad (serial)
1934 Even if the mouse is not in the above list, it may be compatible
1935 with one in the list.
1936 Refer to the man page for
1938 for compatibility information.
1940 It should also be noted that while this is enabled, any
1941 other client of the mouse (such as an X server) should access
1942 the mouse through the virtual mouse device,
1944 and configure it as a
1946 type mouse, since all
1947 mouse data is converted to this single canonical format when using
1949 If the client program does not support the
1954 It is the second preferred type.
1961 this is the actual port the mouse is on.
1964 for a COM1 serial mouse or
1966 for a PS/2 mouse, for example.
1971 is set, these are the additional flags to pass to the
1974 .It Va mousechar_start
1978 the default mouse cursor character range
1979 .Li 0xd0 Ns - Ns Li 0xd3
1980 is used, otherwise the range start is set to
1984 Use if the default range is occupied in the language code table.
1987 Set the size of the history (scrollback) buffer in lines.
1988 .It Va allscreens_flags
1992 is run with these options for each of the virtual terminals
1996 will enable the mouse pointer on all virtual terminals if
2000 .It Va allscreens_kbdflags
2004 is run with these options for each of the virtual terminals
2010 scrollback (history) buffer to 200 lines.
2017 daemon at system boot time.
2023 .Pa /usr/sbin/cron ) .
2030 these are the flags to pass to
2037 .Pa /usr/sbin/lpd ) .
2044 daemon at system boot time.
2051 these are the flags to pass to the
2060 daemon at system boot time.
2067 settings across reboots.
2068 .It Va mta_start_script
2070 The full path to the script to run to start
2071 a mail transfer agent.
2073 .Pa /etc/rc.sendmail .
2077 .Pa /etc/rc.sendmail
2078 uses are documented in the
2084 .Sq HAMMER ROOT with UFS /boot
2085 setup, the boot loader will not set up the
2088 The system will attempt to fix this on its own.
2089 Set this variable to
2091 to turn this behavior off.
2094 Indicates the device (usually a swap partition) to which a crash dump
2095 should be written in the event of a system crash.
2096 The value of this variable is passed as the argument to
2100 To disable crash dumps, set this variable to
2104 When the system reboots after a crash and a crash dump is found on the
2105 device specified by the
2109 will save that crash dump and a copy of the kernel to the directory
2113 The default value is
2122 .It Va savecore_flags
2124 If crash dumps are enabled, these are the flags to pass to the
2127 .It Va crashinfo_enable
2131 to turn on automatic crash dump summary generation using the utility
2133 .Va crashinfo_program
2135 .It Va crashinfo_program
2137 Program to run to generate a crash dump summary if the variable
2138 .Va crashinfo_enable
2141 The default value is
2142 .Pa /usr/sbin/crashinfo .
2143 .It Va enable_quotas
2147 to turn on user disk quotas on system startup via the
2154 to enable user disk quota checking via the
2157 .It Va accounting_enable
2161 to enable system accounting through the
2168 to enable Linux/ELF binary emulation at system initial boot time.
2169 .\" ----- cleanvar_enable setting--------------------------------
2170 .It Va cleanvar_enable
2178 .Pa /var/spool/uucp/.Temp/*
2180 .\" ----- clear_tmp_enable setting-------------------------------
2181 .It Va clear_tmp_enable
2188 .\" ----- ldconfig_paths setting --------------------------------
2189 .It Va ldconfig_paths
2191 Set to the list of shared library paths to use with
2195 will always be added first, so it need not appear in this list.
2196 .It Va ldconfig_insecure
2200 utility normally refuses to use directories
2201 which are writable by anyone except root.
2202 Set this variable to
2204 to disable that security check during system startup.
2205 .It Va ldconfig_local_dirs
2207 Set to the list of local
2210 The names of all files in the directories listed will be
2211 passed as arguments to
2213 .It Va kern_securelevel
2215 The kernel security level to set at startup.
2216 The allowed range of
2218 ranges from \-1 (the compile time default) to 3 (the most secure).
2221 for the list of possible security levels and their effect on system operation.
2228 at system boot time.
2235 at system boot time.
2238 Path to the SSH server program
2240 .Pa /usr/sbin/sshd ) .
2247 these are the flags to pass to the
2256 at system boot time.
2263 these are the flags to pass to the
2272 daemon at boot time.
2279 these are the flags passed to
2282 .It Va watchdogd_enable
2288 daemon at boot time.
2289 This requires that the kernel have been compiled with
2290 .Cd "options WATCHDOG" .
2295 any configured jails will not be started.
2298 A space separated list of names for jails.
2299 This is purely a configuration aid to help identify and
2300 configure multiple jails.
2301 The names specified in this list will be used to
2302 identify settings common to an instance of a jail.
2303 Assuming that the jail in question was named
2305 you would have the following dependent variables:
2307 jail_vjail_hostname="jail.example.com"
2308 jail_vjail_ip="192.168.1.100"
2309 jail_vjail_rootdir="/var/jails/vjail/root"
2314 When set, use as default value for
2315 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2318 .It Va jail_interface
2321 When set, use as default value for
2322 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2328 When set, use as default value for
2329 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2332 .It Va jail_mount_enable
2340 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2343 by default for every jail in
2345 .It Va jail_fdesc_enable
2353 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2356 by default for every jail in
2358 .It Va jail_procfs_enable
2366 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2369 by default for every jail in
2371 .It Va jail_devfs_enable
2379 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2382 by default for every jail in
2384 .It Va jail_exec_start
2387 When set, use as default value for
2388 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2391 .It Va jail_exec_stop
2393 When set, use as default value for
2394 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2397 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2400 Set to the root directory used by jail
2402 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2405 Set to the fully qualified domain name (FQDN) assigned to jail
2407 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2410 Set to the IP address assigned to jail
2412 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2417 These are flags to pass to
2419 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2422 When set, sets the interface to use when setting IP address alias.
2423 Note that the alias is created at jail startup and removed at jail shutdown.
2424 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2427 .Pa /etc/fstab. Ns Aq Ar jname
2429 This is the file system information file to use for jail
2431 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2438 mount all file systems from
2439 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2441 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2448 mount the file-descriptor file system inside jail
2451 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2458 mount the process file system inside jail
2461 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2468 mount the device file system inside jail
2471 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2474 .Dq Li /bin/sh /etc/rc
2476 This is the command executed at jail startup.
2477 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2480 .Dq Li /bin/sh /etc/rc.shutdown
2482 This is the command executed at jail shutdown.
2483 .It Va jail_set_hostname_allow
2487 do not allow the root user in a jail to set its hostname.
2488 .It Va jail_socket_unixiproute_only
2492 do not allow any sockets,
2493 besides UNIX/IP/route sockets,
2494 to be used within a jail.
2495 .It Va jail_sysvipc_allow
2499 allow applications within a jail to use System V IPC.
2504 LVM volumes will be discovered and configured on boot.
2505 .It Va newsyslog_enable
2511 before syslogd starts.
2512 .It Va newsyslog_flags
2515 .Va newsyslog_enable
2518 these are the flags passed to
2520 .It Va resident_enable
2524 make the dynamic binaries listed in
2525 .Pa /etc/resident.conf
2527 .It Va varsym_enable
2532 .Pa /etc/varsym.conf
2533 to set system-wide variables for variant symlinks.
2538 or a whitespace separated list of IRQ numbers which will be used as a source of
2540 .\" -----------------------------------------------------
2545 to disable caching entropy via
2547 Otherwise set to the directory used to store entropy files in.
2552 to disable caching entropy through reboots.
2553 Otherwise set to the filename used to store cached entropy through reboots.
2554 This file should be located on the root file system to seed the
2556 device as early as possible in the boot process.
2557 .It Va entropy_save_sz
2559 Determines the size of the entropy cache files used for entropy cached
2560 through reboots and also entropy cached via
2562 The entropy is fed to the system in blocks of 512 bytes, so this number
2563 should be large enough to fill as many of the entropy pools in the kernel
2565 By default, it is set to 16384, which should be able to seed all 32 entropy
2566 pools in the Fortuna CSPRNG.
2578 Configuration file for
2587 .Pa /var/run/dmesg.boot
2589 .It Va rcshutdown_timeout
2591 If set, start a watchdog timer in the background which will terminate
2595 has not completed within the specified time (in seconds).
2596 Notice that in addition to this soft timeout,
2598 also applies a hard timeout for the execution of
2600 This is configured via
2603 .Va kern.init_shutdown_timeout
2604 and defaults to 120 seconds. Setting the value of
2605 .Va rcshutdown_timeout
2606 to more than 120 seconds will have no effect until the
2609 .Va kern.init_shutdown_timeout
2615 the udevd daemon will be started on boot.
2616 .It Va vfs_quota_enable
2620 vfs quota rc.d scripts will be run on boot.
2621 .It Va vfs_quota_sync
2623 List of mount points whose counters are to be synchronized with on-disk
2624 usage during system startup. See also
2626 .It Va vknetd_enable
2631 will be started on boot.
2634 Additional flags passed to
2636 Usually address/cidrbits is specified here.
2637 When no flags are passed, default option
2640 .It Va vkernel_enable
2644 any configured vkernels will not be started.
2645 .It Va vkernel_kill_timeout
2647 This defines the default number of seconds that we will wait for the
2648 vkernel to shut down on it's own. If after this time it's still alive,
2649 it will be killed with SIGKILL.
2652 Defines the default path to the vkernel binary.
2655 A space separated list of names for vkernels.
2656 This is purely a configuration aid to help identify and
2657 configure multiple vkernels.
2658 The names specified in this list will be used to
2659 identify settings common to a vkernel instance.
2660 Assuming that the vkernel in question was named
2662 you would have the following dependent variables
2663 (filled with reference values in this text):
2665 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2666 vkernel_example_memsize="64m"
2667 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2668 vkernel_example_iface_list="auto:bridge0"
2669 vkernel_example_logfile="/dev/null"
2670 vkernel_example_flags="-U"
2671 vkernel_example_kill_timeout="45"
2674 The last five are optional.
2675 They default to an empty string if not set, except for logfile which defaults to
2680 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2681 .It Pa /etc/defaults/rc.conf
2683 .It Pa /etc/rc.conf.local
2684 .It Pa /etc/start_if. Ns Aq Ar interface
2702 .Xr resident.conf 5 ,
2763 .An Jordan K. Hubbard .