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