summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/misc/weechat.xml
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/misc/weechat.xml')
-rw-r--r--nixos/modules/services/misc/weechat.xml97
1 files changed, 47 insertions, 50 deletions
diff --git a/nixos/modules/services/misc/weechat.xml b/nixos/modules/services/misc/weechat.xml
index 7255edfb9da3..83ae171217d2 100644
--- a/nixos/modules/services/misc/weechat.xml
+++ b/nixos/modules/services/misc/weechat.xml
@@ -1,66 +1,63 @@
-<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">
- <title>WeeChat</title>
- <para>
- <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and
- extensible IRC client.
- </para>
- <section xml:id="module-services-weechat-basic-usage">
- <title>Basic Usage</title>
-
+<!-- Do not edit this file directly, edit its companion .md instead
+ and regenerate this file using nixos/doc/manual/md-to-db.sh -->
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-weechat">
+ <title>WeeChat</title>
<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.
+ <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and
+ extensible IRC client.
</para>
-
- <para>
- This can be done by enabling the <literal>weechat</literal> service:
-<programlisting>
+ <section xml:id="module-services-weechat-basic-usage">
+ <title>Basic Usage</title>
+ <para>
+ By default, the module creates a
+ <link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/"><literal>systemd</literal></link>
+ unit which runs the chat client in a detached
+ <link xlink:href="https://www.gnu.org/software/screen/"><literal>screen</literal></link>
+ session.
+ </para>
+ <para>
+ This can be done by enabling the <literal>weechat</literal>
+ service:
+ </para>
+ <programlisting>
{ ... }:
{
- <link linkend="opt-services.weechat.enable">services.weechat.enable</link> = true;
+ services.weechat.enable = true;
}
</programlisting>
- </para>
-
- <para>
- The service is managed by a dedicated user named <literal>weechat</literal>
- in the state directory <literal>/var/lib/weechat</literal>.
- </para>
- </section>
- <section xml:id="module-services-weechat-reattach">
- <title>Re-attaching to WeeChat</title>
-
- <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>
+ <para>
+ The service is managed by a dedicated user named
+ <literal>weechat</literal> in the state directory
+ <literal>/var/lib/weechat</literal>.
+ </para>
+ </section>
+ <section xml:id="module-services-weechat-reattach">
+ <title>Re-attaching to WeeChat</title>
+ <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:
+ </para>
+ <programlisting>
{
- <link linkend="opt-programs.screen.screenrc">programs.screen.screenrc</link> = ''
+ programs.screen.screenrc = ''
multiuser on
acladd normal_user
'';
}
</programlisting>
- Now, the session can be re-attached like this:
-<programlisting>
+ <para>
+ Now, the session can be re-attached like this:
+ </para>
+ <programlisting>
screen -x weechat/weechat-screen
</programlisting>
- </para>
-
- <para>
- <emphasis>The session name can be changed using
- <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
- </para>
- </section>
+ <para>
+ <emphasis>The session name can be changed using
+ <link xlink:href="options.html#opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>
+ </para>
+ </section>
</chapter>