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