summaryrefslogtreecommitdiff
path: root/kike.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2020-10-25 15:30:06 +0100
committerPřemysl Eric Janouch <p@janouch.name>2020-10-29 02:46:40 +0100
commit53cc52e320da15262179e224d99db8571c85b904 (patch)
tree703d45af9ac7f6ca0c16ead1bd699f34140913c9 /kike.adoc
parentcbe40093089ebf073b81a46ac30dffba7984b787 (diff)
downloadxK-53cc52e320da15262179e224d99db8571c85b904.tar.gz
xK-53cc52e320da15262179e224d99db8571c85b904.tar.xz
xK-53cc52e320da15262179e224d99db8571c85b904.zip
Add real manual pages
To some extent they duplicate the README but from a different angle.
Diffstat (limited to 'kike.adoc')
-rw-r--r--kike.adoc53
1 files changed, 53 insertions, 0 deletions
diff --git a/kike.adoc b/kike.adoc
new file mode 100644
index 0000000..e97cba2
--- /dev/null
+++ b/kike.adoc
@@ -0,0 +1,53 @@
+kike(1)
+=======
+:doctype: manpage
+:manmanual: uirc3 Manual
+:mansource: uirc3 {release-version}
+
+Name
+----
+kike - an experimental IRC daemon
+
+Synopsis
+--------
+*kike* [_OPTION_]...
+
+Description
+-----------
+*kike* is a basic IRC daemon for single-server networks, suitable for testing
+and private use. When run without a configuration file, it will start listening
+on the standard port 6667 and the "any" address.
+
+Options
+-------
+*-d*, *--debug*::
+ Do not daemonize, print more information on the standard error stream
+ to help debug various issues.
+
+*-h*, *--help*::
+ Display a help message and exit.
+
+*-V*, *--version*::
+ Output version information and exit.
+
+*--write-default-cfg*[**=**__PATH__]::
+ Write a configuration file with defaults, show its path and exit.
++
+The file will be appropriately commented.
++
+When no _PATH_ is specified, it will be created in the user's home directory,
+contrary to what you might expect from a server.
+
+Files
+-----
+*kike* follows the XDG Base Directory Specification.
+
+_~/.config/kike/kike.conf_::
+_/etc/xdg/kike/kike.conf_::
+ The daemon's configuration file. Use the *--write-default-cfg* option
+ to create a new one for editing.
+
+Reporting bugs
+--------------
+Use https://git.janouch.name/p/uirc3 to report bugs, request features,
+or submit pull requests.