Sync usage with man page.
[netbsd-mini2440.git] / libexec / atrun / atrun.8
blobe5751bab821be51f89e81b91d8be99b251564cd2
1 .\" $NetBSD: atrun.8,v 1.10 2000/11/07 06:43:25 lukem Exp $
2 .\" $OpenBSD: atrun.8,v 1.4 1998/05/22 22:16:29 deraadt Exp $
3 .\" $FreeBSD: atrun.man,v 1.3 1997/02/22 14:20:55 peter Exp $
4 .Dd April 12, 1995
5 .Dt ATRUN 8
6 .Os
7 .Sh NAME
8 .Nm atrun
9 .Nd run jobs queued for later execution
10 .Sh SYNOPSIS
11 .Nm atrun
12 .Op Fl l Ar load_avg
13 .Op Fl d
14 .Sh DESCRIPTION
15 .Nm
16 runs jobs queued by
17 .Xr at 1 .
18 Root's
19 .Xr crontab 5
20 must contain the line:
21 .Bd -literal
22 */10     *       *       *       *       root    /usr/libexec/atrun
23 .Ed
24 .Pp
25 so that
26 .Xr atrun 8
27 gets called every ten minutes.
28 .Pp
29 At every invocation, every job in lowercase queues whose starting time
30 has passed is started.
31 A maximum of one batch job (denoted by uppercase queues) is started
32 each time
33 .Nm
34 is invoked.
35 .Sh OPTIONS
36 .Bl -tag -width indent
37 .It Fl l Ar load_avg
38 Specifies a limiting load factor, over which batch jobs should
39 not be run, instead of the compiled-in value of 1.5.
40 .It Fl d
41 Debug; print error messages to standard error instead of using
42 .Xr syslog 3 .
43 .El
44 .Sh WARNINGS
45 For
46 .Nm
47 to work, you have to start up a
48 .Xr cron 8
49 daemon.
50 .Sh FILES
51 .Bl -tag -width /var/at/spool -compact
52 .It Pa /var/at/spool
53 Directory containing output spool files
54 .It Pa /var/at/jobs
55 Directory containing job files
56 .El
57 .Sh SEE ALSO
58 .Xr at 1 ,
59 .Xr crontab 1 ,
60 .Xr syslog 3 ,
61 .Xr crontab 5 ,
62 .Xr cron 8
63 .Sh AUTHORS
64 .An Thomas Koenig Aq ig25@rz.uni-karlsruhe.de
65 .Sh BUGS
66 The functionality of
67 .Nm
68 should be merged into
69 .Xr cron 8 .