Merge from vendor branch BIND:
[dragonfly.git] / libexec / atrun / atrun.man
1 .\" $FreeBSD: src/libexec/atrun/atrun.man,v 1.7.2.3 2001/08/16 10:44:13 ru Exp $
2 .\" $DragonFly: src/libexec/atrun/atrun.man,v 1.2 2003/06/17 04:27:07 dillon Exp $
3 .Dd April 12, 1995
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 atrun
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 .Xr atrun 8
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 .Sh OPTIONS
39 .Bl -tag -width indent
40 .It Fl l Ar load_avg
41 Specify a limiting load factor, over which batch jobs should
42 not be run, instead of the compiled in default of 1.5.
43 .It Fl d
44 Debug; print error messages to standard error instead of using
45 .Xr syslog 3 .
46 .El
47 .Sh WARNINGS
48 For
49 .Nm
50 to work, you have to start up a
51 .Xr cron 8
52 daemon.
53 .Sh FILES
54 .Bl -tag -width /var/at/spool -compact
55 .It Pa /var/at/spool
56 Directory containing output spool files
57 .It Pa /var/at/jobs
58 Directory containing job files
59 .El
60 .Sh SEE ALSO
61 .Xr at 1 ,
62 .Xr crontab 1 ,
63 .Xr syslog 3 ,
64 .Xr crontab 5 ,
65 .Xr cron 8
66 .Sh BUGS
67 The functionality of 
68 .Nm
69 should be merged into
70 .Xr cron 8 .