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.57.2.1 2008/08/04 21:05:59 thomas 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 variables 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
152 .It Va sensorsd_enable
161 a sensors monitoring and logging daemon.
162 .It Va sensorsd_flags
165 Additional flags passed to the
168 .It Va pccard_ifconfig
170 List of arguments to be passed to
172 at boot time or on insertion of the card (e.g.\&
173 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
174 for a fixed address or
177 .It Va pccard_ether_delay
179 Set the delay before starting
182 .Pa /etc/pccard_ether
184 This defaults to 5 seconds to work around a bug in the
186 driver which can lead to system hangs when using some newer
189 .It Va removable_interfaces
191 List of removable network interfaces to be supported by
192 .Pa /etc/pccard_ether .
195 List of directories to search for startup script files.
196 .It Va script_name_sep
198 The field separator to use for breaking down the list of startup script files
199 into individual filenames.
200 The default is a space.
201 It is not necessary to change this unless there are startup scripts with names
203 .It Va hostapd_enable
212 The fully qualified domain name (FQDN) of this host on the network.
213 This should almost certainly be set to something meaningful, even if
214 there is no network connection.
217 is used to set the hostname via DHCP,
218 this variable should be set to an empty string.
221 Enable support for IPv6 networking.
222 Note that this requires that the kernel have been compiled with
223 .Cd "options INET6" .
226 The NIS domain name of this host, or
229 .It Va dhclient_program
231 Path to the DHCP client program
233 .Pa /sbin/dhclient ) .
234 .It Va dhclient_flags
236 Additional flags to pass to the DHCP client program.
244 .It Va dhcrelay_enable
257 If the kernel was not built with
261 kernel module will be loaded.
265 .Va ipfilter_enable .
270 ruleset definition file.
281 these are the flags to pass to
283 when loading the ruleset.
290 which logs packets from
298 this specifies the path of the log file.
309 these are the flags to pass to
311 .It Va firewall_enable
315 to load firewall rules at startup.
316 If the kernel was not built with
317 .Cd "options IPFIREWALL" ,
320 kernel module will be loaded.
324 .Va ipfilter_enable .
325 .It Va ipv6_firewall_enable
327 The IPv6 equivalent of
328 .Va firewall_enable .
331 to load IPv6 firewall rules at startup.
332 If the kernel was not built with
333 .Cd "options IPV6FIREWALL" ,
336 kernel module will be loaded.
337 .It Va firewall_script
339 The full path to the firewall script to run
341 .Pa /etc/rc.firewall ) .
342 .It Va ipv6_firewall_script
344 The IPv6 equivalent of
345 .Va firewall_script .
348 Names the firewall type from the selection in
349 .Pa /etc/rc.firewall ,
350 or the file which contains the local firewall ruleset.
351 Valid selections from
355 .Bl -tag -width ".Li simple" -compact
357 unrestricted IP access
359 all IP services disabled, except via
362 basic protection for a workstation on a LAN
368 If a filename is specified, the full path must be given.
369 .It Va firewall_trusted_nets
371 List of trusted networks (if
375 .It Va firewall_trusted_interfaces
377 List of trusted network interfaces (if
381 .It Va firewall_allowed_icmp_types
383 List of allowed ICMP types (if
387 .It Va firewall_open_tcp_ports
389 List of TCP ports to open (if
393 .It Va firewall_open_udp_ports
395 List of UDP ports to open (if
399 .It Va ipv6_firewall_type
401 The IPv6 equivalent of
403 .It Va firewall_quiet
407 to disable the display of firewall rules on the console during boot.
408 .It Va ipv6_firewall_quiet
410 The IPv6 equivalent of
412 .It Va firewall_logging
416 to enable firewall event logging.
417 This is equivalent to the
418 .Dv IPFIREWALL_VERBOSE
420 .It Va ipv6_firewall_logging
422 The IPv6 equivalent of
423 .Va firewall_logging .
424 .It Va firewall_flags
430 specifies a filename.
431 .It Va ipv6_firewall_flags
433 The IPv6 equivalent of
450 sockets must be enabled in the kernel.
451 .It Va natd_interface
453 This is the name of the public interface on which
456 The interface may be given as an interface name or as an IP address.
461 flags should be placed here.
466 flag is automatically added with the above
469 .\" ----- ipfilter_enable setting --------------------------------
470 .It Va ipfilter_enable
481 Typical usage will require putting
483 ipfilter_enable="YES"
501 can be enabled independently.
505 both require at least one of
515 options IPFILTER_DEFAULT_BLOCK
518 in the kernel configuration file is a good idea, too.
522 .Va firewall_enable .
523 .\" ----- ipfilter_program setting ------------------------------
524 .It Va ipfilter_program
530 .\" ----- ipfilter_rules setting --------------------------------
531 .It Va ipfilter_rules
536 The name of the filter rule definition file.
537 The file is expected to be readable for the
540 .\" ----- ipv6_ipfilter_rules setting ---------------------------
541 .It Va ipv6_ipfilter_rules
546 The name of the IPv6 filter rule definition file.
547 The file is expected to be readable for the
550 .\" ----- ipfilter_flags setting --------------------------------
551 .It Va ipfilter_flags
557 .\" ----- ipnat_enable setting ----------------------------------
567 network address translation.
570 for a detailed discussion.
571 .\" ----- ipnat_program setting ---------------------------------
578 .\" ----- ipnat_rules setting -----------------------------------
585 holding the network address translation definition.
586 This file is expected to be readable for the
589 .\" ----- ipnat_flags setting -----------------------------------
596 .\" ----- ipmon_enable setting ----------------------------------
611 Setting this variable needs setting
618 for a detailed discussion.
619 .\" ----- ipmon_program setting ---------------------------------
626 .\" ----- ipmon_flags setting -----------------------------------
635 Another typical example would be
636 .Dq Fl D Pa /var/log/ipflog
639 log directly to a file bypassing
642 .Pa /etc/newsyslog.conf
643 in such case like this:
645 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
647 .\" ----- ipfs_enable setting -----------------------------------
657 saving the filter and NAT state tables during shutdown
658 and reloading them during startup again.
659 Setting this variable needs setting
668 for a detailed discussion.
673 cannot be used because the raised securelevel will prevent
675 from saving the state tables at shutdown time.
676 .\" ----- ipfs_program setting ----------------------------------
683 .\" ----- ipfs_flags setting ------------------------------------
690 .\" ----- end of added ipf hook ---------------------------------
691 .It Va tcp_extensions
698 disables certain TCP options as described by
704 might help remedy such problems with connections as randomly hanging
705 or other weird behavior.
706 Some network devices are known to be broken with respect to these options.
713 .Va net.inet.tcp.log_in_vain
715 .Va net.inet.udp.log_in_vain ,
720 are set to the given value.
728 will disable probing idle TCP connections to verify that the
729 peer is still up and reachable.
730 .It Va tcp_drop_synfin
737 will cause the kernel to ignore TCP frames that have both
738 the SYN and FIN flags set.
739 This prevents OS fingerprinting, but may break some legitimate applications.
740 This option is only available if the kernel was built with the
743 .It Va icmp_drop_redirect
750 will cause the kernel to ignore ICMP REDIRECT packets.
753 for more information.
754 .It Va icmp_log_redirect
761 will cause the kernel to log ICMP REDIRECT packets.
763 the log messages are not rate-limited, so this option should only be used
764 for troubleshooting networks.
767 for more information.
768 .It Va icmp_bmcastecho
772 to respond to broadcast or multicast ICMP ping packets.
775 for more information.
776 .It Va ip_portrange_first
780 this is the first port in the default portrange.
783 for more information.
784 .It Va ip_portrange_last
788 this is the last port in the default portrange.
791 for more information.
793 .It Va ifconfig_ Ns Aq Ar interface
797 Typically includes IP address.
798 Assuming that the interface in question was
800 it might look something like this:
802 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
806 .Pa /etc/start_if. Ns Aq Ar interface
807 file is present, it is read and executed by the
809 interpreter before configuring the interface as specified in the
810 .Va ifconfig_ Ns Aq Ar interface
812 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
815 It is possible to bring up an interface with DHCP by adding
818 .Va ifconfig_ Ns Aq Ar interface
820 For instance, to initialize the
822 device via DHCP, it is possible to use something like:
827 Also, if your interface needs WPA authentication, it is possible to add
830 .Va ifconfig_ Ns Aq Ar interface
833 .Xr wpa_supplicant 8 .
835 .Xr wpa_supplicant.conf 5
836 for configuring authentication information.
840 options in this variable, in addition to the
841 .Pa /etc/start_if. Ns Aq Ar interface
843 For instance, to initialize the
845 device via DHCP, using WPA authentication and 802.11b mode, it is
846 possible to use something like:
848 ifconfig_wi0="up DHCP WPA mode 11b"
852 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
854 Configuration to establish an additional network address for
856 Assuming that the interface in question was
858 it might look something like this:
860 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
861 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
866 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
867 entry that is found, its contents are passed to
869 Execution stops at the first unsuccessful access, so if
870 something like this is present:
872 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
873 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
874 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
875 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
878 Then note that alias4 would
880 be added since the search would stop with the missing alias3 entry.
883 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
887 It is possible to rename interface by doing:
889 ifconfig_ed0_name="net0"
890 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
892 .It Va network_interfaces
894 The list of network interfaces to configure on this host,
897 to configure all network interfaces
900 For example, if the only network devices to be configured are the loopback device
904 driver, this could be set to
907 .Va ifconfig_ Ns Aq Ar interface
908 variable is assumed to exist for each value of
910 .It Va ipv6_network_interfaces
912 This is the IPv6 equivalent of
913 .Va network_interfaces .
914 Instead of setting the ifconfig variables as
915 .Va ifconfig_ Ns Aq Ar interface
916 they should be set as
917 .Va ipv6_ifconfig_ Ns Aq Ar interface .
918 Aliases should be set as
919 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
920 Interfaces that do not have a
921 .Va ipv6_ifconfig_ Ns Aq Ar interface
922 setting will be auto configured by
925 .Va ipv6_gateway_enable
928 Note that the IPv6 networking code does not support the
929 .Pa /etc/start_if. Ns Aq Ar interface
931 .It Va ipv6_prefix_ Ns Aq Ar interface
935 prefixlen 64 is used.
936 .It Va ipv6_default_interface
940 this is the default output interface for scoped addresses.
941 Now this works only for IPv6 link local multicast addresses.
942 .It Va cloned_interfaces
944 Set to the list of clonable network interfaces to create on this host.
946 .Va cloned_interfaces
947 are automatically appended to
948 .Va network_interfaces
950 .It Va gif_interfaces
954 tunnel interfaces to configure on this host.
956 .Va gifconfig_ Ns Aq Ar interface
957 variable is assumed to exist for each value of
959 The value of this variable is used to configure the link layer of the
960 tunnel according to the syntax of the
964 Additionally, this option ensures that each listed interface is created via the
968 before attempting to configure it.
969 .It Va sppp_interfaces
973 interfaces to configure on this host.
975 .Va spppconfig_ Ns Aq Ar interface
976 variable is assumed to exist for each value of
978 Each interface should also be configured by a general
979 .Va ifconfig_ Ns Aq Ar interface
983 for more information about available options.
993 Mode in which to run the
1002 See the manual for a full description.
1007 enables network address translation.
1008 Used in conjunction with
1010 allows hosts on private network addresses access to the Internet using
1011 this host as a network address translating router.
1014 The name of the profile to use from
1015 .Pa /etc/ppp/ppp.conf .
1018 The name of the user under which
1025 .It Va rc_conf_files
1027 This option is used to specify a list of files that will override
1029 .Pa /etc/defaults/rc.conf .
1030 The files will be read in the order in which they are specified and should
1031 include the full path to the file.
1032 By default, the files specified are
1035 .Pa /etc/rc.conf.local
1036 .It Va fsck_y_enable
1041 will be run with the
1043 flag if the initial preen of the file systems fails.
1046 List of file system types that are network-based.
1047 This list should generally not be modified by end users.
1049 .Va extra_netfs_types
1051 .It Va extra_netfs_types
1053 If set to something other than
1055 (the default), this variable extends the list of file system types
1056 for which automatic mounting at startup by
1058 should be delayed until the network is initialized.
1060 a whitespace-separated list of network file system descriptor pairs,
1061 each consisting of a file system type as passed to
1063 and a human-readable, one-word description, joined with a colon
1065 Extending the default list in this way is only necessary
1066 when third party file system types are used.
1067 .It Va syslogd_enable
1074 .It Va syslogd_program
1079 .Pa /usr/sbin/syslogd ) .
1080 .It Va syslogd_flags
1086 these are the flags to pass to
1095 .It Va inetd_program
1100 .Pa /usr/sbin/inetd ) .
1107 these are the flags to pass to
1116 .It Va named_program
1121 .Pa /usr/sbin/named ) .
1128 these are the flags to pass to
1130 .It Va named_pidfile
1132 This is the default path to the
1135 Change it if you change the location in
1136 .Pa /etc/namedb/named.conf .
1137 .It Va named_chrootdir
1139 The root directory for a name server run in a
1144 will not be run in a
1147 .It Va kerberos5_server_enable
1151 to start a Kerberos 5 authentication server at boot time.
1152 .It Va kerberos5_server_program
1155 .Va kerberos5_server_enable
1158 this is the path to Kerberos 5 Authentication Server.
1159 .It Va kadmind5_server_enable
1165 the Kerberos 5 Administration Daemon; set to
1168 .It Va kadmind5_server_program
1171 .Va kadmind5_server_enable
1174 this is the path to Kerberos 5 Administration Daemon.
1175 .It Va kpasswdd_server_enable
1181 the Kerberos 5 Password-Changing Daemon; set to
1184 .It Va kpasswdd_server_program
1187 .Va kpasswdd_server_enable
1190 this is the path to Kerberos 5 Password-Changing Daemon.
1197 daemon at boot time.
1204 these are the flags to pass to it.
1211 daemon at boot time.
1218 these are the flags to pass to it.
1221 manpage for more information.
1222 .It Va amd_map_program
1224 If set, the specified program is run to get the list of
1229 maps are stored in NIS, one can set this to run
1241 will be updated at boot time to reflect the kernel release being run.
1245 will not be updated.
1246 .It Va nfs_client_enable
1250 run the NFS client daemons at boot time.
1251 .It Va nfs_client_flags
1254 .Va nfs_client_enable
1257 these are the flags to pass to the
1260 .It Va nfs_access_cache
1263 .Va nfs_client_enable
1268 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1269 NFS ACCESS results should be cached.
1270 A value of 2-10 seconds will substantially reduce network traffic for
1271 many NFS operations.
1272 The default is 5 seconds.
1273 Note that the attribute cache holds stat information only.
1274 The NFS data cache is independent of the attribute cache and is only
1275 invalidated when the client detects that the server has modified the
1277 This value specifies a maximum timeout.
1278 The NFS client will automatically use a shorter timeout for files which
1279 have been recently modified.
1280 .It Va nfs_neg_cache
1283 .Va nfs_client_enable
1288 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1289 filenames), or to the number of seconds for which negative lookups should
1291 A value of 2-10 seconds will substantially reduce network
1292 traffic for many NFS operations, especially source code builds.
1293 The default is 3 seconds.
1294 .It Va nfs_server_enable
1298 run the NFS server daemons at boot time.
1299 .It Va nfs_server_flags
1302 .Va nfs_server_enable
1305 these are the flags to pass to the
1308 .It Va mountd_enable
1313 .Va nfs_server_enable
1319 It is commonly needed to run CFS without real NFS used.
1326 these are the flags to pass to the
1329 .It Va weak_mountd_authentication
1333 allow services like PCNFSD to make non-privileged mount requests.
1334 .It Va nfs_reserved_port_only
1338 provide NFS services only on a secure port.
1339 .It Va nfs_bufpackets
1341 If set to a number, indicates the number of packets worth of
1342 socket buffer space to reserve on an NFS client.
1343 The kernel default is typically 4.
1344 Using a higher number may be useful on gigabit networks to improve performance.
1345 The minimum value is 2 and the maximum is 64.
1346 .It Va rpc_umntall_enable
1350 (default) and we are also an NFS client, run
1352 at boot time to clear out old mounts on remote servers.
1357 will not be run at boot time.
1358 .It Va rpc_lockd_enable
1362 and also an NFS server, run
1365 .It Va rpc_statd_enable
1369 and also an NFS server, run
1372 .It Va rpcbind_program
1374 Path to program for rpcbind daemon
1376 .Pa /usr/sbin/portmap ) .
1377 .It Va rpcbind_enable
1384 .It Va rpcbind_flags
1390 these are the flags to pass to
1391 .Va rpcbind_program .
1392 .It Va keyserv_enable
1398 daemon on boot for running Secure RPC.
1399 .It Va keyserv_flags
1405 these are the flags to pass to
1408 .It Va pppoed_enable
1414 daemon at boot time to provide PPP over Ethernet services.
1415 .It Va pppoed_provider
1418 listens to requests to this provider and ultimately runs
1422 argument of the same name.
1425 Additional flags to pass to
1427 .It Va pppoed_interface
1429 The network interface to run
1432 This is mandatory when
1442 service at boot time.
1443 This command is intended for networks of machines where a consistent
1445 for all hosts must be established.
1446 This is often useful in large NFS environments where time stamps on
1447 files are expected to be consistent network-wide.
1454 these are the flags to pass to the
1463 at system boot time.
1464 .It Va dntpd_program
1469 .Pa /usr/sbin/dntpd ) .
1476 these are the flags to pass to the
1479 .It Va btconfig_enable
1483 configure Bluetooth devices via
1485 at system boot time.
1486 .It Va btconfig_devices
1492 this is the list of Bluetooth devices to configure.
1494 .Va btconfig_devices
1495 is not specified, all devices known to the system will be configured.
1497 .Va btconfig_ Ns Aq Ar device
1498 variable can be set to specify parameters to be passed to
1500 .It Va btconfig_args
1506 this is the list of configuration parameters to pass to all Bluetooth
1512 run the Service Discovery Profile daemon
1514 at system boot time.
1521 these are the flags to pass to the
1524 .It Va bthcid_enable
1528 run the Bluetooth Link Key/PIN Code Manager daemon
1530 at system boot time.
1537 these are the flags to pass to the
1540 .It Va nis_client_enable
1546 service at system boot time.
1547 .It Va nis_client_flags
1550 .Va nis_client_enable
1553 these are the flags to pass to the
1556 .It Va nis_ypset_enable
1562 daemon at system boot time.
1563 .It Va nis_ypset_flags
1566 .Va nis_ypset_enable
1569 these are the flags to pass to the
1572 .It Va nis_server_enable
1578 daemon at system boot time.
1579 .It Va nis_server_flags
1582 .Va nis_server_enable
1585 these are the flags to pass to the
1588 .It Va nis_ypxfrd_enable
1594 daemon at system boot time.
1595 .It Va nis_ypxfrd_flags
1598 .Va nis_ypxfrd_enable
1601 these are the flags to pass to the
1604 .It Va nis_yppasswdd_enable
1610 daemon at system boot time.
1611 .It Va nis_yppasswdd_flags
1614 .Va nis_yppasswdd_enable
1617 these are the flags to pass to the
1620 .It Va rpc_ypupdated_enable
1626 daemon at system boot time.
1627 .It Va defaultrouter
1631 create a default route to this host name or IP address
1632 (use an IP address if this router is also required to get to the
1634 .It Va ipv6_defaultrouter
1636 The IPv6 equivalent of
1638 .It Va static_routes
1640 Set to the list of static routes that are to be added at system boot time.
1643 then for each whitespace separated
1646 .Va route_ Ns Aq Ar element
1647 variable is assumed to exist whose contents will later be passed to a
1650 .It Va ipv6_static_routes
1652 The IPv6 equivalent of
1656 then for each whitespace separated
1659 .Va ipv6_route_ Ns Aq Ar element
1660 variable is assumed to exist whose contents will later be passed to a
1661 .Dq Nm route Cm add Fl inet6
1663 .It Va gateway_enable
1667 configure host to act as an IP router, e.g. to forward packets
1669 .It Va ipv6_gateway_enable
1671 The IPv6 equivalent of
1672 .Va gateway_enable .
1673 .It Va router_enable
1677 run a routing daemon of some sort, based on the settings of
1681 .It Va ipv6_router_enable
1683 The IPv6 equivalent of
1687 run a routing daemon of some sort, based on the settings of
1688 .Va ipv6_router_program
1690 .Va ipv6_router_flags .
1691 .It Va router_program
1697 this is the name of the routing daemon to use
1699 .Pa /sbin/routed ) .
1700 .It Va ipv6_router_program
1702 The IPv6 equivalent of
1705 .Pa /sbin/route6d ) .
1712 these are the flags to pass to the routing daemon.
1713 .It Va ipv6_router_flags
1715 The IPv6 equivalent of
1717 .It Va mrouted_enable
1721 run the multicast routing daemon,
1723 .It Va mroute6d_enable
1725 The IPv6 equivalent of
1726 .Va mrouted_enable .
1729 run the IPv6 multicast routing daemon.
1730 Note that no IPv6 multicast routing daemon is included in the
1734 can be installed from the
1737 .It Va mrouted_flags
1743 these are the flags to pass to the
1746 .It Va mroute6d_flags
1748 The IPv6 equivalent of
1754 these are the flags passed to the IPv6 multicast routing daemon.
1755 .It Va mroute6d_program
1761 this is the path to the IPv6 multicast routing daemon.
1762 .It Va rtadvd_enable
1768 daemon at boot time.
1771 .Va ipv6_gateway_enable
1776 utility sends router advertisement packets to the interfaces specified in
1777 .Va rtadvd_interfaces .
1779 and should only be enabled with great care.
1780 You may want to fine-tune
1782 .It Va rtadvd_interfaces
1788 this is the list of interfaces to use.
1789 .It Va rtsold_enable
1795 daemon at boot time.
1798 daemon is used for automatic discovery of non-link local addresses.
1805 these are the flags to pass to the
1808 .It Va ipxgateway_enable
1812 enable the routing of IPX traffic.
1813 .It Va ipxrouted_enable
1819 daemon at system boot time.
1820 .It Va ipxrouted_flags
1823 .Va ipxrouted_enable
1826 these are the flags to pass to the
1833 enable global proxy ARP.
1834 .It Va forward_sourceroute
1842 source-routed packets are forwarded.
1843 .It Va accept_sourceroute
1847 the system will accept source-routed packets directed at it.
1854 daemon at system boot time.
1861 these are the flags to pass to the
1864 .It Va bootparamd_enable
1870 daemon at system boot time.
1871 .It Va bootparamd_flags
1874 .Va bootparamd_enable
1877 these are the flags to pass to the
1880 .It Va stf_interface_ipv4addr
1884 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1885 Specify this entry to enable the 6to4 interface.
1886 .It Va stf_interface_ipv4plen
1888 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1889 An effective value is 0-31.
1890 .It Va stf_interface_ipv6_ifid
1892 IPv6 interface ID for
1896 .It Va stf_interface_ipv6_slaid
1898 IPv6 Site Level Aggregator for
1900 .It Va ipv6_faith_prefix
1904 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1908 .It Va ipv6_ipv4mapping
1912 this enables IPv4 mapped IPv6 address communication (like
1913 .Li ::ffff:a.b.c.d ) .
1918 to enable the configuration of ATM interfaces at system boot time.
1919 For all of the ATM variables described below, please refer to the
1921 man page for further details on the available command parameters.
1922 Also refer to the files in
1923 .Pa /usr/share/examples/atm
1924 for more detailed configuration information.
1925 .It Va atm_netif_ Ns Aq Ar intf
1927 For the ATM physical interface
1929 this variable defines the name prefix and count for the ATM network
1930 interfaces to be created.
1931 The value will be passed as the parameters of an
1932 .Dq Nm atm Cm "set netif" Ar intf
1934 .It Va atm_sigmgr_ Ns Aq Ar intf
1936 For the ATM physical interface
1938 this variable defines the ATM signalling manager to be used.
1939 The value will be passed as the parameters of an
1940 .Dq Nm atm Cm attach Ar intf
1942 .It Va atm_prefix_ Ns Aq Ar intf
1944 For the ATM physical interface
1946 this variable defines the NSAP prefix for interfaces using a UNI signalling
1950 the prefix will automatically be set via the
1953 Otherwise, the value will be passed as the parameters of an
1954 .Dq Nm atm Cm "set prefix" Ar intf
1956 .It Va atm_macaddr_ Ns Aq Ar intf
1958 For the ATM physical interface
1960 this variable defines the MAC address for interfaces using a UNI signalling
1964 the hardware MAC address contained in the ATM interface card will be used.
1965 Otherwise, the value will be passed as the parameters of an
1966 .Dq Nm atm Cm "set mac" Ar intf
1968 .It Va atm_arpserver_ Ns Aq Ar netif
1970 For the ATM network interface
1972 this variable defines the ATM address for a host which is to provide ATMARP
1974 This variable is only applicable to interfaces using a UNI signalling manager.
1977 this host will become an ATMARP server.
1978 The value will be passed as the parameters of an
1979 .Dq Nm atm Cm "set arpserver" Ar netif
1981 .It Va atm_scsparp_ Ns Aq Ar netif
1985 SCSP/ATMARP service for the network interface
1987 will be initiated using the
1992 This variable is only applicable if
1993 .Va atm_arpserver_ Ns Aq Ar netif
1998 Set to the list of permanent ATM ARP entries to be added at system boot time.
1999 For each whitespace separated
2002 .Va atm_arp_ Ns Aq Ar element
2003 variable is assumed to exist.
2004 The value of each of these variables will be passed as the parameters of an
2005 .Dq Nm atm Cm "add arp"
2009 The keyboard bell sound.
2016 if the default behavior is desired.
2017 For details, refer to the
2024 no keymap is installed, otherwise the value is used to install
2026 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2029 The keyboard repeat speed.
2036 if the default behavior is desired.
2041 attempt to program the function keys with the value.
2042 The value should be a single string of the form:
2043 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2046 Can be set to the value of
2049 .Dq Li destructive ,
2052 to set the cursor behavior explicitly or choose the default behavior.
2057 no screen map is installed, otherwise the value is used to install
2058 the screen map file in
2059 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2064 the default 8x16 font value is used for screen size requests, otherwise
2066 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2072 the default 8x14 font value is used for screen size requests, otherwise
2074 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2080 the default 8x8 font value is used for screen size requests, otherwise
2082 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2088 the default screen blanking interval is used, otherwise it is set to
2095 this is the actual screen saver to use
2096 .Li ( blank , snake , daemon ,
2098 .It Va moused_enable
2104 daemon is started for doing cut/paste selection on the console.
2107 This is the protocol type of the mouse connected to this host.
2108 This variable must be set if
2115 is able to detect the appropriate mouse type automatically in many cases.
2116 Set this variable to
2118 to let the daemon detect it, or
2119 select one from the following list if the automatic detection fails.
2121 If the mouse is attached to the PS/2 mouse port, choose
2125 regardless of the brand and model of the mouse.
2126 Likewise, if the mouse is attached to the bus mouse port, choose
2130 All other protocols are for serial mice and will not work with
2131 the PS/2 and bus mice.
2132 If this is a USB mouse,
2134 is the only protocol type which will work.
2136 .Bl -tag -width ".Li x10mouseremote" -compact
2138 Microsoft mouse (serial)
2140 Microsoft IntelliMouse (serial)
2142 Mouse systems Corp. mouse (serial)
2144 MM Series mouse (serial)
2146 Logitech mouse (serial)
2150 Logitech MouseMan and TrackMan (serial)
2152 ALPS GlidePoint (serial)
2153 .It Li thinkingmouse
2154 Kensington ThinkingMouse (serial)
2158 MM HitTablet (serial)
2159 .It Li x10mouseremote
2160 X10 MouseRemote (serial)
2162 Interlink VersaPad (serial)
2165 Even if the mouse is not in the above list, it may be compatible
2166 with one in the list.
2167 Refer to the man page for
2169 for compatibility information.
2171 It should also be noted that while this is enabled, any
2172 other client of the mouse (such as an X server) should access
2173 the mouse through the virtual mouse device,
2175 and configure it as a
2177 type mouse, since all
2178 mouse data is converted to this single canonical format when using
2180 If the client program does not support the
2185 It is the second preferred type.
2192 this is the actual port the mouse is on.
2195 for a COM1 serial mouse,
2199 for a bus mouse, for example.
2204 is set, these are the additional flags to pass to the
2207 .It Va mousechar_start
2211 the default mouse cursor character range
2212 .Li 0xd0 Ns - Ns Li 0xd3
2213 is used, otherwise the range start is set to
2217 Use if the default range is occupied in the language code table.
2220 Set the size of the history (scrollback) buffer in lines.
2221 .It Va allscreens_flags
2225 is run with these options for each of the virtual terminals
2229 will enable the mouse pointer on all virtual terminals if
2233 .It Va allscreens_kbdflags
2237 is run with these options for each of the virtual terminals
2243 scrollback (history) buffer to 200 lines.
2250 daemon at system boot time.
2256 .Pa /usr/sbin/cron ) .
2263 these are the flags to pass to
2270 .Pa /usr/sbin/lpd ) .
2277 daemon at system boot time.
2284 these are the flags to pass to the
2293 settings across reboots.
2294 .It Va mta_start_script
2296 The full path to the script to run to start
2297 a mail transfer agent.
2299 .Pa /etc/rc.sendmail .
2303 .Pa /etc/rc.sendmail
2304 uses are documented in the
2309 Indicates the device (usually a swap partition) to which a crash dump
2310 should be written in the event of a system crash.
2311 The value of this variable is passed as the argument to
2313 To disable crash dumps, set this variable to
2317 When the system reboots after a crash and a crash dump is found on the
2318 device specified by the
2322 will save that crash dump and a copy of the kernel to the directory
2326 The default value is
2335 .It Va savecore_flags
2337 If crash dumps are enabled, these are the flags to pass to the
2340 .It Va enable_quotas
2344 to turn on user disk quotas on system startup via the
2351 to enable user disk quota checking via the
2354 .It Va accounting_enable
2358 to enable system accounting through the
2365 to enable Linux/ELF binary emulation at system initial boot time.
2366 .It Va sysvipc_enable
2370 load System V IPC primitives at boot time.
2371 .\" ----- cleanvar_enable setting--------------------------------
2372 .It Va cleanvar_enable
2380 .Pa /var/spool/uucp/.Temp/*
2382 .\" ----- clear_tmp_enable setting-------------------------------
2383 .It Va clear_tmp_enable
2390 .\" ----- ldconfig_paths setting --------------------------------
2391 .It Va ldconfig_paths
2393 Set to the list of shared library paths to use with
2397 will always be added first, so it need not appear in this list.
2398 .It Va ldconfig_insecure
2402 utility normally refuses to use directories
2403 which are writable by anyone except root.
2404 Set this variable to
2406 to disable that security check during system startup.
2407 .It Va kern_securelevel
2409 The kernel security level to set at startup.
2410 The allowed range of
2412 ranges from \-1 (the compile time default) to 3 (the most secure).
2415 for the list of possible security levels and their effect on system operation.
2422 at system boot time.
2429 at system boot time.
2432 Path to the SSH server program
2434 .Pa /usr/sbin/sshd ) .
2441 these are the flags to pass to the
2450 at system boot time.
2457 these are the flags to pass to the
2466 daemon at boot time.
2473 these are the flags passed to
2476 .It Va watchdogd_enable
2482 daemon at boot time.
2483 This requires that the kernel have been compiled with
2484 .Cd "options WATCHDOG" .
2489 any configured jails will not be started.
2492 A space separated list of names for jails.
2493 This is purely a configuration aid to help identify and
2494 configure multiple jails.
2495 The names specified in this list will be used to
2496 identify settings common to an instance of a jail.
2497 Assuming that the jail in question was named
2499 you would have the following dependent variables:
2501 jail_vjail_hostname="jail.example.com"
2502 jail_vjail_ip="192.168.1.100"
2503 jail_vjail_rootdir="/var/jails/vjail/root"
2509 When set, use as default value for
2510 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2513 .It Va jail_interface
2516 When set, use as default value for
2517 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2523 When set, use as default value for
2524 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2527 .It Va jail_mount_enable
2535 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2538 by default for every jail in
2540 .It Va jail_fdesc_enable
2548 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2551 by default for every jail in
2553 .It Va jail_procfs_enable
2561 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2564 by default for every jail in
2566 .It Va jail_exec_start
2569 When set, use as default value for
2570 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2573 .It Va jail_exec_stop
2575 When set, use as default value for
2576 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2579 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2582 Set to the root directory used by jail
2584 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2587 Set to the fully qualified domain name (FQDN) assigned to jail
2589 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2592 Set to the IP address assigned to jail
2594 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2599 These are flags to pass to
2601 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2604 When set, sets the interface to use when setting IP address alias.
2605 Note that the alias is created at jail startup and removed at jail shutdown.
2606 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2609 .Pa /etc/fstab. Ns Aq Ar jname
2611 This is the file system information file to use for jail
2613 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2620 mount all file systems from
2621 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2623 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2630 mount the file-descriptor file system inside jail
2633 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2640 mount the process file system inside jail
2643 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2646 .Dq Li /bin/sh /etc/rc
2648 This is the command executed at jail startup.
2649 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2652 .Dq Li /bin/sh /etc/rc.shutdown
2654 This is the command executed at jail shutdown.
2655 .It Va jail_set_hostname_allow
2659 do not allow the root user in a jail to set its hostname.
2660 .It Va jail_socket_unixiproute_only
2664 do not allow any sockets,
2665 besides UNIX/IP/route sockets,
2666 to be used within a jail.
2667 .It Va jail_sysvipc_allow
2671 allow applications within a jail to use System V IPC.
2672 .It Va newsyslog_enable
2678 before syslogd starts.
2679 .It Va newsyslog_flags
2682 .Va newsyslog_enable
2685 these are the flags passed to
2687 .It Va resident_enable
2691 make the dynamic binaries listed in
2692 .Pa /etc/resident.conf
2694 .It Va varsym_enable
2699 .Pa /etc/varsym.conf
2700 to set system-wide variables for variant symlinks.
2705 or a whitespace separated list of IRQ numbers which will be used as a source of
2707 .\" ----- isdn settings ---------------------------------
2717 daemon at system boot time.
2721 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2723 Additional flags to pass to
2729 for certain tunable parameters).
2735 The terminal type of the output device when
2737 operates in full-screen mode.
2738 .It Va isdn_screenflags
2743 The video mode for full-screen mode (only for
2753 The output device for
2755 in full-screen mode (or
2765 enables the ISDN protocol trace utility
2767 at system boot time.
2768 .It Va isdn_traceflags
2771 .Dq Fl f Pa /var/tmp/isdntrace0
2775 .\" -----------------------------------------------------
2780 to disable caching entropy via
2782 Otherwise set to the directory used to store entropy files in.
2787 to disable caching entropy through reboots.
2788 Otherwise set to the filename used to store cached entropy through reboots.
2789 This file should be located on the root file system to seed the
2791 device as early as possible in the boot process.
2803 Configuration file for
2812 .Pa /var/run/dmesg.boot
2814 .It Va rcshutdown_timeout
2816 If set, start a watchdog timer in the background which will terminate
2820 has not completed within the specified time (in seconds).
2823 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2824 .It Pa /etc/defaults/rc.conf
2826 .It Pa /etc/rc.conf.local
2827 .It Pa /etc/start_if. Ns Aq Ar interface
2845 .Xr resident.conf 5 ,
2910 .An Jordan K. Hubbard .