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 .It Va ppp_user
 917 .Pq Vt str
 918 The name of the user under which
 919 .Xr ppp 8
 920 should be started.
 921 By default,
 922 .Xr ppp 8
 923 is started as
 924 .Dq Li root .
 925 .It Va rc_conf_files
 926 .Pq Vt str
 927 This option is used to specify a list of files that will override
 928 the settings in
 929 .Pa /etc/defaults/rc.conf .
 930 The files will be read in the order in which they are specified and should
 931 include the full path to the file.
 932 By default, the files specified are
 933 .Pa /etc/rc.conf
 934 and
 935 .Pa /etc/rc.conf.local
 936 .It Va fsck_y_enable
 937 .Pq Vt bool
 938 If set to
 939 .Dq Li YES ,
 940 .Xr fsck 8
 941 will be run with the
 942 .Fl y
 943 flag if the initial preen of the file systems fails.
 944 .It Va netfs_types
 945 .Pq Vt str
 946 List of file system types that are network-based.
 947 This list should generally not be modified by end users.
 948 Use
 949 .Va extra_netfs_types
 950 instead.
 951 .It Va extra_netfs_types
 952 .Pq Vt str
 953 If set to something other than
 954 .Dq Li NO
 955 (the default), this variable extends the list of file system types
 956 for which automatic mounting at startup by
 957 .Xr rc 8
 958 should be delayed until the network is initialized.
 959 It should contain
 960 a whitespace-separated list of network file system descriptor pairs,
 961 each consisting of a file system type as passed to
 962 .Xr mount 8
 963 and a human-readable, one-word description, joined with a colon
 964 .Pq Ql \&: .
 965 Extending the default list in this way is only necessary
 966 when third party file system types are used.
 967 .It Va devfs_config_files
 968 .Pq Vt str
 969 This option is used to specify a list of configuration files containing
 970 .Xr devfs 5
 971 rules that will be applied by
 972 .Xr devfsctl 8
 973 in the order in which they are specified and must include the full path
 974 to the file.
 975 .It Va syslogd_enable
 976 .Pq Vt bool
 977 If set to
 978 .Dq Li YES ,
 979 run the
 980 .Xr syslogd 8
 981 daemon.
 982 .It Va syslogd_program
 983 .Pq Vt str
 984 Path to
 985 .Xr syslogd 8
 986 (default
 987 .Pa /usr/sbin/syslogd ) .
 988 .It Va syslogd_flags
 989 .Pq Vt str
 990 If
 991 .Va syslogd_enable
 992 is set to
 993 .Dq Li YES ,
 994 these are the flags to pass to
 995 .Xr syslogd 8 .
 996 .It Va inetd_enable
 997 .Pq Vt bool
 998 If set to
 999 .Dq Li YES ,
