aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2020-12-25 13:16:52 +0100
committerGustav Sörnäs <gustav@sornas.net>2020-12-25 13:16:52 +0100
commit9e79d7d5733dc83e40a2f2e037c6cecce1ff02a7 (patch)
treed2ed20daae43152d4507789e3927512e9d1598ad
parent571918426693331f4cf95a6a1e8590825662be91 (diff)
downloadmum-9e79d7d5733dc83e40a2f2e037c6cecce1ff02a7.tar.gz
add note about manpages to readme
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
index 11d1108..9496362 100644
--- a/README.org
+++ b/README.org
@@ -58,6 +58,16 @@ $ cd ../mumctl
$ cargo build --release
#+END_SRC
+*** man-pages
+
+Man-pages for mumd, mumctl and mumdrc (the configuration file) are included as
+both asciidoc txt-files and already formatted groff-files. They are generated
+with
+
+#+BEGIN_SRC
+$ asciidoctor -b manpage *.txt
+#+END_SRC
+
** Usage
This describes how to connect to a server and join different channels.
See usage.org or `$ mumctl --help` for more information.