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