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