--- /dev/null
+<html>
+ <head>
+ <title>keitairc: マニュアル</title>
+ <link type="text/css" rel="stylesheet" href="default.css" />
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <style type="text/css">
+ <!--
+ blockquote { font-family: monospace; }
+ dl dt { font-family: monospace; }
+ -->
+ </style>
+ </head>
+ <body>
+
+ <h1>keitairc: マニュアル</h1>
+
+ <p>
+ <a href="index.html">はじめに</a> |
+ <a href="license.html">ライセンス</a> |
+ <a href="environment.html">動作環境</a> |
+ <a href="screenshot.html">スクリーンショット</a> |
+ <a href="install.html">インストール</a> |
+ <a href="usage.html">使い方</a> |
+ マニュアル |
+ <a href="http://sourceforge.jp/projects/keitairc/">開発</a> |
+ <a href="security.html">セキュリティ</a> |
+ <a href="faq.html">FAQ</a> |
+ <a href="changes.html">変更履歴</a>
+ </p>
+
+ <h2>keitairc 設定の指定方法</h2>
+
+ <p>
+ このページの記述は keitairc 2.0 系を対象としています。
+ </p>
+
+ <p>
+ keitairc にはいろいろな設定項目があります。
+ これらの設定項目は、設定ファイルで指定しておくこともできますし、
+ keitairc の起動時引数で指定することもできます。
+ </p>
+
+ <h2>設定ファイルと起動時引数の評価順</h2>
+
+ <p>
+ keitairc は、起動時に、
+ <tt>/etc/keitairc</tt> が存在するなら最初にこれを読み込みます。
+ ユーザ共通のサイト・ローカルな設定はここに記述するとよいでしょう。
+ <p>
+ 次に、ユーザのホーム・ディレクトリ直下に
+ <tt>.keitairc</tt> が存在するならこれを読み込みます。
+ ユーザごとの設定はここに記述するとよいでしょう。
+ <p>
+ 次に、keitairc の第一引数が存在するファイル名であった場合、
+ これを読み込みます。
+ <p>
+ 最後に、起動時引数で指定されたパラメータを
+ 評価します。一時的な設定を行う際に用いるとよいでしょう。
+ <p>
+ いずれの設定方法でも、後で評価された設定の方が優先されます。
+ </p>
+
+ <h2>設定ファイルの書式</h2>
+
+ <p>
+ 設定ファイルで指定する場合は、項目名の後にイコール、
+ その後に値を記述してください。
+ <p>
+ 例: 設定ファイルにおける cookie_ttl の設定
+ </p>
+ <blockquote>
+ cookie_ttl = 14400
+ </blockquote>
+ <p>
+ 設定ファイルでは、行頭の空白は無視されます。<br>
+ # 以降の記述は無視されます。<br>
+ 空白のみの行、空行は無視されます。<br>
+ 日本語文字列を値に指定する場合、設定ファイルのキャラクタセットは
+ utf-8でなければなりません。
+ </p>
+
+ <h2>起動時引数の書式</h2>
+
+ <p>
+ いずれの設定項目も、起動時引数で指定することもできます。
+ 起動時引数で指定する場合は、項目名の先頭にハイフンをつけ、
+ 項目名と値の間のイコールは省略してください。
+ <p>
+ 例: 起動時引数ファイルにおける cookie_ttl の設定
+ </p>
+ <blockquote>
+ -cookie_ttl 14400
+ </blockquote>
+ <p>
+ 起動時引数による設定は、プロセス情報を介して、
+ 同じホストにいる別のユーザから見ることができます。
+ 保護したい情報は起動時引数で指定しないようにしましょう。
+ </p>
+
+ <h2>設定項目の一覧: 基本編</h2>
+
+ <p>
+ 以下に、keitairc の設定項目の一覧を示します。<br>
+ [必須] と書かれた項目は、なんらかの方法で設定を行わないと
+ keitairc が起動しません。
+ </p>
+
+ <dl>
+ <dt>irc_nick</dt>
+ <dd>
+ [必須]
+ irc の nick を指定します。
+ </dd>
+ <dt>irc_username</dt>
+ <dd>
+ [必須]
+ irc 上のユーザ名を指定します。
+ </dd>
+ <dt>irc_desc</dt>
+ <dd>
+ irc クライアントとしての description を指定します。
+ デフォルトは文字列 keitairc です。通常は変更する必要はありません。
+ </dd>
+ <dt>irc_server</dt>
+ <dd>
+ [必須]
+ irc server を指定します。
+ </dd>
+ <dt>irc_port</dt>
+ <dd>
+ 接続すべき irc port を指定します。
+ デフォルトは 6667 です。
+ </dd>
+ <dt>irc_password</dt>
+ <dd>
+ irc server に接続する際にサーバパスワードが必要であれば指定します。
+ デフォルトは無しです。
+ </dd>
+ <dt>irc_keyword</dt>
+ <dd>
+ 指定した文字列(群)が発言中にあった場合、キーワードハイライトします。
+ 文字列を複数指定する場合は、空白をはさまずカンマで区切って羅列してください。<br>
+ 設定例:
+ <blockquote>
+ irc_keyword = ASAP,緊急,急募,飲み会
+ </blockquote>
+ </dd>
+ <dt>irc_charset</dt>
+ <dd>
+ 接続するirc server/channelで用いられているキャラクタセットを指定します。
+ デフォルトはiso-2022-jp-1です。<br>
+ (iso-2022-jp 以外のキャラクタセットでの動作確認は不完全です)
+ </dd>
+ <dt>web_port</dt>
+ <dd>
+ keitairc が http server として待ち受けるポート番号を指定します。
+ デフォルトは tcp/8080 です。
+ </dd>
+ <dt>web_lines</dt>
+ <dd>
+ keitairc が各チャンネルごとに記憶する発言行数を指定します。
+ デフォルトは100行です。
+ </dd>
+ <dt>web_password</dt>
+ <dd>
+ [必須]
+ keitairc にログインする際のパスワード文字列を指定します。<br>
+ 平文で指定しますので、設定ファイルが漏洩するとパスワードも漏洩します。
+ また起動時引数で指定すると、プロセス情報を見るだけで
+ パスワードも漏洩します。
+ </dd>
+ <dt>web_host</dt>
+ <dd>
+ [必須]
+ keitairc は http server として立ち上がりますが、
+ その http server のホスト名を指定します。
+ </dd>
+ </dl>
+
+ <h2>機種・携帯キャリアごとの設定項目</h2>
+
+ <h3>NTT DoCoMo</h3>
+ <dl>
+ <dt>docomo_foma_icc</dt>
+ <dd>
+ NTT DoCoMo FOMA端末のICC番号を指定すると、
+ 該当する端末はこれを用いて認証できます。
+ 設定例:
+ <blockquote>
+ docomo_foma_icc = icc99998888777766665555
+ </blockquote>
+ </dd>
+ <dt>docomo_imodeid</dt>
+ <dd>
+ NTT DoCoMo FOMA端末のiモードIDを指定すると、
+ 該当する端末はこれを用いて認証できます。
+ 設定例:
+ <blockquote>
+ docomo_imodeid = AAbb123
+ </blockquote>
+ </dd>
+ </dl>
+
+ <h3>KDDI au</h3>
+ <dl>
+ <dt>au_subscriber_id</dt>
+ <dd>
+ au携帯端末のEZ番号 (サブスクライバID) を指定すると、
+ 該当する端末はこれを用いて認証できます。
+ 設定例:
+ <blockquote>
+ au_subscriber_id = 01099887766554_xx.ezweb.ne.jp
+ </blockquote>
+ </dd>
+ </dl>
+
+ <h3>Softbank mobile</h3>
+ <dl>
+ <dt>softbank_serial_key</dt>
+ <dd>
+ au携帯端末のEZ番号 (サブスクライバID) を指定すると、
+ 該当する端末はこれを用いて認証できます。
+ 設定例:
+ <blockquote>
+ softbank_serial_key = SN112233445566778
+ </blockquote>
+ </dd>
+ </dl>
+
+ <h3>emobile</h3>
+ <dl>
+ <dt>emobile_userid</dt>
+ <dd>
+ emobile端末のuseridを指定すると、
+ 該当する端末はこれを用いて認証できます。
+ </dd>
+ </dl>
+
+ <h2>設定項目の一覧: 上級編</h2>
+
+ <dl>
+ <dt>cookie_ttl</dt>
+ <dd>
+ Cookieの生存時間を指定します。
+ デフォルトは3日間です。
+ </dd>
+ <dt>session_ttl</dt>
+ <dd>
+ セッション情報の生存時間を指定します。
+ デフォルトは30分です。
+ </dd>
+ <dt>web_title</dt>
+ <dd>
+ keitairc の web アクセス画面のタイトルの基本名を指定します。
+ デフォルトは keitairc です。
+ </dd>
+ <dt>web_root</dt>
+ <dd>
+ keitairc が web server として動作するときの、
+ URI上のkeitaircのトップディレクトリを指定します。<br>
+ たとえば
+ <tt>example.com</tt>
+ というサーバで
+ <blockquote>
+ web_host = example.com<br>
+ web_port = 8080<br>
+ web_root = /irc/
+ </blockquote>
+ と指定してkeitaircを立ち上げた場合、
+ そのkeitaircのトップページは
+ <tt>http://example.com:8080/irc/</tt>
+ として動作します。末尾には必ず <tt>/</tt> を付けてください。
+ </dd>
+ <dt>web_charset</dt>
+ <dd>
+ keitaircにhttpアクセスする際のキャラクタセットを指定します。
+ デフォルトは shiftjis です。
+ </dd>
+ <dt>fontsize</dt>
+ <dd>
+ keitaircに携帯機器以外からアクセスした際の、
+ webページの基本的なフォントサイズを指定します。<br>
+ これは
+ <tt><font size=""></tt>
+ エレメントの引数になる文字列です。
+ デフォルトは <tt>+0</tt> です。
+ </dd>
+ <dt>mobile_fontsize</dt>
+ <dd>
+ keitaircに携帯機器からアクセスした際の、
+ webページの基本的なフォントサイズを指定します。<br>
+ これは
+ <tt><font size=""></tt>
+ エレメントの引数になる文字列です。
+ デフォルトは <tt>-1</tt> です。
+ </dd>
+ <dt>silent_config</dt>
+ <dd>
+ keitairc 起動時のプラグイン読み込み表示を抑制します。
+ 抑制する場合は yes や 1,
+ 抑制しない場合は no や 0 を指定してください。
+ デフォルトは no です。
+ </dd>
+ <dt>show_joinleave</dt>
+ <dd>
+ 他ユーザの join や leave も表示します。
+ デフォルトは yes です。
+ </dd>
+ <dt>show_console</dt>
+ <dd>
+ チャネルの発言同様に irc console も表示します。
+ デフォルトは no です。
+ </dd>
+ <dt>ping_delay</dt>
+ <dd>
+ keitairc は一定間隔で irc server への接続を確認します。
+ その間隔時間を指定します。
+ デフォルトは30秒です。
+ </dd>
+ <dt>reconnect_delay</dt>
+ <dd>
+ keitaircは、irc serverからの切断を認識すると、
+ 一定時間後に再接続を試みます。
+ その待ち時間を指定します。
+ デフォルトは10秒です。
+ </dd>
+ <dt>follow_nick</dt>
+ <dd>
+ 他のユーザのnick, ユーザ名を把握し、変化に追従するようにします。
+ デフォルトは yes です。<br>
+ 情報を把握するため、keitairc の立ち上がり時に irc メッセージを
+ それなりに流しますので、irc トラフィックが気になる場合は
+ no にしてください。
+ </dd>
+ <dt>smtp_server</dt>
+ <dd>
+ メール送信機能を使う場合、smtp server を指定します。
+ デフォルトは未定義です。
+ smtp auth には非対応です。
+ </dd>
+ <dt>smtp_from</dt>
+ <dd>
+ メール送信機能を使う場合、smtp における FROM を指定します。
+ デフォルトは未定義です。
+ </dd>
+ <dt>smtp_to</dt>
+ <dd>
+ メール送信機能を使う場合、宛先メールアドレスを指定します。
+ デフォルトは未定義です。
+ </dd>
+ <dt>debug</dt>
+ <dd>
+ より詳細なログを表示します。
+ デフォルトは off です。
+ </dd>
+
+ <dt>daemonize</dt>
+ <dd>
+ 起動時に daemon 化します。
+ デフォルトは off です。
+ </dd>
+ <dt>pid_dir</dt>
+ <dd>
+ daemonize = yes で keitairc が daemon として起動した場合、
+ <tt>pid_dir</tt> で指定したディレクトリ以下の
+ <tt>pid_file</tt> ファイルに PID を保存します。
+ デフォルトは <tt>/var/run</tt> です。
+ </dd>
+ <dt>pid_file</dt>
+ <dd>
+ daemonize = yes で keitairc が daemon として起動した場合、
+ <tt>pid_dir</tt> で指定したディレクトリ以下の
+ <tt>pid_file</tt> ファイルに PID を保存します。
+ デフォルトは <tt>keitairc.pid</tt> です。
+ </dd>
+
+ <dt>template_dir</dt>
+ <dd>
+ keitairc が使うテンプレートファイルの検索パスを指定します。<br>
+ 複数のパスをコロンで連結して指定できます。<br>
+ デフォルトは <tt><i>カレントディレクトリ</i>/lib/templates:/usr/share/keitairc/lib/templates</tt> で、
+ すなわちまず <tt><i>カレントディレクトリ</i>/lib/templates</tt>,
+ 見つからなければ
+ <tt>/usr/share/keitairc/lib/templates</tt> を検索します。
+ </dd>
+ <dt>plugin_dir</dt>
+ <dd>
+ keitairc が使うプラグインファイルの検索パスを指定します。<br>
+ 複数のパスをコロンで連結して指定できます。<br>
+ デフォルトは <tt><i>カレントディレクトリ</i>/lib/plugins:/usr/share/keitairc/lib/plugins</tt> で、
+ すなわちまず <tt><i>カレントディレクトリ</i>/lib/plugins</tt>,
+ 見つからなければ
+ <tt>/usr/share/keitairc/lib/plugins</tt> を検索します。
+ </dd>
+ <dt>public_dir</dt>
+ <dd>
+ keitairc が使う静的ファイルの検索パスを指定します。<br>
+ 複数のパスをコロンで連結して指定できます。<br>
+ デフォルトは <tt><i>カレントディレクトリ</i>/lib/public:/usr/share/keitairc/lib/public</tt> で、
+ すなわちまず <tt><i>カレントディレクトリ</i>/lib/public</tt>,
+ 見つからなければ
+ <tt>/usr/share/keitairc/lib/public</tt> を検索します。
+ </dd>
+ <dt>rgeocode_server</dt>
+ <dd>
+ 携帯端末の位置情報取得機能をもとに、
+ 現在位置の住所文字列を取得する際、
+ どの逆ジオコードサーバを利用するか指定します。<br>
+ refits を指定すると
+ http://refits.cgk.affrc.go.jp/tsrv/jp/rgeocode.html
+ で提供されているサービスを使用します。<br>
+ google を指定すると http://maps.google.com
+ で提供されているサービスを使用します。<br>
+ デフォルトは refits です。
+ </dd>
+ <dt>reverse_message</dt>
+ <dd>
+ 全発言画面で、新しい発言ほど上に表示します。
+ デフォルトはonです。
+ </dd>
+ <dt>reverse_recent</dt>
+ <dd>
+ 未読発言一覧画面で、新しい発言ほど上に表示します。
+ デフォルトはonです。
+ </dd>
+ <dt>reverse_unread</dt>
+ <dd>
+ 未読発言画面で、新しい発言ほど上に表示します。
+ デフォルトはonです。
+ </dd>
+ </dl>
+
+ <h2>keitairc 2.0 で廃止された設定項目</h2>
+
+ <p>
+ 以下は、かつて keitairc 1.x で存在し、
+ keitairc 2.0 で廃止された設定項目です。
+ keitairc 2.0 は、これら設定が残っている場合、起動時に警告を表示します。
+ </p>
+
+ <dl>
+ <dt>show_newmsgonly</dt>
+ <dd>
+ 新着メッセージのみを表示するようにする指定でしたが、
+ 廃止されました。keitairc 2.0 以降では指定しても無視されます。
+ </dd>
+ <dt>web_username</dt>
+ <dd>
+ webアクセス時の認証のユーザ名の指定でしたが、
+ 廃止されました。keitairc 2.0 以降では指定しても無視されます。
+ </dd>
+ <dt>use_cookie</dt>
+ <dd>
+ Cookieを利用するかどうかの指定でしたが、
+ 廃止されました。keitairc 2.0 以降では指定しても無視され、
+ 常にCookieを利用しようとします。
+ </dd>
+ <dt>au_pcsv</dt>
+ <dd>
+ au端末の場合に、外部リンクに対してPCサイトビューアー用の
+ リンクも出すかどうかの指定でしたが、
+ 廃止されました。keitairc 2.0 以降では指定しても無視され、
+ au端末からのアクセスの場合は、外部リンクに対してPCサイトビューアー用の
+ リンクも常に案内します。
+ </dd>
+
+ </dl>
+
+ <a href="http://sourceforge.jp/">
+ <img src="http://sourceforge.jp/sflogo.php?group_id=1057"
+ width="96" height="31" border="0" alt="SourceForge.jp"></a><br>
+ </p>
+
+ </body>
+</html>
OSDN Git Service
