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
43 .Nd command scripts for auto-reboot and daemon startup
56 utility is the command script which controls the automatic boot process
61 script contains commands which are pertinent only
64 .Pa /usr/local/etc/rc.d/
65 mechanism is used instead of
70 it is still supported.
71 In this case, it should source
73 and contain additional custom startup code for your system.
74 The best way to handle
76 however, is to separate it out into
78 style scripts and place them under
79 .Pa /usr/local/etc/rc.d/ .
82 file contains the global system configuration information referenced
83 by the startup scripts, while
85 contains the local system configuration.
92 directories contain scripts which will be automatically
93 executed at boot time and shutdown time.
98 .Va autoboot Ns = Ns Li yes
100 .Pq Va rc_fast Ns = Ns Li yes ,
103 scripts from performing the check for already running processes
104 (thus speeding up the boot process).
106 .Va rc_fast Ns = Ns Li yes
107 speedup will not occur when
109 is started up after exiting the single-user shell.
111 Determine whether the system is booting diskless,
113 .Pa /etc/rc.initdiskless
120 shell functions to use.
122 Load the configuration files.
124 Determine if booting in a jail,
127 to the list of KEYWORDS to skip in
132 to order the files in
141 Call each script in turn using
149 and sources the script in a subshell.
152 suffix then it is sourced directly into the current shell.
153 Stop processing when the script that is the value of the
154 .Va $early_late_divider
159 this time including the scripts in the
162 Ignore everything up to the
163 .Va $early_late_divider ,
164 then start executing the scripts as described above.
166 .Ss Operation of Nm rc.shutdown
173 shell functions to use.
175 Load the configuration files.
179 to order the files in
190 reverse that order, and assign the result to a variable.
192 Call each script in turn using
200 and sources the script in a subshell.
203 suffix then it is sourced directly into the current shell.
205 .Ss Contents of Nm rc.d/
209 The following file naming conventions are currently used in
211 .Bl -tag -width ".Pa ALLUPPERCASE" -offset indent
215 to ensure that certain operations are performed before others.
216 In order of startup, these are:
217 .Bl -tag -width ".Pa NETWORKING"
219 Ensure basic network services are running, including general
220 network configuration.
222 Ensure basic services
223 exist for services that start early (such as
225 because they are required by
229 Check-point before all general purpose daemons such as
234 Check-point before user login services
238 as well as services which might run commands as users
244 Scripts that are to be sourced into the current shell rather than a subshell
248 Extreme care must be taken in using this, as the startup sequence will
249 terminate if the script does.
251 Scripts that are sourced in a subshell.
252 The boot does not stop if such a script terminates with a non-zero status,
253 but a script can stop the boot if necessary by invoking the
259 Each script should contain
261 keywords, especially an appropriate
263 entry, and if necessary
269 Each script is expected to support at least the following arguments, which
270 are automatically supported if it uses the
273 .Bl -tag -width ".Cm restart" -offset indent
276 This should check that the service is to be started as specified by
278 Also checks if the service is already running and refuses to start if
280 This latter check is not performed by standard
282 scripts if the system is starting directly to multi-user mode, to
283 speed up the boot process.
288 check and start anyway.
290 If the service is to be started as specified by
293 This should check that the service is running and complain if it is not.
298 check and attempt to stop.
305 If the script starts a process (rather than performing a one-off
306 operation), show the status of the process.
307 Otherwise it is not necessary to support this argument.
308 Defaults to displaying the process ID of the program (if running).
310 If the script starts a process (rather than performing a one-off
311 operation), wait for the command to exit.
312 Otherwise it is not necessary to support this argument.
316 variables are used to control the startup of the service (if any).
319 If a script must implement additional commands it can list them in
322 variable, and define their actions in a variable constructed from
323 the command name (see the
327 The following key points apply to old-style scripts in
328 .Pa /usr/local/etc/rc.d/ :
332 Scripts are only executed if their
334 matches the shell globbing pattern
336 and they are executable.
337 Any other files or directories present within the directory are silently
340 When a script is executed at boot time, it is passed the string
342 as its first and only argument.
343 At shutdown time, it is passed the string
345 as its first and only argument.
348 scripts are expected to handle these arguments appropriately.
349 If no action needs to be taken at a given time
350 (either boot time or shutdown time),
351 the script should exit successfully and without producing an error message.
353 The scripts within each directory are executed in lexicographical order.
354 If a specific order is required,
355 numbers may be used as a prefix to the existing filenames,
358 would be executed before
360 without the numeric prefixes the opposite would be true.
362 The output from each script is traditionally a space character,
363 followed by the name of the software package being started or shut down,
365 a trailing newline character (see the
369 .Sh SCRIPTS OF INTEREST
370 When an automatic reboot is in progress,
372 is invoked with the argument
374 One of the scripts run from
386 all the disks of minor inconsistencies resulting
387 from the last system shutdown.
388 If this fails, then checks/repairs of serious inconsistencies
389 caused by hardware or software failure will be performed
390 in the background at the end of the booting process.
393 is not set, when going from single-user to multi-user mode for example,
394 the script does not do anything.
398 script can execute scripts from multiple
401 The default location includes
402 .Pa /usr/local/etc/rc.d/ ,
403 but these may be overridden with the
410 script is used to set any special configurations for serial devices.
414 script is used to configure rules for the kernel based firewall
416 It has several possible options:
418 .Bl -tag -width ".Ar filename" -compact -offset indent
422 will try to protect just this machine
424 will try to protect a whole network
426 totally disables IP services except via
430 disables the loading of firewall rules
432 will load the rules in the given filename (full path required).
437 scripts are used to configure ATM network interfaces.
438 The interfaces are configured in three passes.
439 The first pass performs the initial interface configuration.
440 The second pass completes the interface configuration and defines PVCs and
441 permanent ATMARP entries.
442 The third pass starts any ATM daemons.
444 Most daemons, including network related daemons, have their own script in
446 which can be used to start, stop, and check the status of the service.
448 Any architecture specific scripts, such as
450 for example, specifically check that they are on that architecture
451 before starting the daemon.
453 Following tradition, all startup files reside in
456 .Bl -tag -compact -width Pa
459 .It Pa /etc/rc.conf.local
461 .It Pa /etc/rc.firewall
463 .It Pa /etc/rc.shutdown
465 .It Pa /var/run/dmesg.boot
467 results soon after the
472 buffer in the kernel no longer has this information.
475 The following is a minimal
478 Most scripts require little more than the following.
479 .Bd -literal -offset indent
484 # REQUIRE: bar_service_required_to_precede_foo
490 command="/usr/local/bin/foo"
496 Certain scripts may want to provide enhanced functionality.
497 The user may access this functionality through additional commands.
498 The script may list and define as many commands at it needs.
499 .Bd -literal -offset indent
504 # REQUIRE: bar_service_required_to_precede_foo
505 # BEFORE: baz_service_requiring_foo_to_precede_it
511 command="/usr/local/bin/foo"
512 extra_commands="nop hello"
513 hello_cmd="echo Hello World."
525 As all processes are killed by
527 at shutdown, the explicit
529 is unnecessary, but is often included.