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 $
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 hotplugd_enable
191 a devices hot plugging monitoring daemon.
192 .It Va hotplugd_flags
195 Additional flags passed to the
198 .It Va pccard_ifconfig
200 List of arguments to be passed to
202 at boot time or on insertion of the card (e.g.\&
203 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
204 for a fixed address or
207 .It Va pccard_ether_delay
209 Set the delay before starting
212 .Pa /etc/pccard_ether
214 This defaults to 5 seconds to work around a bug in the
216 driver which can lead to system hangs when using some newer
219 .It Va removable_interfaces
221 List of removable network interfaces to be supported by
222 .Pa /etc/pccard_ether .
225 List of directories to search for startup script files.
226 .It Va script_name_sep
228 The field separator to use for breaking down the list of startup script files
229 into individual filenames.
230 The default is a space.
231 It is not necessary to change this unless there are startup scripts with names
233 .It Va hostapd_enable
242 The fully qualified domain name (FQDN) of this host on the network.
243 This should almost certainly be set to something meaningful, even if
244 there is no network connection.
247 is used to set the hostname via DHCP,
248 this variable should be set to an empty string.
251 Enable support for IPv6 networking.
252 Note that this requires that the kernel have been compiled with
253 .Cd "options INET6" .
256 The NIS domain name of this host, or
259 .It Va dhclient_program
261 Path to the DHCP client program
263 .Pa /sbin/dhclient ) .
264 .It Va dhclient_flags
266 Additional flags to pass to the DHCP client program.
274 If the kernel was not built with
278 kernel module will be loaded.
282 .Va ipfilter_enable .
287 ruleset definition file.
298 these are the flags to pass to
300 when loading the ruleset.
307 which logs packets from
315 this specifies the path of the log file.
326 these are the flags to pass to
328 .It Va firewall_enable
332 to load firewall rules at startup.
333 If the kernel was not built with
334 .Cd "options IPFIREWALL" ,
337 kernel module will be loaded.
341 .Va ipfilter_enable .
342 .It Va ipv6_firewall_enable
344 The IPv6 equivalent of
345 .Va firewall_enable .
348 to load IPv6 firewall rules at startup.
349 If the kernel was not built with
350 .Cd "options IPV6FIREWALL" ,
353 kernel module will be loaded.
354 .It Va firewall_script
356 The full path to the firewall script to run
358 .Pa /etc/rc.firewall ) .
359 .It Va ipv6_firewall_script
361 The IPv6 equivalent of
362 .Va firewall_script .
365 Names the firewall type from the selection in
366 .Pa /etc/rc.firewall ,
367 or the file which contains the local firewall ruleset.
368 Valid selections from
372 .Bl -tag -width ".Li simple" -compact
374 unrestricted IP access
376 all IP services disabled, except via
379 basic protection for a workstation on a LAN
385 If a filename is specified, the full path must be given.
386 .It Va firewall_trusted_nets
388 List of trusted networks (if
392 .It Va firewall_trusted_interfaces
394 List of trusted network interfaces (if
398 .It Va firewall_allowed_icmp_types
400 List of allowed ICMP types (if
404 .It Va firewall_open_tcp_ports
406 List of TCP ports to open (if
410 .It Va firewall_open_udp_ports
412 List of UDP ports to open (if
416 .It Va ipv6_firewall_type
418 The IPv6 equivalent of
420 .It Va firewall_quiet
424 to disable the display of firewall rules on the console during boot.
425 .It Va ipv6_firewall_quiet
427 The IPv6 equivalent of
429 .It Va firewall_logging
433 to enable firewall event logging.
434 This is equivalent to the
435 .Dv IPFIREWALL_VERBOSE
437 .It Va ipv6_firewall_logging
439 The IPv6 equivalent of
440 .Va firewall_logging .
441 .It Va firewall_flags
447 specifies a filename.
448 .It Va ipv6_firewall_flags
450 The IPv6 equivalent of
467 sockets must be enabled in the kernel.
468 .It Va natd_interface
470 This is the name of the public interface on which
473 The interface may be given as an interface name or as an IP address.
478 flags should be placed here.
483 flag is automatically added with the above
486 .\" ----- ipfilter_enable setting --------------------------------
487 .It Va ipfilter_enable
498 Typical usage will require putting
500 ipfilter_enable="YES"
518 can be enabled independently.
522 both require at least one of
532 options IPFILTER_DEFAULT_BLOCK
535 in the kernel configuration file is a good idea, too.
539 .Va firewall_enable .
540 .\" ----- ipfilter_program setting ------------------------------
541 .It Va ipfilter_program
547 .\" ----- ipfilter_rules setting --------------------------------
548 .It Va ipfilter_rules
553 The name of the filter rule definition file.
554 The file is expected to be readable for the
557 .\" ----- ipv6_ipfilter_rules setting ---------------------------
558 .It Va ipv6_ipfilter_rules
563 The name of the IPv6 filter rule definition file.
564 The file is expected to be readable for the
567 .\" ----- ipfilter_flags setting --------------------------------
568 .It Va ipfilter_flags
574 .\" ----- ipnat_enable setting ----------------------------------
584 network address translation.
587 for a detailed discussion.
588 .\" ----- ipnat_program setting ---------------------------------
595 .\" ----- ipnat_rules setting -----------------------------------
602 holding the network address translation definition.
603 This file is expected to be readable for the
606 .\" ----- ipnat_flags setting -----------------------------------
613 .\" ----- ipmon_enable setting ----------------------------------
628 Setting this variable needs setting
635 for a detailed discussion.
636 .\" ----- ipmon_program setting ---------------------------------
643 .\" ----- ipmon_flags setting -----------------------------------
652 Another typical example would be
653 .Dq Fl D Pa /var/log/ipflog
656 log directly to a file bypassing
659 .Pa /etc/newsyslog.conf
660 in such case like this:
662 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
664 .\" ----- ipfs_enable setting -----------------------------------
674 saving the filter and NAT state tables during shutdown
675 and reloading them during startup again.
676 Setting this variable needs setting
685 for a detailed discussion.
690 cannot be used because the raised securelevel will prevent
692 from saving the state tables at shutdown time.
693 .\" ----- ipfs_program setting ----------------------------------
700 .\" ----- ipfs_flags setting ------------------------------------
707 .\" ----- end of added ipf hook ---------------------------------
708 .It Va tcp_extensions
715 disables certain TCP options as described by
721 might help remedy such problems with connections as randomly hanging
722 or other weird behavior.
723 Some network devices are known to be broken with respect to these options.
730 .Va net.inet.tcp.log_in_vain
732 .Va net.inet.udp.log_in_vain ,
737 are set to the given value.
745 will disable probing idle TCP connections to verify that the
746 peer is still up and reachable.
747 .It Va tcp_drop_synfin
754 will cause the kernel to ignore TCP frames that have both
755 the SYN and FIN flags set.
756 This prevents OS fingerprinting, but may break some legitimate applications.
757 This option is only available if the kernel was built with the
760 .It Va icmp_drop_redirect
767 will cause the kernel to ignore ICMP REDIRECT packets.
770 for more information.
771 .It Va icmp_log_redirect
778 will cause the kernel to log ICMP REDIRECT packets.
780 the log messages are not rate-limited, so this option should only be used
781 for troubleshooting networks.
784 for more information.
785 .It Va icmp_bmcastecho
789 to respond to broadcast or multicast ICMP ping packets.
792 for more information.
793 .It Va ip_portrange_first
797 this is the first port in the default portrange.
800 for more information.
801 .It Va ip_portrange_last
805 this is the last port in the default portrange.
808 for more information.
810 .It Va ifconfig_ Ns Aq Ar interface
814 Typically includes IP address.
815 Assuming that the interface in question was
817 it might look something like this:
819 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
823 .Pa /etc/start_if. Ns Aq Ar interface
824 file is present, it is read and executed by the
826 interpreter before configuring the interface as specified in the
827 .Va ifconfig_ Ns Aq Ar interface
829 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
832 It is possible to bring up an interface with DHCP by adding
835 .Va ifconfig_ Ns Aq Ar interface
837 For instance, to initialize the
839 device via DHCP, it is possible to use something like:
844 Also, if your interface needs WPA authentication, it is possible to add
847 .Va ifconfig_ Ns Aq Ar interface
850 .Xr wpa_supplicant 8 .
852 .Xr wpa_supplicant.conf 5
853 for configuring authentication information.
857 options in this variable, in addition to the
858 .Pa /etc/start_if. Ns Aq Ar interface
860 For instance, to initialize the
862 device via DHCP, using WPA authentication and 802.11b mode, it is
863 possible to use something like:
865 ifconfig_wi0="up DHCP WPA mode 11b"
869 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
871 Configuration to establish an additional network address for
873 Assuming that the interface in question was
875 it might look something like this:
877 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
878 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
883 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
884 entry that is found, its contents are passed to
886 Execution stops at the first unsuccessful access, so if
887 something like this is present:
889 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
890 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
891 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
892 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
895 Then note that alias4 would
897 be added since the search would stop with the missing alias3 entry.
900 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
904 It is possible to rename interface by doing:
906 ifconfig_ed0_name="net0"
907 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
909 .It Va network_interfaces
911 The list of network interfaces to configure on this host,
914 to configure all network interfaces
917 For example, if the only network devices to be configured are the loopback device
921 driver, this could be set to
924 .Va ifconfig_ Ns Aq Ar interface
925 variable is assumed to exist for each value of
927 .It Va ipv6_network_interfaces
929 This is the IPv6 equivalent of
930 .Va network_interfaces .
931 Instead of setting the ifconfig variables as
932 .Va ifconfig_ Ns Aq Ar interface
933 they should be set as
934 .Va ipv6_ifconfig_ Ns Aq Ar interface .
935 Aliases should be set as
936 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
937 Interfaces that do not have a
938 .Va ipv6_ifconfig_ Ns Aq Ar interface
939 setting will be auto configured by
942 .Va ipv6_gateway_enable
945 Note that the IPv6 networking code does not support the
946 .Pa /etc/start_if. Ns Aq Ar interface
948 .It Va ipv6_prefix_ Ns Aq Ar interface
952 prefixlen 64 is used.
953 .It Va ipv6_default_interface
957 this is the default output interface for scoped addresses.
958 Now this works only for IPv6 link local multicast addresses.
959 .It Va cloned_interfaces
961 Set to the list of clonable network interfaces to create on this host.
963 .Va cloned_interfaces
964 are automatically appended to
965 .Va network_interfaces
967 .It Va gif_interfaces
971 tunnel interfaces to configure on this host.
973 .Va gifconfig_ Ns Aq Ar interface
974 variable is assumed to exist for each value of
976 The value of this variable is used to configure the link layer of the
977 tunnel according to the syntax of the
981 Additionally, this option ensures that each listed interface is created via the
985 before attempting to configure it.
986 .It Va sppp_interfaces
990 interfaces to configure on this host.
992 .Va spppconfig_ Ns Aq Ar interface
993 variable is assumed to exist for each value of
995 Each interface should also be configured by a general
996 .Va ifconfig_ Ns Aq Ar interface
1000 for more information about available options.
1010 Mode in which to run the
1019 See the manual for a full description.
1024 enables network address translation.
1025 Used in conjunction with
1027 allows hosts on private network addresses access to the Internet using
1028 this host as a network address translating router.
1031 The name of the profile to use from
1032 .Pa /etc/ppp/ppp.conf .
1035 The name of the user under which
1042 .It Va rc_conf_files
1044 This option is used to specify a list of files that will override
1046 .Pa /etc/defaults/rc.conf .
1047 The files will be read in the order in which they are specified and should
1048 include the full path to the file.
1049 By default, the files specified are
1052 .Pa /etc/rc.conf.local
1053 .It Va fsck_y_enable
1058 will be run with the
1060 flag if the initial preen of the file systems fails.
1063 List of file system types that are network-based.
1064 This list should generally not be modified by end users.
1066 .Va extra_netfs_types
1068 .It Va extra_netfs_types
1070 If set to something other than
1072 (the default), this variable extends the list of file system types
1073 for which automatic mounting at startup by
1075 should be delayed until the network is initialized.
1077 a whitespace-separated list of network file system descriptor pairs,
1078 each consisting of a file system type as passed to
1080 and a human-readable, one-word description, joined with a colon
1082 Extending the default list in this way is only necessary
1083 when third party file system types are used.
1084 .It Va devfs_config_files
1086 This option is used to specify a list of configuration files containing
1088 rules that will be applied by
1090 in the order in which they are specified and must include the full path
1092 .It Va syslogd_enable
1099 .It Va syslogd_program
1104 .Pa /usr/sbin/syslogd ) .
1105 .It Va syslogd_flags
1111 these are the flags to pass to
1120 .It Va inetd_program
1125 .Pa /usr/sbin/inetd ) .
1132 these are the flags to pass to
1140 daemon at boot time.
1147 these are the flags to pass to it.
1154 daemon at boot time.
1161 these are the flags to pass to it.
1164 manpage for more information.
1165 .It Va amd_map_program
1167 If set, the specified program is run to get the list of
1172 maps are stored in NIS, one can set this to run
1184 will be updated at boot time to reflect the kernel release being run.
1188 will not be updated.
1189 .It Va nfs_client_enable
1193 setup NFS client parameters at boot time.
1194 .It Va nfs_access_cache
1197 .Va nfs_client_enable
1202 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1203 NFS ACCESS results should be cached.
1204 A value of 2-10 seconds will substantially reduce network traffic for
1205 many NFS operations.
1206 The default is 5 seconds.
1207 Note that the attribute cache holds stat information only.
1208 The NFS data cache is independent of the attribute cache and is only
1209 invalidated when the client detects that the server has modified the
1211 This value specifies a maximum timeout.
1212 The NFS client will automatically use a shorter timeout for files which
1213 have been recently modified.
1214 .It Va nfs_neg_cache
1217 .Va nfs_client_enable
1222 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1223 filenames), or to the number of seconds for which negative lookups should
1225 A value of 2-10 seconds will substantially reduce network
1226 traffic for many NFS operations, especially source code builds.
1227 The default is 3 seconds.
1228 .It Va nfs_server_enable
1232 run the NFS server daemons at boot time.
1233 .It Va nfs_server_flags
1236 .Va nfs_server_enable
1239 these are the flags to pass to the
1242 .It Va mountd_enable
1247 .Va nfs_server_enable
1253 It is commonly needed to run CFS without real NFS used.
1260 these are the flags to pass to the
1263 .It Va weak_mountd_authentication
1267 allow services like PCNFSD to make non-privileged mount requests.
1268 .It Va nfs_reserved_port_only
1272 provide NFS services only on a secure port.
1273 .It Va nfs_bufpackets
1275 If set to a number, indicates the number of packets worth of
1276 socket buffer space to reserve on an NFS client.
1277 The kernel default is typically 4.
1278 Using a higher number may be useful on gigabit networks to improve performance.
1279 The minimum value is 2 and the maximum is 64.
1280 .It Va rpc_umntall_enable
1284 (default) and we are also an NFS client, run
1286 at boot time to clear out old mounts on remote servers.
1291 will not be run at boot time.
1292 .It Va rpc_lockd_enable
1296 and also an NFS server, run
1299 .It Va rpc_lockd_flags
1302 .Va rpc_lockd_enable
1305 these are the flags to pass to
1307 .It Va rpc_statd_enable
1311 and also an NFS server, run
1314 .It Va rpc_statd_flags
1317 .Va rpc_statd_enable
1320 these are the flags to pass to
1322 .It Va rpcbind_program
1324 Path to program for rpcbind daemon
1326 .Pa /usr/sbin/rpcbind ) .
1327 .It Va rpcbind_enable
1334 .It Va rpcbind_flags
1340 these are the flags to pass to
1341 .Va rpcbind_program .
1342 .It Va keyserv_enable
1348 daemon on boot for running Secure RPC.
1349 .It Va keyserv_flags
1355 these are the flags to pass to
1358 .It Va pppoed_enable
1364 daemon at boot time to provide PPP over Ethernet services.
1365 .It Va pppoed_provider
1368 listens to requests to this provider and ultimately runs
1372 argument of the same name.
1375 Additional flags to pass to
1377 .It Va pppoed_interface
1379 The network interface to run
1382 This is mandatory when
1392 service at boot time.
1393 This command is intended for networks of machines where a consistent
1395 for all hosts must be established.
1396 This is often useful in large NFS environments where time stamps on
1397 files are expected to be consistent network-wide.
1404 these are the flags to pass to the
1413 at system boot time.
1414 .It Va dntpd_program
1419 .Pa /usr/sbin/dntpd ) .
1426 these are the flags to pass to the
1429 .It Va btconfig_enable
1433 configure Bluetooth devices via
1435 at system boot time.
1436 .It Va btconfig_devices
1442 this is the list of Bluetooth devices to configure.
1444 .Va btconfig_devices
1445 is not specified, all devices known to the system will be configured.
1447 .Va btconfig_ Ns Aq Ar device
1448 variable can be set to specify parameters to be passed to
1450 .It Va btconfig_args
1456 this is the list of configuration parameters to pass to all Bluetooth
1462 run the Service Discovery Profile daemon
1464 at system boot time.
1471 these are the flags to pass to the
1474 .It Va bthcid_enable
1478 run the Bluetooth Link Key/PIN Code Manager daemon
1480 at system boot time.
1487 these are the flags to pass to the
1490 .It Va nis_client_enable
1496 service at system boot time.
1497 .It Va nis_client_flags
1500 .Va nis_client_enable
1503 these are the flags to pass to the
1506 .It Va nis_ypset_enable
1512 daemon at system boot time.
1513 .It Va nis_ypset_flags
1516 .Va nis_ypset_enable
1519 these are the flags to pass to the
1522 .It Va nis_server_enable
1528 daemon at system boot time.
1529 .It Va nis_server_flags
1532 .Va nis_server_enable
1535 these are the flags to pass to the
1538 .It Va nis_ypxfrd_enable
1544 daemon at system boot time.
1545 .It Va nis_ypxfrd_flags
1548 .Va nis_ypxfrd_enable
1551 these are the flags to pass to the
1554 .It Va nis_yppasswdd_enable
1560 daemon at system boot time.
1561 .It Va nis_yppasswdd_flags
1564 .Va nis_yppasswdd_enable
1567 these are the flags to pass to the
1570 .It Va rpc_ypupdated_enable
1576 daemon at system boot time.
1577 .It Va defaultrouter
1581 create a default route to this host name or IP address
1582 (use an IP address if this router is also required to get to the
1584 .It Va ipv6_defaultrouter
1586 The IPv6 equivalent of
1588 .It Va static_routes
1590 Set to the list of static routes that are to be added at system boot time.
1593 then for each whitespace separated
1596 .Va route_ Ns Aq Ar element
1597 variable is assumed to exist whose contents will later be passed to a
1600 .It Va ipv6_static_routes
1602 The IPv6 equivalent of
1606 then for each whitespace separated
1609 .Va ipv6_route_ Ns Aq Ar element
1610 variable is assumed to exist whose contents will later be passed to a
1611 .Dq Nm route Cm add Fl inet6
1613 .It Va gateway_enable
1617 configure host to act as an IP router, e.g. to forward packets
1619 .It Va ipv6_gateway_enable
1621 The IPv6 equivalent of
1622 .Va gateway_enable .
1623 .It Va router_enable
1627 run a routing daemon of some sort, based on the settings of
1631 .It Va ipv6_router_enable
1633 The IPv6 equivalent of
1637 run a routing daemon of some sort, based on the settings of
1638 .Va ipv6_router_program
1640 .Va ipv6_router_flags .
1641 .It Va router_program
1647 this is the name of the routing daemon to use
1649 .Pa /sbin/routed ) .
1650 .It Va ipv6_router_program
1652 The IPv6 equivalent of
1655 .Pa /sbin/route6d ) .
1662 these are the flags to pass to the routing daemon.
1663 .It Va ipv6_router_flags
1665 The IPv6 equivalent of
1667 .It Va mrouted_enable
1671 run the multicast routing daemon,
1673 .It Va mroute6d_enable
1675 The IPv6 equivalent of
1676 .Va mrouted_enable .
1679 run the IPv6 multicast routing daemon.
1680 Note that no IPv6 multicast routing daemon is included in the
1684 can be installed from the
1687 .It Va mrouted_flags
1693 these are the flags to pass to the
1696 .It Va mroute6d_flags
1698 The IPv6 equivalent of
1704 these are the flags passed to the IPv6 multicast routing daemon.
1705 .It Va mroute6d_program
1711 this is the path to the IPv6 multicast routing daemon.
1712 .It Va rtadvd_enable
1718 daemon at boot time.
1721 .Va ipv6_gateway_enable
1726 utility sends router advertisement packets to the interfaces specified in
1727 .Va rtadvd_interfaces .
1729 and should only be enabled with great care.
1730 You may want to fine-tune
1732 .It Va rtadvd_interfaces
1738 this is the list of interfaces to use.
1739 .It Va rtsold_enable
1745 daemon at boot time.
1748 daemon is used for automatic discovery of non-link local addresses.
1755 these are the flags to pass to the
1758 .It Va ipxgateway_enable
1762 enable the routing of IPX traffic.
1763 .It Va ipxrouted_enable
1769 daemon at system boot time.
1770 .It Va ipxrouted_flags
1773 .Va ipxrouted_enable
1776 these are the flags to pass to the
1783 enable global proxy ARP.
1784 .It Va forward_sourceroute
1792 source-routed packets are forwarded.
1793 .It Va accept_sourceroute
1797 the system will accept source-routed packets directed at it.
1804 daemon at system boot time.
1811 these are the flags to pass to the
1814 .It Va bootparamd_enable
1820 daemon at system boot time.
1821 .It Va bootparamd_flags
1824 .Va bootparamd_enable
1827 these are the flags to pass to the
1830 .It Va stf_interface_ipv4addr
1834 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1835 Specify this entry to enable the 6to4 interface.
1836 .It Va stf_interface_ipv4plen
1838 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1839 An effective value is 0-31.
1840 .It Va stf_interface_ipv6_ifid
1842 IPv6 interface ID for
1846 .It Va stf_interface_ipv6_slaid
1848 IPv6 Site Level Aggregator for
1850 .It Va ipv6_faith_prefix
1854 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1858 .It Va ipv6_ipv4mapping
1862 this enables IPv4 mapped IPv6 address communication (like
1863 .Li ::ffff:a.b.c.d ) .
1868 to enable the configuration of ATM interfaces at system boot time.
1869 For all of the ATM variables described below, please refer to the
1871 man page for further details on the available command parameters.
1872 Also refer to the files in
1873 .Pa /usr/share/examples/atm
1874 for more detailed configuration information.
1875 .It Va atm_netif_ Ns Aq Ar intf
1877 For the ATM physical interface
1879 this variable defines the name prefix and count for the ATM network
1880 interfaces to be created.
1881 The value will be passed as the parameters of an
1882 .Dq Nm atm Cm "set netif" Ar intf
1884 .It Va atm_sigmgr_ Ns Aq Ar intf
1886 For the ATM physical interface
1888 this variable defines the ATM signalling manager to be used.
1889 The value will be passed as the parameters of an
1890 .Dq Nm atm Cm attach Ar intf
1892 .It Va atm_prefix_ Ns Aq Ar intf
1894 For the ATM physical interface
1896 this variable defines the NSAP prefix for interfaces using a UNI signalling
1900 the prefix will automatically be set via the
1903 Otherwise, the value will be passed as the parameters of an
1904 .Dq Nm atm Cm "set prefix" Ar intf
1906 .It Va atm_macaddr_ Ns Aq Ar intf
1908 For the ATM physical interface
1910 this variable defines the MAC address for interfaces using a UNI signalling
1914 the hardware MAC address contained in the ATM interface card will be used.
1915 Otherwise, the value will be passed as the parameters of an
1916 .Dq Nm atm Cm "set mac" Ar intf
1918 .It Va atm_arpserver_ Ns Aq Ar netif
1920 For the ATM network interface
1922 this variable defines the ATM address for a host which is to provide ATMARP
1924 This variable is only applicable to interfaces using a UNI signalling manager.
1927 this host will become an ATMARP server.
1928 The value will be passed as the parameters of an
1929 .Dq Nm atm Cm "set arpserver" Ar netif
1931 .It Va atm_scsparp_ Ns Aq Ar netif
1935 SCSP/ATMARP service for the network interface
1937 will be initiated using the
1942 This variable is only applicable if
1943 .Va atm_arpserver_ Ns Aq Ar netif
1948 Set to the list of permanent ATM ARP entries to be added at system boot time.
1949 For each whitespace separated
1952 .Va atm_arp_ Ns Aq Ar element
1953 variable is assumed to exist.
1954 The value of each of these variables will be passed as the parameters of an
1955 .Dq Nm atm Cm "add arp"
1959 The keyboard bell sound.
1966 if the default behavior is desired.
1967 For details, refer to the
1974 no keymap is installed, otherwise the value is used to install
1976 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1979 The keyboard repeat speed.
1986 if the default behavior is desired.
1991 attempt to program the function keys with the value.
1992 The value should be a single string of the form:
1993 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1996 Can be set to the value of
1999 .Dq Li destructive ,
2002 to set the cursor behavior explicitly or choose the default behavior.
2007 no screen map is installed, otherwise the value is used to install
2008 the screen map file in
2009 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2014 the default 8x16 font value is used for screen size requests, otherwise
2016 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2022 the default 8x14 font value is used for screen size requests, otherwise
2024 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2030 the default 8x8 font value is used for screen size requests, otherwise
2032 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2038 the default screen blanking interval is used, otherwise it is set to
2045 this is the actual screen saver to use
2046 .Li ( blank , snake , daemon ,
2048 .It Va moused_enable
2054 daemon is started for doing cut/paste selection on the console.
2057 This is the protocol type of the mouse connected to this host.
2058 This variable must be set if
2065 is able to detect the appropriate mouse type automatically in many cases.
2066 Set this variable to
2068 to let the daemon detect it, or
2069 select one from the following list if the automatic detection fails.
2071 If the mouse is attached to the PS/2 mouse port, choose
2075 regardless of the brand and model of the mouse.
2076 Likewise, if the mouse is attached to the bus mouse port, choose
2080 All other protocols are for serial mice and will not work with
2081 the PS/2 and bus mice.
2082 If this is a USB mouse,
2084 is the only protocol type which will work.
2086 .Bl -tag -width ".Li x10mouseremote" -compact
2088 Microsoft mouse (serial)
2090 Microsoft IntelliMouse (serial)
2092 Mouse systems Corp. mouse (serial)
2094 MM Series mouse (serial)
2096 Logitech mouse (serial)
2100 Logitech MouseMan and TrackMan (serial)
2102 ALPS GlidePoint (serial)
2103 .It Li thinkingmouse
2104 Kensington ThinkingMouse (serial)
2108 MM HitTablet (serial)
2109 .It Li x10mouseremote
2110 X10 MouseRemote (serial)
2112 Interlink VersaPad (serial)
2115 Even if the mouse is not in the above list, it may be compatible
2116 with one in the list.
2117 Refer to the man page for
2119 for compatibility information.
2121 It should also be noted that while this is enabled, any
2122 other client of the mouse (such as an X server) should access
2123 the mouse through the virtual mouse device,
2125 and configure it as a
2127 type mouse, since all
2128 mouse data is converted to this single canonical format when using
2130 If the client program does not support the
2135 It is the second preferred type.
2142 this is the actual port the mouse is on.
2145 for a COM1 serial mouse,
2149 for a bus mouse, for example.
2154 is set, these are the additional flags to pass to the
2157 .It Va mousechar_start
2161 the default mouse cursor character range
2162 .Li 0xd0 Ns - Ns Li 0xd3
2163 is used, otherwise the range start is set to
2167 Use if the default range is occupied in the language code table.
2170 Set the size of the history (scrollback) buffer in lines.
2171 .It Va allscreens_flags
2175 is run with these options for each of the virtual terminals
2179 will enable the mouse pointer on all virtual terminals if
2183 .It Va allscreens_kbdflags
2187 is run with these options for each of the virtual terminals
2193 scrollback (history) buffer to 200 lines.
2200 daemon at system boot time.
2206 .Pa /usr/sbin/cron ) .
2213 these are the flags to pass to
2220 .Pa /usr/sbin/lpd ) .
2227 daemon at system boot time.
2234 these are the flags to pass to the
2243 daemon at system boot time.
2250 settings across reboots.
2251 .It Va mta_start_script
2253 The full path to the script to run to start
2254 a mail transfer agent.
2256 .Pa /etc/rc.sendmail .
2260 .Pa /etc/rc.sendmail
2261 uses are documented in the
2267 .Sq HAMMER ROOT with UFS /boot
2268 setup, the boot loader will not set up the
2271 The system will attempt to fix this on its own.
2272 Set this variable to
2274 to turn this behavior off.
2277 Indicates the device (usually a swap partition) to which a crash dump
2278 should be written in the event of a system crash.
2279 The value of this variable is passed as the argument to
2283 To disable crash dumps, set this variable to
2287 When the system reboots after a crash and a crash dump is found on the
2288 device specified by the
2292 will save that crash dump and a copy of the kernel to the directory
2296 The default value is
2305 .It Va savecore_flags
2307 If crash dumps are enabled, these are the flags to pass to the
2310 .It Va enable_quotas
2314 to turn on user disk quotas on system startup via the
2321 to enable user disk quota checking via the
2324 .It Va accounting_enable
2328 to enable system accounting through the
2335 to enable Linux/ELF binary emulation at system initial boot time.
2336 .It Va sysvipc_enable
2340 load System V IPC primitives at boot time.
2341 .\" ----- cleanvar_enable setting--------------------------------
2342 .It Va cleanvar_enable
2350 .Pa /var/spool/uucp/.Temp/*
2352 .\" ----- clear_tmp_enable setting-------------------------------
2353 .It Va clear_tmp_enable
2360 .\" ----- ldconfig_paths setting --------------------------------
2361 .It Va ldconfig_paths
2363 Set to the list of shared library paths to use with
2367 will always be added first, so it need not appear in this list.
2368 .It Va ldconfig_insecure
2372 utility normally refuses to use directories
2373 which are writable by anyone except root.
2374 Set this variable to
2376 to disable that security check during system startup.
2377 .It Va kern_securelevel
2379 The kernel security level to set at startup.
2380 The allowed range of
2382 ranges from \-1 (the compile time default) to 3 (the most secure).
2385 for the list of possible security levels and their effect on system operation.
2392 at system boot time.
2399 at system boot time.
2402 Path to the SSH server program
2404 .Pa /usr/sbin/sshd ) .
2411 these are the flags to pass to the
2420 at system boot time.
2427 these are the flags to pass to the
2436 daemon at boot time.
2443 these are the flags passed to
2446 .It Va watchdogd_enable
2452 daemon at boot time.
2453 This requires that the kernel have been compiled with
2454 .Cd "options WATCHDOG" .
2459 any configured jails will not be started.
2462 A space separated list of names for jails.
2463 This is purely a configuration aid to help identify and
2464 configure multiple jails.
2465 The names specified in this list will be used to
2466 identify settings common to an instance of a jail.
2467 Assuming that the jail in question was named
2469 you would have the following dependent variables:
2471 jail_vjail_hostname="jail.example.com"
2472 jail_vjail_ip="192.168.1.100"
2473 jail_vjail_rootdir="/var/jails/vjail/root"
2479 When set, use as default value for
2480 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2483 .It Va jail_interface
2486 When set, use as default value for
2487 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2493 When set, use as default value for
2494 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2497 .It Va jail_mount_enable
2505 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2508 by default for every jail in
2510 .It Va jail_fdesc_enable
2518 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2521 by default for every jail in
2523 .It Va jail_procfs_enable
2531 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2534 by default for every jail in
2536 .It Va jail_exec_start
2539 When set, use as default value for
2540 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2543 .It Va jail_exec_stop
2545 When set, use as default value for
2546 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2549 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2552 Set to the root directory used by jail
2554 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2557 Set to the fully qualified domain name (FQDN) assigned to jail
2559 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2562 Set to the IP address assigned to jail
2564 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2569 These are flags to pass to
2571 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2574 When set, sets the interface to use when setting IP address alias.
2575 Note that the alias is created at jail startup and removed at jail shutdown.
2576 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2579 .Pa /etc/fstab. Ns Aq Ar jname
2581 This is the file system information file to use for jail
2583 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2590 mount all file systems from
2591 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2593 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2600 mount the file-descriptor file system inside jail
2603 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2610 mount the process file system inside jail
2613 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2616 .Dq Li /bin/sh /etc/rc
2618 This is the command executed at jail startup.
2619 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2622 .Dq Li /bin/sh /etc/rc.shutdown
2624 This is the command executed at jail shutdown.
2625 .It Va jail_set_hostname_allow
2629 do not allow the root user in a jail to set its hostname.
2630 .It Va jail_socket_unixiproute_only
2634 do not allow any sockets,
2635 besides UNIX/IP/route sockets,
2636 to be used within a jail.
2637 .It Va jail_sysvipc_allow
2641 allow applications within a jail to use System V IPC.
2642 .It Va newsyslog_enable
2648 before syslogd starts.
2649 .It Va newsyslog_flags
2652 .Va newsyslog_enable
2655 these are the flags passed to
2657 .It Va resident_enable
2661 make the dynamic binaries listed in
2662 .Pa /etc/resident.conf
2664 .It Va varsym_enable
2669 .Pa /etc/varsym.conf
2670 to set system-wide variables for variant symlinks.
2675 or a whitespace separated list of IRQ numbers which will be used as a source of
2677 .\" ----- isdn settings ---------------------------------
2687 daemon at system boot time.
2691 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2693 Additional flags to pass to
2699 for certain tunable parameters).
2705 The terminal type of the output device when
2707 operates in full-screen mode.
2708 .It Va isdn_screenflags
2713 The video mode for full-screen mode (only for
2723 The output device for
2725 in full-screen mode (or
2735 enables the ISDN protocol trace utility
2737 at system boot time.
2738 .It Va isdn_traceflags
2741 .Dq Fl f Pa /var/tmp/isdntrace0
2745 .\" -----------------------------------------------------
2750 to disable caching entropy via
2752 Otherwise set to the directory used to store entropy files in.
2757 to disable caching entropy through reboots.
2758 Otherwise set to the filename used to store cached entropy through reboots.
2759 This file should be located on the root file system to seed the
2761 device as early as possible in the boot process.
2773 Configuration file for
2782 .Pa /var/run/dmesg.boot
2784 .It Va rcshutdown_timeout
2786 If set, start a watchdog timer in the background which will terminate
2790 has not completed within the specified time (in seconds).
2791 .It Va vkernel_enable
2795 any configured vkernels will not be started.
2798 A space separated list of names for vkernels.
2799 This is purely a configuration aid to help identify and
2800 configure multiple vkernels.
2801 The names specified in this list will be used to
2802 identify settings common to a vkernel instance.
2803 Assuming that the vkernel in question was named
2805 you would have the following dependent variables
2806 (filled with reference values in this text):
2808 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2809 vkernel_example_memsize="64m"
2810 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2811 vkernel_example_iface_list="auto:bridge0"
2812 vkernel_example_logfile="/dev/null"
2813 vkernel_example_flags="-U"
2816 The last three are optional.
2817 They default to an empty string if not set, except for logfile which defaults to
2822 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2823 .It Pa /etc/defaults/rc.conf
2825 .It Pa /etc/rc.conf.local
2826 .It Pa /etc/start_if. Ns Aq Ar interface
2844 .Xr resident.conf 5 ,
2907 .An Jordan K. Hubbard .