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