1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Portions of this manual page are Copyrighted by
5 .\" The NetBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\" must display the following acknowledgement:
17 .\" This product includes software developed by the University of
18 .\" California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, 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
35 .\" @(#)rc.8 8.2 (Berkeley) 12/11/93
36 .\" $FreeBSD: src/share/man/man8/rc.8,v 1.22 2002/12/12 17:25:58 ru Exp $
37 .Dd September 28, 2009
42 .Nd command scripts for auto-reboot and daemon startup
56 utility is the command script which controls the automatic boot process
63 scripts contains commands which are pertinent only to a specific site.
65 .Pa /usr/local/etc/rc.d/
70 these days but if you want to use them it is still supported.
71 In this case, they should source
73 and contain additional custom startup and shutdown code for your system.
74 The best way to handle
77 .Nm rc.shutdown.local ,
78 however, is to separate them out into
80 style scripts and place them under
81 .Pa /usr/local/etc/rc.d/ .
84 file contains the global system configuration information referenced
85 by the startup scripts, while
87 contains the local system configuration.
94 directories contain scripts which will be automatically
95 executed at boot time and shutdown time.
103 shell functions to use.
106 .Va autoboot Ns = Ns Li yes
108 .Pq Va rc_fast Ns = Ns Li yes ,
111 scripts from performing the check for already running processes
112 (thus speeding up the boot process).
114 .Va rc_fast Ns = Ns Li yes
115 speedup will not occur when
117 is started up after exiting the single-user shell.
121 to order the files in
129 and assign the result to a variable.
131 Call each script in turn using
139 and sources the script in a subshell.
142 suffix then it is sourced directly into the current shell.
144 .Ss Operation of Nm rc.shutdown
151 shell functions to use.
155 to order the files in
163 reverse that order, and assign the result to a variable.
165 Call each script in turn using
173 and sources the script in a subshell.
176 suffix then it is sourced directly into the current shell.
178 .Ss Contents of Nm rc.d/
182 The following file naming conventions are currently used in
184 .Bl -tag -width ".Pa ALLUPPERCASE" -offset indent
188 to ensure that certain operations are performed before others.
189 In order of startup, these are:
190 .Bl -tag -width ".Pa NETWORKING"
192 Ensure basic network services are running, including general
193 network configuration
194 .Pq Pa netif , routing , network_ipv6 , isdnd, ppp-user .
196 Ensure basic services (such as
200 exist for services that start early (such as
202 because they are required by
206 Check-point before all general purpose daemons such as
211 Check-point before user login services
215 as well as services which might run commands as users
221 Scripts that are to be sourced into the current shell rather than a subshell
225 Extreme care must be taken in using this, as the startup sequence will
226 terminate if the script does.
228 Scripts that are sourced in a subshell.
229 These can stop the boot if necessary with the following shell
231 .Bd -literal -offset indent
232 if [ "$autoboot" = yes ]; then
238 Note that this should be used extremely sparingly!
241 Each script should contain
243 keywords, especially an appropriate
245 entry, and if necessary
251 Each script is expected to support at least the following arguments, which
252 are automatically supported if it uses the
255 .Bl -tag -width ".Cm restart" -offset indent
258 This should check that the service is to be started as specified by
260 Also checks if the service is already running and refuses to start if
262 This latter check is not performed by standard
264 scripts if the system is starting directly to multi-user mode, to
265 speed up the boot process.
268 is given, skip the PID check.
273 check and start anyway.
275 If the service is to be started as specified by
278 This should check that the service is running and complain if it is not.
283 check and attempt to stop.
290 If the script starts a process (rather than performing a one-off
291 operation), show the status of the process.
292 Otherwise it is not necessary to support this argument.
293 Defaults to displaying the process ID of the program (if running).
295 If the script starts a process (rather than performing a one-off
296 operation), wait for the command to exit.
297 Otherwise it is not necessary to support this argument.
301 variables are used to control the startup of the service (if any).
304 If a script must implement additional commands it can list them in
307 variable, and define their actions in a variable constructed from
308 the command name (see the
312 The following key points apply to old-style scripts in
313 .Pa /usr/local/etc/rc.d/ :
316 Scripts are only executed if their
318 matches the shell globbing pattern
320 and they are executable.
321 Any other files or directories present within the directory are silently
324 When a script is executed at boot time, it is passed the string
326 as its only argument.
327 At shutdown time, it is passed the string
329 as its only argument.
332 scripts are expected to handle these arguments appropriately.
333 If no action needs to be taken at a given time
334 (either boot time or shutdown time),
335 the script should exit successfully and without producing an error message.
337 The scripts within each directory are executed in lexicographical order.
338 If a specific order is required,
339 numbers may be used as a prefix to the existing filenames,
342 would be executed before
344 without the numeric prefixes the opposite would be true.
346 The output from each script is traditionally a space character,
347 followed by the name of the software package being started or shut down,
349 a trailing newline character (see the
353 .Sh SCRIPTS OF INTEREST
354 When an automatic reboot is in progress,
356 is invoked with the argument
358 One of the scripts run from
370 file systems of minor inconsistencies resulting
371 from the last system shutdown.
372 If preening fails further action depends on the
390 is not set, when going from single-user to multi-user mode for example,
391 the script does not do anything.
394 .Pa /etc/rc.d/localdaemons
395 script can execute scripts from multiple
398 The default locations are
399 .Pa /usr/pkg/etc/rc.d/
401 .Pa /usr/local/etc/rc.d/ ,
402 but these may be overridden with the
409 script is used to set any special configurations for serial devices.
412 .Pa /etc/rc.d/{net*,routing}
413 scripts are used to start the network.
414 The network is started in several passes.
416 .Pa /etc/rc.d/netif ,
417 configures the network
420 .Pa /etc/rc.d/routing
421 script starts routing and sets routing options.
423 .Pa /etc/rc.d/netoptions
424 script sets additional networking options.
426 .Pa /etc/rc.d/network_ipv6
427 script configures IPv6 interfaces and options.
431 script is used to configure rules for the
433 kernel based firewall
435 It has several possible options:
437 .Bl -tag -width ".Ar filename" -compact -offset indent
441 will try to protect just this machine
443 will try to protect a whole network
445 totally disables IP services except via
449 disables the loading of firewall rules
451 will load the rules in the given filename (full path required).
456 scripts are used to configure ATM network interfaces.
457 The interfaces are configured in three passes.
458 The first pass performs the initial interface configuration.
459 The second pass completes the interface configuration and defines PVCs and
460 permanent ATMARP entries.
461 The third pass starts any ATM daemons.
463 Most daemons, including network related daemons, have their own script in
465 which can be used to start, stop, and check the status of the service.
467 Any architecture specific scripts, such as
469 for example, specifically check that they are on that architecture
470 before starting the daemon.
472 Following tradition, all startup files reside in
478 .It Pa /etc/rc.conf.local
480 .It Pa /etc/rc.firewall
482 .It Pa /etc/rc.shutdown
483 .It Pa /etc/rc.shutdown.local
487 The following is a minimal
490 Most scripts require little more than the following.
491 .Bd -literal -offset indent
496 # REQUIRE: bar_service_required_to_precede_foo
497 # BEFORE: baz_service_requiring_foo_to_precede_it
503 command="/usr/local/bin/foo"
509 Certain scripts may want to provide enhanced functionality.
510 The user may access this functionality through additional commands.
511 The script may list and define as many commands at it needs.
512 .Bd -literal -offset indent
517 # REQUIRE: bar_service_required_to_precede_foo
518 # BEFORE: baz_service_requiring_foo_to_precede_it
524 command="/usr/local/bin/foo"
525 extra_commands="nop hello"
526 hello_cmd="echo Hello World."
538 The following is a simple, hypothetical example of an old-style
539 .Pa /usr/local/etc/rc.d/
541 which would start a daemon at boot time,
542 and kill it at shutdown time.
543 .Bd -literal -offset indent
546 # initialization/shutdown script for foobar package
550 /usr/local/sbin/foo -d && echo -n ' foo'
553 kill `cat /var/run/foo.pid` && echo -n ' foo'
556 echo "unknown option: $1 - should be 'start' or 'stop'" >&2
561 As all processes are killed by
563 at shutdown, the explicit
565 is unnecessary, but is often included.
583 facility was implemented in