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: src/share/man/man5/rc.conf.5,v 1.197 2003/07/28 13:56:00 mbr Exp $
  26 .\"
  27 .Dd December 21, 2014
  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 installer.
  42 .Pp
  43 The purpose of
  44 .Nm
  45 is not to run commands or perform system startup actions directly.
  46 Instead, it is included by the various generic startup scripts in
  47 .Pa /etc
  48 which conditionalize their
  49 internal actions according to the settings found there.
  50 .Pp
  51 The
  52 .Pa /etc/defaults/rc.conf
  53 file specifies the default settings for all the available options,
  54 the
  55 .Pa /etc/rc.conf
  56 file specifies override settings.
  57 Options need only be specified in
  58 .Pa /etc/rc.conf
  59 when the system administrator wishes to override the defaults.
  60 The file
  61 .Pa /etc/rc.conf.local
  62 is used to override settings in
  63 .Pa /etc/rc.conf
  64 for historical reasons.
  65 In addition to
  66 .Pa /etc/rc.conf.local
  67 you can also place smaller configuration files for each
  68 .Xr rc 8
  69 script in the
  70 .Pa /etc/rc.conf.d
  71 directory, which will be included by the
  72 .Va load_rc_config
  73 function.
  74 For jail configurations you could use the file
  75 .Pa /etc/rc.conf.d/jail
  76 to store jail specific configuration options.
  77 Also see the
  78 .Va rc_conf_files
  79 variable below.
  80 .Pp
  81 The following list provides a name and short description for each
  82 variable that can be set in the
  83 .Nm
  84 file.
  85 To set a variable of
  86 .Vt bool
  87 type, specify either
  88 .Dq Li YES ,
  89 .Dq Li TRUE ,
  90 .Dq Li ON ,
  91 or
  92 .Dq Li 1 .
  93 To unset, specify
  94 .Dq Li NO ,
  95 .Dq Li FALSE ,
  96 .Dq Li OFF ,
  97 or
  98 .Dq Li 0 .
  99 These values are case insensitive.
 100 The
 101 .Va _enable
 102 postfix in the name of a variable for starting a service can be
 103 omitted (as in
 104 .Nx ) .
 105 .Bl -tag -width indent-two
 106 .It Va rc_debug
 107 .Pq Vt bool
 108 If set to
 109 .Dq Li YES ,
 110 enable output of debug messages from rc scripts.
 111 This variable can be helpful in diagnosing mistakes when
 112 editing or integrating new scripts.
 113 Beware that this produces copious output to the terminal and
 114 .Xr syslog 3 .
 115 .It Va rc_info
 116 .Pq Vt bool
 117 If set to
 118 .Dq Li NO ,
 119 disable informational messages from the rc scripts.
 120 Informational messages are displayed when
 121 a condition that is not serious enough to warrant a warning or an error occurs.
 122 .It Va rc_startmsgs
 123 .Pq Vt bool
 124 If set to
 125 .Dq Li YES ,
 126 show
 127 .Dq Starting foo:
 128 when faststart is used (e.g., at boot time).
 129 .It Va swapfile
 130 .Pq Vt str
 131 If set to
 132 .Dq Li NO ,
 133 no swapfile is installed, otherwise the value is used as the full
 134 pathname to a file to use for additional swap space.
 135 The
 136 .Xr vn 4
 137 driver is needed for a swapfile and will be loaded if it is not
 138 already compiled into the kernel or loaded via
 139 .Xr loader.conf 5 .
 140 .It Va apm_enable
 141 .Pq Vt bool
 142 If set to
 143 .Dq Li YES ,
 144 enable support for Automatic Power Management with the
 145 .Xr apm 8
 146 command.
 147 .It Va apmd_enable
 148 .Pq Vt bool
 149 Run
 150 .Xr apmd 8
 151 to handle APM event from userland.
 152 This also enables support for APM.
 153 .It Va apmd_flags
 154 .Pq Vt str
 155 If
 156 .Va apmd_enable
 157 is set to
 158 .Dq Li YES ,
 159 these are the flags to pass to the
 160 .Xr apmd 8
 161 daemon.
 162 .It Va battd_enable
 163 Enable
 164 .Xr battd 8
 165 to monitor the status of batteries present in the system.
 166 This also enables support for APM.
 167 .It Va battd_flags
 168 .Pq Vt str
 169 If
 170 .Va battd_enable
 171 is set to
 172 .Dq Li YES ,
 173 these are the flags to pass to the
 174 .Xr battd 8
 175 daemon.
 176 .It Va devd_enable
 177 .Pq Vt bool
 178 Run
 179 .Xr devd 8
 180 to handle device added, removed or unknown events from the kernel.
 181 .It Va devd_flags
 182 .Pq Vt str
 183 If
 184 .Va devd_enable
 185 is set to
 186 .Dq Li YES ,
 187 these are the flags to pass to the
 188 .Xr devd 8
 189 daemon.
 190 .It Va powerd_enable
 191 .Pq Vt bool
 192 Set to
 193 .Dq Li NO
 194 by default.
 195 Setting this to
 196 .Dq Li YES
 197 enables
 198 .Xr powerd 8 ,
 199 a CPU speed control daemon.
 200 .It Va sensorsd_enable
 201 .Pq Vt bool
 202 Set to
 203 .Dq Li NO
 204 by default.
 205 Setting this to
 206 .Dq Li YES
 207 enables
 208 .Xr sensorsd 8 ,
 209 a sensors monitoring and logging daemon.
 210 .It Va sensorsd_flags
 211 .Pq Vt str
 212 Empty by default.
 213 Additional flags passed to the
 214 .Xr sensorsd 8
 215 program.
 216 .It Va sysvipcd_enable
 217 .Pq Vt bool
 218 Set to
 219 .Dq Li NO
 220 by default.
 221 Setting this to
 222 .Dq Li YES
 223 enables
 224 .Xr sysvipcd 8 ,
 225 a daemon needed for the userspace implementation of the XSI Interprocess
 226 Communication functions.
 227 .It Va sysvipcd_flags
 228 .Pq Vt str
 229 Empty by default.
 230 Additional flags passed to the
 231 .Xr sysvipcd 8
 232 program.
 233 .It Va hotplugd_enable
 234 .Pq Vt bool
 235 Set to
 236 .Dq Li NO
 237 by default.
 238 Setting this to
 239 .Dq Li YES
 240 enables
 241 .Xr hotplugd 8 ,
 242 a devices hot plugging monitoring daemon.
 243 .It Va hotplugd_flags
 244 .Pq Vt str
 245 Empty by default.
 246 Additional flags passed to the
 247 .Xr hotplugd 8
 248 program.
 249 .It Va pccard_ifconfig
 250 .Pq Vt str
 251 List of arguments to be passed to
 252 .Xr ifconfig 8
 253 at boot time or on insertion of the card (e.g.\&
 254 .Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
 255 for a fixed address or
 256 .Dq Li DHCP
 257 for a DHCP client).
 258 .It Va pccard_ether_delay
 259 .Pq Vt str
 260 Set the delay before starting
 261 .Xr dhclient 8
 262 in the
 263 .Pa /etc/pccard_ether
 264 script.
 265 This defaults to 5 seconds to work around a bug in the
 266 .Xr ed 4
 267 driver which can lead to system hangs when using some newer
 268 .Xr ed 4
 269 based cards.
 270 .It Va removable_interfaces
 271 .Pq Vt str
 272 List of removable network interfaces to be supported by
 273 .Pa /etc/pccard_ether .
 274 .It Va local_startup
 275 .Pq Vt str
 276 List of directories to search for startup script files.
 277 .It Va script_name_sep
 278 .Pq Vt str
 279 The field separator to use for breaking down the list of startup script files
 280 into individual filenames.
 281 The default is a space.
 282 It is not necessary to change this unless there are startup scripts with names
 283 containing spaces.
 284 .It Va hostapd_enable
 285 .Pq Vt bool
 286 Set to
 287 .Dq Li YES
 288 to start
 289 .Xr hostapd 8
 290 at system boot time.
 291 .It Va hostname
 292 .Pq Vt str
 293 The fully qualified domain name (FQDN) of this host on the network.
 294 This should almost certainly be set to something meaningful, even if
 295 there is no network connection.
 296 If
 297 .Xr dhclient 8
 298 is used to set the hostname via DHCP,
 299 this variable should be set to an empty string.
 300 .It Va ipv6_enable
 301 .Pq Vt bool
 302 Enable support for IPv6 networking.
 303 Note that this requires that the kernel have been compiled with
 304 .Cd "options INET6" .
 305 .It Va nisdomainname
 306 .Pq Vt str
 307 The NIS domain name of this host, or
 308 .Dq Li NO
 309 if NIS is not used.
 310 .It Va dhclient_program
 311 .Pq Vt str
 312 Path to the DHCP client program
 313 (default
 314 .Pa /sbin/dhclient ) .
 315 .It Va dhclient_flags
 316 .Pq Vt str
 317 Additional flags to pass to the DHCP client program.
 318 .It Va pf_enable
 319 .Pq Vt bool
 320 Set to
 321 .Dq Li YES
 322 to load
 323 .Xr pf 4
 324 at startup.
 325 If the kernel was not built with
 326 .Cd "device pf" ,
 327 the
 328 .Pa pf.ko
 329 kernel module will be loaded.
 330 See also
 331 .Va firewall_enable .
 332 .It Va pf_rules
 333 .Pq Vt str
 334 Path to the
 335 .Xr pf 4
 336 ruleset definition file.
 337 .It Va pf_program
 338 .Pq Vt str
 339 Path to
 340 .Xr pfctl 8 .
 341 .It Va pf_flags
 342 .Pq Vt str
 343 If
 344 .Va pf_enable
 345 is set to
 346 .Dq Li YES ,
 347 these are the flags to pass to
 348 .Xr pfctl 8
 349 when loading the ruleset.
 350 .It Va pflog_enable
 351 .Pq Vt bool
 352 Set this to
 353 .Dq Li YES
 354 to enable
 355 .Xr pflogd 8
 356 which logs packets from
 357 .Xr pf 4 .
 358 .It Va pflog_logfile
 359 .Pq Vt str
 360 If
 361 .Va pflog_enable
 362 is set to
 363 .Dq Li YES
 364 this specifies the path of the log file.
 365 .It Va pflog_program
 366 .Pq Vt str
 367 Path to
 368 .Xr pflogd 8 .
 369 .It Va pflog_flags
 370 .Pq Vt str
 371 If
 372 .Va pflog_enable
 373 is set to
 374 .Dq Li YES ,
 375 these are the flags to pass to
 376 .Xr pflogd 8 .
 377 .It Va firewall_enable
 378 .Pq Vt bool
 379 Set to
 380 .Dq Li YES
 381 to load firewall rules at startup.
 382 If the kernel was not built with
 383 .Cd "options IPFIREWALL" ,
 384 the
 385 .Pa ipfw.ko
 386 kernel module will be loaded.
 387 See also
 388 .Va pf_enable .
 389 .It Va ipv6_firewall_enable
 390 .Pq Vt bool
 391 The IPv6 equivalent of
 392 .Va firewall_enable .
 393 Set to
 394 .Dq Li YES
 395 to load IPv6 firewall rules at startup.
 396 If the kernel was not built with
 397 .Cd "options IPV6FIREWALL" ,
 398 the
 399 .Pa ip6fw.ko
 400 kernel module will be loaded.
 401 .It Va firewall_script
 402 .Pq Vt str
 403 The full path to the firewall script to run
 404 (default
 405 .Pa /etc/rc.firewall ) .
 406 .It Va ipv6_firewall_script
 407 .Pq Vt str
 408 The IPv6 equivalent of
 409 .Va firewall_script .
 410 .It Va firewall_type
 411 .Pq Vt str
 412 Names the firewall type from the selection in
 413 .Pa /etc/rc.firewall ,
 414 or the file which contains the local firewall ruleset.
 415 Valid selections from
 416 .Pa /etc/rc.firewall
 417 are:
 418 .Pp
 419 .Bl -tag -width ".Li simple" -compact
 420 .It Li open
 421 unrestricted IP access
 422 .It Li closed
 423 all IP services disabled, except via
 424 .Dq Li lo0
 425 .It Li client
 426 basic protection for a workstation on a LAN
 427 .It Li simple
 428 alias for
 429 .Li client .
 430 .El
 431 .Pp
 432 If a filename is specified, the full path must be given.
 433 .It Va firewall_trusted_nets
 434 .Pq Vt str
 435 List of trusted networks (if
 436 .Va firewall_type
 437 is set to
 438 .Li client ) .
 439 .It Va firewall_trusted_interfaces
 440 .Pq Vt str
 441 List of trusted network interfaces (if
 442 .Va firewall_type
 443 is set to
 444 .Li client ) .
 445 .It Va firewall_allowed_icmp_types
 446 .Pq Vt str
 447 List of allowed ICMP types (if
 448 .Va firewall_type
 449 is set to
 450 .Li client ) .
 451 .It Va firewall_open_tcp_ports
 452 .Pq Vt str
 453 List of TCP ports to open (if
 454 .Va firewall_type
 455 is set to
 456 .Li client ) .
 457 .It Va firewall_open_udp_ports
 458 .Pq Vt str
 459 List of UDP ports to open (if
 460 .Va firewall_type
 461 is set to
 462 .Li client ) .
 463 .It Va ipv6_firewall_type
 464 .Pq Vt str
 465 The IPv6 equivalent of
 466 .Va firewall_type .
 467 .It Va firewall_quiet
 468 .Pq Vt bool
 469 Set to
 470 .Dq Li YES
 471 to disable the display of firewall rules on the console during boot.
 472 .It Va ipv6_firewall_quiet
 473 .Pq Vt bool
 474 The IPv6 equivalent of
 475 .Va firewall_quiet .
 476 .It Va firewall_logging
 477 .Pq Vt bool
 478 Set to
 479 .Dq Li YES
 480 to enable firewall event logging.
 481 This is equivalent to the
 482 .Dv IPFIREWALL_VERBOSE
 483 kernel option.
 484 .It Va ipv6_firewall_logging
 485 .Pq Vt bool
 486 The IPv6 equivalent of
 487 .Va firewall_logging .
 488 .It Va firewall_flags
 489 .Pq Vt str
 490 Flags passed to
 491 .Xr ipfw 8
 492 if
 493 .Va firewall_type
 494 specifies a filename.
 495 .It Va ipv6_firewall_flags
 496 .Pq Vt str
 497 The IPv6 equivalent of
 498 .Va firewall_flags .
 499 .It Va natd_program
 500 .Pq Vt str
 501 Path to
 502 .Xr natd 8 .
 503 .It Va natd_enable
 504 .Pq Vt bool
 505 Set to
 506 .Dq Li YES
 507 to enable
 508 .Xr natd 8 .
 509 .Va firewall_enable
 510 must also be set to
 511 .Dq Li YES ,
 512 and
 513 .Xr divert 4
 514 sockets must be enabled in the kernel.
 515 .It Va natd_interface
 516 .Pq Vt str
 517 This is the name of the public interface on which
 518 .Xr natd 8
 519 should run.
 520 The interface may be given as an interface name or as an IP address.
 521 .It Va natd_flags
 522 .Pq Vt str
 523 Additional
 524 .Xr natd 8
 525 flags should be placed here.
 526 The
 527 .Fl n
 528 or
 529 .Fl a
 530 flag is automatically added with the above
 531 .Va natd_interface
 532 as an argument.
 533 .It Va tcp_extensions
 534 .Pq Vt bool
 535 Set to
 536 .Dq Li YES
 537 by default.
 538 Setting this to
 539 .Dq Li NO
 540 disables certain TCP options as described by
 541 .Rs
 542 .%T "RFC 1323"
 543 .Re
 544 Setting this to
 545 .Dq Li NO
 546 might help remedy such problems with connections as randomly hanging
 547 or other weird behavior.
 548 Some network devices are known to be broken with respect to these options.
 549 .It Va log_in_vain
 550 .Pq Vt int
 551 Set to 0 by default.
 552 The
 553 .Xr sysctl 8
 554 variables,
 555 .Va net.inet.tcp.log_in_vain
 556 and
 557 .Va net.inet.udp.log_in_vain ,
 558 as described in
 559 .Xr tcp 4
 560 and
 561 .Xr udp 4 ,
 562 are set to the given value.
 563 .It Va tcp_keepalive
 564 .Pq Vt bool
 565 Set to
 566 .Dq Li YES
 567 by default.
 568 Setting to
 569 .Dq Li NO
 570 will disable probing idle TCP connections to verify that the
 571 peer is still up and reachable.
 572 .It Va tcp_drop_synfin
 573 .Pq Vt bool
 574 Set to
 575 .Dq Li NO
 576 by default.
 577 Setting to
 578 .Dq Li YES
 579 will cause the kernel to ignore TCP frames that have both
 580 the SYN and FIN flags set.
 581 This prevents OS fingerprinting, but may break some legitimate applications.
 582 This option is only available if the kernel was built with the
 583 .Dv TCP_DROP_SYNFIN
 584 option.
 585 .It Va icmp_drop_redirect
 586 .Pq Vt bool
 587 Set to
 588 .Dq Li NO
 589 by default.
 590 Setting to
 591 .Dq Li YES
 592 will cause the kernel to ignore ICMP REDIRECT packets.
 593 Refer to
 594 .Xr icmp 4
 595 for more information.
 596 .It Va icmp_log_redirect
 597 .Pq Vt bool
 598 Set to
 599 .Dq Li NO
 600 by default.
 601 Setting to
 602 .Dq Li YES
 603 will cause the kernel to log ICMP REDIRECT packets.
 604 Note that
 605 the log messages are not rate-limited, so this option should only be used
 606 for troubleshooting networks.
 607 Refer to
 608 .Xr icmp 4
 609 for more information.
 610 .It Va icmp_bmcastecho
 611 .Pq Vt bool
 612 Set to
 613 .Dq Li YES
 614 to respond to broadcast or multicast ICMP ping packets.
 615 Refer to
 616 .Xr icmp 4
 617 for more information.
 618 .It Va ip_portrange_first
 619 .Pq Vt int
 620 If not set to
 621 .Dq Li NO ,
 622 this is the first port in the default portrange.
 623 Refer to
 624 .Xr ip 4
 625 for more information.
 626 .It Va ip_portrange_last
 627 .Pq Vt int
 628 If not set to
 629 .Dq Li NO ,
 630 this is the last port in the default portrange.
 631 Refer to
 632 .Xr ip 4
 633 for more information.
 634 .\"
 635 .It Va ifconfig_ Ns Aq Ar interface
 636 .Pq Vt str
 637 Configuration for
 638 .Dq interface .
 639 Typically includes IP address.
 640 Assuming that the interface in question was
 641 .Li ed0 ,
 642 it might look something like this:
 643 .Bd -literal
 644 ifconfig_ed0="inet 10.0.0.1 netmask 0xffff0000"
 645 .Ed
 646 .Pp
 647 If the
 648 .Pa /etc/start_if. Ns Aq Ar interface
 649 file is present, it is read and executed by the
 650 .Xr sh 1
 651 interpreter before configuring the interface as specified in the
 652 .Va ifconfig_ Ns Aq Ar interface
 653 and
 654 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
 655 variables.
 656 .Pp
 657 It is possible to bring up an interface with DHCP by adding
 658 .Dq Li DHCP
 659 to the
 660 .Va ifconfig_ Ns Aq Ar interface
 661 variable.
 662 For instance, to initialize the
 663 .Li ed0
 664 device via DHCP, it is possible to use something like:
 665 .Bd -literal
 666 ifconfig_ed0="DHCP"
 667 .Ed
 668 .Pp
 669 If a
 670 .Va vlans_ Ns Aq Ar interface
 671 variable is set,
 672 a
 673 .Xr vlan 4
 674 interface will be created for each item in the list with the
 675 .Ar vlandev
 676 argument set to
 677 .Ar interface .
 678 If a vlan interface's name is a number,
 679 then that number is used as the vlan tag and the new vlan interface is
 680 named
 681 .Ar interface . Ns Ar tag .
 682 Otherwise,
 683 the vlan tag must be specified via a
 684 .Va vlan
 685 parameter in the
 686 .Va create_args_ Ns Aq Ar interface
 687 variable.
 688 .Pp
 689 To create a vlan device named
 690 .Li em0.101
 691 on
 692 .Li em0
 693 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
 694 .Bd -literal
 695 vlans_em0="101"
 696 ifconfig_em0_101="inet 192.0.2.1/24"
 697 .Ed
 698 .Pp
 699 To create a vlan device named
 700 .Li myvlan
 701 on
 702 .Li em0
 703 with the vlan tag 102:
 704 .Bd -literal
 705 vlans_em0="myvlan"
 706 create_args_myvlan="vlan 102"
 707 .Ed
 708 .Pp
 709 If a
 710 .Va wlans_ Ns Aq Ar interface
 711 variable is set,
 712 an
 713 .Xr wlan 4
 714 interface will be created for each item in the list with the
 715 .Ar wlandev
 716 argument set to
 717 .Ar interface .
 718 Further wlan cloning arguments may be passed to the
 719 .Xr ifconfig 8
 720 .Cm create
 721 command by setting the
 722 .Va create_args_ Ns Aq Ar interface
 723 variable.
 724 One or more
 725 .Xr wlan 4
 726 devices must be created for each wireless devices as of
 727 .Dx 2.5 .
 728 Debugging flags for
 729 .Xr wlan 4
 730 devices as set by
 731 .Xr wlandebug 8
 732 may be specified with an
 733 .Va wlandebug_ Ns Aq Ar interface
 734 variable.
 735 The contents of this variable will be passed directly to
 736 .Xr wlandebug 8 .
 737 .Pp
 738 Also, if your interface needs WPA authentication, it is possible to add
 739 .Dq Li WPA
 740 to the
 741 .Va ifconfig_ Ns Aq Ar interface
 742 variable.
 743 This will start
 744 .Xr wpa_supplicant 8 .
 745 See
 746 .Xr wpa_supplicant.conf 5
 747 for configuring authentication information.
 748 .Pp
 749 Finally, you can add
 750 .Xr ifconfig 8
 751 options in this variable, in addition to the
 752 .Pa /etc/start_if. Ns Aq Ar interface
 753 file.
 754 For instance, to initialize the
 755 .Li wi0
 756 device via DHCP, using WPA authentication and 802.11b mode, it is
 757 possible to use something like:
 758 .Bd -literal
 759 wlans_wi0="wlan0"
 760 ifconfig_wlan0="up DHCP WPA mode 11b"
 761 .Ed
 762 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
 763 .Pq Vt str
 764 Configuration to establish an additional network address for
 765 .Dq interface .
 766 Assuming that the interface in question was
 767 .Li ed0 ,
 768 it might look something like this:
 769 .Bd -literal
 770 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
 771 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
 772 .Ed
 773 .Pp
 774 And so on.
 775 For each
 776 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
 777 entry that is found, its contents are passed to
 778 .Xr ifconfig 8 .
 779 Execution stops at the first unsuccessful access, so if
 780 something like this is present:
 781 .Bd -literal
 782 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
 783 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
 784 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
 785 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
 786 .Ed
 787 .Pp
 788 Then note that alias4 would
 789 .Em not
 790 be added since the search would stop with the missing alias3 entry.
 791 .It Va ifconfig_ Ns Ao Ar interface Ac Ns Va _name
 792 .Pq Vt str
 793 New name for
 794 .Dq interface .
 795 It is possible to rename interface by doing:
 796 .Bd -literal
 797 ifconfig_ed0_name="net0"
 798 ifconfig_net0="inet 10.0.0.1 netmask 0xffff0000"
 799 .Ed
 800 .It Va network_interfaces
 801 .Pq Vt str
 802 The list of network interfaces to configure on this host,
 803 or
 804 .Dq Li auto
 805 to configure all network interfaces
 806 (default
 807 .Dq Li auto ) .
 808 For example, if the only network devices to be configured are the loopback device
 809 .Pq Li lo0
 810 and a NIC using the
 811 .Xr ed 4
 812 driver, this could be set to
 813 .Dq Li "lo0 ed0" .
 814 An
 815 .Va ifconfig_ Ns Aq Ar interface
 816 variable is assumed to exist for each value of
 817 .Ar interface .
 818 .It Va ipv6_network_interfaces
 819 .Pq Vt str
 820 This is the IPv6 equivalent of
 821 .Va network_interfaces .
 822 Instead of setting the ifconfig variables as
 823 .Va ifconfig_ Ns Aq Ar interface
 824 they should be set as
 825 .Va ipv6_ifconfig_ Ns Aq Ar interface .
 826 Aliases should be set as
 827 .Va ipv6_ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n .
 828 Interfaces that do not have a
 829 .Va ipv6_ifconfig_ Ns Aq Ar interface
 830 setting will be auto configured by
 831 .Xr rtsol 8
 832 if the
 833 .Va ipv6_gateway_enable
 834 is set to
 835 .Dq Li NO .
 836 Note that the IPv6 networking code does not support the
 837 .Pa /etc/start_if. Ns Aq Ar interface
 838 files.
 839 .It Va ipv6_prefix_ Ns Aq Ar interface
 840 .Pq Vt str
 841 Assign prefix to
 842 .Ar interface ,
 843 prefixlen 64 is used.
 844 .It Va ipv6_default_interface
 845 .Pq Vt str
 846 If not set to
 847 .Dq Li NO ,
 848 this is the default output interface for scoped addresses.
 849 Now this works only for IPv6 link local multicast addresses.
 850 .It Va cloned_interfaces
 851 .Pq Vt str
 852 Set to the list of clonable network interfaces to create on this host.
 853 Entries in
 854 .Va cloned_interfaces
 855 are automatically appended to
 856 .Va network_interfaces
 857 for configuration.
 858 .It Va gif_interfaces
 859 .Pq Vt str
 860 Set to the list of
 861 .Xr gif 4
 862 tunnel interfaces to configure on this host.
 863 A
 864 .Va gifconfig_ Ns Aq Ar interface
 865 variable is assumed to exist for each value of
 866 .Ar interface .
 867 The value of this variable is used to configure the link layer of the
 868 tunnel according to the syntax of the
 869 .Cm tunnel
 870 option to
 871 .Xr ifconfig 8 .
 872 Additionally, this option ensures that each listed interface is created via the
 873 .Cm create
 874 option to
 875 .Xr ifconfig 8
 876 before attempting to configure it.
 877 .It Va sppp_interfaces
 878 .Pq Vt str
 879 Set to the list of
 880 .Xr sppp 4
 881 interfaces to configure on this host.
 882 A
 883 .Va spppconfig_ Ns Aq Ar interface
 884 variable is assumed to exist for each value of
 885 .Ar interface .
 886 Each interface should also be configured by a general
 887 .Va ifconfig_ Ns Aq Ar interface
 888 setting.
 889 Refer to
 890 .Xr spppcontrol 8
 891 for more information about available options.
 892 .It Va ppp_enable
 893 .Pq Vt bool
 894 If set to
 895 .Dq Li YES ,
 896 run the
 897 .Xr ppp 8
 898 daemon.
 899 .It Va ppp_mode
 900 .Pq Vt str
 901 Mode in which to run the
 902 .Xr ppp 8
 903 daemon.
 904 Accepted modes are
 905 .Dq Li auto ,
 906 .Dq Li ddial ,
 907 .Dq Li direct
 908 and
 909 .Dq Li dedicated .
 910 See the manual for a full description.
 911 .It Va ppp_nat
 912 .Pq Vt bool
 913 If set to
 914 .Dq Li YES ,
 915 enables network address translation.
 916 Used in conjunction with
 917 .Va gateway_enable
 918 allows hosts on private network addresses access to the Internet using
 919 this host as a network address translating router.
 920 .It Va ppp_profile
 921 .Pq Vt str
 922 The name of the profile to use from
 923 .Pa /etc/ppp/ppp.conf .
 924 Also used for per-profile overrides of
 925 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
 926 Where the profile contains any of the characters
 927 .Dq Li .-/+
 928 they are translated to
 929 .Dq Li _
 930 for the purposes of the override variable names.
 931 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
 932 .Pq Vt int
 933 Set the unit number to be used for this profile.
 934 See the manual description of
 935 .Fl unit Ns Ar N
 936 in
 937 .Xr ppp 8
 938 for details.
 939 .It Va ppp_user
 940 .Pq Vt str
 941 The name of the user under which
 942 .Xr ppp 8
 943 should be started.
 944 By default,
 945 .Xr ppp 8
 946 is started as
 947 .Dq Li root .
 948 .It Va rc_conf_files
 949 .Pq Vt str
 950 This option is used to specify a list of files that will override
 951 the settings in
 952 .Pa /etc/defaults/rc.conf .
 953 The files will be read in the order in which they are specified and should
 954 include the full path to the file.
 955 By default, the files specified are
 956 .Pa /etc/rc.conf
 957 and
 958 .Pa /etc/rc.conf.local
 959 .It Va fsck_y_enable
 960 .Pq Vt bool
 961 If set to
 962 .Dq Li YES ,
 963 .Xr fsck 8
 964 will be run with the
 965 .Fl y
 966 flag if the initial preen of the file systems fails.
 967 .It Va netfs_types
 968 .Pq Vt str
 969 List of file system types that are network-based.
 970 This list should generally not be modified by end users.
 971 Use
 972 .Va extra_netfs_types
 973 instead.
 974 .It Va extra_netfs_types
 975 .Pq Vt str
 976 If set to something other than
 977 .Dq Li NO
 978 (the default), this variable extends the list of file system types
 979 for which automatic mounting at startup by
 980 .Xr rc 8
 981 should be delayed until the network is initialized.
 982 It should contain
 983 a whitespace-separated list of network file system descriptor pairs,
 984 each consisting of a file system type as passed to
 985 .Xr mount 8
 986 and a human-readable, one-word description, joined with a colon
 987 .Pq Ql \&: .
 988 Extending the default list in this way is only necessary
 989 when third party file system types are used.
 990 .It Va devfs_config_files
 991 .Pq Vt str
 992 This option is used to specify a list of configuration files containing
 993 .Xr devfs 5
 994 rules that will be applied by
 995 .Xr devfsctl 8
 996 in the order in which they are specified and must include the full path
 997 to the file.
 998 .It Va syslogd_enable
 999 .Pq Vt bool
