diff options
| -rw-r--r-- | fml/doc/ja/01_RFC_ARGV.txt | 55 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/usage/chapter.onhost.sgml | 93 |
2 files changed, 92 insertions, 56 deletions
diff --git a/fml/doc/ja/01_RFC_ARGV.txt b/fml/doc/ja/01_RFC_ARGV.txt deleted file mode 100644 index 115eb9ed..00000000 --- a/fml/doc/ja/01_RFC_ARGV.txt +++ /dev/null @@ -1,55 +0,0 @@ - コマンドの使い方 - - -『データを見るだけのもの』は、これはこれで別に構わないと思うのだけれど、 -『操作をするもの』カテゴリってのがいくつかある。fmlhtmify は別としても、 -こいつらは分離しないで makefml に統合するべきかな〜と思うところアリ。 -ばらさないようにすれば admin コマンドや CGI でも使えるようになり得るしね。 - - -＊ データを見るだけのもの - - fmladdr [-n] - fmlalias [-n] - fmldoc モジュール名 - fmlconf [-n] $ml - - うーむ？ - fmlerror $ml - fmlerror $ml [アルゴリズム？] - - -＊ 何らかの操作をするもの - - makefml $command $ml - fml $ml $command (makefml と一緒) - - -＊ 何らかの操作をするもの (の特殊なもの) - fmlhtmlify [-I DIR] $src_dir $dst_dir - - -＊ バラバラなので、makefml に統合するべきかな〜とおもうもの - fmlsummary $command $ml - fmlthread $command $ml - fmlspool [options] $command $ml - fmlsuper $command $ml - - -> - - * admin summary と user summary - fml $ml summary 単なる表示 (user summary はこれだけ) - fml $ml summary $subcommand - - fml $ml thread 単なる表示 - fml $ml thread $subcommand - - fml $ml spool 単なる表示 - fml $ml spool $subcommand - - fml $ml mailq 単なる表示 - fml $ml mailq $subcommand - - --------------------- -$FML$ diff --git a/fml/doc/ja/tutorial/usage/chapter.onhost.sgml b/fml/doc/ja/tutorial/usage/chapter.onhost.sgml index 6738c6f2..e8b13d1c 100644 --- a/fml/doc/ja/tutorial/usage/chapter.onhost.sgml +++ b/fml/doc/ja/tutorial/usage/chapter.onhost.sgml @@ -1,5 +1,5 @@ <!-- - $FML: chapter.onhost.sgml,v 1.3 2002/11/26 11:17:13 fukachan Exp $ + $FML: chapter.onhost.sgml,v 1.4 2003/01/05 08:03:22 fukachan Exp $ --> <chapter id="usage.onhost"> @@ -45,6 +45,97 @@ makefml の基本的な使い方は &fml4; の makefml と同様です。 もちろんファイルを編集しても構いませんが。 </para> +<para> +なお、fml コマンドは引数の順番の異なる makefml です。 +コマンドの中身/動作は同じですので、 +シンタックスの好き嫌いでどちらかを選んで使って下さい。 +<screen> +makefml コマンド ＭＬ名 オプション +fml ＭＬ名 コマンド オプション +</screen> +</para> + +</sect1> + + +<sect1 id="usage.commandpolicy"> + <title> + コマンドを用意する基準 + </title> + +<para> +&fmldevel; では、機能ごとに個別にコマンドを用意するようにしていますが、 +やたらと多くなるだけなので、以下のような基準に基づき用意することにしま +す(2003/03 記)。 +</para> + +<para> +できるだけ分離しないで makefml に統合するべきかな〜と思います。 +てきぎ admin コマンドや CGI でも使えるようになりうるので、 +再利用性が高いですしね。 +</para> + + +<setc2> + <title> + 特定のＭＬに操作を施すコマンド + </title> + +<para> +特定のＭＬに対し、何らかのデータを見るだけでなく操作をする可能性がある +なら、makefml (or fml) のコマンドとして実装する。 +<screen> +makefml コマンド ＭＬ名 オプション +fml ＭＬ名 コマンド オプション +</screen> +</para> + +</sect2> + + +<setc2> + <title> + データを見るだけのコマンド + </title> + + +<para> +特定のＭＬと関わりのないものもある。モジュールのドキュメントを見るとか、 +OS のアカウントやエイリアス一覧を表示させる類のものだ。 +これは fml が頭文字につくコマンドを別途用意する。 +<screen> +fmladdr [-n] +fmlalias [-n] +fmldoc モジュール名 +fmlconf [-n] $ml +</screen> +</para> + +</setc2> + + +<setc2> + <title> + 操作を施すコマンドだが、特定のＭＬとの関わりはないかも知れないタイプ + </title> + +<para> +これが一番困るケースのような気がする。 +どうしても作る必要があるなら、 +fml が頭文字につくコマンドを別途用意する。 +</para> + +<para> +例: 記事のスプールを HTML 化する。 +でも、fml に限らず、MH フォルダでも構わない。 +<screen> +fmlhtmlify [-I DIR] $src_dir $dst_dir +</screen> +</para> + +</sect2> + + </sect1> |