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