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