xref: /netbsd-src/share/man/man5/rc.conf.5 (revision fdecd6a253f999ae92b139670d9e15cc9df4497c)
1.\"	$NetBSD: rc.conf.5,v 1.9 1997/05/12 11:28:19 lukem 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. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"      This product includes software developed by Matthew R. Green for
19.\"      the NetBSD Project.
20.\" 4. The name of the author may not be used to endorse or promote products
21.\"    derived from this software without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.Dd March 22, 1997
36.Dt RC.CONF 5
37.Os NetBSD 1.3
38.\" turn off hyphenation
39.hym 999
40.Sh NAME
41.Nm rc.conf
42.Nd system startup configuration file
43.Sh DESCRIPTION
44The
45.Nm
46file specifies which services are enabled during system startup by
47the startup script
48.Pa /etc/rc .
49The
50.Nm
51file is a shell script that is sourced by
52.Pa /etc/rc
53if it exists, meaning
54that
55.Nm
56must contain valid shell commands.
57.Pp
58Listed below are the
59.Nm
60variables that may be set, the values that each may be set to,
61a brief description of what each variable does, and a reference to
62relevant manual pages. Most
63variables have three values: a list of parameters to pass on the
64command line, "DEFAULT" for a reasonable default set of parameters,
65or "NO" if the daemon is not to be run at all. Some programs don't
66take a set of flags, and may only be set to "YES" or "NO". A few are
67always run, and will not take "NO."
68The arguments passed if "DEFAULT" is chosen are listed in
69.Nm
70itself.
71.Pp
72Basic network configuration:
73.Bl -tag -width bootparamd_flags
74.It Sy hostname
75Name of host.
76If empty or not set, then the contents of
77.Pa /etc/myname
78(if it exists) are used.
79.It Sy domainname
80YP domain of host.
81If empty or not set, then the contents of
82.Pa /etc/defaultdomain
83(if it exists) are used.
84.It Sy defaultroute
85Default network route.
86If empty or not set, then the contents of
87.Pa /etc/mygate
88(if it exists) are used.
89.El
90.Pp
91Actions to perform on boot-up:
92.Bl -tag -width bootparamd_flags
93.It Sy update_motd
94YES or NO.  Updates the
95.Nx
96version string in the
97.Pa /etc/motd
98file to reflect the version of the running kernel.  See
99.Xr motd 5 .
100.El
101.Pp
102Programs run on boot-up:
103.Bl -tag -width bootparamd_flags
104.It Sy savecore_flags
105Parameters, DEFAULT or NO.
106Saves a copy of the kernel and crash dump when the system comes up
107after a crash.  The
108.Ar -z
109parameter will compress the kernel and crash dump.  See
110.Xr savecore 8 .
111.It Sy lkm_init
112YES or NO. Loads
113.Xr lkm 4
114modules based on information in
115.Pa /etc/lkm.conf .
116See
117.Xr lkm.conf 5 .
118.It Sy ipfilter
119YES or NO.  Runs
120.Xr ipf 8
121to load in packet filter specifications from
122.Pa /etc/ipf.conf
123at network boot time, before any interfaces are configured.  See
124.Xr ipf 5 .
125.It Sy ntpdate_hosts
126Parameters, DEFAULT or NO.
127List of time servers for
128.Xr ntpdate 8 .
129If DEFAULT, the list of servers is loaded from
130.Pa /etc/ntp.conf .
131.El
132.Pp
133Interface boot-up configuration:
134.Bl -tag -width bootparamd_flags
135.It Sy net_interfaces
136Parameters, DEFAULT, or NO.
137Lists a set of interfaces to be configured with
138.Xr ifconfig 8
139at boot time.
140If DEFAULT, the interfaces are found by running
141.Xr ifconfig 8
142with the
143.Fl l
144flag. Usually, the parameters for the subsequent
145.Xr ifconfig 8
146commands are found in files named
147.Pa /etc/ifconfig.* ,
148where
149.Dq *
150is the name of each interface (e.g.
151.Pa /etc/ifconfig.le0 ) .
152Alternatively, the parameters may be taken from an
153.Sy ifconfig_*
154variable (see below).  In either case, the parameters have the interface
155name prepended to them and are then handed to
156.Xr ifconfig 8 .
157.It Sy ifconfig_*
158Parameters only.
159Supplies a set of parameters for configuring the given interface
160.Dq *
161(e.g.
162.Sy ifconfig_le0 ) .
163See
164.Sy net_interfaces
165above.
166.It Sy ifaliases_*
167List of
168.Sq Ar "address netmask"
169pairs to configure additional network addresses for the given
170configured interface
171.Dq *
172(e.g.
173.Sy ifaliases_le0 ) .
174If
175.Ar netmask
176is
177.Dq - ,
178then use the default netmask for the interface.
179.El
180.Pp
181Daemons required for other daemons:
182.Bl -tag -width bootparamd_flags
183.It Sy inetd_flags
184Parameters, DEFAULT or NO.
185Starts other internet programs (as listed in
186.Pa /etc/inetd.conf )
187as necessary.  The
188.Ar -l
189option turns on libwrap connection logging.  See
190.Xr inetd 8 .
191.It Sy portmap
192YES or NO.  The
193.Xr portmap 8
194daemon is required for any
195.Xr rpc 3
196services.  These include NFS, YP,
197.Xr bootparamd 8 ,
198.Xr rstatd 8 ,
199.Xr rusersd 8 ,
200and
201.Xr rwalld 8 .
202.El
203.Pp
204Commonly used daemons:
205.Bl -tag -width bootparamd_flags
206.It Sy update_flags
207Parameters or DEFAULT.  The
208.Xr update 8
209daemon flushes cached disk pages that are dirty to disk at regular intervals.
210.It Sy syslogd_flags
211Parameters, DEFAULT or NO.
212Syslog daemon; logs messages to logfiles.  See
213.Xr syslogd 8 .
214.It Sy timed_flags
215Parameters, DEFAULT or NO.
216Local area network time synchronisation daemon.  The
217.Ar -M
218parameter allows this host to be a master, as well as a slave. See
219.Xr timed 8 .
220.It Sy xntpd_flags
221Parameters, DEFAULT or NO.
222Local and wide area network time synchronisation daemon.  If this is used,
223.Sy timed_flags
224should be set to
225.Dq Ar -M -F localhost
226on one xntp-using host on the network, and to "NO"
227on any other xntp-using host.
228.It Sy sendmail_flags
229Parameters, DEFAULT or NO.
230Sendmail SMTP mail transport agent.  See
231.Xr sendmail 8 .
232.It Sy named_flags
233Parameters, DEFAULT or NO.
234BIND domain name resolver and server.  See
235.Xr named 8 .
236.It Sy lpd_flags
237Parameters, DEFAULT or NO.
238Line printer daemon; allows other hosts to print to the local host's printer.
239The
240.Ar -l
241option turns on extra logging.  See
242.Xr lpd 8 .
243.El
244.Pp
245Routing daemons:
246.Bl -tag -width bootparamd_flags
247.It Sy routed_flags
248Parameters, DEFAULT or NO.
249RIP routing protocol daemon.  This should be NO if
250.Sy gated_flags
251is anything but NO.  See
252.Xr routed 8 .
253.It Sy gated_flags
254Parameters, DEFAULT or NO.
255Routing daemon for many IP routing protocols.
256This should be NO if
257.Sy routed_flags
258is anything but NO.
259.Xr gated 8
260is not included with
261.Nx .
262.It Sy mrouted_flags
263Parameters, DEFAULT or NO.
264DVMRP multicast routing protocol daemon.  See
265.Xr mrouted 8 .
266.El
267.Pp
268Daemons used to boot other hosts over a network:
269.Bl -tag -width bootparamd_flags
270.It Sy rarpd_flags
271Parameters, DEFAULT or NO.
272Reverse ARP daemon; used to boot
273.Nx
274and Sun workstations.  See
275.Xr rarpd 8 .
276.It Sy bootparamd_flags
277Parameters, DEFAULT or NO.
278Boot parameter server; used for booting
279.Nx
280and SunOS 4.x systems.  See
281.Xr bootparamd 8 .
282.It Sy dhcpd_flags
283Parameters, DEFAULT or NO.
284Dynamic Host Configuration Protocol daemon, for assigning IP addresses to
285hosts and passing boot information.  See
286.Xr dhcpd 8 .
287.It Sy rbootd_flags
288Parameters, DEFAULT or NO.
289HP boot protocol daemon; used for booting HP workstations.  See
290.Xr rbootd 8 .
291.It Sy mopd_flags
292Parameters, DEFAULT or NO.
293DEC MOP protocol daemon; used for booting VAX and other DEC machines.  See
294.Xr mopd 8 .
295.El
296.Pp
297YP (NIS) daemons:
298.Bl -tag -width bootparamd_flags
299.It Sy ypbind_flags
300Parameters, DEFAULT or NO.
301Run on YP (NIS) clients to use information from a YP server.  See
302.Xr ypbind 8 .
303.It Sy ypserv_flags
304Parameters, DEFAULT or NO.
305YP (NIS) server for distributing information from certain files in
306.Pa /etc .
307See
308.Xr ypserv 8 .
309.It Sy yppasswdd_flags
310Parameters, DEFAULT or NO.
311Allows remote YP users to update password on master server.  See
312.Xr yppasswdd 8 .
313.El
314.Pp
315Network file system daemons:
316.Bl -tag -width bootparamd_flags
317.It Sy nfs_client
318YES or NO.  Runs
319.Xr nfsiod 8
320to increase performance of an NFS client host.
321.It Sy nfsiod_flags
322Parameters or DEFAULT.  Flags passed to
323.Xr nfsiod 8
324if
325.Sy nfs_client
326is set to YES.
327.It Sy nfs_server
328YES or NO.  Sets up a host to be a NFS server by running
329.Xr mountd 8
330and
331.Xr nfsd 8 .
332.It Sy mountd_flags
333Parameters or DEFAULT. These are passed to
334.Xr mountd 8
335if
336.Sy nfs_server
337is set to YES.
338.It Sy nfsd_flags
339Parameters or DEFAULT. These are passed to
340.Xr nfsd 8
341if
342.Sy nfs_server
343is set to YES.
344.It Sy lockd_flags
345Parameters, DEFAULT or NO.  Provides locking for NFS.  Ignored if
346.Sy nfs_server
347and
348.Sy nfs_client
349are both set to NO.  See
350.Xr rpc.lockd 8 .
351.It Sy statd_flags
352Parameters, DEFAULT or NO.  Ignored if
353.Sy nfs_server
354and
355.Sy nfs_client
356are both set to NO.  Status monitoring daemon used when
357.Xr rpc.lockd 8
358is running.  See
359.Xr rpc.statd 8 .
360.It Sy amd_flags
361Parameters, DEFAULT or NO.
362The automounter daemon,
363.Xr amd 8 ,
364automatically mounts NFS file systems whenever a file or directory within
365that filesystem is accessed.
366.It Sy amd_dir
367The
368.Xr amd 8
369mount directory.  Used only if
370.Sy amd_flags
371is not set to NO.
372.It Sy amd_master
373The
374.Xr amd 8
375automounter master map.
376Used only if
377.Sy amd_flags
378is not set to NO.
379.El
380.Pp
381Other daemons:
382.Bl -tag -width bootparamd_flags
383.It Sy rwhod
384YES or NO.  Daemon to support
385.Xr rwho 8
386command.  See
387.Xr rwhod 8 .
388.It Sy kerberos_server
389YES or NO.  Runs the kerberos server
390.Xr kerberos 8
391and the kerberos admininstration server,
392.Xr kadmind 8 .
393This should only be run on the kerberos master server.
394The kerberos server is only available with the domestic distribution of
395.Nx .
396.El
397.Sh FILES
398.Pa /etc/rc.conf
399.Sh SEE ALSO
400.Xr boot 8 ,
401.Xr rc 8
402.Sh HISTORY
403The
404.Nm
405file appeared in
406.Nx 1.3 .
407