aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2020-12-25 22:04:18 +0100
committerGitHub <noreply@github.com>2020-12-25 22:04:18 +0100
commit3ae0eff0093ce76a45613ef6feecc8c7e0ac25de (patch)
tree6c8502db1523fa7237a1c97864c70d331226d165 /README.org
parent4db4520ce2da54f0974e758bf3e001f1605154ed (diff)
parent9e79d7d5733dc83e40a2f2e037c6cecce1ff02a7 (diff)
downloadmum-3ae0eff0093ce76a45613ef6feecc8c7e0ac25de.tar.gz
Merge pull request #34 from sornas/man
Add man pages
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
index 12b8049..5620e7b 100644
--- a/README.org
+++ b/README.org
@@ -55,6 +55,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 mumctl --help or documentation/*.txt for more information.