]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - share/man/man5/rc.conf.5
MFC r270647: Add references to vt(4) and the configuration files in /usr/sha
[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 February 15, 2014
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 kerberos5_server_enable
2052 .Pq Vt bool
2053 Set to
2054 .Dq Li YES
2055 to start a Kerberos 5 authentication server
2056 at boot time.
2057 .It Va kerberos5_server
2058 .Pq Vt str
2059 If
2060 .Va kerberos5_server_enable
2061 is set to
2062 .Dq Li YES
2063 this is the path to Kerberos 5 Authentication Server.
2064 .It Va kerberos5_server_flags
2065 .Pq Vt str
2066 Empty by default.
2067 This variable contains additional flags to be passed to the Kerberos 5
2068 authentication server.
2069 .It Va kadmind5_server_enable
2070 .Pq Vt bool
2071 Set to
2072 .Dq Li YES
2073 to start
2074 .Xr kadmind 8 ,
2075 the Kerberos 5 Administration Daemon; set to
2076 .Dq Li NO
2077 on a slave server.
2078 .It Va kadmind5_server
2079 .Pq Vt str
2080 If
2081 .Va kadmind5_server_enable
2082 is set to
2083 .Dq Li YES
2084 this is the path to Kerberos 5 Administration Daemon.
2085 .It Va kpasswdd_server_enable
2086 .Pq Vt bool
2087 Set to
2088 .Dq Li YES
2089 to start
2090 .Xr kpasswdd 8 ,
2091 the Kerberos 5 Password-Changing Daemon; set to
2092 .Dq Li NO
2093 on a slave server.
2094 .It Va kpasswdd_server
2095 .Pq Vt str
2096 If
2097 .Va kpasswdd_server_enable
2098 is set to
2099 .Dq Li YES
2100 this is the path to Kerberos 5 Password-Changing Daemon.
2101 .It Va kfd_enable
2102 .Pq Vt bool
2103 Set to
2104 .Dq Li YES
2105 to start
2106 .Xr kfd 8 ,
2107 the Kerberos 5 ticket forwarding daemon, at the boot time.
2108 .It Va kfd_program
2109 .Pq Vt str
2110 Path to
2111 .Xr kfd 8
2112 (default
2113 .Pa /usr/libexec/kfd ) .
2114 .It Va rwhod_enable
2115 .Pq Vt bool
2116 If set to
2117 .Dq Li YES ,
2118 run the
2119 .Xr rwhod 8
2120 daemon at boot time.
2121 .It Va rwhod_flags
2122 .Pq Vt str
2123 If
2124 .Va rwhod_enable
2125 is set to
2126 .Dq Li YES ,
2127 these are the flags to pass to it.
2128 .It Va amd_enable
2129 .Pq Vt bool
2130 If set to
2131 .Dq Li YES ,
2132 run the
2133 .Xr amd 8
2134 daemon at boot time.
2135 .It Va amd_flags
2136 .Pq Vt str
2137 If
2138 .Va amd_enable
2139 is set to
2140 .Dq Li YES ,
2141 these are the flags to pass to it.
2142 See the
2143 .Xr amd 8
2144 manpage for more information.
2145 .It Va amd_map_program
2146 .Pq Vt str
2147 If set,
2148 the specified program is run to get the list of
2149 .Xr amd 8
2150 maps.
2151 For example, if the
2152 .Xr amd 8
2153 maps are stored in NIS, one can set this to
2154 run
2155 .Xr ypcat 1
2156 to get a list of
2157 .Xr amd 8
2158 maps from the
2159 .Pa amd.master
2160 NIS map.
2161 .It Va update_motd
2162 .Pq Vt bool
2163 If set to
2164 .Dq Li YES ,
2165 .Pa /etc/motd
2166 will be updated at boot time to reflect the kernel release
2167 being run.
2168 If set to
2169 .Dq Li NO ,
2170 .Pa /etc/motd
2171 will not be updated.
2172 .It Va nfs_client_enable
2173 .Pq Vt bool
2174 If set to
2175 .Dq Li YES ,
2176 run the NFS client daemons at boot time.
2177 .It Va nfs_access_cache
2178 .Pq Vt int
2179 If
2180 .Va nfs_client_enable
2181 is set to
2182 .Dq Li YES ,
2183 this can be set to
2184 .Dq Li 0
2185 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2186 NFS ACCESS
2187 results should be cached.
2188 A value of 2-10 seconds will substantially reduce network
2189 traffic for many NFS operations.
2190 .It Va nfs_server_enable
2191 .Pq Vt bool
2192 If set to
2193 .Dq Li YES ,
2194 run the NFS server daemons at boot time.
2195 .It Va nfs_server_flags
2196 .Pq Vt str
2197 If
2198 .Va nfs_server_enable
2199 is set to
2200 .Dq Li YES ,
2201 these are the flags to pass to the
2202 .Xr nfsd 8
2203 daemon.
2204 .It Va nfsv4_server_enable
2205 .Pq Vt bool
2206 If
2207 .Va nfs_server_enable
2208 is set to
2209 .Dq Li YES
2210 and
2211 .Va nfsv4_server_enable
2212 are set to
2213 .Dq Li YES ,
2214 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2215 .It Va nfsuserd_enable
2216 .Pq Vt bool
2217 If
2218 .Va nfsuserd_enable
2219 is set to
2220 .Dq Li YES ,
2221 run the nfsuserd daemon, which is needed for NFSv4 in order
2222 to map between user/group names vs uid/gid numbers.
2223 If
2224 .Va nfsv4_server_enable
2225 is set to
2226 .Dq Li YES ,
2227 this will be forced enabled.
2228 .It Va nfsuserd_flags
2229 .Pq Vt str
2230 If
2231 .Va nfsuserd_enable
2232 is set to
2233 .Dq Li YES ,
2234 these are the flags to pass to the
2235 .Xr nfsuserd 8
2236 daemon.
2237 .It Va nfscbd_enable
2238 .Pq Vt bool
2239 If
2240 .Va nfscbd_enable
2241 is set to
2242 .Dq Li YES ,
2243 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2244 .It Va nfscbd_flags
2245 .Pq Vt str
2246 If
2247 .Va nfscbd_enable
2248 is set to
2249 .Dq Li YES ,
2250 these are the flags to pass to the
2251 .Xr nfscbd 8
2252 daemon.
2253 .It Va oldnfs_server_enable
2254 .Pq Vt bool
2255 If
2256 .Va oldnfs_server_enable
2257 is set to
2258 .Dq Li YES ,
2259 force the NFS server daemons to run the old NFS server code
2260 that does not support NFSv4.
2261 .It Va mountd_enable
2262 .Pq Vt bool
2263 If set to
2264 .Dq Li YES ,
2265 and no
2266 .Va nfs_server_enable
2267 is set, start
2268 .Xr mountd 8 ,
2269 but not
2270 .Xr nfsd 8
2271 daemon.
2272 It is commonly needed to run CFS without real NFS used.
2273 .It Va mountd_flags
2274 .Pq Vt str
2275 If
2276 .Va mountd_enable
2277 is set to
2278 .Dq Li YES ,
2279 these are the flags to pass to the
2280 .Xr mountd 8
2281 daemon.
2282 .It Va weak_mountd_authentication
2283 .Pq Vt bool
2284 If set to
2285 .Dq Li YES ,
2286 allow services like PCNFSD to make non-privileged mount
2287 requests.
2288 .It Va nfs_reserved_port_only
2289 .Pq Vt bool
2290 If set to
2291 .Dq Li YES ,
2292 provide NFS services only on a secure port.
2293 .It Va nfs_bufpackets
2294 .Pq Vt int
2295 If set to a number, indicates the number of packets worth of
2296 socket buffer space to reserve on an NFS client.
2297 The kernel default is typically 4.
2298 Using a higher number may be
2299 useful on gigabit networks to improve performance.
2300 The minimum value is
2301 2 and the maximum is 64.
2302 .It Va rpc_lockd_enable
2303 .Pq Vt bool
2304 If set to
2305 .Dq Li YES
2306 and also an NFS server or client, run
2307 .Xr rpc.lockd 8
2308 at boot time.
2309 .It Va rpc_lockd_flags
2310 .Pq Vt str
2311 If
2312 .Va rpc_lockd_enable
2313 is set to
2314 .Dq Li YES ,
2315 these are the flags to pass to the
2316 .Xr rpc.lockd 8
2317 daemon.
2318 .It Va rpc_statd_enable
2319 .Pq Vt bool
2320 If set to
2321 .Dq Li YES
2322 and also an NFS server or client, run
2323 .Xr rpc.statd 8
2324 at boot time.
2325 .It Va rpc_statd_flags
2326 .Pq Vt str
2327 If
2328 .Va rpc_statd_enable
2329 is set to
2330 .Dq Li YES ,
2331 these are the flags to pass to the
2332 .Xr rpc.statd 8
2333 daemon.
2334 .It Va rpcbind_program
2335 .Pq Vt str
2336 Path to
2337 .Xr rpcbind 8
2338 (default
2339 .Pa /usr/sbin/rpcbind ) .
2340 .It Va rpcbind_enable
2341 .Pq Vt bool
2342 If set to
2343 .Dq Li YES ,
2344 run the
2345 .Xr rpcbind 8
2346 service at boot time.
2347 .It Va rpcbind_flags
2348 .Pq Vt str
2349 If
2350 .Va rpcbind_enable
2351 is set to
2352 .Dq Li YES ,
2353 these are the flags to pass to the
2354 .Xr rpcbind 8
2355 daemon.
2356 .It Va keyserv_enable
2357 .Pq Vt bool
2358 If set to
2359 .Dq Li YES ,
2360 run the
2361 .Xr keyserv 8
2362 daemon on boot for running Secure RPC.
2363 .It Va keyserv_flags
2364 .Pq Vt str
2365 If
2366 .Va keyserv_enable
2367 is set to
2368 .Dq Li YES ,
2369 these are the flags to pass to
2370 .Xr keyserv 8
2371 daemon.
2372 .It Va pppoed_enable
2373 .Pq Vt bool
2374 If set to
2375 .Dq Li YES ,
2376 run the
2377 .Xr pppoed 8
2378 daemon at boot time to provide PPP over Ethernet services.
2379 .It Va pppoed_ Ns Aq Ar provider
2380 .Pq Vt str
2381 .Xr pppoed 8
2382 listens to requests to this
2383 .Ar provider
2384 and ultimately runs
2385 .Xr ppp 8
2386 with a
2387 .Ar system
2388 argument of the same name.
2389 .It Va pppoed_flags
2390 .Pq Vt str
2391 Additional flags to pass to
2392 .Xr pppoed 8 .
2393 .It Va pppoed_interface
2394 .Pq Vt str
2395 The network interface to run
2396 .Xr pppoed 8
2397 on.
2398 This is mandatory when
2399 .Va pppoed_enable
2400 is set to
2401 .Dq Li YES .
2402 .It Va timed_enable
2403 .Pq Vt bool
2404 If set to
2405 .Dq Li YES ,
2406 run the
2407 .Xr timed 8
2408 service at boot time.
2409 This command is intended for networks of
2410 machines where a consistent
2411 .Dq "network time"
2412 for all hosts must be established.
2413 This is often useful in large NFS
2414 environments where time stamps on files are expected to be consistent
2415 network-wide.
2416 .It Va timed_flags
2417 .Pq Vt str
2418 If
2419 .Va timed_enable
2420 is set to
2421 .Dq Li YES ,
2422 these are the flags to pass to the
2423 .Xr timed 8
2424 service.
2425 .It Va ntpdate_enable
2426 .Pq Vt bool
2427 If set to
2428 .Dq Li YES ,
2429 run
2430 .Xr ntpdate 8
2431 at system startup.
2432 This command is intended to
2433 synchronize the system clock only
2434 .Em once
2435 from some standard reference.
2436 .It Va ntpdate_config
2437 .Pq Vt str
2438 Configuration file for
2439 .Xr ntpdate 8 .
2440 Default
2441 .Pa /etc/ntp.conf .
2442 .It Va ntpdate_hosts
2443 .Pq Vt str
2444 A whitespace-separated list of NTP servers to synchronize with at startup.
2445 The default is to use the servers listed in
2446 .Va ntpdate_config ,
2447 if that file exists.
2448 .It Va ntpdate_program
2449 .Pq Vt str
2450 Path to
2451 .Xr ntpdate 8
2452 (default
2453 .Pa /usr/sbin/ntpdate ) .
2454 .It Va ntpdate_flags
2455 .Pq Vt str
2456 If
2457 .Va ntpdate_enable
2458 is set to
2459 .Dq Li YES ,
2460 these are the flags to pass to the
2461 .Xr ntpdate 8
2462 command (typically a hostname).
2463 .It Va ntpd_enable
2464 .Pq Vt bool
2465 If set to
2466 .Dq Li YES ,
2467 run the
2468 .Xr ntpd 8
2469 command at boot time.
2470 .It Va ntpd_program
2471 .Pq Vt str
2472 Path to
2473 .Xr ntpd 8
2474 (default
2475 .Pa /usr/sbin/ntpd ) .
2476 .It Va ntpd_config
2477 .Pq Vt str
2478 Path to
2479 .Xr ntpd 8
2480 configuration file.
2481 Default
2482 .Pa /etc/ntp.conf .
2483 .It Va ntpd_flags
2484 .Pq Vt str
2485 If
2486 .Va ntpd_enable
2487 is set to
2488 .Dq Li YES ,
2489 these are the flags to pass to the
2490 .Xr ntpd 8
2491 daemon.
2492 .It Va ntpd_sync_on_start
2493 .Pq Vt bool
2494 If set to
2495 .Dq Li YES ,
2496 .Xr ntpd 8
2497 is run with the
2498 .Fl g
2499 flag, which syncs the system's clock on startup.
2500 See
2501 .Xr ntpd 8
2502 for more information regarding the
2503 .Fl g
2504 option.
2505 This is a preferred alternative to using
2506 .Xr ntpdate 8
2507 or specifying the
2508 .Va ntpdate_enable
2509 variable.
2510 .It Va nis_client_enable
2511 .Pq Vt bool
2512 If set to
2513 .Dq Li YES ,
2514 run the
2515 .Xr ypbind 8
2516 service at system boot time.
2517 .It Va nis_client_flags
2518 .Pq Vt str
2519 If
2520 .Va nis_client_enable
2521 is set to
2522 .Dq Li YES ,
2523 these are the flags to pass to the
2524 .Xr ypbind 8
2525 service.
2526 .It Va nis_ypset_enable
2527 .Pq Vt bool
2528 If set to
2529 .Dq Li YES ,
2530 run the
2531 .Xr ypset 8
2532 daemon at system boot time.
2533 .It Va nis_ypset_flags
2534 .Pq Vt str
2535 If
2536 .Va nis_ypset_enable
2537 is set to
2538 .Dq Li YES ,
2539 these are the flags to pass to the
2540 .Xr ypset 8
2541 daemon.
2542 .It Va nis_server_enable
2543 .Pq Vt bool
2544 If set to
2545 .Dq Li YES ,
2546 run the
2547 .Xr ypserv 8
2548 daemon at system boot time.
2549 .It Va nis_server_flags
2550 .Pq Vt str
2551 If
2552 .Va nis_server_enable
2553 is set to
2554 .Dq Li YES ,
2555 these are the flags to pass to the
2556 .Xr ypserv 8
2557 daemon.
2558 .It Va nis_ypxfrd_enable
2559 .Pq Vt bool
2560 If set to
2561 .Dq Li YES ,
2562 run the
2563 .Xr rpc.ypxfrd 8
2564 daemon at system boot time.
2565 .It Va nis_ypxfrd_flags
2566 .Pq Vt str
2567 If
2568 .Va nis_ypxfrd_enable
2569 is set to
2570 .Dq Li YES ,
2571 these are the flags to pass to the
2572 .Xr rpc.ypxfrd 8
2573 daemon.
2574 .It Va nis_yppasswdd_enable
2575 .Pq Vt bool
2576 If set to
2577 .Dq Li YES ,
2578 run the
2579 .Xr rpc.yppasswdd 8
2580 daemon at system boot time.
2581 .It Va nis_yppasswdd_flags
2582 .Pq Vt str
2583 If
2584 .Va nis_yppasswdd_enable
2585 is set to
2586 .Dq Li YES ,
2587 these are the flags to pass to the
2588 .Xr rpc.yppasswdd 8
2589 daemon.
2590 .It Va rpc_ypupdated_enable
2591 .Pq Vt bool
2592 If set to
2593 .Dq Li YES ,
2594 run the
2595 .Nm rpc.ypupdated
2596 daemon at system boot time.
2597 .It Va bsnmpd_enable
2598 .Pq Vt bool
2599 If set to
2600 .Dq Li YES ,
2601 run the
2602 .Xr bsnmpd 1
2603 daemon at system boot time.
2604 Be sure to understand the security implications of running SNMP daemon
2605 on your host.
2606 .It Va bsnmpd_flags
2607 .Pq Vt str
2608 If
2609 .Va bsnmpd_enable
2610 is set to
2611 .Dq Li YES ,
2612 these are the flags to pass to the
2613 .Xr bsnmpd 1
2614 daemon.
2615 .It Va defaultrouter
2616 .Pq Vt str
2617 If not set to
2618 .Dq Li NO ,
2619 create a default route to this host name or IP address
2620 (use an IP address if this router is also required to get to the
2621 name server!).
2622 .It Va ipv6_defaultrouter
2623 .Pq Vt str
2624 The IPv6 equivalent of
2625 .Va defaultrouter .
2626 .It Va static_arp_pairs
2627 .Pq Vt str
2628 Set to the list of static ARP pairs that are to be added at system
2629 boot time.
2630 For each whitespace separated
2631 .Ar element
2632 in the value, a
2633 .Va static_arp_ Ns Aq Ar element
2634 variable is assumed to exist whose contents will later be passed to a
2635 .Dq Nm arp Cm -S
2636 operation.
2637 For example
2638 .Bd -literal
2639 static_arp_pairs="gw"
2640 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2641 .Ed
2642 .It Va static_ndp_pairs
2643 .Pq Vt str
2644 Set to the list of static NDP pairs that are to be added at system
2645 boot time.
2646 For each whitespace separated
2647 .Ar element
2648 in the value, a
2649 .Va static_ndp_ Ns Aq Ar element
2650 variable is assumed to exist whose contents will later be passed to a
2651 .Dq Nm ndp Cm -s
2652 operation.
2653 For example
2654 .Bd -literal
2655 static_ndp_pairs="gw"
2656 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2657 .Ed
2658 .It Va static_routes
2659 .Pq Vt str
2660 Set to the list of static routes that are to be added at system
2661 boot time.
2662 If not set to
2663 .Dq Li NO
2664 then for each whitespace separated
2665 .Ar element
2666 in the value, a
2667 .Va route_ Ns Aq Ar element
2668 variable is assumed to exist
2669 whose contents will later be passed to a
2670 .Dq Nm route Cm add
2671 operation.
2672 For example:
2673 .Bd -literal
2674 static_routes="ext mcast:gif0 gif0local:gif0"
2675 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2676 route_mcast="-net 224.0.0.0/4 -iface gif0"
2677 route_gif0local="-host 169.254.1.1 -iface lo0"
2678 .Ed
2679 .Pp
2680 When an
2681 .Ar element
2682 is in the form of
2683 .Li name:ifname ,
2684 the route is specific to the interface
2685 .Li ifname .
2686 .It Va ipv6_static_routes
2687 .Pq Vt str
2688 The IPv6 equivalent of
2689 .Va static_routes .
2690 If not set to
2691 .Dq Li NO
2692 then for each whitespace separated
2693 .Ar element
2694 in the value, a
2695 .Va ipv6_route_ Ns Aq Ar element
2696 variable is assumed to exist
2697 whose contents will later be passed to a
2698 .Dq Nm route Cm add Fl inet6
2699 operation.
2700 .It Va natm_static_routes
2701 .Pq Vt str
2702 The
2703 .Xr natmip 4
2704 equivalent of
2705 .Va static_routes .
2706 If not empty then for each whitespace separated
2707 .Ar element
2708 in the value, a
2709 .Va route_ Ns Aq Ar element
2710 variable is assumed to exist whose contents will later be passed to a
2711 .Dq Nm atmconfig Cm natm Cm add
2712 operation.
2713 .It Va gateway_enable
2714 .Pq Vt bool
2715 If set to
2716 .Dq Li YES ,
2717 configure host to act as an IP router, e.g.\& to forward packets
2718 between interfaces.
2719 .It Va ipv6_gateway_enable
2720 .Pq Vt bool
2721 The IPv6 equivalent of
2722 .Va gateway_enable .
2723 .It Va routed_enable
2724 .Pq Vt bool
2725 If set to
2726 .Dq Li YES ,
2727 run a routing daemon of some sort, based on the
2728 settings of
2729 .Va routed_program
2730 and
2731 .Va routed_flags .
2732 .It Va route6d_enable
2733 .Pq Vt bool
2734 The IPv6 equivalent of
2735 .Va routed_enable .
2736 If set to
2737 .Dq Li YES ,
2738 run a routing daemon of some sort, based on the
2739 settings of
2740 .Va route6d_program
2741 and
2742 .Va route6d_flags .
2743 .It Va routed_program
2744 .Pq Vt str
2745 If
2746 .Va routed_enable
2747 is set to
2748 .Dq Li YES ,
2749 this is the name of the routing daemon to use.
2750 .It Va route6d_program
2751 .Pq Vt str
2752 The IPv6 equivalent of
2753 .Va routed_program .
2754 .It Va routed_flags
2755 .Pq Vt str
2756 If
2757 .Va routed_enable
2758 is set to
2759 .Dq Li YES ,
2760 these are the flags to pass to the routing daemon.
2761 .It Va route6d_flags
2762 .Pq Vt str
2763 The IPv6 equivalent of
2764 .Va routed_flags .
2765 .It Va mrouted_enable
2766 .Pq Vt bool
2767 If set to
2768 .Dq Li YES ,
2769 run the multicast routing daemon,
2770 .Xr mrouted 8 .
2771 .It Va mroute6d_enable
2772 .Pq Vt bool
2773 The IPv6 equivalent of
2774 .Va mrouted_enable .
2775 If set to
2776 .Dq Li YES ,
2777 run the IPv6 multicast routing daemon.
2778 .Pp
2779 Note that multicast routing daemons are no longer included in the
2780 .Fx
2781 base system, however, both
2782 .Xr mrouted 8
2783 and
2784 .Xr pim6dd 8
2785 may be installed from the
2786 .Fx
2787 Ports Collection.
2788 .It Va mrouted_flags
2789 .Pq Vt str
2790 If
2791 .Va mrouted_enable
2792 is set to
2793 .Dq Li YES ,
2794 these are the flags to pass to the
2795 .Xr mrouted 8
2796 daemon.
2797 .It Va mroute6d_flags
2798 .Pq Vt str
2799 The IPv6 equivalent of
2800 .Va mrouted_flags .
2801 If
2802 .Va mroute6d_enable
2803 is set to
2804 .Dq Li YES ,
2805 these are the flags passed to the IPv6 multicast routing daemon.
2806 .It Va mroute6d_program
2807 .Pq Vt str
2808 If
2809 .Va mroute6d_enable
2810 is set to
2811 .Dq Li YES ,
2812 this is the path to the IPv6 multicast routing daemon.
2813 .It Va rtadvd_enable
2814 .Pq Vt bool
2815 If set to
2816 .Dq Li YES ,
2817 run the
2818 .Xr rtadvd 8
2819 daemon at boot time.
2820 The
2821 .Xr rtadvd 8
2822 utility sends ICMPv6 Router Advertisement messages to
2823 the interfaces specified in
2824 .Va rtadvd_interfaces .
2825 This should only be enabled with great care.
2826 You may want to fine-tune
2827 .Xr rtadvd.conf 5 .
2828 .It Va rtadvd_interfaces
2829 .Pq Vt str
2830 If
2831 .Va rtadvd_enable
2832 is set to
2833 .Dq Li YES
2834 this is the list of interfaces to use.
2835 .It Va ipxgateway_enable
2836 .Pq Vt bool
2837 If set to
2838 .Dq Li YES ,
2839 enable the routing of IPX traffic.
2840 .It Va ipxrouted_enable
2841 .Pq Vt bool
2842 If set to
2843 .Dq Li YES ,
2844 run the
2845 .Xr IPXrouted 8
2846 daemon at system boot time.
2847 .It Va ipxrouted_flags
2848 .Pq Vt str
2849 If
2850 .Va ipxrouted_enable
2851 is set to
2852 .Dq Li YES ,
2853 these are the flags to pass to the
2854 .Xr IPXrouted 8
2855 daemon.
2856 .It Va arpproxy_all
2857 .Pq Vt bool
2858 If set to
2859 .Dq Li YES ,
2860 enable global proxy ARP.
2861 .It Va forward_sourceroute
2862 .Pq Vt bool
2863 If set to
2864 .Dq Li YES
2865 and
2866 .Va gateway_enable
2867 is also set to
2868 .Dq Li YES ,
2869 source-routed packets are forwarded.
2870 .It Va accept_sourceroute
2871 .Pq Vt bool
2872 If set to
2873 .Dq Li YES ,
2874 the system will accept source-routed packets directed at it.
2875 .It Va rarpd_enable
2876 .Pq Vt bool
2877 If set to
2878 .Dq Li YES ,
2879 run the
2880 .Xr rarpd 8
2881 daemon at system boot time.
2882 .It Va rarpd_flags
2883 .Pq Vt str
2884 If
2885 .Va rarpd_enable
2886 is set to
2887 .Dq Li YES ,
2888 these are the flags to pass to the
2889 .Xr rarpd 8
2890 daemon.
2891 .It Va bootparamd_enable
2892 .Pq Vt bool
2893 If set to
2894 .Dq Li YES ,
2895 run the
2896 .Xr bootparamd 8
2897 daemon at system boot time.
2898 .It Va bootparamd_flags
2899 .Pq Vt str
2900 If
2901 .Va bootparamd_enable
2902 is set to
2903 .Dq Li YES ,
2904 these are the flags to pass to the
2905 .Xr bootparamd 8
2906 daemon.
2907 .It Va stf_interface_ipv4addr
2908 .Pq Vt str
2909 If not set to
2910 .Dq Li NO ,
2911 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2912 interface).
2913 Specify this entry to enable the 6to4 interface.
2914 .It Va stf_interface_ipv4plen
2915 .Pq Vt int
2916 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2917 An effective value is 0-31.
2918 .It Va stf_interface_ipv6_ifid
2919 .Pq Vt str
2920 IPv6 interface ID for
2921 .Xr stf 4 .
2922 This can be set to
2923 .Dq Li AUTO .
2924 .It Va stf_interface_ipv6_slaid
2925 .Pq Vt str
2926 IPv6 Site Level Aggregator for
2927 .Xr stf 4 .
2928 .It Va ipv6_faith_prefix
2929 .Pq Vt str
2930 If not set to
2931 .Dq Li NO ,
2932 this is the faith prefix to enable a FAITH IPv6-to-IPv4 TCP
2933 translator.
2934 You also need
2935 .Xr faithd 8
2936 setup.
2937 .It Va ipv6_ipv4mapping
2938 .Pq Vt bool
2939 If set to
2940 .Dq Li YES
2941 this enables IPv4 mapped IPv6 address communication (like
2942 .Li ::ffff:a.b.c.d ) .
2943 .It Va rtsold_enable
2944 .Pq Vt bool
2945 Set to
2946 .Dq Li YES
2947 to enable the
2948 .Xr rtsold 8
2949 daemon to send ICMPv6 Router Solicitation messages.
2950 .It Va rtsold_flags
2951 .Pq Vt str
2952 If
2953 .Va rtsold_enable
2954 is set to
2955 .Dq Li YES ,
2956 these are the flags to pass to
2957 .Xr rtsold 8 .
2958 .It Va rtsol_flags
2959 .Pq Vt str
2960 For interfaces configured with the
2961 .Dq Li inet6 accept_rtadv
2962 keyword, these are the flags to pass to
2963 .Xr rtsol 8 .
2964 .Pp
2965 Note that
2966 .Va rtsold_enable
2967 is mutually exclusive to
2968 .Va rtsol_flags ;
2969 .Va rtsold_enable
2970 takes precedence.
2971 .It Va atm_enable
2972 .Pq Vt bool
2973 Set to
2974 .Dq Li YES
2975 to enable the configuration of ATM interfaces at system boot time.
2976 For all of the ATM variables described below, please refer to the
2977 .Xr atm 8
2978 manual page for further details on the available command parameters.
2979 Also refer to the files in
2980 .Pa /usr/share/examples/atm
2981 for more detailed configuration information.
2982 .It Va atm_load
2983 .Pq Vt str
2984 This is a list of physical ATM interface drivers to load.
2985 Typical values are
2986 .Dq Li hfa_pci
2987 and/or
2988 .Dq Li hea_pci .
2989 .It Va atm_netif_ Ns Aq Ar intf
2990 .Pq Vt str
2991 For the ATM physical interface
2992 .Ar intf ,
2993 this variable defines the name prefix and count for the ATM network
2994 interfaces to be created.
2995 The value will be passed as the parameters of an
2996 .Dq Nm atm Cm "set netif" Ar intf
2997 command.
2998 .It Va atm_sigmgr_ Ns Aq Ar intf
2999 .Pq Vt str
3000 For the ATM physical interface
3001 .Ar intf ,
3002 this variable defines the ATM signalling manager to be used.
3003 The value will be passed as the parameters of an
3004 .Dq Nm atm Cm attach Ar intf
3005 command.
3006 .It Va atm_prefix_ Ns Aq Ar intf
3007 .Pq Vt str
3008 For the ATM physical interface
3009 .Ar intf ,
3010 this variable defines the NSAP prefix for interfaces using a UNI signalling
3011 manager.
3012 If set to
3013 .Dq Li ILMI ,
3014 the prefix will automatically be set via the
3015 .Xr ilmid 8
3016 daemon.
3017 Otherwise, the value will be passed as the parameters of an
3018 .Dq Nm atm Cm "set prefix" Ar intf
3019 command.
3020 .It Va atm_macaddr_ Ns Aq Ar intf
3021 .Pq Vt str
3022 For the ATM physical interface
3023 .Ar intf ,
3024 this variable defines the MAC address for interfaces using a UNI signalling
3025 manager.
3026 If set to
3027 .Dq Li NO ,
3028 the hardware MAC address contained in the ATM interface card will be used.
3029 Otherwise, the value will be passed as the parameters of an
3030 .Dq Nm atm Cm "set mac" Ar intf
3031 command.
3032 .It Va atm_arpserver_ Ns Aq Ar netif
3033 .Pq Vt str
3034 For the ATM network interface
3035 .Ar netif ,
3036 this variable defines the ATM address for a host which is to provide ATMARP
3037 service.
3038 This variable is only applicable to interfaces using a UNI signalling
3039 manager.
3040 If set to
3041 .Dq Li local ,
3042 this host will become an ATMARP server.
3043 The value will be passed as the parameters of an
3044 .Dq Nm atm Cm "set arpserver" Ar netif
3045 command.
3046 .It Va atm_scsparp_ Ns Aq Ar netif
3047 .Pq Vt bool
3048 If set to
3049 .Dq Li YES ,
3050 SCSP/ATMARP service for the network interface
3051 .Ar netif
3052 will be initiated using the
3053 .Xr scspd 8
3054 and
3055 .Xr atmarpd 8
3056 daemons.
3057 This variable is only applicable if
3058 .Va atm_arpserver_ Ns Aq Ar netif
3059 is set to
3060 .Dq Li local .
3061 .It Va atm_pvcs
3062 .Pq Vt str
3063 Set to the list of ATM PVCs to be added at system
3064 boot time.
3065 For each whitespace separated
3066 .Ar element
3067 in the value, an
3068 .Va atm_pvc_ Ns Aq Ar element
3069 variable is assumed to exist.
3070 The value of each of these variables
3071 will be passed as the parameters of an
3072 .Dq Nm atm Cm "add pvc"
3073 command.
3074 .It Va atm_arps
3075 .Pq Vt str
3076 Set to the list of permanent ATM ARP entries to be added
3077 at system boot time.
3078 For each whitespace separated
3079 .Ar element
3080 in the value, an
3081 .Va atm_arp_ Ns Aq Ar element
3082 variable is assumed to exist.
3083 The value of each of these variables
3084 will be passed as the parameters of an
3085 .Dq Nm atm Cm "add arp"
3086 command.
3087 .It Va natm_interfaces
3088 .Pq Vt str
3089 Set to the list of
3090 .Xr natm 4
3091 interfaces that will also be used for HARP through
3092 .Xr harp 4 .
3093 If this list is not empty all interfaces in the list will be brought up
3094 with
3095 .Xr ifconfig 8
3096 and
3097 .Xr harp 4
3098 will be loaded.
3099 For this to work the interface drivers must be either compiled into the
3100 kernel or must reside on the root partition.
3101 .It Va keybell
3102 .Pq Vt str
3103 The keyboard bell sound.
3104 Set to
3105 .Dq Li normal ,
3106 .Dq Li visual ,
3107 .Dq Li off ,
3108 or
3109 .Dq Li NO
3110 if the default behavior is desired.
3111 For details, refer to the
3112 .Xr kbdcontrol 1
3113 manpage.
3114 .It Va keyboard
3115 .Pq Vt str
3116 If set to a non-null string, the virtual console's keyboard input is
3117 set to this device.
3118 .It Va keymap
3119 .Pq Vt str
3120 If set to
3121 .Dq Li NO ,
3122 no keymap is installed, otherwise the value is used to install
3123 the keymap file found in
3124 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3125 (if using
3126 .Xr syscons 4 ) or
3127 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3128 (if using
3129 .Xr vt 4 ) .
3130 .It Va keyrate
3131 .Pq Vt str
3132 The keyboard repeat speed.
3133 Set to
3134 .Dq Li slow ,
3135 .Dq Li normal ,
3136 .Dq Li fast ,
3137 or
3138 .Dq Li NO
3139 if the default behavior is desired.
3140 .It Va keychange
3141 .Pq Vt str
3142 If not set to
3143 .Dq Li NO ,
3144 attempt to program the function keys with the value.
3145 The value should
3146 be a single string of the form:
3147 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3148 .It Va cursor
3149 .Pq Vt str
3150 Can be set to the value of
3151 .Dq Li normal ,
3152 .Dq Li blink ,
3153 .Dq Li destructive ,
3154 or
3155 .Dq Li NO
3156 to set the cursor behavior explicitly or choose the default behavior.
3157 .It Va scrnmap
3158 .Pq Vt str
3159 If set to
3160 .Dq Li NO ,
3161 no screen map is installed, otherwise the value is used to install
3162 the screen map file in
3163 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3164 This parameter is ignored when using
3165 .Xr vt 4
3166 as the console driver.
3167 .It Va font8x16
3168 .Pq Vt str
3169 If set to
3170 .Dq Li NO ,
3171 the default 8x16 font value is used for screen size requests, otherwise
3172 the value in
3173 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3174 or
3175 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3176 is used (depending on the console driver being used).
3177 .It Va font8x14
3178 .Pq Vt str
3179 If set to
3180 .Dq Li NO ,
3181 the default 8x14 font value is used for screen size requests, otherwise
3182 the value in
3183 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3184 or
3185 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3186 is used (depending on the console driver being used).
3187 .It Va font8x8
3188 .Pq Vt str
3189 If set to
3190 .Dq Li NO ,
3191 the default 8x8 font value is used for screen size requests, otherwise
3192 the value in
3193 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3194 or
3195 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3196 is used (depending on the console driver being used).
3197 .It Va blanktime
3198 .Pq Vt int
3199 If set to
3200 .Dq Li NO ,
3201 the default screen blanking interval is used, otherwise it is set
3202 to
3203 .Ar value
3204 seconds.
3205 .It Va saver
3206 .Pq Vt str
3207 If not set to
3208 .Dq Li NO ,
3209 this is the actual screen saver to use
3210 .Li ( blank , snake , daemon ,
3211 etc).
3212 .It Va moused_nondefault_enable
3213 .Pq Vt str
3214 If set to
3215 .Dq Li NO ,
3216 the mouse device specified on
3217 the command line is not automatically treated as enabled by the
3218 .Pa /etc/rc.d/moused
3219 script.
3220 Having this variable set to
3221 .Dq Li YES
3222 allows a
3223 .Xr usb 4
3224 mouse,
3225 for example,
3226 to be enabled as soon as it is plugged in.
3227 .It Va moused_enable
3228 .Pq Vt str
3229 If set to
3230 .Dq Li YES ,
3231 the
3232 .Xr moused 8
3233 daemon is started for doing cut/paste selection on the console.
3234 .It Va moused_type
3235 .Pq Vt str
3236 This is the protocol type of the mouse connected to this host.
3237 This variable must be set if
3238 .Va moused_enable
3239 is set to
3240 .Dq Li YES .
3241 The
3242 .Xr moused 8
3243 daemon
3244 is able to detect the appropriate mouse type automatically in many cases.
3245 Set this variable to
3246 .Dq Li auto
3247 to let the daemon detect it, or
3248 select one from the following list if the automatic detection fails.
3249 .Pp
3250 If the mouse is attached to the PS/2 mouse port, choose
3251 .Dq Li auto
3252 or
3253 .Dq Li ps/2 ,
3254 regardless of the brand and model of the mouse.
3255 Likewise, if the
3256 mouse is attached to the bus mouse port, choose
3257 .Dq Li auto
3258 or
3259 .Dq Li busmouse .
3260 All other protocols are for serial mice and will not work with
3261 the PS/2 and bus mice.
3262 If this is a USB mouse,
3263 .Dq Li auto
3264 is the only protocol type which will work.
3265 .Pp
3266 .Bl -tag -width ".Li x10mouseremote" -compact
3267 .It Li microsoft
3268 Microsoft mouse (serial)
3269 .It Li intellimouse
3270 Microsoft IntelliMouse (serial)
3271 .It Li mousesystems
3272 Mouse systems Corp.\& mouse (serial)
3273 .It Li mmseries
3274 MM Series mouse (serial)
3275 .It Li logitech
3276 Logitech mouse (serial)
3277 .It Li busmouse
3278 A bus mouse
3279 .It Li mouseman
3280 Logitech MouseMan and TrackMan (serial)
3281 .It Li glidepoint
3282 ALPS GlidePoint (serial)
3283 .It Li thinkingmouse
3284 Kensington ThinkingMouse (serial)
3285 .It Li ps/2
3286 PS/2 mouse
3287 .It Li mmhittab
3288 MM HitTablet (serial)
3289 .It Li x10mouseremote
3290 X10 MouseRemote (serial)
3291 .It Li versapad
3292 Interlink VersaPad (serial)
3293 .El
3294 .Pp
3295 Even if the mouse is not in the above list, it may be compatible
3296 with one in the list.
3297 Refer to the manual page for
3298 .Xr moused 8
3299 for compatibility information.
3300 .Pp
3301 It should also be noted that while this is enabled, any
3302 other client of the mouse (such as an X server) should access
3303 the mouse through the virtual mouse device,
3304 .Pa /dev/sysmouse ,
3305 and configure it as a
3306 .Dq Li sysmouse
3307 type mouse, since all
3308 mouse data is converted to this single canonical format when
3309 using
3310 .Xr moused 8 .
3311 If the client program does not support the
3312 .Dq Li sysmouse
3313 type,
3314 specify the
3315 .Dq Li mousesystems
3316 type.
3317 It is the second preferred type.
3318 .It Va moused_port
3319 .Pq Vt str
3320 If
3321 .Va moused_enable
3322 is set to
3323 .Dq Li YES ,
3324 this is the actual port the mouse is on.
3325 It might be
3326 .Pa /dev/cuau0
3327 for a COM1 serial mouse,
3328 .Pa /dev/psm0
3329 for a PS/2 mouse or
3330 .Pa /dev/mse0
3331 for a bus mouse, for example.
3332 .It Va moused_flags
3333 .Pq Vt str
3334 If
3335 .Va moused_flags
3336 is set, its value is used as an additional set of flags to pass to the
3337 .Xr moused 8
3338 daemon.
3339 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3340 When
3341 .Va moused_nondefault_enable
3342 is enabled, and a
3343 .Xr moused 8
3344 daemon is started for a non-default port, the
3345 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3346 set of options has precedence over and replaces the default
3347 .Va moused_flags
3348 (where
3349 .Ar XXX
3350 is the name of the non-default port, i.e.,\&
3351 .Ar ums0 ) .
3352 By setting
3353 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3354 it is possible to set up a different set of default flags for each
3355 .Xr moused 8
3356 instance.
3357 For example, you can use
3358 .Dq Li "-3"
3359 for the default
3360 .Va moused_flags
3361 to make your laptop's touchpad more comfortable to use,
3362 but an empty set of options for
3363 .Va moused_ums0_flags
3364 when your
3365 .Xr usb 4
3366 mouse has three or more buttons.
3367 .It Va mousechar_start
3368 .Pq Vt int
3369 If set to
3370 .Dq Li NO ,
3371 the default mouse cursor character range
3372 .Li 0xd0 Ns - Ns Li 0xd3
3373 is used,
3374 otherwise the range start is set
3375 to
3376 .Ar value
3377 character, see
3378 .Xr vidcontrol 1 .
3379 Use if the default range is occupied in the language code table.
3380 .It Va allscreens_flags
3381 .Pq Vt str
3382 If set,
3383 .Xr vidcontrol 1
3384 is run with these options for each of the virtual terminals
3385 .Pq Pa /dev/ttyv* .
3386 For example,
3387 .Dq Fl m Cm on
3388 will enable the mouse pointer on all virtual terminals
3389 if
3390 .Va moused_enable
3391 is set to
3392 .Dq Li YES .
3393 .It Va allscreens_kbdflags
3394 .Pq Vt str
3395 If set,
3396 .Xr kbdcontrol 1
3397 is run with these options for each of the virtual terminals
3398 .Pq Pa /dev/ttyv* .
3399 For example,
3400 .Dq Fl h Li 200
3401 will set the
3402 .Xr syscons 4
3403 or
3404 .Xr vt 4
3405 scrollback (history) buffer to 200 lines.
3406 .It Va cron_enable
3407 .Pq Vt bool
3408 If set to
3409 .Dq Li YES ,
3410 run the
3411 .Xr cron 8
3412 daemon at system boot time.
3413 .It Va cron_program
3414 .Pq Vt str
3415 Path to
3416 .Xr cron 8
3417 (default
3418 .Pa /usr/sbin/cron ) .
3419 .It Va cron_flags
3420 .Pq Vt str
3421 If
3422 .Va cron_enable
3423 is set to
3424 .Dq Li YES ,
3425 these are the flags to pass to
3426 .Xr cron 8 .
3427 .It Va cron_dst
3428 .Pq Vt bool
3429 If set to
3430 .Dq Li YES ,
3431 enable the special handling of transitions to and from the
3432 Daylight Saving Time in
3433 .Xr cron 8
3434 (equivalent to using the flag
3435 .Fl s ) .
3436 .It Va lpd_program
3437 .Pq Vt str
3438 Path to
3439 .Xr lpd 8
3440 (default
3441 .Pa /usr/sbin/lpd ) .
3442 .It Va lpd_enable
3443 .Pq Vt bool
3444 If set to
3445 .Dq Li YES ,
3446 run the
3447 .Xr lpd 8
3448 daemon at system boot time.
3449 .It Va lpd_flags
3450 .Pq Vt str
3451 If
3452 .Va lpd_enable
3453 is set to
3454 .Dq Li YES ,
3455 these are the flags to pass to the
3456 .Xr lpd 8
3457 daemon.
3458 .It Va chkprintcap_enable
3459 .Pq Vt bool
3460 If set to
3461 .Dq Li YES ,
3462 run the
3463 .Xr chkprintcap 8
3464 command before starting the
3465 .Xr lpd 8
3466 daemon.
3467 .It Va chkprintcap_flags
3468 .Pq Vt str
3469 If
3470 .Va lpd_enable
3471 and
3472 .Va chkprintcap_enable
3473 are set to
3474 .Dq Li YES ,
3475 these are the flags to pass to the
3476 .Xr chkprintcap 8
3477 program.
3478 The default is
3479 .Dq Li -d ,
3480 which causes missing directories to be created.
3481 .It Va mta_start_script
3482 .Pq Vt str
3483 This variable specifies the full path to the script to run to start
3484 a mail transfer agent.
3485 The default is
3486 .Pa /etc/rc.sendmail .
3487 The
3488 .Va sendmail_*
3489 variables which
3490 .Pa /etc/rc.sendmail
3491 uses are documented in the
3492 .Xr rc.sendmail 8
3493 manual page.
3494 .It Va dumpdev
3495 .Pq Vt str
3496 Indicates the device (usually a swap partition) to which a crash dump
3497 should be written in the event of a system crash.
3498 If the value of this variable is
3499 .Dq Li AUTO ,
3500 the first suitable swap device listed in
3501 .Pa /etc/fstab
3502 will be used as dump device.
3503 Otherwise, the value of this variable is passed as the argument to
3504 .Xr dumpon 8 .
3505 To disable crash dumps, set this variable to
3506 .Dq Li NO .
3507 .It Va dumpdir
3508 .Pq Vt str
3509 When the system reboots after a crash and a crash dump is found on the
3510 device specified by the
3511 .Va dumpdev
3512 variable,
3513 .Xr savecore 8
3514 will save that crash dump and a copy of the kernel to the directory
3515 specified by the
3516 .Va dumpdir
3517 variable.
3518 The default value is
3519 .Pa /var/crash .
3520 Set to
3521 .Dq Li NO
3522 to not run
3523 .Xr savecore 8
3524 at boot time when
3525 .Va dumpdir
3526 is set.
3527 .It Va savecore_flags
3528 .Pq Vt str
3529 If crash dumps are enabled, these are the flags to pass to the
3530 .Xr savecore 8
3531 utility.
3532 .It Va quota_enable
3533 .Pq Vt bool
3534 Set to
3535 .Dq Li YES
3536 to turn on user and group disk quotas on system startup via the
3537 .Xr quotaon 8
3538 command for all file systems marked as having quotas enabled in
3539 .Pa /etc/fstab .
3540 The kernel must be built with
3541 .Cd "options QUOTA"
3542 for disk quotas to function.
3543 .It Va check_quotas
3544 .Pq Vt bool
3545 Set to
3546 .Dq Li YES
3547 to enable user and group disk quota checking via the
3548 .Xr quotacheck 8
3549 command.
3550 .It Va quotacheck_flags
3551 .Pq Vt str
3552 If
3553 .Va quota_enable
3554 is set to
3555 .Dq Li YES ,
3556 and
3557 .Va check_quotas
3558 is set to
3559 .Dq Li YES ,
3560 these are the flags to pass to the
3561 .Xr quotacheck 8
3562 utility.
3563 The default is
3564 .Dq Li "-a" ,
3565 which checks quotas for all file systems with quotas enabled in
3566 .Pa /etc/fstab .
3567 .It Va quotaon_flags
3568 .Pq Vt str
3569 If
3570 .Va quota_enable
3571 is set to
3572 .Dq Li YES ,
3573 these are the flags to pass to the
3574 .Xr quotaon 8
3575 utility.
3576 The default is
3577 .Dq Li "-a" ,
3578 which enables quotas for all file systems with quotas enabled in
3579 .Pa /etc/fstab .
3580 .It Va quotaoff_flags
3581 .Pq Vt str
3582 If
3583 .Va quota_enable
3584 is set to
3585 .Dq Li YES ,
3586 these are the flags to pass to the
3587 .Xr quotaoff 8
3588 utility when shutting down the quota system.
3589 The default is
3590 .Dq Li "-a" ,
3591 which disables quotas for all file systems with quotas enabled in
3592 .Pa /etc/fstab .
3593 .It Va accounting_enable
3594 .Pq Vt bool
3595 Set to
3596 .Dq Li YES
3597 to enable system accounting through the
3598 .Xr accton 8
3599 facility.
3600 .It Va ibcs2_enable
3601 .Pq Vt bool
3602 Set to
3603 .Dq Li YES
3604 to enable iBCS2 (SCO) binary emulation at system initial boot
3605 time.
3606 .It Va ibcs2_loaders
3607 .Pq Vt str
3608 If not set to
3609 .Dq Li NO
3610 and if
3611 .Va ibcs2_enable
3612 is set to
3613 .Dq Li YES ,
3614 this specifies a list of additional iBCS2 loaders to enable.
3615 .It Va firstboot_sentinel
3616 .Pq Vt str
3617 This variable specifies the full path to a
3618 .Dq first boot
3619 sentinel file.
3620 If a file exists with this path,
3621 .Pa rc.d
3622 scripts with the
3623 .Dq firstboot
3624 keyword will be run on startup and the sentinel file will be deleted
3625 after the boot process completes.
3626 The sentinel file must be located on a writable file system which is
3627 mounted no later than
3628 .Va early_late_divider
3629 to function properly.
3630 The default is
3631 .Pa /firstboot .
3632 .It Va linux_enable
3633 .Pq Vt bool
3634 Set to
3635 .Dq Li YES
3636 to enable Linux/ELF binary emulation at system initial
3637 boot time.
3638 .It Va svr4_enable
3639 .Pq Vt bool
3640 If set to
3641 .Dq Li YES ,
3642 enable SysVR4 emulation at boot time.
3643 .It Va sysvipc_enable
3644 .Pq Vt bool
3645 If set to
3646 .Dq Li YES ,
3647 load System V IPC primitives at boot time.
3648 .It Va clear_tmp_enable
3649 .Pq Vt bool
3650 Set to
3651 .Dq Li YES
3652 to have
3653 .Pa /tmp
3654 cleaned at startup.
3655 .It Va clear_tmp_X
3656 .Pq Vt bool
3657 Set to
3658 .Dq Li NO
3659 to disable removing of X11 lock files,
3660 and the removal and (secure) recreation
3661 of the various socket directories for X11
3662 related programs.
3663 .It Va ldconfig_paths
3664 .Pq Vt str
3665 Set to the list of shared library paths to use with
3666 .Xr ldconfig 8 .
3667 NOTE:
3668 .Pa /usr/lib
3669 will always be added first, so it need not appear in this list.
3670 .It Va ldconfig32_paths
3671 .Pq Vt str
3672 Set to the list of 32-bit compatibility shared library paths to
3673 use with
3674 .Xr ldconfig 8 .
3675 .It Va ldconfig_paths_aout
3676 .Pq Vt str
3677 Set to the list of shared library paths to use with
3678 .Xr ldconfig 8
3679 legacy
3680 .Xr a.out 5
3681 support.
3682 .It Va ldconfig_insecure
3683 .Pq Vt bool
3684 The
3685 .Xr ldconfig 8
3686 utility normally refuses to use directories
3687 which are writable by anyone except root.
3688 Set this variable to
3689 .Dq Li YES
3690 to disable that security check during system startup.
3691 .It Va ldconfig_local_dirs
3692 .Pq Vt str
3693 Set to the list of local
3694 .Xr ldconfig 8
3695 directories.
3696 The names of all files in the directories listed will be
3697 passed as arguments to
3698 .Xr ldconfig 8 .
3699 .It Va ldconfig_local32_dirs
3700 .Pq Vt str
3701 Set to the list of local 32-bit compatibility
3702 .Xr ldconfig 8
3703 directories.
3704 The names of all files in the directories listed will be
3705 passed as arguments to
3706 .Dq Nm ldconfig Fl 32 .
3707 .It Va kern_securelevel_enable
3708 .Pq Vt bool
3709 Set to
3710 .Dq Li YES
3711 to set the kernel security level at system startup.
3712 .It Va kern_securelevel
3713 .Pq Vt int
3714 The kernel security level to set at startup.
3715 The allowed range of
3716 .Ar value
3717 ranges from \-1 (the compile time default) to 3 (the
3718 most secure).
3719 See
3720 .Xr security 7
3721 for the list of possible security levels and their effect
3722 on system operation.
3723 .It Va sshd_program
3724 .Pq Vt str
3725 Path to the SSH server program
3726 .Pa ( /usr/sbin/sshd
3727 is the default).
3728 .It Va sshd_enable
3729 .Pq Vt bool
3730 Set to
3731 .Dq Li YES
3732 to start
3733 .Xr sshd 8
3734 at system boot time.
3735 .It Va sshd_flags
3736 .Pq Vt str
3737 If
3738 .Va sshd_enable
3739 is set to
3740 .Dq Li YES ,
3741 these are the flags to pass to the
3742 .Xr sshd 8
3743 daemon.
3744 .It Va ftpd_program
3745 .Pq Vt str
3746 Path to the FTP server program
3747 .Pa ( /usr/libexec/ftpd
3748 is the default).
3749 .It Va ftpd_enable
3750 .Pq Vt bool
3751 Set to
3752 .Dq Li YES
3753 to start
3754 .Xr ftpd 8
3755 as a stand-alone daemon at system boot time.
3756 .It Va ftpd_flags
3757 .Pq Vt str
3758 If
3759 .Va ftpd_enable
3760 is set to
3761 .Dq Li YES ,
3762 these are the additional flags to pass to the
3763 .Xr ftpd 8
3764 daemon.
3765 .It Va watchdogd_enable
3766 .Pq Vt bool
3767 If set to
3768 .Dq Li YES ,
3769 start the
3770 .Xr watchdogd 8
3771 daemon at boot time.
3772 This requires that the kernel have been compiled with a
3773 .Xr watchdog 4
3774 compatible device.
3775 .It Va watchdogd_flags
3776 .Pq Vt str
3777 If
3778 .Va watchdogd_enable
3779 is set to
3780 .Dq Li YES ,
3781 these are the flags passed to the
3782 .Xr watchdogd 8
3783 daemon.
3784 .It Va devfs_rulesets
3785 .Pq Vt str
3786 List of files containing sets of rules for
3787 .Xr devfs 8 .
3788 .It Va devfs_system_ruleset
3789 .Pq Vt str
3790 Rule name(s) to apply to the system
3791 .Pa /dev
3792 itself.
3793 .It Va devfs_set_rulesets
3794 .Pq Vt str
3795 Pairs of already-mounted
3796 .Pa dev
3797 directories and rulesets that should be applied to them.
3798 For example: /mount/dev=ruleset_name
3799 .It Va devfs_load_rulesets
3800 .Pq Vt bool
3801 If set, always load the default rulesets listed in
3802 .Va devfs_rulesets .
3803 .It Va performance_cx_lowest
3804 .Pq Vt str
3805 CPU idle state to use while on AC power.
3806 The string
3807 .Dq Li LOW
3808 indicates that
3809 .Xr acpi 4
3810 should use the lowest power state available while
3811 .Dq Li HIGH
3812 indicates that the lowest latency state (less power savings) should be used.
3813 .It Va performance_cpu_freq
3814 .Pq Vt str
3815 CPU clock frequency to use while on AC power.
3816 The string
3817 .Dq Li LOW
3818 indicates that
3819 .Xr cpufreq 4
3820 should use the lowest frequency available while
3821 .Dq Li HIGH
3822 indicates that the highest frequency (less power savings) should be used.
3823 .It Va economy_cx_lowest
3824 .Pq Vt str
3825 CPU idle state to use when off AC power.
3826 The string
3827 .Dq Li LOW
3828 indicates that
3829 .Xr acpi 4
3830 should use the lowest power state available while
3831 .Dq Li HIGH
3832 indicates that the lowest latency state (less power savings) should be used.
3833 .It Va economy_cpu_freq
3834 .Pq Vt str
3835 CPU clock frequency to use when off AC power.
3836 The string
3837 .Dq Li LOW
3838 indicates that
3839 .Xr cpufreq 4
3840 should use the lowest frequency available while
3841 .Dq Li HIGH
3842 indicates that the highest frequency (less power savings) should be used.
3843 .It Va jail_enable
3844 .Pq Vt bool
3845 If set to
3846 .Dq Li NO ,
3847 any configured jails will not be started.
3848 .It Va jail_conf
3849 .Pq Vt str
3850 The configuration filename used by
3851 .Xr jail 8
3852 utility.
3853 The default value is
3854 .Pa /etc/jail.conf .
3855 .It Va jail_parallel_start
3856 .Pq Vt bool
3857 If set to
3858 .Dq Li YES ,
3859 all configured jails will be started in the background (in parallel).
3860 .It Va jail_flags
3861 .Pq Vt str
3862 Unset by default.
3863 When set, use as default value for
3864 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3865 for every jail in
3866 .Va jail_list .
3867 .It Va jail_list
3868 .Pq Vt str
3869 A space separated list of names for jails.
3870 If this variable is empty,
3871 all of
3872 .Xr jail 8
3873 instances in the configuration file will be configured.
3874 This is purely a configuration aid to help identify and
3875 configure multiple jails.
3876 The names specified in this list will be used to
3877 identify settings common to an instance of a jail,
3878 and should contain alphanumeric characters only.
3879 The literal jail name of
3880 .Dq Li 0
3881 .Pq zero
3882 is not allowed.
3883 .It Va jail_* variables
3884 Note that older releases supported per-jail configuration via
3885 .Xr rc.conf 5
3886 variables.
3887 For example,
3888 hostname of a jail named
3889 .Li vjail
3890 was able to be set by
3891 .Li jail_vjail_hostname .
3892 These per-jail configuration variables are now obsolete in favor of
3893 .Xr jail 8
3894 configuration file.
3895 For backward compatibility,
3896 when per-jail configuration variables are defined,
3897 .Xr jail 8
3898 configuration files are created as
3899 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3900 and used.
3901 .Pp
3902 The following per-jail parameters are handled by
3903 .Pa rc.d/jail
3904 script out of their corresponding
3905 .Nm
3906 variables.
3907 In addition to them, parameters in
3908 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3909 will be added to the configuration file.
3910 They must be a semi-colon
3911 .Pq Ql \&;
3912 delimited list of
3913 .Dq key=value .
3914 For more details,
3915 see
3916 .Xr jail 8
3917 manual page.
3918 .Bl  -tag -width "host.hostname" -offset indent
3919 .It Li path
3920 set from
3921 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3922 .It Li host.hostname
3923 set from
3924 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3925 .It Li exec.consolelog
3926 set from
3927 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3928 The default value is
3929 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3930 .It Li interface
3931 set from
3932 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3933 .It Li vnet.interface
3934 set from
3935 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3936 This implies
3937 .Li vnet
3938 parameter will be enabled and cannot be specified with
3939 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3940 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3941 and/or
3942 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3943 at the same time.
3944 .It Li fstab
3945 set from
3946 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3947 .It Li mount
3948 set from
3949 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3950 .It Li exec.fib
3951 set from
3952 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3953 .It Li exec.start
3954 set from
3955 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3956 The parameter name was
3957 .Li command
3958 in some older releases.
3959 .It Li exec.prestart
3960 set from
3961 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3962 .It Li exec.poststart
3963 set from
3964 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3965 .It Li exec.stop
3966 set from
3967 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3968 .It Li exec.prestop
3969 set from
3970 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3971 .It Li exec.poststop
3972 set from
3973 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3974 .It Li ip4.addr
3975 set if
3976 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3977 or
3978 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3979 contain IPv4 addresses
3980 .It Li ip6.addr
3981 set if
3982 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3983 or
3984 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3985 contain IPv6 addresses
3986 .It Li allow.mount
3987 set from
3988 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3989 .It Li mount.devfs
3990 set from
3991 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3992 .It Li devfs_ruleset
3993 set from
3994 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3995 This must be an integer,
3996 not a string.
3997 .It Li mount.fdescfs
3998 set from
3999 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
4000 .It Li allow.set_hostname
4001 set from
4002 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
4003 .It Li allow.rawsocket
4004 set from
4005 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
4006 .It Li allow.sysvipc
4007 set from
4008 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
4009 .El
4010 .\" -----------------------------------------------------
4011 .It Va harvest_interrupt
4012 .Pq Vt bool
4013 Set to
4014 .Dq Li YES
4015 to use hardware interrupts as an entropy source.
4016 Refer to
4017 .Xr random 4
4018 for more information.
4019 .It Va harvest_ethernet
4020 .Pq Vt bool
4021 Set to
4022 .Dq Li YES
4023 to use LAN traffic as an entropy source.
4024 Refer to
4025 .Xr random 4
4026 for more information.
4027 .It Va harvest_p_to_p
4028 .Pq Vt bool
4029 Set to
4030 .Dq Li YES
4031 to use serial line traffic as an entropy source.
4032 Refer to
4033 .Xr random 4
4034 for more information.
4035 .It Va entropy_dir
4036 .Pq Vt str
4037 Set to
4038 .Dq Li NO
4039 to disable caching entropy via
4040 .Xr cron 8 .
4041 Otherwise set to the directory used to store entropy files in.
4042 .It Va entropy_file
4043 .Pq Vt str
4044 Set to
4045 .Dq Li NO
4046 to disable caching entropy through reboots.
4047 Otherwise set to the filename used to store cached entropy through
4048 reboots.
4049 This file should be located on the root file system to seed the
4050 .Xr random 4
4051 device as early as possible in the boot process.
4052 .It Va entropy_save_sz
4053 .Pq Vt int
4054 Size of the entropy cache files saved by
4055 .Nm save-entropy
4056 periodically.
4057 .It Va entropy_save_num
4058 .Pq Vt int
4059 Number of entropy cache files to save by
4060 .Nm save-entropy
4061 periodically.
4062 .It Va ipsec_enable
4063 .Pq Vt bool
4064 Set to
4065 .Dq Li YES
4066 to run
4067 .Xr setkey 8
4068 on
4069 .Va ipsec_file
4070 at boot time.
4071 .It Va ipsec_file
4072 .Pq Vt str
4073 Configuration file for
4074 .Xr setkey 8 .
4075 .It Va dmesg_enable
4076 .Pq Vt bool
4077 Set to
4078 .Dq Li YES
4079 to save
4080 .Xr dmesg 8
4081 to
4082 .Pa /var/run/dmesg.boot
4083 on boot.
4084 .It Va rcshutdown_timeout
4085 .Pq Vt int
4086 If set, start a watchdog timer in the background which will terminate
4087 .Pa rc.shutdown
4088 if
4089 .Xr shutdown 8
4090 has not completed within the specified time (in seconds).
4091 Notice that in addition to this soft timeout,
4092 .Xr init 8
4093 also applies a hard timeout for the execution of
4094 .Pa rc.shutdown .
4095 This is configured via
4096 .Xr sysctl 8
4097 variable
4098 .Va kern.init_shutdown_timeout
4099 and defaults to 120 seconds.
4100 Setting the value of
4101 .Va rcshutdown_timeout
4102 to more than 120 seconds will have no effect until the
4103 .Xr sysctl 8
4104 variable
4105 .Va kern.init_shutdown_timeout
4106 is also increased.
4107 .It Va virecover_enable
4108 .Pq Vt bool
4109 Set to
4110 .Dq Li NO
4111 to prevent the system from trying to
4112 recover pre-maturely terminated
4113 .Xr vi 1
4114 sessions.
4115 .It Va ugidfw_enable
4116 .Pq Vt bool
4117 Set to
4118 .Dq Li YES
4119 to load the
4120 .Xr mac_bsdextended 4
4121 module upon system initialization and load a default
4122 ruleset file.
4123 .It Va bsdextended_script
4124 .Pq Vt str
4125 The default
4126 .Xr mac_bsdextended 4
4127 ruleset file to load.
4128 The default value of this variable is
4129 .Pa /etc/rc.bsdextended .
4130 .It Va newsyslog_enable
4131 .Pq Vt bool
4132 If set to
4133 .Dq Li YES ,
4134 run
4135 .Xr newsyslog 8
4136 command at startup.
4137 .It Va newsyslog_flags
4138 .Pq Vt str
4139 If
4140 .Va newsyslog_enable
4141 is set to
4142 .Dq Li YES ,
4143 these are the flags to pass to the
4144 .Xr newsyslog 8
4145 program.
4146 The default is
4147 .Dq Li -CN ,
4148 which causes log files flagged with a
4149 .Cm C
4150 to be created.
4151 .It Va mdconfig_md Ns Aq Ar X
4152 .Pq Vt str
4153 Arguments to
4154 .Xr mdconfig 8
4155 for
4156 .Xr md 4
4157 device
4158 .Ar X .
4159 At minimum a
4160 .Fl t Ar type
4161 must be specified and either a
4162 .Fl s Ar size
4163 for malloc or swap backed
4164 .Xr md 4
4165 devices or a
4166 .Fl f Ar file
4167 for vnode backed
4168 .Xr md 4
4169 devices.
4170 Note that
4171 .Va mdconfig_md Ns Aq Ar X
4172 variables are evaluated until one variable is unset or null.
4173 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4174 .Pq Vt str
4175 Optional arguments passed to
4176 .Xr newfs 8
4177 to initialize
4178 .Xr md 4
4179 device
4180 .Ar X .
4181 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4182 .Pq Vt str
4183 An ownership specification passed to
4184 .Xr chown 8
4185 after the specified
4186 .Xr md 4
4187 device
4188 .Ar X
4189 has been mounted.
4190 Both the
4191 .Xr md 4
4192 device and the mount point will be changed.
4193 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4194 .Pq Vt str
4195 A mode string passed to
4196 .Xr chmod 1
4197 after the specified
4198 .Xr md 4
4199 device
4200 .Ar X
4201 has been mounted.
4202 Both the
4203 .Xr md 4
4204 device and the mount point will be changed.
4205 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4206 .Pq Vt str
4207 Files to be copied to the mount point of the
4208 .Xr md 4
4209 device
4210 .Ar X
4211 after it has been mounted.
4212 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4213 .Pq Vt str
4214 Command to execute after the specified
4215 .Xr md 4
4216 device
4217 .Ar X
4218 has been mounted.
4219 Note that the command is passed to
4220 .Ic eval
4221 and that both
4222 .Va _dev
4223 and
4224 .Va _mp
4225 variables can be used to reference respectively the
4226 .Xr md 4
4227 device and the mount point.
4228 Assuming that the
4229 .Xr md 4
4230 device is
4231 .Li md0 ,
4232 one could set the following:
4233 .Bd -literal
4234 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4235 .Ed
4236 .It Va autobridge_interfaces
4237 .Pq Vt str
4238 Set to the list of bridge interfaces that will have newly arriving interfaces
4239 checked against to be automatically added.
4240 If not set to
4241 .Dq Li NO
4242 then for each whitespace separated
4243 .Ar element
4244 in the value, a
4245 .Va autobridge_ Ns Aq Ar element
4246 variable is assumed to exist which has a whitespace separated list of interface
4247 names to match, these names can use wildcards.
4248 For example:
4249 .Bd -literal
4250 autobridge_interfaces="bridge0"
4251 autobridge_bridge0="tap* dc0 vlan[345]"
4252 .Ed
4253 .It Va mixer_enable
4254 .Pq Vt bool
4255 If set to
4256 .Dq Li YES ,
4257 enable support for sound mixer.
4258 .It Va hcsecd_enable
4259 .Pq Vt bool
4260 If set to
4261 .Dq Li YES ,
4262 enable Bluetooth security daemon.
4263 .It Va hcsecd_config
4264 .Pq Vt str
4265 Configuration file for
4266 .Xr hcsecd 8 .
4267 Default
4268 .Pa /etc/bluetooth/hcsecd.conf .
4269 .It Va sdpd_enable
4270 .Pq Vt bool
4271 If set to
4272 .Dq Li YES ,
4273 enable Bluetooth Service Discovery Protocol daemon.
4274 .It Va sdpd_control
4275 .Pq Vt str
4276 Path to
4277 .Xr sdpd 8
4278 control socket.
4279 Default
4280 .Pa /var/run/sdp .
4281 .It Va sdpd_groupname
4282 .Pq Vt str
4283 Sets
4284 .Xr sdpd 8
4285 group to run as after it initializes.
4286 Default
4287 .Dq Li nobody .
4288 .It Va sdpd_username
4289 .Pq Vt str
4290 Sets
4291 .Xr sdpd 8
4292 user to run as after it initializes.
4293 Default
4294 .Dq Li nobody .
4295 .It Va bthidd_enable
4296 .Pq Vt bool
4297 If set to
4298 .Dq Li YES ,
4299 enable Bluetooth Human Interface Device daemon.
4300 .It Va bthidd_config
4301 .Pq Vt str
4302 Configuration file for
4303 .Xr bthidd 8 .
4304 Default
4305 .Pa /etc/bluetooth/bthidd.conf .
4306 .It Va bthidd_hids
4307 .Pq Vt str
4308 Path to a file, where
4309 .Xr bthidd 8
4310 will store information about known HID devices.
4311 Default
4312 .Pa /var/db/bthidd.hids .
4313 .It Va rfcomm_pppd_server_enable
4314 .Pq Vt bool
4315 If set to
4316 .Dq Li YES ,
4317 enable Bluetooth RFCOMM PPP wrapper daemon.
4318 .It Va rfcomm_pppd_server_profile
4319 .Pq Vt str
4320 The name of the profile to use from
4321 .Pa /etc/ppp/ppp.conf .
4322 Multiple profiles can be specified here.
4323 Also used to specify per-profile overrides.
4324 When the profile name contains any of the characters
4325 .Dq Li .-/+
4326 they are translated to
4327 .Dq Li _
4328 for the proposes of the override variable names.
4329 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4330 .Pq Vt str
4331 Overrides local address to listen on.
4332 By default
4333 .Xr rfcomm_pppd 8
4334 will listen on
4335 .Dq Li ANY
4336 address.
4337 The address can be specified as BD_ADDR or name.
4338 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4339 .Pq Vt str
4340 Overrides local RFCOMM channel to listen on.
4341 By default
4342 .Xr rfcomm_pppd 8
4343 will listen on RFCOMM channel 1.
4344 Must set properly if multiple profiles used in the same time.
4345 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4346 .Pq Vt bool
4347 Tells
4348 .Xr rfcomm_pppd 8
4349 if it should register Serial Port service on the specified RFCOMM channel.
4350 Default
4351 .Dq Li NO .
4352 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4353 .Pq Vt bool
4354 Tells
4355 .Xr rfcomm_pppd 8
4356 if it should register Dial-Up Networking service on the specified
4357 RFCOMM channel.
4358 Default
4359 .Dq Li NO .
4360 .It Va ubthidhci_enable
4361 .Pq Vt bool
4362 If set to
4363 .Dq Li YES ,
4364 change the USB Bluetooth controller from HID mode to HCI mode.
4365 You also need to specify the location of USB Bluetooth controller with the
4366 .Va ubthidhci_busnum
4367 and
4368 .Va ubthidhci_addr
4369 variables.
4370 .It Va ubthidhci_busnum
4371 Bus number where the USB Bluetooth controller is located.
4372 Check the output of
4373 .Xr usbconfig 8
4374 on your system to find this information.
4375 .It Va ubthidhci_addr
4376 Bus address of the USB Bluetooth controller.
4377 Check the output of
4378 .Xr usbconfig 8
4379 on your system to find this information.
4380 .It Va netwait_enable
4381 .Pq Vt bool
4382 If set to
4383 .Dq Li YES ,
4384 delays the start of network-reliant services until
4385 .Va netwait_if
4386 is up and ICMP packets to a destination defined in
4387 .Va netwait_ip
4388 are flowing.
4389 Link state is examined first, followed by
4390 .Dq Li pinging
4391 an IP address to verify network usability.
4392 If no destination can be reached or timeouts are exceeded,
4393 network services are started anyway with no guarantee that
4394 the network is usable.
4395 Use of this variable requires both
4396 .Va netwait_ip
4397 and
4398 .Va netwait_if
4399 to be set.
4400 .It Va netwait_ip
4401 .Pq Vt str
4402 Empty by default.
4403 This variable contains a space-delimited list of IP addresses to
4404 .Xr ping 8 .
4405 DNS hostnames should not be used as resolution is not guaranteed
4406 to be functional at this point.
4407 If multiple IP addresses are specified,
4408 each will be tried until one is successful or the list is exhausted.
4409 .It Va netwait_timeout
4410 .Pq Vt int
4411 Indicates the total number of seconds to perform a
4412 .Dq Li ping
4413 against each IP address in
4414 .Va netwait_ip ,
4415 at a rate of one ping per second.
4416 If any of the pings are successful,
4417 full network connectivity is considered reliable.
4418 The default is 60.
4419 .It Va netwait_if
4420 .Pq Vt str
4421 Empty by default.
4422 Defines the name of the network interface on which watch for link.
4423 .Xr ifconfig 8
4424 is used to monitor the interface, looking for
4425 .Dq Li status: no carrier .
4426 Once gone, the link is considered up.
4427 This can be a
4428 .Xr vlan 4
4429 interface if desired.
4430 .It Va netwait_if_timeout
4431 .Pq Vt int
4432 Defines the total number of seconds to wait for link to become usable,
4433 polled at a 1-second interval.
4434 The default is 30.
4435 .It Va rctl_enable
4436 .Pq Vt bool
4437 Set to
4438 .Dq Li YES
4439 to load
4440 .Xr rctl 8
4441 rules from the defined ruleset.
4442 The kernel must be built with
4443 .Cd "options RACCT"
4444 and
4445 .Cd "options RCTL" .
4446 .It Va rctl_rules
4447 .Pq Vt str
4448 Set to
4449 .Pa /etc/rctl.conf
4450 by default.
4451 This variables contains the
4452 .Xr rctl.conf 5
4453 ruleset to load for
4454 .Xr rctl 8 .
4455 .El
4456 .Sh FILES
4457 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4458 .It Pa /etc/defaults/rc.conf
4459 .It Pa /etc/rc.conf
4460 .It Pa /etc/rc.conf.local
4461 .El
4462 .Sh SEE ALSO
4463 .Xr catman 1 ,
4464 .Xr chmod 1 ,
4465 .Xr gdb 1 ,
4466 .Xr info 1 ,
4467 .Xr kbdcontrol 1 ,
4468 .Xr makewhatis 1 ,
4469 .Xr sh 1 ,
4470 .Xr vi 1 ,
4471 .Xr vidcontrol 1 ,
4472 .Xr bridge 4 ,
4473 .Xr dummynet 4 ,
4474 .Xr ip 4 ,
4475 .Xr ipf 4 ,
4476 .Xr ipfw 4 ,
4477 .Xr ipnat 4 ,
4478 .Xr kld 4 ,
4479 .Xr pf 4 ,
4480 .Xr pflog 4 ,
4481 .Xr pfsync 4 ,
4482 .Xr tcp 4 ,
4483 .Xr udp 4 ,
4484 .Xr exports 5 ,
4485 .Xr fstab 5 ,
4486 .Xr ipf 5 ,
4487 .Xr ipnat 5 ,
4488 .Xr jail.conf 5 ,
4489 .Xr motd 5 ,
4490 .Xr newsyslog.conf 5 ,
4491 .Xr pf.conf 5 ,
4492 .Xr security 7 ,
4493 .Xr accton 8 ,
4494 .Xr amd 8 ,
4495 .Xr apm 8 ,
4496 .Xr atm 8 ,
4497 .Xr bthidd 8 ,
4498 .Xr chkprintcap 8 ,
4499 .Xr chown 8 ,
4500 .Xr cron 8 ,
4501 .Xr devfs 8 ,
4502 .Xr dhclient 8 ,
4503 .Xr ftpd 8 ,
4504 .Xr geli 8 ,
4505 .Xr hcsecd 8 ,
4506 .Xr ifconfig 8 ,
4507 .Xr inetd 8 ,
4508 .Xr ipf 8 ,
4509 .Xr ipfw 8 ,
4510 .Xr ipnat 8 ,
4511 .Xr jail 8 ,
4512 .Xr kldxref 8 ,
4513 .Xr lpd 8 ,
4514 .Xr mdconfig 8 ,
4515 .Xr mdmfs 8 ,
4516 .Xr mixer 8 ,
4517 .Xr mountd 8 ,
4518 .Xr moused 8 ,
4519 .Xr mrouted 8 ,
4520 .Xr newfs 8 ,
4521 .Xr newsyslog 8 ,
4522 .Xr nfsd 8 ,
4523 .Xr ntpd 8 ,
4524 .Xr ntpdate 8 ,
4525 .Xr pfctl 8 ,
4526 .Xr pflogd 8 ,
4527 .Xr ping 8 ,
4528 .Xr powerd 8 ,
4529 .Xr quotacheck 8 ,
4530 .Xr quotaon 8 ,
4531 .Xr rc 8 ,
4532 .Xr rc.sendmail 8 ,
4533 .Xr rfcomm_pppd 8 ,
4534 .Xr route 8 ,
4535 .Xr routed 8 ,
4536 .Xr rpcbind 8 ,
4537 .Xr rpc.lockd 8 ,
4538 .Xr rpc.statd 8 ,
4539 .Xr rwhod 8 ,
4540 .Xr savecore 8 ,
4541 .Xr sdpd 8 ,
4542 .Xr sshd 8 ,
4543 .Xr swapon 8 ,
4544 .Xr sysctl 8 ,
4545 .Xr syslogd 8 ,
4546 .Xr timed 8 ,
4547 .Xr unbound 8 ,
4548 .Xr usbconfig 8 ,
4549 .Xr wlandebug 8 ,
4550 .Xr yp 8 ,
4551 .Xr ypbind 8 ,
4552 .Xr ypserv 8 ,
4553 .Xr ypset 8
4554 .Sh HISTORY
4555 The
4556 .Nm
4557 file appeared in
4558 .Fx 2.2.2 .
4559 .Sh AUTHORS
4560 .An Jordan K. Hubbard .