share/man/man5/rc.conf.5

   1 .\" Copyright (c) 1995
   2 .\"     Jordan K. Hubbard
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 3, 2022
  28 .Dt RC.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm rc.conf
  32 .Nd system configuration information
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm
  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
  40 .Nm
  41 file is generally initialized by the system installation utility.
  42 .Pp
  43 The purpose of
  44 .Nm
  45 is not to run commands or perform system startup actions
  46 directly.
  47 Instead, it is included by the
  48 various generic startup scripts in
  49 .Pa /etc
  50 which conditionalize their
  51 internal actions according to the settings found there.
  52 .Pp
  53 The
  54 .Pa /etc/rc.conf
  55 file is included from the file
  56 .Pa /etc/defaults/rc.conf ,
  57 which specifies the default settings for all the available options.
  58 Options need only be specified in
  59 .Pa /etc/rc.conf
  60 when the system administrator wishes to override these defaults.
  61 The file
  62 .Pa /etc/defaults/vendor.conf
  63 allows vendors to override
  64 .Fx
  65 defaults.
  66 The file
  67 .Pa /etc/rc.conf.local
  68 is used to override settings in
  69 .Pa /etc/rc.conf
  70 for historical reasons.
  71 .Pp
  72 The sysrc(8) command provides a scripting interface to modify system
  73 config files.
  74 .Pp
  75 In addition to
  76 .Pa /etc/rc.conf.local
  77 you can also place smaller configuration files for each
  78 .Xr rc 8
  79 script in the
  80 .Pa /etc/rc.conf.d
  81 directory or
  82 .Ao Ar dir Ac Ns Pa /rc.conf.d
  83 directories specified in
  84 .Va local_startup ,
  85 which will be included by the
  86 .Va load_rc_config
  87 function.
  88 For jail configurations you could use the file
  89 .Pa /etc/rc.conf.d/jail
  90 to store jail specific configuration options.
  91 If
  92 .Va local_startup
  93 contains
  94 .Pa /usr/local/etc/rc.d
  95 and
  96 .Pa /opt/conf ,
  97 .Pa /usr/local/rc.conf.d/jail
  98 and
  99 .Pa /opt/conf/rc.conf.d/jail
 100 will be loaded.
 101 If
 102 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
 103 is a directory,
 104 all of files in the directory will be loaded.
 105 Also see the
 106 .Va rc_conf_files
 107 variable below.
 108 .Pp
 109 Options are set with
 110 .Dq Ar name Ns Li = Ns Ar value
 111 assignments that use
 112 .Xr sh 1
 113 syntax.
 114 The following list provides a name and short description for each
 115 variable that can be set in the
 116 .Nm
 117 file:
 118 .Bl -tag -width indent-two
 119 .It Va rc_debug
 120 .Pq Vt bool
 121 If set to
 122 .Dq Li YES ,
 123 enable output of debug messages from rc scripts.
 124 This variable can be helpful in diagnosing mistakes when
 125 editing or integrating new scripts.
 126 Beware that this produces copious output to the terminal and
 127 .Xr syslog 3 .
 128 .It Va rc_info
 129 .Pq Vt bool
 130 If set to
 131 .Dq Li NO ,
 132 disable informational messages from the rc scripts.
 133 Informational messages are displayed when
 134 a condition that is not serious enough to warrant a warning or
 135 an error occurs.
 136 .It Va rc_startmsgs
 137 .Pq Vt bool
 138 If set to
 139 .Dq Li YES ,
 140 show
 141 .Dq Starting foo:
 142 when faststart is used (e.g., at boot time).
 143 .It Va early_late_divider
 144 .Pq Vt str
 145 The name of the script that should be used as the
 146 delimiter between the
 147 .Dq early
 148 and
 149 .Dq late
 150 stages of the boot process.
 151 The early stage should contain all the services needed to
 152 get the disks (local or remote) mounted so that the late
 153 stage can include scripts contained in the directories
 154 listed in the
 155 .Va local_startup
 156 variable (see below).
 157 Thus, the two likely candidates for this value are
 158 .Pa mountcritlocal
 159 for the typical system, and
 160 .Pa mountcritremote
 161 if the system needs remote file
 162 systems mounted to get access to the
 163 .Va local_startup
 164 directories; for example when
 165 .Pa /usr/local
 166 is NFS mounted.
 167 For
 168 .Pa rc.conf
 169 within a
 170 .Xr jail 8
 171 .Pa NETWORKING
 172 is likely to be an appropriate value.
 173 Extreme care should be taken when changing this value,
 174 and before changing it one should ensure that there are
 175 adequate provisions to recover from a failed boot
 176 (such as physical contact with the machine,
 177 or reliable remote console access).
 178 .It Va always_force_depends
 179 .Pq Vt bool
 180 Various
 181 .Pa rc.d
 182 scripts use the force_depend function to check whether required
 183 services are already running, and to start them if necessary.
 184 By default during boot time this check is bypassed if the
 185 required service is enabled in
 186 .Pa /etc/rc.conf[.local] .
 187 Setting this option will bypass that check at boot time and
 188 always test whether or not the service is actually running.
 189 Enabling this option is likely to increase your boot time if
 190 services are enabled that utilize the force_depend check.
 191 .It Ao Ar name Ac Ns Va _chroot
 192 .Pq Vt str
 193 .Xr chroot 8
 194 to this directory before running the service.
 195 .It Ao Ar name Ac Ns Va _fib
 196 .Pq Vt int
 197 The
 198 .Xr setfib 1
 199 value to run the service under.
 200 .It Ao Ar name Ac Ns Va _group
 201 .Pq Vt str
 202 Run the chrooted service under this system group.
 203 Unlike the
 204 .Ao Ar name Ac Ns Va _user
 205 setting, this setting has no effect if the service is not chrooted.
 206 .It Ao Ar name Ac Ns Va _limits
 207 .Pq Vt str
 208 Resource limits to apply to the service using
 209 .Xr limits 1 .
 210 By default, resource limits are based on the login class defined in
 211 .Ao Ar name Ac Ns Va _login_class .
 212 .It Ao Ar name Ac Ns Va _login_class
 213 .Pq Vt str
 214 Login class to be used with
 215 .Ao Ar name Ac Ns Va _limits .
 216 Defaults to
 217 .Dq Li daemon .
 218 .It Ao Ar name Ac Ns Va _nice
 219 .Pq Vt int
 220 The
 221 .Xr nice 1
 222 value to run the service under.
 223 .It Ao Ar name Ac Ns Va _oomprotect
 224 Use
 225 .Xr protect 1
 226 to prevent the service from being killed when swap space
 227 is exhausted.
 228 Use
 229 .Dq Li YES
 230 to protect only the service itself, and
 231 .Dq Li ALL
 232 to protect the service and all child processes.
 233 .Pp
 234 Please note rc scripts that redefine
 235 .Bd -literal
 236 ${name}_cmd
 237 .Ed
 238 such as PostgreSQL will not inherit the OOM killer protection.
 239 .It Ao Ar name Ac Ns Va _user
 240 .Pq Vt str
 241 Run the service under this user account.
 242 .It Va apm_enable
 243 .Pq Vt bool
 244 If set to
 245 .Dq Li YES ,
 246 enable support for Automatic Power Management with
 247 the
 248 .Xr apm 8
 249 command.
 250 .It Va apmd_enable
 251 .Pq Vt bool
 252 Run
 253 .Xr apmd 8
 254 to handle APM event from userland.
 255 This also enables support for APM.
 256 .It Va apmd_flags
 257 .Pq Vt str
 258 If
 259 .Va apmd_enable
 260 is set to
 261 .Dq Li YES ,
 262 these are the flags to pass to the
 263 .Xr apmd 8
 264 daemon.
 265 .It Va devd_enable
 266 .Pq Vt bool
 267 Run
 268 .Xr devd 8
 269 to handle device added, removed or unknown events from the kernel.
 270 .It Va ddb_enable
 271 .Pq Vt bool
 272 Run
 273 .Xr ddb 8
 274 to install
 275 .Xr ddb 4
 276 scripts at boot time.
 277 .It Va ddb_config
 278 .Pq Vt str
 279 Configuration file for
 280 .Xr ddb 8 .
 281 Default
 282 .Pa /etc/ddb.conf .
 283 .It Va devmatch_enable
 284 .Pq Vt bool
 285 If set to
 286 .Dq Li NO ,
 287 disable auto-loading of kernel modules with
 288 .Xr devmatch 8 .
 289 .It Va devmatch_blocklist
 290 .Pq Vt str
 291 A whitespace-separated list of kernel modules to be ignored by
 292 .Xr devmatch 8 .
 293 In addition, the
 294 .Xr kenv 1
 295 .Va devmatch_blocklist
 296 is appended to this variable to allow disabling of
 297 .Xr devmatch 8
 298 loaded modules from the boot loader.
 299 .It Va devmatch_blacklist
 300 .Pq Vt str
 301 This variable is deprecated.
 302 Use
 303 .Va devmatch_blocklist
 304 instead.
 305 A whitespace-separated list of kernel modules to be ignored by
 306 .Xr devmatch 8 .
 307 .It Va kld_list
 308 .Pq Vt str
 309 A whitespace-separated list of kernel modules to load right after
 310 the local disks are mounted, without any
 311 .Pa .ko
 312 extension or path.
 313 Loading modules at this point in the boot process is
 314 much faster than doing it via
 315 .Pa /boot/loader.conf
 316 for those modules not necessary for mounting local disks.
 317 .It Va kldxref_enable
 318 .Pq Vt bool
 319 Set to
 320 .Dq Li NO
 321 by default.
 322 Set to
 323 .Dq Li YES
 324 to automatically rebuild
 325 .Pa linker.hints
 326 files with
 327 .Xr kldxref 8
 328 at boot time.
 329 .It Va kldxref_clobber
 330 .Pq Vt bool
 331 Set to
 332 .Dq Li NO
 333 by default.
 334 If
 335 .Va kldxref_enable
 336 is true,
 337 setting to
 338 .Dq Li YES
 339 will overwrite existing
 340 .Pa linker.hints
 341 files at boot time.
 342 Otherwise,
 343 only missing
 344 .Pa linker.hints
 345 files are generated.
 346 .It Va kldxref_module_path
 347 .Pq Vt str
 348 Empty by default.
 349 A semi-colon
 350 .Pq Ql \&;
 351 delimited list of paths containing
 352 .Xr kld 4
 353 modules.
 354 If empty,
 355 the contents of the
 356 .Va kern.module_path
 357 .Xr sysctl 8
 358 are used.
 359 .It Va powerd_enable
 360 .Pq Vt bool
 361 If set to
 362 .Dq Li YES ,
 363 enable the system power control facility with the
 364 .Xr powerd 8
 365 daemon.
 366 .It Va powerd_flags
 367 .Pq Vt str
 368 If
 369 .Va powerd_enable
 370 is set to
 371 .Dq Li YES ,
 372 these are the flags to pass to the
 373 .Xr powerd 8
 374 daemon.
 375 .It Va tmpmfs
 376 Controls the creation of a
 377 .Pa /tmp
 378 memory file system.
 379 Always happens if set to
 380 .Dq Li YES
 381 and never happens if set to
 382 .Dq Li NO .
 383 If set to anything else, a memory file system is created if
 384 .Pa /tmp
 385 is not writable.
 386 .It Va tmpsize
 387 Controls the size of a created
 388 .Pa /tmp
 389 memory file system.
 390 .It Va tmpmfs_flags
 391 Extra options passed to the
 392 .Xr mdmfs 8
 393 utility when the memory file system for
 394 .Pa /tmp
 395 is created.
 396 The default is
 397 .Dq Li "-S" ,
 398 which inhibits the use of softupdates on
 399 .Pa /tmp
 400 so that file system space is freed without delay
 401 after file truncation or deletion.
 402 See
 403 .Xr mdmfs 8
 404 for other options you can use in
 405 .Va tmpmfs_flags .
 406 .It Va varmfs
 407 Controls the creation of a
 408 .Pa /var
 409 memory file system.
 410 Always happens if set to
 411 .Dq Li YES
 412 and never happens if set to
 413 .Dq Li NO .
 414 If set to anything else, a memory file system is created if
 415 .Pa /var
 416 is not writable.
 417 .It Va varsize
 418 Controls the size of a created
 419 .Pa /var
 420 memory file system.
 421 .It Va varmfs_flags
 422 Extra options passed to the
 423 .Xr mdmfs 8
 424 utility when the memory file system for
 425 .Pa /var
 426 is created.
 427 The default is
 428 .Dq Li "-S" ,
 429 which inhibits the use of softupdates on
 430 .Pa /var
 431 so that file system space is freed without delay
 432 after file truncation or deletion.
 433 See
 434 .Xr mdmfs 8
 435 for other options you can use in
 436 .Va varmfs_flags .
 437 .It Va populate_var
 438 Controls the automatic population of the
 439 .Pa /var
 440 file system.
 441 Always happens if set to
 442 .Dq Li YES
 443 and never happens if set to
 444 .Dq Li NO .
 445 If set to anything else, a memory file system is created if
 446 .Pa /var
 447 is not writable.
 448 Note that this process requires access to certain commands in
 449 .Pa /usr
 450 before
 451 .Pa /usr
 452 is mounted on normal systems.
 453 .It Va cleanvar_enable
 454 .Pq Vt bool
 455 Clean the
 456 .Pa /var
 457 directory.
 458 .It Va local_startup
 459 .Pq Vt str
 460 List of directories to search for startup script files.
 461 .It Va script_name_sep
 462 .Pq Vt str
 463 The field separator to use for breaking down the list of startup script files
 464 into individual filenames.
 465 The default is a space.
 466 It is not necessary to change this unless there are startup scripts with names
 467 containing spaces.
 468 .It Va hostapd_enable
 469 .Pq Vt bool
 470 Set to
 471 .Dq Li YES
 472 to start
 473 .Xr hostapd 8
 474 at system boot time.
 475 .It Va hostname
 476 .Pq Vt str
 477 The fully qualified domain name (FQDN) of this host on the network.
 478 This should almost certainly be set to something meaningful, even if
 479 there is no network connection.
 480 If
 481 .Xr dhclient 8
 482 is used to set the hostname via DHCP,
 483 this variable should be set to an empty string.
 484 Within a
 485 .Xr jail 8
 486 the hostname is generally already set and this variable may be absent.
 487 If this value remains unset when the system is done booting
 488 your console login will display the default hostname of
 489 .Dq Amnesiac .
 490 .It Va nisdomainname
 491 .Pq Vt str
 492 The NIS domain name of this host, or
 493 .Dq Li NO
 494 if NIS is not used.
 495 .It Va dhclient_program
 496 .Pq Vt str
 497 Path to the DHCP client program
 498 .Pa ( /sbin/dhclient ,
 499 the
 500 .Ox
 501 DHCP client,
 502 is the default).
 503 .It Va dhclient_flags
 504 .Pq Vt str
 505 Additional flags to pass to the DHCP client program.
 506 For the
 507 .Ox
 508 DHCP client, see the
 509 .Xr dhclient 8
 510 manpage for a description of the command line options available.
 511 .It Va dhclient_flags_ Ns Aq Ar iface
 512 Additional flags to pass to the DHCP client program running on
 513 .Ar iface
 514 only.
 515 When specified, this variable overrides
 516 .Va dhclient_flags .
 517 .It Va background_dhclient
 518 .Pq Vt bool
 519 Set to
 520 .Dq Li YES
 521 to start the DHCP client in background.
 522 This can cause trouble with applications depending on
 523 a working network, but it will provide a faster startup
 524 in many cases.
 525 .It Va background_dhclient_ Ns Aq Ar iface
 526 When specified, this variable overrides the
 527 .Va background_dhclient
 528 variable for interface
 529 .Ar iface
 530 only.
 531 .It Va synchronous_dhclient
 532 .Pq Vt bool
 533 Set to
 534 .Dq Li YES
 535 to start
 536 .Xr dhclient 8
 537 synchronously at startup.
 538 This behavior can be overridden on a per-interface basis by replacing
 539 the
 540 .Dq Li DHCP
 541 keyword in the
 542 .Va ifconfig_ Ns Aq Ar interface
 543 variable with
 544 .Dq Li SYNCDHCP
 545 or
 546 .Dq Li NOSYNCDHCP .
 547 .It Va defaultroute_delay
 548 .Pq Vt int
 549 When set to a positive value, wait up to this long after configuring
 550 DHCP interfaces at startup to give the interfaces time to receive a lease.
 551 .It Va firewall_enable
 552 .Pq Vt bool
 553 Set to
 554 .Dq Li YES
 555 to load firewall rules at startup.
 556 If the kernel was not built with
 557 .Cd "options IPFIREWALL" ,
 558 the
 559 .Pa ipfw.ko
 560 kernel module will be loaded.
 561 See also
 562 .Va ipfilter_enable .
 563 .It Va firewall_script
 564 .Pq Vt str
 565 This variable specifies the full path to the firewall script to run.
 566 The default is
 567 .Pa /etc/rc.firewall .
 568 .It Va firewall_type
 569 .Pq Vt str
 570 Names the firewall type from the selection in
 571 .Pa /etc/rc.firewall ,
 572 or the file which contains the local firewall ruleset.
 573 Valid selections from
 574 .Pa /etc/rc.firewall
 575 are:
 576 .Pp
 577 .Bl -tag -width ".Li workstation" -compact
 578 .It Li open
 579 unrestricted IP access
 580 .It Li closed
 581 all IP services disabled, except via
 582 .Dq Li lo0
 583 .It Li client
 584 basic protection for a workstation
 585 .It Li workstation
 586 basic protection for a workstation using stateful firewalling
 587 .It Li simple
 588 basic protection for a LAN.
 589 .El
 590 .Pp
 591 If a filename is specified, the full path
 592 must be given.
 593 .Pp
 594 Most of the predefined rulesets define additional configuration variables.
 595 These are documented in
 596 .Pa /etc/rc.firewall .
 597 .It Va firewall_quiet
 598 .Pq Vt bool
 599 Set to
 600 .Dq Li YES
 601 to disable the display of firewall rules on the console during boot.
 602 .It Va firewall_logging
 603 .Pq Vt bool
 604 Set to
 605 .Dq Li YES
 606 to enable firewall event logging.
 607 This is equivalent to the
 608 .Dv IPFIREWALL_VERBOSE
 609 kernel option.
 610 .It Va firewall_logif
 611 .Pq Vt bool
 612 Set to
 613 .Dq Li YES
 614 to create pseudo interface
 615 .Li ipfw0
 616 for logging.
 617 For more details, see
 618 .Xr ipfw 8
 619 manual page.
 620 .It Va firewall_flags
 621 .Pq Vt str
 622 Flags passed to
 623 .Xr ipfw 8
 624 if
 625 .Va firewall_type
 626 specifies a filename.
 627 .It Va firewall_coscripts
 628 .Pq Vt str
 629 List of executables and/or rc scripts to run after firewall starts/stops.
 630 Default is empty.
 631 .\" ----- firewall_nat_enable setting --------------------------------
 632 .It Va firewall_nat_enable
 633 .Pq Vt bool
 634 The
 635 .Xr ipfw 8
 636 equivalent of
 637 .Va natd_enable .
 638 Setting this to
 639 .Dq Li YES
 640 will automatically load the
 641 .Xr ipfw 8
 642 NAT kernel module if
 643 .Va firewall_enable
 644 is also set to
 645 .Dq Li YES .
 646 .It Va firewall_nat_interface
 647 .Pq Vt str
 648 The
 649 .Xr ipfw 8
 650 equivalent of
 651 .Va natd_interface .
 652 This is the name of the public interface or IP address on which
 653 kernel NAT should run.
 654 .It Va firewall_nat_flags
 655 .Pq Vt str
 656 Additional configuration parameters for kernel NAT should be placed here.
 657 .It Va firewall_nat64_enable
 658 .Pq Vt bool
 659 Setting this to
 660 .Dq Li YES
 661 will automatically load the
 662 .Xr ipfw 8
 663 NAT64 kernel module if
 664 .Va firewall_enable
 665 is also set to
 666 .Dq Li YES .
 667 .It Va firewall_nptv6_enable
 668 .Pq Vt bool
 669 Setting this to
 670 .Dq Li YES
 671 will automatically load the
 672 .Xr ipfw 8
 673 NPTv6 kernel module if
 674 .Va firewall_enable
 675 is also set to
 676 .Dq Li YES .
 677 .It Va firewall_pmod_enable
 678 .Pq Vt bool
 679 Setting this to
 680 .Dq Li YES
 681 will automatically load the
 682 .Xr ipfw 8
 683 pmod kernel module if
 684 .Va firewall_enable
 685 is also set to
 686 .Dq Li YES .
 687 .It Va dummynet_enable
 688 .Pq Vt bool
 689 Setting this to
 690 .Dq Li YES
 691 will automatically load the
 692 .Xr dummynet 4
 693 module if
 694 .Va firewall_enable
 695 is also set to
 696 .Dq Li YES .
 697 .\" -------------------------------------------------------------------
 698 .It Va ipfw_netflow_enable
 699 .Pq Vt bool
 700 Setting this to
 701 .Dq Li YES
 702 will enable netflow logging via
 703 .Xr ng_netflow 4
 704 .Pp
 705 By default a ipfw rule is inserted and all packets are duplicated with
 706 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
 707 port using protocol version 5.
 708 .It Va ipfw_netflow_hook
 709 .Pq Vt int
 710 netflow hook name, must be numerical
 711 (default
 712 .Pa 9995 ) .
 713 .It Va ipfw_netflow_rule
 714 .Pq Vt int
 715 ipfw rule number
 716 (default
 717 .Pa 1000 ) .
 718 .It Va ipfw_netflow_ip
 719 .Pq Vt str
 720 Destination server ip for receiving netflow data
 721 (default
 722 .Pa 127.0.0.1 ) .
 723 .It Va ipfw_netflow_port
 724 .Pq Vt int
 725 Destination server port for receiving netflow data
 726 (default
 727 .Pa 9995 ) .
 728 .It Va ipfw_netflow_version
 729 .Pq Vt int
 730 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
 731 .It Va ipfw_netflow_fib
 732 .Pq Vt int
 733 Only match packet in FIB
 734 .Pa ipfw_netflow_fib
 735 (default is undefined meaning all FIBs).
 736 .It Va natd_program
 737 .Pq Vt str
 738 Path to
 739 .Xr natd 8 .
 740 .It Va natd_enable
 741 .Pq Vt bool
 742 Set to
 743 .Dq Li YES
 744 to enable
 745 .Xr natd 8 .
 746 .Va firewall_enable
 747 must also be set to
 748 .Dq Li YES ,
 749 and
 750 .Xr divert 4
 751 sockets must be enabled in the kernel.
 752 If the kernel was not built with
 753 .Cd "options IPDIVERT" ,
 754 the
 755 .Pa ipdivert.ko
 756 kernel module will be loaded.
 757 .It Va natd_interface
 758 .Pq Vt str
 759 This is the name of the public interface on which
 760 .Xr natd 8
 761 should run.
 762 The interface may be given as an interface name or as an IP address.
 763 .It Va natd_flags
 764 .Pq Vt str
 765 Additional
 766 .Xr natd 8
 767 flags should be placed here.
 768 The
 769 .Fl n
 770 or
 771 .Fl a
 772 flag is automatically added with the above
 773 .Va natd_interface
 774 as an argument.
 775 .\" ----- ipfilter_enable setting --------------------------------
 776 .It Va ipfilter_enable
 777 .Pq Vt bool
 778 Set to
 779 .Dq Li NO
 780 by default.
 781 Setting this to
 782 .Dq Li YES
 783 enables
 784 .Xr ipf 8
 785 packet filtering.
 786 .Pp
 787 Typical usage will require putting
 788 .Bd -literal
 789 ipfilter_enable="YES"
 790 ipnat_enable="YES"
 791 ipmon_enable="YES"
 792 ipfs_enable="YES"
 793 .Ed
 794 .Pp
 795 into
 796 .Pa /etc/rc.conf
 797 and editing
 798 .Pa /etc/ipf.rules
 799 and
 800 .Pa /etc/ipnat.rules
 801 appropriately.
 802 .Pp
 803 Note that
 804 .Va ipfilter_enable
 805 and
 806 .Va ipnat_enable
 807 can be enabled independently.
 808 .Va ipmon_enable
 809 and
 810 .Va ipfs_enable
 811 both require at least one of
 812 .Va ipfilter_enable
 813 and
 814 .Va ipnat_enable
 815 to be enabled.
 816 .Pp
 817 Having
 818 .Bd -literal
 819 options IPFILTER
 820 options IPFILTER_LOG
 821 options IPFILTER_DEFAULT_BLOCK
 822 .Ed
 823 .Pp
 824 in the kernel configuration file is a good idea, too.
 825 .\" ----- ipfilter_program setting ------------------------------
 826 .It Va ipfilter_program
 827 .Pq Vt str
 828 Path to
 829 .Xr ipf 8
 830 (default
 831 .Pa /sbin/ipf ) .
 832 .\" ----- ipfilter_rules setting --------------------------------
 833 .It Va ipfilter_rules
 834 .Pq Vt str
 835 Set to
 836 .Pa /etc/ipf.rules
 837 by default.
 838 This variable contains the name of the filter rule definition file.
 839 The file is expected to be readable for the
 840 .Xr ipf 8
 841 command to execute.
 842 .\" ----- ipfilter_flags setting --------------------------------
 843 .It Va ipfilter_flags
 844 .Pq Vt str
 845 Empty by default.
 846 This variable contains flags passed to the
 847 .Xr ipf 8
 848 program.
 849 .\" ----- ipnat_enable setting ----------------------------------
 850 .It Va ipnat_enable
 851 .Pq Vt bool
 852 Set to
 853 .Dq Li NO
 854 by default.
 855 Set it to
 856 .Dq Li YES
 857 to enable
 858 .Xr ipnat 8
 859 network address translation.
 860 See
 861 .Va ipfilter_enable
 862 for a detailed discussion.
 863 .\" ----- ipnat_program setting ---------------------------------
 864 .It Va ipnat_program
 865 .Pq Vt str
 866 Path to
 867 .Xr ipnat 8
 868 (default
 869 .Pa /sbin/ipnat ) .
 870 .\" ----- ipnat_rules setting -----------------------------------
 871 .It Va ipnat_rules
 872 .Pq Vt str
 873 Set to
 874 .Pa /etc/ipnat.rules
 875 by default.
 876 This variable contains the name of the file
 877 holding the network address translation definition.
 878 This file is expected to be readable for the
 879 .Xr ipnat 8
 880 command to execute.
 881 .\" ----- ipnat_flags setting -----------------------------------
 882 .It Va ipnat_flags
 883 .Pq Vt str
 884 Empty by default.
 885 This variable contains flags passed to the
 886 .Xr ipnat 8
 887 program.
 888 .\" ----- ipmon_enable setting ----------------------------------
 889 .It Va ipmon_enable
 890 .Pq Vt bool
 891 Set to
 892 .Dq Li NO
 893 by default.
 894 Set it to
 895 .Dq Li YES
 896 to enable
 897 .Xr ipmon 8
 898 monitoring (logging
 899 .Xr ipf 8
 900 and
 901 .Xr ipnat 8
 902 events).
 903 Setting this variable needs setting
 904 .Va ipfilter_enable
 905 or
 906 .Va ipnat_enable
 907 too.
 908 See
 909 .Va ipfilter_enable
 910 for a detailed discussion.
 911 .\" ----- ipmon_program setting ---------------------------------
 912 .It Va ipmon_program
 913 .Pq Vt str
 914 Path to
 915 .Xr ipmon 8
 916 (default
 917 .Pa /sbin/ipmon ) .
 918 .\" ----- ipmon_flags setting -----------------------------------
 919 .It Va ipmon_flags
 920 .Pq Vt str
 921 Set to
 922 .Dq Li -Ds
 923 by default.
 924 This variable contains flags passed to the
 925 .Xr ipmon 8
 926 program.
 927 Another typical example would be
 928 .Dq Fl D Pa /var/log/ipflog
 929 to have
 930 .Xr ipmon 8
 931 log directly to a file bypassing
 932 .Xr syslogd 8 .
 933 Make sure to adjust
 934 .Pa /etc/newsyslog.conf
 935 in such case like this:
 936 .Bd -literal
 937 /var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
 938 .Ed
 939 .\" ----- ipfs_enable setting -----------------------------------
 940 .It Va ipfs_enable
 941 .Pq Vt bool
 942 Set to
 943 .Dq Li NO
 944 by default.
 945 Set it to
 946 .Dq Li YES
 947 to enable
 948 .Xr ipfs 8
 949 saving the filter and NAT state tables during shutdown
 950 and reloading them during startup again.
 951 Setting this variable needs setting
 952 .Va ipfilter_enable
 953 or
 954 .Va ipnat_enable
 955 to
 956 .Dq Li YES
 957 too.
 958 See
 959 .Va ipfilter_enable
 960 for a detailed discussion.
 961 Note that if
 962 .Va kern_securelevel
 963 is set to 3,
 964 .Va ipfs_enable
 965 cannot be used
 966 because the raised securelevel will prevent
 967 .Xr ipfs 8
 968 from saving the state tables at shutdown time.
 969 .\" ----- ipfs_program setting ----------------------------------
 970 .It Va ipfs_program
 971 .Pq Vt str
 972 Path to
 973 .Xr ipfs 8
 974 (default
 975 .Pa /sbin/ipfs ) .
 976 .\" ----- ipfs_flags setting ------------------------------------
 977 .It Va ipfs_flags
 978 .Pq Vt str
 979 Empty by default.
 980 This variable contains flags passed to the
 981 .Xr ipfs 8
 982 program.
 983 .\" ----- end of added ipf hook ---------------------------------
 984 .It Va pf_enable
 985 .Pq Vt bool
 986 Set to
 987 .Dq Li NO
 988 by default.
 989 Setting this to
 990 .Dq Li YES
 991 enables
 992 .Xr pf 4
 993 packet filtering.
 994 .Pp
 995 Typical usage will require putting
 996 .Pp
 997 .Dl pf_enable="YES"
 998 .Pp
 999 into
