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