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