freebsd-skq/libexec/atrun/atrun.man

.\" $FreeBSD$
.Dd October 30, 2012
.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.
.Pp
Before starting a job,
.Nm
will check the status of its owner's account with
.Xr pam 3
and refuse to run the job if the account is unavailable,
e.g., locked out or expired.
.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 default of 1.5 * number of active CPUs.
.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 /etc/pam.d/atrun -compact
.It Pa /etc/pam.d/atrun
.Xr pam.conf 5
configuration file for
.Nm
.It Pa /var/at/jobs
Directory containing job files
.It Pa /var/at/spool
Directory containing output spool files
.El
.Sh SEE ALSO
.Xr at 1 ,
.Xr crontab 1 ,
.Xr pam 3 ,
.Xr syslog 3 ,
.Xr crontab 5 ,
.Xr pam.conf 5 ,
.Xr cron 8
.Sh BUGS
The functionality of
.Nm
should be merged into
.Xr cron 8 .
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
atrun(8): scale default load average limit with the number of CPUs Previously atrun refused to run jobs if load average was not below fixed limit of 1.5. PR: 173175 Reviewed by: peterj Approved by: trasz (mentor) MFC after: 2 weeks 2012-10-30 19:46:00 +00:00			`.Dd October 30, 2012`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Dt ATRUN 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 10:49:54 +00:00			`.Os`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.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 .`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`.Pp`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`Root's`
			`.Xr crontab 5`
			`file`
			`.Pa /etc/crontab`
			`has to contain the line`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Bd -literal`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`/5 * * * root /usr/libexec/atrun`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Ed`
			`.Pp`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`so that`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Nm`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`gets invoked every five minutes.`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Pp`
Removed trailing whitespace. 2004-07-02 19:07:33 +00:00			`At every invocation,`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Nm`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`will start all the jobs in the lowercase queues whose start`
			`time has elapsed.`
Removed trailing whitespace. 2004-07-02 19:07:33 +00:00			`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`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`uppercase queues) is started.`
Note PAM support in atrun(8). Sort FILES section while there. Touch document date. 2007-06-17 14:02:31 +00:00			`.Pp`
			`Before starting a job,`
			`.Nm`
			`will check the status of its owner's account with`
			`.Xr pam 3`
			`and refuse to run the job if the account is unavailable,`
			`e.g., locked out or expired.`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Sh OPTIONS`
			`.Bl -tag -width indent`
			`.It Fl l Ar load_avg`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`Specify a limiting load factor, over which batch jobs should`
atrun(8): scale default load average limit with the number of CPUs Previously atrun refused to run jobs if load average was not below fixed limit of 1.5. PR: 173175 Reviewed by: peterj Approved by: trasz (mentor) MFC after: 2 weeks 2012-10-30 19:46:00 +00:00			`not be run, instead of the default of 1.5 * number of active CPUs.`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.It Fl d`
			`Debug; print error messages to standard error instead of using`
			`.Xr syslog 3 .`
			`.El`
			`.Sh WARNINGS`
			`For`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Nm`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`to work, you have to start up a`
			`.Xr cron 8`
			`daemon.`
			`.Sh FILES`
Note PAM support in atrun(8). Sort FILES section while there. Touch document date. 2007-06-17 14:02:31 +00:00			`.Bl -tag -width /etc/pam.d/atrun -compact`
			`.It Pa /etc/pam.d/atrun`
			`.Xr pam.conf 5`
			`configuration file for`
			`.Nm`
Clean up grammar. Provide proper pathnames for spool directories. Document dependency on current load average for starting new batch jobs. PR: 7109 1998-07-01 05:47:58 +00:00			`.It Pa /var/at/jobs`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`Directory containing job files`
Note PAM support in atrun(8). Sort FILES section while there. Touch document date. 2007-06-17 14:02:31 +00:00			`.It Pa /var/at/spool`
			`Directory containing output spool files`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.El`
			`.Sh SEE ALSO`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Xr at 1 ,`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Xr crontab 1 ,`
Note PAM support in atrun(8). Sort FILES section while there. Touch document date. 2007-06-17 14:02:31 +00:00			`.Xr pam 3 ,`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Xr syslog 3 ,`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Xr crontab 5 ,`
Note PAM support in atrun(8). Sort FILES section while there. Touch document date. 2007-06-17 14:02:31 +00:00			`.Xr pam.conf 5 ,`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Xr cron 8`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`.Sh BUGS`
Removed trailing whitespace. 2004-07-02 19:07:33 +00:00			`The functionality of`
Cosmetic in error strings. Sort Xrefs. Add usage (with syslog capability). 1997-11-20 07:21:55 +00:00			`.Nm`
Upgrade. Close security holes reported. 1995-04-12 02:52:21 +00:00			`should be merged into`
			`.Xr cron 8 .`