[apple/system_cmds.git] / atrun.tproj / atrun.man

.\" $FreeBSD: src/libexec/atrun/atrun.man,v 1.12 2004/07/02 19:07:31 ru Exp $
.Dd April 12, 1995
.Dt ATRUN 8
.Os
.Sh NAME
.Nm atrun
.Nd run jobs queued for later execution
.Sh SYNOPSIS
.Nm atrun
.Op Fl l Ar load_avg
.Op Fl d
.Sh DESCRIPTION
.Nm Atrun
runs jobs queued by
.Xr at 1 .
.Pp
Root's
.Xr crontab 5
file
.Pa /etc/crontab
has to contain the line
.Bd -literal
*/5     *       *       *       *       root    /usr/libexec/atrun
.Ed
.Pp
so that
.Nm
gets invoked every five minutes.
.Pp
At every invocation,
.Nm
will start all the jobs in the lowercase queues whose start
time has elapsed.
In addition, if the load average over the last minute was less than
the specified limit then a maximum of one batch job (denoted by the
uppercase queues) is started.
.Sh OPTIONS
.Bl -tag -width indent
.It Fl l Ar load_avg
Specify a limiting load factor, over which batch jobs should
not be run, instead of the compiled in default of 1.5.
.It Fl d
Debug; print error messages to standard error instead of using
.Xr syslog 3 .
.El
.Sh WARNINGS
For
.Nm
to work, you have to start up a
.Xr cron 8
daemon.
.Sh FILES
.Bl -tag -width /var/at/spool -compact
.It Pa /var/at/spool
Directory containing output spool files
.It Pa /var/at/jobs
Directory containing job files
.El
.Sh SEE ALSO
.Xr at 1 ,
.Xr crontab 1 ,
.Xr syslog 3 ,
.Xr crontab 5 ,
.Xr cron 8
.Sh BUGS
The functionality of
.Nm
should be merged into
.Xr cron 8 .
Commit	Line	Data
916eb79e A	1	.\" $FreeBSD: src/libexec/atrun/atrun.man,v 1.12 2004/07/02 19:07:31 ru Exp $
	2	.Dd April 12, 1995
	3	.Dt ATRUN 8
	4	.Os
	5	.Sh NAME
	6	.Nm atrun
	7	.Nd run jobs queued for later execution
	8	.Sh SYNOPSIS
	9	.Nm atrun
	10	.Op Fl l Ar load_avg
	11	.Op Fl d
	12	.Sh DESCRIPTION
	13	.Nm Atrun
	14	runs jobs queued by
	15	.Xr at 1 .
	16	.Pp
	17	Root's
	18	.Xr crontab 5
	19	file
	20	.Pa /etc/crontab
	21	has to contain the line
	22	.Bd -literal
	23	/5 * * * root /usr/libexec/atrun
	24	.Ed
	25	.Pp
	26	so that
	27	.Nm
	28	gets invoked every five minutes.
	29	.Pp
	30	At every invocation,
	31	.Nm
	32	will start all the jobs in the lowercase queues whose start
	33	time has elapsed.
	34	In addition, if the load average over the last minute was less than
	35	the specified limit then a maximum of one batch job (denoted by the
	36	uppercase queues) is started.
	37	.Sh OPTIONS
	38	.Bl -tag -width indent
	39	.It Fl l Ar load_avg
	40	Specify a limiting load factor, over which batch jobs should
	41	not be run, instead of the compiled in default of 1.5.
	42	.It Fl d
	43	Debug; print error messages to standard error instead of using
	44	.Xr syslog 3 .
	45	.El
	46	.Sh WARNINGS
	47	For
	48	.Nm
	49	to work, you have to start up a
	50	.Xr cron 8
	51	daemon.
	52	.Sh FILES
	53	.Bl -tag -width /var/at/spool -compact
	54	.It Pa /var/at/spool
	55	Directory containing output spool files
	56	.It Pa /var/at/jobs
	57	Directory containing job files
	58	.El
	59	.Sh SEE ALSO
	60	.Xr at 1 ,
	61	.Xr crontab 1 ,
	62	.Xr syslog 3 ,
	63	.Xr crontab 5 ,
	64	.Xr cron 8
65	.Sh BUGS
66	The functionality of
67	.Nm
68	should be merged into
69	.Xr cron 8 .