aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/satr.1
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2015-12-30 14:22:15 +0100
committerMattias Andrée <maandree@member.fsf.org>2015-12-30 14:22:15 +0100
commit4a0c0f8fac5610b74297828ec1b3a924967e2061 (patch)
tree79c36f0d9270994fcddc80335f03e3b3971aa4b1 /doc/man/satr.1
parentupdate makefile (diff)
downloadsat-4a0c0f8fac5610b74297828ec1b3a924967e2061.tar.gz
sat-4a0c0f8fac5610b74297828ec1b3a924967e2061.tar.bz2
sat-4a0c0f8fac5610b74297828ec1b3a924967e2061.tar.xz
man pages
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'doc/man/satr.1')
-rw-r--r--doc/man/satr.148
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/man/satr.1 b/doc/man/satr.1
new file mode 100644
index 0000000..d3ebb4a
--- /dev/null
+++ b/doc/man/satr.1
@@ -0,0 +1,48 @@
+.TH SATR 1 SAT
+.SH NAME
+satr \- Run jobs queued for later execution early.
+.SH SYNOPSIS
+.B satr
+.RI [ JOB-ID ]...
+.SH DESCRIPTION
+.BR satr (1)
+shall execute and remove one or more jobs from
+.BR sat 's
+list of jobs queued for later execution. The job's to
+remove shall have an ID listed in
+.IR JOB-ID .
+This is a numerical value, which can be found by examining
+the queue with
+.BR satq (1).
+If no
+.I JOB-ID
+is specified, all queued jobs shall be executed and removed.
+.SH OPTIONS
+None.
+.SH ENVIRONMENT
+.TP
+.B XDG_RUNTIME_DIR
+This environment variable names the directory in which
+interprocess communication related files are stored. If
+unset or empty, /run is used.
+.TP
+.B SAT_HOOK_PATH
+The pathname of the hook script to use. Does not have to
+already exist. If not defined, $XDG_CONFIG_HOME/sat/hook
+(if XDG_CONFIG_HOME is defined), $HOME/.config/sat/hook
+(if HOME is defined), ~/.config/sat/hook (if the user has
+a home and is not root), or /etc/sat/hook (otherwise) is
+used.
+.SH "SEE ALSO"
+.BR sat (1),
+.BR satq (1),
+.BR satrm (1),
+.BR satd (1)
+.SH AUTHORS
+Principal author, Mattias Andrée. See the COPYING file for the full
+list of authors.
+.SH LICENSE
+MIT/Expat License.
+.SH BUGS
+Please report bugs to https://github.com/maandree/sat/issues or to
+maandree@member.fsf.org