summaryrefslogtreecommitdiff
path: root/doc/de/user/plugin_logger.de.xml
blob: c5c8774e9798ab15d14825e6cb1b0688a36697ef (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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?xml version="1.0" encoding="UTF-8"?>

<!--

WeeChat documentation (german version)

Copyright (c) 2003-2009 by FlashCode <flashcode@flashtux.org>

This manual is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

-->

<section id="secPluginLogger">
  <title>Logger plugin</title>
  
  <para>
    The Logger plugin lets you save content of buffers to files, with options
    about what and how it is saved.
  </para>
  
  <section id="secLoggerOptions">
    <title>Options (file logger.conf)</title>
    
    <para>
      &logger_options.xml;
    </para>
    
  </section>
  
  <section id="secLoggerCommands">
    <title>Commands</title>
    
    <para>
      &logger_commands.xml;
    </para>
    
  </section>
  
  <section id="secLoggerLevels">
    <title>Levels</title>
    
    <para>
      Logging is made with a level for each buffer. Default level is 9 (log
      all messages displayed on buffer).
      You can change level for one buffer, or a group of buffers.
    </para>
    
    <para>
      Possible levels are 0 to 9. Zero means "<literal>do not log
      anything</literal>" and 9 means "<literal>log all messages</literal>".
    </para>
    
    <para>
      Plugins are using different levels for messages displayed.
      IRC plugin uses following levels:
      <itemizedlist>
        <listitem>
          <para>
            Level 1: message from user (on channel or private)
          </para>
        </listitem>
        <listitem>
          <para>
            Level 2: nick change (you or someone else)
          </para>
        </listitem>
        <listitem>
          <para>
            Level 3: any server message (except join/part/quit)
          </para>
        </listitem>
        <listitem>
          <para>
            Level 4: server message join/part/quit
          </para>
        </listitem>
      </itemizedlist>
      So if you set level 3 for an IRC channel, WeeChat will log all messages,
      but not join/part/quit.
    </para>
    
    <para>
      Some examples:
      <itemizedlist>
        <listitem>
          <para>
            set level 3 for IRC channel #weechat:
            <screen>/set logger.level.irc.freenode.#weechat 3</screen>
          </para>
        </listitem>
        <listitem>
          <para>
            set level 3 for freenode server buffer:
            <screen>/set logger.level.irc.server.freenode 3</screen>
          </para>
        </listitem>
        <listitem>
          <para>
            set level 3 for all channels on server freenode:
            <screen>/set logger.level.irc.freenode 3</screen>
          </para>
        </listitem>
        <listitem>
          <para>
            set level 2 for all IRC buffers:
            <screen>/set logger.level.irc 2</screen>
          </para>
        </listitem>
      </itemizedlist>
    </para>
    
  </section>
  
  <section id="secLoggerMasks">
    <title>Filename masks</title>
    
    <para>
      It is possible to define a filename mask for each buffer, and use local
      buffer variables to build filename (to see local variables for current
      buffer: <command>/buffer localvar</command>).
    </para>
    
    <para>
      For example if you want one directory by IRC server and one file by
      channel inside:
      <screen>/set logger.mask.irc "irc/$server/$channel.weechatlog"</screen>
      You'll have following files:
<screen>
~/.weechat/
    |--- logs/
        |--- irc/
            |--- freenode/
            |       freenode.weechatlog
            |       #weechat.weechatlog
            |       #mychan.weechatlog
            |--- oftc/
            |       oftc.weechatlog
            |       #chan1.weechatlog
            |       #chan2.weechatlog
</screen>
    </para>
    
  </section>
  
</section>