]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man5/rc.conf.5
Merge upstream r4302 to support multiple concurrently valid anchors.
[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 February 26, 2017
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 .Pp
43 The purpose of
44 .Nm
45 is not to run commands or perform system startup actions
46 directly.
47 Instead, it is included by the
48 various generic startup scripts in
49 .Pa /etc
50 which conditionalize their
51 internal actions according to the settings found there.
52 .Pp
53 The
54 .Pa /etc/rc.conf
55 file is included from the file
56 .Pa /etc/defaults/rc.conf ,
57 which specifies the default settings for all the available options.
58 Options need only be specified in
59 .Pa /etc/rc.conf
60 when the system administrator wishes to override these defaults.
61 The file
62 .Pa /etc/rc.conf.local
63 is used to override settings in
64 .Pa /etc/rc.conf
65 for historical reasons.
66 .Pp
67 In addition to
68 .Pa /etc/rc.conf.local
69 you can also place smaller configuration files for each
70 .Xr rc 8
71 script in the
72 .Pa /etc/rc.conf.d
73 directory or
74 .Ao Ar dir Ac Ns Pa /rc.conf.d
75 directories specified in
76 .Va local_startup ,
77 which will be included by the
78 .Va load_rc_config
79 function.
80 For jail configurations you could use the file
81 .Pa /etc/rc.conf.d/jail
82 to store jail specific configuration options.
83 If
84 .Va local_startup
85 contains
86 .Pa /usr/local/etc/rc.d
87 and
88 .Pa /opt/conf ,
89 .Pa /usr/local/rc.conf.d/jail
90 and
91 .Pa /opt/conf/rc.conf.d/jail
92 will be loaded.
93 If
94 .Ao Ar dir Ac Ns Pa /rc.conf.d/ Ns Ao Ar name Ac
95 is a directory,
96 all of files in the directory will be loaded.
97 Also see the
98 .Va rc_conf_files
99 variable below.
100 .Pp
101 Options are set with
102 .Dq Ar name Ns Li = Ns Ar value
103 assignments that use
104 .Xr sh 1
105 syntax.
106 The following list provides a name and short description for each
107 variable that can be set in the
108 .Nm
109 file:
110 .Bl -tag -width indent-two
111 .It Va rc_debug
112 .Pq Vt bool
113 If set to
114 .Dq Li YES ,
115 enable output of debug messages from rc scripts.
116 This variable can be helpful in diagnosing mistakes when
117 editing or integrating new scripts.
118 Beware that this produces copious output to the terminal and
119 .Xr syslog 3 .
120 .It Va rc_info
121 .Pq Vt bool
122 If set to
123 .Dq Li NO ,
124 disable informational messages from the rc scripts.
125 Informational messages are displayed when
126 a condition that is not serious enough to warrant a warning or
127 an error occurs.
128 .It Va rc_startmsgs
129 .Pq Vt bool
130 If set to
131 .Dq Li YES ,
132 show
133 .Dq Starting foo:
134 when faststart is used (e.g., at boot time).
135 .It Va early_late_divider
136 .Pq Vt str
137 The name of the script that should be used as the
138 delimiter between the
139 .Dq early
140 and
141 .Dq late
142 stages of the boot process.
143 The early stage should contain all the services needed to
144 get the disks (local or remote) mounted so that the late
145 stage can include scripts contained in the directories
146 listed in the
147 .Va local_startup
148 variable (see below).
149 Thus, the two likely candidates for this value are
150 .Pa mountcritlocal
151 for the typical system, and
152 .Pa mountcritremote
153 if the system needs remote file
154 systems mounted to get access to the
155 .Va local_startup
156 directories; for example when
157 .Pa /usr/local
158 is NFS mounted.
159 For
160 .Pa rc.conf
161 within a
162 .Xr jail 8
163 .Pa NETWORKING
164 is likely to be an appropriate value.
165 Extreme care should be taken when changing this value,
166 and before changing it one should ensure that there are
167 adequate provisions to recover from a failed boot
168 (such as physical contact with the machine,
169 or reliable remote console access).
170 .It Va always_force_depends
171 .Pq Vt bool
172 Various
173 .Pa rc.d
174 scripts use the force_depend function to check whether required
175 services are already running, and to start them if necessary.
176 By default during boot time this check is bypassed if the
177 required service is enabled in
178 .Pa /etc/rc.conf[.local] .
179 Setting this option will bypass that check at boot time and
180 always test whether or not the service is actually running.
181 Enabling this option is likely to increase your boot time if
182 services are enabled that utilize the force_depend check.
183 .It Ao Ar name Ac Ns Va _chroot
184 .Pq Vt str
185 .Xr chroot 8
186 to this directory before running the service.
187 .It Ao Ar name Ac Ns Va _user
188 .Pq Vt str
189 Run the service under this user account.
190 .It Ao Ar name Ac Ns Va _group
191 .Pq Vt str
192 Run the chrooted service under this system group.
193 Unlike the _user
194 setting, this setting has no effect if the service is not chrooted.
195 .It Ao Ar name Ac Ns Va _fib
196 .Pq Vt int
197 The
198 .Xr setfib 1
199 value to run the service under.
200 .It Ao Ar name Ac Ns Va _nice
201 .Pq Vt int
202 The
203 .Xr nice 1
204 value to run the service under.
205 .It Va apm_enable
206 .Pq Vt bool
207 If set to
208 .Dq Li YES ,
209 enable support for Automatic Power Management with
210 the
211 .Xr apm 8
212 command.
213 .It Va apmd_enable
214 .Pq Vt bool
215 Run
216 .Xr apmd 8
217 to handle APM event from userland.
218 This also enables support for APM.
219 .It Va apmd_flags
220 .Pq Vt str
221 If
222 .Va apmd_enable
223 is set to
224 .Dq Li YES ,
225 these are the flags to pass to the
226 .Xr apmd 8
227 daemon.
228 .It Va devd_enable
229 .Pq Vt bool
230 Run
231 .Xr devd 8
232 to handle device added, removed or unknown events from the kernel.
233 .It Va ddb_enable
234 .Pq Vt bool
235 Run
236 .Xr ddb 8
237 to install
238 .Xr ddb 4
239 scripts at boot time.
240 .It Va ddb_config
241 .Pq Vt str
242 Configuration file for
243 .Xr ddb 8 .
244 Default
245 .Pa /etc/ddb.conf .
246 .It Va kld_list
247 .Pq Vt str
248 A list of kernel modules to load right after the local
249 disks are mounted.
250 Loading modules at this point in the boot process is
251 much faster than doing it via
252 .Pa /boot/loader.conf
253 for those modules not necessary for mounting local disk.
254 .It Va kldxref_enable
255 .Pq Vt bool
256 Set to
257 .Dq Li NO
258 by default.
259 Set to
260 .Dq Li YES
261 to automatically rebuild
262 .Pa linker.hints
263 files with
264 .Xr kldxref 8
265 at boot time.
266 .It Va kldxref_clobber
267 .Pq Vt bool
268 Set to
269 .Dq Li NO
270 by default.
271 If
272 .Va kldxref_enable
273 is true,
274 setting to
275 .Dq Li YES
276 will overwrite existing
277 .Pa linker.hints
278 files at boot time.
279 Otherwise,
280 only missing
281 .Pa linker.hints
282 files are generated.
283 .It Va kldxref_module_path
284 .Pq Vt str
285 Empty by default.
286 A semi-colon
287 .Pq Ql \&;
288 delimited list of paths containing
289 .Xr kld 4
290 modules.
291 If empty,
292 the contents of the
293 .Va kern.module_path
294 .Xr sysctl 8
295 are used.
296 .It Va powerd_enable
297 .Pq Vt bool
298 If set to
299 .Dq Li YES ,
300 enable the system power control facility with the
301 .Xr powerd 8
302 daemon.
303 .It Va powerd_flags
304 .Pq Vt str
305 If
306 .Va powerd_enable
307 is set to
308 .Dq Li YES ,
309 these are the flags to pass to the
310 .Xr powerd 8
311 daemon.
312 .It Va tmpmfs
313 Controls the creation of a
314 .Pa /tmp
315 memory file system.
316 Always happens if set to
317 .Dq Li YES
318 and never happens if set to
319 .Dq Li NO .
320 If set to anything else, a memory file system is created if
321 .Pa /tmp
322 is not writable.
323 .It Va tmpsize
324 Controls the size of a created
325 .Pa /tmp
326 memory file system.
327 .It Va tmpmfs_flags
328 Extra options passed to the
329 .Xr mdmfs 8
330 utility when the memory file system for
331 .Pa /tmp
332 is created.
333 The default is
334 .Dq Li "-S" ,
335 which inhibits the use of softupdates on
336 .Pa /tmp
337 so that file system space is freed without delay
338 after file truncation or deletion.
339 See
340 .Xr mdmfs 8
341 for other options you can use in
342 .Va tmpmfs_flags .
343 .It Va varmfs
344 Controls the creation of a
345 .Pa /var
346 memory file system.
347 Always happens if set to
348 .Dq Li YES
349 and never happens if set to
350 .Dq Li NO .
351 If set to anything else, a memory file system is created if
352 .Pa /var
353 is not writable.
354 .It Va varsize
355 Controls the size of a created
356 .Pa /var
357 memory file system.
358 .It Va varmfs_flags
359 Extra options passed to the
360 .Xr mdmfs 8
361 utility when the memory file system for
362 .Pa /var
363 is created.
364 The default is
365 .Dq Li "-S" ,
366 which inhibits the use of softupdates on
367 .Pa /var
368 so that file system space is freed without delay
369 after file truncation or deletion.
370 See
371 .Xr mdmfs 8
372 for other options you can use in
373 .Va varmfs_flags .
374 .It Va populate_var
375 Controls the automatic population of the
376 .Pa /var
377 file system.
378 Always happens if set to
379 .Dq Li YES
380 and never happens if set to
381 .Dq Li NO .
382 If set to anything else, a memory file system is created if
383 .Pa /var
384 is not writable.
385 Note that this process requires access to certain commands in
386 .Pa /usr
387 before
388 .Pa /usr
389 is mounted on normal systems.
390 .It Va cleanvar_enable
391 .Pq Vt bool
392 Clean the
393 .Pa /var
394 directory.
395 .It Va local_startup
396 .Pq Vt str
397 List of directories to search for startup script files.
398 .It Va script_name_sep
399 .Pq Vt str
400 The field separator to use for breaking down the list of startup script files
401 into individual filenames.
402 The default is a space.
403 It is not necessary to change this unless there are startup scripts with names
404 containing spaces.
405 .It Va hostapd_enable
406 .Pq Vt bool
407 Set to
408 .Dq Li YES
409 to start
410 .Xr hostapd 8
411 at system boot time.
412 .It Va hostname
413 .Pq Vt str
414 The fully qualified domain name (FQDN) of this host on the network.
415 This should almost certainly be set to something meaningful, even if
416 there is no network connection.
417 If
418 .Xr dhclient 8
419 is used to set the hostname via DHCP,
420 this variable should be set to an empty string.
421 If this value remains unset when the system is done booting
422 your console login will display the default hostname of
423 .Dq Amnesiac .
424 .It Va nisdomainname
425 .Pq Vt str
426 The NIS domain name of this host, or
427 .Dq Li NO
428 if NIS is not used.
429 .It Va dhclient_program
430 .Pq Vt str
431 Path to the DHCP client program
432 .Pa ( /sbin/dhclient ,
433 the
434 .Ox
435 DHCP client,
436 is the default).
437 .It Va dhclient_flags
438 .Pq Vt str
439 Additional flags to pass to the DHCP client program.
440 For the
441 .Ox
442 DHCP client, see the
443 .Xr dhclient 8
444 manpage for a description of the command line options available.
445 .It Va dhclient_flags_ Ns Aq Ar iface
446 Additional flags to pass to the DHCP client program running on
447 .Ar iface
448 only.
449 When specified, this variable overrides
450 .Va dhclient_flags .
451 .It Va background_dhclient
452 .Pq Vt bool
453 Set to
454 .Dq Li YES
455 to start the DHCP client in background.
456 This can cause trouble with applications depending on
457 a working network, but it will provide a faster startup
458 in many cases.
459 .It Va background_dhclient_ Ns Aq Ar iface
460 When specified, this variable overrides the
461 .Va background_dhclient
462 variable for interface
463 .Ar iface
464 only.
465 .It Va synchronous_dhclient
466 .Pq Vt bool
467 Set to
468 .Dq Li YES
469 to start
470 .Xr dhclient 8
471 synchronously at startup.
472 This behavior can be overridden on a per-interface basis by replacing
473 the
474 .Dq Li DHCP
475 keyword in the
476 .Va ifconfig_ Ns Aq Ar interface
477 variable with
478 .Dq Li SYNCDHCP
479 or
480 .Dq Li NOSYNCDHCP .
481 .It Va defaultroute_delay
482 .Pq Vt int
483 When set to a positive value, wait up to this long after configuring
484 DHCP interfaces at startup to give the interfaces time to receive a lease.
485 .It Va firewall_enable
486 .Pq Vt bool
487 Set to
488 .Dq Li YES
489 to load firewall rules at startup.
490 If the kernel was not built with
491 .Cd "options IPFIREWALL" ,
492 the
493 .Pa ipfw.ko
494 kernel module will be loaded.
495 See also
496 .Va ipfilter_enable .
497 .It Va firewall_script
498 .Pq Vt str
499 This variable specifies the full path to the firewall script to run.
500 The default is
501 .Pa /etc/rc.firewall .
502 .It Va firewall_type
503 .Pq Vt str
504 Names the firewall type from the selection in
505 .Pa /etc/rc.firewall ,
506 or the file which contains the local firewall ruleset.
507 Valid selections from
508 .Pa /etc/rc.firewall
509 are:
510 .Pp
511 .Bl -tag -width ".Li simple" -compact
512 .It Li open
513 unrestricted IP access
514 .It Li closed
515 all IP services disabled, except via
516 .Dq Li lo0
517 .It Li client
518 basic protection for a workstation
519 .It Li simple
520 basic protection for a LAN.
521 .El
522 .Pp
523 If a filename is specified, the full path
524 must be given.
525 .It Va firewall_quiet
526 .Pq Vt bool
527 Set to
528 .Dq Li YES
529 to disable the display of firewall rules on the console during boot.
530 .It Va firewall_logging
531 .Pq Vt bool
532 Set to
533 .Dq Li YES
534 to enable firewall event logging.
535 This is equivalent to the
536 .Dv IPFIREWALL_VERBOSE
537 kernel option.
538 .It Va firewall_logif
539 .Pq Vt bool
540 Set to
541 .Dq Li YES
542 to create pseudo interface
543 .Li ipfw0
544 for logging.
545 For more details, see
546 .Xr ipfw 8
547 manual page.
548 .It Va firewall_flags
549 .Pq Vt str
550 Flags passed to
551 .Xr ipfw 8
552 if
553 .Va firewall_type
554 specifies a filename.
555 .It Va firewall_coscripts
556 .Pq Vt str
557 List of executables and/or rc scripts to run after firewall starts/stops.
558 Default is empty.
559 .\" ----- firewall_nat_enable setting --------------------------------
560 .It Va firewall_nat_enable
561 .Pq Vt bool
562 The
563 .Xr ipfw 8
564 equivalent of
565 .Va natd_enable .
566 Setting this to
567 .Dq Li YES
568 enables kernel NAT.
569 .Va firewall_enable
570 must also be set to
571 .Dq Li YES .
572 .It Va firewall_nat_interface
573 .Pq Vt str
574 The
575 .Xr ipfw 8
576 equivalent of
577 .Va natd_interface .
578 This is the name of the public interface or IP address on which
579 kernel NAT should run.
580 .It Va firewall_nat_flags
581 .Pq Vt str
582 Additional configuration parameters for kernel NAT should be placed here.
583 .It Va dummynet_enable
584 .Pq Vt bool
585 Setting this to
586 .Dq Li YES
587 will automatically load the
588 .Xr dummynet 4
589 module if
590 .Va firewall_enable
591 is also set to
592 .Dq Li YES .
593 .\" -------------------------------------------------------------------
594 .It Va ipfw_netflow_enable
595 .Pq Vt bool
596 Setting this to
597 .Dq Li YES
598 will enable netflow logging via
599 .Xr ng_netflow 4
600 .Pp
601 By default a ipfw rule is inserted and all packets are duplicated with
602 the ngtee command and netflow packets are sent to 127.0.0.1 on the netflow
603 port using protocol version 5.
604 .It Va ipfw_netflow_hook
605 .Pq Vt int
606 netflow hook name, must be numerical
607 (default
608 .Pa 9995 ) .
609 .It Va ipfw_netflow_rule
610 .Pq Vt int
611 ipfw rule number
612 (default
613 .Pa 1000 ) .
614 .It Va ipfw_netflow_ip
615 .Pq Vt str
616 Destination server ip for receiving netflow data
617 (default
618 .Pa 127.0.0.1 ) .
619 .It Va ipfw_netflow_port
620 .Pq Vt int
621 Destination server port for receiving netflow data
622 (default
623 .Pa 9995 ) .
624 .It Va ipfw_netflow_version
625 .Pq Vt int
626 Do not set for using version 5 of the netflow protocol, set it to 9 for using version 9.
627 .It Va ipfw_netflow_fib
628 .Pq Vt int
629 Only match packet in FIB
630 .Pa ipfw_netflow_fib
631 (default is undefined meaning all FIBs).
632 .It Va natd_program
633 .Pq Vt str
634 Path to
635 .Xr natd 8 .
636 .It Va natd_enable
637 .Pq Vt bool
638 Set to
639 .Dq Li YES
640 to enable
641 .Xr natd 8 .
642 .Va firewall_enable
643 must also be set to
644 .Dq Li YES ,
645 and
646 .Xr divert 4
647 sockets must be enabled in the kernel.
648 If the kernel was not built with
649 .Cd "options IPDIVERT" ,
650 the
651 .Pa ipdivert.ko
652 kernel module will be loaded.
653 .It Va natd_interface
654 .Pq Vt str
655 This is the name of the public interface on which
656 .Xr natd 8
657 should run.
658 The interface may be given as an interface name or as an IP address.
659 .It Va natd_flags
660 .Pq Vt str
661 Additional
662 .Xr natd 8
663 flags should be placed here.
664 The
665 .Fl n
666 or
667 .Fl a
668 flag is automatically added with the above
669 .Va natd_interface
670 as an argument.
671 .\" ----- ipfilter_enable setting --------------------------------
672 .It Va ipfilter_enable
673 .Pq Vt bool
674 Set to
675 .Dq Li NO
676 by default.
677 Setting this to
678 .Dq Li YES
679 enables
680 .Xr ipf 8
681 packet filtering.
682 .Pp
683 Typical usage will require putting
684 .Bd -literal
685 ipfilter_enable="YES"
686 ipnat_enable="YES"
687 ipmon_enable="YES"
688 ipfs_enable="YES"
689 .Ed
690 .Pp
691 into
692 .Pa /etc/rc.conf
693 and editing
694 .Pa /etc/ipf.rules
695 and
696 .Pa /etc/ipnat.rules
697 appropriately.
698 .Pp
699 Note that
700 .Va ipfilter_enable
701 and
702 .Va ipnat_enable
703 can be enabled independently.
704 .Va ipmon_enable
705 and
706 .Va ipfs_enable
707 both require at least one of
708 .Va ipfilter_enable
709 and
710 .Va ipnat_enable
711 to be enabled.
712 .Pp
713 Having
714 .Bd -literal
715 options IPFILTER
716 options IPFILTER_LOG
717 options IPFILTER_DEFAULT_BLOCK
718 .Ed
719 .Pp
720 in the kernel configuration file is a good idea, too.
721 .\" ----- ipfilter_program setting ------------------------------
722 .It Va ipfilter_program
723 .Pq Vt str
724 Path to
725 .Xr ipf 8
726 (default
727 .Pa /sbin/ipf ) .
728 .\" ----- ipfilter_rules setting --------------------------------
729 .It Va ipfilter_rules
730 .Pq Vt str
731 Set to
732 .Pa /etc/ipf.rules
733 by default.
734 This variable contains the name of the filter rule definition file.
735 The file is expected to be readable for the
736 .Xr ipf 8
737 command to execute.
738 .\" ----- ipv6_ipfilter_rules setting ---------------------------
739 .It Va ipv6_ipfilter_rules
740 .Pq Vt str
741 Set to
742 .Pa /etc/ipf6.rules
743 by default.
744 This variable contains the IPv6 filter rule definition file.
745 The file is expected to be readable for the
746 .Xr ipf 8
747 command to execute.
748 .\" ----- ipfilter_flags setting --------------------------------
749 .It Va ipfilter_flags
750 .Pq Vt str
751 Empty by default.
752 This variable contains flags passed to the
753 .Xr ipf 8
754 program.
755 .\" ----- ipnat_enable setting ----------------------------------
756 .It Va ipnat_enable
757 .Pq Vt bool
758 Set to
759 .Dq Li NO
760 by default.
761 Set it to
762 .Dq Li YES
763 to enable
764 .Xr ipnat 8
765 network address translation.
766 See
767 .Va ipfilter_enable
768 for a detailed discussion.
769 .\" ----- ipnat_program setting ---------------------------------
770 .It Va ipnat_program
771 .Pq Vt str
772 Path to
773 .Xr ipnat 8
774 (default
775 .Pa /sbin/ipnat ) .
776 .\" ----- ipnat_rules setting -----------------------------------
777 .It Va ipnat_rules
778 .Pq Vt str
779 Set to
780 .Pa /etc/ipnat.rules
781 by default.
782 This variable contains the name of the file
783 holding the network address translation definition.
784 This file is expected to be readable for the
785 .Xr ipnat 8
786 command to execute.
787 .\" ----- ipnat_flags setting -----------------------------------
788 .It Va ipnat_flags
789 .Pq Vt str
790 Empty by default.
791 This variable contains flags passed to the
792 .Xr ipnat 8
793 program.
794 .\" ----- ipmon_enable setting ----------------------------------
795 .It Va ipmon_enable
796 .Pq Vt bool
797 Set to
798 .Dq Li NO
799 by default.
800 Set it to
801 .Dq Li YES
802 to enable
803 .Xr ipmon 8
804 monitoring (logging
805 .Xr ipf 8
806 and
807 .Xr ipnat 8
808 events).
809 Setting this variable needs setting
810 .Va ipfilter_enable
811 or
812 .Va ipnat_enable
813 too.
814 See
815 .Va ipfilter_enable
816 for a detailed discussion.
817 .\" ----- ipmon_program setting ---------------------------------
818 .It Va ipmon_program
819 .Pq Vt str
820 Path to
821 .Xr ipmon 8
822 (default
823 .Pa /sbin/ipmon ) .
824 .\" ----- ipmon_flags setting -----------------------------------
825 .It Va ipmon_flags
826 .Pq Vt str
827 Set to
828 .Dq Li -Ds
829 by default.
830 This variable contains flags passed to the
831 .Xr ipmon 8
832 program.
833 Another typical example would be
834 .Dq Fl D Pa /var/log/ipflog
835 to have
836 .Xr ipmon 8
837 log directly to a file bypassing
838 .Xr syslogd 8 .
839 Make sure to adjust
840 .Pa /etc/newsyslog.conf
841 in such case like this:
842 .Bd -literal
843 /var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
844 .Ed
845 .\" ----- ipfs_enable setting -----------------------------------
846 .It Va ipfs_enable
847 .Pq Vt bool
848 Set to
849 .Dq Li NO
850 by default.
851 Set it to
852 .Dq Li YES
853 to enable
854 .Xr ipfs 8
855 saving the filter and NAT state tables during shutdown
856 and reloading them during startup again.
857 Setting this variable needs setting
858 .Va ipfilter_enable
859 or
860 .Va ipnat_enable
861 to
862 .Dq Li YES
863 too.
864 See
865 .Va ipfilter_enable
866 for a detailed discussion.
867 Note that if
868 .Va kern_securelevel
869 is set to 3,
870 .Va ipfs_enable
871 cannot be used
872 because the raised securelevel will prevent
873 .Xr ipfs 8
874 from saving the state tables at shutdown time.
875 .\" ----- ipfs_program setting ----------------------------------
876 .It Va ipfs_program
877 .Pq Vt str
878 Path to
879 .Xr ipfs 8
880 (default
881 .Pa /sbin/ipfs ) .
882 .\" ----- ipfs_flags setting ------------------------------------
883 .It Va ipfs_flags
884 .Pq Vt str
885 Empty by default.
886 This variable contains flags passed to the
887 .Xr ipfs 8
888 program.
889 .\" ----- end of added ipf hook ---------------------------------
890 .It Va pf_enable
891 .Pq Vt bool
892 Set to
893 .Dq Li NO
894 by default.
895 Setting this to
896 .Dq Li YES
897 enables
898 .Xr pf 4
899 packet filtering.
900 .Pp
901 Typical usage will require putting
902 .Pp
903 .Dl pf_enable="YES"
904 .Pp
905 into
906 .Pa /etc/rc.conf
907 and editing
908 .Pa /etc/pf.conf
909 appropriately.
910 Adding
911 .Pp
912 .Dl "device pf"
913 .Pp
914 builds support for
915 .Xr pf 4
916 into the kernel, otherwise the
917 kernel module will be loaded.
918 .It Va pf_rules
919 .Pq Vt str
920 Path to
921 .Xr pf 4
922 ruleset configuration file
923 (default
924 .Pa /etc/pf.conf ) .
925 .It Va pf_program
926 .Pq Vt str
927 Path to
928 .Xr pfctl 8
929 (default
930 .Pa /sbin/pfctl ) .
931 .It Va pf_flags
932 .Pq Vt str
933 If
934 .Va pf_enable
935 is set to
936 .Dq Li YES ,
937 these flags are passed to the
938 .Xr pfctl 8
939 program when loading the ruleset.
940 .It Va pflog_enable
941 .Pq Vt bool
942 Set to
943 .Dq Li NO
944 by default.
945 Setting this to
946 .Dq Li YES
947 enables
948 .Xr pflogd 8
949 which logs packets from the
950 .Xr pf 4
951 packet filter.
952 .It Va pflog_logfile
953 .Pq Vt str
954 If
955 .Va pflog_enable
956 is set to
957 .Dq Li YES
958 this controls where
959 .Xr pflogd 8
960 stores the logfile
961 (default
962 .Pa /var/log/pflog ) .
963 Check
964 .Pa /etc/newsyslog.conf
965 to adjust logfile rotation for this.
966 .It Va pflog_program
967 .Pq Vt str
968 Path to
969 .Xr pflogd 8
970 (default
971 .Pa /sbin/pflogd ) .
972 .It Va pflog_flags
973 .Pq Vt str
974 Empty by default.
975 This variable contains additional flags passed to the
976 .Xr pflogd 8
977 program.
978 .It Va pflog_instances
979 .Pq Vt str
980 If logging to more than one
981 .Xr pflog 4
982 interface is desired,
983 .Va pflog_instances
984 is set to the list of
985 .Xr pflogd 8
986 instances that should be started at system boot time.
987 If
988 .Va pflog_instances
989 is set, for each whitespace-seperated
990 .Ar element
991 in the list,
992 .Ao Ar element Ac Ns Va _dev
993 and
994 .Ao Ar element Ac Ns Va _logfile
995 elements are assumed to exist.
996 .Ao Ar element Ac Ns Va _dev
997 must contain the
998 .Xr pflog 4
999 interface to be watched by the named
1000 .Xr pflogd 8
1001 instance.
1002 .Ao Ar element Ac Ns Va _logfile
1003 must contain the name of the logfile that will be used by the
1004 .Xr pflogd 8
1005 instance.
1006 .It Va ftpproxy_enable
1007 .Pq Vt bool
1008 Set to
1009 .Dq Li NO
1010 by default.
1011 Setting this to
1012 .Dq Li YES
1013 enables
1014 .Xr ftp-proxy 8
1015 which supports the
1016 .Xr pf 4
1017 packet filter in translating ftp connections.
1018 .It Va ftpproxy_flags
1019 .Pq Vt str
1020 Empty by default.
1021 This variable contains additional flags passed to the
1022 .Xr ftp-proxy 8
1023 program.
1024 .It Va ftpproxy_instances
1025 .Pq Vt str
1026 Empty by default.
1027 If multiple instances of
1028 .Xr ftp-proxy 8
1029 are desired at boot time,
1030 .Va ftpproxy_instances
1031 should contain a whitespace-seperated list of instance names.
1032 For each
1033 .Ar element
1034 in the list, a variable named
1035 .Ao Ar element Ac Ns Va _flags
1036 should be defined, containing the command-line flags to be passed to the
1037 .Xr ftp-proxy 8
1038 instance.
1039 .It Va pfsync_enable
1040 .Pq Vt bool
1041 Set to
1042 .Dq Li NO
1043 by default.
1044 Setting this to
1045 .Dq Li YES
1046 enables exposing
1047 .Xr pf 4
1048 state changes to other hosts over the network by means of
1049 .Xr pfsync 4 .
1050 The
1051 .Va pfsync_syncdev
1052 variable
1053 must also be set then.
1054 .It Va pfsync_syncdev
1055 .Pq Vt str
1056 Empty by default.
1057 This variable specifies the name of the network interface
1058 .Xr pfsync 4
1059 should operate through.
1060 It must be set accordingly if
1061 .Va pfsync_enable
1062 is set to
1063 .Dq Li YES .
1064 .It Va pfsync_syncpeer
1065 .Pq Vt str
1066 Empty by default.
1067 This variable is optional.
1068 By default, state change messages are sent out on the synchronisation
1069 interface using IP multicast packets.
1070 The protocol is IP protocol 240, PFSYNC, and the multicast group used is
1071 224.0.0.240.
1072 When a peer address is specified using the
1073 .Va pfsync_syncpeer
1074 option, the peer address is used as a destination for the pfsync
1075 traffic, and the traffic can then be protected using
1076 .Xr ipsec 4 .
1077 See the
1078 .Xr pfsync 4
1079 manpage for more details about using
1080 .Xr ipsec 4
1081 with
1082 .Xr pfsync 4
1083 interfaces.
1084 .It Va pfsync_ifconfig
1085 .Pq Vt str
1086 Empty by default.
1087 This variable can contain additional options to be passed to the
1088 .Xr ifconfig 8
1089 command used to set up
1090 .Xr pfsync 4 .
1091 .It Va tcp_extensions
1092 .Pq Vt bool
1093 Set to
1094 .Dq Li YES
1095 by default.
1096 Setting this to
1097 .Dq Li NO
1098 disables certain TCP options as described by
1099 .Rs
1100 .%T "RFC 1323"
1101 .Re
1102 Setting this to
1103 .Dq Li NO
1104 might help remedy such problems with connections as randomly hanging
1105 or other weird behavior.
1106 Some network devices are known
1107 to be broken with respect to these options.
1108 .It Va log_in_vain
1109 .Pq Vt int
1110 Set to 0 by default.
1111 The
1112 .Xr sysctl 8
1113 variables,
1114 .Va net.inet.tcp.log_in_vain
1115 and
1116 .Va net.inet.udp.log_in_vain ,
1117 as described in
1118 .Xr tcp 4
1119 and
1120 .Xr udp 4 ,
1121 are set to the given value.
1122 .It Va tcp_keepalive
1123 .Pq Vt bool
1124 Set to
1125 .Dq Li YES
1126 by default.
1127 Setting to
1128 .Dq Li NO
1129 will disable probing idle TCP connections to verify that the
1130 peer is still up and reachable.
1131 .It Va tcp_drop_synfin
1132 .Pq Vt bool
1133 Set to
1134 .Dq Li NO
1135 by default.
1136 Setting to
1137 .Dq Li YES
1138 will cause the kernel to ignore TCP frames that have both
1139 the SYN and FIN flags set.
1140 This prevents OS fingerprinting, but may
1141 break some legitimate applications.
1142 .It Va icmp_drop_redirect
1143 .Pq Vt bool
1144 Set to
1145 .Dq Li NO
1146 by default.
1147 Setting to
1148 .Dq Li YES
1149 will cause the kernel to ignore ICMP REDIRECT packets.
1150 Refer to
1151 .Xr icmp 4
1152 for more information.
1153 .It Va icmp_log_redirect
1154 .Pq Vt bool
1155 Set to
1156 .Dq Li NO
1157 by default.
1158 Setting to
1159 .Dq Li YES
1160 will cause the kernel to log ICMP REDIRECT packets.
1161 Note that
1162 the log messages are not rate-limited, so this option should only be used
1163 for troubleshooting networks.
1164 Refer to
1165 .Xr icmp 4
1166 for more information.
1167 .It Va icmp_bmcastecho
1168 .Pq Vt bool
1169 Set to
1170 .Dq Li YES
1171 to respond to broadcast or multicast ICMP ping packets.
1172 Refer to
1173 .Xr icmp 4
1174 for more information.
1175 .It Va ip_portrange_first
1176 .Pq Vt int
1177 If not set to
1178 .Dq Li NO ,
1179 this is the first port in the default portrange.
1180 Refer to
1181 .Xr ip 4
1182 for more information.
1183 .It Va ip_portrange_last
1184 .Pq Vt int
1185 If not set to
1186 .Dq Li NO ,
1187 this is the last port in the default portrange.
1188 Refer to
1189 .Xr ip 4
1190 for more information.
1191 .It Va network_interfaces
1192 .Pq Vt str
1193 Set to the list of network interfaces to configure on this host or
1194 .Dq Li AUTO
1195 (the default) for all current interfaces.
1196 Setting the
1197 .Va network_interfaces
1198 variable to anything other than the default is deprecated.
1199 Interfaces that the administrator wishes to store configuration for,
1200 but not start at boot should be configured with the
1201 .Dq Li NOAUTO
1202 keyword in their
1203 .Va ifconfig_ Ns Aq Ar interface
1204 variables as described below.
1205 .Pp
1206 An
1207 .Va ifconfig_ Ns Aq Ar interface
1208 variable is also assumed to exist for each value of
1209 .Ar interface .
1210 When an interface name contains any of the characters
1211 .Dq Li .-/+
1212 they are translated to
1213 .Dq Li _
1214 before lookup.
1215 The variable can contain arguments to
1216 .Xr ifconfig 8 ,
1217 as well as special case-insensitive keywords described below.
1218 Such keywords are removed before passing the value to
1219 .Xr ifconfig 8
1220 while the order of the other arguments is preserved.
1221 .Pp
1222 It is possible to add IP alias entries using
1223 .Xr ifconfig 8
1224 syntax with the address family keyword such as
1225 .Li inet .
1226 Assuming that the interface in question was
1227 .Li ed0 ,
1228 it might look something like this:
1229 .Bd -literal
1230 ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
1231 ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
1232 .Ed
1233 .Pp
1234 It also possible to configure multiple IP addresses in Classless
1235 Inter-Domain Routing
1236 .Pq CIDR
1237 address notation,
1238 whose each address component can be a range like
1239 .Li inet 192.0.2.5-23/24
1240 or
1241 .Li inet6 2001:db8:1-f::1/64 .
1242 This notation allows address and prefix length part only,
1243 not the other address modifiers.
1244 Note that the maximum number of the generated addresses from a range
1245 specification is limited to an integer value specified in
1246 .Va netif_ipexpand_max
1247 in
1248 .Nm
1249 because a small typo can unexpectedly generate a large number of addresses.
1250 The default value is
1251 .Li 2048 .
1252 It can be increased by adding the following line into
1253 .Nm :
1254 .Bd -literal
1255 netif_ipexpand_max="4096"
1256 .Ed
1257 .Pp
1258 In the case of
1259 .Li 192.0.2.5-23/24 ,
1260 the address 192.0.2.5 will be configured with the
1261 netmask /24 and the addresses 192.0.2.6 to 192.0.2.23 with
1262 the non-conflicting netmask /32 as explained in the
1263 .Xr ifconfig 8
1264 alias section.
1265 Note that this special netmask handling is only for
1266 .Li inet ,
1267 not for the other address families such as
1268 .Li inet6 .
1269 .Pp
1270 With the interface in question being
1271 .Li ed0 ,
1272 an example could look like:
1273 .Bd -literal
1274 ifconfig_ed0_alias2="inet 192.0.2.129/27"
1275 ifconfig_ed0_alias3="inet 192.0.2.1-5/28"
1276 .Ed
1277 .Pp
1278 and so on.
1279 .Pp
1280 Note that
1281 .Va ipv4_addrs_ Ns Aq Ar interface
1282 variable was supported for IPv4 CIDR address notation.
1283 It is now deprecated because the functionality was integrated into
1284 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1285 though
1286 .Va ipv4_addrs_ Ns Aq Ar interface
1287 is still supported for backward compatibility.
1288 .Pp
1289 For each
1290 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1291 entry with an address family keyword,
1292 its contents are passed to
1293 .Xr ifconfig 8 .
1294 Execution stops at the first unsuccessful access, so if
1295 something like this is present:
1296 .Bd -literal
1297 ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
1298 ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
1299 ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
1300 ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
1301 .Ed
1302 .Pp
1303 Then note that alias4 would
1304 .Em not
1305 be added since the search would
1306 stop with the missing
1307 .Dq Li alias3
1308 entry.
1309 Because of this difficult to manage behavior,
1310 there is
1311 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _aliases
1312 variable, which has the same functionality as
1313 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1314 and can have all of entries in a variable like the following:
1315 .Bd -literal
1316 ifconfig_ed0_aliases="\\
1317         inet 127.0.0.251 netmask 0xffffffff \\
1318         inet 127.0.0.252 netmask 0xffffffff \\
1319         inet 127.0.0.253 netmask 0xffffffff \\
1320         inet 127.0.0.254 netmask 0xffffffff"
1321 .Ed
1322 .Pp
1323 It also supports CIDR notation.
1324 .Pp
1325 If the
1326 .Pa /etc/start_if. Ns Aq Ar interface
1327 file is present, it is read and executed by the
1328 .Xr sh 1
1329 interpreter
1330 before configuring the interface as specified in the
1331 .Va ifconfig_ Ns Aq Ar interface
1332 and
1333 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1334 variables.
1335 .Pp
1336 If a
1337 .Va vlans_ Ns Aq Ar interface
1338 variable is set,
1339 a
1340 .Xr vlan 4
1341 interface will be created for each item in the list with the
1342 .Ar vlandev
1343 argument set to
1344 .Ar interface .
1345 If a vlan interface's name is a number,
1346 then that number is used as the vlan tag and the new vlan interface is
1347 named
1348 .Ar interface . Ns Ar tag .
1349 Otherwise,
1350 the vlan tag must be specified via a
1351 .Va vlan
1352 parameter in the
1353 .Va create_args_ Ns Aq Ar interface
1354 variable.
1355 .Pp
1356 To create a vlan device named
1357 .Li em0.101
1358 on
1359 .Li em0
1360 with the vlan tag 101 and the optional the IPv4 address 192.0.2.1/24:
1361 .Bd -literal
1362 vlans_em0="101"
1363 ifconfig_em0_101="inet 192.0.2.1/24"
1364 .Ed
1365 .Pp
1366 To create a vlan device named
1367 .Li myvlan
1368 on
1369 .Li em0
1370 with the vlan tag 102:
1371 .Bd -literal
1372 vlans_em0="myvlan"
1373 create_args_myvlan="vlan 102"
1374 .Ed
1375 .Pp
1376 If a
1377 .Va wlans_ Ns Aq Ar interface
1378 variable is set,
1379 an
1380 .Xr wlan 4
1381 interface will be created for each item in the list with the
1382 .Ar wlandev
1383 argument set to
1384 .Ar interface .
1385 Further wlan cloning arguments may be passed to the
1386 .Xr ifconfig 8
1387 .Cm create
1388 command by setting the
1389 .Va create_args_ Ns Aq Ar interface
1390 variable.
1391 One or more
1392 .Xr wlan 4
1393 devices must be created for each wireless devices as of
1394 .Fx 8.0 .
1395 Debugging flags for
1396 .Xr wlan 4
1397 devices as set by
1398 .Xr wlandebug 8
1399 may be specified with an
1400 .Va wlandebug_ Ns Aq Ar interface
1401 variable.
1402 The contents of this variable will be passed directly to
1403 .Xr wlandebug 8 .
1404 .Pp
1405 If the
1406 .Va ifconfig_ Ns Aq Ar interface
1407 contains the keyword
1408 .Dq Li NOAUTO
1409 then the interface will not be configured
1410 at boot or by
1411 .Pa /etc/pccard_ether
1412 when
1413 .Va network_interfaces
1414 is set to
1415 .Dq Li AUTO .
1416 .Pp
1417 It is possible to bring up an interface with DHCP by adding
1418 .Dq Li DHCP
1419 to the
1420 .Va ifconfig_ Ns Aq Ar interface
1421 variable.
1422 For instance, to initialize the
1423 .Li ed0
1424 device via DHCP,
1425 it is possible to use something like:
1426 .Bd -literal
1427 ifconfig_ed0="DHCP"
1428 .Ed
1429 .Pp
1430 If you want to configure your wireless interface with
1431 .Xr wpa_supplicant 8
1432 for use with WPA, EAP/LEAP or WEP, you need to add
1433 .Dq Li WPA
1434 to the
1435 .Va ifconfig_ Ns Aq Ar interface
1436 variable.
1437 .Pp
1438 On the other hand, if you want to configure your wireless interface with
1439 .Xr hostapd 8 ,
1440 you need to add
1441 .Dq Li HOSTAP
1442 to the
1443 .Va ifconfig_ Ns Aq Ar interface
1444 variable.
1445 .Xr hostapd 8
1446 will use the settings from
1447 .Pa /etc/hostapd- Ns Ao Ar interface Ac Ns .conf
1448 .Pp
1449 Finally, you can add
1450 .Xr ifconfig 8
1451 options in this variable, in addition to the
1452 .Pa /etc/start_if. Ns Aq Ar interface
1453 file.
1454 For instance, to configure an
1455 .Xr ath 4
1456 wireless device in station mode with an address obtained
1457 via DHCP, using WPA authentication and 802.11b mode, it is
1458 possible to use something like:
1459 .Bd -literal
1460 wlans_ath0="wlan0"
1461 ifconfig_wlan0="DHCP WPA mode 11b"
1462 .Ed
1463 .Pp
1464 In addition to the
1465 .Va ifconfig_ Ns Aq Ar interface
1466 form, a fallback variable
1467 .Va ifconfig_DEFAULT
1468 may be configured.
1469 It will be used for all interfaces with no
1470 .Va ifconfig_ Ns Aq Ar interface
1471 variable.
1472 This is intended to replace the no longer supported
1473 .Va pccard_ifconfig
1474 variable.
1475 .Pp
1476 It is also possible to rename an interface by doing:
1477 .Bd -literal
1478 ifconfig_ed0_name="net0"
1479 ifconfig_net0="inet 192.0.2.1 netmask 0xffffff00"
1480 .Ed
1481 .It Va ipv6_enable
1482 .Pq Vt bool
1483 This variable is deprecated.
1484 Use
1485 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1486 and
1487 .Va ipv6_activate_all_interfaces
1488 if necessary.
1489 .Pp
1490 If the variable is
1491 .Dq Li YES ,
1492 .Dq Li inet6 accept_rtadv
1493 is added to all of
1494 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1495 and the
1496 .Va ipv6_activate_all_interfaces
1497 is defined as
1498 .Dq Li YES .
1499 .It Va ipv6_prefer
1500 .Pq Vt bool
1501 This variable is deprecated.
1502 Use
1503 .Va ip6addrctl_policy
1504 instead.
1505 .Pp
1506 If the variable is
1507 .Dq Li YES ,
1508 the default address selection policy table set by
1509 .Xr ip6addrctl 8
1510 will be IPv6-preferred.
1511 .Pp
1512 If the variable is
1513 .Dq Li NO ,
1514 the default address selection policy table set by
1515 .Xr ip6addrctl 8
1516 will be IPv4-preferred.
1517 .It Va ipv6_activate_all_interfaces
1518 .Pq Vt bool
1519 This controls initial configuration on IPv6-capable
1520 interfaces with no corresponding
1521 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1522 variable.
1523 Note that it is not always necessary to set this variable to
1524 .Dq YES
1525 to use IPv6 functionality on
1526 .Fx .
1527 In most cases, just configuring
1528 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1529 variables works.
1530 .Pp
1531 If the variable is
1532 .Dq Li NO ,
1533 all interfaces which do not have a corresponding
1534 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1535 variable will be marked as
1536 .Dq Li IFDISABLED
1537 at creation.
1538 This means that all of IPv6 functionality on that interface
1539 is completely disabled to enforce a security policy.
1540 If the variable is set to
1541 .Dq YES ,
1542 the flag will be cleared on all of the interfaces.
1543 .Pp
1544 In most cases, just defining an
1545 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1546 for an IPv6-capable interface should be sufficient.
1547 However, if an interface is added dynamically
1548 .Pq by some tunneling protocols such as PPP, for example ,
1549 it is often difficult to define the variable in advance.
1550 In such a case, configuring the
1551 .Dq Li IFDISABLED
1552 flag can be disabled by setting this variable to
1553 .Dq YES .
1554 .Pp
1555 For more details of the
1556 .Dq Li IFDISABLED
1557 flag and keywords
1558 .Dq Li inet6 ifdisabled ,
1559 see
1560 .Xr ifconfig 8 .
1561 .Pp
1562 Default is
1563 .Dq Li NO .
1564 .It Va ipv6_privacy
1565 .Pq Vt bool
1566 If the variable is
1567 .Dq Li YES
1568 privacy addresses will be generated for each IPv6
1569 interface as described in RFC 4941.
1570 .It Va ipv6_network_interfaces
1571 .Pq Vt str
1572 This is the IPv6 equivalent of
1573 .Va network_interfaces .
1574 Normally manual configuration of this variable is not needed.
1575 .It Va ipv6_cpe_wanif
1576 .Pq Vt str
1577 If the variable is set to an interface name,
1578 the
1579 .Xr ifconfig 8
1580 options
1581 .Dq inet6 -no_radr accept_rtadv
1582 will be added to the specified interface automatically before evaluating
1583 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1584 and two
1585 .Xr sysctl 8
1586 variables
1587 .Va net.inet6.ip6.rfc6204w3
1588 and
1589 .Va net.inet6.ip6.no_radr
1590 will be set to 1.
1591 .Pp
1592 This means the specified interface will accept ICMPv6 Router
1593 Advertisement messages on that link and add the discovered
1594 routers into the Default Router List.
1595 While the other interfaces can still accept RA messages if the
1596 .Dq inet6 accept_rtadv
1597 option is specified, adding
1598 routes into the Default Router List will be disabled by
1599 .Dq inet6 no_radr
1600 option by default.
1601 See
1602 .Xr ifconfig 8
1603 for more details.
1604 .Pp
1605 Note that ICMPv6 Router Advertisement messages will be
1606 accepted even when
1607 .Va net.inet6.ip6.forwarding
1608 is 1
1609 .Pq packet forwarding is enabled
1610 when
1611 .Va net.inet6.ip6.rfc6204w3
1612 is set to 1.
1613 .Pp
1614 Default is
1615 .Dq Li NO .
1616 .It Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1617 .Pq Vt str
1618 IPv6 functionality on an interface should be configured by
1619 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6 ,
1620 instead of setting ifconfig parameters in
1621 .Va ifconfig_ Ns Aq Ar interface .
1622 If this variable is empty, all of IPv6 configurations on the
1623 specified interface by other variables such as
1624 .Va ipv6_prefix_ Ns Ao Ar interface Ac
1625 will be ignored.
1626 .Pp
1627 Aliases should be set by
1628 .Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
1629 with
1630 .Dq Li inet6
1631 keyword.
1632 For example:
1633 .Bd -literal
1634 ifconfig_ed0_ipv6="inet6 2001:db8:1::1 prefixlen 64"
1635 ifconfig_ed0_alias0="inet6 2001:db8:2::1 prefixlen 64"
1636 .Ed
1637 .Pp
1638 Interfaces that have an
1639 .Dq Li inet6 accept_rtadv
1640 keyword in
1641 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1642 setting will be automatically configured by SLAAC
1643 .Pq StateLess Address AutoConfiguration
1644 described in
1645 .Rs
1646 .%T "RFC 4862"
1647 .Re
1648 .Pp
1649 Note that a link-local address will be automatically configured in
1650 addition to the configured global-scope addresses because the IPv6
1651 specifications require it on each link.
1652 The address is calculated from the MAC address by using an algorithm
1653 defined in
1654 .Rs
1655 .%T "RFC 4862"
1656 .%O "Section 5.3"
1657 .Re
1658 .Pp
1659 If only a link-local address is needed on the interface,
1660 the following configuration can be used:
1661 .Bd -literal
1662 ifconfig_ed0_ipv6="inet6 auto_linklocal"
1663 .Ed
1664 .Pp
1665 A link-local address can also be configured manually.
1666 This is useful for the default router address of an IPv6 router
1667 so that it does not change when the network interface
1668 card is replaced.
1669 For example:
1670 .Bd -literal
1671 ifconfig_ed0_ipv6="inet6 fe80::1 prefixlen 64"
1672 .Ed
1673 .It Va ipv6_prefix_ Ns Aq Ar interface
1674 .Pq Vt str
1675 If one or more prefixes are defined in
1676 .Va ipv6_prefix_ Ns Aq Ar interface
1677 addresses based on each prefix and the EUI-64 interface index will be
1678 configured on that interface.
1679 Note that this variable will be ignored when
1680 .Va ifconfig_ Ns Ao Ar interface Ac Ns _ipv6
1681 is empty.
1682 .Pp
1683 For example, the following configuration
1684 .Bd -literal
1685 ipv6_prefix_ed0="2001:db8:1:0 2001:db8:2:0"
1686 .Ed
1687 .Pp
1688 is equivalent to the following:
1689 .Bd -literal
1690 ifconfig_ed0_alias0="inet6 2001:db8:1:: eui64 prefixlen 64"
1691 ifconfig_ed0_alias1="inet6 2001:db8:1:: prefixlen 64 anycast"
1692 ifconfig_ed0_alias2="inet6 2001:db8:2:: eui64 prefixlen 64"
1693 ifconfig_ed0_alias3="inet6 2001:db8:2:: prefixlen 64 anycast"
1694 .Ed
1695 .Pp
1696 These Subnet-Router anycast addresses will be added only when
1697 .Va ipv6_gateway_enable
1698 is YES.
1699 .It Va ipv6_default_interface
1700 .Pq Vt str
1701 If not set to
1702 .Dq Li NO ,
1703 this is the default output interface for scoped addresses.
1704 This works only with ipv6_gateway_enable="NO".
1705 .It Va ip6addrctl_enable
1706 .Pq Vt bool
1707 This variable is to enable configuring default address selection policy table
1708 .Pq RFC 3484 .
1709 The table can be specified in another variable
1710 .Va ip6addrctl_policy .
1711 For
1712 .Va ip6addrctl_policy
1713 the following keywords can be specified:
1714 .Dq Li ipv4_prefer ,
1715 .Dq Li ipv6_prefer ,
1716 or
1717 .Dq Li AUTO .
1718 .Pp
1719 If
1720 .Dq Li ipv4_prefer
1721 or
1722 .Dq Li ipv6_prefer
1723 is specified,
1724 .Xr ip6addrctl 8
1725 installs a pre-defined policy table described in Section 2.1
1726 .Pq IPv6-preferred
1727 or 10.3
1728 .Pq IPv4-preferred
1729 of RFC 3484.
1730 .Pp
1731 If
1732 .Dq Li AUTO
1733 is specified, it attempts to read a file
1734 .Pa /etc/ip6addrctl.conf
1735 first.
1736 If this file is found,
1737 .Xr ip6addrctl 8
1738 reads and installs it.
1739 If not found, a policy is automatically set
1740 according to
1741 .Va ipv6_activate_all_interfaces
1742 variable; if the variable is set to
1743 .Dq Li YES
1744 the IPv6-preferred one is used.
1745 Otherwise IPv4-preferred.
1746 .Pp
1747 The default value of
1748 .Va ip6addrctl_enable
1749 and
1750 .Va ip6addrctl_policy
1751 are
1752 .Dq Li YES
1753 and
1754 .Dq Li AUTO ,
1755 respectively.
1756 .It Va cloned_interfaces
1757 .Pq Vt str
1758 Set to the list of clonable network interfaces to create on this host.
1759 Further cloning arguments may be passed to the
1760 .Xr ifconfig 8
1761 .Cm create
1762 command for each interface by setting the
1763 .Va create_args_ Ns Aq Ar interface
1764 variable.
1765 If an interface name is specified with
1766 .Dq :sticky
1767 keyword,
1768 the interface will not be destroyed even when
1769 .Pa rc.d/netif
1770 script is invoked with
1771 .Dq stop
1772 argument.
1773 This is useful when reconfiguring the interface without destroying it.
1774 Entries in
1775 .Va cloned_interfaces
1776 are automatically appended to
1777 .Va network_interfaces
1778 for configuration.
1779 .It Va cloned_interfaces_sticky
1780 .Pq Vt bool
1781 This variable is to globally enable functionality of
1782 .Dq :sticky
1783 keyword in
1784 .Va cloned_interfaces
1785 for all interfaces.
1786 The default value is
1787 .Dq NO .
1788 Even if this variable is specified to
1789 .Dq YES ,
1790 .Dq :nosticky
1791 keyword can be used to override it on per interface basis.
1792 .It Va gif_interfaces
1793 .Pq Vt str
1794 This variable is deprecated in favor of
1795 .Va cloned_interfaces .
1796 Set to the list of
1797 .Xr gif 4
1798 tunnel interfaces to configure on this host.
1799 A
1800 .Va gifconfig_ Ns Aq Ar interface
1801 variable is assumed to exist for each value of
1802 .Ar interface .
1803 The value of this variable is used to configure the link layer of the
1804 tunnel according to the syntax of the
1805 .Cm tunnel
1806 option to
1807 .Xr ifconfig 8 .
1808 Additionally, this option ensures that each listed interface is created
1809 via the
1810 .Cm create
1811 option to
1812 .Xr ifconfig 8
1813 before attempting to configure it.
1814 .It Va sppp_interfaces
1815 .Pq Vt str
1816 Set to the list of
1817 .Xr sppp 4
1818 interfaces to configure on this host.
1819 A
1820 .Va spppconfig_ Ns Aq Ar interface
1821 variable is assumed to exist for each value of
1822 .Ar interface .
1823 Each interface should also be configured by a general
1824 .Va ifconfig_ Ns Aq Ar interface
1825 setting.
1826 Refer to
1827 .Xr spppcontrol 8
1828 for more information about available options.
1829 .It Va ppp_enable
1830 .Pq Vt bool
1831 If set to
1832 .Dq Li YES ,
1833 run the
1834 .Xr ppp 8
1835 daemon.
1836 .It Va ppp_profile
1837 .Pq Vt str
1838 The name of the profile to use from
1839 .Pa /etc/ppp/ppp.conf .
1840 Also used for per-profile overrides of
1841 .Va ppp_mode
1842 and
1843 .Va ppp_nat ,
1844 and
1845 .Va ppp_ Ns Ao Ar profile Ac Ns _unit .
1846 When the profile name contains any of the characters
1847 .Dq Li .-/+
1848 they are translated to
1849 .Dq Li _
1850 for the proposes of the override variable names.
1851 .It Va ppp_mode
1852 .Pq Vt str
1853 Mode in which to run the
1854 .Xr ppp 8
1855 daemon.
1856 .It Va ppp_ Ns Ao Ar profile Ac Ns _mode
1857 .Pq Vt str
1858 Overrides the global
1859 .Va ppp_mode
1860 for
1861 .Ar profile .
1862 Accepted modes are
1863 .Dq Li auto ,
1864 .Dq Li ddial ,
1865 .Dq Li direct
1866 and
1867 .Dq Li dedicated .
1868 See the manual for a full description.
1869 .It Va ppp_nat
1870 .Pq Vt bool
1871 If set to
1872 .Dq Li YES ,
1873 enables network address translation.
1874 Used in conjunction with
1875 .Va gateway_enable
1876 allows hosts on private network addresses access to the Internet using
1877 this host as a network address translating router.
1878 .It Va ppp_ Ns Ao Ar profile Ac Ns _nat
1879 .Pq Vt str
1880 Overrides the global
1881 .Va ppp_nat
1882 for
1883 .Ar profile .
1884 .It Va ppp_ Ns Ao Ar profile Ac Ns _unit
1885 .Pq Vt int
1886 Set the unit number to be used for this profile.
1887 See the manual description of
1888 .Fl unit Ns Ar N
1889 for details.
1890 .It Va ppp_user
1891 .Pq Vt str
1892 The name of the user under which
1893 .Xr ppp 8
1894 should be started.
1895 By
1896 default,
1897 .Xr ppp 8
1898 is started as
1899 .Dq Li root .
1900 .It Va rc_conf_files
1901 .Pq Vt str
1902 This option is used to specify a list of files that will override
1903 the settings in
1904 .Pa /etc/defaults/rc.conf .
1905 The files will be read in the order in which they are specified and should
1906 include the full path to the file.
1907 By default, the files specified are
1908 .Pa /etc/rc.conf
1909 and
1910 .Pa /etc/rc.conf.local
1911 .It Va zfs_enable
1912 .Pq Vt bool
1913 If set to
1914 .Dq Li YES ,
1915 .Pa /etc/rc.d/zfs
1916 will attempt to automatically mount ZFS file systems and initialize ZFS volumes
1917 (ZVOLs).
1918 .It Va gptboot_enable
1919 .Pq Vt bool
1920 If set to
1921 .Dq Li YES ,
1922 .Pa /etc/rc.d/gptboot
1923 will log if the system successfully (or not) booted from a GPT partition,
1924 which had the
1925 .Ar bootonce
1926 attribute set using
1927 .Xr gpart 8
1928 utility.
1929 .It Va gbde_autoattach_all
1930 .Pq Vt bool
1931 If set to
1932 .Dq Li YES ,
1933 .Pa /etc/rc.d/gbde
1934 will attempt to automatically initialize your .bde devices in
1935 .Pa /etc/fstab .
1936 .It Va gbde_devices
1937 .Pq Vt str
1938 List the devices that the script should try to attach,
1939 or
1940 .Dq Li AUTO .
1941 .It Va gbde_lockdir
1942 .Pq Vt str
1943 The directory where the
1944 .Xr gbde 4
1945 lockfiles are located.
1946 The default lockfile directory is
1947 .Pa /etc .
1948 .Pp
1949 The lockfile for each individual
1950 .Xr gbde 4
1951 device can be overridden by setting the variable
1952 .Va gbde_lock_ Ns Aq Ar device ,
1953 where
1954 .Ar device
1955 is the encrypted device without the
1956 .Dq Pa /dev/
1957 and
1958 .Dq Pa .bde
1959 parts.
1960 .It Va gbde_attach_attempts
1961 .Pq Vt int
1962 Number of times to attempt attaching to a
1963 .Xr gbde 4
1964 device, i.e., how many times the user is asked for the pass-phrase.
1965 Default is 3.
1966 .It Va geli_devices
1967 .Pq Vt str
1968 List of devices to automatically attach on boot.
1969 Note that .eli devices from
1970 .Pa /etc/fstab
1971 are automatically appended to this list.
1972 .It Va geli_tries
1973 .Pq Vt int
1974 Number of times user is asked for the pass-phrase.
1975 If empty, it will be taken from
1976 .Va kern.geom.eli.tries
1977 sysctl variable.
1978 .It Va geli_default_flags
1979 .Pq Vt str
1980 Default flags to use by
1981 .Xr geli 8
1982 when configuring disk encryption.
1983 Flags can be configured for every device separately by defining
1984 .Va geli_ Ns Ao Ar device Ac Ns Va _flags
1985 variable.
1986 .It Va geli_autodetach
1987 .Pq Vt str
1988 Specifies if GELI devices should be marked for detach on last close after
1989 file systems are mounted.
1990 Default is
1991 .Dq Li YES .
1992 This can be changed for every device separately by defining
1993 .Va geli_ Ns Ao Ar device Ac Ns Va _autodetach
1994 variable.
1995 .It Va root_rw_mount
1996 .Pq Vt bool
1997 Set to
1998 .Dq Li YES
1999 by default.
2000 After the file systems are checked at boot time, the root file system
2001 is remounted as read-write if this is set to
2002 .Dq Li YES .
2003 Diskless systems that mount their root file system from a read-only remote
2004 NFS share should set this to
2005 .Dq Li NO
2006 in their
2007 .Pa rc.conf .
2008 .It Va fsck_y_enable
2009 .Pq Vt bool
2010 If set to
2011 .Dq Li YES ,
2012 .Xr fsck 8
2013 will be run with the
2014 .Fl y
2015 flag if the initial preen
2016 of the file systems fails.
2017 .It Va background_fsck
2018 .Pq Vt bool
2019 If set to
2020 .Dq Li YES ,
2021 the system will attempt to run
2022 .Xr fsck 8
2023 in the background where possible.
2024 .It Va background_fsck_delay
2025 .Pq Vt int
2026 The amount of time in seconds to sleep before starting a background
2027 .Xr fsck 8 .
2028 It defaults to sixty seconds to allow large applications such as
2029 the X server to start before disk I/O bandwidth is monopolized by
2030 .Xr fsck 8 .
2031 If set to a negative number, the background file system check will be
2032 delayed indefinitely to allow the administrator to run it at a more
2033 convenient time.
2034 For example it may be run from
2035 .Xr cron 8
2036 by adding a line like
2037 .Pp
2038 .Dl "0 4 * * * root /etc/rc.d/bgfsck forcestart"
2039 .Pp
2040 to
2041 .Pa /etc/crontab .
2042 .It Va netfs_types
2043 .Pq Vt str
2044 List of file system types that are network-based.
2045 This list should generally not be modified by end users.
2046 Use
2047 .Va extra_netfs_types
2048 instead.
2049 .It Va extra_netfs_types
2050 .Pq Vt str
2051 If set to something other than
2052 .Dq Li NO
2053 (the default),
2054 this variable extends the list of file system types
2055 for which automatic mounting at startup by
2056 .Xr rc 8
2057 should be delayed until the network is initialized.
2058 It should contain
2059 a whitespace-separated list of network file system descriptor pairs,
2060 each consisting of a file system type as passed to
2061 .Xr mount 8
2062 and a human-readable, one-word description,
2063 joined with a colon
2064 .Pq Ql \&: .
2065 Extending the default list in this way is only necessary
2066 when third party file system types are used.
2067 .It Va syslogd_enable
2068 .Pq Vt bool
2069 If set to
2070 .Dq Li YES ,
2071 run the
2072 .Xr syslogd 8
2073 daemon.
2074 .It Va syslogd_program
2075 .Pq Vt str
2076 Path to
2077 .Xr syslogd 8
2078 (default
2079 .Pa /usr/sbin/syslogd ) .
2080 .It Va syslogd_flags
2081 .Pq Vt str
2082 If
2083 .Va syslogd_enable
2084 is set to
2085 .Dq Li YES ,
2086 these are the flags to pass to
2087 .Xr syslogd 8 .
2088 .It Va inetd_enable
2089 .Pq Vt bool
2090 If set to
2091 .Dq Li YES ,
2092 run the
2093 .Xr inetd 8
2094 daemon.
2095 .It Va inetd_program
2096 .Pq Vt str
2097 Path to
2098 .Xr inetd 8
2099 (default
2100 .Pa /usr/sbin/inetd ) .
2101 .It Va inetd_flags
2102 .Pq Vt str
2103 If
2104 .Va inetd_enable
2105 is set to
2106 .Dq Li YES ,
2107 these are the flags to pass to
2108 .Xr inetd 8 .
2109 .It Va hastd_enable
2110 .Pq Vt bool
2111 If set to
2112 .Dq Li YES ,
2113 run the
2114 .Xr hastd 8
2115 daemon.
2116 .It Va hastd_program
2117 .Pq Vt str
2118 Path to
2119 .Xr hastd 8
2120 (default
2121 .Pa /sbin/hastd ) .
2122 .It Va hastd_flags
2123 .Pq Vt str
2124 If
2125 .Va hastd_enable
2126 is set to
2127 .Dq Li YES ,
2128 these are the flags to pass to
2129 .Xr hastd 8 .
2130 .It Va local_unbound_enable
2131 .Pq Vt bool
2132 If set to
2133 .Dq Li YES ,
2134 run the
2135 .Xr unbound 8
2136 daemon as a local caching resolver.
2137 .It Va kdc_enable
2138 .Pq Vt bool
2139 Set to
2140 .Dq Li YES
2141 to start a Kerberos 5 authentication server
2142 at boot time.
2143 .It Va kdc_program
2144 .Pq Vt str
2145 If
2146 .Va kdc_enable
2147 is set to
2148 .Dq Li YES
2149 this is the path to Kerberos 5 Authentication Server.
2150 .It Va kdc_flags
2151 .Pq Vt str
2152 Empty by default.
2153 This variable contains additional flags to be passed to the Kerberos 5
2154 authentication server.
2155 .It Va kadmind_enable
2156 .Pq Vt bool
2157 Set to
2158 .Dq Li YES
2159 to start
2160 .Xr kadmind 8 ,
2161 the Kerberos 5 Administration Daemon; set to
2162 .Dq Li NO
2163 on a slave server.
2164 .It Va kadmind_program
2165 .Pq Vt str
2166 If
2167 .Va kadmind_enable
2168 is set to
2169 .Dq Li YES
2170 this is the path to Kerberos 5 Administration Daemon.
2171 .It Va kpasswdd_enable
2172 .Pq Vt bool
2173 Set to
2174 .Dq Li YES
2175 to start
2176 .Xr kpasswdd 8 ,
2177 the Kerberos 5 Password-Changing Daemon; set to
2178 .Dq Li NO
2179 on a slave server.
2180 .It Va kpasswdd_program
2181 .Pq Vt str
2182 If
2183 .Va kpasswdd_enable
2184 is set to
2185 .Dq Li YES
2186 this is the path to Kerberos 5 Password-Changing Daemon.
2187 .It Va kfd_enable
2188 .Pq Vt bool
2189 Set to
2190 .Dq Li YES
2191 to start
2192 .Xr kfd 8 ,
2193 the Kerberos 5 ticket forwarding daemon, at the boot time.
2194 .It Va kfd_program
2195 .Pq Vt str
2196 Path to
2197 .Xr kfd 8
2198 (default
2199 .Pa /usr/libexec/kfd ) .
2200 .It Va rwhod_enable
2201 .Pq Vt bool
2202 If set to
2203 .Dq Li YES ,
2204 run the
2205 .Xr rwhod 8
2206 daemon at boot time.
2207 .It Va rwhod_flags
2208 .Pq Vt str
2209 If
2210 .Va rwhod_enable
2211 is set to
2212 .Dq Li YES ,
2213 these are the flags to pass to it.
2214 .It Va amd_enable
2215 .Pq Vt bool
2216 If set to
2217 .Dq Li YES ,
2218 run the
2219 .Xr amd 8
2220 daemon at boot time.
2221 .It Va amd_flags
2222 .Pq Vt str
2223 If
2224 .Va amd_enable
2225 is set to
2226 .Dq Li YES ,
2227 these are the flags to pass to it.
2228 See the
2229 .Xr amd 8
2230 manpage for more information.
2231 .It Va amd_map_program
2232 .Pq Vt str
2233 If set,
2234 the specified program is run to get the list of
2235 .Xr amd 8
2236 maps.
2237 For example, if the
2238 .Xr amd 8
2239 maps are stored in NIS, one can set this to
2240 run
2241 .Xr ypcat 1
2242 to get a list of
2243 .Xr amd 8
2244 maps from the
2245 .Pa amd.master
2246 NIS map.
2247 .It Va update_motd
2248 .Pq Vt bool
2249 If set to
2250 .Dq Li YES ,
2251 .Pa /etc/motd
2252 will be updated at boot time to reflect the kernel release
2253 being run.
2254 If set to
2255 .Dq Li NO ,
2256 .Pa /etc/motd
2257 will not be updated.
2258 .It Va nfs_client_enable
2259 .Pq Vt bool
2260 If set to
2261 .Dq Li YES ,
2262 run the NFS client daemons at boot time.
2263 .It Va nfs_access_cache
2264 .Pq Vt int
2265 If
2266 .Va nfs_client_enable
2267 is set to
2268 .Dq Li YES ,
2269 this can be set to
2270 .Dq Li 0
2271 to disable NFS ACCESS RPC caching, or to the number of seconds for which
2272 NFS ACCESS
2273 results should be cached.
2274 A value of 2-10 seconds will substantially reduce network
2275 traffic for many NFS operations.
2276 .It Va nfs_server_enable
2277 .Pq Vt bool
2278 If set to
2279 .Dq Li YES ,
2280 run the NFS server daemons at boot time.
2281 .It Va nfs_server_flags
2282 .Pq Vt str
2283 If
2284 .Va nfs_server_enable
2285 is set to
2286 .Dq Li YES ,
2287 these are the flags to pass to the
2288 .Xr nfsd 8
2289 daemon.
2290 .It Va nfsv4_server_enable
2291 .Pq Vt bool
2292 If
2293 .Va nfs_server_enable
2294 is set to
2295 .Dq Li YES
2296 and
2297 .Va nfsv4_server_enable
2298 are set to
2299 .Dq Li YES ,
2300 enable the server for NFSv4 as well as NFSv2 and NFSv3.
2301 .It Va nfsuserd_enable
2302 .Pq Vt bool
2303 If
2304 .Va nfsuserd_enable
2305 is set to
2306 .Dq Li YES ,
2307 run the nfsuserd daemon, which is needed for NFSv4 in order
2308 to map between user/group names vs uid/gid numbers.
2309 If
2310 .Va nfsv4_server_enable
2311 is set to
2312 .Dq Li YES ,
2313 this will be forced enabled.
2314 .It Va nfsuserd_flags
2315 .Pq Vt str
2316 If
2317 .Va nfsuserd_enable
2318 is set to
2319 .Dq Li YES ,
2320 these are the flags to pass to the
2321 .Xr nfsuserd 8
2322 daemon.
2323 .It Va nfscbd_enable
2324 .Pq Vt bool
2325 If
2326 .Va nfscbd_enable
2327 is set to
2328 .Dq Li YES ,
2329 run the nfscbd daemon, which enables callbacks/delegations for the NFSv4 client.
2330 .It Va nfscbd_flags
2331 .Pq Vt str
2332 If
2333 .Va nfscbd_enable
2334 is set to
2335 .Dq Li YES ,
2336 these are the flags to pass to the
2337 .Xr nfscbd 8
2338 daemon.
2339 .It Va mountd_enable
2340 .Pq Vt bool
2341 If set to
2342 .Dq Li YES ,
2343 and no
2344 .Va nfs_server_enable
2345 is set, start
2346 .Xr mountd 8 ,
2347 but not
2348 .Xr nfsd 8
2349 daemon.
2350 It is commonly needed to run CFS without real NFS used.
2351 .It Va mountd_flags
2352 .Pq Vt str
2353 If
2354 .Va mountd_enable
2355 is set to
2356 .Dq Li YES ,
2357 these are the flags to pass to the
2358 .Xr mountd 8
2359 daemon.
2360 .It Va weak_mountd_authentication
2361 .Pq Vt bool
2362 If set to
2363 .Dq Li YES ,
2364 allow services like PCNFSD to make non-privileged mount
2365 requests.
2366 .It Va nfs_reserved_port_only
2367 .Pq Vt bool
2368 If set to
2369 .Dq Li YES ,
2370 provide NFS services only on a secure port.
2371 .It Va nfs_bufpackets
2372 .Pq Vt int
2373 If set to a number, indicates the number of packets worth of
2374 socket buffer space to reserve on an NFS client.
2375 The kernel default is typically 4.
2376 Using a higher number may be
2377 useful on gigabit networks to improve performance.
2378 The minimum value is
2379 2 and the maximum is 64.
2380 .It Va rpc_lockd_enable
2381 .Pq Vt bool
2382 If set to
2383 .Dq Li YES
2384 and also an NFS server or client, run
2385 .Xr rpc.lockd 8
2386 at boot time.
2387 .It Va rpc_lockd_flags
2388 .Pq Vt str
2389 If
2390 .Va rpc_lockd_enable
2391 is set to
2392 .Dq Li YES ,
2393 these are the flags to pass to the
2394 .Xr rpc.lockd 8
2395 daemon.
2396 .It Va rpc_statd_enable
2397 .Pq Vt bool
2398 If set to
2399 .Dq Li YES
2400 and also an NFS server or client, run
2401 .Xr rpc.statd 8
2402 at boot time.
2403 .It Va rpc_statd_flags
2404 .Pq Vt str
2405 If
2406 .Va rpc_statd_enable
2407 is set to
2408 .Dq Li YES ,
2409 these are the flags to pass to the
2410 .Xr rpc.statd 8
2411 daemon.
2412 .It Va rpcbind_program
2413 .Pq Vt str
2414 Path to
2415 .Xr rpcbind 8
2416 (default
2417 .Pa /usr/sbin/rpcbind ) .
2418 .It Va rpcbind_enable
2419 .Pq Vt bool
2420 If set to
2421 .Dq Li YES ,
2422 run the
2423 .Xr rpcbind 8
2424 service at boot time.
2425 .It Va rpcbind_flags
2426 .Pq Vt str
2427 If
2428 .Va rpcbind_enable
2429 is set to
2430 .Dq Li YES ,
2431 these are the flags to pass to the
2432 .Xr rpcbind 8
2433 daemon.
2434 .It Va keyserv_enable
2435 .Pq Vt bool
2436 If set to
2437 .Dq Li YES ,
2438 run the
2439 .Xr keyserv 8
2440 daemon on boot for running Secure RPC.
2441 .It Va keyserv_flags
2442 .Pq Vt str
2443 If
2444 .Va keyserv_enable
2445 is set to
2446 .Dq Li YES ,
2447 these are the flags to pass to
2448 .Xr keyserv 8
2449 daemon.
2450 .It Va pppoed_enable
2451 .Pq Vt bool
2452 If set to
2453 .Dq Li YES ,
2454 run the
2455 .Xr pppoed 8
2456 daemon at boot time to provide PPP over Ethernet services.
2457 .It Va pppoed_ Ns Aq Ar provider
2458 .Pq Vt str
2459 .Xr pppoed 8
2460 listens to requests to this
2461 .Ar provider
2462 and ultimately runs
2463 .Xr ppp 8
2464 with a
2465 .Ar system
2466 argument of the same name.
2467 .It Va pppoed_flags
2468 .Pq Vt str
2469 Additional flags to pass to
2470 .Xr pppoed 8 .
2471 .It Va pppoed_interface
2472 .Pq Vt str
2473 The network interface to run
2474 .Xr pppoed 8
2475 on.
2476 This is mandatory when
2477 .Va pppoed_enable
2478 is set to
2479 .Dq Li YES .
2480 .It Va timed_enable
2481 .Pq Vt bool
2482 If set to
2483 .Dq Li YES ,
2484 run the
2485 .Xr timed 8
2486 service at boot time.
2487 This command is intended for networks of
2488 machines where a consistent
2489 .Dq "network time"
2490 for all hosts must be established.
2491 This is often useful in large NFS
2492 environments where time stamps on files are expected to be consistent
2493 network-wide.
2494 .It Va timed_flags
2495 .Pq Vt str
2496 If
2497 .Va timed_enable
2498 is set to
2499 .Dq Li YES ,
2500 these are the flags to pass to the
2501 .Xr timed 8
2502 service.
2503 .It Va ntpdate_enable
2504 .Pq Vt bool
2505 If set to
2506 .Dq Li YES ,
2507 run
2508 .Xr ntpdate 8
2509 at system startup.
2510 This command is intended to
2511 synchronize the system clock only
2512 .Em once
2513 from some standard reference.
2514 .It Va ntpdate_config
2515 .Pq Vt str
2516 Configuration file for
2517 .Xr ntpdate 8 .
2518 Default
2519 .Pa /etc/ntp.conf .
2520 .It Va ntpdate_hosts
2521 .Pq Vt str
2522 A whitespace-separated list of NTP servers to synchronize with at startup.
2523 The default is to use the servers listed in
2524 .Va ntpdate_config ,
2525 if that file exists.
2526 .It Va ntpdate_program
2527 .Pq Vt str
2528 Path to
2529 .Xr ntpdate 8
2530 (default
2531 .Pa /usr/sbin/ntpdate ) .
2532 .It Va ntpdate_flags
2533 .Pq Vt str
2534 If
2535 .Va ntpdate_enable
2536 is set to
2537 .Dq Li YES ,
2538 these are the flags to pass to the
2539 .Xr ntpdate 8
2540 command (typically a hostname).
2541 .It Va ntpd_enable
2542 .Pq Vt bool
2543 If set to
2544 .Dq Li YES ,
2545 run the
2546 .Xr ntpd 8
2547 command at boot time.
2548 .It Va ntpd_program
2549 .Pq Vt str
2550 Path to
2551 .Xr ntpd 8
2552 (default
2553 .Pa /usr/sbin/ntpd ) .
2554 .It Va ntpd_config
2555 .Pq Vt str
2556 Path to
2557 .Xr ntpd 8
2558 configuration file.
2559 Default
2560 .Pa /etc/ntp.conf .
2561 .It Va ntpd_flags
2562 .Pq Vt str
2563 If
2564 .Va ntpd_enable
2565 is set to
2566 .Dq Li YES ,
2567 these are the flags to pass to the
2568 .Xr ntpd 8
2569 daemon.
2570 .It Va ntpd_sync_on_start
2571 .Pq Vt bool
2572 If set to
2573 .Dq Li YES ,
2574 .Xr ntpd 8
2575 is run with the
2576 .Fl g
2577 flag, which syncs the system's clock on startup.
2578 See
2579 .Xr ntpd 8
2580 for more information regarding the
2581 .Fl g
2582 option.
2583 This is a preferred alternative to using
2584 .Xr ntpdate 8
2585 or specifying the
2586 .Va ntpdate_enable
2587 variable.
2588 .It Va nis_client_enable
2589 .Pq Vt bool
2590 If set to
2591 .Dq Li YES ,
2592 run the
2593 .Xr ypbind 8
2594 service at system boot time.
2595 .It Va nis_client_flags
2596 .Pq Vt str
2597 If
2598 .Va nis_client_enable
2599 is set to
2600 .Dq Li YES ,
2601 these are the flags to pass to the
2602 .Xr ypbind 8
2603 service.
2604 .It Va nis_ypldap_enable
2605 .Pq Vt bool
2606 If set to
2607 .Dq Li YES ,
2608 run the
2609 .Xr ypldap 8
2610 daemon at system boot time.
2611 .It Va nis_ypldap_flags
2612 .Pq Vt str
2613 If
2614 .Va nis.ypldap_enable
2615 is set to
2616 .Dq Li YES ,
2617 these are the flags to pass to the
2618 .Xr ypldap 8
2619 daemon.
2620 .It Va nis_ypset_enable
2621 .Pq Vt bool
2622 If set to
2623 .Dq Li YES ,
2624 run the
2625 .Xr ypset 8
2626 daemon at system boot time.
2627 .It Va nis_ypset_flags
2628 .Pq Vt str
2629 If
2630 .Va nis_ypset_enable
2631 is set to
2632 .Dq Li YES ,
2633 these are the flags to pass to the
2634 .Xr ypset 8
2635 daemon.
2636 .It Va nis_server_enable
2637 .Pq Vt bool
2638 If set to
2639 .Dq Li YES ,
2640 run the
2641 .Xr ypserv 8
2642 daemon at system boot time.
2643 .It Va nis_server_flags
2644 .Pq Vt str
2645 If
2646 .Va nis_server_enable
2647 is set to
2648 .Dq Li YES ,
2649 these are the flags to pass to the
2650 .Xr ypserv 8
2651 daemon.
2652 .It Va nis_ypxfrd_enable
2653 .Pq Vt bool
2654 If set to
2655 .Dq Li YES ,
2656 run the
2657 .Xr rpc.ypxfrd 8
2658 daemon at system boot time.
2659 .It Va nis_ypxfrd_flags
2660 .Pq Vt str
2661 If
2662 .Va nis_ypxfrd_enable
2663 is set to
2664 .Dq Li YES ,
2665 these are the flags to pass to the
2666 .Xr rpc.ypxfrd 8
2667 daemon.
2668 .It Va nis_yppasswdd_enable
2669 .Pq Vt bool
2670 If set to
2671 .Dq Li YES ,
2672 run the
2673 .Xr rpc.yppasswdd 8
2674 daemon at system boot time.
2675 .It Va nis_yppasswdd_flags
2676 .Pq Vt str
2677 If
2678 .Va nis_yppasswdd_enable
2679 is set to
2680 .Dq Li YES ,
2681 these are the flags to pass to the
2682 .Xr rpc.yppasswdd 8
2683 daemon.
2684 .It Va rpc_ypupdated_enable
2685 .Pq Vt bool
2686 If set to
2687 .Dq Li YES ,
2688 run the
2689 .Nm rpc.ypupdated
2690 daemon at system boot time.
2691 .It Va bsnmpd_enable
2692 .Pq Vt bool
2693 If set to
2694 .Dq Li YES ,
2695 run the
2696 .Xr bsnmpd 1
2697 daemon at system boot time.
2698 Be sure to understand the security implications of running SNMP daemon
2699 on your host.
2700 .It Va bsnmpd_flags
2701 .Pq Vt str
2702 If
2703 .Va bsnmpd_enable
2704 is set to
2705 .Dq Li YES ,
2706 these are the flags to pass to the
2707 .Xr bsnmpd 1
2708 daemon.
2709 .It Va defaultrouter
2710 .Pq Vt str
2711 If not set to
2712 .Dq Li NO ,
2713 create a default route to this host name or IP address
2714 (use an IP address if this router is also required to get to the
2715 name server!).
2716 .It Va ipv6_defaultrouter
2717 .Pq Vt str
2718 The IPv6 equivalent of
2719 .Va defaultrouter .
2720 .It Va static_arp_pairs
2721 .Pq Vt str
2722 Set to the list of static ARP pairs that are to be added at system
2723 boot time.
2724 For each whitespace separated
2725 .Ar element
2726 in the value, a
2727 .Va static_arp_ Ns Aq Ar element
2728 variable is assumed to exist whose contents will later be passed to a
2729 .Dq Nm arp Cm -S
2730 operation.
2731 For example
2732 .Bd -literal
2733 static_arp_pairs="gw"
2734 static_arp_gw="192.168.1.1 00:01:02:03:04:05"
2735 .Ed
2736 .It Va static_ndp_pairs
2737 .Pq Vt str
2738 Set to the list of static NDP pairs that are to be added at system
2739 boot time.
2740 For each whitespace separated
2741 .Ar element
2742 in the value, a
2743 .Va static_ndp_ Ns Aq Ar element
2744 variable is assumed to exist whose contents will later be passed to a
2745 .Dq Nm ndp Cm -s
2746 operation.
2747 For example
2748 .Bd -literal
2749 static_ndp_pairs="gw"
2750 static_ndp_gw="2001:db8:3::1 00:01:02:03:04:05"
2751 .Ed
2752 .It Va static_routes
2753 .Pq Vt str
2754 Set to the list of static routes that are to be added at system
2755 boot time.
2756 If not set to
2757 .Dq Li NO
2758 then for each whitespace separated
2759 .Ar element
2760 in the value, a
2761 .Va route_ Ns Aq Ar element
2762 variable is assumed to exist
2763 whose contents will later be passed to a
2764 .Dq Nm route Cm add
2765 operation.
2766 For example:
2767 .Bd -literal
2768 static_routes="ext mcast:gif0 gif0local:gif0"
2769 route_ext="-net 10.0.0.0/24 -gateway 192.168.0.1"
2770 route_mcast="-net 224.0.0.0/4 -iface gif0"
2771 route_gif0local="-host 169.254.1.1 -iface lo0"
2772 .Ed
2773 .Pp
2774 When an
2775 .Ar element
2776 is in the form of
2777 .Li name:ifname ,
2778 the route is specific to the interface
2779 .Li ifname .
2780 .It Va ipv6_static_routes
2781 .Pq Vt str
2782 The IPv6 equivalent of
2783 .Va static_routes .
2784 If not set to
2785 .Dq Li NO
2786 then for each whitespace separated
2787 .Ar element
2788 in the value, a
2789 .Va ipv6_route_ Ns Aq Ar element
2790 variable is assumed to exist
2791 whose contents will later be passed to a
2792 .Dq Nm route Cm add Fl inet6
2793 operation.
2794 .It Va gateway_enable
2795 .Pq Vt bool
2796 If set to
2797 .Dq Li YES ,
2798 configure host to act as an IP router, e.g.\& to forward packets
2799 between interfaces.
2800 .It Va ipv6_gateway_enable
2801 .Pq Vt bool
2802 The IPv6 equivalent of
2803 .Va gateway_enable .
2804 .It Va routed_enable
2805 .Pq Vt bool
2806 If set to
2807 .Dq Li YES ,
2808 run a routing daemon of some sort, based on the
2809 settings of
2810 .Va routed_program
2811 and
2812 .Va routed_flags .
2813 .It Va route6d_enable
2814 .Pq Vt bool
2815 The IPv6 equivalent of
2816 .Va routed_enable .
2817 If set to
2818 .Dq Li YES ,
2819 run a routing daemon of some sort, based on the
2820 settings of
2821 .Va route6d_program
2822 and
2823 .Va route6d_flags .
2824 .It Va routed_program
2825 .Pq Vt str
2826 If
2827 .Va routed_enable
2828 is set to
2829 .Dq Li YES ,
2830 this is the name of the routing daemon to use.
2831 .It Va route6d_program
2832 .Pq Vt str
2833 The IPv6 equivalent of
2834 .Va routed_program .
2835 .It Va routed_flags
2836 .Pq Vt str
2837 If
2838 .Va routed_enable
2839 is set to
2840 .Dq Li YES ,
2841 these are the flags to pass to the routing daemon.
2842 .It Va route6d_flags
2843 .Pq Vt str
2844 The IPv6 equivalent of
2845 .Va routed_flags .
2846 .It Va rtadvd_enable
2847 .Pq Vt bool
2848 If set to
2849 .Dq Li YES ,
2850 run the
2851 .Xr rtadvd 8
2852 daemon at boot time.
2853 The
2854 .Xr rtadvd 8
2855 utility sends ICMPv6 Router Advertisement messages to
2856 the interfaces specified in
2857 .Va rtadvd_interfaces .
2858 This should only be enabled with great care.
2859 You may want to fine-tune
2860 .Xr rtadvd.conf 5 .
2861 .It Va rtadvd_interfaces
2862 .Pq Vt str
2863 If
2864 .Va rtadvd_enable
2865 is set to
2866 .Dq Li YES
2867 this is the list of interfaces to use.
2868 .It Va arpproxy_all
2869 .Pq Vt bool
2870 If set to
2871 .Dq Li YES ,
2872 enable global proxy ARP.
2873 .It Va forward_sourceroute
2874 .Pq Vt bool
2875 If set to
2876 .Dq Li YES
2877 and
2878 .Va gateway_enable
2879 is also set to
2880 .Dq Li YES ,
2881 source-routed packets are forwarded.
2882 .It Va accept_sourceroute
2883 .Pq Vt bool
2884 If set to
2885 .Dq Li YES ,
2886 the system will accept source-routed packets directed at it.
2887 .It Va rarpd_enable
2888 .Pq Vt bool
2889 If set to
2890 .Dq Li YES ,
2891 run the
2892 .Xr rarpd 8
2893 daemon at system boot time.
2894 .It Va rarpd_flags
2895 .Pq Vt str
2896 If
2897 .Va rarpd_enable
2898 is set to
2899 .Dq Li YES ,
2900 these are the flags to pass to the
2901 .Xr rarpd 8
2902 daemon.
2903 .It Va bootparamd_enable
2904 .Pq Vt bool
2905 If set to
2906 .Dq Li YES ,
2907 run the
2908 .Xr bootparamd 8
2909 daemon at system boot time.
2910 .It Va bootparamd_flags
2911 .Pq Vt str
2912 If
2913 .Va bootparamd_enable
2914 is set to
2915 .Dq Li YES ,
2916 these are the flags to pass to the
2917 .Xr bootparamd 8
2918 daemon.
2919 .It Va stf_interface_ipv4addr
2920 .Pq Vt str
2921 If not set to
2922 .Dq Li NO ,
2923 this is the local IPv4 address for 6to4 (IPv6 over IPv4 tunneling
2924 interface).
2925 Specify this entry to enable the 6to4 interface.
2926 .It Va stf_interface_ipv4plen
2927 .Pq Vt int
2928 Prefix length for 6to4 IPv4 addresses, to limit peer address range.
2929 An effective value is 0-31.
2930 .It Va stf_interface_ipv6_ifid
2931 .Pq Vt str
2932 IPv6 interface ID for
2933 .Xr stf 4 .
2934 This can be set to
2935 .Dq Li AUTO .
2936 .It Va stf_interface_ipv6_slaid
2937 .Pq Vt str
2938 IPv6 Site Level Aggregator for
2939 .Xr stf 4 .
2940 .It Va ipv6_ipv4mapping
2941 .Pq Vt bool
2942 If set to
2943 .Dq Li YES
2944 this enables IPv4 mapped IPv6 address communication (like
2945 .Li ::ffff:a.b.c.d ) .
2946 .It Va rtsold_enable
2947 .Pq Vt bool
2948 Set to
2949 .Dq Li YES
2950 to enable the
2951 .Xr rtsold 8
2952 daemon to send ICMPv6 Router Solicitation messages.
2953 .It Va rtsold_flags
2954 .Pq Vt str
2955 If
2956 .Va rtsold_enable
2957 is set to
2958 .Dq Li YES ,
2959 these are the flags to pass to
2960 .Xr rtsold 8 .
2961 .It Va rtsol_flags
2962 .Pq Vt str
2963 For interfaces configured with the
2964 .Dq Li inet6 accept_rtadv
2965 keyword, these are the flags to pass to
2966 .Xr rtsol 8 .
2967 .Pp
2968 Note that
2969 .Va rtsold_enable
2970 is mutually exclusive to
2971 .Va rtsol_flags ;
2972 .Va rtsold_enable
2973 takes precedence.
2974 .It Va keybell
2975 .Pq Vt str
2976 The keyboard bell sound.
2977 Set to
2978 .Dq Li normal ,
2979 .Dq Li visual ,
2980 .Dq Li off ,
2981 or
2982 .Dq Li NO
2983 if the default behavior is desired.
2984 For details, refer to the
2985 .Xr kbdcontrol 1
2986 manpage.
2987 .It Va keyboard
2988 .Pq Vt str
2989 If set to a non-null string, the virtual console's keyboard input is
2990 set to this device.
2991 .It Va keymap
2992 .Pq Vt str
2993 If set to
2994 .Dq Li NO ,
2995 no keymap is installed, otherwise the value is used to install
2996 the keymap file found in
2997 .Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
2998 (if using
2999 .Xr syscons 4 ) or
3000 .Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
3001 (if using
3002 .Xr vt 4 ) .
3003 .It Va keyrate
3004 .Pq Vt str
3005 The keyboard repeat speed.
3006 Set to
3007 .Dq Li slow ,
3008 .Dq Li normal ,
3009 .Dq Li fast ,
3010 or
3011 .Dq Li NO
3012 if the default behavior is desired.
3013 .It Va keychange
3014 .Pq Vt str
3015 If not set to
3016 .Dq Li NO ,
3017 attempt to program the function keys with the value.
3018 The value should
3019 be a single string of the form:
3020 .Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
3021 .It Va cursor
3022 .Pq Vt str
3023 Can be set to the value of
3024 .Dq Li normal ,
3025 .Dq Li blink ,
3026 .Dq Li destructive ,
3027 or
3028 .Dq Li NO
3029 to set the cursor behavior explicitly or choose the default behavior.
3030 .It Va scrnmap
3031 .Pq Vt str
3032 If set to
3033 .Dq Li NO ,
3034 no screen map is installed, otherwise the value is used to install
3035 the screen map file in
3036 .Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
3037 This parameter is ignored when using
3038 .Xr vt 4
3039 as the console driver.
3040 .It Va font8x16
3041 .Pq Vt str
3042 If set to
3043 .Dq Li NO ,
3044 the default 8x16 font value is used for screen size requests, otherwise
3045 the value in
3046 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3047 or
3048 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3049 is used (depending on the console driver being used).
3050 .It Va font8x14
3051 .Pq Vt str
3052 If set to
3053 .Dq Li NO ,
3054 the default 8x14 font value is used for screen size requests, otherwise
3055 the value in
3056 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3057 or
3058 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3059 is used (depending on the console driver being used).
3060 .It Va font8x8
3061 .Pq Vt str
3062 If set to
3063 .Dq Li NO ,
3064 the default 8x8 font value is used for screen size requests, otherwise
3065 the value in
3066 .Pa /usr/share/syscons/fonts/ Ns Aq Ar value
3067 or
3068 .Pa /usr/share/vt/fonts/ Ns Aq Ar value
3069 is used (depending on the console driver being used).
3070 .It Va blanktime
3071 .Pq Vt int
3072 If set to
3073 .Dq Li NO ,
3074 the default screen blanking interval is used, otherwise it is set
3075 to
3076 .Ar value
3077 seconds.
3078 .It Va saver
3079 .Pq Vt str
3080 If not set to
3081 .Dq Li NO ,
3082 this is the actual screen saver to use
3083 .Li ( blank , snake , daemon ,
3084 etc).
3085 .It Va moused_nondefault_enable
3086 .Pq Vt str
3087 If set to
3088 .Dq Li NO ,
3089 the mouse device specified on
3090 the command line is not automatically treated as enabled by the
3091 .Pa /etc/rc.d/moused
3092 script.
3093 Having this variable set to
3094 .Dq Li YES
3095 allows a
3096 .Xr usb 4
3097 mouse,
3098 for example,
3099 to be enabled as soon as it is plugged in.
3100 .It Va moused_enable
3101 .Pq Vt str
3102 If set to
3103 .Dq Li YES ,
3104 the
3105 .Xr moused 8
3106 daemon is started for doing cut/paste selection on the console.
3107 .It Va moused_type
3108 .Pq Vt str
3109 This is the protocol type of the mouse connected to this host.
3110 This variable must be set if
3111 .Va moused_enable
3112 is set to
3113 .Dq Li YES .
3114 The
3115 .Xr moused 8
3116 daemon
3117 is able to detect the appropriate mouse type automatically in many cases.
3118 Set this variable to
3119 .Dq Li auto
3120 to let the daemon detect it, or
3121 select one from the following list if the automatic detection fails.
3122 .Pp
3123 If the mouse is attached to the PS/2 mouse port, choose
3124 .Dq Li auto
3125 or
3126 .Dq Li ps/2 ,
3127 regardless of the brand and model of the mouse.
3128 Likewise, if the
3129 mouse is attached to the bus mouse port, choose
3130 .Dq Li auto
3131 or
3132 .Dq Li busmouse .
3133 All other protocols are for serial mice and will not work with
3134 the PS/2 and bus mice.
3135 If this is a USB mouse,
3136 .Dq Li auto
3137 is the only protocol type which will work.
3138 .Pp
3139 .Bl -tag -width ".Li x10mouseremote" -compact
3140 .It Li microsoft
3141 Microsoft mouse (serial)
3142 .It Li intellimouse
3143 Microsoft IntelliMouse (serial)
3144 .It Li mousesystems
3145 Mouse systems Corp.\& mouse (serial)
3146 .It Li mmseries
3147 MM Series mouse (serial)
3148 .It Li logitech
3149 Logitech mouse (serial)
3150 .It Li busmouse
3151 A bus mouse
3152 .It Li mouseman
3153 Logitech MouseMan and TrackMan (serial)
3154 .It Li glidepoint
3155 ALPS GlidePoint (serial)
3156 .It Li thinkingmouse
3157 Kensington ThinkingMouse (serial)
3158 .It Li ps/2
3159 PS/2 mouse
3160 .It Li mmhittab
3161 MM HitTablet (serial)
3162 .It Li x10mouseremote
3163 X10 MouseRemote (serial)
3164 .It Li versapad
3165 Interlink VersaPad (serial)
3166 .El
3167 .Pp
3168 Even if the mouse is not in the above list, it may be compatible
3169 with one in the list.
3170 Refer to the manual page for
3171 .Xr moused 8
3172 for compatibility information.
3173 .Pp
3174 It should also be noted that while this is enabled, any
3175 other client of the mouse (such as an X server) should access
3176 the mouse through the virtual mouse device,
3177 .Pa /dev/sysmouse ,
3178 and configure it as a
3179 .Dq Li sysmouse
3180 type mouse, since all
3181 mouse data is converted to this single canonical format when
3182 using
3183 .Xr moused 8 .
3184 If the client program does not support the
3185 .Dq Li sysmouse
3186 type,
3187 specify the
3188 .Dq Li mousesystems
3189 type.
3190 It is the second preferred type.
3191 .It Va moused_port
3192 .Pq Vt str
3193 If
3194 .Va moused_enable
3195 is set to
3196 .Dq Li YES ,
3197 this is the actual port the mouse is on.
3198 It might be
3199 .Pa /dev/cuau0
3200 for a COM1 serial mouse,
3201 .Pa /dev/psm0
3202 for a PS/2 mouse or
3203 .Pa /dev/mse0
3204 for a bus mouse, for example.
3205 .It Va moused_flags
3206 .Pq Vt str
3207 If
3208 .Va moused_flags
3209 is set, its value is used as an additional set of flags to pass to the
3210 .Xr moused 8
3211 daemon.
3212 .It Va "moused_" Ns Ar XXX Ns Va "_flags"
3213 When
3214 .Va moused_nondefault_enable
3215 is enabled, and a
3216 .Xr moused 8
3217 daemon is started for a non-default port, the
3218 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3219 set of options has precedence over and replaces the default
3220 .Va moused_flags
3221 (where
3222 .Ar XXX
3223 is the name of the non-default port, i.e.,\&
3224 .Ar ums0 ) .
3225 By setting
3226 .Va "moused_" Ns Ar XXX Ns Va "_flags"
3227 it is possible to set up a different set of default flags for each
3228 .Xr moused 8
3229 instance.
3230 For example, you can use
3231 .Dq Li "-3"
3232 for the default
3233 .Va moused_flags
3234 to make your laptop's touchpad more comfortable to use,
3235 but an empty set of options for
3236 .Va moused_ums0_flags
3237 when your
3238 .Xr usb 4
3239 mouse has three or more buttons.
3240 .It Va mousechar_start
3241 .Pq Vt int
3242 If set to
3243 .Dq Li NO ,
3244 the default mouse cursor character range
3245 .Li 0xd0 Ns - Ns Li 0xd3
3246 is used,
3247 otherwise the range start is set
3248 to
3249 .Ar value
3250 character, see
3251 .Xr vidcontrol 1 .
3252 Use if the default range is occupied in the language code table.
3253 .It Va allscreens_flags
3254 .Pq Vt str
3255 If set,
3256 .Xr vidcontrol 1
3257 is run with these options for each of the virtual terminals
3258 .Pq Pa /dev/ttyv* .
3259 For example,
3260 .Dq Fl m Cm on
3261 will enable the mouse pointer on all virtual terminals
3262 if
3263 .Va moused_enable
3264 is set to
3265 .Dq Li YES .
3266 .It Va allscreens_kbdflags
3267 .Pq Vt str
3268 If set,
3269 .Xr kbdcontrol 1
3270 is run with these options for each of the virtual terminals
3271 .Pq Pa /dev/ttyv* .
3272 For example,
3273 .Dq Fl h Li 200
3274 will set the
3275 .Xr syscons 4
3276 or
3277 .Xr vt 4
3278 scrollback (history) buffer to 200 lines.
3279 .It Va cron_enable
3280 .Pq Vt bool
3281 If set to
3282 .Dq Li YES ,
3283 run the
3284 .Xr cron 8
3285 daemon at system boot time.
3286 .It Va cron_program
3287 .Pq Vt str
3288 Path to
3289 .Xr cron 8
3290 (default
3291 .Pa /usr/sbin/cron ) .
3292 .It Va cron_flags
3293 .Pq Vt str
3294 If
3295 .Va cron_enable
3296 is set to
3297 .Dq Li YES ,
3298 these are the flags to pass to
3299 .Xr cron 8 .
3300 .It Va cron_dst
3301 .Pq Vt bool
3302 If set to
3303 .Dq Li YES ,
3304 enable the special handling of transitions to and from the
3305 Daylight Saving Time in
3306 .Xr cron 8
3307 (equivalent to using the flag
3308 .Fl s ) .
3309 .It Va lpd_program
3310 .Pq Vt str
3311 Path to
3312 .Xr lpd 8
3313 (default
3314 .Pa /usr/sbin/lpd ) .
3315 .It Va lpd_enable
3316 .Pq Vt bool
3317 If set to
3318 .Dq Li YES ,
3319 run the
3320 .Xr lpd 8
3321 daemon at system boot time.
3322 .It Va lpd_flags
3323 .Pq Vt str
3324 If
3325 .Va lpd_enable
3326 is set to
3327 .Dq Li YES ,
3328 these are the flags to pass to the
3329 .Xr lpd 8
3330 daemon.
3331 .It Va chkprintcap_enable
3332 .Pq Vt bool
3333 If set to
3334 .Dq Li YES ,
3335 run the
3336 .Xr chkprintcap 8
3337 command before starting the
3338 .Xr lpd 8
3339 daemon.
3340 .It Va chkprintcap_flags
3341 .Pq Vt str
3342 If
3343 .Va lpd_enable
3344 and
3345 .Va chkprintcap_enable
3346 are set to
3347 .Dq Li YES ,
3348 these are the flags to pass to the
3349 .Xr chkprintcap 8
3350 program.
3351 The default is
3352 .Dq Li -d ,
3353 which causes missing directories to be created.
3354 .It Va mta_start_script
3355 .Pq Vt str
3356 This variable specifies the full path to the script to run to start
3357 a mail transfer agent.
3358 The default is
3359 .Pa /etc/rc.sendmail .
3360 The
3361 .Va sendmail_*
3362 variables which
3363 .Pa /etc/rc.sendmail
3364 uses are documented in the
3365 .Xr rc.sendmail 8
3366 manual page.
3367 .It Va dumpdev
3368 .Pq Vt str
3369 Indicates the device (usually a swap partition) to which a crash dump
3370 should be written in the event of a system crash.
3371 If the value of this variable is
3372 .Dq Li AUTO ,
3373 the first suitable swap device listed in
3374 .Pa /etc/fstab
3375 will be used as dump device.
3376 Otherwise, the value of this variable is passed as the argument to
3377 .Xr dumpon 8 .
3378 To disable crash dumps, set this variable to
3379 .Dq Li NO .
3380 .It Va dumpdir
3381 .Pq Vt str
3382 When the system reboots after a crash and a crash dump is found on the
3383 device specified by the
3384 .Va dumpdev
3385 variable,
3386 .Xr savecore 8
3387 will save that crash dump and a copy of the kernel to the directory
3388 specified by the
3389 .Va dumpdir
3390 variable.
3391 The default value is
3392 .Pa /var/crash .
3393 Set to
3394 .Dq Li NO
3395 to not run
3396 .Xr savecore 8
3397 at boot time when
3398 .Va dumpdir
3399 is set.
3400 .It Va dumppubkey
3401 .Pq Vt str
3402 Path to a public key.
3403 It is used by
3404 .Xr dumpon 8
3405 to encrypt a one-time key for a crash dump.
3406 The public key has to match a private key used by
3407 .Xr decryptcore 8
3408 to decrypt a crash dump after reboot.
3409 See
3410 .Xr dumpon 8
3411 for more details.
3412 .It Va savecore_enable
3413 .Pq Vt bool
3414 If set to
3415 .Dq Li NO ,
3416 disable automatic extraction of the crash dump from the
3417 .Va dumpdev .
3418 .It Va savecore_flags
3419 .Pq Vt str
3420 If crash dumps are enabled, these are the flags to pass to the
3421 .Xr savecore 8
3422 utility.
3423 .It Va quota_enable
3424 .Pq Vt bool
3425 Set to
3426 .Dq Li YES
3427 to turn on user and group disk quotas on system startup via the
3428 .Xr quotaon 8
3429 command for all file systems marked as having quotas enabled in
3430 .Pa /etc/fstab .
3431 The kernel must be built with
3432 .Cd "options QUOTA"
3433 for disk quotas to function.
3434 .It Va check_quotas
3435 .Pq Vt bool
3436 Set to
3437 .Dq Li YES
3438 to enable user and group disk quota checking via the
3439 .Xr quotacheck 8
3440 command.
3441 .It Va quotacheck_flags
3442 .Pq Vt str
3443 If
3444 .Va quota_enable
3445 is set to
3446 .Dq Li YES ,
3447 and
3448 .Va check_quotas
3449 is set to
3450 .Dq Li YES ,
3451 these are the flags to pass to the
3452 .Xr quotacheck 8
3453 utility.
3454 The default is
3455 .Dq Li "-a" ,
3456 which checks quotas for all file systems with quotas enabled in
3457 .Pa /etc/fstab .
3458 .It Va quotaon_flags
3459 .Pq Vt str
3460 If
3461 .Va quota_enable
3462 is set to
3463 .Dq Li YES ,
3464 these are the flags to pass to the
3465 .Xr quotaon 8
3466 utility.
3467 The default is
3468 .Dq Li "-a" ,
3469 which enables quotas for all file systems with quotas enabled in
3470 .Pa /etc/fstab .
3471 .It Va quotaoff_flags
3472 .Pq Vt str
3473 If
3474 .Va quota_enable
3475 is set to
3476 .Dq Li YES ,
3477 these are the flags to pass to the
3478 .Xr quotaoff 8
3479 utility when shutting down the quota system.
3480 The default is
3481 .Dq Li "-a" ,
3482 which disables quotas for all file systems with quotas enabled in
3483 .Pa /etc/fstab .
3484 .It Va accounting_enable
3485 .Pq Vt bool
3486 Set to
3487 .Dq Li YES
3488 to enable system accounting through the
3489 .Xr accton 8
3490 facility.
3491 .It Va ibcs2_enable
3492 .Pq Vt bool
3493 Set to
3494 .Dq Li YES
3495 to enable iBCS2 (SCO) binary emulation at system initial boot
3496 time.
3497 .It Va ibcs2_loaders
3498 .Pq Vt str
3499 If not set to
3500 .Dq Li NO
3501 and if
3502 .Va ibcs2_enable
3503 is set to
3504 .Dq Li YES ,
3505 this specifies a list of additional iBCS2 loaders to enable.
3506 .It Va firstboot_sentinel
3507 .Pq Vt str
3508 This variable specifies the full path to a
3509 .Dq first boot
3510 sentinel file.
3511 If a file exists with this path,
3512 .Pa rc.d
3513 scripts with the
3514 .Dq firstboot
3515 keyword will be run on startup and the sentinel file will be deleted
3516 after the boot process completes.
3517 The sentinel file must be located on a writable file system which is
3518 mounted no later than
3519 .Va early_late_divider
3520 to function properly.
3521 The default is
3522 .Pa /firstboot .
3523 .It Va linux_enable
3524 .Pq Vt bool
3525 Set to
3526 .Dq Li YES
3527 to enable Linux/ELF binary emulation at system initial
3528 boot time.
3529 .It Va sysvipc_enable
3530 .Pq Vt bool
3531 If set to
3532 .Dq Li YES ,
3533 load System V IPC primitives at boot time.
3534 .It Va clear_tmp_enable
3535 .Pq Vt bool
3536 Set to
3537 .Dq Li YES
3538 to have
3539 .Pa /tmp
3540 cleaned at startup.
3541 .It Va clear_tmp_X
3542 .Pq Vt bool
3543 Set to
3544 .Dq Li NO
3545 to disable removing of X11 lock files,
3546 and the removal and (secure) recreation
3547 of the various socket directories for X11
3548 related programs.
3549 .It Va ldconfig_paths
3550 .Pq Vt str
3551 Set to the list of shared library paths to use with
3552 .Xr ldconfig 8 .
3553 NOTE:
3554 .Pa /usr/lib
3555 will always be added first, so it need not appear in this list.
3556 .It Va ldconfig32_paths
3557 .Pq Vt str
3558 Set to the list of 32-bit compatibility shared library paths to
3559 use with
3560 .Xr ldconfig 8 .
3561 .It Va ldconfig_paths_aout
3562 .Pq Vt str
3563 Set to the list of shared library paths to use with
3564 .Xr ldconfig 8
3565 legacy
3566 .Xr a.out 5
3567 support.
3568 .It Va ldconfig_insecure
3569 .Pq Vt bool
3570 The
3571 .Xr ldconfig 8
3572 utility normally refuses to use directories
3573 which are writable by anyone except root.
3574 Set this variable to
3575 .Dq Li YES
3576 to disable that security check during system startup.
3577 .It Va ldconfig_local_dirs
3578 .Pq Vt str
3579 Set to the list of local
3580 .Xr ldconfig 8
3581 directories.
3582 The names of all files in the directories listed will be
3583 passed as arguments to
3584 .Xr ldconfig 8 .
3585 .It Va ldconfig_local32_dirs
3586 .Pq Vt str
3587 Set to the list of local 32-bit compatibility
3588 .Xr ldconfig 8
3589 directories.
3590 The names of all files in the directories listed will be
3591 passed as arguments to
3592 .Dq Nm ldconfig Fl 32 .
3593 .It Va kern_securelevel_enable
3594 .Pq Vt bool
3595 Set to
3596 .Dq Li YES
3597 to set the kernel security level at system startup.
3598 .It Va kern_securelevel
3599 .Pq Vt int
3600 The kernel security level to set at startup.
3601 The allowed range of
3602 .Ar value
3603 ranges from \-1 (the compile time default) to 3 (the
3604 most secure).
3605 See
3606 .Xr security 7
3607 for the list of possible security levels and their effect
3608 on system operation.
3609 .It Va sshd_program
3610 .Pq Vt str
3611 Path to the SSH server program
3612 .Pa ( /usr/sbin/sshd
3613 is the default).
3614 .It Va sshd_enable
3615 .Pq Vt bool
3616 Set to
3617 .Dq Li YES
3618 to start
3619 .Xr sshd 8
3620 at system boot time.
3621 .It Va sshd_flags
3622 .Pq Vt str
3623 If
3624 .Va sshd_enable
3625 is set to
3626 .Dq Li YES ,
3627 these are the flags to pass to the
3628 .Xr sshd 8
3629 daemon.
3630 .It Va ftpd_program
3631 .Pq Vt str
3632 Path to the FTP server program
3633 .Pa ( /usr/libexec/ftpd
3634 is the default).
3635 .It Va ftpd_enable
3636 .Pq Vt bool
3637 Set to
3638 .Dq Li YES
3639 to start
3640 .Xr ftpd 8
3641 as a stand-alone daemon at system boot time.
3642 .It Va ftpd_flags
3643 .Pq Vt str
3644 If
3645 .Va ftpd_enable
3646 is set to
3647 .Dq Li YES ,
3648 these are the additional flags to pass to the
3649 .Xr ftpd 8
3650 daemon.
3651 .It Va watchdogd_enable
3652 .Pq Vt bool
3653 If set to
3654 .Dq Li YES ,
3655 start the
3656 .Xr watchdogd 8
3657 daemon at boot time.
3658 This requires that the kernel have been compiled with a
3659 .Xr watchdog 4
3660 compatible device.
3661 .It Va watchdogd_flags
3662 .Pq Vt str
3663 If
3664 .Va watchdogd_enable
3665 is set to
3666 .Dq Li YES ,
3667 these are the flags passed to the
3668 .Xr watchdogd 8
3669 daemon.
3670 .It Va devfs_rulesets
3671 .Pq Vt str
3672 List of files containing sets of rules for
3673 .Xr devfs 8 .
3674 .It Va devfs_system_ruleset
3675 .Pq Vt str
3676 Rule name(s) to apply to the system
3677 .Pa /dev
3678 itself.
3679 .It Va devfs_set_rulesets
3680 .Pq Vt str
3681 Pairs of already-mounted
3682 .Pa dev
3683 directories and rulesets that should be applied to them.
3684 For example: /mount/dev=ruleset_name
3685 .It Va devfs_load_rulesets
3686 .Pq Vt bool
3687 If set, always load the default rulesets listed in
3688 .Va devfs_rulesets .
3689 .It Va performance_cx_lowest
3690 .Pq Vt str
3691 CPU idle state to use while on AC power.
3692 The string
3693 .Dq Li LOW
3694 indicates that
3695 .Xr acpi 4
3696 should use the lowest power state available while
3697 .Dq Li HIGH
3698 indicates that the lowest latency state (less power savings) should be used.
3699 .It Va performance_cpu_freq
3700 .Pq Vt str
3701 CPU clock frequency to use while on AC power.
3702 The string
3703 .Dq Li LOW
3704 indicates that
3705 .Xr cpufreq 4
3706 should use the lowest frequency available while
3707 .Dq Li HIGH
3708 indicates that the highest frequency (less power savings) should be used.
3709 .It Va economy_cx_lowest
3710 .Pq Vt str
3711 CPU idle state to use when off AC power.
3712 The string
3713 .Dq Li LOW
3714 indicates that
3715 .Xr acpi 4
3716 should use the lowest power state available while
3717 .Dq Li HIGH
3718 indicates that the lowest latency state (less power savings) should be used.
3719 .It Va economy_cpu_freq
3720 .Pq Vt str
3721 CPU clock frequency to use when off AC power.
3722 The string
3723 .Dq Li LOW
3724 indicates that
3725 .Xr cpufreq 4
3726 should use the lowest frequency available while
3727 .Dq Li HIGH
3728 indicates that the highest frequency (less power savings) should be used.
3729 .It Va jail_enable
3730 .Pq Vt bool
3731 If set to
3732 .Dq Li NO ,
3733 any configured jails will not be started.
3734 .It Va jail_conf
3735 .Pq Vt str
3736 The configuration filename used by
3737 .Xr jail 8
3738 utility.
3739 The default value is
3740 .Pa /etc/jail.conf .
3741 .It Va jail_parallel_start
3742 .Pq Vt bool
3743 If set to
3744 .Dq Li YES ,
3745 all configured jails will be started in the background (in parallel).
3746 .It Va jail_flags
3747 .Pq Vt str
3748 Unset by default.
3749 When set, use as default value for
3750 .Va jail_ Ns Ao Ar jname Ac Ns Va _flags
3751 for every jail in
3752 .Va jail_list .
3753 .It Va jail_list
3754 .Pq Vt str
3755 A space-delimited list of jail names.
3756 When left empty, all of the
3757 .Xr jail 8
3758 instances defined in the configuration file are started.
3759 The names specified in this list control the jail startup order.
3760 .Xr jail 8
3761 instances missing from
3762 .Va jail_list
3763 must be started manually.
3764 Note that a jail's
3765 .Va depend
3766 parameter in the configuration file may override this list.
3767 .It Va jail_reverse_stop
3768 .Pq Vt bool
3769 When set to
3770 .Dq Li YES ,
3771 all configured jails in
3772 .Va jail_list
3773 are stopped in reverse order.
3774 .It Va jail_* variables
3775 Note that older releases supported per-jail configuration via
3776 .Nm
3777 variables.
3778 For example,
3779 hostname of a jail named
3780 .Li vjail
3781 was able to be set by
3782 .Li jail_vjail_hostname .
3783 These per-jail configuration variables are now obsolete in favor of
3784 .Xr jail 8
3785 configuration file.
3786 For backward compatibility,
3787 when per-jail configuration variables are defined,
3788 .Xr jail 8
3789 configuration files are created as
3790 .Pa /var/run/jail. Ns Ao Ar jname Ac Ns Pa .conf
3791 and used.
3792 .Pp
3793 The following per-jail parameters are handled by
3794 .Pa rc.d/jail
3795 script out of their corresponding
3796 .Nm
3797 variables.
3798 In addition to them, parameters in
3799 .Va jail_ Ns Ao Ar jname Ac Ns Va _parameters
3800 will be added to the configuration file.
3801 They must be a semi-colon
3802 .Pq Ql \&;
3803 delimited list of
3804 .Dq key=value .
3805 For more details,
3806 see
3807 .Xr jail 8
3808 manual page.
3809 .Bl  -tag -width "host.hostname" -offset indent
3810 .It Li path
3811 set from
3812 .Va jail_ Ns Ao Ar jname Ac Ns Va _rootdir
3813 .It Li host.hostname
3814 set from
3815 .Va jail_ Ns Ao Ar jname Ac Ns Va _hostname
3816 .It Li exec.consolelog
3817 set from
3818 .Va jail_ Ns Ao Ar jname Ac Ns Va _consolelog .
3819 The default value is
3820 .Pa /var/log/jail_ Ao Ar jname Ac Pa _console.log .
3821 .It Li interface
3822 set from
3823 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface .
3824 .It Li vnet.interface
3825 set from
3826 .Va jail_ Ns Ao Ar jname Ac Ns Va _vnet_interface .
3827 This implies
3828 .Li vnet
3829 parameter will be enabled and cannot be specified with
3830 .Va jail_ Ns Ao Ar jname Ac Ns Va _interface ,
3831 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3832 and/or
3833 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3834 at the same time.
3835 .It Li fstab
3836 set from
3837 .Va jail_ Ns Ao Ar jname Ac Ns Va _fstab
3838 .It Li mount
3839 set from
3840 .Va jail_ Ns Ao Ar jname Ac Ns Va _procfs_enable .
3841 .It Li exec.fib
3842 set from
3843 .Va jail_ Ns Ao Ar jname Ac Ns Va _fib
3844 .It Li exec.start
3845 set from
3846 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_start .
3847 The parameter name was
3848 .Li command
3849 in some older releases.
3850 .It Li exec.prestart
3851 set from
3852 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestart
3853 .It Li exec.poststart
3854 set from
3855 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststart
3856 .It Li exec.stop
3857 set from
3858 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_stop
3859 .It Li exec.prestop
3860 set from
3861 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_prestop
3862 .It Li exec.poststop
3863 set from
3864 .Va jail_ Ns Ao Ar jname Ac Ns Va _exec_poststop
3865 .It Li ip4.addr
3866 set if
3867 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3868 or
3869 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3870 contain IPv4 addresses
3871 .It Li ip6.addr
3872 set if
3873 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip
3874 or
3875 .Va jail_ Ns Ao Ar jname Ac Ns Va _ip_multi Ns Aq Ar n
3876 contain IPv6 addresses
3877 .It Li allow.mount
3878 set from
3879 .Va jail_ Ns Ao Ar jname Ac Ns Va _mount_enable
3880 .It Li mount.devfs
3881 set from
3882 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_enable
3883 .It Li devfs_ruleset
3884 set from
3885 .Va jail_ Ns Ao Ar jname Ac Ns Va _devfs_ruleset .
3886 This must be an integer,
3887 not a string.
3888 .It Li mount.fdescfs
3889 set from
3890 .Va jail_ Ns Ao Ar jname Ac Ns Va _fdescfs_enable
3891 .It Li allow.set_hostname
3892 set from
3893 .Va jail_ Ns Ao Ar jname Ac Ns Va _set_hostname_allow
3894 .It Li allow.rawsocket
3895 set from
3896 .Va jail_ Ns Ao Ar jname Ac Ns Va _socket_unixiproute_only
3897 .It Li allow.sysvipc
3898 set from
3899 .Va jail_ Ns Ao Ar jname Ac Ns Va _sysvipc_allow
3900 .El
3901 .\" -----------------------------------------------------
3902 .It Va harvest_mask
3903 .Pq Vt int
3904 Set to a bit-mask
3905 representing the entropy sources
3906 you wish to harvest.
3907 Refer to
3908 .Xr random 4
3909 for more information.
3910 .It Va entropy_dir
3911 .Pq Vt str
3912 Set to
3913 .Dq Li NO
3914 to disable caching entropy via
3915 .Xr cron 8 .
3916 Otherwise set to the directory
3917 in which the entropy files are stored.
3918 To be useful,
3919 there must be
3920 a system cron job
3921 that regularly writes and rotates
3922 files here.
3923 All files found
3924 will be used at boot time.
3925 The default is
3926 .Pa /var/db/entropy .
3927 .It Va entropy_file
3928 .Pq Vt str
3929 Set to
3930 .Dq Li NO
3931 to disable caching entropy through reboots.
3932 Otherwise set to the name
3933 of a file used to store cached entropy.
3934 This file should be located
3935 on a file system that is readable
3936 before all the volumes specified in
3937 .Xr fstab 5
3938 are mounted.
3939 By default,
3940 .Pa /entropy
3941 is used,
3942 but if
3943 .Pa /var/db/entropy-file
3944 is found it will also be used.
3945 This will be of some use to
3946 .Xr bsdinstall 8 .
3947 .It Va entropy_boot_file
3948 .Pq Vt str
3949 Set to
3950 .Dq Li NO
3951 to disable
3952 very early caching entropy
3953 through reboots.
3954 Otherwise set to the filename
3955 used to read
3956 very early reboot cached entropy.
3957 This file should be located where
3958 .Xr loader 8
3959 can read it.
3960 See also
3961 .Xr loader.conf 5 .
3962 The default location is
3963 .Pa /boot/entropy .
3964 .It Va entropy_save_sz
3965 .Pq Vt int
3966 Size of the entropy cache files saved by
3967 .Nm save-entropy
3968 periodically.
3969 .It Va entropy_save_num
3970 .Pq Vt int
3971 Number of entropy cache files to save by
3972 .Nm save-entropy
3973 periodically.
3974 .It Va ipsec_enable
3975 .Pq Vt bool
3976 Set to
3977 .Dq Li YES
3978 to run
3979 .Xr setkey 8
3980 on
3981 .Va ipsec_file
3982 at boot time.
3983 .It Va ipsec_file
3984 .Pq Vt str
3985 Configuration file for
3986 .Xr setkey 8 .
3987 .It Va dmesg_enable
3988 .Pq Vt bool
3989 Set to
3990 .Dq Li YES
3991 to save
3992 .Xr dmesg 8
3993 to
3994 .Pa /var/run/dmesg.boot
3995 on boot.
3996 .It Va rcshutdown_timeout
3997 .Pq Vt int
3998 If set, start a watchdog timer in the background which will terminate
3999 .Pa rc.shutdown
4000 if
4001 .Xr shutdown 8
4002 has not completed within the specified time (in seconds).
4003 Notice that in addition to this soft timeout,
4004 .Xr init 8
4005 also applies a hard timeout for the execution of
4006 .Pa rc.shutdown .
4007 This is configured via
4008 .Xr sysctl 8
4009 variable
4010 .Va kern.init_shutdown_timeout
4011 and defaults to 120 seconds.
4012 Setting the value of
4013 .Va rcshutdown_timeout
4014 to more than 120 seconds will have no effect until the
4015 .Xr sysctl 8
4016 variable
4017 .Va kern.init_shutdown_timeout
4018 is also increased.
4019 .It Va virecover_enable
4020 .Pq Vt bool
4021 Set to
4022 .Dq Li NO
4023 to prevent the system from trying to
4024 recover pre-maturely terminated
4025 .Xr vi 1
4026 sessions.
4027 .It Va ugidfw_enable
4028 .Pq Vt bool
4029 Set to
4030 .Dq Li YES
4031 to load the
4032 .Xr mac_bsdextended 4
4033 module upon system initialization and load a default
4034 ruleset file.
4035 .It Va bsdextended_script
4036 .Pq Vt str
4037 The default
4038 .Xr mac_bsdextended 4
4039 ruleset file to load.
4040 The default value of this variable is
4041 .Pa /etc/rc.bsdextended .
4042 .It Va newsyslog_enable
4043 .Pq Vt bool
4044 If set to
4045 .Dq Li YES ,
4046 run
4047 .Xr newsyslog 8
4048 command at startup.
4049 .It Va newsyslog_flags
4050 .Pq Vt str
4051 If
4052 .Va newsyslog_enable
4053 is set to
4054 .Dq Li YES ,
4055 these are the flags to pass to the
4056 .Xr newsyslog 8
4057 program.
4058 The default is
4059 .Dq Li -CN ,
4060 which causes log files flagged with a
4061 .Cm C
4062 to be created.
4063 .It Va mdconfig_md Ns Aq Ar X
4064 .Pq Vt str
4065 Arguments to
4066 .Xr mdconfig 8
4067 for
4068 .Xr md 4
4069 device
4070 .Ar X .
4071 At minimum a
4072 .Fl t Ar type
4073 must be specified and either a
4074 .Fl s Ar size
4075 for malloc or swap backed
4076 .Xr md 4
4077 devices or a
4078 .Fl f Ar file
4079 for vnode backed
4080 .Xr md 4
4081 devices.
4082 Note that
4083 .Va mdconfig_md Ns Aq Ar X
4084 variables are evaluated until one variable is unset or null.
4085 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _newfs
4086 .Pq Vt str
4087 Optional arguments passed to
4088 .Xr newfs 8
4089 to initialize
4090 .Xr md 4
4091 device
4092 .Ar X .
4093 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _owner
4094 .Pq Vt str
4095 An ownership specification passed to
4096 .Xr chown 8
4097 after the specified
4098 .Xr md 4
4099 device
4100 .Ar X
4101 has been mounted.
4102 Both the
4103 .Xr md 4
4104 device and the mount point will be changed.
4105 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _perms
4106 .Pq Vt str
4107 A mode string passed to
4108 .Xr chmod 1
4109 after the specified
4110 .Xr md 4
4111 device
4112 .Ar X
4113 has been mounted.
4114 Both the
4115 .Xr md 4
4116 device and the mount point will be changed.
4117 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _files
4118 .Pq Vt str
4119 Files to be copied to the mount point of the
4120 .Xr md 4
4121 device
4122 .Ar X
4123 after it has been mounted.
4124 .It Va mdconfig_md Ns Ao Ar X Ac Ns Va _cmd
4125 .Pq Vt str
4126 Command to execute after the specified
4127 .Xr md 4
4128 device
4129 .Ar X
4130 has been mounted.
4131 Note that the command is passed to
4132 .Ic eval
4133 and that both
4134 .Va _dev
4135 and
4136 .Va _mp
4137 variables can be used to reference respectively the
4138 .Xr md 4
4139 device and the mount point.
4140 Assuming that the
4141 .Xr md 4
4142 device is
4143 .Li md0 ,
4144 one could set the following:
4145 .Bd -literal
4146 mdconfig_md0_cmd="tar xfzC /var/file.tgz \e${_mp}"
4147 .Ed
4148 .It Va autobridge_interfaces
4149 .Pq Vt str
4150 Set to the list of bridge interfaces that will have newly arriving interfaces
4151 checked against to be automatically added.
4152 If not set to
4153 .Dq Li NO
4154 then for each whitespace separated
4155 .Ar element
4156 in the value, a
4157 .Va autobridge_ Ns Aq Ar element
4158 variable is assumed to exist which has a whitespace separated list of interface
4159 names to match, these names can use wildcards.
4160 For example:
4161 .Bd -literal
4162 autobridge_interfaces="bridge0"
4163 autobridge_bridge0="tap* dc0 vlan[345]"
4164 .Ed
4165 .It Va mixer_enable
4166 .Pq Vt bool
4167 If set to
4168 .Dq Li YES ,
4169 enable support for sound mixer.
4170 .It Va hcsecd_enable
4171 .Pq Vt bool
4172 If set to
4173 .Dq Li YES ,
4174 enable Bluetooth security daemon.
4175 .It Va hcsecd_config
4176 .Pq Vt str
4177 Configuration file for
4178 .Xr hcsecd 8 .
4179 Default
4180 .Pa /etc/bluetooth/hcsecd.conf .
4181 .It Va sdpd_enable
4182 .Pq Vt bool
4183 If set to
4184 .Dq Li YES ,
4185 enable Bluetooth Service Discovery Protocol daemon.
4186 .It Va sdpd_control
4187 .Pq Vt str
4188 Path to
4189 .Xr sdpd 8
4190 control socket.
4191 Default
4192 .Pa /var/run/sdp .
4193 .It Va sdpd_groupname
4194 .Pq Vt str
4195 Sets
4196 .Xr sdpd 8
4197 group to run as after it initializes.
4198 Default
4199 .Dq Li nobody .
4200 .It Va sdpd_username
4201 .Pq Vt str
4202 Sets
4203 .Xr sdpd 8
4204 user to run as after it initializes.
4205 Default
4206 .Dq Li nobody .
4207 .It Va bthidd_enable
4208 .Pq Vt bool
4209 If set to
4210 .Dq Li YES ,
4211 enable Bluetooth Human Interface Device daemon.
4212 .It Va bthidd_config
4213 .Pq Vt str
4214 Configuration file for
4215 .Xr bthidd 8 .
4216 Default
4217 .Pa /etc/bluetooth/bthidd.conf .
4218 .It Va bthidd_hids
4219 .Pq Vt str
4220 Path to a file, where
4221 .Xr bthidd 8
4222 will store information about known HID devices.
4223 Default
4224 .Pa /var/db/bthidd.hids .
4225 .It Va rfcomm_pppd_server_enable
4226 .Pq Vt bool
4227 If set to
4228 .Dq Li YES ,
4229 enable Bluetooth RFCOMM PPP wrapper daemon.
4230 .It Va rfcomm_pppd_server_profile
4231 .Pq Vt str
4232 The name of the profile to use from
4233 .Pa /etc/ppp/ppp.conf .
4234 Multiple profiles can be specified here.
4235 Also used to specify per-profile overrides.
4236 When the profile name contains any of the characters
4237 .Dq Li .-/+
4238 they are translated to
4239 .Dq Li _
4240 for the proposes of the override variable names.
4241 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _bdaddr
4242 .Pq Vt str
4243 Overrides local address to listen on.
4244 By default
4245 .Xr rfcomm_pppd 8
4246 will listen on
4247 .Dq Li ANY
4248 address.
4249 The address can be specified as BD_ADDR or name.
4250 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _channel
4251 .Pq Vt str
4252 Overrides local RFCOMM channel to listen on.
4253 By default
4254 .Xr rfcomm_pppd 8
4255 will listen on RFCOMM channel 1.
4256 Must set properly if multiple profiles used in the same time.
4257 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_sp
4258 .Pq Vt bool
4259 Tells
4260 .Xr rfcomm_pppd 8
4261 if it should register Serial Port service on the specified RFCOMM channel.
4262 Default
4263 .Dq Li NO .
4264 .It Va rfcomm_pppd_server_ Ns Ao Ar profile Ac Ns _register_dun
4265 .Pq Vt bool
4266 Tells
4267 .Xr rfcomm_pppd 8
4268 if it should register Dial-Up Networking service on the specified
4269 RFCOMM channel.
4270 Default
4271 .Dq Li NO .
4272 .It Va ubthidhci_enable
4273 .Pq Vt bool
4274 If set to
4275 .Dq Li YES ,
4276 change the USB Bluetooth controller from HID mode to HCI mode.
4277 You also need to specify the location of USB Bluetooth controller with the
4278 .Va ubthidhci_busnum
4279 and
4280 .Va ubthidhci_addr
4281 variables.
4282 .It Va ubthidhci_busnum
4283 Bus number where the USB Bluetooth controller is located.
4284 Check the output of
4285 .Xr usbconfig 8
4286 on your system to find this information.
4287 .It Va ubthidhci_addr
4288 Bus address of the USB Bluetooth controller.
4289 Check the output of
4290 .Xr usbconfig 8
4291 on your system to find this information.
4292 .It Va netwait_enable
4293 .Pq Vt bool
4294 If set to
4295 .Dq Li YES ,
4296 delays the start of network-reliant services until
4297 .Va netwait_if
4298 is up and ICMP packets to a destination defined in
4299 .Va netwait_ip
4300 are flowing.
4301 Link state is examined first, followed by
4302 .Dq Li pinging
4303 an IP address to verify network usability.
4304 If no destination can be reached or timeouts are exceeded,
4305 network services are started anyway with no guarantee that
4306 the network is usable.
4307 Use of this variable requires both
4308 .Va netwait_ip
4309 and
4310 .Va netwait_if
4311 to be set.
4312 .It Va netwait_ip
4313 .Pq Vt str
4314 Empty by default.
4315 This variable contains a space-delimited list of IP addresses to
4316 .Xr ping 8 .
4317 DNS hostnames should not be used as resolution is not guaranteed
4318 to be functional at this point.
4319 If multiple IP addresses are specified,
4320 each will be tried until one is successful or the list is exhausted.
4321 .It Va netwait_timeout
4322 .Pq Vt int
4323 Indicates the total number of seconds to perform a
4324 .Dq Li ping
4325 against each IP address in
4326 .Va netwait_ip ,
4327 at a rate of one ping per second.
4328 If any of the pings are successful,
4329 full network connectivity is considered reliable.
4330 The default is 60.
4331 .It Va netwait_if
4332 .Pq Vt str
4333 Empty by default.
4334 Defines the name of the network interface on which watch for link.
4335 .Xr ifconfig 8
4336 is used to monitor the interface, looking for
4337 .Dq Li status: no carrier .
4338 Once gone, the link is considered up.
4339 This can be a
4340 .Xr vlan 4
4341 interface if desired.
4342 .It Va netwait_if_timeout
4343 .Pq Vt int
4344 Defines the total number of seconds to wait for link to become usable,
4345 polled at a 1-second interval.
4346 The default is 30.
4347 .It Va rctl_enable
4348 .Pq Vt bool
4349 If set to
4350 .Dq Li YES ,
4351 load
4352 .Xr rctl 8
4353 rules from the defined ruleset.
4354 The kernel must be built with
4355 .Cd "options RACCT"
4356 and
4357 .Cd "options RCTL" .
4358 .It Va rctl_rules
4359 .Pq Vt str
4360 Set to
4361 .Pa /etc/rctl.conf
4362 by default.
4363 This variables contains the
4364 .Xr rctl.conf 5
4365 ruleset to load for
4366 .Xr rctl 8 .
4367 .It Va iovctl_files
4368 .Pq Vt str
4369 A space-separated list of configuration files used by
4370 .Xr iovctl 8 .
4371 The default value is an empty string.
4372 .It Va autofs_enable
4373 .Pq Vt bool
4374 If set to
4375 .Dq Li YES ,
4376 start the
4377 .Xr automount 8
4378 utility and the
4379 .Xr automountd 8
4380 and
4381 .Xr autounmountd 8
4382 daemons at boot time.
4383 .It Va automount_flags
4384 .Pq Vt str
4385 If
4386 .Va autofs_enable
4387 is set to
4388 .Dq Li YES ,
4389 these are the flags to pass to the
4390 .Xr automount 8
4391 program.
4392 By default no flags are passed.
4393 .It Va automountd_flags
4394 .Pq Vt str
4395 If
4396 .Va autofs_enable
4397 is set to
4398 .Dq Li YES ,
4399 these are the flags to pass to the
4400 .Xr automountd 8
4401 daemon.
4402 By default no flags are passed.
4403 .It Va autounmountd_flags
4404 .Pq Vt str
4405 If
4406 .Va autofs_enable
4407 is set to
4408 .Dq Li YES ,
4409 these are the flags to pass to the
4410 .Xr autounmountd 8
4411 daemon.
4412 By default no flags are passed.
4413 .It Va ctld_enable
4414 .Pq Vt bool
4415 If set to
4416 .Dq Li YES ,
4417 start the
4418 .Xr ctld 8
4419 daemon at boot time.
4420 .It Va iscsid_enable
4421 .Pq Vt bool
4422 If set to
4423 .Dq Li YES ,
4424 start the
4425 .Xr iscsid 8
4426 daemon at boot time.
4427 .It Va iscsictl_enable
4428 .Pq Vt bool
4429 If set to
4430 .Dq Li YES ,
4431 start the
4432 .Xr iscsictl 8
4433 utility at boot time.
4434 .It Va iscsictl_flags
4435 .Pq Vt str
4436 If
4437 .Va iscsictl_enable
4438 is set to
4439 .Dq Li YES ,
4440 these are the flags to pass to the
4441 .Xr iscsictl 8
4442 program.
4443 The default is
4444 .Dq Li -Aa ,
4445 which configures sessions based on the
4446 .Pa /etc/iscsi.conf
4447 configuration file.
4448 .El
4449 .Sh FILES
4450 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
4451 .It Pa /etc/defaults/rc.conf
4452 .It Pa /etc/rc.conf
4453 .It Pa /etc/rc.conf.local
4454 .El
4455 .Sh SEE ALSO
4456 .Xr catman 1 ,
4457 .Xr chmod 1 ,
4458 .Xr gdb 1 ,
4459 .Xr info 1 ,
4460 .Xr kbdcontrol 1 ,
4461 .Xr makewhatis 1 ,
4462 .Xr sh 1 ,
4463 .Xr vi 1 ,
4464 .Xr vidcontrol 1 ,
4465 .Xr bridge 4 ,
4466 .Xr dummynet 4 ,
4467 .Xr ip 4 ,
4468 .Xr ipf 4 ,
4469 .Xr ipfw 4 ,
4470 .Xr ipnat 4 ,
4471 .Xr kld 4 ,
4472 .Xr pf 4 ,
4473 .Xr pflog 4 ,
4474 .Xr pfsync 4 ,
4475 .Xr tcp 4 ,
4476 .Xr udp 4 ,
4477 .Xr exports 5 ,
4478 .Xr fstab 5 ,
4479 .Xr ipf 5 ,
4480 .Xr ipnat 5 ,
4481 .Xr jail.conf 5 ,
4482 .Xr loader.conf 5 ,
4483 .Xr motd 5 ,
4484 .Xr newsyslog.conf 5 ,
4485 .Xr pf.conf 5 ,
4486 .Xr security 7 ,
4487 .Xr accton 8 ,
4488 .Xr amd 8 ,
4489 .Xr apm 8 ,
4490 .Xr bsdinstall 8 ,
4491 .Xr bthidd 8 ,
4492 .Xr chkprintcap 8 ,
4493 .Xr chown 8 ,
4494 .Xr cron 8 ,
4495 .Xr devfs 8 ,
4496 .Xr dhclient 8 ,
4497 .Xr ftpd 8 ,
4498 .Xr geli 8 ,
4499 .Xr hcsecd 8 ,
4500 .Xr ifconfig 8 ,
4501 .Xr inetd 8 ,
4502 .Xr iovctl 8 ,
4503 .Xr ipf 8 ,
4504 .Xr ipfw 8 ,
4505 .Xr ipnat 8 ,
4506 .Xr jail 8 ,
4507 .Xr kldxref 8 ,
4508 .Xr loader 8 ,
4509 .Xr lpd 8 ,
4510 .Xr mdconfig 8 ,
4511 .Xr mdmfs 8 ,
4512 .Xr mixer 8 ,
4513 .Xr mountd 8 ,
4514 .Xr moused 8 ,
4515 .Xr newfs 8 ,
4516 .Xr newsyslog 8 ,
4517 .Xr nfsd 8 ,
4518 .Xr ntpd 8 ,
4519 .Xr ntpdate 8 ,
4520 .Xr pfctl 8 ,
4521 .Xr pflogd 8 ,
4522 .Xr ping 8 ,
4523 .Xr powerd 8 ,
4524 .Xr quotacheck 8 ,
4525 .Xr quotaon 8 ,
4526 .Xr rc 8 ,
4527 .Xr rc.sendmail 8 ,
4528 .Xr rfcomm_pppd 8 ,
4529 .Xr route 8 ,
4530 .Xr routed 8 ,
4531 .Xr rpc.lockd 8 ,
4532 .Xr rpc.statd 8 ,
4533 .Xr rpcbind 8 ,
4534 .Xr rwhod 8 ,
4535 .Xr savecore 8 ,
4536 .Xr sdpd 8 ,
4537 .Xr sshd 8 ,
4538 .Xr swapon 8 ,
4539 .Xr sysctl 8 ,
4540 .Xr syslogd 8 ,
4541 .Xr timed 8 ,
4542 .Xr unbound 8 ,
4543 .Xr usbconfig 8 ,
4544 .Xr wlandebug 8 ,
4545 .Xr yp 8 ,
4546 .Xr ypbind 8 ,
4547 .Xr ypserv 8 ,
4548 .Xr ypset 8
4549 .Sh HISTORY
4550 The
4551 .Nm
4552 file appeared in
4553 .Fx 2.2.2 .
4554 .Sh AUTHORS
4555 .An Jordan K. Hubbard .