Initial version.release/1

1 files changed, 36 insertions, 0 deletions

diff --git a/man/olamic-worker.1.md b/man/olamic-worker.1.md
new file mode 100644
index 0000000..d558f47
--- /dev/null
+++ b/man/olamic-worker.1.md
@@ -0,0 +1,36 @@
+% OLAMIC-WORKER(1)
+% Julian B Kongslie
+% October 2020
+
+# NAME
+
+olamic-worker - run olamic tasks
+
+# SYNOPSIS
+
+**olamic-worker**
+
+# DESCRIPTION
+
+**olamic-worker** will continuously try to pull a new task from the olamic
+queue, and run it. It uses its current working directory as a scratch space.
+
+# ENVIRONMENT VARIABLES
+
+**OLAMIC_EMAIL**
+:   The default email to complain to if a task fails. This can (and typically
+    will) be overridden on a per-task basis.
+
+**OLAMIC_QUEUE_HOST**
+:   The host where the olamic queue lives. Defaults to the local machine.
+
+**OLAMIC_QUEUE_DIR**
+:   The directory where the olamic queue lives. Defaults to /srv/olamic/queue.
+
+**OLAMIC_WORKER_PERIOD**
+:   How long the worker sleeps for when it can't find a task. Defaults to one
+    minute.
+
+# SEE ALSO
+
+olamic-enqueue(1)