xref: /freebsd/share/man/man5/rc.conf.5 (revision 81d1ffee089aab2652954909acbe6aadd8a1a72c)
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 March 3, 2002
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
71The following list provides a name and short description for each
72variable that can be set in the
73.Nm
74file:
75.Bl -tag -width indent-two
76.It Va rc_debug
77.Pq Vt bool
78If set to
79.Dq Li YES ,
80enable output of debug messages from rc scripts.
81This variable can be helpful in diagnosing mistakes when
82editing or integrating new scripts.
83Beware that this produces copious output to the terminal and
84.Xr syslog 3 .
85.It Va rc_info
86.Pq Vt bool
87If set to
88.Dq Li NO ,
89disable informational messages from the rc scripts.
90Informational messages are displayed when
91a condition that is not serious enough to warrant a warning or
92an error occurs.
93.It Va swapfile
94.Pq Vt str
95If set to
96.Dq Li NO ,
97no swapfile is installed, otherwise the value is used as the full
98pathname to a file to use for additional swap space.
99.It Va apm_enable
100.Pq Vt bool
101If set to
102.Dq Li YES ,
103enable support for Automatic Power Management with
104the
105.Xr apm 8
106command.
107.It Va apmd_enable
108.Pq Vt bool
109Run
110.Xr apmd 8
111to handle APM event from userland.
112This also enables support for APM.
113.It Va apmd_flags
114.Pq Vt str
115If
116.Va apmd_enable
117is set to
118.Dq Li YES ,
119these are the flags to pass to the
120.Xr apmd 8
121daemon.
122.It Va devd_enable
123.Pq Vt bool
124Run
125.Xr devd 8
126to handle device added, removed or unknown events from the kernel.
127.It Va pccard_enable
128.Pq Vt bool
129If set to
130.Dq Li YES ,
131enable PCCARD support at boot time.
132.It Va pccard_mem
133.Pq Vt str
134Set to PCCARD controller memory address or
135.Dq Li DEFAULT
136for the default value.
137.It Va pccard_ifconfig
138.Pq Vt str
139List of arguments to be passed to
140.Xr ifconfig 8
141at boot time or on
142insertion of the card (e.g.\&
143.Dq Cm inet Li 192.168.1.1 Cm netmask Li 255.255.255.0
144for a fixed address or
145.Dq Li DHCP
146for a DHCP client).
147.It Va pccard_beep
148.Pq Vt int
149If 0,
150set the PCCARD controller to silent mode.
151If 1,
152set it to beep mode.
153If 2,
154set it to melody mode.
155.It Va pccard_conf
156.Pq Vt str
157Path to the configuration file for the
158.Xr pccardd 8
159daemon (e.g.\&
160.Pa /etc/pccard.conf.sample ) .
161.It Va pccardd_flags
162.Pq Vt str
163If
164.Va pccard_enable
165is set to
166.Dq Li YES ,
167these are the flags to pass to the
168.Xr pccardd 8
169daemon.
170.It Va pccard_ether_delay
171.Pq Vt str
172Set the delay before starting
173.Xr dhclient 8
174in
175.Xr pccard_ether 8
176script.
177This defaults to 5 seconds to work around a bug in the
178.Xr ed 4
179driver which can lead to system hangs when using some newer
180.Xr ed 4
181based cards.
182.It Va removable_interfaces
183.Pq Vt str
184List of removable network interfaces to be supported by
185.Pa /etc/pccard_ether .
186.It Va local_startup
187.Pq Vt str
188List of directories to search for startup script files.
189.It Va script_name_sep
190.Pq Vt str
191The field separator to use for breaking down the list of startup script files
192into individual filenames.
193The default is a space.
194It is not necessary to change this unless there are startup scripts with names
195containing spaces.
196.It Va hostname
197.Pq Vt str
198The fully qualified domain name (FQDN) of this host on the network.
199This should almost certainly be set to something meaningful, even if
200there is no network connection.
201If
202.Xr dhclient 8
203is used to set the hostname via DHCP,
204this variable should be set to an empty string.
205.It Va nisdomainname
206.Pq Vt str
207The NIS domain name of this host, or
208.Dq Li NO
209if NIS is not used.
210.It Va dhcp_program
211.Pq Vt str
212Path to the DHCP client program
213.Pa ( /sbin/dhclient ,
214the ISC DHCP client,
215is the default).
216.It Va dhcp_flags
217.Pq Vt str
218Additional flags to pass to the DHCP client program.
219For the ISC DHCP client, see the
220.Xr dhclient 8
221manpage for a description of the command line options available.
222.It Va firewall_enable
223.Pq Vt bool
224Set to
225.Dq Li YES
226to load firewall rules at startup.
227If the kernel was not built with
228.Cd "options IPFIREWALL" ,
229the
230.Pa ipfw.ko
231kernel module will be loaded.
232See also
233.Va ipfilter_enable .
234.It Va firewall_script
235.Pq Vt str
236This variable specifies the full path to the firewall script to run.
237The default is
238.Pa /etc/rc.firewall .
239.It Va firewall_type
240.Pq Vt str
241Names the firewall type from the selection in
242.Pa /etc/rc.firewall ,
243or the file which contains the local firewall ruleset.
244Valid selections from
245.Pa /etc/rc.firewall
246are:
247.Pp
248.Bl -tag -width ".Li simple" -compact
249.It Li open
250unrestricted IP access
251.It Li closed
252all IP services disabled, except via
253.Dq Li lo0
254.It Li client
255basic protection for a workstation
256.It Li simple
257basic protection for a LAN.
258.El
259.Pp
260If a filename is specified, the full path
261must be given.
262.It Va firewall_quiet
263.Pq Vt bool
264Set to
265.Dq Li YES
266to disable the display of firewall rules on the console during boot.
267.It Va firewall_logging
268.Pq Vt bool
269Set to
270.Dq Li YES
271to enable firewall event logging.
272This is equivalent to the
273.Dv IPFIREWALL_VERBOSE
274kernel option.
275.It Va firewall_flags
276.Pq Vt str
277Flags passed to
278.Xr ipfw 8
279if
280.Va firewall_type
281specifies a filename.
282.It Va natd_program
283.Pq Vt str
284Path to
285.Xr natd 8 .
286.It Va natd_enable
287.Pq Vt bool
288Set to
289.Dq Li YES
290to enable
291.Xr natd 8 .
292.Va firewall_enable
293must also be set to
294.Dq Li YES ,
295and
296.Xr divert 4
297sockets must be enabled in the kernel.
298.It Va natd_interface
299.Pq Vt str
300This is the name of the public interface on which
301.Xr natd 8
302should run.
303The interface may be given as an interface name or as an IP address.
304.It Va natd_flags
305.Pq Vt str
306Additional
307.Xr natd 8
308flags should be placed here.
309The
310.Fl n
311or
312.Fl a
313flag is automatically added with the above
314.Va natd_interface
315as an argument.
316.\" ----- ipfilter_enable setting --------------------------------
317.It Va ipfilter_enable
318.Pq Vt bool
319Set to
320.Dq Li NO
321by default.
322Setting this to
323.Dq Li YES
324enables
325.Xr ipf 8
326packet filtering.
327.Pp
328Typical usage will require putting
329.Bd -literal
330ipfilter_enable="YES"
331ipnat_enable="YES"
332ipmon_enable="YES"
333ipfs_enable="YES"
334.Ed
335.Pp
336into
337.Pa /etc/rc.conf
338and editing
339.Pa /etc/ipf.rules
340and
341.Pa /etc/ipnat.rules
342appropriately.
343.Pp
344Note that
345.Va ipfilter_enable
346and
347.Va ipnat_enable
348can be enabled independently.
349.Va ipmon_enable
350and
351.Va ipfs_enable
352both require at least one of
353.Va ipfilter_enable
354and
355.Va ipnat_enable
356to be enabled.
357.Pp
358Having
359.Bd -literal
360options IPFILTER
361options IPFILTER_LOG
362options IPFILTER_DEFAULT_BLOCK
363.Ed
364.Pp
365in the kernel configuration file is a good idea, too.
366.\" ----- ipfilter_program setting ------------------------------
367.It Va ipfilter_program
368.Pq Vt str
369Path to
370.Xr ipf 8
371(default
372.Pa /sbin/ipf ) .
373.\" ----- ipfilter_rules setting --------------------------------
374.It Va ipfilter_rules
375.Pq Vt str
376Set to
377.Pa /etc/ipf.rules
378by default.
379This variable contains the name of the filter rule definition file.
380The file is expected to be readable for the
381.Xr ipf 8
382command to execute.
383.\" ----- ipfilter_flags setting --------------------------------
384.It Va ipfilter_flags
385.Pq Vt str
386Empty by default.
387This variable contains flags passed to the
388.Xr ipf 8
389program.
390.\" ----- ipnat_enable setting ----------------------------------
391.It Va ipnat_enable
392.Pq Vt bool
393Set to
394.Dq Li NO
395by default.
396Set it to
397.Dq Li YES
398to enable
399.Xr ipnat 1
400network address translation.
401See
402.Va ipfilter_enable
403for a detailed discussion.
404.\" ----- ipnat_program setting ---------------------------------
405.It Va ipnat_program
406.Pq Vt str
407Path to
408.Xr ipnat 1
409(default
410.Pa /sbin/ipnat ) .
411.\" ----- ipnat_rules setting -----------------------------------
412.It Va ipnat_rules
413.Pq Vt str
414Set to
415.Pa /etc/ipnat.rules
416by default.
417This variable contains the name of the file
418holding the network address translation definition.
419This file is expected to be readable for the
420.Xr ipnat 1
421command to execute.
422.\" ----- ipnat_flags setting -----------------------------------
423.It Va ipnat_flags
424.Pq Vt str
425Empty by default.
426This variable contains flags passed to the
427.Xr ipnat 1
428program.
429.\" ----- ipmon_enable setting ----------------------------------
430.It Va ipmon_enable
431.Pq Vt bool
432Set to
433.Dq Li NO
434by default.
435Set it to
436.Dq Li YES
437to enable
438.Xr ipmon 8
439monitoring (logging
440.Xr ipf 8
441and
442.Xr ipnat 1
443events).
444Setting this variable needs setting
445.Va ipfilter_enable
446or
447.Va ipnat_enable
448too.
449See
450.Va ipfilter_enable
451for a detailed discussion.
452.\" ----- ipmon_program setting ---------------------------------
453.It Va ipmon_program
454.Pq Vt str
455Path to
456.Xr ipmon 8
457(default
458.Pa /sbin/ipmon ) .
459.\" ----- ipmon_flags setting -----------------------------------
460.It Va ipmon_flags
461.Pq Vt str
462Set to
463.Dq Li -Ds
464by default.
465This variable contains flags passed to the
466.Xr ipmon 8
467program.
468Another typical example would be
469.Dq Fl D Pa /var/log/ipflog
470to have
471.Xr ipmon 8
472log directly to a file bypassing
473.Xr syslogd 8 .
474Make sure to adjust
475.Pa /etc/newsyslog.conf
476in such case like this:
477.Bd -literal
478/var/log/ipflog  640  10  100  *  Z  /var/run/ipmon.pid
479.Ed
480.\" ----- ipfs_enable setting -----------------------------------
481.It Va ipfs_enable
482.Pq Vt bool
483Set to
484.Dq Li NO
485by default.
486Set it to
487.Dq Li YES
488to enable
489.Xr ipfs 8
490saving the filter and NAT state tables during shutdown
491and reloading them during startup again.
492Setting this variable needs setting
493.Va ipfilter_enable
494or
495.Va ipnat_enable
496to
497.Dq Li YES
498too.
499See
500.Va ipfilter_enable
501for a detailed discussion.
502Note that if
503.Va kern_securelevel
504is set to 3,
505.Va ipfs_enable
506cannot be used
507because the raised securelevel will prevent
508.Xr ipfs 8
509from saving the state tables at shutdown time.
510.\" ----- ipfs_program setting ----------------------------------
511.It Va ipfs_program
512.Pq Vt str
513Path to
514.Xr ipfs 8
515(default
516.Pa /sbin/ipfs ) .
517.\" ----- ipfs_flags setting ------------------------------------
518.It Va ipfs_flags
519.Pq Vt str
520Empty by default.
521This variable contains flags passed to the
522.Xr ipfs 8
523program.
524.\" ----- end of added ipf hook ---------------------------------
525.It Va tcp_extensions
526.Pq Vt bool
527Set to
528.Dq Li YES
529by default.
530Setting this to
531.Dq Li NO
532disables certain TCP options as described by
533.Rs
534.%T "RFC 1323"
535.Re
536Setting this to
537.Dq Li NO
538might help remedy such problems with connections as randomly hanging
539or other weird behavior.
540Some network devices are known
541to be broken with respect to these options.
542.It Va log_in_vain
543.Pq Vt int
544Set to 0 by default.
545The
546.Xr sysctl 8
547variables,
548.Va net.inet.tcp.log_in_vain
549and
550.Va net.inet.udp.log_in_vain ,
551as described in
552.Xr tcp 4
553and
554.Xr udp 4 ,
555are set to the given value.
556.It Va tcp_keepalive
557.Pq Vt bool
558Set to
559.Dq Li YES
560by default.
561Setting to
562.Dq Li NO
563will disable probing idle TCP connections to verify that the
564peer is still up and reachable.
565.It Va tcp_drop_synfin
566.Pq Vt bool
567Set to
568.Dq Li NO
569by default.
570Setting to
571.Dq Li YES
572will cause the kernel to ignore TCP frames that have both
573the SYN and FIN flags set.
574This prevents OS fingerprinting, but may
575break some legitimate applications.
576This option is only available if the
577kernel was built with the
578.Dv TCP_DROP_SYNFIN
579option.
580.It Va icmp_drop_redirect
581.Pq Vt bool
582Set to
583.Dq Li NO
584by default.
585Setting to
586.Dq Li YES
587will cause the kernel to ignore ICMP REDIRECT packets.
588.It Va icmp_log_redirect
589.Pq Vt bool
590Set to
591.Dq Li NO
592by default.
593Setting to
594.Dq Li YES
595will cause the kernel to log ICMP REDIRECT packets.
596Note that
597the log messages are not rate-limited, so this option should only be used
598for troubleshooting networks.
599.It Va network_interfaces
600.Pq Vt str
601Set to the list of network interfaces to configure on this host.
602For example, if the only network devices in the system are the loopback
603device
604.Pq Li lo0
605and a NIC using the
606.Xr ed 4
607driver,
608this could be set to
609.Dq Li "lo0 ed0" .
610An
611.Va ifconfig_ Ns Aq Ar interface
612variable is also assumed to exist for each value of
613.Ar interface .
614It is also possible to add IP alias entries here in cases where
615multiple IP addresses registered against a single interface
616are desired.
617Assuming that the interface in question was
618.Li ed0 ,
619it might look
620something like this:
621.Bd -literal
622ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
623ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
624.Ed
625.Pp
626And so on.
627For each
628.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
629entry that is found,
630its contents are passed to
631.Xr ifconfig 8 .
632Execution stops at the first unsuccessful access, so if
633something like this is present:
634.Bd -literal
635ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
636ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
637ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
638ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
639.Ed
640.Pp
641Then note that alias4 would
642.Em not
643be added since the search would
644stop with the missing alias3 entry.
645.Pp
646If the
647.Pa /etc/start_if. Ns Aq Ar interface
648file is present, it is read and executed by the
649.Xr sh 1
650interpreter
651before configuring the interface as specified in the
652.Va ifconfig_ Ns Aq Ar interface
653and
654.Va ifconfig_ Ns Ao Ar interface Ac Ns Va _alias Ns Aq Ar n
655variables.
656.Pp
657It is possible to bring up an interface with DHCP by setting the
658.Va ifconfig_ Ns Aq Ar interface
659variable to
660.Dq Li DHCP .
661For instance, to initialize the
662.Li ed0
663device via DHCP,
664it is possible to use something like:
665.Bd -literal
666ifconfig_ed0="DHCP"
667.Ed
668.It Va cloned_interfaces
669.Pq Vt str
670Set to the list of clonable network interfaces to create on this host.
671Entries in
672.Va cloned_interfaces
673are automatically appended to
674.Va network_interfaces
675for configuration.
676.It Va gif_interfaces
677.Pq Vt str
678Set to the list of
679.Xr gif 4
680tunnel interfaces to configure on this host.
681A
682.Va gifconfig_ Ns Aq Ar interface
683variable is assumed to exist for each value of
684.Ar interface .
685The value of this variable is used to configure the link layer of the
686tunnel according to the syntax of the
687.Cm tunnel
688option to
689.Xr ifconfig 8 .
690Additionally, this option ensures that each listed interface is created
691via the
692.Cm create
693option to
694.Xr ifconfig 8
695before attempting to configure it.
696.It Va ppp_enable
697.Pq Vt bool
698If set to
699.Dq Li YES ,
700run the
701.Xr ppp 8
702daemon.
703.It Va ppp_mode
704.Pq Vt str
705Mode in which to run the
706.Xr ppp 8
707daemon.
708Accepted modes are
709.Dq Li auto ,
710.Dq Li ddial ,
711.Dq Li direct
712and
713.Dq Li dedicated .
714See the manual for a full description.
715.It Va ppp_nat
716.Pq Vt bool
717If set to
718.Dq Li YES ,
719enables network address translation.
720Used in conjunction with
721.Va gateway_enable
722allows hosts on private network addresses access to the Internet using
723this host as a network address translating router.
724.It Va ppp_profile
725.Pq Vt str
726The name of the profile to use from
727.Pa /etc/ppp/ppp.conf .
728.It Va ppp_user
729.Pq Vt str
730The name of the user under which
731.Xr ppp 8
732should be started.
733By
734default,
735.Xr ppp 8
736is started as
737.Dq Li root .
738.It Va rc_conf_files
739.Pq Vt str
740This option is used to specify a list of files that will override
741the settings in
742.Pa /etc/defaults/rc.conf .
743The files will be read in the order in which they are specified and should
744include the full path to the file.
745By default, the files specified are
746.Pa /etc/rc.conf
747and
748.Pa /etc/rc.conf.local
749.It Va fsck_y_enable
750.Pq Vt bool
751If set to
752.Dq Li YES ,
753.Xr fsck 8
754will be run with the
755.Fl y
756flag if the initial preen
757of the file systems fails.
758.It Va background_fsck
759.Pq Vt bool
760If set to
761.Dq Li YES ,
762the system will attempt to run
763.Xr fsck 8
764in the background where possible.
765.It Va background_fsck_delay
766.Pq Vt int
767The amount of time in seconds to sleep before starting a background
768.Xr fsck 8 .
769It defaults to sixty seconds to allow large applications such as
770the X server to start before disk I/O bandwidth is monopolized by
771.Xr fsck 8 .
772.It Va extra_netfs_types
773.Pq Vt str
774If set to something other than
775.Dq Li NO
776(the default),
777this variable extends the list of file system types
778for which automatic mounting at startup by
779.Xr rc 8
780should be delayed until the network is initialized.
781It should contain
782a whitespace-separated list of network file system descriptor pairs,
783each consisting of a file system type as passed to
784.Xr mount 8
785and a human-readable, one-word description,
786joined with a colon
787.Pq Ql \&: .
788Extending the default list in this way is only necessary
789when third party file system types are used.
790.It Va syslogd_enable
791.Pq Vt bool
792If set to
793.Dq Li YES ,
794run the
795.Xr syslogd 8
796daemon.
797.It Va syslogd_program
798.Pq Vt str
799Path to
800.Xr syslogd 8
801(default
802.Pa /usr/sbin/syslogd ) .
803.It Va syslogd_flags
804.Pq Vt str
805If
806.Va syslogd_enable
807is set to
808.Dq Li YES ,
809these are the flags to pass to
810.Xr syslogd 8 .
811.It Va inetd_enable
812.Pq Vt bool
813If set to
814.Dq Li YES ,
815run the
816.Xr inetd 8
817daemon.
818.It Va inetd_program
819.Pq Vt str
820Path to
821.Xr inetd 8
822(default
823.Pa /usr/sbin/inetd ) .
824.It Va inetd_flags
825.Pq Vt str
826If
827.Va inetd_enable
828is set to
829.Dq Li YES ,
830these are the flags to pass to
831.Xr inetd 8 .
832.It Va named_rcng
833.Pq Vt bool
834If set to
835.Dq Li YES
836use new functionality provided in the
837.Pa /etc/rc.d/named
838script to facilitate a
839.Xr chroot 8
840instance of
841.Xr named 8 .
842This variable is experimental.
843It may be removed or changed in the near future.
844.It Va named_enable
845.Pq Vt bool
846If set to
847.Dq Li YES ,
848run the
849.Xr named 8
850daemon.
851.It Va named_program
852.Pq Vt str
853Path to
854.Xr named 8
855(default
856.Pa /usr/sbin/named ) .
857.It Va named_flags
858.Pq Vt str
859If
860.Va named_enable
861is set to
862.Dq Li YES ,
863these are the flags to pass to
864.Xr named 8 .
865.It Va named_pidfile
866.Pq Vt str
867This is the default path to the
868.Xr named 8
869daemon's PID file.
870Change it if you change the location in
871.Xr named.conf 5 .
872.It Va named_chrootdir
873.Pq Vt str
874The root directory for a name server run in a
875.Xr chroot 8
876environment.
877If left empty
878.Xr named 8
879will not be run in a
880.Xr chroot 8
881environment.
882This variable has no effect if
883.Va named_rcng
884is not enabled.
885This variable is experimental.
886It may be removed or changed in the near future.
887.It Va named_chroot_autoupdate
888.Pq Vt bool
889Set to
890.Dq Li NO
891to disable automatic syncing of libraries and
892other system files between the root file system and the
893.Xr chroot 8 .
894This variable has no effect if
895.Va named_rcng
896is not enabled.
897This variable is experimental.
898It may be removed or changed in the near future.
899.It Va named_symlink_enable
900.Pq Vt bool
901Set to
902.Dq Li NO
903to disable symlinking of
904.Pa /var/run/named.pid
905and
906.Pa /var/run/ndc
907into the
908.Xr chroot 8
909environment in which
910.Xr named 8
911is running.
912This variable has no effect if
913.Va named_rcng
914is not enabled.
915This variable is experimental.
916It may be removed or changed in the near future.
917.It Va kerberos4_server_enable
918.Pq Vt bool
919Set to
920.Dq Li YES
921to start a Kerberos IV authentication server
922at boot time.
923.It Va kadmind4_server_enable
924.Pq Vt bool
925Set to
926.Dq Li YES
927to start
928.Xr kadmind 8 ,
929the Kerberos IV Administration Daemon; set to
930.Dq Li NO
931on a slave server.
932.It Va kerberos_stash
933.Pq Vt str
934If
935.Dq Li YES ,
936instruct the Kerberos servers to use the stashed master key instead of
937prompting for it (only if
938.Va kerberos_server_enable
939is set to
940.Dq Li YES ,
941and is used for both
942.Xr kerberos 1
943and
944.Xr kadmind 8 ) .
945.It Va kerberos5_server_enable
946.Pq Vt bool
947Set to
948.Dq Li YES
949to start a Kerberos 5 authentication server
950at boot time.
951.It Va kadmind5_server_enable
952.Pq Vt bool
953Set to
954.Dq Li YES
955to start
956.Xr k5admind 8 ,
957the Kerberos 5 Administration Daemon; set to
958.Dq Li NO
959on a slave server.
960.It Va rwhod_enable
961.Pq Vt bool
962If set to
963.Dq Li YES ,
964run the
965.Xr rwhod 8
966daemon at boot time.
967.It Va rwhod_flags
968.Pq Vt str
969If
970.Va rwhod_enable
971is set to
972.Dq Li YES ,
973these are the flags to pass to it.
974.It Va amd_enable
975.Pq Vt bool
976If set to
977.Dq Li YES ,
978run the
979.Xr amd 8
980daemon at boot time.
981.It Va amd_flags
982.Pq Vt str
983If
984.Va amd_enable
985is set to
986.Dq Li YES ,
987these are the flags to pass to it.
988See the
989.Xr amd 8
990manpage for more information.
991.It Va amd_map_program
992.Pq Vt str
993If set,
994the specified program is run to get the list of
995.Xr amd 8
996maps.
997For example, if the
998.Xr amd 8
999maps are stored in NIS, one can set this to
1000run
1001.Xr ypcat 1
1002to get a list of
1003.Xr amd 8
1004maps from the
1005.Pa amd.master
1006NIS map.
1007.It Va update_motd
1008.Pq Vt bool
1009If set to
1010.Dq Li YES ,
1011.Pa /etc/motd
1012will be updated at boot time to reflect the kernel release
1013being run.
1014If set to
1015.Dq Li NO ,
1016.Pa /etc/motd
1017will not be updated.
1018.It Va nfs_client_enable
1019.Pq Vt bool
1020If set to
1021.Dq Li YES ,
1022run the NFS client daemons at boot time.
1023.It Va nfs_access_cache
1024.Pq Vt int
1025If
1026.Va nfs_client_enable
1027is set to
1028.Dq Li YES ,
1029this can be set to
1030.Dq Li 0
1031to disable NFS ACCESS RPC caching, or to the number of seconds for which
1032NFS ACCESS
1033results should be cached.
1034A value of 2-10 seconds will substantially reduce network
1035traffic for many NFS operations.
1036.It Va nfs_server_enable
1037.Pq Vt bool
1038If set to
1039.Dq Li YES ,
1040run the NFS server daemons at boot time.
1041.It Va nfs_server_flags
1042.Pq Vt str
1043If
1044.Va nfs_server_enable
1045is set to
1046.Dq Li YES ,
1047these are the flags to pass to the
1048.Xr nfsd 8
1049daemon.
1050.It Va mountd_enable
1051.Pq Vt bool
1052If set to
1053.Dq Li YES ,
1054and no
1055.Va nfs_server_enable
1056is set, start
1057.Xr mountd 8 ,
1058but not
1059.Xr nfsd 8
1060daemon.
1061It is commonly needed to run CFS without real NFS used.
1062.It Va weak_mountd_authentication
1063.Pq Vt bool
1064If set to
1065.Dq Li YES ,
1066allow services like PCNFSD to make non-privileged mount
1067requests.
1068.It Va nfs_reserved_port_only
1069.Pq Vt bool
1070If set to
1071.Dq Li YES ,
1072provide NFS services only on a secure port.
1073.It Va nfs_bufpackets
1074.Pq Vt int
1075If set to a number, indicates the number of packets worth of
1076socket buffer space to reserve on an NFS client.
1077The kernel default is typically 4.
1078Using a higher number may be
1079useful on gigabit networks to improve performance.
1080The minimum value is
10812 and the maximum is 64.
1082.It Va rpc_lockd_enable
1083.Pq Vt bool
1084If set to
1085.Dq Li YES
1086and also an NFS server, run
1087.Xr rpc.lockd 8
1088at boot time.
1089.It Va rpc_statd_enable
1090.Pq Vt bool
1091If set to
1092.Dq Li YES
1093and also an NFS server, run
1094.Xr rpc.statd 8
1095at boot time.
1096.It Va rpcbind_program
1097.Pq Vt str
1098Path to
1099.Xr rpcbind 8
1100(default
1101.Pa /usr/sbin/rpcbind ) .
1102.It Va rpcbind_enable
1103.Pq Vt bool
1104If set to
1105.Dq Li YES ,
1106run the
1107.Xr rpcbind 8
1108service at boot time.
1109.It Va rpcbind_flags
1110.Pq Vt str
1111If
1112.Va rpcbind_enable
1113is set to
1114.Dq Li YES ,
1115these are the flags to pass to the
1116.Xr rpcbind 8
1117daemon.
1118.It Va xtend_enable
1119.Pq Vt bool
1120If set to
1121.Dq Li YES ,
1122run the
1123.Xr xtend 8
1124daemon at boot time.
1125.It Va xtend_flags
1126.Pq Vt str
1127If
1128.Va xtend_enable
1129is set to
1130.Dq Li YES ,
1131these are the flags to pass to the
1132.Xr xtend 8
1133daemon.
1134.It Va pppoed_enable
1135.Pq Vt bool
1136If set to
1137.Dq Li YES ,
1138run the
1139.Xr pppoed 8
1140daemon at boot time to provide PPP over Ethernet services.
1141.It Va pppoed_ Ns Ar provider
1142.Pq Vt str
1143.Xr pppoed 8
1144listens to requests to this
1145.Ar provider
1146and ultimately runs
1147.Xr ppp 8
1148with a
1149.Ar system
1150argument of the same name.
1151.It Va pppoed_flags
1152.Pq Vt str
1153Additional flags to pass to
1154.Xr pppoed 8 .
1155.It Va pppoed_interface
1156.Pq Vt str
1157The network interface to run
1158.Xr pppoed 8
1159on.
1160This is mandatory when
1161.Va pppoed_enable
1162is set to
1163.Dq Li YES .
1164.It Va timed_enable
1165.Pq Vt boot
1166If set to
1167.Dq Li YES ,
1168run the
1169.Xr timed 8
1170service at boot time.
1171This command is intended for networks of
1172machines where a consistent
1173.Dq "network time"
1174for all hosts must be established.
1175This is often useful in large NFS
1176environments where time stamps on files are expected to be consistent
1177network-wide.
1178.It Va timed_flags
1179.Pq Vt str
1180If
1181.Va timed_enable
1182is set to
1183.Dq Li YES ,
1184these are the flags to pass to the
1185.Xr timed 8
1186service.
1187.It Va ntpdate_enable
1188.Pq Vt bool
1189If set to
1190.Dq Li YES ,
1191run
1192.Xr ntpdate 8
1193at system startup.
1194This command is intended to
1195synchronize the system clock only
1196.Em once
1197from some standard reference.
1198An option to set this up initially
1199(from a list of known servers) is also provided by the
1200.Xr sysinstall 8
1201program when the system is first installed.
1202.It Va ntpdate_program
1203.Pq Vt str
1204Path to
1205.Xr ntpdate 8
1206(default
1207.Pa /usr/sbin/ntpdate ) .
1208.It Va ntpdate_flags
1209.Pq Vt str
1210If
1211.Va ntpdate_enable
1212is set to
1213.Dq Li YES ,
1214these are the flags to pass to the
1215.Xr ntpdate 8
1216command (typically a hostname).
1217.It Va ntpd_enable
1218.Pq Vt bool
1219If set to
1220.Dq Li YES ,
1221run the
1222.Xr ntpd 8
1223command at boot time.
1224.It Va ntpd_program
1225.Pq Vt str
1226Path to
1227.Xr ntpd 8
1228(default
1229.Pa /usr/sbin/ntpd ) .
1230.It Va ntpd_flags
1231.Pq Vt str
1232If
1233.Va ntpd_enable
1234is set to
1235.Dq Li YES ,
1236these are the flags to pass to the
1237.Xr ntpd 8
1238daemon.
1239.It Va nis_client_enable
1240.Pq Vt bool
1241If set to
1242.Dq Li YES ,
1243run the
1244.Xr ypbind 8
1245service at system boot time.
1246.It Va nis_client_flags
1247.Pq Vt str
1248If
1249.Va nis_client_enable
1250is set to
1251.Dq Li YES ,
1252these are the flags to pass to the
1253.Xr ypbind 8
1254service.
1255.It Va nis_ypset_enable
1256.Pq Vt bool
1257If set to
1258.Dq Li YES ,
1259run the
1260.Xr ypset 8
1261daemon at system boot time.
1262.It Va nis_ypset_flags
1263.Pq Vt str
1264If
1265.Va nis_ypset_enable
1266is set to
1267.Dq Li YES ,
1268these are the flags to pass to the
1269.Xr ypset 8
1270daemon.
1271.It Va nis_server_enable
1272.Pq Vt bool
1273If set to
1274.Dq Li YES ,
1275run the
1276.Xr ypserv 8
1277daemon at system boot time.
1278.It Va nis_server_flags
1279.Pq Vt str
1280If
1281.Va nis_server_enable
1282is set to
1283.Dq Li YES ,
1284these are the flags to pass to the
1285.Xr ypserv 8
1286daemon.
1287.It Va nis_ypxfrd_enable
1288.Pq Vt bool
1289If set to
1290.Dq Li YES ,
1291run the
1292.Xr rpc.ypxfrd 8
1293daemon at system boot time.
1294.It Va nis_ypxfrd_flags
1295.Pq Vt str
1296If
1297.Va nis_ypxfrd_enable
1298is set to
1299.Dq Li YES ,
1300these are the flags to pass to the
1301.Xr rpc.ypxfrd 8
1302daemon.
1303.It Va nis_yppasswdd_enable
1304.Pq Vt bool
1305If set to
1306.Dq Li YES ,
1307run the
1308.Xr rpc.yppasswdd 8
1309daemon at system boot time.
1310.It Va nis_yppasswdd_flags
1311.Pq Vt str
1312If
1313.Va nis_yppasswdd_enable
1314is set to
1315.Dq Li YES ,
1316these are the flags to pass to the
1317.Xr rpc.yppasswdd 8
1318daemon.
1319.It Va defaultrouter
1320.Pq Vt str
1321If not set to
1322.Dq Li NO ,
1323create a default route to this host name or IP address
1324(use an IP address if this router is also required to get to the
1325name server!).
1326.It Va static_routes
1327.Pq Vt str
1328Set to the list of static routes that are to be added at system
1329boot time.
1330If not set to
1331.Dq Li NO
1332then for each whitespace separated
1333.Ar element
1334in the value, a
1335.Va route_ Ns Aq Ar element
1336variable is assumed to exist
1337whose contents will later be passed to a
1338.Dq Nm route Cm add
1339operation.
1340.It Va gateway_enable
1341.Pq Vt bool
1342If set to
1343.Dq Li YES ,
1344configure host to act as an IP router, e.g. to forward packets
1345between interfaces.
1346.It Va router_enable
1347.Pq Vt bool
1348If set to
1349.Dq Li YES ,
1350run a routing daemon of some sort, based on the
1351settings of
1352.Va router
1353and
1354.Va router_flags .
1355.It Va router
1356.Pq Vt str
1357If
1358.Va router_enable
1359is set to
1360.Dq Li YES ,
1361this is the name of the routing daemon to use.
1362.It Va router_flags
1363.Pq Vt str
1364If
1365.Va router_enable
1366is set to
1367.Dq Li YES ,
1368these are the flags to pass to the routing daemon.
1369.It Va mrouted_enable
1370.Pq Vt bool
1371If set to
1372.Dq Li YES ,
1373run the multicast routing daemon,
1374.Xr mrouted 8 .
1375.It Va mrouted_flags
1376.Pq Vt str
1377If
1378.Va mrouted_enable
1379is set to
1380.Dq Li YES ,
1381these are the flags to pass to the
1382.Xr mrouted 8
1383daemon.
1384.It Va ipxgateway_enable
1385.Pq Vt bool
1386If set to
1387.Dq Li YES ,
1388enable the routing of IPX traffic.
1389.It Va ipxrouted_enable
1390.Pq Vt bool
1391If set to
1392.Dq Li YES ,
1393run the
1394.Xr IPXrouted 8
1395daemon at system boot time.
1396.It Va ipxrouted_flags
1397.Pq Vt str
1398If
1399.Va ipxrouted_enable
1400is set to
1401.Dq Li YES ,
1402these are the flags to pass to the
1403.Xr IPXrouted 8
1404daemon.
1405.It Va arpproxy_all
1406.Pq Vt bool
1407If set to
1408.Dq Li YES ,
1409enable global proxy ARP.
1410.It Va forward_sourceroute
1411.Pq Vt bool
1412If set to
1413.Dq Li YES
1414and
1415.Va gateway_enable
1416is also set to
1417.Dq Li YES ,
1418source-routed packets are forwarded.
1419.It Va accept_sourceroute
1420.Pq Vt bool
1421If set to
1422.Dq Li YES ,
1423the system will accept source-routed packets directed at it.
1424.It Va rarpd_enable
1425.Pq Vt bool
1426If set to
1427.Dq Li YES ,
1428run the
1429.Xr rarpd 8
1430daemon at system boot time.
1431.It Va rarpd_flags
1432.Pq Vt str
1433If
1434.Va rarpd_enable
1435is set to
1436.Dq Li YES ,
1437these are the flags to pass to the
1438.Xr rarpd 8
1439daemon.
1440.It Va bootparamd_enable
1441.Pq Vt bool
1442If set to
1443.Dq Li YES ,
1444run the
1445.Xr bootparamd 8
1446daemon at system boot time.
1447.It Va bootparamd_flags
1448.Pq Vt str
1449If
1450.Va bootparamd_enable
1451is set to
1452.Dq Li YES ,
1453these are the flags to pass to the
1454.Xr bootparamd 8
1455daemon.
1456.It Va atm_enable
1457.Pq Vt bool
1458Set to
1459.Dq Li YES
1460to enable the configuration of ATM interfaces at system boot time.
1461For all of the ATM variables described below, please refer to the
1462.Xr atm 8
1463man page for further details on the available command parameters.
1464Also refer to the files in
1465.Pa /usr/share/examples/atm
1466for more detailed configuration information.
1467.It Va atm_netif_ Ns Aq Ar intf
1468.Pq Vt str
1469For the ATM physical interface
1470.Ar intf ,
1471this variable defines the name prefix and count for the ATM network
1472interfaces to be created.
1473The value will be passed as the parameters of an
1474.Dq Nm atm Cm "set netif" Ar intf
1475command.
1476.It Va atm_sigmgr_ Ns Aq Ar intf
1477.Pq Vt str
1478For the ATM physical interface
1479.Ar intf ,
1480this variable defines the ATM signalling manager to be used.
1481The value will be passed as the parameters of an
1482.Dq Nm atm Cm attach Ar intf
1483command.
1484.It Va atm_prefix_ Ns Aq Ar intf
1485.Pq Vt str
1486For the ATM physical interface
1487.Ar intf ,
1488this variable defines the NSAP prefix for interfaces using a UNI signalling
1489manager.
1490If set to
1491.Dq Li ILMI ,
1492the prefix will automatically be set via the
1493.Xr ilmid 8
1494daemon.
1495Otherwise, the value will be passed as the parameters of an
1496.Dq Nm atm Cm "set prefix" Ar intf
1497command.
1498.It Va atm_macaddr_ Ns Aq Ar intf
1499.Pq Vt str
1500For the ATM physical interface
1501.Ar intf ,
1502this variable defines the MAC address for interfaces using a UNI signalling
1503manager.
1504If set to
1505.Dq Li NO ,
1506the hardware MAC address contained in the ATM interface card will be used.
1507Otherwise, the value will be passed as the parameters of an
1508.Dq Nm atm Cm "set mac" Ar intf
1509command.
1510.It Va atm_arpserver_ Ns Aq Ar netif
1511.Pq Vt str
1512For the ATM network interface
1513.Ar netif ,
1514this variable defines the ATM address for a host which is to provide ATMARP
1515service.
1516This variable is only applicable to interfaces using a UNI signalling
1517manager.
1518If set to
1519.Dq Li local ,
1520this host will become an ATMARP server.
1521The value will be passed as the parameters of an
1522.Dq Nm atm Cm "set arpserver" Ar netif
1523command.
1524.It Va atm_scsparp_ Ns Aq Ar netif
1525.Pq Vt bool
1526If set to
1527.Dq Li YES ,
1528SCSP/ATMARP service for the network interface
1529.Ar netif
1530will be initiated using the
1531.Xr scspd 8
1532and
1533.Xr atmarpd 8
1534daemons.
1535This variable is only applicable if
1536.Va atm_arpserver_ Ns Aq Ar netif
1537is set to
1538.Dq Li local .
1539.It Va atm_pvcs
1540.Pq Vt str
1541Set to the list of ATM PVCs to be added at system
1542boot time.
1543For each whitespace separated
1544.Ar element
1545in the value, an
1546.Va atm_pvc_ Ns Aq Ar element
1547variable is assumed to exist.
1548The value of each of these variables
1549will be passed as the parameters of an
1550.Dq Nm atm Cm "add pvc"
1551command.
1552.It Va atm_arps
1553.Pq Vt str
1554Set to the list of permanent ATM ARP entries to be added
1555at system boot time.
1556For each whitespace separated
1557.Ar element
1558in the value, an
1559.Va atm_arp_ Ns Aq Ar element
1560variable is assumed to exist.
1561The value of each of these variables
1562will be passed as the parameters of an
1563.Dq Nm atm Cm "add arp"
1564command.
1565.It Va keybell
1566.Pq Vt str
1567The keyboard bell sound.
1568Set to
1569.Dq Li normal ,
1570.Dq Li visual ,
1571.Dq Li off ,
1572or
1573.Dq Li NO
1574if the default behavior is desired.
1575For details, refer to the
1576.Xr kbdcontrol 1
1577manpage.
1578.It Va keymap
1579.Pq Vt str
1580If set to
1581.Dq Li NO ,
1582no keymap is installed, otherwise the value is used to install
1583the keymap file in
1584.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
1585.It Va keyrate
1586.Pq Vt str
1587The keyboard repeat speed.
1588Set to
1589.Dq Li slow ,
1590.Dq Li normal ,
1591.Dq Li fast ,
1592or
1593.Dq Li NO
1594if the default behavior is desired.
1595.It Va keychange
1596.Pq Vt str
1597If not set to
1598.Dq Li NO ,
1599attempt to program the function keys with the value.
1600The value should
1601be a single string of the form:
1602.Dq Ar funkey_number new_value Op Ar funkey_number new_value ... .
1603.It Va cursor
1604.Pq Vt str
1605Can be set to the value of
1606.Dq Li normal ,
1607.Dq Li blink ,
1608.Dq Li destructive ,
1609or
1610.Dq Li NO
1611to set the cursor behavior explicitly or choose the default behavior.
1612.It Va scrnmap
1613.Pq Vt str
1614If set to
1615.Dq Li NO ,
1616no screen map is installed, otherwise the value is used to install
1617the screen map file in
1618.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
1619.It Va font8x16
1620.Pq Vt str
1621If set to
1622.Dq Li NO ,
1623the default 8x16 font value is used for screen size requests, otherwise
1624the value in
1625.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1626is used.
1627.It Va font8x14
1628.Pq Vt str
1629If set to
1630.Dq Li NO ,
1631the default 8x14 font value is used for screen size requests, otherwise
1632the value in
1633.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1634is used.
1635.It Va font8x8
1636.Pq Vt str
1637If set to
1638.Dq Li NO ,
1639the default 8x8 font value is used for screen size requests, otherwise
1640the value in
1641.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
1642is used.
1643.It Va blanktime
1644.Pq Vt int
1645If set to
1646.Dq Li NO ,
1647the default screen blanking interval is used, otherwise it is set
1648to
1649.Ar value
1650seconds.
1651.It Va saver
1652.Pq Vt str
1653If not set to
1654.Dq Li NO ,
1655this is the actual screen saver to use
1656.Li ( blank , snake , daemon ,
1657etc).
1658.It Va moused_enable
1659.Pq Vt str
1660If set to
1661.Dq Li YES ,
1662the
1663.Xr moused 8
1664daemon is started for doing cut/paste selection on the console.
1665.It Va moused_type
1666.Pq Vt str
1667This is the protocol type of the mouse connected to this host.
1668This variable must be set if
1669.Va moused_enable
1670is set to
1671.Dq Li YES .
1672The
1673.Xr moused 8
1674daemon
1675is able to detect the appropriate mouse type automatically in many cases.
1676Set this variable to
1677.Dq Li auto
1678to let the daemon detect it, or
1679select one from the following list if the automatic detection fails.
1680.Pp
1681If the mouse is attached to the PS/2 mouse port, choose
1682.Dq Li auto
1683or
1684.Dq Li ps/2 ,
1685regardless of the brand and model of the mouse.
1686Likewise, if the
1687mouse is attached to the bus mouse port, choose
1688.Dq Li auto
1689or
1690.Dq Li busmouse .
1691All other protocols are for serial mice and will not work with
1692the PS/2 and bus mice.
1693If this is a USB mouse,
1694.Dq Li auto
1695is the only protocol type which will work.
1696.Pp
1697.Bl -tag -width ".Li x10mouseremote" -compact
1698.It Li microsoft
1699Microsoft mouse (serial)
1700.It Li intellimouse
1701Microsoft IntelliMouse (serial)
1702.It Li mousesystems
1703Mouse systems Corp. mouse (serial)
1704.It Li mmseries
1705MM Series mouse (serial)
1706.It Li logitech
1707Logitech mouse (serial)
1708.It Li busmouse
1709A bus mouse
1710.It Li mouseman
1711Logitech MouseMan and TrackMan (serial)
1712.It Li glidepoint
1713ALPS GlidePoint (serial)
1714.It Li thinkingmouse
1715Kensington ThinkingMouse (serial)
1716.It Li ps/2
1717PS/2 mouse
1718.It Li mmhittab
1719MM HitTablet (serial)
1720.It Li x10mouseremote
1721X10 MouseRemote (serial)
1722.It Li versapad
1723Interlink VersaPad (serial)
1724.El
1725.Pp
1726Even if the mouse is not in the above list, it may be compatible
1727with one in the list.
1728Refer to the man page for
1729.Xr moused 8
1730for compatibility information.
1731.Pp
1732It should also be noted that while this is enabled, any
1733other client of the mouse (such as an X server) should access
1734the mouse through the virtual mouse device,
1735.Pa /dev/sysmouse ,
1736and configure it as a
1737.Dq Li sysmouse
1738type mouse, since all
1739mouse data is converted to this single canonical format when
1740using
1741.Xr moused 8 .
1742If the client program does not support the
1743.Dq Li sysmouse
1744type,
1745specify the
1746.Dq Li mousesystems
1747type.
1748It is the second preferred type.
1749.It Va moused_port
1750.Pq Vt str
1751If
1752.Va moused_enable
1753is set to
1754.Dq Li YES ,
1755this is the actual port the mouse is on.
1756It might be
1757.Pa /dev/cuaa0
1758for a COM1 serial mouse,
1759.Pa /dev/psm0
1760for a PS/2 mouse or
1761.Pa /dev/mse0
1762for a bus mouse, for example.
1763.It Va moused_flags
1764.Pq Vt str
1765If
1766.Va moused_type
1767is set, these are the additional flags to pass to the
1768.Xr moused 8
1769daemon.
1770.It Va mousechar_start
1771.Pq Vt int
1772If set to
1773.Dq Li NO ,
1774the default mouse cursor character range
1775.Li 0xd0 Ns - Ns Li 0xd3
1776is used,
1777otherwise the range start is set
1778to
1779.Ar value
1780character, see
1781.Xr vidcontrol 1 .
1782Use if the default range is occupied in the language code table.
1783.It Va allscreens_flags
1784.Pq Vt str
1785If set,
1786.Xr vidcontrol 1
1787is run with these options for each of the virtual terminals
1788.Pq Pa /dev/ttyv* .
1789For example,
1790.Dq Fl m Cm on
1791will enable the mouse pointer on all virtual terminals
1792if
1793.Va moused_enable
1794is set to
1795.Dq Li YES .
1796.It Va allscreens_kbdflags
1797.Pq Vt str
1798If set,
1799.Xr kbdcontrol 1
1800is run with these options for each of the virtual terminals
1801.Pq Pa /dev/ttyv* .
1802For example,
1803.Dq Fl h Li 200
1804will set the
1805.Xr syscons 4
1806scrollback (history) buffer to 200 lines.
1807.It Va cron_enable
1808.Pq Vt bool
1809If set to
1810.Dq Li YES ,
1811run the
1812.Xr cron 8
1813daemon at system boot time.
1814.It Va cron_program
1815.Pq Vt str
1816Path to
1817.Xr cron 8
1818(default
1819.Pa /usr/sbin/cron ) .
1820.It Va cron_flags
1821.Pq Vt str
1822If
1823.Va cron_enable
1824is set to
1825.Dq Li YES ,
1826these are the flags to pass to
1827.Xr cron 8 .
1828.It Va lpd_program
1829.Pq Vt str
1830Path to
1831.Xr lpd 8
1832(default
1833.Pa /usr/sbin/lpd ) .
1834.It Va lpd_enable
1835.Pq Vt bool
1836If set to
1837.Dq Li YES ,
1838run the
1839.Xr lpd 8
1840daemon at system boot time.
1841.It Va lpd_flags
1842.Pq Vt str
1843If
1844.Va lpd_enable
1845is set to
1846.Dq Li YES ,
1847these are the flags to pass to the
1848.Xr lpd 8
1849daemon.
1850.It Va mta_start_script
1851.Pq Vt str
1852This variable specifies the full path to the script to run to start
1853a mail transfer agent.
1854The default is
1855.Pa /etc/rc.sendmail .
1856The
1857.Va sendmail_*
1858variables which
1859.Pa /etc/rc.sendmail
1860uses are documented in the
1861.Xr rc.sendmail 8
1862man page.
1863.It Va dumpdev
1864.Pq Vt str
1865Indicates the device (usually a swap partition) to which a crash dump
1866should be written in the event of a system crash.
1867The value of this variable is passed as the argument to
1868.Xr dumpon 8 .
1869To disable crash dumps, set this variable to
1870.Dq Li NO .
1871.It Va dumpdir
1872.Pq Vt str
1873When the system reboots after a crash and a crash dump is found on the
1874device specified by the
1875.Va dumpdev
1876variable,
1877.Xr savecore 8
1878will save that crash dump and a copy of the kernel to the directory
1879specified by the
1880.Va dumpdir
1881variable.
1882The default value is
1883.Pa /var/crash .
1884Set to
1885.Dq Li NO
1886to not run
1887.Xr savecore 8
1888at boot time when
1889.Va dumpdir
1890is set.
1891.It Va savecore_flags
1892.Pq Vt str
1893If crash dumps are enabled, these are the flags to pass to the
1894.Xr savecore 8
1895utility.
1896.It Va enable_quotas
1897.Pq Vt bool
1898Set to
1899.Dq Li YES
1900to turn on user disk quotas on system startup via the
1901.Xr quotaon 8
1902command.
1903.It Va check_quotas
1904.Pq Vt bool
1905Set to
1906.Dq Li YES
1907to enable user disk quota checking via the
1908.Xr quotacheck 8
1909command.
1910.It Va accounting_enable
1911.Pq Vt bool
1912Set to
1913.Dq Li YES
1914to enable system accounting through the
1915.Xr accton 8
1916facility.
1917.It Va ibcs2_enable
1918.Pq Vt bool
1919Set to
1920.Dq Li YES
1921to enable iBCS2 (SCO) binary emulation at system initial boot
1922time.
1923.It Va ibcs2_loaders
1924.Pq Vt str
1925If not set to
1926.Dq Li NO
1927and if
1928.Va ibcs2_enable
1929is set to
1930.Dq Li YES ,
1931this specifies a list of additional iBCS2 loaders to enable.
1932.It Va linux_enable
1933.Pq Vt bool
1934Set to
1935.Dq Li YES
1936to enable Linux/ELF binary emulation at system initial
1937boot time.
1938.It Va osf1_enable
1939.Pq Vt bool
1940Set to
1941.Dq Li YES
1942to enable OSF/1 (Digital UNIX) binary emulation at system
1943initial boot time.
1944(alpha)
1945.It Va clear_tmp_enable
1946.Pq Vt bool
1947Set to
1948.Dq Li YES
1949to have
1950.Pa /tmp
1951cleaned at startup.
1952.It Va ldconfig_paths
1953.Pq Vt str
1954Set to the list of shared library paths to use with
1955.Xr ldconfig 8 .
1956NOTE:
1957.Pa /usr/lib
1958will always be added first, so it need not appear in this list.
1959.It Va ldconfig_insecure
1960.Pq Vt bool
1961The
1962.Xr ldconfig 8
1963utility normally refuses to use directories
1964which are writable by anyone except root.
1965Set this variable to
1966.Dq Li YES
1967to disable that security check during system startup.
1968.It Va kern_securelevel_enable
1969.Pq Vt bool
1970Set to
1971.Dq Li YES
1972to set the kernel security level at system startup.
1973.It Va kern_securelevel
1974.Pq Vt int
1975The kernel security level to set at startup.
1976The allowed range of
1977.Ar value
1978ranges from \-1 (the compile time default) to 3 (the
1979most secure).
1980See
1981.Xr init 8
1982for the list of possible security levels and their effect
1983on system operation.
1984.It Va lomac_enable
1985.Pq Vt bool
1986Set to
1987.Dq Li YES
1988to enable Low Watermark Mandatory Access Control (LOMAC) at boot time.
1989This security model enforces integrity constraints for system processes;
1990see
1991.Xr lomac 4
1992for a complete description of the LOMAC model, as well as its impact
1993on system operation.
1994.It Va start_vinum
1995.Pq Vt bool
1996Set to
1997.Dq Li YES
1998to start
1999.Xr vinum 8
2000at system boot time.
2001.It Va sshd_program
2002.Pq Vt str
2003Path to the SSH server program
2004.Pa ( /usr/sbin/sshd
2005is the default).
2006.It Va sshd_enable
2007.Pq Vt bool
2008Set to
2009.Dq Li YES
2010to start
2011.Xr sshd 8
2012at system boot time.
2013.It Va sshd_flags
2014.Pq Vt str
2015If
2016.Va sshd_enable
2017is set to
2018.Dq Li YES ,
2019these are the flags to pass to the
2020.Xr sshd 8
2021daemon.
2022.It Va unaligned_print
2023.Pq Vt bool
2024If set to
2025.Dq Li NO ,
2026unaligned access warnings will not be printed.
2027(alpha)
2028.\" ----- isdn settings ---------------------------------
2029.It Va isdn_enable
2030.Pq Vt bool
2031Set to
2032.Dq Li NO
2033by default.
2034When set to
2035.Dq Li YES ,
2036starts the
2037.Xr isdnd 8
2038daemon
2039at system boot time.
2040.It Va isdn_flags
2041.Pq Vt str
2042Set to
2043.Dq Fl d Ns Cm n Fl d Ns Li 0x1f9
2044by default.
2045Additional flags to pass to
2046.Xr isdnd 8
2047(but see
2048.Va isdn_fsdev
2049and
2050.Va isdn_ttype
2051for certain tunable parameters).
2052.It Va isdn_ttype
2053.Pq Vt str
2054Set to
2055.Dq Li cons25
2056by default.
2057The terminal type of the output device when
2058.Xr isdnd 8
2059operates in full-screen mode.
2060.It Va isdn_screenflags
2061.Pq Vt str
2062Set to
2063.Dq Li NO
2064by default.
2065The video mode for full-screen mode (only for
2066.Xr syscons 4
2067console driver, see
2068.Xr vidcontrol 1
2069for valid modes).
2070.It Va isdn_fsdev
2071.Pq Vt str
2072Set to
2073.Dq Li NO
2074by default.
2075The output device for
2076.Xr isdnd 8
2077in full-screen mode (or
2078.Dq Li NO
2079for daemon mode).
2080.It Va isdn_trace
2081.Pq Vt bool
2082Set to
2083.Dq Li NO
2084by default.
2085When set to
2086.Dq Li YES ,
2087enables the ISDN protocol trace utility
2088.Xr isdntrace 8
2089at system boot time.
2090.It Va isdn_traceflags
2091.Pq Vt str
2092Set to
2093.Dq Fl f Pa /var/tmp/isdntrace0
2094by default.
2095Flags for
2096.Xr isdntrace 8 .
2097.\" -----------------------------------------------------
2098.It Va pcvt_verbose
2099.Pq Vt bool
2100Set to
2101.Dq Li NO
2102by default.
2103When set to
2104.Dq Li YES ,
2105verbose messages about the actions done by the start script are displayed.
2106.Em Note :
2107the
2108.Xr pcvt 4
2109driver must be compiled into the kernel before the
2110.Xr pcvt 4
2111related
2112options described here take any effect.
2113.It Va pcvt_keymap
2114.Pq Vt str
2115Set to
2116.Dq Li NO
2117by default.
2118Use this to configure a national keyboard mapping found in the
2119.Pa /usr/share/misc/keycap.pcvt
2120file of keyboard mappings.
2121(See also the manual pages
2122.Xr keycap 5
2123and
2124.Xr keycap 3
2125for usage of
2126.Xr pcvt 4 Ns 's
2127keycap database and the manual page
2128.Xr kcon 1
2129option
2130.Fl m
2131for national keyboard mapping configuration.)
2132.It Va pcvt_keydel
2133.Pq Vt int
2134Set to
2135.Dq Li NO
2136by default.
2137Used to set the keyboard key repeat delay value.
2138Valid values are
2139in the range 0..3 for delay values of 250, 500, 750 and 1000 msec.
2140(See also the
2141.Xr kcon 1
2142manual page.)
2143.It Va pcvt_keyrate
2144.Pq Vt int
2145Set to
2146.Dq Li NO
2147by default.
2148Used to set the keyboard key repetition rate value.
2149Valid values are
2150in the range 0..31 for repetition values of 2..30 characters per second.
2151.It Va pcvt_keyrepeat
2152.Pq Vt bool
2153Set to
2154.Dq Li NO
2155by default.
2156Set to
2157.Dq Li YES
2158to enable automatic keyboard key repeating.
2159.It Va pcvt_force24
2160.Pq Vt bool
2161Set to
2162.Dq Li NO
2163by default.
2164Set to
2165.Dq Li YES
2166to force
2167.Xr pcvt 4
2168to use 24 lines only (in 25 lines mode) for compatibility
2169with the original
2170.Tn VT220
2171terminal.
2172.It Va pcvt_hpext
2173.Pq Vt bool
2174Set to
2175.Dq Li NO
2176by default.
2177Set to
2178.Dq Li YES
2179to enable the display and functionality of function key labels (as found
2180on
2181.Tn Hewlett-Packard
2182terminals such as the
2183.Tn HP2392A
2184and the
2185.Tn HP700/92
2186in
2187.Tn ANSI
2188mode).
2189.It Va pcvt_lines
2190.Pq Vt int
2191Set to
2192.Dq Li NO
2193by default resulting in a value of 25.
2194Used to set the number of lines on the screen.
2195For VGA displays, valid
2196values are 25, 28, 40 and 50 lines.
2197(See also the
2198.Xr scon 1
2199manual page.)
2200.It Va pcvt_blanktime
2201.Pq Vt int
2202Set to
2203.Dq Li NO
2204by default.
2205Used to set the screen saver timeout in seconds for values greater than
2206zero.
2207.It Va pcvt_cursorh
2208.Pq Vt int
2209Set to
2210.Dq Li NO
2211by default.
2212Used to set the cursor top scanline.
2213(See also the
2214.Xr cursor 1
2215manual page.)
2216.It Va pcvt_cursorl
2217.Pq Vt int
2218Set to
2219.Dq Li NO
2220by default.
2221Used to set the cursor bottom scanline.
2222.It Va pcvt_monohigh
2223.Pq Vt bool
2224Set to
2225.Dq Li NO
2226by default.
2227Set to
2228.Dq Li YES
2229to set intensity to high on monochrome monitors.
2230(See also the
2231.Xr scon 1
2232manual page, option
2233.Fl p ,
2234for more information on changing VGA palette
2235values.)
2236.El
2237.Sh FILES
2238.Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
2239.It Pa /etc/defaults/rc.conf
2240.It Pa /etc/rc.conf
2241.It Pa /etc/rc.conf.local
2242.El
2243.Sh SEE ALSO
2244.Xr catman 1 ,
2245.Xr gdb 1 ,
2246.Xr info 1 ,
2247.Xr kbdcontrol 1 ,
2248.Xr makewhatis 1 ,
2249.Xr vidcontrol 1 ,
2250.Xr tcp 4 ,
2251.Xr udp 4 ,
2252.Xr exports 5 ,
2253.Xr motd 5 ,
2254.Xr accton 8 ,
2255.Xr amd 8 ,
2256.Xr apm 8 ,
2257.Xr atm 8 ,
2258.Xr cron 8 ,
2259.Xr dhclient 8 ,
2260.Xr gated 8 ,
2261.Xr ifconfig 8 ,
2262.Xr inetd 8 ,
2263.Xr isdnd 8 ,
2264.Xr isdntrace 8 ,
2265.Xr lpd 8 ,
2266.Xr mdconfig 8 ,
2267.Xr moused 8 ,
2268.Xr mrouted 8 ,
2269.Xr named 8 ,
2270.Xr nfsd 8 ,
2271.Xr ntpd 8 ,
2272.Xr ntpdate 8 ,
2273.Xr pcnfsd 8 ,
2274.Xr quotacheck 8 ,
2275.Xr quotaon 8 ,
2276.Xr rc 8 ,
2277.Xr rc.sendmail 8 ,
2278.Xr route 8 ,
2279.Xr routed 8 ,
2280.Xr rpc.lockd 8 ,
2281.Xr rpc.statd 8 ,
2282.Xr rpcbind 8 ,
2283.Xr rwhod 8 ,
2284.Xr savecore 8 ,
2285.Xr sshd 8 ,
2286.Xr swapon 8 ,
2287.Xr sysctl 8 ,
2288.Xr syslogd 8 ,
2289.Xr timed 8 ,
2290.Xr vinum 8 ,
2291.Xr xtend 8 ,
2292.Xr yp 8 ,
2293.Xr ypbind 8 ,
2294.Xr ypserv 8 ,
2295.Xr ypset 8
2296.Sh HISTORY
2297The
2298.Nm
2299file appeared in
2300.Fx 2.2.2 .
2301.Sh AUTHORS
2302.An Jordan K. Hubbard .
2303