summaryrefslogtreecommitdiff
path: root/xS/xS.adoc
blob: c2154f4316e3e94d43b8eeb42cb82a0e10835f97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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)