summaryrefslogtreecommitdiff
path: root/xS/xS.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2023-07-03 08:53:20 +0200
committerPřemysl Eric Janouch <p@janouch.name>2023-07-04 23:26:05 +0200
commit6f596f1dcbee812dd7feff1bc6664cdc7944f2a3 (patch)
tree75b4ed0437387bcab49d39aba0aa53de38aa25f1 /xS/xS.adoc
parentabcff46dc49168125b51a63d10db3eb284d9bcc0 (diff)
downloadxK-6f596f1dcbee812dd7feff1bc6664cdc7944f2a3.tar.gz
xK-6f596f1dcbee812dd7feff1bc6664cdc7944f2a3.tar.xz
xK-6f596f1dcbee812dd7feff1bc6664cdc7944f2a3.zip
Move project version to file, add xS manual page
So far Go applications remain independent to handle Nix's inability to easily combine them with the CMake part. There is also no "install" target, because any packagers will want to adjust installation paths manually, and there is no configure step.
Diffstat (limited to 'xS/xS.adoc')
-rw-r--r--xS/xS.adoc57
1 files changed, 57 insertions, 0 deletions
diff --git a/xS/xS.adoc b/xS/xS.adoc
new file mode 100644
index 0000000..c2154f4
--- /dev/null
+++ b/xS/xS.adoc
@@ -0,0 +1,57 @@
+xS(1)
+=====
+:doctype: manpage
+:manmanual: xK Manual
+:mansource: xK {release-version}
+
+Name
+----
+xS - IRC daemon
+
+Synopsis
+--------
+*xS* [_OPTION_]...
+
+Description
+-----------
+*xS* 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
+-------
+*-debug*::
+ Do not daemonize, print more information on the standard error stream
+ to help debug various issues.
+
+*-systemd*::
+ Log using the format specified in *sd-daemon*(3).
+
+*-h*, *-help*::
+ Display a help message and exit.
+
+*-version*::
+ Output version information and exit.
+
+*-writedefaultcfg*::
+ Write a configuration file with defaults, show its path and exit.
++
+The file will be appropriately commented.
+
+Files
+-----
+*xS* follows the XDG Base Directory Specification.
+
+_~/.config/xS/xS.conf_::
+_/etc/xdg/xS/xS.conf_::
+ The daemon's configuration file. Use the *-writedefaultcfg* option
+ to create a new one for editing.
+
+Reporting bugs
+--------------
+Use https://git.janouch.name/p/xK to report bugs, request features,
+or submit pull requests.
+
+See also
+--------
+*sd-daemon*(3)