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