From 4894b8245ba4139498ec155170e9bdc9f4a96eda Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordu.net>
Date: Fri, 2 Jun 2017 09:53:03 +0200
Subject: Add manpage documentation skeleton.

---
 doc/catlfish.1.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 doc/catlfish.1.md

(limited to 'doc/catlfish.1.md')

diff --git a/doc/catlfish.1.md b/doc/catlfish.1.md
new file mode 100644
index 0000000..31ce060
--- /dev/null
+++ b/doc/catlfish.1.md
@@ -0,0 +1,48 @@
+catlfish(1) -- Certificate Transparency log node
+================================================
+
+## SYNOPSIS
+
+`catlfish` [`-c` <config-name>] <command>
+
+## DESCRIPTION
+
+`catlfish` is a Certificate Transparency log. A node in a log instance
+can be started using the `start-node` command and stopped using the
+`stop-node` command.
+
+<command> is one of:
+
+* `start-node` [`-a` <application>]:
+  Start a `catlfish` node.
+
+* `stop-node`:
+  Stop a `catlfish` node.
+
+## OPTIONS
+
+* `-a` <application>:
+  Use <application> as the `-boot` argument to erl(1) instead of the
+  default application `catlfish`.
+
+* `-c` <config-name>:
+  Use <config-name> to find the configuration file for the node
+  instead of the name of the basename of the current working
+  directory. The configuration file should be generated by
+  genconfig(1).
+
+* `-d` <directory>:
+  Use <directory> as the `pipe_dir` argument to run_erl(1) instead of
+  using the current working directory (`.`).
+
+* `-l` <directory>:
+  Use <directory> as the `log_dir` argument to run_erl(1) instead of
+  using `./log'.
+
+## STANDARDS
+
+`RFC69662` Certificate Transparency
+
+## SEE ALSO
+
+genconfig(1), erl(1)
-- 
cgit v1.1