1000 If set to
1001 .Dq Li YES ,
1002 run the
1003 .Xr syslogd 8
1004 daemon.
1005 .It Va syslogd_program
1006 .Pq Vt str
1007 Path to
1008 .Xr syslogd 8
1009 (default
1010 .Pa /usr/sbin/syslogd ) .
1011 .It Va syslogd_flags
1012 .Pq Vt str
1013 If
1014 .Va syslogd_enable
1015 is set to
1016 .Dq Li YES ,
1017 these are the flags to pass to
1018 .Xr syslogd 8 .
1019 .It Va inetd_enable
1020 .Pq Vt bool
1021 If set to
1022 .Dq Li YES ,
1023 run the
1024 .Xr inetd 8
1025 daemon.
1026 .It Va inetd_program
1027 .Pq Vt str
1028 Path to
1029 .Xr inetd 8
1030 (default
1031 .Pa /usr/sbin/inetd ) .
1032 .It Va inetd_flags
1033 .Pq Vt str
1034 If
1035 .Va inetd_enable
1036 is set to
1037 .Dq Li YES ,
1038 these are the flags to pass to
1039 .Xr inetd 8 .
1040 .It Va rwhod_enable
1041 .Pq Vt bool
1042 If set to
1043 .Dq Li YES ,
1044 run the
1045 .Xr rwhod 8
1046 daemon at boot time.
1047 .It Va rwhod_flags
1048 .Pq Vt str
1049 If
1050 .Va rwhod_enable
1051 is set to
1052 .Dq Li YES ,
1053 these are the flags to pass to it.
1054 .It Va amd_enable
1055 .Pq Vt bool
1056 If set to
1057 .Dq Li YES ,
1058 run the
1059 .Xr amd 8
1060 daemon at boot time.
1061 .It Va amd_flags
1062 .Pq Vt str
1063 If
1064 .Va amd_enable
1065 is set to
1066 .Dq Li YES ,
1067 these are the flags to pass to it.
1068 See the
1069 .Xr amd 8
1070 manpage for more information.
1071 .It Va amd_map_program
1072 .Pq Vt str
1073 If set, the specified program is run to get the list of
1074 .Xr amd 8
1075 maps.
1076 For example, if the
1077 .Xr amd 8
1078 maps are stored in NIS, one can set this to run
1079 .Xr ypcat 1
1080 to get a list of
1081 .Xr amd 8
1082 maps from the
1083 .Pa amd.master
1084 NIS map.
1085 .It Va update_motd
1086 .Pq Vt bool
1087 If set to
1088 .Dq Li YES ,
1089 .Pa /etc/motd
1090 will be updated at boot time to reflect the kernel release being run.
1091 If set to
1092 .Dq Li NO ,
1093 .Pa /etc/motd
1094 will not be updated.
1095 .It Va nfs_client_enable
1096 .Pq Vt bool
1097 If set to
1098 .Dq Li YES ,
1099 setup NFS client parameters at boot time.
1100 .It Va nfs_access_cache
1101 .Pq Vt int
1102 If
1103 .Va nfs_client_enable
1104 is set to
1105 .Dq Li YES ,
1106 this can be set to
1107 .Dq Li 0
1108 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1109 NFS ACCESS results should be cached.
1110 A value of 2-10 seconds will substantially reduce network traffic for
1111 many NFS operations.
1112 The default is 5 seconds.
1113 Note that the attribute cache holds stat information only.
1114 The NFS data cache is independent of the attribute cache and is only
1115 invalidated when the client detects that the server has modified the
1116 underlying file.
1117 This value specifies a maximum timeout.
1118 The NFS client will automatically use a shorter timeout for files which
1119 have been recently modified.
1120 .It Va nfs_neg_cache
1121 .Pq Vt int
1122 If
1123 .Va nfs_client_enable
1124 is set to
1125 .Dq Li YES ,
1126 this can be set to
1127 .Dq Li 0
1128 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1129 filenames), or to the number of seconds for which negative lookups should
1130 be cached.
1131 A value of 2-10 seconds will substantially reduce network
1132 traffic for many NFS operations, especially source code builds.
1133 The default is 3 seconds.
1134 .It Va nfs_server_enable
1135 .Pq Vt bool
1136 If set to
1137 .Dq Li YES ,
1138 run the NFS server daemons at boot time.
1139 .It Va nfs_server_flags
1140 .Pq Vt str
1141 If
1142 .Va nfs_server_enable
1143 is set to
1144 .Dq Li YES ,
1145 these are the flags to pass to the
1146 .Xr nfsd 8
1147 daemon.
1148 .It Va mountd_enable
1149 .Pq Vt bool
1150 If set to
1151 .Dq Li YES ,
1152 and no
1153 .Va nfs_server_enable
1154 is set, start
1155 .Xr mountd 8 ,
1156 but not
1157 .Xr nfsd 8
1158 daemon.
1159 It is commonly needed to run CFS without real NFS used.
1160 .It Va mountd_flags
1161 .Pq Vt str
1162 If
1163 .Va mountd_enable
1164 is set to
1165 .Dq Li YES ,
1166 these are the flags to pass to the
1167 .Xr mountd 8
1168 daemon.
1169 .It Va weak_mountd_authentication
1170 .Pq Vt bool
1171 If set to
1172 .Dq Li YES ,
1173 allow services like PCNFSD to make non-privileged mount requests.
1174 .It Va nfs_reserved_port_only
1175 .Pq Vt bool
1176 If set to
1177 .Dq Li YES ,
1178 provide NFS services only on a secure port.
1179 .It Va nfs_bufpackets
1180 .Pq Vt int
1181 If set to a number, indicates the number of packets worth of
1182 socket buffer space to reserve on an NFS client.
1183 The kernel default is typically 4.
1184 Using a higher number may be useful on gigabit networks to improve performance.
1185 The minimum value is 2 and the maximum is 64.
1186 .It Va rpc_umntall_enable
1187 .Pq Vt bool
1188 If set to
1189 .Dq Li YES
1190 (default) and we are also an NFS client, run
1191 .Xr rpc.umntall 8
1192 at boot time to clear out old mounts on remote servers.
1193 If set to
1194 .Dq Li NO
1195 then
1196 .Xr rpc.umntall 8
1197 will not be run at boot time.
1198 .It Va rpc_lockd_enable
1199 .Pq Vt bool
1200 If set to
1201 .Dq Li YES
1202 and also an NFS server, run
1203 .Xr rpc.lockd 8
1204 at boot time.
1205 .It Va rpc_lockd_flags
1206 .Pq Vt str
1207 If
1208 .Va rpc_lockd_enable
1209 is set to
1210 .Dq Li YES ,
1211 these are the flags to pass to
1212 .Xr rpc.lockd 8 .
1213 .It Va rpc_statd_enable
1214 .Pq Vt bool
1215 If set to
1216 .Dq Li YES
1217 and also an NFS server, run
1218 .Xr rpc.statd 8
1219 at boot time.
1220 .It Va rpc_statd_flags
1221 .Pq Vt str
1222 If
1223 .Va rpc_statd_enable
1224 is set to
1225 .Dq Li YES ,
1226 these are the flags to pass to
1227 .Xr rpc.statd 8 .
1228 .It Va rpcbind_program
1229 .Pq Vt str
1230 Path to program for rpcbind daemon
1231 (default
1232 .Pa /usr/sbin/rpcbind ) .
1233 .It Va rpcbind_enable
1234 .Pq Vt bool
1235 If set to
1236 .Dq Li YES ,
1237 run
1238 .Va rpcbind_program
1239 at boot time.
1240 .It Va rpcbind_flags
1241 .Pq Vt str
1242 If
1243 .Va rpcbind_enable
1244 is set to
1245 .Dq Li YES ,
1246 these are the flags to pass to
1247 .Va rpcbind_program .
1248 .It Va keyserv_enable
1249 .Pq Vt bool
1250 If set to
1251 .Dq Li YES ,
1252 run the
1253 .Xr keyserv 8
1254 daemon on boot for running Secure RPC.
1255 .It Va keyserv_flags
1256 .Pq Vt str
1257 If
1258 .Va keyserv_enable
1259 is set to
1260 .Dq Li YES ,
1261 these are the flags to pass to
1262 .Xr keyserv 8
1263 daemon.
1264 .It Va pppoed_enable
1265 .Pq Vt bool
1266 If set to
1267 .Dq Li YES ,
1268 run the
1269 .Xr pppoed 8
1270 daemon at boot time to provide PPP over Ethernet services.
1271 .It Va pppoed_provider
1272 .Pq Vt str
1273 .Xr pppoed 8
1274 listens to requests to this provider and ultimately runs
1275 .Xr ppp 8
1276 with a
1277 .Ar system
1278 argument of the same name.
1279 .It Va pppoed_flags
1280 .Pq Vt str
1281 Additional flags to pass to
1282 .Xr pppoed 8 .
1283 .It Va pppoed_interface
1284 .Pq Vt str
1285 The network interface to run
1286 .Xr pppoed 8
1287 on.
1288 This is mandatory when
1289 .Va pppoed_enable
1290 is set to
1291 .Dq Li YES .
1292 .It Va timed_enable
1293 .Pq Vt bool
1294 If set to
1295 .Dq Li YES ,
1296 run the
1297 .Xr timed 8
1298 service at boot time.
1299 This command is intended for networks of machines where a consistent
1300 .Dq "network time"
1301 for all hosts must be established.
1302 This is often useful in large NFS environments where time stamps on
1303 files are expected to be consistent network-wide.
1304 .It Va timed_flags
1305 .Pq Vt str
1306 If
1307 .Va timed_enable
1308 is set to
1309 .Dq Li YES ,
1310 these are the flags to pass to the
1311 .Xr timed 8
1312 service.
1313 .It Va dntpd_enable
1314 .Pq Vt bool
1315 If set to
1316 .Dq Li YES ,
1317 run
1318 .Xr dntpd 8
1319 at system boot time.
1320 .It Va dntpd_program
1321 .Pq Vt str
1322 Path to
1323 .Xr dntpd 8
1324 (default
1325 .Pa /usr/sbin/dntpd ) .
1326 .It Va dntpd_flags
1327 .Pq Vt str
1328 If
1329 .Va dntpd_enable
1330 is set to
1331 .Dq Li YES ,
1332 these are the flags to pass to the
1333 .Xr dntpd 8
1334 daemon.
1335 .It Va btconfig_enable
1336 .Pq Vt bool
1337 If set to
1338 .Dq Li YES ,
1339 configure Bluetooth devices via
1340 .Xr btconfig 8
1341 at system boot time.
1342 .It Va btconfig_devices
1343 .Pq Vt str
1344 If
1345 .Va btconfig_enable
1346 is set to
1347 .Dq Li YES ,
1348 this is the list of Bluetooth devices to configure.
1349 If
1350 .Va btconfig_devices
1351 is not specified, all devices known to the system will be configured.
1352 A
1353 .Va btconfig_ Ns Aq Ar device
1354 variable can be set to specify parameters to be passed to
1355 .Ar device .
1356 .It Va btconfig_args
1357 .Pq Vt str
1358 If
1359 .Va btconfig_enable
1360 is set to
1361 .Dq Li YES ,
1362 this is the list of configuration parameters to pass to all Bluetooth
1363 devices.
1364 .It Va sdpd_enable
1365 .Pq Vt bool
1366 If set to
1367 .Dq Li YES ,
1368 run the Service Discovery Profile daemon
1369 .Xr ( sdpd 8 )
1370 at system boot time.
1371 .It Va sdpd_flags
1372 .Pq Vt str
1373 If
1374 .Va sdpd_enable
1375 is set to
1376 .Dq Li YES ,
1377 these are the flags to pass to the
1378 .Xr sdpd 8
1379 daemon.
1380 .It Va bthcid_enable
1381 .Pq Vt bool
1382 If set to
1383 .Dq Li YES ,
1384 run the Bluetooth Link Key/PIN Code Manager daemon
1385 .Xr ( bthcid 8 )
1386 at system boot time.
1387 .It Va bthcid_flags
1388 .Pq Vt str
1389 If
1390 .Va bthcid_enable
1391 is set to
1392 .Dq Li YES ,
1393 these are the flags to pass to the
1394 .Xr bthcid 8
1395 daemon.
1396 .It Va nis_client_enable
1397 .Pq Vt bool
1398 If set to
1399 .Dq Li YES ,
1400 run the
1401 .Xr ypbind 8
1402 service at system boot time.
1403 .It Va nis_client_flags
1404 .Pq Vt str
1405 If
1406 .Va nis_client_enable
1407 is set to
1408 .Dq Li YES ,
1409 these are the flags to pass to the
1410 .Xr ypbind 8
1411 service.
1412 .It Va nis_ypset_enable
1413 .Pq Vt bool
1414 If set to
1415 .Dq Li YES ,
1416 run the
1417 .Xr ypset 8
1418 daemon at system boot time.
1419 .It Va nis_ypset_flags
1420 .Pq Vt str
1421 If
1422 .Va nis_ypset_enable
1423 is set to
1424 .Dq Li YES ,
1425 these are the flags to pass to the
1426 .Xr ypset 8
1427 daemon.
1428 .It Va nis_server_enable
1429 .Pq Vt bool
1430 If set to
1431 .Dq Li YES ,
1432 run the
1433 .Xr ypserv 8
1434 daemon at system boot time.
1435 .It Va nis_server_flags
1436 .Pq Vt str
1437 If
1438 .Va nis_server_enable
1439 is set to
1440 .Dq Li YES ,
1441 these are the flags to pass to the
1442 .Xr ypserv 8
1443 daemon.
1444 .It Va nis_ypxfrd_enable
1445 .Pq Vt bool
1446 If set to
1447 .Dq Li YES ,
1448 run the
1449 .Xr rpc.ypxfrd 8
1450 daemon at system boot time.
1451 .It Va nis_ypxfrd_flags
1452 .Pq Vt str
1453 If
1454 .Va nis_ypxfrd_enable
1455 is set to
1456 .Dq Li YES ,
1457 these are the flags to pass to the
1458 .Xr rpc.ypxfrd 8
1459 daemon.
1460 .It Va nis_yppasswdd_enable
1461 .Pq Vt bool
1462 If set to
1463 .Dq Li YES ,
1464 run the
1465 .Xr rpc.yppasswdd 8
1466 daemon at system boot time.
1467 .It Va nis_yppasswdd_flags
1468 .Pq Vt str
1469 If
1470 .Va nis_yppasswdd_enable
1471 is set to
1472 .Dq Li YES ,
1473 these are the flags to pass to the
1474 .Xr rpc.yppasswdd 8
1475 daemon.
1476 .It Va rpc_ypupdated_enable
1477 .Pq Vt bool
1478 If set to
1479 .Dq Li YES ,
1480 run the
1481 .Nm rpc.ypupdated
1482 daemon at system boot time.
1483 .It Va defaultrouter
1484 .Pq Vt str
1485 If not set to
1486 .Dq Li NO ,
1487 create a default route to this host name or IP address
1488 (use an IP address if this router is also required to get to the
1489 name server!).
1490 .It Va ipv6_defaultrouter
1491 .Pq Vt str
1492 The IPv6 equivalent of
1493 .Va defaultrouter .
1494 .It Va static_routes
1495 .Pq Vt str
1496 Set to the list of static routes that are to be added at system boot time.
1497 If not set to
1498 .Dq Li NO
1499 then for each whitespace separated
1500 .Ar element
1501 in the value, a
1502 .Va route_ Ns Aq Ar element
1503 variable is assumed to exist whose contents will later be passed to a
1504 .Dq Nm route Cm add
1505 operation.
1506 .It Va change_routes
1507 .Pq Vt str
1508 Set to the list of static routes that are to be changed at system boot time
1509 (such as those added by the kernel).
1510 If not set to
1511 .Dq Li NO
1512 then for each whitespace separated
1513 .Ar element
1514 in the value, a
1515 .Va change_route_ Ns Aq Ar element
1516 variable is assumed to exist whose contents will later be passed to a
1517 .Dq Nm route Cm change
1518 operation.
1519 .It Va ipv6_static_routes
1520 .Pq Vt str
1521 The IPv6 equivalent of
1522 .Va static_routes .
1523 If not set to
1524 .Dq Li NO
1525 then for each whitespace separated
1526 .Ar element
1527 in the value, a
1528 .Va ipv6_route_ Ns Aq Ar element
1529 variable is assumed to exist whose contents will later be passed to a
1530 .Dq Nm route Cm add Fl inet6
1531 operation.
1532 .It Va gateway_enable
1533 .Pq Vt bool
1534 If set to
1535 .Dq Li YES ,
1536 configure host to act as an IP router, e.g. to forward packets
1537 between interfaces.
1538 .It Va ipv6_gateway_enable
1539 .Pq Vt bool
1540 The IPv6 equivalent of
1541 .Va gateway_enable .
1542 .It Va router_enable
1543 .Pq Vt bool
1544 If set to
1545 .Dq Li YES ,
1546 run a routing daemon of some sort, based on the settings of
1547 .Va router_program
1548 and
1549 .Va router_flags .
1550 .It Va ipv6_router_enable
1551 .Pq Vt bool
1552 The IPv6 equivalent of
1553 .Va router_enable .
1554 If set to
1555 .Dq Li YES ,
1556 run a routing daemon of some sort, based on the settings of
1557 .Va ipv6_router_program
1558 and
1559 .Va ipv6_router_flags .
1560 .It Va router_program
1561 .Pq Vt str
1562 If
1563 .Va router_enable
1564 is set to
1565 .Dq Li YES ,
1566 this is the name of the routing daemon to use
1567 (default
1568 .Pa /sbin/routed ) .
1569 .It Va ipv6_router_program
1570 .Pq Vt str
1571 The IPv6 equivalent of
1572 .Va router_program
1573 (default
1574 .Pa /sbin/route6d ) .
1575 .It Va router_flags
1576 .Pq Vt str
1577 If
1578 .Va router_enable
1579 is set to
1580 .Dq Li YES ,
1581 these are the flags to pass to the routing daemon.
1582 .It Va ipv6_router_flags
1583 .Pq Vt str
1584 The IPv6 equivalent of
1585 .Va router_flags .
1586 .It Va mrouted_enable
1587 .Pq Vt bool
1588 If set to
1589 .Dq Li YES ,
1590 run the multicast routing daemon,
1591 .Xr mrouted 8 .
1592 .It Va mroute6d_enable
1593 .Pq Vt bool
1594 The IPv6 equivalent of
1595 .Va mrouted_enable .
1596 If set to
1597 .Dq Li YES ,
1598 run the IPv6 multicast routing daemon.
1599 Note that no IPv6 multicast routing daemon is included in the
1600 .Dx
1601 base system but
1602 .Xr pim6dd 8
1603 can be installed from the
1604 .Xr dports 7
1605 collection
1606 .Pa ( net/mcast-tools ) .
1607 .It Va mrouted_flags
1608 .Pq Vt str
1609 If
1610 .Va mrouted_enable
1611 is set to
1612 .Dq Li YES ,
1613 these are the flags to pass to the
1614 .Xr mrouted 8
1615 daemon.
1616 .It Va mroute6d_flags
1617 .Pq Vt str
1618 The IPv6 equivalent of
1619 .Va mrouted_flags .
1620 If
1621 .Va mroute6d_enable
1622 is set to
1623 .Dq Li YES ,
1624 these are the flags passed to the IPv6 multicast routing daemon.
1625 .It Va mroute6d_program
1626 .Pq Vt str
1627 If
1628 .Va mroute6d_enable
1629 is set to
1630 .Dq Li YES ,
1631 this is the path to the IPv6 multicast routing daemon.
1632 .It Va rtadvd_enable
1633 .Pq Vt bool
1634 If set to
1635 .Dq Li YES ,
1636 run the
1637 .Xr rtadvd 8
1638 daemon at boot time.
1639 .Xr rtadvd 8
1640 will only run if
1641 .Va ipv6_gateway_enable
1642 is also set to
1643 .Dq Li YES .
1644 The
1645 .Xr rtadvd 8
1646 utility sends router advertisement packets to the interfaces specified in
1647 .Va rtadvd_interfaces .
1648 .Xr rtadvd 8
1649 and should only be enabled with great care.
1650 You may want to fine-tune
1651 .Xr rtadvd.conf 5 .
1652 .It Va rtadvd_interfaces
1653 .Pq Vt str
1654 If
1655 .Va rtadvd_enable
1656 is set to
1657 .Dq Li YES
1658 this is the list of interfaces to use.
1659 .It Va rtsold_enable
1660 .Pq Vt bool
1661 If set to
1662 .Dq Li YES ,
1663 run the
1664 .Xr rtsold 8
1665 daemon at boot time.
1666 The
1667 .Xr rtsold 8
1668 daemon is used for automatic discovery of non-link local addresses.
1669 .It Va rtsold_flags
1670 .Pq Vt str
1671 If
1672 .Va rtsold_enable
1673 is set to
1674 .Dq Li YES ,
1675 these are the flags to pass to the
1676 .Xr rtsold 8
1677 daemon.
1678 .It Va arpproxy_all
1679 .Pq Vt bool
1680 If set to
1681 .Dq Li YES ,
1682 enable global proxy ARP.
1683 .It Va forward_sourceroute
1684 .Pq Vt bool
1685 If set to
1686 .Dq Li YES
1687 and
1688 .Va gateway_enable
1689 is also set to
1690 .Dq Li YES ,
1691 source-routed packets are forwarded.
1692 .It Va accept_sourceroute
1693 .Pq Vt bool
1694 If set to
1695 .Dq Li YES ,
1696 the system will accept source-routed packets directed at it.
1697 .It Va rarpd_enable
1698 .Pq Vt bool
1699 If set to
1700 .Dq Li YES ,
1701 run the
1702 .Xr rarpd 8
1703 daemon at system boot time.
1704 .It Va rarpd_flags
1705 .Pq Vt str
1706 If
1707 .Va rarpd_enable
1708 is set to
1709 .Dq Li YES ,
1710 these are the flags to pass to the
1711 .Xr rarpd 8
1712 daemon.
1713 .It Va bootparamd_enable
1714 .Pq Vt bool
1715 If set to
1716 .Dq Li YES ,
1717 run the
1718 .Xr bootparamd 8
1719 daemon at system boot time.
1720 .It Va bootparamd_flags
1721 .Pq Vt str
1722 If
1723 .Va bootparamd_enable
1724 is set to
1725 .Dq Li YES ,
1726 these are the flags to pass to the
1727 .Xr bootparamd 8
1728 daemon.
1729 .It Va stf_interface_ipv4addr
1730 .Pq Vt str
1731 If not set to
1732 .Dq Li NO ,
1733 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1734 Specify this entry to enable the 6to4 interface.
1735 .It Va stf_interface_ipv4plen
1736 .Pq Vt int
1737 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1738 An effective value is 0-31.
1739 .It Va stf_interface_ipv6_ifid
1740 .Pq Vt str
1741 IPv6 interface ID for
1742 .Xr stf 4 .
1743 This can be set to
1744 .Dq Li AUTO .
1745 .It Va stf_interface_ipv6_slaid
1746 .Pq Vt str
1747 IPv6 Site Level Aggregator for
1748 .Xr stf 4 .
1749 .It Va ipv6_faith_prefix
1750 .Pq Vt str
1751 If not set to
1752 .Dq Li NO ,
1753 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1754 You also need
1755 .Xr faithd 8
1756 setup.
1757 .It Va keybell
1758 .Pq Vt str
1759 The keyboard bell sound.
1760 Set to
1761 .Dq Li normal ,
1762 .Dq Li visual ,
1763 .Dq Li off ,
1764 or
1765 .Dq Li NO
1766 if the default behavior is desired.
1767 For details, refer to the
1768 .Xr kbdcontrol 1
1769 manpage.
1770 .It Va keymap
1771 .Pq Vt str
1772 If set to
1773 .Dq Li NO ,
1774 no keymap is installed, otherwise the value is used to install
1775 the keymap file in
1776 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1777 .It Va keyrate
1778 .Pq Vt str
1779 The keyboard repeat speed.
1780 Set to
1781 .Dq Li slow ,
1782 .Dq Li normal ,
1783 .Dq Li fast ,
1784 or
1785 .Dq Li NO
1786 if the default behavior is desired.
1787 .It Va keychange
1788 .Pq Vt str
1789 If not set to
1790 .Dq Li NO ,
1791 attempt to program the function keys with the value.
1792 The value should be a single string of the form:
1793 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1794 .It Va cursor
1795 .Pq Vt str
1796 Can be set to the value of
1797 .Dq Li normal ,
1798 .Dq Li blink ,
1799 .Dq Li destructive ,
1800 or
1801 .Dq Li NO
1802 to set the cursor behavior explicitly or choose the default behavior.
1803 .It Va scrnmap
1804 .Pq Vt str
1805 If set to
1806 .Dq Li NO ,
1807 no screen map is installed, otherwise the value is used to install
1808 the screen map file in
1809 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1810 .It Va font8x16
1811 .Pq Vt str
1812 If set to
1813 .Dq Li NO ,
1814 the default 8x16 font value is used for screen size requests, otherwise
1815 the value in
1816 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1817 is used.
1818 .It Va font8x14
1819 .Pq Vt str
1820 If set to
1821 .Dq Li NO ,
1822 the default 8x14 font value is used for screen size requests, otherwise
1823 the value in
1824 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1825 is used.
1826 .It Va font8x8
1827 .Pq Vt str
1828 If set to
1829 .Dq Li NO ,
1830 the default 8x8 font value is used for screen size requests, otherwise
1831 the value in
1832 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1833 is used.
1834 .It Va blanktime
1835 .Pq Vt int
1836 If set to
1837 .Dq Li NO ,
1838 the default screen blanking interval is used, otherwise it is set to
1839 .Ar value
1840 seconds.
1841 .It Va saver
1842 .Pq Vt str
1843 If not set to
1844 .Dq Li NO ,
1845 this is the actual screen saver to use
1846 .Li ( blank , snake , daemon ,
1847 etc).
1848 .It Va moused_nondefault_enable
1849 .Pq Vt str
1850 If set to
1851 .Dq Li NO ,
1852 the mouse device specified on
1853 the command line is not automatically treated as enabled by the
1854 .Pa /etc/rc.d/moused
1855 script.
1856 Having this variable set to
1857 .Dq Li YES
1858 allows a
1859 .Xr usb 4
1860 mouse,
1861 for example,
1862 to be enabled as soon as it is plugged in.
1863 .It Va moused_enable
1864 .Pq Vt str
1865 If set to
1866 .Dq Li YES ,
1867 the
1868 .Xr moused 8
1869 daemon is started for doing cut/paste selection on the console.
1870 .It Va moused_type
1871 .Pq Vt str
1872 This is the protocol type of the mouse connected to this host.
1873 This variable must be set if
1874 .Va moused_enable
1875 is set to
1876 .Dq Li YES .
1877 The
1878 .Xr moused 8
1879 daemon
1880 is able to detect the appropriate mouse type automatically in many cases.
1881 Set this variable to
1882 .Dq Li auto
1883 to let the daemon detect it, or
1884 select one from the following list if the automatic detection fails.
1885 .Pp
1886 If the mouse is attached to the PS/2 mouse port, choose
1887 .Dq Li auto
1888 or
1889 .Dq Li ps/2 ,
1890 regardless of the brand and model of the mouse.
1891 Likewise, if the mouse is attached to the bus mouse port, choose
1892 .Dq Li auto
1893 or
1894 .Dq Li busmouse .
1895 All other protocols are for serial mice and will not work with
1896 the PS/2 and bus mice.
1897 If this is a USB mouse,
1898 .Dq Li auto
1899 is the only protocol type which will work.
1900 .Pp
1901 .Bl -tag -width ".Li x10mouseremote" -compact
1902 .It Li microsoft
1903 Microsoft mouse (serial)
1904 .It Li intellimouse
1905 Microsoft IntelliMouse (serial)
1906 .It Li mousesystems
1907 Mouse systems Corp. mouse (serial)
1908 .It Li mmseries
1909 MM Series mouse (serial)
1910 .It Li logitech
1911 Logitech mouse (serial)
1912 .It Li busmouse
1913 A bus mouse
1914 .It Li mouseman
1915 Logitech MouseMan and TrackMan (serial)
1916 .It Li glidepoint
1917 ALPS GlidePoint (serial)
1918 .It Li thinkingmouse
1919 Kensington ThinkingMouse (serial)
1920 .It Li ps/2
1921 PS/2 mouse
1922 .It Li mmhittab
1923 MM HitTablet (serial)
1924 .It Li x10mouseremote
1925 X10 MouseRemote (serial)
1926 .It Li versapad
1927 Interlink VersaPad (serial)
1928 .El
1929 .Pp
1930 Even if the mouse is not in the above list, it may be compatible
1931 with one in the list.
1932 Refer to the man page for
1933 .Xr moused 8
1934 for compatibility information.
1935 .Pp
1936 It should also be noted that while this is enabled, any
1937 other client of the mouse (such as an X server) should access
1938 the mouse through the virtual mouse device,
1939 .Pa /dev/sysmouse ,
1940 and configure it as a
1941 .Dq Li sysmouse
1942 type mouse, since all
1943 mouse data is converted to this single canonical format when using
1944 .Xr moused 8 .
1945 If the client program does not support the
1946 .Dq Li sysmouse
1947 type, specify the
1948 .Dq Li mousesystems
1949 type.
1950 It is the second preferred type.
1951 .It Va moused_port
1952 .Pq Vt str
1953 If
1954 .Va moused_enable
1955 is set to
1956 .Dq Li YES ,
1957 this is the actual port the mouse is on.
1958 It might be
1959 .Pa /dev/cuaa0
1960 for a COM1 serial mouse or
1961 .Pa /dev/psm0
1962 for a PS/2 mouse, for example.
1963 .It Va moused_flags
1964 .Pq Vt str
1965 If
1966 .Va moused_type
1967 is set, these are the additional flags to pass to the
1968 .Xr moused 8
1969 daemon.
1970 .It Va mousechar_start
1971 .Pq Vt int
1972 If set to
1973 .Dq Li NO ,
1974 the default mouse cursor character range
1975 .Li 0xd0 Ns - Ns Li 0xd3
1976 is used, otherwise the range start is set to
1977 .Ar value
1978 character, see
1979 .Xr vidcontrol 1 .
1980 Use if the default range is occupied in the language code table.
1981 .It Va vidhistory
1982 .Pq Vt int
1983 Set the size of the history (scrollback) buffer in lines.
1984 .It Va allscreens_flags
1985 .Pq Vt str
1986 If set,
1987 .Xr vidcontrol 1
1988 is run with these options for each of the virtual terminals
1989 .Pq Pa /dev/ttyv* .
1990 For example,
1991 .Dq Fl m Cm on
1992 will enable the mouse pointer on all virtual terminals if
1993 .Va moused_enable
1994 is set to
1995 .Dq Li YES .
1996 .It Va allscreens_kbdflags
1997 .Pq Vt str
1998 If set,
1999 .Xr kbdcontrol 1
2000 is run with these options for each of the virtual terminals
2001 .Pq Pa /dev/ttyv* .
2002 For example,
2003 .Dq Fl h Li 200
2004 will set the
2005 .Xr syscons 4
2006 scrollback (history) buffer to 200 lines.
2007 .It Va cron_enable
2008 .Pq Vt bool
2009 If set to
2010 .Dq Li YES ,
2011 run the
2012 .Xr cron 8
2013 daemon at system boot time.
2014 .It Va cron_program
2015 .Pq Vt str
2016 Path to
2017 .Xr cron 8
2018 (default
2019 .Pa /usr/sbin/cron ) .
2020 .It Va cron_flags
2021 .Pq Vt str
2022 If
2023 .Va cron_enable
2024 is set to
2025 .Dq Li YES ,
2026 these are the flags to pass to
2027 .Xr cron 8 .
2028 .It Va lpd_program
2029 .Pq Vt str
2030 Path to
2031 .Xr lpd 8
2032 (default
2033 .Pa /usr/sbin/lpd ) .
2034 .It Va lpd_enable
2035 .Pq Vt bool
2036 If set to
2037 .Dq Li YES ,
2038 run the
2039 .Xr lpd 8
2040 daemon at system boot time.
2041 .It Va lpd_flags
2042 .Pq Vt str
2043 If
2044 .Va lpd_enable
2045 is set to
2046 .Dq Li YES ,
2047 these are the flags to pass to the
2048 .Xr lpd 8
2049 daemon.
2050 .It Va nscd_enable
2051 .Pq Vt bool
2052 If set to
2053 .Dq Li YES ,
2054 run the
2055 .Xr nscd 8
2056 daemon at system boot time.
2057 .It Va mixer_enable
2058 .Pq Vt bool
2059 If set to
2060 .Dq Li YES ,
2061 preserve
2062 .Xr mixer 8
2063 settings across reboots.
2064 .It Va mta_start_script
2065 .Pq Vt str
2066 The full path to the script to run to start
2067 a mail transfer agent.
2068 The default is
2069 .Pa /etc/rc.sendmail .
2070 The
2071 .Va sendmail_*
2072 variables which
2073 .Pa /etc/rc.sendmail
2074 uses are documented in the
2075 .Xr rc.sendmail 8
2076 man page.
2077 .It Va fixbootfile
2078 .Pq Vt bool
2079 In a
2080 .Sq HAMMER ROOT with UFS /boot
2081 setup, the boot loader will not set up the
2082 .Va kern.bootfile
2083 sysctl correctly.
2084 The system will attempt to fix this on its own.
2085 Set this variable to
2086 .Dq Li NO
2087 to turn this behavior off.
2088 .It Va dumpdev
2089 .Pq Vt str
2090 Indicates the device (usually a swap partition) to which a crash dump
2091 should be written in the event of a system crash.
2092 The value of this variable is passed as the argument to
2093 .Xr dumpon 8
2094 and
2095 .Xr savecore 8 .
2096 To disable crash dumps, set this variable to
2097 .Dq Li NO .
2098 .It Va dumpdir
2099 .Pq Vt str
2100 When the system reboots after a crash and a crash dump is found on the
2101 device specified by the
2102 .Va dumpdev
2103 variable,
2104 .Xr savecore 8
2105 will save that crash dump and a copy of the kernel to the directory
2106 specified by the
2107 .Va dumpdir
2108 variable.
2109 The default value is
2110 .Pa /var/crash .
2111 Set to
2112 .Dq Li NO
2113 to not run
2114 .Xr savecore 8
2115 at boot time when
2116 .Va dumpdir
2117 is set.
2118 .It Va savecore_flags
2119 .Pq Vt str
2120 If crash dumps are enabled, these are the flags to pass to the
2121 .Xr savecore 8
2122 utility.
2123 .It Va crashinfo_enable
2124 .Pq Vt bool
2125 Set to
2126 .Dq Li YES
2127 to turn on automatic crash dump summary generation using the utility
2128 specified by the
2129 .Va crashinfo_program
2130 variable.
2131 .It Va crashinfo_program
2132 .Pq Vt str
2133 Program to run to generate a crash dump summary if the variable
2134 .Va crashinfo_enable
2135 is set to
2136 .Dq Li YES .
2137 The default value is
2138 .Pa /usr/sbin/crashinfo .
2139 .It Va enable_quotas
2140 .Pq Vt bool
2141 Set to
2142 .Dq Li YES
2143 to turn on user disk quotas on system startup via the
2144 .Xr quotaon 8
2145 command.
2146 .It Va check_quotas
2147 .Pq Vt bool
2148 Set to
2149 .Dq Li YES
2150 to enable user disk quota checking via the
2151 .Xr quotacheck 8
2152 command.
2153 .It Va accounting_enable
2154 .Pq Vt bool
2155 Set to
2156 .Dq Li YES
2157 to enable system accounting through the
2158 .Xr accton 8
2159 facility.
2160 .It Va linux_enable
2161 .Pq Vt bool
2162 Set to
2163 .Dq Li YES
2164 to enable Linux/ELF binary emulation at system initial boot time.
2165 .\" ----- cleanvar_enable setting--------------------------------
2166 .It Va cleanvar_enable
2167 .Pq Vt bool
2168 Set to
2169 .Dq Li YES
2170 to have
2171 .Pa /var/run ,
2172 .Pa /var/spool/lock
2173 and
2174 .Pa /var/spool/uucp/.Temp/*
2175 cleaned at startup.
2176 .\" ----- clear_tmp_enable setting-------------------------------
2177 .It Va clear_tmp_enable
2178 .Pq Vt bool
2179 Set to
2180 .Dq Li YES
2181 to have
2182 .Pa /tmp
2183 cleaned at startup.
2184 .\" ----- ldconfig_paths setting --------------------------------
2185 .It Va ldconfig_paths
2186 .Pq Vt str
2187 Set to the list of shared library paths to use with
2188 .Xr ldconfig 8 .
2189 NOTE:
2190 .Pa /usr/lib
2191 will always be added first, so it need not appear in this list.
2192 .It Va ldconfig_insecure
2193 .Pq Vt bool
2194 The
2195 .Xr ldconfig 8
2196 utility normally refuses to use directories
2197 which are writable by anyone except root.
2198 Set this variable to
2199 .Dq Li YES
2200 to disable that security check during system startup.
2201 .It Va ldconfig_local_dirs
2202 .Pq Vt str
2203 Set to the list of local
2204 .Xr ldconfig 8
2205 directories.
2206 The names of all files in the directories listed will be
2207 passed as arguments to
2208 .Xr ldconfig 8 .
2209 .It Va kern_securelevel
2210 .Pq Vt int
2211 The kernel security level to set at startup.
2212 The allowed range of
2213 .Ar value
2214 ranges from \-1 (the compile time default) to 3 (the most secure).
2215 See
2216 .Xr init 8
2217 for the list of possible security levels and their effect on system operation.
2218 .It Va start_vinum
2219 .Pq Vt bool
2220 Set to
2221 .Dq Li YES
2222 to start
2223 .Xr vinum 8
2224 at system boot time.
2225 .It Va sshd_enable
2226 .Pq Vt bool
2227 Set to
2228 .Dq Li YES
2229 to start
2230 .Xr sshd 8
2231 at system boot time.
2232 .It Va sshd_program
2233 .Pq Vt str
2234 Path to the SSH server program
2235 (default
2236 .Pa /usr/sbin/sshd ) .
2237 .It Va sshd_flags
2238 .Pq Vt str
2239 If
2240 .Va sshd_enable
2241 is set to
2242 .Dq Li YES ,
2243 these are the flags to pass to the
2244 .Xr sshd 8
2245 daemon.
2246 .It Va ftpd_enable
2247 .Pq Vt bool
2248 Set to
2249 .Dq Li YES
2250 to start
2251 .Xr ftpd 8
2252 at system boot time.
2253 .It Va ftpd_flags
2254 .Pq Vt str
2255 If
2256 .Va ftpd_enable
2257 is set to
2258 .Dq Li YES ,
2259 these are the flags to pass to the
2260 .Xr ftpd 8
2261 daemon.
2262 .It Va watchdogd_enable
2263 .Pq Vt bool
2264 If set to
2265 .Dq Li YES ,
2266 start the
2267 .Xr watchdogd 8
2268 daemon at boot time.
2269 This requires that the kernel have been compiled with
2270 .Cd "options WATCHDOG" .
2271 .It Va jail_enable
2272 .Pq Vt bool
2273 If set to
2274 .Dq Li NO ,
2275 any configured jails will not be started.
2276 .It Va jail_list
2277 .Pq Vt str
2278 A space separated list of names for jails.
2279 This is purely a configuration aid to help identify and
2280 configure multiple jails.
2281 The names specified in this list will be used to
2282 identify settings common to an instance of a jail.
2283 Assuming that the jail in question was named
2284 .Li vjail ,
2285 you would have the following dependent variables:
2286 .Bd -literal
2287 jail_vjail_hostname="jail.example.com"
2288 jail_vjail_ip="192.168.1.100"
2289 jail_vjail_rootdir="/var/jails/vjail/root"
2290 .Ed
2291 .It Va jail_flags
2292 .Pq Vt str
2293 Unset by default.
2294 When set, use as default value for
2295 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2296 for every jail in
2297 .Va jail_list .
2298 .It Va jail_interface
2299 .Pq Vt str
2300 Unset by default.
2301 When set, use as default value for
2302 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2303 for every jail in
2304 .Va jail_list .
2305 .It Va jail_fstab
2306 .Pq Vt str
2307 Unset by default.
2308 When set, use as default value for
2309 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2310 for every jail in
2311 .Va jail_list .
2312 .It Va jail_mount_enable
2313 .Pq Vt bool
2314 Set to
2315 .Dq Li NO
2316 by default.
2317 When set to
2318 .Dq Li YES ,
2319 sets
2320 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2321 to
2322 .Dq Li YES
2323 by default for every jail in
2324 .Va jail_list .
2325 .It Va jail_procfs_enable
2326 .Pq Vt bool
2327 Set to
2328 .Dq Li NO
2329 by default.
2330 When set to
2331 .Dq Li YES ,
2332 sets
2333 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2334 to
2335 .Dq Li YES
2336 by default for every jail in
2337 .Va jail_list .
2338 .It Va jail_devfs_enable
2339 .Pq Vt bool
2340 Set to
2341 .Dq Li NO
2342 by default.
2343 When set to
2344 .Dq Li YES ,
2345 sets
2346 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2347 to
2348 .Dq Li YES
2349 by default for every jail in
2350 .Va jail_list .
2351 .It Va jail_exec_start
2352 .Pq Vt str
2353 Unset by default.
2354 When set, use as default value for
2355 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2356 for every jail in
2357 .Va jail_list .
2358 .It Va jail_exec_stop
2359 Unset by default.
2360 When set, use as default value for
2361 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2362 for every jail in
2363 .Va jail_list .
2364 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2365 .Pq Vt str
2366 Unset by default.
2367 Set to the root directory used by jail
2368 .Va jname .
2369 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2370 .Pq Vt str
2371 Unset by default.
2372 Set to the fully qualified domain name (FQDN) assigned to jail
2373 .Va jname .
2374 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2375 .Pq Vt str
2376 Unset by default.
2377 Set to the IP address assigned to jail
2378 .Va jname .
2379 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2380 .Pq Vt str
2381 Set to
2382 .Dq Li -l -U root
2383 by default.
2384 These are flags to pass to
2385 .Xr jail 8 .
2386 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2387 .Pq Vt str
2388 Unset by default.
2389 When set, sets the interface to use when setting IP address alias.
2390 Note that the alias is created at jail startup and removed at jail shutdown.
2391 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2392 .Pq Vt str
2393 Set to
2394 .Pa /etc/fstab. Ns Aq Ar jname
2395 by default.
2396 This is the file system information file to use for jail
2397 .Va jname .
2398 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2399 .Pq Vt bool
2400 Set to
2401 .Dq Li NO
2402 by default.
2403 When set to
2404 .Dq Li YES ,
2405 mount all file systems from
2406 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2407 at jail startup.
2408 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2409 .Pq Vt bool
2410 Set to
2411 .Dq Li NO
2412 by default.
2413 When set to
2414 .Dq Li YES ,
2415 mount the process file system inside jail
2416 .Ar jname
2417 at jail startup.
2418 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2419 .Pq Vt bool
2420 Set to
2421 .Dq Li NO
2422 by default.
2423 When set to
2424 .Dq Li YES ,
2425 mount the device file system inside jail
2426 .Ar jname
2427 at jail startup.
2428 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2429 .Pq Vt str
2430 Set to
2431 .Dq Li /bin/sh /etc/rc
2432 by default.
2433 This is the command executed at jail startup.
2434 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2435 .Pq Vt str
2436 Set to
2437 .Dq Li /bin/sh /etc/rc.shutdown
2438 by default.
2439 This is the command executed at jail shutdown.
2440 .It Va jail_set_hostname_allow
2441 .Pq Vt bool
2442 If set to
2443 .Dq Li NO ,
2444 do not allow the root user in a jail to set its hostname.
2445 .It Va jail_socket_unixiproute_only
2446 .Pq Vt bool
2447 If set to
2448 .Dq Li YES ,
2449 do not allow any sockets,
2450 besides UNIX/IP/route sockets,
2451 to be used within a jail.
2452 .It Va jail_sysvipc_allow
2453 .Pq Vt bool
2454 If set to
2455 .Dq Li YES ,
2456 allow applications within a jail to use System V IPC.
2457 .It Va lvm_enable
2458 .Pq Vt bool
2459 If set to
2460 .Dq Li YES
2461 LVM volumes will be discovered and configured on boot.
2462 .It Va newsyslog_enable
2463 .Pq Vt bool
2464 If set to
2465 .Dq Li YES ,
2466 run
2467 .Xr newsyslog 8
2468 before syslogd starts.
2469 .It Va newsyslog_flags
2470 .Pq Vt str
2471 If
2472 .Va newsyslog_enable
2473 is set to
2474 .Dq Li YES ,
2475 these are the flags passed to
2476 .Xr newsyslog 8 .
2477 .It Va resident_enable
2478 .Pq Vt bool
2479 If set to
2480 .Dq Li YES ,
2481 make the dynamic binaries listed in
2482 .Pa /etc/resident.conf
2483 resident.
2484 .It Va varsym_enable
2485 .Pq Vt bool
2486 If set to
2487 .Dq Li YES ,
2488 process
2489 .Pa /etc/varsym.conf
2490 to set system-wide variables for variant symlinks.
2491 .It Va rand_irqs
2492 .Pq Vt str
2493 Set either to
2494 .Dq Li NO
2495 or a whitespace separated list of IRQ numbers which will be used as a source of
2496 randomness.
2497 .\" -----------------------------------------------------
2498 .It Va entropy_dir
2499 .Pq Vt str
2500 Set to
2501 .Dq Li NO
2502 to disable caching entropy via
2503 .Xr cron 8 .
2504 Otherwise set to the directory used to store entropy files in.
2505 .It Va entropy_file
2506 .Pq Vt str
2507 Set to
2508 .Dq Li NO
2509 to disable caching entropy through reboots.
2510 Otherwise set to the filename used to store cached entropy through reboots.
2511 This file should be located on the root file system to seed the
2512 .Xr random 4
2513 device as early as possible in the boot process.
2514 .It Va entropy_save_sz
2515 .Pq Vt int
2516 Determines the size of the entropy cache files used for entropy cached
2517 through reboots and also entropy cached via
2518 .Xr cron 8 .
2519 The entropy is fed to the system in blocks of 512 bytes, so this number
2520 should be large enough to fill as many of the entropy pools in the kernel
2521 CSPRNG as possible.
2522 By default, it is set to 16384, which should be able to seed all 32 entropy
2523 pools in the Fortuna CSPRNG.
2524 .It Va ipsec_enable
2525 .Pq Vt bool
2526 Set to
2527 .Dq Li YES
2528 to run
2529 .Xr setkey 8
2530 on
2531 .Va ipsec_file
2532 at boot time.
2533 .It Va ipsec_file
2534 .Pq Vt str
2535 Configuration file for
2536 .Xr setkey 8 .
2537 .It Va dmesg_enable
2538 .Pq Vt bool
2539 Set to
2540 .Dq Li YES
2541 to save
2542 .Xr dmesg 8
2543 to
2544 .Pa /var/run/dmesg.boot
2545 on boot.
2546 .It Va rcshutdown_timeout
2547 .Pq Vt int
2548 If set, start a watchdog timer in the background which will terminate
2549 .Pa rc.shutdown
2550 if
2551 .Xr shutdown 8
2552 has not completed within the specified time (in seconds).
2553 Notice that in addition to this soft timeout,
2554 .Xr init 8
2555 also applies a hard timeout for the execution of
2556 .Pa rc.shutdown .
2557 This is configured via
2558 .Xr sysctl 8
2559 variable
2560 .Va kern.init_shutdown_timeout
2561 and defaults to 120 seconds. Setting the value of
2562 .Va rcshutdown_timeout
2563 to more than 120 seconds will have no effect until the
2564 .Xr sysctl 8
2565 variable
2566 .Va kern.init_shutdown_timeout
2567 is also increased.
2568 .It Va udevd_enable
2569 .Pq Vt bool
2570 If set to
2571 .Dq Li YES ,
2572 the udevd daemon will be started on boot.
2573 .It Va vfs_quota_enable
2574 .Pq Vt bool
2575 If set to
2576 .Dq Li YES ,
2577 vfs quota rc.d scripts will be run on boot.
2578 .It Va vfs_quota_sync
2579 .Pq Vt str
2580 List of mount points whose counters are to be synchronized with on-disk
2581 usage during system startup. See also
2582 .Xr vquota 8 .
2583 .It Va vknetd_enable
2584 .Pq Vt bool
2585 If set to
2586 .Dq Li YES ,
2587 .Xr vknetd 8
2588 will be started on boot.
2589 .It Va vknetd_flags
2590 .Pq Vt bool
2591 Additional flags passed to
2592 .Xr vknetd 8 .
2593 Usually address/cidrbits is specified here.
2594 When no flags are passed, default option
2595 .Fl U
2596 will be used.
2597 .It Va vkernel_enable
2598 .Pq Vt bool
2599 If set to
2600 .Dq Li NO ,
2601 any configured vkernels will not be started.
2602 .It Va vkernel_kill_timeout
2603 .Pq Vt int
2604 This defines the default number of seconds that we will wait for the
2605 vkernel to shut down on it's own. If after this time it's still alive,
2606 it will be killed with SIGKILL.
2607 .It Va vkernel_bin
2608 .Pq Vt str
2609 Defines the default path to the vkernel binary.
2610 .It Va vkernel_list
2611 .Pq Vt str
2612 A space separated list of names for vkernels.
2613 This is purely a configuration aid to help identify and
2614 configure multiple vkernels.
2615 The names specified in this list will be used to
2616 identify settings common to a vkernel instance.
2617 Assuming that the vkernel in question was named
2618 .Li example ,
2619 you would have the following dependent variables
2620 (filled with reference values in this text):
2621 .Bd -literal
2622 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2623 vkernel_example_memsize="64m"
2624 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2625 vkernel_example_iface_list="auto:bridge0"
2626 vkernel_example_logfile="/dev/null"
2627 vkernel_example_flags="-U"
2628 vkernel_example_kill_timeout="45"
2629 .Ed
2630 .Pp
2631 The last five are optional.
2632 They default to an empty string if not set, except for logfile which defaults to
2633 .Pa /dev/null
2634 if it is not set.
2635 .El
2636 .Sh FILES
2637 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2638 .It Pa /etc/defaults/rc.conf
2639 .It Pa /etc/rc.conf
2640 .It Pa /etc/rc.conf.local
2641 .It Pa /etc/start_if. Ns Aq Ar interface
2642 .El
2643 .Sh SEE ALSO
2644 .Xr catman 1 ,
2645 .Xr gdb 1 ,
2646 .Xr info 1 ,
2647 .Xr kbdcontrol 1 ,
2648 .Xr varsym 1 ,
2649 .Xr vidcontrol 1 ,
2650 .Xr ip 4 ,
2651 .Xr ipfw 4 ,
2652 .Xr kld 4 ,
2653 .Xr pf 4 ,
2654 .Xr tcp 4 ,
2655 .Xr udp 4 ,
2656 .Xr vlan 4 ,
2657 .Xr exports 5 ,
2658 .Xr motd 5 ,
2659 .Xr resident.conf 5 ,
2660 .Xr varsym.conf 5 ,
2661 .Xr accton 8 ,
2662 .Xr amd 8 ,
2663 .Xr apm 8 ,
2664 .Xr btconfig 8 ,
2665 .Xr bthcid 8 ,
2666 .Xr cron 8 ,
2667 .Xr devd 8 ,
2668 .Xr dhclient 8 ,
2669 .Xr dntpd 8 ,
2670 .Xr ftpd 8 ,
2671 .Xr ifconfig 8 ,
2672 .Xr inetd 8 ,
2673 .Xr jail 8 ,
2674 .Xr lpd 8 ,
2675 .Xr makewhatis 8 ,
2676 .Xr mixer 8 ,
2677 .Xr mountd 8 ,
2678 .Xr moused 8 ,
2679 .Xr mrouted 8 ,
2680 .Xr named 8 ,
2681 .Xr nfsd 8 ,
2682 .Xr pcnfsd 8 ,
2683 .Xr pfctl 8 ,
2684 .Xr pflogd 8 ,
2685 .Xr quotacheck 8 ,
2686 .Xr quotaon 8 ,
2687 .Xr rc 8 ,
2688 .Xr rc.sendmail 8 ,
2689 .Xr resident 8 ,
2690 .Xr rndcontrol 8 ,
2691 .Xr route 8 ,
2692 .Xr routed 8 ,
2693 .Xr rpcbind 8 ,
2694 .Xr rpc.lockd 8 ,
2695 .Xr rpc.statd 8 ,
2696 .Xr rtadvd 8 ,
2697 .Xr rtsold 8 ,
2698 .Xr rwhod 8 ,
2699 .Xr savecore 8 ,
2700 .Xr sdpd 8 ,
2701 .Xr sensorsd 8 ,
2702 .Xr sshd 8 ,
2703 .Xr swapon 8 ,
2704 .Xr sysctl 8 ,
2705 .Xr syslogd 8 ,
2706 .Xr sysvipcd 8 ,
2707 .Xr timed 8 ,
2708 .Xr vinum 8 ,
2709 .Xr yp 8 ,
2710 .Xr ypbind 8 ,
2711 .Xr ypserv 8 ,
2712 .Xr ypset 8
2713 .Sh HISTORY
2714 The
2715 .Nm
2716 file appeared in
2717 .Fx 2.2.2 .
2718 .Sh AUTHORS
2719 .An Jordan K. Hubbard .