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