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
175 a CPU speed control daemon.
176 .It Va sensorsd_enable
185 a sensors monitoring and logging daemon.
186 .It Va sensorsd_flags
189 Additional flags passed to the
192 .It Va hotplugd_enable
201 a devices hot plugging monitoring daemon.
202 .It Va hotplugd_flags
205 Additional flags passed to the
208 .It Va pccard_ifconfig
210 List of arguments to be passed to
212 at boot time or on insertion of the card (e.g.\&
213 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
214 for a fixed address or
217 .It Va pccard_ether_delay
219 Set the delay before starting
222 .Pa /etc/pccard_ether
224 This defaults to 5 seconds to work around a bug in the
226 driver which can lead to system hangs when using some newer
229 .It Va removable_interfaces
231 List of removable network interfaces to be supported by
232 .Pa /etc/pccard_ether .
235 List of directories to search for startup script files.
236 .It Va script_name_sep
238 The field separator to use for breaking down the list of startup script files
239 into individual filenames.
240 The default is a space.
241 It is not necessary to change this unless there are startup scripts with names
243 .It Va hostapd_enable
252 The fully qualified domain name (FQDN) of this host on the network.
253 This should almost certainly be set to something meaningful, even if
254 there is no network connection.
257 is used to set the hostname via DHCP,
258 this variable should be set to an empty string.
261 Enable support for IPv6 networking.
262 Note that this requires that the kernel have been compiled with
263 .Cd "options INET6" .
266 The NIS domain name of this host, or
269 .It Va dhclient_program
271 Path to the DHCP client program
273 .Pa /sbin/dhclient ) .
274 .It Va dhclient_flags
276 Additional flags to pass to the DHCP client program.
284 If the kernel was not built with
288 kernel module will be loaded.
290 .Va firewall_enable .
295 ruleset definition file.
306 these are the flags to pass to
308 when loading the ruleset.
315 which logs packets from
323 this specifies the path of the log file.
334 these are the flags to pass to
336 .It Va firewall_enable
340 to load firewall rules at startup.
341 If the kernel was not built with
342 .Cd "options IPFIREWALL" ,
345 kernel module will be loaded.
348 .It Va ipv6_firewall_enable
350 The IPv6 equivalent of
351 .Va firewall_enable .
354 to load IPv6 firewall rules at startup.
355 If the kernel was not built with
356 .Cd "options IPV6FIREWALL" ,
359 kernel module will be loaded.
360 .It Va firewall_script
362 The full path to the firewall script to run
364 .Pa /etc/rc.firewall ) .
365 .It Va ipv6_firewall_script
367 The IPv6 equivalent of
368 .Va firewall_script .
371 Names the firewall type from the selection in
372 .Pa /etc/rc.firewall ,
373 or the file which contains the local firewall ruleset.
374 Valid selections from
378 .Bl -tag -width ".Li simple" -compact
380 unrestricted IP access
382 all IP services disabled, except via
385 basic protection for a workstation on a LAN
391 If a filename is specified, the full path must be given.
392 .It Va firewall_trusted_nets
394 List of trusted networks (if
398 .It Va firewall_trusted_interfaces
400 List of trusted network interfaces (if
404 .It Va firewall_allowed_icmp_types
406 List of allowed ICMP types (if
410 .It Va firewall_open_tcp_ports
412 List of TCP ports to open (if
416 .It Va firewall_open_udp_ports
418 List of UDP ports to open (if
422 .It Va ipv6_firewall_type
424 The IPv6 equivalent of
426 .It Va firewall_quiet
430 to disable the display of firewall rules on the console during boot.
431 .It Va ipv6_firewall_quiet
433 The IPv6 equivalent of
435 .It Va firewall_logging
439 to enable firewall event logging.
440 This is equivalent to the
441 .Dv IPFIREWALL_VERBOSE
443 .It Va ipv6_firewall_logging
445 The IPv6 equivalent of
446 .Va firewall_logging .
447 .It Va firewall_flags
453 specifies a filename.
454 .It Va ipv6_firewall_flags
456 The IPv6 equivalent of
473 sockets must be enabled in the kernel.
474 .It Va natd_interface
476 This is the name of the public interface on which
479 The interface may be given as an interface name or as an IP address.
484 flags should be placed here.
489 flag is automatically added with the above
492 .It Va tcp_extensions
499 disables certain TCP options as described by
505 might help remedy such problems with connections as randomly hanging
506 or other weird behavior.
507 Some network devices are known to be broken with respect to these options.
514 .Va net.inet.tcp.log_in_vain
516 .Va net.inet.udp.log_in_vain ,
521 are set to the given value.
529 will disable probing idle TCP connections to verify that the
530 peer is still up and reachable.
531 .It Va tcp_drop_synfin
538 will cause the kernel to ignore TCP frames that have both
539 the SYN and FIN flags set.
540 This prevents OS fingerprinting, but may break some legitimate applications.
541 This option is only available if the kernel was built with the
544 .It Va icmp_drop_redirect
551 will cause the kernel to ignore ICMP REDIRECT packets.
554 for more information.
555 .It Va icmp_log_redirect
562 will cause the kernel to log ICMP REDIRECT packets.
564 the log messages are not rate-limited, so this option should only be used
565 for troubleshooting networks.
568 for more information.
569 .It Va icmp_bmcastecho
573 to respond to broadcast or multicast ICMP ping packets.
576 for more information.
577 .It Va ip_portrange_first
581 this is the first port in the default portrange.
584 for more information.
585 .It Va ip_portrange_last
589 this is the last port in the default portrange.
592 for more information.
594 .It Va ifconfig_ Ns Aq Ar interface
598 Typically includes IP address.
599 Assuming that the interface in question was
601 it might look something like this:
603 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
607 .Pa /etc/start_if. Ns Aq Ar interface
608 file is present, it is read and executed by the
610 interpreter before configuring the interface as specified in the
611 .Va ifconfig_ Ns Aq Ar interface
613 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
616 It is possible to bring up an interface with DHCP by adding
619 .Va ifconfig_ Ns Aq Ar interface
621 For instance, to initialize the
623 device via DHCP, it is possible to use something like:
629 .Va wlans_ Ns Aq Ar interface
633 interface will be created for each item in the list with the
637 Further wlan cloning arguments may be passed to the
640 command by setting the
641 .Va create_args_ Ns Aq Ar interface
645 devices must be created for each wireless devices as of
651 may be specified with an
652 .Va wlandebug_ Ns Aq Ar interface
654 The contents of this variable will be passed directly to
657 Also, if your interface needs WPA authentication, it is possible to add
660 .Va ifconfig_ Ns Aq Ar interface
663 .Xr wpa_supplicant 8 .
665 .Xr wpa_supplicant.conf 5
666 for configuring authentication information.
670 options in this variable, in addition to the
671 .Pa /etc/start_if. Ns Aq Ar interface
673 For instance, to initialize the
675 device via DHCP, using WPA authentication and 802.11b mode, it is
676 possible to use something like:
678 ifconfig_wi0="up DHCP WPA mode 11b"
682 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
684 Configuration to establish an additional network address for
686 Assuming that the interface in question was
688 it might look something like this:
690 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
691 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
696 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
697 entry that is found, its contents are passed to
699 Execution stops at the first unsuccessful access, so if
700 something like this is present:
702 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
703 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
704 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
705 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
708 Then note that alias4 would
710 be added since the search would stop with the missing alias3 entry.
713 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
717 It is possible to rename interface by doing:
719 ifconfig_ed0_name="net0"
720 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
722 .It Va network_interfaces
724 The list of network interfaces to configure on this host,
727 to configure all network interfaces
730 For example, if the only network devices to be configured are the loopback device
734 driver, this could be set to
737 .Va ifconfig_ Ns Aq Ar interface
738 variable is assumed to exist for each value of
740 .It Va ipv6_network_interfaces
742 This is the IPv6 equivalent of
743 .Va network_interfaces .
744 Instead of setting the ifconfig variables as
745 .Va ifconfig_ Ns Aq Ar interface
746 they should be set as
747 .Va ipv6_ifconfig_ Ns Aq Ar interface .
748 Aliases should be set as
749 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
750 Interfaces that do not have a
751 .Va ipv6_ifconfig_ Ns Aq Ar interface
752 setting will be auto configured by
755 .Va ipv6_gateway_enable
758 Note that the IPv6 networking code does not support the
759 .Pa /etc/start_if. Ns Aq Ar interface
761 .It Va ipv6_prefix_ Ns Aq Ar interface
765 prefixlen 64 is used.
766 .It Va ipv6_default_interface
770 this is the default output interface for scoped addresses.
771 Now this works only for IPv6 link local multicast addresses.
772 .It Va cloned_interfaces
774 Set to the list of clonable network interfaces to create on this host.
776 .Va cloned_interfaces
777 are automatically appended to
778 .Va network_interfaces
780 .It Va gif_interfaces
784 tunnel interfaces to configure on this host.
786 .Va gifconfig_ Ns Aq Ar interface
787 variable is assumed to exist for each value of
789 The value of this variable is used to configure the link layer of the
790 tunnel according to the syntax of the
794 Additionally, this option ensures that each listed interface is created via the
798 before attempting to configure it.
799 .It Va sppp_interfaces
803 interfaces to configure on this host.
805 .Va spppconfig_ Ns Aq Ar interface
806 variable is assumed to exist for each value of
808 Each interface should also be configured by a general
809 .Va ifconfig_ Ns Aq Ar interface
813 for more information about available options.
823 Mode in which to run the
832 See the manual for a full description.
837 enables network address translation.
838 Used in conjunction with
840 allows hosts on private network addresses access to the Internet using
841 this host as a network address translating router.
844 The name of the profile to use from
845 .Pa /etc/ppp/ppp.conf .
848 The name of the user under which
857 This option is used to specify a list of files that will override
859 .Pa /etc/defaults/rc.conf .
860 The files will be read in the order in which they are specified and should
861 include the full path to the file.
862 By default, the files specified are
865 .Pa /etc/rc.conf.local
873 flag if the initial preen of the file systems fails.
876 List of file system types that are network-based.
877 This list should generally not be modified by end users.
879 .Va extra_netfs_types
881 .It Va extra_netfs_types
883 If set to something other than
885 (the default), this variable extends the list of file system types
886 for which automatic mounting at startup by
888 should be delayed until the network is initialized.
890 a whitespace-separated list of network file system descriptor pairs,
891 each consisting of a file system type as passed to
893 and a human-readable, one-word description, joined with a colon
895 Extending the default list in this way is only necessary
896 when third party file system types are used.
897 .It Va devfs_config_files
899 This option is used to specify a list of configuration files containing
901 rules that will be applied by
903 in the order in which they are specified and must include the full path
905 .It Va syslogd_enable
912 .It Va syslogd_program
917 .Pa /usr/sbin/syslogd ) .
924 these are the flags to pass to
938 .Pa /usr/sbin/inetd ) .
945 these are the flags to pass to
960 these are the flags to pass to it.
974 these are the flags to pass to it.
977 manpage for more information.
978 .It Va amd_map_program
980 If set, the specified program is run to get the list of
985 maps are stored in NIS, one can set this to run
997 will be updated at boot time to reflect the kernel release being run.
1001 will not be updated.
1002 .It Va nfs_client_enable
1006 setup NFS client parameters at boot time.
1007 .It Va nfs_access_cache
1010 .Va nfs_client_enable
1015 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1016 NFS ACCESS results should be cached.
1017 A value of 2-10 seconds will substantially reduce network traffic for
1018 many NFS operations.
1019 The default is 5 seconds.
1020 Note that the attribute cache holds stat information only.
1021 The NFS data cache is independent of the attribute cache and is only
1022 invalidated when the client detects that the server has modified the
1024 This value specifies a maximum timeout.
1025 The NFS client will automatically use a shorter timeout for files which
1026 have been recently modified.
1027 .It Va nfs_neg_cache
1030 .Va nfs_client_enable
1035 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1036 filenames), or to the number of seconds for which negative lookups should
1038 A value of 2-10 seconds will substantially reduce network
1039 traffic for many NFS operations, especially source code builds.
1040 The default is 3 seconds.
1041 .It Va nfs_server_enable
1045 run the NFS server daemons at boot time.
1046 .It Va nfs_server_flags
1049 .Va nfs_server_enable
1052 these are the flags to pass to the
1055 .It Va mountd_enable
1060 .Va nfs_server_enable
1066 It is commonly needed to run CFS without real NFS used.
1073 these are the flags to pass to the
1076 .It Va weak_mountd_authentication
1080 allow services like PCNFSD to make non-privileged mount requests.
1081 .It Va nfs_reserved_port_only
1085 provide NFS services only on a secure port.
1086 .It Va nfs_bufpackets
1088 If set to a number, indicates the number of packets worth of
1089 socket buffer space to reserve on an NFS client.
1090 The kernel default is typically 4.
1091 Using a higher number may be useful on gigabit networks to improve performance.
1092 The minimum value is 2 and the maximum is 64.
1093 .It Va rpc_umntall_enable
1097 (default) and we are also an NFS client, run
1099 at boot time to clear out old mounts on remote servers.
1104 will not be run at boot time.
1105 .It Va rpc_lockd_enable
1109 and also an NFS server, run
1112 .It Va rpc_lockd_flags
1115 .Va rpc_lockd_enable
1118 these are the flags to pass to
1120 .It Va rpc_statd_enable
1124 and also an NFS server, run
1127 .It Va rpc_statd_flags
1130 .Va rpc_statd_enable
1133 these are the flags to pass to
1135 .It Va rpcbind_program
1137 Path to program for rpcbind daemon
1139 .Pa /usr/sbin/rpcbind ) .
1140 .It Va rpcbind_enable
1147 .It Va rpcbind_flags
1153 these are the flags to pass to
1154 .Va rpcbind_program .
1155 .It Va keyserv_enable
1161 daemon on boot for running Secure RPC.
1162 .It Va keyserv_flags
1168 these are the flags to pass to
1171 .It Va pppoed_enable
1177 daemon at boot time to provide PPP over Ethernet services.
1178 .It Va pppoed_provider
1181 listens to requests to this provider and ultimately runs
1185 argument of the same name.
1188 Additional flags to pass to
1190 .It Va pppoed_interface
1192 The network interface to run
1195 This is mandatory when
1205 service at boot time.
1206 This command is intended for networks of machines where a consistent
1208 for all hosts must be established.
1209 This is often useful in large NFS environments where time stamps on
1210 files are expected to be consistent network-wide.
1217 these are the flags to pass to the
1226 at system boot time.
1227 .It Va dntpd_program
1232 .Pa /usr/sbin/dntpd ) .
1239 these are the flags to pass to the
1242 .It Va btconfig_enable
1246 configure Bluetooth devices via
1248 at system boot time.
1249 .It Va btconfig_devices
1255 this is the list of Bluetooth devices to configure.
1257 .Va btconfig_devices
1258 is not specified, all devices known to the system will be configured.
1260 .Va btconfig_ Ns Aq Ar device
1261 variable can be set to specify parameters to be passed to
1263 .It Va btconfig_args
1269 this is the list of configuration parameters to pass to all Bluetooth
1275 run the Service Discovery Profile daemon
1277 at system boot time.
1284 these are the flags to pass to the
1287 .It Va bthcid_enable
1291 run the Bluetooth Link Key/PIN Code Manager daemon
1293 at system boot time.
1300 these are the flags to pass to the
1303 .It Va nis_client_enable
1309 service at system boot time.
1310 .It Va nis_client_flags
1313 .Va nis_client_enable
1316 these are the flags to pass to the
1319 .It Va nis_ypset_enable
1325 daemon at system boot time.
1326 .It Va nis_ypset_flags
1329 .Va nis_ypset_enable
1332 these are the flags to pass to the
1335 .It Va nis_server_enable
1341 daemon at system boot time.
1342 .It Va nis_server_flags
1345 .Va nis_server_enable
1348 these are the flags to pass to the
1351 .It Va nis_ypxfrd_enable
1357 daemon at system boot time.
1358 .It Va nis_ypxfrd_flags
1361 .Va nis_ypxfrd_enable
1364 these are the flags to pass to the
1367 .It Va nis_yppasswdd_enable
1373 daemon at system boot time.
1374 .It Va nis_yppasswdd_flags
1377 .Va nis_yppasswdd_enable
1380 these are the flags to pass to the
1383 .It Va rpc_ypupdated_enable
1389 daemon at system boot time.
1390 .It Va defaultrouter
1394 create a default route to this host name or IP address
1395 (use an IP address if this router is also required to get to the
1397 .It Va ipv6_defaultrouter
1399 The IPv6 equivalent of
1401 .It Va static_routes
1403 Set to the list of static routes that are to be added at system boot time.
1406 then for each whitespace separated
1409 .Va route_ Ns Aq Ar element
1410 variable is assumed to exist whose contents will later be passed to a
1413 .It Va ipv6_static_routes
1415 The IPv6 equivalent of
1419 then for each whitespace separated
1422 .Va ipv6_route_ Ns Aq Ar element
1423 variable is assumed to exist whose contents will later be passed to a
1424 .Dq Nm route Cm add Fl inet6
1426 .It Va gateway_enable
1430 configure host to act as an IP router, e.g. to forward packets
1432 .It Va ipv6_gateway_enable
1434 The IPv6 equivalent of
1435 .Va gateway_enable .
1436 .It Va router_enable
1440 run a routing daemon of some sort, based on the settings of
1444 .It Va ipv6_router_enable
1446 The IPv6 equivalent of
1450 run a routing daemon of some sort, based on the settings of
1451 .Va ipv6_router_program
1453 .Va ipv6_router_flags .
1454 .It Va router_program
1460 this is the name of the routing daemon to use
1462 .Pa /sbin/routed ) .
1463 .It Va ipv6_router_program
1465 The IPv6 equivalent of
1468 .Pa /sbin/route6d ) .
1475 these are the flags to pass to the routing daemon.
1476 .It Va ipv6_router_flags
1478 The IPv6 equivalent of
1480 .It Va mrouted_enable
1484 run the multicast routing daemon,
1486 .It Va mroute6d_enable
1488 The IPv6 equivalent of
1489 .Va mrouted_enable .
1492 run the IPv6 multicast routing daemon.
1493 Note that no IPv6 multicast routing daemon is included in the
1497 can be installed from the
1500 .It Va mrouted_flags
1506 these are the flags to pass to the
1509 .It Va mroute6d_flags
1511 The IPv6 equivalent of
1517 these are the flags passed to the IPv6 multicast routing daemon.
1518 .It Va mroute6d_program
1524 this is the path to the IPv6 multicast routing daemon.
1525 .It Va rtadvd_enable
1531 daemon at boot time.
1534 .Va ipv6_gateway_enable
1539 utility sends router advertisement packets to the interfaces specified in
1540 .Va rtadvd_interfaces .
1542 and should only be enabled with great care.
1543 You may want to fine-tune
1545 .It Va rtadvd_interfaces
1551 this is the list of interfaces to use.
1552 .It Va rtsold_enable
1558 daemon at boot time.
1561 daemon is used for automatic discovery of non-link local addresses.
1568 these are the flags to pass to the
1571 .It Va ipxgateway_enable
1575 enable the routing of IPX traffic.
1576 .It Va ipxrouted_enable
1582 daemon at system boot time.
1583 .It Va ipxrouted_flags
1586 .Va ipxrouted_enable
1589 these are the flags to pass to the
1596 enable global proxy ARP.
1597 .It Va forward_sourceroute
1605 source-routed packets are forwarded.
1606 .It Va accept_sourceroute
1610 the system will accept source-routed packets directed at it.
1617 daemon at system boot time.
1624 these are the flags to pass to the
1627 .It Va bootparamd_enable
1633 daemon at system boot time.
1634 .It Va bootparamd_flags
1637 .Va bootparamd_enable
1640 these are the flags to pass to the
1643 .It Va stf_interface_ipv4addr
1647 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1648 Specify this entry to enable the 6to4 interface.
1649 .It Va stf_interface_ipv4plen
1651 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1652 An effective value is 0-31.
1653 .It Va stf_interface_ipv6_ifid
1655 IPv6 interface ID for
1659 .It Va stf_interface_ipv6_slaid
1661 IPv6 Site Level Aggregator for
1663 .It Va ipv6_faith_prefix
1667 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1671 .It Va ipv6_ipv4mapping
1675 this enables IPv4 mapped IPv6 address communication (like
1676 .Li ::ffff:a.b.c.d ) .
1681 to enable the configuration of ATM interfaces at system boot time.
1682 For all of the ATM variables described below, please refer to the
1684 man page for further details on the available command parameters.
1685 Also refer to the files in
1686 .Pa /usr/share/examples/atm
1687 for more detailed configuration information.
1688 .It Va atm_netif_ Ns Aq Ar intf
1690 For the ATM physical interface
1692 this variable defines the name prefix and count for the ATM network
1693 interfaces to be created.
1694 The value will be passed as the parameters of an
1695 .Dq Nm atm Cm "set netif" Ar intf
1697 .It Va atm_sigmgr_ Ns Aq Ar intf
1699 For the ATM physical interface
1701 this variable defines the ATM signalling manager to be used.
1702 The value will be passed as the parameters of an
1703 .Dq Nm atm Cm attach Ar intf
1705 .It Va atm_prefix_ Ns Aq Ar intf
1707 For the ATM physical interface
1709 this variable defines the NSAP prefix for interfaces using a UNI signalling
1713 the prefix will automatically be set via the
1716 Otherwise, the value will be passed as the parameters of an
1717 .Dq Nm atm Cm "set prefix" Ar intf
1719 .It Va atm_macaddr_ Ns Aq Ar intf
1721 For the ATM physical interface
1723 this variable defines the MAC address for interfaces using a UNI signalling
1727 the hardware MAC address contained in the ATM interface card will be used.
1728 Otherwise, the value will be passed as the parameters of an
1729 .Dq Nm atm Cm "set mac" Ar intf
1731 .It Va atm_arpserver_ Ns Aq Ar netif
1733 For the ATM network interface
1735 this variable defines the ATM address for a host which is to provide ATMARP
1737 This variable is only applicable to interfaces using a UNI signalling manager.
1740 this host will become an ATMARP server.
1741 The value will be passed as the parameters of an
1742 .Dq Nm atm Cm "set arpserver" Ar netif
1744 .It Va atm_scsparp_ Ns Aq Ar netif
1748 SCSP/ATMARP service for the network interface
1750 will be initiated using the
1755 This variable is only applicable if
1756 .Va atm_arpserver_ Ns Aq Ar netif
1761 Set to the list of permanent ATM ARP entries to be added at system boot time.
1762 For each whitespace separated
1765 .Va atm_arp_ Ns Aq Ar element
1766 variable is assumed to exist.
1767 The value of each of these variables will be passed as the parameters of an
1768 .Dq Nm atm Cm "add arp"
1772 The keyboard bell sound.
1779 if the default behavior is desired.
1780 For details, refer to the
1787 no keymap is installed, otherwise the value is used to install
1789 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1792 The keyboard repeat speed.
1799 if the default behavior is desired.
1804 attempt to program the function keys with the value.
1805 The value should be a single string of the form:
1806 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1809 Can be set to the value of
1812 .Dq Li destructive ,
1815 to set the cursor behavior explicitly or choose the default behavior.
1820 no screen map is installed, otherwise the value is used to install
1821 the screen map file in
1822 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1827 the default 8x16 font value is used for screen size requests, otherwise
1829 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1835 the default 8x14 font value is used for screen size requests, otherwise
1837 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1843 the default 8x8 font value is used for screen size requests, otherwise
1845 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1851 the default screen blanking interval is used, otherwise it is set to
1858 this is the actual screen saver to use
1859 .Li ( blank , snake , daemon ,
1861 .It Va moused_enable
1867 daemon is started for doing cut/paste selection on the console.
1870 This is the protocol type of the mouse connected to this host.
1871 This variable must be set if
1878 is able to detect the appropriate mouse type automatically in many cases.
1879 Set this variable to
1881 to let the daemon detect it, or
1882 select one from the following list if the automatic detection fails.
1884 If the mouse is attached to the PS/2 mouse port, choose
1888 regardless of the brand and model of the mouse.
1889 Likewise, if the mouse is attached to the bus mouse port, choose
1893 All other protocols are for serial mice and will not work with
1894 the PS/2 and bus mice.
1895 If this is a USB mouse,
1897 is the only protocol type which will work.
1899 .Bl -tag -width ".Li x10mouseremote" -compact
1901 Microsoft mouse (serial)
1903 Microsoft IntelliMouse (serial)
1905 Mouse systems Corp. mouse (serial)
1907 MM Series mouse (serial)
1909 Logitech mouse (serial)
1913 Logitech MouseMan and TrackMan (serial)
1915 ALPS GlidePoint (serial)
1916 .It Li thinkingmouse
1917 Kensington ThinkingMouse (serial)
1921 MM HitTablet (serial)
1922 .It Li x10mouseremote
1923 X10 MouseRemote (serial)
1925 Interlink VersaPad (serial)
1928 Even if the mouse is not in the above list, it may be compatible
1929 with one in the list.
1930 Refer to the man page for
1932 for compatibility information.
1934 It should also be noted that while this is enabled, any
1935 other client of the mouse (such as an X server) should access
1936 the mouse through the virtual mouse device,
1938 and configure it as a
1940 type mouse, since all
1941 mouse data is converted to this single canonical format when using
1943 If the client program does not support the
1948 It is the second preferred type.
1955 this is the actual port the mouse is on.
1958 for a COM1 serial mouse or
1960 for a PS/2 mouse, for example.
1965 is set, these are the additional flags to pass to the
1968 .It Va mousechar_start
1972 the default mouse cursor character range
1973 .Li 0xd0 Ns - Ns Li 0xd3
1974 is used, otherwise the range start is set to
1978 Use if the default range is occupied in the language code table.
1981 Set the size of the history (scrollback) buffer in lines.
1982 .It Va allscreens_flags
1986 is run with these options for each of the virtual terminals
1990 will enable the mouse pointer on all virtual terminals if
1994 .It Va allscreens_kbdflags
1998 is run with these options for each of the virtual terminals
2004 scrollback (history) buffer to 200 lines.
2011 daemon at system boot time.
2017 .Pa /usr/sbin/cron ) .
2024 these are the flags to pass to
2031 .Pa /usr/sbin/lpd ) .
2038 daemon at system boot time.
2045 these are the flags to pass to the
2054 daemon at system boot time.
2061 settings across reboots.
2062 .It Va mta_start_script
2064 The full path to the script to run to start
2065 a mail transfer agent.
2067 .Pa /etc/rc.sendmail .
2071 .Pa /etc/rc.sendmail
2072 uses are documented in the
2078 .Sq HAMMER ROOT with UFS /boot
2079 setup, the boot loader will not set up the
2082 The system will attempt to fix this on its own.
2083 Set this variable to
2085 to turn this behavior off.
2088 Indicates the device (usually a swap partition) to which a crash dump
2089 should be written in the event of a system crash.
2090 The value of this variable is passed as the argument to
2094 To disable crash dumps, set this variable to
2098 When the system reboots after a crash and a crash dump is found on the
2099 device specified by the
2103 will save that crash dump and a copy of the kernel to the directory
2107 The default value is
2116 .It Va savecore_flags
2118 If crash dumps are enabled, these are the flags to pass to the
2121 .It Va crashinfo_enable
2125 to turn on automatic crash dump summary generation using the utility
2127 .Va crashinfo_program
2129 .It Va crashinfo_program
2131 Program to run to generate a crash dump summary if the variable
2132 .Va crashinfo_enable
2135 The default value is
2136 .Pa /usr/sbin/crashinfo .
2137 .It Va enable_quotas
2141 to turn on user disk quotas on system startup via the
2148 to enable user disk quota checking via the
2151 .It Va accounting_enable
2155 to enable system accounting through the
2162 to enable Linux/ELF binary emulation at system initial boot time.
2163 .It Va sysvipc_enable
2167 load System V IPC primitives at boot time.
2168 .\" ----- cleanvar_enable setting--------------------------------
2169 .It Va cleanvar_enable
2177 .Pa /var/spool/uucp/.Temp/*
2179 .\" ----- clear_tmp_enable setting-------------------------------
2180 .It Va clear_tmp_enable
2187 .\" ----- ldconfig_paths setting --------------------------------
2188 .It Va ldconfig_paths
2190 Set to the list of shared library paths to use with
2194 will always be added first, so it need not appear in this list.
2195 .It Va ldconfig_insecure
2199 utility normally refuses to use directories
2200 which are writable by anyone except root.
2201 Set this variable to
2203 to disable that security check during system startup.
2204 .It Va kern_securelevel
2206 The kernel security level to set at startup.
2207 The allowed range of
2209 ranges from \-1 (the compile time default) to 3 (the most secure).
2212 for the list of possible security levels and their effect on system operation.
2219 at system boot time.
2226 at system boot time.
2229 Path to the SSH server program
2231 .Pa /usr/sbin/sshd ) .
2238 these are the flags to pass to the
2247 at system boot time.
2254 these are the flags to pass to the
2263 daemon at boot time.
2270 these are the flags passed to
2273 .It Va watchdogd_enable
2279 daemon at boot time.
2280 This requires that the kernel have been compiled with
2281 .Cd "options WATCHDOG" .
2286 any configured jails will not be started.
2289 A space separated list of names for jails.
2290 This is purely a configuration aid to help identify and
2291 configure multiple jails.
2292 The names specified in this list will be used to
2293 identify settings common to an instance of a jail.
2294 Assuming that the jail in question was named
2296 you would have the following dependent variables:
2298 jail_vjail_hostname="jail.example.com"
2299 jail_vjail_ip="192.168.1.100"
2300 jail_vjail_rootdir="/var/jails/vjail/root"
2306 When set, use as default value for
2307 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2310 .It Va jail_interface
2313 When set, use as default value for
2314 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2320 When set, use as default value for
2321 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2324 .It Va jail_mount_enable
2332 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2335 by default for every jail in
2337 .It Va jail_fdesc_enable
2345 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2348 by default for every jail in
2350 .It Va jail_procfs_enable
2358 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2361 by default for every jail in
2363 .It Va jail_devfs_enable
2371 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2374 by default for every jail in
2376 .It Va jail_exec_start
2379 When set, use as default value for
2380 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2383 .It Va jail_exec_stop
2385 When set, use as default value for
2386 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2389 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2392 Set to the root directory used by jail
2394 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2397 Set to the fully qualified domain name (FQDN) assigned to jail
2399 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2402 Set to the IP address assigned to jail
2404 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2409 These are flags to pass to
2411 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2414 When set, sets the interface to use when setting IP address alias.
2415 Note that the alias is created at jail startup and removed at jail shutdown.
2416 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2419 .Pa /etc/fstab. Ns Aq Ar jname
2421 This is the file system information file to use for jail
2423 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2430 mount all file systems from
2431 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2433 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2440 mount the file-descriptor file system inside jail
2443 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2450 mount the process file system inside jail
2453 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2460 mount the device file system inside jail
2463 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2466 .Dq Li /bin/sh /etc/rc
2468 This is the command executed at jail startup.
2469 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2472 .Dq Li /bin/sh /etc/rc.shutdown
2474 This is the command executed at jail shutdown.
2475 .It Va jail_set_hostname_allow
2479 do not allow the root user in a jail to set its hostname.
2480 .It Va jail_socket_unixiproute_only
2484 do not allow any sockets,
2485 besides UNIX/IP/route sockets,
2486 to be used within a jail.
2487 .It Va jail_sysvipc_allow
2491 allow applications within a jail to use System V IPC.
2496 LVM volumes will be discovered and configured on boot.
2497 .It Va newsyslog_enable
2503 before syslogd starts.
2504 .It Va newsyslog_flags
2507 .Va newsyslog_enable
2510 these are the flags passed to
2512 .It Va resident_enable
2516 make the dynamic binaries listed in
2517 .Pa /etc/resident.conf
2519 .It Va varsym_enable
2524 .Pa /etc/varsym.conf
2525 to set system-wide variables for variant symlinks.
2530 or a whitespace separated list of IRQ numbers which will be used as a source of
2532 .\" ----- isdn settings ---------------------------------
2542 daemon at system boot time.
2546 .Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2548 Additional flags to pass to
2554 for certain tunable parameters).
2560 The terminal type of the output device when
2562 operates in full-screen mode.
2563 .It Va isdn_screenflags
2568 The video mode for full-screen mode (only for
2578 The output device for
2580 in full-screen mode (or
2590 enables the ISDN protocol trace utility
2592 at system boot time.
2593 .It Va isdn_traceflags
2596 .Dq Fl f Pa /var/tmp/isdntrace0
2600 .\" -----------------------------------------------------
2605 to disable caching entropy via
2607 Otherwise set to the directory used to store entropy files in.
2612 to disable caching entropy through reboots.
2613 Otherwise set to the filename used to store cached entropy through reboots.
2614 This file should be located on the root file system to seed the
2616 device as early as possible in the boot process.
2628 Configuration file for
2637 .Pa /var/run/dmesg.boot
2639 .It Va rcshutdown_timeout
2641 If set, start a watchdog timer in the background which will terminate
2645 has not completed within the specified time (in seconds).
2650 the udevd daemon will be started on boot.
2651 .It Va vkernel_enable
2655 any configured vkernels will not be started.
2656 .It Va vkernel_kill_timeout
2658 This defines the default number of seconds that we will wait for the
2659 vkernel to shut down on it's own. If after this time it's still alive,
2660 it will be killed with SIGKILL.
2663 Defines the default path to the vkernel binary.
2666 A space separated list of names for vkernels.
2667 This is purely a configuration aid to help identify and
2668 configure multiple vkernels.
2669 The names specified in this list will be used to
2670 identify settings common to a vkernel instance.
2671 Assuming that the vkernel in question was named
2673 you would have the following dependent variables
2674 (filled with reference values in this text):
2676 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2677 vkernel_example_memsize="64m"
2678 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2679 vkernel_example_iface_list="auto:bridge0"
2680 vkernel_example_logfile="/dev/null"
2681 vkernel_example_flags="-U"
2682 vkernel_example_kill_timeout="45"
2685 The last five are optional.
2686 They default to an empty string if not set, except for logfile which defaults to
2691 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2692 .It Pa /etc/defaults/rc.conf
2694 .It Pa /etc/rc.conf.local
2695 .It Pa /etc/start_if. Ns Aq Ar interface
2712 .Xr resident.conf 5 ,
2775 .An Jordan K. Hubbard .