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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<!-- $Id: contents.html 11393 2008-05-11 06:56:12Z topia $ -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Log 関係のモジュール - Tiarra Documentation</title>
<link rel="stylesheet" type="text/css" href="../default.css" />
</head>
<body>
<div class="header">
<h1>Log 関係のモジュール</h1>
</div>
<hr class="sep" />
<div class="pane-main">
<div id="module-Log::Channel" class="module">
<div class="module-header"><h2 title="チャンネルやprivのログを取るモジュール。">Log::Channel</h2>
<span class="description">チャンネルやprivのログを取るモジュール。</span></div>
<div class="content">
<p class="comment">
Log系のモジュールでは、以下のように日付や時刻の置換が行なわれる。<br />
%% : %<br />
%Y : 年(4桁)<br />
%m : 月(2桁)<br />
%d : 日(2桁)<br />
%H : 時間(2桁)<br />
%M : 分(2桁)<br />
%S : 秒(2桁)<br />
</p>
<p class="comment">
ログを保存するディレクトリ。Tiarraが起動した位置からの相対パス。~指定は使えない。<br />
</p>
<div class="element"><span class="key">directory</span>:<span class="value">log</span></div>
<p class="comment">
ログファイルの文字コード。省略されたらjis。<br />
</p>
<div class="element"><span class="key">charset</span>:<span class="value">utf8</span></div>
<p class="comment">
各行のヘッダのフォーマット。省略されたら'%H:%M'。<br />
</p>
<div class="element"><span class="key">header</span>:<span class="value">%H:%M:%S</span></div>
<p class="comment">
ファイル名のフォーマット。省略されたら'%Y.%m.%d.txt'<br />
</p>
<div class="element"><span class="key">filename</span>:<span class="value">%Y.%m.%d.txt</span></div>
<p class="comment">
ログファイルのモード(8進数)。省略されたら600<br />
</p>
<div class="element"><span class="key">mode</span>:<span class="value">600</span></div>
<p class="comment">
ログディレクトリのモード(8進数)。省略されたら700<br />
</p>
<div class="element"><span class="key">dir-mode</span>:<span class="value">700</span></div>
<p class="comment">
ログを取るコマンドを表すマスク。省略されたら記録出来るだけのコマンドを記録する。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">privmsg,join,part,kick,invite,mode,nick,quit,kill,topic,notice</span></div>
<p class="comment">
PRIVMSGとNOTICEを記録する際に、自分の発言と他人の発言でフォーマットを変えるかどうか。1/0。デフォルトで1。<br />
</p>
<div class="element"><span class="key">distinguish-myself</span>:<span class="value">1</span></div>
<p class="comment">
各ログファイルを開きっぱなしにするかどうか。<br />
このオプションは多くの場合、ディスクアクセスを抑えて効率良くログを保存しますが<br />
ログを記録すべき全てのファイルを開いたままにするので、50や100のチャンネルを<br />
別々のファイルにログを取るような場合には使うべきではありません。<br />
万一 fd があふれた場合、クライアントから(またはサーバへ)接続できない・<br />
新たなモジュールをロードできない・ログが全然できないなどの症状が起こる可能性が<br />
あります。limit の詳細については OS 等のドキュメントを参照してください。<br />
</p>
<div class="element"><span class="key">keep-file-open</span>:<span class="value">1</span></div>
<p class="comment">
keep-file-open 時に各行ごとに flush するかどうか。<br />
open/close の負荷は気になるが、ログは失いたくない人向け。<br />
keep-file-open が有効でないなら無視され(1になり)ます。<br />
</p>
<div class="element"><span class="key">always-flush</span>:<span class="value">0</span></div>
<p class="comment">
keep-file-openを有効にした場合、発言の度にログファイルに追記するのではなく<br />
一定の分量が溜まってから書き込まれる。そのため、ファイルを開いても<br />
最近の発言はまだ書き込まれていない可能性がある。<br />
syncを設定すると、即座にログをディスクに書き込むためのコマンドが追加される。<br />
省略された場合はコマンドを追加しない。<br />
</p>
<div class="element"><span class="key">sync</span>:<span class="value">sync</span></div>
<p class="comment">
各チャンネルの設定。チャンネル名の部分はマスクである。<br />
個人宛てに送られたPRIVMSGやNOTICEはチャンネル名"priv"として検索される。<br />
記述された順序で検索されるので、全てのチャンネルにマッチする"*"などは最後に書かなければならない。<br />
指定されたディレクトリが存在しなかったら、Log::Channelはそれを勝手に作る。<br />
フォーマットは次の通り。<br />
channel: <ディレクトリ名> (<チャンネル名> / 'priv')<br />
例:<br />
filename: %Y.%m.%d.txt<br />
channel: IRCDanwasitu #IRC談話室@ircnet<br />
channel: others *<br />
この例では、#IRC談話室@ircnetのログはIRCDanwasitu/%Y.%m.%d.txtに、<br />
それ以外(privも含む)のログはothers/%Y.%m.%d.txtに保存される。<br />
#(channel) はチャンネル名に展開される。<br />
(古いバージョンだと展開されずにそのままディレクトリ名になってしまいます。)<br />
IRCのチャンネル名は大文字小文字が区別されず、サーバからは各送信者が指定した通りの<br />
チャンネル名が送られてきます。そのため、大文字小文字が区別されるファイルシステムでは<br />
同じチャンネルが別々のディレクトリに作られることになります。<br />
この問題を回避するため、チャンネル名を小文字に統一した #(lc_channel) が利用できます。<br />
</p>
<div class="element"><span class="key">channel</span>:<span class="value">priv priv</span></div>
<div class="element"><span class="key">channel</span>:<span class="value">#(lc_channel) *</span></div>
<div class="element"><span class="key">channel</span>:<span class="value">others *</span></div>
<p class="comment">
ファイル名のエンコーディング.<br />
指定可能な値は, utf8, sjis, euc, jis, ascii.<br />
ascii は実際には utf8 と同等で8bit部分が全てquoted-printableされる.<br />
デフォルトはWindowsではsjis, それ以外では utf8.<br />
</p>
<div class="element"><span class="key">filename-encoding</span>:<span class="value">utf8</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-Log::ChannelList" class="module">
<div class="module-header"><h2 title="チャンネルリストをテンプレートに沿って HTML 化します。">Log::ChannelList</h2>
<span class="description">チャンネルリストをテンプレートに沿って HTML 化します。</span></div>
<div class="content">
<p class="comment">
list コマンドが実行された際に動作します。<br />
</p>
<p class="comment">
出力したいファイル名、ネットワーク名、使う設定のブロックを指定します。。<br />
</p>
<div class="element"><span class="key">networks</span>:<span class="value">ircnet.html ircnet ircnet</span></div>
<div class="block element"><span class="block key">ircnet</span>
<div class="block content">
<p class="comment">
テンプレートファイルを指定します。<br />
</p>
<div class="element"><span class="key">template</span>:<span class="value">channellist.html.tmpl</span></div>
<p class="comment">
出力とテンプレートファイルの文字コードを指定します。<br />
</p>
<div class="element"><span class="key">charset</span>:<span class="value">euc</span></div>
<p class="comment">
取得を開始/終了した時刻のフォーマットを指定します。<br />
</p>
<div class="element"><span class="key">fetch-starttime</span>:<span class="value">%Y年%m月%d日 %H時%M分(日本時間)</span></div>
<div class="element"><span class="key">fetch-endtime</span>:<span class="value">%Y年%m月%d日 %H時%M分(日本時間)</span></div>
<p class="comment">
表示するチャンネルの mask を指定します。<br />
</p>
<div class="element"><span class="key">mask</span>:<span class="value">*</span></div>
<div class="element"><span class="key">mask</span>:<span class="value">-re:^\&(AUTH|SERVICES|LOCAL|HASH|SERVERS|NUMERICS|CHANNEL|KILLS|NOTICES|ERRORS)</span></div>
<p class="comment">
出力するファイルのモードを指定します。<br />
</p>
<div class="element"><span class="key">mode</span>:<span class="value">644</span></div>
</div></div>
</div>
</div>
<hr class="sep" />
<div id="module-Log::Raw" class="module">
<div class="module-header"><h2 title="サーバとの生の通信を保存する">Log::Raw</h2>
<span class="description">サーバとの生の通信を保存する</span></div>
<div class="content">
<p class="comment">
Log系のモジュールでは、以下のように日付や時刻の置換が行なわれる。<br />
%% : %<br />
%Y : 年(4桁)<br />
%m : 月(2桁)<br />
%d : 日(2桁)<br />
%H : 時間(2桁)<br />
%M : 分(2桁)<br />
%S : 秒(2桁)<br />
</p>
<p class="comment">
ログを保存するディレクトリ。Tiarraが起動した位置からの相対パス。~指定は使えない。<br />
</p>
<div class="element"><span class="key">directory</span>:<span class="value">rawlog</span></div>
<p class="comment">
各行のヘッダのフォーマット。省略されたら'%H:%M'。<br />
</p>
<div class="element"><span class="key">header</span>:<span class="value">%H:%M:%S</span></div>
<p class="comment">
ファイル名のフォーマット。省略されたら'%Y.%m.%d.txt'<br />
</p>
<div class="element"><span class="key">filename</span>:<span class="value">%Y-%m-%d.txt</span></div>
<p class="comment">
ログファイルのモード(8進数)。省略されたら600<br />
</p>
<div class="element"><span class="key">mode</span>:<span class="value">600</span></div>
<p class="comment">
ログディレクトリのモード(8進数)。省略されたら700<br />
</p>
<div class="element"><span class="key">dir-mode</span>:<span class="value">700</span></div>
<p class="comment">
使っている文字コードがよくわからなかったときの文字コード。省略されたらutf8。<br />
たぶんこの指定が生きることはないと思いますが……。<br />
</p>
<div class="element"><span class="key">charset</span>:<span class="value">jis</span></div>
<p class="comment">
NumericReply の名前を解決して表示する(ちゃんとした dump では無くなります)<br />
</p>
<div class="element"><span class="key">resolve-numeric</span>:<span class="value">1</span></div>
<p class="comment">
ログを取るコマンドを表すマスク。省略されたら記録出来るだけのコマンドを記録する。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">*,-ping,-pong</span></div>
<p class="comment">
各ログファイルを開きっぱなしにするかどうか。<br />
このオプションは多くの場合、ディスクアクセスを抑えて効率良くログを保存しますが<br />
ログを記録すべき全てのファイルを開いたままにするので、50や100のチャンネルを<br />
別々のファイルにログを取るような場合には使うべきではありません。<br />
万一 fd があふれた場合、クライアントから(またはサーバへ)接続できない・<br />
新たなモジュールをロードできない・ログが全然できないなどの症状が起こる可能性が<br />
あります。limit の詳細については OS 等のドキュメントを参照してください。<br />
</p>
<div class="element"><span class="key">keep-file-open</span>:<span class="value">1</span></div>
<p class="comment">
keep-file-open 時に各行ごとに flush するかどうか。<br />
open/close の負荷は気になるが、ログは失いたくない人向け。<br />
keep-file-open が有効でないなら無視され(1になり)ます。<br />
</p>
<div class="element"><span class="key">always-flush</span>:<span class="value">0</span></div>
<p class="comment">
keep-file-openを有効にした場合、発言の度にログファイルに追記するのではなく<br />
一定の分量が溜まってから書き込まれる。そのため、ファイルを開いても<br />
最近の発言はまだ書き込まれていない可能性がある。<br />
syncを設定すると、即座にログをディスクに書き込むためのコマンドが追加される。<br />
省略された場合はコマンドを追加しない。<br />
</p>
<div class="element"><span class="key">sync</span>:<span class="value">sync</span></div>
<p class="comment">
各サーバの設定。サーバ名の部分はマスクである。<br />
記述された順序で検索されるので、全てのサーバにマッチする"*"などは最後に書かなければならない。<br />
指定されたディレクトリが存在しなかったら、勝手に作られる。<br />
フォーマットは次の通り。<br />
channel: <ディレクトリ名> <サーバ名マスク><br />
例:<br />
filename: %Y-%m-%d.txt<br />
server: ircnet ircnet<br />
server: others *<br />
この例では、ircnetのログはircnet/%Y.%m.%d.txtに、<br />
それ以外のログはothers/%Y.%m.%d.txtに保存される。<br />
</p>
<div class="element"><span class="key">server</span>:<span class="value">ircnet ircnet</span></div>
<div class="element"><span class="key">server</span>:<span class="value">others *</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-Log::Recent" class="module">
<div class="module-header"><h2 title="クライアントを接続した時に、保存しておいた最近のメッセージを送る。">Log::Recent</h2>
<span class="description">クライアントを接続した時に、保存しておいた最近のメッセージを送る。</span></div>
<div class="content">
<p class="comment">
クライアントオプションの no-recent-logs が指定されていれば送信しません。<br />
</p>
<p class="comment">
各行のヘッダのフォーマット。省略されたら'%H:%M'。<br />
</p>
<div class="element"><span class="key">header</span>:<span class="value">%H:%M:%S</span></div>
<p class="comment">
ログをチャンネル毎に何行まで保存するか。省略されたら10。<br />
</p>
<div class="element"><span class="key">line</span>:<span class="value">15</span></div>
<p class="comment">
PRIVMSGとNOTICEを記録する際に、自分の発言と他人の発言でフォーマットを変えるかどうか。1/0。デフォルトで1。<br />
</p>
<div class="element"><span class="key">distinguish-myself</span>:<span class="value">1</span></div>
<p class="comment">
どのメッセージを保存するか。省略されたら保存可能な全てのメッセージを保存する。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">privmsg,notice,topic,join,part,quit,kill</span></div>
</div>
</div>
</div>
<div class="pane-sidebar">
<ul class="menu">
<li><a href="#module-Log::Channel" title="チャンネルやprivのログを取るモジュール。">Log::Channel</a></li>
<li><a href="#module-Log::ChannelList" title="チャンネルリストをテンプレートに沿って HTML 化します。">Log::ChannelList</a></li>
<li><a href="#module-Log::Raw" title="サーバとの生の通信を保存する">Log::Raw</a></li>
<li><a href="#module-Log::Recent" title="クライアントを接続した時に、保存しておいた最近のメッセージを送る。">Log::Recent</a></li>
<li><a href="../module-toc.html">モジュール一覧に戻る</a></li>
</ul>
</div>
</body>
</html>
|
