libexec/atrun/atrun.man

   1 .Dd June 22, 2015
   2 .Dt ATRUN 8
   3 .Os
   4 .Sh NAME
   5 .Nm atrun
   6 .Nd run jobs queued for later execution
   7 .Sh SYNOPSIS
   8 .Nm atrun
   9 .Op Fl l Ar load_avg
  10 .Op Fl d
  11 .Sh DESCRIPTION
  12 .Nm Atrun
  13 runs jobs queued by
  14 .Xr at 1 .
  15 .Pp
  16 The system
  17 .Xr crontab 5
  18 file
  19 .Pa /etc/crontab
  20 must contain the line
  21 .Bd -literal
  22 */5     *       *       *       *       root    /usr/libexec/atrun
  23 .Ed
  24 .Pp
  25 so
  26 .Nm
  27 is invoked every five minutes.
  28 .Pp
  29 At every invocation,
  30 .Nm
  31 starts all the jobs in the lowercase queues whose start
  32 time has elapsed.
  33 In addition, if the load average over the last minute was less than
  34 the specified limit, then a maximum of one batch job (denoted by the
  35 uppercase queues) is started.
  36 .Pp
  37 Before starting a job,
  38 .Nm
  39 checks the status of its owner's account with
  40 .Xr pam 3
  41 and refuses to run the job if the account is unavailable,
  42 e.g., locked out or expired.
  43 .Sh OPTIONS
  44 .Bl -tag -width indent
  45 .It Fl l Ar load_avg
  46 Specify a limiting load factor, over which batch jobs should
  47 not be run, instead of the default of 1.5 * number of active CPUs.
  48 .It Fl d
  49 Debug; print error messages to standard error instead of using
  50 .Xr syslog 3 .
  51 .El
  52 .Sh WARNINGS
  53 For
  54 .Nm
  55 to work, a
  56 .Xr cron 8
  57 daemon must be running
  58 .Nm
  59 periodically.
  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 .