doc/manual.html

   1 <html>
   2   <head>
   3     <title>keitairc: マニュアル</title>
   4     <link type="text/css" rel="stylesheet" href="default.css" />
   5     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6     <style type="text/css">
   7       <!--
   8           blockquote { font-family: monospace; }
   9           dl dt { font-family: monospace; }
  10         -->
  11     </style>
  12   </head>
  13   <body>
  14
  15     <h1>keitairc: マニュアル</h1>
  16
  17     <p>
  18       <a href="index.html">はじめに</a> |
  19       <a href="license.html">ライセンス</a> |
  20       <a href="environment.html">動作環境</a> |
  21       <a href="screenshot.html">スクリーンショット</a> |
  22       <a href="install.html">インストール</a> |
  23       <a href="usage.html">使い方</a> |
  24       マニュアル |
  25       <a href="http://sourceforge.jp/projects/keitairc/">開発</a> |
  26       <a href="security.html">セキュリティ</a> |
  27       <a href="faq.html">FAQ</a> |
  28       <a href="changes.html">変更履歴</a>
  29     </p>
  30
  31     <h2>keitairc 設定の指定方法</h2>
  32
  33     <p>
  34       このページの記述は keitairc 2.0 系を対象としています。
  35     </p>
  36
  37     <p>
  38       keitairc にはいろいろな設定項目があります。
  39       これらの設定項目は、設定ファイルで指定しておくこともできますし、
  40       keitairc の起動時引数で指定することもできます。
  41     </p>
  42
  43     <h2>設定ファイルと起動時引数の評価順</h2>
  44
  45     <p>
  46       keitairc は、起動時に、
  47       <tt>/etc/keitairc</tt> が存在するなら最初にこれを読み込みます。
  48       ユーザ共通のサイト・ローカルな設定はここに記述するとよいでしょう。
  49     <p>
  50       次に、ユーザのホーム・ディレクトリ直下に
  51       <tt>.keitairc</tt> が存在するならこれを読み込みます。
  52       ユーザごとの設定はここに記述するとよいでしょう。
  53     <p>
  54       次に、keitairc の第一引数が存在するファイル名であった場合、
  55       これを読み込みます。
  56     <p>
  57       最後に、起動時引数で指定されたパラメータを
  58       評価します。一時的な設定を行う際に用いるとよいでしょう。
  59     <p>
  60       いずれの設定方法でも、後で評価された設定の方が優先されます。
  61     </p>
  62
  63     <h2>設定ファイルの書式</h2>
  64
  65     <p>
  66       設定ファイルで指定する場合は、項目名の後にイコール、
  67       その後に値を記述してください。
  68     <p>
  69       例: 設定ファイルにおける cookie_ttl の設定
  70     </p>
  71     <blockquote>
  72       cookie_ttl = 14400
  73     </blockquote>
  74     <p>
  75       設定ファイルでは、行頭の空白は無視されます。<br />
  76       # 以降の記述は無視されます。<br />
  77       空白のみの行、空行は無視されます。<br />
  78       日本語文字列を値に指定する場合、設定ファイルのキャラクタセットは
  79       utf-8でなければなりません。
  80     </p>
  81
  82     <h2>起動時引数の書式</h2>
  83
  84     <p>
  85       いずれの設定項目も、起動時引数で指定することもできます。
  86       起動時引数で指定する場合は、項目名の先頭にハイフンをつけ、
  87       項目名と値の間のイコールは省略してください。
  88     <p>
  89       例: 起動時引数ファイルにおける cookie_ttl の設定
  90     </p>
  91     <blockquote>
  92       -cookie_ttl 14400
  93     </blockquote>
  94     <p>
  95       起動時引数による設定は、プロセス情報を介して、
  96       同じホストにいる別のユーザから見ることができます。
  97       保護したい情報は起動時引数で指定しないようにしましょう。
  98     </p>
  99
 100     <h2>設定項目の一覧: 基本編</h2>
 101
 102     <p>
 103       以下に、keitairc の設定項目の一覧を示します。<br />
 104       [必須] と書かれた項目は、なんらかの方法で設定を行わないと
 105       keitairc が起動しません。
 106     </p>
 107
 108     <dl>
 109       <dt>irc_nick</dt>
 110       <dd>
 111         [必須]
 112         irc の nick を指定します。
 113       </dd>
 114       <dt>irc_username</dt>
 115       <dd>
 116         [必須]
 117         irc 上のユーザ名を指定します。
 118       </dd>
 119       <dt>irc_desc</dt>
 120       <dd>
 121         irc クライアントとしての description を指定します。
 122         デフォルトは文字列 keitairc です。通常は変更する必要はありません。
 123       </dd>
 124       <dt>irc_server</dt>
 125       <dd>
 126         [必須]
 127         irc server を指定します。
 128       </dd>
 129       <dt>irc_port</dt>
 130       <dd>
 131         接続すべき irc port を指定します。
 132         デフォルトは 6667 です。
 133       </dd>
 134       <dt>irc_password</dt>
 135       <dd>
 136         irc server に接続する際にサーバパスワードが必要であれば指定します。
 137         デフォルトは無しです。
 138       </dd>
 139       <dt>irc_keyword</dt>
 140       <dd>
 141         指定した文字列(群)が発言中にあった場合、キーワードハイライトします。
 142         文字列を複数指定する場合は、空白をはさまずカンマで区切って羅列してください。<br />
 143         設定例:
 144         <blockquote>
 145           irc_keyword = ASAP,緊急,急募,飲み会
 146         </blockquote>
 147       </dd>
 148       <dt>irc_charset</dt>
 149       <dd>
 150         接続するirc server/channelで用いられているキャラクタセットを指定します。
 151         デフォルトはiso-2022-jp-1です。<br />
 152         (iso-2022-jp/utf8 でのみ動作を確認しています)<br />
 153         指定には、Perlの
 154         <tt>Encode::JP</tt>で定義されているエンコーディング指定文字列を
 155         使うことができます。
 156       </dd>
 157       <dt>web_port</dt>
 158       <dd>
 159         keitairc にアクセスするときのポート番号を指定します。<br />
 160         (keitairc 自体が listen する port を指定したい場合は
 161         <tt>web_listen_port</tt> で指定してください)<br />
 162         デフォルトは tcp/8080 です。
 163       </dd>
 164       <dt>web_lines</dt>
 165       <dd>
 166         keitairc が各チャンネルごとに記憶する発言行数を指定します。
 167         デフォルトは100行です。
 168       </dd>
 169       <dt>web_password</dt>
 170       <dd>
 171         [必須]
 172         keitairc にログインする際のパスワード文字列を指定します。<br />
 173         平文で指定しますので、設定ファイルが漏洩するとパスワードも漏洩します。
 174         また起動時引数で指定すると、プロセス情報を見るだけで
 175         パスワードも漏洩します。
 176       </dd>
 177       <dt>web_host</dt>
 178       <dd>
 179         [必須]
 180         keitairc は http server として立ち上がりますが、
 181         その http server のホスト名を指定します。
 182       </dd>
 183     </dl>
 184
 185     <h2>機種・携帯キャリアごとの設定項目</h2>
 186
 187     <h3>NTT DoCoMo</h3>
 188     <dl>
 189       <dt>docomo_foma_icc</dt>
 190       <dd>
 191         NTT DoCoMo FOMA端末のICC番号を指定すると、
 192         該当する端末はこれを用いて認証できます。
 193         設定例:
 194         <blockquote>
 195           docomo_foma_icc = icc99998888777766665555
 196         </blockquote>
 197       </dd>
 198       <dt>docomo_imodeid</dt>
 199       <dd>
 200         NTT DoCoMo FOMA端末のiモードIDを指定すると、
 201         該当する端末はこれを用いて認証できます。
 202         設定例:
 203         <blockquote>
 204           docomo_imodeid = AAbb123
 205         </blockquote>
 206       </dd>
 207     </dl>
 208
 209     <h3>KDDI au</h3>
 210     <dl>
 211       <dt>au_subscriber_id</dt>
 212       <dd>
 213         au携帯端末のEZ番号 (サブスクライバID) を指定すると、
 214         該当する端末はこれを用いて認証できます。
 215         設定例:
 216         <blockquote>
 217           au_subscriber_id = 01099887766554_xx.ezweb.ne.jp
 218         </blockquote>
 219       </dd>
 220     </dl>
 221
 222     <h3>Softbank mobile</h3>
 223     <dl>
 224       <dt>softbank_serial_key</dt>
 225       <dd>
 226         au携帯端末のEZ番号 (サブスクライバID) を指定すると、
 227         該当する端末はこれを用いて認証できます。
 228         設定例:
 229         <blockquote>
 230           softbank_serial_key = SN112233445566778
 231         </blockquote>
 232       </dd>
 233     </dl>
 234
 235     <h3>emobile</h3>
 236     <dl>
 237       <dt>emobile_userid</dt>
 238       <dd>
 239         emobile端末のuseridを指定すると、
 240         該当する端末はこれを用いて認証できます。
 241       </dd>
 242     </dl>
 243
 244     <h2>設定項目の一覧: 上級編</h2>
 245
 246     <dl>
 247       <dt>cookie_ttl</dt>
 248       <dd>
 249         Cookieの生存時間を指定します。
 250         デフォルトは3日間です。
 251       </dd>
 252       <dt>session_ttl</dt>
 253       <dd>
 254         セッション情報の生存時間を指定します。
 255         デフォルトは30分です。
 256       </dd>
 257       <dt>web_listen_port</dt>
 258       <dd>
 259         keitairc が web 接続を待ち受ける port を指定します。
 260         reverse proxy 環境などで、
 261         keitairc が listen する port と、
 262         クライアントがアクセスする port を別に指定したい場合等に用います。
 263         デフォルトは <tt>web_port</tt> で指定されているポートと同じです。
 264       </dd>
 265       <dt>web_title</dt>
 266       <dd>
 267         keitairc の web アクセス画面のタイトルの基本名を指定します。
 268         デフォルトは keitairc です。
 269       </dd>
 270       <dt>web_root</dt>
 271       <dd>
 272         keitairc が web server として動作するときの、
 273         URI上のkeitaircのトップディレクトリを指定します。<br />
 274         たとえば
 275         <tt>example.com</tt>
 276         というサーバで
 277         <blockquote>
 278           web_host = example.com<br />
 279           web_port = 8080<br />
 280           web_root = /irc/
 281         </blockquote>
 282         と指定してkeitaircを立ち上げた場合、
 283         そのkeitaircのトップページは
 284         <tt>http://example.com:8080/irc/</tt>
 285         として動作します。末尾には必ず <tt>/</tt> を付けてください。
 286       </dd>
 287       <dt>web_charset</dt>
 288       <dd>
 289         keitaircにhttpアクセスする際のキャラクタセットを指定します。
 290         デフォルトは shiftjis です。<br />
 291         指定には、Perlの
 292         <tt>Encode::JP</tt>で定義されているエンコーディング指定文字列を
 293         使うことができます。
 294       </dd>
 295       <dt>web_schema</dt>
 296       <dd>
 297         keitaircにwebアクセスする際のスキーマを指定します。
 298         デフォルトはhttpです。
 299         https経由でkeitaircを使いたい場合はhttpsと指定してください。<br />
 300         ただしkeitairc自体はhttpsを提供しておりません。
 301         web_schemaにhttpsを指定しても、keitaircが提供するのはhttpサービスのみです。実際には、keitaircの前段にapacheのmod_proxyやmod_sslなどをかませてお使いいただくことになるでしょう。<br />
 302         また、日本の携帯端末に対しhttpsでサービスを提供する際には、
 303         SSL証明書や認証文字列の取得、位置情報の取得などにいろいろな制限があります。
 304         注意して使用してください。
 305       </dd>
 306       <dt>extra_header</dt>
 307       <dd>
 308         表示内容にヘッダを追加したいときに指定します。
 309         デフォルトは未定義です。<br />
 310         CSS のスタイルファイルを指定したい場合等に使用します。<br />
 311         たとえば <tt>http://example.com/style.css</tt> をスタイルファイルとして利用したい場合は以下のように、
 312         <blockquote>
 313           extra_header = '&lt;link rel="stylesheet" type="text/css" href="http://example.com/style.css"&gt;'
 314         </blockquote>
 315         keitairc 設置ディレクトリ以下の <tt>lib/public</tt> に設置した <tt>my.css</tt> をスタイルファイルとして利用したい場合は以下のように設定します。
 316         <blockquote>
 317           extra_header = '&lt;link rel="stylesheet" type="text/css" href="/my.css"&gt;'
 318         </blockquote>
 319       </dd>
 320       <dt>fontsize</dt>
 321       <dd>
 322         keitaircに携帯機器以外からアクセスした際の、
 323         webページの基本的なフォントサイズを指定します。<br />
 324         これは
 325         <tt>&lt;font size=""&gt;</tt>
 326         エレメントの引数になる文字列です。
 327         デフォルトは <tt>+0</tt> です。
 328       </dd>
 329       <dt>mobile_fontsize</dt>
 330       <dd>
 331         keitaircに携帯機器からアクセスした際の、
 332         webページの基本的なフォントサイズを指定します。<br />
 333         これは
 334         <tt>&lt;font size=""&gt;</tt>
 335         エレメントの引数になる文字列です。
 336         デフォルトは <tt>-1</tt> です。
 337       </dd>
 338       <dt>silent_config</dt>
 339       <dd>
 340         keitairc 起動時のプラグイン読み込み表示を抑制します。
 341         抑制する場合は yes や 1,
 342         抑制しない場合は no や 0 を指定してください。
 343         デフォルトは no です。
 344       </dd>
 345       <dt>show_joinleave</dt>
 346       <dd>
 347         他ユーザの join や leave も表示します。
 348         デフォルトは yes です。
 349       </dd>
 350       <dt>show_console</dt>
 351       <dd>
 352         チャネルの発言同様に irc console も表示します。
 353         デフォルトは no です。
 354       </dd>
 355       <dt>ping_delay</dt>
 356       <dd>
 357         keitairc は一定間隔で irc server への接続を確認します。
 358         その間隔時間を指定します。
 359         デフォルトは30秒です。
 360       </dd>
 361       <dt>reconnect_delay</dt>
 362       <dd>
 363         keitaircは、irc serverからの切断を認識すると、
 364         一定時間後に再接続を試みます。
 365         その待ち時間を指定します。
 366         デフォルトは10秒です。
 367       </dd>
 368       <dt>follow_nick</dt>
 369       <dd>
 370         他のユーザのnick, ユーザ名を把握し、変化に追従するようにします。
 371         デフォルトは yes です。<br />
 372         情報を把握するため keitairc の立ち上がり時/チャネルへのユーザの
 373         join 時に irc メッセージが流れます。keitairc が接続している pirc に
 374         他の irc クライアントも接続している場合は、そのクライアントに意図しない
 375         タイミングで大量のメッセージが流れてしまうような挙動になることがあります。
 376         その場合は、別の pirc に接続するようにするか、follow_nick を no にしてください。
 377       </dd>
 378       <dt>smtp_server</dt>
 379       <dd>
 380         メール送信機能を使う場合、smtp server を指定します。
 381         デフォルトは未定義です。
 382         smtp auth には非対応です。
 383       </dd>
 384       <dt>smtp_from</dt>
 385       <dd>
 386         メール送信機能を使う場合、smtp における FROM を指定します。
 387         デフォルトは未定義です。
 388       </dd>
 389       <dt>smtp_to</dt>
 390       <dd>
 391         メール送信機能を使う場合、宛先メールアドレスを指定します。
 392         デフォルトは未定義です。
 393       </dd>
 394       <dt>debug</dt>
 395       <dd>
 396         より詳細なログを表示します。
 397         デフォルトは off です。
 398       </dd>
 399
 400       <dt>daemonize</dt>
 401       <dd>
 402         起動時に daemon 化します。
 403         デフォルトは off です。
 404       </dd>
 405       <dt>pid_dir</dt>
 406       <dd>
 407         daemonize = yes で keitairc が daemon として起動した場合、
 408         <tt>pid_dir</tt> で指定したディレクトリ以下の
 409         <tt>pid_file</tt> ファイルに PID を保存します。
 410         デフォルトは <tt>/var/run</tt> です。
 411       </dd>
 412       <dt>pid_file</dt>
 413       <dd>
 414         daemonize = yes で keitairc が daemon として起動した場合、
 415         <tt>pid_dir</tt> で指定したディレクトリ以下の
 416         <tt>pid_file</tt> ファイルに PID を保存します。
 417         デフォルトは <tt>keitairc.pid</tt> です。
 418       </dd>
 419
 420       <dt>template_dir</dt>
 421       <dd>
 422         keitairc が使うテンプレートファイルの検索パスを指定します。<br />
 423         複数のパスをコロンで連結して指定できます。<br />
 424         デフォルトは <tt><i>カレントディレクトリ</i>/lib/templates:PREFIX/share/keitairc/templates</tt> で、
 425         すなわちまず <tt><i>カレントディレクトリ</i>/lib/templates</tt>,
 426         見つからなければ
 427         <tt>PREFIX/share/keitairc/lib/templates</tt> を検索します(PREFIX はインストール時に指定した
 428         PREFIX になります。通常 /usr もしくは /usr/local の場合が多いでしょう)
 429       </dd>
 430       <dt>plugin_dir</dt>
 431       <dd>
 432         keitairc が使うプラグインファイルの検索パスを指定します。<br />
 433         複数のパスをコロンで連結して指定できます。<br />
 434         デフォルトは <tt><i>カレントディレクトリ</i>/lib/plugins:PREFIX/share/keitairc/plugins</tt> で、
 435         すなわちまず <tt><i>カレントディレクトリ</i>/lib/plugins</tt>,
 436         見つからなければ
 437         <tt>/usr/share/keitairc/plugins</tt> を検索します(PREFIX はインストール時に指定した
 438         PREFIX になります。通常 /usr もしくは /usr/local の場合が多いでしょう)
 439       </dd>
 440       <dt>public_dir</dt>
 441       <dd>
 442         keitairc が使う静的ファイルの検索パスを指定します。<br />
 443         複数のパスをコロンで連結して指定できます。<br />
 444         デフォルトは <tt><i>カレントディレクトリ</i>/lib/public:PREFIX/share/keitairc/public</tt> で、
 445         すなわちまず <tt><i>カレントディレクトリ</i>/lib/public</tt>,
 446         見つからなければ
 447         <tt>PREFIX/share/keitairc/public</tt> を検索します(PREFIX はインストール時に指定した
 448         PREFIX になります。通常 /usr もしくは /usr/local の場合が多いでしょう)
 449       </dd>
 450       <dt>rgeocode_server</dt>
 451       <dd>
 452         携帯端末の位置情報取得機能をもとに、
 453         現在位置の住所文字列を取得する際、
 454         どの逆ジオコードサーバを利用するか指定します。<br />
 455         finds を指定すると
 456         http://www.finds.jp/wsdocs/rgeocode/
 457         で提供されているサービスを使用します。<br />
 458         google を指定すると http://maps.google.com
 459         で提供されているサービスを使用します。<br />
 460         デフォルトは finds です。<br />
 461         (なお、
 462         http://www.finds.jp/wsdocs/rgeocode/ は以前は
 463         http://refits.cgk.affrc.go.jp/tsrv/jp/rgeocode.html
 464         で提供されておりました。当時の設定との互換性のため、
 465         refits と指定した場合は finds と同じ意味になります)
 466       </dd>
 467       <dt>reverse_message</dt>
 468       <dd>
 469         全発言画面で、新しい発言ほど上に表示します。
 470         デフォルトはonです。
 471       </dd>
 472       <dt>reverse_recent</dt>
 473       <dd>
 474         未読発言一覧画面で、新しい発言ほど上に表示します。
 475         デフォルトはonです。
 476       </dd>
 477       <dt>reverse_unread</dt>
 478       <dd>
 479         未読発言画面で、新しい発言ほど上に表示します。
 480         デフォルトはonです。
 481       </dd>
 482       <dt>url_target</dt>
 483       <dd>
 484         URLリンクでウィンドウのターゲットを指定します。
 485         デフォルトは _self です(WebKit UI ではこの値は無視され、常に target=_blank で
 486         になります)
 487       </dd>
 488       <dt>url_redirect</dt>
 489       <dd>
 490         URLリンクでリダイレクタを指定するときに使用します。
 491         デフォルトは未定義です。
 492       </dd>
 493     </dl>
 494
 495     <h2>keitairc 2.0 で廃止された設定項目</h2>
 496
 497     <p>
 498       以下は、かつて keitairc 1.x で存在し、
 499       keitairc 2.0 で廃止された設定項目です。
 500       keitairc 2.0 は、これら設定が残っている場合、起動時に警告を表示します。
 501     </p>
 502
 503     <dl>
 504       <dt>show_newmsgonly</dt>
 505       <dd>
 506         新着メッセージのみを表示するようにする指定でしたが、
 507         廃止されました。keitairc 2.0 以降では指定しても無視されます。
 508       </dd>
 509       <dt>web_username</dt>
 510       <dd>
 511         webアクセス時の認証のユーザ名の指定でしたが、
 512         廃止されました。keitairc 2.0 以降では指定しても無視されます。
 513       </dd>
 514       <dt>use_cookie</dt>
 515       <dd>
 516         Cookieを利用するかどうかの指定でしたが、
 517         廃止されました。keitairc 2.0 以降では指定しても無視され、
 518         常にCookieを利用しようとします。
 519       </dd>
 520       <dt>au_pcsv</dt>
 521       <dd>
 522         au端末の場合に、外部リンクに対してPCサイトビューアー用の
 523         リンクも出すかどうかの指定でしたが、
 524         廃止されました。keitairc 2.0 以降では指定しても無視され、
 525         au端末からのアクセスの場合は、外部リンクに対してPCサイトビューアー用の
 526         リンクも常に案内します。
 527       </dd>
 528
 529     </dl>
 530
 531     <h2>keitairc で使われる環境変数</h2>
 532     <dl>
 533       <dt>HOME</dt>
 534       <dd>
 535         ユーザごとの設定ファイル .keitairc を探すのに使われます。
 536       </dd>
 537       <dt>IS_IPOD</dt>
 538       <dd>
 539         1 に設定すると、すべてのクライアントを強制的に
 540         iPhone/iPod touch/Android端末と見なしWebKit UIを表示します。<br />
 541         0 に設定すると、逆に iPhone/iPod touch/Android からのアクセスの場合でも、
 542         強制的に iPhone/iPod touch/Android からのアクセスとは認識しなくなります。
 543         主にデバグ目的の設定ですが、WebKit UI をPC のWebブラウザから利用するような
 544         場合、あるいは WebKit mobile ブラウザから通常 UI を利用したような場合などに
 545         利用することもできます。
 546       </dd>
 547     </dl>
 548
 549       <a href="http://sourceforge.jp/">
 550         <img src="http://sourceforge.jp/sflogo.php?group_id=1057"
 551              width="96" height="31" border="0" alt="SourceForge.jp"></a><br />
 552     </p>
 553
 554 <script type="text/javascript">
 555 var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
 556 document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
 557 </script>
 558 <script type="text/javascript">
 559 try {
 560 var pageTracker = _gat._getTracker("UA-15158856-1");
 561 pageTracker._trackPageview();
 562 } catch(err) {}</script>
 563
 564   </body>
 565 </html>