commit 8c17c417a1687df44fa9a672e47fc43ef627db59 · pyrox.dev/nixpkgs

+46

nixos/modules/services/misc/weechat.md

···

       1
       1
       +
       # WeeChat {#module-services-weechat}

     

       2
       2
       +
       

     

       3
       3
       +
       [WeeChat](https://weechat.org/) is a fast and

     

       4
       4
       +
       extensible IRC client.

     

       5
       5
       +
       

     

       6
       6
       +
       ## Basic Usage {#module-services-weechat-basic-usage}

     

       7
       7
       +
       

     

       8
       8
       +
       By default, the module creates a

     

       9
       9
       +
       [`systemd`](https://www.freedesktop.org/wiki/Software/systemd/)

     

       10
       10
       +
       unit which runs the chat client in a detached

     

       11
       11
       +
       [`screen`](https://www.gnu.org/software/screen/)

     

       12
       12
       +
       session.

     

       13
       13
       +
       

     

       14
       14
       +
       This can be done by enabling the `weechat` service:

     

       15
       15
       +
       ```

     

       16
       16
       +
       { ... }:

     

       17
       17
       +
       

     

       18
       18
       +
       {

     

       19
       19
       +
         services.weechat.enable = true;

     

       20
       20
       +
       }

     

       21
       21
       +
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       The service is managed by a dedicated user named `weechat`

     

       24
       24
       +
       in the state directory `/var/lib/weechat`.

     

       25
       25
       +
       

     

       26
       26
       +
       ## Re-attaching to WeeChat {#module-services-weechat-reattach}

     

       27
       27
       +
       

     

       28
       28
       +
       WeeChat runs in a screen session owned by a dedicated user. To explicitly

     

       29
       29
       +
       allow your another user to attach to this session, the

     

       30
       30
       +
       `screenrc` needs to be tweaked by adding

     

       31
       31
       +
       [multiuser](https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser)

     

       32
       32
       +
       support:

     

       33
       33
       +
       ```

     

       34
       34
       +
       {

     

       35
       35
       +
         programs.screen.screenrc = ''

     

       36
       36
       +
           multiuser on

     

       37
       37
       +
           acladd normal_user

     

       38
       38
       +
         '';

     

       39
       39
       +
       }

     

       40
       40
       +
       ```

     

       41
       41
       +
       Now, the session can be re-attached like this:

     

       42
       42
       +
       ```

     

       43
       43
       +
       screen -x weechat/weechat-screen

     

       44
       44
       +
       ```

     

       45
       45
       +
       

     

       46
       46
       +
       *The session name can be changed using [services.weechat.sessionName.](options.html#opt-services.weechat.sessionName)*

nixos/modules/services/misc/weechat.nix

···

       59
       59
        
             };

     

       60
       60
        
         };

     

       61
       61
        
       

     

       62
       62
       +
         # Don't edit the docbook xml directly, edit the md and generate it:

     

       63
       63
       +
         # `pandoc weechat.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > weechat.xml`

     

       62
       64
        
         meta.doc = ./weechat.xml;

     

       63
       65
        
       }

+43 -48

nixos/modules/services/misc/weechat.xml

···

       1
       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
                version="5.0"

     

       5
       5
       -
                xml:id="module-services-weechat">

     

       6
       6
       -
        <title>WeeChat</title>

     

       7
       7
       -
        <para>

     

       8
       8
       -
         <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and

     

       9
       9
       -
         extensible IRC client.

     

       10
       10
       -
        </para>

     

       11
       11
       -
        <section xml:id="module-services-weechat-basic-usage">

     

       12
       12
       -
         <title>Basic Usage</title>

     

       13
       13
       -
       

     

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-weechat">

     

       2
       2
       +
         <title>WeeChat</title>

     

       14
       3
        
         <para>

     

       15
       15
       -
          By default, the module creates a

     

       16
       16
       -
          <link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/"><literal>systemd</literal></link>

     

       17
       17
       -
          unit which runs the chat client in a detached

     

       18
       18
       -
          <link xlink:href="https://www.gnu.org/software/screen/"><literal>screen</literal></link>

     

       19
       19
       -
          session.

     

       4
       4
       +
           <link xlink:href="https://weechat.org/">WeeChat</link> is a fast and

     

       5
       5
       +
           extensible IRC client.

     

       20
       6
        
         </para>

     

       21
       21
       -
       

     

       22
       22
       -
         <para>

     

       23
       23
       -
          This can be done by enabling the <literal>weechat</literal> service:

     

       24
       24
       -
       <programlisting>

     

       7
       7
       +
         <section xml:id="module-services-weechat-basic-usage">

     

       8
       8
       +
           <title>Basic Usage</title>

     

       9
       9
       +
           <para>

     

       10
       10
       +
             By default, the module creates a

     

       11
       11
       +
             <link xlink:href="https://www.freedesktop.org/wiki/Software/systemd/"><literal>systemd</literal></link>

     

       12
       12
       +
             unit which runs the chat client in a detached

     

       13
       13
       +
             <link xlink:href="https://www.gnu.org/software/screen/"><literal>screen</literal></link>

     

       14
       14
       +
             session.

     

       15
       15
       +
           </para>

     

       16
       16
       +
           <para>

     

       17
       17
       +
             This can be done by enabling the <literal>weechat</literal>

     

       18
       18
       +
             service:

     

       19
       19
       +
           </para>

     

       20
       20
       +
           <programlisting>

     

       25
       21
        
       { ... }:

     

       26
       22
        
       

     

       27
       23
        
       {

     

       28
       24
        
         services.weechat.enable = true;

     

       29
       25
        
       }

     

       30
       26
        
       </programlisting>

     

       31
       31
       -
         </para>

     

       32
       32
       -
       

     

       33
       33
       -
         <para>

     

       34
       34
       -
          The service is managed by a dedicated user named <literal>weechat</literal>

     

       35
       35
       -
          in the state directory <literal>/var/lib/weechat</literal>.

     

       36
       36
       -
         </para>

     

       37
       37
       -
        </section>

     

       38
       38
       -
        <section xml:id="module-services-weechat-reattach">

     

       39
       39
       -
         <title>Re-attaching to WeeChat</title>

     

       40
       40
       -
       

     

       41
       41
       -
         <para>

     

       42
       42
       -
          WeeChat runs in a screen session owned by a dedicated user. To explicitly

     

       43
       43
       -
          allow your another user to attach to this session, the

     

       44
       44
       -
          <literal>screenrc</literal> needs to be tweaked by adding

     

       45
       45
       -
          <link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link>

     

       46
       46
       -
          support:

     

       47
       47
       -
       <programlisting>

     

       27
       27
       +
           <para>

     

       28
       28
       +
             The service is managed by a dedicated user named

     

       29
       29
       +
             <literal>weechat</literal> in the state directory

     

       30
       30
       +
             <literal>/var/lib/weechat</literal>.

     

       31
       31
       +
           </para>

     

       32
       32
       +
         </section>

     

       33
       33
       +
         <section xml:id="module-services-weechat-reattach">

     

       34
       34
       +
           <title>Re-attaching to WeeChat</title>

     

       35
       35
       +
           <para>

     

       36
       36
       +
             WeeChat runs in a screen session owned by a dedicated user. To

     

       37
       37
       +
             explicitly allow your another user to attach to this session, the

     

       38
       38
       +
             <literal>screenrc</literal> needs to be tweaked by adding

     

       39
       39
       +
             <link xlink:href="https://www.gnu.org/software/screen/manual/html_node/Multiuser.html#Multiuser">multiuser</link>

     

       40
       40
       +
             support:

     

       41
       41
       +
           </para>

     

       42
       42
       +
           <programlisting>

     

       48
       43
        
       {

     

       49
       44
        
         programs.screen.screenrc = ''

     

       50
       45
        
           multiuser on

     
···

       52
       47
        
         '';

     

       53
       48
        
       }

     

       54
       49
        
       </programlisting>

     

       55
       55
       -
          Now, the session can be re-attached like this:

     

       56
       56
       -
       <programlisting>

     

       50
       50
       +
           <para>

     

       51
       51
       +
             Now, the session can be re-attached like this:

     

       52
       52
       +
           </para>

     

       53
       53
       +
           <programlisting>

     

       57
       54
        
       screen -x weechat/weechat-screen

     

       58
       55
        
       </programlisting>

     

       59
       59
       -
         </para>

     

       60
       60
       -
       

     

       61
       61
       -
         <para>

     

       62
       62
       -
          <emphasis>The session name can be changed using

     

       63
       63
       -
          <link linkend="opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>

     

       64
       64
       -
         </para>

     

       65
       65
       -
        </section>

     

       56
       56
       +
           <para>

     

       57
       57
       +
             <emphasis>The session name can be changed using

     

       58
       58
       +
             <link xlink:href="options.html#opt-services.weechat.sessionName">services.weechat.sessionName.</link></emphasis>

     

       59
       59
       +
           </para>

     

       60
       60
       +
         </section>

     

       66
       61
        
       </chapter>