diff options
author | Linus Nordberg <linus@nordu.net> | 2017-06-02 09:53:03 +0200 |
---|---|---|
committer | Linus Nordberg <linus@nordu.net> | 2017-07-06 17:48:30 +0200 |
commit | bb71cbabaac8baf18f7a685339f0e2670b019d91 (patch) | |
tree | 9e3406d251a281a847429c7bf065a928737ca909 /doc/catlfish.1.md | |
parent | 49445bfe1985054ee18691bf27c4033285401ddb (diff) |
Add manpage documentation skeleton.
Diffstat (limited to 'doc/catlfish.1.md')
-rw-r--r-- | doc/catlfish.1.md | 48 |
1 files changed, 48 insertions, 0 deletions
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) |