4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the installer.
45 is not to run commands or perform system startup actions directly.
46 Instead, it is included by the various generic startup scripts in
48 which conditionalize their
49 internal actions according to the settings found there.
52 .Pa /etc/defaults/rc.conf
53 file specifies the default settings for all the available options,
56 file specifies override settings.
57 Options need only be specified in
59 when the system administrator wishes to override the defaults.
61 .Pa /etc/rc.conf.local
62 is used to override settings in
64 for historical reasons.
69 The following list provides a name and short description for each
70 variable that can be set in the
87 These values are case insensitive.
90 postfix in the name of a variable for starting a service can be
93 .Bl -tag -width indent-two
98 enable output of debug messages from rc scripts.
99 This variable can be helpful in diagnosing mistakes when
100 editing or integrating new scripts.
101 Beware that this produces copious output to the terminal and
107 disable informational messages from the rc scripts.
108 Informational messages are displayed when
109 a condition that is not serious enough to warrant a warning or an error occurs.
114 no swapfile is installed, otherwise the value is used as the full
115 pathname to a file to use for additional swap space.
120 enable support for Automatic Power Management with the
127 to handle APM event from userland.
128 This also enables support for APM.
135 these are the flags to pass to the
141 to monitor the status of batteries present in the system.
142 This also enables support for APM.
149 these are the flags to pass to the
156 to handle device added, removed or unknown events from the kernel.
163 these are the flags to pass to the
175 a CPU speed control daemon.
176 .It Va sensorsd_enable
185 a sensors monitoring and logging daemon.
186 .It Va sensorsd_flags
189 Additional flags passed to the
192 .It Va hotplugd_enable
201 a devices hot plugging monitoring daemon.
202 .It Va hotplugd_flags
205 Additional flags passed to the
208 .It Va pccard_ifconfig
210 List of arguments to be passed to
212 at boot time or on insertion of the card (e.g.\&
213 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
214 for a fixed address or
217 .It Va pccard_ether_delay
219 Set the delay before starting
222 .Pa /etc/pccard_ether
224 This defaults to 5 seconds to work around a bug in the
226 driver which can lead to system hangs when using some newer
229 .It Va removable_interfaces
231 List of removable network interfaces to be supported by
232 .Pa /etc/pccard_ether .
235 List of directories to search for startup script files.
236 .It Va script_name_sep
238 The field separator to use for breaking down the list of startup script files
239 into individual filenames.
240 The default is a space.
241 It is not necessary to change this unless there are startup scripts with names
243 .It Va hostapd_enable
252 The fully qualified domain name (FQDN) of this host on the network.
253 This should almost certainly be set to something meaningful, even if
254 there is no network connection.
257 is used to set the hostname via DHCP,
258 this variable should be set to an empty string.
261 Enable support for IPv6 networking.
262 Note that this requires that the kernel have been compiled with
263 .Cd "options INET6" .
266 The NIS domain name of this host, or
269 .It Va dhclient_program
271 Path to the DHCP client program
273 .Pa /sbin/dhclient ) .
274 .It Va dhclient_flags
276 Additional flags to pass to the DHCP client program.
284 If the kernel was not built with
288 kernel module will be loaded.
292 .Va ipfilter_enable .
297 ruleset definition file.
308 these are the flags to pass to
310 when loading the ruleset.
317 which logs packets from
325 this specifies the path of the log file.
336 these are the flags to pass to
338 .It Va firewall_enable
342 to load firewall rules at startup.
343 If the kernel was not built with
344 .Cd "options IPFIREWALL" ,
347 kernel module will be loaded.
351 .Va ipfilter_enable .
352 .It Va ipv6_firewall_enable
354 The IPv6 equivalent of
355 .Va firewall_enable .
358 to load IPv6 firewall rules at startup.
359 If the kernel was not built with
360 .Cd "options IPV6FIREWALL" ,
363 kernel module will be loaded.
364 .It Va firewall_script
366 The full path to the firewall script to run
368 .Pa /etc/rc.firewall ) .
369 .It Va ipv6_firewall_script
371 The IPv6 equivalent of
372 .Va firewall_script .
375 Names the firewall type from the selection in
376 .Pa /etc/rc.firewall ,
377 or the file which contains the local firewall ruleset.
378 Valid selections from
382 .Bl -tag -width ".Li simple" -compact
384 unrestricted IP access
386 all IP services disabled, except via
389 basic protection for a workstation on a LAN
395 If a filename is specified, the full path must be given.
396 .It Va firewall_trusted_nets
398 List of trusted networks (if
402 .It Va firewall_trusted_interfaces
404 List of trusted network interfaces (if
408 .It Va firewall_allowed_icmp_types
410 List of allowed ICMP types (if
414 .It Va firewall_open_tcp_ports
416 List of TCP ports to open (if
420 .It Va firewall_open_udp_ports
422 List of UDP ports to open (if
426 .It Va ipv6_firewall_type
428 The IPv6 equivalent of
430 .It Va firewall_quiet
434 to disable the display of firewall rules on the console during boot.
435 .It Va ipv6_firewall_quiet
437 The IPv6 equivalent of
439 .It Va firewall_logging
443 to enable firewall event logging.
444 This is equivalent to the
445 .Dv IPFIREWALL_VERBOSE
447 .It Va ipv6_firewall_logging
449 The IPv6 equivalent of
450 .Va firewall_logging .
451 .It Va firewall_flags
457 specifies a filename.
458 .It Va ipv6_firewall_flags
460 The IPv6 equivalent of
477 sockets must be enabled in the kernel.
478 .It Va natd_interface
480 This is the name of the public interface on which
483 The interface may be given as an interface name or as an IP address.
488 flags should be placed here.
493 flag is automatically added with the above
496 .\" ----- ipfilter_enable setting --------------------------------
497 .It Va ipfilter_enable
508 Typical usage will require putting
510 ipfilter_enable="YES"
528 can be enabled independently.
532 both require at least one of
542 options IPFILTER_DEFAULT_BLOCK
545 in the kernel configuration file is a good idea, too.
549 .Va firewall_enable .
550 .\" ----- ipfilter_program setting ------------------------------
551 .It Va ipfilter_program
557 .\" ----- ipfilter_rules setting --------------------------------
558 .It Va ipfilter_rules
563 The name of the filter rule definition file.
564 The file is expected to be readable for the
567 .\" ----- ipv6_ipfilter_rules setting ---------------------------
568 .It Va ipv6_ipfilter_rules
573 The name of the IPv6 filter rule definition file.
574 The file is expected to be readable for the
577 .\" ----- ipfilter_flags setting --------------------------------
578 .It Va ipfilter_flags
584 .\" ----- ipnat_enable setting ----------------------------------
594 network address translation.
597 for a detailed discussion.
598 .\" ----- ipnat_program setting ---------------------------------
605 .\" ----- ipnat_rules setting -----------------------------------
612 holding the network address translation definition.
613 This file is expected to be readable for the
616 .\" ----- ipnat_flags setting -----------------------------------
623 .\" ----- ipmon_enable setting ----------------------------------
638 Setting this variable needs setting
645 for a detailed discussion.
646 .\" ----- ipmon_program setting ---------------------------------
653 .\" ----- ipmon_flags setting -----------------------------------
662 Another typical example would be
663 .Dq Fl D Pa /var/log/ipflog
666 log directly to a file bypassing
669 .Pa /etc/newsyslog.conf
670 in such case like this:
672 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
674 .\" ----- ipfs_enable setting -----------------------------------
684 saving the filter and NAT state tables during shutdown
685 and reloading them during startup again.
686 Setting this variable needs setting
695 for a detailed discussion.
700 cannot be used because the raised securelevel will prevent
702 from saving the state tables at shutdown time.
703 .\" ----- ipfs_program setting ----------------------------------
710 .\" ----- ipfs_flags setting ------------------------------------
717 .\" ----- end of added ipf hook ---------------------------------
718 .It Va tcp_extensions
725 disables certain TCP options as described by
731 might help remedy such problems with connections as randomly hanging
732 or other weird behavior.
733 Some network devices are known to be broken with respect to these options.
740 .Va net.inet.tcp.log_in_vain
742 .Va net.inet.udp.log_in_vain ,
747 are set to the given value.
755 will disable probing idle TCP connections to verify that the
756 peer is still up and reachable.
757 .It Va tcp_drop_synfin
764 will cause the kernel to ignore TCP frames that have both
765 the SYN and FIN flags set.
766 This prevents OS fingerprinting, but may break some legitimate applications.
767 This option is only available if the kernel was built with the
770 .It Va icmp_drop_redirect
777 will cause the kernel to ignore ICMP REDIRECT packets.
780 for more information.
781 .It Va icmp_log_redirect
788 will cause the kernel to log ICMP REDIRECT packets.
790 the log messages are not rate-limited, so this option should only be used
791 for troubleshooting networks.
794 for more information.
795 .It Va icmp_bmcastecho
799 to respond to broadcast or multicast ICMP ping packets.
802 for more information.
803 .It Va ip_portrange_first
807 this is the first port in the default portrange.
810 for more information.
811 .It Va ip_portrange_last
815 this is the last port in the default portrange.
818 for more information.
820 .It Va ifconfig_ Ns Aq Ar interface
824 Typically includes IP address.
825 Assuming that the interface in question was
827 it might look something like this:
829 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
833 .Pa /etc/start_if. Ns Aq Ar interface
834 file is present, it is read and executed by the
836 interpreter before configuring the interface as specified in the
837 .Va ifconfig_ Ns Aq Ar interface
839 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
842 It is possible to bring up an interface with DHCP by adding
845 .Va ifconfig_ Ns Aq Ar interface
847 For instance, to initialize the
849 device via DHCP, it is possible to use something like:
854 Also, if your interface needs WPA authentication, it is possible to add
857 .Va ifconfig_ Ns Aq Ar interface
860 .Xr wpa_supplicant 8 .
862 .Xr wpa_supplicant.conf 5
863 for configuring authentication information.
867 options in this variable, in addition to the
868 .Pa /etc/start_if. Ns Aq Ar interface
870 For instance, to initialize the
872 device via DHCP, using WPA authentication and 802.11b mode, it is
873 possible to use something like:
875 ifconfig_wi0="up DHCP WPA mode 11b"
879 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
881 Configuration to establish an additional network address for
883 Assuming that the interface in question was
885 it might look something like this:
887 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
888 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
893 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
894 entry that is found, its contents are passed to
896 Execution stops at the first unsuccessful access, so if
897 something like this is present:
899 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
900 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
901 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
902 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
905 Then note that alias4 would
907 be added since the search would stop with the missing alias3 entry.
910 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
914 It is possible to rename interface by doing:
916 ifconfig_ed0_name="net0"
917 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
919 .It Va network_interfaces
921 The list of network interfaces to configure on this host,
924 to configure all network interfaces
927 For example, if the only network devices to be configured are the loopback device
931 driver, this could be set to
934 .Va ifconfig_ Ns Aq Ar interface
935 variable is assumed to exist for each value of
937 .It Va ipv6_network_interfaces
939 This is the IPv6 equivalent of
940 .Va network_interfaces .
941 Instead of setting the ifconfig variables as
942 .Va ifconfig_ Ns Aq Ar interface
943 they should be set as
944 .Va ipv6_ifconfig_ Ns Aq Ar interface .
945 Aliases should be set as
946 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
947 Interfaces that do not have a
948 .Va ipv6_ifconfig_ Ns Aq Ar interface
949 setting will be auto configured by
952 .Va ipv6_gateway_enable
955 Note that the IPv6 networking code does not support the
956 .Pa /etc/start_if. Ns Aq Ar interface
958 .It Va ipv6_prefix_ Ns Aq Ar interface
962 prefixlen 64 is used.
963 .It Va ipv6_default_interface
967 this is the default output interface for scoped addresses.
968 Now this works only for IPv6 link local multicast addresses.
969 .It Va cloned_interfaces
971 Set to the list of clonable network interfaces to create on this host.
973 .Va cloned_interfaces
974 are automatically appended to
975 .Va network_interfaces
977 .It Va gif_interfaces
981 tunnel interfaces to configure on this host.
983 .Va gifconfig_ Ns Aq Ar interface
984 variable is assumed to exist for each value of
986 The value of this variable is used to configure the link layer of the
987 tunnel according to the syntax of the
991 Additionally, this option ensures that each listed interface is created via the
995 before attempting to configure it.
996 .It Va sppp_interfaces
1000 interfaces to configure on this host.
1002 .Va spppconfig_ Ns Aq Ar interface
1003 variable is assumed to exist for each value of
1005 Each interface should also be configured by a general
1006 .Va ifconfig_ Ns Aq Ar interface
1010 for more information about available options.
1020 Mode in which to run the
1029 See the manual for a full description.
1034 enables network address translation.
1035 Used in conjunction with
1037 allows hosts on private network addresses access to the Internet using
1038 this host as a network address translating router.
1041 The name of the profile to use from
1042 .Pa /etc/ppp/ppp.conf .
1045 The name of the user under which
1052 .It Va rc_conf_files
1054 This option is used to specify a list of files that will override
1056 .Pa /etc/defaults/rc.conf .
1057 The files will be read in the order in which they are specified and should
1058 include the full path to the file.
1059 By default, the files specified are
1062 .Pa /etc/rc.conf.local
1063 .It Va fsck_y_enable
1068 will be run with the
1070 flag if the initial preen of the file systems fails.
1073 List of file system types that are network-based.
1074 This list should generally not be modified by end users.
1076 .Va extra_netfs_types
1078 .It Va extra_netfs_types
1080 If set to something other than
1082 (the default), this variable extends the list of file system types
1083 for which automatic mounting at startup by
1085 should be delayed until the network is initialized.
1087 a whitespace-separated list of network file system descriptor pairs,
1088 each consisting of a file system type as passed to
1090 and a human-readable, one-word description, joined with a colon
1092 Extending the default list in this way is only necessary
1093 when third party file system types are used.
1094 .It Va devfs_config_files
1096 This option is used to specify a list of configuration files containing
1098 rules that will be applied by
1100 in the order in which they are specified and must include the full path
1102 .It Va syslogd_enable
1109 .It Va syslogd_program
1114 .Pa /usr/sbin/syslogd ) .
1115 .It Va syslogd_flags
1121 these are the flags to pass to
1130 .It Va inetd_program
1135 .Pa /usr/sbin/inetd ) .
1142 these are the flags to pass to
1150 daemon at boot time.
1157 these are the flags to pass to it.
1164 daemon at boot time.
1171 these are the flags to pass to it.
1174 manpage for more information.
1175 .It Va amd_map_program
1177 If set, the specified program is run to get the list of
1182 maps are stored in NIS, one can set this to run
1194 will be updated at boot time to reflect the kernel release being run.
1198 will not be updated.
1199 .It Va nfs_client_enable
1203 setup NFS client parameters at boot time.
1204 .It Va nfs_access_cache
1207 .Va nfs_client_enable
1212 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1213 NFS ACCESS results should be cached.
1214 A value of 2-10 seconds will substantially reduce network traffic for
1215 many NFS operations.
1216 The default is 5 seconds.
1217 Note that the attribute cache holds stat information only.
1218 The NFS data cache is independent of the attribute cache and is only
1219 invalidated when the client detects that the server has modified the
1221 This value specifies a maximum timeout.
1222 The NFS client will automatically use a shorter timeout for files which
1223 have been recently modified.
1224 .It Va nfs_neg_cache
1227 .Va nfs_client_enable
1232 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1233 filenames), or to the number of seconds for which negative lookups should
1235 A value of 2-10 seconds will substantially reduce network
1236 traffic for many NFS operations, especially source code builds.
1237 The default is 3 seconds.
1238 .It Va nfs_server_enable
1242 run the NFS server daemons at boot time.
1243 .It Va nfs_server_flags
1246 .Va nfs_server_enable
1249 these are the flags to pass to the
1252 .It Va mountd_enable
1257 .Va nfs_server_enable
1263 It is commonly needed to run CFS without real NFS used.
1270 these are the flags to pass to the
1273 .It Va weak_mountd_authentication
1277 allow services like PCNFSD to make non-privileged mount requests.
1278 .It Va nfs_reserved_port_only
1282 provide NFS services only on a secure port.
1283 .It Va nfs_bufpackets
1285 If set to a number, indicates the number of packets worth of
1286 socket buffer space to reserve on an NFS client.
1287 The kernel default is typically 4.
1288 Using a higher number may be useful on gigabit networks to improve performance.
1289 The minimum value is 2 and the maximum is 64.
1290 .It Va rpc_umntall_enable
1294 (default) and we are also an NFS client, run
1296 at boot time to clear out old mounts on remote servers.
1301 will not be run at boot time.
1302 .It Va rpc_lockd_enable
1306 and also an NFS server, run
1309 .It Va rpc_lockd_flags
1312 .Va rpc_lockd_enable
1315 these are the flags to pass to
1317 .It Va rpc_statd_enable
1321 and also an NFS server, run
1324 .It Va rpc_statd_flags
1327 .Va rpc_statd_enable
1330 these are the flags to pass to
1332 .It Va rpcbind_program
1334 Path to program for rpcbind daemon
1336 .Pa /usr/sbin/rpcbind ) .
1337 .It Va rpcbind_enable
1344 .It Va rpcbind_flags
1350 these are the flags to pass to
1351 .Va rpcbind_program .
1352 .It Va keyserv_enable
1358 daemon on boot for running Secure RPC.
1359 .It Va keyserv_flags
1365 these are the flags to pass to
1368 .It Va pppoed_enable
1374 daemon at boot time to provide PPP over Ethernet services.
1375 .It Va pppoed_provider
1378 listens to requests to this provider and ultimately runs
1382 argument of the same name.
1385 Additional flags to pass to
1387 .It Va pppoed_interface
1389 The network interface to run
1392 This is mandatory when
1402 service at boot time.
1403 This command is intended for networks of machines where a consistent
1405 for all hosts must be established.
1406 This is often useful in large NFS environments where time stamps on
1407 files are expected to be consistent network-wide.
1414 these are the flags to pass to the
1423 at system boot time.
1424 .It Va dntpd_program
1429 .Pa /usr/sbin/dntpd ) .
1436 these are the flags to pass to the
1439 .It Va btconfig_enable
1443 configure Bluetooth devices via
1445 at system boot time.
1446 .It Va btconfig_devices
1452 this is the list of Bluetooth devices to configure.
1454 .Va btconfig_devices
1455 is not specified, all devices known to the system will be configured.
1457 .Va btconfig_ Ns Aq Ar device
1458 variable can be set to specify parameters to be passed to
1460 .It Va btconfig_args
1466 this is the list of configuration parameters to pass to all Bluetooth
1472 run the Service Discovery Profile daemon
1474 at system boot time.
1481 these are the flags to pass to the
1484 .It Va bthcid_enable
1488 run the Bluetooth Link Key/PIN Code Manager daemon
1490 at system boot time.
1497 these are the flags to pass to the
1500 .It Va nis_client_enable
1506 service at system boot time.
1507 .It Va nis_client_flags
1510 .Va nis_client_enable
1513 these are the flags to pass to the
1516 .It Va nis_ypset_enable
1522 daemon at system boot time.
1523 .It Va nis_ypset_flags
1526 .Va nis_ypset_enable
1529 these are the flags to pass to the
1532 .It Va nis_server_enable
1538 daemon at system boot time.
1539 .It Va nis_server_flags
1542 .Va nis_server_enable
1545 these are the flags to pass to the
1548 .It Va nis_ypxfrd_enable
1554 daemon at system boot time.
1555 .It Va nis_ypxfrd_flags
1558 .Va nis_ypxfrd_enable
1561 these are the flags to pass to the
1564 .It Va nis_yppasswdd_enable
1570 daemon at system boot time.
1571 .It Va nis_yppasswdd_flags
1574 .Va nis_yppasswdd_enable
1577 these are the flags to pass to the
1580 .It Va rpc_ypupdated_enable
1586 daemon at system boot time.
1587 .It Va defaultrouter
1591 create a default route to this host name or IP address
1592 (use an IP address if this router is also required to get to the
1594 .It Va ipv6_defaultrouter
1596 The IPv6 equivalent of
1598 .It Va static_routes
1600 Set to the list of static routes that are to be added at system boot time.
1603 then for each whitespace separated
1606 .Va route_ Ns Aq Ar element
1607 variable is assumed to exist whose contents will later be passed to a
1610 .It Va ipv6_static_routes
1612 The IPv6 equivalent of
1616 then for each whitespace separated
1619 .Va ipv6_route_ Ns Aq Ar element
1620 variable is assumed to exist whose contents will later be passed to a
1621 .Dq Nm route Cm add Fl inet6
1623 .It Va gateway_enable
1627 configure host to act as an IP router, e.g. to forward packets
1629 .It Va ipv6_gateway_enable
1631 The IPv6 equivalent of
1632 .Va gateway_enable .
1633 .It Va router_enable
1637 run a routing daemon of some sort, based on the settings of
1641 .It Va ipv6_router_enable
1643 The IPv6 equivalent of
1647 run a routing daemon of some sort, based on the settings of
1648 .Va ipv6_router_program
1650 .Va ipv6_router_flags .
1651 .It Va router_program
1657 this is the name of the routing daemon to use
1659 .Pa /sbin/routed ) .
1660 .It Va ipv6_router_program
1662 The IPv6 equivalent of
1665 .Pa /sbin/route6d ) .
1672 these are the flags to pass to the routing daemon.
1673 .It Va ipv6_router_flags
1675 The IPv6 equivalent of
1677 .It Va mrouted_enable
1681 run the multicast routing daemon,
1683 .It Va mroute6d_enable
1685 The IPv6 equivalent of
1686 .Va mrouted_enable .
1689 run the IPv6 multicast routing daemon.
1690 Note that no IPv6 multicast routing daemon is included in the
1694 can be installed from the
1697 .It Va mrouted_flags
1703 these are the flags to pass to the
1706 .It Va mroute6d_flags
1708 The IPv6 equivalent of
1714 these are the flags passed to the IPv6 multicast routing daemon.
1715 .It Va mroute6d_program
1721 this is the path to the IPv6 multicast routing daemon.
1722 .It Va rtadvd_enable
1728 daemon at boot time.
1731 .Va ipv6_gateway_enable
1736 utility sends router advertisement packets to the interfaces specified in
1737 .Va rtadvd_interfaces .
1739 and should only be enabled with great care.
1740 You may want to fine-tune
1742 .It Va rtadvd_interfaces
1748 this is the list of interfaces to use.
1749 .It Va rtsold_enable
1755 daemon at boot time.
1758 daemon is used for automatic discovery of non-link local addresses.
1765 these are the flags to pass to the
1768 .It Va ipxgateway_enable
1772 enable the routing of IPX traffic.
1773 .It Va ipxrouted_enable
1779 daemon at system boot time.
1780 .It Va ipxrouted_flags
1783 .Va ipxrouted_enable
1786 these are the flags to pass to the
1793 enable global proxy ARP.
1794 .It Va forward_sourceroute
1802 source-routed packets are forwarded.
1803 .It Va accept_sourceroute
1807 the system will accept source-routed packets directed at it.
1814 daemon at system boot time.
1821 these are the flags to pass to the
1824 .It Va bootparamd_enable
1830 daemon at system boot time.
1831 .It Va bootparamd_flags
1834 .Va bootparamd_enable
1837 these are the flags to pass to the
1840 .It Va stf_interface_ipv4addr
1844 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1845 Specify this entry to enable the 6to4 interface.
1846 .It Va stf_interface_ipv4plen
1848 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1849 An effective value is 0-31.
1850 .It Va stf_interface_ipv6_ifid
1852 IPv6 interface ID for
1856 .It Va stf_interface_ipv6_slaid
1858 IPv6 Site Level Aggregator for
1860 .It Va ipv6_faith_prefix
1864 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1868 .It Va ipv6_ipv4mapping
1872 this enables IPv4 mapped IPv6 address communication (like
1873 .Li ::ffff:a.b.c.d ) .
1878 to enable the configuration of ATM interfaces at system boot time.
1879 For all of the ATM variables described below, please refer to the
1881 man page for further details on the available command parameters.
1882 Also refer to the files in
1883 .Pa /usr/share/examples/atm
1884 for more detailed configuration information.
1885 .It Va atm_netif_ Ns Aq Ar intf
1887 For the ATM physical interface
1889 this variable defines the name prefix and count for the ATM network
1890 interfaces to be created.
1891 The value will be passed as the parameters of an
1892 .Dq Nm atm Cm "set netif" Ar intf
1894 .It Va atm_sigmgr_ Ns Aq Ar intf
1896 For the ATM physical interface
1898 this variable defines the ATM signalling manager to be used.
1899 The value will be passed as the parameters of an
1900 .Dq Nm atm Cm attach Ar intf
1902 .It Va atm_prefix_ Ns Aq Ar intf
1904 For the ATM physical interface
1906 this variable defines the NSAP prefix for interfaces using a UNI signalling
1910 the prefix will automatically be set via the
1913 Otherwise, the value will be passed as the parameters of an
1914 .Dq Nm atm Cm "set prefix" Ar intf
1916 .It Va atm_macaddr_ Ns Aq Ar intf
1918 For the ATM physical interface
1920 this variable defines the MAC address for interfaces using a UNI signalling
1924 the hardware MAC address contained in the ATM interface card will be used.
1925 Otherwise, the value will be passed as the parameters of an
1926 .Dq Nm atm Cm "set mac" Ar intf
1928 .It Va atm_arpserver_ Ns Aq Ar netif
1930 For the ATM network interface
1932 this variable defines the ATM address for a host which is to provide ATMARP
1934 This variable is only applicable to interfaces using a UNI signalling manager.
1937 this host will become an ATMARP server.
1938 The value will be passed as the parameters of an
1939 .Dq Nm atm Cm "set arpserver" Ar netif
1941 .It Va atm_scsparp_ Ns Aq Ar netif
1945 SCSP/ATMARP service for the network interface
1947 will be initiated using the
1952 This variable is only applicable if
1953 .Va atm_arpserver_ Ns Aq Ar netif
1958 Set to the list of permanent ATM ARP entries to be added at system boot time.
1959 For each whitespace separated
1962 .Va atm_arp_ Ns Aq Ar element
1963 variable is assumed to exist.
1964 The value of each of these variables will be passed as the parameters of an
1965 .Dq Nm atm Cm "add arp"
1969 The keyboard bell sound.
1976 if the default behavior is desired.
1977 For details, refer to the
1984 no keymap is installed, otherwise the value is used to install
1986 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1989 The keyboard repeat speed.
1996 if the default behavior is desired.
2001 attempt to program the function keys with the value.
2002 The value should be a single string of the form:
2003 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2006 Can be set to the value of
2009 .Dq Li destructive ,
2012 to set the cursor behavior explicitly or choose the default behavior.
2017 no screen map is installed, otherwise the value is used to install
2018 the screen map file in
2019 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2024 the default 8x16 font value is used for screen size requests, otherwise
2026 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2032 the default 8x14 font value is used for screen size requests, otherwise
2034 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2040 the default 8x8 font value is used for screen size requests, otherwise
2042 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2048 the default screen blanking interval is used, otherwise it is set to
2055 this is the actual screen saver to use
2056 .Li ( blank , snake , daemon ,
2058 .It Va moused_enable
2064 daemon is started for doing cut/paste selection on the console.
2067 This is the protocol type of the mouse connected to this host.
2068 This variable must be set if
2075 is able to detect the appropriate mouse type automatically in many cases.
2076 Set this variable to
2078 to let the daemon detect it, or
2079 select one from the following list if the automatic detection fails.
2081 If the mouse is attached to the PS/2 mouse port, choose
2085 regardless of the brand and model of the mouse.
2086 Likewise, if the mouse is attached to the bus mouse port, choose
2090 All other protocols are for serial mice and will not work with
2091 the PS/2 and bus mice.
2092 If this is a USB mouse,
2094 is the only protocol type which will work.
2096 .Bl -tag -width ".Li x10mouseremote" -compact
2098 Microsoft mouse (serial)
2100 Microsoft IntelliMouse (serial)
2102 Mouse systems Corp. mouse (serial)
2104 MM Series mouse (serial)
2106 Logitech mouse (serial)
2110 Logitech MouseMan and TrackMan (serial)
2112 ALPS GlidePoint (serial)
2113 .It Li thinkingmouse
2114 Kensington ThinkingMouse (serial)
2118 MM HitTablet (serial)
2119 .It Li x10mouseremote
2120 X10 MouseRemote (serial)
2122 Interlink VersaPad (serial)
2125 Even if the mouse is not in the above list, it may be compatible
2126 with one in the list.
2127 Refer to the man page for
2129 for compatibility information.
2131 It should also be noted that while this is enabled, any
2132 other client of the mouse (such as an X server) should access
2133 the mouse through the virtual mouse device,
2135 and configure it as a
2137 type mouse, since all
2138 mouse data is converted to this single canonical format when using
2140 If the client program does not support the
2145 It is the second preferred type.
2152 this is the actual port the mouse is on.
2155 for a COM1 serial mouse,
2159 for a bus mouse, for example.
2164 is set, these are the additional flags to pass to the
2167 .It Va mousechar_start
2171 the default mouse cursor character range
2172 .Li 0xd0 Ns - Ns Li 0xd3
2173 is used, otherwise the range start is set to
2177 Use if the default range is occupied in the language code table.
2180 Set the size of the history (scrollback) buffer in lines.
2181 .It Va allscreens_flags
2185 is run with these options for each of the virtual terminals
2189 will enable the mouse pointer on all virtual terminals if
2193 .It Va allscreens_kbdflags
2197 is run with these options for each of the virtual terminals
2203 scrollback (history) buffer to 200 lines.
2210 daemon at system boot time.
2216 .Pa /usr/sbin/cron ) .
2223 these are the flags to pass to
2230 .Pa /usr/sbin/lpd ) .
2237 daemon at system boot time.
2244 these are the flags to pass to the
2253 daemon at system boot time.
2260 settings across reboots.
2261 .It Va mta_start_script
2263 The full path to the script to run to start
2264 a mail transfer agent.
2266 .Pa /etc/rc.sendmail .
2270 .Pa /etc/rc.sendmail
2271 uses are documented in the
2277 .Sq HAMMER ROOT with UFS /boot
2278 setup, the boot loader will not set up the
2281 The system will attempt to fix this on its own.
2282 Set this variable to
2284 to turn this behavior off.
2287 Indicates the device (usually a swap partition) to which a crash dump
2288 should be written in the event of a system crash.
2289 The value of this variable is passed as the argument to
2293 To disable crash dumps, set this variable to
2297 When the system reboots after a crash and a crash dump is found on the
2298 device specified by the
2302 will save that crash dump and a copy of the kernel to the directory
2306 The default value is
2315 .It Va savecore_flags
2317 If crash dumps are enabled, these are the flags to pass to the
2320 .It Va crashinfo_enable
2324 to turn on automatic crash dump summary generation using the utility
2326 .Va crashinfo_program
2328 .It Va crashinfo_program
2330 Program to run to generate a crash dump summary if the variable
2331 .Va crashinfo_enable
2334 The default value is
2335 .Pa /usr/sbin/crashinfo .
2336 .It Va enable_quotas
2340 to turn on user disk quotas on system startup via the
2347 to enable user disk quota checking via the
2350 .It Va accounting_enable
2354 to enable system accounting through the
2361 to enable Linux/ELF binary emulation at system initial boot time.
2362 .It Va sysvipc_enable
2366 load System V IPC primitives at boot time.
2367 .\" ----- cleanvar_enable setting--------------------------------
2368 .It Va cleanvar_enable
2376 .Pa /var/spool/uucp/.Temp/*
2378 .\" ----- clear_tmp_enable setting-------------------------------
2379 .It Va clear_tmp_enable
2386 .\" ----- ldconfig_paths setting --------------------------------
2387 .It Va ldconfig_paths
2389 Set to the list of shared library paths to use with
2393 will always be added first, so it need not appear in this list.
2394 .It Va ldconfig_insecure
2398 utility normally refuses to use directories
2399 which are writable by anyone except root.
2400 Set this variable to
2402 to disable that security check during system startup.
2403 .It Va kern_securelevel
2405 The kernel security level to set at startup.
2406 The allowed range of
2408 ranges from \-1 (the compile time default) to 3 (the most secure).
2411 for the list of possible security levels and their effect on system operation.
2418 at system boot time.
2425 at system boot time.
2428 Path to the SSH server program
2430 .Pa /usr/sbin/sshd ) .
2437 these are the flags to pass to the
2446 at system boot time.
2453 these are the flags to pass to the
2462 daemon at boot time.
2469 these are the flags passed to
2472 .It Va watchdogd_enable
2478 daemon at boot time.
2479 This requires that the kernel have been compiled with
2480 .Cd "options WATCHDOG" .
2485 any configured jails will not be started.
2488 A space separated list of names for jails.
2489 This is purely a configuration aid to help identify and
2490 configure multiple jails.
2491 The names specified in this list will be used to
2492 identify settings common to an instance of a jail.
2493 Assuming that the jail in question was named
2495 you would have the following dependent variables:
2497 jail_vjail_hostname="jail.example.com"
2498 jail_vjail_ip="192.168.1.100"
2499 jail_vjail_rootdir="/var/jails/vjail/root"
2505 When set, use as default value for
2506 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2509 .It Va jail_interface
2512 When set, use as default value for
2513 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2519 When set, use as default value for
2520 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2523 .It Va jail_mount_enable
2531 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2534 by default for every jail in
2536 .It Va jail_fdesc_enable
2544 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2547 by default for every jail in
2549 .It Va jail_procfs_enable
2557 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2560 by default for every jail in
2562 .It Va jail_exec_start
2565 When set, use as default value for
2566 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2569 .It Va jail_exec_stop
2571 When set, use as default value for
2572 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2575 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2578 Set to the root directory used by jail
2580 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2583 Set to the fully qualified domain name (FQDN) assigned to jail
2585 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2588 Set to the IP address assigned to jail
2590 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2595 These are flags to pass to
2597 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2600 When set, sets the interface to use when setting IP address alias.
2601 Note that the alias is created at jail startup and removed at jail shutdown.
2602 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2605 .Pa /etc/fstab. Ns Aq Ar jname
2607 This is the file system information file to use for jail
2609 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2616 mount all file systems from
2617 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2619 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2626 mount the file-descriptor file system inside jail
2629 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2636 mount the process file system inside jail
2639 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2642 .Dq Li /bin/sh /etc/rc
2644 This is the command executed at jail startup.
2645 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2648 .Dq Li /bin/sh /etc/rc.shutdown
2650 This is the command executed at jail shutdown.
2651 .It Va jail_set_hostname_allow
2655 do not allow the root user in a jail to set its hostname.
2656 .It Va jail_socket_unixiproute_only
2660 do not allow any sockets,
2661 besides UNIX/IP/route sockets,
2662 to be used within a jail.
2663 .It Va jail_sysvipc_allow
2667 allow applications within a jail to use System V IPC.
2672 LVM volumes will be discovered and configured on boot.
2673 .It Va newsyslog_enable
2679 before syslogd starts.
2680 .It Va newsyslog_flags
2683 .Va newsyslog_enable
2686 these are the flags passed to
2688 .It Va resident_enable
2692 make the dynamic binaries listed in
2693 .Pa /etc/resident.conf
2695 .It Va varsym_enable
2700 .Pa /etc/varsym.conf
2701 to set system-wide variables for variant symlinks.
2706 or a whitespace separated list of IRQ numbers which will be used as a source of
2708 .\" ----- isdn settings ---------------------------------
2718 daemon at system boot time.
2722 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2724 Additional flags to pass to
2730 for certain tunable parameters).
2736 The terminal type of the output device when
2738 operates in full-screen mode.
2739 .It Va isdn_screenflags
2744 The video mode for full-screen mode (only for
2754 The output device for
2756 in full-screen mode (or
2766 enables the ISDN protocol trace utility
2768 at system boot time.
2769 .It Va isdn_traceflags
2772 .Dq Fl f Pa /var/tmp/isdntrace0
2776 .\" -----------------------------------------------------
2781 to disable caching entropy via
2783 Otherwise set to the directory used to store entropy files in.
2788 to disable caching entropy through reboots.
2789 Otherwise set to the filename used to store cached entropy through reboots.
2790 This file should be located on the root file system to seed the
2792 device as early as possible in the boot process.
2804 Configuration file for
2813 .Pa /var/run/dmesg.boot
2815 .It Va rcshutdown_timeout
2817 If set, start a watchdog timer in the background which will terminate
2821 has not completed within the specified time (in seconds).
2826 the udevd daemon will be started on boot.
2827 .It Va vkernel_enable
2831 any configured vkernels will not be started.
2834 A space separated list of names for vkernels.
2835 This is purely a configuration aid to help identify and
2836 configure multiple vkernels.
2837 The names specified in this list will be used to
2838 identify settings common to a vkernel instance.
2839 Assuming that the vkernel in question was named
2841 you would have the following dependent variables
2842 (filled with reference values in this text):
2844 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2845 vkernel_example_memsize="64m"
2846 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2847 vkernel_example_iface_list="auto:bridge0"
2848 vkernel_example_logfile="/dev/null"
2849 vkernel_example_flags="-U"
2852 The last three are optional.
2853 They default to an empty string if not set, except for logfile which defaults to
2858 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2859 .It Pa /etc/defaults/rc.conf
2861 .It Pa /etc/rc.conf.local
2862 .It Pa /etc/start_if. Ns Aq Ar interface
2880 .Xr resident.conf 5 ,
2943 .An Jordan K. Hubbard .