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.40 2007/06/10 18:57:59 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.
53 file is included from the file
54 .Pa /etc/defaults/rc.conf ,
55 which specifies the default settings for all the available options.
56 Options need only be specified in
58 when the system administrator wishes to override these defaults.
60 .Pa /etc/rc.conf.local
61 is used to override settings in
63 for historical reasons.
68 The following list provides a name and short description for each
69 variable that can be set in the
72 .Bl -tag -width indent-two
77 enable output of debug messages from rc scripts.
78 This variable can be helpful in diagnosing mistakes when
79 editing or integrating new scripts.
80 Beware that this produces copious output to the terminal and
86 disable informational messages from the rc scripts.
87 Informational messages are displayed when
88 a condition that is not serious enough to warrant a warning or an error occurs.
93 no swapfile is installed, otherwise the value is used as the full
94 pathname to a file to use for additional swap space.
99 enable support for Automatic Power Management with the
106 to handle APM event from userland.
107 This also enables support for APM.
114 these are the flags to pass to the
120 to monitor the status of batteries present in the system.
121 This also enables support for APM.
128 these are the flags to pass to the
131 .It Va pccard_ifconfig
133 List of arguments to be passed to
135 at boot time or on insertion of the card (e.g.\&
136 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
137 for a fixed address or
140 .It Va pccard_ether_delay
142 Set the delay before starting
145 .Pa /etc/pccard_ether
147 This defaults to 5 seconds to work around a bug in the
149 driver which can lead to system hangs when using some newer
152 .It Va removable_interfaces
154 List of removable network interfaces to be supported by
155 .Pa /etc/pccard_ether .
158 List of directories to search for startup script files.
159 .It Va script_name_sep
161 The field separator to use for breaking down the list of startup script files
162 into individual filenames.
163 The default is a space.
164 It is not necessary to change this unless there are startup scripts with names
168 The fully qualified domain name (FQDN) of this host on the network.
169 This should almost certainly be set to something meaningful, even if
170 there is no network connection.
173 is used to set the hostname via DHCP,
174 this variable should be set to an empty string.
177 Enable support for IPv6 networking.
178 Note that this requires that the kernel have been compiled with
179 .Cd "options INET6" .
182 The NIS domain name of this host, or
185 .It Va dhclient_program
187 Path to the DHCP client program
188 .Pa ( /sbin/dhclient ,
189 the ISC DHCP client, is the default).
190 .It Va dhclient_flags
192 Additional flags to pass to the DHCP client program.
193 For the ISC DHCP client, see the
195 manpage for a description of the command line options available.
196 .It Va background_dhclient
200 to start the DHCP client in background.
201 This can cause trouble with applications depending on
202 a working network, but it will provide a faster startup in many cases.
210 .It Va dhcrelay_enable
223 If the kernel was not built with
227 kernel module will be loaded.
231 .Va ipfilter_enable .
236 ruleset definition file.
247 these are the flags to pass to
249 when loading the ruleset.
256 which logs packets from
264 this specifies the path of the log file.
275 these are the flags to pass to
277 .It Va firewall_enable
281 to load firewall rules at startup.
282 If the kernel was not built with
283 .Cd "options IPFIREWALL" ,
286 kernel module will be loaded.
290 .Va ipfilter_enable .
291 .It Va ipv6_firewall_enable
293 The IPv6 equivalent of
294 .Va firewall_enable .
297 to load IPv6 firewall rules at startup.
298 If the kernel was not built with
299 .Cd "options IPV6FIREWALL" ,
302 kernel module will be loaded.
303 .It Va firewall_script
305 This variable specifies the full path to the firewall script to run.
307 .Pa /etc/rc.firewall .
308 .It Va ipv6_firewall_script
310 The IPv6 equivalent of
311 .Va firewall_script .
314 Names the firewall type from the selection in
315 .Pa /etc/rc.firewall ,
316 or the file which contains the local firewall ruleset.
317 Valid selections from
321 .Bl -tag -width ".Li simple" -compact
323 unrestricted IP access
325 all IP services disabled, except via
328 basic protection for a workstation on a LAN
334 If a filename is specified, the full path must be given.
335 .It Va firewall_trusted_nets
337 List of trusted networks (if
341 .It Va firewall_trusted_interfaces
343 List of trusted network interfaces (if
347 .It Va firewall_allowed_icmp_types
349 List of allowed ICMP types (if
353 .It Va firewall_open_tcp_ports
355 List of TCP ports to open (if
359 .It Va firewall_open_udp_ports
361 List of UDP ports to open (if
365 .It Va ipv6_firewall_type
367 The IPv6 equivalent of
369 .It Va firewall_quiet
373 to disable the display of firewall rules on the console during boot.
374 .It Va ipv6_firewall_quiet
376 The IPv6 equivalent of
378 .It Va firewall_logging
382 to enable firewall event logging.
383 This is equivalent to the
384 .Dv IPFIREWALL_VERBOSE
386 .It Va ipv6_firewall_logging
388 The IPv6 equivalent of
389 .Va firewall_logging .
390 .It Va firewall_flags
396 specifies a filename.
397 .It Va ipv6_firewall_flags
399 The IPv6 equivalent of
416 sockets must be enabled in the kernel.
417 .It Va natd_interface
419 This is the name of the public interface on which
422 The interface may be given as an interface name or as an IP address.
427 flags should be placed here.
432 flag is automatically added with the above
435 .\" ----- ipfilter_enable setting --------------------------------
436 .It Va ipfilter_enable
447 Typical usage will require putting
449 ipfilter_enable="YES"
467 can be enabled independently.
471 both require at least one of
481 options IPFILTER_DEFAULT_BLOCK
484 in the kernel configuration file is a good idea, too.
488 .Va firewall_enable .
489 .\" ----- ipfilter_program setting ------------------------------
490 .It Va ipfilter_program
496 .\" ----- ipfilter_rules setting --------------------------------
497 .It Va ipfilter_rules
502 This variable contains the name of the filter rule definition file.
503 The file is expected to be readable for the
506 .\" ----- ipv6_ipfilter_rules setting ---------------------------
507 .It Va ipv6_ipfilter_rules
512 This variable contains the IPv6 filter rule definition file.
513 The file is expected to be readable for the
516 .\" ----- ipfilter_flags setting --------------------------------
517 .It Va ipfilter_flags
520 This variable contains flags passed to the
523 .\" ----- ipnat_enable setting ----------------------------------
533 network address translation.
536 for a detailed discussion.
537 .\" ----- ipnat_program setting ---------------------------------
544 .\" ----- ipnat_rules setting -----------------------------------
550 This variable contains the name of the file
551 holding the network address translation definition.
552 This file is expected to be readable for the
555 .\" ----- ipnat_flags setting -----------------------------------
559 This variable contains flags passed to the
562 .\" ----- ipmon_enable setting ----------------------------------
577 Setting this variable needs setting
584 for a detailed discussion.
585 .\" ----- ipmon_program setting ---------------------------------
592 .\" ----- ipmon_flags setting -----------------------------------
598 This variable contains flags passed to the
601 Another typical example would be
602 .Dq Fl D Pa /var/log/ipflog
605 log directly to a file bypassing
608 .Pa /etc/newsyslog.conf
609 in such case like this:
611 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
613 .\" ----- ipfs_enable setting -----------------------------------
623 saving the filter and NAT state tables during shutdown
624 and reloading them during startup again.
625 Setting this variable needs setting
634 for a detailed discussion.
639 cannot be used because the raised securelevel will prevent
641 from saving the state tables at shutdown time.
642 .\" ----- ipfs_program setting ----------------------------------
649 .\" ----- ipfs_flags setting ------------------------------------
653 This variable contains flags passed to the
656 .\" ----- end of added ipf hook ---------------------------------
657 .It Va tcp_extensions
664 disables certain TCP options as described by
670 might help remedy such problems with connections as randomly hanging
671 or other weird behavior.
672 Some network devices are known to be broken with respect to these options.
679 .Va net.inet.tcp.log_in_vain
681 .Va net.inet.udp.log_in_vain ,
686 are set to the given value.
694 will disable probing idle TCP connections to verify that the
695 peer is still up and reachable.
696 .It Va tcp_drop_synfin
703 will cause the kernel to ignore TCP frames that have both
704 the SYN and FIN flags set.
705 This prevents OS fingerprinting, but may break some legitimate applications.
706 This option is only available if the kernel was built with the
709 .It Va icmp_drop_redirect
716 will cause the kernel to ignore ICMP REDIRECT packets.
719 for more information.
720 .It Va icmp_log_redirect
727 will cause the kernel to log ICMP REDIRECT packets.
729 the log messages are not rate-limited, so this option should only be used
730 for troubleshooting networks.
733 for more information.
734 .It Va icmp_bmcastecho
738 to respond to broadcast or multicast ICMP ping packets.
741 for more information.
742 .It Va ip_portrange_first
746 this is the first port in the default portrange.
749 for more information.
750 .It Va ip_portrange_last
754 this is the last port in the default portrange.
757 for more information.
758 .It Va network_interfaces
760 Set to the list of network interfaces to configure on this host.
761 For example, if the only network devices in the system are the loopback device
765 driver, this could be set to
768 .Va ifconfig_ Ns Aq Ar interface
769 variable is also assumed to exist for each value of
771 It is also possible to add IP alias entries here in cases where
772 multiple IP addresses registered against a single interface are desired.
773 Assuming that the interface in question was
775 it might look something like this:
777 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
778 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
783 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
784 entry that is found, its contents are passed to
786 Execution stops at the first unsuccessful access, so if
787 something like this is present:
789 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
790 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
791 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
792 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
795 Then note that alias4 would
797 be added since the search would stop with the missing alias3 entry.
800 .Pa /etc/start_if. Ns Aq Ar interface
801 file is present, it is read and executed by the
803 interpreter before configuring the interface as specified in the
804 .Va ifconfig_ Ns Aq Ar interface
806 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
809 It is possible to bring up an interface with DHCP by setting the
810 .Va ifconfig_ Ns Aq Ar interface
813 For instance, to initialize the
815 device via DHCP, it is possible to use something like:
819 .It Va ipv6_network_interfaces
821 This is the IPv6 equivalent of
822 .Va network_interfaces .
823 Instead of setting the ifconfig variables as
824 .Va ifconfig_ Ns Aq Ar interface
825 they should be set as
826 .Va ipv6_ifconfig_ Ns Aq Ar interface .
827 Aliases should be set as
828 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
829 .Va ipv6_prefix_ Ns Aq Ar interface
831 Interfaces that do not have a
832 .Va ipv6_ifconfig_ Ns Aq Ar interface
833 setting will be auto configured by
836 .Va ipv6_gateway_enable
839 Note that the IPv6 networking code does not support the
840 .Pa /etc/start_if. Ns Aq Ar interface
842 .It Va ipv6_default_interface
846 this is the default output interface for scoped addresses.
847 Now this works only for IPv6 link local multicast addresses.
848 .It Va cloned_interfaces
850 Set to the list of clonable network interfaces to create on this host.
852 .Va cloned_interfaces
853 are automatically appended to
854 .Va network_interfaces
856 .It Va gif_interfaces
860 tunnel interfaces to configure on this host.
862 .Va gifconfig_ Ns Aq Ar interface
863 variable is assumed to exist for each value of
865 The value of this variable is used to configure the link layer of the
866 tunnel according to the syntax of the
870 Additionally, this option ensures that each listed interface is created via the
874 before attempting to configure it.
875 .It Va sppp_interfaces
879 interfaces to configure on this host.
881 .Va spppconfig_ Ns Aq Ar interface
882 variable is assumed to exist for each value of
884 Each interface should also be configured by a general
885 .Va ifconfig_ Ns Aq Ar interface
889 for more information about available options.
899 Mode in which to run the
908 See the manual for a full description.
913 enables network address translation.
914 Used in conjunction with
916 allows hosts on private network addresses access to the Internet using
917 this host as a network address translating router.
920 The name of the profile to use from
921 .Pa /etc/ppp/ppp.conf .
924 The name of the user under which
933 This option is used to specify a list of files that will override
935 .Pa /etc/defaults/rc.conf .
936 The files will be read in the order in which they are specified and should
937 include the full path to the file.
938 By default, the files specified are
941 .Pa /etc/rc.conf.local
949 flag if the initial preen of the file systems fails.
952 List of file system types that are network-based.
953 This list should generally not be modified by end users.
955 .Va extra_netfs_types
957 .It Va extra_netfs_types
959 If set to something other than
961 (the default), this variable extends the list of file system types
962 for which automatic mounting at startup by
964 should be delayed until the network is initialized.
966 a whitespace-separated list of network file system descriptor pairs,
967 each consisting of a file system type as passed to
969 and a human-readable, one-word description, joined with a colon
971 Extending the default list in this way is only necessary
972 when third party file system types are used.
973 .It Va syslogd_enable
980 .It Va syslogd_program
985 .Pa /usr/sbin/syslogd ) .
992 these are the flags to pass to
1001 .It Va inetd_program
1006 .Pa /usr/sbin/inetd ) .
1013 these are the flags to pass to
1022 .It Va named_program
1027 .Pa /usr/sbin/named ) .
1034 these are the flags to pass to
1036 .It Va named_pidfile
1038 This is the default path to the
1041 Change it if you change the location in
1042 .Pa /etc/namedb/named.conf .
1043 .It Va named_chrootdir
1045 The root directory for a name server run in a
1050 will not be run in a
1053 .It Va kerberos5_server_enable
1057 to start a Kerberos 5 authentication server at boot time.
1058 .It Va kerberos5_server_program
1061 .Va kerberos5_server_enable
1064 this is the path to Kerberos 5 Authentication Server.
1065 .It Va kadmind5_server_enable
1071 the Kerberos 5 Administration Daemon; set to
1074 .It Va kadmind5_server_program
1077 .Va kadmind5_server_enable
1080 this is the path to Kerberos 5 Administration Daemon.
1081 .It Va kpasswdd_server_enable
1087 the Kerberos 5 Password-Changing Daemon; set to
1090 .It Va kpasswdd_server_program
1093 .Va kpasswdd_server_enable
1096 this is the path to Kerberos 5 Password-Changing Daemon.
1103 daemon at boot time.
1110 these are the flags to pass to it.
1117 daemon at boot time.
1124 these are the flags to pass to it.
1127 manpage for more information.
1128 .It Va amd_map_program
1130 If set, the specified program is run to get the list of
1135 maps are stored in NIS, one can set this to run
1147 will be updated at boot time to reflect the kernel release being run.
1151 will not be updated.
1152 .It Va nfs_client_enable
1156 run the NFS client daemons at boot time.
1157 .It Va nfs_client_flags
1160 .Va nfs_client_enable
1163 these are the flags to pass to the
1166 .It Va nfs_access_cache
1169 .Va nfs_client_enable
1174 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1175 NFS ACCESS results should be cached.
1176 A value of 2-10 seconds will substantially reduce network traffic for
1177 many NFS operations.
1178 The default is 5 seconds.
1179 Note that the attribute cache holds stat information only.
1180 The NFS data cache is independent of the attribute cache and is only
1181 invalidated when the client detects that the server has modified the
1183 This value specifies a maximum timeout.
1184 The NFS client will automatically use a shorter timeout for files which
1185 have been recently modified.
1186 .It Va nfs_neg_cache
1189 .Va nfs_client_enable
1194 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1195 filenames), or to the number of seconds for which negative lookups should
1197 A value of 2-10 seconds will substantially reduce network
1198 traffic for many NFS operations, especially source code builds.
1199 The default is 3 seconds.
1200 .It Va nfs_server_enable
1204 run the NFS server daemons at boot time.
1205 .It Va nfs_server_flags
1208 .Va nfs_server_enable
1211 these are the flags to pass to the
1214 .It Va mountd_enable
1219 .Va nfs_server_enable
1225 It is commonly needed to run CFS without real NFS used.
1232 these are the flags to pass to the
1235 .It Va weak_mountd_authentication
1239 allow services like PCNFSD to make non-privileged mount requests.
1240 .It Va nfs_reserved_port_only
1244 provide NFS services only on a secure port.
1245 .It Va nfs_bufpackets
1247 If set to a number, indicates the number of packets worth of
1248 socket buffer space to reserve on an NFS client.
1249 The kernel default is typically 4.
1250 Using a higher number may be useful on gigabit networks to improve performance.
1251 The minimum value is 2 and the maximum is 64.
1252 .It Va rpc_umntall_enable
1256 (default) and we are also an NFS client, run
1258 at boot time to clear out old mounts on remote servers.
1263 will not be run at boot time.
1264 .It Va rpc_lockd_enable
1268 and also an NFS server, run
1271 .It Va rpc_statd_enable
1275 and also an NFS server, run
1278 .It Va rpcbind_program
1283 .Pa /usr/sbin/rpcbind ) .
1284 .It Va rpcbind_enable
1290 service at boot time.
1291 .It Va rpcbind_flags
1297 these are the flags to pass to the
1300 .It Va keyserv_enable
1306 daemon on boot for running Secure RPC.
1307 .It Va keyserv_flags
1313 these are the flags to pass to
1316 .It Va pppoed_enable
1322 daemon at boot time to provide PPP over Ethernet services.
1323 .It Va pppoed_provider
1326 listens to requests to this provider and ultimately runs
1330 argument of the same name.
1333 Additional flags to pass to
1335 .It Va pppoed_interface
1337 The network interface to run
1340 This is mandatory when
1350 service at boot time.
1351 This command is intended for networks of machines where a consistent
1353 for all hosts must be established.
1354 This is often useful in large NFS environments where time stamps on
1355 files are expected to be consistent network-wide.
1362 these are the flags to pass to the
1371 command at boot time.
1377 .Pa /usr/sbin/ntpd ) .
1384 these are the flags to pass to the
1389 by default which sets the time immediately at startup if the
1390 local clock is off by more than 180 seconds.
1393 from doing this, set
1403 at system boot time.
1404 .It Va dntpd_program
1409 .Pa /usr/sbin/dntpd ) .
1416 these are the flags to pass to the
1419 .It Va nis_client_enable
1425 service at system boot time.
1426 .It Va nis_client_flags
1429 .Va nis_client_enable
1432 these are the flags to pass to the
1435 .It Va nis_ypset_enable
1441 daemon at system boot time.
1442 .It Va nis_ypset_flags
1445 .Va nis_ypset_enable
1448 these are the flags to pass to the
1451 .It Va nis_server_enable
1457 daemon at system boot time.
1458 .It Va nis_server_flags
1461 .Va nis_server_enable
1464 these are the flags to pass to the
1467 .It Va nis_ypxfrd_enable
1473 daemon at system boot time.
1474 .It Va nis_ypxfrd_flags
1477 .Va nis_ypxfrd_enable
1480 these are the flags to pass to the
1483 .It Va nis_yppasswdd_enable
1489 daemon at system boot time.
1490 .It Va nis_yppasswdd_flags
1493 .Va nis_yppasswdd_enable
1496 these are the flags to pass to the
1499 .It Va rpc_ypupdated_enable
1505 daemon at system boot time.
1506 .It Va defaultrouter
1510 create a default route to this host name or IP address
1511 (use an IP address if this router is also required to get to the
1513 .It Va ipv6_defaultrouter
1515 The IPv6 equivalent of
1517 .It Va static_routes
1519 Set to the list of static routes that are to be added at system boot time.
1522 then for each whitespace separated
1525 .Va route_ Ns Aq Ar element
1526 variable is assumed to exist whose contents will later be passed to a
1529 .It Va ipv6_static_routes
1531 The IPv6 equivalent of
1535 then for each whitespace separated
1538 .Va ipv6_route_ Ns Aq Ar element
1539 variable is assumed to exist whose contents will later be passed to a
1540 .Dq Nm route Cm add Fl inet6
1542 .It Va gateway_enable
1546 configure host to act as an IP router, e.g. to forward packets
1548 .It Va ipv6_gateway_enable
1550 The IPv6 equivalent of
1551 .Va gateway_enable .
1552 .It Va router_enable
1556 run a routing daemon of some sort, based on the settings of
1560 .It Va ipv6_router_enable
1562 The IPv6 equivalent of
1566 run a routing daemon of some sort, based on the settings of
1567 .Va ipv6_router_program
1569 .Va ipv6_router_flags .
1570 .It Va router_program
1576 this is the name of the routing daemon to use.
1577 .It Va ipv6_router_program
1579 The IPv6 equivalent of
1580 .Va router_program .
1587 these are the flags to pass to the routing daemon.
1588 .It Va ipv6_router_flags
1590 The IPv6 equivalent of
1592 .It Va mrouted_enable
1596 run the multicast routing daemon,
1598 .It Va mroute6d_enable
1600 The IPv6 equivalent of
1601 .Va mrouted_enable .
1604 run the IPv6 multicast routing daemon.
1605 Note that no IPv6 multicast routing daemon is included in the
1609 can be installed from the
1612 .It Va mrouted_flags
1618 these are the flags to pass to the
1621 .It Va mroute6d_flags
1623 The IPv6 equivalent of
1629 these are the flags passed to the IPv6 multicast routing daemon.
1630 .It Va mroute6d_program
1636 this is the path to the IPv6 multicast routing daemon.
1637 .It Va rtadvd_enable
1643 daemon at boot time.
1646 .Va ipv6_gateway_enable
1651 utility sends router advertisement packets to the interfaces specified in
1652 .Va rtadvd_interfaces .
1654 and should only be enabled with great care.
1655 You may want to fine-tune
1657 .It Va rtadvd_interfaces
1663 this is the list of interfaces to use.
1664 .It Va ipxgateway_enable
1668 enable the routing of IPX traffic.
1669 .It Va ipxrouted_enable
1675 daemon at system boot time.
1676 .It Va ipxrouted_flags
1679 .Va ipxrouted_enable
1682 these are the flags to pass to the
1689 enable global proxy ARP.
1690 .It Va forward_sourceroute
1698 source-routed packets are forwarded.
1699 .It Va accept_sourceroute
1703 the system will accept source-routed packets directed at it.
1710 daemon at system boot time.
1717 these are the flags to pass to the
1720 .It Va bootparamd_enable
1726 daemon at system boot time.
1727 .It Va bootparamd_flags
1730 .Va bootparamd_enable
1733 these are the flags to pass to the
1736 .It Va stf_interface_ipv4addr
1740 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1741 Specify this entry to enable the 6to4 interface.
1742 .It Va stf_interface_ipv4plen
1744 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1745 An effective value is 0-31.
1746 .It Va stf_interface_ipv6_ifid
1748 IPv6 interface ID for
1752 .It Va stf_interface_ipv6_slaid
1754 IPv6 Site Level Aggregator for
1756 .It Va ipv6_faith_prefix
1760 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1764 .It Va ipv6_ipv4mapping
1768 this enables IPv4 mapped IPv6 address communication (like
1769 .Li ::ffff:a.b.c.d ) .
1774 to enable the configuration of ATM interfaces at system boot time.
1775 For all of the ATM variables described below, please refer to the
1777 man page for further details on the available command parameters.
1778 Also refer to the files in
1779 .Pa /usr/share/examples/atm
1780 for more detailed configuration information.
1781 .It Va atm_netif_ Ns Aq Ar intf
1783 For the ATM physical interface
1785 this variable defines the name prefix and count for the ATM network
1786 interfaces to be created.
1787 The value will be passed as the parameters of an
1788 .Dq Nm atm Cm "set netif" Ar intf
1790 .It Va atm_sigmgr_ Ns Aq Ar intf
1792 For the ATM physical interface
1794 this variable defines the ATM signalling manager to be used.
1795 The value will be passed as the parameters of an
1796 .Dq Nm atm Cm attach Ar intf
1798 .It Va atm_prefix_ Ns Aq Ar intf
1800 For the ATM physical interface
1802 this variable defines the NSAP prefix for interfaces using a UNI signalling
1806 the prefix will automatically be set via the
1809 Otherwise, the value will be passed as the parameters of an
1810 .Dq Nm atm Cm "set prefix" Ar intf
1812 .It Va atm_macaddr_ Ns Aq Ar intf
1814 For the ATM physical interface
1816 this variable defines the MAC address for interfaces using a UNI signalling
1820 the hardware MAC address contained in the ATM interface card will be used.
1821 Otherwise, the value will be passed as the parameters of an
1822 .Dq Nm atm Cm "set mac" Ar intf
1824 .It Va atm_arpserver_ Ns Aq Ar netif
1826 For the ATM network interface
1828 this variable defines the ATM address for a host which is to provide ATMARP
1830 This variable is only applicable to interfaces using a UNI signalling manager.
1833 this host will become an ATMARP server.
1834 The value will be passed as the parameters of an
1835 .Dq Nm atm Cm "set arpserver" Ar netif
1837 .It Va atm_scsparp_ Ns Aq Ar netif
1841 SCSP/ATMARP service for the network interface
1843 will be initiated using the
1848 This variable is only applicable if
1849 .Va atm_arpserver_ Ns Aq Ar netif
1854 Set to the list of permanent ATM ARP entries to be added at system boot time.
1855 For each whitespace separated
1858 .Va atm_arp_ Ns Aq Ar element
1859 variable is assumed to exist.
1860 The value of each of these variables will be passed as the parameters of an
1861 .Dq Nm atm Cm "add arp"
1865 The keyboard bell sound.
1872 if the default behavior is desired.
1873 For details, refer to the
1880 no keymap is installed, otherwise the value is used to install
1882 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1885 The keyboard repeat speed.
1892 if the default behavior is desired.
1897 attempt to program the function keys with the value.
1898 The value should be a single string of the form:
1899 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1902 Can be set to the value of
1905 .Dq Li destructive ,
1908 to set the cursor behavior explicitly or choose the default behavior.
1913 no screen map is installed, otherwise the value is used to install
1914 the screen map file in
1915 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1920 the default 8x16 font value is used for screen size requests, otherwise
1922 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1928 the default 8x14 font value is used for screen size requests, otherwise
1930 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1936 the default 8x8 font value is used for screen size requests, otherwise
1938 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1944 the default screen blanking interval is used, otherwise it is set to
1951 this is the actual screen saver to use
1952 .Li ( blank , snake , daemon ,
1954 .It Va moused_enable
1960 daemon is started for doing cut/paste selection on the console.
1963 This is the protocol type of the mouse connected to this host.
1964 This variable must be set if
1971 is able to detect the appropriate mouse type automatically in many cases.
1972 Set this variable to
1974 to let the daemon detect it, or
1975 select one from the following list if the automatic detection fails.
1977 If the mouse is attached to the PS/2 mouse port, choose
1981 regardless of the brand and model of the mouse.
1982 Likewise, if the mouse is attached to the bus mouse port, choose
1986 All other protocols are for serial mice and will not work with
1987 the PS/2 and bus mice.
1988 If this is a USB mouse,
1990 is the only protocol type which will work.
1992 .Bl -tag -width ".Li x10mouseremote" -compact
1994 Microsoft mouse (serial)
1996 Microsoft IntelliMouse (serial)
1998 Mouse systems Corp. mouse (serial)
2000 MM Series mouse (serial)
2002 Logitech mouse (serial)
2006 Logitech MouseMan and TrackMan (serial)
2008 ALPS GlidePoint (serial)
2009 .It Li thinkingmouse
2010 Kensington ThinkingMouse (serial)
2014 MM HitTablet (serial)
2015 .It Li x10mouseremote
2016 X10 MouseRemote (serial)
2018 Interlink VersaPad (serial)
2021 Even if the mouse is not in the above list, it may be compatible
2022 with one in the list.
2023 Refer to the man page for
2025 for compatibility information.
2027 It should also be noted that while this is enabled, any
2028 other client of the mouse (such as an X server) should access
2029 the mouse through the virtual mouse device,
2031 and configure it as a
2033 type mouse, since all
2034 mouse data is converted to this single canonical format when using
2036 If the client program does not support the
2041 It is the second preferred type.
2048 this is the actual port the mouse is on.
2051 for a COM1 serial mouse,
2055 for a bus mouse, for example.
2060 is set, these are the additional flags to pass to the
2063 .It Va mousechar_start
2067 the default mouse cursor character range
2068 .Li 0xd0 Ns - Ns Li 0xd3
2069 is used, otherwise the range start is set to
2073 Use if the default range is occupied in the language code table.
2076 Set the size of the history (scrollback) buffer in lines.
2077 .It Va allscreens_flags
2081 is run with these options for each of the virtual terminals
2085 will enable the mouse pointer on all virtual terminals if
2089 .It Va allscreens_kbdflags
2093 is run with these options for each of the virtual terminals
2099 scrollback (history) buffer to 200 lines.
2106 daemon at system boot time.
2112 .Pa /usr/sbin/cron ) .
2119 these are the flags to pass to
2126 .Pa /usr/sbin/lpd ) .
2133 daemon at system boot time.
2140 these are the flags to pass to the
2149 settings across reboots.
2150 .It Va mta_start_script
2152 This variable specifies the full path to the script to run to start
2153 a mail transfer agent.
2155 .Pa /etc/rc.sendmail .
2159 .Pa /etc/rc.sendmail
2160 uses are documented in the
2165 Indicates the device (usually a swap partition) to which a crash dump
2166 should be written in the event of a system crash.
2167 The value of this variable is passed as the argument to
2169 To disable crash dumps, set this variable to
2173 When the system reboots after a crash and a crash dump is found on the
2174 device specified by the
2178 will save that crash dump and a copy of the kernel to the directory
2182 The default value is
2191 .It Va savecore_flags
2193 If crash dumps are enabled, these are the flags to pass to the
2196 .It Va enable_quotas
2200 to turn on user disk quotas on system startup via the
2207 to enable user disk quota checking via the
2210 .It Va accounting_enable
2214 to enable system accounting through the
2221 to enable Linux/ELF binary emulation at system initial boot time.
2222 .It Va sysvipc_enable
2226 load System V IPC primitives at boot time.
2227 .\" ----- cleanvar_enable setting--------------------------------
2228 .It Va cleanvar_enable
2236 .Pa /var/spool/uucp/.Temp/*
2238 .\" ----- clear_tmp_enable setting-------------------------------
2239 .It Va clear_tmp_enable
2246 .\" ----- ldconfig_paths setting --------------------------------
2247 .It Va ldconfig_paths
2249 Set to the list of shared library paths to use with
2253 will always be added first, so it need not appear in this list.
2254 .It Va ldconfig_insecure
2258 utility normally refuses to use directories
2259 which are writable by anyone except root.
2260 Set this variable to
2262 to disable that security check during system startup.
2263 .It Va kern_securelevel
2265 The kernel security level to set at startup.
2266 The allowed range of
2268 ranges from \-1 (the compile time default) to 3 (the most secure).
2271 for the list of possible security levels and their effect on system operation.
2278 at system boot time.
2285 at system boot time.
2288 Path to the SSH server program
2289 .Pa ( /usr/sbin/sshd
2297 these are the flags to pass to the
2306 at system boot time.
2313 these are the flags to pass to the
2322 daemon at boot time.
2329 these are the flags passed to
2332 .It Va watchdogd_enable
2338 daemon at boot time.
2339 This requires that the kernel have been compiled with
2340 .Cd "options WATCHDOG" .
2345 any configured jails will not be started.
2348 A space separated list of names for jails.
2349 This is purely a configuration aid to help identify and
2350 configure multiple jails.
2351 The names specified in this list will be used to
2352 identify settings common to an instance of a jail.
2353 Assuming that the jail in question was named
2355 you would have the following dependent variables:
2357 jail_vjail_hostname="jail.example.com"
2358 jail_vjail_ip="192.168.1.100"
2359 jail_vjail_rootdir="/var/jails/vjail/root"
2360 jail_vjail_exec="/bin/sh /etc/rc"
2363 The last one is optional.
2367 .It Va jail_set_hostname_allow
2371 do not allow the root user in a jail to set its hostname.
2372 .It Va jail_socket_unixiproute_only
2376 do not allow any protocol, besides TCP/IP, to be used within a jail.
2377 .It Va jail_sysvipc_allow
2381 allow applications within a jail to use System V IPC.
2382 .It Va resident_enable
2386 make the dynamic binaries listed in
2387 .Pa /etc/resident.conf
2389 .It Va varsym_enable
2394 .Pa /etc/varsym.conf
2395 to set system-wide variables for variant symlinks.
2400 or a whitespace separated list of IRQ numbers which will be used as a source of
2402 .\" ----- isdn settings ---------------------------------
2412 daemon at system boot time.
2416 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2418 Additional flags to pass to
2424 for certain tunable parameters).
2430 The terminal type of the output device when
2432 operates in full-screen mode.
2433 .It Va isdn_screenflags
2438 The video mode for full-screen mode (only for
2448 The output device for
2450 in full-screen mode (or
2460 enables the ISDN protocol trace utility
2462 at system boot time.
2463 .It Va isdn_traceflags
2466 .Dq Fl f Pa /var/tmp/isdntrace0
2470 .\" -----------------------------------------------------
2475 to disable caching entropy via
2477 Otherwise set to the directory used to store entropy files in.
2482 to disable caching entropy through reboots.
2483 Otherwise set to the filename used to store cached entropy through reboots.
2484 This file should be located on the root file system to seed the
2486 device as early as possible in the boot process.
2487 .It Va entropy_save_sz
2489 Size of the entropy cache files saved by
2492 .It Va entropy_save_num
2494 Number of entropy cache files to save by
2508 Configuration file for
2517 .Pa /var/run/dmesg.boot
2519 .It Va rcshutdown_timeout
2521 If set, start a watchdog timer in the background which will terminate
2525 has not completed within the specified time (in seconds).
2528 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
2529 .It Pa /etc/defaults/rc.conf
2531 .It Pa /etc/rc.conf.local
2549 .Xr resident.conf 5 ,
2609 .An Jordan K. Hubbard .