From 4407cf7927f712bbc60e1b908eeceedfcaf44d89 Mon Sep 17 00:00:00 2001 From: fukachan Date: Sat, 24 Nov 2001 03:22:52 +0000 Subject: reorder, enrich part II --- fml/doc/ja/tutorial/usage/TODO | 209 ++++++++++++++++++++++++++++++ fml/doc/ja/tutorial/usage/command.sgml | 66 ++++++++++ fml/doc/ja/tutorial/usage/fmlconf.sgml | 21 +++ fml/doc/ja/tutorial/usage/fmldoc.sgml | 22 ++++ fml/doc/ja/tutorial/usage/fmlhtmlify.sgml | 16 +++ fml/doc/ja/tutorial/usage/fmlthread.sgml | 25 ++++ fml/doc/ja/tutorial/usage/makefml.sgml | 69 ++++++++++ fml/doc/ja/tutorial/usage/onhost.sgml | 46 +++++++ fml/doc/ja/tutorial/usage/post.sgml | 8 +- 9 files changed, 478 insertions(+), 4 deletions(-) create mode 100644 fml/doc/ja/tutorial/usage/TODO create mode 100644 fml/doc/ja/tutorial/usage/command.sgml create mode 100644 fml/doc/ja/tutorial/usage/fmlconf.sgml create mode 100644 fml/doc/ja/tutorial/usage/fmldoc.sgml create mode 100644 fml/doc/ja/tutorial/usage/fmlhtmlify.sgml create mode 100644 fml/doc/ja/tutorial/usage/fmlthread.sgml create mode 100644 fml/doc/ja/tutorial/usage/makefml.sgml create mode 100644 fml/doc/ja/tutorial/usage/onhost.sgml (limited to 'fml/doc/ja/tutorial/usage') diff --git a/fml/doc/ja/tutorial/usage/TODO b/fml/doc/ja/tutorial/usage/TODO new file mode 100644 index 00000000..465ef148 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/TODO @@ -0,0 +1,209 @@ + + + + + fml-devel の実行形式プログラム + + + +プログラムには +/usr/local/bin 以下にインストールされるものと、 +/usr/local/libexec/fml 以下にインストールされるものがあります。 + + + +/usr/local/bin 以下にインストールされるものも、 +実体は /usr/local/libexec/fml 以下の同名のファイルです。 +そして、 +/usr/local/libexec/fml 以下のファイルは +/usr/local/libexec/fml/loader へのリンクです。 + + + +fml5 ではすべてのプログラムは /usr/local/libexec/fml/loader を経由して +起動されます。バージョン依存性を処理するためです。 + + + +loader は起動される時の名前で振舞いを変えています。 + + + + + + /usr/local/libexec/fml/ のプログラム + + + + + + /usr/local/libexec/fml/distribute + + +配送処理をするプログラムです。 +subject を書き換える。 +スプールに記事として溜める。 +IPv6 をしゃべる。 +チケット番号をふる。 +et. al. + + + + + + + + + /usr/local/libexec/fml/fml.pl + + +distribute と同じ。 + + + + + + + + + /usr/local/libexec/fml/command + + +command は fml.pl --ctladdr と同じです。 + + + +プログラム自体は動きますが、 +機能するコマンドはまだないです。 + + + + + + + + + /usr/local/libexec/fml/makefml.cgi + + +makefml の CGI インターフェイス。 +うごくけど、まだプロトタイプ。 +動く機能は makefml と同等のものです。 +それは最終的に makefml と同じ関数を呼び出しているからです。 + + + +例: +/cgi-bin/makefml.cgi?ml_name=elena&method=bye&address=rudo@nuinui.net + + + + + + + + + /usr/local/libexec/fml/fmlticket.cgi + + + +fmlticket の CGI 版。 +チケットを close する。 +あるチケットに該当する記事群を表示する。 + + + + + + + + /usr/local/libexec/fml/mead + + +ま〜だだよ + + + + + + + + + /usr/local/libexec/fml/fmlserv + + +ま〜だだよ + + + + + + + + + + /usr/local/bin/ のプログラム + + + + + + /usr/local/bin/makefml + + + +登録と削除関係、および最低限のMLの作成だけは動きます +(add subscribe bye unsubscribe resign remove そして newml)。 + + + +使い方は fml 4.0 と一緒です。 + +% makefml add elena アドレス +% makefml bye elena アドレス +% makefml newml elena + + + + + + + + + + /usr/local/bin/fmlconf + + 変数一覧を表示します + + + + + + /usr/local/bin/fmldoc + + +モジュールのマニュアルを表示する +perldoc への wrapper です。 + + + + + + + + /usr/local/bin/fmlticket + + +現在のチケットシステムのサマリを表示する。 +チケットの close をする。 + + + + + + + diff --git a/fml/doc/ja/tutorial/usage/command.sgml b/fml/doc/ja/tutorial/usage/command.sgml new file mode 100644 index 00000000..dc52c359 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/command.sgml @@ -0,0 +1,66 @@ + + + + + コマンドメール (fml をメールで操作する) + + + +fml にメールで文字列(コマンド)を送り込むことで、fml に特定の処理をして +もらうことができます。例えば、メンバーの登録、削除や、過去の記事を取り +寄せるなどの処理です。 + + + + +fml 5.0 では + +メールによるコマンド処理 +makefml によるコマンド処理 +CGI でのコマンド処理 + +これらすべての機能が FML::Command:: クラスのモジュールを使うように +設計されています。 + + + + + + 処理の流れ + + + +elena MLの場合、 +コマンドメールを elena-ctl@fml.org に送信してください。 +メールは MTA が受け、最終的に MTA は +/usr/local/libexec/fml/fml.pl --ctladdr +(もしくは /usr/local/libexec/fml/command ) +というコマンドを実行します。 +fml.pl はメールを標準入力から受けとり、 +MLとして必要な処理をした後、MTA へ配送を委ねます。 + + + + +4.0 と違い、5.0 ではコマンドの結果を + +一通のメール ( MIME/Multipart )にまとめて返送 + +しています。 + + + + + + + +§.command.module; + + +§.command.extension; + +§.command.internal; + + diff --git a/fml/doc/ja/tutorial/usage/fmlconf.sgml b/fml/doc/ja/tutorial/usage/fmlconf.sgml new file mode 100644 index 00000000..eda23ec0 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/fmlconf.sgml @@ -0,0 +1,21 @@ + + + + + 設定を表示する (fmlconf) + + +fmlconf (/usr/local/bin/fmlconf) +は引数にML名をとり、そのMLの変数一覧を表示します。 +-n をつけるとデフォルトと異なる変数のみを表示します。 + + +% fmlconf elena +% fmlconf -n elena + + + + + diff --git a/fml/doc/ja/tutorial/usage/fmldoc.sgml b/fml/doc/ja/tutorial/usage/fmldoc.sgml new file mode 100644 index 00000000..302fbef2 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/fmldoc.sgml @@ -0,0 +1,22 @@ + + + + + モジュールのドキュメントを表示する (fmldoc) + + +fmldoc の使い方は perldoc と同様です。 +fml の任意のモジュールに対し、そのドキュメントを表示します。 +実のところ perldoc への wrapper です。 + + + +例えば、FML::Process::Kernel のドキュメントが見たい場合、 + +% fmldoc FML::Process::Kernel + + + + diff --git a/fml/doc/ja/tutorial/usage/fmlhtmlify.sgml b/fml/doc/ja/tutorial/usage/fmlhtmlify.sgml new file mode 100644 index 00000000..fe5bcdef --- /dev/null +++ b/fml/doc/ja/tutorial/usage/fmlhtmlify.sgml @@ -0,0 +1,16 @@ + + + + + 記事を HTML 化する (fmlhtmlify) + + + +% fmlhtmlify ML名 + + + + + diff --git a/fml/doc/ja/tutorial/usage/fmlthread.sgml b/fml/doc/ja/tutorial/usage/fmlthread.sgml new file mode 100644 index 00000000..0421b84f --- /dev/null +++ b/fml/doc/ja/tutorial/usage/fmlthread.sgml @@ -0,0 +1,25 @@ + + + + + スレッドを表示する (fmlthread) + + +fmlthread は引数にコマンドとML名をとります。 +疑似チケットシステムへのインターフェイスです。 + +close されていないチケット一覧を表示 + +% fmlthread list elena + + +チケットを close する。 + +% fmlthread close elena チケット番号 + + + + + diff --git a/fml/doc/ja/tutorial/usage/makefml.sgml b/fml/doc/ja/tutorial/usage/makefml.sgml new file mode 100644 index 00000000..aa5e2c55 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/makefml.sgml @@ -0,0 +1,69 @@ + + + + + makefml を使って、ユーザの登録/削除他(あらゆる:) + + +makefml の基本的な使い方は fml 4.0 の makefml と同様です。 +というより、できるだけ互換性を保つように構築する予定です。 + + + +現状 makefml に命令を与えると admin コマンドと同じ動作をするようになっ +ています。 +つまり特権的な動作ということです。 +例えば、メンバーの登録に confirmation は必要ありません。 + + + +現在使えるコマンドは以下のものです。 + + + + メンバーの登録 + ( + subscribe + add + ) + + + + + + メンバーの削除 + ( + bye + remove + resign + signoff + unsubscribe + ) + + + + + + MLの作成 + ( + newml + ) + + + + + + ファイルを送り返す + ( + get + mget + ) + + + + + + + diff --git a/fml/doc/ja/tutorial/usage/onhost.sgml b/fml/doc/ja/tutorial/usage/onhost.sgml new file mode 100644 index 00000000..fe6e9d20 --- /dev/null +++ b/fml/doc/ja/tutorial/usage/onhost.sgml @@ -0,0 +1,46 @@ + + + + + ML管理者にできること (MLサーバのホスト上) + + + + + + ホスト上でできること + + + +MLサーバのホストに入ることができる(例: slogin してシェルが取れる) +人は、通常MLにとって最強の人を意味します。 + + + +ファイルを直接編集することで、どんなことでもできるわけですから、 +無敵です。 + + + +しかしながら、人間間違いを犯すもので、ついフォーマットを +間違えるといったことがあります。 + + + +そのため、通常は makefml ( /usr/local/bin/makefml )を +使うことで、fml を操作して下さい。 + + + + + +§.usage.makefml; +§.usage.fmlconf; +§.usage.fmldoc; +§.usage.fmlthread; +§.usage.fmlhtmlify; + + + diff --git a/fml/doc/ja/tutorial/usage/post.sgml b/fml/doc/ja/tutorial/usage/post.sgml index 4783a1f7..c5b784df 100644 --- a/fml/doc/ja/tutorial/usage/post.sgml +++ b/fml/doc/ja/tutorial/usage/post.sgml @@ -1,5 +1,5 @@ @@ -20,7 +20,7 @@ fml.pl - MLとして処理するべきこと + fml.pl が MLとして処理するべきこと @@ -29,7 +29,7 @@ subject Subject: [elena:00100] えれなさん素敵 - (デフォルトではつけません) +(デフォルトではつけません) @@ -54,7 +54,7 @@ Subject: [elena:00100] - 備考: ブートしていく様子 + 解説: ブートしていく様子 -- cgit v1.2.1