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