CONTENTS

SYNOPSIS

DESCRIPTION

1. Source /etc/rc.subr to load various rc.subr(8) shell functions to use.
2. If autobooting, set autoboot = yes and enable a flag (rc_fast = yes), which prevents the rc.d/ scripts from performing the check for already running processes (thus speeding up the boot process). This rc_fast = yes speedup will not occur when rc is started up after exiting the single-user shell.
3. Invoke rcorder(8) to order the files in /etc/rc.d/ that do not have a "nostart" keyword (refer to rcorder 8 ’s -s flag), and assign the result to a variable.
4. Call each script in turn using run_rc_script (from rc.subr(8)), which sets $1 to "start", and sources the script in a subshell. If the script has a .sh suffix then it is sourced directly into the current shell.

Operation of Nm rc.shutdown

1. Source /etc/rc.subr to load various rc.subr(8) shell functions to use.
2. Invoke rcorder(8) to order the files in /etc/rc.d/ that have a "shutdown" keyword (refer to rcorder 8 ’s -k flag), reverse that order, and assign the result to a variable.
3. Call each script in turn using run_rc_script (from rc.subr(8)), which sets $1 to "stop", and sources the script in a subshell. If the script has a .sh suffix then it is sourced directly into the current shell.

Contents of Nm rc.d/

Each script should contain rcorder(8) keywords, especially an appropriate "PROVIDE" entry, and if necessary "REQUIRE" and "BEFORE" keywords.

Each script is expected to support at least the following arguments, which are automatically supported if it uses the run_rc_command function:

start	Start the service. This should check that the service is to be started as specified by rc.conf(5). Also checks if the service is already running and refuses to start if it is. This latter check is not performed by standard .Fx scripts if the system is starting directly to multi-user mode, to speed up the boot process. If forcestart is given, ignore the rc.conf(5) check and start anyway.
stop	If the service is to be started as specified by rc.conf(5), stop the service. This should check that the service is running and complain if it is not. If forcestop is given, ignore the rc.conf(5) check and attempt to stop.
restart	Perform a stop then a start.
status	If the script starts a process (rather than performing a one-off operation), show the status of the process. Otherwise it is not necessary to support this argument. Defaults to displaying the process ID of the program (if running).
poll	If the script starts a process (rather than performing a one-off operation), wait for the command to exit. Otherwise it is not necessary to support this argument.
rcvar	Display which rc.conf(5) variables are used to control the startup of the service (if any).

SCRIPTS OF INTEREST

The rc.early script is run very early in the startup process, immediately before the file system check. The rc.early script is deprecated. Any commands in this file should be separated out into rc.d/ style scripts and integrated into the rc system.

The /etc/rc.d/local script can execute scripts from multiple rc.d/ directories. The default locations are /usr/local/etc/rc.d/ and /usr/X11R6/etc/rc.d/, but these may be overridden with the local_startup rc.conf(5) variable.

The /etc/rc.d/serial script is used to set any special configurations for serial devices.

The /etc/rc.d/network* scripts are used to start the network. The network is started in several passes. The first pass, /etc/rc.d/network1, sets the hostname and domainname and configures the network interfaces. The /etc/rc.d/network2 script starts routing and sets routing options. The /etc/rc.d/network3 script sets additional networking options. Finally, the /etc/rc.d/network_ipv6 script configures IPv6 interfaces and options.

The rc.firewall script is used to configure rules for the kernel based firewall service. It has several possible options:

open	will allow anyone in
client	will try to protect just this machine
simple	will try to protect a whole network
closed	totally disables IP services except via lo0 interface
UNKNOWN	disables the loading of firewall rules
filename	will load the rules in the given filename (full path required).

The /etc/rc.d/atm* scripts are used to configure ATM network interfaces. The interfaces are configured in three passes. The first pass performs the initial interface configuration. The second pass completes the interface configuration and defines PVCs and permanent ATMARP entries. The third pass starts any ATM daemons.

Most daemons, including network related daemons, have their own script in /etc/rc.d/, which can be used to start, stop, and check the status of the service.

Any architecture specific scripts, such as /etc/rc.d/apm for example, specifically check that they are on that architecture before starting the daemon.

EXAMPLES

# PROVIDE: foo
# REQUIRE: bar_service_required_to_precede_foo
# BEFORE: baz_service_requiring_foo_to_precede_it

. /etc/rc.subr

name="foo"
rcvar=‘set_rcvar‘
command="/usr/local/bin/foo"

load_rc_config $name
run_rc_command "$1"

Certain scripts may want to provide enhanced functionality. The user may access this functionality through additional commands. The script may list and define as many commands at it needs.
#!/bin/sh
#

# PROVIDE: foo
# REQUIRE: bar_service_required_to_precede_foo
# BEFORE: baz_service_requiring_foo_to_precede_it

. /etc/rc.subr

name="foo"
rcvar=‘set_rcvar‘
command="/usr/local/bin/foo"
extra_commands="nop hello"
hello_cmd="echo Hello World."
nop_cmd="do_nop"

do_nop()
{
echo "I do nothing."
}

load_rc_config $name
run_rc_command "$1"

The following is a simple, hypothetical example of an old-style /usr/local/etc/rc.d/ script, which would start a daemon at boot time, and kill it at shutdown time.
#!/bin/sh -
#
# initialization/shutdown script for foobar package

case "$1" in
start)
/usr/local/sbin/foo -d && echo -n ’ foo’
;;
stop)
kill ‘cat /var/run/foo.pid‘ && echo -n ’ foo’
;;
*)
echo "unknown option: $1 - should be ’start’ or ’stop’" >&2
;;
esac

HISTORY