xref: /dragonfly/libexec/atrun/atrun.8 (revision 1975d09e)
1.\" $FreeBSD: src/libexec/atrun/atrun.man,v 1.13 2007/06/17 14:02:31 yar Exp $
2.\" $DragonFly: src/libexec/atrun/atrun.man,v 1.4 2007/07/29 17:27:45 swildner Exp $
3.Dd June 17, 2007
4.Dt ATRUN 8
5.Os
6.Sh NAME
7.Nm atrun
8.Nd run jobs queued for later execution
9.Sh SYNOPSIS
10.Nm
11.Op Fl l Ar load_avg
12.Op Fl d
13.Sh DESCRIPTION
14.Nm Atrun
15runs jobs queued by
16.Xr at 1 .
17.Pp
18Root's
19.Xr crontab 5
20file
21.Pa /etc/crontab
22has to contain the line
23.Bd -literal
24*/5     *       *       *       *       root    /usr/libexec/atrun
25.Ed
26.Pp
27so that
28.Nm
29gets invoked every five minutes.
30.Pp
31At every invocation,
32.Nm
33will start all the jobs in the lowercase queues whose start
34time has elapsed.
35In addition, if the load average over the last minute was less than
36the specified limit then a maximum of one batch job (denoted by the
37uppercase queues) is started.
38.Pp
39Before starting a job,
40.Nm
41will check the status of its owner's account with
42.Xr pam 3
43and refuse to run the job if the account is unavailable,
44e.g., locked out or expired.
45.Sh OPTIONS
46.Bl -tag -width indent
47.It Fl l Ar load_avg
48Specify a limiting load factor, over which batch jobs should
49not be run, instead of the compiled in default of 1.5.
50.It Fl d
51Debug; print error messages to standard error instead of using
52.Xr syslog 3 .
53.El
54.Sh WARNINGS
55For
56.Nm
57to work, you have to start up a
58.Xr cron 8
59daemon.
60.Sh FILES
61.Bl -tag -width /etc/pam.d/atrun -compact
62.It Pa /etc/pam.d/atrun
63.Xr pam.conf 5
64configuration file for
65.Nm
66.It Pa /var/at/jobs
67Directory containing job files
68.It Pa /var/at/spool
69Directory containing output spool files
70.El
71.Sh SEE ALSO
72.Xr at 1 ,
73.Xr crontab 1 ,
74.Xr pam 3 ,
75.Xr syslog 3 ,
76.Xr crontab 5 ,
77.Xr pam.conf 5 ,
78.Xr cron 8
79.Sh BUGS
80The functionality of
81.Nm
82should be merged into
83.Xr cron 8 .
84