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 to handle device added, removed or unknown events from the kernel.
151 these are the flags to pass to the
163 a CPU speed control daemon.
164 .It Va sensorsd_enable
173 a sensors monitoring and logging daemon.
174 .It Va sensorsd_flags
177 Additional flags passed to the
180 .It Va sysvipcd_enable
189 a daemon needed for the userspace implementation of the XSI Interprocess
190 Communication functions.
191 .It Va sysvipcd_flags
194 Additional flags passed to the
197 .It Va hotplugd_enable
206 a devices hot plugging monitoring daemon.
207 .It Va hotplugd_flags
210 Additional flags passed to the
213 .It Va pccard_ifconfig
215 List of arguments to be passed to
217 at boot time or on insertion of the card (e.g.\&
218 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
219 for a fixed address or
222 .It Va pccard_ether_delay
224 Set the delay before starting
227 .Pa /etc/pccard_ether
229 This defaults to 5 seconds to work around a bug in the
231 driver which can lead to system hangs when using some newer
234 .It Va removable_interfaces
236 List of removable network interfaces to be supported by
237 .Pa /etc/pccard_ether .
240 List of directories to search for startup script files.
241 .It Va script_name_sep
243 The field separator to use for breaking down the list of startup script files
244 into individual filenames.
245 The default is a space.
246 It is not necessary to change this unless there are startup scripts with names
248 .It Va hostapd_enable
257 The fully qualified domain name (FQDN) of this host on the network.
258 This should almost certainly be set to something meaningful, even if
259 there is no network connection.
262 is used to set the hostname via DHCP,
263 this variable should be set to an empty string.
266 Enable support for IPv6 networking.
267 Note that this requires that the kernel have been compiled with
268 .Cd "options INET6" .
271 The NIS domain name of this host, or
274 .It Va dhclient_program
276 Path to the DHCP client program
278 .Pa /sbin/dhclient ) .
279 .It Va dhclient_flags
281 Additional flags to pass to the DHCP client program.
289 If the kernel was not built with
293 kernel module will be loaded.
295 .Va firewall_enable .
300 ruleset definition file.
311 these are the flags to pass to
313 when loading the ruleset.
320 which logs packets from
328 this specifies the path of the log file.
339 these are the flags to pass to
341 .It Va firewall_enable
345 to load firewall rules at startup.
346 If the kernel was not built with
347 .Cd "options IPFIREWALL" ,
350 kernel module will be loaded.
353 .It Va ipv6_firewall_enable
355 The IPv6 equivalent of
356 .Va firewall_enable .
359 to load IPv6 firewall rules at startup.
360 If the kernel was not built with
361 .Cd "options IPV6FIREWALL" ,
364 kernel module will be loaded.
365 .It Va firewall_script
367 The full path to the firewall script to run
369 .Pa /etc/rc.firewall ) .
370 .It Va ipv6_firewall_script
372 The IPv6 equivalent of
373 .Va firewall_script .
376 Names the firewall type from the selection in
377 .Pa /etc/rc.firewall ,
378 or the file which contains the local firewall ruleset.
379 Valid selections from
383 .Bl -tag -width ".Li simple" -compact
385 unrestricted IP access
387 all IP services disabled, except via
390 basic protection for a workstation on a LAN
396 If a filename is specified, the full path must be given.
397 .It Va firewall_trusted_nets
399 List of trusted networks (if
403 .It Va firewall_trusted_interfaces
405 List of trusted network interfaces (if
409 .It Va firewall_allowed_icmp_types
411 List of allowed ICMP types (if
415 .It Va firewall_open_tcp_ports
417 List of TCP ports to open (if
421 .It Va firewall_open_udp_ports
423 List of UDP ports to open (if
427 .It Va ipv6_firewall_type
429 The IPv6 equivalent of
431 .It Va firewall_quiet
435 to disable the display of firewall rules on the console during boot.
436 .It Va ipv6_firewall_quiet
438 The IPv6 equivalent of
440 .It Va firewall_logging
444 to enable firewall event logging.
445 This is equivalent to the
446 .Dv IPFIREWALL_VERBOSE
448 .It Va ipv6_firewall_logging
450 The IPv6 equivalent of
451 .Va firewall_logging .
452 .It Va firewall_flags
458 specifies a filename.
459 .It Va ipv6_firewall_flags
461 The IPv6 equivalent of
478 sockets must be enabled in the kernel.
479 .It Va natd_interface
481 This is the name of the public interface on which
484 The interface may be given as an interface name or as an IP address.
489 flags should be placed here.
494 flag is automatically added with the above
497 .It Va tcp_extensions
504 disables certain TCP options as described by
510 might help remedy such problems with connections as randomly hanging
511 or other weird behavior.
512 Some network devices are known to be broken with respect to these options.
519 .Va net.inet.tcp.log_in_vain
521 .Va net.inet.udp.log_in_vain ,
526 are set to the given value.
534 will disable probing idle TCP connections to verify that the
535 peer is still up and reachable.
536 .It Va tcp_drop_synfin
543 will cause the kernel to ignore TCP frames that have both
544 the SYN and FIN flags set.
545 This prevents OS fingerprinting, but may break some legitimate applications.
546 This option is only available if the kernel was built with the
549 .It Va icmp_drop_redirect
556 will cause the kernel to ignore ICMP REDIRECT packets.
559 for more information.
560 .It Va icmp_log_redirect
567 will cause the kernel to log ICMP REDIRECT packets.
569 the log messages are not rate-limited, so this option should only be used
570 for troubleshooting networks.
573 for more information.
574 .It Va icmp_bmcastecho
578 to respond to broadcast or multicast ICMP ping packets.
581 for more information.
582 .It Va ip_portrange_first
586 this is the first port in the default portrange.
589 for more information.
590 .It Va ip_portrange_last
594 this is the last port in the default portrange.
597 for more information.
599 .It Va ifconfig_ Ns Aq Ar interface
603 Typically includes IP address.
604 Assuming that the interface in question was
606 it might look something like this:
608 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
612 .Pa /etc/start_if. Ns Aq Ar interface
613 file is present, it is read and executed by the
615 interpreter before configuring the interface as specified in the
616 .Va ifconfig_ Ns Aq Ar interface
618 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
621 It is possible to bring up an interface with DHCP by adding
624 .Va ifconfig_ Ns Aq Ar interface
626 For instance, to initialize the
628 device via DHCP, it is possible to use something like:
634 .Va vlans_ Ns Aq Ar interface
638 interface will be created for each item in the list with the
642 If a vlan interface's name is a number,
643 then that number is used as the vlan tag and the new vlan interface is
645 .Ar interface . Ns Ar tag .
647 the vlan tag must be specified via a
650 .Va create_args_ Ns Aq Ar interface
653 To create a vlan device named
657 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
660 ifconfig_em0_101="inet 192.0.2.1/24"
663 To create a vlan device named
667 with the vlan tag 102:
670 create_args_myvlan="vlan 102"
674 .Va wlans_ Ns Aq Ar interface
678 interface will be created for each item in the list with the
682 Further wlan cloning arguments may be passed to the
685 command by setting the
686 .Va create_args_ Ns Aq Ar interface
690 devices must be created for each wireless devices as of
696 may be specified with an
697 .Va wlandebug_ Ns Aq Ar interface
699 The contents of this variable will be passed directly to
702 Also, if your interface needs WPA authentication, it is possible to add
705 .Va ifconfig_ Ns Aq Ar interface
708 .Xr wpa_supplicant 8 .
710 .Xr wpa_supplicant.conf 5
711 for configuring authentication information.
715 options in this variable, in addition to the
716 .Pa /etc/start_if. Ns Aq Ar interface
718 For instance, to initialize the
720 device via DHCP, using WPA authentication and 802.11b mode, it is
721 possible to use something like:
724 ifconfig_wlan0="up DHCP WPA mode 11b"
726 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
728 Configuration to establish an additional network address for
730 Assuming that the interface in question was
732 it might look something like this:
734 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
735 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
740 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
741 entry that is found, its contents are passed to
743 Execution stops at the first unsuccessful access, so if
744 something like this is present:
746 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
747 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
748 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
749 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
752 Then note that alias4 would
754 be added since the search would stop with the missing alias3 entry.
755 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
759 It is possible to rename interface by doing:
761 ifconfig_ed0_name="net0"
762 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
764 .It Va network_interfaces
766 The list of network interfaces to configure on this host,
769 to configure all network interfaces
772 For example, if the only network devices to be configured are the loopback device
776 driver, this could be set to
779 .Va ifconfig_ Ns Aq Ar interface
780 variable is assumed to exist for each value of
782 .It Va ipv6_network_interfaces
784 This is the IPv6 equivalent of
785 .Va network_interfaces .
786 Instead of setting the ifconfig variables as
787 .Va ifconfig_ Ns Aq Ar interface
788 they should be set as
789 .Va ipv6_ifconfig_ Ns Aq Ar interface .
790 Aliases should be set as
791 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
792 Interfaces that do not have a
793 .Va ipv6_ifconfig_ Ns Aq Ar interface
794 setting will be auto configured by
797 .Va ipv6_gateway_enable
800 Note that the IPv6 networking code does not support the
801 .Pa /etc/start_if. Ns Aq Ar interface
803 .It Va ipv6_prefix_ Ns Aq Ar interface
807 prefixlen 64 is used.
808 .It Va ipv6_default_interface
812 this is the default output interface for scoped addresses.
813 Now this works only for IPv6 link local multicast addresses.
814 .It Va cloned_interfaces
816 Set to the list of clonable network interfaces to create on this host.
818 .Va cloned_interfaces
819 are automatically appended to
820 .Va network_interfaces
822 .It Va gif_interfaces
826 tunnel interfaces to configure on this host.
828 .Va gifconfig_ Ns Aq Ar interface
829 variable is assumed to exist for each value of
831 The value of this variable is used to configure the link layer of the
832 tunnel according to the syntax of the
836 Additionally, this option ensures that each listed interface is created via the
840 before attempting to configure it.
841 .It Va sppp_interfaces
845 interfaces to configure on this host.
847 .Va spppconfig_ Ns Aq Ar interface
848 variable is assumed to exist for each value of
850 Each interface should also be configured by a general
851 .Va ifconfig_ Ns Aq Ar interface
855 for more information about available options.
865 Mode in which to run the
874 See the manual for a full description.
879 enables network address translation.
880 Used in conjunction with
882 allows hosts on private network addresses access to the Internet using
883 this host as a network address translating router.
886 The name of the profile to use from
887 .Pa /etc/ppp/ppp.conf .
888 Also used for per-profile overrides of
889 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
890 Where the profile contains any of the characters
892 they are translated to
894 for the purposes of the override variable names.
895 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
897 Set the unit number to be used for this profile.
898 See the manual description of
905 The name of the user under which
914 This option is used to specify a list of files that will override
916 .Pa /etc/defaults/rc.conf .
917 The files will be read in the order in which they are specified and should
918 include the full path to the file.
919 By default, the files specified are
922 .Pa /etc/rc.conf.local
930 flag if the initial preen of the file systems fails.
933 List of file system types that are network-based.
934 This list should generally not be modified by end users.
936 .Va extra_netfs_types
938 .It Va extra_netfs_types
940 If set to something other than
942 (the default), this variable extends the list of file system types
943 for which automatic mounting at startup by
945 should be delayed until the network is initialized.
947 a whitespace-separated list of network file system descriptor pairs,
948 each consisting of a file system type as passed to
950 and a human-readable, one-word description, joined with a colon
952 Extending the default list in this way is only necessary
953 when third party file system types are used.
954 .It Va devfs_config_files
956 This option is used to specify a list of configuration files containing
958 rules that will be applied by
960 in the order in which they are specified and must include the full path
962 .It Va syslogd_enable
969 .It Va syslogd_program
974 .Pa /usr/sbin/syslogd ) .
981 these are the flags to pass to
995 .Pa /usr/sbin/inetd ) .
1002 these are the flags to pass to
1010 daemon at boot time.
1017 these are the flags to pass to it.
1024 daemon at boot time.
1031 these are the flags to pass to it.
1034 manpage for more information.
1035 .It Va amd_map_program
1037 If set, the specified program is run to get the list of
1042 maps are stored in NIS, one can set this to run
1054 will be updated at boot time to reflect the kernel release being run.
1058 will not be updated.
1059 .It Va nfs_client_enable
1063 setup NFS client parameters at boot time.
1064 .It Va nfs_access_cache
1067 .Va nfs_client_enable
1072 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1073 NFS ACCESS results should be cached.
1074 A value of 2-10 seconds will substantially reduce network traffic for
1075 many NFS operations.
1076 The default is 5 seconds.
1077 Note that the attribute cache holds stat information only.
1078 The NFS data cache is independent of the attribute cache and is only
1079 invalidated when the client detects that the server has modified the
1081 This value specifies a maximum timeout.
1082 The NFS client will automatically use a shorter timeout for files which
1083 have been recently modified.
1084 .It Va nfs_neg_cache
1087 .Va nfs_client_enable
1092 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1093 filenames), or to the number of seconds for which negative lookups should
1095 A value of 2-10 seconds will substantially reduce network
1096 traffic for many NFS operations, especially source code builds.
1097 The default is 3 seconds.
1098 .It Va nfs_server_enable
1102 run the NFS server daemons at boot time.
1103 .It Va nfs_server_flags
1106 .Va nfs_server_enable
1109 these are the flags to pass to the
1112 .It Va mountd_enable
1117 .Va nfs_server_enable
1123 It is commonly needed to run CFS without real NFS used.
1130 these are the flags to pass to the
1133 .It Va weak_mountd_authentication
1137 allow services like PCNFSD to make non-privileged mount requests.
1138 .It Va nfs_reserved_port_only
1142 provide NFS services only on a secure port.
1143 .It Va nfs_bufpackets
1145 If set to a number, indicates the number of packets worth of
1146 socket buffer space to reserve on an NFS client.
1147 The kernel default is typically 4.
1148 Using a higher number may be useful on gigabit networks to improve performance.
1149 The minimum value is 2 and the maximum is 64.
1150 .It Va rpc_umntall_enable
1154 (default) and we are also an NFS client, run
1156 at boot time to clear out old mounts on remote servers.
1161 will not be run at boot time.
1162 .It Va rpc_lockd_enable
1166 and also an NFS server, run
1169 .It Va rpc_lockd_flags
1172 .Va rpc_lockd_enable
1175 these are the flags to pass to
1177 .It Va rpc_statd_enable
1181 and also an NFS server, run
1184 .It Va rpc_statd_flags
1187 .Va rpc_statd_enable
1190 these are the flags to pass to
1192 .It Va rpcbind_program
1194 Path to program for rpcbind daemon
1196 .Pa /usr/sbin/rpcbind ) .
1197 .It Va rpcbind_enable
1204 .It Va rpcbind_flags
1210 these are the flags to pass to
1211 .Va rpcbind_program .
1212 .It Va keyserv_enable
1218 daemon on boot for running Secure RPC.
1219 .It Va keyserv_flags
1225 these are the flags to pass to
1228 .It Va pppoed_enable
1234 daemon at boot time to provide PPP over Ethernet services.
1235 .It Va pppoed_provider
1238 listens to requests to this provider and ultimately runs
1242 argument of the same name.
1245 Additional flags to pass to
1247 .It Va pppoed_interface
1249 The network interface to run
1252 This is mandatory when
1262 service at boot time.
1263 This command is intended for networks of machines where a consistent
1265 for all hosts must be established.
1266 This is often useful in large NFS environments where time stamps on
1267 files are expected to be consistent network-wide.
1274 these are the flags to pass to the
1283 at system boot time.
1284 .It Va dntpd_program
1289 .Pa /usr/sbin/dntpd ) .
1296 these are the flags to pass to the
1299 .It Va btconfig_enable
1303 configure Bluetooth devices via
1305 at system boot time.
1306 .It Va btconfig_devices
1312 this is the list of Bluetooth devices to configure.
1314 .Va btconfig_devices
1315 is not specified, all devices known to the system will be configured.
1317 .Va btconfig_ Ns Aq Ar device
1318 variable can be set to specify parameters to be passed to
1320 .It Va btconfig_args
1326 this is the list of configuration parameters to pass to all Bluetooth
1332 run the Service Discovery Profile daemon
1334 at system boot time.
1341 these are the flags to pass to the
1344 .It Va bthcid_enable
1348 run the Bluetooth Link Key/PIN Code Manager daemon
1350 at system boot time.
1357 these are the flags to pass to the
1360 .It Va nis_client_enable
1366 service at system boot time.
1367 .It Va nis_client_flags
1370 .Va nis_client_enable
1373 these are the flags to pass to the
1376 .It Va nis_ypset_enable
1382 daemon at system boot time.
1383 .It Va nis_ypset_flags
1386 .Va nis_ypset_enable
1389 these are the flags to pass to the
1392 .It Va nis_server_enable
1398 daemon at system boot time.
1399 .It Va nis_server_flags
1402 .Va nis_server_enable
1405 these are the flags to pass to the
1408 .It Va nis_ypxfrd_enable
1414 daemon at system boot time.
1415 .It Va nis_ypxfrd_flags
1418 .Va nis_ypxfrd_enable
1421 these are the flags to pass to the
1424 .It Va nis_yppasswdd_enable
1430 daemon at system boot time.
1431 .It Va nis_yppasswdd_flags
1434 .Va nis_yppasswdd_enable
1437 these are the flags to pass to the
1440 .It Va rpc_ypupdated_enable
1446 daemon at system boot time.
1447 .It Va defaultrouter
1451 create a default route to this host name or IP address
1452 (use an IP address if this router is also required to get to the
1454 .It Va ipv6_defaultrouter
1456 The IPv6 equivalent of
1458 .It Va static_routes
1460 Set to the list of static routes that are to be added at system boot time.
1463 then for each whitespace separated
1466 .Va route_ Ns Aq Ar element
1467 variable is assumed to exist whose contents will later be passed to a
1470 .It Va change_routes
1472 Set to the list of static routes that are to be changed at system boot time
1473 (such as those added by the kernel).
1476 then for each whitespace separated
1479 .Va change_route_ Ns Aq Ar element
1480 variable is assumed to exist whose contents will later be passed to a
1481 .Dq Nm route Cm change
1483 .It Va ipv6_static_routes
1485 The IPv6 equivalent of
1489 then for each whitespace separated
1492 .Va ipv6_route_ Ns Aq Ar element
1493 variable is assumed to exist whose contents will later be passed to a
1494 .Dq Nm route Cm add Fl inet6
1496 .It Va gateway_enable
1500 configure host to act as an IP router, e.g. to forward packets
1502 .It Va ipv6_gateway_enable
1504 The IPv6 equivalent of
1505 .Va gateway_enable .
1506 .It Va router_enable
1510 run a routing daemon of some sort, based on the settings of
1514 .It Va ipv6_router_enable
1516 The IPv6 equivalent of
1520 run a routing daemon of some sort, based on the settings of
1521 .Va ipv6_router_program
1523 .Va ipv6_router_flags .
1524 .It Va router_program
1530 this is the name of the routing daemon to use
1532 .Pa /sbin/routed ) .
1533 .It Va ipv6_router_program
1535 The IPv6 equivalent of
1538 .Pa /sbin/route6d ) .
1545 these are the flags to pass to the routing daemon.
1546 .It Va ipv6_router_flags
1548 The IPv6 equivalent of
1550 .It Va mrouted_enable
1554 run the multicast routing daemon,
1556 .It Va mroute6d_enable
1558 The IPv6 equivalent of
1559 .Va mrouted_enable .
1562 run the IPv6 multicast routing daemon.
1563 Note that no IPv6 multicast routing daemon is included in the
1567 can be installed from the
1570 .Pa ( net/mcast-tools ) .
1571 .It Va mrouted_flags
1577 these are the flags to pass to the
1580 .It Va mroute6d_flags
1582 The IPv6 equivalent of
1588 these are the flags passed to the IPv6 multicast routing daemon.
1589 .It Va mroute6d_program
1595 this is the path to the IPv6 multicast routing daemon.
1596 .It Va rtadvd_enable
1602 daemon at boot time.
1605 .Va ipv6_gateway_enable
1610 utility sends router advertisement packets to the interfaces specified in
1611 .Va rtadvd_interfaces .
1613 and should only be enabled with great care.
1614 You may want to fine-tune
1616 .It Va rtadvd_interfaces
1622 this is the list of interfaces to use.
1623 .It Va rtsold_enable
1629 daemon at boot time.
1632 daemon is used for automatic discovery of non-link local addresses.
1639 these are the flags to pass to the
1646 enable global proxy ARP.
1647 .It Va forward_sourceroute
1655 source-routed packets are forwarded.
1656 .It Va accept_sourceroute
1660 the system will accept source-routed packets directed at it.
1667 daemon at system boot time.
1674 these are the flags to pass to the
1677 .It Va bootparamd_enable
1683 daemon at system boot time.
1684 .It Va bootparamd_flags
1687 .Va bootparamd_enable
1690 these are the flags to pass to the
1693 .It Va stf_interface_ipv4addr
1697 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1698 Specify this entry to enable the 6to4 interface.
1699 .It Va stf_interface_ipv4plen
1701 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1702 An effective value is 0-31.
1703 .It Va stf_interface_ipv6_ifid
1705 IPv6 interface ID for
1709 .It Va stf_interface_ipv6_slaid
1711 IPv6 Site Level Aggregator for
1713 .It Va ipv6_faith_prefix
1717 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1723 The keyboard bell sound.
1730 if the default behavior is desired.
1731 For details, refer to the
1738 no keymap is installed, otherwise the value is used to install
1740 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1743 The keyboard repeat speed.
1750 if the default behavior is desired.
1755 attempt to program the function keys with the value.
1756 The value should be a single string of the form:
1757 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1760 Can be set to the value of
1763 .Dq Li destructive ,
1766 to set the cursor behavior explicitly or choose the default behavior.
1771 no screen map is installed, otherwise the value is used to install
1772 the screen map file in
1773 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1778 the default 8x16 font value is used for screen size requests, otherwise
1780 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1786 the default 8x14 font value is used for screen size requests, otherwise
1788 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1794 the default 8x8 font value is used for screen size requests, otherwise
1796 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1802 the default screen blanking interval is used, otherwise it is set to
1809 this is the actual screen saver to use
1810 .Li ( blank , snake , daemon ,
1812 .It Va moused_nondefault_enable
1816 the mouse device specified on
1817 the command line is not automatically treated as enabled by the
1818 .Pa /etc/rc.d/moused
1820 Having this variable set to
1826 to be enabled as soon as it is plugged in.
1827 .It Va moused_enable
1833 daemon is started for doing cut/paste selection on the console.
1836 This is the protocol type of the mouse connected to this host.
1837 This variable must be set if
1844 is able to detect the appropriate mouse type automatically in many cases.
1845 Set this variable to
1847 to let the daemon detect it, or
1848 select one from the following list if the automatic detection fails.
1850 If the mouse is attached to the PS/2 mouse port, choose
1854 regardless of the brand and model of the mouse.
1855 Likewise, if the mouse is attached to the bus mouse port, choose
1859 All other protocols are for serial mice and will not work with
1860 the PS/2 and bus mice.
1861 If this is a USB mouse,
1863 is the only protocol type which will work.
1865 .Bl -tag -width ".Li x10mouseremote" -compact
1867 Microsoft mouse (serial)
1869 Microsoft IntelliMouse (serial)
1871 Mouse systems Corp. mouse (serial)
1873 MM Series mouse (serial)
1875 Logitech mouse (serial)
1879 Logitech MouseMan and TrackMan (serial)
1881 ALPS GlidePoint (serial)
1882 .It Li thinkingmouse
1883 Kensington ThinkingMouse (serial)
1887 MM HitTablet (serial)
1888 .It Li x10mouseremote
1889 X10 MouseRemote (serial)
1891 Interlink VersaPad (serial)
1894 Even if the mouse is not in the above list, it may be compatible
1895 with one in the list.
1896 Refer to the man page for
1898 for compatibility information.
1900 It should also be noted that while this is enabled, any
1901 other client of the mouse (such as an X server) should access
1902 the mouse through the virtual mouse device,
1904 and configure it as a
1906 type mouse, since all
1907 mouse data is converted to this single canonical format when using
1909 If the client program does not support the
1914 It is the second preferred type.
1921 this is the actual port the mouse is on.
1924 for a COM1 serial mouse or
1926 for a PS/2 mouse, for example.
1931 is set, these are the additional flags to pass to the
1934 .It Va mousechar_start
1938 the default mouse cursor character range
1939 .Li 0xd0 Ns - Ns Li 0xd3
1940 is used, otherwise the range start is set to
1944 Use if the default range is occupied in the language code table.
1947 Set the size of the history (scrollback) buffer in lines.
1948 .It Va allscreens_flags
1952 is run with these options for each of the virtual terminals
1956 will enable the mouse pointer on all virtual terminals if
1960 .It Va allscreens_kbdflags
1964 is run with these options for each of the virtual terminals
1970 scrollback (history) buffer to 200 lines.
1977 daemon at system boot time.
1983 .Pa /usr/sbin/cron ) .
1990 these are the flags to pass to
1997 .Pa /usr/sbin/lpd ) .
2004 daemon at system boot time.
2011 these are the flags to pass to the
2020 daemon at system boot time.
2027 settings across reboots.
2028 .It Va mta_start_script
2030 The full path to the script to run to start
2031 a mail transfer agent.
2033 .Pa /etc/rc.sendmail .
2037 .Pa /etc/rc.sendmail
2038 uses are documented in the
2044 .Sq HAMMER ROOT with UFS /boot
2045 setup, the boot loader will not set up the
2048 The system will attempt to fix this on its own.
2049 Set this variable to
2051 to turn this behavior off.
2054 Indicates the device (usually a swap partition) to which a crash dump
2055 should be written in the event of a system crash.
2056 The value of this variable is passed as the argument to
2060 To disable crash dumps, set this variable to
2064 When the system reboots after a crash and a crash dump is found on the
2065 device specified by the
2069 will save that crash dump and a copy of the kernel to the directory
2073 The default value is
2082 .It Va savecore_flags
2084 If crash dumps are enabled, these are the flags to pass to the
2087 .It Va crashinfo_enable
2091 to turn on automatic crash dump summary generation using the utility
2093 .Va crashinfo_program
2095 .It Va crashinfo_program
2097 Program to run to generate a crash dump summary if the variable
2098 .Va crashinfo_enable
2101 The default value is
2102 .Pa /usr/sbin/crashinfo .
2103 .It Va enable_quotas
2107 to turn on user disk quotas on system startup via the
2114 to enable user disk quota checking via the
2117 .It Va accounting_enable
2121 to enable system accounting through the
2128 to enable Linux/ELF binary emulation at system initial boot time.
2129 .\" ----- cleanvar_enable setting--------------------------------
2130 .It Va cleanvar_enable
2138 .Pa /var/spool/uucp/.Temp/*
2140 .\" ----- clear_tmp_enable setting-------------------------------
2141 .It Va clear_tmp_enable
2148 .\" ----- ldconfig_paths setting --------------------------------
2149 .It Va ldconfig_paths
2151 Set to the list of shared library paths to use with
2155 will always be added first, so it need not appear in this list.
2156 .It Va ldconfig_insecure
2160 utility normally refuses to use directories
2161 which are writable by anyone except root.
2162 Set this variable to
2164 to disable that security check during system startup.
2165 .It Va ldconfig_local_dirs
2167 Set to the list of local
2170 The names of all files in the directories listed will be
2171 passed as arguments to
2173 .It Va kern_securelevel
2175 The kernel security level to set at startup.
2176 The allowed range of
2178 ranges from \-1 (the compile time default) to 3 (the most secure).
2181 for the list of possible security levels and their effect on system operation.
2188 at system boot time.
2195 at system boot time.
2198 Path to the SSH server program
2200 .Pa /usr/sbin/sshd ) .
2207 these are the flags to pass to the
2216 at system boot time.
2223 these are the flags to pass to the
2226 .It Va watchdogd_enable
2232 daemon at boot time.
2233 This requires that the kernel have been compiled with
2234 .Cd "options WATCHDOG" .
2239 any configured jails will not be started.
2242 A space separated list of names for jails.
2243 This is purely a configuration aid to help identify and
2244 configure multiple jails.
2245 The names specified in this list will be used to
2246 identify settings common to an instance of a jail.
2247 Assuming that the jail in question was named
2249 you would have the following dependent variables:
2251 jail_vjail_hostname="jail.example.com"
2252 jail_vjail_ip="192.168.1.100"
2253 jail_vjail_rootdir="/var/jails/vjail/root"
2258 When set, use as default value for
2259 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2262 .It Va jail_interface
2265 When set, use as default value for
2266 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2272 When set, use as default value for
2273 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2276 .It Va jail_mount_enable
2284 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2287 by default for every jail in
2289 .It Va jail_procfs_enable
2297 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2300 by default for every jail in
2302 .It Va jail_devfs_enable
2310 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2313 by default for every jail in
2315 .It Va jail_exec_start
2318 When set, use as default value for
2319 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2322 .It Va jail_exec_stop
2324 When set, use as default value for
2325 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2328 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2331 Set to the root directory used by jail
2333 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2336 Set to the fully qualified domain name (FQDN) assigned to jail
2338 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2341 Set to the IP address assigned to jail
2343 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2348 These are flags to pass to
2350 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2353 When set, sets the interface to use when setting IP address alias.
2354 Note that the alias is created at jail startup and removed at jail shutdown.
2355 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2358 .Pa /etc/fstab. Ns Aq Ar jname
2360 This is the file system information file to use for jail
2362 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2369 mount all file systems from
2370 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2372 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2379 mount the process file system inside jail
2382 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2389 mount the device file system inside jail
2392 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2395 .Dq Li /bin/sh /etc/rc
2397 This is the command executed at jail startup.
2398 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2401 .Dq Li /bin/sh /etc/rc.shutdown
2403 This is the command executed at jail shutdown.
2404 .It Va jail_set_hostname_allow
2408 do not allow the root user in a jail to set its hostname.
2409 .It Va jail_socket_unixiproute_only
2413 do not allow any sockets,
2414 besides UNIX/IP/route sockets,
2415 to be used within a jail.
2416 .It Va jail_sysvipc_allow
2420 allow applications within a jail to use System V IPC.
2425 LVM volumes will be discovered and configured on boot.
2426 .It Va newsyslog_enable
2432 before syslogd starts.
2433 .It Va newsyslog_flags
2436 .Va newsyslog_enable
2439 these are the flags passed to
2441 .It Va resident_enable
2445 make the dynamic binaries listed in
2446 .Pa /etc/resident.conf
2448 .It Va varsym_enable
2453 .Pa /etc/varsym.conf
2454 to set system-wide variables for variant symlinks.
2459 or a whitespace separated list of IRQ numbers which will be used as a source of
2461 .\" -----------------------------------------------------
2466 to disable caching entropy via
2468 Otherwise set to the directory used to store entropy files in.
2473 to disable caching entropy through reboots.
2474 Otherwise set to the filename used to store cached entropy through reboots.
2475 This file should be located on the root file system to seed the
2477 device as early as possible in the boot process.
2478 .It Va entropy_save_sz
2480 Determines the size of the entropy cache files used for entropy cached
2481 through reboots and also entropy cached via
2483 The entropy is fed to the system in blocks of 512 bytes, so this number
2484 should be large enough to fill as many of the entropy pools in the kernel
2486 By default, it is set to 16384, which should be able to seed all 32 entropy
2487 pools in the Fortuna CSPRNG.
2499 Configuration file for
2508 .Pa /var/run/dmesg.boot
2510 .It Va rcshutdown_timeout
2512 If set, start a watchdog timer in the background which will terminate
2516 has not completed within the specified time (in seconds).
2517 Notice that in addition to this soft timeout,
2519 also applies a hard timeout for the execution of
2521 This is configured via
2524 .Va kern.init_shutdown_timeout
2525 and defaults to 120 seconds. Setting the value of
2526 .Va rcshutdown_timeout
2527 to more than 120 seconds will have no effect until the
2530 .Va kern.init_shutdown_timeout
2536 the udevd daemon will be started on boot.
2537 .It Va vfs_quota_enable
2541 vfs quota rc.d scripts will be run on boot.
2542 .It Va vfs_quota_sync
2544 List of mount points whose counters are to be synchronized with on-disk
2545 usage during system startup. See also
2547 .It Va vknetd_enable
2552 will be started on boot.
2555 Additional flags passed to
2557 Usually address/cidrbits is specified here.
2558 When no flags are passed, default option
2561 .It Va vkernel_enable
2565 any configured vkernels will not be started.
2566 .It Va vkernel_kill_timeout
2568 This defines the default number of seconds that we will wait for the
2569 vkernel to shut down on it's own. If after this time it's still alive,
2570 it will be killed with SIGKILL.
2573 Defines the default path to the vkernel binary.
2576 A space separated list of names for vkernels.
2577 This is purely a configuration aid to help identify and
2578 configure multiple vkernels.
2579 The names specified in this list will be used to
2580 identify settings common to a vkernel instance.
2581 Assuming that the vkernel in question was named
2583 you would have the following dependent variables
2584 (filled with reference values in this text):
2586 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL64/kernel.debug"
2587 vkernel_example_memsize="64m"
2588 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2589 vkernel_example_iface_list="auto:bridge0"
2590 vkernel_example_logfile="/dev/null"
2591 vkernel_example_flags="-U"
2592 vkernel_example_kill_timeout="45"
2595 The last five are optional.
2596 They default to an empty string if not set, except for logfile which defaults to
2601 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2602 .It Pa /etc/defaults/rc.conf
2604 .It Pa /etc/rc.conf.local
2605 .It Pa /etc/start_if. Ns Aq Ar interface
2623 .Xr resident.conf 5 ,
2682 .An Jordan K. Hubbard .