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 $
27 .Dd September 29, 2017
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
140 .It Ao Ar module Ac Ns Ar _load
144 that kernel module will be loaded.
146 .Ao Ar module Ac Ns Ar _name
147 is defined (see below), the
148 module's name is taken to be
150 .It Ao Ar module Ac Ns Ar _name
152 Defines the name of the module.
157 to handle device added, removed or unknown events from the kernel.
164 these are the flags to pass to the
176 a CPU speed control daemon.
180 Additional flags passed to the
183 .It Va sensorsd_enable
192 a sensors monitoring and logging daemon.
193 .It Va sensorsd_flags
196 Additional flags passed to the
199 .It Va sysvipcd_enable
208 a daemon needed for the userspace implementation of the XSI Interprocess
209 Communication functions.
210 .It Va sysvipcd_flags
213 Additional flags passed to the
216 .It Va hotplugd_enable
225 a devices hot plugging monitoring daemon.
226 .It Va hotplugd_flags
229 Additional flags passed to the
232 .It Va pccard_ifconfig
234 List of arguments to be passed to
236 at boot time or on insertion of the card (e.g.\&
237 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
238 for a fixed address or
241 .It Va pccard_ether_delay
243 Set the delay before starting
246 .Pa /etc/pccard_ether
248 This defaults to 5 seconds to work around a bug in the
250 driver which can lead to system hangs when using some newer
253 .It Va removable_interfaces
255 List of removable network interfaces to be supported by
256 .Pa /etc/pccard_ether .
259 List of directories to search for startup script files.
260 .It Va script_name_sep
262 The field separator to use for breaking down the list of startup script files
263 into individual filenames.
264 The default is a space.
265 It is not necessary to change this unless there are startup scripts with names
269 The fully qualified domain name (FQDN) of this host on the network.
270 This should almost certainly be set to something meaningful, even if
271 there is no network connection.
274 is used to set the hostname via DHCP,
275 this variable should be set to an empty string.
278 Enable support for IPv6 networking.
279 Note that this requires that the kernel have been compiled with
280 .Cd "options INET6" .
283 The NIS domain name of this host, or
286 .It Va dhclient_program
288 Path to the DHCP client program
290 .Pa /sbin/dhclient ) .
291 .It Va dhclient_flags
293 Additional flags to pass to the DHCP client program.
301 If the kernel was not built with
305 kernel module will be loaded.
307 .Va firewall_enable .
312 ruleset definition file.
323 these are the flags to pass to
325 when loading the ruleset.
332 which logs packets from
340 this specifies the path of the log file.
351 these are the flags to pass to
353 .It Va firewall_enable
357 to load firewall rules at startup.
358 If the kernel was not built with
359 .Cd "options IPFIREWALL" ,
362 kernel module will be loaded.
365 .It Va ipv6_firewall_enable
367 The IPv6 equivalent of
368 .Va firewall_enable .
371 to load IPv6 firewall rules at startup.
372 If the kernel was not built with
373 .Cd "options IPV6FIREWALL" ,
376 kernel module will be loaded.
377 .It Va firewall_script
379 The full path to the firewall script to run
381 .Pa /etc/rc.firewall ) .
382 .It Va ipv6_firewall_script
384 The IPv6 equivalent of
385 .Va firewall_script .
388 Names the firewall type from the selection in
389 .Pa /etc/rc.firewall ,
390 or the file which contains the local firewall ruleset.
391 Valid selections from
395 .Bl -tag -width ".Li simple" -compact
397 unrestricted IP access
399 all IP services disabled, except via
402 basic protection for a workstation on a LAN
408 If a filename is specified, the full path must be given.
409 .It Va firewall_trusted_nets
411 List of trusted networks (if
415 .It Va firewall_trusted_interfaces
417 List of trusted network interfaces (if
421 .It Va firewall_allowed_icmp_types
423 List of allowed ICMP types (if
427 .It Va firewall_open_tcp_ports
429 List of TCP ports to open (if
433 .It Va firewall_open_udp_ports
435 List of UDP ports to open (if
439 .It Va ipv6_firewall_type
441 The IPv6 equivalent of
443 .It Va firewall_quiet
447 to disable the display of firewall rules on the console during boot.
448 .It Va ipv6_firewall_quiet
450 The IPv6 equivalent of
452 .It Va firewall_logging
456 to enable firewall event logging.
457 This is equivalent to the
458 .Dv IPFIREWALL_VERBOSE
460 .It Va ipv6_firewall_logging
462 The IPv6 equivalent of
463 .Va firewall_logging .
464 .It Va firewall_flags
470 specifies a filename.
471 .It Va ipv6_firewall_flags
473 The IPv6 equivalent of
490 sockets must be enabled in the kernel.
491 .It Va natd_interface
493 This is the name of the public interface on which
496 The interface may be given as an interface name or as an IP address.
501 flags should be placed here.
506 flag is automatically added with the above
509 .It Va tcp_extensions
516 disables certain TCP options as described by
522 might help remedy such problems with connections as randomly hanging
523 or other weird behavior.
524 Some network devices are known to be broken with respect to these options.
531 .Va net.inet.tcp.log_in_vain
533 .Va net.inet.udp.log_in_vain ,
538 are set to the given value.
546 will disable probing idle TCP connections to verify that the
547 peer is still up and reachable.
548 .It Va tcp_drop_synfin
555 will cause the kernel to ignore TCP frames that have both
556 the SYN and FIN flags set.
557 This prevents OS fingerprinting, but may break some legitimate applications.
558 This option is only available if the kernel was built with the
561 .It Va icmp_drop_redirect
568 will cause the kernel to ignore ICMP REDIRECT packets.
571 for more information.
572 .It Va icmp_log_redirect
579 will cause the kernel to log ICMP REDIRECT packets.
581 the log messages are not rate-limited, so this option should only be used
582 for troubleshooting networks.
585 for more information.
586 .It Va icmp_bmcastecho
590 to respond to broadcast or multicast ICMP ping packets.
593 for more information.
594 .It Va ip_portrange_first
598 this is the first port in the default portrange.
601 for more information.
602 .It Va ip_portrange_last
606 this is the last port in the default portrange.
609 for more information.
611 .It Va ifconfig_ Ns Aq Ar interface
615 Typically includes IP address.
616 Assuming that the interface in question was
618 it might look something like this:
620 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
624 .Pa /etc/start_if. Ns Aq Ar interface
625 file is present, it is read and executed by the
627 interpreter before configuring the interface as specified in the
628 .Va ifconfig_ Ns Aq Ar interface
630 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
633 It is possible to bring up an interface with DHCP by adding
636 .Va ifconfig_ Ns Aq Ar interface
638 For instance, to initialize the
640 device via DHCP, it is possible to use something like:
646 .Va vlans_ Ns Aq Ar interface
650 interface will be created for each item in the list with the
654 If a vlan interface's name is a number,
655 then that number is used as the vlan tag and the new vlan interface is
657 .Ar interface . Ns Ar tag .
659 the vlan tag must be specified via a
662 .Va create_args_ Ns Aq Ar interface
665 To create a vlan device named
669 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
672 ifconfig_em0_101="inet 192.0.2.1/24"
675 To create a vlan device named
679 with the vlan tag 102:
682 create_args_myvlan="vlan 102"
686 .Va wlans_ Ns Aq Ar interface
690 interface will be created for each item in the list with the
694 Further wlan cloning arguments may be passed to the
697 command by setting the
698 .Va create_args_ Ns Aq Ar interface
702 devices must be created for each wireless devices as of
708 may be specified with an
709 .Va wlandebug_ Ns Aq Ar interface
711 The contents of this variable will be passed directly to
714 Also, if your interface needs WPA authentication, it is possible to add
717 .Va ifconfig_ Ns Aq Ar interface
720 .Xr wpa_supplicant 8 .
722 .Xr wpa_supplicant.conf 5
723 for configuring authentication information.
727 options in this variable, in addition to the
728 .Pa /etc/start_if. Ns Aq Ar interface
730 For instance, to initialize the
732 device via DHCP, using WPA authentication and 802.11b mode, it is
733 possible to use something like:
736 ifconfig_wlan0="up DHCP WPA mode 11b"
738 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
740 Configuration to establish an additional network address for
742 Assuming that the interface in question was
744 it might look something like this:
746 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
747 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
752 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
753 entry that is found, its contents are passed to
755 Execution stops at the first unsuccessful access, so if
756 something like this is present:
758 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
759 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
760 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
761 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
764 Then note that alias4 would
766 be added since the search would stop with the missing alias3 entry.
767 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
771 It is possible to rename interface by doing:
773 ifconfig_ed0_name="net0"
774 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
776 .It Va network_interfaces
778 The list of network interfaces to configure on this host,
781 to configure all network interfaces
784 For example, if the only network devices to be configured are the loopback device
788 driver, this could be set to
791 .Va ifconfig_ Ns Aq Ar interface
792 variable is assumed to exist for each value of
794 .It Va ipv6_network_interfaces
796 This is the IPv6 equivalent of
797 .Va network_interfaces .
798 Instead of setting the ifconfig variables as
799 .Va ifconfig_ Ns Aq Ar interface
800 they should be set as
801 .Va ipv6_ifconfig_ Ns Aq Ar interface .
802 Aliases should be set as
803 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
804 Interfaces that do not have a
805 .Va ipv6_ifconfig_ Ns Aq Ar interface
806 setting will be auto configured by
809 .Va ipv6_gateway_enable
812 Note that the IPv6 networking code does not support the
813 .Pa /etc/start_if. Ns Aq Ar interface
815 .It Va ipv6_prefix_ Ns Aq Ar interface
819 prefixlen 64 is used.
820 .It Va ipv6_default_interface
824 this is the default output interface for scoped addresses.
825 Now this works only for IPv6 link local multicast addresses.
826 .It Va cloned_interfaces
828 Set to the list of clonable network interfaces to create on this host.
830 .Va cloned_interfaces
831 are automatically appended to
832 .Va network_interfaces
834 .It Va gif_interfaces
838 tunnel interfaces to configure on this host.
840 .Va gifconfig_ Ns Aq Ar interface
841 variable is assumed to exist for each value of
843 The value of this variable is used to configure the link layer of the
844 tunnel according to the syntax of the
848 Additionally, this option ensures that each listed interface is created via the
852 before attempting to configure it.
853 .It Va sppp_interfaces
857 interfaces to configure on this host.
859 .Va spppconfig_ Ns Aq Ar interface
860 variable is assumed to exist for each value of
862 Each interface should also be configured by a general
863 .Va ifconfig_ Ns Aq Ar interface
867 for more information about available options.
877 Mode in which to run the
886 See the manual for a full description.
891 enables network address translation.
892 Used in conjunction with
894 allows hosts on private network addresses access to the Internet using
895 this host as a network address translating router.
898 The name of the profile to use from
899 .Pa /etc/ppp/ppp.conf .
900 Also used for per-profile overrides of
901 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
902 Where the profile contains any of the characters
904 they are translated to
906 for the purposes of the override variable names.
907 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
909 Set the unit number to be used for this profile.
910 See the manual description of
917 The name of the user under which
926 This option is used to specify a list of files that will override
928 .Pa /etc/defaults/rc.conf .
929 The files will be read in the order in which they are specified and should
930 include the full path to the file.
931 By default, the files specified are
934 .Pa /etc/rc.conf.local
942 flag if the initial preen of the file systems fails.
945 List of file system types that are network-based.
946 This list should generally not be modified by end users.
948 .Va extra_netfs_types
950 .It Va extra_netfs_types
952 If set to something other than
954 (the default), this variable extends the list of file system types
955 for which automatic mounting at startup by
957 should be delayed until the network is initialized.
959 a whitespace-separated list of network file system descriptor pairs,
960 each consisting of a file system type as passed to
962 and a human-readable, one-word description, joined with a colon
964 Extending the default list in this way is only necessary
965 when third party file system types are used.
966 .It Va devfs_config_files
968 This option is used to specify a list of configuration files containing
970 rules that will be applied by
972 in the order in which they are specified and must include the full path
974 .It Va syslogd_enable
981 .It Va syslogd_program
986 .Pa /usr/sbin/syslogd ) .
993 these are the flags to pass to
1002 .It Va inetd_program
1007 .Pa /usr/sbin/inetd ) .
1014 these are the flags to pass to
1022 daemon at boot time.
1029 these are the flags to pass to it.
1035 will be updated at boot time to reflect the kernel release being run.
1039 will not be updated.
1040 .It Va nfs_client_enable
1044 setup NFS client parameters at boot time.
1045 .It Va nfs_access_cache
1048 .Va nfs_client_enable
1053 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1054 NFS ACCESS results should be cached.
1055 A value of 2-10 seconds will substantially reduce network traffic for
1056 many NFS operations.
1057 The default is 5 seconds.
1058 Note that the attribute cache holds stat information only.
1059 The NFS data cache is independent of the attribute cache and is only
1060 invalidated when the client detects that the server has modified the
1062 This value specifies a maximum timeout.
1063 The NFS client will automatically use a shorter timeout for files which
1064 have been recently modified.
1065 .It Va nfs_neg_cache
1068 .Va nfs_client_enable
1073 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1074 filenames), or to the number of seconds for which negative lookups should
1076 A value of 2-10 seconds will substantially reduce network
1077 traffic for many NFS operations, especially source code builds.
1078 The default is 3 seconds.
1079 .It Va nfs_server_enable
1083 run the NFS server daemons at boot time.
1084 .It Va nfs_server_flags
1087 .Va nfs_server_enable
1090 these are the flags to pass to the
1093 .It Va mountd_enable
1098 .Va nfs_server_enable
1104 It is commonly needed to run CFS without real NFS used.
1111 these are the flags to pass to the
1114 .It Va weak_mountd_authentication
1118 allow services like PCNFSD to make non-privileged mount requests.
1119 .It Va nfs_reserved_port_only
1123 provide NFS services only on a secure port.
1124 .It Va nfs_bufpackets
1126 If set to a number, indicates the number of packets worth of
1127 socket buffer space to reserve on an NFS client.
1128 The kernel default is typically 4.
1129 Using a higher number may be useful on gigabit networks to improve performance.
1130 The minimum value is 2 and the maximum is 64.
1131 .It Va rpc_umntall_enable
1135 (default) and we are also an NFS client, run
1137 at boot time to clear out old mounts on remote servers.
1142 will not be run at boot time.
1143 .It Va rpc_lockd_enable
1147 and also an NFS server, run
1150 .It Va rpc_lockd_flags
1153 .Va rpc_lockd_enable
1156 these are the flags to pass to
1158 .It Va rpc_statd_enable
1162 and also an NFS server, run
1165 .It Va rpc_statd_flags
1168 .Va rpc_statd_enable
1171 these are the flags to pass to
1173 .It Va rpcbind_program
1175 Path to program for rpcbind daemon
1177 .Pa /usr/sbin/rpcbind ) .
1178 .It Va rpcbind_enable
1185 .It Va rpcbind_flags
1191 these are the flags to pass to
1192 .Va rpcbind_program .
1193 .It Va keyserv_enable
1199 daemon on boot for running Secure RPC.
1200 .It Va keyserv_flags
1206 these are the flags to pass to
1209 .It Va pppoed_enable
1215 daemon at boot time to provide PPP over Ethernet services.
1216 .It Va pppoed_provider
1219 listens to requests to this provider and ultimately runs
1223 argument of the same name.
1226 Additional flags to pass to
1228 .It Va pppoed_interface
1230 The network interface to run
1233 This is mandatory when
1243 service at boot time.
1244 This command is intended for networks of machines where a consistent
1246 for all hosts must be established.
1247 This is often useful in large NFS environments where time stamps on
1248 files are expected to be consistent network-wide.
1255 these are the flags to pass to the
1264 at system boot time.
1265 .It Va dntpd_program
1270 .Pa /usr/sbin/dntpd ) .
1277 these are the flags to pass to the
1280 .It Va btconfig_enable
1284 configure Bluetooth devices via
1286 at system boot time.
1287 .It Va btconfig_devices
1293 this is the list of Bluetooth devices to configure.
1295 .Va btconfig_devices
1296 is not specified, all devices known to the system will be configured.
1298 .Va btconfig_ Ns Aq Ar device
1299 variable can be set to specify parameters to be passed to
1301 .It Va btconfig_args
1307 this is the list of configuration parameters to pass to all Bluetooth
1313 run the Service Discovery Profile daemon
1315 at system boot time.
1322 these are the flags to pass to the
1325 .It Va bthcid_enable
1329 run the Bluetooth Link Key/PIN Code Manager daemon
1331 at system boot time.
1338 these are the flags to pass to the
1341 .It Va nis_client_enable
1347 service at system boot time.
1348 .It Va nis_client_flags
1351 .Va nis_client_enable
1354 these are the flags to pass to the
1357 .It Va nis_ypset_enable
1363 daemon at system boot time.
1364 .It Va nis_ypset_flags
1367 .Va nis_ypset_enable
1370 these are the flags to pass to the
1373 .It Va nis_server_enable
1379 daemon at system boot time.
1380 .It Va nis_server_flags
1383 .Va nis_server_enable
1386 these are the flags to pass to the
1389 .It Va nis_ypxfrd_enable
1395 daemon at system boot time.
1396 .It Va nis_ypxfrd_flags
1399 .Va nis_ypxfrd_enable
1402 these are the flags to pass to the
1405 .It Va nis_yppasswdd_enable
1411 daemon at system boot time.
1412 .It Va nis_yppasswdd_flags
1415 .Va nis_yppasswdd_enable
1418 these are the flags to pass to the
1421 .It Va rpc_ypupdated_enable
1427 daemon at system boot time.
1428 .It Va defaultrouter
1432 create a default route to this host name or IP address
1433 (use an IP address if this router is also required to get to the
1435 .It Va ipv6_defaultrouter
1437 The IPv6 equivalent of
1439 .It Va static_routes
1441 Set to the list of static routes that are to be added at system boot time.
1444 then for each whitespace separated
1447 .Va route_ Ns Aq Ar element
1448 variable is assumed to exist whose contents will later be passed to a
1451 .It Va change_routes
1453 Set to the list of static routes that are to be changed at system boot time
1454 (such as those added by the kernel).
1457 then for each whitespace separated
1460 .Va change_route_ Ns Aq Ar element
1461 variable is assumed to exist whose contents will later be passed to a
1462 .Dq Nm route Cm change
1464 .It Va ipv6_static_routes
1466 The IPv6 equivalent of
1470 then for each whitespace separated
1473 .Va ipv6_route_ Ns Aq Ar element
1474 variable is assumed to exist whose contents will later be passed to a
1475 .Dq Nm route Cm add Fl inet6
1477 .It Va gateway_enable
1481 configure host to act as an IP router, e.g. to forward packets
1483 .It Va ipv6_gateway_enable
1485 The IPv6 equivalent of
1486 .Va gateway_enable .
1487 .It Va router_enable
1491 run a routing daemon of some sort, based on the settings of
1495 .It Va ipv6_router_enable
1497 The IPv6 equivalent of
1501 run a routing daemon of some sort, based on the settings of
1502 .Va ipv6_router_program
1504 .Va ipv6_router_flags .
1505 .It Va router_program
1511 this is the name of the routing daemon to use
1513 .Pa /sbin/routed ) .
1514 .It Va ipv6_router_program
1516 The IPv6 equivalent of
1519 .Pa /sbin/route6d ) .
1526 these are the flags to pass to the routing daemon.
1527 .It Va ipv6_router_flags
1529 The IPv6 equivalent of
1531 .It Va mrouted_enable
1535 run the multicast routing daemon,
1537 .It Va mroute6d_enable
1539 The IPv6 equivalent of
1540 .Va mrouted_enable .
1543 run the IPv6 multicast routing daemon.
1544 Note that no IPv6 multicast routing daemon is included in the
1548 can be installed from the
1551 .Pa ( net/mcast-tools ) .
1552 .It Va mrouted_flags
1558 these are the flags to pass to the
1561 .It Va mroute6d_flags
1563 The IPv6 equivalent of
1569 these are the flags passed to the IPv6 multicast routing daemon.
1570 .It Va mroute6d_program
1576 this is the path to the IPv6 multicast routing daemon.
1577 .It Va rtadvd_enable
1583 daemon at boot time.
1586 .Va ipv6_gateway_enable
1591 utility sends router advertisement packets to the interfaces specified in
1592 .Va rtadvd_interfaces .
1594 and should only be enabled with great care.
1595 You may want to fine-tune
1597 .It Va rtadvd_interfaces
1603 this is the list of interfaces to use.
1604 .It Va rtsold_enable
1610 daemon at boot time.
1613 daemon is used for automatic discovery of non-link local addresses.
1620 these are the flags to pass to the
1627 enable global proxy ARP.
1628 .It Va forward_sourceroute
1636 source-routed packets are forwarded.
1637 .It Va accept_sourceroute
1641 the system will accept source-routed packets directed at it.
1648 daemon at system boot time.
1655 these are the flags to pass to the
1658 .It Va bootparamd_enable
1664 daemon at system boot time.
1665 .It Va bootparamd_flags
1668 .Va bootparamd_enable
1671 these are the flags to pass to the
1674 .It Va stf_interface_ipv4addr
1678 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1679 Specify this entry to enable the 6to4 interface.
1680 .It Va stf_interface_ipv4plen
1682 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1683 An effective value is 0-31.
1684 .It Va stf_interface_ipv6_ifid
1686 IPv6 interface ID for
1690 .It Va stf_interface_ipv6_slaid
1692 IPv6 Site Level Aggregator for
1694 .It Va ipv6_faith_prefix
1698 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1704 The keyboard bell sound.
1711 if the default behavior is desired.
1712 For details, refer to the
1719 no keymap is installed, otherwise the value is used to install
1721 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1724 The keyboard repeat speed.
1731 if the default behavior is desired.
1736 attempt to program the function keys with the value.
1737 The value should be a single string of the form:
1738 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1741 Can be set to the value of
1744 .Dq Li destructive ,
1747 to set the cursor behavior explicitly or choose the default behavior.
1752 no screen map is installed, otherwise the value is used to install
1753 the screen map file in
1754 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1759 the default 8x16 font value is used for screen size requests, otherwise
1761 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1767 the default 8x14 font value is used for screen size requests, otherwise
1769 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1775 the default 8x8 font value is used for screen size requests, otherwise
1777 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1783 the default screen blanking interval is used, otherwise it is set to
1790 this is the actual screen saver to use
1791 .Li ( blank , snake , daemon ,
1793 .It Va moused_nondefault_enable
1797 the mouse device specified on
1798 the command line is not automatically treated as enabled by the
1799 .Pa /etc/rc.d/moused
1801 Having this variable set to
1807 to be enabled as soon as it is plugged in.
1808 .It Va moused_enable
1814 daemon is started for doing cut/paste selection on the console.
1817 This is the protocol type of the mouse connected to this host.
1823 is able to detect the appropriate mouse type automatically in many cases.
1824 Leave this variable at the default
1826 to let the daemon detect it, or
1827 select one from the following list if the automatic detection fails.
1829 If the mouse is attached to the PS/2 mouse port, leave the variable at the
1834 regardless of the brand and model of the mouse.
1835 Likewise, if the mouse is attached to the bus mouse port, leave it at
1839 All other protocols are for serial mice and will not work with
1840 the PS/2 and bus mice.
1841 If this is a USB mouse,
1843 is the only protocol type which will work.
1845 .Bl -tag -width ".Li x10mouseremote" -compact
1847 Microsoft mouse (serial)
1849 Microsoft IntelliMouse (serial)
1851 Mouse systems Corp. mouse (serial)
1853 MM Series mouse (serial)
1855 Logitech mouse (serial)
1859 Logitech MouseMan and TrackMan (serial)
1861 ALPS GlidePoint (serial)
1862 .It Li thinkingmouse
1863 Kensington ThinkingMouse (serial)
1867 MM HitTablet (serial)
1868 .It Li x10mouseremote
1869 X10 MouseRemote (serial)
1871 Interlink VersaPad (serial)
1874 Even if the mouse is not in the above list, it may be compatible
1875 with one in the list.
1876 Refer to the man page for
1878 for compatibility information.
1880 It should also be noted that while this is enabled, any
1881 other client of the mouse (such as an X server) should access
1882 the mouse through the virtual mouse device,
1884 and configure it as a
1886 type mouse, since all
1887 mouse data is converted to this single canonical format when using
1889 If the client program does not support the
1894 It is the second preferred type.
1901 this is the actual port the mouse is on.
1904 for a COM1 serial mouse or
1906 for a PS/2 mouse, for example.
1911 is set, these are the additional flags to pass to the
1914 .It Va mousechar_start
1918 the default mouse cursor character range
1919 .Li 0xd0 Ns - Ns Li 0xd3
1920 is used, otherwise the range start is set to
1924 Use if the default range is occupied in the language code table.
1927 Set the size of the history (scrollback) buffer in lines.
1928 .It Va allscreens_flags
1932 is run with these options for each of the virtual terminals
1936 will enable the mouse pointer on all virtual terminals if
1940 .It Va allscreens_kbdflags
1944 is run with these options for each of the virtual terminals
1950 scrollback (history) buffer to 200 lines.
1957 daemon at system boot time.
1963 .Pa /usr/sbin/cron ) .
1970 these are the flags to pass to
1977 .Pa /usr/sbin/lpd ) .
1984 daemon at system boot time.
1991 these are the flags to pass to the
2000 daemon at system boot time.
2007 settings across reboots.
2008 .It Va mta_start_script
2010 The full path to the script to run to start
2011 a mail transfer agent.
2013 .Pa /etc/rc.sendmail .
2017 .Pa /etc/rc.sendmail
2018 uses are documented in the
2024 .Sq HAMMER ROOT with UFS /boot
2025 setup, the boot loader will not set up the
2028 The system will attempt to fix this on its own.
2029 Set this variable to
2031 to turn this behavior off.
2034 Indicates the device (usually a swap partition) to which a crash dump
2035 should be written in the event of a system crash.
2036 The value of this variable is passed as the argument to
2040 To disable crash dumps, set this variable to
2044 When the system reboots after a crash and a crash dump is found on the
2045 device specified by the
2049 will save that crash dump and a copy of the kernel to the directory
2053 The default value is
2062 .It Va savecore_flags
2064 If crash dumps are enabled, these are the flags to pass to the
2067 .It Va crashinfo_enable
2071 to turn on automatic crash dump summary generation using the utility
2073 .Va crashinfo_program
2075 .It Va crashinfo_program
2077 Program to run to generate a crash dump summary if the variable
2078 .Va crashinfo_enable
2081 The default value is
2082 .Pa /usr/sbin/crashinfo .
2083 .It Va enable_quotas
2087 to turn on user disk quotas on system startup via the
2094 to enable user disk quota checking via the
2097 .It Va accounting_enable
2101 to enable system accounting through the
2104 .\" ----- cleanvar_enable setting--------------------------------
2105 .It Va cleanvar_enable
2113 .Pa /var/spool/uucp/.Temp/*
2115 .\" ----- clear_tmp_enable setting-------------------------------
2116 .It Va clear_tmp_enable
2123 .\" ----- ldconfig_paths setting --------------------------------
2124 .It Va ldconfig_paths
2126 Set to the list of shared library paths to use with
2130 will always be added first, so it need not appear in this list.
2131 .It Va ldconfig_insecure
2135 utility normally refuses to use directories
2136 which are writable by anyone except root.
2137 Set this variable to
2139 to disable that security check during system startup.
2140 .It Va ldconfig_local_dirs
2142 Set to the list of local
2145 The names of all files in the directories listed will be
2146 passed as arguments to
2148 .It Va kern_securelevel
2150 The kernel security level to set at startup.
2151 The allowed range of
2153 ranges from \-1 (the compile time default) to 3 (the most secure).
2156 for the list of possible security levels and their effect on system operation.
2163 at system boot time.
2170 at system boot time.
2173 Path to the SSH server program
2175 .Pa /usr/sbin/sshd ) .
2182 these are the flags to pass to the
2191 at system boot time.
2198 these are the flags to pass to the
2201 .It Va watchdogd_enable
2207 daemon at boot time.
2208 This requires that the kernel have been compiled with
2209 .Cd "options WATCHDOG" .
2214 any configured jails will not be started.
2217 A space separated list of names for jails.
2218 This is purely a configuration aid to help identify and
2219 configure multiple jails.
2220 The names specified in this list will be used to
2221 identify settings common to an instance of a jail.
2222 Assuming that the jail in question was named
2224 you would have the following dependent variables:
2226 jail_vjail_hostname="jail.example.com"
2227 jail_vjail_ip="192.168.1.100"
2228 jail_vjail_rootdir="/var/jails/vjail/root"
2233 When set, use as default value for
2234 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2237 .It Va jail_interface
2240 When set, use as default value for
2241 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2247 When set, use as default value for
2248 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2251 .It Va jail_mount_enable
2259 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2262 by default for every jail in
2264 .It Va jail_procfs_enable
2272 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2275 by default for every jail in
2277 .It Va jail_devfs_enable
2285 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2288 by default for every jail in
2290 .It Va jail_exec_start
2293 When set, use as default value for
2294 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2297 .It Va jail_exec_stop
2299 When set, use as default value for
2300 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2303 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2306 Set to the root directory used by jail
2308 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2311 Set to the fully qualified domain name (FQDN) assigned to jail
2313 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2316 Set to the IP address assigned to jail
2318 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2323 These are flags to pass to
2325 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2328 When set, sets the interface to use when setting IP address alias.
2329 Note that the alias is created at jail startup and removed at jail shutdown.
2330 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2333 .Pa /etc/fstab. Ns Aq Ar jname
2335 This is the file system information file to use for jail
2337 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2344 mount all file systems from
2345 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2347 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2354 mount the process file system inside jail
2357 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2364 mount the device file system inside jail
2367 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2370 .Dq Li /bin/sh /etc/rc
2372 This is the command executed at jail startup.
2373 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2376 .Dq Li /bin/sh /etc/rc.shutdown
2378 This is the command executed at jail shutdown.
2379 .It Va jail_set_hostname_allow
2383 do not allow the root user in a jail to set its hostname.
2384 .It Va jail_socket_unixiproute_only
2388 do not allow any sockets,
2389 besides UNIX/IP/route sockets,
2390 to be used within a jail.
2391 .It Va jail_sysvipc_allow
2395 allow applications within a jail to use System V IPC.
2400 LVM volumes will be discovered and configured on boot.
2401 .It Va newsyslog_enable
2407 before syslogd starts.
2408 .It Va newsyslog_flags
2411 .Va newsyslog_enable
2414 these are the flags passed to
2416 .It Va resident_enable
2420 make the dynamic binaries listed in
2421 .Pa /etc/resident.conf
2423 .It Va varsym_enable
2428 .Pa /etc/varsym.conf
2429 to set system-wide variables for variant symlinks.
2434 or a whitespace separated list of IRQ numbers which will be used as a source of
2436 .\" -----------------------------------------------------
2441 to disable caching entropy via
2443 Otherwise set to the directory used to store entropy files in.
2448 to disable caching entropy through reboots.
2449 Otherwise set to the filename used to store cached entropy through reboots.
2450 This file should be located on the root file system to seed the
2452 device as early as possible in the boot process.
2453 .It Va entropy_save_sz
2455 Determines the size of the entropy cache files used for entropy cached
2456 through reboots and also entropy cached via
2458 The entropy is fed to the system in blocks of 512 bytes, so this number
2459 should be large enough to fill as many of the entropy pools in the kernel
2461 By default, it is set to 16384, which should be able to seed all 32 entropy
2462 pools in the Fortuna CSPRNG.
2474 Configuration file for
2483 .Pa /var/run/dmesg.boot
2485 .It Va rcshutdown_timeout
2487 If set, start a watchdog timer in the background which will terminate
2491 has not completed within the specified time (in seconds).
2492 Notice that in addition to this soft timeout,
2494 also applies a hard timeout for the execution of
2496 This is configured via
2499 .Va kern.init_shutdown_timeout
2500 and defaults to 120 seconds. Setting the value of
2501 .Va rcshutdown_timeout
2502 to more than 120 seconds will have no effect until the
2505 .Va kern.init_shutdown_timeout
2511 the udevd daemon will be started on boot.
2512 .It Va vfs_quota_enable
2516 vfs quota rc.d scripts will be run on boot.
2517 .It Va vfs_quota_sync
2519 List of mount points whose counters are to be synchronized with on-disk
2520 usage during system startup. See also
2522 .It Va vknetd_enable
2527 will be started on boot.
2530 Additional flags passed to
2532 Usually address/cidrbits is specified here.
2533 When no flags are passed, default option
2536 .It Va vkernel_enable
2540 any configured vkernels will not be started.
2541 .It Va vkernel_kill_timeout
2543 This defines the default number of seconds that we will wait for the
2544 vkernel to shut down on it's own. If after this time it's still alive,
2545 it will be killed with SIGKILL.
2548 Defines the default path to the vkernel binary.
2551 A space separated list of names for vkernels.
2552 This is purely a configuration aid to help identify and
2553 configure multiple vkernels.
2554 The names specified in this list will be used to
2555 identify settings common to a vkernel instance.
2556 Assuming that the vkernel in question was named
2558 you would have the following dependent variables
2559 (filled with reference values in this text):
2561 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL64/kernel.debug"
2562 vkernel_example_memsize="64m"
2563 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2564 vkernel_example_memimg="/var/vkernel/memimg.000001"
2565 vkernel_example_user="myuser"
2566 vkernel_example_iface_list="auto:bridge0"
2567 vkernel_example_logfile="/dev/null"
2568 vkernel_example_flags="-U"
2569 vkernel_example_kill_timeout="45"
2572 The last six are optional.
2573 They default to an empty string if not set, except for logfile which defaults to
2583 which is the vkernel's default directory for memory images,
2584 with permissions of 1777, i.e. world writable with the sticky bit set
2587 .It Va autofs_enable
2597 daemons at boot time.
2598 .It Va automount_flags
2604 these are the flags to pass to the
2607 By default no flags are passed.
2608 .It Va automountd_flags
2614 these are the flags to pass to the
2617 By default no flags are passed.
2618 .It Va autounmountd_flags
2624 these are the flags to pass to the
2627 By default no flags are passed.
2630 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2631 .It Pa /etc/defaults/rc.conf
2633 .It Pa /etc/rc.conf.local
2634 .It Pa /etc/start_if. Ns Aq Ar interface
2654 .Xr resident.conf 5 ,
2659 .Xr autounmountd 8 ,
2715 .An Jordan K. Hubbard .