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
27 .Dd September 17, 2009
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 system installation utility,
46 is not to run commands or perform system startup actions
48 Instead, it is included by the
49 various generic startup scripts in
51 which conditionalize their
52 internal actions according to the settings found there.
56 file is included from the file
57 .Pa /etc/defaults/rc.conf ,
58 which specifies the default settings for all the available options.
59 Options need only be specified in
61 when the system administrator wishes to override these defaults.
63 .Pa /etc/rc.conf.local
64 is used to override settings in
66 for historical reasons.
72 .Dq Ar name Ns Li = Ns Ar value
76 The following list provides a name and short description for each
77 variable that can be set in the
80 .Bl -tag -width indent-two
85 enable output of debug messages from rc scripts.
86 This variable can be helpful in diagnosing mistakes when
87 editing or integrating new scripts.
88 Beware that this produces copious output to the terminal and
94 disable informational messages from the rc scripts.
95 Informational messages are displayed when
96 a condition that is not serious enough to warrant a warning or
104 when faststart is used (e.g., at boot time).
105 .It Va early_late_divider
107 The name of the script that should be used as the
108 delimiter between the
112 stages of the boot process.
113 The early stage should contain all the services needed to
114 get the disks (local or remote) mounted so that the late
115 stage can include scripts contained in the directories
118 variable (see below).
119 Thus, the two likely candidates for this value are
121 for the typical system, and
123 if the system needs remote file
124 systems mounted to get access to the
126 directories; for example when
134 is likely to be an appropriate value.
135 Extreme care should be taken when changing this value,
136 and before changing it one should ensure that there are
137 adequate provisions to recover from a failed boot
138 (such as physical contact with the machine,
139 or reliable remote console access).
144 no swapfile is installed, otherwise the value is used as the full
145 pathname to a file to use for additional swap space.
150 enable support for Automatic Power Management with
158 to handle APM event from userland.
159 This also enables support for APM.
166 these are the flags to pass to the
173 to handle device added, removed or unknown events from the kernel.
180 scripts at boot time.
183 Configuration file for
187 .It Va kldxref_enable
194 to automatically rebuild
199 .It Va kldxref_clobber
209 will overwrite existing
216 .It Va kldxref_module_path
221 delimited list of paths containing
233 enable the system power control facility with the
242 these are the flags to pass to the
246 Controls the creation of a
249 Always happens if set to
251 and never happens if set to
253 If set to anything else, a memory file system is created if
257 Controls the size of a created
261 Extra options passed to the
263 utility when the memory file system for
268 which inhibits the use of softupdates on
270 so that file system space is freed without delay
271 after file truncation or deletion.
274 for other options you can use in
277 Controls the creation of a
280 Always happens if set to
282 and never happens if set to
284 If set to anything else, a memory file system is created if
288 Controls the size of a created
292 Extra options passed to the
294 utility when the memory file system for
299 which inhibits the use of softupdates on
301 so that file system space is freed without delay
302 after file truncation or deletion.
305 for other options you can use in
308 Controls the automatic population of the
311 Always happens if set to
313 and never happens if set to
315 If set to anything else, a memory file system is created if
318 Note that this process requires access to certain commands in
322 is mounted on normal systems.
323 .It Va cleanvar_enable
330 List of directories to search for startup script files.
331 .It Va script_name_sep
333 The field separator to use for breaking down the list of startup script files
334 into individual filenames.
335 The default is a space.
336 It is not necessary to change this unless there are startup scripts with names
338 .It Va hostapd_enable
347 The fully qualified domain name (FQDN) of this host on the network.
348 This should almost certainly be set to something meaningful, even if
349 there is no network connection.
352 is used to set the hostname via DHCP,
353 this variable should be set to an empty string.
356 Enable support for IPv6 networking.
357 Note that this requires that the kernel has been compiled with
358 .Cd "options INET6" .
361 The NIS domain name of this host, or
364 .It Va dhclient_program
366 Path to the DHCP client program
367 .Pa ( /sbin/dhclient ,
372 .It Va dhclient_flags
374 Additional flags to pass to the DHCP client program.
379 manpage for a description of the command line options available.
380 .It Va dhclient_flags_ Ns Aq Ar iface
381 Additional flags to pass to the DHCP client program running on
384 When specified, this variable overrides
386 .It Va background_dhclient
390 to start the DHCP client in background.
391 This can cause trouble with applications depending on
392 a working network, but it will provide a faster startup
394 .It Va background_dhclient_ Ns Aq Ar iface
395 When specified, this variable overrides the
396 .Va background_dhclient
397 variable for interface
400 .It Va synchronous_dhclient
406 synchronously at startup.
407 This behavior can be overridden on a per-interface basis by replacing
411 .Va ifconfig_ Ns Aq Ar interface
416 .It Va defaultroute_delay
418 When set to a positive value, wait up to this long after configuring
419 DHCP interfaces at startup to give the interfaces time to receive a lease.
420 .It Va firewall_enable
424 to load firewall rules at startup.
425 If the kernel was not built with
426 .Cd "options IPFIREWALL" ,
429 kernel module will be loaded.
431 .Va ipfilter_enable .
432 .It Va ipv6_firewall_enable
434 The IPv6 equivalent of
435 .Va firewall_enable .
438 to load IPv6 firewall rules at startup.
439 If the kernel was not built with
440 .Cd "options IPV6FIREWALL" ,
443 kernel module will be loaded.
444 .It Va firewall_script
446 This variable specifies the full path to the firewall script to run.
448 .Pa /etc/rc.firewall .
449 .It Va ipv6_firewall_script
451 The IPv6 equivalent of
452 .Va firewall_script .
455 Names the firewall type from the selection in
456 .Pa /etc/rc.firewall ,
457 or the file which contains the local firewall ruleset.
458 Valid selections from
462 .Bl -tag -width ".Li simple" -compact
464 unrestricted IP access
466 all IP services disabled, except via
469 basic protection for a workstation
471 basic protection for a LAN.
474 If a filename is specified, the full path
476 .It Va ipv6_firewall_type
478 The IPv6 equivalent of
480 .It Va firewall_quiet
484 to disable the display of firewall rules on the console during boot.
485 .It Va ipv6_firewall_quiet
487 The IPv6 equivalent of
489 .It Va firewall_logging
493 to enable firewall event logging.
494 This is equivalent to the
495 .Dv IPFIREWALL_VERBOSE
497 .It Va ipv6_firewall_logging
499 The IPv6 equivalent of
500 .Va firewall_logging .
501 .It Va firewall_flags
507 specifies a filename.
508 .It Va ipv6_firewall_flags
510 The IPv6 equivalent of
512 .\" ----- firewall_nat_enable setting --------------------------------
513 .It Va firewall_nat_enable
525 .It Va firewall_nat_interface
531 This is the name of the public interface or IP address on which
532 kernel NAT should run.
533 .It Va firewall_nat_flags
535 Additional configuration parameters for kernel NAT should be placed here.
536 .It Va dummynet_enable
540 will automatically load the
546 .\" -------------------------------------------------------------------
562 sockets must be enabled in the kernel.
563 If the kernel was not built with
564 .Cd "options IPDIVERT" ,
567 kernel module will be loaded.
568 .It Va natd_interface
570 This is the name of the public interface on which
573 The interface may be given as an interface name or as an IP address.
578 flags should be placed here.
583 flag is automatically added with the above
586 .\" ----- ipfilter_enable setting --------------------------------
587 .It Va ipfilter_enable
598 Typical usage will require putting
600 ipfilter_enable="YES"
618 can be enabled independently.
622 both require at least one of
632 options IPFILTER_DEFAULT_BLOCK
635 in the kernel configuration file is a good idea, too.
636 .\" ----- ipfilter_program setting ------------------------------
637 .It Va ipfilter_program
643 .\" ----- ipfilter_rules setting --------------------------------
644 .It Va ipfilter_rules
649 This variable contains the name of the filter rule definition file.
650 The file is expected to be readable for the
653 .\" ----- ipv6_ipfilter_rules setting ---------------------------
654 .It Va ipv6_ipfilter_rules
659 This variable contains the IPv6 filter rule definition file.
660 The file is expected to be readable for the
663 .\" ----- ipfilter_flags setting --------------------------------
664 .It Va ipfilter_flags
667 This variable contains flags passed to the
670 .\" ----- ipnat_enable setting ----------------------------------
680 network address translation.
683 for a detailed discussion.
684 .\" ----- ipnat_program setting ---------------------------------
691 .\" ----- ipnat_rules setting -----------------------------------
697 This variable contains the name of the file
698 holding the network address translation definition.
699 This file is expected to be readable for the
702 .\" ----- ipnat_flags setting -----------------------------------
706 This variable contains flags passed to the
709 .\" ----- ipmon_enable setting ----------------------------------
724 Setting this variable needs setting
731 for a detailed discussion.
732 .\" ----- ipmon_program setting ---------------------------------
739 .\" ----- ipmon_flags setting -----------------------------------
745 This variable contains flags passed to the
748 Another typical example would be
749 .Dq Fl D Pa /var/log/ipflog
752 log directly to a file bypassing
755 .Pa /etc/newsyslog.conf
756 in such case like this:
758 /var/log/ipflog 640 10 100 * Z /var/run/ipmon.pid
760 .\" ----- ipfs_enable setting -----------------------------------
770 saving the filter and NAT state tables during shutdown
771 and reloading them during startup again.
772 Setting this variable needs setting
781 for a detailed discussion.
787 because the raised securelevel will prevent
789 from saving the state tables at shutdown time.
790 .\" ----- ipfs_program setting ----------------------------------
797 .\" ----- ipfs_flags setting ------------------------------------
801 This variable contains flags passed to the
804 .\" ----- end of added ipf hook ---------------------------------
816 Typical usage will require putting
831 into the kernel, otherwise the
832 kernel module will be loaded.
837 ruleset configuration file
852 these flags are passed to the
854 program when loading the ruleset.
864 which logs packets from the
877 .Pa /var/log/pflog ) .
879 .Pa /etc/newsyslog.conf
880 to adjust logfile rotation for this.
890 This variable contains additional flags passed to the
893 .It Va ftpproxy_enable
904 packet filter in translating ftp connections.
905 .It Va ftpproxy_flags
908 This variable contains additional flags passed to the
920 state changes to other hosts over the network by means of
925 must also be set then.
926 .It Va pfsync_syncdev
929 This variable specifies the name of the network interface
931 should operate through.
932 It must be set accordingly if
936 .It Va pfsync_syncpeer
939 This variable is optional.
940 By default, state change messages are sent out on the synchronisation
941 interface using IP multicast packets.
942 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
944 When a peer address is specified using the
946 option, the peer address is used as a destination for the pfsync
947 traffic, and the traffic can then be protected using
951 manpage for more details about using
956 .It Va pfsync_ifconfig
959 This variable can contain additional options to be passed to the
961 command used to set up
963 .It Va tcp_extensions
970 disables certain TCP options as described by
976 might help remedy such problems with connections as randomly hanging
977 or other weird behavior.
978 Some network devices are known
979 to be broken with respect to these options.
986 .Va net.inet.tcp.log_in_vain
988 .Va net.inet.udp.log_in_vain ,
993 are set to the given value.
1001 will disable probing idle TCP connections to verify that the
1002 peer is still up and reachable.
1003 .It Va tcp_drop_synfin
1010 will cause the kernel to ignore TCP frames that have both
1011 the SYN and FIN flags set.
1012 This prevents OS fingerprinting, but may
1013 break some legitimate applications.
1014 .It Va icmp_drop_redirect
1021 will cause the kernel to ignore ICMP REDIRECT packets.
1024 for more information.
1025 .It Va icmp_log_redirect
1032 will cause the kernel to log ICMP REDIRECT packets.
1034 the log messages are not rate-limited, so this option should only be used
1035 for troubleshooting networks.
1038 for more information.
1039 .It Va icmp_bmcastecho
1043 to respond to broadcast or multicast ICMP ping packets.
1046 for more information.
1047 .It Va ip_portrange_first
1051 this is the first port in the default portrange.
1054 for more information.
1055 .It Va ip_portrange_last
1059 this is the last port in the default portrange.
1062 for more information.
1063 .It Va network_interfaces
1065 Set to the list of network interfaces to configure on this host or
1067 (the default) for all current interfaces.
1069 .Va network_interfaces
1070 variable to anything other than the default is deprecated.
1071 Interfaces that the administrator wishes to store configuration for,
1072 but not start at boot should be configured with the
1075 .Va ifconfig_ Ns Aq Ar interface
1076 variables as described below.
1079 .Va ifconfig_ Ns Aq Ar interface
1080 variable is also assumed to exist for each value of
1082 When an interface name contains any of the characters
1084 they are translated to
1087 The variable can contain arguments to
1089 as well as special case-insensitive keywords described below.
1090 Such keywords are removed before passing the value to
1092 while the order of the other arguments is preserved.
1094 One can configure more than one IPv4 address with the
1095 .Va ipv4_addrs_ Ns Aq Ar interface
1097 One or more IP addresses must be provided in Classless Inter-Domain
1098 Routing (CIDR) address notation, whose last byte can be a range like
1100 In this case the address 192.0.2.5 will be configured with the
1101 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1102 the non-conflicting netmask /32 as explained in the
1105 With the interface in question being
1107 an example could look like:
1109 ipv4_addrs_ed0="192.0.2.129/27 192.0.2.1-5/28"
1112 It is also possible to add IP alias entries using
1115 Assuming that the interface in question was
1118 something like this:
1120 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1121 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1126 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1127 entry that is found,
1128 its contents are passed to
1130 Execution stops at the first unsuccessful access, so if
1131 something like this is present:
1133 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1134 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1135 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1136 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1139 Then note that alias4 would
1141 be added since the search would
1142 stop with the missing
1145 Due to this difficult to manage behavior, the
1146 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1150 .Pa /etc/start_if. Ns Aq Ar interface
1151 file is present, it is read and executed by the
1154 before configuring the interface as specified in the
1155 .Va ifconfig_ Ns Aq Ar interface
1157 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1161 .Va wlans_ Ns Aq Ar interface
1165 interface will be created for each item in the list with the
1169 Further wlan cloning arguments may be passed to the
1172 command by setting the
1173 .Va create_args_ Ns Aq Ar interface
1177 devices must be created for each wireless devices as of
1183 may be specified with an
1184 .Va wlandebug_ Ns Aq Ar interface
1186 The contents of this variable will be passed directly to
1190 .Va ifconfig_ Ns Aq Ar interface
1191 contains the keyword
1193 then the interface will not be configured
1195 .Pa /etc/pccard_ether
1197 .Va network_interfaces
1201 It is possible to bring up an interface with DHCP by adding
1204 .Va ifconfig_ Ns Aq Ar interface
1206 For instance, to initialize the
1209 it is possible to use something like:
1214 Also, if you want to configure your wireless interface with
1215 .Xr wpa_supplicant 8
1216 for use with WPA, EAP/LEAP or WEP, you need to add
1219 .Va ifconfig_ Ns Aq Ar interface
1222 Finally, you can add
1224 options in this variable, in addition to the
1225 .Pa /etc/start_if. Ns Aq Ar interface
1227 For instance, configure an
1229 wireless device in station mode with an address obtained
1230 via DHCP, using WPA authentication and 802.11b mode, it is
1231 possible to use something like:
1234 ifconfig_wlan0="DHCP WPA mode 11b"
1238 .Va ifconfig_ Ns Aq Ar interface
1239 form, a fallback variable
1240 .Va ifconfig_DEFAULT
1242 It will be used for all interfaces with no
1243 .Va ifconfig_ Ns Aq Ar interface
1245 This is intended to replace the no longer supported
1249 It is also possible to rename interface by doing:
1251 ifconfig_ed0_name="net0"
1252 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1254 .It Va ipv6_network_interfaces
1256 This is the IPv6 equivalent of
1257 .Va network_interfaces .
1258 Instead of setting the ifconfig variables as
1259 .Va ifconfig_ Ns Aq Ar interface
1260 they should be set as
1261 .Va ipv6_ifconfig_ Ns Aq Ar interface .
1262 Aliases should be set as
1263 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
1264 .Va ipv6_prefix_ Ns Aq Ar interface
1266 Interfaces that do not have a
1267 .Va ipv6_ifconfig_ Ns Aq Ar interface
1268 setting will be auto configured by
1271 .Va ipv6_gateway_enable
1274 Note that the IPv6 networking code does not support the
1275 .Pa /etc/start_if. Ns Aq Ar interface
1277 .It Va ipv6_default_interface
1281 this is the default output interface for scoped addresses.
1282 Now this works only for IPv6 link local multicast addresses.
1283 .It Va cloned_interfaces
1285 Set to the list of clonable network interfaces to create on this host.
1287 .Va cloned_interfaces
1288 are automatically appended to
1289 .Va network_interfaces
1291 .It Va fec_interfaces
1295 Fast EtherChannel interfaces to configure on this host.
1297 .Va fecconfig_ Ns Aq Ar interface
1298 variable is assumed to exist for each value of
1300 The value of this variable is used to configure link aggregated interfaces
1301 according to the syntax of the
1302 .Cm NGM_FEC_ADD_IFACE
1306 Additionally, this option ensures that each listed interface is created
1311 before attempting to configure it.
1314 fec_interfaces="fec0"
1315 fecconfig_fec0="em0 em1"
1316 ifconfig_fec0="DHCP"
1318 .It Va gif_interfaces
1322 tunnel interfaces to configure on this host.
1324 .Va gifconfig_ Ns Aq Ar interface
1325 variable is assumed to exist for each value of
1327 The value of this variable is used to configure the link layer of the
1328 tunnel according to the syntax of the
1332 Additionally, this option ensures that each listed interface is created
1337 before attempting to configure it.
1338 .It Va sppp_interfaces
1342 interfaces to configure on this host.
1344 .Va spppconfig_ Ns Aq Ar interface
1345 variable is assumed to exist for each value of
1347 Each interface should also be configured by a general
1348 .Va ifconfig_ Ns Aq Ar interface
1352 for more information about available options.
1362 The name of the profile to use from
1363 .Pa /etc/ppp/ppp.conf .
1364 Also used for per-profile overrides of
1369 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1370 When the profile name contains any of the characters
1372 they are translated to
1374 for the proposes of the override variable names.
1377 Mode in which to run the
1380 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1382 Overrides the global
1392 See the manual for a full description.
1397 enables network address translation.
1398 Used in conjunction with
1400 allows hosts on private network addresses access to the Internet using
1401 this host as a network address translating router.
1402 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1404 Overrides the global
1408 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1410 Set the unit number to be used for this profile.
1411 See the manual description of
1416 The name of the user under which
1424 .It Va rc_conf_files
1426 This option is used to specify a list of files that will override
1428 .Pa /etc/defaults/rc.conf .
1429 The files will be read in the order in which they are specified and should
1430 include the full path to the file.
1431 By default, the files specified are
1434 .Pa /etc/rc.conf.local
1440 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1442 .It Va gbde_autoattach_all
1447 will attempt to automatically initialize your .bde devices in
1451 List the devices that the script should try to attach,
1456 The directory where the
1458 lockfiles are located.
1459 The default lockfile directory is
1462 The lockfile for each individual
1464 device can be overridden by setting the variable
1465 .Va gbde_lock_ Ns Aq Ar device ,
1468 is the encrypted device without the
1473 .It Va gbde_attach_attempts
1475 Number of times to attempt attaching to a
1477 device, i.e., how many times the user is asked for the pass-phrase.
1481 List of devices to automatically attach on boot.
1482 Note that .eli devices from
1484 are automatically appended to this list.
1487 Number of times user is asked for the pass-phrase.
1488 If empty, it will be taken from
1489 .Va kern.geom.eli.tries
1491 .It Va geli_default_flags
1493 Default flags to use by
1495 when configuring disk encryption.
1496 Flags can be configured for every device separately by defining
1497 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1499 .It Va geli_autodetach
1501 Specifies if GELI devices should be marked for detach on last close after
1502 file systems are mounted.
1505 This can be changed for every device separately by defining
1506 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1508 .It Va geli_swap_flags
1509 Options passed to the
1511 utility when encrypted GEOM providers for swap partitions are created.
1513 .Dq Li "-e aes -l 256 -s 4096 -d" .
1514 .It Va root_rw_mount
1519 After the file systems are checked at boot time, the root file system
1520 is remounted as read-write if this is set to
1522 Diskless systems that mount their root file system from a read-only remote
1523 NFS share should set this to
1527 .It Va fsck_y_enable
1532 will be run with the
1534 flag if the initial preen
1535 of the file systems fails.
1536 .It Va background_fsck
1540 the system will attempt to run
1542 in the background where possible.
1543 .It Va background_fsck_delay
1545 The amount of time in seconds to sleep before starting a background
1547 It defaults to sixty seconds to allow large applications such as
1548 the X server to start before disk I/O bandwidth is monopolized by
1550 If set to a negative number, the background file system check will be
1551 delayed indefinitely to allow the administrator to run it at a more
1553 For example it may be run from
1555 by adding a line like
1557 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1563 List of file system types that are network-based.
1564 This list should generally not be modified by end users.
1566 .Va extra_netfs_types
1568 .It Va extra_netfs_types
1570 If set to something other than
1573 this variable extends the list of file system types
1574 for which automatic mounting at startup by
1576 should be delayed until the network is initialized.
1578 a whitespace-separated list of network file system descriptor pairs,
1579 each consisting of a file system type as passed to
1581 and a human-readable, one-word description,
1584 Extending the default list in this way is only necessary
1585 when third party file system types are used.
1586 .It Va syslogd_enable
1593 .It Va syslogd_program
1598 .Pa /usr/sbin/syslogd ) .
1599 .It Va syslogd_flags
1605 these are the flags to pass to
1614 .It Va inetd_program
1619 .Pa /usr/sbin/inetd ) .
1626 these are the flags to pass to
1635 .It Va named_program
1640 .Pa /usr/sbin/named ) .
1645 configuration file, (default
1646 .Pa /etc/namedb/named.conf ) .
1653 these are the flags to pass to
1655 .It Va named_pidfile
1657 This is the default path to the
1660 This must match the location in
1666 process should be run as.
1667 .It Va named_chrootdir
1669 The root directory for a name server run in a
1671 environment (default
1675 will not be run in a
1678 .It Va named_chroot_autoupdate
1682 to disable automatic update of the
1685 .It Va named_symlink_enable
1689 to disable symlinking of
1698 loop until working name service is established.
1699 .It Va named_wait_host
1701 Name of host to lookup for the named_wait option.
1703 .It Va named_auto_forward
1705 Set to enable automatic creation of a forwarder
1706 configuration file derived from
1707 .Pa /etc/resolv.conf .
1708 .It Va named_auto_forward_only
1710 Set to change the default forwarder configuration from
1714 .It Va kerberos5_server_enable
1718 to start a Kerberos 5 authentication server
1720 .It Va kerberos5_server
1723 .Va kerberos5_server_enable
1726 this is the path to Kerberos 5 Authentication Server.
1727 .It Va kerberos5_server_flags
1730 This variable contains additional flags to be passed to the Kerberos 5
1731 authentication server.
1732 .It Va kadmind5_server_enable
1738 the Kerberos 5 Administration Daemon; set to
1741 .It Va kadmind5_server
1744 .Va kadmind5_server_enable
1747 this is the path to Kerberos 5 Administration Daemon.
1748 .It Va kpasswdd_server_enable
1754 the Kerberos 5 Password-Changing Daemon; set to
1757 .It Va kpasswdd_server
1760 .Va kpasswdd_server_enable
1763 this is the path to Kerberos 5 Password-Changing Daemon.
1770 daemon at boot time.
1777 these are the flags to pass to it.
1784 daemon at boot time.
1791 these are the flags to pass to it.
1794 manpage for more information.
1795 .It Va amd_map_program
1798 the specified program is run to get the list of
1803 maps are stored in NIS, one can set this to
1816 will be updated at boot time to reflect the kernel release
1821 will not be updated.
1822 .It Va nfs_client_enable
1826 run the NFS client daemons at boot time.
1827 .It Va nfs_access_cache
1830 .Va nfs_client_enable
1835 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1837 results should be cached.
1838 A value of 2-10 seconds will substantially reduce network
1839 traffic for many NFS operations.
1840 .It Va nfs_server_enable
1844 run the NFS server daemons at boot time.
1845 .It Va nfs_server_flags
1848 .Va nfs_server_enable
1851 these are the flags to pass to the
1854 .It Va idmapd_enable
1858 run the ID mapping daemon for NFS version 4.
1865 these are the flags to pass to the
1868 .It Va mountd_enable
1873 .Va nfs_server_enable
1879 It is commonly needed to run CFS without real NFS used.
1886 these are the flags to pass to the
1889 .It Va weak_mountd_authentication
1893 allow services like PCNFSD to make non-privileged mount
1895 .It Va nfs_reserved_port_only
1899 provide NFS services only on a secure port.
1900 .It Va nfs_bufpackets
1902 If set to a number, indicates the number of packets worth of
1903 socket buffer space to reserve on an NFS client.
1904 The kernel default is typically 4.
1905 Using a higher number may be
1906 useful on gigabit networks to improve performance.
1907 The minimum value is
1908 2 and the maximum is 64.
1909 .It Va rpc_lockd_enable
1913 and also an NFS server or client, run
1916 .It Va rpc_lockd_flags
1919 .Va rpc_lockd_enable
1922 these are the flags to pass to the
1925 .It Va rpc_statd_enable
1929 and also an NFS server or client, run
1932 .It Va rpc_statd_flags
1935 .Va rpc_statd_enable
1938 these are the flags to pass to the
1941 .It Va rpcbind_program
1946 .Pa /usr/sbin/rpcbind ) .
1947 .It Va rpcbind_enable
1953 service at boot time.
1954 .It Va rpcbind_flags
1960 these are the flags to pass to the
1963 .It Va keyserv_enable
1969 daemon on boot for running Secure RPC.
1970 .It Va keyserv_flags
1976 these are the flags to pass to
1979 .It Va pppoed_enable
1985 daemon at boot time to provide PPP over Ethernet services.
1986 .It Va pppoed_ Ns Aq Ar provider
1989 listens to requests to this
1995 argument of the same name.
1998 Additional flags to pass to
2000 .It Va pppoed_interface
2002 The network interface to run
2005 This is mandatory when
2015 service at boot time.
2016 This command is intended for networks of
2017 machines where a consistent
2019 for all hosts must be established.
2020 This is often useful in large NFS
2021 environments where time stamps on files are expected to be consistent
2029 these are the flags to pass to the
2032 .It Va ntpdate_enable
2039 This command is intended to
2040 synchronize the system clock only
2042 from some standard reference.
2043 An option to set this up initially
2044 (from a list of known servers) is also provided by the
2046 program when the system is first installed.
2047 .It Va ntpdate_config
2049 Configuration file for
2053 .It Va ntpdate_hosts
2055 A whitespace-separated list of NTP servers to synchronize with at startup.
2056 The default is to use the servers listed in
2057 .Va ntpdate_config ,
2058 if that file exists.
2059 .It Va ntpdate_program
2064 .Pa /usr/sbin/ntpdate ) .
2065 .It Va ntpdate_flags
2071 these are the flags to pass to the
2073 command (typically a hostname).
2080 command at boot time.
2086 .Pa /usr/sbin/ntpd ) .
2100 these are the flags to pass to the
2103 .It Va ntpd_sync_on_start
2110 flag, which syncs the system's clock on startup.
2113 for more information regarding the
2116 This is a preferred alternative to using
2121 .It Va nis_client_enable
2127 service at system boot time.
2128 .It Va nis_client_flags
2131 .Va nis_client_enable
2134 these are the flags to pass to the
2137 .It Va nis_ypset_enable
2143 daemon at system boot time.
2144 .It Va nis_ypset_flags
2147 .Va nis_ypset_enable
2150 these are the flags to pass to the
2153 .It Va nis_server_enable
2159 daemon at system boot time.
2160 .It Va nis_server_flags
2163 .Va nis_server_enable
2166 these are the flags to pass to the
2169 .It Va nis_ypxfrd_enable
2175 daemon at system boot time.
2176 .It Va nis_ypxfrd_flags
2179 .Va nis_ypxfrd_enable
2182 these are the flags to pass to the
2185 .It Va nis_yppasswdd_enable
2191 daemon at system boot time.
2192 .It Va nis_yppasswdd_flags
2195 .Va nis_yppasswdd_enable
2198 these are the flags to pass to the
2201 .It Va rpc_ypupdated_enable
2207 daemon at system boot time.
2208 .It Va bsnmpd_enable
2214 daemon at system boot time.
2215 Be sure to understand the security implications of running SNMP daemon
2223 these are the flags to pass to the
2226 .It Va defaultrouter
2230 create a default route to this host name or IP address
2231 (use an IP address if this router is also required to get to the
2233 .It Va ipv6_defaultrouter
2235 The IPv6 equivalent of
2237 .It Va static_routes
2239 Set to the list of static routes that are to be added at system
2243 then for each whitespace separated
2246 .Va route_ Ns Aq Ar element
2247 variable is assumed to exist
2248 whose contents will later be passed to a
2253 static_routes="mcast gif0local"
2254 route_mcast="-net 224.0.0.0/4 -iface gif0"
2255 route_gif0local="-host 169.254.1.1 -iface lo0"
2257 .It Va ipv6_static_routes
2259 The IPv6 equivalent of
2263 then for each whitespace separated
2266 .Va ipv6_route_ Ns Aq Ar element
2267 variable is assumed to exist
2268 whose contents will later be passed to a
2269 .Dq Nm route Cm add Fl inet6
2271 .It Va natm_static_routes
2277 If not empty then for each whitespace separated
2280 .Va route_ Ns Aq Ar element
2281 variable is assumed to exist whose contents will later be passed to a
2282 .Dq Nm atmconfig Cm natm Cm add
2284 .It Va gateway_enable
2288 configure host to act as an IP router, e.g.\& to forward packets
2290 .It Va ipv6_gateway_enable
2292 The IPv6 equivalent of
2293 .Va gateway_enable .
2294 .It Va router_enable
2298 run a routing daemon of some sort, based on the
2303 .It Va ipv6_router_enable
2305 The IPv6 equivalent of
2309 run a routing daemon of some sort, based on the
2313 .Va ipv6_router_flags .
2320 this is the name of the routing daemon to use.
2323 The IPv6 equivalent of
2331 these are the flags to pass to the routing daemon.
2332 .It Va ipv6_router_flags
2334 The IPv6 equivalent of
2336 .It Va mrouted_enable
2340 run the multicast routing daemon,
2342 .It Va mroute6d_enable
2344 The IPv6 equivalent of
2345 .Va mrouted_enable .
2348 run the IPv6 multicast routing daemon.
2350 Note that multicast routing daemons are no longer included in the
2352 base system, however, both
2356 may be installed from the
2359 .It Va mrouted_flags
2365 these are the flags to pass to the
2368 .It Va mroute6d_flags
2370 The IPv6 equivalent of
2376 these are the flags passed to the IPv6 multicast routing daemon.
2377 .It Va mroute6d_program
2383 this is the path to the IPv6 multicast routing daemon.
2384 .It Va rtadvd_enable
2390 daemon at boot time.
2393 .Va ipv6_gateway_enable
2398 utility sends router advertisement packets to the interfaces specified in
2399 .Va rtadvd_interfaces
2400 and should only be enabled with great care.
2401 You may want to fine-tune
2403 .It Va rtadvd_interfaces
2409 this is the list of interfaces to use.
2410 .It Va ipxgateway_enable
2414 enable the routing of IPX traffic.
2415 .It Va ipxrouted_enable
2421 daemon at system boot time.
2422 .It Va ipxrouted_flags
2425 .Va ipxrouted_enable
2428 these are the flags to pass to the
2435 enable global proxy ARP.
2436 .It Va forward_sourceroute
2444 source-routed packets are forwarded.
2445 .It Va accept_sourceroute
2449 the system will accept source-routed packets directed at it.
2456 daemon at system boot time.
2463 these are the flags to pass to the
2466 .It Va bootparamd_enable
2472 daemon at system boot time.
2473 .It Va bootparamd_flags
2476 .Va bootparamd_enable
2479 these are the flags to pass to the
2482 .It Va stf_interface_ipv4addr
2486 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2488 Specify this entry to enable the 6to4 interface.
2489 .It Va stf_interface_ipv4plen
2491 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2492 An effective value is 0-31.
2493 .It Va stf_interface_ipv6_ifid
2495 IPv6 interface ID for
2499 .It Va stf_interface_ipv6_slaid
2501 IPv6 Site Level Aggregator for
2503 .It Va ipv6_faith_prefix
2507 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2512 .It Va ipv6_ipv4mapping
2516 this enables IPv4 mapped IPv6 address communication (like
2517 .Li ::ffff:a.b.c.d ) .
2522 to enable the configuration of ATM interfaces at system boot time.
2523 For all of the ATM variables described below, please refer to the
2525 manual page for further details on the available command parameters.
2526 Also refer to the files in
2527 .Pa /usr/share/examples/atm
2528 for more detailed configuration information.
2531 This is a list of physical ATM interface drivers to load.
2536 .It Va atm_netif_ Ns Aq Ar intf
2538 For the ATM physical interface
2540 this variable defines the name prefix and count for the ATM network
2541 interfaces to be created.
2542 The value will be passed as the parameters of an
2543 .Dq Nm atm Cm "set netif" Ar intf
2545 .It Va atm_sigmgr_ Ns Aq Ar intf
2547 For the ATM physical interface
2549 this variable defines the ATM signalling manager to be used.
2550 The value will be passed as the parameters of an
2551 .Dq Nm atm Cm attach Ar intf
2553 .It Va atm_prefix_ Ns Aq Ar intf
2555 For the ATM physical interface
2557 this variable defines the NSAP prefix for interfaces using a UNI signalling
2561 the prefix will automatically be set via the
2564 Otherwise, the value will be passed as the parameters of an
2565 .Dq Nm atm Cm "set prefix" Ar intf
2567 .It Va atm_macaddr_ Ns Aq Ar intf
2569 For the ATM physical interface
2571 this variable defines the MAC address for interfaces using a UNI signalling
2575 the hardware MAC address contained in the ATM interface card will be used.
2576 Otherwise, the value will be passed as the parameters of an
2577 .Dq Nm atm Cm "set mac" Ar intf
2579 .It Va atm_arpserver_ Ns Aq Ar netif
2581 For the ATM network interface
2583 this variable defines the ATM address for a host which is to provide ATMARP
2585 This variable is only applicable to interfaces using a UNI signalling
2589 this host will become an ATMARP server.
2590 The value will be passed as the parameters of an
2591 .Dq Nm atm Cm "set arpserver" Ar netif
2593 .It Va atm_scsparp_ Ns Aq Ar netif
2597 SCSP/ATMARP service for the network interface
2599 will be initiated using the
2604 This variable is only applicable if
2605 .Va atm_arpserver_ Ns Aq Ar netif
2610 Set to the list of ATM PVCs to be added at system
2612 For each whitespace separated
2615 .Va atm_pvc_ Ns Aq Ar element
2616 variable is assumed to exist.
2617 The value of each of these variables
2618 will be passed as the parameters of an
2619 .Dq Nm atm Cm "add pvc"
2623 Set to the list of permanent ATM ARP entries to be added
2624 at system boot time.
2625 For each whitespace separated
2628 .Va atm_arp_ Ns Aq Ar element
2629 variable is assumed to exist.
2630 The value of each of these variables
2631 will be passed as the parameters of an
2632 .Dq Nm atm Cm "add arp"
2634 .It Va natm_interfaces
2638 interfaces that will also be used for HARP through
2640 If this list is not empty all interfaces in the list will be brought up
2646 For this to work the interface drivers must be either compiled into the
2647 kernel or must reside on the root partition.
2650 The keyboard bell sound.
2657 if the default behavior is desired.
2658 For details, refer to the
2663 If set to a non-null string, the virtual console's keyboard input is
2669 no keymap is installed, otherwise the value is used to install
2671 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
2674 The keyboard repeat speed.
2681 if the default behavior is desired.
2686 attempt to program the function keys with the value.
2688 be a single string of the form:
2689 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
2692 Can be set to the value of
2695 .Dq Li destructive ,
2698 to set the cursor behavior explicitly or choose the default behavior.
2703 no screen map is installed, otherwise the value is used to install
2704 the screen map file in
2705 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
2710 the default 8x16 font value is used for screen size requests, otherwise
2712 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2718 the default 8x14 font value is used for screen size requests, otherwise
2720 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2726 the default 8x8 font value is used for screen size requests, otherwise
2728 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
2734 the default screen blanking interval is used, otherwise it is set
2742 this is the actual screen saver to use
2743 .Li ( blank , snake , daemon ,
2745 .It Va moused_nondefault_enable
2749 the mouse device specified on
2750 the command line is not automatically treated as enabled by the
2751 .Pa /etc/rc.d/moused
2753 Having this variable set to
2759 to be enabled as soon as it is plugged in.
2760 .It Va moused_enable
2766 daemon is started for doing cut/paste selection on the console.
2769 This is the protocol type of the mouse connected to this host.
2770 This variable must be set if
2777 is able to detect the appropriate mouse type automatically in many cases.
2778 Set this variable to
2780 to let the daemon detect it, or
2781 select one from the following list if the automatic detection fails.
2783 If the mouse is attached to the PS/2 mouse port, choose
2787 regardless of the brand and model of the mouse.
2789 mouse is attached to the bus mouse port, choose
2793 All other protocols are for serial mice and will not work with
2794 the PS/2 and bus mice.
2795 If this is a USB mouse,
2797 is the only protocol type which will work.
2799 .Bl -tag -width ".Li x10mouseremote" -compact
2801 Microsoft mouse (serial)
2803 Microsoft IntelliMouse (serial)
2805 Mouse systems Corp.\& mouse (serial)
2807 MM Series mouse (serial)
2809 Logitech mouse (serial)
2813 Logitech MouseMan and TrackMan (serial)
2815 ALPS GlidePoint (serial)
2816 .It Li thinkingmouse
2817 Kensington ThinkingMouse (serial)
2821 MM HitTablet (serial)
2822 .It Li x10mouseremote
2823 X10 MouseRemote (serial)
2825 Interlink VersaPad (serial)
2828 Even if the mouse is not in the above list, it may be compatible
2829 with one in the list.
2830 Refer to the manual page for
2832 for compatibility information.
2834 It should also be noted that while this is enabled, any
2835 other client of the mouse (such as an X server) should access
2836 the mouse through the virtual mouse device,
2838 and configure it as a
2840 type mouse, since all
2841 mouse data is converted to this single canonical format when
2844 If the client program does not support the
2850 It is the second preferred type.
2857 this is the actual port the mouse is on.
2860 for a COM1 serial mouse,
2864 for a bus mouse, for example.
2869 is set, its value is used as an additional set of flags to pass to the
2872 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
2874 .Va moused_nondefault_enable
2877 daemon is started for a non-default port, the
2878 .Va "moused_" Ns Ar XXX Ns Va "_flags"
2879 set of options has precedence over and replaces the default
2880 .Va moused_flags (where
2882 is the name of the non-default port, i.e.\&
2885 .Va "moused_" Ns Ar XXX Ns Va "_flags"
2886 it is possible to set up a different set of default flags for each
2889 For example, you can use
2893 to make your laptop's touchpad more comfortable to use,
2894 but an empty set of options for
2895 .Va moused_ums0_flags
2898 mouse has three or more buttons.
2899 .It Va mousechar_start
2903 the default mouse cursor character range
2904 .Li 0xd0 Ns - Ns Li 0xd3
2906 otherwise the range start is set
2911 Use if the default range is occupied in the language code table.
2912 .It Va allscreens_flags
2916 is run with these options for each of the virtual terminals
2920 will enable the mouse pointer on all virtual terminals
2925 .It Va allscreens_kbdflags
2929 is run with these options for each of the virtual terminals
2935 scrollback (history) buffer to 200 lines.
2942 daemon at system boot time.
2948 .Pa /usr/sbin/cron ) .
2955 these are the flags to pass to
2961 enable the special handling of transitions to and from the
2962 Daylight Saving Time in
2964 (equivalent to using the flag
2971 .Pa /usr/sbin/lpd ) .
2978 daemon at system boot time.
2985 these are the flags to pass to the
2988 .It Va chkprintcap_enable
2994 command before starting the
2997 .It Va chkprintcap_flags
3002 .Va chkprintcap_enable
3005 these are the flags to pass to the
3010 which causes missing directories to be created.
3011 .It Va mta_start_script
3013 This variable specifies the full path to the script to run to start
3014 a mail transfer agent.
3016 .Pa /etc/rc.sendmail .
3020 .Pa /etc/rc.sendmail
3021 uses are documented in the
3026 Indicates the device (usually a swap partition) to which a crash dump
3027 should be written in the event of a system crash.
3028 If the value of this variable is
3030 the first suitable swap device listed in
3032 will be used as dump device.
3033 Otherwise, the value of this variable is passed as the argument to
3035 To disable crash dumps, set this variable to
3039 When the system reboots after a crash and a crash dump is found on the
3040 device specified by the
3044 will save that crash dump and a copy of the kernel to the directory
3048 The default value is
3057 .It Va savecore_flags
3059 If crash dumps are enabled, these are the flags to pass to the
3066 to turn on user and group disk quotas on system startup via the
3068 command for all file systems marked as having quotas enabled in
3070 The kernel must be built with
3072 for disk quotas to function.
3077 to enable user and group disk quota checking via the
3080 .It Va quotacheck_flags
3090 these are the flags to pass to the
3095 which checks quotas for all file systems with quotas enabled in
3097 .It Va quotaon_flags
3103 these are the flags to pass to the
3108 which enables quotas for all file systems with quotas enabled in
3110 .It Va quotaoff_flags
3116 these are the flags to pass to the
3118 utility when shutting down the quota system.
3121 which disables quotas for all file systems with quotas enabled in
3123 .It Va accounting_enable
3127 to enable system accounting through the
3134 to enable iBCS2 (SCO) binary emulation at system initial boot
3136 .It Va ibcs2_loaders
3144 this specifies a list of additional iBCS2 loaders to enable.
3149 to enable Linux/ELF binary emulation at system initial
3155 enable SysVR4 emulation at boot time.
3156 .It Va sysvipc_enable
3160 load System V IPC primitives at boot time.
3161 .It Va clear_tmp_enable
3172 to disable removing of X11 lock files,
3173 and the removal and (secure) recreation
3174 of the various socket directories for X11
3176 .It Va ldconfig_paths
3178 Set to the list of shared library paths to use with
3182 will always be added first, so it need not appear in this list.
3183 .It Va ldconfig32_paths
3185 Set to the list of 32-bit compatibility shared library paths to
3188 .It Va ldconfig_paths_aout
3190 Set to the list of shared library paths to use with
3195 .It Va ldconfig_insecure
3199 utility normally refuses to use directories
3200 which are writable by anyone except root.
3201 Set this variable to
3203 to disable that security check during system startup.
3204 .It Va ldconfig_local_dirs
3206 Set to the list of local
3209 The names of all files in the directories listed will be
3210 passed as arguments to
3212 .It Va ldconfig_local32_dirs
3214 Set to the list of local 32-bit compatibility
3217 The names of all files in the directories listed will be
3218 passed as arguments to
3219 .Dq Nm ldconfig Fl 32 .
3220 .It Va kern_securelevel_enable
3224 to set the kernel security level at system startup.
3225 .It Va kern_securelevel
3227 The kernel security level to set at startup.
3228 The allowed range of
3230 ranges from \-1 (the compile time default) to 3 (the
3234 for the list of possible security levels and their effect
3235 on system operation.
3238 Path to the SSH server program
3239 .Pa ( /usr/sbin/sshd
3247 at system boot time.
3254 these are the flags to pass to the
3259 Path to the FTP server program
3260 .Pa ( /usr/libexec/ftpd
3268 as a stand-alone daemon at system boot time.
3275 these are the additional flags to pass to the
3278 .It Va watchdogd_enable
3284 daemon at boot time.
3285 This requires that the kernel have been compiled with a
3288 .It Va watchdogd_flags
3291 .Va watchdogd_enable
3294 these are the flags passed to the
3297 .It Va performance_cx_lowest
3299 CPU idle state to use while on AC power.
3304 should use the lowest power state available while
3306 indicates that the lowest latency state (less power savings) should be used.
3307 .It Va performance_cpu_freq
3309 CPU clock frequency to use while on AC power.
3314 should use the lowest frequency available while
3316 indicates that the highest frequency (less power savings) should be used.
3317 .It Va economy_cx_lowest
3319 CPU idle state to use when off AC power.
3324 should use the lowest power state available while
3326 indicates that the lowest latency state (less power savings) should be used.
3327 .It Va economy_cpu_freq
3329 CPU clock frequency to use when off AC power.
3334 should use the lowest frequency available while
3336 indicates that the highest frequency (less power savings) should be used.
3341 any configured jails will not be started.
3344 A space separated list of names for jails.
3345 This is purely a configuration aid to help identify and
3346 configure multiple jails.
3347 The names specified in this list will be used to
3348 identify settings common to an instance of a jail.
3349 Assuming that the jail in question was named
3351 you would have the following dependent variables:
3353 jail_vjail_hostname="jail.example.com"
3354 jail_vjail_ip="192.0.2.100"
3355 jail_vjail_rootdir="/var/jails/vjail/root"
3361 When set, use as default value for
3362 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3365 .It Va jail_interface
3368 When set, use as default value for
3369 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3375 When set, use as default value for
3376 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3379 .It Va jail_mount_enable
3387 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3390 by default for every jail in
3392 .It Va jail_devfs_ruleset
3396 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3397 to given value for every jail in
3399 .It Va jail_devfs_enable
3407 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3410 by default for every jail in
3412 .It Va jail_fdescfs_enable
3420 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3423 by default for every jail in
3425 .It Va jail_procfs_enable
3433 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3436 by default for every jail in
3438 .It Va jail_exec_prestart Ns Aq Ar N
3441 When set, use as default value for
3442 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3445 .It Va jail_exec_start
3448 When set, use as default value for
3449 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3452 .It Va jail_exec_afterstart Ns Aq Ar N
3455 When set, use as default value for
3456 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3459 .It Va jail_exec_poststart Ns Aq Ar N
3462 When set, use as default value for
3463 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3466 .It Va jail_exec_prestop Ns Aq Ar N
3469 When set, use as default value for
3470 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3473 .It Va jail_exec_stop
3475 When set, use as default value for
3476 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3479 .It Va jail_exec_poststop Ns Aq Ar N
3482 When set, use as default value for
3483 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3486 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3489 Set to the root directory used by jail
3491 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3494 Set to the fully qualified domain name (FQDN) assigned to jail
3496 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3499 Set to the (primary) IPv4 and/or IPv6 address(es) assigned to the jail.
3500 The argument can be a sole address or a comma separated list of addresses.
3501 Additionally each address can be prefixed by the name of an interface
3502 followed by a pipe to overwrite
3503 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3506 and/or suffixed by a netmask, prefixlen or prefix.
3507 In case no netmask, prefixlen or prefix is given,
3509 will be used for IPv4 and
3511 will be used for an IPv6 address.
3512 If no address is given for the jail then the jail will be started with
3513 no networking support.
3514 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3517 Set additional IPv4 and/or IPv6 address(es) assigned to the jail.
3518 The sequence starts with
3520 and the numbers have to be strictly ascending.
3521 These entries follow the same syntax as their primary
3522 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3524 The order of the entries can be important as the first address for
3525 each address family found will be the primary address of the jail.
3531 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3536 These are flags to pass to
3538 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
3541 When set, sets the interface to use when setting IP address alias.
3542 Note that the alias is created at jail startup and removed at jail shutdown.
3543 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3546 When set, the jail is started with the specified forwarding table (sometimes
3547 referred to as a routing table) via
3549 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3552 .Pa /etc/fstab. Ns Aq Ar jname
3554 This is the file system information file to use for jail
3556 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3563 mount all file systems from
3564 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3566 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset
3569 When set, defines the device file system ruleset file to use for jail
3571 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3578 mount the device file system inside jail
3581 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3588 mount the file-descriptor file system inside jail
3591 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
3598 mount the process file system inside jail
3601 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart Ns Aq Ar N
3604 This is the command run as
3607 before jail startup, where
3610 It is run outside the jail.
3611 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
3614 .Dq Li /bin/sh /etc/rc
3616 This is the command executed in a jail at jail startup.
3617 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_afterstart Ns Aq Ar N
3620 This is the command run as
3624 after jail startup, where
3627 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart Ns Aq Ar N
3630 This is the command run as
3633 after jail startup, where
3636 It is run outside the jail.
3637 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop Ns Aq Ar N
3640 This is the command run as
3643 before jail shutdown, where
3646 It is run outside the jail.
3647 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3650 .Dq Li /bin/sh /etc/rc.shutdown
3652 This is the command executed in a jail at jail shutdown.
3653 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop Ns Aq Ar N
3656 This is the command run as
3659 after jail shutdown, where
3662 It is run outside the jail.
3663 .It Va jail_set_hostname_allow
3667 do not allow the root user in a jail to set its hostname.
3668 .It Va jail_socket_unixiproute_only
3672 do not allow any sockets,
3673 besides UNIX/IP/route sockets,
3674 to be used within a jail.
3675 .It Va jail_sysvipc_allow
3679 allow applications within a jail to use System V IPC.
3680 .\" -----------------------------------------------------
3681 .It Va harvest_interrupt
3685 to use hardware interrupts as an entropy source.
3688 for more information.
3689 .It Va harvest_ethernet
3693 to use LAN traffic as an entropy source.
3696 for more information.
3697 .It Va harvest_p_to_p
3701 to use serial line traffic as an entropy source.
3704 for more information.
3709 to disable caching entropy via
3711 Otherwise set to the directory used to store entropy files in.
3716 to disable caching entropy through reboots.
3717 Otherwise set to the filename used to store cached entropy through
3719 This file should be located on the root file system to seed the
3721 device as early as possible in the boot process.
3722 .It Va entropy_save_sz
3724 Size of the entropy cache files saved by
3727 .It Va entropy_save_num
3729 Number of entropy cache files to save by
3743 Configuration file for
3752 .Pa /var/run/dmesg.boot
3754 .It Va rcshutdown_timeout
3756 If set, start a watchdog timer in the background which will terminate
3760 has not completed within the specified time (in seconds).
3761 Notice that in addition to this soft timeout,
3763 also applies a hard timeout for the execution of
3765 This is configured via
3768 .Va kern.init_shutdown_timeout
3769 and defaults to 120 seconds.
3770 Setting the value of
3771 .Va rcshutdown_timeout
3772 to more than 120 seconds will have no effect until the
3775 .Va kern.init_shutdown_timeout
3777 .It Va virecover_enable
3781 to prevent the system from trying to
3782 recover pre-maturely terminated
3785 .It Va ugidfw_enable
3790 .Xr mac_bsdextended 4
3791 module upon system initialization and load a default
3793 .It Va bsdextended_script
3796 .Xr mac_bsdextended 4
3797 ruleset file to load.
3798 The default value of this variable is
3799 .Pa /etc/rc.bsdextended .
3800 .It Va newsyslog_enable
3807 .It Va newsyslog_flags
3810 .Va newsyslog_enable
3813 these are the flags to pass to the
3818 which causes log files flagged with a
3821 .It Va mdconfig_md Ns Aq Ar X
3831 must be specified and either a
3833 for malloc or swap backed
3841 .Va mdconfig_md Ns Aq Ar X
3842 variables are evaluated until one variable is unset or null.
3843 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
3845 Optional arguments passed to
3851 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
3853 An ownership specification passed to
3862 device and the mount point will be changed.
3863 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
3865 A mode string passed to
3874 device and the mount point will be changed.
3875 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
3877 Files to be copied to the mount point of the
3881 after it has been mounted.
3882 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
3884 Command to execute after the specified
3889 Note that the command is passed to
3895 variables can be used to reference respectively the
3897 device and the mount point.
3902 one could set the following:
3904 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
3906 .It Va ramdisk_units
3908 A list of one or more ramdisk units to configure with
3912 in time to be mounted from
3916 must specify at least a
3919 .Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
3921 Note that this way to configure ramdisks has been deprecated
3924 variables (see above).
3925 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config
3933 must be specified, where
3939 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs
3941 Optional arguments passed to
3943 to initialize ramdisk
3945 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner
3947 An ownership specification passed to
3949 after the specified ramdisk unit
3954 device and the mount point will be changed.
3955 .It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms
3957 A mode string passed to
3959 after the specified ramdisk unit
3964 device and the mount point will be changed.
3965 .It Va autobridge_interfaces
3967 Set to the list of bridge interfaces that will have newly arriving interfaces
3968 checked against to be automatically added.
3971 then for each whitespace separated
3974 .Va autobridge_ Ns Aq Ar element
3975 variable is assumed to exist which has a whitespace separated list of interface
3976 names to match, these names can use wildcards.
3979 autobridge_interfaces="bridge0"
3980 autobridge_bridge0="tap* dc0 vlan[345]"
3986 enable support for sound mixer.
3987 .It Va hcsecd_enable
3991 enable Bluetooth security daemon.
3992 .It Va hcsecd_config
3994 Configuration file for
3997 .Pa /etc/bluetooth/hcsecd.conf .
4002 enable Bluetooth Service Discovery Protocol daemon.
4010 .It Va sdpd_groupname
4014 group to run as after it initializes.
4017 .It Va sdpd_username
4021 user to run as after it initializes.
4024 .It Va bthidd_enable
4028 enable Bluetooth Human Interface Device daemon.
4029 .It Va bthidd_config
4031 Configuration file for
4034 .Pa /etc/bluetooth/bthidd.conf .
4037 Path to a file, where
4039 will store information about known HID devices.
4041 .Pa /var/db/bthidd.hids .
4042 .It Va rfcomm_pppd_server_enable
4046 enable Bluetooth RFCOMM PPP wrapper daemon.
4047 .It Va rfcomm_pppd_server_profile
4049 The name of the profile to use from
4050 .Pa /etc/ppp/ppp.conf .
4051 Multiple profiles can be specified here.
4052 Also used to specify per-profile overrides.
4053 When the profile name contains any of the characters
4055 they are translated to
4057 for the proposes of the override variable names.
4058 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4060 Overrides local address to listen on.
4066 The address can be specified as BD_ADDR or name.
4067 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4069 Overrides local RFCOMM channel to listen on.
4072 will listen on RFCOMM channel 1.
4073 Must set properly if multiple profiles used in the same time.
4074 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4078 if it should register Serial Port service on the speficied RFCOMM channel.
4081 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4085 if it should register Dial-Up Networking service on the speficied
4091 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4092 .It Pa /etc/defaults/rc.conf
4094 .It Pa /etc/rc.conf.local
4123 .Xr newsyslog.conf 5 ,
4190 .An Jordan K. Hubbard .
projects / FreeBSD / releng / 8.0.git / blob