設定
plumの設定はplum.confというファイルで行います。
plum.confでモジュールの組み込み関する設定と、
モジュールのプロパティの設定を行います。
plum.confは普通のテキストで、1行につき1つの設定を書きます。
どんなに長くなっても、必ず1行に書いて下さい。
また「#」で始まる行はコメントです。
実際の設定例として、plum-default.confという設定ファイルが用意されています。
とりあえず動くかどうかを確認したい場合は、この設定ファイルを使って下さい。
この設定ファイルでは、pircとほぼ同じ動作をするように設定してあります。
plum-default.confを使ってplumを実行するためには、
perl plum default
のように実行して下さい。これで動くことが確認できたら、
このファイルを少しずつ変更していくのがいいと思います。
モジュール
モジュールの組み込みに関する設定には以下のものがあります。
- + dir/module.plm
- dir/module.plmというモジュールを組み込みます。
- = dir/module.plm
- dir/module.plmというモジュールを読み込みます。
モジュールの初期化は行われますが、組み込みは行われません。
- - dir/module.plm
- モジュールの組み込みは行いません。
モジュールは前に書いてあるものから順に組み込まれます。
モジュールを組み込む順番によって、多少動作が変わるので注意して下さい。
同じモジュールに関して異なった設定を行った場合は、
最後の設定が有効になります。
プロパティ
プロパティの設定は以下のような形式で指定します。
- dir.module.key: value
- dir/module.plmというモジュールの、
keyというプロパティをvalueという値にします。
valueには数字でも文字列でもそのまま指定します。
valueと"value"と'value'はそれぞれ別のものなので注意して下さい。
同じプロパティを複数設定できるものとできないものがあります。
複数設定できないプロパティを複数設定した場合は、
最初に設定したものが有効になります。
モジュールの多重組み込み
plum 2.6以降では同じ名前のモジュールを複数組み込むことができます。
正確に言うと1つのモジュールのサブルーチンを、
異なったプロパティで複数回実行します。
この機能を使用するためには、モジュールの組み込みとプロパティの記述を
変更する必要があります。
モジュールの組み込みは以下のように行います。
- + dir/module.plm label1,label2
- dir/module.plmというモジュールを組み込みます。
このとき、label1、label2というラベルで
このモジュールのサブルーチンを2回ずつ実行します。
プロパティの設定は以下のように行います。
- dir.module.label1.key: value1
- dir/module.plmというモジュールのlabel1でのプロパティです。
- dir.modlue.label2.key: value2
- dir/module.plmというモジュールのlabel2でのプロパティです。
- dir.module.key: value
- dir/module.plmのデフォルトプロパティです。
ラベルのプロパティが設定されていない場合はこの値を使用します。
plumのプロパティ
plum自身のプロパティには以下のものがあります。
各モジュールで設定できるプロパティは
それぞれのモジュールのドキュメントを参照して下さい。
- plum.kanji ({jis|euc|sjis})
- plum.confがどの漢字コードで書かれているかを指定します。
plum.confがJISで書かれているなら「jis」、
EUCで書かれているなら「euc」、
SJISで書かれているなら「sjis」をそれぞれ指定して下さい。
また、「jis」は別の漢字コードと組み合わせることができ、
「jis,euc」や、「jis,sjis」と指定すれば、
どちらの漢字コードで書かれていても正しく認識します。
plumをUNIXで実行するなら「jis,euc」、
WindowsやMacintoshで実行するなら「jis,sjis」と指定しておけば
おそらく問題ないと思います。
- plum.nick ニックネーム
- IRCでのニックネームを指定します。
ニックネームは9文字以内で、アルファベット、
数字と一部の記号が使用できます。漢字やカタカナは使用できません。
デフォルトではログイン名を使用します。
- plum.user ユーザ名
- ニックネームとは別に、実際のユーザ名を指定します。
普通はログイン名を設定するようにして下さい。
デフォルトではログイン名を使用します。
- plum.name 実名
- ユーザの実名を指定します。自分の名前を自由に設定できます。
ニックネームやユーザ名とは違って漢字なども使用できます。
文字数の制限はありませんが、
長くても20文字程度にしておいたほうがいいと思います。
- plum.server* サーバ名[:ポート番号] [パスワード]
- 接続するサーバを指定します。
サーバ名にはIPアドレスを指定することもできます。
- plum.client* クライアントマスク[:ポート番号] [パスワード]
- 接続を許可するクライアントを指定します。
クライアントマスクにマッチするマシンからの接続のみを許可します。
クライアントマスクには「*」と「?」の
2種類のワイルドカードが使用できます。
「*」は任意の長さの文字列とマッチし、
「?」は任意の一文字とマッチします。
プロパティ名の最後に「*」がついているものは、
同じプロパティを複数指定することができます。
プロパティ名に「*」は含まれないので注意して下さい。
また、プロパティの値の見方は以下のようになっています。
- value
- valueをそのまま指定します。
- 値
- 「値」そのものではなく、相当する値を指定します。
- [value]
- valueは省略することができます。
- {value1|value2|value3}
- 「|」で区切られたうちのどれか1つを指定します。
- (value)
- value,value,valueのように「,」で区切って複数指定できます。
これ以外の記号は、空白も含めてそのまま指定して下さい。
日付・時間のフォーマット
モジュールの中にはプロパティに日付や時間のフォーマットを
指定できるものがあります。
これらは「%」とアルファベット1文字という形式で、
以下のように展開されます。
- %Y
- 年 (1970〜)
- %y
- 年の下2桁 (00〜99)
- %m
- 月 (01〜12)
- %d
- 日 (01〜31)
- %j
- 日 (001〜366)
- %w
- 曜日 (0〜6)
- %H
- 時間 (00〜23)
- %I
- 時間 (01〜12)
- %k
- 時間 ( 0〜23)
- %l
- 時間 ( 1〜12)
- %M
- 分 (00〜59)
- %S
- 秒 (00〜61)