Initial version.release/1

2 files changed, 60 insertions, 0 deletions

diff --git a/man/olamic-enqueue.1.md b/man/olamic-enqueue.1.md
new file mode 100644
index 0000000..15434cc
--- /dev/null
+++ b/man/olamic-enqueue.1.md
@@ -0,0 +1,24 @@
+% OLAMIC-ENQUEUE(1)
+% Julian B Kongslie
+% October 2020
+
+# NAME
+
+olamic-enqueue - create a new task for olamic
+
+# SYNOPSIS
+
+**olamic-enqueue** **/path/to/queue** **/url/for/git/repo** **git-commit-hash** [**VAR**=**VALUE** ...]
+
+# DESCRIPTION
+
+**olamic-enqueue** creates a new task within the specified queue which will
+clone the given repository at the given commit. It reads from stdin a script to
+run within the checkout. Any additional variables passed on the command line
+will be available to the script when it runs.
+
+When **olamic-enqueue** completes, it prints the UUID of the created task.
+
+# SEE ALSO
+
+olamic-worker(1)
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)