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 $
26 .\" $DragonFly: src/share/man/man5/rc.conf.5,v 1.61 2008/10/20 07:35:08 swildner Exp $
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the installer.
45 is not to run commands or perform system startup actions directly.
46 Instead, it is included by the various generic startup scripts in
48 which conditionalize their
49 internal actions according to the settings found there.
52 .Pa /etc/defaults/rc.conf
53 file specifies the default settings for all the available options,
56 file specifies override settings.
57 Options need only be specified in
59 when the system administrator wishes to override the defaults.
61 .Pa /etc/rc.conf.local
62 is used to override settings in
64 for historical reasons.
69 The following list provides a name and short description for each
70 variable that can be set in the
87 These values are case insensitive.
90 postfix in the name of a variable for starting a service can be
93 .Bl -tag -width indent-two
98 enable output of debug messages from rc scripts.
99 This variable can be helpful in diagnosing mistakes when
100 editing or integrating new scripts.
101 Beware that this produces copious output to the terminal and
107 disable informational messages from the rc scripts.
108 Informational messages are displayed when
109 a condition that is not serious enough to warrant a warning or an error occurs.
114 no swapfile is installed, otherwise the value is used as the full
115 pathname to a file to use for additional swap space.
120 enable support for Automatic Power Management with the
127 to handle APM event from userland.
128 This also enables support for APM.
135 these are the flags to pass to the
141 to monitor the status of batteries present in the system.
142 This also enables support for APM.
149 these are the flags to pass to the
156 to handle device added, removed or unknown events from the kernel.
163 these are the flags to pass to the
166 .It Va sensorsd_enable
175 a sensors monitoring and logging daemon.
176 .It Va sensorsd_flags
179 Additional flags passed to the
182 .It Va pccard_ifconfig
184 List of arguments to be passed to
186 at boot time or on insertion of the card (e.g.\&
187 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
188 for a fixed address or
191 .It Va pccard_ether_delay
193 Set the delay before starting
196 .Pa /etc/pccard_ether
198 This defaults to 5 seconds to work around a bug in the
200 driver which can lead to system hangs when using some newer
203 .It Va removable_interfaces
205 List of removable network interfaces to be supported by
206 .Pa /etc/pccard_ether .
209 List of directories to search for startup script files.
210 .It Va script_name_sep
212 The field separator to use for breaking down the list of startup script files
213 into individual filenames.
214 The default is a space.
215 It is not necessary to change this unless there are startup scripts with names
217 .It Va hostapd_enable
226 The fully qualified domain name (FQDN) of this host on the network.
227 This should almost certainly be set to something meaningful, even if
228 there is no network connection.
231 is used to set the hostname via DHCP,
232 this variable should be set to an empty string.
235 Enable support for IPv6 networking.
236 Note that this requires that the kernel have been compiled with
237 .Cd "options INET6" .
240 The NIS domain name of this host, or
243 .It Va dhclient_program
245 Path to the DHCP client program
247 .Pa /sbin/dhclient ) .
248 .It Va dhclient_flags
250 Additional flags to pass to the DHCP client program.
258 If the kernel was not built with
262 kernel module will be loaded.
266 .Va ipfilter_enable .
271 ruleset definition file.
282 these are the flags to pass to
284 when loading the ruleset.
291 which logs packets from
299 this specifies the path of the log file.
310 these are the flags to pass to
312 .It Va firewall_enable
316 to load firewall rules at startup.
317 If the kernel was not built with
318 .Cd "options IPFIREWALL" ,
321 kernel module will be loaded.
325 .Va ipfilter_enable .
326 .It Va ipv6_firewall_enable
328 The IPv6 equivalent of
329 .Va firewall_enable .
332 to load IPv6 firewall rules at startup.
333 If the kernel was not built with
334 .Cd "options IPV6FIREWALL" ,
337 kernel module will be loaded.
338 .It Va firewall_script
340 The full path to the firewall script to run
342 .Pa /etc/rc.firewall ) .
343 .It Va ipv6_firewall_script
345 The IPv6 equivalent of
346 .Va firewall_script .
349 Names the firewall type from the selection in
350 .Pa /etc/rc.firewall ,
351 or the file which contains the local firewall ruleset.
352 Valid selections from
356 .Bl -tag -width ".Li simple" -compact
358 unrestricted IP access
360 all IP services disabled, except via
363 basic protection for a workstation on a LAN
369 If a filename is specified, the full path must be given.
370 .It Va firewall_trusted_nets
372 List of trusted networks (if
376 .It Va firewall_trusted_interfaces
378 List of trusted network interfaces (if
382 .It Va firewall_allowed_icmp_types
384 List of allowed ICMP types (if
388 .It Va firewall_open_tcp_ports
390 List of TCP ports to open (if
394 .It Va firewall_open_udp_ports
396 List of UDP ports to open (if
400 .It Va ipv6_firewall_type
402 The IPv6 equivalent of
404 .It Va firewall_quiet
408 to disable the display of firewall rules on the console during boot.
409 .It Va ipv6_firewall_quiet
411 The IPv6 equivalent of
413 .It Va firewall_logging
417 to enable firewall event logging.
418 This is equivalent to the
419 .Dv IPFIREWALL_VERBOSE
421 .It Va ipv6_firewall_logging
423 The IPv6 equivalent of
424 .Va firewall_logging .
425 .It Va firewall_flags
431 specifies a filename.
432 .It Va ipv6_firewall_flags
434 The IPv6 equivalent of
451 sockets must be enabled in the kernel.
452 .It Va natd_interface
454 This is the name of the public interface on which
457 The interface may be given as an interface name or as an IP address.
462 flags should be placed here.
467 flag is automatically added with the above
470 .\" ----- ipfilter_enable setting --------------------------------
471 .It Va ipfilter_enable
482 Typical usage will require putting
484 ipfilter_enable="YES"
502 can be enabled independently.
506 both require at least one of
516 options IPFILTER_DEFAULT_BLOCK
519 in the kernel configuration file is a good idea, too.
523 .Va firewall_enable .
524 .\" ----- ipfilter_program setting ------------------------------
525 .It Va ipfilter_program
531 .\" ----- ipfilter_rules setting --------------------------------
532 .It Va ipfilter_rules
537 The name of the filter rule definition file.
538 The file is expected to be readable for the
541 .\" ----- ipv6_ipfilter_rules setting ---------------------------
542 .It Va ipv6_ipfilter_rules
547 The name of the IPv6 filter rule definition file.
548 The file is expected to be readable for the
551 .\" ----- ipfilter_flags setting --------------------------------
552 .It Va ipfilter_flags
558 .\" ----- ipnat_enable setting ----------------------------------
568 network address translation.
571 for a detailed discussion.
572 .\" ----- ipnat_program setting ---------------------------------
579 .\" ----- ipnat_rules setting -----------------------------------
586 holding the network address translation definition.
587 This file is expected to be readable for the
590 .\" ----- ipnat_flags setting -----------------------------------
597 .\" ----- ipmon_enable setting ----------------------------------
612 Setting this variable needs setting
619 for a detailed discussion.
620 .\" ----- ipmon_program setting ---------------------------------
627 .\" ----- ipmon_flags setting -----------------------------------
636 Another typical example would be
637 .Dq Fl D Pa /var/log/ipflog
640 log directly to a file bypassing
643 .Pa /etc/newsyslog.conf
644 in such case like this:
646 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
648 .\" ----- ipfs_enable setting -----------------------------------
658 saving the filter and NAT state tables during shutdown
659 and reloading them during startup again.
660 Setting this variable needs setting
669 for a detailed discussion.
674 cannot be used because the raised securelevel will prevent
676 from saving the state tables at shutdown time.
677 .\" ----- ipfs_program setting ----------------------------------
684 .\" ----- ipfs_flags setting ------------------------------------
691 .\" ----- end of added ipf hook ---------------------------------
692 .It Va tcp_extensions
699 disables certain TCP options as described by
705 might help remedy such problems with connections as randomly hanging
706 or other weird behavior.
707 Some network devices are known to be broken with respect to these options.
714 .Va net.inet.tcp.log_in_vain
716 .Va net.inet.udp.log_in_vain ,
721 are set to the given value.
729 will disable probing idle TCP connections to verify that the
730 peer is still up and reachable.
731 .It Va tcp_drop_synfin
738 will cause the kernel to ignore TCP frames that have both
739 the SYN and FIN flags set.
740 This prevents OS fingerprinting, but may break some legitimate applications.
741 This option is only available if the kernel was built with the
744 .It Va icmp_drop_redirect
751 will cause the kernel to ignore ICMP REDIRECT packets.
754 for more information.
755 .It Va icmp_log_redirect
762 will cause the kernel to log ICMP REDIRECT packets.
764 the log messages are not rate-limited, so this option should only be used
765 for troubleshooting networks.
768 for more information.
769 .It Va icmp_bmcastecho
773 to respond to broadcast or multicast ICMP ping packets.
776 for more information.
777 .It Va ip_portrange_first
781 this is the first port in the default portrange.
784 for more information.
785 .It Va ip_portrange_last
789 this is the last port in the default portrange.
792 for more information.
794 .It Va ifconfig_ Ns Aq Ar interface
798 Typically includes IP address.
799 Assuming that the interface in question was
801 it might look something like this:
803 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
807 .Pa /etc/start_if. Ns Aq Ar interface
808 file is present, it is read and executed by the
810 interpreter before configuring the interface as specified in the
811 .Va ifconfig_ Ns Aq Ar interface
813 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
816 It is possible to bring up an interface with DHCP by adding
819 .Va ifconfig_ Ns Aq Ar interface
821 For instance, to initialize the
823 device via DHCP, it is possible to use something like:
828 Also, if your interface needs WPA authentication, it is possible to add
831 .Va ifconfig_ Ns Aq Ar interface
834 .Xr wpa_supplicant 8 .
836 .Xr wpa_supplicant.conf 5
837 for configuring authentication information.
841 options in this variable, in addition to the
842 .Pa /etc/start_if. Ns Aq Ar interface
844 For instance, to initialize the
846 device via DHCP, using WPA authentication and 802.11b mode, it is
847 possible to use something like:
849 ifconfig_wi0="up DHCP WPA mode 11b"
853 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
855 Configuration to establish an additional network address for
857 Assuming that the interface in question was
859 it might look something like this:
861 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
862 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
867 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
868 entry that is found, its contents are passed to
870 Execution stops at the first unsuccessful access, so if
871 something like this is present:
873 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
874 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
875 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
876 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
879 Then note that alias4 would
881 be added since the search would stop with the missing alias3 entry.
884 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
888 It is possible to rename interface by doing:
890 ifconfig_ed0_name="net0"
891 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
893 .It Va network_interfaces
895 The list of network interfaces to configure on this host,
898 to configure all network interfaces
901 For example, if the only network devices to be configured are the loopback device
905 driver, this could be set to
908 .Va ifconfig_ Ns Aq Ar interface
909 variable is assumed to exist for each value of
911 .It Va ipv6_network_interfaces
913 This is the IPv6 equivalent of
914 .Va network_interfaces .
915 Instead of setting the ifconfig variables as
916 .Va ifconfig_ Ns Aq Ar interface
917 they should be set as
918 .Va ipv6_ifconfig_ Ns Aq Ar interface .
919 Aliases should be set as
920 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
921 Interfaces that do not have a
922 .Va ipv6_ifconfig_ Ns Aq Ar interface
923 setting will be auto configured by
926 .Va ipv6_gateway_enable
929 Note that the IPv6 networking code does not support the
930 .Pa /etc/start_if. Ns Aq Ar interface
932 .It Va ipv6_prefix_ Ns Aq Ar interface
936 prefixlen 64 is used.
937 .It Va ipv6_default_interface
941 this is the default output interface for scoped addresses.
942 Now this works only for IPv6 link local multicast addresses.
943 .It Va cloned_interfaces
945 Set to the list of clonable network interfaces to create on this host.
947 .Va cloned_interfaces
948 are automatically appended to
949 .Va network_interfaces
951 .It Va gif_interfaces
955 tunnel interfaces to configure on this host.
957 .Va gifconfig_ Ns Aq Ar interface
958 variable is assumed to exist for each value of
960 The value of this variable is used to configure the link layer of the
961 tunnel according to the syntax of the
965 Additionally, this option ensures that each listed interface is created via the
969 before attempting to configure it.
970 .It Va sppp_interfaces
974 interfaces to configure on this host.
976 .Va spppconfig_ Ns Aq Ar interface
977 variable is assumed to exist for each value of
979 Each interface should also be configured by a general
980 .Va ifconfig_ Ns Aq Ar interface
984 for more information about available options.
994 Mode in which to run the
1003 See the manual for a full description.
1008 enables network address translation.
1009 Used in conjunction with
1011 allows hosts on private network addresses access to the Internet using
1012 this host as a network address translating router.
1015 The name of the profile to use from
1016 .Pa /etc/ppp/ppp.conf .
1019 The name of the user under which
1026 .It Va rc_conf_files
1028 This option is used to specify a list of files that will override
1030 .Pa /etc/defaults/rc.conf .
1031 The files will be read in the order in which they are specified and should
1032 include the full path to the file.
1033 By default, the files specified are
1036 .Pa /etc/rc.conf.local
1037 .It Va fsck_y_enable
1042 will be run with the
1044 flag if the initial preen of the file systems fails.
1047 List of file system types that are network-based.
1048 This list should generally not be modified by end users.
1050 .Va extra_netfs_types
1052 .It Va extra_netfs_types
1054 If set to something other than
1056 (the default), this variable extends the list of file system types
1057 for which automatic mounting at startup by
1059 should be delayed until the network is initialized.
1061 a whitespace-separated list of network file system descriptor pairs,
1062 each consisting of a file system type as passed to
1064 and a human-readable, one-word description, joined with a colon
1066 Extending the default list in this way is only necessary
1067 when third party file system types are used.
1068 .It Va syslogd_enable
1075 .It Va syslogd_program
1080 .Pa /usr/sbin/syslogd ) .
1081 .It Va syslogd_flags
1087 these are the flags to pass to
1096 .It Va inetd_program
1101 .Pa /usr/sbin/inetd ) .
1108 these are the flags to pass to
1117 .It Va named_program
1122 .Pa /usr/sbin/named ) .
1129 these are the flags to pass to
1131 .It Va named_pidfile
1133 This is the default path to the
1136 Change it if you change the location in
1137 .Pa /etc/namedb/named.conf .
1138 .It Va named_chrootdir
1140 The root directory for a name server run in a
1145 will not be run in a
1148 .It Va kerberos5_server_enable
1152 to start a Kerberos 5 authentication server at boot time.
1153 .It Va kerberos5_server_program
1156 .Va kerberos5_server_enable
1159 this is the path to Kerberos 5 Authentication Server.
1160 .It Va kadmind5_server_enable
1166 the Kerberos 5 Administration Daemon; set to
1169 .It Va kadmind5_server_program
1172 .Va kadmind5_server_enable
1175 this is the path to Kerberos 5 Administration Daemon.
1176 .It Va kpasswdd_server_enable
1182 the Kerberos 5 Password-Changing Daemon; set to
1185 .It Va kpasswdd_server_program
1188 .Va kpasswdd_server_enable
1191 this is the path to Kerberos 5 Password-Changing Daemon.
1198 daemon at boot time.
1205 these are the flags to pass to it.
1212 daemon at boot time.
1219 these are the flags to pass to it.
1222 manpage for more information.
1223 .It Va amd_map_program
1225 If set, the specified program is run to get the list of
1230 maps are stored in NIS, one can set this to run
1242 will be updated at boot time to reflect the kernel release being run.
1246 will not be updated.
1247 .It Va nfs_client_enable
1251 run the NFS client daemons at boot time.
1252 .It Va nfs_client_flags
1255 .Va nfs_client_enable
1258 these are the flags to pass to the
1261 .It Va nfs_access_cache
1264 .Va nfs_client_enable
1269 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1270 NFS ACCESS results should be cached.
1271 A value of 2-10 seconds will substantially reduce network traffic for
1272 many NFS operations.
1273 The default is 5 seconds.
1274 Note that the attribute cache holds stat information only.
1275 The NFS data cache is independent of the attribute cache and is only
1276 invalidated when the client detects that the server has modified the
1278 This value specifies a maximum timeout.
1279 The NFS client will automatically use a shorter timeout for files which
1280 have been recently modified.
1281 .It Va nfs_neg_cache
1284 .Va nfs_client_enable
1289 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1290 filenames), or to the number of seconds for which negative lookups should
1292 A value of 2-10 seconds will substantially reduce network
1293 traffic for many NFS operations, especially source code builds.
1294 The default is 3 seconds.
1295 .It Va nfs_server_enable
1299 run the NFS server daemons at boot time.
1300 .It Va nfs_server_flags
1303 .Va nfs_server_enable
1306 these are the flags to pass to the
1309 .It Va mountd_enable
1314 .Va nfs_server_enable
1320 It is commonly needed to run CFS without real NFS used.
1327 these are the flags to pass to the
1330 .It Va weak_mountd_authentication
1334 allow services like PCNFSD to make non-privileged mount requests.
1335 .It Va nfs_reserved_port_only
1339 provide NFS services only on a secure port.
1340 .It Va nfs_bufpackets
1342 If set to a number, indicates the number of packets worth of
1343 socket buffer space to reserve on an NFS client.
1344 The kernel default is typically 4.
1345 Using a higher number may be useful on gigabit networks to improve performance.
1346 The minimum value is 2 and the maximum is 64.
1347 .It Va rpc_umntall_enable
1351 (default) and we are also an NFS client, run
1353 at boot time to clear out old mounts on remote servers.
1358 will not be run at boot time.
1359 .It Va rpc_lockd_enable
1363 and also an NFS server, run
1366 .It Va rpc_lockd_flags
1369 .Va rpc_lockd_enable
1372 these are the flags to pass to
1374 .It Va rpc_statd_enable
1378 and also an NFS server, run
1381 .It Va rpc_statd_flags
1384 .Va rpc_statd_enable
1387 these are the flags to pass to
1389 .It Va rpcbind_program
1391 Path to program for rpcbind daemon
1393 .Pa /usr/sbin/rpcbind ) .
1394 .It Va rpcbind_enable
1401 .It Va rpcbind_flags
1407 these are the flags to pass to
1408 .Va rpcbind_program .
1409 .It Va keyserv_enable
1415 daemon on boot for running Secure RPC.
1416 .It Va keyserv_flags
1422 these are the flags to pass to
1425 .It Va pppoed_enable
1431 daemon at boot time to provide PPP over Ethernet services.
1432 .It Va pppoed_provider
1435 listens to requests to this provider and ultimately runs
1439 argument of the same name.
1442 Additional flags to pass to
1444 .It Va pppoed_interface
1446 The network interface to run
1449 This is mandatory when
1459 service at boot time.
1460 This command is intended for networks of machines where a consistent
1462 for all hosts must be established.
1463 This is often useful in large NFS environments where time stamps on
1464 files are expected to be consistent network-wide.
1471 these are the flags to pass to the
1480 at system boot time.
1481 .It Va dntpd_program
1486 .Pa /usr/sbin/dntpd ) .
1493 these are the flags to pass to the
1496 .It Va btconfig_enable
1500 configure Bluetooth devices via
1502 at system boot time.
1503 .It Va btconfig_devices
1509 this is the list of Bluetooth devices to configure.
1511 .Va btconfig_devices
1512 is not specified, all devices known to the system will be configured.
1514 .Va btconfig_ Ns Aq Ar device
1515 variable can be set to specify parameters to be passed to
1517 .It Va btconfig_args
1523 this is the list of configuration parameters to pass to all Bluetooth
1529 run the Service Discovery Profile daemon
1531 at system boot time.
1538 these are the flags to pass to the
1541 .It Va bthcid_enable
1545 run the Bluetooth Link Key/PIN Code Manager daemon
1547 at system boot time.
1554 these are the flags to pass to the
1557 .It Va nis_client_enable
1563 service at system boot time.
1564 .It Va nis_client_flags
1567 .Va nis_client_enable
1570 these are the flags to pass to the
1573 .It Va nis_ypset_enable
1579 daemon at system boot time.
1580 .It Va nis_ypset_flags
1583 .Va nis_ypset_enable
1586 these are the flags to pass to the
1589 .It Va nis_server_enable
1595 daemon at system boot time.
1596 .It Va nis_server_flags
1599 .Va nis_server_enable
1602 these are the flags to pass to the
1605 .It Va nis_ypxfrd_enable
1611 daemon at system boot time.
1612 .It Va nis_ypxfrd_flags
1615 .Va nis_ypxfrd_enable
1618 these are the flags to pass to the
1621 .It Va nis_yppasswdd_enable
1627 daemon at system boot time.
1628 .It Va nis_yppasswdd_flags
1631 .Va nis_yppasswdd_enable
1634 these are the flags to pass to the
1637 .It Va rpc_ypupdated_enable
1643 daemon at system boot time.
1644 .It Va defaultrouter
1648 create a default route to this host name or IP address
1649 (use an IP address if this router is also required to get to the
1651 .It Va ipv6_defaultrouter
1653 The IPv6 equivalent of
1655 .It Va static_routes
1657 Set to the list of static routes that are to be added at system boot time.
1660 then for each whitespace separated
1663 .Va route_ Ns Aq Ar element
1664 variable is assumed to exist whose contents will later be passed to a
1667 .It Va ipv6_static_routes
1669 The IPv6 equivalent of
1673 then for each whitespace separated
1676 .Va ipv6_route_ Ns Aq Ar element
1677 variable is assumed to exist whose contents will later be passed to a
1678 .Dq Nm route Cm add Fl inet6
1680 .It Va gateway_enable
1684 configure host to act as an IP router, e.g. to forward packets
1686 .It Va ipv6_gateway_enable
1688 The IPv6 equivalent of
1689 .Va gateway_enable .
1690 .It Va router_enable
1694 run a routing daemon of some sort, based on the settings of
1698 .It Va ipv6_router_enable
1700 The IPv6 equivalent of
1704 run a routing daemon of some sort, based on the settings of
1705 .Va ipv6_router_program
1707 .Va ipv6_router_flags .
1708 .It Va router_program
1714 this is the name of the routing daemon to use
1716 .Pa /sbin/routed ) .
1717 .It Va ipv6_router_program
1719 The IPv6 equivalent of
1722 .Pa /sbin/route6d ) .
1729 these are the flags to pass to the routing daemon.
1730 .It Va ipv6_router_flags
1732 The IPv6 equivalent of
1734 .It Va mrouted_enable
1738 run the multicast routing daemon,
1740 .It Va mroute6d_enable
1742 The IPv6 equivalent of
1743 .Va mrouted_enable .
1746 run the IPv6 multicast routing daemon.
1747 Note that no IPv6 multicast routing daemon is included in the
1751 can be installed from the
1754 .It Va mrouted_flags
1760 these are the flags to pass to the
1763 .It Va mroute6d_flags
1765 The IPv6 equivalent of
1771 these are the flags passed to the IPv6 multicast routing daemon.
1772 .It Va mroute6d_program
1778 this is the path to the IPv6 multicast routing daemon.
1779 .It Va rtadvd_enable
1785 daemon at boot time.
1788 .Va ipv6_gateway_enable
1793 utility sends router advertisement packets to the interfaces specified in
1794 .Va rtadvd_interfaces .
1796 and should only be enabled with great care.
1797 You may want to fine-tune
1799 .It Va rtadvd_interfaces
1805 this is the list of interfaces to use.
1806 .It Va rtsold_enable
1812 daemon at boot time.
1815 daemon is used for automatic discovery of non-link local addresses.
1822 these are the flags to pass to the
1825 .It Va ipxgateway_enable
1829 enable the routing of IPX traffic.
1830 .It Va ipxrouted_enable
1836 daemon at system boot time.
1837 .It Va ipxrouted_flags
1840 .Va ipxrouted_enable
1843 these are the flags to pass to the
1850 enable global proxy ARP.
1851 .It Va forward_sourceroute
1859 source-routed packets are forwarded.
1860 .It Va accept_sourceroute
1864 the system will accept source-routed packets directed at it.
1871 daemon at system boot time.
1878 these are the flags to pass to the
1881 .It Va bootparamd_enable
1887 daemon at system boot time.
1888 .It Va bootparamd_flags
1891 .Va bootparamd_enable
1894 these are the flags to pass to the
1897 .It Va stf_interface_ipv4addr
1901 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1902 Specify this entry to enable the 6to4 interface.
1903 .It Va stf_interface_ipv4plen
1905 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1906 An effective value is 0-31.
1907 .It Va stf_interface_ipv6_ifid
1909 IPv6 interface ID for
1913 .It Va stf_interface_ipv6_slaid
1915 IPv6 Site Level Aggregator for
1917 .It Va ipv6_faith_prefix
1921 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1925 .It Va ipv6_ipv4mapping
1929 this enables IPv4 mapped IPv6 address communication (like
1930 .Li ::ffff:a.b.c.d ) .
1935 to enable the configuration of ATM interfaces at system boot time.
1936 For all of the ATM variables described below, please refer to the
1938 man page for further details on the available command parameters.
1939 Also refer to the files in
1940 .Pa /usr/share/examples/atm
1941 for more detailed configuration information.
1942 .It Va atm_netif_ Ns Aq Ar intf
1944 For the ATM physical interface
1946 this variable defines the name prefix and count for the ATM network
1947 interfaces to be created.
1948 The value will be passed as the parameters of an
1949 .Dq Nm atm Cm "set netif" Ar intf
1951 .It Va atm_sigmgr_ Ns Aq Ar intf
1953 For the ATM physical interface
1955 this variable defines the ATM signalling manager to be used.
1956 The value will be passed as the parameters of an
1957 .Dq Nm atm Cm attach Ar intf
1959 .It Va atm_prefix_ Ns Aq Ar intf
1961 For the ATM physical interface
1963 this variable defines the NSAP prefix for interfaces using a UNI signalling
1967 the prefix will automatically be set via the
1970 Otherwise, the value will be passed as the parameters of an
1971 .Dq Nm atm Cm "set prefix" Ar intf
1973 .It Va atm_macaddr_ Ns Aq Ar intf
1975 For the ATM physical interface
1977 this variable defines the MAC address for interfaces using a UNI signalling
1981 the hardware MAC address contained in the ATM interface card will be used.
1982 Otherwise, the value will be passed as the parameters of an
1983 .Dq Nm atm Cm "set mac" Ar intf
1985 .It Va atm_arpserver_ Ns Aq Ar netif
1987 For the ATM network interface
1989 this variable defines the ATM address for a host which is to provide ATMARP
1991 This variable is only applicable to interfaces using a UNI signalling manager.
1994 this host will become an ATMARP server.
1995 The value will be passed as the parameters of an
1996 .Dq Nm atm Cm "set arpserver" Ar netif
1998 .It Va atm_scsparp_ Ns Aq Ar netif
2002 SCSP/ATMARP service for the network interface
2004 will be initiated using the
2009 This variable is only applicable if
2010 .Va atm_arpserver_ Ns Aq Ar netif
2015 Set to the list of permanent ATM ARP entries to be added at system boot time.
2016 For each whitespace separated
2019 .Va atm_arp_ Ns Aq Ar element
2020 variable is assumed to exist.
2021 The value of each of these variables will be passed as the parameters of an
2022 .Dq Nm atm Cm "add arp"
2026 The keyboard bell sound.
2033 if the default behavior is desired.
2034 For details, refer to the
2041 no keymap is installed, otherwise the value is used to install
2043 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2046 The keyboard repeat speed.
2053 if the default behavior is desired.
2058 attempt to program the function keys with the value.
2059 The value should be a single string of the form:
2060 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2063 Can be set to the value of
2066 .Dq Li destructive ,
2069 to set the cursor behavior explicitly or choose the default behavior.
2074 no screen map is installed, otherwise the value is used to install
2075 the screen map file in
2076 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2081 the default 8x16 font value is used for screen size requests, otherwise
2083 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2089 the default 8x14 font value is used for screen size requests, otherwise
2091 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2097 the default 8x8 font value is used for screen size requests, otherwise
2099 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2105 the default screen blanking interval is used, otherwise it is set to
2112 this is the actual screen saver to use
2113 .Li ( blank , snake , daemon ,
2115 .It Va moused_enable
2121 daemon is started for doing cut/paste selection on the console.
2124 This is the protocol type of the mouse connected to this host.
2125 This variable must be set if
2132 is able to detect the appropriate mouse type automatically in many cases.
2133 Set this variable to
2135 to let the daemon detect it, or
2136 select one from the following list if the automatic detection fails.
2138 If the mouse is attached to the PS/2 mouse port, choose
2142 regardless of the brand and model of the mouse.
2143 Likewise, if the mouse is attached to the bus mouse port, choose
2147 All other protocols are for serial mice and will not work with
2148 the PS/2 and bus mice.
2149 If this is a USB mouse,
2151 is the only protocol type which will work.
2153 .Bl -tag -width ".Li x10mouseremote" -compact
2155 Microsoft mouse (serial)
2157 Microsoft IntelliMouse (serial)
2159 Mouse systems Corp. mouse (serial)
2161 MM Series mouse (serial)
2163 Logitech mouse (serial)
2167 Logitech MouseMan and TrackMan (serial)
2169 ALPS GlidePoint (serial)
2170 .It Li thinkingmouse
2171 Kensington ThinkingMouse (serial)
2175 MM HitTablet (serial)
2176 .It Li x10mouseremote
2177 X10 MouseRemote (serial)
2179 Interlink VersaPad (serial)
2182 Even if the mouse is not in the above list, it may be compatible
2183 with one in the list.
2184 Refer to the man page for
2186 for compatibility information.
2188 It should also be noted that while this is enabled, any
2189 other client of the mouse (such as an X server) should access
2190 the mouse through the virtual mouse device,
2192 and configure it as a
2194 type mouse, since all
2195 mouse data is converted to this single canonical format when using
2197 If the client program does not support the
2202 It is the second preferred type.
2209 this is the actual port the mouse is on.
2212 for a COM1 serial mouse,
2216 for a bus mouse, for example.
2221 is set, these are the additional flags to pass to the
2224 .It Va mousechar_start
2228 the default mouse cursor character range
2229 .Li 0xd0 Ns - Ns Li 0xd3
2230 is used, otherwise the range start is set to
2234 Use if the default range is occupied in the language code table.
2237 Set the size of the history (scrollback) buffer in lines.
2238 .It Va allscreens_flags
2242 is run with these options for each of the virtual terminals
2246 will enable the mouse pointer on all virtual terminals if
2250 .It Va allscreens_kbdflags
2254 is run with these options for each of the virtual terminals
2260 scrollback (history) buffer to 200 lines.
2267 daemon at system boot time.
2273 .Pa /usr/sbin/cron ) .
2280 these are the flags to pass to
2287 .Pa /usr/sbin/lpd ) .
2294 daemon at system boot time.
2301 these are the flags to pass to the
2310 daemon at system boot time.
2317 settings across reboots.
2318 .It Va mta_start_script
2320 The full path to the script to run to start
2321 a mail transfer agent.
2323 .Pa /etc/rc.sendmail .
2327 .Pa /etc/rc.sendmail
2328 uses are documented in the
2333 Indicates the device (usually a swap partition) to which a crash dump
2334 should be written in the event of a system crash.
2335 The value of this variable is passed as the argument to
2337 To disable crash dumps, set this variable to
2341 When the system reboots after a crash and a crash dump is found on the
2342 device specified by the
2346 will save that crash dump and a copy of the kernel to the directory
2350 The default value is
2359 .It Va savecore_flags
2361 If crash dumps are enabled, these are the flags to pass to the
2364 .It Va enable_quotas
2368 to turn on user disk quotas on system startup via the
2375 to enable user disk quota checking via the
2378 .It Va accounting_enable
2382 to enable system accounting through the
2389 to enable Linux/ELF binary emulation at system initial boot time.
2390 .It Va sysvipc_enable
2394 load System V IPC primitives at boot time.
2395 .\" ----- cleanvar_enable setting--------------------------------
2396 .It Va cleanvar_enable
2404 .Pa /var/spool/uucp/.Temp/*
2406 .\" ----- clear_tmp_enable setting-------------------------------
2407 .It Va clear_tmp_enable
2414 .\" ----- ldconfig_paths setting --------------------------------
2415 .It Va ldconfig_paths
2417 Set to the list of shared library paths to use with
2421 will always be added first, so it need not appear in this list.
2422 .It Va ldconfig_insecure
2426 utility normally refuses to use directories
2427 which are writable by anyone except root.
2428 Set this variable to
2430 to disable that security check during system startup.
2431 .It Va kern_securelevel
2433 The kernel security level to set at startup.
2434 The allowed range of
2436 ranges from \-1 (the compile time default) to 3 (the most secure).
2439 for the list of possible security levels and their effect on system operation.
2446 at system boot time.
2453 at system boot time.
2456 Path to the SSH server program
2458 .Pa /usr/sbin/sshd ) .
2465 these are the flags to pass to the
2474 at system boot time.
2481 these are the flags to pass to the
2490 daemon at boot time.
2497 these are the flags passed to
2500 .It Va watchdogd_enable
2506 daemon at boot time.
2507 This requires that the kernel have been compiled with
2508 .Cd "options WATCHDOG" .
2513 any configured jails will not be started.
2516 A space separated list of names for jails.
2517 This is purely a configuration aid to help identify and
2518 configure multiple jails.
2519 The names specified in this list will be used to
2520 identify settings common to an instance of a jail.
2521 Assuming that the jail in question was named
2523 you would have the following dependent variables:
2525 jail_vjail_hostname="jail.example.com"
2526 jail_vjail_ip="192.168.1.100"
2527 jail_vjail_rootdir="/var/jails/vjail/root"
2533 When set, use as default value for
2534 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2537 .It Va jail_interface
2540 When set, use as default value for
2541 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2547 When set, use as default value for
2548 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2551 .It Va jail_mount_enable
2559 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2562 by default for every jail in
2564 .It Va jail_fdesc_enable
2572 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2575 by default for every jail in
2577 .It Va jail_procfs_enable
2585 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2588 by default for every jail in
2590 .It Va jail_exec_start
2593 When set, use as default value for
2594 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2597 .It Va jail_exec_stop
2599 When set, use as default value for
2600 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2603 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2606 Set to the root directory used by jail
2608 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2611 Set to the fully qualified domain name (FQDN) assigned to jail
2613 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2616 Set to the IP address assigned to jail
2618 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2623 These are flags to pass to
2625 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2628 When set, sets the interface to use when setting IP address alias.
2629 Note that the alias is created at jail startup and removed at jail shutdown.
2630 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2633 .Pa /etc/fstab. Ns Aq Ar jname
2635 This is the file system information file to use for jail
2637 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2644 mount all file systems from
2645 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2647 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2654 mount the file-descriptor file system inside jail
2657 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2664 mount the process file system inside jail
2667 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2670 .Dq Li /bin/sh /etc/rc
2672 This is the command executed at jail startup.
2673 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2676 .Dq Li /bin/sh /etc/rc.shutdown
2678 This is the command executed at jail shutdown.
2679 .It Va jail_set_hostname_allow
2683 do not allow the root user in a jail to set its hostname.
2684 .It Va jail_socket_unixiproute_only
2688 do not allow any sockets,
2689 besides UNIX/IP/route sockets,
2690 to be used within a jail.
2691 .It Va jail_sysvipc_allow
2695 allow applications within a jail to use System V IPC.
2696 .It Va newsyslog_enable
2702 before syslogd starts.
2703 .It Va newsyslog_flags
2706 .Va newsyslog_enable
2709 these are the flags passed to
2711 .It Va resident_enable
2715 make the dynamic binaries listed in
2716 .Pa /etc/resident.conf
2718 .It Va varsym_enable
2723 .Pa /etc/varsym.conf
2724 to set system-wide variables for variant symlinks.
2729 or a whitespace separated list of IRQ numbers which will be used as a source of
2731 .\" ----- isdn settings ---------------------------------
2741 daemon at system boot time.
2745 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2747 Additional flags to pass to
2753 for certain tunable parameters).
2759 The terminal type of the output device when
2761 operates in full-screen mode.
2762 .It Va isdn_screenflags
2767 The video mode for full-screen mode (only for
2777 The output device for
2779 in full-screen mode (or
2789 enables the ISDN protocol trace utility
2791 at system boot time.
2792 .It Va isdn_traceflags
2795 .Dq Fl f Pa /var/tmp/isdntrace0
2799 .\" -----------------------------------------------------
2804 to disable caching entropy via
2806 Otherwise set to the directory used to store entropy files in.
2811 to disable caching entropy through reboots.
2812 Otherwise set to the filename used to store cached entropy through reboots.
2813 This file should be located on the root file system to seed the
2815 device as early as possible in the boot process.
2827 Configuration file for
2836 .Pa /var/run/dmesg.boot
2838 .It Va rcshutdown_timeout
2840 If set, start a watchdog timer in the background which will terminate
2844 has not completed within the specified time (in seconds).
2847 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2848 .It Pa /etc/defaults/rc.conf
2850 .It Pa /etc/rc.conf.local
2851 .It Pa /etc/start_if. Ns Aq Ar interface
2869 .Xr resident.conf 5 ,
2933 .An Jordan K. Hubbard .