/usr/share/doc/tiarra/module/System.html is in tiarra 20100212-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | <?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>System 関係のモジュール - Tiarra Documentation</title>
<link rel="stylesheet" type="text/css" href="../default.css" />
</head>
<body>
<div class="header">
<h1>System 関係のモジュール</h1>
</div>
<hr class="sep" />
<div class="pane-main">
<div id="module-System::Error" class="module">
<div class="module-header"><h2 title="サーバーからのERRORメッセージをNOTICEに埋め込む">System::Error</h2>
<span class="description">サーバーからのERRORメッセージをNOTICEに埋め込む</span></div>
<div class="content">
<p class="comment">
これをoffにするとクライアントにERRORメッセージがそのまま送られます。<br />
クライアントとの間ではERRORメッセージは主に切断警告に使われており、<br />
そのまま流してしまうとクライアントが混乱する可能性があります。<br />
設定項目はありません。<br />
</p>
<p class="comment">
このモジュールを回避してERRORメッセージをクライアントに送りたい場合は、<br />
remarkのsend-error-as-is-to-clientを指定してください。<br />
</p>
</div>
</div>
<hr class="sep" />
<div id="module-System::LivePatch" class="module">
<div class="module-header"><h2 title="Live Patch.">System::LivePatch</h2>
<span class="description">Live Patch.</span></div>
<div class="content">
<p class="comment">
main/* に対する実行時パッチ<br />
起動/ロード時に確認は行われるが, 実際の適用は指示があるまで行われない.<br />
</p>
<p class="comment">
対応している箇所.<br />
ModuleManager / reload_modules_if_modified / r3004 => r8809<br />
LinedINETSocket / connect / r3004 => r8930<br />
Configuration::Block / equals / r3004 => r11868<br />
</p>
<p class="comment">
/livepatch check で確認.<br />
/livepatch apply で適用.<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">livepatch</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::Macro" class="module">
<div class="module-header"><h2 title="新規にコマンドを追加し、そのコマンドが使われた時に特定の動作をまとめて実行します。">System::Macro</h2>
<span class="description">新規にコマンドを追加し、そのコマンドが使われた時に特定の動作をまとめて実行します。</span></div>
<div class="content">
<p class="comment">
書式: <コマンド> <動作><br />
コマンド"switch"を追加して、それが使われると<br />
#a@ircnet,#b@ircnet,#c@ircnetにjoinして、<br />
#d@ircnet,#e@ircnet,#f@ircnetからpartする例。<br />
</p>
<div class="element"><span class="key">macro</span>:<span class="value">switch join #a@ircnet,#b@ircnet,#c@ircnet</span></div>
<div class="element"><span class="key">macro</span>:<span class="value">switch part #d@ircnet,#e@ircnet,#f@ircnet</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::NotifyIcon::Win32" class="module">
<div class="module-header"><h2 title="タスクトレイにアイコンを表示する。">System::NotifyIcon::Win32</h2>
<span class="description">タスクトレイにアイコンを表示する。</span></div>
<div class="content">
<p class="comment">
タスクトレイにアイコンを表示します。<br />
クリックすると表示非表示を切り替えることができ、右クリックすると<br />
Reload と Exit ができるコンテキストメニューを表示します。<br />
多少反応が鈍いかもしれませんがちょっと待てば出てくると思います。<br />
</p>
<p class="comment">
Win32::GUI を必要とします。<br />
コンテキストメニューは表示している間処理をブロックしています。<br />
</p>
<p class="comment">
Win32 イベントループを処理する最大間隔を指定します。<br />
</p>
<div class="element"><span class="key">interval</span>:<span class="value">2</span></div>
<p class="comment">
通知領域に表示するアイコンを指定します。<br />
Win32::GUI の制限でちゃんとしたアイコンファイルしか指定できません。<br />
</p>
<div class="element"><span class="key">iconfile</span>:<span class="value">guiperl.ico</span></div>
<p class="comment">
モジュールが読み込まれたときにコンソールウィンドウを隠すかどうかを<br />
指定します。<br />
</p>
<div class="element"><span class="key">hide-console-on-load</span>:<span class="value">1</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::Pong" class="module">
<div class="module-header"><h2 title="サーバーからのPINGメッセージに対し、自動的にPONGを返す。">System::Pong</h2>
<span class="description">サーバーからのPINGメッセージに対し、自動的にPONGを返す。</span></div>
<div class="content">
<p class="comment">
これをoffにするとクライアントが自らPINGに応答せざるを得なくなりますが、<br />
クライアントからのPONGメッセージはデフォルトのサーバーへ送られるので<br />
デフォルト以外のサーバーからはPing Timeoutで落とされるなど<br />
全く良い事がありません。<br />
設定項目はありません。<br />
</p>
</div>
</div>
<hr class="sep" />
<div id="module-System::PrivTranslator" class="module">
<div class="module-header"><h2 title="クライアントからの個人的なprivが相手に届かなくなる現象を回避する。">System::PrivTranslator</h2>
<span class="description">クライアントからの個人的なprivが相手に届かなくなる現象を回避する。</span></div>
<div class="content">
<p class="comment">
このモジュールは個人宛てのprivmsgの送信者のnickにネットワーク名を付加します。<br />
また、最後に声をかけられてから5分以内の nick 変更をクライアントに伝えます。<br />
設定項目はありませんが、 networks/channel-network-separator を ! や @ 以外に<br />
変更することをおすすめします。<br />
</p>
</div>
</div>
<hr class="sep" />
<div id="module-System::Raw" class="module">
<div class="module-header"><h2 title="マスクで指定したサーバーにIRCメッセージを加工せずに直接送る。">System::Raw</h2>
<span class="description">マスクで指定したサーバーにIRCメッセージを加工せずに直接送る。</span></div>
<div class="content">
<p class="comment">
例えばQUITを送る事で一時的な切断が可能。<br />
</p>
<p class="comment">
この機能を利用するためのコマンド名。デフォルトは「raw」。<br />
「/raw ircnet quit」のようにして使う。<br />
一つ目のパラメータは送り先のネットワーク名。ワイルドカード使用可能。<br />
CHOCOA の場合、 raw がクライアントで使われてしまうので、<br />
コマンド名を変えるか、 /raw raw ircnet quit のようにする必要がある。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">raw</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::Reload" class="module">
<div class="module-header"><h2 title="confファイルやモジュールの更新をリロードするコマンドを追加する。">System::Reload</h2>
<span class="description">confファイルやモジュールの更新をリロードするコマンドを追加する。</span></div>
<div class="content">
<p class="comment">
リロードを実行するコマンド名。省略されるとコマンドを追加しません。<br />
例えば"load"を設定すると、"/load"と発言しようとした時にリロードを実行します。<br />
この時コマンドはTiarraが握り潰すので、IRCプロトコル上で定義された<br />
コマンド名を設定すべきではありません。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">load</span></div>
<p class="comment">
command と同じですが、サーバにもブロードキャストします。<br />
</p>
<div class="element"><span class="key">broadcast-command</span>:<span class="value">load-all</span></div>
<p class="comment">
confファイルをリロードしたときに通知します。<br />
モジュールの設定が変更されていた場合は、ここでの設定にかかわらず、<br />
モジュールごとに表示されます。1または省略された場合は通知します。<br />
</p>
<div class="element"><span class="key">conf-reloaded-notify</span>:<span class="value">1</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::RemoteControl" class="module">
<div class="module-header"><h2 title="特定の発言が送られてきたとき、それに反応してIRCコマンドを実行します。">System::RemoteControl</h2>
<span class="description">特定の発言が送られてきたとき、それに反応してIRCコマンドを実行します。</span></div>
<div class="content">
<p class="comment">
実行を許可する人間を表すマスク。<br />
</p>
<div class="element"><span class="key">mask</span>:<span class="value">*!*example@example.net</span></div>
<p class="comment">
構文: + <nick> <IRC Message><br />
<nick>は反応するbotのnickを表すマスク。<br />
<Tiarra::IRC::Message>はサーバーに向けて発行するIRCメッセージ。<br />
<br />
例:<br />
+ hoge NICK [hoge]<br />
hogeというBOTが[hoge]にnickを変更する。<br />
</p>
</div>
</div>
<hr class="sep" />
<div id="module-System::Shutdown" class="module">
<div class="module-header"><h2 title="Tiarraを終了させる。">System::Shutdown</h2>
<span class="description">Tiarraを終了させる。</span></div>
<div class="content">
<p class="comment">
クライアントから特定のコマンドが実行された時や、<br />
誰かから個人的に(privで)特定の発言が送られた時に<br />
Tiarra を終了させます。<br />
</p>
<p class="comment">
追加するコマンド。省略された場合はコマンドでのシャットダウンは無効になります。<br />
</p>
<div class="element"><span class="key">command</span>:<span class="value">shutdown</span></div>
<p class="comment">
Tiarraをシャットダウンさせるprivの発言。<br />
省略された場合はprivでのシャットダウンは無効になります。<br />
パラメータとして shutdown メッセージを指定できます。<br />
</p>
<div class="element"><span class="key">message</span>:<span class="value">shutdown</span></div>
<p class="comment">
privでのシャットダウンを許可する人。<br />
省略された場合はprivでのシャットダウンは無効になります。<br />
複数のマスクを指定した場合は、一つでもマッチするものがあればシャットダウンします。<br />
</p>
<div class="element"><span class="key">mask</span>:<span class="value">example!example@*.example.jp</span></div>
</div>
</div>
<hr class="sep" />
<div id="module-System::WebClient" class="module">
<div class="module-header"><h2 title="ブラウザ上でログを見たり発言したりできます.">System::WebClient</h2>
<span class="description">ブラウザ上でログを見たり発言したりできます.</span></div>
<div class="content">
<p class="comment">
WebClient を起動させる場所の指定.<br />
</p>
<div class="element"><span class="key">bind-addr</span>:<span class="value">127.0.0.1</span></div>
<div class="element"><span class="key">bind-port</span>:<span class="value">8667</span></div>
<div class="element"><span class="key">path</span>:<span class="value">/irc</span></div>
<div class="element"><span class="key">css</span>:<span class="value">/irc/style/style.css</span></div>
<p class="comment">
上の設定をapacheでReverseProxyさせる場合, httpd.conf には次のように設定.<br />
ProxyPass /irc/ http://localhost:8667/irc/<br />
ProxyPassReverse /irc/ http://localhost:8667/irc/<br />
<Location /irc/><br />
...<br />
</Location><br />
</p>
<p class="comment">
ReverseProxy 利用時の追加設定.<br />
接続元が全部プロキシサーバになっちゃうのでその対応.<br />
ReverseProxy 使わず直接公開の場合は不要.<br />
</p>
<div class="element"><span class="key">extract-forwarded-for</span>:<span class="value">127.0.0.1</span></div>
<p class="comment">
利用する接続設定の一覧.<br />
<br />
空白区切りで評価する順に記述.<br />
使われる設定は,<br />
- 接続元 IP が一致する物.<br />
- user/passが送られてきていない(認証前/anonymous):<br />
- 認証不要の設定があればその設定を利用.<br />
- 認証不要の設定がなければ 401 Unauthorized.<br />
- user/passが送られてきている.<br />
- 一致する設定を利用.<br />
- 一致する設定がなければ 401 Unauthorized.<br />
</p>
<div class="element"><span class="key">allow</span>:<span class="value">private public</span></div>
<p class="comment">
許可する接続の設定.<br />
</p>
<div class="block element"><span class="block key">allow-private</span>
<div class="block content">
<p class="comment">
接続元IPアドレスの制限.<br />
</p>
<div class="element"><span class="key">host</span>:<span class="value">127.0.0.1</span></div>
<p class="comment">
認証設定.<br />
auth: <user> <pass><br />
auth: :basic <user> <pass><br />
auth: :softbank <端末ID><br />
auth: :softbank <UID><br />
auth: :au <SUBNO><br />
各値(<pass>等)には {MD5}xxxx や {B}xxx や {CRYPT}xxx を利用可能.<br />
そのままべた書きも出来るけれど.<br />
</p>
<div class="element"><span class="key">auth</span>:<span class="value">:basic user pass</span></div>
<p class="comment">
公開するチャンネルの指定.<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">*@*</span></div>
</div></div>
<div class="block element"><span class="block key">allow-public</span>
<div class="block content">
<div class="element"><span class="key">host</span>:<span class="value">*</span></div>
<div class="element"><span class="key">auth</span>:<span class="value">:basic user2 pass2</span></div>
<div class="element"><span class="key">mask</span>:<span class="value">#公開チャンネル@ircnet</span></div>
</div></div>
<p class="comment">
デバッグフラグ.<br />
</p>
<div class="element"><span class="key">debug</span>:<span class="value">0</span></div>
<p class="comment">
保存する最大行数.<br />
</p>
<div class="element"><span class="key">max-lines</span>:<span class="value">100</span></div>
<p class="comment">
クライアントモード.<br />
owner か shared.<br />
</p>
<div class="element"><span class="key"> mode</span>:<span class="value">owner</span></div>
<p class="comment">
ログの方向.<br />
asc (旧->新) か desc (新->旧).<br />
</p>
<div class="element"><span class="key"> sort-order</span>:<span class="value">asc</span></div>
<p class="comment">
name-default 設定は VERSION 0.05 で廃止されました.<br />
# 発言BOXで名前指定しなかったときのデフォルトの名前.<br />
# mode: shared の時に使われる.<br />
-name-default: (noname)<br />
</p>
<p class="comment">
外部にTiarraさんを使っているときに, そこのネットワークを切り出して表示する.<br />
exteact-network: <netname> <remote-sep><br />
<netname> ::= このTiarraさんから見たときの外部Tiarraさんのネットワーク名.<br />
(このtiarra.confで指定しているネットワーク名)<br />
<remote-sep> ::= 外部Tiarraさんで使っているセパレータ.<br />
(こっちはこのtiarra.confのではないです)<br />
省略すると @ と仮定.<br />
</p>
<div class="element"><span class="key">exteact-network</span>:<span class="value">tiarra</span></div>
<div class="element"><span class="key">exteact-network</span>:<span class="value">tiarra @</span></div>
</div>
</div>
</div>
<div class="pane-sidebar">
<ul class="menu">
<li><a href="#module-System::Error" title="サーバーからのERRORメッセージをNOTICEに埋め込む">System::Error</a></li>
<li><a href="#module-System::LivePatch" title="Live Patch.">System::LivePatch</a></li>
<li><a href="#module-System::Macro" title="新規にコマンドを追加し、そのコマンドが使われた時に特定の動作をまとめて実行します。">System::Macro</a></li>
<li><a href="#module-System::NotifyIcon::Win32" title="タスクトレイにアイコンを表示する。">System::NotifyIcon::Win32</a></li>
<li><a href="#module-System::Pong" title="サーバーからのPINGメッセージに対し、自動的にPONGを返す。">System::Pong</a></li>
<li><a href="#module-System::PrivTranslator" title="クライアントからの個人的なprivが相手に届かなくなる現象を回避する。">System::PrivTranslator</a></li>
<li><a href="#module-System::Raw" title="マスクで指定したサーバーにIRCメッセージを加工せずに直接送る。">System::Raw</a></li>
<li><a href="#module-System::Reload" title="confファイルやモジュールの更新をリロードするコマンドを追加する。">System::Reload</a></li>
<li><a href="#module-System::RemoteControl" title="特定の発言が送られてきたとき、それに反応してIRCコマンドを実行します。">System::RemoteControl</a></li>
<li><a href="#module-System::Shutdown" title="Tiarraを終了させる。">System::Shutdown</a></li>
<li><a href="#module-System::WebClient" title="ブラウザ上でログを見たり発言したりできます.">System::WebClient</a></li>
<li><a href="../module-toc.html">モジュール一覧に戻る</a></li>
</ul>
</div>
</body>
</html>
|