summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMagnus Ahltorp <map@kth.se>2017-07-03 00:21:02 +0200
committerLinus Nordberg <linus@nordu.net>2017-07-06 17:48:30 +0200
commitbb67c23918ba22be498537a29c01b696732d5b3b (patch)
tree4562cc0f90eac0fb992508f64946ad28ee4bb636 /doc
parentb09e878a21c09d8344ec8b2a896d7d1a8162387e (diff)
Automatic generation of config man page skeleton
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile10
-rw-r--r--doc/catlfish-log.cfg.in.5.adoc95
-rw-r--r--doc/catlfish-node.cfg.5.adoc113
3 files changed, 217 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile
index b3de194..528b6d5 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,7 +1,12 @@
MANDOCS = catlfish.1 genconfig.1
RONN = ronn --warnings --organization="FIXME:\$$version"
-all: man html
+all: configman man html
+
+configman:
+ ../tools/compileconfig.py --manpagedir=.
+ make catlfish-log.cfg.in.5
+ make catlfish-node.cfg.5
man: $(MANDOCS)
@@ -10,6 +15,9 @@ html: $(addsuffix .html,$(MANDOCS))
%: %.md
$(RONN) --roff $^
+%: %.adoc
+ a2x --doctype manpage --format manpage $^
+
%.html: %.md
$(RONN) --html $^
diff --git a/doc/catlfish-log.cfg.in.5.adoc b/doc/catlfish-log.cfg.in.5.adoc
new file mode 100644
index 0000000..1cc912f
--- /dev/null
+++ b/doc/catlfish-log.cfg.in.5.adoc
@@ -0,0 +1,95 @@
+:man source: Catlfish
+:man manual: Catlfish Manual
+CATLFISH-LOG.CFG.IN(5)
+======================
+
+NAME
+----
+catlfish-log.cfg.in - catlfish log configuration
+
+OPTIONS
+-------
+ **apikeys**: (list of items)::
+// write description here
+
+ **nodename**: __nodename__:::
+// write description here
+
+ **publickey**: __key__:::
+ BASE64-encoded key
+
+ **backup-quorum-size**: __number-of-nodes__::
+ number of secondary merge nodes that need to have an entry before the entry is considered committed
+
+ **baseurl**: __url__::
+// write description here
+
+ **cafingerprint**: __fingerprint__::
+// write description here
+
+ **frontendnodes**: (list of items)::
+// write description here
+
+ **address**: __ip-address__:::
+// write description here
+
+ **name**: __nodename__:::
+// write description here
+
+ **publicaddress**: __ip-address__:::
+// write description here
+
+ **logpublickey**: __key__::
+// write description here
+
+ **mergenodes**: (list of items)::
+// write description here
+
+ **address**: __ip-address__:::
+// write description here
+
+ **name**: __nodename__:::
+// write description here
+
+ **mmd**: __seconds__::
+// write description here
+
+ **primarymergenode**: __nodename__::
+// write description here
+
+ **signingnodes**: (list of items)::
+// write description here
+
+ **address**: __ip-address__:::
+// write description here
+
+ **name**: __nodename__:::
+// write description here
+
+ **statusservers**: (list of items)::
+// write description here
+
+ **address**: __ip-address__:::
+// write description here
+
+ **name**: __nodename__:::
+// write description here
+
+ **publicaddress**: __ip-address__:::
+// write description here
+
+ **storage-quorum-size**: __number-of-nodes__::
+// write description here
+
+ **storagenodes**: (list of items)::
+// write description here
+
+ **address**: __ip-address__:::
+// write description here
+
+ **name**: __nodename__:::
+// write description here
+
+ **version**: __version__::
+// write description here
+
diff --git a/doc/catlfish-node.cfg.5.adoc b/doc/catlfish-node.cfg.5.adoc
new file mode 100644
index 0000000..fabef29
--- /dev/null
+++ b/doc/catlfish-node.cfg.5.adoc
@@ -0,0 +1,113 @@
+:man source: Catlfish
+:man manual: Catlfish Manual
+CATLFISH-NODE.CFG(5)
+====================
+
+NAME
+----
+catlfish-node.cfg - catlfish node configuration
+
+OPTIONS
+-------
+ **configurl**: __url__::
+// write description here
+
+ **ctapiaddress**: __ip-address__::
+// write description here
+
+ **dbbackend**: **permdb**|**fsdb**::
+// write description here
+
+ **frontendaddress**: __ip-address__::
+// write description here
+
+ **logadminkey**: __key__::
+// write description here
+
+ **merge**: ::
+// write description here
+
+ **backup-sendentries-chunksize**: __number-of-entries__:::
+// write description here
+
+ **backup-sendlog-chunksize**: __number-of-entries__:::
+// write description here
+
+ **backup-window-size**: __number-of-entries__:::
+// write description here
+
+ **dist-sendentries-chunksize**: __number-of-entries__:::
+// write description here
+
+ **dist-sendlog-chunksize**: __number-of-entries__:::
+// write description here
+
+ **dist-window-size**: __number-of-entries__:::
+// write description here
+
+ **min-delay**: __seconds__:::
+// write description here
+
+ **mergeaddress**: __ip-address__::
+// write description here
+
+ **nodename**: __nodename__::
+// write description here
+
+ **paths**: ::
+// write description here
+
+ **configdir**: __path__:::
+// write description here
+
+ **db**: __path__:::
+// write description here
+
+ **https_cacertfile**: __path__:::
+// write description here
+
+ **https_certfile**: __path__:::
+// write description here
+
+ **https_keyfile**: __path__:::
+// write description here
+
+ **knownroots**: __path__:::
+// write description here
+
+ **logprivatekey**: __path__:::
+// write description here
+
+ **logpublickey**: __path__:::
+// write description here
+
+ **mergedb**: __path__:::
+// write description here
+
+ **privatekeys**: __path__:::
+// write description here
+
+ **public_cacertfile**: __path__:::
+// write description here
+
+ **publickeys**: __path__:::
+// write description here
+
+ **verifycert_bin**: __path__:::
+// write description here
+
+ **publichttpaddress**: __ip-address__::
+// write description here
+
+ **ratelimits**: ::
+// write description here
+
+ **add_chain**: __rate__:::
+// write description here
+
+ **signingaddress**: __ip-address__::
+// write description here
+
+ **storageaddress**: __ip-address__::
+// write description here
+