prepare least standard howto

1 files changed, 100 insertions, 2 deletions

diff --git a/fml/doc/guide.ja.html b/fml/doc/guide.ja.html
index ac3d5f2c..c22bc83f 100644
--- a/fml/doc/guide.ja.html
+++ b/fml/doc/guide.ja.html
@@ -35,6 +35,9 @@
 	</A>
 
 	<LI>
+	<A HREF="#programs"> 使用できるコマンドについて </A>
+
+	<LI>
 	<A HREF="#newml">ユーザ fml で ＭＬを作る。 </A>
 
 	<LI>
@@ -42,14 +45,109 @@
 </UL>
 
 <HR>
+<A NAME="programs">
+<P> コマンドについて
+<BR>
+
+インストーラは /usr/local/bin に 
+
+	fmldoc fmlconf fmlticket makefml 
+
+をインストールします。これらは実は /usr/local/libexec/fml の下の実体を
+呼び出す単なる wrapper です。
+
+fmldoc の使い方は perldoc と同様です。fml の任意のモジュールに対しその
+ドキュメントを表示します。
+実のところ perldoc への wrapper です。
+<PRE>
+例:
+% fmldoc FML::Process::Kernel
+</PRE>
+
+fmlconf は引数にＭＬ名をとり、そのＭＬの変数一覧を表示します。
+-n をつけるとデフォルトと異なる変数のみを表示します。
+<PRE>
+例:
+% fmlconf elena
+% fmlconf -n elena
+</PRE>
+
+fmlticket は引数にコマンドとＭＬ名をとります。
+チケットシステムへのインターフェイスです。
+まだ製作途中です。
+<PRE>
+例: close されていないチケット一覧を表示
+% fmlticket list elena
+
+例: チケットを close する。
+% fmlticket close elena チケット番号
+</PRE>
+
+makefml の使い方は fml 4.0 の makefml と同様です。
+現在使えるコマンドは以下のものだけです。
+<UL>
+	<LI>メンバーの登録
+	<LI>メンバーの削除
+	<LI>ＭＬの作成( newml )
+</UL>
+
 
-<NAME="#newml">
+<HR>
+<A NAME="newml">
 <P> ＭＬを作る
 
+fml 4.0 と同様です。 
+が、config.cf という設定ファイルをインストールしてくれるだけです。
+<PRE>
+% su fml
+% makefml newml elena
+% ls /var/spool/ml/elena
+config.cf
+</PRE>
+
+include include-ctl aliases も fml 4.0 と同様です。
+が、まだ、makefml newml で自動生成できるようになっていません _o_
+
+/var/spool/ml/elena/include ファイルは
+<PRE> 
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena"
+</PRE> 
+
+/var/spool/ml/elena/include-ctl ファイルは
+<PRE> 
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena --ctladdr"
+</PRE>
 
-<NAME="#config.cf">
+aliases への追加は次のようにして下さい。
+<PRE>
+elena: :include:/var/spool/ml/elena/include
+elena-ctl: :include:/var/spool/ml/elena/include-ctl
+elena-admin: fml
+owner-elena: fml
+owner-elena-ctl: fml
+</PRE> 
+
+
+<HR>
+<A NAME="config.cf">
 <P> カスタマイズをする
 
+elena ＭＬの設定のカスタマイズは /var/spool/ml/elena/config.cf を編集
+して下さい。フォーマットは fml 4.0 の cf に近いですが、postfix の設定
+ファイルと同様です。
+
+必要な項目を追加して下さい。それ以外はデフォルト値が使われます。
+デフォルト値はインストールしたバージョンに依存し、
+<PRE>
+/etc/fml/defaults/バージョン番号/default_config.cf
+</PRE>
+というファイルで定義されています。
+これは perl のライブラリが /usr/local/lib/perl/5.00503/ のように
+バージョン番号付のディレクトリに置かれるのと同様です。
+
+インストールした fml のバージョンごとに全部別のディレクトリに
+置かれることに注意して下さい。
+この仕組みのおかげでアップグレードしても元に戻すのが簡単です。
 
 </BODY>
 </HTML>