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