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