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
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
184 If you are running a serial port at 115200 baud we recommend setting
185 the flags to "-l 1500" as lower frequencies will cause characters to
187 .It Va sensorsd_enable
196 a sensors monitoring and logging daemon.
197 .It Va sensorsd_flags
200 Additional flags passed to the
203 .It Va sysvipcd_enable
212 a daemon needed for the userspace implementation of the XSI Interprocess
213 Communication functions.
214 .It Va sysvipcd_flags
217 Additional flags passed to the
220 .It Va hotplugd_enable
229 a devices hot plugging monitoring daemon.
230 .It Va hotplugd_flags
233 Additional flags passed to the
236 .It Va pccard_ifconfig
238 List of arguments to be passed to
240 at boot time or on insertion of the card (e.g.\&
241 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
242 for a fixed address or
245 .It Va removable_interfaces
247 List of removable network interfaces to be supported by
248 .Pa /etc/pccard_ether .
251 List of directories to search for startup script files.
252 .It Va script_name_sep
254 The field separator to use for breaking down the list of startup script files
255 into individual filenames.
256 The default is a space.
257 It is not necessary to change this unless there are startup scripts with names
261 The fully qualified domain name (FQDN) of this host on the network.
262 This should almost certainly be set to something meaningful, even if
263 there is no network connection.
264 If DHCP is used to set the hostname,
265 this variable should be set to an empty string.
268 Enable support for IPv6 networking.
269 Note that this requires that the kernel have been compiled with
270 .Cd "options INET6" .
273 The NIS domain name of this host, or
278 Set the rc script that is called to start the DHCP client.
283 .It Va dhclient_program
288 .Pa /sbin/dhclient ) .
289 .It Va dhclient_flags
291 Additional flags to pass to the
300 in master mode (i.e., configure all available Ethernet interfaces) at startup.
301 .It Va dhcpcd_program
309 Additional flags to pass to the
316 to go to background immediately.
324 If the kernel was not built with
328 kernel module will be loaded.
330 .Va firewall_enable .
335 ruleset definition file.
346 these are the flags to pass to
348 when loading the ruleset.
355 which logs packets from
363 this specifies the path of the log file.
374 these are the flags to pass to
376 .It Va firewall_enable
380 to load firewall rules at startup.
381 If the kernel was not built with
382 .Cd "options IPFIREWALL" ,
385 kernel module will be loaded.
388 .It Va ipv6_firewall_enable
390 The IPv6 equivalent of
391 .Va firewall_enable .
394 to load IPv6 firewall rules at startup.
395 If the kernel was not built with
396 .Cd "options IPV6FIREWALL" ,
399 kernel module will be loaded.
400 .It Va firewall_script
402 The full path to the firewall script to run
404 .Pa /etc/rc.firewall ) .
405 .It Va ipv6_firewall_script
407 The IPv6 equivalent of
408 .Va firewall_script .
411 Names the firewall type from the selection in
412 .Pa /etc/rc.firewall ,
413 or the file which contains the local firewall ruleset.
414 Valid selections from
418 .Bl -tag -width ".Li simple" -compact
420 unrestricted IP access
422 all IP services disabled, except via
425 basic protection for a workstation on a LAN
431 If a filename is specified, the full path must be given.
432 .It Va firewall_trusted_nets
434 List of trusted networks (if
438 .It Va firewall_trusted_interfaces
440 List of trusted network interfaces (if
444 .It Va firewall_allowed_icmp_types
446 List of allowed ICMP types (if
450 .It Va firewall_open_tcp_ports
452 List of TCP ports to open (if
456 .It Va firewall_open_udp_ports
458 List of UDP ports to open (if
462 .It Va ipv6_firewall_type
464 The IPv6 equivalent of
466 .It Va firewall_quiet
470 to disable the display of firewall rules on the console during boot.
471 .It Va ipv6_firewall_quiet
473 The IPv6 equivalent of
475 .It Va firewall_logging
479 to enable firewall event logging.
480 This is equivalent to the
481 .Dv IPFIREWALL_VERBOSE
483 .It Va ipv6_firewall_logging
485 The IPv6 equivalent of
486 .Va firewall_logging .
487 .It Va firewall_flags
493 specifies a filename.
494 .It Va ipv6_firewall_flags
496 The IPv6 equivalent of
510 The full path to the shell script to run to set up the ipfw3
511 firewall rules (default
512 .Pa /etc/ipfw3.rules ) .
515 List of ipfw3 modules to be loaded before executing the above
518 .Dq Li ipfw3 ipfw3_basic ) .
534 sockets must be enabled in the kernel.
535 .It Va natd_interface
537 This is the name of the public interface on which
540 The interface may be given as an interface name or as an IP address.
545 flags should be placed here.
550 flag is automatically added with the above
553 .It Va tcp_extensions
560 disables certain TCP options as described by
566 might help remedy such problems with connections as randomly hanging
567 or other weird behavior.
568 Some network devices are known to be broken with respect to these options.
575 .Va net.inet.tcp.log_in_vain
577 .Va net.inet.udp.log_in_vain ,
582 are set to the given value.
590 will disable probing idle TCP connections to verify that the
591 peer is still up and reachable.
592 .It Va tcp_drop_synfin
599 will cause the kernel to ignore TCP frames that have both
600 the SYN and FIN flags set.
601 This prevents OS fingerprinting, but may break some legitimate applications.
602 This option is only available if the kernel was built with the
605 .It Va icmp_drop_redirect
612 will cause the kernel to ignore ICMP REDIRECT packets.
615 for more information.
616 .It Va icmp_log_redirect
623 will cause the kernel to log ICMP REDIRECT packets.
625 the log messages are not rate-limited, so this option should only be used
626 for troubleshooting networks.
629 for more information.
630 .It Va icmp_bmcastecho
634 to respond to broadcast or multicast ICMP ping packets.
637 for more information.
638 .It Va ip_portrange_first
642 this is the first port in the default portrange.
645 for more information.
646 .It Va ip_portrange_last
650 this is the last port in the default portrange.
653 for more information.
655 .It Va ifconfig_ Ns Aq Ar interface
659 Typically includes IP address.
660 Assuming that the interface in question was
662 it might look something like this:
664 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
668 .Pa /etc/start_if. Ns Aq Ar interface
669 file is present, it is read and executed by the
671 interpreter before configuring the interface as specified in the
672 .Va ifconfig_ Ns Aq Ar interface
674 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
677 It is possible to bring up an interface with DHCP by adding
680 .Va ifconfig_ Ns Aq Ar interface
682 For instance, to initialize the
684 device via DHCP, it is possible to use something like:
690 .Va vlans_ Ns Aq Ar interface
694 interface will be created for each item in the list with the
698 If a vlan interface's name is a number,
699 then that number is used as the vlan tag and the new vlan interface is
701 .Ar interface . Ns Ar tag .
703 the vlan tag must be specified via a
706 .Va create_args_ Ns Aq Ar interface
709 To create a vlan device named
713 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
716 ifconfig_em0_101="inet 192.0.2.1/24"
719 To create a vlan device named
723 with the vlan tag 102:
726 create_args_myvlan="vlan 102"
730 .Va wlans_ Ns Aq Ar interface
734 interface will be created for each item in the list with the
738 Further wlan cloning arguments may be passed to the
741 command by setting the
742 .Va create_args_ Ns Aq Ar interface
746 devices must be created for each wireless devices as of
752 may be specified with an
753 .Va wlandebug_ Ns Aq Ar interface
755 The contents of this variable will be passed directly to
758 Also, if your interface needs WPA authentication, it is possible to add
761 .Va ifconfig_ Ns Aq Ar interface
764 .Xr wpa_supplicant 8 .
766 .Xr wpa_supplicant.conf 5
767 for configuring authentication information.
769 .Va wpa_supplicant_enable .
773 options in this variable, in addition to the
774 .Pa /etc/start_if. Ns Aq Ar interface
776 For instance, to initialize the
778 device via DHCP, using WPA authentication and 802.11b mode, it is
779 possible to use something like:
782 ifconfig_wlan0="up DHCP WPA mode 11b"
784 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
786 Configuration to establish an additional network address for
788 Assuming that the interface in question was
790 it might look something like this:
792 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
793 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
798 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
799 entry that is found, its contents are passed to
801 Execution stops at the first unsuccessful access, so if
802 something like this is present:
804 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
805 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
806 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
807 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
810 Then note that alias4 would
812 be added since the search would stop with the missing alias3 entry.
813 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
817 It is possible to rename interface by doing:
819 ifconfig_ed0_name="net0"
820 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
829 will disable the configuration of network interfaces.
830 .It Va network_interfaces
832 The list of network interfaces to configure on this host,
835 to configure all network interfaces
838 For example, if the only network devices to be configured are the loopback device
842 driver, this could be set to
845 .Va ifconfig_ Ns Aq Ar interface
846 variable is assumed to exist for each value of
848 .It Va ipv6_network_interfaces
850 This is the IPv6 equivalent of
851 .Va network_interfaces .
852 Instead of setting the ifconfig variables as
853 .Va ifconfig_ Ns Aq Ar interface
854 they should be set as
855 .Va ipv6_ifconfig_ Ns Aq Ar interface .
856 Aliases should be set as
857 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
858 Interfaces that do not have a
859 .Va ipv6_ifconfig_ Ns Aq Ar interface
860 setting will be auto configured by
863 .Va ipv6_gateway_enable
866 Note that the IPv6 networking code does not support the
867 .Pa /etc/start_if. Ns Aq Ar interface
869 .It Va ipv6_prefix_ Ns Aq Ar interface
873 prefixlen 64 is used.
874 .It Va ipv6_default_interface
878 this is the default output interface for scoped addresses.
879 Now this works only for IPv6 link local multicast addresses.
880 .It Va ip6addrctl_enable
882 This variable is to enable configuring the default address selection policy table
886 and the policy table to be installed is specified by the
887 .Va ip6addrctl_policy
889 .It Va ip6addrctl_policy
891 This variable specifies the policy table to be installed,
892 and can be one of the following keywords:
905 installs a pre-defined policy table described in Section 2.1
913 is specified, it attempts to read a file
914 .Pa /etc/ip6addrctl.conf
916 If this file is found,
918 reads and installs it.
919 If not found, a policy is automatically set
922 variable; if the variable is set to
924 the IPv6-preferred one is used.
925 Otherwise IPv4-preferred.
926 .It Va ip6addrctl_verbose
930 print the installed policy table after configuring.
933 .It Va cloned_interfaces
935 Set to the list of clonable network interfaces to create on this host.
937 .Va cloned_interfaces
938 are automatically appended to
939 .Va network_interfaces
941 .It Va gif_interfaces
945 tunnel interfaces to configure on this host.
947 .Va gifconfig_ Ns Aq Ar interface
948 variable is assumed to exist for each value of
950 The value of this variable is used to configure the link layer of the
951 tunnel according to the syntax of the
955 Additionally, this option ensures that each listed interface is created via the
959 before attempting to configure it.
960 .It Va sppp_interfaces
964 interfaces to configure on this host.
966 .Va spppconfig_ Ns Aq Ar interface
967 variable is assumed to exist for each value of
969 Each interface should also be configured by a general
970 .Va ifconfig_ Ns Aq Ar interface
974 for more information about available options.
984 Mode in which to run the
993 See the manual for a full description.
998 enables network address translation.
999 Used in conjunction with
1001 allows hosts on private network addresses access to the Internet using
1002 this host as a network address translating router.
1005 The name of the profile to use from
1006 .Pa /etc/ppp/ppp.conf .
1007 Also used for per-profile overrides of
1008 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1009 Where the profile contains any of the characters
1011 they are translated to
1013 for the purposes of the override variable names.
1014 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1016 Set the unit number to be used for this profile.
1017 See the manual description of
1024 The name of the user under which
1031 .It Va rc_conf_files
1033 This option is used to specify a list of files that will override
1035 .Pa /etc/defaults/rc.conf .
1036 The files will be read in the order in which they are specified and should
1037 include the full path to the file.
1038 By default, the files specified are
1041 .Pa /etc/rc.conf.local
1042 .It Va fsck_y_enable
1047 will be run with the
1049 flag if the initial preen of the file systems fails.
1052 List of file system types that are network-based.
1053 This list should generally not be modified by end users.
1055 .Va extra_netfs_types
1057 .It Va extra_netfs_types
1059 If set to something other than
1061 (the default), this variable extends the list of file system types
1062 for which automatic mounting at startup by
1064 should be delayed until the network is initialized.
1066 a whitespace-separated list of network file system descriptor pairs,
1067 each consisting of a file system type as passed to
1069 and a human-readable, one-word description, joined with a colon
1071 Extending the default list in this way is only necessary
1072 when third party file system types are used.
1073 .It Va devfs_config_files
1075 This option is used to specify a list of configuration files containing
1077 rules that will be applied by
1079 in the order in which they are specified and must include the full path
1081 .It Va tmpfs_var_run
1089 Necessary directories under there will be automatically created.
1098 .It Va syslogd_enable
1105 .It Va syslogd_program
1110 .Pa /usr/sbin/syslogd ) .
1111 .It Va syslogd_flags
1117 these are the flags to pass to
1126 .It Va inetd_program
1131 .Pa /usr/sbin/inetd ) .
1138 these are the flags to pass to
1146 daemon at boot time.
1153 these are the flags to pass to it.
1159 will be updated at boot time to reflect the kernel release being run.
1163 will not be updated.
1164 .It Va nfs_client_enable
1168 setup NFS client parameters at boot time.
1169 .It Va nfs_access_cache
1172 .Va nfs_client_enable
1177 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1178 NFS ACCESS results should be cached.
1179 A value of 2-10 seconds will substantially reduce network traffic for
1180 many NFS operations.
1181 The default is 5 seconds.
1182 Note that the attribute cache holds stat information only.
1183 The NFS data cache is independent of the attribute cache and is only
1184 invalidated when the client detects that the server has modified the
1186 This value specifies a maximum timeout.
1187 The NFS client will automatically use a shorter timeout for files which
1188 have been recently modified.
1189 .It Va nfs_neg_cache
1192 .Va nfs_client_enable
1197 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1198 filenames), or to the number of seconds for which negative lookups should
1200 A value of 2-10 seconds will substantially reduce network
1201 traffic for many NFS operations, especially source code builds.
1202 The default is 3 seconds.
1203 .It Va nfs_server_enable
1207 run the NFS server daemons at boot time.
1208 .It Va nfs_server_flags
1211 .Va nfs_server_enable
1214 these are the flags to pass to the
1217 .It Va mountd_enable
1222 .Va nfs_server_enable
1228 It is commonly needed to run CFS without real NFS used.
1235 these are the flags to pass to the
1238 .It Va weak_mountd_authentication
1242 allow services like PCNFSD to make non-privileged mount requests.
1243 .It Va nfs_reserved_port_only
1247 provide NFS services only on a secure port.
1248 .It Va nfs_bufpackets
1250 If set to a number, indicates the number of packets worth of
1251 socket buffer space to reserve on an NFS client.
1252 The kernel default is typically 4.
1253 Using a higher number may be useful on gigabit networks to improve performance.
1254 The minimum value is 2 and the maximum is 64.
1255 .It Va rpc_umntall_enable
1259 (default) and we are also an NFS client, run
1261 at boot time to clear out old mounts on remote servers.
1266 will not be run at boot time.
1267 .It Va rpc_lockd_enable
1271 and also an NFS server, run
1274 .It Va rpc_lockd_flags
1277 .Va rpc_lockd_enable
1280 these are the flags to pass to
1282 .It Va rpc_statd_enable
1286 and also an NFS server, run
1289 .It Va rpc_statd_flags
1292 .Va rpc_statd_enable
1295 these are the flags to pass to
1297 .It Va rpcbind_program
1299 Path to program for rpcbind daemon
1301 .Pa /usr/sbin/rpcbind ) .
1302 .It Va rpcbind_enable
1309 .It Va rpcbind_flags
1315 these are the flags to pass to
1316 .Va rpcbind_program .
1317 .It Va keyserv_enable
1323 daemon on boot for running Secure RPC.
1324 .It Va keyserv_flags
1330 these are the flags to pass to
1333 .It Va pppoed_enable
1339 daemon at boot time to provide PPP over Ethernet services.
1340 .It Va pppoed_provider
1343 listens to requests to this provider and ultimately runs
1347 argument of the same name.
1350 Additional flags to pass to
1352 .It Va pppoed_interface
1354 The network interface to run
1357 This is mandatory when
1367 at system boot time.
1368 .It Va dntpd_program
1373 .Pa /usr/sbin/dntpd ) .
1380 these are the flags to pass to the
1383 .It Va btconfig_enable
1387 configure Bluetooth devices via
1389 at system boot time.
1390 .It Va btconfig_devices
1396 this is the list of Bluetooth devices to configure.
1398 .Va btconfig_devices
1399 is not specified, all devices known to the system will be configured.
1401 .Va btconfig_ Ns Aq Ar device
1402 variable can be set to specify parameters to be passed to
1404 .It Va btconfig_args
1410 this is the list of configuration parameters to pass to all Bluetooth
1416 run the Service Discovery Profile daemon
1418 at system boot time.
1425 these are the flags to pass to the
1428 .It Va bthcid_enable
1432 run the Bluetooth Link Key/PIN Code Manager daemon
1434 at system boot time.
1441 these are the flags to pass to the
1444 .It Va nis_client_enable
1450 service at system boot time.
1451 .It Va nis_client_flags
1454 .Va nis_client_enable
1457 these are the flags to pass to the
1460 .It Va nis_ypset_enable
1466 daemon at system boot time.
1467 .It Va nis_ypset_flags
1470 .Va nis_ypset_enable
1473 these are the flags to pass to the
1476 .It Va nis_server_enable
1482 daemon at system boot time.
1483 .It Va nis_server_flags
1486 .Va nis_server_enable
1489 these are the flags to pass to the
1492 .It Va nis_ypxfrd_enable
1498 daemon at system boot time.
1499 .It Va nis_ypxfrd_flags
1502 .Va nis_ypxfrd_enable
1505 these are the flags to pass to the
1508 .It Va nis_yppasswdd_enable
1514 daemon at system boot time.
1515 .It Va nis_yppasswdd_flags
1518 .Va nis_yppasswdd_enable
1521 these are the flags to pass to the
1524 .It Va rpc_ypupdated_enable
1530 daemon at system boot time.
1531 .It Va defaultrouter
1535 create a default route to this host name or IP address
1536 (use an IP address if this router is also required to get to the
1538 .It Va ipv6_defaultrouter
1540 The IPv6 equivalent of
1542 .It Va static_routes
1544 Set to the list of static routes that are to be added at system boot time.
1547 then for each whitespace separated
1550 .Va route_ Ns Aq Ar element
1551 variable is assumed to exist whose contents will later be passed to a
1554 .It Va change_routes
1556 Set to the list of static routes that are to be changed at system boot time
1557 (such as those added by the kernel).
1560 then for each whitespace separated
1563 .Va change_route_ Ns Aq Ar element
1564 variable is assumed to exist whose contents will later be passed to a
1565 .Dq Nm route Cm change
1567 .It Va ipv6_static_routes
1569 The IPv6 equivalent of
1573 then for each whitespace separated
1576 .Va ipv6_route_ Ns Aq Ar element
1577 variable is assumed to exist whose contents will later be passed to a
1578 .Dq Nm route Cm add Fl inet6
1580 .It Va gateway_enable
1584 configure host to act as an IP router, e.g. to forward packets
1586 .It Va ipv6_gateway_enable
1588 The IPv6 equivalent of
1589 .Va gateway_enable .
1590 .It Va router_enable
1594 run a routing daemon of some sort, based on the settings of
1598 .It Va ipv6_router_enable
1600 The IPv6 equivalent of
1604 run a routing daemon of some sort, based on the settings of
1605 .Va ipv6_router_program
1607 .Va ipv6_router_flags .
1608 .It Va router_program
1614 this is the name of the routing daemon to use
1616 .Pa /sbin/routed ) .
1617 .It Va ipv6_router_program
1619 The IPv6 equivalent of
1622 .Pa /sbin/route6d ) .
1629 these are the flags to pass to the routing daemon.
1630 .It Va ipv6_router_flags
1632 The IPv6 equivalent of
1634 .It Va rtadvd_enable
1640 daemon at boot time.
1643 .Va ipv6_gateway_enable
1648 utility sends router advertisement packets to the interfaces specified in
1649 .Va rtadvd_interfaces .
1651 and should only be enabled with great care.
1652 You may want to fine-tune
1654 .It Va rtadvd_interfaces
1660 this is the list of interfaces to use.
1661 .It Va rtsold_enable
1667 daemon at boot time.
1670 daemon is used for automatic discovery of non-link local addresses.
1677 these are the flags to pass to the
1684 enable global proxy ARP.
1685 .It Va forward_sourceroute
1693 source-routed packets are forwarded.
1694 .It Va accept_sourceroute
1698 the system will accept source-routed packets directed at it.
1705 daemon at system boot time.
1712 these are the flags to pass to the
1715 .It Va wpa_supplicant_enable
1720 .Xr wpa_supplicant 8
1722 .Dq interface matching mode
1723 at system boot time.
1724 .It Va wpa_supplicant_program
1727 .Xr wpa_supplicant 8 .
1728 .It Va wpa_supplicant_flags
1731 .Va wpa_supplicant_enable
1734 these are the flags to pass to the
1735 .Xr wpa_supplicant 8
1737 .It Va bootparamd_enable
1743 daemon at system boot time.
1744 .It Va bootparamd_flags
1747 .Va bootparamd_enable
1750 these are the flags to pass to the
1753 .It Va stf_interface_ipv4addr
1757 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1758 Specify this entry to enable the 6to4 interface.
1759 .It Va stf_interface_ipv4plen
1761 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1762 An effective value is 0-31.
1763 .It Va stf_interface_ipv6_ifid
1765 IPv6 interface ID for
1769 .It Va stf_interface_ipv6_slaid
1771 IPv6 Site Level Aggregator for
1775 The keyboard bell sound.
1782 if the default behavior is desired.
1783 For details, refer to the
1790 no keymap is installed, otherwise the value is used to install
1792 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1795 The keyboard repeat speed.
1802 if the default behavior is desired.
1807 attempt to program the function keys with the value.
1808 The value should be a single string of the form:
1809 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1812 Can be set to the value of
1815 .Dq Li destructive ,
1818 to set the cursor behavior explicitly or choose the default behavior.
1823 no screen map is installed, otherwise the value is used to install
1824 the screen map file in
1825 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1830 the default 8x16 font value is used for screen size requests, otherwise
1832 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1838 the default 8x14 font value is used for screen size requests, otherwise
1840 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1846 the default 8x8 font value is used for screen size requests, otherwise
1848 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1854 the default screen blanking interval is used, otherwise it is set to
1861 this is the actual screen saver to use
1862 .Li ( blank , snake , daemon ,
1864 .It Va moused_nondefault_enable
1868 the mouse device specified on
1869 the command line is not automatically treated as enabled by the
1870 .Pa /etc/rc.d/moused
1872 Having this variable set to
1878 to be enabled as soon as it is plugged in.
1879 .It Va moused_enable
1885 daemon is started for doing cut/paste selection on the console.
1892 this is the protocol type of the mouse connected to this host.
1898 is able to detect the appropriate mouse type automatically in many cases.
1899 Leave this variable at the default
1901 to let the daemon detect it, or
1902 select one from the following list if the automatic detection fails.
1904 If the mouse is attached to the PS/2 mouse port, leave the variable at the
1909 regardless of the brand and model of the mouse.
1910 Likewise, if the mouse is attached to the bus mouse port, leave it at
1914 All other protocols are for serial mice and will not work with
1915 the PS/2 and bus mice.
1916 If this is a USB mouse,
1918 is the only protocol type which will work.
1920 .Bl -tag -width ".Li x10mouseremote" -compact
1922 Microsoft mouse (serial)
1924 Microsoft IntelliMouse (serial)
1926 Mouse systems Corp. mouse (serial)
1928 MM Series mouse (serial)
1930 Logitech mouse (serial)
1934 Logitech MouseMan and TrackMan (serial)
1936 ALPS GlidePoint (serial)
1937 .It Li thinkingmouse
1938 Kensington ThinkingMouse (serial)
1942 MM HitTablet (serial)
1943 .It Li x10mouseremote
1944 X10 MouseRemote (serial)
1946 Interlink VersaPad (serial)
1949 Even if the mouse is not in the above list, it may be compatible
1950 with one in the list.
1951 Refer to the man page for
1953 for compatibility information.
1955 It should also be noted that while this is enabled, any
1956 other client of the mouse (such as an X server) should access
1957 the mouse through the virtual mouse device,
1959 and configure it as a
1961 type mouse, since all
1962 mouse data is converted to this single canonical format when using
1964 If the client program does not support the
1969 It is the second preferred type.
1976 this is the actual port the mouse is on.
1979 for a COM1 serial mouse or
1981 for a PS/2 mouse, for example.
1986 is set, these are the additional flags to pass to the
1989 .It Va mousechar_start
1993 the default mouse cursor character range
1994 .Li 0xd0 Ns - Ns Li 0xd3
1995 is used, otherwise the range start is set to
1999 Use if the default range is occupied in the language code table.
2002 Set the size of the history (scrollback) buffer in lines.
2003 .It Va allscreens_flags
2007 is run with these options for each of the virtual terminals
2011 will enable the mouse pointer on all virtual terminals if
2015 .It Va allscreens_kbdflags
2019 is run with these options for each of the virtual terminals
2025 scrollback (history) buffer to 200 lines.
2032 daemon at system boot time.
2038 .Pa /usr/sbin/cron ) .
2045 these are the flags to pass to
2052 .Pa /usr/sbin/lpd ) .
2059 daemon at system boot time.
2066 these are the flags to pass to the
2075 daemon at system boot time.
2082 settings across reboots.
2083 .It Va mta_start_script
2085 The full path to the script to run to start
2086 a mail transfer agent.
2088 .Pa /etc/rc.sendmail .
2092 .Pa /etc/rc.sendmail
2093 uses are documented in the
2099 .Sq HAMMER ROOT with UFS /boot
2100 setup, the boot loader will not set up the
2103 The system will attempt to fix this on its own.
2104 Set this variable to
2106 to turn this behavior off.
2109 Indicates the device (usually a swap partition) to which a crash dump
2110 should be written in the event of a system crash.
2111 The value of this variable is passed as the argument to
2115 To disable crash dumps, set this variable to
2119 When the system reboots after a crash and a crash dump is found on the
2120 device specified by the
2124 will save that crash dump and a copy of the kernel to the directory
2128 The default value is
2137 .It Va savecore_flags
2139 If crash dumps are enabled, these are the flags to pass to the
2142 .It Va crashinfo_enable
2146 to turn on automatic crash dump summary generation using the utility
2148 .Va crashinfo_program
2150 .It Va crashinfo_program
2152 Program to run to generate a crash dump summary if the variable
2153 .Va crashinfo_enable
2156 The default value is
2157 .Pa /usr/sbin/crashinfo .
2158 .It Va enable_quotas
2162 to turn on user disk quotas on system startup via the
2169 to enable user disk quota checking via the
2172 .It Va accounting_enable
2176 to enable system accounting through the
2179 .\" ----- cleanvar_enable setting--------------------------------
2180 .It Va cleanvar_enable
2188 .Pa /var/spool/uucp/.Temp/*
2190 .\" ----- clear_tmp_enable setting-------------------------------
2191 .It Va clear_tmp_enable
2198 .\" ----- ldconfig_paths setting --------------------------------
2199 .It Va ldconfig_paths
2201 Set to the list of shared library paths to use with
2205 will always be added first, so it need not appear in this list.
2206 .It Va ldconfig_insecure
2210 utility normally refuses to use directories
2211 which are writable by anyone except root.
2212 Set this variable to
2214 to disable that security check during system startup.
2215 .It Va ldconfig_local_dirs
2217 Set to the list of local
2220 The names of all files in the directories listed will be
2221 passed as arguments to
2223 .It Va kern_securelevel
2225 The kernel security level to set at startup.
2226 The allowed range of
2228 ranges from \-1 (the compile time default) to 3 (the most secure).
2231 for the list of possible security levels and their effect on system operation.
2238 at system boot time.
2245 at system boot time.
2248 Path to the SSH server program
2250 .Pa /usr/sbin/sshd ) .
2257 these are the flags to pass to the
2266 at system boot time.
2273 these are the flags to pass to the
2276 .It Va watchdogd_enable
2282 daemon at boot time.
2287 any configured jails will not be started.
2290 A space separated list of names for jails.
2291 This is purely a configuration aid to help identify and
2292 configure multiple jails.
2293 The names specified in this list will be used to
2294 identify settings common to an instance of a jail.
2295 Assuming that the jail in question was named
2297 you would have the following dependent variables:
2299 jail_vjail_hostname="jail.example.com"
2300 jail_vjail_ip="192.168.1.100"
2301 jail_vjail_rootdir="/var/jails/vjail/root"
2306 When set, use as default value for
2307 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2310 .It Va jail_interface
2313 When set, use as default value for
2314 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2320 When set, use as default value for
2321 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2324 .It Va jail_mount_enable
2332 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2335 by default for every jail in
2337 .It Va jail_procfs_enable
2345 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2348 by default for every jail in
2350 .It Va jail_devfs_enable
2358 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2361 by default for every jail in
2363 .It Va jail_exec_start
2366 When set, use as default value for
2367 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2370 .It Va jail_exec_stop
2372 When set, use as default value for
2373 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2376 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2379 Set to the root directory used by jail
2381 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2384 Set to the fully qualified domain name (FQDN) assigned to jail
2386 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2389 Set to the IP address assigned to jail
2391 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2396 These are flags to pass to
2398 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2401 When set, sets the interface to use when setting IP address alias.
2402 Note that the alias is created at jail startup and removed at jail shutdown.
2403 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2406 .Pa /etc/fstab. Ns Aq Ar jname
2408 This is the file system information file to use for jail
2410 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2417 mount all file systems from
2418 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2420 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2427 mount the process file system inside jail
2430 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2437 mount the device file system inside jail
2440 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2443 .Dq Li /bin/sh /etc/rc
2445 This is the command executed at jail startup.
2446 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2449 .Dq Li /bin/sh /etc/rc.shutdown
2451 This is the command executed at jail shutdown.
2452 .It Va jail_default_set_hostname_allow
2456 do not allow the root user in a jail to set its hostname.
2457 .It Va jail_default_socket_unixiproute_only
2461 do not allow any sockets,
2462 besides UNIX/IP/route sockets,
2463 to be used within a jail.
2464 .It Va jail_default_sysvipc_allow
2468 allow applications within a jail to use System V IPC.
2469 .It Va jail_default_chflags_allow
2473 allow applications within a jail to alter system file flags.
2474 .It Va jail_default_raw_sockets_allow
2478 allow applications within a jail to user raw sockets.
2479 .It Va jail_default_allow_listen_override
2483 allows both wildcard and non-wildcard listen sockets in the jail to
2484 override wildcard listen sockets on the host.
2489 LVM volumes will be discovered and configured on boot.
2490 .It Va newsyslog_enable
2496 before syslogd starts.
2497 .It Va newsyslog_flags
2500 .Va newsyslog_enable
2503 these are the flags passed to
2505 .It Va resident_enable
2509 make the dynamic binaries listed in
2510 .Pa /etc/resident.conf
2512 .It Va varsym_enable
2517 .Pa /etc/varsym.conf
2518 to set system-wide variables for variant symlinks.
2523 or a whitespace separated list of IRQ numbers which will be used as a source of
2525 .\" -----------------------------------------------------
2530 to disable caching entropy via
2532 Otherwise set to the directory used to store entropy files in.
2537 to disable caching entropy through reboots.
2538 Otherwise set to the filename used to store cached entropy through reboots.
2539 This file should be located on the root file system to seed the
2541 device as early as possible in the boot process.
2542 .It Va entropy_save_sz
2544 Determines the size of the entropy cache files used for entropy cached
2545 through reboots and also entropy cached via
2547 The entropy is fed to the system in blocks of 512 bytes, so this number
2548 should be large enough to fill as many of the entropy pools in the kernel
2550 By default, it is set to 16384, which should be able to seed all 32 entropy
2551 pools in the Fortuna CSPRNG.
2559 .Pa /var/run/dmesg.boot
2561 .It Va rcshutdown_timeout
2563 If set, start a watchdog timer in the background which will terminate
2567 has not completed within the specified time (in seconds).
2568 Notice that in addition to this soft timeout,
2570 also applies a hard timeout for the execution of
2572 This is configured via
2575 .Va kern.init_shutdown_timeout
2576 and defaults to 120 seconds. Setting the value of
2577 .Va rcshutdown_timeout
2578 to more than 120 seconds will have no effect until the
2581 .Va kern.init_shutdown_timeout
2587 the udevd daemon will be started on boot.
2588 .It Va vfs_quota_enable
2592 vfs quota rc.d scripts will be run on boot.
2593 .It Va vfs_quota_sync
2595 List of mount points whose counters are to be synchronized with on-disk
2596 usage during system startup.
2599 .It Va vknetd_enable
2604 will be started on boot.
2607 Additional flags passed to
2609 Usually address/cidrbits is specified here.
2610 When no flags are passed, default option
2613 .It Va vkernel_enable
2617 any configured vkernels will not be started.
2618 .It Va vkernel_kill_timeout
2620 This defines the default number of seconds that we will wait for the
2621 vkernel to shut down on its own.
2622 If after this time it's still alive,
2623 it will be killed with SIGKILL.
2626 Defines the default path to the vkernel binary.
2629 A space separated list of names for vkernels.
2630 This is purely a configuration aid to help identify and
2631 configure multiple vkernels.
2632 The names specified in this list will be used to
2633 identify settings common to a vkernel instance.
2634 Assuming that the vkernel in question was named
2636 you would have the following dependent variables
2637 (filled with reference values in this text):
2639 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL64/kernel.debug"
2640 vkernel_example_memsize="64m"
2641 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2642 vkernel_example_memimg="/var/vkernel/memimg.000001"
2643 vkernel_example_user="myuser"
2644 vkernel_example_iface_list="auto:bridge0"
2645 vkernel_example_logfile="/dev/null"
2646 vkernel_example_flags="-U"
2647 vkernel_example_kill_timeout="45"
2650 The last six are optional.
2651 They default to an empty string if not set, except for logfile which defaults to
2661 which is the vkernel's default directory for memory images,
2662 with permissions of 1777, i.e. world writable with the sticky bit set
2665 .It Va autofs_enable
2675 daemons at boot time.
2676 .It Va automount_flags
2682 these are the flags to pass to the
2685 By default no flags are passed.
2686 .It Va automountd_flags
2692 these are the flags to pass to the
2695 By default no flags are passed.
2696 .It Va autounmountd_flags
2702 these are the flags to pass to the
2705 By default no flags are passed.
2708 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2709 .It Pa /etc/defaults/rc.conf
2711 .It Pa /etc/rc.conf.local
2712 .It Pa /etc/start_if. Ns Aq Ar interface
2731 .Xr resident.conf 5 ,
2736 .Xr autounmountd 8 ,
2781 .Xr wpa_supplicant 8 ,
2792 .An Jordan K. Hubbard .