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