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. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, 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
31 .\" @(#)rc.8 8.2 (Berkeley) 12/11/93
39 .Nd command scripts for auto-reboot and daemon startup
52 utility is the command script which controls the automatic boot process
57 script contains commands which are pertinent only
60 .Pa /usr/local/etc/rc.d/
61 mechanism is used instead of
66 it is still supported.
67 In this case, it should source
69 and contain additional custom startup code for your system.
70 The best way to handle
72 however, is to separate it out into
74 style scripts and place them under
75 .Pa /usr/local/etc/rc.d/ .
78 file contains the global system configuration information referenced
79 by the startup scripts, while
81 contains the local system configuration.
88 directories contain scripts which will be automatically
89 executed at boot time and shutdown time.
94 .Va autoboot Ns = Ns Li yes
96 .Pq Va rc_fast Ns = Ns Li yes ,
99 scripts from performing the check for already running processes
100 (thus speeding up the boot process).
102 .Va rc_fast Ns = Ns Li yes
103 speedup will not occur when
105 is started up after exiting the single-user shell.
107 Determine whether the system is booting diskless,
109 .Pa /etc/rc.initdiskless
116 shell functions to use.
118 Load the configuration files.
120 Determine if booting in a jail,
123 (no jails allowed) or
125 (only allow vnet-enabled jails) to the list of KEYWORDS to skip in
129 .Va ${firstboot_sentinel}
132 to the list of KEYWORDS to skip in
137 to order the files in
146 Call each script in turn using
154 and sources the script in a subshell.
157 suffix then it is sourced directly into the current shell.
158 Stop processing when the script that is the value of the
159 .Va $early_late_divider
162 Check again to see if the file
163 .Va ${firstboot_sentinel}
164 exists (in case it is located on a newly mounted file system)
165 and adjust the list of KEYWORDs to skip appropriately.
169 this time including the scripts in the
172 Ignore everything up to the
173 .Va $early_late_divider ,
174 then start executing the scripts as described above.
177 .Va ${firstboot_sentinel}
180 .Va ${firstboot_sentinel}-reboot
181 also exists (because it was created by a script), then delete it and reboot.
183 .Ss Operation of Nm rc.shutdown
190 shell functions to use.
192 Load the configuration files.
196 to order the files in
207 reverse that order, and assign the result to a variable.
209 Call each script in turn using
217 and sources the script in a subshell.
220 suffix then it is sourced directly into the current shell.
222 .Ss Contents of Nm rc.d/
226 The following file naming conventions are currently used in
228 .Bl -tag -width ".Pa ALLUPPERCASE" -offset indent
232 to ensure that certain operations are performed before others.
233 In order of startup, these are:
234 .Bl -tag -width ".Pa NETWORKING"
236 Ensure basic network services are running, including general
237 network configuration.
239 Ensure basic services
240 exist for services that start early (such as
242 because they are required by
246 Check-point before all general purpose daemons such as
251 Check-point before user login services
255 as well as services which might run commands as users
261 Scripts that are to be sourced into the current shell rather than a subshell
265 Extreme care must be taken in using this, as the startup sequence will
266 terminate if the script does.
268 Scripts that are sourced in a subshell.
269 The boot does not stop if such a script terminates with a non-zero status,
270 but a script can stop the boot if necessary by invoking the
276 Each script should contain
278 keywords, especially an appropriate
280 entry, and if necessary
286 Each script is expected to support at least the following arguments, which
287 are automatically supported if it uses the
290 .Bl -tag -width ".Cm restart" -offset indent
293 This should check that the service is to be started as specified by
295 Also checks if the service is already running and refuses to start if
297 This latter check is not performed by standard
299 scripts if the system is starting directly to multi-user mode, to
300 speed up the boot process.
305 check and start anyway.
307 If the service is to be started as specified by
310 This should check that the service is running and complain if it is not.
315 check and attempt to stop.
322 If the script starts a process (rather than performing a one-off
323 operation), show the status of the process.
324 Otherwise it is not necessary to support this argument.
325 Defaults to displaying the process ID of the program (if running).
327 Print a short description of what the script does.
329 Print the script's non-standard commands.
331 If the script starts a process (rather than performing a one-off
332 operation), wait for the command to exit.
333 Otherwise it is not necessary to support this argument.
335 Return 0 if the service is enabled and 1 if it is not.
336 This command does not print anything.
340 variables are used to control the startup of the service (if any).
343 If a script must implement additional commands it can list them in
346 variable, and define their actions in a variable constructed from
347 the command name (see the
351 The following key points apply to old-style scripts in
352 .Pa /usr/local/etc/rc.d/ :
355 Scripts are only executed if their
357 matches the shell globbing pattern
359 and they are executable.
360 Any other files or directories present within the directory are silently
363 When a script is executed at boot time, it is passed the string
365 as its first and only argument.
366 At shutdown time, it is passed the string
368 as its first and only argument.
371 scripts are expected to handle these arguments appropriately.
372 If no action needs to be taken at a given time
373 (either boot time or shutdown time),
374 the script should exit successfully and without producing an error message.
376 The scripts within each directory are executed in lexicographical order.
377 If a specific order is required,
378 numbers may be used as a prefix to the existing filenames,
381 would be executed before
383 without the numeric prefixes the opposite would be true.
385 The output from each script is traditionally a space character,
386 followed by the name of the software package being started or shut down,
388 a trailing newline character (see the
392 .Sh SCRIPTS OF INTEREST
393 When an automatic reboot is in progress,
395 is invoked with the argument
397 One of the scripts run from
409 all the disks of minor inconsistencies resulting
410 from the last system shutdown.
411 If this fails, then checks/repairs of serious inconsistencies
412 caused by hardware or software failure will be performed
413 in the background at the end of the booting process.
416 is not set, when going from single-user to multi-user mode for example,
417 the script does not do anything.
421 script can execute scripts from multiple
424 The default location includes
425 .Pa /usr/local/etc/rc.d/ ,
426 but these may be overridden with the
433 script is used to set any special configurations for serial devices.
437 script is used to configure rules for the kernel based firewall
439 It has several possible options:
441 .Bl -tag -width ".Ar filename" -compact -offset indent
445 will try to protect just this machine
447 will try to protect a whole network
449 totally disables IP services except via
453 disables the loading of firewall rules
455 will load the rules in the given filename (full path required).
458 Most daemons, including network related daemons, have their own script in
460 which can be used to start, stop, and check the status of the service.
462 Any architecture specific scripts, such as
464 for example, specifically check that they are on that architecture
465 before starting the daemon.
467 Following tradition, all startup files reside in
470 .Bl -tag -compact -width Pa
473 .It Pa /etc/rc.conf.local
475 .It Pa /etc/rc.firewall
477 .It Pa /etc/rc.shutdown
479 .It Pa /var/run/dmesg.boot
481 results soon after the
486 buffer in the kernel no longer has this information.
489 The following is a minimal
492 Most scripts require little more than the following.
493 .Bd -literal -offset indent
498 # REQUIRE: bar_service_required_to_precede_foo
504 command="/usr/local/bin/foo"
510 Certain scripts may want to provide enhanced functionality.
511 The user may access this functionality through additional commands.
512 The script may list and define as many commands at it needs.
513 .Bd -literal -offset indent
518 # REQUIRE: bar_service_required_to_precede_foo
519 # BEFORE: baz_service_requiring_foo_to_precede_it
525 command="/usr/local/bin/foo"
526 extra_commands="nop hello"
527 hello_cmd="echo Hello World."
539 As all processes are killed by
541 at shutdown, the explicit
543 is unnecessary, but is often included.