8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man4 / init.d.4
blob94477bb6771ae668513932ba471e6b0893cb50f1
1 '\" te
2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH INIT.D 4 "Aug 17, 2005"
7 .SH NAME
8 init.d \- initialization and termination scripts for changing init states
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/etc/init.d\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 \fB/etc/init.d\fR is a directory containing initialization and termination
19 scripts for changing init states. These scripts are linked when appropriate to
20 files in the \fBrc?.d\fR directories, where `\fB?\fR' is a single character
21 corresponding to the init state. See \fBinit\fR(1M) for definitions of the
22 states.
23 .sp
24 .LP
25 The service management facility (see \fBsmf\fR(5)) is the preferred mechanism
26 for service initiation and termination. The \fBinit.d\fR and \fBrc?.d\fR
27 directories are obsolete, and are provided for compatibility purposes only.
28 Applications launched from these directories by \fBsvc.startd\fR(1M) are
29 incomplete services, and will not be restarted on failure.
30 .sp
31 .LP
32 File names in \fBrc?.d\fR directories are of the form \fB[SK]nn\fI<init.d
33 filename>\fR\fR, where \fBS\fR means start this job, \fBK\fR means kill this
34 job, and \fBnn\fR is the relative sequence number for killing or starting the
35 job.
36 .sp
37 .LP
38 When entering a state (init S,0,2,3,etc.) the \fBrc[S0-6]\fR script executes
39 those scripts in \fB/etc/rc[S0-6].d\fR that are prefixed with \fBK\fR followed
40 by those scripts prefixed with \fBS\fR. When executing each script in one of
41 the \fB/etc/rc[S0-6] directories, the /sbin/rc[S0-6]\fR script passes a single
42 argument. It passes the argument 'stop' for scripts prefixed with \fBK\fR and
43 the argument 'start' for scripts prefixed with \fBS\fR. There is no harm in
44 applying the same sequence number to multiple scripts. In this case the order
45 of execution is deterministic but unspecified.
46 .sp
47 .LP
48 Guidelines for selecting sequence numbers are provided in \fBREADME\fR files
49 located in the directory associated with that target state. For example,
50 \fB/etc/rc[S0-6].d/README\fR. Absence of a \fBREADME\fR file indicates that
51 there are currently no established guidelines.
52 .sp
53 .LP
54 Do not put \fB/etc/init.d\fR in your \fB$PATH\fR. Having this directory in your
55 \fB$PATH\fR can cause unexpected behavior. The programs in \fB/etc/init.d\fR
56 are associated with \fBinit\fR state changes and, under normal circumstances,
57 are not intended to be invoked from a command line.
58 .SH EXAMPLES
59 .LP
60 \fBExample 1 \fRExample of \fB/sbin/rc2\fR.
61 .sp
62 .LP
63 When changing to init state 2 (multi-user mode, network resources not
64 exported), \fB/sbin/rc2\fR is initiated by the \fBsvc.startd\fR(1M) process.
65 The following steps are performed by \fB/sbin/rc2\fR.
67 .RS +4
68 .TP
70 In the directory \fB/etc/rc2.d\fR are files used to stop processes that
71 should not be running in state 2. The filenames are prefixed with \fBK\fR. Each
72 \fBK\fR file in the directory is executed (by \fB/sbin/rc2\fR) in alphanumeric
73 order when the system enters init state 2. See example below.
74 .RE
75 .RS +4
76 .TP
78 Also in the \fBrc2.d\fR directory are files used to start processes that
79 should be running in state 2. As in Step 1, each \fBS\fR file is executed.
80 .RE
81 .sp
82 .LP
83 Assume the file \fB/etc/init.d/netdaemon\fR is a script that will initiate
84 networking daemons when given the argument 'start', and will terminate the
85 daemons if given the argument 'stop'. It is linked to
86 \fB/etc/rc2.d/S68netdaemon\fR, and to \fB/etc/rc0.d/K67netdaemon\fR. The file
87 is executed by \fB/etc/rc2.d/S68netdaemon start\fR when init state 2 is entered
88 and by \fB/etc/rc0.d/K67netdaemon stop\fR when shutting the system down.
90 .SH SEE ALSO
91 .sp
92 .LP
93 \fBsvcs\fR(1), \fBinit\fR(1M), \fBsvc.startd\fR(1M), \fBsvccfg\fR(1M),
94 \fBsmf\fR(5)
95 .SH NOTES
96 .sp
97 .LP
98 Solaris now provides an expanded mechanism, which includes automated restart,
99 for applications historically started via the init script mechanism. The
100 Service Management Facility (introduced in \fBsmf\fR(5)) is the preferred
101 delivery mechanism for persistently running applications. Existing \fBinit.d\fR
102 scripts will, however, continue to be executed according to the rules in this
103 manual page. The details of execution in relation to managed services are
104 available in \fBsvc.startd\fR(1M).
107 On earlier Solaris releases, a script named with a suffix of '.sh' would be
108 sourced, allowing scripts to modify the environment of other scripts executed
109 later. This behavior is no longer supported; for altering the environment in
110 which services are run, see the \fBsetenv\fR subcommand in \fBsvccfg\fR(1M).
113 \fB/sbin/rc2\fR has references to the obsolescent \fBrc.d\fR directory. These
114 references are for compatibility with old \fBINSTALL\fR scripts. New
115 \fBINSTALL\fR scripts should use the \fBinit.d\fR directory for related
116 executables. The same is true for the \fBshutdown.d\fR directory.