nixpkgs/nixos/modules/services/misc/weechat.xml

67 lines
2.0 KiB
XML
Raw Normal View History

<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="module-services-weechat">
2018-09-30 00:51:11 +00:00
<title>WeeChat</title>
<para>
<link xlink:href="https://weechat.org/">WeeChat</link> is a fast and
extensible IRC client.
2018-09-30 00:51:11 +00:00
</para>
2019-02-07 03:35:58 +00:00
<section xml:id="module-services-weechat-basic-usage">
2018-09-30 00:51:11 +00:00
<title>Basic Usage</title>
2018-09-30 00:51:11 +00:00
<para>
By default, the module creates a
<literal><link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/">systemd</link></literal>
unit which runs the chat client in a detached
<literal><link xlink:href="https://www.gnu.org/software/screen/">screen</link></literal>
session.
2018-09-30 00:51:11 +00:00
</para>
2018-09-30 00:51:11 +00:00
<para>
This can be done by enabling the <literal>weechat</literal> service:
<programlisting>
{ ... }:
{
<link linkend="opt-services.weechat.enable">services.weechat.enable</link> = true;
}
</programlisting>
2018-09-30 00:51:11 +00:00
</para>
<para>
The service is managed by a dedicated user named <literal>weechat</literal>
in the state directory <literal>/var/lib/weechat</literal>.
2018-09-30 00:51:11 +00:00
</para>
</section>
2019-02-07 03:35:58 +00:00
<section xml:id="module-services-weechat-reattach">
2018-09-30 00:51:11 +00:00
<title>Re-attaching to WeeChat</title>
2018-09-30 00:51:11 +00:00
<para>
WeeChat runs in a screen session owned by a dedicated user. To explicitly
allow your another user to attach to this session, the
<literal>screenrc</literal> needs to be tweaked by adding
<link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link>
support:
<programlisting>
{
<link linkend="opt-programs.screen.screenrc">programs.screen.screenrc</link> = ''
multiuser on
acladd normal_user
'';
}
</programlisting>
2018-09-30 00:51:11 +00:00
Now, the session can be re-attached like this:
<programlisting>
screen -x weechat/weechat-screen
</programlisting>
2018-09-30 00:51:11 +00:00
</para>
<para>
<emphasis>The session name can be changed using
<link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
2018-09-30 00:51:11 +00:00
</para>
</section>
</chapter>