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 2008/02/17 19:51:53 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
86 These values are case insensitive.
89 postfix in the name of a variables for starting a service can be
92 .Bl -tag -width indent-two
97 enable output of debug messages from rc scripts.
98 This variable can be helpful in diagnosing mistakes when
99 editing or integrating new scripts.
100 Beware that this produces copious output to the terminal and
106 disable informational messages from the rc scripts.
107 Informational messages are displayed when
108 a condition that is not serious enough to warrant a warning or an error occurs.
113 no swapfile is installed, otherwise the value is used as the full
114 pathname to a file to use for additional swap space.
119 enable support for Automatic Power Management with the
126 to handle APM event from userland.
127 This also enables support for APM.
134 these are the flags to pass to the
140 to monitor the status of batteries present in the system.
141 This also enables support for APM.
148 these are the flags to pass to the
151 .It Va sensorsd_enable
160 a sensors monitoring and logging daemon.
161 .It Va sensorsd_flags
164 This variable contains additional flags passed to the
167 .It Va pccard_ifconfig
169 List of arguments to be passed to
171 at boot time or on insertion of the card (e.g.\&
172 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
173 for a fixed address or
176 .It Va pccard_ether_delay
178 Set the delay before starting
181 .Pa /etc/pccard_ether
183 This defaults to 5 seconds to work around a bug in the
185 driver which can lead to system hangs when using some newer
188 .It Va removable_interfaces
190 List of removable network interfaces to be supported by
191 .Pa /etc/pccard_ether .
194 List of directories to search for startup script files.
195 .It Va script_name_sep
197 The field separator to use for breaking down the list of startup script files
198 into individual filenames.
199 The default is a space.
200 It is not necessary to change this unless there are startup scripts with names
202 .It Va hostapd_enable
211 The fully qualified domain name (FQDN) of this host on the network.
212 This should almost certainly be set to something meaningful, even if
213 there is no network connection.
216 is used to set the hostname via DHCP,
217 this variable should be set to an empty string.
220 Enable support for IPv6 networking.
221 Note that this requires that the kernel have been compiled with
222 .Cd "options INET6" .
225 The NIS domain name of this host, or
228 .It Va dhclient_program
230 Path to the DHCP client program
231 .Pa ( /sbin/dhclient ,
232 the ISC DHCP client, is the default).
233 .It Va dhclient_flags
235 Additional flags to pass to the DHCP client program.
236 For the ISC DHCP client, see the
238 manpage for a description of the command line options available.
239 .\".It Va background_dhclient
243 .\"to start the DHCP client in background.
244 .\"This can cause trouble with applications depending on
245 .\"a working network, but it will provide a faster startup in many cases.
253 .It Va dhcrelay_enable
266 If the kernel was not built with
270 kernel module will be loaded.
274 .Va ipfilter_enable .
279 ruleset definition file.
290 these are the flags to pass to
292 when loading the ruleset.
299 which logs packets from
307 this specifies the path of the log file.
318 these are the flags to pass to
320 .It Va firewall_enable
324 to load firewall rules at startup.
325 If the kernel was not built with
326 .Cd "options IPFIREWALL" ,
329 kernel module will be loaded.
333 .Va ipfilter_enable .
334 .It Va ipv6_firewall_enable
336 The IPv6 equivalent of
337 .Va firewall_enable .
340 to load IPv6 firewall rules at startup.
341 If the kernel was not built with
342 .Cd "options IPV6FIREWALL" ,
345 kernel module will be loaded.
346 .It Va firewall_script
348 This variable specifies the full path to the firewall script to run.
350 .Pa /etc/rc.firewall .
351 .It Va ipv6_firewall_script
353 The IPv6 equivalent of
354 .Va firewall_script .
357 Names the firewall type from the selection in
358 .Pa /etc/rc.firewall ,
359 or the file which contains the local firewall ruleset.
360 Valid selections from
364 .Bl -tag -width ".Li simple" -compact
366 unrestricted IP access
368 all IP services disabled, except via
371 basic protection for a workstation on a LAN
377 If a filename is specified, the full path must be given.
378 .It Va firewall_trusted_nets
380 List of trusted networks (if
384 .It Va firewall_trusted_interfaces
386 List of trusted network interfaces (if
390 .It Va firewall_allowed_icmp_types
392 List of allowed ICMP types (if
396 .It Va firewall_open_tcp_ports
398 List of TCP ports to open (if
402 .It Va firewall_open_udp_ports
404 List of UDP ports to open (if
408 .It Va ipv6_firewall_type
410 The IPv6 equivalent of
412 .It Va firewall_quiet
416 to disable the display of firewall rules on the console during boot.
417 .It Va ipv6_firewall_quiet
419 The IPv6 equivalent of
421 .It Va firewall_logging
425 to enable firewall event logging.
426 This is equivalent to the
427 .Dv IPFIREWALL_VERBOSE
429 .It Va ipv6_firewall_logging
431 The IPv6 equivalent of
432 .Va firewall_logging .
433 .It Va firewall_flags
439 specifies a filename.
440 .It Va ipv6_firewall_flags
442 The IPv6 equivalent of
459 sockets must be enabled in the kernel.
460 .It Va natd_interface
462 This is the name of the public interface on which
465 The interface may be given as an interface name or as an IP address.
470 flags should be placed here.
475 flag is automatically added with the above
478 .\" ----- ipfilter_enable setting --------------------------------
479 .It Va ipfilter_enable
490 Typical usage will require putting
492 ipfilter_enable="YES"
510 can be enabled independently.
514 both require at least one of
524 options IPFILTER_DEFAULT_BLOCK
527 in the kernel configuration file is a good idea, too.
531 .Va firewall_enable .
532 .\" ----- ipfilter_program setting ------------------------------
533 .It Va ipfilter_program
539 .\" ----- ipfilter_rules setting --------------------------------
540 .It Va ipfilter_rules
545 This variable contains the name of the filter rule definition file.
546 The file is expected to be readable for the
549 .\" ----- ipv6_ipfilter_rules setting ---------------------------
550 .It Va ipv6_ipfilter_rules
555 This variable contains the IPv6 filter rule definition file.
556 The file is expected to be readable for the
559 .\" ----- ipfilter_flags setting --------------------------------
560 .It Va ipfilter_flags
563 This variable contains flags passed to the
566 .\" ----- ipnat_enable setting ----------------------------------
576 network address translation.
579 for a detailed discussion.
580 .\" ----- ipnat_program setting ---------------------------------
587 .\" ----- ipnat_rules setting -----------------------------------
593 This variable contains the name of the file
594 holding the network address translation definition.
595 This file is expected to be readable for the
598 .\" ----- ipnat_flags setting -----------------------------------
602 This variable contains flags passed to the
605 .\" ----- ipmon_enable setting ----------------------------------
620 Setting this variable needs setting
627 for a detailed discussion.
628 .\" ----- ipmon_program setting ---------------------------------
635 .\" ----- ipmon_flags setting -----------------------------------
641 This variable contains flags passed to the
644 Another typical example would be
645 .Dq Fl D Pa /var/log/ipflog
648 log directly to a file bypassing
651 .Pa /etc/newsyslog.conf
652 in such case like this:
654 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
656 .\" ----- ipfs_enable setting -----------------------------------
666 saving the filter and NAT state tables during shutdown
667 and reloading them during startup again.
668 Setting this variable needs setting
677 for a detailed discussion.
682 cannot be used because the raised securelevel will prevent
684 from saving the state tables at shutdown time.
685 .\" ----- ipfs_program setting ----------------------------------
692 .\" ----- ipfs_flags setting ------------------------------------
696 This variable contains flags passed to the
699 .\" ----- end of added ipf hook ---------------------------------
700 .It Va tcp_extensions
707 disables certain TCP options as described by
713 might help remedy such problems with connections as randomly hanging
714 or other weird behavior.
715 Some network devices are known to be broken with respect to these options.
722 .Va net.inet.tcp.log_in_vain
724 .Va net.inet.udp.log_in_vain ,
729 are set to the given value.
737 will disable probing idle TCP connections to verify that the
738 peer is still up and reachable.
739 .It Va tcp_drop_synfin
746 will cause the kernel to ignore TCP frames that have both
747 the SYN and FIN flags set.
748 This prevents OS fingerprinting, but may break some legitimate applications.
749 This option is only available if the kernel was built with the
752 .It Va icmp_drop_redirect
759 will cause the kernel to ignore ICMP REDIRECT packets.
762 for more information.
763 .It Va icmp_log_redirect
770 will cause the kernel to log ICMP REDIRECT packets.
772 the log messages are not rate-limited, so this option should only be used
773 for troubleshooting networks.
776 for more information.
777 .It Va icmp_bmcastecho
781 to respond to broadcast or multicast ICMP ping packets.
784 for more information.
785 .It Va ip_portrange_first
789 this is the first port in the default portrange.
792 for more information.
793 .It Va ip_portrange_last
797 this is the last port in the default portrange.
800 for more information.
801 .It Va network_interfaces
803 Set to the list of network interfaces to configure on this host.
804 For example, if the only network devices in the system are the loopback device
808 driver, this could be set to
811 .Va ifconfig_ Ns Aq Ar interface
812 variable is also assumed to exist for each value of
814 It is also possible to add IP alias entries here in cases where
815 multiple IP addresses registered against a single interface are desired.
816 Assuming that the interface in question was
818 it might look something like this:
820 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
821 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
826 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
827 entry that is found, its contents are passed to
829 Execution stops at the first unsuccessful access, so if
830 something like this is present:
832 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
833 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
834 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
835 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
838 Then note that alias4 would
840 be added since the search would stop with the missing alias3 entry.
843 .Pa /etc/start_if. Ns Aq Ar interface
844 file is present, it is read and executed by the
846 interpreter before configuring the interface as specified in the
847 .Va ifconfig_ Ns Aq Ar interface
849 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
852 It is possible to bring up an interface with DHCP by adding
855 .Va ifconfig_ Ns Aq Ar interface
857 For instance, to initialize the
859 device via DHCP, it is possible to use something like:
864 Also, if your interface needs WPA authentication, it is possible to add
867 .Va ifconfig_ Ns Aq Ar interface
870 .Xr wpa_supplicant 8 .
872 .Xr wpa_supplicant.conf 5
873 for configuring authentication information.
877 options in this variable, in addition to the
878 .Pa /etc/start_if. Ns Aq Ar interface
880 For instance, to initialize the
882 device via DHCP, using WPA authentication and 802.11b mode, it is
883 possible to use something like:
885 ifconfig_wi0="up DHCP WPA mode 11b"
888 It is also possible to rename interface by doing:
890 ifconfig_ed0_name="net0"
891 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
893 .It Va ipv6_network_interfaces
895 This is the IPv6 equivalent of
896 .Va network_interfaces .
897 Instead of setting the ifconfig variables as
898 .Va ifconfig_ Ns Aq Ar interface
899 they should be set as
900 .Va ipv6_ifconfig_ Ns Aq Ar interface .
901 Aliases should be set as
902 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
903 .Va ipv6_prefix_ Ns Aq Ar interface
905 Interfaces that do not have a
906 .Va ipv6_ifconfig_ Ns Aq Ar interface
907 setting will be auto configured by
910 .Va ipv6_gateway_enable
913 Note that the IPv6 networking code does not support the
914 .Pa /etc/start_if. Ns Aq Ar interface
916 .It Va ipv6_default_interface
920 this is the default output interface for scoped addresses.
921 Now this works only for IPv6 link local multicast addresses.
922 .It Va cloned_interfaces
924 Set to the list of clonable network interfaces to create on this host.
926 .Va cloned_interfaces
927 are automatically appended to
928 .Va network_interfaces
930 .It Va gif_interfaces
934 tunnel interfaces to configure on this host.
936 .Va gifconfig_ Ns Aq Ar interface
937 variable is assumed to exist for each value of
939 The value of this variable is used to configure the link layer of the
940 tunnel according to the syntax of the
944 Additionally, this option ensures that each listed interface is created via the
948 before attempting to configure it.
949 .It Va sppp_interfaces
953 interfaces to configure on this host.
955 .Va spppconfig_ Ns Aq Ar interface
956 variable is assumed to exist for each value of
958 Each interface should also be configured by a general
959 .Va ifconfig_ Ns Aq Ar interface
963 for more information about available options.
973 Mode in which to run the
982 See the manual for a full description.
987 enables network address translation.
988 Used in conjunction with
990 allows hosts on private network addresses access to the Internet using
991 this host as a network address translating router.
994 The name of the profile to use from
995 .Pa /etc/ppp/ppp.conf .
998 The name of the user under which
1005 .It Va rc_conf_files
1007 This option is used to specify a list of files that will override
1009 .Pa /etc/defaults/rc.conf .
1010 The files will be read in the order in which they are specified and should
1011 include the full path to the file.
1012 By default, the files specified are
1015 .Pa /etc/rc.conf.local
1016 .It Va fsck_y_enable
1021 will be run with the
1023 flag if the initial preen of the file systems fails.
1026 List of file system types that are network-based.
1027 This list should generally not be modified by end users.
1029 .Va extra_netfs_types
1031 .It Va extra_netfs_types
1033 If set to something other than
1035 (the default), this variable extends the list of file system types
1036 for which automatic mounting at startup by
1038 should be delayed until the network is initialized.
1040 a whitespace-separated list of network file system descriptor pairs,
1041 each consisting of a file system type as passed to
1043 and a human-readable, one-word description, joined with a colon
1045 Extending the default list in this way is only necessary
1046 when third party file system types are used.
1047 .It Va syslogd_enable
1054 .It Va syslogd_program
1059 .Pa /usr/sbin/syslogd ) .
1060 .It Va syslogd_flags
1066 these are the flags to pass to
1075 .It Va inetd_program
1080 .Pa /usr/sbin/inetd ) .
1087 these are the flags to pass to
1096 .It Va named_program
1101 .Pa /usr/sbin/named ) .
1108 these are the flags to pass to
1110 .It Va named_pidfile
1112 This is the default path to the
1115 Change it if you change the location in
1116 .Pa /etc/namedb/named.conf .
1117 .It Va named_chrootdir
1119 The root directory for a name server run in a
1124 will not be run in a
1127 .It Va kerberos5_server_enable
1131 to start a Kerberos 5 authentication server at boot time.
1132 .It Va kerberos5_server_program
1135 .Va kerberos5_server_enable
1138 this is the path to Kerberos 5 Authentication Server.
1139 .It Va kadmind5_server_enable
1145 the Kerberos 5 Administration Daemon; set to
1148 .It Va kadmind5_server_program
1151 .Va kadmind5_server_enable
1154 this is the path to Kerberos 5 Administration Daemon.
1155 .It Va kpasswdd_server_enable
1161 the Kerberos 5 Password-Changing Daemon; set to
1164 .It Va kpasswdd_server_program
1167 .Va kpasswdd_server_enable
1170 this is the path to Kerberos 5 Password-Changing Daemon.
1177 daemon at boot time.
1184 these are the flags to pass to it.
1191 daemon at boot time.
1198 these are the flags to pass to it.
1201 manpage for more information.
1202 .It Va amd_map_program
1204 If set, the specified program is run to get the list of
1209 maps are stored in NIS, one can set this to run
1221 will be updated at boot time to reflect the kernel release being run.
1225 will not be updated.
1226 .It Va nfs_client_enable
1230 run the NFS client daemons at boot time.
1231 .It Va nfs_client_flags
1234 .Va nfs_client_enable
1237 these are the flags to pass to the
1240 .It Va nfs_access_cache
1243 .Va nfs_client_enable
1248 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1249 NFS ACCESS results should be cached.
1250 A value of 2-10 seconds will substantially reduce network traffic for
1251 many NFS operations.
1252 The default is 5 seconds.
1253 Note that the attribute cache holds stat information only.
1254 The NFS data cache is independent of the attribute cache and is only
1255 invalidated when the client detects that the server has modified the
1257 This value specifies a maximum timeout.
1258 The NFS client will automatically use a shorter timeout for files which
1259 have been recently modified.
1260 .It Va nfs_neg_cache
1263 .Va nfs_client_enable
1268 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1269 filenames), or to the number of seconds for which negative lookups should
1271 A value of 2-10 seconds will substantially reduce network
1272 traffic for many NFS operations, especially source code builds.
1273 The default is 3 seconds.
1274 .It Va nfs_server_enable
1278 run the NFS server daemons at boot time.
1279 .It Va nfs_server_flags
1282 .Va nfs_server_enable
1285 these are the flags to pass to the
1288 .It Va mountd_enable
1293 .Va nfs_server_enable
1299 It is commonly needed to run CFS without real NFS used.
1306 these are the flags to pass to the
1309 .It Va weak_mountd_authentication
1313 allow services like PCNFSD to make non-privileged mount requests.
1314 .It Va nfs_reserved_port_only
1318 provide NFS services only on a secure port.
1319 .It Va nfs_bufpackets
1321 If set to a number, indicates the number of packets worth of
1322 socket buffer space to reserve on an NFS client.
1323 The kernel default is typically 4.
1324 Using a higher number may be useful on gigabit networks to improve performance.
1325 The minimum value is 2 and the maximum is 64.
1326 .It Va rpc_umntall_enable
1330 (default) and we are also an NFS client, run
1332 at boot time to clear out old mounts on remote servers.
1337 will not be run at boot time.
1338 .It Va rpc_lockd_enable
1342 and also an NFS server, run
1345 .It Va rpc_statd_enable
1349 and also an NFS server, run
1352 .It Va rpcbind_program
1357 .Pa /usr/sbin/rpcbind ) .
1358 .It Va rpcbind_enable
1364 service at boot time.
1365 .It Va rpcbind_flags
1371 these are the flags to pass to the
1374 .It Va keyserv_enable
1380 daemon on boot for running Secure RPC.
1381 .It Va keyserv_flags
1387 these are the flags to pass to
1390 .It Va pppoed_enable
1396 daemon at boot time to provide PPP over Ethernet services.
1397 .It Va pppoed_provider
1400 listens to requests to this provider and ultimately runs
1404 argument of the same name.
1407 Additional flags to pass to
1409 .It Va pppoed_interface
1411 The network interface to run
1414 This is mandatory when
1424 service at boot time.
1425 This command is intended for networks of machines where a consistent
1427 for all hosts must be established.
1428 This is often useful in large NFS environments where time stamps on
1429 files are expected to be consistent network-wide.
1436 these are the flags to pass to the
1445 at system boot time.
1446 .It Va dntpd_program
1451 .Pa /usr/sbin/dntpd ) .
1458 these are the flags to pass to the
1461 .It Va btconfig_enable
1465 configure Bluetooth devices via
1467 at system boot time.
1468 .It Va btconfig_devices
1474 this is the list of Bluetooth devices to configure.
1476 .Va btconfig_devices
1477 is not specified, all devices known to the system will be configured.
1479 .Va btconfig_ Ns Aq Ar device
1480 variable can be set to specify parameters to be passed to
1482 .It Va btconfig_args
1488 this is the list of configuration parameters to pass to all Bluetooth
1494 run the Service Discovery Profile daemon
1496 at system boot time.
1503 these are the flags to pass to the
1506 .It Va bthcid_enable
1510 run the Bluetooth Link Key/PIN Code Manager daemon
1512 at system boot time.
1519 these are the flags to pass to the
1522 .It Va nis_client_enable
1528 service at system boot time.
1529 .It Va nis_client_flags
1532 .Va nis_client_enable
1535 these are the flags to pass to the
1538 .It Va nis_ypset_enable
1544 daemon at system boot time.
1545 .It Va nis_ypset_flags
1548 .Va nis_ypset_enable
1551 these are the flags to pass to the
1554 .It Va nis_server_enable
1560 daemon at system boot time.
1561 .It Va nis_server_flags
1564 .Va nis_server_enable
1567 these are the flags to pass to the
1570 .It Va nis_ypxfrd_enable
1576 daemon at system boot time.
1577 .It Va nis_ypxfrd_flags
1580 .Va nis_ypxfrd_enable
1583 these are the flags to pass to the
1586 .It Va nis_yppasswdd_enable
1592 daemon at system boot time.
1593 .It Va nis_yppasswdd_flags
1596 .Va nis_yppasswdd_enable
1599 these are the flags to pass to the
1602 .It Va rpc_ypupdated_enable
1608 daemon at system boot time.
1609 .It Va defaultrouter
1613 create a default route to this host name or IP address
1614 (use an IP address if this router is also required to get to the
1616 .It Va ipv6_defaultrouter
1618 The IPv6 equivalent of
1620 .It Va static_routes
1622 Set to the list of static routes that are to be added at system boot time.
1625 then for each whitespace separated
1628 .Va route_ Ns Aq Ar element
1629 variable is assumed to exist whose contents will later be passed to a
1632 .It Va ipv6_static_routes
1634 The IPv6 equivalent of
1638 then for each whitespace separated
1641 .Va ipv6_route_ Ns Aq Ar element
1642 variable is assumed to exist whose contents will later be passed to a
1643 .Dq Nm route Cm add Fl inet6
1645 .It Va gateway_enable
1649 configure host to act as an IP router, e.g. to forward packets
1651 .It Va ipv6_gateway_enable
1653 The IPv6 equivalent of
1654 .Va gateway_enable .
1655 .It Va router_enable
1659 run a routing daemon of some sort, based on the settings of
1663 .It Va ipv6_router_enable
1665 The IPv6 equivalent of
1669 run a routing daemon of some sort, based on the settings of
1670 .Va ipv6_router_program
1672 .Va ipv6_router_flags .
1673 .It Va router_program
1679 this is the name of the routing daemon to use.
1680 .It Va ipv6_router_program
1682 The IPv6 equivalent of
1683 .Va router_program .
1690 these are the flags to pass to the routing daemon.
1691 .It Va ipv6_router_flags
1693 The IPv6 equivalent of
1695 .It Va mrouted_enable
1699 run the multicast routing daemon,
1701 .It Va mroute6d_enable
1703 The IPv6 equivalent of
1704 .Va mrouted_enable .
1707 run the IPv6 multicast routing daemon.
1708 Note that no IPv6 multicast routing daemon is included in the
1712 can be installed from the
1715 .It Va mrouted_flags
1721 these are the flags to pass to the
1724 .It Va mroute6d_flags
1726 The IPv6 equivalent of
1732 these are the flags passed to the IPv6 multicast routing daemon.
1733 .It Va mroute6d_program
1739 this is the path to the IPv6 multicast routing daemon.
1740 .It Va rtadvd_enable
1746 daemon at boot time.
1749 .Va ipv6_gateway_enable
1754 utility sends router advertisement packets to the interfaces specified in
1755 .Va rtadvd_interfaces .
1757 and should only be enabled with great care.
1758 You may want to fine-tune
1760 .It Va rtadvd_interfaces
1766 this is the list of interfaces to use.
1767 .It Va rtsold_enable
1773 daemon at boot time.
1776 daemon is used for automatic discovery of non-link local addresses.
1783 these are the flags to pass to the
1786 .It Va ipxgateway_enable
1790 enable the routing of IPX traffic.
1791 .It Va ipxrouted_enable
1797 daemon at system boot time.
1798 .It Va ipxrouted_flags
1801 .Va ipxrouted_enable
1804 these are the flags to pass to the
1811 enable global proxy ARP.
1812 .It Va forward_sourceroute
1820 source-routed packets are forwarded.
1821 .It Va accept_sourceroute
1825 the system will accept source-routed packets directed at it.
1832 daemon at system boot time.
1839 these are the flags to pass to the
1842 .It Va bootparamd_enable
1848 daemon at system boot time.
1849 .It Va bootparamd_flags
1852 .Va bootparamd_enable
1855 these are the flags to pass to the
1858 .It Va stf_interface_ipv4addr
1862 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1863 Specify this entry to enable the 6to4 interface.
1864 .It Va stf_interface_ipv4plen
1866 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1867 An effective value is 0-31.
1868 .It Va stf_interface_ipv6_ifid
1870 IPv6 interface ID for
1874 .It Va stf_interface_ipv6_slaid
1876 IPv6 Site Level Aggregator for
1878 .It Va ipv6_faith_prefix
1882 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1886 .It Va ipv6_ipv4mapping
1890 this enables IPv4 mapped IPv6 address communication (like
1891 .Li ::ffff:a.b.c.d ) .
1896 to enable the configuration of ATM interfaces at system boot time.
1897 For all of the ATM variables described below, please refer to the
1899 man page for further details on the available command parameters.
1900 Also refer to the files in
1901 .Pa /usr/share/examples/atm
1902 for more detailed configuration information.
1903 .It Va atm_netif_ Ns Aq Ar intf
1905 For the ATM physical interface
1907 this variable defines the name prefix and count for the ATM network
1908 interfaces to be created.
1909 The value will be passed as the parameters of an
1910 .Dq Nm atm Cm "set netif" Ar intf
1912 .It Va atm_sigmgr_ Ns Aq Ar intf
1914 For the ATM physical interface
1916 this variable defines the ATM signalling manager to be used.
1917 The value will be passed as the parameters of an
1918 .Dq Nm atm Cm attach Ar intf
1920 .It Va atm_prefix_ Ns Aq Ar intf
1922 For the ATM physical interface
1924 this variable defines the NSAP prefix for interfaces using a UNI signalling
1928 the prefix will automatically be set via the
1931 Otherwise, the value will be passed as the parameters of an
1932 .Dq Nm atm Cm "set prefix" Ar intf
1934 .It Va atm_macaddr_ Ns Aq Ar intf
1936 For the ATM physical interface
1938 this variable defines the MAC address for interfaces using a UNI signalling
1942 the hardware MAC address contained in the ATM interface card will be used.
1943 Otherwise, the value will be passed as the parameters of an
1944 .Dq Nm atm Cm "set mac" Ar intf
1946 .It Va atm_arpserver_ Ns Aq Ar netif
1948 For the ATM network interface
1950 this variable defines the ATM address for a host which is to provide ATMARP
1952 This variable is only applicable to interfaces using a UNI signalling manager.
1955 this host will become an ATMARP server.
1956 The value will be passed as the parameters of an
1957 .Dq Nm atm Cm "set arpserver" Ar netif
1959 .It Va atm_scsparp_ Ns Aq Ar netif
1963 SCSP/ATMARP service for the network interface
1965 will be initiated using the
1970 This variable is only applicable if
1971 .Va atm_arpserver_ Ns Aq Ar netif
1976 Set to the list of permanent ATM ARP entries to be added at system boot time.
1977 For each whitespace separated
1980 .Va atm_arp_ Ns Aq Ar element
1981 variable is assumed to exist.
1982 The value of each of these variables will be passed as the parameters of an
1983 .Dq Nm atm Cm "add arp"
1987 The keyboard bell sound.
1994 if the default behavior is desired.
1995 For details, refer to the
2002 no keymap is installed, otherwise the value is used to install
2004 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2007 The keyboard repeat speed.
2014 if the default behavior is desired.
2019 attempt to program the function keys with the value.
2020 The value should be a single string of the form:
2021 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2024 Can be set to the value of
2027 .Dq Li destructive ,
2030 to set the cursor behavior explicitly or choose the default behavior.
2035 no screen map is installed, otherwise the value is used to install
2036 the screen map file in
2037 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2042 the default 8x16 font value is used for screen size requests, otherwise
2044 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2050 the default 8x14 font value is used for screen size requests, otherwise
2052 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2058 the default 8x8 font value is used for screen size requests, otherwise
2060 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2066 the default screen blanking interval is used, otherwise it is set to
2073 this is the actual screen saver to use
2074 .Li ( blank , snake , daemon ,
2076 .It Va moused_enable
2082 daemon is started for doing cut/paste selection on the console.
2085 This is the protocol type of the mouse connected to this host.
2086 This variable must be set if
2093 is able to detect the appropriate mouse type automatically in many cases.
2094 Set this variable to
2096 to let the daemon detect it, or
2097 select one from the following list if the automatic detection fails.
2099 If the mouse is attached to the PS/2 mouse port, choose
2103 regardless of the brand and model of the mouse.
2104 Likewise, if the mouse is attached to the bus mouse port, choose
2108 All other protocols are for serial mice and will not work with
2109 the PS/2 and bus mice.
2110 If this is a USB mouse,
2112 is the only protocol type which will work.
2114 .Bl -tag -width ".Li x10mouseremote" -compact
2116 Microsoft mouse (serial)
2118 Microsoft IntelliMouse (serial)
2120 Mouse systems Corp. mouse (serial)
2122 MM Series mouse (serial)
2124 Logitech mouse (serial)
2128 Logitech MouseMan and TrackMan (serial)
2130 ALPS GlidePoint (serial)
2131 .It Li thinkingmouse
2132 Kensington ThinkingMouse (serial)
2136 MM HitTablet (serial)
2137 .It Li x10mouseremote
2138 X10 MouseRemote (serial)
2140 Interlink VersaPad (serial)
2143 Even if the mouse is not in the above list, it may be compatible
2144 with one in the list.
2145 Refer to the man page for
2147 for compatibility information.
2149 It should also be noted that while this is enabled, any
2150 other client of the mouse (such as an X server) should access
2151 the mouse through the virtual mouse device,
2153 and configure it as a
2155 type mouse, since all
2156 mouse data is converted to this single canonical format when using
2158 If the client program does not support the
2163 It is the second preferred type.
2170 this is the actual port the mouse is on.
2173 for a COM1 serial mouse,
2177 for a bus mouse, for example.
2182 is set, these are the additional flags to pass to the
2185 .It Va mousechar_start
2189 the default mouse cursor character range
2190 .Li 0xd0 Ns - Ns Li 0xd3
2191 is used, otherwise the range start is set to
2195 Use if the default range is occupied in the language code table.
2198 Set the size of the history (scrollback) buffer in lines.
2199 .It Va allscreens_flags
2203 is run with these options for each of the virtual terminals
2207 will enable the mouse pointer on all virtual terminals if
2211 .It Va allscreens_kbdflags
2215 is run with these options for each of the virtual terminals
2221 scrollback (history) buffer to 200 lines.
2228 daemon at system boot time.
2234 .Pa /usr/sbin/cron ) .
2241 these are the flags to pass to
2248 .Pa /usr/sbin/lpd ) .
2255 daemon at system boot time.
2262 these are the flags to pass to the
2271 settings across reboots.
2272 .It Va mta_start_script
2274 This variable specifies the full path to the script to run to start
2275 a mail transfer agent.
2277 .Pa /etc/rc.sendmail .
2281 .Pa /etc/rc.sendmail
2282 uses are documented in the
2287 Indicates the device (usually a swap partition) to which a crash dump
2288 should be written in the event of a system crash.
2289 The value of this variable is passed as the argument to
2291 To disable crash dumps, set this variable to
2295 When the system reboots after a crash and a crash dump is found on the
2296 device specified by the
2300 will save that crash dump and a copy of the kernel to the directory
2304 The default value is
2313 .It Va savecore_flags
2315 If crash dumps are enabled, these are the flags to pass to the
2318 .It Va enable_quotas
2322 to turn on user disk quotas on system startup via the
2329 to enable user disk quota checking via the
2332 .It Va accounting_enable
2336 to enable system accounting through the
2343 to enable Linux/ELF binary emulation at system initial boot time.
2344 .It Va sysvipc_enable
2348 load System V IPC primitives at boot time.
2349 .\" ----- cleanvar_enable setting--------------------------------
2350 .It Va cleanvar_enable
2358 .Pa /var/spool/uucp/.Temp/*
2360 .\" ----- clear_tmp_enable setting-------------------------------
2361 .It Va clear_tmp_enable
2368 .\" ----- ldconfig_paths setting --------------------------------
2369 .It Va ldconfig_paths
2371 Set to the list of shared library paths to use with
2375 will always be added first, so it need not appear in this list.
2376 .It Va ldconfig_insecure
2380 utility normally refuses to use directories
2381 which are writable by anyone except root.
2382 Set this variable to
2384 to disable that security check during system startup.
2385 .It Va kern_securelevel
2387 The kernel security level to set at startup.
2388 The allowed range of
2390 ranges from \-1 (the compile time default) to 3 (the most secure).
2393 for the list of possible security levels and their effect on system operation.
2400 at system boot time.
2407 at system boot time.
2410 Path to the SSH server program
2411 .Pa ( /usr/sbin/sshd
2419 these are the flags to pass to the
2428 at system boot time.
2435 these are the flags to pass to the
2444 daemon at boot time.
2451 these are the flags passed to
2454 .It Va watchdogd_enable
2460 daemon at boot time.
2461 This requires that the kernel have been compiled with
2462 .Cd "options WATCHDOG" .
2467 any configured jails will not be started.
2470 A space separated list of names for jails.
2471 This is purely a configuration aid to help identify and
2472 configure multiple jails.
2473 The names specified in this list will be used to
2474 identify settings common to an instance of a jail.
2475 Assuming that the jail in question was named
2477 you would have the following dependent variables:
2479 jail_vjail_hostname="jail.example.com"
2480 jail_vjail_ip="192.168.1.100"
2481 jail_vjail_rootdir="/var/jails/vjail/root"
2487 When set, use as default value for
2488 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2491 .It Va jail_interface
2494 When set, use as default value for
2495 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2501 When set, use as default value for
2502 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2505 .It Va jail_mount_enable
2513 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2516 by default for every jail in
2518 .It Va jail_fdesc_enable
2526 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2529 by default for every jail in
2531 .It Va jail_procfs_enable
2539 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2542 by default for every jail in
2544 .It Va jail_exec_start
2547 When set, use as default value for
2548 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2551 .It Va jail_exec_stop
2553 When set, use as default value for
2554 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2557 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2560 Set to the root directory used by jail
2562 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2565 Set to the fully qualified domain name (FQDN) assigned to jail
2567 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2570 Set to the IP address assigned to jail
2572 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2577 These are flags to pass to
2579 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2582 When set, sets the interface to use when setting IP address alias.
2583 Note that the alias is created at jail startup and removed at jail shutdown.
2584 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2587 .Pa /etc/fstab. Ns Aq Ar jname
2589 This is the file system information file to use for jail
2591 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2598 mount all file systems from
2599 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2601 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2608 mount the file-descriptor file system inside jail
2611 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2618 mount the process file system inside jail
2621 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2624 .Dq Li /bin/sh /etc/rc
2626 This is the command executed at jail startup.
2627 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2630 .Dq Li /bin/sh /etc/rc.shutdown
2632 This is the command executed at jail shutdown.
2633 .It Va jail_set_hostname_allow
2637 do not allow the root user in a jail to set its hostname.
2638 .It Va jail_socket_unixiproute_only
2642 do not allow any sockets,
2643 besides UNIX/IP/route sockets,
2644 to be used within a jail.
2645 .It Va jail_sysvipc_allow
2649 allow applications within a jail to use System V IPC.
2650 .It Va newsyslog_enable
2656 before syslogd starts.
2657 .It Va newsyslog_flags
2660 .Va newsyslog_enable
2663 these are the flags passed to
2665 .It Va resident_enable
2669 make the dynamic binaries listed in
2670 .Pa /etc/resident.conf
2672 .It Va varsym_enable
2677 .Pa /etc/varsym.conf
2678 to set system-wide variables for variant symlinks.
2683 or a whitespace separated list of IRQ numbers which will be used as a source of
2685 .\" ----- isdn settings ---------------------------------
2695 daemon at system boot time.
2699 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2701 Additional flags to pass to
2707 for certain tunable parameters).
2713 The terminal type of the output device when
2715 operates in full-screen mode.
2716 .It Va isdn_screenflags
2721 The video mode for full-screen mode (only for
2731 The output device for
2733 in full-screen mode (or
2743 enables the ISDN protocol trace utility
2745 at system boot time.
2746 .It Va isdn_traceflags
2749 .Dq Fl f Pa /var/tmp/isdntrace0
2753 .\" -----------------------------------------------------
2758 to disable caching entropy via
2760 Otherwise set to the directory used to store entropy files in.
2765 to disable caching entropy through reboots.
2766 Otherwise set to the filename used to store cached entropy through reboots.
2767 This file should be located on the root file system to seed the
2769 device as early as possible in the boot process.
2781 Configuration file for
2790 .Pa /var/run/dmesg.boot
2792 .It Va rcshutdown_timeout
2794 If set, start a watchdog timer in the background which will terminate
2798 has not completed within the specified time (in seconds).
2801 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
2802 .It Pa /etc/defaults/rc.conf
2804 .It Pa /etc/rc.conf.local
2822 .Xr resident.conf 5 ,
2886 .An Jordan K. Hubbard .