share/man/man5/rc.conf.5

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