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