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