[apple/launchd.git] / launchd / src / launchctl.1

.Dd September 30, 2004
.Dt launchctl 1
.Os Darwin
.Sh NAME
.Nm launchctl
.Nd Interfaces with launchd
.Sh SYNOPSIS
.Nm
.Op Ar subcommand Op Ar arguments ...
.Sh DESCRIPTION
.Nm 
interfaces with
.Nm launchd
to load, unload daemons/agents and generally control
.Nm launchd .
.Nm
supports taking subcommands on the command line, interactively or even redirected from standard input.
These commands can be stored in
.Nm $HOME/.launchd.conf
or
.Nm /etc/launchd.conf
to be read at the time
.Nm launchd
starts.
.Sh SUBCOMMANDS
.Bl -tag -width -indent
.It Xo Ar load Op Fl wF
.Ar paths ...
.Xc
Load the specified configuration files or directories of configuration files.
.Bl -tag -width -indent
.It Fl w
Remove the disabled key and write the configuration files back out to disk.
.It Fl F
Force the loading of the plist. Ignore the Disabled key.
.El
.It Xo Ar unload Op Fl w
.Ar paths ...
.Xc
Unload the specified configuration files or directories of configuration files.
.Bl -tag -width -indent
.It Fl w
Add the disabled key and write the configuration files back out to disk.
.El
.It Ar start Ar joblabels ...
Start the specified jobs by label.
.It Ar stop Ar joblabels ...
Stop the specified jobs by label. Jobs may restart automatically if demand driven.
.It Ar list
List all of the jobs loaded into
.Nm launchd .
.It Ar setenv Ar key Ar value
Set an environmental variable inside of
.Nm launchd .
.It Ar unsetenv Ar key
Unset an environmental variable inside of
.Nm launchd .
.It Ar getenv Ar key
Get an environmental variable inside of
.Nm launchd .
.It Ar export
Export all of the environmental variables of
.Nm launchd
for use in a shell eval statement.
.It Ar getrusage self | children
Get the resource utilization statistics for
.Nm launchd
or the children of
.Nm launchd .
.It Xo Ar log
.Op Ar level loglevel
.Op Ar only | mask loglevels...
.Xc
Get and set the
.Xr syslog 3
log level mask. The available log levels are: debug, info, notice, warning, error, critical, alert and emergency.
.It Xo Ar limit
.Op Ar cpu | filesize | data | stack | core | rss | memlock | maxproc | maxfiles
.Op Ar both Op Ar soft | hard
.Xc
With no arguments, this command prints all the resource limits of
.Nm launchd
as found via
.Xr getrlimit 2 .
When a given resource is specified, it prints the limits for that resource.
With a third argument, it sets both the hard and soft limits to that value.
With four arguments, the third and forth argument represent the soft and hard limits respectively.
See
.Xr setrlimit 2 .
.It Ar stdout path
Set the standard out file descriptor to the given path.
.Nm launchd
.It Ar stderr path
Set the standard error file descriptor to the given path.
.Nm launchd
.It Ar shutdown
Tell
.Nm launchd
to prepare for shutdown by removing all jobs.
.It Ar reloadttys
Tell
.Nm launchd
to reread /etc/ttys. This option may go away in a future release.
.It Ar umask Op Ar newmask
Get or optionally set the
.Xr umask 2
of
.Nm launchd .
.It Ar help
Print out a quick usage statement.
.El
.Sh ENVIRONMENTAL VARIABLES
.Bl -tag -width -indent
.It Pa LAUNCHD_SOCKET
This variable informs launchctl how to find the correct launchd to talk to. If it is missing, launchctl will use a built-in default.
.El
.Sh FILES
.Bl -tag -width "/System/Library/LaunchDaemons" -compact
.It Pa ~/Library/LaunchAgents
Per-user agents provided by the user.
.It Pa /Library/LaunchAgents
Per-user agents provided by the administrator.
.It Pa /Library/LaunchDaemons
System wide daemons provided by the administrator.
.It Pa /System/Library/LaunchAgents
Mac OS X Per-user agents.
.It Pa /System/Library/LaunchDaemons
Mac OS X System wide daemons.
.El
.Sh SEE ALSO 
.Xr launchd.plist 5 ,
.Xr launchd.conf 5 ,
.Xr launchd 8
Commit	Line	Data
e91b9f68 A	1	.Dd September 30, 2004
	2	.Dt launchctl 1
	3	.Os Darwin
	4	.Sh NAME
	5	.Nm launchctl
	6	.Nd Interfaces with launchd
	7	.Sh SYNOPSIS
	8	.Nm
	9	.Op Ar subcommand Op Ar arguments ...
	10	.Sh DESCRIPTION
	11	.Nm
	12	interfaces with
	13	.Nm launchd
	14	to load, unload daemons/agents and generally control
	15	.Nm launchd .
	16	.Nm
	17	supports taking subcommands on the command line, interactively or even redirected from standard input.
	18	These commands can be stored in
	19	.Nm $HOME/.launchd.conf
	20	or
	21	.Nm /etc/launchd.conf
	22	to be read at the time
	23	.Nm launchd
	24	starts.
	25	.Sh SUBCOMMANDS
	26	.Bl -tag -width -indent