1000 .Pa /etc/rc.conf
1001 and editing
1002 .Pa /etc/pf.conf
1003 appropriately.
1004 Adding
1005 .Pp
1006 .Dl "device pf"
1007 .Pp
1008 builds support for
1009 .Xr pf 4
1010 into the kernel, otherwise the
1011 kernel module will be loaded.
1012 .It Va pf_rules
1013 .Pq Vt str
1014 Path to
1015 .Xr pf 4
1016 ruleset configuration file
1017 (default
1018 .Pa /etc/pf.conf ) .
1019 .It Va pf_program
1020 .Pq Vt str
1021 Path to
1022 .Xr pfctl 8
1023 (default
1024 .Pa /sbin/pfctl ) .
1025 .It Va pf_flags
1026 .Pq Vt str
1027 If
1028 .Va pf_enable
1029 is set to
1030 .Dq Li YES ,
1031 these flags are passed to the
1032 .Xr pfctl 8
1033 program when loading the ruleset.
1034 .It Va pf_fallback_rules_enable
1035 .Pq Vt bool
1036 Set to
1037 .Dq Li NO
1038 by default.
1039 Setting this to
1040 .Dq Li YES
1041 enables loading
1042 .Va pf_fallback_rules_file
1043 or
1044 .Va pf_fallback_rules
1045 in case of a problem when loading the ruleset in
1046 .Va pf_rules .
1047 .It Va pf_fallback_rules_file
1048 .Pq Vt str
1049 Path to a pf ruleset to load in case of failure when loading the
1050 ruleset in
1051 .Va pf_rules
1052 (default
1053 .Pa /etc/pf-fallback.conf ) .
1054 .It Va pf_fallback_rules
1055 .Pq Vt str
1056 A pf ruleset to load in case of failure when loading the ruleset in
1057 .Va pf_rules
1058 and
1059 .Va pf_fallback_rules_file
1060 is not found.
1061 Multiple rules can be set as follows:
1062 .Bd -literal
1063 pf_fallback_rules="\\
1064         block drop log all\\
1065         pass in quick on em0"
1066 .Pp
1067 .Ed
1068 The default fallback rule is
1069 .Dq block drop log all
1070 .It Va pflog_enable
1071 .Pq Vt bool
1072 Set to
1073 .Dq Li NO
1074 by default.
1075 Setting this to
1076 .Dq Li YES
1077 enables
1078 .Xr pflogd 8
1079 which logs packets from the
1080 .Xr pf 4
1081 packet filter.
1082 .It Va pflog_logfile
1083 .Pq Vt str
1084 If
1085 .Va pflog_enable
1086 is set to
1087 .Dq Li YES
1088 this controls where
1089 .Xr pflogd 8
1090 stores the logfile
1091 (default
1092 .Pa /var/log/pflog ) .
1093 Check
1094 .Pa /etc/newsyslog.conf
1095 to adjust logfile rotation for this.
1096 .It Va pflog_program
1097 .Pq Vt str
1098 Path to
1099 .Xr pflogd 8
1100 (default
1101 .Pa /sbin/pflogd ) .
1102 .It Va pflog_flags
1103 .Pq Vt str
1104 Empty by default.
1105 This variable contains additional flags passed to the
1106 .Xr pflogd 8
1107 program.
1108 .It Va pflog_instances
1109 .Pq Vt str
1110 If logging to more than one
1111 .Xr pflog 4
1112 interface is desired,
1113 .Va pflog_instances
1114 is set to the list of
1115 .Xr pflogd 8
1116 instances that should be started at system boot time.
1117 If
1118 .Va pflog_instances
1119 is set, for each whitespace-separated
1120 .Ar element
1121 in the list,
1122 .Ao Ar element Ac Ns Va _dev
1123 and
1124 .Ao Ar element Ac Ns Va _logfile
1125 elements are assumed to exist.
1126 .Ao Ar element Ac Ns Va _dev
1127 must contain the
1128 .Xr pflog 4
1129 interface to be watched by the named
1130 .Xr pflogd 8
1131 instance.
1132 .Ao Ar element Ac Ns Va _logfile
1133 must contain the name of the logfile that will be used by the
1134 .Xr pflogd 8
1135 instance.
1136 .It Va ftpproxy_enable
1137 .Pq Vt bool
1138 Set to
1139 .Dq Li NO
1140 by default.
1141 Setting this to
1142 .Dq Li YES
1143 enables
1144 .Xr ftp-proxy 8
1145 which supports the
1146 .Xr pf 4
1147 packet filter in translating ftp connections.
1148 .It Va ftpproxy_flags
1149 .Pq Vt str
1150 Empty by default.
1151 This variable contains additional flags passed to the
1152 .Xr ftp-proxy 8
1153 program.
1154 .It Va ftpproxy_instances
1155 .Pq Vt str
1156 Empty by default.
1157 If multiple instances of
1158 .Xr ftp-proxy 8
1159 are desired at boot time,
1160 .Va ftpproxy_instances
1161 should contain a whitespace-separated list of instance names.
1162 For each
1163 .Ar element
1164 in the list, a variable named
1165 .Ao Ar element Ac Ns Va _flags
1166 should be defined, containing the command-line flags to be passed to the
1167 .Xr ftp-proxy 8
1168 instance.
1169 .It Va pfsync_enable
1170 .Pq Vt bool
1171 Set to
1172 .Dq Li NO
1173 by default.
1174 Setting this to
1175 .Dq Li YES
1176 enables exposing
1177 .Xr pf 4
1178 state changes to other hosts over the network by means of
1179 .Xr pfsync 4 .
1180 The
1181 .Va pfsync_syncdev
1182 variable
1183 must also be set then.
1184 .It Va pfsync_syncdev
1185 .Pq Vt str
1186 Empty by default.
1187 This variable specifies the name of the network interface
1188 .Xr pfsync 4
1189 should operate through.
1190 It must be set accordingly if
1191 .Va pfsync_enable
1192 is set to
1193 .Dq Li YES .
1194 .It Va pfsync_syncpeer
1195 .Pq Vt str
1196 Empty by default.
1197 This variable is optional.
1198 By default, state change messages are sent out on the synchronisation
1199 interface using IP multicast packets.
1200 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1201 224.0.0.240.
1202 When a peer address is specified using the
1203 .Va pfsync_syncpeer
1204 option, the peer address is used as a destination for the pfsync
1205 traffic, and the traffic can then be protected using
1206 .Xr ipsec 4 .
1207 See the
1208 .Xr pfsync 4
1209 manpage for more details about using
1210 .Xr ipsec 4
1211 with
1212 .Xr pfsync 4
1213 interfaces.
1214 .It Va pfsync_ifconfig
1215 .Pq Vt str
1216 Empty by default.
1217 This variable can contain additional options to be passed to the
1218 .Xr ifconfig 8
1219 command used to set up
1220 .Xr pfsync 4 .
1221 .It Va tcp_extensions
1222 .Pq Vt bool
1223 Set to
1224 .Dq Li YES
1225 by default.
1226 Setting this to
1227 .Dq Li NO
1228 disables certain TCP options as described by
1229 .Rs
1230 .%T "RFC 1323"
1231 .Re
1232 Setting this to
1233 .Dq Li NO
1234 might help remedy such problems with connections as randomly hanging
1235 or other weird behavior.
1236 Some network devices are known
1237 to be broken with respect to these options.
1238 .It Va log_in_vain
1239 .Pq Vt int
1240 Set to 0 by default.
1241 The
1242 .Xr sysctl 8
1243 variables,
1244 .Va net.inet.tcp.log_in_vain
1245 and
1246 .Va net.inet.udp.log_in_vain ,
1247 as described in
1248 .Xr tcp 4
1249 and
1250 .Xr udp 4 ,
1251 are set to the given value.
1252 .It Va tcp_keepalive
1253 .Pq Vt bool
1254 Set to
1255 .Dq Li YES
1256 by default.
1257 Setting to
1258 .Dq Li NO
1259 will disable probing idle TCP connections to verify that the
1260 peer is still up and reachable.
1261 .It Va tcp_drop_synfin
1262 .Pq Vt bool
1263 Set to
1264 .Dq Li NO
1265 by default.
1266 Setting to
1267 .Dq Li YES
1268 will cause the kernel to ignore TCP frames that have both
1269 the SYN and FIN flags set.
1270 This prevents OS fingerprinting, but may
1271 break some legitimate applications.
1272 .It Va icmp_drop_redirect
1273 .Pq Vt bool
1274 Set to
1275 .Dq Li AUTO
1276 by default.
1277 This setting will be identical to
1278 .Dq Li YES ,
1279 if a dynamicrouting daemon is enabled, because redirect processing may
1280 cause performance issues for large routing tables.
1281 If no such service is enabled, this setting behaves like a
1282 .Dq Li NO .
1283 Setting to
1284 .Dq Li YES
1285 will cause the kernel to ignore ICMP REDIRECT packets.
1286 Setting to
1287 .Dq Li NO
1288 will cause the kernel to process ICMP REDIRECT packets.
1289 Refer to
1290 .Xr icmp 4
1291 for more information.
1292 .It Va icmp_log_redirect
1293 .Pq Vt bool
1294 Set to
1295 .Dq Li NO
1296 by default.
1297 Setting to
1298 .Dq Li YES
1299 will cause the kernel to log ICMP REDIRECT packets.
1300 Note that
1301 the log messages are not rate-limited, so this option should only be used
1302 for troubleshooting networks.
1303 Refer to
1304 .Xr icmp 4
1305 for more information.
1306 .It Va icmp_bmcastecho
1307 .Pq Vt bool
1308 Set to
1309 .Dq Li YES
1310 to respond to broadcast or multicast ICMP ping packets.
1311 Refer to
1312 .Xr icmp 4
1313 for more information.
1314 .It Va ip_portrange_first
1315 .Pq Vt int
1316 If not set to
1317 .Dq Li NO ,
1318 this is the first port in the default portrange.
1319 Refer to
1320 .Xr ip 4
1321 for more information.
1322 .It Va ip_portrange_last
1323 .Pq Vt int
1324 If not set to
1325 .Dq Li NO ,
1326 this is the last port in the default portrange.
1327 Refer to
1328 .Xr ip 4
1329 for more information.
1330 .It Va network_interfaces
1331 .Pq Vt str
1332 Set to the list of network interfaces to configure on this host or
1333 .Dq Li AUTO
1334 (the default) for all current interfaces.
1335 Setting the
1336 .Va network_interfaces
1337 variable to anything other than the default is deprecated.
1338 Interfaces that the administrator wishes to store configuration for,
1339 but not start at boot should be configured with the
1340 .Dq Li NOAUTO
1341 keyword in their
1342 .Va ifconfig_ Ns Aq Ar interface
1343 variables as described below.
1344 .Pp
1345 An
1346 .Va ifconfig_ Ns Aq Ar interface
1347 variable is also assumed to exist for each value of
1348 .Ar interface .
1349 When an interface name contains any of the characters
1350 .Dq Li .-/+
1351 they are translated to
1352 .Dq Li _
1353 before lookup.
1354 The variable can contain arguments to
1355 .Xr ifconfig 8 ,
1356 as well as special case-insensitive keywords described below.
1357 Such keywords are removed before passing the value to
1358 .Xr ifconfig 8
1359 while the order of the other arguments is preserved.
1360 .Pp
1361 It is possible to add IP alias entries using
1362 .Xr ifconfig 8
1363 syntax with the address family keyword such as
1364 .Li inet .
1365 Assuming that the interface in question was
1366 .Li em0 ,
1367 it might look something like this:
1368 .Bd -literal
1369 ifconfig_em0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1370 ifconfig_em0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1371 .Ed
1372 .Pp
1373 It also possible to configure multiple IP addresses in Classless
1374 Inter-Domain Routing
1375 .Pq CIDR
1376 address notation,
1377 whose each address component can be a range like
1378 .Li inet 192.0.2.5-23/24
1379 or
1380 .Li inet6 2001:db8:1-f::1/64 .
1381 This notation allows address and prefix length part only,
1382 not the other address modifiers.
1383 Note that the maximum number of the generated addresses from a range
1384 specification is limited to an integer value specified in
1385 .Va netif_ipexpand_max
1386 in
1387 .Nm
1388 because a small typo can unexpectedly generate a large number of addresses.
1389 The default value is
1390 .Li 2048 .
1391 It can be increased by adding the following line into
1392 .Nm :
1393 .Bd -literal
1394 netif_ipexpand_max="4096"
1395 .Ed
1396 .Pp
1397 In the case of
1398 .Li 192.0.2.5-23/24 ,
1399 the address 192.0.2.5 will be configured with the
1400 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1401 the non-conflicting netmask /32 as explained in the
1402 .Xr ifconfig 8
1403 alias section.
1404 Note that this special netmask handling is only for
1405 .Li inet ,
1406 not for the other address families such as
1407 .Li inet6 .
1408 .Pp
1409 With the interface in question being
1410 .Li em0 ,
1411 an example could look like:
1412 .Bd -literal
1413 ifconfig_em0_alias2="inet 192.0.2.129/27"
1414 ifconfig_em0_alias3="inet 192.0.2.1-5/28"
1415 .Ed
1416 .Pp
1417 and so on.
1418 .Pp
1419 Note that deprecated
1420 .Va ipv4_addrs_ Ns Aq Ar interface
1421 variable was supported for IPv4 CIDR address notation.
1422 The
1423 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1424 variable replaces it, though
1425 .Va ipv4_addrs_ Ns Aq Ar interface
1426 is still supported for backward compatibility.
1427 .Pp
1428 For each
1429 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1430 entry with an address family keyword,
1431 its contents are passed to
1432 .Xr ifconfig 8 .
1433 Execution stops at the first unsuccessful access, so if
1434 something like this is present:
1435 .Bd -literal
1436 ifconfig_em0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1437 ifconfig_em0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1438 ifconfig_em0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1439 ifconfig_em0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1440 .Ed
1441 .Pp
1442 Then note that alias4 would
1443 .Em not
1444 be added since the search would
1445 stop with the missing
1446 .Dq Li alias3
1447 entry.
1448 Because of this difficult to manage behavior,
1449 there is
1450 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1451 variable, which has the same functionality as
1452 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1453 and can have all of entries in a variable like the following:
1454 .Bd -literal
1455 ifconfig_em0_aliases="\\
1456         inet 127.0.0.251 netmask 0xffffffff \\
1457         inet 127.0.0.252 netmask 0xffffffff \\
1458         inet 127.0.0.253 netmask 0xffffffff \\
1459         inet 127.0.0.254 netmask 0xffffffff"
1460 .Ed
1461 .Pp
1462 It also supports CIDR notation.
1463 .Pp
1464 If the
1465 .Pa /etc/start_if . Ns Aq Ar interface
1466 file is present, it is read and executed by the
1467 .Xr sh 1
1468 interpreter
1469 before configuring the interface as specified in the
1470 .Va ifconfig_ Ns Aq Ar interface
1471 and
1472 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1473 variables.
1474 .Pp
1475 If a
1476 .Va vlans_ Ns Aq Ar interface
1477 variable is set,
1478 a
1479 .Xr vlan 4
1480 interface will be created for each item in the list with the
1481 .Ar vlandev
1482 argument set to
1483 .Ar interface .
1484 If a vlan interface's name is a number,
1485 then that number is used as the vlan tag and the new vlan interface is
1486 named
1487 .Ar interface . Ns Ar tag .
1488 Otherwise,
1489 the vlan tag must be specified via a
1490 .Va vlan
1491 parameter in the
1492 .Va create_args_ Ns Aq Ar interface
1493 variable.
1494 .Pp
1495 To create a vlan device named
1496 .Li em0.101
1497 on
1498 .Li em0
1499 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1500 .Bd -literal
1501 vlans_em0="101"
1502 ifconfig_em0_101="inet 192.0.2.1/24"
1503 .Ed
1504 .Pp
1505 To create a vlan device named
1506 .Li myvlan
1507 on
1508 .Li em0
1509 with the vlan tag 102:
1510 .Bd -literal
1511 vlans_em0="myvlan"
1512 create_args_myvlan="vlan 102"
1513 .Ed
1514 .Pp
1515 If a
1516 .Va wlans_ Ns Aq Ar interface
1517 variable is set,
1518 an
1519 .Xr wlan 4
1520 interface will be created for each item in the list with the
1521 .Ar wlandev
1522 argument set to
1523 .Ar interface .
1524 Further wlan cloning arguments may be passed to the
1525 .Xr ifconfig 8
1526 .Cm create
1527 command by setting the
1528 .Va create_args_ Ns Aq Ar interface
1529 variable.
1530 One or more
1531 .Xr wlan 4
1532 devices must be created for each wireless devices as of
1533 .Fx 8.0 .
1534 Debugging flags for
1535 .Xr wlan 4
1536 devices as set by
1537 .Xr wlandebug 8
1538 may be specified with an
1539 .Va wlandebug_ Ns Aq Ar interface
1540 variable.
1541 The contents of this variable will be passed directly to
1542 .Xr wlandebug 8 .
1543 .Pp
1544 If the
1545 .Va ifconfig_ Ns Aq Ar interface
1546 contains the keyword
1547 .Dq Li NOAUTO
1548 then the interface will not be configured
1549 at boot or by
1550 .Pa /etc/pccard_ether
1551 when
1552 .Va network_interfaces
1553 is set to
1554 .Dq Li AUTO .
1555 .Pp
1556 It is possible to bring up an interface with DHCP by adding
1557 .Dq Li DHCP
1558 to the
1559 .Va ifconfig_ Ns Aq Ar interface
1560 variable.
1561 For instance, to initialize the
1562 .Li em0
1563 device via DHCP,
1564 it is possible to use something like:
1565 .Bd -literal
1566 ifconfig_em0="DHCP"
1567 .Ed
1568 .Pp
1569 If you want to configure your wireless interface with
1570 .Xr wpa_supplicant 8
1571 for use with WPA, EAP/LEAP or WEP, you need to add
1572 .Dq Li WPA
1573 to the
1574 .Va ifconfig_ Ns Aq Ar interface
1575 variable.
1576 .Pp
1577 On the other hand, if you want to configure your wireless interface with
1578 .Xr hostapd 8 ,
1579 you need to add
1580 .Dq Li HOSTAP
1581 to the
1582 .Va ifconfig_ Ns Aq Ar interface
1583 variable.
1584 .Xr hostapd 8
1585 will use the settings from
1586 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1587 .Pp
1588 Finally, you can add
1589 .Xr ifconfig 8
1590 options in this variable, in addition to the
1591 .Pa /etc/start_if . Ns Aq Ar interface
1592 file.
1593 For instance, to configure an
1594 .Xr ath 4
1595 wireless device in station mode with an address obtained
1596 via DHCP, using WPA authentication and 802.11b mode, it is
1597 possible to use something like:
1598 .Bd -literal
1599 wlans_ath0="wlan0"
1600 ifconfig_wlan0="DHCP WPA mode 11b"
1601 .Ed
1602 .Pp
1603 In addition to the
1604 .Va ifconfig_ Ns Aq Ar interface
1605 form, a fallback variable
1606 .Va ifconfig_DEFAULT
1607 may be configured.
1608 It will be used for all interfaces with no
1609 .Va ifconfig_ Ns Aq Ar interface
1610 variable.
1611 This is intended to replace the no longer supported
1612 .Va pccard_ifconfig
1613 variable.
1614 .Pp
1615 It is also possible to rename an interface by doing:
1616 .Bd -literal
1617 ifconfig_em0_name="net0"
1618 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1619 .Ed
1620 .It Va ipv6_enable
1621 .Pq Vt bool
1622 This variable is deprecated.
1623 Use
1624 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1625 and
1626 .Va ipv6_activate_all_interfaces
1627 if necessary.
1628 .Pp
1629 If the variable is
1630 .Dq Li YES ,
1631 .Dq Li inet6 accept_rtadv
1632 is added to all of
1633 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1634 and the
1635 .Va ipv6_activate_all_interfaces
1636 is defined as
1637 .Dq Li YES .
1638 .It Va ipv6_prefer
1639 .Pq Vt bool
1640 This variable is deprecated.
1641 Use
1642 .Va ip6addrctl_policy
1643 instead.
1644 .Pp
1645 If the variable is
1646 .Dq Li YES ,
1647 the default address selection policy table set by
1648 .Xr ip6addrctl 8
1649 will be IPv6-preferred.
1650 .Pp
1651 If the variable is
1652 .Dq Li NO ,
1653 the default address selection policy table set by
1654 .Xr ip6addrctl 8
1655 will be IPv4-preferred.
1656 .It Va ipv6_activate_all_interfaces
1657 .Pq Vt bool
1658 This controls initial configuration on IPv6-capable
1659 interfaces with no corresponding
1660 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1661 variable.
1662 Note that it is not always necessary to set this variable to
1663 .Dq YES
1664 to use IPv6 functionality on
1665 .Fx .
1666 In most cases, just configuring
1667 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1668 variables works.
1669 .Pp
1670 If the variable is
1671 .Dq Li NO ,
1672 all interfaces which do not have a corresponding
1673 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1674 variable will be marked as
1675 .Dq Li IFDISABLED
1676 at creation.
1677 This means that all of IPv6 functionality on that interface
1678 is completely disabled to enforce a security policy.
1679 If the variable is set to
1680 .Dq YES ,
1681 the flag will be cleared on all of the interfaces.
1682 .Pp
1683 In most cases, just defining an
1684 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1685 for an IPv6-capable interface should be sufficient.
1686 However, if an interface is added dynamically
1687 .Pq by some tunneling protocols such as PPP, for example ,
1688 it is often difficult to define the variable in advance.
1689 In such a case, configuring the
1690 .Dq Li IFDISABLED
1691 flag can be disabled by setting this variable to
1692 .Dq YES .
1693 .Pp
1694 For more details of the
1695 .Dq Li IFDISABLED
1696 flag and keywords
1697 .Dq Li inet6 ifdisabled ,
1698 see
1699 .Xr ifconfig 8 .
1700 .Pp
1701 Default is
1702 .Dq Li NO .
1703 .It Va ipv6_privacy
1704 .Pq Vt bool
1705 If the variable is
1706 .Dq Li YES
1707 privacy addresses will be generated for each IPv6
1708 interface as described in RFC 4941.
1709 .It Va ipv6_network_interfaces
1710 .Pq Vt str
1711 This is the IPv6 equivalent of
1712 .Va network_interfaces .
1713 Normally manual configuration of this variable is not needed.
1714 .It Va ipv6_cpe_wanif
1715 .Pq Vt str
1716 If the variable is set to an interface name,
1717 the
1718 .Xr ifconfig 8
1719 options
1720 .Dq inet6 -no_radr accept_rtadv
1721 will be added to the specified interface automatically before evaluating
1722 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1723 and two
1724 .Xr sysctl 8
1725 variables
1726 .Va net.inet6.ip6.rfc6204w3
1727 and
1728 .Va net.inet6.ip6.no_radr
1729 will be set to 1.
1730 .Pp
1731 This means the specified interface will accept ICMPv6 Router
1732 Advertisement messages on that link and add the discovered
1733 routers into the Default Router List.
1734 While the other interfaces can still accept RA messages if the
1735 .Dq inet6 accept_rtadv
1736 option is specified, adding
1737 routes into the Default Router List will be disabled by
1738 .Dq inet6 no_radr
1739 option by default.
1740 See
1741 .Xr ifconfig 8
1742 for more details.
1743 .Pp
1744 Note that ICMPv6 Router Advertisement messages will be
1745 accepted even when
1746 .Va net.inet6.ip6.forwarding
1747 is 1
1748 .Pq packet forwarding is enabled
1749 when
1750 .Va net.inet6.ip6.rfc6204w3
1751 is set to 1.
1752 .Pp
1753 Default is
1754 .Dq Li NO .
1755 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _descr
1756 .Pq Vt str
1757 This assigns arbitrary description to an interface.
1758 The
1759 .Xr sysctl 8
1760 variable
1761 .Va net.ifdescr_maxlen
1762 limits its length.
1763 This static setting may be overridden by commands
1764 started with dynamic interface configuration utilities
1765 like
1766 .Xr dhclient 8
1767 hooks.
1768 The description can be seen with
1769 .Xr ifconfig 8
1770 command and it may be exported with
1771 .Xr bsnmpd 1
1772 daemon using its MIB-2 module.
1773 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1774 .Pq Vt str
1775 IPv6 functionality on an interface should be configured by
1776 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1777 instead of setting ifconfig parameters in
1778 .Va ifconfig_ Ns Aq Ar interface .
1779 If this variable is empty, all of IPv6 configurations on the
1780 specified interface by other variables such as
1781 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1782 will be ignored.
1783 .Pp
1784 Aliases should be set by
1785 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1786 with
1787 .Dq Li inet6
1788 keyword.
1789 For example:
1790 .Bd -literal
1791 ifconfig_em0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1792 ifconfig_em0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1793 .Ed
1794 .Pp
1795 Interfaces that have an
1796 .Dq Li inet6 accept_rtadv
1797 keyword in
1798 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1799 setting will be automatically configured by SLAAC
1800 .Pq StateLess Address AutoConfiguration
1801 described in
1802 .Rs
1803 .%T "RFC 4862"
1804 .Re
1805 .Pp
1806 Note that a link-local address will be automatically configured in
1807 addition to the configured global-scope addresses because the IPv6
1808 specifications require it on each link.
1809 The address is calculated from the MAC address by using an algorithm
1810 defined in
1811 .Rs
1812 .%T "RFC 4862"
1813 .%O "Section 5.3"
1814 .Re
1815 .Pp
1816 If only a link-local address is needed on the interface,
1817 the following configuration can be used:
1818 .Bd -literal
1819 ifconfig_em0_ipv6="inet6 auto_linklocal"
1820 .Ed
1821 .Pp
1822 A link-local address can also be configured manually.
1823 This is useful for the default router address of an IPv6 router
1824 so that it does not change when the network interface
1825 card is replaced.
1826 For example:
1827 .Bd -literal
1828 ifconfig_em0_ipv6="inet6 fe80::1 prefixlen 64"
1829 .Ed
1830 .It Va ipv6_prefix_ Ns Aq Ar interface
1831 .Pq Vt str
1832 If one or more prefixes are defined in
1833 .Va ipv6_prefix_ Ns Aq Ar interface
1834 addresses based on each prefix and the EUI-64 interface index will be
1835 configured on that interface.
1836 Note that this variable will be ignored when
1837 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1838 is empty.
1839 .Pp
1840 For example, the following configuration
1841 .Bd -literal
1842 ipv6_prefix_em0="2001:db8:1:0 2001:db8:2:0"
1843 .Ed
1844 .Pp
1845 is equivalent to the following:
1846 .Bd -literal
1847 ifconfig_em0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1848 ifconfig_em0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1849 ifconfig_em0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1850 ifconfig_em0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1851 .Ed
1852 .Pp
1853 These Subnet-Router anycast addresses will be added only when
1854 .Va ipv6_gateway_enable
1855 is YES.
1856 .It Va ipv6_default_interface
1857 .Pq Vt str
1858 If not set to
1859 .Dq Li NO ,
1860 this is the default output interface for scoped addresses.
1861 This works only with ipv6_gateway_enable="NO".
1862 .It Va ip6addrctl_enable
1863 .Pq Vt bool
1864 This variable is to enable configuring default address selection policy table
1865 .Pq RFC 3484 .
1866 The table can be specified in another variable
1867 .Va ip6addrctl_policy .
1868 For
1869 .Va ip6addrctl_policy
1870 the following keywords can be specified:
1871 .Dq Li ipv4_prefer ,
1872 .Dq Li ipv6_prefer ,
1873 or
1874 .Dq Li AUTO .
1875 .Pp
1876 If
1877 .Dq Li ipv4_prefer
1878 or
1879 .Dq Li ipv6_prefer
1880 is specified,
1881 .Xr ip6addrctl 8
1882 installs a pre-defined policy table described in Section 10.3
1883 .Pq IPv4-preferred
1884 or 2.1
1885 .Pq IPv6-preferred
1886 of RFC 3484.
1887 .Pp
1888 If
1889 .Dq Li AUTO
1890 is specified, it attempts to read a file
1891 .Pa /etc/ip6addrctl.conf
1892 first.
1893 If this file is found,
1894 .Xr ip6addrctl 8
1895 reads and installs it.
1896 If not found, a policy is automatically set
1897 according to
1898 .Va ipv6_activate_all_interfaces
1899 variable; if the variable is set to
1900 .Dq Li YES
1901 the IPv6-preferred one is used.
1902 Otherwise IPv4-preferred.
1903 .Pp
1904 The default value of
1905 .Va ip6addrctl_enable
1906 and
1907 .Va ip6addrctl_policy
1908 are
1909 .Dq Li YES
1910 and
1911 .Dq Li AUTO ,
1912 respectively.
1913 .It Va cloned_interfaces
1914 .Pq Vt str
1915 Set to the list of clonable network interfaces to create on this host.
1916 Further cloning arguments may be passed to the
1917 .Xr ifconfig 8
1918 .Cm create
1919 command for each interface by setting the
1920 .Va create_args_ Ns Aq Ar interface
1921 variable.
1922 If an interface name is specified with
1923 .Dq :sticky
1924 keyword,
1925 the interface will not be destroyed even when
1926 .Pa rc.d/netif
1927 script is invoked with
1928 .Dq stop
1929 argument.
1930 This is useful when reconfiguring the interface without destroying it.
1931 Entries in
1932 .Va cloned_interfaces
1933 are automatically appended to
1934 .Va network_interfaces
1935 for configuration.
1936 .It Va cloned_interfaces_sticky
1937 .Pq Vt bool
1938 This variable is to globally enable functionality of
1939 .Dq :sticky
1940 keyword in
1941 .Va cloned_interfaces
1942 for all interfaces.
1943 The default value is
1944 .Dq NO .
1945 Even if this variable is specified to
1946 .Dq YES ,
1947 .Dq :nosticky
1948 keyword can be used to override it on per interface basis.
1949 .It Va gif_interfaces
1950 Set to the list of
1951 .Xr gif 4
1952 tunnel interfaces to configure on this host.
1953 A
1954 .Va gifconfig_ Ns Aq Ar interface
1955 variable is assumed to exist for each value of
1956 .Ar interface .
1957 The value of this variable is used to configure the link layer of the
1958 tunnel using the
1959 .Cm tunnel
1960 option to
1961 .Xr ifconfig 8 .
1962 Additionally, this option ensures that each listed interface is created
1963 via the
1964 .Cm create
1965 option to
1966 .Xr ifconfig 8
1967 before attempting to configure it.
1968 .Pp
1969 For example, configure two
1970 .Xr gif 4
1971 interfaces with:
1972 .Bd -literal
1973 gif_interfaces="gif0 gif1"
1974 gifconfig_gif0="100.64.0.1 100.64.0.2"
1975 ifconfig_gif0="inet 10.0.0.1 10.0.0.2 netmask 255.255.255.252"
1976 gifconfig_gif1="inet6 2a00::1 2a01::1"
1977 ifconfig_gif1="inet 10.1.0.1 10.1.0.2 netmask 255.255.255.252"
1978 .Ed
1979 .It Va ppp_enable
1980 .Pq Vt bool
1981 If set to
1982 .Dq Li YES ,
1983 run the
1984 .Xr ppp 8
1985 daemon.
1986 .It Va ppp_profile
1987 .Pq Vt str
1988 The name of the profile to use from
1989 .Pa /etc/ppp/ppp.conf .
1990 Also used for per-profile overrides of
1991 .Va ppp_mode
1992 and
1993 .Va ppp_nat ,
1994 and
1995 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1996 When the profile name contains any of the characters
1997 .Dq Li .-/+
1998 they are translated to
1999 .Dq Li _
2000 for the proposes of the override variable names.
2001 .It Va ppp_mode
2002 .Pq Vt str
2003 Mode in which to run the
2004 .Xr ppp 8
2005 daemon.
2006 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
2007 .Pq Vt str
2008 Overrides the global
2009 .Va ppp_mode
2010 for
2011 .Ar profile .
2012 Accepted modes are
2013 .Dq Li auto ,
2014 .Dq Li ddial ,
2015 .Dq Li direct
2016 and
2017 .Dq Li dedicated .
2018 See the manual for a full description.
2019 .It Va ppp_nat
2020 .Pq Vt bool
2021 If set to
2022 .Dq Li YES ,
2023 enables network address translation.
2024 Used in conjunction with
2025 .Va gateway_enable
2026 allows hosts on private network addresses access to the Internet using
2027 this host as a network address translating router.
2028 Default is
2029 .Dq Li YES .
2030 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
2031 .Pq Vt str
2032 Overrides the global
2033 .Va ppp_nat
2034 for
2035 .Ar profile .
2036 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
2037 .Pq Vt int
2038 Set the unit number to be used for this profile.
2039 See the manual description of
2040 .Fl unit Ns Ar N
2041 for details.
2042 .It Va ppp_user
2043 .Pq Vt str
2044 The name of the user under which
2045 .Xr ppp 8
2046 should be started.
2047 By
2048 default,
2049 .Xr ppp 8
2050 is started as
2051 .Dq Li root .
2052 .It Va rc_conf_files
2053 .Pq Vt str
2054 This option is used to specify a list of files that will override
2055 the settings in
2056 .Pa /etc/defaults/rc.conf .
2057 The files will be read in the order in which they are specified and should
2058 include the full path to the file.
2059 By default, the files specified are
2060 .Pa /etc/rc.conf
2061 and
2062 .Pa /etc/rc.conf.local
2063 .It Va zfs_enable
2064 .Pq Vt bool
2065 If set to
2066 .Dq Li YES ,
2067 .Pa /etc/rc.d/zfs
2068 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
2069 (ZVOLs).
2070 .It Va gptboot_enable
2071 .Pq Vt bool
2072 If set to
2073 .Dq Li YES ,
2074 .Pa /etc/rc.d/gptboot
2075 will log if the system successfully (or not) booted from a GPT partition,
2076 which had the
2077 .Ar bootonce
2078 attribute set using
2079 .Xr gpart 8
2080 utility.
2081 .It Va gbde_autoattach_all
2082 .Pq Vt bool
2083 If set to
2084 .Dq Li YES ,
2085 .Pa /etc/rc.d/gbde
2086 will attempt to automatically initialize your .bde devices in
2087 .Pa /etc/fstab .
2088 .It Va gbde_devices
2089 .Pq Vt str
2090 List the devices that the script should try to attach,
2091 or
2092 .Dq Li AUTO .
2093 .It Va gbde_lockdir
2094 .Pq Vt str
2095 The directory where the
2096 .Xr gbde 4
2097 lockfiles are located.
2098 The default lockfile directory is
2099 .Pa /etc .
2100 .Pp
2101 The lockfile for each individual
2102 .Xr gbde 4
2103 device can be overridden by setting the variable
2104 .Va gbde_lock_ Ns Aq Ar device ,
2105 where
2106 .Ar device
2107 is the encrypted device without the
2108 .Dq Pa /dev/
2109 and
2110 .Dq Pa .bde
2111 parts.
2112 .It Va gbde_attach_attempts
2113 .Pq Vt int
2114 Number of times to attempt attaching to a
2115 .Xr gbde 4
2116 device, i.e., how many times the user is asked for the pass-phrase.
2117 Default is 3.
2118 .It Va geli_devices
2119 .Pq Vt str
2120 List of devices to automatically attach on boot.
2121 Note that .eli devices from
2122 .Pa /etc/fstab
2123 are automatically appended to this list.
2124 .It Va geli_groups
2125 .Pq Vt str
2126 List of groups containing devices to automatically attach on boot with the same
2127 keyfiles and passphrase.
2128 This must be accompanied with a corresponding
2129 .Va geli_ Ns Ao Ar group Ac Ns Va _devices
2130 variable.
2131 .It Va geli_tries
2132 .Pq Vt int
2133 Number of times user is asked for the pass-phrase.
2134 If empty, it will be taken from
2135 .Va kern.geom.eli.tries
2136 sysctl variable.
2137 .It Va geli_default_flags
2138 .Pq Vt str
2139 Default flags to use by
2140 .Xr geli 8
2141 when configuring disk encryption.
2142 Flags can be configured for every device separately by defining the
2143 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
2144 variable, and for every group separately by defining the
2145 .Va geli_ Ns Ao Ar group Ac Ns Va _flags
2146 variable.
2147 .It Va geli_autodetach
2148 .Pq Vt str
2149 Specifies if GELI devices should be marked for detach on last close after
2150 file systems are mounted.
2151 Default is
2152 .Dq Li YES .
2153 This can be changed for every device separately by defining the
2154 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
2155 variable.
2156 .It Va root_rw_mount
2157 .Pq Vt bool
2158 Set to
2159 .Dq Li YES
2160 by default.
2161 After the file systems are checked at boot time, the root file system
2162 is remounted as read-write if this is set to
2163 .Dq Li YES .
2164 Diskless systems that mount their root file system from a read-only remote
2165 NFS share should set this to
2166 .Dq Li NO
2167 in their
2168 .Pa rc.conf .
2169 .It Va fsck_y_enable
2170 .Pq Vt bool
2171 If set to
2172 .Dq Li YES ,
2173 .Xr fsck 8
2174 will be run with the
2175 .Fl y
2176 flag if the initial preen
2177 of the file systems fails.
2178 .It Va background_fsck
2179 .Pq Vt bool
2180 If set to
2181 .Dq Li NO ,
2182 the system will not attempt to run
2183 .Xr fsck 8
2184 in the background where possible.
2185 .It Va background_fsck_delay
2186 .Pq Vt int
2187 The amount of time in seconds to sleep before starting a background
2188 .Xr fsck 8 .
2189 It defaults to sixty seconds to allow large applications such as
2190 the X server to start before disk I/O bandwidth is monopolized by
2191 .Xr fsck 8 .
2192 If set to a negative number, the background file system check will be
2193 delayed indefinitely to allow the administrator to run it at a more
2194 convenient time.
2195 For example it may be run from
2196 .Xr cron 8
2197 by adding a line like
2198 .Pp
2199 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2200 .Pp
2201 to
2202 .Pa /etc/crontab .
2203 .It Va netfs_types
2204 .Pq Vt str
2205 List of file system types that are network-based.
2206 This list should generally not be modified by end users.
2207 Use
2208 .Va extra_netfs_types
2209 instead.
2210 .It Va extra_netfs_types
2211 .Pq Vt str
2212 If set to something other than
2213 .Dq Li NO
2214 (the default),
2215 this variable extends the list of file system types
2216 for which automatic mounting at startup by
2217 .Xr rc 8
2218 should be delayed until the network is initialized.
2219 It should contain
2220 a whitespace-separated list of network file system descriptor pairs,
2221 each consisting of a file system type as passed to
2222 .Xr mount 8
2223 and a human-readable, one-word description,
2224 joined with a colon
2225 .Pq Ql \&: .
2226 Extending the default list in this way is only necessary
2227 when third party file system types are used.
2228 .It Va syslogd_enable
2229 .Pq Vt bool
2230 If set to
2231 .Dq Li YES ,
2232 run the
2233 .Xr syslogd 8
2234 daemon.
2235 .It Va syslogd_program
2236 .Pq Vt str
2237 Path to
2238 .Xr syslogd 8
2239 (default
2240 .Pa /usr/sbin/syslogd ) .
2241 .It Va syslogd_flags
2242 .Pq Vt str
2243 If
2244 .Va syslogd_enable
2245 is set to
2246 .Dq Li YES ,
2247 these are the flags to pass to
2248 .Xr syslogd 8 .
2249 .It Va inetd_enable
2250 .Pq Vt bool
2251 If set to
2252 .Dq Li YES ,
2253 run the
2254 .Xr inetd 8
2255 daemon.
2256 .It Va inetd_program
2257 .Pq Vt str
2258 Path to
2259 .Xr inetd 8
2260 (default
2261 .Pa /usr/sbin/inetd ) .
2262 .It Va inetd_flags
2263 .Pq Vt str
2264 If
2265 .Va inetd_enable
2266 is set to
2267 .Dq Li YES ,
2268 these are the flags to pass to
2269 .Xr inetd 8 .
2270 .It Va hastd_enable
2271 .Pq Vt bool
2272 If set to
2273 .Dq Li YES ,
2274 run the
2275 .Xr hastd 8
2276 daemon.
2277 .It Va hastd_program
2278 .Pq Vt str
2279 Path to
2280 .Xr hastd 8
2281 (default
2282 .Pa /sbin/hastd ) .
2283 .It Va hastd_flags
2284 .Pq Vt str
2285 If
2286 .Va hastd_enable
2287 is set to
2288 .Dq Li YES ,
2289 these are the flags to pass to
2290 .Xr hastd 8 .
2291 .It Va local_unbound_enable
2292 .Pq Vt bool
2293 If set to
2294 .Dq Li YES ,
2295 run the
2296 .Xr unbound 8
2297 daemon as a local caching resolver.
2298 .It Va kdc_enable
2299 .Pq Vt bool
2300 Set to
2301 .Dq Li YES
2302 to start a Kerberos 5 authentication server
2303 at boot time.
2304 .It Va kdc_program
2305 .Pq Vt str
2306 If
2307 .Va kdc_enable
2308 is set to
2309 .Dq Li YES
2310 this is the path to Kerberos 5 Authentication Server.
2311 .It Va kdc_flags
2312 .Pq Vt str
2313 Empty by default.
2314 This variable contains additional flags to be passed to the Kerberos 5
2315 authentication server.
2316 .It Va kadmind_enable
2317 .Pq Vt bool
2318 Set to
2319 .Dq Li YES
2320 to start
2321 .Xr kadmind 8 ,
2322 the Kerberos 5 Administration Daemon; set to
2323 .Dq Li NO
2324 on a slave server.
2325 .It Va kadmind_program
2326 .Pq Vt str
2327 If
2328 .Va kadmind_enable
2329 is set to
2330 .Dq Li YES
2331 this is the path to Kerberos 5 Administration Daemon.
2332 .It Va kpasswdd_enable
2333 .Pq Vt bool
2334 Set to
2335 .Dq Li YES
2336 to start
2337 .Xr kpasswdd 8 ,
2338 the Kerberos 5 Password-Changing Daemon; set to
2339 .Dq Li NO
2340 on a slave server.
2341 .It Va kpasswdd_program
2342 .Pq Vt str
2343 If
2344 .Va kpasswdd_enable
2345 is set to
2346 .Dq Li YES
2347 this is the path to Kerberos 5 Password-Changing Daemon.
2348 .It Va kfd_enable
2349 .Pq Vt bool
2350 Set to
2351 .Dq Li YES
2352 to start
2353 .Xr kfd 8 ,
2354 the Kerberos 5 ticket forwarding daemon, at the boot time.
2355 .It Va kfd_program
2356 .Pq Vt str
2357 Path to
2358 .Xr kfd 8
2359 (default
2360 .Pa /usr/libexec/kfd ) .
2361 .It Va rwhod_enable
2362 .Pq Vt bool
2363 If set to
2364 .Dq Li YES ,
2365 run the
2366 .Xr rwhod 8
2367 daemon at boot time.
2368 .It Va rwhod_flags
2369 .Pq Vt str
2370 If
2371 .Va rwhod_enable
2372 is set to
2373 .Dq Li YES ,
2374 these are the flags to pass to it.
2375 .It Va update_motd
2376 .Pq Vt bool
2377 If set to
2378 .Dq Li YES ,
2379 .Pa /etc/motd
2380 will be updated at boot time to reflect the kernel release
2381 being run.
2382 If set to
2383 .Dq Li NO ,
2384 .Pa /etc/motd
2385 will not be updated.
2386 .It Va nfs_client_enable
2387 .Pq Vt bool
2388 If set to
2389 .Dq Li YES ,
2390 run the NFS client daemons at boot time.
2391 .It Va nfs_access_cache
2392 .Pq Vt int
2393 If
2394 .Va nfs_client_enable
2395 is set to
2396 .Dq Li YES ,
2397 this can be set to
2398 .Dq Li 0
2399 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2400 NFS ACCESS
2401 results should be cached.
2402 A value of 2-10 seconds will substantially reduce network
2403 traffic for many NFS operations.
2404 .It Va nfs_server_enable
2405 .Pq Vt bool
2406 If set to
2407 .Dq Li YES ,
2408 run the NFS server daemons at boot time.
2409 .It Va nfs_server_flags
2410 .Pq Vt str
2411 If
2412 .Va nfs_server_enable
2413 is set to
2414 .Dq Li YES ,
2415 these are the flags to pass to the
2416 .Xr nfsd 8
2417 daemon.
2418 .It Va nfsv4_server_enable
2419 .Pq Vt bool
2420 If
2421 .Va nfs_server_enable
2422 is set to
2423 .Dq Li YES
2424 and
2425 .Va nfsv4_server_enable
2426 is set to
2427 .Dq Li YES ,
2428 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2429 .It Va nfsv4_server_only
2430 .Pq Vt bool
2431 If
2432 .Va nfs_server_enable
2433 is set to
2434 .Dq Li YES
2435 and
2436 .Va nfsv4_server_only
2437 is set to
2438 .Dq Li YES ,
2439 enable the NFS server for NFSv4 only.
2440 .It Va nfs_server_maxio
2441 .Pq Vt int
2442 value to set vfs.nfsd.srvmaxio to, which is the
2443 maximum I/O size for the NFS server.
2444 .It Va tlsclntd_enable
2445 .Pq Vt bool
2446 If set to
2447 .Dq Li YES ,
2448 run the
2449 .Xr rpc.tlsclntd 8
2450 daemon, which is needed for NFS-over-TLS NFS mounts.
2451 .It Va tlsservd_enable
2452 .Pq Vt bool
2453 If set to
2454 .Dq Li YES ,
2455 run the
2456 .Xr rpc.tlsservd 8
2457 daemon, which is needed for the
2458 .Xr nfsd 8
2459 to support NFS-over-TLS NFS mounts.
2460 .It Va nfsuserd_enable
2461 .Pq Vt bool
2462 If
2463 .Va nfsuserd_enable
2464 is set to
2465 .Dq Li YES ,
2466 run the nfsuserd daemon, which is needed for NFSv4 in order
2467 to map between user/group names vs uid/gid numbers.
2468 If
2469 .Va nfsv4_server_enable
2470 is set to
2471 .Dq Li YES ,
2472 this will be forced enabled.
2473 .It Va nfsuserd_flags
2474 .Pq Vt str
2475 If
2476 .Va nfsuserd_enable
2477 is set to
2478 .Dq Li YES ,
2479 these are the flags to pass to the
2480 .Xr nfsuserd 8
2481 daemon.
2482 .It Va nfscbd_enable
2483 .Pq Vt bool
2484 If
2485 .Va nfscbd_enable
2486 is set to
2487 .Dq Li YES ,
2488 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2489 .It Va nfscbd_flags
2490 .Pq Vt str
2491 If
2492 .Va nfscbd_enable
2493 is set to
2494 .Dq Li YES ,
2495 these are the flags to pass to the
2496 .Xr nfscbd 8
2497 daemon.
2498 .It Va mountd_enable
2499 .Pq Vt bool
2500 If set to
2501 .Dq Li YES ,
2502 and no
2503 .Va nfs_server_enable
2504 is set, start
2505 .Xr mountd 8 ,
2506 but not
2507 .Xr nfsd 8
2508 daemon.
2509 It is commonly needed to run CFS without real NFS used.
2510 .It Va mountd_flags
2511 .Pq Vt str
2512 If
2513 .Va mountd_enable
2514 is set to
2515 .Dq Li YES ,
2516 these are the flags to pass to the
2517 .Xr mountd 8
2518 daemon.
2519 .It Va weak_mountd_authentication
2520 .Pq Vt bool
2521 If set to
2522 .Dq Li YES ,
2523 allow services like PCNFSD to make non-privileged mount
2524 requests.
2525 .It Va nfs_reserved_port_only
2526 .Pq Vt bool
2527 If set to
2528 .Dq Li YES ,
2529 provide NFS services only on a secure port.
2530 .It Va nfs_bufpackets
2531 .Pq Vt int
2532 If set to a number, indicates the number of packets worth of
2533 socket buffer space to reserve on an NFS client.
2534 The kernel default is typically 4.
2535 Using a higher number may be
2536 useful on gigabit networks to improve performance.
2537 The minimum value is
2538 2 and the maximum is 64.
2539 .It Va rpc_lockd_enable
2540 .Pq Vt bool
2541 If set to
2542 .Dq Li YES
2543 and also an NFS server or client, run
2544 .Xr rpc.lockd 8
2545 at boot time.
2546 .It Va rpc_lockd_flags
2547 .Pq Vt str
2548 If
2549 .Va rpc_lockd_enable
2550 is set to
2551 .Dq Li YES ,
2552 these are the flags to pass to the
2553 .Xr rpc.lockd 8
2554 daemon.
2555 .It Va rpc_statd_enable
2556 .Pq Vt bool
2557 If set to
2558 .Dq Li YES
2559 and also an NFS server or client, run
2560 .Xr rpc.statd 8
2561 at boot time.
2562 .It Va rpc_statd_flags
2563 .Pq Vt str
2564 If
2565 .Va rpc_statd_enable
2566 is set to
2567 .Dq Li YES ,
2568 these are the flags to pass to the
2569 .Xr rpc.statd 8
2570 daemon.
2571 .It Va rpcbind_program
2572 .Pq Vt str
2573 Path to
2574 .Xr rpcbind 8
2575 (default
2576 .Pa /usr/sbin/rpcbind ) .
2577 .It Va rpcbind_enable
2578 .Pq Vt bool
2579 If set to
2580 .Dq Li YES ,
2581 run the
2582 .Xr rpcbind 8
2583 service at boot time.
2584 .It Va rpcbind_flags
2585 .Pq Vt str
2586 If
2587 .Va rpcbind_enable
2588 is set to
2589 .Dq Li YES ,
2590 these are the flags to pass to the
2591 .Xr rpcbind 8
2592 daemon.
2593 .It Va keyserv_enable
2594 .Pq Vt bool
2595 If set to
2596 .Dq Li YES ,
2597 run the
2598 .Xr keyserv 8
2599 daemon on boot for running Secure RPC.
2600 .It Va keyserv_flags
2601 .Pq Vt str
2602 If
2603 .Va keyserv_enable
2604 is set to
2605 .Dq Li YES ,
2606 these are the flags to pass to
2607 .Xr keyserv 8
2608 daemon.
2609 .It Va pppoed_enable
2610 .Pq Vt bool
2611 If set to
2612 .Dq Li YES ,
2613 run the
2614 .Xr pppoed 8
2615 daemon at boot time to provide PPP over Ethernet services.
2616 .It Va pppoed_ Ns Aq Ar provider
2617 .Pq Vt str
2618 .Xr pppoed 8
2619 listens to requests to this
2620 .Ar provider
2621 and ultimately runs
2622 .Xr ppp 8
2623 with a
2624 .Ar system
2625 argument of the same name.
2626 .It Va pppoed_flags
2627 .Pq Vt str
2628 Additional flags to pass to
2629 .Xr pppoed 8 .
2630 .It Va pppoed_interface
2631 .Pq Vt str
2632 The network interface to run
2633 .Xr pppoed 8
2634 on.
2635 This is mandatory when
2636 .Va pppoed_enable
2637 is set to
2638 .Dq Li YES .
2639 .It Va ntpdate_enable
2640 .Pq Vt bool
2641 If set to
2642 .Dq Li YES ,
2643 run
2644 .Xr ntpdate 8
2645 at system startup.
2646 This command is intended to
2647 synchronize the system clock only
2648 .Em once
2649 from some standard reference.
2650 .Pp
2651 Note that the use of the
2652 .Va ntpd_sync_on_start
2653 variable is a preferred alternative to the
2654 .Xr ntpdate 8
2655 utility as
2656 .Xr ntpdate 8
2657 is to be retired from the NTP distribution.
2658 .It Va ntpdate_config
2659 .Pq Vt str
2660 Configuration file for
2661 .Xr ntpdate 8 .
2662 Default
2663 .Pa /etc/ntp.conf .
2664 .It Va ntpdate_hosts
2665 .Pq Vt str
2666 A whitespace-separated list of NTP servers to synchronize with at startup.
2667 The default is to use the servers listed in
2668 .Va ntpdate_config ,
2669 if that file exists.
2670 .It Va ntpdate_program
2671 .Pq Vt str
2672 Path to
2673 .Xr ntpdate 8
2674 (default
2675 .Pa /usr/sbin/ntpdate ) .
2676 .It Va ntpdate_flags
2677 .Pq Vt str
2678 If
2679 .Va ntpdate_enable
2680 is set to
2681 .Dq Li YES ,
2682 these are the flags to pass to the
2683 .Xr ntpdate 8
2684 command (typically a hostname).
2685 .It Va ntpd_enable
2686 .Pq Vt bool
2687 If set to
2688 .Dq Li YES ,
2689 run the
2690 .Xr ntpd 8
2691 command at boot time.
2692 .It Va ntpd_program
2693 .Pq Vt str
2694 Path to
2695 .Xr ntpd 8
2696 (default
2697 .Pa /usr/sbin/ntpd ) .
2698 .It Va ntpd_config
2699 .Pq Vt str
2700 Path to
2701 .Xr ntpd 8
2702 configuration file.
2703 Default
2704 .Pa /etc/ntp.conf .
2705 .It Va ntpd_flags
2706 .Pq Vt str
2707 If
2708 .Va ntpd_enable
2709 is set to
2710 .Dq Li YES ,
2711 these are the flags to pass to the
2712 .Xr ntpd 8
2713 daemon.
2714 .It Va ntpd_sync_on_start
2715 .Pq Vt bool
2716 If set to
2717 .Dq Li YES ,
2718 .Xr ntpd 8
2719 is run with the
2720 .Fl g
2721 flag, which syncs the system's clock on startup.
2722 See
2723 .Xr ntpd 8
2724 for more information regarding the
2725 .Fl g
2726 option.
2727 This is a preferred alternative to using
2728 .Xr ntpdate 8
2729 or specifying the
2730 .Va ntpdate_enable
2731 variable.
2732 .It Va nis_client_enable
2733 .Pq Vt bool
2734 If set to
2735 .Dq Li YES ,
2736 run the
2737 .Xr ypbind 8
2738 service at system boot time.
2739 .It Va nis_client_flags
2740 .Pq Vt str
2741 If
2742 .Va nis_client_enable
2743 is set to
2744 .Dq Li YES ,
2745 these are the flags to pass to the
2746 .Xr ypbind 8
2747 service.
2748 .It Va nis_ypldap_enable
2749 .Pq Vt bool
2750 If set to
2751 .Dq Li YES ,
2752 run the
2753 .Xr ypldap 8
2754 daemon at system boot time.
2755 .It Va nis_ypldap_flags
2756 .Pq Vt str
2757 If
2758 .Va nis.ypldap_enable
2759 is set to
2760 .Dq Li YES ,
2761 these are the flags to pass to the
2762 .Xr ypldap 8
2763 daemon.
2764 .It Va nis_ypset_enable
2765 .Pq Vt bool
2766 If set to
2767 .Dq Li YES ,
2768 run the
2769 .Xr ypset 8
2770 daemon at system boot time.
2771 .It Va nis_ypset_flags
2772 .Pq Vt str
2773 If
2774 .Va nis_ypset_enable
2775 is set to
2776 .Dq Li YES ,
2777 these are the flags to pass to the
2778 .Xr ypset 8
2779 daemon.
2780 .It Va nis_server_enable
2781 .Pq Vt bool
2782 If set to
2783 .Dq Li YES ,
2784 run the
2785 .Xr ypserv 8
2786 daemon at system boot time.
2787 .It Va nis_server_flags
2788 .Pq Vt str
2789 If
2790 .Va nis_server_enable
2791 is set to
2792 .Dq Li YES ,
2793 these are the flags to pass to the
2794 .Xr ypserv 8
2795 daemon.
2796 .It Va nis_ypxfrd_enable
2797 .Pq Vt bool
2798 If set to
2799 .Dq Li YES ,
2800 run the
2801 .Xr rpc.ypxfrd 8
2802 daemon at system boot time.
2803 .It Va nis_ypxfrd_flags
2804 .Pq Vt str
2805 If
2806 .Va nis_ypxfrd_enable
2807 is set to
2808 .Dq Li YES ,
2809 these are the flags to pass to the
2810 .Xr rpc.ypxfrd 8
2811 daemon.
2812 .It Va nis_yppasswdd_enable
2813 .Pq Vt bool
2814 If set to
2815 .Dq Li YES ,
2816 run the
2817 .Xr rpc.yppasswdd 8
2818 daemon at system boot time.
2819 .It Va nis_yppasswdd_flags
2820 .Pq Vt str
2821 If
2822 .Va nis_yppasswdd_enable
2823 is set to
2824 .Dq Li YES ,
2825 these are the flags to pass to the
2826 .Xr rpc.yppasswdd 8
2827 daemon.
2828 .It Va rpc_ypupdated_enable
2829 .Pq Vt bool
2830 If set to
2831 .Dq Li YES ,
2832 run the
2833 .Nm rpc.ypupdated
2834 daemon at system boot time.
2835 .It Va bsnmpd_enable
2836 .Pq Vt bool
2837 If set to
2838 .Dq Li YES ,
2839 run the
2840 .Xr bsnmpd 1
2841 daemon at system boot time.
2842 Be sure to understand the security implications of running SNMP daemon
2843 on your host.
2844 .It Va bsnmpd_flags
2845 .Pq Vt str
2846 If
2847 .Va bsnmpd_enable
2848 is set to
2849 .Dq Li YES ,
2850 these are the flags to pass to the
2851 .Xr bsnmpd 1
2852 daemon.
2853 .It Va defaultrouter
2854 .Pq Vt str
2855 If not set to
2856 .Dq Li NO ,
2857 create a default route to this host name or IP address
2858 (use an IP address if this router is also required to get to the
2859 name server!).
2860 .It Va defaultrouter_fibN
2861 .Pq Vt str
2862 If not set to
2863 .Dq Li NO ,
2864 create a default route in FIB N to this host name or IP address.
2865 .It Va ipv6_defaultrouter
2866 .Pq Vt str
2867 The IPv6 equivalent of
2868 .Va defaultrouter .
2869 .It Va ipv6_defaultrouter_fibN
2870 .Pq Vt str
2871 The IPv6 equivalent of
2872 .Va defaultrouter_fibN .
2873 .It Va static_arp_pairs
2874 .Pq Vt str
2875 Set to the list of static ARP pairs that are to be added at system
2876 boot time.
2877 For each whitespace separated
2878 .Ar element
2879 in the value, a
2880 .Va static_arp_ Ns Aq Ar element
2881 variable is assumed to exist whose contents will later be passed to a
2882 .Dq Nm arp Cm -S
2883 operation.
2884 For example
2885 .Bd -literal
2886 static_arp_pairs="gw"
2887 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2888 .Ed
2889 .It Va static_ndp_pairs
2890 .Pq Vt str
2891 Set to the list of static NDP pairs that are to be added at system
2892 boot time.
2893 For each whitespace separated
2894 .Ar element
2895 in the value, a
2896 .Va static_ndp_ Ns Aq Ar element
2897 variable is assumed to exist whose contents will later be passed to a
2898 .Dq Nm ndp Cm -s
2899 operation.
2900 For example
2901 .Bd -literal
2902 static_ndp_pairs="gw"
2903 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2904 .Ed
2905 .It Va static_routes
2906 .Pq Vt str
2907 Set to the list of static routes that are to be added at system
2908 boot time.
2909 If not set to
2910 .Dq Li NO
2911 then for each whitespace separated
2912 .Ar element
2913 in the value, a
2914 .Va route_ Ns Aq Ar element
2915 variable is assumed to exist
2916 whose contents will later be passed to a
2917 .Dq Nm route Cm add
2918 operation.
2919 For example:
2920 .Bd -literal
2921 static_routes="ext mcast:gif0 gif0local:gif0"
2922 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2923 route_mcast="-net 224.0.0.0/4 -iface gif0"
2924 route_gif0local="-host 169.254.1.1 -iface lo0"
2925 .Ed
2926 .Pp
2927 When an
2928 .Ar element
2929 is in the form of
2930 .Li name:ifname ,
2931 the route is specific to the interface
2932 .Li ifname .
2933 .It Va ipv6_static_routes
2934 .Pq Vt str
2935 The IPv6 equivalent of
2936 .Va static_routes .
2937 If not set to
2938 .Dq Li NO
2939 then for each whitespace separated
2940 .Ar element
2941 in the value, a
2942 .Va ipv6_route_ Ns Aq Ar element
2943 variable is assumed to exist
2944 whose contents will later be passed to a
2945 .Dq Nm route Cm add Fl inet6
2946 operation.
2947 .It Va gateway_enable
2948 .Pq Vt bool
2949 If set to
2950 .Dq Li YES ,
2951 configure host to act as an IP router, e.g.\& to forward packets
2952 between interfaces.
2953 .It Va ipv6_gateway_enable
2954 .Pq Vt bool
2955 The IPv6 equivalent of
2956 .Va gateway_enable .
2957 .It Va routed_enable
2958 .Pq Vt bool
2959 If set to
2960 .Dq Li YES ,
2961 run a routing daemon of some sort, based on the
2962 settings of
2963 .Va routed_program
2964 and
2965 .Va routed_flags .
2966 .It Va route6d_enable
2967 .Pq Vt bool
2968 The IPv6 equivalent of
2969 .Va routed_enable .
2970 If set to
2971 .Dq Li YES ,
2972 run a routing daemon of some sort, based on the
2973 settings of
2974 .Va route6d_program
2975 and
2976 .Va route6d_flags .
2977 .It Va routed_program
2978 .Pq Vt str
2979 If
2980 .Va routed_enable
2981 is set to
2982 .Dq Li YES ,
2983 this is the name of the routing daemon to use.
2984 .It Va route6d_program
2985 .Pq Vt str
2986 The IPv6 equivalent of
2987 .Va routed_program .
2988 .It Va routed_flags
2989 .Pq Vt str
2990 If
2991 .Va routed_enable
2992 is set to
2993 .Dq Li YES ,
2994 these are the flags to pass to the routing daemon.
2995 .It Va route6d_flags
2996 .Pq Vt str
2997 The IPv6 equivalent of
2998 .Va routed_flags .
2999 .It Va rtadvd_enable
3000 .Pq Vt bool
3001 If set to
3002 .Dq Li YES ,
3003 run the
3004 .Xr rtadvd 8
3005 daemon at boot time.
3006 The
3007 .Xr rtadvd 8
3008 utility sends ICMPv6 Router Advertisement messages to
3009 the interfaces specified in
3010 .Va rtadvd_interfaces .
3011 This should only be enabled with great care.
3012 You may want to fine-tune
3013 .Xr rtadvd.conf 5 .
3014 .It Va rtadvd_interfaces
3015 .Pq Vt str
3016 If
3017 .Va rtadvd_enable
3018 is set to
3019 .Dq Li YES
3020 this is the list of interfaces to use.
3021 .It Va arpproxy_all
3022 .Pq Vt bool
3023 If set to
3024 .Dq Li YES ,
3025 enable global proxy ARP.
3026 .It Va forward_sourceroute
3027 .Pq Vt bool
3028 If set to
3029 .Dq Li YES
3030 and
3031 .Va gateway_enable
3032 is also set to
3033 .Dq Li YES ,
3034 source-routed packets are forwarded.
3035 .It Va accept_sourceroute
3036 .Pq Vt bool
3037 If set to
3038 .Dq Li YES ,
3039 the system will accept source-routed packets directed at it.
3040 .It Va rarpd_enable
3041 .Pq Vt bool
3042 If set to
3043 .Dq Li YES ,
3044 run the
3045 .Xr rarpd 8
3046 daemon at system boot time.
3047 .It Va rarpd_flags
3048 .Pq Vt str
3049 If
3050 .Va rarpd_enable
3051 is set to
3052 .Dq Li YES ,
3053 these are the flags to pass to the
3054 .Xr rarpd 8
3055 daemon.
3056 .It Va bootparamd_enable
3057 .Pq Vt bool
3058 If set to
3059 .Dq Li YES ,
3060 run the
3061 .Xr bootparamd 8
3062 daemon at system boot time.
3063 .It Va bootparamd_flags
3064 .Pq Vt str
3065 If
3066 .Va bootparamd_enable
3067 is set to
3068 .Dq Li YES ,
3069 these are the flags to pass to the
3070 .Xr bootparamd 8
3071 daemon.
3072 .It Va stf_interface_ipv4addr
3073 .Pq Vt str
3074 If not set to
3075 .Dq Li NO ,
3076 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
3077 interface).
3078 Specify this entry to enable the 6to4 interface.
3079 .It Va stf_interface_ipv4plen
3080 .Pq Vt int
3081 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
3082 An effective value is 0-31.
3083 .It Va stf_interface_ipv6_ifid
3084 .Pq Vt str
3085 IPv6 interface ID for
3086 .Xr stf 4 .
3087 This can be set to
3088 .Dq Li AUTO .
3089 .It Va stf_interface_ipv6_slaid
3090 .Pq Vt str
3091 IPv6 Site Level Aggregator for
3092 .Xr stf 4 .
3093 .It Va ipv6_ipv4mapping
3094 .Pq Vt bool
3095 If set to
3096 .Dq Li YES
3097 this enables IPv4 mapped IPv6 address communication (like
3098 .Li ::ffff:a.b.c.d ) .
3099 .It Va rtsold_enable
3100 .Pq Vt bool
3101 Set to
3102 .Dq Li YES
3103 to enable the
3104 .Xr rtsold 8
3105 daemon to send ICMPv6 Router Solicitation messages.
3106 .It Va rtsold_flags
3107 .Pq Vt str
3108 If
3109 .Va rtsold_enable
3110 is set to
3111 .Dq Li YES ,
3112 these are the flags to pass to
3113 .Xr rtsold 8 .
3114 .It Va rtsol_flags
3115 .Pq Vt str
3116 For interfaces configured with the
3117 .Dq Li inet6 accept_rtadv
3118 keyword, these are the flags to pass to
3119 .Xr rtsol 8 .
3120 .Pp
3121 Note that
3122 .Va rtsold_enable
3123 is mutually exclusive to
3124 .Va rtsol_flags ;
3125 .Va rtsold_enable
3126 takes precedence.
3127 .It Va keybell
3128 .Pq Vt str
3129 The keyboard bell sound.
3130 Set to
3131 .Dq Li normal ,
3132 .Dq Li visual ,
3133 .Dq Li off ,
3134 or
3135 .Dq Li NO
3136 if the default behavior is desired.
3137 For details, refer to the
3138 .Xr kbdcontrol 1
3139 manpage.
3140 .It Va keyboard
3141 .Pq Vt str
3142 If set to a non-null string, the virtual console's keyboard input is
3143 set to this device.
3144 .It Va keymap
3145 .Pq Vt str
3146 If set to
3147 .Dq Li NO ,
3148 no keymap is installed, otherwise the value is used to install
3149 the keymap file found in
3150 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3151 (if using
3152 .Xr syscons 4 ) or
3153 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3154 (if using
3155 .Xr vt 4 ) .
3156 .It Va keyrate
3157 .Pq Vt str
3158 The keyboard repeat speed.
3159 Set to
3160 .Dq Li slow ,
3161 .Dq Li normal ,
3162 .Dq Li fast ,
3163 or
3164 .Dq Li NO
3165 if the default behavior is desired.
3166 .It Va keychange
3167 .Pq Vt str
3168 If not set to
3169 .Dq Li NO ,
3170 attempt to program the function keys with the value.
3171 The value should
3172 be a single string of the form:
3173 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3174 .It Va cursor
3175 .Pq Vt str
3176 Can be set to the value of
3177 .Dq Li normal ,
3178 .Dq Li blink ,
3179 .Dq Li destructive ,
3180 or
3181 .Dq Li NO
3182 to set the cursor behavior explicitly or choose the default behavior.
3183 .It Va scrnmap
3184 .Pq Vt str
3185 If set to
3186 .Dq Li NO ,
3187 no screen map is installed, otherwise the value is used to install
3188 the screen map file in
3189 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3190 This parameter is ignored when using
3191 .Xr vt 4
3192 as the console driver.
3193 .It Va font8x16
3194 .Pq Vt str
3195 If set to
3196 .Dq Li NO ,
3197 the default 8x16 font value is used for screen size requests, otherwise
3198 the value in
3199 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3200 or
3201 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3202 is used (depending on the console driver being used).
3203 .It Va font8x14
3204 .Pq Vt str
3205 If set to
3206 .Dq Li NO ,
3207 the default 8x14 font value is used for screen size requests, otherwise
3208 the value in
3209 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3210 or
3211 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3212 is used (depending on the console driver being used).
3213 .It Va font8x8
3214 .Pq Vt str
3215 If set to
3216 .Dq Li NO ,
3217 the default 8x8 font value is used for screen size requests, otherwise
3218 the value in
3219 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3220 or
3221 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3222 is used (depending on the console driver being used).
3223 .It Va blanktime
3224 .Pq Vt int
3225 If set to
3226 .Dq Li NO ,
3227 the default screen blanking interval is used, otherwise it is set
3228 to
3229 .Ar value
3230 seconds.
3231 .It Va saver
3232 .Pq Vt str
3233 If not set to
3234 .Dq Li NO ,
3235 this is the actual screen saver to use
3236 .Li ( blank , snake , daemon ,
3237 etc).
3238 .It Va moused_nondefault_enable
3239 .Pq Vt str
3240 If set to
3241 .Dq Li NO ,
3242 the mouse device specified on
3243 the command line is not automatically treated as enabled by the
3244 .Pa /etc/rc.d/moused
3245 script.
3246 Having this variable set to
3247 .Dq Li YES
3248 allows a
3249 .Xr usb 4
3250 mouse,
3251 for example,
3252 to be enabled as soon as it is plugged in.
3253 .It Va moused_enable
3254 .Pq Vt str
3255 If set to
3256 .Dq Li YES ,
3257 the
3258 .Xr moused 8
3259 daemon is started for doing cut/paste selection on the console.
3260 .It Va moused_type
3261 .Pq Vt str
3262 This is the protocol type of the mouse connected to this host.
3263 This variable must be set if
3264 .Va moused_enable
3265 is set to
3266 .Dq Li YES .
3267 The
3268 .Xr moused 8
3269 daemon
3270 is able to detect the appropriate mouse type automatically in many cases.
3271 Set this variable to
3272 .Dq Li auto
3273 to let the daemon detect it, or
3274 select one from the following list if the automatic detection fails.
3275 .Pp
3276 If the mouse is attached to the PS/2 mouse port, choose
3277 .Dq Li auto
3278 or
3279 .Dq Li ps/2 ,
3280 regardless of the brand and model of the mouse.
3281 Likewise, if the
3282 mouse is attached to the bus mouse port, choose
3283 .Dq Li auto
3284 or
3285 .Dq Li busmouse .
3286 All other protocols are for serial mice and will not work with
3287 the PS/2 and bus mice.
3288 If this is a USB mouse,
3289 .Dq Li auto
3290 is the only protocol type which will work.
3291 .Pp
3292 .Bl -tag -width ".Li x10mouseremote" -compact
3293 .It Li microsoft
3294 Microsoft mouse (serial)
3295 .It Li intellimouse
3296 Microsoft IntelliMouse (serial)
3297 .It Li mousesystems
3298 Mouse systems Corp.\& mouse (serial)
3299 .It Li mmseries
3300 MM Series mouse (serial)
3301 .It Li logitech
3302 Logitech mouse (serial)
3303 .It Li busmouse
3304 A bus mouse
3305 .It Li mouseman
3306 Logitech MouseMan and TrackMan (serial)
3307 .It Li glidepoint
3308 ALPS GlidePoint (serial)
3309 .It Li thinkingmouse
3310 Kensington ThinkingMouse (serial)
3311 .It Li ps/2
3312 PS/2 mouse
3313 .It Li mmhittab
3314 MM HitTablet (serial)
3315 .It Li x10mouseremote
3316 X10 MouseRemote (serial)
3317 .It Li versapad
3318 Interlink VersaPad (serial)
3319 .El
3320 .Pp
3321 Even if the mouse is not in the above list, it may be compatible
3322 with one in the list.
3323 Refer to the manual page for
3324 .Xr moused 8
3325 for compatibility information.
3326 .Pp
3327 It should also be noted that while this is enabled, any
3328 other client of the mouse (such as an X server) should access
3329 the mouse through the virtual mouse device,
3330 .Pa /dev/sysmouse ,
3331 and configure it as a
3332 .Dq Li sysmouse
3333 type mouse, since all
3334 mouse data is converted to this single canonical format when
3335 using
3336 .Xr moused 8 .
3337 If the client program does not support the
3338 .Dq Li sysmouse
3339 type,
3340 specify the
3341 .Dq Li mousesystems
3342 type.
3343 It is the second preferred type.
3344 .It Va moused_port
3345 .Pq Vt str
3346 If
3347 .Va moused_enable
3348 is set to
3349 .Dq Li YES ,
3350 this is the actual port the mouse is on.
3351 It might be
3352 .Pa /dev/cuau0
3353 for a COM1 serial mouse, or
3354 .Pa /dev/psm0
3355 for a PS/2 mouse, for example.
3356 .It Va moused_flags
3357 .Pq Vt str
3358 If
3359 .Va moused_flags
3360 is set, its value is used as an additional set of flags to pass to the
3361 .Xr moused 8
3362 daemon.
3363 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3364 When
3365 .Va moused_nondefault_enable
3366 is enabled, and a
3367 .Xr moused 8
3368 daemon is started for a non-default port, the
3369 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3370 set of options has precedence over and replaces the default
3371 .Va moused_flags
3372 (where
3373 .Ar XXX
3374 is the name of the non-default port, i.e.,\&
3375 .Ar ums0 ) .
3376 By setting
3377 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3378 it is possible to set up a different set of default flags for each
3379 .Xr moused 8
3380 instance.
3381 For example, you can use
3382 .Dq Li "-3"
3383 for the default
3384 .Va moused_flags
3385 to make your laptop's touchpad more comfortable to use,
3386 but an empty set of options for
3387 .Va moused_ums0_flags
3388 when your
3389 .Xr usb 4
3390 mouse has three or more buttons.
3391 .It Va mousechar_start
3392 .Pq Vt int
3393 If set to
3394 .Dq Li NO ,
3395 the default mouse cursor character range
3396 .Li 0xd0 Ns - Ns Li 0xd3
3397 is used,
3398 otherwise the range start is set
3399 to
3400 .Ar value
3401 character, see
3402 .Xr vidcontrol 1 .
3403 Use if the default range is occupied in the language code table.
3404 .It Va allscreens_flags
3405 .Pq Vt str
3406 If set,
3407 .Xr vidcontrol 1
3408 is run with these options for each of the virtual terminals
3409 .Pq Pa /dev/ttyv* .
3410 For example,
3411 .Dq Fl m Cm on
3412 will enable the mouse pointer on all virtual terminals
3413 if
3414 .Va moused_enable
3415 is set to
3416 .Dq Li YES .
3417 .It Va allscreens_kbdflags
3418 .Pq Vt str
3419 If set,
3420 .Xr kbdcontrol 1
3421 is run with these options for each of the virtual terminals
3422 .Pq Pa /dev/ttyv* .
3423 For example,
3424 .Dq Fl h Li 200
3425 will set the
3426 .Xr syscons 4
3427 or
3428 .Xr vt 4
3429 scrollback (history) buffer to 200 lines.
3430 .It Va cron_enable
3431 .Pq Vt bool
3432 If set to
3433 .Dq Li YES ,
3434 run the
3435 .Xr cron 8
3436 daemon at system boot time.
3437 .It Va cron_program
3438 .Pq Vt str
3439 Path to
3440 .Xr cron 8
3441 (default
3442 .Pa /usr/sbin/cron ) .
3443 .It Va cron_flags
3444 .Pq Vt str
3445 If
3446 .Va cron_enable
3447 is set to
3448 .Dq Li YES ,
3449 these are the flags to pass to
3450 .Xr cron 8 .
3451 .It Va cron_dst
3452 .Pq Vt bool
3453 If set to
3454 .Dq Li YES ,
3455 enable the special handling of transitions to and from the
3456 Daylight Saving Time in
3457 .Xr cron 8
3458 (equivalent to using the flag
3459 .Fl s ) .
3460 .It Va lpd_program
3461 .Pq Vt str
3462 Path to
3463 .Xr lpd 8
3464 (default
3465 .Pa /usr/sbin/lpd ) .
3466 .It Va lpd_enable
3467 .Pq Vt bool
3468 If set to
3469 .Dq Li YES ,
3470 run the
3471 .Xr lpd 8
3472 daemon at system boot time.
3473 .It Va lpd_flags
3474 .Pq Vt str
3475 If
3476 .Va lpd_enable
3477 is set to
3478 .Dq Li YES ,
3479 these are the flags to pass to the
3480 .Xr lpd 8
3481 daemon.
3482 .It Va chkprintcap_enable
3483 .Pq Vt bool
3484 If set to
3485 .Dq Li YES ,
3486 run the
3487 .Xr chkprintcap 8
3488 command before starting the
3489 .Xr lpd 8
3490 daemon.
3491 .It Va chkprintcap_flags
3492 .Pq Vt str
3493 If
3494 .Va lpd_enable
3495 and
3496 .Va chkprintcap_enable
3497 are set to
3498 .Dq Li YES ,
3499 these are the flags to pass to the
3500 .Xr chkprintcap 8
3501 program.
3502 The default is
3503 .Dq Li -d ,
3504 which causes missing directories to be created.
3505 .It Va mta_start_script
3506 .Pq Vt str
3507 This variable specifies the full path to the script to run to start
3508 a mail transfer agent.
3509 The default is
3510 .Pa /etc/rc.sendmail .
3511 The
3512 .Va sendmail_*
3513 variables which
3514 .Pa /etc/rc.sendmail
3515 uses are documented in the
3516 .Xr rc.sendmail 8
3517 manual page.
3518 .It Va dumpdev
3519 .Pq Vt str
3520 Indicates the device (usually a swap partition) to which a crash dump
3521 should be written in the event of a system crash.
3522 If the value of this variable is
3523 .Dq Li AUTO ,
3524 the first suitable swap device listed in
3525 .Pa /etc/fstab
3526 will be used as dump device.
3527 Otherwise, the value of this variable is passed as the argument to
3528 .Xr dumpon 8
3529 and
3530 .Xr savecore 8 .
3531 To disable crash dumps, set this variable to
3532 .Dq Li NO .
3533 .It Va dumpon_flags
3534 .Pq Vt str
3535 Flags to pass to
3536 .Xr dumpon 8
3537 when configuring
3538 .Va dumpdev
3539 as the system dump device.
3540 .It Va dumpdir
3541 .Pq Vt str
3542 When the system reboots after a crash and a crash dump is found on the
3543 device specified by the
3544 .Va dumpdev
3545 variable,
3546 .Xr savecore 8
3547 will save that crash dump and a copy of the kernel to the directory
3548 specified by the
3549 .Va dumpdir
3550 variable.
3551 The default value is
3552 .Pa /var/crash .
3553 Set to
3554 .Dq Li NO
3555 to not run
3556 .Xr savecore 8
3557 at boot time when
3558 .Va dumpdir
3559 is set.
3560 .It Va savecore_enable
3561 .Pq Vt bool
3562 If set to
3563 .Dq Li NO ,
3564 disable automatic extraction of the crash dump from the
3565 .Va dumpdev .
3566 .It Va savecore_flags
3567 .Pq Vt str
3568 If crash dumps are enabled, these are the flags to pass to the
3569 .Xr savecore 8
3570 utility.
3571 .It Va quota_enable
3572 .Pq Vt bool
3573 Set to
3574 .Dq Li YES
3575 to turn on user and group disk quotas on system startup via the
3576 .Xr quotaon 8
3577 command for all file systems marked as having quotas enabled in
3578 .Pa /etc/fstab .
3579 The kernel must be built with
3580 .Cd "options QUOTA"
3581 for disk quotas to function.
3582 .It Va check_quotas
3583 .Pq Vt bool
3584 Set to
3585 .Dq Li YES
3586 to enable user and group disk quota checking via the
3587 .Xr quotacheck 8
3588 command.
3589 .It Va quotacheck_flags
3590 .Pq Vt str
3591 If
3592 .Va quota_enable
3593 is set to
3594 .Dq Li YES ,
3595 and
3596 .Va check_quotas
3597 is set to
3598 .Dq Li YES ,
3599 these are the flags to pass to the
3600 .Xr quotacheck 8
3601 utility.
3602 The default is
3603 .Dq Li "-a" ,
3604 which checks quotas for all file systems with quotas enabled in
3605 .Pa /etc/fstab .
3606 .It Va quotaon_flags
3607 .Pq Vt str
3608 If
3609 .Va quota_enable
3610 is set to
3611 .Dq Li YES ,
3612 these are the flags to pass to the
3613 .Xr quotaon 8
3614 utility.
3615 The default is
3616 .Dq Li "-a" ,
3617 which enables quotas for all file systems with quotas enabled in
3618 .Pa /etc/fstab .
3619 .It Va quotaoff_flags
3620 .Pq Vt str
3621 If
3622 .Va quota_enable
3623 is set to
3624 .Dq Li YES ,
3625 these are the flags to pass to the
3626 .Xr quotaoff 8
3627 utility when shutting down the quota system.
3628 The default is
3629 .Dq Li "-a" ,
3630 which disables quotas for all file systems with quotas enabled in
3631 .Pa /etc/fstab .
3632 .It Va accounting_enable
3633 .Pq Vt bool
3634 Set to
3635 .Dq Li YES
3636 to enable system accounting through the
3637 .Xr accton 8
3638 facility.
3639 .It Va firstboot_sentinel
3640 .Pq Vt str
3641 This variable specifies the full path to a
3642 .Dq first boot
3643 sentinel file.
3644 If a file exists with this path,
3645 .Pa rc.d
3646 scripts with the
3647 .Dq firstboot
3648 keyword will be run on startup and the sentinel file will be deleted
3649 after the boot process completes.
3650 The sentinel file must be located on a writable file system which is
3651 mounted no later than
3652 .Va early_late_divider
3653 to function properly.
3654 The default is
3655 .Pa /firstboot .
3656 .It Va linux_enable
3657 .Pq Vt bool
3658 Set to
3659 .Dq Li YES
3660 to enable Linux/ELF binary emulation at system initial
3661 boot time.
3662 .It Va sysvipc_enable
3663 .Pq Vt bool
3664 If set to
3665 .Dq Li YES ,
3666 load System V IPC primitives at boot time.
3667 .It Va clear_tmp_enable
3668 .Pq Vt bool
3669 Set to
3670 .Dq Li YES
3671 to have
3672 .Pa /tmp
3673 cleaned at startup.
3674 .It Va clear_tmp_X
3675 .Pq Vt bool
3676 Set to
3677 .Dq Li NO
3678 to disable removing of X11 lock files,
3679 and the removal and (secure) recreation
3680 of the various socket directories for X11
3681 related programs.
3682 .It Va ldconfig_paths
3683 .Pq Vt str
3684 Set to the list of shared library paths to use with
3685 .Xr ldconfig 8 .
3686 NOTE:
3687 .Pa /lib
3688 and
3689 .Pa /usr/lib
3690 will always be added first, so they need not appear in this list.
3691 .It Va ldconfig32_paths
3692 .Pq Vt str
3693 Set to the list of 32-bit compatibility shared library paths to
3694 use with
3695 .Xr ldconfig 8 .
3696 .It Va ldconfig_insecure
3697 .Pq Vt bool
3698 The
3699 .Xr ldconfig 8
3700 utility normally refuses to use directories
3701 which are writable by anyone except root.
3702 Set this variable to
3703 .Dq Li YES
3704 to disable that security check during system startup.
3705 .It Va ldconfig_local_dirs
3706 .Pq Vt str
3707 Set to the list of local
3708 .Xr ldconfig 8
3709 directories.
3710 The names of all files in the directories listed will be
3711 passed as arguments to
3712 .Xr ldconfig 8 .
3713 .It Va ldconfig_local32_dirs
3714 .Pq Vt str
3715 Set to the list of local 32-bit compatibility
3716 .Xr ldconfig 8
3717 directories.
3718 The names of all files in the directories listed will be
3719 passed as arguments to
3720 .Dq Nm ldconfig Fl 32 .
3721 .It Va kern_securelevel_enable
3722 .Pq Vt bool
3723 Set to
3724 .Dq Li YES
3725 to set the kernel security level at system startup.
3726 .It Va kern_securelevel
3727 .Pq Vt int
3728 The kernel security level to set at startup.
3729 The allowed range of
3730 .Ar value
3731 ranges from \-1 (the compile time default) to 3 (the
3732 most secure).
3733 See
3734 .Xr security 7
3735 for the list of possible security levels and their effect
3736 on system operation.
3737 .It Va sshd_program
3738 .Pq Vt str
3739 Path to the SSH server program
3740 .Pa ( /usr/sbin/sshd
3741 is the default).
3742 .It Va sshd_enable
3743 .Pq Vt bool
3744 Set to
3745 .Dq Li YES
3746 to start
3747 .Xr sshd 8
3748 at system boot time.
3749 .It Va sshd_flags
3750 .Pq Vt str
3751 If
3752 .Va sshd_enable
3753 is set to
3754 .Dq Li YES ,
3755 these are the flags to pass to the
3756 .Xr sshd 8
3757 daemon.
3758 .It Va ftpd_program
3759 .Pq Vt str
3760 Path to the FTP server program
3761 .Pa ( /usr/libexec/ftpd
3762 is the default).
3763 .It Va ftpd_enable
3764 .Pq Vt bool
3765 Set to
3766 .Dq Li YES
3767 to start
3768 .Xr ftpd 8
3769 as a stand-alone daemon at system boot time.
3770 .It Va ftpd_flags
3771 .Pq Vt str
3772 If
3773 .Va ftpd_enable
3774 is set to
3775 .Dq Li YES ,
3776 these are the additional flags to pass to the
3777 .Xr ftpd 8
3778 daemon.
3779 .It Va watchdogd_enable
3780 .Pq Vt bool
3781 If set to
3782 .Dq Li YES ,
3783 start the
3784 .Xr watchdogd 8
3785 daemon at boot time.
3786 This requires that the kernel have been compiled with a
3787 .Xr watchdog 4
3788 compatible device.
3789 .It Va watchdogd_flags
3790 .Pq Vt str
3791 If
3792 .Va watchdogd_enable
3793 is set to
3794 .Dq Li YES ,
3795 these are the flags passed to the
3796 .Xr watchdogd 8
3797 daemon.
3798 .It Va watchdogd_timeout
3799 .Pq Vt int
3800 If
3801 .Va watchdogd_enable
3802 is set to
3803 .Dq Li YES ,
3804 this is a timeout that will be used by the
3805 .Xr watchdogd 8
3806 daemon.
3807 If this option is set, it overrides
3808 .Fl t
3809 in
3810 .Va watchdogd_flags .
3811 .It Va watchdogd_shutdown_timeout
3812 .Pq Vt int
3813 If
3814 .Va watchdogd_enable
3815 is set to
3816 .Dq Li YES ,
3817 this is a timeout that will be set by the
3818 .Xr watchdogd 8
3819 daemon when it exits during the system shutdown.
3820 This timeout will not be set when returning to the single-user mode
3821 or when the watchdogd service is stopped individually using the
3822 .Xr service 8
3823 command or the rc.d script.
3824 Note that the timeout will be applied if
3825 .Xr watchdogd 8
3826 is stopped outside of
3827 .Xr rc 8
3828 framework.
3829 If this option is set, it overrides
3830 .Fl x
3831 in
3832 .Va watchdogd_flags .
3833 .It Va devfs_rulesets
3834 .Pq Vt str
3835 List of files containing sets of rules for
3836 .Xr devfs 8 .
3837 .It Va devfs_system_ruleset
3838 .Pq Vt str
3839 Rule name(s) to apply to the system
3840 .Pa /dev
3841 itself.
3842 .It Va devfs_set_rulesets
3843 .Pq Vt str
3844 Pairs of already-mounted
3845 .Pa dev
3846 directories and rulesets that should be applied to them.
3847 For example: /mount/dev=ruleset_name
3848 .It Va devfs_load_rulesets
3849 .Pq Vt bool
3850 If set, always load the default rulesets listed in
3851 .Va devfs_rulesets .
3852 .It Va performance_cx_lowest
3853 .Pq Vt str
3854 CPU idle state to use while on AC power.
3855 The string
3856 .Dq Li LOW
3857 indicates that
3858 .Xr acpi 4
3859 should use the lowest power state available while
3860 .Dq Li HIGH
3861 indicates that the lowest latency state (less power savings) should be used.
3862 .It Va performance_cpu_freq
3863 .Pq Vt str
3864 CPU clock frequency to use while on AC power.
3865 The string
3866 .Dq Li LOW
3867 indicates that
3868 .Xr cpufreq 4
3869 should use the lowest frequency available while
3870 .Dq Li HIGH
3871 indicates that the highest frequency (less power savings) should be used.
3872 .It Va economy_cx_lowest
3873 .Pq Vt str
3874 CPU idle state to use when off AC power.
3875 The string
3876 .Dq Li LOW
3877 indicates that
3878 .Xr acpi 4
3879 should use the lowest power state available while
3880 .Dq Li HIGH
3881 indicates that the lowest latency state (less power savings) should be used.
3882 .It Va economy_cpu_freq
3883 .Pq Vt str
3884 CPU clock frequency to use when off AC power.
3885 The string
3886 .Dq Li LOW
3887 indicates that
3888 .Xr cpufreq 4
3889 should use the lowest frequency available while
3890 .Dq Li HIGH
3891 indicates that the highest frequency (less power savings) should be used.
3892 .It Va jail_enable
3893 .Pq Vt bool
3894 If set to
3895 .Dq Li NO ,
3896 any configured jails will not be started.
3897 .It Va jail_conf
3898 .Pq Vt str
3899 The configuration filename used by
3900 .Xr jail 8
3901 utility.
3902 The default value is
3903 .Pa /etc/jail.conf .
3904 .Pa /etc/jail.  Ns Ao Ar jname Ac Ns Va .conf
3905 and
3906 .Pa /etc/jail.conf.d/ Ns Ao Ar jname Ac Ns Va .conf
3907 will also be used if
3908 .Va Ao Ar jname Ac Va
3909 is set in
3910 .Va jail_list .
3911 .It Va jail_parallel_start
3912 .Pq Vt bool
3913 If set to
3914 .Dq Li YES ,
3915 all configured jails will be started in the background (in parallel).
3916 .It Va jail_flags
3917 .Pq Vt str
3918 Unset by default.
3919 When set, use as default value for
3920 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3921 for every jail in
3922 .Va jail_list .
3923 .It Va jail_list
3924 .Pq Vt str
3925 A space-delimited list of jail names.
3926 When left empty, all of the
3927 .Xr jail 8
3928 instances defined in the configuration file are started.
3929 The names specified in this list control the jail startup order.
3930 .Xr jail 8
3931 instances missing from
3932 .Va jail_list
3933 must be started manually.
3934 Note that a jail's
3935 .Va depend
3936 parameter in the configuration file may override this list.
3937 .It Va jail_reverse_stop
3938 .Pq Vt bool
3939 When set to
3940 .Dq Li YES ,
3941 all configured jails in
3942 .Va jail_list
3943 are stopped in reverse order.
3944 .It Va jail_ Ns * variables
3945 Note that older releases supported per-jail configuration via
3946 .Nm
3947 variables.
3948 For example,
3949 hostname of a jail named
3950 .Li vjail
3951 was able to be set by
3952 .Li jail_vjail_hostname .
3953 These per-jail configuration variables are now obsolete in favor of
3954 .Xr jail 8
3955 configuration file.
3956 For backward compatibility,
3957 when per-jail configuration variables are defined,
3958 .Xr jail 8
3959 configuration files are created as
3960 .Pa /var/run/jail . Ns Ao Ar jname Ac Ns Pa .conf
3961 and used.
3962 .Pp
3963 The following per-jail parameters are handled by
3964 .Pa rc.d/jail
3965 script out of their corresponding
3966 .Nm
3967 variables.
3968 In addition to them, parameters in
3969 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3970 will be added to the configuration file.
3971 They must be a semi-colon
3972 .Pq Ql \&;
3973 delimited list of
3974 .Dq key=value .
3975 For more details,
3976 see
3977 .Xr jail 8
3978 manual page.
3979 .Bl  -tag -width "host.hostname" -offset indent
3980 .It Li path
3981 set from
3982 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3983 .It Li host.hostname
3984 set from
3985 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3986 .It Li exec.consolelog
3987 set from
3988 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3989 The default value is
3990 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3991 .It Li interface
3992 set from
3993 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3994 .It Li vnet.interface
3995 set from
3996 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3997 This implies
3998 .Li vnet
3999 parameter will be enabled and cannot be specified with
4000 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
4001 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4002 and/or
4003 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4004 at the same time.
4005 .It Li fstab
4006 set from
4007 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
4008 .It Li mount
4009 set from
4010 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
4011 .It Li exec.fib
4012 set from
4013 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
4014 .It Li exec.start
4015 set from
4016 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
4017 The parameter name was
4018 .Li command
4019 in some older releases.
4020 .It Li exec.prestart
4021 set from
4022 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
4023 .It Li exec.poststart
4024 set from
4025 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
4026 .It Li exec.stop
4027 set from
4028 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4029 .It Li exec.prestop
4030 set from
4031 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
4032 .It Li exec.poststop
4033 set from
4034 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
4035 .It Li ip4.addr
4036 set if
4037 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4038 or
4039 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4040 contain IPv4 addresses
4041 .It Li ip6.addr
4042 set if
4043 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4044 or
4045 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4046 contain IPv6 addresses
4047 .It Li allow.mount
4048 set from
4049 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4050 .It Li mount.devfs
4051 set from
4052 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4053 .It Li devfs_ruleset
4054 set from
4055 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
4056 This must be an integer,
4057 not a string.
4058 .It Li mount.fdescfs
4059 set from
4060 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4061 .It Li allow.set_hostname
4062 set from
4063 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4064 .It Li allow.rawsocket
4065 set from
4066 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4067 .It Li allow.sysvipc
4068 set from
4069 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4070 .El
4071 .\" -----------------------------------------------------
4072 .It Va harvest_mask
4073 .Pq Vt int
4074 Set to a bit-mask
4075 representing the entropy sources
4076 you wish to harvest.
4077 Refer to
4078 .Xr random 4
4079 for more information.
4080 .It Va entropy_dir
4081 .Pq Vt str
4082 Set to
4083 .Dq Li NO
4084 to disable caching entropy via
4085 .Xr cron 8 .
4086 Otherwise set to the directory
4087 in which the entropy files are stored.
4088 To be useful,
4089 there must be
4090 a system cron job
4091 that regularly writes and rotates
4092 files here.
4093 All files found
4094 will be used at boot time.
4095 The default is
4096 .Pa /var/db/entropy .
4097 .It Va entropy_file
4098 .Pq Vt str
4099 Set to
4100 .Dq Li NO
4101 to disable caching entropy through reboots.
4102 Otherwise set to the name
4103 of a file used to store cached entropy.
4104 This file should be located
4105 on a file system that is readable
4106 before all the volumes specified in
4107 .Xr fstab 5
4108 are mounted.
4109 By default,
4110 .Pa /entropy
4111 is used,
4112 but if
4113 .Pa /var/db/entropy-file
4114 is found it will also be used.
4115 This will be of some use to
4116 .Xr bsdinstall 8 .
4117 .It Va entropy_boot_file
4118 .Pq Vt str
4119 Set to
4120 .Dq Li NO
4121 to disable
4122 very early caching entropy
4123 through reboots.
4124 Otherwise set to the filename
4125 used to read
4126 very early reboot cached entropy.
4127 This file should be located where
4128 .Xr loader 8
4129 can read it.
4130 See also
4131 .Xr loader.conf 5 .
4132 The default location is
4133 .Pa /boot/entropy .
4134 .It Va entropy_save_sz
4135 .Pq Vt int
4136 Size of the entropy cache files saved by
4137 .Nm save-entropy
4138 periodically.
4139 .It Va entropy_save_num
4140 .Pq Vt int
4141 Number of entropy cache files to save by
4142 .Nm save-entropy
4143 periodically.
4144 .It Va ipsec_enable
4145 .Pq Vt bool
4146 Set to
4147 .Dq Li YES
4148 to run
4149 .Xr setkey 8
4150 on
4151 .Va ipsec_file
4152 at boot time.
4153 .It Va ipsec_file
4154 .Pq Vt str
4155 Configuration file for
4156 .Xr setkey 8 .
4157 .It Va dmesg_enable
4158 .Pq Vt bool
4159 Set to
4160 .Dq Li YES
4161 to save
4162 .Xr dmesg 8
4163 to
4164 .Pa /var/run/dmesg.boot
4165 on boot.
4166 .It Va rcshutdown_timeout
4167 .Pq Vt int
4168 If set, start a watchdog timer in the background which will terminate
4169 .Pa rc.shutdown
4170 if
4171 .Xr shutdown 8
4172 has not completed within the specified time (in seconds).
4173 Notice that in addition to this soft timeout,
4174 .Xr init 8
4175 also applies a hard timeout for the execution of
4176 .Pa rc.shutdown .
4177 This is configured via
4178 .Xr sysctl 8
4179 variable
4180 .Va kern.init_shutdown_timeout
4181 and defaults to 120 seconds.
4182 Setting the value of
4183 .Va rcshutdown_timeout
4184 to more than 120 seconds will have no effect until the
4185 .Xr sysctl 8
4186 variable
4187 .Va kern.init_shutdown_timeout
4188 is also increased.
4189 .It Va virecover_enable
4190 .Pq Vt bool
4191 Set to
4192 .Dq Li NO
4193 to prevent the system from trying to
4194 recover pre-maturely terminated
4195 .Xr vi 1
4196 sessions.
4197 .It Va ugidfw_enable
4198 .Pq Vt bool
4199 Set to
4200 .Dq Li YES
4201 to load the
4202 .Xr mac_bsdextended 4
4203 module upon system initialization and load a default
4204 ruleset file.
4205 .It Va bsdextended_script
4206 .Pq Vt str
4207 The default
4208 .Xr mac_bsdextended 4
4209 ruleset file to load.
4210 The default value of this variable is
4211 .Pa /etc/rc.bsdextended .
4212 .It Va newsyslog_enable
4213 .Pq Vt bool
4214 If set to
4215 .Dq Li YES ,
4216 run
4217 .Xr newsyslog 8
4218 command at startup.
4219 .It Va newsyslog_flags
4220 .Pq Vt str
4221 If
4222 .Va newsyslog_enable
4223 is set to
4224 .Dq Li YES ,
4225 these are the flags to pass to the
4226 .Xr newsyslog 8
4227 program.
4228 The default is
4229 .Dq Li -CN ,
4230 which causes log files flagged with a
4231 .Cm C
4232 to be created.
4233 .It Va mdconfig_md Ns Aq Ar X
4234 .Pq Vt str
4235 Arguments to
4236 .Xr mdconfig 8
4237 for
4238 .Xr md 4
4239 device
4240 .Ar X .
4241 At minimum a
4242 .Fl t Ar type
4243 must be specified and either a
4244 .Fl s Ar size
4245 for malloc or swap backed
4246 .Xr md 4
4247 devices or a
4248 .Fl f Ar file
4249 for vnode backed
4250 .Xr md 4
4251 devices.
4252 Note that
4253 .Va mdconfig_md Ns Aq Ar X
4254 variables are evaluated until one variable is unset or null.
4255 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4256 .Pq Vt str
4257 Optional arguments passed to
4258 .Xr newfs 8
4259 to initialize
4260 .Xr md 4
4261 device
4262 .Ar X .
4263 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4264 .Pq Vt str
4265 An ownership specification passed to
4266 .Xr chown 8
4267 after the specified
4268 .Xr md 4
4269 device
4270 .Ar X
4271 has been mounted.
4272 Both the
4273 .Xr md 4
4274 device and the mount point will be changed.
4275 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4276 .Pq Vt str
4277 A mode string passed to
4278 .Xr chmod 1
4279 after the specified
4280 .Xr md 4
4281 device
4282 .Ar X
4283 has been mounted.
4284 Both the
4285 .Xr md 4
4286 device and the mount point will be changed.
4287 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4288 .Pq Vt str
4289 Files to be copied to the mount point of the
4290 .Xr md 4
4291 device
4292 .Ar X
4293 after it has been mounted.
4294 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4295 .Pq Vt str
4296 Command to execute after the specified
4297 .Xr md 4
4298 device
4299 .Ar X
4300 has been mounted.
4301 Note that the command is passed to
4302 .Ic eval
4303 and that both
4304 .Va _dev
4305 and
4306 .Va _mp
4307 variables can be used to reference respectively the
4308 .Xr md 4
4309 device and the mount point.
4310 Assuming that the
4311 .Xr md 4
4312 device is
4313 .Li md0 ,
4314 one could set the following:
4315 .Bd -literal
4316 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4317 .Ed
4318 .It Va autobridge_interfaces
4319 .Pq Vt str
4320 Set to the list of bridge interfaces that will have newly arriving interfaces
4321 checked against to be automatically added.
4322 If not set to
4323 .Dq Li NO
4324 then for each whitespace separated
4325 .Ar element
4326 in the value, a
4327 .Va autobridge_ Ns Aq Ar element
4328 variable is assumed to exist which has a whitespace separated list of interface
4329 names to match, these names can use wildcards.
4330 For example:
4331 .Bd -literal
4332 autobridge_interfaces="bridge0"
4333 autobridge_bridge0="tap* dc0 vlan[345]"
4334 .Ed
4335 .It Va mixer_enable
4336 .Pq Vt bool
4337 If set to
4338 .Dq Li YES ,
4339 enable support for sound mixer.
4340 .It Va hcsecd_enable
4341 .Pq Vt bool
4342 If set to
4343 .Dq Li YES ,
4344 enable Bluetooth security daemon.
4345 .It Va hcsecd_config
4346 .Pq Vt str
4347 Configuration file for
4348 .Xr hcsecd 8 .
4349 Default
4350 .Pa /etc/bluetooth/hcsecd.conf .
4351 .It Va sdpd_enable
4352 .Pq Vt bool
4353 If set to
4354 .Dq Li YES ,
4355 enable Bluetooth Service Discovery Protocol daemon.
4356 .It Va sdpd_control
4357 .Pq Vt str
4358 Path to
4359 .Xr sdpd 8
4360 control socket.
4361 Default
4362 .Pa /var/run/sdp .
4363 .It Va sdpd_groupname
4364 .Pq Vt str
4365 Sets
4366 .Xr sdpd 8
4367 group to run as after it initializes.
4368 Default
4369 .Dq Li nobody .
4370 .It Va sdpd_username
4371 .Pq Vt str
4372 Sets
4373 .Xr sdpd 8
4374 user to run as after it initializes.
4375 Default
4376 .Dq Li nobody .
4377 .It Va bthidd_enable
4378 .Pq Vt bool
4379 If set to
4380 .Dq Li YES ,
4381 enable Bluetooth Human Interface Device daemon.
4382 .It Va bthidd_config
4383 .Pq Vt str
4384 Configuration file for
4385 .Xr bthidd 8 .
4386 Default
4387 .Pa /etc/bluetooth/bthidd.conf .
4388 .It Va bthidd_hids
4389 .Pq Vt str
4390 Path to a file, where
4391 .Xr bthidd 8
4392 will store information about known HID devices.
4393 Default
4394 .Pa /var/db/bthidd.hids .
4395 .It Va rfcomm_pppd_server_enable
4396 .Pq Vt bool
4397 If set to
4398 .Dq Li YES ,
4399 enable Bluetooth RFCOMM PPP wrapper daemon.
4400 .It Va rfcomm_pppd_server_profile
4401 .Pq Vt str
4402 The name of the profile to use from
4403 .Pa /etc/ppp/ppp.conf .
4404 Multiple profiles can be specified here.
4405 Also used to specify per-profile overrides.
4406 When the profile name contains any of the characters
4407 .Dq Li .-/+
4408 they are translated to
4409 .Dq Li _
4410 for the proposes of the override variable names.
4411 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4412 .Pq Vt str
4413 Overrides local address to listen on.
4414 By default
4415 .Xr rfcomm_pppd 8
4416 will listen on
4417 .Dq Li ANY
4418 address.
4419 The address can be specified as BD_ADDR or name.
4420 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4421 .Pq Vt str
4422 Overrides local RFCOMM channel to listen on.
4423 By default
4424 .Xr rfcomm_pppd 8
4425 will listen on RFCOMM channel 1.
4426 Must set properly if multiple profiles used in the same time.
4427 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4428 .Pq Vt bool
4429 Tells
4430 .Xr rfcomm_pppd 8
4431 if it should register Serial Port service on the specified RFCOMM channel.
4432 Default
4433 .Dq Li NO .
4434 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4435 .Pq Vt bool
4436 Tells
4437 .Xr rfcomm_pppd 8
4438 if it should register Dial-Up Networking service on the specified
4439 RFCOMM channel.
4440 Default
4441 .Dq Li NO .
4442 .It Va ubthidhci_enable
4443 .Pq Vt bool
4444 If set to
4445 .Dq Li YES ,
4446 change the USB Bluetooth controller from HID mode to HCI mode.
4447 You also need to specify the location of USB Bluetooth controller with the
4448 .Va ubthidhci_busnum
4449 and
4450 .Va ubthidhci_addr
4451 variables.
4452 .It Va ubthidhci_busnum
4453 Bus number where the USB Bluetooth controller is located.
4454 Check the output of
4455 .Xr usbconfig 8
4456 on your system to find this information.
4457 .It Va ubthidhci_addr
4458 Bus address of the USB Bluetooth controller.
4459 Check the output of
4460 .Xr usbconfig 8
4461 on your system to find this information.
4462 .It Va netwait_enable
4463 .Pq Vt bool
4464 If set to
4465 .Dq Li YES ,
4466 delays the start of network-reliant services until
4467 .Va netwait_if
4468 is up and ICMP packets to a destination defined in
4469 .Va netwait_ip
4470 are flowing.
4471 Link state is examined first, followed by
4472 .Dq Li pinging
4473 an IP address to verify network usability.
4474 If no destination can be reached or timeouts are exceeded,
4475 network services are started anyway with no guarantee that
4476 the network is usable.
4477 Use of this variable requires both
4478 .Va netwait_ip
4479 and
4480 .Va netwait_if
4481 to be set.
4482 .It Va netwait_ip
4483 .Pq Vt str
4484 Empty by default.
4485 This variable contains a space-delimited list of IP addresses to
4486 .Xr ping 8 .
4487 DNS hostnames should not be used as resolution is not guaranteed
4488 to be functional at this point.
4489 If multiple IP addresses are specified,
4490 each will be tried until one is successful or the list is exhausted.
4491 .It Va netwait_timeout
4492 .Pq Vt int
4493 Indicates the total number of seconds to perform a
4494 .Dq Li ping
4495 against each IP address in
4496 .Va netwait_ip ,
4497 at a rate of one ping per second.
4498 If any of the pings are successful,
4499 full network connectivity is considered reliable.
4500 The default is 60.
4501 .It Va netwait_if
4502 .Pq Vt str
4503 Empty by default.
4504 Defines the name of the network interface on which watch for link.
4505 .Xr ifconfig 8
4506 is used to monitor the interface, looking for
4507 .Dq Li status: no carrier .
4508 Once gone, the link is considered up.
4509 This can be a
4510 .Xr vlan 4
4511 interface if desired.
4512 .It Va netwait_if_timeout
4513 .Pq Vt int
4514 Defines the total number of seconds to wait for link to become usable,
4515 polled at a 1-second interval.
4516 The default is 30.
4517 .It Va rctl_enable
4518 .Pq Vt bool
4519 If set to
4520 .Dq Li YES ,
4521 load
4522 .Xr rctl 8
4523 rules from the defined ruleset.
4524 The kernel must be built with
4525 .Cd "options RACCT"
4526 and
4527 .Cd "options RCTL" .
4528 .It Va rctl_rules
4529 .Pq Vt str
4530 Set to
4531 .Pa /etc/rctl.conf
4532 by default.
4533 This variables contains the
4534 .Xr rctl.conf 5
4535 ruleset to load for
4536 .Xr rctl 8 .
4537 .It Va iovctl_files
4538 .Pq Vt str
4539 A space-separated list of configuration files used by
4540 .Xr iovctl 8 .
4541 The default value is an empty string.
4542 .It Va autofs_enable
4543 .Pq Vt bool
4544 If set to
4545 .Dq Li YES ,
4546 start the
4547 .Xr automount 8
4548 utility and the
4549 .Xr automountd 8
4550 and
4551 .Xr autounmountd 8
4552 daemons at boot time.
4553 .It Va automount_flags
4554 .Pq Vt str
4555 If
4556 .Va autofs_enable
4557 is set to
4558 .Dq Li YES ,
4559 these are the flags to pass to the
4560 .Xr automount 8
4561 program.
4562 By default no flags are passed.
4563 .It Va automountd_flags
4564 .Pq Vt str
4565 If
4566 .Va autofs_enable
4567 is set to
4568 .Dq Li YES ,
4569 these are the flags to pass to the
4570 .Xr automountd 8
4571 daemon.
4572 By default no flags are passed.
4573 .It Va autounmountd_flags
4574 .Pq Vt str
4575 If
4576 .Va autofs_enable
4577 is set to
4578 .Dq Li YES ,
4579 these are the flags to pass to the
4580 .Xr autounmountd 8
4581 daemon.
4582 By default no flags are passed.
4583 .It Va ctld_enable
4584 .Pq Vt bool
4585 If set to
4586 .Dq Li YES ,
4587 start the
4588 .Xr ctld 8
4589 daemon at boot time.
4590 .It Va iscsid_enable
4591 .Pq Vt bool
4592 If set to
4593 .Dq Li YES ,
4594 start the
4595 .Xr iscsid 8
4596 daemon at boot time.
4597 .It Va iscsictl_enable
4598 .Pq Vt bool
4599 If set to
4600 .Dq Li YES ,
4601 start the
4602 .Xr iscsictl 8
4603 utility at boot time.
4604 .It Va iscsictl_flags
4605 .Pq Vt str
4606 If
4607 .Va iscsictl_enable
4608 is set to
4609 .Dq Li YES ,
4610 these are the flags to pass to the
4611 .Xr iscsictl 8
4612 program.
4613 The default is
4614 .Dq Li -Aa ,
4615 which configures sessions based on the
4616 .Pa /etc/iscsi.conf
4617 configuration file.
4618 .It Va cfumass_enable
4619 .Pq Vt bool
4620 If set to
4621 .Dq Li YES ,
4622 create and export an USB LUN using
4623 .Xr cfumass 4
4624 at boot time.
4625 .It Va cfumass_dir
4626 .Pq Vt str
4627 The directory where the files exported by USB LUN are located.
4628 The default directory is
4629 .Pa /var/cfumass .
4630 .It Va service_delete_empty
4631 .Pq Vt bool
4632 If set to
4633 .Dq Li YES ,
4634 .Ql Li service delete
4635 removes empty
4636 .Dq Li rc.conf.d
4637 files.
4638 .It Va zfs_bootonce_activate
4639 .Pq Vt bool
4640 If set to
4641 .Dq Li YES ,
4642 and a boot environment marked bootonce is successfully booted,
4643 it will be made permanently active.
4644 .It Va zfskeys_enable
4645 .Pq Vt bool
4646 If set to
4647 .Dq Li YES ,
4648 enable auto-loading of encryption keys for encrypted ZFS datasets.
4649 For every dataset the script will first load the appropriate encryption key
4650 and the attempt to unlock the dataset.
4651 .Pp
4652 The script operates only on datasets which are encrypted with
4653 ZFS native encryption
4654 and have a ZFS
4655 .Dq Li keylocation
4656 dataset property beginning with
4657 .Dq Li file:// .
4658 .It Va zfskeys_datasets
4659 .Pq Vt str
4660 A whitespace-separated list of ZFS datasets to unlock.
4661 The list is empty by default,
4662 which means that the script will attempt to unlock all datasets.
4663 .It Va zfskeys_timeout
4664 .Pq Vt int
4665 Define the total number of seconds to wait for the zfskeys script
4666 to unlock an encrypted dataset.
4667 The default is 10.
4668 .El
4669 .Sh FILES
4670 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4671 .It Pa /etc/defaults/rc.conf
4672 .It Pa /etc/defaults/vendor.conf
4673 .It Pa /etc/rc.conf
4674 .It Pa /etc/rc.conf.local
4675 .El
4676 .Sh SEE ALSO
4677 .Xr chmod 1 ,
4678 .Xr gdb 1 ,
4679 .Xr info 1 ,
4680 .Xr kbdcontrol 1 ,
4681 .Xr limits 1 ,
4682 .Xr protect 1 ,
4683 .Xr sh 1 ,
4684 .Xr vi 1 ,
4685 .Xr vidcontrol 1 ,
4686 .Xr bridge 4 ,
4687 .Xr dummynet 4 ,
4688 .Xr ip 4 ,
4689 .Xr ipf 4 ,
4690 .Xr ipfw 4 ,
4691 .Xr ipnat 4 ,
4692 .Xr kld 4 ,
4693 .Xr pf 4 ,
4694 .Xr pflog 4 ,
4695 .Xr pfsync 4 ,
4696 .Xr tcp 4 ,
4697 .Xr udp 4 ,
4698 .Xr exports 5 ,
4699 .Xr fstab 5 ,
4700 .Xr ipf 5 ,
4701 .Xr ipnat 5 ,
4702 .Xr jail.conf 5 ,
4703 .Xr loader.conf 5 ,
4704 .Xr login.conf 5 ,
4705 .Xr motd 5 ,
4706 .Xr newsyslog.conf 5 ,
4707 .Xr pf.conf 5 ,
4708 .Xr firewall 7 ,
4709 .Xr growfs 7 ,
4710 .Xr security 7 ,
4711 .Xr tuning 7 ,
4712 .Xr accton 8 ,
4713 .Xr apm 8 ,
4714 .Xr bsdinstall 8 ,
4715 .Xr bthidd 8 ,
4716 .Xr chkprintcap 8 ,
4717 .Xr chown 8 ,
4718 .Xr cron 8 ,
4719 .Xr devfs 8 ,
4720 .Xr dhclient 8 ,
4721 .Xr ftpd 8 ,
4722 .Xr geli 8 ,
4723 .Xr hcsecd 8 ,
4724 .Xr ifconfig 8 ,
4725 .Xr inetd 8 ,
4726 .Xr iovctl 8 ,
4727 .Xr ipf 8 ,
4728 .Xr ipfw 8 ,
4729 .Xr ipnat 8 ,
4730 .Xr jail 8 ,
4731 .Xr kldxref 8 ,
4732 .Xr loader 8 ,
4733 .Xr lpd 8 ,
4734 .Xr makewhatis 8 ,
4735 .Xr mdconfig 8 ,
4736 .Xr mdmfs 8 ,
4737 .Xr mixer 8 ,
4738 .Xr mountd 8 ,
4739 .Xr moused 8 ,
4740 .Xr newfs 8 ,
4741 .Xr newsyslog 8 ,
4742 .Xr nfsd 8 ,
4743 .Xr ntpd 8 ,
4744 .Xr ntpdate 8 ,
4745 .Xr pfctl 8 ,
4746 .Xr pflogd 8 ,
4747 .Xr ping 8 ,
4748 .Xr powerd 8 ,
4749 .Xr quotacheck 8 ,
4750 .Xr quotaon 8 ,
4751 .Xr rc 8 ,
4752 .Xr rc.sendmail 8 ,
4753 .Xr rc.subr 8 ,
4754 .Xr rcorder 8 ,
4755 .Xr rfcomm_pppd 8 ,
4756 .Xr route 8 ,
4757 .Xr routed 8 ,
4758 .Xr rpc.lockd 8 ,
4759 .Xr rpc.statd 8 ,
4760 .Xr rpc.tlsclntd 8 ,
4761 .Xr rpc.tlsservd 8 ,
4762 .Xr rpcbind 8 ,
4763 .Xr rwhod 8 ,
4764 .Xr savecore 8 ,
4765 .Xr sdpd 8 ,
4766 .Xr service 8 ,
4767 .Xr sshd 8 ,
4768 .Xr swapon 8 ,
4769 .Xr sysctl 8 ,
4770 .Xr syslogd 8 ,
4771 .Xr sysrc 8 ,
4772 .Xr unbound 8 ,
4773 .Xr usbconfig 8 ,
4774 .Xr wlandebug 8 ,
4775 .Xr yp 8 ,
4776 .Xr ypbind 8 ,
4777 .Xr ypserv 8 ,
4778 .Xr ypset 8
4779 .Sh HISTORY
4780 The
4781 .Nm
4782 file appeared in
4783 .Fx 2.2.2 .
4784 .Sh AUTHORS
4785 .An Jordan K. Hubbard .