From 4a0c0f8fac5610b74297828ec1b3a924967e2061 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 30 Dec 2015 14:22:15 +0100 Subject: man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/satd.1 | 43 +++++++++++++++++++++ doc/man/satq.1 | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/man/satr.1 | 48 +++++++++++++++++++++++ doc/man/satrm.1 | 45 ++++++++++++++++++++++ 4 files changed, 252 insertions(+) create mode 100644 doc/man/satd.1 create mode 100644 doc/man/satq.1 create mode 100644 doc/man/satr.1 create mode 100644 doc/man/satrm.1 (limited to 'doc') diff --git a/doc/man/satd.1 b/doc/man/satd.1 new file mode 100644 index 0000000..eab8f01 --- /dev/null +++ b/doc/man/satd.1 @@ -0,0 +1,43 @@ +.TH SATD 1 SAT +.SH NAME +satd \- Start the daemon that runs jobs queued for later execution. +.SH SYNOPSIS +.B satd +.RB [ \-f ] +.SH DESCRIPTION +.BR satd (1) +shall start the +.B sat +daemon, which is used for automatically executing jobs +queued for later execution. +.SH OPTIONS +.TP +.B \-f +Run the daemon in the foreground. +.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 diff --git a/doc/man/satq.1 b/doc/man/satq.1 new file mode 100644 index 0000000..5c52d31 --- /dev/null +++ b/doc/man/satq.1 @@ -0,0 +1,116 @@ +.TH SATQ 1 SAT +.SH NAME +satq \- List all jobs queued for later execution. +.SH SYNOPSIS +.B satq +.SH DESCRIPTION +.BR satq (1) +shall list all jobs in +.BR sat 's +list of jobs queued for later execution. Each job in the +queue is separated by one empty line (LF LF), there is +a empty line at the end of the output too. Each job is +printed on multiple lines, where all but the first line +is indented with two blank spaces. The first line is not +indented. The output for each job is formatted +.PP +.nf +job: \fIJOB-ID\fP clock: \fICLOCK\fP argc: \fIARGC\fP remaining: \fIREM\fP argv[0]: \fIARGV0\fP + time: \fITIME\fP + argv: \fIARGV\fP + envp: \fIENVP\fP +.fi +.PP +where +.TP +.I JOB-ID +is a the ID of the job. This is a non-negative integer. +.TP +.I CLOCK +is either +.B walltime +or +.BR boottime . +.TP +.I ARGC +is the number of arguments in the job's command line, including +the command itself. This is a positive integer. +.TP +.I REM +is the remaining time until the job is executed. This is +formatted +.RI [ DAYS \fBd\fP[ HOURS \fB:\fP[ MINUTES \fB:\fP]]] SECONDS \fB.\fP NANOSECONDS +where +.IR DAYS , +.IR HOURS , +and +.IR MINUTES +are only included if non-zero or a higher-valued variable +is included. The first included uses as few digits as +possible, the others uses two digits, this true for +.I SECONDS +too. +.I NANOSECONDS +is always in nine digits. +.TP +.I ARGV0 +is the first argument in the job's command line, that is, +the command that will be executed. This field, in contrast +to the eailer, may contain spaces. However it will be +quoted, if necessary, in manner so that it can be pasted +to the shell and run. +.TP +.I TIME +is the time the job will be executed. If the +.I CLOCK +is +.BR boottime , +this is formatted as +.IR REM . +If +.I CLOCK +is +.BR walltime , +it is formatted +.IB YEAR - MM - DD \ HH : MM : SS +in 24-hour clock, local time. +.TP +.I ARGV +is all arguments in the job's command line, including +.IR ARGV0 . +Each argument is quoted if necssary. +.TP +.I ENVP +is all environment variables. Each entry is quoted +if necessary so it can be pasted to the shell and +used with +.BR env (1). +.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 satrm (1), +.BR satr (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 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 diff --git a/doc/man/satrm.1 b/doc/man/satrm.1 new file mode 100644 index 0000000..8e2633d --- /dev/null +++ b/doc/man/satrm.1 @@ -0,0 +1,45 @@ +.TH SATRM 1 SAT +.SH NAME +satrm \- Unqueue a job for later execution. +.SH SYNOPSIS +.B satrm +.IR JOB-ID ... +.SH DESCRIPTION +.BR satrm (1) +shall 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). +.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 satr (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 -- cgit v1.2.3-70-g09d2