ab36757d	27	.It Xo Ar load Op Fl wF
e91b9f68 A	28	.Ar paths ...
	29	.Xc
	30	Load the specified configuration files or directories of configuration files.
	31	.Bl -tag -width -indent
	32	.It Fl w
	33	Remove the disabled key and write the configuration files back out to disk.
ab36757d A	34	.It Fl F
ab36757d A	35	Force the loading of the plist. Ignore the Disabled key.
e91b9f68 A	36	.El
	37	.It Xo Ar unload Op Fl w
	38	.Ar paths ...
	39	.Xc
	40	Unload the specified configuration files or directories of configuration files.
	41	.Bl -tag -width -indent
	42	.It Fl w
	43	Add the disabled key and write the configuration files back out to disk.
	44	.El
	45	.It Ar start Ar joblabels ...
	46	Start the specified jobs by label.
	47	.It Ar stop Ar joblabels ...
	48	Stop the specified jobs by label. Jobs may restart automatically if demand driven.
	49	.It Ar list
	50	List all of the jobs loaded into
	51	.Nm launchd .
	52	.It Ar setenv Ar key Ar value
	53	Set an environmental variable inside of
	54	.Nm launchd .
	55	.It Ar unsetenv Ar key
	56	Unset an environmental variable inside of
	57	.Nm launchd .
	58	.It Ar getenv Ar key
	59	Get an environmental variable inside of
	60	.Nm launchd .
	61	.It Ar export
	62	Export all of the environmental variables of
	63	.Nm launchd
	64	for use in a shell eval statement.
	65	.It Ar getrusage self \| children
	66	Get the resource utilization statistics for
	67	.Nm launchd
	68	or the children of
	69	.Nm launchd .
	70	.It Xo Ar log
	71	.Op Ar level loglevel
	72	.Op Ar only \| mask loglevels...
	73	.Xc
	74	Get and set the
	75	.Xr syslog 3
	76	log level mask. The available log levels are: debug, info, notice, warning, error, critical, alert and emergency.
	77	.It Xo Ar limit
	78	.Op Ar cpu \| filesize \| data \| stack \| core \| rss \| memlock \| maxproc \| maxfiles
	79	.Op Ar both Op Ar soft \| hard
	80	.Xc
	81	With no arguments, this command prints all the resource limits of
	82	.Nm launchd
	83	as found via
	84	.Xr getrlimit 2 .
	85	When a given resource is specified, it prints the limits for that resource.
	86	With a third argument, it sets both the hard and soft limits to that value.
	87	With four arguments, the third and forth argument represent the soft and hard limits respectively.
	88	See
	89	.Xr setrlimit 2 .
	90	.It Ar stdout path
	91	Set the standard out file descriptor to the given path.
	92	.Nm launchd
	93	.It Ar stderr path
	94	Set the standard error file descriptor to the given path.
	95	.Nm launchd
	96	.It Ar shutdown
	97	Tell
	98	.Nm launchd
	99	to prepare for shutdown by removing all jobs.
100	.It Ar reloadttys
101	Tell
102	.Nm launchd
103	to reread /etc/ttys. This option may go away in a future release.
104	.It Ar umask Op Ar newmask
105	Get or optionally set the
106	.Xr umask 2
107	of
108	.Nm launchd .
109	.It Ar help
110	Print out a quick usage statement.
111	.El
ab36757d A	112	.Sh ENVIRONMENTAL VARIABLES
	113	.Bl -tag -width -indent
	114	.It Pa LAUNCHD_SOCKET
	115	This variable informs launchctl how to find the correct launchd to talk to. If it is missing, launchctl will use a built-in default.
	116	.El
e91b9f68 A	117	.Sh FILES
	118	.Bl -tag -width "/System/Library/LaunchDaemons" -compact
	119	.It Pa ~/Library/LaunchAgents
	120	Per-user agents provided by the user.
	121	.It Pa /Library/LaunchAgents
	122	Per-user agents provided by the administrator.
	123	.It Pa /Library/LaunchDaemons
	124	System wide daemons provided by the administrator.
	125	.It Pa /System/Library/LaunchAgents
	126	Mac OS X Per-user agents.
	127	.It Pa /System/Library/LaunchDaemons
	128	Mac OS X System wide daemons.
	129	.El
	130	.Sh SEE ALSO
	131	.Xr launchd.plist 5 ,
	132	.Xr launchd.conf 5 ,
	133	.Xr launchd 8