xref: /netbsd-src/share/man/man5/rc.conf.5 (revision 2a399c6883d870daece976daec6ffa7bb7f934ce)
1.\"	$NetBSD: rc.conf.5,v 1.15 1997/11/23 04:18:14 mrg Exp $
2.\"
3.\" Copyright (c) 1996 Matthew R. Green
4.\" Copyright (c) 1997 Curt J. Sampson
5.\" Copyright (c) 1997 Michael W. Long
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the author may not be used to endorse or promote products
17.\"    derived from this software without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd March 22, 1997
32.Dt RC.CONF 5
33.Os NetBSD 1.3
34.\" turn off hyphenation
35.hym 999
36.Sh NAME
37.Nm rc.conf
38.Nd system startup configuration file
39.Sh DESCRIPTION
40The
41.Nm
42file specifies which services are enabled during system startup by
43the startup script
44.Pa /etc/rc .
45The
46.Nm
47file is a shell script that is sourced by
48.Pa /etc/rc
49if it exists, meaning that
50.Nm
51must contain valid shell commands.
52.Pp
53Listed below are the
54.Nm
55variables that may be set, the values to which each may be set,
56a brief description of what each variable does, and a reference to
57relevant manual pages.
58.Pp
59Most variables are one of two types: enabling variables or flags
60variables.  Enabling variables, such as
61.Sy inetd ,
62are generally named after the program or the system they enable,
63and are set to "YES" or "NO".  Flags variables, such as
64.Sy inetd_flags
65have the same name with "_flags" appended, and determine what
66arguments are passed to the program if it is enabled.
67.Pp
68If a variable that
69.Pa /etc/rc
70expects to be set is not set, or the value is not one of the allowed
71values, a warning will be printed.
72.Pp
73Basic network configuration:
74.Bl -tag -width net_interfaces
75.It Sy hostname
76Name of host.
77If empty or not set, then the contents of
78.Pa /etc/myname
79(if it exists) are used.
80.It Sy domainname
81YP (NIS) domain of host.
82If empty or not set, then the contents of
83.Pa /etc/defaultdomain
84(if it exists) are used.
85.It Sy defaultroute
86Default network route.
87If empty or not set, then the contents of
88.Pa /etc/mygate
89(if it exists) are used.
90.El
91.Pp
92Boottime file-system and swap configuration:
93.Bl -tag -width critical_filesystems
94.It Sy critical_filesystems
95File systems mounted very early in the system boot, except for the
96.Pa /usr
97and
98.Pa /var
99file-systems.
100.It Sy no_swap
101Set the
102.Sy no_swap
103variable to YES if you have configured your system with no swap on
104purpose.  If not set, or set to anything other than YES, and no
105swap devices are configured, the system will warn you.
106.El
107.Pp
108One-time actions to perform or programs to run on boot-up:
109.Bl -tag -width net_interfaces
110.It Sy lkm
111YES or NO.  Runs
112.Pa /etc/rc.lkm .
113.It Sy savecore
114YES or NO.  Runs the
115.Xr savecore 8
116utility.  Passes
117.Sy savecore_flags .
118.It Sy update_motd
119YES or NO.  Updates the
120.Nx
121version string in the
122.Pa /etc/motd
123file to reflect the version of the running kernel.  See
124.Xr motd 5 .
125.El
126.Pp
127Networking startup:
128.Bl -tag -width net_interfaces
129.It Sy ipfilter
130YES or NO.  Runs
131.Xr ipf 8
132to load in packet filter specifications from
133.Pa /etc/ipf.conf
134at network boot time, before any interfaces are configured.  See
135.Xr ipf 5 .
136.It Sy auto_ifconfig
137YES or NO.  Sets the
138.Sy net_interfaces
139variable (see below) to the output of
140.Xr ifconfig 8
141with the
142.Ar -l
143flag and suppresses warnings about interfaces in this list that
144do not have an ifconfig file or variable.
145.It Sy net_interfaces
146The list of network interfaces to be configured at boot time.
147For each interface "xxn", the system first looks for ifconfig
148parameters in
149.Pa /etc/ifconfig.xxn
150and then in the variable
151.Sy ifconfig_xxn .
152The contents of the file or the variable are handed to ifconfig
153after the interface name.  If
154.Sy auto_ifconfig
155is set to "NO" and neither the file nor the variable is found,
156a warning is printed.
157.It Sy ifaliases_*
158List of
159.Sq Ar "address netmask"
160pairs to configure additional network addresses for the given
161configured interface
162.Dq *
163(e.g.
164.Sy ifaliases_le0 ) .
165If
166.Ar netmask
167is
168.Dq - ,
169then use the default netmask for the interface.
170.It Sy flushroutes
171YES or NO.  Flushes the route table on networking startup.  Useful
172when coming up to multiuser mode after going down to single-user
173mode.
174.It Sy ntpdate
175YES or NO.  Runs
176.Xr ntpdate 8
177to set the system time from one of the hosts in
178.Sy ntpdate_hosts .
179If
180.Sy ntpdate_hosts
181is empty, it will attempt to find a list of hosts in
182.Pa /etc/ntp.conf .
183.It Sy ppp_peers
184If
185.Sy ppp_peers
186is not empty, then
187.Pa /etc/netstart
188will check each word in
189.Sy ppp_peers
190for a coresponding ppp configuration file in
191.Pa /etc/ppp/peers
192and will call
193.Xr pppd 8
194with the
195.Dq call Sy peer
196option.
197.El
198.Pp
199Daemons required by other daemons:
200.Bl -tag -width net_interfaces
201.It Sy inetd
202YES or NO.  Runs the
203.Xr inetd 8
204daemon to start network server processes (as listed in
205.Pa /etc/inetd.conf )
206as necessary.  Passes
207.Sy inetd_flags .
208The
209.Ar -l
210flag turns on libwrap connection logging.
211.It Sy portmap
212YES or NO.  The
213.Xr portmap 8
214daemon is required for any
215.Xr rpc 3
216services.  These include NFS, YP,
217.Xr bootparamd 8 ,
218.Xr rstatd 8 ,
219.Xr rusersd 8 ,
220and
221.Xr rwalld 8 .
222.El
223.Pp
224Commonly used daemons:
225.Bl -tag -width net_interfaces
226.It Sy update
227YES or NO.  Runs
228.Xr update 8
229and passes
230.Sy update_flags .
231.It Sy syslogd
232YES or NO.  Runs
233.Xr syslogd 8
234and passes
235.Sy syslogd_flags .
236.It Sy named
237YES or NO.  Runs
238.Xr named 8
239and passes
240.Sy named_flags .
241.It Sy timed
242YES or NO.  Runs
243.Xr timed 8
244and passes
245.Sy timed_flags .
246The
247.Ar -M
248option allows
249.Xr timed 8
250to be a master time source as well as a slave. If you are also running
251.Xr xntpd 8 ,
252only one machine running both should have the
253.Ar -M
254flag given to
255.Xr timed 8 .
256.It Sy xntpd
257YES or NO.  Runs
258.Xr xntpd 8
259and passes
260.Sy xntpd_flags .
261.It Sy sendmail
262YES or NO.  Runs
263.Xr sendmail 8
264and passes
265.Sy sendmail_flags .
266.It Sy lpd
267YES or NO.  Runs
268.Xr lpd 8
269and passes
270.Sy lpd_flags .
271The
272.Ar -l
273flag will turn on extra logging.
274.El
275.Pp
276Routing daemons:
277.Bl -tag -width net_interfaces
278.It Sy routed
279YES or NO.  Runs
280.Xr routed 8 ,
281the RIP routing protocol daemon.  Passes
282.Sy routed_flags .
283This should be NO if
284.Sy gated
285is YES.
286.It Sy gated
287YES or NO.  Runs
288.Xr gated 8 ,
289the multiprotocol routing daemon.  Passes
290.Sy gated_flags .
291This should be NO if
292.Sy routed
293is YES.
294.Xr Gated 8
295is not included with
296.Nx .
297.It Sy mrouted
298YES or NO.  Runs
299.Xr mrouted 8 ,
300the DVMRP multicast routing protocol daemon. Passes
301.Sy mrouted_flags .
302.El
303.Pp
304Daemons used to boot other hosts over a network:
305.Bl -tag -width net_interfaces
306.It Sy rarpd
307YES or NO.  Runs
308.Xr rarpd 8 ,
309the reverse ARP daemon, often used to boot
310.Nx
311and Sun workstations.  Passes
312.Sy rarpd_flags .
313.It Sy bootparamd
314YES or NO.  Runs
315.Xr bootparamd 8 ,
316the boot parameter server, with
317.Sy bootparamd_flags
318as options. Used to boot
319.Nx
320and SunOS 4.x systems.
321.It Sy dhcpd
322YES or NO.  Runs
323.Xr dhcpd 8 ,
324the Dynamic Host Configuration Protocol daemon, for assigning IP addresses to
325hosts and passing boot information.  Passes
326.Sy dhcpd_flags .
327.It Sy rbootd
328YES or NO.  Runs
329.Xr rbootd 8 ,
330the HP boot protocol daemon; used for booting HP workstations.  Passes
331.Sy rbootd_flags .
332.It Sy mopd
333YES or NO.  Runs
334.Xr mopd 8 ,
335the DEC MOP protocol daemon; used for booting VAX and other DEC machines.
336Passes
337.Sy mopd_flags .
338.El
339.Pp
340YP (NIS) daemons:
341.Bl -tag -width net_interfaces
342.It Sy ypbind
343YES or NO.  Runs
344.Xr ypbind 8 ,
345which lets YP (NIS) clients use information from a YP server.  Passes
346.Sy ypbind_flags .
347.It Sy ypserv
348YES or NO.  Runs
349.Xr ypserv 8 ,
350the YP (NIS) server for distributing information from certain files in
351.Pa /etc .
352Passes
353.Sy ypserv_flags .
354The
355.Ar -d
356flag causes it to use DNS for lookups in
357.Pa /etc/hosts
358that fail.
359.It Sy yppasswdd
360YES or NO.  Runs
361.Xr yppasswdd 8 ,
362which allows remote YP users to update password on master server.  Passes
363.Sy yppasswdd_flags .
364.El
365.Pp
366NFS daemons and parameters:
367.Bl -tag -width net_interfaces
368.It Sy nfs_client
369YES or NO.  Runs
370.Xr nfsiod 8
371to increase performance of an NFS client host.  Passes
372.Sy nfsiod_flags .
373.It Sy nfs_server
374YES or NO.  Sets up a host to be a NFS server by running
375.Xr mountd 8
376and
377.Xr nfsd 8 , and passing
378.Sy mountd_flags
379and
380.Sy nfsd_flags
381to them, respectively.
382.It Sy lockd
383YES or NO.  Runs
384.Xr rpc.lockd 8
385if either
386.Sy nfs_server
387or
388.Sy nfs_client
389is (or both are) set to YES.  Passes
390.Sy lockd_flags .
391.It Sy statd
392YES or NO.  Runs
393.Xr rpc.statd 8 ,
394a status monitoring daemon used when
395.Xr lockd 8
396is running, if either
397.Sy nfs_server
398or
399.Sy nfs_client
400is (or both are) set to YES.  Passes
401.Sy statd_flags .
402
403.It Sy amd
404YES or NO.  Runs
405.Xr amd 8 ,
406the automounter daemon, which automatically mounts NFS file systems
407whenever a file or directory within that filesystem is accessed.  Passes
408.Sy amd_flags .
409.It Sy amd_dir
410The
411.Xr amd 8
412mount directory.  Used only if
413.Sy amd
414is set to YES.
415.It Sy amd_master
416The
417.Xr amd 8
418automounter master map.
419Used only if
420.Sy amd
421is set to YES.
422.El
423.Pp
424X Window System daemons:
425.Bl -tag -width net_interfaces
426.It Sy xfs
427YES or NO.  Runs the
428.Xr xfs 1
429X11 font server, which supplies local X font files to X terminals.
430.It Sy xdm
431YES or NO.  Runs the
432.Xr xdm 1
433X display manager.
434
435These X daemons are available only with the optional X distribution of
436.Nx .
437.El
438.Pp
439Other daemons:
440.Bl -tag -width net_interfaces
441.It Sy apmd
442YES or NO.  Runs
443.Xr apmd 8
444and passes
445.Sy apmd_flags .
446.It Sy rwhod
447YES or NO.  Runs
448.Xr rwhod 8
449to support the
450.Xr rwho 1
451command.
452.It Sy kerberos
453YES or NO.  Runs the kerberos  server
454.Xr kerberos 8
455and the kerberos  admininstration server,
456.Xr kadmind 8 .
457This should only be run on the kerberos master server.
458Both servers implement version IV of the Kerberos protocol, not the
459newer Kerberos version 5.
460The kerberos server is only available with the domestic distribution of
461.Nx .
462.El
463.Sh FILES
464.Pa /etc/rc.conf
465.Sh SEE ALSO
466.Xr boot 8 ,
467.Xr rc 8
468.Sh HISTORY
469The
470.Nm
471file appeared in
472.Nx 1.3 .
473