[apple/launchd.git] / SystemStarter / SystemStarter.8

.Dd April 12, 2002
.Dt SystemStarter 8 
.Os Darwin
.Sh NAME
.Nm SystemStarter
.\" The following lines are read in generating the apropos(man -k) database. Use only key
.\" words here as the database is built based on the words here and in the .ND line. 
.\" Use .Nm macro to designate other names for the documented program.
.Nd Start, stop, and restart system services
.Sh SYNOPSIS
.Nm
.Op Fl gvxdDqn
.Op Ar action Op Ar service
.Sh DESCRIPTION
The
.Nm
utility is deprecated.  System services should instead be described by a
.Xr launchd.plist 5 .
See
.Xr launchd 8
for more details.
The
.Nm launchd
utility is available on Mac OS X 10.4 and later.
.Pp
In earlier versions of Mac OS X, the 
.Nm 
utility is used to start, stop, and restart the system services which
are described in the
.Pa /Library/StartupItems/
and
.Pa /System/Library/StartupItems/
paths.
.Pp
The optional
.Ar action
argument specifies which action 
.Nm
performs on the startup items.  The optional
.Ar service
argument specifies which startup items to perform the action on.  If no
.Ar service
is specified, all startup items will be acted on; otherwise, only the item providing the 
.Ar service ,
any items it requires, or any items that depend on it will be acted on.
.Pp
During boot 
.Nm
is invoked by
.Xr launchd 8
and is responsible for
starting all startup items in an order that satisfies each item's 
requirements.
.Sh ACTIONS
.Bl -tag -width -indent
.It Nm start
start all items, or start the item that provides the specified
.Ar service
and all items providing services it requires.
.It Nm stop
stop all items, or stop the item that provides the specified
.Ar service
and all items that depend on it.
.It Nm restart
restart all items, or restart the item providing the specified
.Ar service .
.El
.Sh OPTIONS
.Bl -tag -width -indent
.It Fl g
(ignored)
.It Fl v
verbose (text mode) startup
.It Fl x
(ignored)
.It Fl r
(ignored)
.It Fl d
print debugging output
.It Fl D
print debugging output and dependencies
.It Fl q
be quiet (disable debugging output)
.It Fl n
don't actually perform action on items (no-run mode)
.El
.Sh NOTES
Unless an explicit call to
.Nm ConsoleMessage
is made,
.Nm
examines the exit status of the startup item scripts to determine the success or failure of the services provided by that script.
.Pp
.Sh FILES
.Bl -tag -width -/System/Library/StartupItems -compact
.It Pa /Library/StartupItems/
User-installed startup items.
.It Pa /System/Library/StartupItems/
System-provided startup items.
.El
.Sh SEE ALSO 
.\" List links in ascending order by section, alphabetically within a section.
.\" Please do not reference files that do not exist without filing a bug report
.Xr ConsoleMessage 8 ,
.Xr launchd 8 ,
.Xr launchd.plist 5 ,
.Xr rc 8
.\" .Sh BUGS              \" Document known, unremedied bugs 
.Sh HISTORY
The
.Nm
utility appeared in Darwin 1.0 and
was extended in Darwin 6.0 to support partial startup and interprocess communication.
.Nm
was deprecated by
.Xr launchd 8
in Darwin 8.0.
Commit	Line	Data
e91b9f68 A	1	.Dd April 12, 2002
	2	.Dt SystemStarter 8
	3	.Os Darwin
	4	.Sh NAME
	5	.Nm SystemStarter
	6	.\" The following lines are read in generating the apropos(man -k) database. Use only key
	7	.\" words here as the database is built based on the words here and in the .ND line.
	8	.\" Use .Nm macro to designate other names for the documented program.
	9	.Nd Start, stop, and restart system services
	10	.Sh SYNOPSIS
	11	.Nm
	12	.Op Fl gvxdDqn
	13	.Op Ar action Op Ar service
	14	.Sh DESCRIPTION
ddbbfbc1 A	15	The
	16	.Nm
	17	utility is deprecated. System services should instead be described by a
	18	.Xr launchd.plist 5 .
	19	See
	20	.Xr launchd 8
	21	for more details.
	22	The
	23	.Nm launchd
	24	utility is available on Mac OS X 10.4 and later.
	25	.Pp
	26	In earlier versions of Mac OS X, the
e91b9f68	27	.Nm
ddbbfbc1	28	utility is used to start, stop, and restart the system services which
e91b9f68 A	29	are described in the
	30	.Pa /Library/StartupItems/
	31	and
	32	.Pa /System/Library/StartupItems/
	33	paths.
	34	.Pp
	35	The optional
	36	.Ar action
	37	argument specifies which action
	38	.Nm
	39	performs on the startup items. The optional
	40	.Ar service
	41	argument specifies which startup items to perform the action on. If no
	42	.Ar service
	43	is specified, all startup items will be acted on; otherwise, only the item providing the
	44	.Ar service ,
	45	any items it requires, or any items that depend on it will be acted on.
	46	.Pp
	47	During boot
	48	.Nm
	49	is invoked by
ddbbfbc1 A	50	.Xr launchd 8
ddbbfbc1 A	51	and is responsible for
e91b9f68 A	52	starting all startup items in an order that satisfies each item's
	53	requirements.
	54	.Sh ACTIONS
	55	.Bl -tag -width -indent
	56	.It Nm start
	57	start all items, or start the item that provides the specified
	58	.Ar service
	59	and all items providing services it requires.
	60	.It Nm stop
	61	stop all items, or stop the item that provides the specified
	62	.Ar service
	63	and all items that depend on it.
	64	.It Nm restart
	65	restart all items, or restart the item providing the specified
	66	.Ar service .
	67	.El
	68	.Sh OPTIONS
	69	.Bl -tag -width -indent
	70	.It Fl g
	71	(ignored)
	72	.It Fl v
	73	verbose (text mode) startup
	74	.It Fl x
	75	(ignored)
	76	.It Fl r
	77	(ignored)
	78	.It Fl d
	79	print debugging output
	80	.It Fl D
	81	print debugging output and dependencies
	82	.It Fl q
	83	be quiet (disable debugging output)
	84	.It Fl n
	85	don't actually perform action on items (no-run mode)
	86	.El
	87	.Sh NOTES
	88	Unless an explicit call to
	89	.Nm ConsoleMessage
	90	is made,
	91	.Nm
	92	examines the exit status of the startup item scripts to determine the success or failure of the services provided by that script.
	93	.Pp
e91b9f68 A	94	.Sh FILES
	95	.Bl -tag -width -/System/Library/StartupItems -compact
	96	.It Pa /Library/StartupItems/
	97	User-installed startup items.
	98	.It Pa /System/Library/StartupItems/
	99	System-provided startup items.
	100	.El
	101	.Sh SEE ALSO
	102	.\" List links in ascending order by section, alphabetically within a section.
	103	.\" Please do not reference files that do not exist without filing a bug report
ddbbfbc1 A	104	.Xr ConsoleMessage 8 ,
	105	.Xr launchd 8 ,
	106	.Xr launchd.plist 5 ,
e91b9f68 A	107	.Xr rc 8
	108	.\" .Sh BUGS \" Document known, unremedied bugs
	109	.Sh HISTORY
	110	The
	111	.Nm
ddbbfbc1	112	utility appeared in Darwin 1.0 and
e91b9f68	113	was extended in Darwin 6.0 to support partial startup and interprocess communication.
ddbbfbc1 A	114	.Nm
	115	was deprecated by
	116	.Xr launchd 8
	117	in Darwin 8.0.