pyrox.dev
1<chapter xmlns="http://docbook.org/ns/docbook"
2 xmlns:xlink="http://www.w3.org/1999/xlink"
3 xmlns:xi="http://www.w3.org/2001/XInclude"
4 version="5.0"
5 xml:id="module-services-weechat">
6 <title>WeeChat</title>
7 <para>
8 <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and
9 extensible IRC client.
10 </para>
11 <section xml:id="module-services-weechat-basic-usage">
12 <title>Basic Usage</title>
13
14 <para>
15 By default, the module creates a
16 <literal><link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/">systemd</link></literal>
17 unit which runs the chat client in a detached
18 <literal><link xlink:href="https://www.gnu.org/software/screen/">screen</link></literal>
19 session.
20 </para>
21
22 <para>
23 This can be done by enabling the <literal>weechat</literal> service:
24<programlisting>
25{ ... }:
26
27{
28 <link linkend="opt-services.weechat.enable">services.weechat.enable</link> = true;
29}
30</programlisting>
31 </para>
32
33 <para>
34 The service is managed by a dedicated user named <literal>weechat</literal>
35 in the state directory <literal>/var/lib/weechat</literal>.
36 </para>
37 </section>
38 <section xml:id="module-services-weechat-reattach">
39 <title>Re-attaching to WeeChat</title>
40
41 <para>
42 WeeChat runs in a screen session owned by a dedicated user. To explicitly
43 allow your another user to attach to this session, the
44 <literal>screenrc</literal> needs to be tweaked by adding
45 <link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link>
46 support:
47<programlisting>
48{
49 <link linkend="opt-programs.screen.screenrc">programs.screen.screenrc</link> = ''
50 multiuser on
51 acladd normal_user
52 '';
53}
54</programlisting>
55 Now, the session can be re-attached like this:
56<programlisting>
57screen -x weechat/weechat-screen
58</programlisting>
59 </para>
60
61 <para>
62 <emphasis>The session name can be changed using
63 <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
64 </para>
65 </section>
66</chapter>