xref: /freebsd/share/man/man5/rc.conf.5 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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.\"     $Id: rc.conf.5,v 1.2 1997/09/11 14:31:55 jkh Exp $
26.\"
27.Dd April 26, 1997
28.Dt RC.CONF 5
29.Os FreeBSD 2.2.2
30.Sh NAME
31.Nm rc.conf
32.Nd local configuration information.
33.Sh DESCRIPTION
34The file
35.Nm rc.conf
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.  In new installations, the
39.Nm rc.conf
40file is generally initialized by the system installation utility:
41.Pa /stand/sysinstall .
42.Pp
43It is the duty of the system administrator to properly maintain this file
44as changes occur on the local host.
45.Sh FILES
46.Bl -tag -width /etc/rc.conf -compact
47.It Pa /etc/rc.conf
48.El
49.Sh DESCRIPTION
50The purpose of
51.Nm
52is not to run commands or perform system startup actions
53directly.  Instead, it is included by the
54various generic startup scripts in
55.Pa /etc
56which conditionalize their
57internal actions according to the settings found there.
58.Pp
59The following list provides a name and short description for each
60variable you can set in the
61.Nm
62file:
63.Bl -tag -width Ar
64.It Ar swapfile
65(str) If set to
66.Ar NO
67then no swapfile is installed, otherwise the value is used as the full
68pathname to a file to use for additional swap space.
69.It Ar apm_enable
70(bool) If set to
71.Ar YES ,
72enable support for Automatic Power Management with
73the
74.Xr apm 8
75command.
76.It Ar pccard_enable
77(bool) If set to
78.Ar YES ,
79enable PCCARD support at boot time.
80.It Ar pccard_mem
81(str) Set to PCCARD controller memory address or
82.Ar DEFAULT
83for the default value.
84.It Ar pccard_ifconfig
85(str) List of ethernet devices (e.g.
86.Ar "ed0 ed1 ep0 ..." )
87which should be dynamically ifconfig'd on insertion or boot.
88.It Ar local_startup
89(str) List of directories to search for startup script files.
90.It Ar local_periodic
91(str) List of directories to search for periodic scripts (3.0 only).
92.It Ar hostname
93(str) The Fully Qualified Domain Name of your host on the network.
94This should almost certainly be set to something meaningful, even if
95you've no network connected.
96.It Ar nisdomainname
97(str) The NIS domainname of your host, or
98.Ar NO
99if you're not running NIS.
100.It Ar firewall
101(str) Set to
102.Ar NO
103if you don't want to use one of the firewall definitions in
104.Pa /etc/rc.firewall ,
105otherwise it should name of one of the firewalls defined there.
106.It Ar tcp_extensions
107(bool) Set to
108.Ar YES
109by default, this enables certain TCP options as described by
110Internet RFCs 1323 and 1644.  If you have problems with connections
111randomly hanging or other weird behavior of such nature, you might
112try setting this to
113.Ar NO
114and seeing if that helps.  Some hardware/software out there is known
115to be broken with respect to these options.
116.It Ar network_interfaces
117(str) Set to the list of network interfaces to configure on this host.
118For example, if you had a loopback device (standard) and an SMC Elite
119Ultra NIC, you might have this set to
120.Qq Ar "lo0 ed0"
121for the two interfaces.  An
122.No ifconfig_ Ns Em interface
123variable is also assumed to exist for each value of
124.Em interface .
125It is also possible to add IP alias entries here in cases where you
126want a single interface to have multiple IP addresses registered against
127it.
128Assuming that the interface in question was ed0, it might look
129something like this:
130.Bd -literal
131ifconfig_ed0_alias0="inet 127.0.0.253 netmask 0xffffffff"
132ifconfig_ed0_alias1="inet 127.0.0.254 netmask 0xffffffff"
133
134.Ed
135And so on.  For each ifconfig_<interface>_alias<n> entry that is
136found, its contents are passed to
137.Xr ifconfig 8 .
138Execution stops at the first unsuccessful access, so if you
139had something like:
140.Bd -literal
141ifconfig_ed0_alias0="inet 127.0.0.251 netmask 0xffffffff"
142ifconfig_ed0_alias1="inet 127.0.0.252 netmask 0xffffffff"
143ifconfig_ed0_alias2="inet 127.0.0.253 netmask 0xffffffff"
144ifconfig_ed0_alias4="inet 127.0.0.254 netmask 0xffffffff"
145
146.Ed
147Then note that alias4 would \fBnot\fR be added since the search would
148stop with the missing alias3 entry.
149.It Ar syslogd_enable
150(bool) If set to
151.Ar YES ,
152run the
153.Xr syslogd 8
154daemon.
155.It Ar syslogd_flags
156(str) if syslogd_enable is set to
157.Ar YES ,
158these are the flags to pass to
159.Xr syslogd 8 .
160.It Ar inetd_enable
161(bool) If set to
162.Ar YES ,
163run the
164.Xr inetd 8
165daemon.
166.It Ar inetd_flags
167(str) if inetd_enable is set to
168.Ar YES ,
169these are the flags to pass to
170.Xr inetd 8 .
171.It Ar named_enable
172(bool) If set to
173.Ar YES ,
174run the
175.Xr named 8
176daemon.
177.It Ar named_flags
178(str) if
179.Ar named_enable
180is set to
181.Ar YES ,
182these are the flags to pass to
183.Xr named 8 .
184.It Ar kerberos_server_enable
185(bool) Set to
186.Ar YES
187if you want to run a Kerberos authentication server
188at boot time.
189.It Ar rwhod_enable
190(bool) If set to
191.Ar YES ,
192run the
193.Xr rwhod 8
194daemon at boot time.
195.It Ar amd_enable
196(bool) If set to
197.Ar YES ,
198run the
199.Xr amd 8
200daemon at boot time.
201.It Ar amd_flags
202(str) If
203.Ar amd_enable
204is set to
205.Ar YES ,
206these are the flags to pass to it.  Use the \fBinfo amd\fR
207command for more information.
208.It Ar nfs_client_enable
209(bool) If set to
210.Ar YES ,
211run the NFS client daemons at boot time.
212.It Ar nfs_client_flags
213(str) If
214.Ar nfs_client_enable
215is set to
216.Ar YES ,
217these are the flags to pass to the
218.Xr nfsiod 8
219daemon.
220.It Ar nfs_server_enable
221(bool) If set to
222.Ar YES ,
223run the NFS server daemons at boot time.
224.It Ar nfs_server_flags
225(str) If
226.Ar nfs_server_enable
227is set to
228.Ar YES ,
229these are the flags to pass to the
230.Xr nfsd 8
231daemon.
232.It Ar weak_mountd_authentication
233(bool) If set to
234.Ar YES ,
235allow services like \fBPCNFSD\fR to make non-privileged mount
236requests.
237.It Ar nfs_reserved_port_only
238(bool) If set to
239.Ar YES ,
240provide NFS services only on a secure port.
241.It Ar rcp_lockd_enable
242(bool) If set to
243.Ar YES
244and also an NFS server, run
245.Xr rpc.lockd 8
246at boot time.
247.It Ar rcp_statd_enable
248(bool) If set to
249.Ar YES
250and also an NFS server, run
251.Xr rpc.statd 8
252at boot time.
253.It Ar portmap_enable
254(bool) If set to
255.Ar YES ,
256run the
257.Xr portmap 8
258service at boot time.
259.It Ar portmap_flags
260(str) If
261.Ar portmap_enable
262is set to
263.Ar YES ,
264these are the flags to pass to the
265.Xr portmap 8
266daemon.
267.It Ar xtend_enable
268(bool) If set to
269.Ar YES
270then run the
271.Xr xtend 8
272daemon at boot time.
273.It Ar xtend_flags
274(str) If
275.Ar xtend_enable
276is set to
277.Ar YES ,
278these are the flags to pass to the
279.Xr xtend 8
280daemon.
281.It Ar timed_enable
282(boot) if
283.Ar YES
284then run the
285.Xr timed 8
286service at boot time.  This command is intended for networks of
287machines where a consistent
288.Qq "network time"
289for all hosts must be established.  This is often useful in large NFS
290environments where time stamps on files are expected to be consistent
291network-wide.
292.It Ar timed_flags
293(str) If
294.Ar timed_enable
295is set to
296.Ar YES ,
297these are the flags to pass to the
298.Xr timed 8
299service.
300.It Ar ntpdate_enable
301(bool) If set to
302.Ar YES ,
303run ntpdate at system startup.  This command is intended to
304synchronize the system clock only
305.Ar once
306from some standard reference.  An option to set this up initially
307(from a list of known servers) is also provided by the
308.Pa /stand/sysinstall
309program when the system is first installed.
310.It Ar ntpdate_flags
311(str) If
312.Ar ntpdate_enable
313is set to
314.Ar YES ,
315these are the flags to pass to the
316.Xr ntpdate 8
317command (typically a hostname).
318.It Ar xntpd_enable
319(bool) If set to
320.Ar YES
321then run the
322.Xr xntpd 8
323command at boot time.
324.It Ar xntpd_flags
325(str) If
326.Ar xntpd_enable
327is set to
328.Ar YES ,
329these are the flags to pass to the
330.Xr xntpd 8
331daemon.
332.It Ar tickadj_enable
333(bool) If set to
334.Ar YES
335then run the
336.Xr tickadj 8
337command at system boot time.
338.It Ar tickadj_flags
339(str) If
340.Ar tickadj_enable
341is set to
342.Ar YES ,
343these are the flags to pass to the
344.Xr tickadj 8
345command.
346.It Ar nis_client_enable
347(bool) If set to
348.Ar YES
349then run the
350.Xr ypbind 8
351service at system boot time.
352.It Ar nis_client_flags
353(str) If
354.Ar nis_client_enable
355is set to
356.Ar YES ,
357these are the flags to pass to the
358.Xr ypbind 8
359service.
360.It Ar nis_ypset_enable
361(bool) If set to
362.Ar YES
363then run the
364.Xr ypset 8
365daemon at system boot time.
366.It Ar nis_ypset_flags
367(str) If
368.Ar nis_ypset_enable
369is set to
370.Ar YES ,
371these are the flags to pass to the
372.Xr ypset 8
373daemon.
374.It Ar nis_server_enable
375(bool) If set to
376.Ar YES
377then run the
378.Xr ypserv 8
379daemon at system boot time.
380.It Ar nis_server_flags
381(str) If
382.Ar nis_server_enable
383is set to
384.Ar YES ,
385these are the flags to pass to the
386.Xr ypserv 8
387daemon.
388.It Ar nis_ypxfrd_enable
389(bool) If set to
390.Ar YES
391then run the
392.Xr ypxfrd 8
393daemon at system boot time.
394.It Ar nis_ypxfrd_flags
395(str) If
396.Ar nis_ypxfrd_enable
397is set to
398.Ar YES ,
399these are the flags to pass to the
400.Xr ypxfrd 8
401daemon.
402.It Ar nis_yppasswdd_enable
403(bool) If set to
404.Ar YES
405then run the
406.Xr yppasswdd 8
407daemon at system boot time.
408.It Ar nis_yppasswdd_flags
409(str) If
410.Ar nis_yppasswdd_enable
411is set to
412.Ar YES ,
413these are the flags to pass to the
414.Xr yppasswdd 8
415daemon.
416.It Ar defaultrouter
417(str) If not set to
418.Ar NO
419then create a default route to this host name or IP address (use IP
420address value if you also require this router to get to a name
421server!)
422.It Ar static_routes
423(str) Set to the list of static routes you would like to add at system
424boot time.  If not set to
425.Ar NO
426then for each whitespace separated element in the value, a
427.No route_ Ns em element
428variable is assumed to exist for each instance
429of
430.Em element ,
431and will later be passed to a ``route add'' operation.
432.It Ar gateway_enable
433(bool) If set to
434.Ar YES ,
435then configure host to at as an IP router, e.g. to forward packets
436between interfaces.
437.It Ar router_enable
438(bool) If set to
439.Ar YES
440then run a routing daemon of some sort, based on the
441settings of
442.Ar router
443and
444.Ar router_flags .
445.It Ar router
446(str) If
447.Ar router_enable
448is set to
449.Ar YES ,
450this is the name of the routing daemon to use.
451.It Ar router_flags
452(str) If
453.Ar router_enable
454is set to
455.Ar YES ,
456these are the flags to pass to the routing daemon.
457.It Ar mrouted_enable
458(bool) If set to
459.Ar YES
460then run the multicast routing daemon,
461.Xr mrouted 8 .
462.It Ar ipxgateway_enable
463(bool) If set to
464.Ar YES
465then enable the routing of IPX traffic.
466.It Ar ipxrouted_enable
467(bool) If set to
468.Ar YES
469then run the
470.Xr ipxrouted 8
471daemon at system boot time.
472.It Ar ipxrouted_flags
473(str) If
474.Ar ipxrouted_enable
475is set to
476.Ar YES ,
477these are the flags to pass to the
478.Xr ipxrouted 8
479daemon.
480.It Ar keymap
481(str) If set to
482.Ar NO
483then no keymap is installed, otherwise the value is used to install
484the keymap file in
485.Pa /usr/share/syscons/keymaps/<value>.kbd
486.It Ar keyrate
487(str) The keyboard repeat speed.  Set to
488.Ar slow ,
489.Ar normal ,
490.Ar fast
491or
492.Ar NO
493if the default behavior is desired.
494.It Ar keychange
495(str) If not set to
496.Ar NO ,
497attempt to program the function keys with the value.  The value should
498be a single string of the form:
499.Qq Ar "<funkey_number> <new_value> [<funkey_number> <new_value>]..."
500.It Ar cursor
501(str) Can be set to the value of
502.Ar normal ,
503.Ar blink ,
504.Ar destructive
505or
506.Ar NO
507to set the cursor behavior explicitly or choose the default behavior.
508.It Ar scrnmap
509(str) If set to
510.Ar NO
511then no screen map is installed, otherwise the value is used to install
512the screen map file in
513.Pa /usr/share/syscons/scrnmaps/<value> .
514.It Ar font8x16
515(str) If set to
516.Ar NO
517then the default 8x16 font value is used for screen size requests, otherwise
518the value in
519.Pa /usr/share/syscons/fonts/<value>
520is used.
521.It Ar font8x14
522(str) If set to
523.Ar NO
524then the default 8x14 font value is used for screen size requests, otherwise
525the value in
526.Pa /usr/share/syscons/fonts/<value>
527is used.
528.It Ar font8x8
529(str) If set to
530.Ar NO
531then the default 8x8 font value is used for screen size requests, otherwise
532the value in
533.Pa /usr/share/syscons/fonts/<value>
534is used.
535.It Ar blanktime
536(int) If set to
537.Ar NO
538then the default screen blanking interval is used, otherwise it is set
539to
540.Ar value
541seconds.
542.It Ar saver
543(str) If not set to
544.Ar NO ,
545this is the actual screen saver to use (blank, snake, daemon, etc).
546.It Ar moused_type
547(str) If not set to
548.Ar NO ,
549this is the type of mouse you would like to use for doing
550cut/paste selection on the console.
551It should be chosen from the following list of types:
552.Bd -literal
553microsoft        Microsoft mouse
554mousesystems     Mouse systems Corp mouse
555mmseries         MM Series mouse
556logitech         Logitech mouse
557busmouse         A bus mouse
558mouseman         Logitech MouseMan and TrackMan
559ps/2             PS/2 mouse
560mmhittab         MM HitTablet
561
562.Ed
563It should also be noted that while this is enabled, any
564other client of the mouse (such as an X server) should access
565the mouse through the virtual mouse device:
566.Pa /dev/sysmouse
567and configure it as a mousesystems type mouse, since all
568mouse data is converted to this single canonical format when
569using
570.Xr moused 8 .
571.It Ar moused_port
572(str) If
573.Ar moused_type
574is set, this is the actual port the mouse is on.
575It might be
576.Pa /dev/cuaa0
577for a COM1 serial mouse or
578.Pa /dev/psm0
579for a PS/2 mouse, for example.
580.It Ar moused_flags
581(str) If
582.Ar moused_type
583is set, these are the additional flags to pass to the
584.Xr moused 8
585daemon.
586.It Ar cron_enable
587(bool) If set to
588.Ar YES
589then run the
590.Xr cron 8
591daemon at system boot time.
592.It Ar lpd_enable
593(bool) If set to
594.Ar YES
595then run the
596.Xr lpd 8
597daemon at system boot time.
598.It Ar lpd_flags
599(str) If
600.Ar lpd_enable
601is set to
602.Ar YES ,
603these are the flags to pass to the
604.Xr lpd 8
605daemon.
606.It Ar sendmail_enable
607(bool) If set to
608.Ar YES
609then run the
610.Xr sendmail 8
611daemon at system boot time.
612.It Ar sendmail_flags
613(str) If
614.Ar sendmail_enable
615is set to
616.Ar YES ,
617these are the flags to pass to the
618.Xr sendmail 8
619daemon.
620.It Ar savecore_enable
621(bool) If set to
622.Ar YES
623then save kernel crashdumps for debugging purposes when the system
624comes back up after a crash.  Crash images are typically stored in the
625.Pa /var/crash
626directory.
627.It Ar dumpdev
628(str) If not set to
629.Ar NO
630then point kernel crash-dumps at the swap device
631specified as
632.Em value .
633.It Ar check_quotas
634(bool) Set to
635.Ar YES
636if you want to enable user disk quota checking via the
637.Xr quotacheck 8
638command.
639.It Ar accounting_enable
640(bool) Set to
641.Ar YES
642if you wish to enable system accounting through the
643.Xr accton 8
644facility.
645.It Ar ibcs2_enable
646(bool) Set to
647.Ar YES
648if you wish to enable iBCS2 (SCO) binary emulation at system initial boot
649time.
650.It Ar linux_enable
651(bool) Set to
652.Ar YES
653if you wish to enable Linux/ELF binary emulation at system initial
654boot time.
655.It Ar rand_irqs
656(str) Set to the list of IRQs to monitor for random number creation
657(see the man page for
658.Xr rndcontrol 8 ).
659
660.Sh SEE ALSO
661.Xr gdb 1 ,
662.Xr info 1 ,
663.Xr exports 5 ,
664.Xr accton 8 ,
665.Xr amd 8 ,
666.Xr gated 8 ,
667.Xr ifconfig 8 ,
668.Xr named 8 ,
669.Xr ntpdate 8 ,
670.Xr pcnfsd 8 ,
671.Xr quotacheck 8 ,
672.Xr rc 8 ,
673.Xr rndcontrol 8 ,
674.Xr route 8 ,
675.Xr routed 8 ,
676.Xr rwhod 8 ,
677.Xr sendmail 8 ,
678.Xr swapon 8 ,
679.Xr timed 8 ,
680.Xr vnconfig 8 ,
681.Xr xntpd 8 ,
682.Xr xtend 8 ,
683.Xr ypserv 8 ,
684.Xr ypset 8
685.Sh HISTORY
686The
687.Nm
688file appeared in
689.Bx 2.2.2 .
690
691.Sh AUTHOR
692Jordan K. Hubbard.
693