From 98118f00ad5a9f10e8f25f6e9e5de7ae10bdaf63 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 23 Dec 2015 16:48:47 +0100 Subject: add readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..7cb23bb --- /dev/null +++ b/README @@ -0,0 +1,33 @@ +NAME + sat - A simple implementation of at(1), with some incompatibility + +DESCRIPTION + sat is a simple implementation of at(1). But is not fully compatible + with at(1). It is used to queue jobs to be executed later, outside + the current controlling terminal. + + sat can also print and edit the list of queued jobs. + +RATIONALE + at(1) is far too complex. + + sat does not do natural language time parsing, it is far too complex, + and locale dependent, for all programs to implemeent and should be + done in a separate program. + + sat does not sanitise the environment. You have env(1) for that. + Relaying on sat to sanitise the environment appropriately could prove + to be a misfortune. + + sat does not do mailing because that is very restrictive, hooks are + used instead. + +ENVIRONMENY + XDG_RUNTIME_DIR + This environment variable names the directory in which + interprocess communication related files are stored. If + unset or empty, /run is used. + +SEE ALSO + at(1), cron(1), sleep-until(1) + -- cgit v1.2.3-70-g09d2