xref: /freebsd-src/libexec/atrun/atrun.man (revision 783baf00128f6cf6fc08404eaad6a11b29d4025d)
1d33daab9SWarren Block.Dd June 22, 2015
2c70e5825SAndrey A. Chernov.Dt ATRUN 8
30efe23d6SRuslan Ermilov.Os
4c70e5825SAndrey A. Chernov.Sh NAME
5c70e5825SAndrey A. Chernov.Nm atrun
6c70e5825SAndrey A. Chernov.Nd run jobs queued for later execution
7c70e5825SAndrey A. Chernov.Sh SYNOPSIS
8c70e5825SAndrey A. Chernov.Nm atrun
9c70e5825SAndrey A. Chernov.Op Fl l Ar load_avg
10c70e5825SAndrey A. Chernov.Op Fl d
11c70e5825SAndrey A. Chernov.Sh DESCRIPTION
12c70e5825SAndrey A. Chernov.Nm Atrun
13c70e5825SAndrey A. Chernovruns jobs queued by
14c70e5825SAndrey A. Chernov.Xr at 1 .
15d1428a91SJoseph Koshy.Pp
16d33daab9SWarren BlockThe system
17c70e5825SAndrey A. Chernov.Xr crontab 5
18c70e5825SAndrey A. Chernovfile
19*783baf00SPaweł Krawczyk.Pa /etc/cron.d/at
20d33daab9SWarren Blockmust contain the line
21d0353b83SRuslan Ermilov.Bd -literal
22d1428a91SJoseph Koshy*/5     *       *       *       *       root    /usr/libexec/atrun
23d0353b83SRuslan Ermilov.Ed
24d0353b83SRuslan Ermilov.Pp
25d33daab9SWarren Blockso
26facc6767SRuslan Ermilov.Nm
27d33daab9SWarren Blockis invoked every five minutes.
28c70e5825SAndrey A. Chernov.Pp
29d1428a91SJoseph KoshyAt every invocation,
30864b6b6eSPhilippe Charnier.Nm
31d33daab9SWarren Blockstarts all the jobs in the lowercase queues whose start
32d1428a91SJoseph Koshytime has elapsed.
33d1428a91SJoseph KoshyIn addition, if the load average over the last minute was less than
34d33daab9SWarren Blockthe specified limit, then a maximum of one batch job (denoted by the
35d1428a91SJoseph Koshyuppercase queues) is started.
3654dd7f5cSYaroslav Tykhiy.Pp
3754dd7f5cSYaroslav TykhiyBefore starting a job,
3854dd7f5cSYaroslav Tykhiy.Nm
39d33daab9SWarren Blockchecks the status of its owner's account with
4054dd7f5cSYaroslav Tykhiy.Xr pam 3
41d33daab9SWarren Blockand refuses to run the job if the account is unavailable,
4254dd7f5cSYaroslav Tykhiye.g., locked out or expired.
43c70e5825SAndrey A. Chernov.Sh OPTIONS
44c70e5825SAndrey A. Chernov.Bl -tag -width indent
45c70e5825SAndrey A. Chernov.It Fl l Ar load_avg
46864b6b6eSPhilippe CharnierSpecify a limiting load factor, over which batch jobs should
47e61e6189SMateusz Guziknot be run, instead of the default of 1.5 * number of active CPUs.
48c70e5825SAndrey A. Chernov.It Fl d
49c70e5825SAndrey A. ChernovDebug; print error messages to standard error instead of using
50c70e5825SAndrey A. Chernov.Xr syslog 3 .
51c70e5825SAndrey A. Chernov.El
52c70e5825SAndrey A. Chernov.Sh WARNINGS
53c70e5825SAndrey A. ChernovFor
54864b6b6eSPhilippe Charnier.Nm
55d33daab9SWarren Blockto work, a
56c70e5825SAndrey A. Chernov.Xr cron 8
57d33daab9SWarren Blockdaemon must be running
58d33daab9SWarren Block.Nm
59d33daab9SWarren Blockperiodically.
60c70e5825SAndrey A. Chernov.Sh FILES
6154dd7f5cSYaroslav Tykhiy.Bl -tag -width /etc/pam.d/atrun -compact
6254dd7f5cSYaroslav Tykhiy.It Pa /etc/pam.d/atrun
6354dd7f5cSYaroslav Tykhiy.Xr pam.conf 5
6454dd7f5cSYaroslav Tykhiyconfiguration file for
6554dd7f5cSYaroslav Tykhiy.Nm
66d1428a91SJoseph Koshy.It Pa /var/at/jobs
67c70e5825SAndrey A. ChernovDirectory containing job files
6854dd7f5cSYaroslav Tykhiy.It Pa /var/at/spool
6954dd7f5cSYaroslav TykhiyDirectory containing output spool files
70c70e5825SAndrey A. Chernov.El
71c70e5825SAndrey A. Chernov.Sh SEE ALSO
72c70e5825SAndrey A. Chernov.Xr at 1 ,
73864b6b6eSPhilippe Charnier.Xr crontab 1 ,
7454dd7f5cSYaroslav Tykhiy.Xr pam 3 ,
75864b6b6eSPhilippe Charnier.Xr syslog 3 ,
76864b6b6eSPhilippe Charnier.Xr crontab 5 ,
7754dd7f5cSYaroslav Tykhiy.Xr pam.conf 5 ,
78864b6b6eSPhilippe Charnier.Xr cron 8
79c70e5825SAndrey A. Chernov.Sh BUGS
80c70e5825SAndrey A. ChernovThe functionality of
81864b6b6eSPhilippe Charnier.Nm
82c70e5825SAndrey A. Chernovshould be merged into
83c70e5825SAndrey A. Chernov.Xr cron 8 .
84