1000 run the
1001 .Xr inetd 8
1002 daemon.
1003 .It Va inetd_program
1004 .Pq Vt str
1005 Path to
1006 .Xr inetd 8
1007 (default
1008 .Pa /usr/sbin/inetd ) .
1009 .It Va inetd_flags
1010 .Pq Vt str
1011 If
1012 .Va inetd_enable
1013 is set to
1014 .Dq Li YES ,
1015 these are the flags to pass to
1016 .Xr inetd 8 .
1017 .It Va rwhod_enable
1018 .Pq Vt bool
1019 If set to
1020 .Dq Li YES ,
1021 run the
1022 .Xr rwhod 8
1023 daemon at boot time.
1024 .It Va rwhod_flags
1025 .Pq Vt str
1026 If
1027 .Va rwhod_enable
1028 is set to
1029 .Dq Li YES ,
1030 these are the flags to pass to it.
1031 .It Va amd_enable
1032 .Pq Vt bool
1033 If set to
1034 .Dq Li YES ,
1035 run the
1036 .Xr amd 8
1037 daemon at boot time.
1038 .It Va amd_flags
1039 .Pq Vt str
1040 If
1041 .Va amd_enable
1042 is set to
1043 .Dq Li YES ,
1044 these are the flags to pass to it.
1045 See the
1046 .Xr amd 8
1047 manpage for more information.
1048 .It Va amd_map_program
1049 .Pq Vt str
1050 If set, the specified program is run to get the list of
1051 .Xr amd 8
1052 maps.
1053 For example, if the
1054 .Xr amd 8
1055 maps are stored in NIS, one can set this to run
1056 .Xr ypcat 1
1057 to get a list of
1058 .Xr amd 8
1059 maps from the
1060 .Pa amd.master
1061 NIS map.
1062 .It Va update_motd
1063 .Pq Vt bool
1064 If set to
1065 .Dq Li YES ,
1066 .Pa /etc/motd
1067 will be updated at boot time to reflect the kernel release being run.
1068 If set to
1069 .Dq Li NO ,
1070 .Pa /etc/motd
1071 will not be updated.
1072 .It Va nfs_client_enable
1073 .Pq Vt bool
1074 If set to
1075 .Dq Li YES ,
1076 setup NFS client parameters at boot time.
1077 .It Va nfs_access_cache
1078 .Pq Vt int
1079 If
1080 .Va nfs_client_enable
1081 is set to
1082 .Dq Li YES ,
1083 this can be set to
1084 .Dq Li 0
1085 to disable NFS ACCESS RPC caching, or to the number of seconds for which
1086 NFS ACCESS results should be cached.
1087 A value of 2-10 seconds will substantially reduce network traffic for
1088 many NFS operations.
1089 The default is 5 seconds.
1090 Note that the attribute cache holds stat information only.
1091 The NFS data cache is independent of the attribute cache and is only
1092 invalidated when the client detects that the server has modified the
1093 underlying file.
1094 This value specifies a maximum timeout.
1095 The NFS client will automatically use a shorter timeout for files which
1096 have been recently modified.
1097 .It Va nfs_neg_cache
1098 .Pq Vt int
1099 If
1100 .Va nfs_client_enable
1101 is set to
1102 .Dq Li YES ,
1103 this can be set to
1104 .Dq Li 0
1105 to disable the caching of NEGATIVE LOOKUPS (lookups of non-existent
1106 filenames), or to the number of seconds for which negative lookups should
1107 be cached.
1108 A value of 2-10 seconds will substantially reduce network
1109 traffic for many NFS operations, especially source code builds.
1110 The default is 3 seconds.
1111 .It Va nfs_server_enable
1112 .Pq Vt bool
1113 If set to
1114 .Dq Li YES ,
1115 run the NFS server daemons at boot time.
1116 .It Va nfs_server_flags
1117 .Pq Vt str
1118 If
1119 .Va nfs_server_enable
1120 is set to
1121 .Dq Li YES ,
1122 these are the flags to pass to the
1123 .Xr nfsd 8
1124 daemon.
1125 .It Va mountd_enable
1126 .Pq Vt bool
1127 If set to
1128 .Dq Li YES ,
1129 and no
1130 .Va nfs_server_enable
1131 is set, start
1132 .Xr mountd 8 ,
1133 but not
1134 .Xr nfsd 8
1135 daemon.
1136 It is commonly needed to run CFS without real NFS used.
1137 .It Va mountd_flags
1138 .Pq Vt str
1139 If
1140 .Va mountd_enable
1141 is set to
1142 .Dq Li YES ,
1143 these are the flags to pass to the
1144 .Xr mountd 8
1145 daemon.
1146 .It Va weak_mountd_authentication
1147 .Pq Vt bool
1148 If set to
1149 .Dq Li YES ,
1150 allow services like PCNFSD to make non-privileged mount requests.
1151 .It Va nfs_reserved_port_only
1152 .Pq Vt bool
1153 If set to
1154 .Dq Li YES ,
1155 provide NFS services only on a secure port.
1156 .It Va nfs_bufpackets
1157 .Pq Vt int
1158 If set to a number, indicates the number of packets worth of
1159 socket buffer space to reserve on an NFS client.
1160 The kernel default is typically 4.
1161 Using a higher number may be useful on gigabit networks to improve performance.
1162 The minimum value is 2 and the maximum is 64.
1163 .It Va rpc_umntall_enable
1164 .Pq Vt bool
1165 If set to
1166 .Dq Li YES
1167 (default) and we are also an NFS client, run
1168 .Xr rpc.umntall 8
1169 at boot time to clear out old mounts on remote servers.
1170 If set to
1171 .Dq Li NO
1172 then
1173 .Xr rpc.umntall 8
1174 will not be run at boot time.
1175 .It Va rpc_lockd_enable
1176 .Pq Vt bool
1177 If set to
1178 .Dq Li YES
1179 and also an NFS server, run
1180 .Xr rpc.lockd 8
1181 at boot time.
1182 .It Va rpc_lockd_flags
1183 .Pq Vt str
1184 If
1185 .Va rpc_lockd_enable
1186 is set to
1187 .Dq Li YES ,
1188 these are the flags to pass to
1189 .Xr rpc.lockd 8 .
1190 .It Va rpc_statd_enable
1191 .Pq Vt bool
1192 If set to
1193 .Dq Li YES
1194 and also an NFS server, run
1195 .Xr rpc.statd 8
1196 at boot time.
1197 .It Va rpc_statd_flags
1198 .Pq Vt str
1199 If
1200 .Va rpc_statd_enable
1201 is set to
1202 .Dq Li YES ,
1203 these are the flags to pass to
1204 .Xr rpc.statd 8 .
1205 .It Va rpcbind_program
1206 .Pq Vt str
1207 Path to program for rpcbind daemon
1208 (default
1209 .Pa /usr/sbin/rpcbind ) .
1210 .It Va rpcbind_enable
1211 .Pq Vt bool
1212 If set to
1213 .Dq Li YES ,
1214 run
1215 .Va rpcbind_program
1216 at boot time.
1217 .It Va rpcbind_flags
1218 .Pq Vt str
1219 If
1220 .Va rpcbind_enable
1221 is set to
1222 .Dq Li YES ,
1223 these are the flags to pass to
1224 .Va rpcbind_program .
1225 .It Va keyserv_enable
1226 .Pq Vt bool
1227 If set to
1228 .Dq Li YES ,
1229 run the
1230 .Xr keyserv 8
1231 daemon on boot for running Secure RPC.
1232 .It Va keyserv_flags
1233 .Pq Vt str
1234 If
1235 .Va keyserv_enable
1236 is set to
1237 .Dq Li YES ,
1238 these are the flags to pass to
1239 .Xr keyserv 8
1240 daemon.
1241 .It Va pppoed_enable
1242 .Pq Vt bool
1243 If set to
1244 .Dq Li YES ,
1245 run the
1246 .Xr pppoed 8
1247 daemon at boot time to provide PPP over Ethernet services.
1248 .It Va pppoed_provider
1249 .Pq Vt str
1250 .Xr pppoed 8
1251 listens to requests to this provider and ultimately runs
1252 .Xr ppp 8
1253 with a
1254 .Ar system
1255 argument of the same name.
1256 .It Va pppoed_flags
1257 .Pq Vt str
1258 Additional flags to pass to
1259 .Xr pppoed 8 .
1260 .It Va pppoed_interface
1261 .Pq Vt str
1262 The network interface to run
1263 .Xr pppoed 8
1264 on.
1265 This is mandatory when
1266 .Va pppoed_enable
1267 is set to
1268 .Dq Li YES .
1269 .It Va timed_enable
1270 .Pq Vt bool
1271 If set to
1272 .Dq Li YES ,
1273 run the
1274 .Xr timed 8
1275 service at boot time.
1276 This command is intended for networks of machines where a consistent
1277 .Dq "network time"
1278 for all hosts must be established.
1279 This is often useful in large NFS environments where time stamps on
1280 files are expected to be consistent network-wide.
1281 .It Va timed_flags
1282 .Pq Vt str
1283 If
1284 .Va timed_enable
1285 is set to
1286 .Dq Li YES ,
1287 these are the flags to pass to the
1288 .Xr timed 8
1289 service.
1290 .It Va dntpd_enable
1291 .Pq Vt bool
1292 If set to
1293 .Dq Li YES ,
1294 run
1295 .Xr dntpd 8
1296 at system boot time.
1297 .It Va dntpd_program
1298 .Pq Vt str
1299 Path to
1300 .Xr dntpd 8
1301 (default
1302 .Pa /usr/sbin/dntpd ) .
1303 .It Va dntpd_flags
1304 .Pq Vt str
1305 If
1306 .Va dntpd_enable
1307 is set to
1308 .Dq Li YES ,
1309 these are the flags to pass to the
1310 .Xr dntpd 8
1311 daemon.
1312 .It Va btconfig_enable
1313 .Pq Vt bool
1314 If set to
1315 .Dq Li YES ,
1316 configure Bluetooth devices via
1317 .Xr btconfig 8
1318 at system boot time.
1319 .It Va btconfig_devices
1320 .Pq Vt str
1321 If
1322 .Va btconfig_enable
1323 is set to
1324 .Dq Li YES ,
1325 this is the list of Bluetooth devices to configure.
1326 If
1327 .Va btconfig_devices
1328 is not specified, all devices known to the system will be configured.
1329 A
1330 .Va btconfig_ Ns Aq Ar device
1331 variable can be set to specify parameters to be passed to
1332 .Ar device .
1333 .It Va btconfig_args
1334 .Pq Vt str
1335 If
1336 .Va btconfig_enable
1337 is set to
1338 .Dq Li YES ,
1339 this is the list of configuration parameters to pass to all Bluetooth
1340 devices.
1341 .It Va sdpd_enable
1342 .Pq Vt bool
1343 If set to
1344 .Dq Li YES ,
1345 run the Service Discovery Profile daemon
1346 .Xr ( sdpd 8 )
1347 at system boot time.
1348 .It Va sdpd_flags
1349 .Pq Vt str
1350 If
1351 .Va sdpd_enable
1352 is set to
1353 .Dq Li YES ,
1354 these are the flags to pass to the
1355 .Xr sdpd 8
1356 daemon.
1357 .It Va bthcid_enable
1358 .Pq Vt bool
1359 If set to
1360 .Dq Li YES ,
1361 run the Bluetooth Link Key/PIN Code Manager daemon
1362 .Xr ( bthcid 8 )
1363 at system boot time.
1364 .It Va bthcid_flags
1365 .Pq Vt str
1366 If
1367 .Va bthcid_enable
1368 is set to
1369 .Dq Li YES ,
1370 these are the flags to pass to the
1371 .Xr bthcid 8
1372 daemon.
1373 .It Va nis_client_enable
1374 .Pq Vt bool
1375 If set to
1376 .Dq Li YES ,
1377 run the
1378 .Xr ypbind 8
1379 service at system boot time.
1380 .It Va nis_client_flags
1381 .Pq Vt str
1382 If
1383 .Va nis_client_enable
1384 is set to
1385 .Dq Li YES ,
1386 these are the flags to pass to the
1387 .Xr ypbind 8
1388 service.
1389 .It Va nis_ypset_enable
1390 .Pq Vt bool
1391 If set to
1392 .Dq Li YES ,
1393 run the
1394 .Xr ypset 8
1395 daemon at system boot time.
1396 .It Va nis_ypset_flags
1397 .Pq Vt str
1398 If
1399 .Va nis_ypset_enable
1400 is set to
1401 .Dq Li YES ,
1402 these are the flags to pass to the
1403 .Xr ypset 8
1404 daemon.
1405 .It Va nis_server_enable
1406 .Pq Vt bool
1407 If set to
1408 .Dq Li YES ,
1409 run the
1410 .Xr ypserv 8
1411 daemon at system boot time.
1412 .It Va nis_server_flags
1413 .Pq Vt str
1414 If
1415 .Va nis_server_enable
1416 is set to
1417 .Dq Li YES ,
1418 these are the flags to pass to the
1419 .Xr ypserv 8
1420 daemon.
1421 .It Va nis_ypxfrd_enable
1422 .Pq Vt bool
1423 If set to
1424 .Dq Li YES ,
1425 run the
1426 .Xr rpc.ypxfrd 8
1427 daemon at system boot time.
1428 .It Va nis_ypxfrd_flags
1429 .Pq Vt str
1430 If
1431 .Va nis_ypxfrd_enable
1432 is set to
1433 .Dq Li YES ,
1434 these are the flags to pass to the
1435 .Xr rpc.ypxfrd 8
1436 daemon.
1437 .It Va nis_yppasswdd_enable
1438 .Pq Vt bool
1439 If set to
1440 .Dq Li YES ,
1441 run the
1442 .Xr rpc.yppasswdd 8
1443 daemon at system boot time.
1444 .It Va nis_yppasswdd_flags
1445 .Pq Vt str
1446 If
1447 .Va nis_yppasswdd_enable
1448 is set to
1449 .Dq Li YES ,
1450 these are the flags to pass to the
1451 .Xr rpc.yppasswdd 8
1452 daemon.
1453 .It Va rpc_ypupdated_enable
1454 .Pq Vt bool
1455 If set to
1456 .Dq Li YES ,
1457 run the
1458 .Nm rpc.ypupdated
1459 daemon at system boot time.
1460 .It Va defaultrouter
1461 .Pq Vt str
1462 If not set to
1463 .Dq Li NO ,
1464 create a default route to this host name or IP address
1465 (use an IP address if this router is also required to get to the
1466 name server!).
1467 .It Va ipv6_defaultrouter
1468 .Pq Vt str
1469 The IPv6 equivalent of
1470 .Va defaultrouter .
1471 .It Va static_routes
1472 .Pq Vt str
1473 Set to the list of static routes that are to be added at system boot time.
1474 If not set to
1475 .Dq Li NO
1476 then for each whitespace separated
1477 .Ar element
1478 in the value, a
1479 .Va route_ Ns Aq Ar element
1480 variable is assumed to exist whose contents will later be passed to a
1481 .Dq Nm route Cm add
1482 operation.
1483 .It Va change_routes
1484 .Pq Vt str
1485 Set to the list of static routes that are to be changed at system boot time
1486 (such as those added by the kernel).
1487 If not set to
1488 .Dq Li NO
1489 then for each whitespace separated
1490 .Ar element
1491 in the value, a
1492 .Va change_route_ Ns Aq Ar element
1493 variable is assumed to exist whose contents will later be passed to a
1494 .Dq Nm route Cm change
1495 operation.
1496 .It Va ipv6_static_routes
1497 .Pq Vt str
1498 The IPv6 equivalent of
1499 .Va static_routes .
1500 If not set to
1501 .Dq Li NO
1502 then for each whitespace separated
1503 .Ar element
1504 in the value, a
1505 .Va ipv6_route_ Ns Aq Ar element
1506 variable is assumed to exist whose contents will later be passed to a
1507 .Dq Nm route Cm add Fl inet6
1508 operation.
1509 .It Va gateway_enable
1510 .Pq Vt bool
1511 If set to
1512 .Dq Li YES ,
1513 configure host to act as an IP router, e.g. to forward packets
1514 between interfaces.
1515 .It Va ipv6_gateway_enable
1516 .Pq Vt bool
1517 The IPv6 equivalent of
1518 .Va gateway_enable .
1519 .It Va router_enable
1520 .Pq Vt bool
1521 If set to
1522 .Dq Li YES ,
1523 run a routing daemon of some sort, based on the settings of
1524 .Va router_program
1525 and
1526 .Va router_flags .
1527 .It Va ipv6_router_enable
1528 .Pq Vt bool
1529 The IPv6 equivalent of
1530 .Va router_enable .
1531 If set to
1532 .Dq Li YES ,
1533 run a routing daemon of some sort, based on the settings of
1534 .Va ipv6_router_program
1535 and
1536 .Va ipv6_router_flags .
1537 .It Va router_program
1538 .Pq Vt str
1539 If
1540 .Va router_enable
1541 is set to
1542 .Dq Li YES ,
1543 this is the name of the routing daemon to use
1544 (default
1545 .Pa /sbin/routed ) .
1546 .It Va ipv6_router_program
1547 .Pq Vt str
1548 The IPv6 equivalent of
1549 .Va router_program
1550 (default
1551 .Pa /sbin/route6d ) .
1552 .It Va router_flags
1553 .Pq Vt str
1554 If
1555 .Va router_enable
1556 is set to
1557 .Dq Li YES ,
1558 these are the flags to pass to the routing daemon.
1559 .It Va ipv6_router_flags
1560 .Pq Vt str
1561 The IPv6 equivalent of
1562 .Va router_flags .
1563 .It Va mrouted_enable
1564 .Pq Vt bool
1565 If set to
1566 .Dq Li YES ,
1567 run the multicast routing daemon,
1568 .Xr mrouted 8 .
1569 .It Va mroute6d_enable
1570 .Pq Vt bool
1571 The IPv6 equivalent of
1572 .Va mrouted_enable .
1573 If set to
1574 .Dq Li YES ,
1575 run the IPv6 multicast routing daemon.
1576 Note that no IPv6 multicast routing daemon is included in the
1577 .Dx
1578 base system but
1579 .Xr pim6dd 8
1580 can be installed from the
1581 .Xr pkgsrc 7
1582 collection.
1583 .It Va mrouted_flags
1584 .Pq Vt str
1585 If
1586 .Va mrouted_enable
1587 is set to
1588 .Dq Li YES ,
1589 these are the flags to pass to the
1590 .Xr mrouted 8
1591 daemon.
1592 .It Va mroute6d_flags
1593 .Pq Vt str
1594 The IPv6 equivalent of
1595 .Va mrouted_flags .
1596 If
1597 .Va mroute6d_enable
1598 is set to
1599 .Dq Li YES ,
1600 these are the flags passed to the IPv6 multicast routing daemon.
1601 .It Va mroute6d_program
1602 .Pq Vt str
1603 If
1604 .Va mroute6d_enable
1605 is set to
1606 .Dq Li YES ,
1607 this is the path to the IPv6 multicast routing daemon.
1608 .It Va rtadvd_enable
1609 .Pq Vt bool
1610 If set to
1611 .Dq Li YES ,
1612 run the
1613 .Xr rtadvd 8
1614 daemon at boot time.
1615 .Xr rtadvd 8
1616 will only run if
1617 .Va ipv6_gateway_enable
1618 is also set to
1619 .Dq Li YES .
1620 The
1621 .Xr rtadvd 8
1622 utility sends router advertisement packets to the interfaces specified in
1623 .Va rtadvd_interfaces .
1624 .Xr rtadvd 8
1625 and should only be enabled with great care.
1626 You may want to fine-tune
1627 .Xr rtadvd.conf 5 .
1628 .It Va rtadvd_interfaces
1629 .Pq Vt str
1630 If
1631 .Va rtadvd_enable
1632 is set to
1633 .Dq Li YES
1634 this is the list of interfaces to use.
1635 .It Va rtsold_enable
1636 .Pq Vt bool
1637 If set to
1638 .Dq Li YES ,
1639 run the
1640 .Xr rtsold 8
1641 daemon at boot time.
1642 The
1643 .Xr rtsold 8
1644 daemon is used for automatic discovery of non-link local addresses.
1645 .It Va rtsold_flags
1646 .Pq Vt str
1647 If
1648 .Va rtsold_enable
1649 is set to
1650 .Dq Li YES ,
1651 these are the flags to pass to the
1652 .Xr rtsold 8
1653 daemon.
1654 .It Va arpproxy_all
1655 .Pq Vt bool
1656 If set to
1657 .Dq Li YES ,
1658 enable global proxy ARP.
1659 .It Va forward_sourceroute
1660 .Pq Vt bool
1661 If set to
1662 .Dq Li YES
1663 and
1664 .Va gateway_enable
1665 is also set to
1666 .Dq Li YES ,
1667 source-routed packets are forwarded.
1668 .It Va accept_sourceroute
1669 .Pq Vt bool
1670 If set to
1671 .Dq Li YES ,
1672 the system will accept source-routed packets directed at it.
1673 .It Va rarpd_enable
1674 .Pq Vt bool
1675 If set to
1676 .Dq Li YES ,
1677 run the
1678 .Xr rarpd 8
1679 daemon at system boot time.
1680 .It Va rarpd_flags
1681 .Pq Vt str
1682 If
1683 .Va rarpd_enable
1684 is set to
1685 .Dq Li YES ,
1686 these are the flags to pass to the
1687 .Xr rarpd 8
1688 daemon.
1689 .It Va bootparamd_enable
1690 .Pq Vt bool
1691 If set to
1692 .Dq Li YES ,
1693 run the
1694 .Xr bootparamd 8
1695 daemon at system boot time.
1696 .It Va bootparamd_flags
1697 .Pq Vt str
1698 If
1699 .Va bootparamd_enable
1700 is set to
1701 .Dq Li YES ,
1702 these are the flags to pass to the
1703 .Xr bootparamd 8
1704 daemon.
1705 .It Va stf_interface_ipv4addr
1706 .Pq Vt str
1707 If not set to
1708 .Dq Li NO ,
1709 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling interface).
1710 Specify this entry to enable the 6to4 interface.
1711 .It Va stf_interface_ipv4plen
1712 .Pq Vt int
1713 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
1714 An effective value is 0-31.
1715 .It Va stf_interface_ipv6_ifid
1716 .Pq Vt str
1717 IPv6 interface ID for
1718 .Xr stf 4 .
1719 This can be set to
1720 .Dq Li AUTO .
1721 .It Va stf_interface_ipv6_slaid
1722 .Pq Vt str
1723 IPv6 Site Level Aggregator for
1724 .Xr stf 4 .
1725 .It Va ipv6_faith_prefix
1726 .Pq Vt str
1727 If not set to
1728 .Dq Li NO ,
1729 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP translator.
1730 You also need
1731 .Xr faithd 8
1732 setup.
1733 .It Va ipv6_ipv4mapping
1734 .Pq Vt bool
1735 If set to
1736 .Dq Li YES
1737 this enables IPv4 mapped IPv6 address communication (like
1738 .Li ::ffff:a.b.c.d ) .
1739 .It Va keybell
1740 .Pq Vt str
1741 The keyboard bell sound.
1742 Set to
1743 .Dq Li normal ,
1744 .Dq Li visual ,
1745 .Dq Li off ,
1746 or
1747 .Dq Li NO
1748 if the default behavior is desired.
1749 For details, refer to the
1750 .Xr kbdcontrol 1
1751 manpage.
1752 .It Va keymap
1753 .Pq Vt str
1754 If set to
1755 .Dq Li NO ,
1756 no keymap is installed, otherwise the value is used to install
1757 the keymap file in
1758 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1759 .It Va keyrate
1760 .Pq Vt str
1761 The keyboard repeat speed.
1762 Set to
1763 .Dq Li slow ,
1764 .Dq Li normal ,
1765 .Dq Li fast ,
1766 or
1767 .Dq Li NO
1768 if the default behavior is desired.
1769 .It Va keychange
1770 .Pq Vt str
1771 If not set to
1772 .Dq Li NO ,
1773 attempt to program the function keys with the value.
1774 The value should be a single string of the form:
1775 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1776 .It Va cursor
1777 .Pq Vt str
1778 Can be set to the value of
1779 .Dq Li normal ,
1780 .Dq Li blink ,
1781 .Dq Li destructive ,
1782 or
1783 .Dq Li NO
1784 to set the cursor behavior explicitly or choose the default behavior.
1785 .It Va scrnmap
1786 .Pq Vt str
1787 If set to
1788 .Dq Li NO ,
1789 no screen map is installed, otherwise the value is used to install
1790 the screen map file in
1791 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1792 .It Va font8x16
1793 .Pq Vt str
1794 If set to
1795 .Dq Li NO ,
1796 the default 8x16 font value is used for screen size requests, otherwise
1797 the value in
1798 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1799 is used.
1800 .It Va font8x14
1801 .Pq Vt str
1802 If set to
1803 .Dq Li NO ,
1804 the default 8x14 font value is used for screen size requests, otherwise
1805 the value in
1806 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1807 is used.
1808 .It Va font8x8
1809 .Pq Vt str
1810 If set to
1811 .Dq Li NO ,
1812 the default 8x8 font value is used for screen size requests, otherwise
1813 the value in
1814 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1815 is used.
1816 .It Va blanktime
1817 .Pq Vt int
1818 If set to
1819 .Dq Li NO ,
1820 the default screen blanking interval is used, otherwise it is set to
1821 .Ar value
1822 seconds.
1823 .It Va saver
1824 .Pq Vt str
1825 If not set to
1826 .Dq Li NO ,
1827 this is the actual screen saver to use
1828 .Li ( blank , snake , daemon ,
1829 etc).
1830 .It Va moused_enable
1831 .Pq Vt str
1832 If set to
1833 .Dq Li YES ,
1834 the
1835 .Xr moused 8
1836 daemon is started for doing cut/paste selection on the console.
1837 .It Va moused_type
1838 .Pq Vt str
1839 This is the protocol type of the mouse connected to this host.
1840 This variable must be set if
1841 .Va moused_enable
1842 is set to
1843 .Dq Li YES .
1844 The
1845 .Xr moused 8
1846 daemon
1847 is able to detect the appropriate mouse type automatically in many cases.
1848 Set this variable to
1849 .Dq Li auto
1850 to let the daemon detect it, or
1851 select one from the following list if the automatic detection fails.
1852 .Pp
1853 If the mouse is attached to the PS/2 mouse port, choose
1854 .Dq Li auto
1855 or
1856 .Dq Li ps/2 ,
1857 regardless of the brand and model of the mouse.
1858 Likewise, if the mouse is attached to the bus mouse port, choose
1859 .Dq Li auto
1860 or
1861 .Dq Li busmouse .
1862 All other protocols are for serial mice and will not work with
1863 the PS/2 and bus mice.
1864 If this is a USB mouse,
1865 .Dq Li auto
1866 is the only protocol type which will work.
1867 .Pp
1868 .Bl -tag -width ".Li x10mouseremote" -compact
1869 .It Li microsoft
1870 Microsoft mouse (serial)
1871 .It Li intellimouse
1872 Microsoft IntelliMouse (serial)
1873 .It Li mousesystems
1874 Mouse systems Corp. mouse (serial)
1875 .It Li mmseries
1876 MM Series mouse (serial)
1877 .It Li logitech
1878 Logitech mouse (serial)
1879 .It Li busmouse
1880 A bus mouse
1881 .It Li mouseman
1882 Logitech MouseMan and TrackMan (serial)
1883 .It Li glidepoint
1884 ALPS GlidePoint (serial)
1885 .It Li thinkingmouse
1886 Kensington ThinkingMouse (serial)
1887 .It Li ps/2
1888 PS/2 mouse
1889 .It Li mmhittab
1890 MM HitTablet (serial)
1891 .It Li x10mouseremote
1892 X10 MouseRemote (serial)
1893 .It Li versapad
1894 Interlink VersaPad (serial)
1895 .El
1896 .Pp
1897 Even if the mouse is not in the above list, it may be compatible
1898 with one in the list.
1899 Refer to the man page for
1900 .Xr moused 8
1901 for compatibility information.
1902 .Pp
1903 It should also be noted that while this is enabled, any
1904 other client of the mouse (such as an X server) should access
1905 the mouse through the virtual mouse device,
1906 .Pa /dev/sysmouse ,
1907 and configure it as a
1908 .Dq Li sysmouse
1909 type mouse, since all
1910 mouse data is converted to this single canonical format when using
1911 .Xr moused 8 .
1912 If the client program does not support the
1913 .Dq Li sysmouse
1914 type, specify the
1915 .Dq Li mousesystems
1916 type.
1917 It is the second preferred type.
1918 .It Va moused_port
1919 .Pq Vt str
1920 If
1921 .Va moused_enable
1922 is set to
1923 .Dq Li YES ,
1924 this is the actual port the mouse is on.
1925 It might be
1926 .Pa /dev/cuaa0
1927 for a COM1 serial mouse or
1928 .Pa /dev/psm0
1929 for a PS/2 mouse, for example.
1930 .It Va moused_flags
1931 .Pq Vt str
1932 If
1933 .Va moused_type
1934 is set, these are the additional flags to pass to the
1935 .Xr moused 8
1936 daemon.
1937 .It Va mousechar_start
1938 .Pq Vt int
1939 If set to
1940 .Dq Li NO ,
1941 the default mouse cursor character range
1942 .Li 0xd0 Ns - Ns Li 0xd3
1943 is used, otherwise the range start is set to
1944 .Ar value
1945 character, see
1946 .Xr vidcontrol 1 .
1947 Use if the default range is occupied in the language code table.
1948 .It Va vidhistory
1949 .Pq Vt int
1950 Set the size of the history (scrollback) buffer in lines.
1951 .It Va allscreens_flags
1952 .Pq Vt str
1953 If set,
1954 .Xr vidcontrol 1
1955 is run with these options for each of the virtual terminals
1956 .Pq Pa /dev/ttyv* .
1957 For example,
1958 .Dq Fl m Cm on
1959 will enable the mouse pointer on all virtual terminals if
1960 .Va moused_enable
1961 is set to
1962 .Dq Li YES .
1963 .It Va allscreens_kbdflags
1964 .Pq Vt str
1965 If set,
1966 .Xr kbdcontrol 1
1967 is run with these options for each of the virtual terminals
1968 .Pq Pa /dev/ttyv* .
1969 For example,
1970 .Dq Fl h Li 200
1971 will set the
1972 .Xr syscons 4
1973 scrollback (history) buffer to 200 lines.
1974 .It Va cron_enable
1975 .Pq Vt bool
1976 If set to
1977 .Dq Li YES ,
1978 run the
1979 .Xr cron 8
1980 daemon at system boot time.
1981 .It Va cron_program
1982 .Pq Vt str
1983 Path to
1984 .Xr cron 8
1985 (default
1986 .Pa /usr/sbin/cron ) .
1987 .It Va cron_flags
1988 .Pq Vt str
1989 If
1990 .Va cron_enable
1991 is set to
1992 .Dq Li YES ,
1993 these are the flags to pass to
1994 .Xr cron 8 .
1995 .It Va lpd_program
1996 .Pq Vt str
1997 Path to
1998 .Xr lpd 8
1999 (default
2000 .Pa /usr/sbin/lpd ) .
2001 .It Va lpd_enable
2002 .Pq Vt bool
2003 If set to
2004 .Dq Li YES ,
2005 run the
2006 .Xr lpd 8
2007 daemon at system boot time.
2008 .It Va lpd_flags
2009 .Pq Vt str
2010 If
2011 .Va lpd_enable
2012 is set to
2013 .Dq Li YES ,
2014 these are the flags to pass to the
2015 .Xr lpd 8
2016 daemon.
2017 .It Va nscd_enable
2018 .Pq Vt bool
2019 If set to
2020 .Dq Li YES ,
2021 run the
2022 .Xr nscd 8
2023 daemon at system boot time.
2024 .It Va mixer_enable
2025 .Pq Vt bool
2026 If set to
2027 .Dq Li YES ,
2028 preserve
2029 .Xr mixer 8
2030 settings across reboots.
2031 .It Va mta_start_script
2032 .Pq Vt str
2033 The full path to the script to run to start
2034 a mail transfer agent.
2035 The default is
2036 .Pa /etc/rc.sendmail .
2037 The
2038 .Va sendmail_*
2039 variables which
2040 .Pa /etc/rc.sendmail
2041 uses are documented in the
2042 .Xr rc.sendmail 8
2043 man page.
2044 .It Va fixbootfile
2045 .Pq Vt bool
2046 In a
2047 .Sq HAMMER ROOT with UFS /boot
2048 setup, the boot loader will not set up the
2049 .Va kern.bootfile
2050 sysctl correctly.
2051 The system will attempt to fix this on its own.
2052 Set this variable to
2053 .Dq Li NO
2054 to turn this behavior off.
2055 .It Va dumpdev
2056 .Pq Vt str
2057 Indicates the device (usually a swap partition) to which a crash dump
2058 should be written in the event of a system crash.
2059 The value of this variable is passed as the argument to
2060 .Xr dumpon 8
2061 and
2062 .Xr savecore 8 .
2063 To disable crash dumps, set this variable to
2064 .Dq Li NO .
2065 .It Va dumpdir
2066 .Pq Vt str
2067 When the system reboots after a crash and a crash dump is found on the
2068 device specified by the
2069 .Va dumpdev
2070 variable,
2071 .Xr savecore 8
2072 will save that crash dump and a copy of the kernel to the directory
2073 specified by the
2074 .Va dumpdir
2075 variable.
2076 The default value is
2077 .Pa /var/crash .
2078 Set to
2079 .Dq Li NO
2080 to not run
2081 .Xr savecore 8
2082 at boot time when
2083 .Va dumpdir
2084 is set.
2085 .It Va savecore_flags
2086 .Pq Vt str
2087 If crash dumps are enabled, these are the flags to pass to the
2088 .Xr savecore 8
2089 utility.
2090 .It Va crashinfo_enable
2091 .Pq Vt bool
2092 Set to
2093 .Dq Li YES
2094 to turn on automatic crash dump summary generation using the utility
2095 specified by the
2096 .Va crashinfo_program
2097 variable.
2098 .It Va crashinfo_program
2099 .Pq Vt str
2100 Program to run to generate a crash dump summary if the variable
2101 .Va crashinfo_enable
2102 is set to
2103 .Dq Li YES .
2104 The default value is
2105 .Pa /usr/sbin/crashinfo .
2106 .It Va enable_quotas
2107 .Pq Vt bool
2108 Set to
2109 .Dq Li YES
2110 to turn on user disk quotas on system startup via the
2111 .Xr quotaon 8
2112 command.
2113 .It Va check_quotas
2114 .Pq Vt bool
2115 Set to
2116 .Dq Li YES
2117 to enable user disk quota checking via the
2118 .Xr quotacheck 8
2119 command.
2120 .It Va accounting_enable
2121 .Pq Vt bool
2122 Set to
2123 .Dq Li YES
2124 to enable system accounting through the
2125 .Xr accton 8
2126 facility.
2127 .It Va linux_enable
2128 .Pq Vt bool
2129 Set to
2130 .Dq Li YES
2131 to enable Linux/ELF binary emulation at system initial boot time.
2132 .\" ----- cleanvar_enable setting--------------------------------
2133 .It Va cleanvar_enable
2134 .Pq Vt bool
2135 Set to
2136 .Dq Li YES
2137 to have
2138 .Pa /var/run ,
2139 .Pa /var/spool/lock
2140 and
2141 .Pa /var/spool/uucp/.Temp/*
2142 cleaned at startup.
2143 .\" ----- clear_tmp_enable setting-------------------------------
2144 .It Va clear_tmp_enable
2145 .Pq Vt bool
2146 Set to
2147 .Dq Li YES
2148 to have
2149 .Pa /tmp
2150 cleaned at startup.
2151 .\" ----- ldconfig_paths setting --------------------------------
2152 .It Va ldconfig_paths
2153 .Pq Vt str
2154 Set to the list of shared library paths to use with
2155 .Xr ldconfig 8 .
2156 NOTE:
2157 .Pa /usr/lib
2158 will always be added first, so it need not appear in this list.
2159 .It Va ldconfig_insecure
2160 .Pq Vt bool
2161 The
2162 .Xr ldconfig 8
2163 utility normally refuses to use directories
2164 which are writable by anyone except root.
2165 Set this variable to
2166 .Dq Li YES
2167 to disable that security check during system startup.
2168 .It Va ldconfig_local_dirs
2169 .Pq Vt str
2170 Set to the list of local
2171 .Xr ldconfig 8
2172 directories.
2173 The names of all files in the directories listed will be
2174 passed as arguments to
2175 .Xr ldconfig 8 .
2176 .It Va kern_securelevel
2177 .Pq Vt int
2178 The kernel security level to set at startup.
2179 The allowed range of
2180 .Ar value
2181 ranges from \-1 (the compile time default) to 3 (the most secure).
2182 See
2183 .Xr init 8
2184 for the list of possible security levels and their effect on system operation.
2185 .It Va start_vinum
2186 .Pq Vt bool
2187 Set to
2188 .Dq Li YES
2189 to start
2190 .Xr vinum 8
2191 at system boot time.
2192 .It Va sshd_enable
2193 .Pq Vt bool
2194 Set to
2195 .Dq Li YES
2196 to start
2197 .Xr sshd 8
2198 at system boot time.
2199 .It Va sshd_program
2200 .Pq Vt str
2201 Path to the SSH server program
2202 (default
2203 .Pa /usr/sbin/sshd ) .
2204 .It Va sshd_flags
2205 .Pq Vt str
2206 If
2207 .Va sshd_enable
2208 is set to
2209 .Dq Li YES ,
2210 these are the flags to pass to the
2211 .Xr sshd 8
2212 daemon.
2213 .It Va ftpd_enable
2214 .Pq Vt bool
2215 Set to
2216 .Dq Li YES
2217 to start
2218 .Xr ftpd 8
2219 at system boot time.
2220 .It Va ftpd_flags
2221 .Pq Vt str
2222 If
2223 .Va ftpd_enable
2224 is set to
2225 .Dq Li YES ,
2226 these are the flags to pass to the
2227 .Xr ftpd 8
2228 daemon.
2229 .It Va usbd_enable
2230 .Pq Vt bool
2231 If set to
2232 .Dq Li YES ,
2233 run the
2234 .Xr usbd 8
2235 daemon at boot time.
2236 .It Va usbd_flags
2237 .Pq Vt str
2238 If
2239 .Va usbd_enable
2240 is set to
2241 .Dq Li YES ,
2242 these are the flags passed to
2243 .Xr usbd 8
2244 daemon.
2245 .It Va watchdogd_enable
2246 .Pq Vt bool
2247 If set to
2248 .Dq Li YES ,
2249 start the
2250 .Xr watchdogd 8
2251 daemon at boot time.
2252 This requires that the kernel have been compiled with
2253 .Cd "options WATCHDOG" .
2254 .It Va jail_enable
2255 .Pq Vt bool
2256 If set to
2257 .Dq Li NO ,
2258 any configured jails will not be started.
2259 .It Va jail_list
2260 .Pq Vt str
2261 A space separated list of names for jails.
2262 This is purely a configuration aid to help identify and
2263 configure multiple jails.
2264 The names specified in this list will be used to
2265 identify settings common to an instance of a jail.
2266 Assuming that the jail in question was named
2267 .Li vjail ,
2268 you would have the following dependent variables:
2269 .Bd -literal
2270 jail_vjail_hostname="jail.example.com"
2271 jail_vjail_ip="192.168.1.100"
2272 jail_vjail_rootdir="/var/jails/vjail/root"
2273 .Ed
2274 .It Va jail_flags
2275 .Pq Vt str
2276 Unset by default.
2277 When set, use as default value for
2278 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2279 for every jail in
2280 .Va jail_list .
2281 .It Va jail_interface
2282 .Pq Vt str
2283 Unset by default.
2284 When set, use as default value for
2285 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2286 for every jail in
2287 .Va jail_list .
2288 .It Va jail_fstab
2289 .Pq Vt str
2290 Unset by default.
2291 When set, use as default value for
2292 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2293 for every jail in
2294 .Va jail_list .
2295 .It Va jail_mount_enable
2296 .Pq Vt bool
2297 Set to
2298 .Dq Li NO
2299 by default.
2300 When set to
2301 .Dq Li YES ,
2302 sets
2303 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2304 to
2305 .Dq Li YES
2306 by default for every jail in
2307 .Va jail_list .
2308 .It Va jail_fdesc_enable
2309 .Pq Vt bool
2310 Set to
2311 .Dq Li NO
2312 by default.
2313 When set to
2314 .Dq Li YES ,
2315 sets
2316 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2317 to
2318 .Dq Li YES
2319 by default for every jail in
2320 .Va jail_list .
2321 .It Va jail_procfs_enable
2322 .Pq Vt bool
2323 Set to
2324 .Dq Li NO
2325 by default.
2326 When set to
2327 .Dq Li YES ,
2328 sets
2329 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2330 to
2331 .Dq Li YES
2332 by default for every jail in
2333 .Va jail_list .
2334 .It Va jail_devfs_enable
2335 .Pq Vt bool
2336 Set to
2337 .Dq Li NO
2338 by default.
2339 When set to
2340 .Dq Li YES ,
2341 sets
2342 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2343 to
2344 .Dq Li YES
2345 by default for every jail in
2346 .Va jail_list .
2347 .It Va jail_exec_start
2348 .Pq Vt str
2349 Unset by default.
2350 When set, use as default value for
2351 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2352 for every jail in
2353 .Va jail_list .
2354 .It Va jail_exec_stop
2355 Unset by default.
2356 When set, use as default value for
2357 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2358 for every jail in
2359 .Va jail_list .
2360 .It Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
2361 .Pq Vt str
2362 Unset by default.
2363 Set to the root directory used by jail
2364 .Va jname .
2365 .It Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
2366 .Pq Vt str
2367 Unset by default.
2368 Set to the fully qualified domain name (FQDN) assigned to jail
2369 .Va jname .
2370 .It Va jail_ Ns Ao Ar jname Ac Ns Va _ip
2371 .Pq Vt str
2372 Unset by default.
2373 Set to the IP address assigned to jail
2374 .Va jname .
2375 .It Va jail_ Ns Ao Ar jname Ac Ns Va _flags
2376 .Pq Vt str
2377 Set to
2378 .Dq Li -l -U root
2379 by default.
2380 These are flags to pass to
2381 .Xr jail 8 .
2382 .It Va jail_ Ns Ao Ar jname Ac Ns Va _interface
2383 .Pq Vt str
2384 Unset by default.
2385 When set, sets the interface to use when setting IP address alias.
2386 Note that the alias is created at jail startup and removed at jail shutdown.
2387 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2388 .Pq Vt str
2389 Set to
2390 .Pa /etc/fstab. Ns Aq Ar jname
2391 by default.
2392 This is the file system information file to use for jail
2393 .Va jname .
2394 .It Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
2395 .Pq Vt bool
2396 Set to
2397 .Dq Li NO
2398 by default.
2399 When set to
2400 .Dq Li YES ,
2401 mount all file systems from
2402 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
2403 at jail startup.
2404 .It Va jail_ Ns Ao Ar jname Ac Ns Va _fdesc_enable
2405 .Pq Vt bool
2406 Set to
2407 .Dq Li NO
2408 by default.
2409 When set to
2410 .Dq Li YES ,
2411 mount the file-descriptor file system inside jail
2412 .Ar jname
2413 at jail startup.
2414 .It Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable
2415 .Pq Vt bool
2416 Set to
2417 .Dq Li NO
2418 by default.
2419 When set to
2420 .Dq Li YES ,
2421 mount the process file system inside jail
2422 .Ar jname
2423 at jail startup.
2424 .It Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
2425 .Pq Vt bool
2426 Set to
2427 .Dq Li NO
2428 by default.
2429 When set to
2430 .Dq Li YES ,
2431 mount the device file system inside jail
2432 .Ar jname
2433 at jail startup.
2434 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start
2435 .Pq Vt str
2436 Set to
2437 .Dq Li /bin/sh /etc/rc
2438 by default.
2439 This is the command executed at jail startup.
2440 .It Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
2441 .Pq Vt str
2442 Set to
2443 .Dq Li /bin/sh /etc/rc.shutdown
2444 by default.
2445 This is the command executed at jail shutdown.
2446 .It Va jail_set_hostname_allow
2447 .Pq Vt bool
2448 If set to
2449 .Dq Li NO ,
2450 do not allow the root user in a jail to set its hostname.
2451 .It Va jail_socket_unixiproute_only
2452 .Pq Vt bool
2453 If set to
2454 .Dq Li YES ,
2455 do not allow any sockets,
2456 besides UNIX/IP/route sockets,
2457 to be used within a jail.
2458 .It Va jail_sysvipc_allow
2459 .Pq Vt bool
2460 If set to
2461 .Dq Li YES ,
2462 allow applications within a jail to use System V IPC.
2463 .It Va lvm_enable
2464 .Pq Vt bool
2465 If set to
2466 .Dq Li YES
2467 LVM volumes will be discovered and configured on boot.
2468 .It Va newsyslog_enable
2469 .Pq Vt bool
2470 If set to
2471 .Dq Li YES ,
2472 run
2473 .Xr newsyslog 8
2474 before syslogd starts.
2475 .It Va newsyslog_flags
2476 .Pq Vt str
2477 If
2478 .Va newsyslog_enable
2479 is set to
2480 .Dq Li YES ,
2481 these are the flags passed to
2482 .Xr newsyslog 8 .
2483 .It Va resident_enable
2484 .Pq Vt bool
2485 If set to
2486 .Dq Li YES ,
2487 make the dynamic binaries listed in
2488 .Pa /etc/resident.conf
2489 resident.
2490 .It Va varsym_enable
2491 .Pq Vt bool
2492 If set to
2493 .Dq Li YES ,
2494 process
2495 .Pa /etc/varsym.conf
2496 to set system-wide variables for variant symlinks.
2497 .It Va rand_irqs
2498 .Pq Vt str
2499 Set either to
2500 .Dq Li NO
2501 or a whitespace separated list of IRQ numbers which will be used as a source of
2502 randomness.
2503 .\" -----------------------------------------------------
2504 .It Va entropy_dir
2505 .Pq Vt str
2506 Set to
2507 .Dq Li NO
2508 to disable caching entropy via
2509 .Xr cron 8 .
2510 Otherwise set to the directory used to store entropy files in.
2511 .It Va entropy_file
2512 .Pq Vt str
2513 Set to
2514 .Dq Li NO
2515 to disable caching entropy through reboots.
2516 Otherwise set to the filename used to store cached entropy through reboots.
2517 This file should be located on the root file system to seed the
2518 .Xr random 4
2519 device as early as possible in the boot process.
2520 .It Va entropy_save_sz
2521 .Pq Vt int
2522 Determines the size of the entropy cache files used for entropy cached
2523 through reboots and also entropy cached via
2524 .Xr cron 8 .
2525 The entropy is fed to the system in blocks of 512 bytes, so this number
2526 should be large enough to fill as many of the entropy pools in the kernel
2527 CSPRNG as possible.
2528 By default, it is set to 16384, which should be able to seed all 32 entropy
2529 pools in the Fortuna CSPRNG.
2530 .It Va ipsec_enable
2531 .Pq Vt bool
2532 Set to
2533 .Dq Li YES
2534 to run
2535 .Xr setkey 8
2536 on
2537 .Va ipsec_file
2538 at boot time.
2539 .It Va ipsec_file
2540 .Pq Vt str
2541 Configuration file for
2542 .Xr setkey 8 .
2543 .It Va dmesg_enable
2544 .Pq Vt bool
2545 Set to
2546 .Dq Li YES
2547 to save
2548 .Xr dmesg 8
2549 to
2550 .Pa /var/run/dmesg.boot
2551 on boot.
2552 .It Va rcshutdown_timeout
2553 .Pq Vt int
2554 If set, start a watchdog timer in the background which will terminate
2555 .Pa rc.shutdown
2556 if
2557 .Xr shutdown 8
2558 has not completed within the specified time (in seconds).
2559 Notice that in addition to this soft timeout,
2560 .Xr init 8
2561 also applies a hard timeout for the execution of
2562 .Pa rc.shutdown .
2563 This is configured via
2564 .Xr sysctl 8
2565 variable
2566 .Va kern.init_shutdown_timeout
2567 and defaults to 120 seconds. Setting the value of
2568 .Va rcshutdown_timeout
2569 to more than 120 seconds will have no effect until the
2570 .Xr sysctl 8
2571 variable
2572 .Va kern.init_shutdown_timeout
2573 is also increased.
2574 .It Va udevd_enable
2575 .Pq Vt bool
2576 If set to
2577 .Dq Li YES ,
2578 the udevd daemon will be started on boot.
2579 .It Va vfs_quota_enable
2580 .Pq Vt bool
2581 If set to
2582 .Dq Li YES ,
2583 vfs quota rc.d scripts will be run on boot.
2584 .It Va vfs_quota_sync
2585 .Pq Vt str
2586 List of mount points whose counters are to be synchronized with on-disk
2587 usage during system startup. See also
2588 .Xr vquota 8 .
2589 .It Va vknetd_enable
2590 .Pq Vt bool
2591 If set to
2592 .Dq Li YES ,
2593 .Xr vknetd 8
2594 will be started on boot.
2595 .It Va vknetd_flags
2596 .Pq Vt bool
2597 Additional flags passed to
2598 .Xr vknetd 8 .
2599 Usually address/cidrbits is specified here.
2600 When no flags are passed, default option
2601 .Fl U
2602 will be used.
2603 .It Va vkernel_enable
2604 .Pq Vt bool
2605 If set to
2606 .Dq Li NO ,
2607 any configured vkernels will not be started.
2608 .It Va vkernel_kill_timeout
2609 .Pq Vt int
2610 This defines the default number of seconds that we will wait for the
2611 vkernel to shut down on it's own. If after this time it's still alive,
2612 it will be killed with SIGKILL.
2613 .It Va vkernel_bin
2614 .Pq Vt str
2615 Defines the default path to the vkernel binary.
2616 .It Va vkernel_list
2617 .Pq Vt str
2618 A space separated list of names for vkernels.
2619 This is purely a configuration aid to help identify and
2620 configure multiple vkernels.
2621 The names specified in this list will be used to
2622 identify settings common to a vkernel instance.
2623 Assuming that the vkernel in question was named
2624 .Li example ,
2625 you would have the following dependent variables
2626 (filled with reference values in this text):
2627 .Bd -literal
2628 vkernel_example_bin="/usr/obj/usr/src/sys/VKERNEL/kernel.debug"
2629 vkernel_example_memsize="64m"
2630 vkernel_example_rootimg_list="/var/vkernel/rootimg.01"
2631 vkernel_example_iface_list="auto:bridge0"
2632 vkernel_example_logfile="/dev/null"
2633 vkernel_example_flags="-U"
2634 vkernel_example_kill_timeout="45"
2635 .Ed
2636 .Pp
2637 The last five are optional.
2638 They default to an empty string if not set, except for logfile which defaults to
2639 .Pa /dev/null
2640 if it is not set.
2641 .El
2642 .Sh FILES
2643 .Bl -tag -width ".Pa /etc/start_if. Ns Aq Ar interface" -compact
2644 .It Pa /etc/defaults/rc.conf
2645 .It Pa /etc/rc.conf
2646 .It Pa /etc/rc.conf.local
2647 .It Pa /etc/start_if. Ns Aq Ar interface
2648 .El
2649 .Sh SEE ALSO
2650 .Xr catman 1 ,
2651 .Xr gdb 1 ,
2652 .Xr info 1 ,
2653 .Xr kbdcontrol 1 ,
2654 .Xr varsym 1 ,
2655 .Xr vidcontrol 1 ,
2656 .Xr ip 4 ,
2657 .Xr ipfw 4 ,
2658 .Xr kld 4 ,
2659 .Xr pf 4 ,
2660 .Xr tcp 4 ,
2661 .Xr udp 4 ,
2662 .Xr vlan 4 ,
2663 .Xr exports 5 ,
2664 .Xr motd 5 ,
2665 .Xr resident.conf 5 ,
2666 .Xr varsym.conf 5 ,
2667 .Xr accton 8 ,
2668 .Xr amd 8 ,
2669 .Xr apm 8 ,
2670 .Xr btconfig 8 ,
2671 .Xr bthcid 8 ,
2672 .Xr cron 8 ,
2673 .Xr devd 8 ,
2674 .Xr dhclient 8 ,
2675 .Xr dntpd 8 ,
2676 .Xr ftpd 8 ,
2677 .Xr ifconfig 8 ,
2678 .Xr inetd 8 ,
2679 .Xr jail 8 ,
2680 .Xr lpd 8 ,
2681 .Xr makewhatis 8 ,
2682 .Xr mixer 8 ,
2683 .Xr mountd 8 ,
2684 .Xr moused 8 ,
2685 .Xr mrouted 8 ,
2686 .Xr named 8 ,
2687 .Xr nfsd 8 ,
2688 .Xr pcnfsd 8 ,
2689 .Xr pfctl 8 ,
2690 .Xr pflogd 8 ,
2691 .Xr quotacheck 8 ,
2692 .Xr quotaon 8 ,
2693 .Xr rc 8 ,
2694 .Xr rc.sendmail 8 ,
2695 .Xr resident 8 ,
2696 .Xr rndcontrol 8 ,
2697 .Xr route 8 ,
2698 .Xr routed 8 ,
2699 .Xr rpcbind 8 ,
2700 .Xr rpc.lockd 8 ,
2701 .Xr rpc.statd 8 ,
2702 .Xr rtadvd 8 ,
2703 .Xr rtsold 8 ,
2704 .Xr rwhod 8 ,
2705 .Xr savecore 8 ,
2706 .Xr sdpd 8 ,
2707 .Xr sensorsd 8 ,
2708 .Xr sshd 8 ,
2709 .Xr swapon 8 ,
2710 .Xr sysctl 8 ,
2711 .Xr syslogd 8 ,
2712 .Xr sysvipcd 8 ,
2713 .Xr timed 8 ,
2714 .Xr usbd 8 ,
2715 .Xr vinum 8 ,
2716 .Xr yp 8 ,
2717 .Xr ypbind 8 ,
2718 .Xr ypserv 8 ,
2719 .Xr ypset 8
2720 .Sh HISTORY
2721 The
2722 .Nm
2723 file appeared in
2724 .Fx 2.2.2 .
2725 .Sh AUTHORS
2726 .An Jordan K. Hubbard .