]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - share/man/man5/rc.conf.5
Copy head (r256279) to stable/10 as part of the 10.0-RELEASE cycle.
[FreeBSD/stable/10.git] / 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$
26 .\"
27 .Dd October 10, 2013
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 system installation utility.
42 .Pp
43 The purpose of
44 .Nm
45 is not to run commands or perform system startup actions
46 directly.
47 Instead, it is included by the
48 various generic startup scripts in
49 .Pa /etc
50 which conditionalize their
51 internal actions according to the settings found there.
52 .Pp
53 The
54 .Pa /etc/rc.conf
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
59 .Pa /etc/rc.conf
60 when the system administrator wishes to override these defaults.
61 The file
62 .Pa /etc/rc.conf.local
63 is used to override settings in
64 .Pa /etc/rc.conf
65 for historical reasons.
66 In addition to
67 .Pa /etc/rc.conf.local
68 you can also place smaller configuration files for each
69 .Xr rc 8
70 script in the
71 .Pa /etc/rc.conf.d
72 directory, which will be included by the
73 .Va load_rc_config
74 function.
75 For jail configurations you could use the file
76 .Pa /etc/rc.conf.d/jail
77 to store jail specific configuration options.
78 Also see the
79 .Va rc_conf_files
80 variable below.
81 .Pp
82 Options are set with
83 .Dq Ar name Ns Li = Ns Ar value
84 assignments that use
85 .Xr sh 1
86 syntax.
87 The following list provides a name and short description for each
88 variable that can be set in the
89 .Nm
90 file:
91 .Bl -tag -width indent-two
92 .It Va rc_debug
93 .Pq Vt bool
94 If set to
95 .Dq Li YES ,
96 enable output of debug messages from rc scripts.
97 This variable can be helpful in diagnosing mistakes when
98 editing or integrating new scripts.
99 Beware that this produces copious output to the terminal and
100 .Xr syslog 3 .
101 .It Va rc_info
102 .Pq Vt bool
103 If set to
104 .Dq Li NO ,
105 disable informational messages from the rc scripts.
106 Informational messages are displayed when
107 a condition that is not serious enough to warrant a warning or
108 an error occurs.
109 .It Va rc_startmsgs
110 .Pq Vt bool
111 If set to
112 .Dq Li YES ,
113 show
114 .Dq Starting foo:
115 when faststart is used (e.g., at boot time).
116 .It Va early_late_divider
117 .Pq Vt str
118 The name of the script that should be used as the
119 delimiter between the
120 .Dq early
121 and
122 .Dq late
123 stages of the boot process.
124 The early stage should contain all the services needed to
125 get the disks (local or remote) mounted so that the late
126 stage can include scripts contained in the directories
127 listed in the
128 .Va local_startup
129 variable (see below).
130 Thus, the two likely candidates for this value are
131 .Pa mountcritlocal
132 for the typical system, and
133 .Pa mountcritremote
134 if the system needs remote file
135 systems mounted to get access to the
136 .Va local_startup
137 directories; for example when
138 .Pa /usr/local
139 is NFS mounted.
140 For
141 .Pa rc.conf
142 within a
143 .Xr jail 8
144 .Pa NETWORKING
145 is likely to be an appropriate value.
146 Extreme care should be taken when changing this value,
147 and before changing it one should ensure that there are
148 adequate provisions to recover from a failed boot
149 (such as physical contact with the machine,
150 or reliable remote console access).
151 .It Va always_force_depends
152 .Pq Vt bool
153 Various
154 .Pa rc.d
155 scripts use the force_depend function to check whether required
156 services are already running, and to start them if necessary.
157 By default during boot time this check is bypassed if the
158 required service is enabled in
159 .Pa /etc/rc.conf[.local] .
160 Setting this option will bypass that check at boot time and
161 always test whether or not the service is actually running.
162 Enabling this option is likely to increase your boot time if
163 services are enabled that utilize the force_depend check.
164 .It Ao Ar name Ac Ns Va _chroot
165 .Pq Vt str
166 .Xr chroot
167 to this directory before running the service.
168 .It Ao Ar name Ac Ns Va _user
169 .Pq Vt str
170 Run the service under this user account.
171 .It Ao Ar name Ac Ns Va _group
172 .Pq Vt str
173 Run the chrooted service under this system group. Unlike the _user
174 setting, this setting has no effect if the service is not chrooted.
175 .It Ao Ar name Ac Ns Va _fib
176 .Pq Vt int
177 The
178 .Xr setfib 1
179 value to run the service under.
180 .It Ao Ar name Ac Ns Va _nice
181 .Pq Vt int
182 The
183 .Xr nice 1
184 value to run the service under.
185 .It Va apm_enable
186 .Pq Vt bool
187 If set to
188 .Dq Li YES ,
189 enable support for Automatic Power Management with
190 the
191 .Xr apm 8
192 command.
193 .It Va apmd_enable
194 .Pq Vt bool
195 Run
196 .Xr apmd 8
197 to handle APM event from userland.
198 This also enables support for APM.
199 .It Va apmd_flags
200 .Pq Vt str
201 If
202 .Va apmd_enable
203 is set to
204 .Dq Li YES ,
205 these are the flags to pass to the
206 .Xr apmd 8
207 daemon.
208 .It Va devd_enable
209 .Pq Vt bool
210 Run
211 .Xr devd 8
212 to handle device added, removed or unknown events from the kernel.
213 .It Va ddb_enable
214 .Pq Vt bool
215 Run
216 .Xr ddb 8
217 to install
218 .Xr ddb 4
219 scripts at boot time.
220 .It Va ddb_config
221 .Pq Vt str
222 Configuration file for
223 .Xr ddb 8 .
224 Default
225 .Pa /etc/ddb.conf .
226 .It Va kld_list
227 .Pq Vt str
228 A list of kernel modules to load right after the local
229 disks are mounted.
230 Loading modules at this point in the boot process is
231 much faster than doing it via
232 .Pa /boot/loader.conf
233 for those modules not necessary for mounting local disk.
234 .It Va kldxref_enable
235 .Pq Vt bool
236 Set to
237 .Dq Li NO
238 by default.
239 Set to
240 .Dq Li YES
241 to automatically rebuild
242 .Pa linker.hints
243 files with
244 .Xr kldxref 8
245 at boot time.
246 .It Va kldxref_clobber
247 .Pq Vt bool
248 Set to
249 .Dq Li NO
250 by default.
251 If
252 .Va kldxref_enable
253 is true,
254 setting to
255 .Dq Li YES
256 will overwrite existing
257 .Pa linker.hints
258 files at boot time.
259 Otherwise,
260 only missing
261 .Pa linker.hints
262 files are generated.
263 .It Va kldxref_module_path
264 .Pq Vt str
265 Empty by default.
266 A semi-colon
267 .Pq Ql \&;
268 delimited list of paths containing
269 .Xr kld 4
270 modules.
271 If empty,
272 the contents of the
273 .Va kern.module_path
274 .Xr sysctl 8
275 are used.
276 .It Va powerd_enable
277 .Pq Vt bool
278 If set to
279 .Dq Li YES ,
280 enable the system power control facility with the
281 .Xr powerd 8
282 daemon.
283 .It Va powerd_flags
284 .Pq Vt str
285 If
286 .Va powerd_enable
287 is set to
288 .Dq Li YES ,
289 these are the flags to pass to the
290 .Xr powerd 8
291 daemon.
292 .It Va tmpmfs
293 Controls the creation of a
294 .Pa /tmp
295 memory file system.
296 Always happens if set to
297 .Dq Li YES
298 and never happens if set to
299 .Dq Li NO .
300 If set to anything else, a memory file system is created if
301 .Pa /tmp
302 is not writable.
303 .It Va tmpsize
304 Controls the size of a created
305 .Pa /tmp
306 memory file system.
307 .It Va tmpmfs_flags
308 Extra options passed to the
309 .Xr mdmfs 8
310 utility when the memory file system for
311 .Pa /tmp
312 is created.
313 The default is
314 .Dq Li "-S" ,
315 which inhibits the use of softupdates on
316 .Pa /tmp
317 so that file system space is freed without delay
318 after file truncation or deletion.
319 See
320 .Xr mdmfs 8
321 for other options you can use in
322 .Va tmpmfs_flags .
323 .It Va varmfs
324 Controls the creation of a
325 .Pa /var
326 memory file system.
327 Always happens if set to
328 .Dq Li YES
329 and never happens if set to
330 .Dq Li NO .
331 If set to anything else, a memory file system is created if
332 .Pa /var
333 is not writable.
334 .It Va varsize
335 Controls the size of a created
336 .Pa /var
337 memory file system.
338 .It Va varmfs_flags
339 Extra options passed to the
340 .Xr mdmfs 8
341 utility when the memory file system for
342 .Pa /var
343 is created.
344 The default is
345 .Dq Li "-S" ,
346 which inhibits the use of softupdates on
347 .Pa /var
348 so that file system space is freed without delay
349 after file truncation or deletion.
350 See
351 .Xr mdmfs 8
352 for other options you can use in
353 .Va varmfs_flags .
354 .It Va populate_var
355 Controls the automatic population of the
356 .Pa /var
357 file system.
358 Always happens if set to
359 .Dq Li YES
360 and never happens if set to
361 .Dq Li NO .
362 If set to anything else, a memory file system is created if
363 .Pa /var
364 is not writable.
365 Note that this process requires access to certain commands in
366 .Pa /usr
367 before
368 .Pa /usr
369 is mounted on normal systems.
370 .It Va cleanvar_enable
371 .Pq Vt bool
372 Clean the
373 .Pa /var
374 directory.
375 .It Va local_startup
376 .Pq Vt str
377 List of directories to search for startup script files.
378 .It Va script_name_sep
379 .Pq Vt str
380 The field separator to use for breaking down the list of startup script files
381 into individual filenames.
382 The default is a space.
383 It is not necessary to change this unless there are startup scripts with names
384 containing spaces.
385 .It Va hostapd_enable
386 .Pq Vt bool
387 Set to
388 .Dq Li YES
389 to start
390 .Xr hostapd 8
391 at system boot time.
392 .It Va hostname
393 .Pq Vt str
394 The fully qualified domain name (FQDN) of this host on the network.
395 This should almost certainly be set to something meaningful, even if
396 there is no network connection.
397 If
398 .Xr dhclient 8
399 is used to set the hostname via DHCP,
400 this variable should be set to an empty string.
401 If this value remains unset when the system is done booting
402 your console login will display the default hostname of
403 .Dq Amnesiac .
404 .It Va nisdomainname
405 .Pq Vt str
406 The NIS domain name of this host, or
407 .Dq Li NO
408 if NIS is not used.
409 .It Va dhclient_program
410 .Pq Vt str
411 Path to the DHCP client program
412 .Pa ( /sbin/dhclient ,
413 the
414 .Ox
415 DHCP client,
416 is the default).
417 .It Va dhclient_flags
418 .Pq Vt str
419 Additional flags to pass to the DHCP client program.
420 For the
421 .Ox
422 DHCP client, see the
423 .Xr dhclient 8
424 manpage for a description of the command line options available.
425 .It Va dhclient_flags_ Ns Aq Ar iface
426 Additional flags to pass to the DHCP client program running on
427 .Ar iface
428 only.
429 When specified, this variable overrides
430 .Va dhclient_flags .
431 .It Va background_dhclient
432 .Pq Vt bool
433 Set to
434 .Dq Li YES
435 to start the DHCP client in background.
436 This can cause trouble with applications depending on
437 a working network, but it will provide a faster startup
438 in many cases.
439 .It Va background_dhclient_ Ns Aq Ar iface
440 When specified, this variable overrides the
441 .Va background_dhclient
442 variable for interface
443 .Ar iface
444 only.
445 .It Va synchronous_dhclient
446 .Pq Vt bool
447 Set to
448 .Dq Li YES
449 to start
450 .Xr dhclient 8
451 synchronously at startup.
452 This behavior can be overridden on a per-interface basis by replacing
453 the
454 .Dq Li DHCP
455 keyword in the
456 .Va ifconfig_ Ns Aq Ar interface
457 variable with
458 .Dq Li SYNCDHCP
459 or
460 .Dq Li NOSYNCDHCP .
461 .It Va defaultroute_delay
462 .Pq Vt int
463 When set to a positive value, wait up to this long after configuring
464 DHCP interfaces at startup to give the interfaces time to receive a lease.
465 .It Va firewall_enable
466 .Pq Vt bool
467 Set to
468 .Dq Li YES
469 to load firewall rules at startup.
470 If the kernel was not built with
471 .Cd "options IPFIREWALL" ,
472 the
473 .Pa ipfw.ko
474 kernel module will be loaded.
475 See also
476 .Va ipfilter_enable .
477 .It Va firewall_script
478 .Pq Vt str
479 This variable specifies the full path to the firewall script to run.
480 The default is
481 .Pa /etc/rc.firewall .
482 .It Va firewall_type
483 .Pq Vt str
484 Names the firewall type from the selection in
485 .Pa /etc/rc.firewall ,
486 or the file which contains the local firewall ruleset.
487 Valid selections from
488 .Pa /etc/rc.firewall
489 are:
490 .Pp
491 .Bl -tag -width ".Li simple" -compact
492 .It Li open
493 unrestricted IP access
494 .It Li closed
495 all IP services disabled, except via
496 .Dq Li lo0
497 .It Li client
498 basic protection for a workstation
499 .It Li simple
500 basic protection for a LAN.
501 .El
502 .Pp
503 If a filename is specified, the full path
504 must be given.
505 .It Va firewall_quiet
506 .Pq Vt bool
507 Set to
508 .Dq Li YES
509 to disable the display of firewall rules on the console during boot.
510 .It Va firewall_logging
511 .Pq Vt bool
512 Set to
513 .Dq Li YES
514 to enable firewall event logging.
515 This is equivalent to the
516 .Dv IPFIREWALL_VERBOSE
517 kernel option.
518 .It Va firewall_logif
519 .Pq Vt bool
520 Set to
521 .Dq Li YES
522 to create pseudo interface
523 .Li ipfw0
524 for logging.
525 For more details, see
526 .Xr ipfw 8
527 manual page.
528 .It Va firewall_flags
529 .Pq Vt str
530 Flags passed to
531 .Xr ipfw 8
532 if
533 .Va firewall_type
534 specifies a filename.
535 .It Va firewall_coscripts
536 .Pq Vt str
537 List of executables and/or rc scripts to run after firewall starts/stops.
538 Default is empty.
539 .\" ----- firewall_nat_enable setting --------------------------------
540 .It Va firewall_nat_enable
541 .Pq Vt bool
542 The
543 .Xr ipfw 8
544 equivalent of
545 .Va natd_enable .
546 Setting this to
547 .Dq Li YES
548 enables kernel NAT.
549 .Va firewall_enable
550 must also be set to
551 .Dq Li YES .
552 .It Va firewall_nat_interface
553 .Pq Vt str
554 The
555 .Xr ipfw 8
556 equivalent of
557 .Va natd_interface .
558 This is the name of the public interface or IP address on which
559 kernel NAT should run.
560 .It Va firewall_nat_flags
561 .Pq Vt str
562 Additional configuration parameters for kernel NAT should be placed here.
563 .It Va dummynet_enable
564 .Pq Vt bool
565 Setting this to
566 .Dq Li YES
567 will automatically load the
568 .Xr dummynet 4
569 module if
570 .Va firewall_enable
571 is also set to
572 .Dq Li YES .
573 .\" -------------------------------------------------------------------
574 .It Va natd_program
575 .Pq Vt str
576 Path to
577 .Xr natd 8 .
578 .It Va natd_enable
579 .Pq Vt bool
580 Set to
581 .Dq Li YES
582 to enable
583 .Xr natd 8 .
584 .Va firewall_enable
585 must also be set to
586 .Dq Li YES ,
587 and
588 .Xr divert 4
589 sockets must be enabled in the kernel.
590 If the kernel was not built with
591 .Cd "options IPDIVERT" ,
592 the
593 .Pa ipdivert.ko
594 kernel module will be loaded.
595 .It Va natd_interface
596 .Pq Vt str
597 This is the name of the public interface on which
598 .Xr natd 8
599 should run.
600 The interface may be given as an interface name or as an IP address.
601 .It Va natd_flags
602 .Pq Vt str
603 Additional
604 .Xr natd 8
605 flags should be placed here.
606 The
607 .Fl n
608 or
609 .Fl a
610 flag is automatically added with the above
611 .Va natd_interface
612 as an argument.
613 .\" ----- ipfilter_enable setting --------------------------------
614 .It Va ipfilter_enable
615 .Pq Vt bool
616 Set to
617 .Dq Li NO
618 by default.
619 Setting this to
620 .Dq Li YES
621 enables
622 .Xr ipf 8
623 packet filtering.
624 .Pp
625 Typical usage will require putting
626 .Bd -literal
627 ipfilter_enable="YES"
628 ipnat_enable="YES"
629 ipmon_enable="YES"
630 ipfs_enable="YES"
631 .Ed
632 .Pp
633 into
634 .Pa /etc/rc.conf
635 and editing
636 .Pa /etc/ipf.rules
637 and
638 .Pa /etc/ipnat.rules
639 appropriately.
640 .Pp
641 Note that
642 .Va ipfilter_enable
643 and
644 .Va ipnat_enable
645 can be enabled independently.
646 .Va ipmon_enable
647 and
648 .Va ipfs_enable
649 both require at least one of
650 .Va ipfilter_enable
651 and
652 .Va ipnat_enable
653 to be enabled.
654 .Pp
655 Having
656 .Bd -literal
657 options IPFILTER
658 options IPFILTER_LOG
659 options IPFILTER_DEFAULT_BLOCK
660 .Ed
661 .Pp
662 in the kernel configuration file is a good idea, too.
663 .\" ----- ipfilter_program setting ------------------------------
664 .It Va ipfilter_program
665 .Pq Vt str
666 Path to
667 .Xr ipf 8
668 (default
669 .Pa /sbin/ipf ) .
670 .\" ----- ipfilter_rules setting --------------------------------
671 .It Va ipfilter_rules
672 .Pq Vt str
673 Set to
674 .Pa /etc/ipf.rules
675 by default.
676 This variable contains the name of the filter rule definition file.
677 The file is expected to be readable for the
678 .Xr ipf 8
679 command to execute.
680 .\" ----- ipv6_ipfilter_rules setting ---------------------------
681 .It Va ipv6_ipfilter_rules
682 .Pq Vt str
683 Set to
684 .Pa /etc/ipf6.rules
685 by default.
686 This variable contains the IPv6 filter rule definition file.
687 The file is expected to be readable for the
688 .Xr ipf 8
689 command to execute.
690 .\" ----- ipfilter_flags setting --------------------------------
691 .It Va ipfilter_flags
692 .Pq Vt str
693 Empty by default.
694 This variable contains flags passed to the
695 .Xr ipf 8
696 program.
697 .\" ----- ipnat_enable setting ----------------------------------
698 .It Va ipnat_enable
699 .Pq Vt bool
700 Set to
701 .Dq Li NO
702 by default.
703 Set it to
704 .Dq Li YES
705 to enable
706 .Xr ipnat 8
707 network address translation.
708 See
709 .Va ipfilter_enable
710 for a detailed discussion.
711 .\" ----- ipnat_program setting ---------------------------------
712 .It Va ipnat_program
713 .Pq Vt str
714 Path to
715 .Xr ipnat 8
716 (default
717 .Pa /sbin/ipnat ) .
718 .\" ----- ipnat_rules setting -----------------------------------
719 .It Va ipnat_rules
720 .Pq Vt str
721 Set to
722 .Pa /etc/ipnat.rules
723 by default.
724 This variable contains the name of the file
725 holding the network address translation definition.
726 This file is expected to be readable for the
727 .Xr ipnat 8
728 command to execute.
729 .\" ----- ipnat_flags setting -----------------------------------
730 .It Va ipnat_flags
731 .Pq Vt str
732 Empty by default.
733 This variable contains flags passed to the
734 .Xr ipnat 8
735 program.
736 .\" ----- ipmon_enable setting ----------------------------------
737 .It Va ipmon_enable
738 .Pq Vt bool
739 Set to
740 .Dq Li NO
741 by default.
742 Set it to
743 .Dq Li YES
744 to enable
745 .Xr ipmon 8
746 monitoring (logging
747 .Xr ipf 8
748 and
749 .Xr ipnat 8
750 events).
751 Setting this variable needs setting
752 .Va ipfilter_enable
753 or
754 .Va ipnat_enable
755 too.
756 See
757 .Va ipfilter_enable
758 for a detailed discussion.
759 .\" ----- ipmon_program setting ---------------------------------
760 .It Va ipmon_program
761 .Pq Vt str
762 Path to
763 .Xr ipmon 8
764 (default
765 .Pa /sbin/ipmon ) .
766 .\" ----- ipmon_flags setting -----------------------------------
767 .It Va ipmon_flags
768 .Pq Vt str
769 Set to
770 .Dq Li -Ds
771 by default.
772 This variable contains flags passed to the
773 .Xr ipmon 8
774 program.
775 Another typical example would be
776 .Dq Fl D Pa /var/log/ipflog
777 to have
778 .Xr ipmon 8
779 log directly to a file bypassing
780 .Xr syslogd 8 .
781 Make sure to adjust
782 .Pa /etc/newsyslog.conf
783 in such case like this:
784 .Bd -literal
785 /var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
786 .Ed
787 .\" ----- ipfs_enable setting -----------------------------------
788 .It Va ipfs_enable
789 .Pq Vt bool
790 Set to
791 .Dq Li NO
792 by default.
793 Set it to
794 .Dq Li YES
795 to enable
796 .Xr ipfs 8
797 saving the filter and NAT state tables during shutdown
798 and reloading them during startup again.
799 Setting this variable needs setting
800 .Va ipfilter_enable
801 or
802 .Va ipnat_enable
803 to
804 .Dq Li YES
805 too.
806 See
807 .Va ipfilter_enable
808 for a detailed discussion.
809 Note that if
810 .Va kern_securelevel
811 is set to 3,
812 .Va ipfs_enable
813 cannot be used
814 because the raised securelevel will prevent
815 .Xr ipfs 8
816 from saving the state tables at shutdown time.
817 .\" ----- ipfs_program setting ----------------------------------
818 .It Va ipfs_program
819 .Pq Vt str
820 Path to
821 .Xr ipfs 8
822 (default
823 .Pa /sbin/ipfs ) .
824 .\" ----- ipfs_flags setting ------------------------------------
825 .It Va ipfs_flags
826 .Pq Vt str
827 Empty by default.
828 This variable contains flags passed to the
829 .Xr ipfs 8
830 program.
831 .\" ----- end of added ipf hook ---------------------------------
832 .It Va pf_enable
833 .Pq Vt bool
834 Set to
835 .Dq Li NO
836 by default.
837 Setting this to
838 .Dq Li YES
839 enables
840 .Xr pf 4
841 packet filtering.
842 .Pp
843 Typical usage will require putting
844 .Pp
845 .Dl pf_enable="YES"
846 .Pp
847 into
848 .Pa /etc/rc.conf
849 and editing
850 .Pa /etc/pf.conf
851 appropriately.
852 Adding
853 .Pp
854 .Dl "device pf"
855 .Pp
856 builds support for
857 .Xr pf 4
858 into the kernel, otherwise the
859 kernel module will be loaded.
860 .It Va pf_rules
861 .Pq Vt str
862 Path to
863 .Xr pf 4
864 ruleset configuration file
865 (default
866 .Pa /etc/pf.conf ) .
867 .It Va pf_program
868 .Pq Vt str
869 Path to
870 .Xr pfctl 8
871 (default
872 .Pa /sbin/pfctl ) .
873 .It Va pf_flags
874 .Pq Vt str
875 If
876 .Va pf_enable
877 is set to
878 .Dq Li YES ,
879 these flags are passed to the
880 .Xr pfctl 8
881 program when loading the ruleset.
882 .It Va pflog_enable
883 .Pq Vt bool
884 Set to
885 .Dq Li NO
886 by default.
887 Setting this to
888 .Dq Li YES
889 enables
890 .Xr pflogd 8
891 which logs packets from the
892 .Xr pf 4
893 packet filter.
894 .It Va pflog_logfile
895 .Pq Vt str
896 If
897 .Va pflog_enable
898 is set to
899 .Dq Li YES
900 this controls where
901 .Xr pflogd 8
902 stores the logfile
903 (default
904 .Pa /var/log/pflog ) .
905 Check
906 .Pa /etc/newsyslog.conf
907 to adjust logfile rotation for this.
908 .It Va pflog_program
909 .Pq Vt str
910 Path to
911 .Xr pflogd 8
912 (default
913 .Pa /sbin/pflogd ) .
914 .It Va pflog_flags
915 .Pq Vt str
916 Empty by default.
917 This variable contains additional flags passed to the
918 .Xr pflogd 8
919 program.
920 .It Va ftpproxy_enable
921 .Pq Vt bool
922 Set to
923 .Dq Li NO
924 by default.
925 Setting this to
926 .Dq Li YES
927 enables
928 .Xr ftp-proxy 8
929 which supports the
930 .Xr pf 4
931 packet filter in translating ftp connections.
932 .It Va ftpproxy_flags
933 .Pq Vt str
934 Empty by default.
935 This variable contains additional flags passed to the
936 .Xr ftp-proxy 8
937 program.
938 .It Va pfsync_enable
939 .Pq Vt bool
940 Set to
941 .Dq Li NO
942 by default.
943 Setting this to
944 .Dq Li YES
945 enables exposing
946 .Xr pf 4
947 state changes to other hosts over the network by means of
948 .Xr pfsync 4 .
949 The
950 .Va pfsync_syncdev
951 variable
952 must also be set then.
953 .It Va pfsync_syncdev
954 .Pq Vt str
955 Empty by default.
956 This variable specifies the name of the network interface
957 .Xr pfsync 4
958 should operate through.
959 It must be set accordingly if
960 .Va pfsync_enable
961 is set to
962 .Dq Li YES .
963 .It Va pfsync_syncpeer
964 .Pq Vt str
965 Empty by default.
966 This variable is optional.
967 By default, state change messages are sent out on the synchronisation
968 interface using IP multicast packets.
969 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
970 224.0.0.240.
971 When a peer address is specified using the
972 .Va pfsync_syncpeer
973 option, the peer address is used as a destination for the pfsync
974 traffic, and the traffic can then be protected using
975 .Xr ipsec 4 .
976 See the
977 .Xr pfsync 4
978 manpage for more details about using
979 .Xr ipsec 4
980 with
981 .Xr pfsync 4
982 interfaces.
983 .It Va pfsync_ifconfig
984 .Pq Vt str
985 Empty by default.
986 This variable can contain additional options to be passed to the
987 .Xr ifconfig 8
988 command used to set up
989 .Xr pfsync 4 .
990 .It Va tcp_extensions
991 .Pq Vt bool
992 Set to
993 .Dq Li YES
994 by default.
995 Setting this to
996 .Dq Li NO
997 disables certain TCP options as described by
998 .Rs
999 .%T "RFC 1323"
1000 .Re
1001 Setting this to
1002 .Dq Li NO
1003 might help remedy such problems with connections as randomly hanging
1004 or other weird behavior.
1005 Some network devices are known
1006 to be broken with respect to these options.
1007 .It Va log_in_vain
1008 .Pq Vt int
1009 Set to 0 by default.
1010 The
1011 .Xr sysctl 8
1012 variables,
1013 .Va net.inet.tcp.log_in_vain
1014 and
1015 .Va net.inet.udp.log_in_vain ,
1016 as described in
1017 .Xr tcp 4
1018 and
1019 .Xr udp 4 ,
1020 are set to the given value.
1021 .It Va tcp_keepalive
1022 .Pq Vt bool
1023 Set to
1024 .Dq Li YES
1025 by default.
1026 Setting to
1027 .Dq Li NO
1028 will disable probing idle TCP connections to verify that the
1029 peer is still up and reachable.
1030 .It Va tcp_drop_synfin
1031 .Pq Vt bool
1032 Set to
1033 .Dq Li NO
1034 by default.
1035 Setting to
1036 .Dq Li YES
1037 will cause the kernel to ignore TCP frames that have both
1038 the SYN and FIN flags set.
1039 This prevents OS fingerprinting, but may
1040 break some legitimate applications.
1041 .It Va icmp_drop_redirect
1042 .Pq Vt bool
1043 Set to
1044 .Dq Li NO
1045 by default.
1046 Setting to
1047 .Dq Li YES
1048 will cause the kernel to ignore ICMP REDIRECT packets.
1049 Refer to
1050 .Xr icmp 4
1051 for more information.
1052 .It Va icmp_log_redirect
1053 .Pq Vt bool
1054 Set to
1055 .Dq Li NO
1056 by default.
1057 Setting to
1058 .Dq Li YES
1059 will cause the kernel to log ICMP REDIRECT packets.
1060 Note that
1061 the log messages are not rate-limited, so this option should only be used
1062 for troubleshooting networks.
1063 Refer to
1064 .Xr icmp 4
1065 for more information.
1066 .It Va icmp_bmcastecho
1067 .Pq Vt bool
1068 Set to
1069 .Dq Li YES
1070 to respond to broadcast or multicast ICMP ping packets.
1071 Refer to
1072 .Xr icmp 4
1073 for more information.
1074 .It Va ip_portrange_first
1075 .Pq Vt int
1076 If not set to
1077 .Dq Li NO ,
1078 this is the first port in the default portrange.
1079 Refer to
1080 .Xr ip 4
1081 for more information.
1082 .It Va ip_portrange_last
1083 .Pq Vt int
1084 If not set to
1085 .Dq Li NO ,
1086 this is the last port in the default portrange.
1087 Refer to
1088 .Xr ip 4
1089 for more information.
1090 .It Va network_interfaces
1091 .Pq Vt str
1092 Set to the list of network interfaces to configure on this host or
1093 .Dq Li AUTO
1094 (the default) for all current interfaces.
1095 Setting the
1096 .Va network_interfaces
1097 variable to anything other than the default is deprecated.
1098 Interfaces that the administrator wishes to store configuration for,
1099 but not start at boot should be configured with the
1100 .Dq Li NOAUTO
1101 keyword in their
1102 .Va ifconfig_ Ns Aq Ar interface
1103 variables as described below.
1104 .Pp
1105 An
1106 .Va ifconfig_ Ns Aq Ar interface
1107 variable is also assumed to exist for each value of
1108 .Ar interface .
1109 When an interface name contains any of the characters
1110 .Dq Li .-/+
1111 they are translated to
1112 .Dq Li _
1113 before lookup.
1114 The variable can contain arguments to
1115 .Xr ifconfig 8 ,
1116 as well as special case-insensitive keywords described below.
1117 Such keywords are removed before passing the value to
1118 .Xr ifconfig 8
1119 while the order of the other arguments is preserved.
1120 .Pp
1121 It is possible to add IP alias entries using
1122 .Xr ifconfig 8
1123 syntax with the address family keyword such as
1124 .Li inet .
1125 Assuming that the interface in question was
1126 .Li ed0 ,
1127 it might look something like this:
1128 .Bd -literal
1129 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1130 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1131 .Ed
1132 .Pp
1133 It also possible to configure multiple IP addresses in Classless
1134 Inter-Domain Routing
1135 .Pq CIDR
1136 address notation,
1137 whose each address component can be a range like
1138 .Li inet 192.0.2.5-23/24
1139 or
1140 .Li inet6 2001:db8:1-f::1/64 .
1141 This notation allows address and prefix length part only,
1142 not the other address modifiers.
1143 .Pp
1144 In the case of
1145 .Li 192.0.2.5-23/24 ,
1146 the address 192.0.2.5 will be configured with the
1147 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1148 the non-conflicting netmask /32 as explained in the
1149 .Xr ifconfig 8
1150 alias section.
1151 Note that this special netmask handling is only for
1152 .Li inet ,
1153 not for the other address families such as
1154 .Li inet6 .
1155 .Pp
1156 With the interface in question being
1157 .Li ed0 ,
1158 an example could look like:
1159 .Bd -literal
1160 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1161 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1162 .Ed
1163 .Pp
1164 and so on.
1165 .Pp
1166 Note that
1167 .Va ipv4_addrs_ Ns Aq Ar interface
1168 variable was supported for IPv4 CIDR address notation.
1169 It is now deprecated because the functionality was integrated into
1170 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1171 though
1172 .Va ipv4_addrs_ Ns Aq Ar interface
1173 is still supported for backward compatibility.
1174 .Pp
1175 For each
1176 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1177 entry with an address family keyword,
1178 its contents are passed to
1179 .Xr ifconfig 8 .
1180 Execution stops at the first unsuccessful access, so if
1181 something like this is present:
1182 .Bd -literal
1183 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1184 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1185 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1186 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1187 .Ed
1188 .Pp
1189 Then note that alias4 would
1190 .Em not
1191 be added since the search would
1192 stop with the missing
1193 .Dq Li alias3
1194 entry.
1195 Because of this difficult to manage behavior,
1196 there is
1197 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1198 variable, which has the same functionality as
1199 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1200 and can have all of entries in a variable like the following:
1201 .Bd -literal
1202 ifconfig_ed0_aliases="\\
1203         inet 127.0.0.251 netmask 0xffffffff \\
1204         inet 127.0.0.252 netmask 0xffffffff \\
1205         inet 127.0.0.253 netmask 0xffffffff \\
1206         inet 127.0.0.254 netmask 0xffffffff"
1207 .Ed
1208 .Pp
1209 It also supports CIDR notation.
1210 .Pp
1211 If the
1212 .Pa /etc/start_if. Ns Aq Ar interface
1213 file is present, it is read and executed by the
1214 .Xr sh 1
1215 interpreter
1216 before configuring the interface as specified in the
1217 .Va ifconfig_ Ns Aq Ar interface
1218 and
1219 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1220 variables.
1221 .Pp
1222 If a
1223 .Va vlans_ Ns Aq Ar interface
1224 variable is set,
1225 a
1226 .Xr vlan 4
1227 interface will be created for each item in the list with the
1228 .Ar vlandev
1229 argument set to
1230 .Ar interface .
1231 If a vlan interface's name is a number,
1232 then that number is used as the vlan tag and the new vlan interface is
1233 named
1234 .Ar interface . Ns Ar tag .
1235 Otherwise,
1236 the vlan tag must be specified via a
1237 .Va vlan
1238 parameter in the
1239 .Va create_args_ Ns Aq Ar interface
1240 variable.
1241 .Pp
1242 To create a vlan device named
1243 .Li em0.101
1244 on
1245 .Li em0
1246 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1247 .Bd -literal
1248 vlans_em0="101"
1249 ifconfig_em0_101="inet 192.0.2.1/24"
1250 .Ed
1251 .Pp
1252 To create a vlan device named
1253 .Li myvlan
1254 on
1255 .Li em0
1256 with the vlan tag 102:
1257 .Bd -literal
1258 vlans_em0="myvlan"
1259 create_args_myvlan="vlan 102"
1260 .Ed
1261 .Pp
1262 If a
1263 .Va wlans_ Ns Aq Ar interface
1264 variable is set,
1265 an
1266 .Xr wlan 4
1267 interface will be created for each item in the list with the
1268 .Ar wlandev
1269 argument set to
1270 .Ar interface .
1271 Further wlan cloning arguments may be passed to the
1272 .Xr ifconfig 8
1273 .Cm create
1274 command by setting the
1275 .Va create_args_ Ns Aq Ar interface
1276 variable.
1277 One or more
1278 .Xr wlan 4
1279 devices must be created for each wireless devices as of
1280 .Fx 8.0 .
1281 Debugging flags for
1282 .Xr wlan 4
1283 devices as set by
1284 .Xr wlandebug 8
1285 may be specified with an
1286 .Va wlandebug_ Ns Aq Ar interface
1287 variable.
1288 The contents of this variable will be passed directly to
1289 .Xr wlandebug 8 .
1290 .Pp
1291 If the
1292 .Va ifconfig_ Ns Aq Ar interface
1293 contains the keyword
1294 .Dq Li NOAUTO
1295 then the interface will not be configured
1296 at boot or by
1297 .Pa /etc/pccard_ether
1298 when
1299 .Va network_interfaces
1300 is set to
1301 .Dq Li AUTO .
1302 .Pp
1303 It is possible to bring up an interface with DHCP by adding
1304 .Dq Li DHCP
1305 to the
1306 .Va ifconfig_ Ns Aq Ar interface
1307 variable.
1308 For instance, to initialize the
1309 .Li ed0
1310 device via DHCP,
1311 it is possible to use something like:
1312 .Bd -literal
1313 ifconfig_ed0="DHCP"
1314 .Ed
1315 .Pp
1316 If you want to configure your wireless interface with
1317 .Xr wpa_supplicant 8
1318 for use with WPA, EAP/LEAP or WEP, you need to add
1319 .Dq Li WPA
1320 to the
1321 .Va ifconfig_ Ns Aq Ar interface
1322 variable.
1323 .Pp
1324 On the other hand, if you want to configure your wireless interface with
1325 .Xr hostapd 8 ,
1326 you need to add
1327 .Dq Li HOSTAP
1328 to the
1329 .Va ifconfig_ Ns Aq Ar interface
1330 variable.
1331 .Xr hostapd 8
1332 will use the settings from
1333 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1334 .Pp
1335 Finally, you can add
1336 .Xr ifconfig 8
1337 options in this variable, in addition to the
1338 .Pa /etc/start_if. Ns Aq Ar interface
1339 file.
1340 For instance, to configure an
1341 .Xr ath 4
1342 wireless device in station mode with an address obtained
1343 via DHCP, using WPA authentication and 802.11b mode, it is
1344 possible to use something like:
1345 .Bd -literal
1346 wlans_ath0="wlan0"
1347 ifconfig_wlan0="DHCP WPA mode 11b"
1348 .Ed
1349 .Pp
1350 In addition to the
1351 .Va ifconfig_ Ns Aq Ar interface
1352 form, a fallback variable
1353 .Va ifconfig_DEFAULT
1354 may be configured.
1355 It will be used for all interfaces with no
1356 .Va ifconfig_ Ns Aq Ar interface
1357 variable.
1358 This is intended to replace the no longer supported
1359 .Va pccard_ifconfig
1360 variable.
1361 .Pp
1362 It is also possible to rename an interface by doing:
1363 .Bd -literal
1364 ifconfig_ed0_name="net0"
1365 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1366 .Ed
1367 .It Va ipv6_enable
1368 .Pq Vt bool
1369 This variable is deprecated.
1370 Use
1371 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1372 and
1373 .Va ipv6_activate_all_interfaces
1374 if necessary.
1375 .Pp
1376 If the variable is
1377 .Dq Li YES ,
1378 .Dq Li inet6 accept_rtadv
1379 is added to all of
1380 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1381 and the
1382 .Va ipv6_activate_all_interfaces
1383 is defined as
1384 .Dq Li YES .
1385 .It Va ipv6_prefer
1386 .Pq Vt bool
1387 This variable is deprecated.
1388 Use
1389 .Va ip6addrctl_policy
1390 instead.
1391 .Pp
1392 If the variable is
1393 .Dq Li YES ,
1394 the default address selection policy table set by
1395 .Xr ip6addrctl 8
1396 will be IPv6-preferred.
1397 .Pp
1398 If the variable is
1399 .Dq Li NO ,
1400 the default address selection policy table set by
1401 .Xr ip6addrctl 8
1402 will be IPv4-preferred.
1403 .It Va ipv6_activate_all_interfaces
1404 .Pq Vt bool
1405 This controls initial configuration on IPv6-capable
1406 interfaces with no corresponding
1407 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1408 variable.
1409 Note that it is not always necessary to set this variable to
1410 .Dq YES
1411 to use IPv6 functionality on
1412 .Fx .
1413 In most cases, just configuring
1414 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1415 variables works.
1416 .Pp
1417 If the variable is
1418 .Dq Li NO ,
1419 all interfaces which do not have a corresponding
1420 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1421 variable will be marked as
1422 .Dq Li IFDISABLED
1423 at creation.
1424 This means that all of IPv6 functionality on that interface
1425 is completely disabled to enforce a security policy.
1426 If the variable is set to
1427 .Dq YES ,
1428 the flag will be cleared on all of the interfaces.
1429 .Pp
1430 In most cases, just defining an
1431 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1432 for an IPv6-capable interface should be sufficient.
1433 However, if an interface is added dynamically
1434 .Pq by some tunneling protocols such as PPP, for example ,
1435 it is often difficult to define the variable in advance.
1436 In such a case, configuring the
1437 .Dq Li IFDISABLED
1438 flag can be disabled by setting this variable to
1439 .Dq YES .
1440 .Pp
1441 For more details of the
1442 .Dq Li IFDISABLED
1443 flag and keywords
1444 .Dq Li inet6 ifdisabled ,
1445 see
1446 .Xr ifconfig 8 .
1447 .Pp
1448 Default is
1449 .Dq Li NO .
1450 .It Va ipv6_privacy
1451 .Pq Vt bool
1452 If the variable is
1453 .Dq Li YES
1454 privacy addresses will be generated for each IPv6
1455 interface as described in RFC 4941.
1456 .It Va ipv6_network_interfaces
1457 .Pq Vt str
1458 This is the IPv6 equivalent of
1459 .Va network_interfaces .
1460 Normally manual configuration of this variable is not needed.
1461 .Pp
1462 .It Va ipv6_cpe_wanif
1463 .Pq Vt str
1464 If the variable is set to an interface name,
1465 the
1466 .Xr ifconfig 8
1467 options
1468 .Dq inet6 -no_radr accept_rtadv
1469 will be added to the specified interface automatically before evaluating
1470 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1471 and two
1472 .Xr sysctl 8
1473 variables
1474 .Va net.inet6.ip6.rfc6204w3
1475 and
1476 .Va net.inet6.ip6.no_radr
1477 will be set to 1.
1478 .Pp
1479 This means the specified interface will accept ICMPv6 Router
1480 Advertisement messages on that link and add the discovered
1481 routers into the Default Router List.
1482 While the other interfaces can still accept RA messages if the
1483 .Dq inet6 accept_rtadv
1484 option is specified, adding
1485 routes into the Default Router List will be disabled by
1486 .Dq inet6 no_radr
1487 option by default.
1488 See
1489 .Xr ifconfig 8
1490 for more details.
1491 .Pp
1492 Note that ICMPv6 Router Advertisement messages will be
1493 accepted even when
1494 .Va net.inet6.ip6.forwarding
1495 is 1
1496 .Pq packet forwarding is enabled
1497 when
1498 .Va net.inet6.ip6.rfc6204w3
1499 is set to 1.
1500 .Pp
1501 Default is
1502 .Dq Li NO .
1503 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1504 .Pq Vt str
1505 IPv6 functionality on an interface should be configured by
1506 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1507 instead of setting ifconfig parameters in
1508 .Va ifconfig_ Ns Aq Ar interface .
1509 If this variable is empty, all of IPv6 configurations on the
1510 specified interface by other variables such as
1511 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1512 will be ignored.
1513 .Pp
1514 Aliases should be set by
1515 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1516 with
1517 .Dq Li inet6
1518 keyword.
1519 For example:
1520 .Bd -literal
1521 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1522 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1523 .Ed
1524 .Pp
1525 Interfaces that have an
1526 .Dq Li inet6 accept_rtadv
1527 keyword in
1528 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1529 setting will be automatically configured by SLAAC
1530 .Pq StateLess Address AutoConfiguration
1531 described in
1532 .Rs
1533 .%T "RFC 4862"
1534 .Re
1535 .Pp
1536 Note that a link-local address will be automatically configured in
1537 addition to the configured global-scope addresses because the IPv6
1538 specifications require it on each link.
1539 The address is calculated from the MAC address by using an algorithm
1540 defined in
1541 .Rs
1542 .%T "RFC 4862"
1543 .%O "Section 5.3"
1544 .Re
1545 .Pp
1546 If only a link-local address is needed on the interface,
1547 the following configuration can be used:
1548 .Bd -literal
1549 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1550 .Ed
1551 .Pp
1552 A link-local address can also be configured manually.
1553 This is useful for the default router address of an IPv6 router
1554 so that it does not change when the network interface
1555 card is replaced.
1556 For example:
1557 .Bd -literal
1558 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1559 .Ed
1560 .It Va ipv6_prefix_ Ns Aq Ar interface
1561 .Pq Vt str
1562 If one or more prefixes are defined in
1563 .Va ipv6_prefix_ Ns Aq Ar interface
1564 addresses based on each prefix and the EUI-64 interface index will be
1565 configured on that interface.
1566 Note that this variable will be ignored when
1567 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1568 is empty.
1569 .Pp
1570 For example, the following configuration
1571 .Bd -literal
1572 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1573 .Ed
1574 .Pp
1575 is equivalent to the following:
1576 .Bd -literal
1577 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1578 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1579 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1580 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1581 .Ed
1582 .Pp
1583 These Subnet-Router anycast addresses will be added only when
1584 .Va ipv6_gateway_enable
1585 is YES.
1586 .It Va ipv6_default_interface
1587 .Pq Vt str
1588 If not set to
1589 .Dq Li NO ,
1590 this is the default output interface for scoped addresses.
1591 This works only with ipv6_gateway_enable="NO".
1592 .It Va ip6addrctl_enable
1593 .Pq Vt bool
1594 This variable is to enable configuring default address selection policy table
1595 .Pq RFC 3484 .
1596 The table can be specified in another variable
1597 .Va ip6addrctl_policy .
1598 For
1599 .Va ip6addrctl_policy
1600 the following keywords can be specified:
1601 .Dq Li ipv4_prefer ,
1602 .Dq Li ipv6_prefer ,
1603 or
1604 .Dq Li AUTO .
1605 .Pp
1606 If
1607 .Dq Li ipv4_prefer
1608 or
1609 .Dq Li ipv6_prefer
1610 is specified,
1611 .Xr ip6addrctl 8
1612 installs a pre-defined policy table described in Section 2.1
1613 .Pq IPv6-preferred
1614 or 10.3
1615 .Pq IPv4-preferred
1616 of RFC 3484.
1617 .Pp
1618 If
1619 .Dq Li AUTO
1620 is specified, it attempts to read a file
1621 .Pa /etc/ip6addrctl.conf
1622 first.
1623 If this file is found,
1624 .Xr ip6addrctl 8
1625 reads and installs it.
1626 If not found, a policy is automatically set
1627 according to
1628 .Va ipv6_activate_all_interfaces
1629 variable; if the variable is set to
1630 .Dq Li YES
1631 the IPv6-preferred one is used.
1632 Otherwise IPv4-preferred.
1633 .Pp
1634 The default value of
1635 .Va ip6addrctl_enable
1636 and
1637 .Va ip6addrctl_policy
1638 are
1639 .Dq Li YES
1640 and
1641 .Dq Li AUTO ,
1642 respectively.
1643 .It Va cloned_interfaces
1644 .Pq Vt str
1645 Set to the list of clonable network interfaces to create on this host.
1646 Further cloning arguments may be passed to the
1647 .Xr ifconfig 8
1648 .Cm create
1649 command for each interface by setting the
1650 .Va create_args_ Ns Aq Ar interface
1651 variable.
1652 If an interface name is specified with
1653 .Dq :sticky
1654 keyword,
1655 the interface will not be destroyed even when
1656 .Pa rc.d/netif
1657 script is invoked with
1658 .Dq stop
1659 argument.
1660 This is useful when reconfiguring the interface without destroying it.
1661 Entries in
1662 .Va cloned_interfaces
1663 are automatically appended to
1664 .Va network_interfaces
1665 for configuration.
1666 .It Va cloned_interfaces_sticky
1667 .Pq Vt bool
1668 This variable is to globally enable functionality of
1669 .Dq :sticky
1670 keyword in
1671 .Va cloned_interfaces
1672 for all interfaces.
1673 The default value is
1674 .Dq NO .
1675 Even if this variable is specified to
1676 .Dq YES ,
1677 .Dq :nosticky
1678 keyword can be used to override it on per interface basis.
1679 .It Va fec_interfaces
1680 .Pq Vt str
1681 Set to the list of
1682 .Xr ng_fec 4
1683 Fast EtherChannel interfaces to configure on this host.
1684 A
1685 .Va fecconfig_ Ns Aq Ar interface
1686 variable is assumed to exist for each value of
1687 .Ar interface .
1688 The value of this variable is used to configure link aggregated interfaces
1689 according to the syntax of the
1690 .Cm NGM_FEC_ADD_IFACE
1691 to
1692 .Xr ngctl 8
1693 msg.
1694 Additionally, this option ensures that each listed interface is created
1695 via the
1696 .Cm mkpeer
1697 command to
1698 .Xr ngctl 8
1699 before attempting to configure it.
1700 For example:
1701 .Bd -literal
1702 fec_interfaces="fec0"
1703 fecconfig_fec0="em0 em1"
1704 ifconfig_fec0="DHCP"
1705 .Ed
1706 .It Va gif_interfaces
1707 .Pq Vt str
1708 This variable is deprecated in favor of
1709 .Va cloned_interfaces .
1710 Set to the list of
1711 .Xr gif 4
1712 tunnel interfaces to configure on this host.
1713 A
1714 .Va gifconfig_ Ns Aq Ar interface
1715 variable is assumed to exist for each value of
1716 .Ar interface .
1717 The value of this variable is used to configure the link layer of the
1718 tunnel according to the syntax of the
1719 .Cm tunnel
1720 option to
1721 .Xr ifconfig 8 .
1722 Additionally, this option ensures that each listed interface is created
1723 via the
1724 .Cm create
1725 option to
1726 .Xr ifconfig 8
1727 before attempting to configure it.
1728 .It Va sppp_interfaces
1729 .Pq Vt str
1730 Set to the list of
1731 .Xr sppp 4
1732 interfaces to configure on this host.
1733 A
1734 .Va spppconfig_ Ns Aq Ar interface
1735 variable is assumed to exist for each value of
1736 .Ar interface .
1737 Each interface should also be configured by a general
1738 .Va ifconfig_ Ns Aq Ar interface
1739 setting.
1740 Refer to
1741 .Xr spppcontrol 8
1742 for more information about available options.
1743 .It Va ppp_enable
1744 .Pq Vt bool
1745 If set to
1746 .Dq Li YES ,
1747 run the
1748 .Xr ppp 8
1749 daemon.
1750 .It Va ppp_profile
1751 .Pq Vt str
1752 The name of the profile to use from
1753 .Pa /etc/ppp/ppp.conf .
1754 Also used for per-profile overrides of
1755 .Va ppp_mode
1756 and
1757 .Va ppp_nat ,
1758 and
1759 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1760 When the profile name contains any of the characters
1761 .Dq Li .-/+
1762 they are translated to
1763 .Dq Li _
1764 for the proposes of the override variable names.
1765 .It Va ppp_mode
1766 .Pq Vt str
1767 Mode in which to run the
1768 .Xr ppp 8
1769 daemon.
1770 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1771 .Pq Vt str
1772 Overrides the global
1773 .Va ppp_mode
1774 for
1775 .Ar profile .
1776 Accepted modes are
1777 .Dq Li auto ,
1778 .Dq Li ddial ,
1779 .Dq Li direct
1780 and
1781 .Dq Li dedicated .
1782 See the manual for a full description.
1783 .It Va ppp_nat
1784 .Pq Vt bool
1785 If set to
1786 .Dq Li YES ,
1787 enables network address translation.
1788 Used in conjunction with
1789 .Va gateway_enable
1790 allows hosts on private network addresses access to the Internet using
1791 this host as a network address translating router.
1792 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1793 .Pq Vt str
1794 Overrides the global
1795 .Va ppp_nat
1796 for
1797 .Ar profile .
1798 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1799 .Pq Vt int
1800 Set the unit number to be used for this profile.
1801 See the manual description of
1802 .Fl unit Ns Ar N
1803 for details.
1804 .It Va ppp_user
1805 .Pq Vt str
1806 The name of the user under which
1807 .Xr ppp 8
1808 should be started.
1809 By
1810 default,
1811 .Xr ppp 8
1812 is started as
1813 .Dq Li root .
1814 .It Va rc_conf_files
1815 .Pq Vt str
1816 This option is used to specify a list of files that will override
1817 the settings in
1818 .Pa /etc/defaults/rc.conf .
1819 The files will be read in the order in which they are specified and should
1820 include the full path to the file.
1821 By default, the files specified are
1822 .Pa /etc/rc.conf
1823 and
1824 .Pa /etc/rc.conf.local
1825 .It Va zfs_enable
1826 .Pq Vt bool
1827 If set to
1828 .Dq Li YES ,
1829 .Pa /etc/rc.d/zfs
1830 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1831 (ZVOLs).
1832 .It Va gptboot_enable
1833 .Pq Vt bool
1834 If set to
1835 .Dq Li YES ,
1836 .Pa /etc/rc.d/gptboot
1837 will log if the system successfully (or not) booted from a GPT partition,
1838 which had the
1839 .Ar bootonce
1840 attribute set using
1841 .Xr gpart 8
1842 utility.
1843 .It Va gbde_autoattach_all
1844 .Pq Vt bool
1845 If set to
1846 .Dq Li YES ,
1847 .Pa /etc/rc.d/gbde
1848 will attempt to automatically initialize your .bde devices in
1849 .Pa /etc/fstab .
1850 .It Va gbde_devices
1851 .Pq Vt str
1852 List the devices that the script should try to attach,
1853 or
1854 .Dq Li AUTO .
1855 .It Va gbde_lockdir
1856 .Pq Vt str
1857 The directory where the
1858 .Xr gbde 4
1859 lockfiles are located.
1860 The default lockfile directory is
1861 .Pa /etc .
1862 .Pp
1863 The lockfile for each individual
1864 .Xr gbde 4
1865 device can be overridden by setting the variable
1866 .Va gbde_lock_ Ns Aq Ar device ,
1867 where
1868 .Ar device
1869 is the encrypted device without the
1870 .Dq Pa /dev/
1871 and
1872 .Dq Pa .bde
1873 parts.
1874 .It Va gbde_attach_attempts
1875 .Pq Vt int
1876 Number of times to attempt attaching to a
1877 .Xr gbde 4
1878 device, i.e., how many times the user is asked for the pass-phrase.
1879 Default is 3.
1880 .It Va geli_devices
1881 .Pq Vt str
1882 List of devices to automatically attach on boot.
1883 Note that .eli devices from
1884 .Pa /etc/fstab
1885 are automatically appended to this list.
1886 .It Va geli_tries
1887 .Pq Vt int
1888 Number of times user is asked for the pass-phrase.
1889 If empty, it will be taken from
1890 .Va kern.geom.eli.tries
1891 sysctl variable.
1892 .It Va geli_default_flags
1893 .Pq Vt str
1894 Default flags to use by
1895 .Xr geli 8
1896 when configuring disk encryption.
1897 Flags can be configured for every device separately by defining
1898 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1899 variable.
1900 .It Va geli_autodetach
1901 .Pq Vt str
1902 Specifies if GELI devices should be marked for detach on last close after
1903 file systems are mounted.
1904 Default is
1905 .Dq Li YES .
1906 This can be changed for every device separately by defining
1907 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1908 variable.
1909 .It Va root_rw_mount
1910 .Pq Vt bool
1911 Set to
1912 .Dq Li YES
1913 by default.
1914 After the file systems are checked at boot time, the root file system
1915 is remounted as read-write if this is set to
1916 .Dq Li YES .
1917 Diskless systems that mount their root file system from a read-only remote
1918 NFS share should set this to
1919 .Dq Li NO
1920 in their
1921 .Pa rc.conf .
1922 .It Va fsck_y_enable
1923 .Pq Vt bool
1924 If set to
1925 .Dq Li YES ,
1926 .Xr fsck 8
1927 will be run with the
1928 .Fl y
1929 flag if the initial preen
1930 of the file systems fails.
1931 .It Va background_fsck
1932 .Pq Vt bool
1933 If set to
1934 .Dq Li YES ,
1935 the system will attempt to run
1936 .Xr fsck 8
1937 in the background where possible.
1938 .It Va background_fsck_delay
1939 .Pq Vt int
1940 The amount of time in seconds to sleep before starting a background
1941 .Xr fsck 8 .
1942 It defaults to sixty seconds to allow large applications such as
1943 the X server to start before disk I/O bandwidth is monopolized by
1944 .Xr fsck 8 .
1945 If set to a negative number, the background file system check will be
1946 delayed indefinitely to allow the administrator to run it at a more
1947 convenient time.
1948 For example it may be run from
1949 .Xr cron 8
1950 by adding a line like
1951 .Pp
1952 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
1953 .Pp
1954 to
1955 .Pa /etc/crontab .
1956 .It Va netfs_types
1957 .Pq Vt str
1958 List of file system types that are network-based.
1959 This list should generally not be modified by end users.
1960 Use
1961 .Va extra_netfs_types
1962 instead.
1963 .It Va extra_netfs_types
1964 .Pq Vt str
1965 If set to something other than
1966 .Dq Li NO
1967 (the default),
1968 this variable extends the list of file system types
1969 for which automatic mounting at startup by
1970 .Xr rc 8
1971 should be delayed until the network is initialized.
1972 It should contain
1973 a whitespace-separated list of network file system descriptor pairs,
1974 each consisting of a file system type as passed to
1975 .Xr mount 8
1976 and a human-readable, one-word description,
1977 joined with a colon
1978 .Pq Ql \&: .
1979 Extending the default list in this way is only necessary
1980 when third party file system types are used.
1981 .It Va syslogd_enable
1982 .Pq Vt bool
1983 If set to
1984 .Dq Li YES ,
1985 run the
1986 .Xr syslogd 8
1987 daemon.
1988 .It Va syslogd_program
1989 .Pq Vt str
1990 Path to
1991 .Xr syslogd 8
1992 (default
1993 .Pa /usr/sbin/syslogd ) .
1994 .It Va syslogd_flags
1995 .Pq Vt str
1996 If
1997 .Va syslogd_enable
1998 is set to
1999 .Dq Li YES ,
2000 these are the flags to pass to
2001 .Xr syslogd 8 .
2002 .It Va inetd_enable
2003 .Pq Vt bool
2004 If set to
2005 .Dq Li YES ,
2006 run the
2007 .Xr inetd 8
2008 daemon.
2009 .It Va inetd_program
2010 .Pq Vt str
2011 Path to
2012 .Xr inetd 8
2013 (default
2014 .Pa /usr/sbin/inetd ) .
2015 .It Va inetd_flags
2016 .Pq Vt str
2017 If
2018 .Va inetd_enable
2019 is set to
2020 .Dq Li YES ,
2021 these are the flags to pass to
2022 .Xr inetd 8 .
2023 .It Va hastd_enable
2024 .Pq Vt bool
2025 If set to
2026 .Dq Li YES ,
2027 run the
2028 .Xr hastd 8
2029 daemon.
2030 .It Va hastd_program
2031 .Pq Vt str
2032 Path to
2033 .Xr hastd 8
2034 (default
2035 .Pa /sbin/hastd ) .
2036 .It Va hastd_flags
2037 .Pq Vt str
2038 If
2039 .Va hastd_enable
2040 is set to
2041 .Dq Li YES ,
2042 these are the flags to pass to
2043 .Xr hastd 8 .
2044 .It Va local_unbound_enable
2045 .Pq Vt bool
2046 If set to
2047 .Dq Li YES ,
2048 run the
2049 .Xr unbound 8
2050 daemon as a local caching resolver.
2051 .It Va named_enable
2052 .Pq Vt bool
2053 If set to
2054 .Dq Li YES ,
2055 run the
2056 .Xr named 8
2057 daemon.
2058 .It Va named_program
2059 .Pq Vt str
2060 Path to
2061 .Xr named 8
2062 (default
2063 .Pa /usr/sbin/named ) .
2064 .It Va named_conf
2065 .Pq Vt str
2066 Path to
2067 .Xr named 8
2068 configuration file, (default
2069 .Pa /etc/namedb/named.conf ) .
2070 .It Va named_flags
2071 .Pq Vt str
2072 If
2073 .Va named_enable
2074 is set to
2075 .Dq Li YES ,
2076 these are the flags to pass to
2077 .Xr named 8 .
2078 .It Va named_uid
2079 .Pq Vt str
2080 The user that the
2081 .Xr named 8
2082 process should be run as.
2083 .It Va named_chrootdir
2084 .Pq Vt str
2085 The root directory for a name server run in a
2086 .Xr chroot 8
2087 environment (default
2088 .Pa /var/named ) .
2089 If left empty
2090 .Xr named 8
2091 will not be run in a
2092 .Xr chroot 8
2093 environment.
2094 .It Va named_chroot_autoupdate
2095 .Pq Vt bool
2096 Set to
2097 .Dq Li NO
2098 to disable automatic update of the
2099 .Xr chroot 8
2100 environment.
2101 .It Va named_symlink_enable
2102 .Pq Vt bool
2103 Set to
2104 .Dq Li NO
2105 to disable symlinking of
2106 daemon's PID file
2107 into the
2108 .Xr chroot 8
2109 environment.
2110 .It Va named_wait
2111 .Pq Vt bool
2112 Set to have
2113 .Pa /etc/rc.d/named
2114 loop until working name service is established.
2115 .It Va named_wait_host
2116 .Pq Vt str
2117 Name of host to lookup for the named_wait option.
2118 (Default localhost)
2119 .It Va named_auto_forward
2120 .Pq Vt bool
2121 Set to enable automatic creation of a forwarder
2122 configuration file derived from
2123 .Pa /etc/resolv.conf .
2124 .It Va named_auto_forward_only
2125 .Pq Vt bool
2126 Set to change the default forwarder configuration from
2127 .Dq forward first
2128 to
2129 .Dq forward only .
2130 .It Va kerberos5_server_enable
2131 .Pq Vt bool
2132 Set to
2133 .Dq Li YES
2134 to start a Kerberos 5 authentication server
2135 at boot time.
2136 .It Va kerberos5_server
2137 .Pq Vt str
2138 If
2139 .Va kerberos5_server_enable
2140 is set to
2141 .Dq Li YES
2142 this is the path to Kerberos 5 Authentication Server.
2143 .It Va kerberos5_server_flags
2144 .Pq Vt str
2145 Empty by default.
2146 This variable contains additional flags to be passed to the Kerberos 5
2147 authentication server.
2148 .It Va kadmind5_server_enable
2149 .Pq Vt bool
2150 Set to
2151 .Dq Li YES
2152 to start
2153 .Xr kadmind 8 ,
2154 the Kerberos 5 Administration Daemon; set to
2155 .Dq Li NO
2156 on a slave server.
2157 .It Va kadmind5_server
2158 .Pq Vt str
2159 If
2160 .Va kadmind5_server_enable
2161 is set to
2162 .Dq Li YES
2163 this is the path to Kerberos 5 Administration Daemon.
2164 .It Va kpasswdd_server_enable
2165 .Pq Vt bool
2166 Set to
2167 .Dq Li YES
2168 to start
2169 .Xr kpasswdd 8 ,
2170 the Kerberos 5 Password-Changing Daemon; set to
2171 .Dq Li NO
2172 on a slave server.
2173 .It Va kpasswdd_server
2174 .Pq Vt str
2175 If
2176 .Va kpasswdd_server_enable
2177 is set to
2178 .Dq Li YES
2179 this is the path to Kerberos 5 Password-Changing Daemon.
2180 .It Va kfd_enable
2181 .Pq Vt bool
2182 Set to
2183 .Dq Li YES
2184 to start
2185 .Xr kfd 8 ,
2186 the Kerberos 5 ticket forwarding daemon, at the boot time.
2187 .It Va kfd_program
2188 .Pq Vt str
2189 Path to
2190 .Xr kfd 8
2191 (default
2192 .Pa /usr/libexec/kfd ) .
2193 .It Va rwhod_enable
2194 .Pq Vt bool
2195 If set to
2196 .Dq Li YES ,
2197 run the
2198 .Xr rwhod 8
2199 daemon at boot time.
2200 .It Va rwhod_flags
2201 .Pq Vt str
2202 If
2203 .Va rwhod_enable
2204 is set to
2205 .Dq Li YES ,
2206 these are the flags to pass to it.
2207 .It Va amd_enable
2208 .Pq Vt bool
2209 If set to
2210 .Dq Li YES ,
2211 run the
2212 .Xr amd 8
2213 daemon at boot time.
2214 .It Va amd_flags
2215 .Pq Vt str
2216 If
2217 .Va amd_enable
2218 is set to
2219 .Dq Li YES ,
2220 these are the flags to pass to it.
2221 See the
2222 .Xr amd 8
2223 manpage for more information.
2224 .It Va amd_map_program
2225 .Pq Vt str
2226 If set,
2227 the specified program is run to get the list of
2228 .Xr amd 8
2229 maps.
2230 For example, if the
2231 .Xr amd 8
2232 maps are stored in NIS, one can set this to
2233 run
2234 .Xr ypcat 1
2235 to get a list of
2236 .Xr amd 8
2237 maps from the
2238 .Pa amd.master
2239 NIS map.
2240 .It Va update_motd
2241 .Pq Vt bool
2242 If set to
2243 .Dq Li YES ,
2244 .Pa /etc/motd
2245 will be updated at boot time to reflect the kernel release
2246 being run.
2247 If set to
2248 .Dq Li NO ,
2249 .Pa /etc/motd
2250 will not be updated.
2251 .It Va nfs_client_enable
2252 .Pq Vt bool
2253 If set to
2254 .Dq Li YES ,
2255 run the NFS client daemons at boot time.
2256 .It Va nfs_access_cache
2257 .Pq Vt int
2258 If
2259 .Va nfs_client_enable
2260 is set to
2261 .Dq Li YES ,
2262 this can be set to
2263 .Dq Li 0
2264 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2265 NFS ACCESS
2266 results should be cached.
2267 A value of 2-10 seconds will substantially reduce network
2268 traffic for many NFS operations.
2269 .It Va nfs_server_enable
2270 .Pq Vt bool
2271 If set to
2272 .Dq Li YES ,
2273 run the NFS server daemons at boot time.
2274 .It Va nfs_server_flags
2275 .Pq Vt str
2276 If
2277 .Va nfs_server_enable
2278 is set to
2279 .Dq Li YES ,
2280 these are the flags to pass to the
2281 .Xr nfsd 8
2282 daemon.
2283 .It Va nfsv4_server_enable
2284 .Pq Vt bool
2285 If
2286 .Va nfs_server_enable
2287 is set to
2288 .Dq Li YES
2289 and
2290 .Va nfsv4_server_enable
2291 are set to
2292 .Dq Li YES ,
2293 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2294 .It Va nfsuserd_enable
2295 .Pq Vt bool
2296 If
2297 .Va nfsuserd_enable
2298 is set to
2299 .Dq Li YES ,
2300 run the nfsuserd daemon, which is needed for NFSv4 in order
2301 to map between user/group names vs uid/gid numbers.
2302 If
2303 .Va nfsv4_server_enable
2304 is set to
2305 .Dq Li YES ,
2306 this will be forced enabled.
2307 .It Va nfsuserd_flags
2308 .Pq Vt str
2309 If
2310 .Va nfsuserd_enable
2311 is set to
2312 .Dq Li YES ,
2313 these are the flags to pass to the
2314 .Xr nfsuserd 8
2315 daemon.
2316 .It Va nfscbd_enable
2317 .Pq Vt bool
2318 If
2319 .Va nfscbd_enable
2320 is set to
2321 .Dq Li YES ,
2322 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2323 .It Va nfscbd_flags
2324 .Pq Vt str
2325 If
2326 .Va nfscbd_enable
2327 is set to
2328 .Dq Li YES ,
2329 these are the flags to pass to the
2330 .Xr nfscbd 8
2331 daemon.
2332 .It Va oldnfs_server_enable
2333 .Pq Vt bool
2334 If
2335 .Va oldnfs_server_enable
2336 is set to
2337 .Dq Li YES ,
2338 force the NFS server daemons to run the old NFS server code
2339 that does not support NFSv4.
2340 .It Va mountd_enable
2341 .Pq Vt bool
2342 If set to
2343 .Dq Li YES ,
2344 and no
2345 .Va nfs_server_enable
2346 is set, start
2347 .Xr mountd 8 ,
2348 but not
2349 .Xr nfsd 8
2350 daemon.
2351 It is commonly needed to run CFS without real NFS used.
2352 .It Va mountd_flags
2353 .Pq Vt str
2354 If
2355 .Va mountd_enable
2356 is set to
2357 .Dq Li YES ,
2358 these are the flags to pass to the
2359 .Xr mountd 8
2360 daemon.
2361 .It Va weak_mountd_authentication
2362 .Pq Vt bool
2363 If set to
2364 .Dq Li YES ,
2365 allow services like PCNFSD to make non-privileged mount
2366 requests.
2367 .It Va nfs_reserved_port_only
2368 .Pq Vt bool
2369 If set to
2370 .Dq Li YES ,
2371 provide NFS services only on a secure port.
2372 .It Va nfs_bufpackets
2373 .Pq Vt int
2374 If set to a number, indicates the number of packets worth of
2375 socket buffer space to reserve on an NFS client.
2376 The kernel default is typically 4.
2377 Using a higher number may be
2378 useful on gigabit networks to improve performance.
2379 The minimum value is
2380 2 and the maximum is 64.
2381 .It Va rpc_lockd_enable
2382 .Pq Vt bool
2383 If set to
2384 .Dq Li YES
2385 and also an NFS server or client, run
2386 .Xr rpc.lockd 8
2387 at boot time.
2388 .It Va rpc_lockd_flags
2389 .Pq Vt str
2390 If
2391 .Va rpc_lockd_enable
2392 is set to
2393 .Dq Li YES ,
2394 these are the flags to pass to the
2395 .Xr rpc.lockd 8
2396 daemon.
2397 .It Va rpc_statd_enable
2398 .Pq Vt bool
2399 If set to
2400 .Dq Li YES
2401 and also an NFS server or client, run
2402 .Xr rpc.statd 8
2403 at boot time.
2404 .It Va rpc_statd_flags
2405 .Pq Vt str
2406 If
2407 .Va rpc_statd_enable
2408 is set to
2409 .Dq Li YES ,
2410 these are the flags to pass to the
2411 .Xr rpc.statd 8
2412 daemon.
2413 .It Va rpcbind_program
2414 .Pq Vt str
2415 Path to
2416 .Xr rpcbind 8
2417 (default
2418 .Pa /usr/sbin/rpcbind ) .
2419 .It Va rpcbind_enable
2420 .Pq Vt bool
2421 If set to
2422 .Dq Li YES ,
2423 run the
2424 .Xr rpcbind 8
2425 service at boot time.
2426 .It Va rpcbind_flags
2427 .Pq Vt str
2428 If
2429 .Va rpcbind_enable
2430 is set to
2431 .Dq Li YES ,
2432 these are the flags to pass to the
2433 .Xr rpcbind 8
2434 daemon.
2435 .It Va keyserv_enable
2436 .Pq Vt bool
2437 If set to
2438 .Dq Li YES ,
2439 run the
2440 .Xr keyserv 8
2441 daemon on boot for running Secure RPC.
2442 .It Va keyserv_flags
2443 .Pq Vt str
2444 If
2445 .Va keyserv_enable
2446 is set to
2447 .Dq Li YES ,
2448 these are the flags to pass to
2449 .Xr keyserv 8
2450 daemon.
2451 .It Va pppoed_enable
2452 .Pq Vt bool
2453 If set to
2454 .Dq Li YES ,
2455 run the
2456 .Xr pppoed 8
2457 daemon at boot time to provide PPP over Ethernet services.
2458 .It Va pppoed_ Ns Aq Ar provider
2459 .Pq Vt str
2460 .Xr pppoed 8
2461 listens to requests to this
2462 .Ar provider
2463 and ultimately runs
2464 .Xr ppp 8
2465 with a
2466 .Ar system
2467 argument of the same name.
2468 .It Va pppoed_flags
2469 .Pq Vt str
2470 Additional flags to pass to
2471 .Xr pppoed 8 .
2472 .It Va pppoed_interface
2473 .Pq Vt str
2474 The network interface to run
2475 .Xr pppoed 8
2476 on.
2477 This is mandatory when
2478 .Va pppoed_enable
2479 is set to
2480 .Dq Li YES .
2481 .It Va timed_enable
2482 .Pq Vt bool
2483 If set to
2484 .Dq Li YES ,
2485 run the
2486 .Xr timed 8
2487 service at boot time.
2488 This command is intended for networks of
2489 machines where a consistent
2490 .Dq "network time"
2491 for all hosts must be established.
2492 This is often useful in large NFS
2493 environments where time stamps on files are expected to be consistent
2494 network-wide.
2495 .It Va timed_flags
2496 .Pq Vt str
2497 If
2498 .Va timed_enable
2499 is set to
2500 .Dq Li YES ,
2501 these are the flags to pass to the
2502 .Xr timed 8
2503 service.
2504 .It Va ntpdate_enable
2505 .Pq Vt bool
2506 If set to
2507 .Dq Li YES ,
2508 run
2509 .Xr ntpdate 8
2510 at system startup.
2511 This command is intended to
2512 synchronize the system clock only
2513 .Em once
2514 from some standard reference.
2515 .It Va ntpdate_config
2516 .Pq Vt str
2517 Configuration file for
2518 .Xr ntpdate 8 .
2519 Default
2520 .Pa /etc/ntp.conf .
2521 .It Va ntpdate_hosts
2522 .Pq Vt str
2523 A whitespace-separated list of NTP servers to synchronize with at startup.
2524 The default is to use the servers listed in
2525 .Va ntpdate_config ,
2526 if that file exists.
2527 .It Va ntpdate_program
2528 .Pq Vt str
2529 Path to
2530 .Xr ntpdate 8
2531 (default
2532 .Pa /usr/sbin/ntpdate ) .
2533 .It Va ntpdate_flags
2534 .Pq Vt str
2535 If
2536 .Va ntpdate_enable
2537 is set to
2538 .Dq Li YES ,
2539 these are the flags to pass to the
2540 .Xr ntpdate 8
2541 command (typically a hostname).
2542 .It Va ntpd_enable
2543 .Pq Vt bool
2544 If set to
2545 .Dq Li YES ,
2546 run the
2547 .Xr ntpd 8
2548 command at boot time.
2549 .It Va ntpd_program
2550 .Pq Vt str
2551 Path to
2552 .Xr ntpd 8
2553 (default
2554 .Pa /usr/sbin/ntpd ) .
2555 .It Va ntpd_config
2556 .Pq Vt str
2557 Path to
2558 .Xr ntpd 8
2559 configuration file.
2560 Default
2561 .Pa /etc/ntp.conf .
2562 .It Va ntpd_flags
2563 .Pq Vt str
2564 If
2565 .Va ntpd_enable
2566 is set to
2567 .Dq Li YES ,
2568 these are the flags to pass to the
2569 .Xr ntpd 8
2570 daemon.
2571 .It Va ntpd_sync_on_start
2572 .Pq Vt bool
2573 If set to
2574 .Dq Li YES ,
2575 .Xr ntpd 8
2576 is run with the
2577 .Fl g
2578 flag, which syncs the system's clock on startup.
2579 See
2580 .Xr ntpd 8
2581 for more information regarding the
2582 .Fl g
2583 option.
2584 This is a preferred alternative to using
2585 .Xr ntpdate 8
2586 or specifying the
2587 .Va ntpdate_enable
2588 variable.
2589 .It Va nis_client_enable
2590 .Pq Vt bool
2591 If set to
2592 .Dq Li YES ,
2593 run the
2594 .Xr ypbind 8
2595 service at system boot time.
2596 .It Va nis_client_flags
2597 .Pq Vt str
2598 If
2599 .Va nis_client_enable
2600 is set to
2601 .Dq Li YES ,
2602 these are the flags to pass to the
2603 .Xr ypbind 8
2604 service.
2605 .It Va nis_ypset_enable
2606 .Pq Vt bool
2607 If set to
2608 .Dq Li YES ,
2609 run the
2610 .Xr ypset 8
2611 daemon at system boot time.
2612 .It Va nis_ypset_flags
2613 .Pq Vt str
2614 If
2615 .Va nis_ypset_enable
2616 is set to
2617 .Dq Li YES ,
2618 these are the flags to pass to the
2619 .Xr ypset 8
2620 daemon.
2621 .It Va nis_server_enable
2622 .Pq Vt bool
2623 If set to
2624 .Dq Li YES ,
2625 run the
2626 .Xr ypserv 8
2627 daemon at system boot time.
2628 .It Va nis_server_flags
2629 .Pq Vt str
2630 If
2631 .Va nis_server_enable
2632 is set to
2633 .Dq Li YES ,
2634 these are the flags to pass to the
2635 .Xr ypserv 8
2636 daemon.
2637 .It Va nis_ypxfrd_enable
2638 .Pq Vt bool
2639 If set to
2640 .Dq Li YES ,
2641 run the
2642 .Xr rpc.ypxfrd 8
2643 daemon at system boot time.
2644 .It Va nis_ypxfrd_flags
2645 .Pq Vt str
2646 If
2647 .Va nis_ypxfrd_enable
2648 is set to
2649 .Dq Li YES ,
2650 these are the flags to pass to the
2651 .Xr rpc.ypxfrd 8
2652 daemon.
2653 .It Va nis_yppasswdd_enable
2654 .Pq Vt bool
2655 If set to
2656 .Dq Li YES ,
2657 run the
2658 .Xr rpc.yppasswdd 8
2659 daemon at system boot time.
2660 .It Va nis_yppasswdd_flags
2661 .Pq Vt str
2662 If
2663 .Va nis_yppasswdd_enable
2664 is set to
2665 .Dq Li YES ,
2666 these are the flags to pass to the
2667 .Xr rpc.yppasswdd 8
2668 daemon.
2669 .It Va rpc_ypupdated_enable
2670 .Pq Vt bool
2671 If set to
2672 .Dq Li YES ,
2673 run the
2674 .Nm rpc.ypupdated
2675 daemon at system boot time.
2676 .It Va bsnmpd_enable
2677 .Pq Vt bool
2678 If set to
2679 .Dq Li YES ,
2680 run the
2681 .Xr bsnmpd 1
2682 daemon at system boot time.
2683 Be sure to understand the security implications of running SNMP daemon
2684 on your host.
2685 .It Va bsnmpd_flags
2686 .Pq Vt str
2687 If
2688 .Va bsnmpd_enable
2689 is set to
2690 .Dq Li YES ,
2691 these are the flags to pass to the
2692 .Xr bsnmpd 1
2693 daemon.
2694 .It Va defaultrouter
2695 .Pq Vt str
2696 If not set to
2697 .Dq Li NO ,
2698 create a default route to this host name or IP address
2699 (use an IP address if this router is also required to get to the
2700 name server!).
2701 .It Va ipv6_defaultrouter
2702 .Pq Vt str
2703 The IPv6 equivalent of
2704 .Va defaultrouter .
2705 .It Va static_arp_pairs
2706 .Pq Vt str
2707 Set to the list of static ARP pairs that are to be added at system
2708 boot time.
2709 For each whitespace separated
2710 .Ar element
2711 in the value, a
2712 .Va static_arp_ Ns Aq Ar element
2713 variable is assumed to exist whose contents will later be passed to a
2714 .Dq Nm arp Cm -S
2715 operation.
2716 For example
2717 .Bd -literal
2718 static_arp_pairs="gw"
2719 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2720 .Ed
2721 .It Va static_ndp_pairs
2722 .Pq Vt str
2723 Set to the list of static NDP pairs that are to be added at system
2724 boot time.
2725 For each whitespace separated
2726 .Ar element
2727 in the value, a
2728 .Va static_ndp_ Ns Aq Ar element
2729 variable is assumed to exist whose contents will later be passed to a
2730 .Dq Nm ndp Cm -s
2731 operation.
2732 For example
2733 .Bd -literal
2734 static_ndp_pairs="gw"
2735 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2736 .Ed
2737 .It Va static_routes
2738 .Pq Vt str
2739 Set to the list of static routes that are to be added at system
2740 boot time.
2741 If not set to
2742 .Dq Li NO
2743 then for each whitespace separated
2744 .Ar element
2745 in the value, a
2746 .Va route_ Ns Aq Ar element
2747 variable is assumed to exist
2748 whose contents will later be passed to a
2749 .Dq Nm route Cm add
2750 operation.
2751 For example:
2752 .Bd -literal
2753 static_routes="ext mcast:gif0 gif0local:gif0"
2754 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2755 route_mcast="-net 224.0.0.0/4 -iface gif0"
2756 route_gif0local="-host 169.254.1.1 -iface lo0"
2757 .Ed
2758 .Pp
2759 When an
2760 .Ar element
2761 is in the form of
2762 .Li name:ifname ,
2763 the route is specific to the interface
2764 .Li ifname .
2765 .It Va ipv6_static_routes
2766 .Pq Vt str
2767 The IPv6 equivalent of
2768 .Va static_routes .
2769 If not set to
2770 .Dq Li NO
2771 then for each whitespace separated
2772 .Ar element
2773 in the value, a
2774 .Va ipv6_route_ Ns Aq Ar element
2775 variable is assumed to exist
2776 whose contents will later be passed to a
2777 .Dq Nm route Cm add Fl inet6
2778 operation.
2779 .It Va natm_static_routes
2780 .Pq Vt str
2781 The
2782 .Xr natmip 4
2783 equivalent of
2784 .Va static_routes .
2785 If not empty then for each whitespace separated
2786 .Ar element
2787 in the value, a
2788 .Va route_ Ns Aq Ar element
2789 variable is assumed to exist whose contents will later be passed to a
2790 .Dq Nm atmconfig Cm natm Cm add
2791 operation.
2792 .It Va gateway_enable
2793 .Pq Vt bool
2794 If set to
2795 .Dq Li YES ,
2796 configure host to act as an IP router, e.g.\& to forward packets
2797 between interfaces.
2798 .It Va ipv6_gateway_enable
2799 .Pq Vt bool
2800 The IPv6 equivalent of
2801 .Va gateway_enable .
2802 .It Va routed_enable
2803 .Pq Vt bool
2804 If set to
2805 .Dq Li YES ,
2806 run a routing daemon of some sort, based on the
2807 settings of
2808 .Va routed_program
2809 and
2810 .Va routed_flags .
2811 .It Va route6d_enable
2812 .Pq Vt bool
2813 The IPv6 equivalent of
2814 .Va routed_enable .
2815 If set to
2816 .Dq Li YES ,
2817 run a routing daemon of some sort, based on the
2818 settings of
2819 .Va route6d_program
2820 and
2821 .Va route6d_flags .
2822 .It Va routed_program
2823 .Pq Vt str
2824 If
2825 .Va routed_enable
2826 is set to
2827 .Dq Li YES ,
2828 this is the name of the routing daemon to use.
2829 .It Va route6d_program
2830 .Pq Vt str
2831 The IPv6 equivalent of
2832 .Va routed_program .
2833 .It Va routed_flags
2834 .Pq Vt str
2835 If
2836 .Va routed_enable
2837 is set to
2838 .Dq Li YES ,
2839 these are the flags to pass to the routing daemon.
2840 .It Va route6d_flags
2841 .Pq Vt str
2842 The IPv6 equivalent of
2843 .Va routed_flags .
2844 .It Va mrouted_enable
2845 .Pq Vt bool
2846 If set to
2847 .Dq Li YES ,
2848 run the multicast routing daemon,
2849 .Xr mrouted 8 .
2850 .It Va mroute6d_enable
2851 .Pq Vt bool
2852 The IPv6 equivalent of
2853 .Va mrouted_enable .
2854 If set to
2855 .Dq Li YES ,
2856 run the IPv6 multicast routing daemon.
2857 .Pp
2858 Note that multicast routing daemons are no longer included in the
2859 .Fx
2860 base system, however, both
2861 .Xr mrouted 8
2862 and
2863 .Xr pim6dd 8
2864 may be installed from the
2865 .Fx
2866 Ports Collection.
2867 .It Va mrouted_flags
2868 .Pq Vt str
2869 If
2870 .Va mrouted_enable
2871 is set to
2872 .Dq Li YES ,
2873 these are the flags to pass to the
2874 .Xr mrouted 8
2875 daemon.
2876 .It Va mroute6d_flags
2877 .Pq Vt str
2878 The IPv6 equivalent of
2879 .Va mrouted_flags .
2880 If
2881 .Va mroute6d_enable
2882 is set to
2883 .Dq Li YES ,
2884 these are the flags passed to the IPv6 multicast routing daemon.
2885 .It Va mroute6d_program
2886 .Pq Vt str
2887 If
2888 .Va mroute6d_enable
2889 is set to
2890 .Dq Li YES ,
2891 this is the path to the IPv6 multicast routing daemon.
2892 .It Va rtadvd_enable
2893 .Pq Vt bool
2894 If set to
2895 .Dq Li YES ,
2896 run the
2897 .Xr rtadvd 8
2898 daemon at boot time.
2899 The
2900 .Xr rtadvd 8
2901 utility sends ICMPv6 Router Advertisement messages to
2902 the interfaces specified in
2903 .Va rtadvd_interfaces .
2904 This should only be enabled with great care.
2905 You may want to fine-tune
2906 .Xr rtadvd.conf 5 .
2907 .It Va rtadvd_interfaces
2908 .Pq Vt str
2909 If
2910 .Va rtadvd_enable
2911 is set to
2912 .Dq Li YES
2913 this is the list of interfaces to use.
2914 .It Va ipxgateway_enable
2915 .Pq Vt bool
2916 If set to
2917 .Dq Li YES ,
2918 enable the routing of IPX traffic.
2919 .It Va ipxrouted_enable
2920 .Pq Vt bool
2921 If set to
2922 .Dq Li YES ,
2923 run the
2924 .Xr IPXrouted 8
2925 daemon at system boot time.
2926 .It Va ipxrouted_flags
2927 .Pq Vt str
2928 If
2929 .Va ipxrouted_enable
2930 is set to
2931 .Dq Li YES ,
2932 these are the flags to pass to the
2933 .Xr IPXrouted 8
2934 daemon.
2935 .It Va arpproxy_all
2936 .Pq Vt bool
2937 If set to
2938 .Dq Li YES ,
2939 enable global proxy ARP.
2940 .It Va forward_sourceroute
2941 .Pq Vt bool
2942 If set to
2943 .Dq Li YES
2944 and
2945 .Va gateway_enable
2946 is also set to
2947 .Dq Li YES ,
2948 source-routed packets are forwarded.
2949 .It Va accept_sourceroute
2950 .Pq Vt bool
2951 If set to
2952 .Dq Li YES ,
2953 the system will accept source-routed packets directed at it.
2954 .It Va rarpd_enable
2955 .Pq Vt bool
2956 If set to
2957 .Dq Li YES ,
2958 run the
2959 .Xr rarpd 8
2960 daemon at system boot time.
2961 .It Va rarpd_flags
2962 .Pq Vt str
2963 If
2964 .Va rarpd_enable
2965 is set to
2966 .Dq Li YES ,
2967 these are the flags to pass to the
2968 .Xr rarpd 8
2969 daemon.
2970 .It Va bootparamd_enable
2971 .Pq Vt bool
2972 If set to
2973 .Dq Li YES ,
2974 run the
2975 .Xr bootparamd 8
2976 daemon at system boot time.
2977 .It Va bootparamd_flags
2978 .Pq Vt str
2979 If
2980 .Va bootparamd_enable
2981 is set to
2982 .Dq Li YES ,
2983 these are the flags to pass to the
2984 .Xr bootparamd 8
2985 daemon.
2986 .It Va stf_interface_ipv4addr
2987 .Pq Vt str
2988 If not set to
2989 .Dq Li NO ,
2990 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2991 interface).
2992 Specify this entry to enable the 6to4 interface.
2993 .It Va stf_interface_ipv4plen
2994 .Pq Vt int
2995 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2996 An effective value is 0-31.
2997 .It Va stf_interface_ipv6_ifid
2998 .Pq Vt str
2999 IPv6 interface ID for
3000 .Xr stf 4 .
3001 This can be set to
3002 .Dq Li AUTO .
3003 .It Va stf_interface_ipv6_slaid
3004 .Pq Vt str
3005 IPv6 Site Level Aggregator for
3006 .Xr stf 4 .
3007 .It Va ipv6_faith_prefix
3008 .Pq Vt str
3009 If not set to
3010 .Dq Li NO ,
3011 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
3012 translator.
3013 You also need
3014 .Xr faithd 8
3015 setup.
3016 .It Va ipv6_ipv4mapping
3017 .Pq Vt bool
3018 If set to
3019 .Dq Li YES
3020 this enables IPv4 mapped IPv6 address communication (like
3021 .Li ::ffff:a.b.c.d ) .
3022 .It Va rtsold_enable
3023 .Pq Vt bool
3024 Set to
3025 .Dq Li YES
3026 to enable the
3027 .Xr rtsold 8
3028 daemon to send ICMPv6 Router Solicitation messages.
3029 .It Va rtsold_flags
3030 .Pq Vt str
3031 If
3032 .Va rtsold_enable
3033 is set to
3034 .Dq Li YES ,
3035 these are the flags to pass to
3036 .Xr rtsold 8 .
3037 .It Va rtsol_flags
3038 .Pq Vt str
3039 For interfaces configured with the
3040 .Dq Li inet6 accept_rtadv
3041 keyword, these are the flags to pass to
3042 .Xr rtsol 8 .
3043 .Pp
3044 Note that
3045 .Va rtsold_enable
3046 is mutually exclusive to
3047 .Va rtsol_flags ;
3048 .Va rtsold_enable
3049 takes precedence.
3050 .It Va atm_enable
3051 .Pq Vt bool
3052 Set to
3053 .Dq Li YES
3054 to enable the configuration of ATM interfaces at system boot time.
3055 For all of the ATM variables described below, please refer to the
3056 .Xr atm 8
3057 manual page for further details on the available command parameters.
3058 Also refer to the files in
3059 .Pa /usr/share/examples/atm
3060 for more detailed configuration information.
3061 .It Va atm_load
3062 .Pq Vt str
3063 This is a list of physical ATM interface drivers to load.
3064 Typical values are
3065 .Dq Li hfa_pci
3066 and/or
3067 .Dq Li hea_pci .
3068 .It Va atm_netif_ Ns Aq Ar intf
3069 .Pq Vt str
3070 For the ATM physical interface
3071 .Ar intf ,
3072 this variable defines the name prefix and count for the ATM network
3073 interfaces to be created.
3074 The value will be passed as the parameters of an
3075 .Dq Nm atm Cm "set netif" Ar intf
3076 command.
3077 .It Va atm_sigmgr_ Ns Aq Ar intf
3078 .Pq Vt str
3079 For the ATM physical interface
3080 .Ar intf ,
3081 this variable defines the ATM signalling manager to be used.
3082 The value will be passed as the parameters of an
3083 .Dq Nm atm Cm attach Ar intf
3084 command.
3085 .It Va atm_prefix_ Ns Aq Ar intf
3086 .Pq Vt str
3087 For the ATM physical interface
3088 .Ar intf ,
3089 this variable defines the NSAP prefix for interfaces using a UNI signalling
3090 manager.
3091 If set to
3092 .Dq Li ILMI ,
3093 the prefix will automatically be set via the
3094 .Xr ilmid 8
3095 daemon.
3096 Otherwise, the value will be passed as the parameters of an
3097 .Dq Nm atm Cm "set prefix" Ar intf
3098 command.
3099 .It Va atm_macaddr_ Ns Aq Ar intf
3100 .Pq Vt str
3101 For the ATM physical interface
3102 .Ar intf ,
3103 this variable defines the MAC address for interfaces using a UNI signalling
3104 manager.
3105 If set to
3106 .Dq Li NO ,
3107 the hardware MAC address contained in the ATM interface card will be used.
3108 Otherwise, the value will be passed as the parameters of an
3109 .Dq Nm atm Cm "set mac" Ar intf
3110 command.
3111 .It Va atm_arpserver_ Ns Aq Ar netif
3112 .Pq Vt str
3113 For the ATM network interface
3114 .Ar netif ,
3115 this variable defines the ATM address for a host which is to provide ATMARP
3116 service.
3117 This variable is only applicable to interfaces using a UNI signalling
3118 manager.
3119 If set to
3120 .Dq Li local ,
3121 this host will become an ATMARP server.
3122 The value will be passed as the parameters of an
3123 .Dq Nm atm Cm "set arpserver" Ar netif
3124 command.
3125 .It Va atm_scsparp_ Ns Aq Ar netif
3126 .Pq Vt bool
3127 If set to
3128 .Dq Li YES ,
3129 SCSP/ATMARP service for the network interface
3130 .Ar netif
3131 will be initiated using the
3132 .Xr scspd 8
3133 and
3134 .Xr atmarpd 8
3135 daemons.
3136 This variable is only applicable if
3137 .Va atm_arpserver_ Ns Aq Ar netif
3138 is set to
3139 .Dq Li local .
3140 .It Va atm_pvcs
3141 .Pq Vt str
3142 Set to the list of ATM PVCs to be added at system
3143 boot time.
3144 For each whitespace separated
3145 .Ar element
3146 in the value, an
3147 .Va atm_pvc_ Ns Aq Ar element
3148 variable is assumed to exist.
3149 The value of each of these variables
3150 will be passed as the parameters of an
3151 .Dq Nm atm Cm "add pvc"
3152 command.
3153 .It Va atm_arps
3154 .Pq Vt str
3155 Set to the list of permanent ATM ARP entries to be added
3156 at system boot time.
3157 For each whitespace separated
3158 .Ar element
3159 in the value, an
3160 .Va atm_arp_ Ns Aq Ar element
3161 variable is assumed to exist.
3162 The value of each of these variables
3163 will be passed as the parameters of an
3164 .Dq Nm atm Cm "add arp"
3165 command.
3166 .It Va natm_interfaces
3167 .Pq Vt str
3168 Set to the list of
3169 .Xr natm 4
3170 interfaces that will also be used for HARP through
3171 .Xr harp 4 .
3172 If this list is not empty all interfaces in the list will be brought up
3173 with
3174 .Xr ifconfig 8
3175 and
3176 .Xr harp 4
3177 will be loaded.
3178 For this to work the interface drivers must be either compiled into the
3179 kernel or must reside on the root partition.
3180 .It Va keybell
3181 .Pq Vt str
3182 The keyboard bell sound.
3183 Set to
3184 .Dq Li normal ,
3185 .Dq Li visual ,
3186 .Dq Li off ,
3187 or
3188 .Dq Li NO
3189 if the default behavior is desired.
3190 For details, refer to the
3191 .Xr kbdcontrol 1
3192 manpage.
3193 .It Va keyboard
3194 .Pq Vt str
3195 If set to a non-null string, the virtual console's keyboard input is
3196 set to this device.
3197 .It Va keymap
3198 .Pq Vt str
3199 If set to
3200 .Dq Li NO ,
3201 no keymap is installed, otherwise the value is used to install
3202 the keymap file in
3203 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
3204 .It Va keyrate
3205 .Pq Vt str
3206 The keyboard repeat speed.
3207 Set to
3208 .Dq Li slow ,
3209 .Dq Li normal ,
3210 .Dq Li fast ,
3211 or
3212 .Dq Li NO
3213 if the default behavior is desired.
3214 .It Va keychange
3215 .Pq Vt str
3216 If not set to
3217 .Dq Li NO ,
3218 attempt to program the function keys with the value.
3219 The value should
3220 be a single string of the form:
3221 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3222 .It Va cursor
3223 .Pq Vt str
3224 Can be set to the value of
3225 .Dq Li normal ,
3226 .Dq Li blink ,
3227 .Dq Li destructive ,
3228 or
3229 .Dq Li NO
3230 to set the cursor behavior explicitly or choose the default behavior.
3231 .It Va scrnmap
3232 .Pq Vt str
3233 If set to
3234 .Dq Li NO ,
3235 no screen map is installed, otherwise the value is used to install
3236 the screen map file in
3237 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3238 .It Va font8x16
3239 .Pq Vt str
3240 If set to
3241 .Dq Li NO ,
3242 the default 8x16 font value is used for screen size requests, otherwise
3243 the value in
3244 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3245 is used.
3246 .It Va font8x14
3247 .Pq Vt str
3248 If set to
3249 .Dq Li NO ,
3250 the default 8x14 font value is used for screen size requests, otherwise
3251 the value in
3252 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3253 is used.
3254 .It Va font8x8
3255 .Pq Vt str
3256 If set to
3257 .Dq Li NO ,
3258 the default 8x8 font value is used for screen size requests, otherwise
3259 the value in
3260 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3261 is used.
3262 .It Va blanktime
3263 .Pq Vt int
3264 If set to
3265 .Dq Li NO ,
3266 the default screen blanking interval is used, otherwise it is set
3267 to
3268 .Ar value
3269 seconds.
3270 .It Va saver
3271 .Pq Vt str
3272 If not set to
3273 .Dq Li NO ,
3274 this is the actual screen saver to use
3275 .Li ( blank , snake , daemon ,
3276 etc).
3277 .It Va moused_nondefault_enable
3278 .Pq Vt str
3279 If set to
3280 .Dq Li NO ,
3281 the mouse device specified on
3282 the command line is not automatically treated as enabled by the
3283 .Pa /etc/rc.d/moused
3284 script.
3285 Having this variable set to
3286 .Dq Li YES
3287 allows a
3288 .Xr usb 4
3289 mouse,
3290 for example,
3291 to be enabled as soon as it is plugged in.
3292 .It Va moused_enable
3293 .Pq Vt str
3294 If set to
3295 .Dq Li YES ,
3296 the
3297 .Xr moused 8
3298 daemon is started for doing cut/paste selection on the console.
3299 .It Va moused_type
3300 .Pq Vt str
3301 This is the protocol type of the mouse connected to this host.
3302 This variable must be set if
3303 .Va moused_enable
3304 is set to
3305 .Dq Li YES .
3306 The
3307 .Xr moused 8
3308 daemon
3309 is able to detect the appropriate mouse type automatically in many cases.
3310 Set this variable to
3311 .Dq Li auto
3312 to let the daemon detect it, or
3313 select one from the following list if the automatic detection fails.
3314 .Pp
3315 If the mouse is attached to the PS/2 mouse port, choose
3316 .Dq Li auto
3317 or
3318 .Dq Li ps/2 ,
3319 regardless of the brand and model of the mouse.
3320 Likewise, if the
3321 mouse is attached to the bus mouse port, choose
3322 .Dq Li auto
3323 or
3324 .Dq Li busmouse .
3325 All other protocols are for serial mice and will not work with
3326 the PS/2 and bus mice.
3327 If this is a USB mouse,
3328 .Dq Li auto
3329 is the only protocol type which will work.
3330 .Pp
3331 .Bl -tag -width ".Li x10mouseremote" -compact
3332 .It Li microsoft
3333 Microsoft mouse (serial)
3334 .It Li intellimouse
3335 Microsoft IntelliMouse (serial)
3336 .It Li mousesystems
3337 Mouse systems Corp.\& mouse (serial)
3338 .It Li mmseries
3339 MM Series mouse (serial)
3340 .It Li logitech
3341 Logitech mouse (serial)
3342 .It Li busmouse
3343 A bus mouse
3344 .It Li mouseman
3345 Logitech MouseMan and TrackMan (serial)
3346 .It Li glidepoint
3347 ALPS GlidePoint (serial)
3348 .It Li thinkingmouse
3349 Kensington ThinkingMouse (serial)
3350 .It Li ps/2
3351 PS/2 mouse
3352 .It Li mmhittab
3353 MM HitTablet (serial)
3354 .It Li x10mouseremote
3355 X10 MouseRemote (serial)
3356 .It Li versapad
3357 Interlink VersaPad (serial)
3358 .El
3359 .Pp
3360 Even if the mouse is not in the above list, it may be compatible
3361 with one in the list.
3362 Refer to the manual page for
3363 .Xr moused 8
3364 for compatibility information.
3365 .Pp
3366 It should also be noted that while this is enabled, any
3367 other client of the mouse (such as an X server) should access
3368 the mouse through the virtual mouse device,
3369 .Pa /dev/sysmouse ,
3370 and configure it as a
3371 .Dq Li sysmouse
3372 type mouse, since all
3373 mouse data is converted to this single canonical format when
3374 using
3375 .Xr moused 8 .
3376 If the client program does not support the
3377 .Dq Li sysmouse
3378 type,
3379 specify the
3380 .Dq Li mousesystems
3381 type.
3382 It is the second preferred type.
3383 .It Va moused_port
3384 .Pq Vt str
3385 If
3386 .Va moused_enable
3387 is set to
3388 .Dq Li YES ,
3389 this is the actual port the mouse is on.
3390 It might be
3391 .Pa /dev/cuau0
3392 for a COM1 serial mouse,
3393 .Pa /dev/psm0
3394 for a PS/2 mouse or
3395 .Pa /dev/mse0
3396 for a bus mouse, for example.
3397 .It Va moused_flags
3398 .Pq Vt str
3399 If
3400 .Va moused_flags
3401 is set, its value is used as an additional set of flags to pass to the
3402 .Xr moused 8
3403 daemon.
3404 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3405 When
3406 .Va moused_nondefault_enable
3407 is enabled, and a
3408 .Xr moused 8
3409 daemon is started for a non-default port, the
3410 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3411 set of options has precedence over and replaces the default
3412 .Va moused_flags
3413 (where
3414 .Ar XXX
3415 is the name of the non-default port, i.e.,\&
3416 .Ar ums0 ) .
3417 By setting
3418 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3419 it is possible to set up a different set of default flags for each
3420 .Xr moused 8
3421 instance.
3422 For example, you can use
3423 .Dq Li "-3"
3424 for the default
3425 .Va moused_flags
3426 to make your laptop's touchpad more comfortable to use,
3427 but an empty set of options for
3428 .Va moused_ums0_flags
3429 when your
3430 .Xr usb 4
3431 mouse has three or more buttons.
3432 .It Va mousechar_start
3433 .Pq Vt int
3434 If set to
3435 .Dq Li NO ,
3436 the default mouse cursor character range
3437 .Li 0xd0 Ns - Ns Li 0xd3
3438 is used,
3439 otherwise the range start is set
3440 to
3441 .Ar value
3442 character, see
3443 .Xr vidcontrol 1 .
3444 Use if the default range is occupied in the language code table.
3445 .It Va allscreens_flags
3446 .Pq Vt str
3447 If set,
3448 .Xr vidcontrol 1
3449 is run with these options for each of the virtual terminals
3450 .Pq Pa /dev/ttyv* .
3451 For example,
3452 .Dq Fl m Cm on
3453 will enable the mouse pointer on all virtual terminals
3454 if
3455 .Va moused_enable
3456 is set to
3457 .Dq Li YES .
3458 .It Va allscreens_kbdflags
3459 .Pq Vt str
3460 If set,
3461 .Xr kbdcontrol 1
3462 is run with these options for each of the virtual terminals
3463 .Pq Pa /dev/ttyv* .
3464 For example,
3465 .Dq Fl h Li 200
3466 will set the
3467 .Xr syscons 4
3468 scrollback (history) buffer to 200 lines.
3469 .It Va cron_enable
3470 .Pq Vt bool
3471 If set to
3472 .Dq Li YES ,
3473 run the
3474 .Xr cron 8
3475 daemon at system boot time.
3476 .It Va cron_program
3477 .Pq Vt str
3478 Path to
3479 .Xr cron 8
3480 (default
3481 .Pa /usr/sbin/cron ) .
3482 .It Va cron_flags
3483 .Pq Vt str
3484 If
3485 .Va cron_enable
3486 is set to
3487 .Dq Li YES ,
3488 these are the flags to pass to
3489 .Xr cron 8 .
3490 .It Va cron_dst
3491 .Pq Vt bool
3492 If set to
3493 .Dq Li YES ,
3494 enable the special handling of transitions to and from the
3495 Daylight Saving Time in
3496 .Xr cron 8
3497 (equivalent to using the flag
3498 .Fl s ) .
3499 .It Va lpd_program
3500 .Pq Vt str
3501 Path to
3502 .Xr lpd 8
3503 (default
3504 .Pa /usr/sbin/lpd ) .
3505 .It Va lpd_enable
3506 .Pq Vt bool
3507 If set to
3508 .Dq Li YES ,
3509 run the
3510 .Xr lpd 8
3511 daemon at system boot time.
3512 .It Va lpd_flags
3513 .Pq Vt str
3514 If
3515 .Va lpd_enable
3516 is set to
3517 .Dq Li YES ,
3518 these are the flags to pass to the
3519 .Xr lpd 8
3520 daemon.
3521 .It Va chkprintcap_enable
3522 .Pq Vt bool
3523 If set to
3524 .Dq Li YES ,
3525 run the
3526 .Xr chkprintcap 8
3527 command before starting the
3528 .Xr lpd 8
3529 daemon.
3530 .It Va chkprintcap_flags
3531 .Pq Vt str
3532 If
3533 .Va lpd_enable
3534 and
3535 .Va chkprintcap_enable
3536 are set to
3537 .Dq Li YES ,
3538 these are the flags to pass to the
3539 .Xr chkprintcap 8
3540 program.
3541 The default is
3542 .Dq Li -d ,
3543 which causes missing directories to be created.
3544 .It Va mta_start_script
3545 .Pq Vt str
3546 This variable specifies the full path to the script to run to start
3547 a mail transfer agent.
3548 The default is
3549 .Pa /etc/rc.sendmail .
3550 The
3551 .Va sendmail_*
3552 variables which
3553 .Pa /etc/rc.sendmail
3554 uses are documented in the
3555 .Xr rc.sendmail 8
3556 manual page.
3557 .It Va dumpdev
3558 .Pq Vt str
3559 Indicates the device (usually a swap partition) to which a crash dump
3560 should be written in the event of a system crash.
3561 If the value of this variable is
3562 .Dq Li AUTO ,
3563 the first suitable swap device listed in
3564 .Pa /etc/fstab
3565 will be used as dump device.
3566 Otherwise, the value of this variable is passed as the argument to
3567 .Xr dumpon 8 .
3568 To disable crash dumps, set this variable to
3569 .Dq Li NO .
3570 .It Va dumpdir
3571 .Pq Vt str
3572 When the system reboots after a crash and a crash dump is found on the
3573 device specified by the
3574 .Va dumpdev
3575 variable,
3576 .Xr savecore 8
3577 will save that crash dump and a copy of the kernel to the directory
3578 specified by the
3579 .Va dumpdir
3580 variable.
3581 The default value is
3582 .Pa /var/crash .
3583 Set to
3584 .Dq Li NO
3585 to not run
3586 .Xr savecore 8
3587 at boot time when
3588 .Va dumpdir
3589 is set.
3590 .It Va savecore_flags
3591 .Pq Vt str
3592 If crash dumps are enabled, these are the flags to pass to the
3593 .Xr savecore 8
3594 utility.
3595 .It Va quota_enable
3596 .Pq Vt bool
3597 Set to
3598 .Dq Li YES
3599 to turn on user and group disk quotas on system startup via the
3600 .Xr quotaon 8
3601 command for all file systems marked as having quotas enabled in
3602 .Pa /etc/fstab .
3603 The kernel must be built with
3604 .Cd "options QUOTA"
3605 for disk quotas to function.
3606 .It Va check_quotas
3607 .Pq Vt bool
3608 Set to
3609 .Dq Li YES
3610 to enable user and group disk quota checking via the
3611 .Xr quotacheck 8
3612 command.
3613 .It Va quotacheck_flags
3614 .Pq Vt str
3615 If
3616 .Va quota_enable
3617 is set to
3618 .Dq Li YES ,
3619 and
3620 .Va check_quotas
3621 is set to
3622 .Dq Li YES ,
3623 these are the flags to pass to the
3624 .Xr quotacheck 8
3625 utility.
3626 The default is
3627 .Dq Li "-a" ,
3628 which checks quotas for all file systems with quotas enabled in
3629 .Pa /etc/fstab .
3630 .It Va quotaon_flags
3631 .Pq Vt str
3632 If
3633 .Va quota_enable
3634 is set to
3635 .Dq Li YES ,
3636 these are the flags to pass to the
3637 .Xr quotaon 8
3638 utility.
3639 The default is
3640 .Dq Li "-a" ,
3641 which enables quotas for all file systems with quotas enabled in
3642 .Pa /etc/fstab .
3643 .It Va quotaoff_flags
3644 .Pq Vt str
3645 If
3646 .Va quota_enable
3647 is set to
3648 .Dq Li YES ,
3649 these are the flags to pass to the
3650 .Xr quotaoff 8
3651 utility when shutting down the quota system.
3652 The default is
3653 .Dq Li "-a" ,
3654 which disables quotas for all file systems with quotas enabled in
3655 .Pa /etc/fstab .
3656 .It Va accounting_enable
3657 .Pq Vt bool
3658 Set to
3659 .Dq Li YES
3660 to enable system accounting through the
3661 .Xr accton 8
3662 facility.
3663 .It Va ibcs2_enable
3664 .Pq Vt bool
3665 Set to
3666 .Dq Li YES
3667 to enable iBCS2 (SCO) binary emulation at system initial boot
3668 time.
3669 .It Va ibcs2_loaders
3670 .Pq Vt str
3671 If not set to
3672 .Dq Li NO
3673 and if
3674 .Va ibcs2_enable
3675 is set to
3676 .Dq Li YES ,
3677 this specifies a list of additional iBCS2 loaders to enable.
3678 .It Va linux_enable
3679 .Pq Vt bool
3680 Set to
3681 .Dq Li YES
3682 to enable Linux/ELF binary emulation at system initial
3683 boot time.
3684 .It Va svr4_enable
3685 .Pq Vt bool
3686 If set to
3687 .Dq Li YES ,
3688 enable SysVR4 emulation at boot time.
3689 .It Va sysvipc_enable
3690 .Pq Vt bool
3691 If set to
3692 .Dq Li YES ,
3693 load System V IPC primitives at boot time.
3694 .It Va clear_tmp_enable
3695 .Pq Vt bool
3696 Set to
3697 .Dq Li YES
3698 to have
3699 .Pa /tmp
3700 cleaned at startup.
3701 .It Va clear_tmp_X
3702 .Pq Vt bool
3703 Set to
3704 .Dq Li NO
3705 to disable removing of X11 lock files,
3706 and the removal and (secure) recreation
3707 of the various socket directories for X11
3708 related programs.
3709 .It Va ldconfig_paths
3710 .Pq Vt str
3711 Set to the list of shared library paths to use with
3712 .Xr ldconfig 8 .
3713 NOTE:
3714 .Pa /usr/lib
3715 will always be added first, so it need not appear in this list.
3716 .It Va ldconfig32_paths
3717 .Pq Vt str
3718 Set to the list of 32-bit compatibility shared library paths to
3719 use with
3720 .Xr ldconfig 8 .
3721 .It Va ldconfig_paths_aout
3722 .Pq Vt str
3723 Set to the list of shared library paths to use with
3724 .Xr ldconfig 8
3725 legacy
3726 .Xr a.out 5
3727 support.
3728 .It Va ldconfig_insecure
3729 .Pq Vt bool
3730 The
3731 .Xr ldconfig 8
3732 utility normally refuses to use directories
3733 which are writable by anyone except root.
3734 Set this variable to
3735 .Dq Li YES
3736 to disable that security check during system startup.
3737 .It Va ldconfig_local_dirs
3738 .Pq Vt str
3739 Set to the list of local
3740 .Xr ldconfig 8
3741 directories.
3742 The names of all files in the directories listed will be
3743 passed as arguments to
3744 .Xr ldconfig 8 .
3745 .It Va ldconfig_local32_dirs
3746 .Pq Vt str
3747 Set to the list of local 32-bit compatibility
3748 .Xr ldconfig 8
3749 directories.
3750 The names of all files in the directories listed will be
3751 passed as arguments to
3752 .Dq Nm ldconfig Fl 32 .
3753 .It Va kern_securelevel_enable
3754 .Pq Vt bool
3755 Set to
3756 .Dq Li YES
3757 to set the kernel security level at system startup.
3758 .It Va kern_securelevel
3759 .Pq Vt int
3760 The kernel security level to set at startup.
3761 The allowed range of
3762 .Ar value
3763 ranges from \-1 (the compile time default) to 3 (the
3764 most secure).
3765 See
3766 .Xr security 7
3767 for the list of possible security levels and their effect
3768 on system operation.
3769 .It Va sshd_program
3770 .Pq Vt str
3771 Path to the SSH server program
3772 .Pa ( /usr/sbin/sshd
3773 is the default).
3774 .It Va sshd_enable
3775 .Pq Vt bool
3776 Set to
3777 .Dq Li YES
3778 to start
3779 .Xr sshd 8
3780 at system boot time.
3781 .It Va sshd_flags
3782 .Pq Vt str
3783 If
3784 .Va sshd_enable
3785 is set to
3786 .Dq Li YES ,
3787 these are the flags to pass to the
3788 .Xr sshd 8
3789 daemon.
3790 .It Va ftpd_program
3791 .Pq Vt str
3792 Path to the FTP server program
3793 .Pa ( /usr/libexec/ftpd
3794 is the default).
3795 .It Va ftpd_enable
3796 .Pq Vt bool
3797 Set to
3798 .Dq Li YES
3799 to start
3800 .Xr ftpd 8
3801 as a stand-alone daemon at system boot time.
3802 .It Va ftpd_flags
3803 .Pq Vt str
3804 If
3805 .Va ftpd_enable
3806 is set to
3807 .Dq Li YES ,
3808 these are the additional flags to pass to the
3809 .Xr ftpd 8
3810 daemon.
3811 .It Va watchdogd_enable
3812 .Pq Vt bool
3813 If set to
3814 .Dq Li YES ,
3815 start the
3816 .Xr watchdogd 8
3817 daemon at boot time.
3818 This requires that the kernel have been compiled with a
3819 .Xr watchdog 4
3820 compatible device.
3821 .It Va watchdogd_flags
3822 .Pq Vt str
3823 If
3824 .Va watchdogd_enable
3825 is set to
3826 .Dq Li YES ,
3827 these are the flags passed to the
3828 .Xr watchdogd 8
3829 daemon.
3830 .It Va devfs_rulesets
3831 .Pq Vt str
3832 List of files containing sets of rules for
3833 .Xr devfs 8 .
3834 .It Va devfs_system_ruleset
3835 .Pq Vt str
3836 Rule name(s) to apply to the system
3837 .Pa /dev
3838 itself.
3839 .It Va devfs_set_rulesets
3840 .Pq Vt str
3841 Pairs of already-mounted
3842 .Pa dev
3843 directories and rulesets that should be applied to them.
3844 For example: /mount/dev=ruleset_name
3845 .It Va devfs_load_rulesets
3846 .Pq Vt bool
3847 If set, always load the default rulesets listed in
3848 .Va devfs_rulesets .
3849 .It Va performance_cx_lowest
3850 .Pq Vt str
3851 CPU idle state to use while on AC power.
3852 The string
3853 .Dq Li LOW
3854 indicates that
3855 .Xr acpi 4
3856 should use the lowest power state available while
3857 .Dq Li HIGH
3858 indicates that the lowest latency state (less power savings) should be used.
3859 .It Va performance_cpu_freq
3860 .Pq Vt str
3861 CPU clock frequency to use while on AC power.
3862 The string
3863 .Dq Li LOW
3864 indicates that
3865 .Xr cpufreq 4
3866 should use the lowest frequency available while
3867 .Dq Li HIGH
3868 indicates that the highest frequency (less power savings) should be used.
3869 .It Va economy_cx_lowest
3870 .Pq Vt str
3871 CPU idle state to use when off AC power.
3872 The string
3873 .Dq Li LOW
3874 indicates that
3875 .Xr acpi 4
3876 should use the lowest power state available while
3877 .Dq Li HIGH
3878 indicates that the lowest latency state (less power savings) should be used.
3879 .It Va economy_cpu_freq
3880 .Pq Vt str
3881 CPU clock frequency to use when off AC power.
3882 The string
3883 .Dq Li LOW
3884 indicates that
3885 .Xr cpufreq 4
3886 should use the lowest frequency available while
3887 .Dq Li HIGH
3888 indicates that the highest frequency (less power savings) should be used.
3889 .It Va jail_enable
3890 .Pq Vt bool
3891 If set to
3892 .Dq Li NO ,
3893 any configured jails will not be started.
3894 .It Va jail_conf
3895 .Pq Vt str
3896 The configuration filename used by
3897 .Xr jail 8
3898 utility.
3899 The default value is
3900 .Pa /etc/jail.conf .
3901 .It Va jail_parallel_start
3902 .Pq Vt bool
3903 If set to
3904 .Dq Li YES ,
3905 all configured jails will be started in the background (in parallel).
3906 .It Va jail_flags
3907 .Pq Vt str
3908 Unset by default.
3909 When set, use as default value for
3910 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3911 for every jail in
3912 .Va jail_list .
3913 .It Va jail_list
3914 .Pq Vt str
3915 A space separated list of names for jails.
3916 If this variable is empty,
3917 all of
3918 .Xr jail 8
3919 instances in the configuration file will be configured.
3920 This is purely a configuration aid to help identify and
3921 configure multiple jails.
3922 The names specified in this list will be used to
3923 identify settings common to an instance of a jail,
3924 and should contain alphanumeric characters only.
3925 The literal jail name of
3926 .Dq Li 0
3927 .Pq zero
3928 is not allowed.
3929 .It Va jail_* variables
3930 Note that older releases supported per-jail configuration via
3931 .Xr rc.conf 5
3932 variables.
3933 For example,
3934 hostname of a jail named
3935 .Li vjail
3936 was able to be set by
3937 .Li jail_vjail_hostname .
3938 These per-jail configuration variables are now obsolete in favor of
3939 .Xr jail 8
3940 configuration file.
3941 For backward compatibility,
3942 when per-jail configuration variables are defined,
3943 .Xr jail 8
3944 configuration files are created as
3945 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3946 and used.
3947 .Pp
3948 The following per-jail parameters are handled by
3949 .Pa rc.d/jail
3950 script out of their corresponding
3951 .Nm
3952 variables.
3953 In addition to them, parameters in
3954 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3955 will be added to the configuration file.
3956 They must be a semi-colon
3957 .Pq Ql \&;
3958 delimited list of
3959 .Dq key=value .
3960 For more details,
3961 see
3962 .Xr jail 8
3963 manual page.
3964 .Bl  -tag -width "host.hostname" -offset indent
3965 .It Li path
3966 set from
3967 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3968 .It Li host.hostname
3969 set from
3970 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3971 .It Li exec.consolelog
3972 set from
3973 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3974 The default value is
3975 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3976 .It Li interface
3977 set from
3978 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3979 .It Li vnet.interface
3980 set from
3981 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3982 This implies
3983 .Li vnet
3984 parameter will be enabled and cannot be specified with
3985 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3986 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3987 and/or
3988 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3989 at the same time.
3990 .It Li fstab
3991 set from
3992 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3993 .It Li mount
3994 set from
3995 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3996 or
3997 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable.
3998 .It Li exec.fib
3999 set from
4000 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
4001 .It Li exec.start
4002 set from
4003 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
4004 The parameter name was
4005 .Li command
4006 in some older releases.
4007 .It Li exec.prestart
4008 set from
4009 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
4010 .It Li exec.poststart
4011 set from
4012 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
4013 .It Li exec.stop
4014 set from
4015 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
4016 .It Li exec.prestop
4017 set from
4018 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
4019 .It Li exec.poststop
4020 set from
4021 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
4022 .It Li ip4.addr
4023 set if
4024 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4025 or
4026 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4027 contain IPv4 addresses
4028 .It Li ip6.addr
4029 set if
4030 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
4031 or
4032 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
4033 contain IPv6 addresses
4034 .It Li allow.mount
4035 set from
4036 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
4037 .It Li mount.devfs
4038 set from
4039 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
4040 .It Li devfs_ruleset
4041 set from
4042 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
4043 This must be an integer,
4044 not a string.
4045 .It Li allow.set_hostname
4046 set from
4047 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4048 .It Li allow.rawsocket
4049 set from
4050 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4051 .It Li allow.sysvipc
4052 set from
4053 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4054 .El
4055 .\" -----------------------------------------------------
4056 .It Va harvest_interrupt
4057 .Pq Vt bool
4058 Set to
4059 .Dq Li YES
4060 to use hardware interrupts as an entropy source.
4061 Refer to
4062 .Xr random 4
4063 for more information.
4064 .It Va harvest_ethernet
4065 .Pq Vt bool
4066 Set to
4067 .Dq Li YES
4068 to use LAN traffic as an entropy source.
4069 Refer to
4070 .Xr random 4
4071 for more information.
4072 .It Va harvest_p_to_p
4073 .Pq Vt bool
4074 Set to
4075 .Dq Li YES
4076 to use serial line traffic as an entropy source.
4077 Refer to
4078 .Xr random 4
4079 for more information.
4080 .It Va entropy_dir
4081 .Pq Vt str
4082 Set to
4083 .Dq Li NO
4084 to disable caching entropy via
4085 .Xr cron 8 .
4086 Otherwise set to the directory used to store entropy files in.
4087 .It Va entropy_file
4088 .Pq Vt str
4089 Set to
4090 .Dq Li NO
4091 to disable caching entropy through reboots.
4092 Otherwise set to the filename used to store cached entropy through
4093 reboots.
4094 This file should be located on the root file system to seed the
4095 .Xr random 4
4096 device as early as possible in the boot process.
4097 .It Va entropy_save_sz
4098 .Pq Vt int
4099 Size of the entropy cache files saved by
4100 .Nm save-entropy
4101 periodically.
4102 .It Va entropy_save_num
4103 .Pq Vt int
4104 Number of entropy cache files to save by
4105 .Nm save-entropy
4106 periodically.
4107 .It Va ipsec_enable
4108 .Pq Vt bool
4109 Set to
4110 .Dq Li YES
4111 to run
4112 .Xr setkey 8
4113 on
4114 .Va ipsec_file
4115 at boot time.
4116 .It Va ipsec_file
4117 .Pq Vt str
4118 Configuration file for
4119 .Xr setkey 8 .
4120 .It Va dmesg_enable
4121 .Pq Vt bool
4122 Set to
4123 .Dq Li YES
4124 to save
4125 .Xr dmesg 8
4126 to
4127 .Pa /var/run/dmesg.boot
4128 on boot.
4129 .It Va rcshutdown_timeout
4130 .Pq Vt int
4131 If set, start a watchdog timer in the background which will terminate
4132 .Pa rc.shutdown
4133 if
4134 .Xr shutdown 8
4135 has not completed within the specified time (in seconds).
4136 Notice that in addition to this soft timeout,
4137 .Xr init 8
4138 also applies a hard timeout for the execution of
4139 .Pa rc.shutdown .
4140 This is configured via
4141 .Xr sysctl 8
4142 variable
4143 .Va kern.init_shutdown_timeout
4144 and defaults to 120 seconds.
4145 Setting the value of
4146 .Va rcshutdown_timeout
4147 to more than 120 seconds will have no effect until the
4148 .Xr sysctl 8
4149 variable
4150 .Va kern.init_shutdown_timeout
4151 is also increased.
4152 .It Va virecover_enable
4153 .Pq Vt bool
4154 Set to
4155 .Dq Li NO
4156 to prevent the system from trying to
4157 recover pre-maturely terminated
4158 .Xr vi 1
4159 sessions.
4160 .It Va ugidfw_enable
4161 .Pq Vt bool
4162 Set to
4163 .Dq Li YES
4164 to load the
4165 .Xr mac_bsdextended 4
4166 module upon system initialization and load a default
4167 ruleset file.
4168 .It Va bsdextended_script
4169 .Pq Vt str
4170 The default
4171 .Xr mac_bsdextended 4
4172 ruleset file to load.
4173 The default value of this variable is
4174 .Pa /etc/rc.bsdextended .
4175 .It Va newsyslog_enable
4176 .Pq Vt bool
4177 If set to
4178 .Dq Li YES ,
4179 run
4180 .Xr newsyslog 8
4181 command at startup.
4182 .It Va newsyslog_flags
4183 .Pq Vt str
4184 If
4185 .Va newsyslog_enable
4186 is set to
4187 .Dq Li YES ,
4188 these are the flags to pass to the
4189 .Xr newsyslog 8
4190 program.
4191 The default is
4192 .Dq Li -CN ,
4193 which causes log files flagged with a
4194 .Cm C
4195 to be created.
4196 .It Va mdconfig_md Ns Aq Ar X
4197 .Pq Vt str
4198 Arguments to
4199 .Xr mdconfig 8
4200 for
4201 .Xr md 4
4202 device
4203 .Ar X .
4204 At minimum a
4205 .Fl t Ar type
4206 must be specified and either a
4207 .Fl s Ar size
4208 for malloc or swap backed
4209 .Xr md 4
4210 devices or a
4211 .Fl f Ar file
4212 for vnode backed
4213 .Xr md 4
4214 devices.
4215 Note that
4216 .Va mdconfig_md Ns Aq Ar X
4217 variables are evaluated until one variable is unset or null.
4218 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4219 .Pq Vt str
4220 Optional arguments passed to
4221 .Xr newfs 8
4222 to initialize
4223 .Xr md 4
4224 device
4225 .Ar X .
4226 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4227 .Pq Vt str
4228 An ownership specification passed to
4229 .Xr chown 8
4230 after the specified
4231 .Xr md 4
4232 device
4233 .Ar X
4234 has been mounted.
4235 Both the
4236 .Xr md 4
4237 device and the mount point will be changed.
4238 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4239 .Pq Vt str
4240 A mode string passed to
4241 .Xr chmod 1
4242 after the specified
4243 .Xr md 4
4244 device
4245 .Ar X
4246 has been mounted.
4247 Both the
4248 .Xr md 4
4249 device and the mount point will be changed.
4250 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4251 .Pq Vt str
4252 Files to be copied to the mount point of the
4253 .Xr md 4
4254 device
4255 .Ar X
4256 after it has been mounted.
4257 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4258 .Pq Vt str
4259 Command to execute after the specified
4260 .Xr md 4
4261 device
4262 .Ar X
4263 has been mounted.
4264 Note that the command is passed to
4265 .Ic eval
4266 and that both
4267 .Va _dev
4268 and
4269 .Va _mp
4270 variables can be used to reference respectively the
4271 .Xr md 4
4272 device and the mount point.
4273 Assuming that the
4274 .Xr md 4
4275 device is
4276 .Li md0 ,
4277 one could set the following:
4278 .Bd -literal
4279 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4280 .Ed
4281 .It Va autobridge_interfaces
4282 .Pq Vt str
4283 Set to the list of bridge interfaces that will have newly arriving interfaces
4284 checked against to be automatically added.
4285 If not set to
4286 .Dq Li NO
4287 then for each whitespace separated
4288 .Ar element
4289 in the value, a
4290 .Va autobridge_ Ns Aq Ar element
4291 variable is assumed to exist which has a whitespace separated list of interface
4292 names to match, these names can use wildcards.
4293 For example:
4294 .Bd -literal
4295 autobridge_interfaces="bridge0"
4296 autobridge_bridge0="tap* dc0 vlan[345]"
4297 .Ed
4298 .It Va mixer_enable
4299 .Pq Vt bool
4300 If set to
4301 .Dq Li YES ,
4302 enable support for sound mixer.
4303 .It Va hcsecd_enable
4304 .Pq Vt bool
4305 If set to
4306 .Dq Li YES ,
4307 enable Bluetooth security daemon.
4308 .It Va hcsecd_config
4309 .Pq Vt str
4310 Configuration file for
4311 .Xr hcsecd 8 .
4312 Default
4313 .Pa /etc/bluetooth/hcsecd.conf .
4314 .It Va sdpd_enable
4315 .Pq Vt bool
4316 If set to
4317 .Dq Li YES ,
4318 enable Bluetooth Service Discovery Protocol daemon.
4319 .It Va sdpd_control
4320 .Pq Vt str
4321 Path to
4322 .Xr sdpd 8
4323 control socket.
4324 Default
4325 .Pa /var/run/sdp .
4326 .It Va sdpd_groupname
4327 .Pq Vt str
4328 Sets
4329 .Xr sdpd 8
4330 group to run as after it initializes.
4331 Default
4332 .Dq Li nobody .
4333 .It Va sdpd_username
4334 .Pq Vt str
4335 Sets
4336 .Xr sdpd 8
4337 user to run as after it initializes.
4338 Default
4339 .Dq Li nobody .
4340 .It Va bthidd_enable
4341 .Pq Vt bool
4342 If set to
4343 .Dq Li YES ,
4344 enable Bluetooth Human Interface Device daemon.
4345 .It Va bthidd_config
4346 .Pq Vt str
4347 Configuration file for
4348 .Xr bthidd 8 .
4349 Default
4350 .Pa /etc/bluetooth/bthidd.conf .
4351 .It Va bthidd_hids
4352 .Pq Vt str
4353 Path to a file, where
4354 .Xr bthidd 8
4355 will store information about known HID devices.
4356 Default
4357 .Pa /var/db/bthidd.hids .
4358 .It Va rfcomm_pppd_server_enable
4359 .Pq Vt bool
4360 If set to
4361 .Dq Li YES ,
4362 enable Bluetooth RFCOMM PPP wrapper daemon.
4363 .It Va rfcomm_pppd_server_profile
4364 .Pq Vt str
4365 The name of the profile to use from
4366 .Pa /etc/ppp/ppp.conf .
4367 Multiple profiles can be specified here.
4368 Also used to specify per-profile overrides.
4369 When the profile name contains any of the characters
4370 .Dq Li .-/+
4371 they are translated to
4372 .Dq Li _
4373 for the proposes of the override variable names.
4374 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4375 .Pq Vt str
4376 Overrides local address to listen on.
4377 By default
4378 .Xr rfcomm_pppd 8
4379 will listen on
4380 .Dq Li ANY
4381 address.
4382 The address can be specified as BD_ADDR or name.
4383 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4384 .Pq Vt str
4385 Overrides local RFCOMM channel to listen on.
4386 By default
4387 .Xr rfcomm_pppd 8
4388 will listen on RFCOMM channel 1.
4389 Must set properly if multiple profiles used in the same time.
4390 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4391 .Pq Vt bool
4392 Tells
4393 .Xr rfcomm_pppd 8
4394 if it should register Serial Port service on the specified RFCOMM channel.
4395 Default
4396 .Dq Li NO .
4397 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4398 .Pq Vt bool
4399 Tells
4400 .Xr rfcomm_pppd 8
4401 if it should register Dial-Up Networking service on the specified
4402 RFCOMM channel.
4403 Default
4404 .Dq Li NO .
4405 .It Va ubthidhci_enable
4406 .Pq Vt bool
4407 If set to
4408 .Dq Li YES ,
4409 change the USB Bluetooth controller from HID mode to HCI mode.
4410 You also need to specify the location of USB Bluetooth controller with the
4411 .Va ubthidhci_busnum
4412 and
4413 .Va ubthidhci_addr
4414 variables.
4415 .It Va ubthidhci_busnum
4416 Bus number where the USB Bluetooth controller is located.
4417 Check the output of
4418 .Xr usbconfig 8
4419 on your system to find this information.
4420 .It Va ubthidhci_addr
4421 Bus address of the USB Bluetooth controller.
4422 Check the output of
4423 .Xr usbconfig 8
4424 on your system to find this information.
4425 .It Va netwait_enable
4426 .Pq Vt bool
4427 If set to
4428 .Dq Li YES ,
4429 delays the start of network-reliant services until
4430 .Va netwait_if
4431 is up and ICMP packets to a destination defined in
4432 .Va netwait_ip
4433 are flowing.
4434 Link state is examined first, followed by
4435 .Dq Li pinging
4436 an IP address to verify network usability.
4437 If no destination can be reached or timeouts are exceeded,
4438 network services are started anyway with no guarantee that
4439 the network is usable.
4440 Use of this variable requires both
4441 .Va netwait_ip
4442 and
4443 .Va netwait_if
4444 to be set.
4445 .It Va netwait_ip
4446 .Pq Vt str
4447 Empty by default.
4448 This variable contains a space-delimited list of IP addresses to
4449 .Xr ping 8 .
4450 DNS hostnames should not be used as resolution is not guaranteed
4451 to be functional at this point.
4452 If multiple IP addresses are specified,
4453 each will be tried until one is successful or the list is exhausted.
4454 .It Va netwait_timeout
4455 .Pq Vt int
4456 Indicates the total number of seconds to perform a
4457 .Dq Li ping
4458 against each IP address in
4459 .Va netwait_ip ,
4460 at a rate of one ping per second.
4461 If any of the pings are successful,
4462 full network connectivity is considered reliable.
4463 The default is 60.
4464 .It Va netwait_if
4465 .Pq Vt str
4466 Empty by default.
4467 Defines the name of the network interface on which watch for link.
4468 .Xr ifconfig 8
4469 is used to monitor the interface, looking for
4470 .Dq Li status: no carrier .
4471 Once gone, the link is considered up.
4472 This can be a
4473 .Xr vlan 4
4474 interface if desired.
4475 .It Va netwait_if_timeout
4476 .Pq Vt int
4477 Defines the total number of seconds to wait for link to become usable,
4478 polled at a 1-second interval.
4479 The default is 30.
4480 .El
4481 .Sh FILES
4482 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4483 .It Pa /etc/defaults/rc.conf
4484 .It Pa /etc/rc.conf
4485 .It Pa /etc/rc.conf.local
4486 .El
4487 .Sh SEE ALSO
4488 .Xr catman 1 ,
4489 .Xr chmod 1 ,
4490 .Xr gdb 1 ,
4491 .Xr info 1 ,
4492 .Xr kbdcontrol 1 ,
4493 .Xr makewhatis 1 ,
4494 .Xr sh 1 ,
4495 .Xr vi 1 ,
4496 .Xr vidcontrol 1 ,
4497 .Xr bridge 4 ,
4498 .Xr dummynet 4 ,
4499 .Xr ip 4 ,
4500 .Xr ipf 4 ,
4501 .Xr ipfw 4 ,
4502 .Xr ipnat 4 ,
4503 .Xr kld 4 ,
4504 .Xr pf 4 ,
4505 .Xr pflog 4 ,
4506 .Xr pfsync 4 ,
4507 .Xr tcp 4 ,
4508 .Xr udp 4 ,
4509 .Xr exports 5 ,
4510 .Xr fstab 5 ,
4511 .Xr ipf 5 ,
4512 .Xr ipnat 5 ,
4513 .Xr motd 5 ,
4514 .Xr newsyslog.conf 5 ,
4515 .Xr pf.conf 5 ,
4516 .Xr security 7 ,
4517 .Xr accton 8 ,
4518 .Xr amd 8 ,
4519 .Xr apm 8 ,
4520 .Xr atm 8 ,
4521 .Xr bthidd 8 ,
4522 .Xr chkprintcap 8 ,
4523 .Xr chown 8 ,
4524 .Xr cron 8 ,
4525 .Xr devfs 8 ,
4526 .Xr dhclient 8 ,
4527 .Xr ftpd 8 ,
4528 .Xr geli 8 ,
4529 .Xr hcsecd 8 ,
4530 .Xr ifconfig 8 ,
4531 .Xr inetd 8 ,
4532 .Xr ipf 8 ,
4533 .Xr ipfw 8 ,
4534 .Xr ipnat 8 ,
4535 .Xr jail 8 ,
4536 .Xr kldxref 8 ,
4537 .Xr lpd 8 ,
4538 .Xr mdconfig 8 ,
4539 .Xr mdmfs 8 ,
4540 .Xr mixer 8 ,
4541 .Xr mountd 8 ,
4542 .Xr moused 8 ,
4543 .Xr mrouted 8 ,
4544 .Xr named 8 ,
4545 .Xr newfs 8 ,
4546 .Xr newsyslog 8 ,
4547 .Xr nfsd 8 ,
4548 .Xr ntpd 8 ,
4549 .Xr ntpdate 8 ,
4550 .Xr pfctl 8 ,
4551 .Xr pflogd 8 ,
4552 .Xr ping 8 ,
4553 .Xr powerd 8 ,
4554 .Xr quotacheck 8 ,
4555 .Xr quotaon 8 ,
4556 .Xr rc 8 ,
4557 .Xr rc.sendmail 8 ,
4558 .Xr rfcomm_pppd 8 ,
4559 .Xr route 8 ,
4560 .Xr routed 8 ,
4561 .Xr rpcbind 8 ,
4562 .Xr rpc.lockd 8 ,
4563 .Xr rpc.statd 8 ,
4564 .Xr rwhod 8 ,
4565 .Xr savecore 8 ,
4566 .Xr sdpd 8 ,
4567 .Xr sshd 8 ,
4568 .Xr swapon 8 ,
4569 .Xr sysctl 8 ,
4570 .Xr syslogd 8 ,
4571 .Xr timed 8 ,
4572 .Xr unbound 8 ,
4573 .Xr usbconfig 8 ,
4574 .Xr wlandebug 8 ,
4575 .Xr yp 8 ,
4576 .Xr ypbind 8 ,
4577 .Xr ypserv 8 ,
4578 .Xr ypset 8
4579 .Sh HISTORY
4580 The
4581 .Nm
4582 file appeared in
4583 .Fx 2.2.2 .
4584 .Sh AUTHORS
4585 .An Jordan K. Hubbard .