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