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/book.sgml | 22 +-- fml/doc/ja/tutorial/command/chapter.sgml | 117 ------------ fml/doc/ja/tutorial/command/extension.sgml | 4 +- fml/doc/ja/tutorial/command/internal.sgml | 6 +- fml/doc/ja/tutorial/command/module.sgml | 93 ++++++++++ fml/doc/ja/tutorial/delivery/reply.sgml | 113 ------------ fml/doc/ja/tutorial/include/chapters.ent | 64 +++---- fml/doc/ja/tutorial/internals/message.sgml | 108 ----------- fml/doc/ja/tutorial/internals/nativelanguage.sgml | 54 ------ fml/doc/ja/tutorial/message/chapter.sgml | 108 +++++++++++ fml/doc/ja/tutorial/message/reply.sgml | 113 ++++++++++++ fml/doc/ja/tutorial/module/IO::Adapter.sgml | 4 +- fml/doc/ja/tutorial/module/nativelanguage.sgml | 54 ++++++ fml/doc/ja/tutorial/overview/available.sgml | 209 ---------------------- fml/doc/ja/tutorial/overview/chapter.sgml | 4 +- fml/doc/ja/tutorial/preface.sgml | 10 +- fml/doc/ja/tutorial/programs/chapter.sgml | 14 -- fml/doc/ja/tutorial/programs/fmlconf.sgml | 21 --- fml/doc/ja/tutorial/programs/fmldoc.sgml | 20 --- fml/doc/ja/tutorial/programs/fmlticket.sgml | 27 --- fml/doc/ja/tutorial/programs/makefml.sgml | 74 -------- 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 +- 30 files changed, 898 insertions(+), 823 deletions(-) delete mode 100644 fml/doc/ja/tutorial/command/chapter.sgml create mode 100644 fml/doc/ja/tutorial/command/module.sgml delete mode 100644 fml/doc/ja/tutorial/delivery/reply.sgml delete mode 100644 fml/doc/ja/tutorial/internals/message.sgml delete mode 100644 fml/doc/ja/tutorial/internals/nativelanguage.sgml create mode 100644 fml/doc/ja/tutorial/message/chapter.sgml create mode 100644 fml/doc/ja/tutorial/message/reply.sgml create mode 100644 fml/doc/ja/tutorial/module/nativelanguage.sgml delete mode 100644 fml/doc/ja/tutorial/overview/available.sgml delete mode 100644 fml/doc/ja/tutorial/programs/chapter.sgml delete mode 100644 fml/doc/ja/tutorial/programs/fmlconf.sgml delete mode 100644 fml/doc/ja/tutorial/programs/fmldoc.sgml delete mode 100644 fml/doc/ja/tutorial/programs/fmlticket.sgml delete mode 100644 fml/doc/ja/tutorial/programs/makefml.sgml 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') diff --git a/fml/doc/ja/tutorial/book.sgml b/fml/doc/ja/tutorial/book.sgml index 5a185964..ce2943f4 100644 --- a/fml/doc/ja/tutorial/book.sgml +++ b/fml/doc/ja/tutorial/book.sgml @@ -2,7 +2,7 @@ This is an sgml using DocBook dtd. Use sgmltools version 2.0.x or above to generate various output formats. -$FML: book.sgml,v 1.19 2001/11/19 14:55:15 fukachan Exp $ +$FML: book.sgml,v 1.20 2001/11/23 15:00:46 fukachan Exp $ --> - - 各論およびカスタマイズ @@ -54,8 +49,12 @@ $FML: book.sgml,v 1.19 2001/11/19 14:55:15 fukachan Exp $ - &chapter.available; - &chapter.programs; + &chapter.usage.post; + &chapter.usage.command; + &chapter.usage.onhost; + + + &chapter.threadtrack.usage; @@ -84,10 +83,6 @@ $FML: book.sgml,v 1.19 2001/11/19 14:55:15 fukachan Exp $ &chapter.delivery; &chapter.replybyfml; - &chapter.fmlcommand; - - - &chapter.threadtrack.usage; @@ -101,11 +96,12 @@ $FML: book.sgml,v 1.19 2001/11/19 14:55:15 fukachan Exp $ &chapter.module.io.adapter; &chapter.module.mail.message; + &chapter.module.nl; 付録 diff --git a/fml/doc/ja/tutorial/command/chapter.sgml b/fml/doc/ja/tutorial/command/chapter.sgml deleted file mode 100644 index 41e161f4..00000000 --- a/fml/doc/ja/tutorial/command/chapter.sgml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - コマンド: fml をメールで操作する - - - -fml にメールで文字列(コマンド)を送り込むことで、fml に特定の処理をして -もらうことができます。例えば、メンバーの登録、削除や、過去の記事を取り -寄せるなどの処理です。 - - - -fml 5.0 では - -メールによるコマンド処理 -makefml によるコマンド処理 -CGI でのコマンド処理 - -これらすべての機能が FML::Command:: クラスのモジュールを使うように -設計されています。 - - - - - - FML::Command クラス以下の構成 - - - -FML::Command:: クラスは以下のような構成になっています。 - -FML::Command.pm FML::Command クラス以下への入口 -FML::Command::ACL ACL -FML::Command::Utils よもやまの定義 -FML::Command::User ユーザ用コマンド群 -FML::Command::Admin ユーザ用コマンド群 - -例えば、(メールでの)ユーザ用のコマンドの場合 -FML::Command.pm を経由して -FML::Command::User::コマンド.pm -モジュールを使うことになります。 - - - - (メールでの)一般ユーザ用コマンド - -FML::Process::Command.pm から -FML::Command.pm 経由で -FML::Command::User::コマンド.pm -を用います。 - - - -最終的に -FML::Command::Admin::コマンド.pm -を使うモジュールもあります。 -例えば登録と削除の実作業は -FML::Command::Admin::コマンド.pm -が行なっています。この場合 -FML::Command::User::コマンド.pm -のコマンドは confirm を行なうための wrapper です。 - - - - - (メールでの) adminコマンド - - -FML::Process::Command.pm から -FML::Command.pm 経由で -FML::Command::Admin::コマンド.pm -を用います。 - - - - - - makefml のコマンド - - -FML::Process::Configure.pm から -FML::Command.pm 経由で -FML::Command::Admin::コマンド.pm -を用います。 - - - - - - CGI （予定） - - -FML::Process::CGI.pm から -FML::Command.pm 経由で -FML::Command::Admin::コマンド.pm -を用います（予定）。 - - - - - - - - - -§.command.internal; - - - -§.command.extension; - - - diff --git a/fml/doc/ja/tutorial/command/extension.sgml b/fml/doc/ja/tutorial/command/extension.sgml index 7a287745..a3331249 100644 --- a/fml/doc/ja/tutorial/command/extension.sgml +++ b/fml/doc/ja/tutorial/command/extension.sgml @@ -1,10 +1,10 @@ - コマンドの拡張の仕方の例 + コマンドの拡張の仕方 (予定) diff --git a/fml/doc/ja/tutorial/command/internal.sgml b/fml/doc/ja/tutorial/command/internal.sgml index 0bfa8974..7cccd856 100644 --- a/fml/doc/ja/tutorial/command/internal.sgml +++ b/fml/doc/ja/tutorial/command/internal.sgml @@ -1,10 +1,10 @@ - + - コマンド処理の概要: + 議論: 『4.0 と 5.0 のコードの書き方はどのくらい違うか？』 diff --git a/fml/doc/ja/tutorial/command/module.sgml b/fml/doc/ja/tutorial/command/module.sgml new file mode 100644 index 00000000..fd0fdd24 --- /dev/null +++ b/fml/doc/ja/tutorial/command/module.sgml @@ -0,0 +1,93 @@ + + + + + + コマンドが使うモジュール + + + +5.0 では、 +コマンドメール、makefml そして CGI が使うモジュール +は共有されています。 +ただし、その権限の差異によって、 +ユーザ用のモジュールと管理者用のモジュールの2つに分かれています。 +以下、これらのモジュール群の構成について解説します。 + + + +FML::Command:: クラスは以下のような構成になっています。 + +FML::Command.pm FML::Command クラス以下への入口 +FML::Command::ACL ACL +FML::Command::Utils よもやまの定義 +FML::Command::User ユーザ用コマンド群 +FML::Command::Admin 管理者用コマンド群 + +例えば、(メールでの)ユーザ用のコマンドの場合 +FML::Command.pm を経由して +FML::Command::User::コマンド.pm +モジュールを使うことになります。 + + + + (メールでの)一般ユーザ用コマンド + +FML::Process::Command.pm から +FML::Command.pm 経由で +FML::Command::User::コマンド.pm +を用います。 + + + +最終的に +FML::Command::Admin::コマンド.pm +を使うモジュールもあります。 +例えば登録と削除の実作業は +FML::Command::Admin::コマンド.pm +が行なっています。この場合 +FML::Command::User::コマンド.pm +のコマンドは confirm を行なうための wrapper です。 + + + + + (メールでの) adminコマンド + + +FML::Process::Command.pm から +FML::Command.pm 経由で +FML::Command::Admin::コマンド.pm +を用います。 + + + + + + makefml のコマンド + + +FML::Process::Configure.pm から +FML::Command.pm 経由で +FML::Command::Admin::コマンド.pm +を用います。 + + + + + + CGI （予定） + + +FML::Process::CGI.pm から +FML::Command.pm 経由で +FML::Command::Admin::コマンド.pm +を用います（予定）。 + + + + + + diff --git a/fml/doc/ja/tutorial/delivery/reply.sgml b/fml/doc/ja/tutorial/delivery/reply.sgml deleted file mode 100644 index 697d6b19..00000000 --- a/fml/doc/ja/tutorial/delivery/reply.sgml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - fml からメールで返事を送り返す - - - - 概要 - - -送り返すべきメールは -Mail::Delivery::Queue -を使い queue に入れます。 -queue に入ったメールは、のちに -FML::Process::QueueManager -クラスが(配送)処理をします。 -FML::Process::QueueManager により -queue ファイルが queue ディレクトリから pickup され、 -Mail::Message で parse され、 -FML::Mailer 経由で -Mail::Delivery が実際にメール配送処理をします。 - -Mail::Delivery::Queue - ↓ - ↓→→→ キューディレクトリ - ↓ -FML::Process::QueueManager - ↓ - ↓←←← キューディレクトリ - ↓ -FML::Mailer - ↓ -Mail::Delivery - - - - - - - queue ディレクトリ - - -queue ディレクトリは複数のディレクトリからなります。 - -new/ -active/ -deferred/ -info/sender/ -info/recipients/ - -info/ には envelope 情報が格納されます。 - - - -queue ファイルを作る時は、一旦 new/ に作成されます。 -queue ファイルを作る作業が終了し、配送準備 OK となったら -new/ から active/ に移動されます。 -つまり active/ にあるファイルは配送準備ができているものです。 - - - - queue ディレクトリをロックする - -特定の $queue_id object ごとに lock() と unlock() メソッドを使い、 -ロックをかけます。 -ロックは active/$queue_id ファイルに対しての flock(2) システムコールです。 - - - - - - - - - fml の中でどうするか？ - - - -あるメッセージを送り返したい場合は、次のようにします。 - -$curproc->reply_message( "you are not a ML member." ); - -この場合の受信者はコマンドの結果などを受けとる人、 -fml にリクエストをした人です。 - - - - -ファイルを送りたい場合や画像を送りたい場合は次のようにします。 - -$curproc->reply_message( { - type => "text/plain; charset=iso-2022-jp", - path => "/etc/fml/main.cf", - filename => "main.cf", - disposition => "main.cf example", - }); - -$curproc->reply_message( { - type => "image/gif", - path => "/some/where/logo001.gif", - filename => "logo.gif", - disposition => "attachment", - }); - - - - - - - diff --git a/fml/doc/ja/tutorial/include/chapters.ent b/fml/doc/ja/tutorial/include/chapters.ent index 41a1a8cc..9c0cd625 100644 --- a/fml/doc/ja/tutorial/include/chapters.ent +++ b/fml/doc/ja/tutorial/include/chapters.ent @@ -1,5 +1,5 @@ @@ -21,27 +21,36 @@ - - - - - + + + + + + + + + + + + + + + - - - + + + - - + + - - + @@ -50,38 +59,31 @@ - - + + + + + - - - - + + + + - - - - - - - - - - - - + + diff --git a/fml/doc/ja/tutorial/internals/message.sgml b/fml/doc/ja/tutorial/internals/message.sgml deleted file mode 100644 index 495c9c3d..00000000 --- a/fml/doc/ja/tutorial/internals/message.sgml +++ /dev/null @@ -1,108 +0,0 @@ - - - - メールの操作 - - -メール(オブジェクト)を扱う関数の詳細については - -Mail::Message クラス - -を見て下さい。 -このクラスが基本的な操作法を提供しています。 -Mail::Bounce や Mail::Delivery を始め、 -あらゆる関数がこのクラスに依存しています。 - - - - - - Mail::Message クラス - - -メールはヘッダに始まりボディ(メール本文)が続きます。 -multipart のように、 -ボディは複数の部分(パート)から成ることもあります。 - - - -メールの配送処理だけを考えると、 -メール本文の細部の構造を気にする必要はありません。 -一方、フィルタリングを始めとして、メール本文の解析を -必要としている処理は多々あります。 - - - -それらのモジュールのために - -Mail::Message クラス - -があり、 -メールの構造を表現するために用いられています。 -このクラスは -Mail::Bounce や Mail::Delivery を始め、 -いたるところで使われています。 - - - -例えば、このような使い方をします。 - - my $fh = new FileHandle $file; - my $msg = Mail::Message->parse( { fd => $fh } ); - - use FML::Mailer; - my $obj = new FML::Mailer; - $obj->send( { - sender => $sender, - recipient => $rcpt, - message => $msg, - }); - - - - - - - - - Mail::Message::Parse クラス - - -ダミーの派生クラスです。 -これは Mail::Message::Compose と同様の階層を便宜上作っています。 -あまり深い意味はありません。 - - - -パーサの実体は - - Mail::Message - -クラスの中にあります。 - - - - - - - - Mail::Message::Compose クラス - - -これはメールを構築する際に用いるクラスですが、単なるアダプタです。 -メールを作成する実体は -CPAN の MIME::Lite クラスです。 -作成のリクエストは -MIME::Lite クラスへ -丸投げされています。 - - - -使い方やメソッドについての詳細は MIME::Lite クラスを参照して下さい。 - - - - - diff --git a/fml/doc/ja/tutorial/internals/nativelanguage.sgml b/fml/doc/ja/tutorial/internals/nativelanguage.sgml deleted file mode 100644 index dbaf3a63..00000000 --- a/fml/doc/ja/tutorial/internals/nativelanguage.sgml +++ /dev/null @@ -1,54 +0,0 @@ - - - - 言語別の処理関数 - - - -fml 内部では言語に依存した変換処理が必要です。 -例えば、JIS と EUC の相互変換は随所で必要です。 -これはメールでは JIS が使われますが、 -プログラムでは EUC の方が扱いやすいためです。 - - - -コマンドの返事の言語依存性については - -『メッセージの他国語化』 - -の章を参照して下さい。 - - - - - - 何か::Language:: - - - -クラス名は -なにか::Language:: -もしくは -Language:: -などとなります。 -これらの階層以下に言語依存モジュール群は配置されます。 - - - -例えば以下のようなモジュールがあります。 - -FML::Language::Japanese::String.pm -Mail::Bounce::Language::Japanese.pm - -前者は、FML モジュール群のために日本語依存の文字列処理関数を -提供しています。 -後者は Mail::Bounce 階層以下のモジュールに対して、 -日本語に依存したエラーメール解析ルーチンを提供しています。 - - - - - - diff --git a/fml/doc/ja/tutorial/message/chapter.sgml b/fml/doc/ja/tutorial/message/chapter.sgml new file mode 100644 index 00000000..86de2a7a --- /dev/null +++ b/fml/doc/ja/tutorial/message/chapter.sgml @@ -0,0 +1,108 @@ + + + + メッセージ(メール)の操作 + + +メール(オブジェクト)を扱う関数の詳細については + +Mail::Message クラス + +を見て下さい。 +このクラスが基本的な操作法を提供しています。 +Mail::Bounce や Mail::Delivery を始め、 +あらゆる関数がこのクラスに依存しています。 + + + + + + Mail::Message クラス + + +メールはヘッダに始まりボディ(メール本文)が続きます。 +multipart のように、 +ボディは複数の部分(パート)から成ることもあります。 + + + +メールの配送処理だけを考えると、 +メール本文の細部の構造を気にする必要はありません。 +一方、フィルタリングを始めとして、メール本文の解析を +必要としている処理は多々あります。 + + + +それらのモジュールのために + +Mail::Message クラス + +があり、 +メールの構造を表現するために用いられています。 +このクラスは +Mail::Bounce や Mail::Delivery を始め、 +いたるところで使われています。 + + + +例えば、このような使い方をします。 + + my $fh = new FileHandle $file; + my $msg = Mail::Message->parse( { fd => $fh } ); + + use FML::Mailer; + my $obj = new FML::Mailer; + $obj->send( { + sender => $sender, + recipient => $rcpt, + message => $msg, + }); + + + + + + + + + Mail::Message::Parse クラス + + +ダミーの派生クラスです。 +これは Mail::Message::Compose と同様の階層を便宜上作っています。 +あまり深い意味はありません。 + + + +パーサの実体は + + Mail::Message + +クラスの中にあります。 + + + + + + + + Mail::Message::Compose クラス + + +これはメールを構築する際に用いるクラスですが、単なるアダプタです。 +メールを作成する実体は +CPAN の MIME::Lite クラスです。 +作成のリクエストは +MIME::Lite クラスへ +丸投げされています。 + + + +使い方やメソッドについての詳細は MIME::Lite クラスを参照して下さい。 + + + + + diff --git a/fml/doc/ja/tutorial/message/reply.sgml b/fml/doc/ja/tutorial/message/reply.sgml new file mode 100644 index 00000000..5bfd8611 --- /dev/null +++ b/fml/doc/ja/tutorial/message/reply.sgml @@ -0,0 +1,113 @@ + + + + + fml からメールで返事を送り返す + + + + 概要 + + +送り返すべきメールは +Mail::Delivery::Queue +を使い queue に入れます。 +queue に入ったメールは、のちに +FML::Process::QueueManager +クラスが(配送)処理をします。 +FML::Process::QueueManager により +queue ファイルが queue ディレクトリから pickup され、 +Mail::Message で parse され、 +FML::Mailer 経由で +Mail::Delivery が実際にメール配送処理をします。 + +Mail::Delivery::Queue + ↓ + ↓→→→ キューディレクトリ + ↓ +FML::Process::QueueManager + ↓ + ↓←←← キューディレクトリ + ↓ +FML::Mailer + ↓ +Mail::Delivery + + + + + + + queue ディレクトリ + + +queue ディレクトリは複数のディレクトリからなります。 + +new/ +active/ +deferred/ +info/sender/ +info/recipients/ + +info/ には envelope 情報が格納されます。 + + + +queue ファイルを作る時は、一旦 new/ に作成されます。 +queue ファイルを作る作業が終了し、配送準備 OK となったら +new/ から active/ に移動されます。 +つまり active/ にあるファイルは配送準備ができているものです。 + + + + queue ディレクトリをロックする + +特定の $queue_id object ごとに lock() と unlock() メソッドを使い、 +ロックをかけます。 +ロックは active/$queue_id ファイルに対しての flock(2) システムコールです。 + + + + + + + + + fml の中でどうするか？ + + + +あるメッセージを送り返したい場合は、次のようにします。 + +$curproc->reply_message( "you are not a ML member." ); + +この場合の受信者はコマンドの結果などを受けとる人、 +fml にリクエストをした人です。 + + + + +ファイルを送りたい場合や画像を送りたい場合は次のようにします。 + +$curproc->reply_message( { + type => "text/plain; charset=iso-2022-jp", + path => "/etc/fml/main.cf", + filename => "main.cf", + disposition => "main.cf example", + }); + +$curproc->reply_message( { + type => "image/gif", + path => "/some/where/logo001.gif", + filename => "logo.gif", + disposition => "attachment", + }); + + + + + + + diff --git a/fml/doc/ja/tutorial/module/IO::Adapter.sgml b/fml/doc/ja/tutorial/module/IO::Adapter.sgml index afa03c9d..489739d1 100644 --- a/fml/doc/ja/tutorial/module/IO::Adapter.sgml +++ b/fml/doc/ja/tutorial/module/IO::Adapter.sgml @@ -1,8 +1,8 @@ - + IO::Adapter diff --git a/fml/doc/ja/tutorial/module/nativelanguage.sgml b/fml/doc/ja/tutorial/module/nativelanguage.sgml new file mode 100644 index 00000000..fddd7ff5 --- /dev/null +++ b/fml/doc/ja/tutorial/module/nativelanguage.sgml @@ -0,0 +1,54 @@ + + + + 言語別の処理関数 + + + +fml 内部では言語に依存した変換処理が必要です。 +例えば、JIS と EUC の相互変換は随所で必要です。 +これはメールでは JIS が使われますが、 +プログラムでは EUC の方が扱いやすいためです。 + + + +コマンドの返事の言語依存性については + +『メッセージの他国語化』 + +の章を参照して下さい。 + + + + + + 何か::Language:: + + + +クラス名は +なにか::Language:: +もしくは +Language:: +などとなります。 +これらの階層以下に言語依存モジュール群は配置されます。 + + + +例えば以下のようなモジュールがあります。 + +FML::Language::Japanese::String.pm +Mail::Bounce::Language::Japanese.pm + +前者は、FML モジュール群のために日本語依存の文字列処理関数を +提供しています。 +後者は Mail::Bounce 階層以下のモジュールに対して、 +日本語に依存したエラーメール解析ルーチンを提供しています。 + + + + + + diff --git a/fml/doc/ja/tutorial/overview/available.sgml b/fml/doc/ja/tutorial/overview/available.sgml deleted file mode 100644 index 9cb3d56f..00000000 --- a/fml/doc/ja/tutorial/overview/available.sgml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - 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 - - - -登録と削除関係、および最低限のＭＬの作成だけは動きます -(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/overview/chapter.sgml b/fml/doc/ja/tutorial/overview/chapter.sgml index 2b3bdaf4..1f059e76 100644 --- a/fml/doc/ja/tutorial/overview/chapter.sgml +++ b/fml/doc/ja/tutorial/overview/chapter.sgml @@ -1,5 +1,5 @@ @@ -51,9 +51,7 @@ (デフォルトでは)インストーラは /usr/local/bin に - fmldoc fmlconf fmlthread makefml fmlhtmlify fmlsch - などをインストールします。 diff --git a/fml/doc/ja/tutorial/preface.sgml b/fml/doc/ja/tutorial/preface.sgml index 48d99208..f9d1db9a 100644 --- a/fml/doc/ja/tutorial/preface.sgml +++ b/fml/doc/ja/tutorial/preface.sgml @@ -1,5 +1,5 @@ @@ -267,7 +267,7 @@ fml 5.0 - + 抽象化 IO 層 メンバーファイルをファイル、/etc/group, NIS, MySQL @@ -275,12 +275,6 @@ fml 5.0 - -詳細は - -『&fml5; の実行形式プログラム』の章 - -を参照して下さい。 diff --git a/fml/doc/ja/tutorial/programs/chapter.sgml b/fml/doc/ja/tutorial/programs/chapter.sgml deleted file mode 100644 index ea5a6535..00000000 --- a/fml/doc/ja/tutorial/programs/chapter.sgml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - プログラム - -§.fmlconf; -§.fmldoc; - -§.makefml; - - diff --git a/fml/doc/ja/tutorial/programs/fmlconf.sgml b/fml/doc/ja/tutorial/programs/fmlconf.sgml deleted file mode 100644 index 72b57200..00000000 --- a/fml/doc/ja/tutorial/programs/fmlconf.sgml +++ /dev/null @@ -1,21 +0,0 @@ - - - - - fmlconf (/usr/local/bin/fmlconf) - - - -fmlconf は引数にＭＬ名をとり、そのＭＬの変数一覧を表示します。 --n をつけるとデフォルトと異なる変数のみを表示します。 - - -% fmlconf elena -% fmlconf -n elena - - - - - diff --git a/fml/doc/ja/tutorial/programs/fmldoc.sgml b/fml/doc/ja/tutorial/programs/fmldoc.sgml deleted file mode 100644 index 3586ab1a..00000000 --- a/fml/doc/ja/tutorial/programs/fmldoc.sgml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - fmldoc (/usr/local/bin/fmldoc) - - -fmldoc の使い方は perldoc と同様です。fml の任意のモジュールに対しその -ドキュメントを表示します。 -実のところ perldoc への wrapper です。 - - -% fmldoc FML::Process::Kernel - - - - - diff --git a/fml/doc/ja/tutorial/programs/fmlticket.sgml b/fml/doc/ja/tutorial/programs/fmlticket.sgml deleted file mode 100644 index 1a26f682..00000000 --- a/fml/doc/ja/tutorial/programs/fmlticket.sgml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - fmlticket (/usr/local/bin/fmlticket) - - - -fmlticket は引数にコマンドとＭＬ名をとります。 -チケットシステムへのインターフェイスです。 -まだ製作途中です。 - -close されていないチケット一覧を表示 - -% fmlticket list elena - - -チケットを close する。 - -% fmlticket close elena チケット番号 - - - - - diff --git a/fml/doc/ja/tutorial/programs/makefml.sgml b/fml/doc/ja/tutorial/programs/makefml.sgml deleted file mode 100644 index 46b18f87..00000000 --- a/fml/doc/ja/tutorial/programs/makefml.sgml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - makefml (/usr/local/bin/makefml) - - -makefml の基本的な使い方は fml 4.0 の makefml と同様です。 -というより、できるだけ互換性を保つように構築する予定です。 - - - -現状 makefml に命令を与えると admin コマンドと同じ動作をするようになっ -ています。 -つまり特権的な動作ということです。 -例えば、メンバーの登録に confirmation は必要ありません。 - - - -現在使えるコマンドは以下のものです。 - - - - メンバーの登録 - ( - subscribe - add - ) - - - - - - メンバーの削除 - ( - bye - remove - resign - signoff - unsubscribe - ) - - - - - - ＭＬの作成 - ( - newml - ) - - - - - - ファイルを送り返す - ( - get - mget - ) - - - - -コマンドについては詳しくは - -コマンド - -の章を参照して下さい。 - - - 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 + + + +登録と削除関係、および最低限のＭＬの作成だけは動きます +(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 ＭＬの場合、 +コマンドメールを elena-ctl@fml.org に送信してください。 +メールは MTA が受け、最終的に MTA は +/usr/local/libexec/fml/fml.pl --ctladdr +(もしくは /usr/local/libexec/fml/command ) +というコマンドを実行します。 +fml.pl はメールを標準入力から受けとり、 +ＭＬとして必要な処理をした後、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) +は引数にＭＬ名をとり、そのＭＬの変数一覧を表示します。 +-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 ＭＬ名 + + + + + 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 は引数にコマンドとＭＬ名をとります。 +疑似チケットシステムへのインターフェイスです。 + +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 + ) + + + + + + ＭＬの作成 + ( + 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 @@ + + + + + ＭＬ管理者にできること (ＭＬサーバのホスト上) + + + + + + ホスト上でできること + + + +ＭＬサーバのホストに入ることができる(例: slogin してシェルが取れる) +人は、通常ＭＬにとって最強の人を意味します。 + + + +ファイルを直接編集することで、どんなことでもできるわけですから、 +無敵です。 + + + +しかしながら、人間間違いを犯すもので、ついフォーマットを +間違えるといったことがあります。 + + + +そのため、通常は 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 - ＭＬとして処理するべきこと + fml.pl が ＭＬとして処理するべきこと @@ -29,7 +29,7 @@ subject Subject: [elena:00100] えれなさん素敵 - (デフォルトではつけません) +(デフォルトではつけません) @@ -54,7 +54,7 @@ Subject: [elena:00100] - 備考: ブートしていく様子 + 解説: ブートしていく様子 -- cgit v1.2.1