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