4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $
26 .\" $DragonFly: src/share/man/man5/rc.conf.5,v 1.61 2008/10/20 07:35:08 swildner Exp $
32 .Nd system configuration information
36 contains descriptive information about the local host name, configuration
37 details for any potential network interfaces and which services should be
38 started up at system initial boot time.
39 In new installations, the
41 file is generally initialized by the installer.
45 is not to run commands or perform system startup actions directly.
46 Instead, it is included by the various generic startup scripts in
48 which conditionalize their
49 internal actions according to the settings found there.
52 .Pa /etc/defaults/rc.conf
53 file specifies the default settings for all the available options,
56 file specifies override settings.
57 Options need only be specified in
59 when the system administrator wishes to override the defaults.
61 .Pa /etc/rc.conf.local
62 is used to override settings in
64 for historical reasons.
69 The following list provides a name and short description for each
70 variable that can be set in the
87 These values are case insensitive.
90 postfix in the name of a variable for starting a service can be
93 .Bl -tag -width indent-two
98 enable output of debug messages from rc scripts.
99 This variable can be helpful in diagnosing mistakes when
100 editing or integrating new scripts.
101 Beware that this produces copious output to the terminal and
107 disable informational messages from the rc scripts.
108 Informational messages are displayed when
109 a condition that is not serious enough to warrant a warning or an error occurs.
114 no swapfile is installed, otherwise the value is used as the full
115 pathname to a file to use for additional swap space.
120 enable support for Automatic Power Management with the
127 to handle APM event from userland.
128 This also enables support for APM.
135 these are the flags to pass to the
141 to monitor the status of batteries present in the system.
142 This also enables support for APM.
149 these are the flags to pass to the
156 to handle device added, removed or unknown events from the kernel.
163 these are the flags to pass to the
166 .It Va sensorsd_enable
175 a sensors monitoring and logging daemon.
176 .It Va sensorsd_flags
179 Additional flags passed to the
182 .It Va pccard_ifconfig
184 List of arguments to be passed to
186 at boot time or on insertion of the card (e.g.\&
187 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
188 for a fixed address or
191 .It Va pccard_ether_delay
193 Set the delay before starting
196 .Pa /etc/pccard_ether
198 This defaults to 5 seconds to work around a bug in the
200 driver which can lead to system hangs when using some newer
203 .It Va removable_interfaces
205 List of removable network interfaces to be supported by
206 .Pa /etc/pccard_ether .
209 List of directories to search for startup script files.
210 .It Va script_name_sep
212 The field separator to use for breaking down the list of startup script files
213 into individual filenames.
214 The default is a space.
215 It is not necessary to change this unless there are startup scripts with names
217 .It Va hostapd_enable
226 The fully qualified domain name (FQDN) of this host on the network.
227 This should almost certainly be set to something meaningful, even if
228 there is no network connection.
231 is used to set the hostname via DHCP,
232 this variable should be set to an empty string.
235 Enable support for IPv6 networking.
236 Note that this requires that the kernel have been compiled with
237 .Cd "options INET6" .
240 The NIS domain name of this host, or
243 .It Va dhclient_program
245 Path to the DHCP client program
247 .Pa /sbin/dhclient ) .
248 .It Va dhclient_flags
250 Additional flags to pass to the DHCP client program.
258 If the kernel was not built with
262 kernel module will be loaded.
266 .Va ipfilter_enable .
271 ruleset definition file.
282 these are the flags to pass to
284 when loading the ruleset.
291 which logs packets from
299 this specifies the path of the log file.
310 these are the flags to pass to
312 .It Va firewall_enable
316 to load firewall rules at startup.
317 If the kernel was not built with
318 .Cd "options IPFIREWALL" ,
321 kernel module will be loaded.
325 .Va ipfilter_enable .
326 .It Va ipv6_firewall_enable
328 The IPv6 equivalent of
329 .Va firewall_enable .
332 to load IPv6 firewall rules at startup.
333 If the kernel was not built with
334 .Cd "options IPV6FIREWALL" ,
337 kernel module will be loaded.
338 .It Va firewall_script
340 The full path to the firewall script to run
342 .Pa /etc/rc.firewall ) .
343 .It Va ipv6_firewall_script
345 The IPv6 equivalent of
346 .Va firewall_script .
349 Names the firewall type from the selection in
350 .Pa /etc/rc.firewall ,
351 or the file which contains the local firewall ruleset.
352 Valid selections from
356 .Bl -tag -width ".Li simple" -compact
358 unrestricted IP access
360 all IP services disabled, except via
363 basic protection for a workstation on a LAN
369 If a filename is specified, the full path must be given.
370 .It Va firewall_trusted_nets
372 List of trusted networks (if
376 .It Va firewall_trusted_interfaces
378 List of trusted network interfaces (if
382 .It Va firewall_allowed_icmp_types
384 List of allowed ICMP types (if
388 .It Va firewall_open_tcp_ports
390 List of TCP ports to open (if
394 .It Va firewall_open_udp_ports
396 List of UDP ports to open (if
400 .It Va ipv6_firewall_type
402 The IPv6 equivalent of
404 .It Va firewall_quiet
408 to disable the display of firewall rules on the console during boot.
409 .It Va ipv6_firewall_quiet
411 The IPv6 equivalent of
413 .It Va firewall_logging
417 to enable firewall event logging.
418 This is equivalent to the
419 .Dv IPFIREWALL_VERBOSE
421 .It Va ipv6_firewall_logging
423 The IPv6 equivalent of
424 .Va firewall_logging .
425 .It Va firewall_flags
431 specifies a filename.
432 .It Va ipv6_firewall_flags
434 The IPv6 equivalent of
451 sockets must be enabled in the kernel.
452 .It Va natd_interface
454 This is the name of the public interface on which
457 The interface may be given as an interface name or as an IP address.
462 flags should be placed here.
467 flag is automatically added with the above
470 .\" ----- ipfilter_enable setting --------------------------------
471 .It Va ipfilter_enable
482 Typical usage will require putting
484 ipfilter_enable="YES"
502 can be enabled independently.
506 both require at least one of
516 options IPFILTER_DEFAULT_BLOCK
519 in the kernel configuration file is a good idea, too.
523 .Va firewall_enable .
524 .\" ----- ipfilter_program setting ------------------------------
525 .It Va ipfilter_program
531 .\" ----- ipfilter_rules setting --------------------------------
532 .It Va ipfilter_rules
537 The name of the filter rule definition file.
538 The file is expected to be readable for the
541 .\" ----- ipv6_ipfilter_rules setting ---------------------------
542 .It Va ipv6_ipfilter_rules
547 The name of the IPv6 filter rule definition file.
548 The file is expected to be readable for the
551 .\" ----- ipfilter_flags setting --------------------------------
552 .It Va ipfilter_flags
558 .\" ----- ipnat_enable setting ----------------------------------
568 network address translation.
571 for a detailed discussion.
572 .\" ----- ipnat_program setting ---------------------------------
579 .\" ----- ipnat_rules setting -----------------------------------
586 holding the network address translation definition.
587 This file is expected to be readable for the
590 .\" ----- ipnat_flags setting -----------------------------------
597 .\" ----- ipmon_enable setting ----------------------------------
612 Setting this variable needs setting
619 for a detailed discussion.
620 .\" ----- ipmon_program setting ---------------------------------
627 .\" ----- ipmon_flags setting -----------------------------------
636 Another typical example would be
637 .Dq Fl D Pa /var/log/ipflog
640 log directly to a file bypassing
643 .Pa /etc/newsyslog.conf
644 in such case like this:
646 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
648 .\" ----- ipfs_enable setting -----------------------------------
658 saving the filter and NAT state tables during shutdown
659 and reloading them during startup again.
660 Setting this variable needs setting
669 for a detailed discussion.
674 cannot be used because the raised securelevel will prevent
676 from saving the state tables at shutdown time.
677 .\" ----- ipfs_program setting ----------------------------------
684 .\" ----- ipfs_flags setting ------------------------------------
691 .\" ----- end of added ipf hook ---------------------------------
692 .It Va tcp_extensions
699 disables certain TCP options as described by
705 might help remedy such problems with connections as randomly hanging
706 or other weird behavior.
707 Some network devices are known to be broken with respect to these options.
714 .Va net.inet.tcp.log_in_vain
716 .Va net.inet.udp.log_in_vain ,
721 are set to the given value.
729 will disable probing idle TCP connections to verify that the
730 peer is still up and reachable.
731 .It Va tcp_drop_synfin
738 will cause the kernel to ignore TCP frames that have both
739 the SYN and FIN flags set.
740 This prevents OS fingerprinting, but may break some legitimate applications.
741 This option is only available if the kernel was built with the
744 .It Va icmp_drop_redirect
751 will cause the kernel to ignore ICMP REDIRECT packets.
754 for more information.
755 .It Va icmp_log_redirect
762 will cause the kernel to log ICMP REDIRECT packets.
764 the log messages are not rate-limited, so this option should only be used
765 for troubleshooting networks.
768 for more information.
769 .It Va icmp_bmcastecho
773 to respond to broadcast or multicast ICMP ping packets.
776 for more information.
777 .It Va ip_portrange_first
781 this is the first port in the default portrange.
784 for more information.
785 .It Va ip_portrange_last
789 this is the last port in the default portrange.
792 for more information.
794 .It Va ifconfig_ Ns Aq Ar interface
798 Typically includes IP address.
799 Assuming that the interface in question was
801 it might look something like this:
803 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
807 .Pa /etc/start_if. Ns Aq Ar interface
808 file is present, it is read and executed by the
810 interpreter before configuring the interface as specified in the
811 .Va ifconfig_ Ns Aq Ar interface
813 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
816 It is possible to bring up an interface with DHCP by adding
819 .Va ifconfig_ Ns Aq Ar interface
821 For instance, to initialize the
823 device via DHCP, it is possible to use something like:
828 Also, if your interface needs WPA authentication, it is possible to add
831 .Va ifconfig_ Ns Aq Ar interface
834 .Xr wpa_supplicant 8 .
836 .Xr wpa_supplicant.conf 5
837 for configuring authentication information.
841 options in this variable, in addition to the
842 .Pa /etc/start_if. Ns Aq Ar interface
844 For instance, to initialize the
846 device via DHCP, using WPA authentication and 802.11b mode, it is
847 possible to use something like:
849 ifconfig_wi0="up DHCP WPA mode 11b"
853 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
855 Configuration to establish an additional network address for
857 Assuming that the interface in question was
859 it might look something like this:
861 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
862 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
867 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
868 entry that is found, its contents are passed to
870 Execution stops at the first unsuccessful access, so if
871 something like this is present:
873 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
874 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
875 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
876 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
879 Then note that alias4 would
881 be added since the search would stop with the missing alias3 entry.
884 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
888 It is possible to rename interface by doing:
890 ifconfig_ed0_name="net0"
891 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
893 .It Va network_interfaces
895 The list of network interfaces to configure on this host,
898 to configure all network interfaces
901 For example, if the only network devices to be configured are the loopback device
905 driver, this could be set to
908 .Va ifconfig_ Ns Aq Ar interface
909 variable is assumed to exist for each value of
911 .It Va ipv6_network_interfaces
913 This is the IPv6 equivalent of
914 .Va network_interfaces .
915 Instead of setting the ifconfig variables as
916 .Va ifconfig_ Ns Aq Ar interface
917 they should be set as
918 .Va ipv6_ifconfig_ Ns Aq Ar interface .
919 Aliases should be set as
920 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
921 Interfaces that do not have a
922 .Va ipv6_ifconfig_ Ns Aq Ar interface
923 setting will be auto configured by
926 .Va ipv6_gateway_enable
929 Note that the IPv6 networking code does not support the
930 .Pa /etc/start_if. Ns Aq Ar interface
932 .It Va ipv6_prefix_ Ns Aq Ar interface
936 prefixlen 64 is used.
937 .It Va ipv6_default_interface
941 this is the default output interface for scoped addresses.
942 Now this works only for IPv6 link local multicast addresses.
943 .It Va cloned_interfaces
945 Set to the list of clonable network interfaces to create on this host.
947 .Va cloned_interfaces
948 are automatically appended to
949 .Va network_interfaces
951 .It Va gif_interfaces
955 tunnel interfaces to configure on this host.
957 .Va gifconfig_ Ns Aq Ar interface
958 variable is assumed to exist for each value of
960 The value of this variable is used to configure the link layer of the
961 tunnel according to the syntax of the
965 Additionally, this option ensures that each listed interface is created via the
969 before attempting to configure it.
970 .It Va sppp_interfaces
974 interfaces to configure on this host.
976 .Va spppconfig_ Ns Aq Ar interface
977 variable is assumed to exist for each value of
979 Each interface should also be configured by a general
980 .Va ifconfig_ Ns Aq Ar interface
984 for more information about available options.
994 Mode in which to run the
1003 See the manual for a full description.
1008 enables network address translation.
1009 Used in conjunction with
1011 allows hosts on private network addresses access to the Internet using
1012 this host as a network address translating router.
1015 The name of the profile to use from
1016 .Pa /etc/ppp/ppp.conf .
1019 The name of the user under which
1026 .It Va rc_conf_files
1028 This option is used to specify a list of files that will override
1030 .Pa /etc/defaults/rc.conf .
1031 The files will be read in the order in which they are specified and should
1032 include the full path to the file.
1033 By default, the files specified are
1036 .Pa /etc/rc.conf.local
1037 .It Va fsck_y_enable
1042 will be run with the
1044 flag if the initial preen of the file systems fails.
1047 List of file system types that are network-based.
1048 This list should generally not be modified by end users.
1050 .Va extra_netfs_types
1052 .It Va extra_netfs_types
1054 If set to something other than
1056 (the default), this variable extends the list of file system types
1057 for which automatic mounting at startup by
1059 should be delayed until the network is initialized.
1061 a whitespace-separated list of network file system descriptor pairs,
1062 each consisting of a file system type as passed to
1064 and a human-readable, one-word description, joined with a colon
1066 Extending the default list in this way is only necessary
1067 when third party file system types are used.
1068 .It Va devfs_config_files
1070 This option is used to specify a list of configuration files containing
1072 rules that will be applied by
1074 in the order in which they are specified and must include the full path
1076 .It Va syslogd_enable
1083 .It Va syslogd_program
1088 .Pa /usr/sbin/syslogd ) .
1089 .It Va syslogd_flags
1095 these are the flags to pass to
1104 .It Va inetd_program
1109 .Pa /usr/sbin/inetd ) .
1116 these are the flags to pass to
1125 .It Va named_program
1130 .Pa /usr/sbin/named ) .
1137 these are the flags to pass to
1139 .It Va named_pidfile
1141 This is the default path to the
1144 Change it if you change the location in
1145 .Pa /etc/namedb/named.conf .
1146 .It Va named_chrootdir
1148 The root directory for a name server run in a
1153 will not be run in a
1162 daemon at boot time.
1169 these are the flags to pass to it.
1176 daemon at boot time.
1183 these are the flags to pass to it.
1186 manpage for more information.
1187 .It Va amd_map_program
1189 If set, the specified program is run to get the list of
1194 maps are stored in NIS, one can set this to run
1206 will be updated at boot time to reflect the kernel release being run.
1210 will not be updated.
1211 .It Va nfs_client_enable
1215 setup NFS client parameters at boot time.
1216 .It Va nfs_access_cache
1219 .Va nfs_client_enable
1224 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1225 NFS ACCESS results should be cached.
1226 A value of 2-10 seconds will substantially reduce network traffic for
1227 many NFS operations.
1228 The default is 5 seconds.
1229 Note that the attribute cache holds stat information only.
1230 The NFS data cache is independent of the attribute cache and is only
1231 invalidated when the client detects that the server has modified the
1233 This value specifies a maximum timeout.
1234 The NFS client will automatically use a shorter timeout for files which
1235 have been recently modified.
1236 .It Va nfs_neg_cache
1239 .Va nfs_client_enable
1244 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1245 filenames), or to the number of seconds for which negative lookups should
1247 A value of 2-10 seconds will substantially reduce network
1248 traffic for many NFS operations, especially source code builds.
1249 The default is 3 seconds.
1250 .It Va nfs_server_enable
1254 run the NFS server daemons at boot time.
1255 .It Va nfs_server_flags
1258 .Va nfs_server_enable
1261 these are the flags to pass to the
1264 .It Va mountd_enable
1269 .Va nfs_server_enable
1275 It is commonly needed to run CFS without real NFS used.
1282 these are the flags to pass to the
1285 .It Va weak_mountd_authentication
1289 allow services like PCNFSD to make non-privileged mount requests.
1290 .It Va nfs_reserved_port_only
1294 provide NFS services only on a secure port.
1295 .It Va nfs_bufpackets
1297 If set to a number, indicates the number of packets worth of
1298 socket buffer space to reserve on an NFS client.
1299 The kernel default is typically 4.
1300 Using a higher number may be useful on gigabit networks to improve performance.
1301 The minimum value is 2 and the maximum is 64.
1302 .It Va rpc_umntall_enable
1306 (default) and we are also an NFS client, run
1308 at boot time to clear out old mounts on remote servers.
1313 will not be run at boot time.
1314 .It Va rpc_lockd_enable
1318 and also an NFS server, run
1321 .It Va rpc_lockd_flags
1324 .Va rpc_lockd_enable
1327 these are the flags to pass to
1329 .It Va rpc_statd_enable
1333 and also an NFS server, run
1336 .It Va rpc_statd_flags
1339 .Va rpc_statd_enable
1342 these are the flags to pass to
1344 .It Va rpcbind_program
1346 Path to program for rpcbind daemon
1348 .Pa /usr/sbin/rpcbind ) .
1349 .It Va rpcbind_enable
1356 .It Va rpcbind_flags
1362 these are the flags to pass to
1363 .Va rpcbind_program .
1364 .It Va keyserv_enable
1370 daemon on boot for running Secure RPC.
1371 .It Va keyserv_flags
1377 these are the flags to pass to
1380 .It Va pppoed_enable
1386 daemon at boot time to provide PPP over Ethernet services.
1387 .It Va pppoed_provider
1390 listens to requests to this provider and ultimately runs
1394 argument of the same name.
1397 Additional flags to pass to
1399 .It Va pppoed_interface
1401 The network interface to run
1404 This is mandatory when
1414 service at boot time.
1415 This command is intended for networks of machines where a consistent
1417 for all hosts must be established.
1418 This is often useful in large NFS environments where time stamps on
1419 files are expected to be consistent network-wide.
1426 these are the flags to pass to the
1435 at system boot time.
1436 .It Va dntpd_program
1441 .Pa /usr/sbin/dntpd ) .
1448 these are the flags to pass to the
1451 .It Va btconfig_enable
1455 configure Bluetooth devices via
1457 at system boot time.
1458 .It Va btconfig_devices
1464 this is the list of Bluetooth devices to configure.
1466 .Va btconfig_devices
1467 is not specified, all devices known to the system will be configured.
1469 .Va btconfig_ Ns Aq Ar device
1470 variable can be set to specify parameters to be passed to
1472 .It Va btconfig_args
1478 this is the list of configuration parameters to pass to all Bluetooth
1484 run the Service Discovery Profile daemon
1486 at system boot time.
1493 these are the flags to pass to the
1496 .It Va bthcid_enable
1500 run the Bluetooth Link Key/PIN Code Manager daemon
1502 at system boot time.
1509 these are the flags to pass to the
1512 .It Va nis_client_enable
1518 service at system boot time.
1519 .It Va nis_client_flags
1522 .Va nis_client_enable
1525 these are the flags to pass to the
1528 .It Va nis_ypset_enable
1534 daemon at system boot time.
1535 .It Va nis_ypset_flags
1538 .Va nis_ypset_enable
1541 these are the flags to pass to the
1544 .It Va nis_server_enable
1550 daemon at system boot time.
1551 .It Va nis_server_flags
1554 .Va nis_server_enable
1557 these are the flags to pass to the
1560 .It Va nis_ypxfrd_enable
1566 daemon at system boot time.
1567 .It Va nis_ypxfrd_flags
1570 .Va nis_ypxfrd_enable
1573 these are the flags to pass to the
1576 .It Va nis_yppasswdd_enable
1582 daemon at system boot time.
1583 .It Va nis_yppasswdd_flags
1586 .Va nis_yppasswdd_enable
1589 these are the flags to pass to the
1592 .It Va rpc_ypupdated_enable
1598 daemon at system boot time.
1599 .It Va defaultrouter
1603 create a default route to this host name or IP address
1604 (use an IP address if this router is also required to get to the
1606 .It Va ipv6_defaultrouter
1608 The IPv6 equivalent of
1610 .It Va static_routes
1612 Set to the list of static routes that are to be added at system boot time.
1615 then for each whitespace separated
1618 .Va route_ Ns Aq Ar element
1619 variable is assumed to exist whose contents will later be passed to a
1622 .It Va ipv6_static_routes
1624 The IPv6 equivalent of
1628 then for each whitespace separated
1631 .Va ipv6_route_ Ns Aq Ar element
1632 variable is assumed to exist whose contents will later be passed to a
1633 .Dq Nm route Cm add Fl inet6
1635 .It Va gateway_enable
1639 configure host to act as an IP router, e.g. to forward packets
1641 .It Va ipv6_gateway_enable
1643 The IPv6 equivalent of
1644 .Va gateway_enable .
1645 .It Va router_enable
1649 run a routing daemon of some sort, based on the settings of
1653 .It Va ipv6_router_enable
1655 The IPv6 equivalent of
1659 run a routing daemon of some sort, based on the settings of
1660 .Va ipv6_router_program
1662 .Va ipv6_router_flags .
1663 .It Va router_program
1669 this is the name of the routing daemon to use
1671 .Pa /sbin/routed ) .
1672 .It Va ipv6_router_program
1674 The IPv6 equivalent of
1677 .Pa /sbin/route6d ) .
1684 these are the flags to pass to the routing daemon.
1685 .It Va ipv6_router_flags
1687 The IPv6 equivalent of
1689 .It Va mrouted_enable
1693 run the multicast routing daemon,
1695 .It Va mroute6d_enable
1697 The IPv6 equivalent of
1698 .Va mrouted_enable .
1701 run the IPv6 multicast routing daemon.
1702 Note that no IPv6 multicast routing daemon is included in the
1706 can be installed from the
1709 .It Va mrouted_flags
1715 these are the flags to pass to the
1718 .It Va mroute6d_flags
1720 The IPv6 equivalent of
1726 these are the flags passed to the IPv6 multicast routing daemon.
1727 .It Va mroute6d_program
1733 this is the path to the IPv6 multicast routing daemon.
1734 .It Va rtadvd_enable
1740 daemon at boot time.
1743 .Va ipv6_gateway_enable
1748 utility sends router advertisement packets to the interfaces specified in
1749 .Va rtadvd_interfaces .
1751 and should only be enabled with great care.
1752 You may want to fine-tune
1754 .It Va rtadvd_interfaces
1760 this is the list of interfaces to use.
1761 .It Va rtsold_enable
1767 daemon at boot time.
1770 daemon is used for automatic discovery of non-link local addresses.
1777 these are the flags to pass to the
1780 .It Va ipxgateway_enable
1784 enable the routing of IPX traffic.
1785 .It Va ipxrouted_enable
1791 daemon at system boot time.
1792 .It Va ipxrouted_flags
1795 .Va ipxrouted_enable
1798 these are the flags to pass to the
1805 enable global proxy ARP.
1806 .It Va forward_sourceroute
1814 source-routed packets are forwarded.
1815 .It Va accept_sourceroute
1819 the system will accept source-routed packets directed at it.
1826 daemon at system boot time.
1833 these are the flags to pass to the
1836 .It Va bootparamd_enable
1842 daemon at system boot time.
1843 .It Va bootparamd_flags
1846 .Va bootparamd_enable
1849 these are the flags to pass to the
1852 .It Va stf_interface_ipv4addr
1856 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1857 Specify this entry to enable the 6to4 interface.
1858 .It Va stf_interface_ipv4plen
1860 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1861 An effective value is 0-31.
1862 .It Va stf_interface_ipv6_ifid
1864 IPv6 interface ID for
1868 .It Va stf_interface_ipv6_slaid
1870 IPv6 Site Level Aggregator for
1872 .It Va ipv6_faith_prefix
1876 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1880 .It Va ipv6_ipv4mapping
1884 this enables IPv4 mapped IPv6 address communication (like
1885 .Li ::ffff:a.b.c.d ) .
1890 to enable the configuration of ATM interfaces at system boot time.
1891 For all of the ATM variables described below, please refer to the
1893 man page for further details on the available command parameters.
1894 Also refer to the files in
1895 .Pa /usr/share/examples/atm
1896 for more detailed configuration information.
1897 .It Va atm_netif_ Ns Aq Ar intf
1899 For the ATM physical interface
1901 this variable defines the name prefix and count for the ATM network
1902 interfaces to be created.
1903 The value will be passed as the parameters of an
1904 .Dq Nm atm Cm "set netif" Ar intf
1906 .It Va atm_sigmgr_ Ns Aq Ar intf
1908 For the ATM physical interface
1910 this variable defines the ATM signalling manager to be used.
1911 The value will be passed as the parameters of an
1912 .Dq Nm atm Cm attach Ar intf
1914 .It Va atm_prefix_ Ns Aq Ar intf
1916 For the ATM physical interface
1918 this variable defines the NSAP prefix for interfaces using a UNI signalling
1922 the prefix will automatically be set via the
1925 Otherwise, the value will be passed as the parameters of an
1926 .Dq Nm atm Cm "set prefix" Ar intf
1928 .It Va atm_macaddr_ Ns Aq Ar intf
1930 For the ATM physical interface
1932 this variable defines the MAC address for interfaces using a UNI signalling
1936 the hardware MAC address contained in the ATM interface card will be used.
1937 Otherwise, the value will be passed as the parameters of an
1938 .Dq Nm atm Cm "set mac" Ar intf
1940 .It Va atm_arpserver_ Ns Aq Ar netif
1942 For the ATM network interface
1944 this variable defines the ATM address for a host which is to provide ATMARP
1946 This variable is only applicable to interfaces using a UNI signalling manager.
1949 this host will become an ATMARP server.
1950 The value will be passed as the parameters of an
1951 .Dq Nm atm Cm "set arpserver" Ar netif
1953 .It Va atm_scsparp_ Ns Aq Ar netif
1957 SCSP/ATMARP service for the network interface
1959 will be initiated using the
1964 This variable is only applicable if
1965 .Va atm_arpserver_ Ns Aq Ar netif
1970 Set to the list of permanent ATM ARP entries to be added at system boot time.
1971 For each whitespace separated
1974 .Va atm_arp_ Ns Aq Ar element
1975 variable is assumed to exist.
1976 The value of each of these variables will be passed as the parameters of an
1977 .Dq Nm atm Cm "add arp"
1981 The keyboard bell sound.
1988 if the default behavior is desired.
1989 For details, refer to the
1996 no keymap is installed, otherwise the value is used to install
1998 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2001 The keyboard repeat speed.
2008 if the default behavior is desired.
2013 attempt to program the function keys with the value.
2014 The value should be a single string of the form:
2015 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2018 Can be set to the value of
2021 .Dq Li destructive ,
2024 to set the cursor behavior explicitly or choose the default behavior.
2029 no screen map is installed, otherwise the value is used to install
2030 the screen map file in
2031 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2036 the default 8x16 font value is used for screen size requests, otherwise
2038 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2044 the default 8x14 font value is used for screen size requests, otherwise
2046 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2052 the default 8x8 font value is used for screen size requests, otherwise
2054 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2060 the default screen blanking interval is used, otherwise it is set to
2067 this is the actual screen saver to use
2068 .Li ( blank , snake , daemon ,
2070 .It Va moused_enable
2076 daemon is started for doing cut/paste selection on the console.
2079 This is the protocol type of the mouse connected to this host.
2080 This variable must be set if
2087 is able to detect the appropriate mouse type automatically in many cases.
2088 Set this variable to
2090 to let the daemon detect it, or
2091 select one from the following list if the automatic detection fails.
2093 If the mouse is attached to the PS/2 mouse port, choose
2097 regardless of the brand and model of the mouse.
2098 Likewise, if the mouse is attached to the bus mouse port, choose
2102 All other protocols are for serial mice and will not work with
2103 the PS/2 and bus mice.
2104 If this is a USB mouse,
2106 is the only protocol type which will work.
2108 .Bl -tag -width ".Li x10mouseremote" -compact
2110 Microsoft mouse (serial)
2112 Microsoft IntelliMouse (serial)
2114 Mouse systems Corp. mouse (serial)
2116 MM Series mouse (serial)
2118 Logitech mouse (serial)
2122 Logitech MouseMan and TrackMan (serial)
2124 ALPS GlidePoint (serial)
2125 .It Li thinkingmouse
2126 Kensington ThinkingMouse (serial)
2130 MM HitTablet (serial)
2131 .It Li x10mouseremote
2132 X10 MouseRemote (serial)
2134 Interlink VersaPad (serial)
2137 Even if the mouse is not in the above list, it may be compatible
2138 with one in the list.
2139 Refer to the man page for
2141 for compatibility information.
2143 It should also be noted that while this is enabled, any
2144 other client of the mouse (such as an X server) should access
2145 the mouse through the virtual mouse device,
2147 and configure it as a
2149 type mouse, since all
2150 mouse data is converted to this single canonical format when using
2152 If the client program does not support the
2157 It is the second preferred type.
2164 this is the actual port the mouse is on.
2167 for a COM1 serial mouse,
2171 for a bus mouse, for example.
2176 is set, these are the additional flags to pass to the
2179 .It Va mousechar_start
2183 the default mouse cursor character range
2184 .Li 0xd0 Ns - Ns Li 0xd3
2185 is used, otherwise the range start is set to
2189 Use if the default range is occupied in the language code table.
2192 Set the size of the history (scrollback) buffer in lines.
2193 .It Va allscreens_flags
2197 is run with these options for each of the virtual terminals
2201 will enable the mouse pointer on all virtual terminals if
2205 .It Va allscreens_kbdflags
2209 is run with these options for each of the virtual terminals
2215 scrollback (history) buffer to 200 lines.
2222 daemon at system boot time.
2228 .Pa /usr/sbin/cron ) .
2235 these are the flags to pass to
2242 .Pa /usr/sbin/lpd ) .
2249 daemon at system boot time.
2256 these are the flags to pass to the
2265 daemon at system boot time.
2272 settings across reboots.
2273 .It Va mta_start_script
2275 The full path to the script to run to start
2276 a mail transfer agent.
2278 .Pa /etc/rc.sendmail .
2282 .Pa /etc/rc.sendmail
2283 uses are documented in the
2289 .Sq HAMMER ROOT with UFS /boot
2290 setup, the boot loader will not set up the
2293 The system will attempt to fix this on its own.
2294 Set this variable to
2296 to turn this behavior off.
2299 Indicates the device (usually a swap partition) to which a crash dump
2300 should be written in the event of a system crash.
2301 The value of this variable is passed as the argument to
2303 To disable crash dumps, set this variable to
2307 When the system reboots after a crash and a crash dump is found on the
2308 device specified by the
2312 will save that crash dump and a copy of the kernel to the directory
2316 The default value is
2325 .It Va savecore_flags
2327 If crash dumps are enabled, these are the flags to pass to the
2330 .It Va enable_quotas
2334 to turn on user disk quotas on system startup via the
2341 to enable user disk quota checking via the
2344 .It Va accounting_enable
2348 to enable system accounting through the
2355 to enable Linux/ELF binary emulation at system initial boot time.
2356 .It Va sysvipc_enable
2360 load System V IPC primitives at boot time.
2361 .\" ----- cleanvar_enable setting--------------------------------
2362 .It Va cleanvar_enable
2370 .Pa /var/spool/uucp/.Temp/*
2372 .\" ----- clear_tmp_enable setting-------------------------------
2373 .It Va clear_tmp_enable
2380 .\" ----- ldconfig_paths setting --------------------------------
2381 .It Va ldconfig_paths
2383 Set to the list of shared library paths to use with
2387 will always be added first, so it need not appear in this list.
2388 .It Va ldconfig_insecure
2392 utility normally refuses to use directories
2393 which are writable by anyone except root.
2394 Set this variable to
2396 to disable that security check during system startup.
2397 .It Va kern_securelevel
2399 The kernel security level to set at startup.
2400 The allowed range of
2402 ranges from \-1 (the compile time default) to 3 (the most secure).
2405 for the list of possible security levels and their effect on system operation.
2412 at system boot time.
2419 at system boot time.
2422 Path to the SSH server program
2424 .Pa /usr/sbin/sshd ) .
2431 these are the flags to pass to the
2440 at system boot time.
2447 these are the flags to pass to the
2456 daemon at boot time.
2463 these are the flags passed to
2466 .It Va watchdogd_enable
2472 daemon at boot time.
2473 This requires that the kernel have been compiled with
2474 .Cd "options WATCHDOG" .
2479 any configured jails will not be started.
2482 A space separated list of names for jails.
2483 This is purely a configuration aid to help identify and
2484 configure multiple jails.
2485 The names specified in this list will be used to
2486 identify settings common to an instance of a jail.
2487 Assuming that the jail in question was named
2489 you would have the following dependent variables:
2491 jail_vjail_hostname="jail.example.com"
2492 jail_vjail_ip="192.168.1.100"
2493 jail_vjail_rootdir="/var/jails/vjail/root"
2499 When set, use as default value for
2500 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2503 .It Va jail_interface
2506 When set, use as default value for
2507 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2513 When set, use as default value for
2514 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2517 .It Va jail_mount_enable
2525 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2528 by default for every jail in
2530 .It Va jail_fdesc_enable
2538 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2541 by default for every jail in
2543 .It Va jail_procfs_enable
2551 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2554 by default for every jail in
2556 .It Va jail_exec_start
2559 When set, use as default value for
2560 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2563 .It Va jail_exec_stop
2565 When set, use as default value for
2566 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2569 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2572 Set to the root directory used by jail
2574 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2577 Set to the fully qualified domain name (FQDN) assigned to jail
2579 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2582 Set to the IP address assigned to jail
2584 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2589 These are flags to pass to
2591 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2594 When set, sets the interface to use when setting IP address alias.
2595 Note that the alias is created at jail startup and removed at jail shutdown.
2596 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2599 .Pa /etc/fstab. Ns Aq Ar jname
2601 This is the file system information file to use for jail
2603 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2610 mount all file systems from
2611 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2613 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2620 mount the file-descriptor file system inside jail
2623 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2630 mount the process file system inside jail
2633 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2636 .Dq Li /bin/sh /etc/rc
2638 This is the command executed at jail startup.
2639 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2642 .Dq Li /bin/sh /etc/rc.shutdown
2644 This is the command executed at jail shutdown.
2645 .It Va jail_set_hostname_allow
2649 do not allow the root user in a jail to set its hostname.
2650 .It Va jail_socket_unixiproute_only
2654 do not allow any sockets,
2655 besides UNIX/IP/route sockets,
2656 to be used within a jail.
2657 .It Va jail_sysvipc_allow
2661 allow applications within a jail to use System V IPC.
2662 .It Va newsyslog_enable
2668 before syslogd starts.
2669 .It Va newsyslog_flags
2672 .Va newsyslog_enable
2675 these are the flags passed to
2677 .It Va resident_enable
2681 make the dynamic binaries listed in
2682 .Pa /etc/resident.conf
2684 .It Va varsym_enable
2689 .Pa /etc/varsym.conf
2690 to set system-wide variables for variant symlinks.
2695 or a whitespace separated list of IRQ numbers which will be used as a source of
2697 .\" ----- isdn settings ---------------------------------
2707 daemon at system boot time.
2711 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2713 Additional flags to pass to
2719 for certain tunable parameters).
2725 The terminal type of the output device when
2727 operates in full-screen mode.
2728 .It Va isdn_screenflags
2733 The video mode for full-screen mode (only for
2743 The output device for
2745 in full-screen mode (or
2755 enables the ISDN protocol trace utility
2757 at system boot time.
2758 .It Va isdn_traceflags
2761 .Dq Fl f Pa /var/tmp/isdntrace0
2765 .\" -----------------------------------------------------
2770 to disable caching entropy via
2772 Otherwise set to the directory used to store entropy files in.
2777 to disable caching entropy through reboots.
2778 Otherwise set to the filename used to store cached entropy through reboots.
2779 This file should be located on the root file system to seed the
2781 device as early as possible in the boot process.
2793 Configuration file for
2802 .Pa /var/run/dmesg.boot
2804 .It Va rcshutdown_timeout
2806 If set, start a watchdog timer in the background which will terminate
2810 has not completed within the specified time (in seconds).
2813 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2814 .It Pa /etc/defaults/rc.conf
2816 .It Pa /etc/rc.conf.local
2817 .It Pa /etc/start_if. Ns Aq Ar interface
2835 .Xr resident.conf 5 ,
2899 .An Jordan K. Hubbard .