diff options
| author | fukachan <fukachan> | 2002-07-06 14:55:14 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2002-07-06 14:55:14 +0000 |
| commit | fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c (patch) | |
| tree | dc5434385deac2555f0bef29b4c71eee069edd18 /fml | |
| parent | 0fef7ae28f858bb5ac669b5c5b4657b3e9063b77 (diff) | |
| download | fml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.tar.gz fml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.tar.bz2 fml8-fdcca16caee1f2d98f4519fe9bdaf8e079ba2f4c.zip | |
clean up/update
Diffstat (limited to 'fml')
35 files changed, 452 insertions, 373 deletions
diff --git a/fml/doc/ja/tutorial/book.sgml b/fml/doc/ja/tutorial/book.sgml index 7749e77f..04315429 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.37 2002/07/05 03:11:10 fukachan Exp $ +$FML: book.sgml,v 1.38 2002/07/05 04:01:35 fukachan Exp $ --> <!doctype book public "-//FML//DTD DocBook V3.1-Based Extension//EN" [ @@ -93,6 +93,7 @@ $FML: book.sgml,v 1.37 2002/07/05 03:11:10 fukachan Exp $ </para> </partintro> + </part> @@ -106,7 +107,6 @@ $FML: book.sgml,v 1.37 2002/07/05 03:11:10 fukachan Exp $ &chapter.design; &chapter.programingstyle; - &chapter.policy; </part> @@ -173,7 +173,6 @@ $FML: book.sgml,v 1.37 2002/07/05 03:11:10 fukachan Exp $ &chapter.glossary; &chapter.cvstree; - &chapter.cvstags; &chapter.docbook; &chapter.inet6; diff --git a/fml/doc/ja/tutorial/delivery/chapter.sgml b/fml/doc/ja/tutorial/delivery/chapter.sgml index a7f7f041..4b3ab628 100644 --- a/fml/doc/ja/tutorial/delivery/chapter.sgml +++ b/fml/doc/ja/tutorial/delivery/chapter.sgml @@ -1,5 +1,5 @@ <!-- - $FML: chapter.sgml,v 1.6 2002/04/01 23:41:01 fukachan Exp $ + $FML: chapter.sgml,v 1.7 2002/07/02 10:39:31 fukachan Exp $ --> <chapter id="delivery"> @@ -85,4 +85,8 @@ Mail::Message </sect1> + +<!-- mail queue --> +§.mailqueue; + </chapter> diff --git a/fml/doc/ja/tutorial/message/reply.sgml b/fml/doc/ja/tutorial/delivery/queue.sgml index e092c9f8..d7e3a771 100644 --- a/fml/doc/ja/tutorial/message/reply.sgml +++ b/fml/doc/ja/tutorial/delivery/queue.sgml @@ -1,15 +1,12 @@ <!-- - $FML: reply.sgml,v 1.1 2001/11/24 03:22:55 fukachan Exp $ + $FML: reply.sgml,v 1.2 2002/04/01 23:41:04 fukachan Exp $ --> -<chapter id="message.reply"> +<sect1 id="message.reply"> <TITLE> fml からメールで返事を送り返す </TITLE> -<sect1> - <title> 概要 </title> - <para> 送り返すべきメールは Mail::Delivery::Queue @@ -17,6 +14,53 @@ Mail::Delivery::Queue queue に入ったメールは、のちに FML::Process::QueueManager クラスが(配送)処理をします。 +</para> + + +<sect2> + <title> + fml の中でどうするか？ + </title> + +<para> +あるメッセージを送り返したい場合は、次のようにします。 +<screen> +$curproc->reply_message( "you are not a ML member." ); +</screen> +この場合の受信者はコマンドの結果などを受けとる人、 +fml にリクエストをした人です。 +</para> + + +<para> +ファイルを送りたい場合や画像を送りたい場合は次のようにします。 +<screen> +$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", + }); +</screen> +</para> + +</sect2> +</sect1> + + +<sect1 id="message.queue"> + <TITLE> + mail queue と配送の仕組み + </TITLE> + +<para> FML::Process::QueueManager により queue ファイルが queue ディレクトリから pickup され、 Mail::Message で parse され、 @@ -36,11 +80,14 @@ FML::Mailer Mail::Delivery </screen> </para> + </sect1> <sect1> - <title> queue ディレクトリ </title> + <TITLE> + mail queue ディレクトリ + </TITLE> <para> queue ディレクトリは複数のディレクトリからなります。 @@ -71,43 +118,3 @@ new/ から active/ に移動されます。 </sect2> </sect1> - - -<sect1> - <title> - fml の中でどうするか？ - </title> - -<para> -あるメッセージを送り返したい場合は、次のようにします。 -<screen> -$curproc->reply_message( "you are not a ML member." ); -</screen> -この場合の受信者はコマンドの結果などを受けとる人、 -fml にリクエストをした人です。 -</para> - - -<para> -ファイルを送りたい場合や画像を送りたい場合は次のようにします。 -<screen> -$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", - }); -</screen> -</para> - -</sect1> - - -</chapter> diff --git a/fml/doc/ja/tutorial/devel/create_program.sgml b/fml/doc/ja/tutorial/devel/create_program.sgml index 2dc90832..38c6961c 100644 --- a/fml/doc/ja/tutorial/devel/create_program.sgml +++ b/fml/doc/ja/tutorial/devel/create_program.sgml @@ -1,5 +1,5 @@ <!-- - $FML: create_program.sgml,v 1.3 2002/04/01 23:41:01 fukachan Exp $ + $FML: create_program.sgml,v 1.4 2002/07/02 10:39:31 fukachan Exp $ --> <chapter id="program.create"> @@ -34,7 +34,9 @@ verify_request() run() finish() </screen> -ダミーでもよいので、このメソッドを用意しておいて下さい。 +ダミーでもよいので、これらのメソッドを適宜用意しておいて下さい。 +各メソッドの具体例は、FML::Process を見て下さい。 +メソッドの役割を知るためには最大構成の Distribute が一番適当かも知れません。 </para> <para> @@ -55,16 +57,21 @@ FML::Process::○○○ を用意したら、 FML::Process::Switch を編集します。 -このモジュールは、各プログラムごとに +このモジュールでは、各プログラムごとに 『ロードするモジュール』 『コマンドラインオプション』 『ＭＬ名を必要とするか否か？』 -などを定義してください。 -編集する場所は fmlsch などの文字列を頼りにサーチすると良いでしょう。 +を定義してください。 +編集する場所は以下の private method です。 +<screen> +sub _module_specific_options +sub _ml_name_is_required +sub _module_we_use +</screen> </para> <para> -この 2 つの準備だけで、準備は終りですです。 +この 2 つの準備だけで、新しいプログラムの準備は終りですです。 呼びたい名前のファイルを loader と link もしくは symlink することで 実行が可能になります。 例えば、標準のインストールでは、次のようになっています。 @@ -103,7 +110,7 @@ lrwxr-xr-x 1 root wheel 6 Nov 23 22:10 mead -> loader CGI のプログラムは FML::CGI::○○○ というモジュールです。 -CGI 系列では次のような、オブジェクトの関係にあります。 +CGI 系列では次のような、オブジェクトの関係があります。 <screen> FML::Process::Kernel | @@ -119,9 +126,10 @@ CGI 系列では次のような、オブジェクトの関係にあります。 </para> <para> -CGI のプログラムの書き方も同様です。 -コマンドラインのプログラムと同様に、 -FML::CGI のモジュールを見本にして、 +CGI のプログラムの書き方もコマンドラインプログラムと同様です。 +名前空間で区別するために CGI スクリプトのモジュールは +FML::Process ではなく FML::CGI に配置されています。 +既存の FML::CGI のモジュールを見本にして、 FML::CGI::○○○ を適宜用意して下さい。 </para> @@ -129,7 +137,7 @@ FML::CGI::○○○ <para> FML::CGI::○○○ の注意点は、 -用意するメソッドは +用意するメソッドが <screen> html_start() html_end() @@ -148,13 +156,18 @@ run_cgi_options() </para> <para> +これらは FML::Process::CGI の中の +verify_request() および run() から呼ばれた先のメソッドとなっています。 +</para> + +<para> CGI プロセスは FML::Process::CGI で駆動され、run() メソッドは <screen> $curproc->html_start($args); 画面を作るために run_cgi_xxx() メソッド郡を呼び出す。 $curproc->html_end($args); </screen> -のように FML::CGI:: 以下のメソッド群を呼び出しているからです。 +の順に FML::CGI:: 以下のメソッド群を呼び出しています。 </para> <para> @@ -164,7 +177,8 @@ $curproc->html_end($args); <para> このため、多くの場合 FML::Process::Kernel - のメソッドは呼ばれてはいません。 + のメソッドは CGI::Kernel でオーバロードされており、 + 直接呼ばれることは稀です。 </para> </footnote> からなっています。 diff --git a/fml/doc/ja/tutorial/devel/cvstree.sgml b/fml/doc/ja/tutorial/devel/cvstree.sgml index 220fb338..cf394bf5 100644 --- a/fml/doc/ja/tutorial/devel/cvstree.sgml +++ b/fml/doc/ja/tutorial/devel/cvstree.sgml @@ -1,5 +1,5 @@ <!-- - $FML + $FML$ --> <appendix id="cvs.dirhier"> @@ -15,17 +15,16 @@ </title> <para> -fml-devel の基本方針として、 +&fmldevel; の基本方針として、 使えるもの(例えば CPAN )は片っ端から使います。 -そうしないと保守する項目が増える一方のためです。 +そうしないと自分で保守しないといけない項目が増える一方のためです。 </para> <para> -また、保守する人をはっきり区別するためにベンダーごとにディレクトリを分 -けています。例えば CPAN で保守されているものは CPAN/ ディレクトリ以下 -に入れてください。 -ライセンスなどによっては、 -将来さらに区分を分ける必要が出てくるかも知れません。 +また、保守する人とライセンスをはっきり区別するためにベンダーごとにディ +レクトリを分けています。例えば CPAN で保守されているものは CPAN/ ディ +レクトリ以下に入れてください。ライセンスなどによっては、将来さらに区分 +を分ける必要が出てくるかも知れません。 </para> <para> @@ -158,6 +157,16 @@ CPAN/dist/ はオリジナルを保存する場所なので、変更してはいけません。 <tbody> <row> + <entry> fml/bin/ </entry> + <entry> /usr/local/bin/ にインストールするプログラム </entry> + </row> + + <row> + <entry> fml/doc/ </entry> + <entry> Documentation/ のソース </entry> + </row> + + <row> <entry> fml/etc/ </entry> <entry> 設定変数 </entry> </row> @@ -177,6 +186,19 @@ CPAN/dist/ はオリジナルを保存する場所なので、変更してはいけません。 呼び出すので、正確には wrapper です。 </entry> </row> + + <row> + <entry> fml/share/ </entry> + <entry> メッセージのテンプレートなど </entry> + </row> + + <row> + <entry> fml/utils/ </entry> + <entry> ユーティリティですが、 + これは + fml ソース内で使うだけです。 + </entry> + </row> </tbody> </tgroup> diff --git a/fml/doc/ja/tutorial/devel/docbook.sgml b/fml/doc/ja/tutorial/devel/docbook.sgml index 2c94e345..c2f6c347 100644 --- a/fml/doc/ja/tutorial/devel/docbook.sgml +++ b/fml/doc/ja/tutorial/devel/docbook.sgml @@ -1,5 +1,5 @@ <!-- - $FML: docbook.sgml,v 1.3 2002/04/01 23:41:01 fukachan Exp $ + $FML: docbook.sgml,v 1.4 2002/07/02 10:39:31 fukachan Exp $ --> @@ -19,7 +19,7 @@ fml-devel (&fmldevel;) のドキュメントでは、SGML の DTD は </para> <para> -ここでは、SGML を書くために最小限必要な知識についてメモします。 +本章では、SGML を書くために最小限必要な知識についてメモします。 </para> <para> @@ -31,7 +31,7 @@ fml-devel (&fmldevel;) のドキュメントでは、SGML の DTD は </para> </footnote> ですが、正しい HTML の書き方と同様です。 -本 Appendix で、２、３の典型的な SGML テンプレートをメモしておくので、 +本 Appendix で、2、3 の典型的な SGML テンプレートをメモしておくので、 それらを適当に切り剥ぎしていけばなんとかなるはずです。 </para> @@ -48,7 +48,7 @@ SGML は本や短い文書(記事)を作成するに使います。 HTML のもっと厳密なものだと思って下さい <footnote> <para> - 正確には HTML が SGML の一部です。 + 正確には HTML が SGML の一部にフォーマッタの要素が合体してしまったものです。 HTML の方がはるかに有名になってしまったので、 「HTML のもっと厳密なもの…」といった説明が良くされます :) </para> @@ -385,14 +385,14 @@ include するべき定義ファイルを <para> SGML を HTML などに翻訳するために、いくつかのツールが必要です。 -DTD と DSL の規格文書群は必須です。 -処理系として openjade と opensp +また DTD と DSL の規格文書群も必須です。 +処理系としては openjade と opensp <footnote> <para> opensp は openjade パッケージに含まれています。 </para> </footnote> -も必須のプログラムです。 +が必須のプログラムでしょう。 その他はオプショナルで、各自が好きにすればよいようです。 </para> @@ -420,8 +420,8 @@ DTD と DSL の規格文書群は必須です。 </listitem> </itemizedlist> - -多くの OS では附属のパッケージシステムで一発ポン！てなもんでしょう。 +多くの OS ではこれらのプログラムを附属のパッケージシステムで簡単に +インストールできるでしょう。 </para> <para> @@ -499,7 +499,7 @@ HTML の各ページに URL をつけたいとか、画像をつけたいといった <para> 見栄えは DSL により記述をすることになります。 -しかしながら、DSL は本質的に LISP (List Processre) 言語なので、 +しかしながら、DSL は本質的に LISP (List Processor) 言語なので、 LISP を知らないとちょっと手が出ないでしょう。 </para> diff --git a/fml/doc/ja/tutorial/include/chapters.ent b/fml/doc/ja/tutorial/include/chapters.ent index f94da298..93856324 100644 --- a/fml/doc/ja/tutorial/include/chapters.ent +++ b/fml/doc/ja/tutorial/include/chapters.ent @@ -1,5 +1,5 @@ <!-- - $FML: chapters.ent,v 1.40 2002/07/05 04:01:36 fukachan Exp $ + $FML: chapters.ent,v 1.41 2002/07/06 05:26:09 fukachan Exp $ --> <!entity versin "1.1"> @@ -20,7 +20,7 @@ <!-- メタレベル --> <!entity bookinfo SYSTEM "include/bookinfo.sgml"> <!entity preface SYSTEM "preface.sgml"> -<!entity sect.terms SYSTEM "include/terms.sgml"> +<!entity sect.terms SYSTEM "terms.sgml"> <!-- パート I: introduction 〜 インストール、テストまで --> @@ -77,6 +77,7 @@ <!-- 配送 --> <!entity chapter.delivery SYSTEM "delivery/chapter.sgml"> +<!entity sect.mailqueue SYSTEM "delivery/queue.sgml"> <!-- 内部構造 --> @@ -97,7 +98,6 @@ <!entity chapter.message SYSTEM "message/chapter.sgml"> <!entity sect.message.nl SYSTEM "message/language.sgml"> <!entity sect.message.discuss SYSTEM "message/discussion.sgml"> -<!entity chapter.replybyfml SYSTEM "message/reply.sgml"> <!-- 開発 --> diff --git a/fml/doc/ja/tutorial/install/download.sgml b/fml/doc/ja/tutorial/install/download.sgml index cb072fe2..4878b42b 100644 --- a/fml/doc/ja/tutorial/install/download.sgml +++ b/fml/doc/ja/tutorial/install/download.sgml @@ -1,5 +1,5 @@ <!-- - $FML: download.sgml,v 1.5 2002/07/02 10:39:37 fukachan Exp $ + $FML: download.sgml,v 1.1 2002/07/04 10:58:59 fukachan Exp $ --> <chapter id="download"> @@ -24,6 +24,7 @@ fml-devel のソースは <para> 開発の適当な区切りごとに、不定期に作成されています。 +ファイル名に日付が入っていますので、 日付の新しいものを選んでダウンロードして下さい。 </para> diff --git a/fml/doc/ja/tutorial/install/fml_on_nt.sgml b/fml/doc/ja/tutorial/install/fml_on_nt.sgml index 525836ac..c2d09a3f 100644 --- a/fml/doc/ja/tutorial/install/fml_on_nt.sgml +++ b/fml/doc/ja/tutorial/install/fml_on_nt.sgml @@ -1,15 +1,16 @@ <!-- - $FML: chapter.sgml,v 1.11 2002/04/01 23:41:02 fukachan Exp $ + $FML: fml_on_nt.sgml,v 1.1 2002/07/02 10:39:34 fukachan Exp $ --> <chapter id="install.fml.nt"> <title> - Microsft 2000/NT 上での fml のインストール + Microsft 2000/NT 上での &fmldevel; のインストール </title> <warning> <para> -まだ、できません。 +まだ、&fmldevel; は動きません。ごめんなさい。 +この章はダミー or ごめんっていうためだけにあります。 </para> </warning> diff --git a/fml/doc/ja/tutorial/install/fml_on_unix.sgml b/fml/doc/ja/tutorial/install/fml_on_unix.sgml index e87156d4..47ff7c87 100644 --- a/fml/doc/ja/tutorial/install/fml_on_unix.sgml +++ b/fml/doc/ja/tutorial/install/fml_on_unix.sgml @@ -1,5 +1,5 @@ <!-- - $FML: fml_on_unix.sgml,v 1.1 2002/07/02 10:39:34 fukachan Exp $ + $FML: fml_on_unix.sgml,v 1.2 2002/07/04 10:59:00 fukachan Exp $ --> <chapter id="install.fml.unix"> @@ -30,7 +30,7 @@ configure を実行する(後述)前に、 <!-- ====================================================== --> <sect1 id="install.fml.unix.configure"> <title> - fml のインストール: configure + configure を実行する </title> @@ -207,7 +207,7 @@ Now you must run "make install". <!-- ====================================================== --> <sect1> <title> - 各ディレクトリの役割 + 補足: 各ディレクトリの役割 </title> <para> @@ -310,6 +310,11 @@ configure を実行後、ユーザ root になり、make install を実行して下さい。 configure はユーザ root で実行する必要はありませんが、 make install はユーザ root で実行して下さい。 間違えないように、configure も root で実行しても構いません。 +<screen> +% su root +# ./configure +# make install +</screen> </para> </warning> @@ -336,7 +341,7 @@ configure のオプション指定が正しければ、 <sect1 id="install.fml.unix.edit.site.default.config.cf"> <title> - site_default_config.cf を編集する + site_default_config.cf を編集する (オプショナル) </title> <para> @@ -360,7 +365,7 @@ configure のオプション指定が正しければ、 デフォルトでは見本として:) subject のタグをつけない設定だけが入っています。 <screen> -# $FML: site_default_config.cf.in,v 1.2 2002/04/01 10:16:48 fukachan Exp $ +# $FML: fml_on_unix.sgml,v 1.2 2002/07/04 10:59:00 fukachan Exp $ # # site default_config.cf EXAMPLE # @@ -388,7 +393,7 @@ article_header_rewrite_rules -= rewrite_article_subject_tag </sect1> -<sect1 id="install.fml.unix.edit.virtual"> +<sect1 id="install.virtual"> <title> バーチャルドメインの場合 </title> @@ -396,8 +401,6 @@ article_header_rewrite_rules -= rewrite_article_subject_tag <para> /usr/local/etc/fml/main.cf の編集は必要ありませんが、 /usr/local/etc/fml/virtual は編集して下さい。 -site_default_config.cf はドメインに関わらず適用されることに注意してく -ださい。 </para> <para> @@ -405,9 +408,6 @@ fml.org がデフォルトのドメインとすると、fml.org のＭＬ群は /var/spool/ml 以下をデフォルトでは使います。そのため、別のドメイン nuinui.net のＭＬ群は別のディレクトリ(例: /var/spool/nuinui.net)を使う 必要があります。 -</para> - -<para> その「ドメイン→ディレクトリ」の対応関係を /usr/local/etc/fml/virtual に定義して下さい。 <screen> @@ -415,6 +415,13 @@ nuinui.net /var/spool/nuinui.net </screen> </para> +<warning> +<para> +なお site_default_config.cf はドメインに関わらず適用されることに注意し +てください。 +</para> +</warning> + </sect1> diff --git a/fml/doc/ja/tutorial/install/postfix.sgml b/fml/doc/ja/tutorial/install/postfix.sgml index a8082824..75c6fc66 100644 --- a/fml/doc/ja/tutorial/install/postfix.sgml +++ b/fml/doc/ja/tutorial/install/postfix.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: postfix.sgml,v 1.1 2002/07/04 10:59:00 fukachan Exp $ --> <sect1 id="install.postfix"> @@ -22,11 +22,20 @@ makefml newml を実行するだけでＭＬが自動的に有効になるように、あらかじ <para> 具体的には postfix の /etc/postfix/main.cf を次のようにしておきます。 <screen> +allow_mail_to_commands = alias,forward,include + alias_maps = hash:/etc/mail/aliases hash:/var/spool/ml/etc/mail/aliases </screen> </para> +<warning> +<para> +また mydestination にデフォルトのドメイン(おそらく $mydomain )が +ちゃんと追加されていることを確認して下さい。 +</para> +</warning> + </sect2> @@ -35,16 +44,29 @@ alias_maps = hash:/etc/mail/aliases バーチャルドメイン(例: nuinui.net) </title> - <para> -/usr/local/etc/fml/virtual の設定と合わせて下さい。 +main.cf と virtual_map と両方の設定が必要です。 <screen> +allow_mail_to_commands = alias,forward,include + alias_maps = hash:/etc/mail/aliases hash:/var/spool/ml/etc/mail/aliases hash:/var/spool/nuinui.net/etc/mail/aliases + +virtual_maps = hash:/var/spool/nuinui.net/etc/postfix/virtual + </screen> +/var/spool/nuinui.net/etc/postfix/virtual は makefml によって自動的に +更新されます。 </para> +<warning> +<para> +mydestination にデフォルトのドメイン(おそらく $mydomain )がちゃんと追 +加されていることを確認して下さい。しかし、バーチャルドメイン(ここでは +nuinui.net)は mydestination に追加する必要はありません。注意して下さい。 +</para> +</warning> </sect2> diff --git a/fml/doc/ja/tutorial/install/qmail.sgml b/fml/doc/ja/tutorial/install/qmail.sgml index e8797b68..2b46957a 100644 --- a/fml/doc/ja/tutorial/install/qmail.sgml +++ b/fml/doc/ja/tutorial/install/qmail.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: qmail.sgml,v 1.1 2002/07/04 10:59:00 fukachan Exp $ --> <sect1 id="install.qmail"> @@ -7,6 +7,14 @@ メールサーバの設定 (qmail) </title> +<warning> +<para> +&fmldevel; の qmail 設定は +/var/qmail/control/virtualdomains +を前提としています。 +</para> +</warning> + <para> makefml newml を実行するだけでＭＬが自動的に有効になるように、あらかじ め qmail の設定を変更しておいて下さい。 @@ -15,7 +23,7 @@ makefml newml を実行するだけでＭＬが自動的に有効になるように、あらかじ <sect2> <title> - デフォルトのドメイン(例: fml.org) + デフォルトのドメイン(例: fml.org)の場合 </title> <para> @@ -31,9 +39,7 @@ fml.org:fml-fml.org </para> <para> -この設定がうまく機能するかいなか？は -makefml newml が作るファイル名に依存しています。 -詳細については +makefml newml が作るファイル名については <link linkend="setup.qmail.aliases"> makefml newml の qmail に関する節 </link> @@ -49,10 +55,11 @@ makefml newml の qmail に関する節 </title> <para> -/usr/local/etc/fml/virtual の設定と合わせて下さい。 +nuinui.net ドメインのＭＬは <screen> nuinui.net:fml-nuinui.net </screen> +などとしてください。 </para> </sect2> diff --git a/fml/doc/ja/tutorial/install/upgrade.sgml b/fml/doc/ja/tutorial/install/upgrade.sgml index e8ba1911..3a8766db 100644 --- a/fml/doc/ja/tutorial/install/upgrade.sgml +++ b/fml/doc/ja/tutorial/install/upgrade.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: upgrade.sgml,v 1.1 2002/07/02 10:39:35 fukachan Exp $ --> <chapter> @@ -19,8 +19,8 @@ </para> <para> -インストール後、/etc/fml/main.cf の fml_version 行の日付を -最新のものにして下さい。 +そして、インストール後、/etc/fml/main.cf の fml_version 行を +今インストールしたバージョンに変更して下さい。 ファイルをセーブした瞬間から新しい fml に切り替わります (注: エディタで編集中は古い内容)。 </para> @@ -35,9 +35,6 @@ <para> ソースのインストールし直しなどは必要ありません。 /etc/fml/main.cf の編集だけです。 -</para> - -<para> /etc/fml/main.cf の fml_verison をアップグレード前のものに 戻して下さい。 </para> diff --git a/fml/doc/ja/tutorial/internals/bootloader.sgml b/fml/doc/ja/tutorial/internals/bootloader.sgml index 32434bfa..56fe2d9d 100644 --- a/fml/doc/ja/tutorial/internals/bootloader.sgml +++ b/fml/doc/ja/tutorial/internals/bootloader.sgml @@ -1,5 +1,5 @@ <!-- - $FML: bootloader.sgml,v 1.6 2002/04/01 23:41:03 fukachan Exp $ + $FML: bootloader.sgml,v 1.7 2002/07/02 10:39:35 fukachan Exp $ --> <chapter id="bootloader"> @@ -10,10 +10,10 @@ <para> &fmldevel; にはインストールされている fml のバージョン依存性を考慮するた -めに、実行時には本章で述べるようなブートストラップの過程があります。 +めに、本章で述べるようなブートストラップの過程があります。 <screen> -boot していくイメージ +fml が boot していくイメージ libexec/loader -> FML::Process::Switch -> @@ -32,7 +32,7 @@ loader から次々と呼ばれていく様子は、例えば配送処理の場合、次のよう </para> <para> -libexec/loader は /usr/local/etc/fml/main.cf を読みこみます。 +libexec/loader は /usr/local/etc/fml/main.cf を読みこみ、 fml_version 変数から使うべきライブラリのバージョンを決めます。 例えば fml_vesrion が current-20010501 となっていたら /usr/local/lib/fml/current-20010501/ 以下にあるライブラリを使うといった @@ -86,7 +86,7 @@ FML::Process::Mead >-| | <listitem> <para> - libexec/loader (wrapper) + libexec/loader (wrapper) Bootstrap() を実行する。 fml.pl などはこの loader へのシンボリックリンクです。 /usr/local/libexec/fml/ を参照して下さい。 @@ -146,10 +146,11 @@ FML::Process::Mead >-| | FML::Process::Flow の中に、 どのように fml プロセスを実行するかが - 定義されています。 + 定義されています。大雑把には <screen> $process = new FML::Process::なにか; $process->prepare($args); +$process->verify_request($args); $process->run($args); $process->finish($args); </screen> diff --git a/fml/doc/ja/tutorial/internals/cgi.sgml b/fml/doc/ja/tutorial/internals/cgi.sgml index 681964d6..cb2cdb12 100644 --- a/fml/doc/ja/tutorial/internals/cgi.sgml +++ b/fml/doc/ja/tutorial/internals/cgi.sgml @@ -1,5 +1,5 @@ <!-- - $FML: cgi.sgml,v 1.5 2002/04/01 23:41:03 fukachan Exp $ + $FML: cgi.sgml,v 1.6 2002/07/02 10:39:35 fukachan Exp $ --> <chapter id="internal.cgi"> @@ -14,7 +14,7 @@ </title> <para> -FML::CGI のクラスは以下の３つのメソッドを実装して下さい。 +FML::CGI のクラスは以下のメソッド群を実装して下さい。 <screen> html_start() run_cgi_main() @@ -30,7 +30,7 @@ html_start() は、 ようするに HTML の先頭部分、たとえば DOCTYPE から BODY あたりを、 html_end() は /BODY と /HTML を表示する部分をカスタマイズするために用います。 -run_cgi() メソッドでは BODY の部分を表示してください。 +run_◎◎ メソッド群では BODY の部分を定義しています。 </para> <para> @@ -60,14 +60,16 @@ finish() <sect1 id="internal.cgi.frames"> <title> - 画面の作りとメソッド + CGI の画面の作りとメソッド </title> <para> -典型的な画面は次のように分割されると考えて良いでしょう。 +fml CGI スクリプトでは典型的な画面が次のように分割されると考えています。 <screen> ヘッダ -バー１ メニュー バー２ +◎ メニュー ◎ +バー１ メイン バー２ +◎ メニュー ◎ フッタ </screen> なお、バー１と２の部分は navigation などと呼ばれます。 @@ -78,17 +80,12 @@ finish() ヘッダ部分( HTTP ヘッダではなく、HTML の DOCTYPE から BODY あたり) やフッタの部分は html_start() および html_end() で HTML コードを生成するでしょう。 -BODY の中身は -<screen> -バー１ メニュー バー２ -</screen> -の部分で、run_cgi() によって生成します。 +BODY の中身は真中の３ｘ３のテーブル状の部分で、run_cgi() から呼ばれる +メソッドが生成しています。 </para> -<warning> <para> -TODO: run_cgi() の中身をもっと細かくすることと、 画面上のどの部分をどのメソッドが記述するのかを指定できる アクセスメソッドが必要です。 @@ -98,9 +95,8 @@ nw north ne west center east sw south se </screen> -くらいの精度がないといけないかも知れません。 +という３x３の精度で表現されています。 </para> -</warning> </sect1> @@ -125,11 +121,11 @@ FML::CGI:: クラスが提供するメニュー生成クラスを <screen> FML::CGI::Admin::Main → FML::Command::Admin::subscribe → -FML::CGI::Admin::Menu → +FML::CGI::Admin::User → メニューの表示 </screen> -などとなるでしょう。 -このように Mach のトランポリン機構のように、いったりきたりします。 +などとなっていて、Mach のトランポリン機構のように、いったりきたりしま +す。 </para> </sect1> diff --git a/fml/doc/ja/tutorial/internals/config.cf.sgml b/fml/doc/ja/tutorial/internals/config.cf.sgml index f855a0df..f1fdfa0b 100644 --- a/fml/doc/ja/tutorial/internals/config.cf.sgml +++ b/fml/doc/ja/tutorial/internals/config.cf.sgml @@ -1,5 +1,5 @@ <!-- - $FML: config.cf.sgml,v 1.6 2002/04/01 23:41:03 fukachan Exp $ + $FML: config.cf.sgml,v 1.7 2002/07/02 10:39:35 fukachan Exp $ --> <chapter> @@ -22,7 +22,20 @@ </para> <para> -この perl script 方式にはいくつか問題があります。 +&fmldevel; では config.cf 一つです。 +フォーマットは postfix や .ini 風の +<screen> +変数 = 値 +</screen> +</para> + +<sect2> + <title> + &fml4; の諸問題 + </title> + +<para> +&fml4; の perl script 方式にはいくつか問題があります。 例えば perl script なので、perl が許す限りの自由な書き方ができます。 これは人間にとっては嬉しいのですが、 機械処理の観点からは問題です。というのは @@ -41,6 +54,7 @@ cf というファイルと config.ph という これは本質的に postfix 風のフォーマットです。 </para> +</sect2> </sect1> @@ -157,7 +171,7 @@ x = a b c d e 『サイト固有の定義』、 『ドメイン固有の定義』 などを別のファイルに分離することができます。 -デフォルトでは分離されています。 +デフォルトではいくつかの .cf ファイルに分離されています。 </para> <para> @@ -205,7 +219,7 @@ $config->{ another_key } これは $dir/$file のような形式のままです。 get() はこのハッシュではなく %_fml_config_result の値を返しています。 -これは $dir などが展開された後の値で、 +このハッシュ中の値は $dir などが展開された後の値で、 /var/spool/ml/elena/file などとなっています。 この変数の値の展開は get() なりで呼ばれた時に始めて行なわれます。 </para> diff --git a/fml/doc/ja/tutorial/internals/dbms.sgml b/fml/doc/ja/tutorial/internals/dbms.sgml index 10955599..49b46ca5 100644 --- a/fml/doc/ja/tutorial/internals/dbms.sgml +++ b/fml/doc/ja/tutorial/internals/dbms.sgml @@ -1,5 +1,5 @@ <!-- - $FML: dbms.sgml,v 1.1 2001/08/19 12:53:08 fukachan Exp $ + $FML: dbms.sgml,v 1.2 2001/10/13 08:47:56 fukachan Exp $ --> <chapter id="dbms"> @@ -7,6 +7,13 @@ データベース管理システム </title> +<warning> +<para> +まだ、実装途中です。 +</para> +</warning> + + <para> DBMS との通信は <link linkend="module.io.adapter"> @@ -21,4 +28,5 @@ IO::Adapter IO::Adapter の前段階のプログラムが頑張る必要があります。 </para> + </chapter> diff --git a/fml/doc/ja/tutorial/internals/design.sgml b/fml/doc/ja/tutorial/internals/design.sgml index 9c51afb2..7b1bf376 100644 --- a/fml/doc/ja/tutorial/internals/design.sgml +++ b/fml/doc/ja/tutorial/internals/design.sgml @@ -1,10 +1,10 @@ <!-- - $FML: design.sgml,v 1.6 2002/04/01 23:41:03 fukachan Exp $ + $FML: design.sgml,v 1.7 2002/07/02 10:39:35 fukachan Exp $ --> <chapter id="design"> <title> - &fmldevel; (仮名) のデザインコンセプト + 原案: &fmldevel; (仮名) のデザインコンセプト </title> @@ -14,11 +14,12 @@ --> <sect1> - -<title> fml-devel プロジェクトの構想 </title> + <title> + fml-devel プロジェクトの構想 + </title> <para> -<ulink url="http://www.fml.org/devel/"> +<ulink url="http://www.fml.org/software/fml-devel/"> fml-devel </ulink> とも呼ばれている &fmldevel; プロジェクトは、 @@ -27,8 +28,8 @@ fml-devel </PARA> <para> -<ulink url="http://www.fml.org/devel/"> -http://www.fml.org/devel/ +<ulink url="http://www.fml.org/software/fml-devel/"> +http://www.fml.org/software/fml-devel/ </ulink> は将来の fml-current についてのデザインや実装例を紹介しています。 </PARA> diff --git a/fml/doc/ja/tutorial/internals/directory.sgml b/fml/doc/ja/tutorial/internals/directory.sgml index 0b2934fe..299514d9 100644 --- a/fml/doc/ja/tutorial/internals/directory.sgml +++ b/fml/doc/ja/tutorial/internals/directory.sgml @@ -4,7 +4,7 @@ </title> -<sect1> +<sect1 id="directory.subdir.hier.level"> <title> Q: サブディレクトリ構造は何段階まで必要か？ </title> diff --git a/fml/doc/ja/tutorial/internals/hook.sgml b/fml/doc/ja/tutorial/internals/hook.sgml index 99ccae5d..629a256b 100644 --- a/fml/doc/ja/tutorial/internals/hook.sgml +++ b/fml/doc/ja/tutorial/internals/hook.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: hook.sgml,v 1.1 2002/02/16 13:23:25 fukachan Exp $ --> <chapter id="hook"> @@ -8,7 +8,7 @@ </title> -<sect1> +<sect1 id="hook.problems"> <title> hook における諸問題 </title> @@ -34,7 +34,7 @@ HOOK を評価する lexical scope では無視するようにするべきでしょう。 </sect1> -<sect1> +<sect1 id="hook.naming.convention"> <title> hook の命名規則 </title> diff --git a/fml/doc/ja/tutorial/internals/main.cf.sgml b/fml/doc/ja/tutorial/internals/main.cf.sgml index 65915245..71e6d2e2 100644 --- a/fml/doc/ja/tutorial/internals/main.cf.sgml +++ b/fml/doc/ja/tutorial/internals/main.cf.sgml @@ -1,5 +1,5 @@ <!-- - $FML: main.cf.sgml,v 1.4 2002/07/02 10:39:35 fukachan Exp $ + $FML: main.cf.sgml,v 1.5 2002/07/04 10:59:00 fukachan Exp $ --> <sect2 id="main.cf"> @@ -18,7 +18,7 @@ main.cf のフォーマットは他の .cf と同様 <footnote> <para> -実際のところファイル拡張子とファイルフォーマットには相関があります。 +ファイル拡張子とファイルフォーマットには相関があります。 </para> </footnote> に @@ -29,7 +29,7 @@ main.cf のフォーマットは他の .cf と同様 <screen> # -# $FML: main.cf.sgml,v 1.4 2002/07/02 10:39:35 fukachan Exp $ +# $FML: main.cf.sgml,v 1.5 2002/07/04 10:59:00 fukachan Exp $ # # fml version diff --git a/fml/doc/ja/tutorial/internals/restriction.sgml b/fml/doc/ja/tutorial/internals/restriction.sgml index 32abdb00..6e4aa133 100644 --- a/fml/doc/ja/tutorial/internals/restriction.sgml +++ b/fml/doc/ja/tutorial/internals/restriction.sgml @@ -1,5 +1,5 @@ <!-- - $FML: restriction.sgml,v 1.1 2001/11/25 12:03:24 fukachan Exp $ + $FML: restriction.sgml,v 1.2 2002/02/17 05:40:53 fukachan Exp $ --> <chapter id="restriction"> @@ -7,6 +7,10 @@ 入力データへの制限 </title> +<para> +入力データは FML::Restriction::CGI クラスが提供する正規表現で +検査します。 +</para> <sect1 id="restriction.overview"> <title> @@ -19,8 +23,13 @@ </title> <para> -チェックなしがデフォルト。 -もしフィルタをしたい場合は FML::Filter クラスが検査を担当する。 +FML::Restriction::CGI クラスによる入力データチェックはありませんが、 +FML::Filter クラスによるフィルタチェックがデフォルトで適用されます。 +フィルタをはずすには、config.cf で +<screen> +use_article_body_filter = no +</screen> +を設定して下さい。 </para> </sect2> @@ -32,10 +41,10 @@ </title> <para> -コマンドメールは FML::Process::Command で一行ずつ -FML::Restriction::Command で定義されているルールで -検査される。合格すれば、 -FML::Command::User::コマンド の実行に進むことができる。 +コマンドメールは FML::Process::Command の中で一行ずつ +FML::Restriction::Command で定義されている正規表現にしたがって +検査されます。検査に合格すれば、 +FML::Command::{User,Admin}::コマンド の実行に進むことができます。 </para> </sect2> @@ -52,9 +61,8 @@ safe_param_ほえほえ() という関数経由でのみ CGI から </para> <para> -safe_param_XXX() は FML::Restriction::CGI ( -FML::Restriction::Base を継承している)経由でパターンの検査をす -る。 +safe_param_XXX() は FML::Restriction::CGI ( FML::Restriction::Base を +継承している)経由でパターンの検査をしています。 </para> </sect2> @@ -71,7 +79,6 @@ FML::Restriction::Base を継承している)経由でパターンの検査をす </sect2> - </sect1> @@ -93,8 +100,7 @@ FML::Restriction::CGI クラスのモジュールを用いて </para> <para> -FML::Restriction 以下では -Base を継承したりしますが、 +FML::Restriction 以下では Base を継承したりしますが、 他のモジュールでは、FML::Restriction クラスを object composition として使って下さい。 例えば、 diff --git a/fml/doc/ja/tutorial/internals/style.sgml b/fml/doc/ja/tutorial/internals/style.sgml index 8459dcbf..ec5e89d5 100644 --- a/fml/doc/ja/tutorial/internals/style.sgml +++ b/fml/doc/ja/tutorial/internals/style.sgml @@ -1,5 +1,5 @@ <!-- - $FML: style.sgml,v 1.4 2002/05/27 09:00:28 fukachan Exp $ + $FML: style.sgml,v 1.5 2002/07/02 10:39:36 fukachan Exp $ --> <chapter id="programingstyle"> @@ -27,11 +27,13 @@ FNF 変数の命名規則（ネーミングコンベンション） </title> - <sect2> - <title> 標準パターン (例 log.cf lock.cf) </title> +<sect2> + <title> + 標準パターン (例 log.cf lock.cf) + </title> <screen> -use_変数 = yes/no +use_変数 = yes か no # ディレクトリなら最後に _dir がつくことが望ましい 変数_dir = 文字列 @@ -52,10 +54,12 @@ use_変数 = yes/no 変数_lower_limit = 文字列(数字だけど文字列扱い) </screen> - </sect2> +</sect2> - <sect2> - <title> パターン２ (例 acl.cf ) </title> +<sect2> + <title> + パターン２ (例 acl.cf) + </title> <screen> 変数_restrictions = reject_属性1 @@ -73,8 +77,10 @@ use_変数 = yes/no </sect2> - <sect2> - <title> パターン3 (さらにプログラム名がつく場合) </title> +<sect2> + <title> + パターン3 (さらにプログラム名がつく場合) + </title> <screen> プログラム_変数_属性 @@ -86,6 +92,63 @@ use_変数 = yes/no <!-- ==================================================== --> +<sect1 id="design.policy"> + <title> + デザイン/コーディングスタイルの上でいろいろ + </title> + +<warning> +<para> +スタイルについては、 +<ulink url="http://www.fml.org/software/FNF/">FNF</ulink> +も参照して下さい。 +</para> +</warning> + + +<sect2> + <title> + ２、３の注意点 + </title> + + +<para> +サーチするキーに対して quotemeta() を +</para> + + +<para> +オブジェクトの中身のキーを直接使わずに、 +常にアクセスメソッドを定義すること。 +例: main_cf へのアクセスは +<screen> +$curproc->{ ... }->{ main_cf } +</screen> +ではなく +<screen> +$curproc->main_cf(); +</screen> +を使うこと +</para> + + +<para> +@EXPORT @EXPORT_OK はできればやめたい… +</para> + + +<para> +Srting::is_japanese_string() +くらいの階層に浅くするべきではないかなぁ？ +せめて 3 段目くらいで止まってほしいような〜 +</para> + +</sect2> + +</sect1> + + +<!-- ==================================================== --> <sect1> <title> プログラミング・スタイル (原案のメモ(注: 単なる走り書き)) diff --git a/fml/doc/ja/tutorial/message/chapter.sgml b/fml/doc/ja/tutorial/message/chapter.sgml index ae84eecf..3135a60b 100644 --- a/fml/doc/ja/tutorial/message/chapter.sgml +++ b/fml/doc/ja/tutorial/message/chapter.sgml @@ -1,5 +1,5 @@ <!-- - $FML: chapter.sgml,v 1.2 2001/11/24 12:48:10 fukachan Exp $ + $FML: chapter.sgml,v 1.3 2002/04/01 23:41:04 fukachan Exp $ --> <chapter id="mail.manipulation"> diff --git a/fml/doc/ja/tutorial/message/language.sgml b/fml/doc/ja/tutorial/message/language.sgml index b0c8c866..fd8c3044 100644 --- a/fml/doc/ja/tutorial/message/language.sgml +++ b/fml/doc/ja/tutorial/message/language.sgml @@ -1,5 +1,5 @@ <!-- - $FML: language.sgml,v 1.2 2001/11/24 12:48:10 fukachan Exp $ + $FML: language.sgml,v 1.3 2002/04/01 23:41:04 fukachan Exp $ --> @@ -24,21 +24,23 @@ $curproc->reply_message_nl('error.already_member', </screen> のような呼び出し方をします。 この関数は -/usr/local/share/fml/message/euc-jp/error/already_member +/usr/local/share/fml/バージョン/message/euc-jp/error/already_member というテンプレートを用いてメッセージを構築します。 </para> <para> -メッセージ中の $変数名、例えば、 +メッセージ中の $_arg_変数名、例えば、 <screen> $_args_address </screen> はハッシュリファレンスとして与えられた引数へ展開されます。 +メッセージテンプレート中の $_arg_address は、その値で +展開されます。 </para> <para> また config.cf 中で定義されている変数も同様に展開可能です。 -例えば $ml_name はＭＬ名に展開されるようになっています。 +例えばテンプレート中の $ml_name はＭＬ名に展開されるようになっています。 </para> </sect1> diff --git a/fml/doc/ja/tutorial/overview/download.sgml b/fml/doc/ja/tutorial/overview/download.sgml deleted file mode 100644 index a325dd5d..00000000 --- a/fml/doc/ja/tutorial/overview/download.sgml +++ /dev/null @@ -1,79 +0,0 @@ -<!-- - $FML: download.sgml,v 1.4 2001/11/23 15:00:48 fukachan Exp $ ---> - -<chapter id="download"> - <title> - &fmldevel; のソースコードをダウンロードする - </title> - - -<!-- ==================================================== --> -<sect1 id="ftp.fml.org"> - <title> - ftp サーバからダウンロードする。 - </title> - -<para> -fml-devel のソースは - <ulink url="ftp://ftp.fml.org/pub/fml-devel/"> - ftp://ftp.fml.org/pub/fml-devel/ - </ulink> -から、 ftp で入手できます。 -</para> - -<para> -開発の適当な区切りごとに、不定期に作成されています。 -日付の新しいものを選んでダウンロードして下さい。 -</para> - -<para> -なお daily snapshot もあります。 - -<ulink url="ftp://ftp.fml.org/pub/fml/daily-snapshots/fml-devel/source/"> -ftp://ftp.fml.org/pub/fml/daily-snapshots/fml-devel/source/ -</ulink> - -</para> - -</sect1> - - -<!-- ==================================================== --> -<sect1 id="anoncvs"> - <title> - cvs へのアクセス - </title> - -<para> -anoncvs.fml.org の fmlsrc 以下が &fmldevel; ブランチです。 -</para> - -<para> -cvs.fml.org にアクセスできる権限のある人は -<screen> -cvs -d cvs.fml.org:/cvsroot co fmlsrc -</screen> -でアクセスできます(注: cvs over ssh のみがサポートされます)。 -</para> - -</sect1> - - -<!-- ==================================================== --> -<sect1 id="cvsweb"> - <title> - cvsweb による cvs へのアクセス - </title> - -<para> -<ulink url="http://www.fml.org/cvsweb/fmlsrc/"> -http://www.fml.org/cvsweb/fmlsrc/ -</ulink> -で cvs を見ることができます。 -</para> - -</sect1> - - -</chapter> diff --git a/fml/doc/ja/tutorial/policy.sgml b/fml/doc/ja/tutorial/policy.sgml deleted file mode 100644 index 8b2a2ba6..00000000 --- a/fml/doc/ja/tutorial/policy.sgml +++ /dev/null @@ -1,59 +0,0 @@ -<!-- - $FML: policy.sgml,v 1.2 2002/04/01 23:41:00 fukachan Exp $ ---> - -<chapter id="design.policy"> - <title> - デザイン/コーディングスタイルの上でいろいろ - </title> - -<warning> -<para> -スタイルについては、 -<ulink url="http://www.fml.org/software/FNF/">FNF</ulink> -も参照して下さい。 -</para> -</warning> - - -<sect1> - <title> - ２、３の注意点 - </title> - - -<para> -サーチするキーに対して quotemeta() を -</para> - - -<para> -オブジェクトの中身のキーを直接使わずに、 -常にアクセスメソッドを定義すること。 -例: main_cf へのアクセスは -<screen> -$curproc->{ ... }->{ main_cf } -</screen> -ではなく -<screen> -$curproc->main_cf(); -</screen> -を使うこと -</para> - - -<para> -@EXPORT @EXPORT_OK はできればやめたい… -</para> - - -<para> -Srting::is_japanese_string() -くらいの階層に浅くするべきではないかなぁ？ -せめて 3 段目くらいで止まってほしいような〜 -</para> - -</sect1> - - -</chapter> diff --git a/fml/doc/ja/tutorial/preface.sgml b/fml/doc/ja/tutorial/preface.sgml index 38c7bad2..91aee6d3 100644 --- a/fml/doc/ja/tutorial/preface.sgml +++ b/fml/doc/ja/tutorial/preface.sgml @@ -1,17 +1,17 @@ <!-- - $FML: preface.sgml,v 1.15 2002/05/13 14:18:15 fukachan Exp $ + $FML: preface.sgml,v 1.16 2002/07/02 10:39:29 fukachan Exp $ --> <preface id="preface"> <title> - 前書き + はじめに </title> <sect1 id="status"> <title> - fml-devel (fml 開発版)の現状と TODO + fml-devel の現状 </title> @@ -20,13 +20,13 @@ 現状の &fmldevel; は運用ベースの実証実験の段階に入り、 config.cf の編集支援ツール(makefml config や CGI からの設定変更)を 除いて基本的な機能は実装されています。 -ＭＬごとに細かい設定変更をしたい場合を除けば、普通に使えます。 -実際使っています。 +つまりＭＬごとに細かい設定変更をしたい場合はファイルの編集が必要ですが、 +それを除けば、ツール類を含めて &fml4; と同様に使えるはずです。 </para> <para> ただ 4.0 の細かい昨日まで実装されているわけではありません。 -その意味では、いろいろな機能を使いたい人は +その意味で、いろいろな機能を使いたい人はまだ <ulink url="http://www.fml.org/software/fml/menu.html"> 4.0 stable </ulink> @@ -34,7 +34,7 @@ config.cf の編集支援ツール(makefml config や CGI からの設定変更)を </para> <para> -現在の fml-devel で動く機能そして TODO リストは +なお、現在の fml-devel で動く機能そして TODO リストは <ulink url="../../../fml/doc/ja/todo/STATUS.html"> http://www.fml.org/software/fml-devel/fml/doc/ja/todo/STATUS.html </ulink> @@ -69,14 +69,11 @@ http://www.fml.org/software/fml-devel/fml/doc/ja/todo/STATUS.html </para> <para> -例えば fml (4.0) を使っていて問題になるのは、 +例えば &fml4; を使っていて問題になるのは、 「特定のホストで、ディスクの上にメンバーファイルを書く」という デザインです。 これは最初のバージョンから継承され続けている基本構造です。 -</para> - -<para> -しかしながら、冗長化構成を考えると +しかしながら、RDBMS との連携や冗長化構成を考えると問題が出てきます。 「NFS の時はどうする？」 「トラブルチケットシステムと連動したい場合は？」 「SQL サーバとも連動したいですね？」 @@ -144,7 +141,8 @@ fml 1.2 相当の最低限の機能 + 自動スレッド追跡システム + 自動 HTML 化機構 </screen> -が動きます。 +が動くことになるでしょう +(というか、これらの機能はすでに動いています)。 </para> </sect1> @@ -157,21 +155,18 @@ fml 1.2 相当の最低限の機能 </title> <para> -4.0 と &fmldevel; は +&fml4; と &fmldevel; は &fmldevel; で作られたモジュールのマージと -4.0 自体のコードの保守をしつつ、 +&fml4; 自体のコードの保守をしつつ、 並行開発されていっています。 </para> <para> -そのため 4.0 系は fml project 全体の中で、 -相対的に stable に近い current という位置付けになります。 -4.0 の bug fix は 4.0.x (4.0.1 4.0.2 …)としてまとめられリリー -スれていく予定です。 -4.0-current は 4.0.x のためのテストケースであり、 +そのため 4.0 系は fml project 全体の中で、相対的に stable に近い +current という位置付けになります。4.0 の bug fix は 4.0.x (4.0.1 4.0.2 +…)としてまとめられリリースされていく予定です。 +また 4.0-current は 4.0.x のためのテストケースであり、 &fmldevel; は本当の開発コード( fml-current )という位置付けといえます。 -</para> - <screen> fml-devel -----------------------------> 8.0 ? (次世代プロジェクトの目標) @@ -180,7 +175,7 @@ fml 1.2 相当の最低限の機能 | | 4.0.1 4.0.2 .... (リリース / 4.0-stable バージョン) </screen> - +</para> <para> &fmldevel; 用に作られたモジュールを &fml4; へ輸入する予定です。 diff --git a/fml/doc/ja/tutorial/setup/cgi.sgml b/fml/doc/ja/tutorial/setup/cgi.sgml index d1b0d1ce..7b0672f1 100644 --- a/fml/doc/ja/tutorial/setup/cgi.sgml +++ b/fml/doc/ja/tutorial/setup/cgi.sgml @@ -1,5 +1,5 @@ <!-- - $FML: cgi.admin.sgml,v 1.3 2002/07/04 15:56:24 fukachan Exp $ + $FML: cgi.sgml,v 1.1 2002/07/05 03:11:11 fukachan Exp $ --> <chapter id="setup.cgi"> @@ -84,7 +84,8 @@ http://lists.fml.org/~fml/cgi-bin/fml/fml.org/.htaccess </para> <para> -デフォルトの .htaccess は次のような無意味なものになっています:) +デフォルトの .htaccess は次のような無意味:)なものになっていて、 +アクセスできません。 <screen> AuthName ByPassword AuthType Basic @@ -96,9 +97,9 @@ require valid-user <warning> <para> (当たり前だけど)このファイルを消すと、誰でもアクセスできるようになります。 -デバッグするならいいけど、そういうことはしないように;-) -でもそういうのに限って再設定し忘れたりするものなので、 -しない方が良いです。 +デバッグする場合はともかく、そういう裏技は使わないようにしましょう;-) +また、そういうのに限って再設定し忘れたりするものなので、しない方が良い +です。きちんと .htaccess を設定しましょう。 </para> </warning> diff --git a/fml/doc/ja/tutorial/setup/config.cf.sgml b/fml/doc/ja/tutorial/setup/config.cf.sgml index ada4f957..9354f15d 100644 --- a/fml/doc/ja/tutorial/setup/config.cf.sgml +++ b/fml/doc/ja/tutorial/setup/config.cf.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: config.cf.sgml,v 1.1.1.1 2002/07/04 08:30:48 fukachan Exp $ --> <sect1 id="setup.config.cf"> @@ -8,12 +8,12 @@ </title> <para> -makefml は +makefml は makefml newml を実行した際に config.cf (設定ファイル) と fml を起動するために MTA が呼び出すファイルである -include -および -include-ctl をインストールしてくれます。 +(postfix のための) include 類および +~fml/.qmail-* +を用意してくれます。 <screen> % su fml % makefml newml elena diff --git a/fml/doc/ja/tutorial/setup/newml.sgml b/fml/doc/ja/tutorial/setup/newml.sgml index 71e8969e..dc1fa588 100644 --- a/fml/doc/ja/tutorial/setup/newml.sgml +++ b/fml/doc/ja/tutorial/setup/newml.sgml @@ -1,5 +1,5 @@ <!-- - $FML: newml.sgml,v 1.3 2002/07/02 10:39:39 fukachan Exp $ + $FML: newml.sgml,v 1.1.1.1 2002/07/04 08:30:48 fukachan Exp $ --> @@ -51,14 +51,15 @@ makefml を使ってＭＬを作成します。 <listitem> <para> <screen> - ~fml/public_html/$domain/$ml/ + ~fml/public_html/fml/mlarchive/$domain/$ml/ </screen> 例えば elena@fml.org なら <screen> - ~fml/public_html/fml.org/elena/ + ~fml/public_html/fml/mlarchive/fml.org/elena/ </screen> を用意する。 - ここに HTML 化された記事が自動的に作られることになる(でふぉると)。 + デフォルトでは、 + ここに HTML 化された記事が自動的に作られることになる。 </para> </listitem> @@ -68,11 +69,11 @@ makefml を使ってＭＬを作成します。 ドメインで一番偉いインターフェイス(そのドメインのＭＬは全部操 作できる)が <screen> - ~fml/public_html/cgi-bin/fml/$domain/admin/menu.cgi + ~fml/public_html/cgi-bin/fml/$domain/admin/config.cgi </screen> また、各ＭＬで一番偉いインターフェイス(そのＭＬの操作ができる) <screen> - ~fml/public_html/cgi-bin/fml/$domain/ml-admin/menu.cgi + ~fml/public_html/cgi-bin/fml/$domain/ml-admin/$ml/config.cgi </screen> </para> </listitem> diff --git a/fml/doc/ja/tutorial/setup/postfix.sgml b/fml/doc/ja/tutorial/setup/postfix.sgml index 7a068dcf..55d8412e 100644 --- a/fml/doc/ja/tutorial/setup/postfix.sgml +++ b/fml/doc/ja/tutorial/setup/postfix.sgml @@ -1,3 +1,7 @@ +<!-- + $FML$ +--> + <sect1 id="setup.postfix.aliases"> <title> メールサーバの設定 (postfix) @@ -9,6 +13,14 @@ alias_maps が適切に設定されていれば、 ＭＬ作成時にも特別な作業はありません。 postfix の設定は自動的に更新されています。 </para> + +<para> +postfix の設定については +<link linkend="install.postfix"> +<xref linkend="install.postfix"> +</link> +を参照して下さい。 +</para> </important> @@ -21,7 +33,7 @@ $ml_home_prefix/etc/mail/aliases <sect2> <title> - 例: /var/spool/ml/etc/mail/aliases のフォーマット + 補足: /var/spool/ml/etc/mail/aliases のフォーマット </title> <para> @@ -29,7 +41,7 @@ aliases のエントリは $ml_home_prefix/etc/mail/aliases に追加されます。 <screen> -### BEGIN-elena@fml.org-ML-aliases ### +### <ALIASES elena@home.fml.org ML> ### # address for post elena: :include:/var/spool/ml/elena/include @@ -41,9 +53,13 @@ owner-elena-ctl: fukachan # maintainer elena-request: elena-admin -elena-admin: fukachan +elena-admin: fukachan, elena-error + +# error analyzer +elena-error: :include:/var/spool/ml/elena/include-error +owner-elena-error: fukachan -### END-elena@fml.org-ML-aliases ### +### </ALIASES elena@home.fml.org ML> ### </screen> バーチャルドメインの場合、 $ml_home_prefix の部分は diff --git a/fml/doc/ja/tutorial/setup/procmail.sgml b/fml/doc/ja/tutorial/setup/procmail.sgml index f4ae8317..09aeb377 100644 --- a/fml/doc/ja/tutorial/setup/procmail.sgml +++ b/fml/doc/ja/tutorial/setup/procmail.sgml @@ -1,8 +1,8 @@ <!-- - $FML: procmail.sgml,v 1.4 2002/07/05 04:01:37 fukachan Exp $ + $FML: procmail.sgml,v 1.1 2002/07/06 05:26:10 fukachan Exp $ --> -<sect1 id="fml.bymyaccount"> +<sect1 id="setup.procmail"> <title> 自分のアカウントでＭＬを行ないたい </title> @@ -22,12 +22,14 @@ こういった場合、 &fmldevel; ではユーザが procmail などの振分ツールを使うだろうと期待しています :-) +そのため、&fmldevel; に振り分けツールは用意されていません。 +OS のパッケージシステムなどを使って振り分けツールをインストールして下さい。 </para> -<sect2 id="procmail"> +<sect2 id="setup.procmailrc"> <title> - procmail の例 + 例: .procmailrc </title> <para> diff --git a/fml/doc/ja/tutorial/setup/qmail.sgml b/fml/doc/ja/tutorial/setup/qmail.sgml index d46ceb90..48b06f59 100644 --- a/fml/doc/ja/tutorial/setup/qmail.sgml +++ b/fml/doc/ja/tutorial/setup/qmail.sgml @@ -1,3 +1,7 @@ +<!-- + $FML$ +--> + <sect1 id="setup.qmail.aliases"> <title> メールサーバの設定 (qmail) @@ -6,16 +10,15 @@ <para> makefml newml は次のような qmail 用の設定ファイルを作ります。 <screen> -~/.qmail-fml:org-elena -~/.qmail-fml:org-elena-ctl +~fml/.qmail-fml:org-elena +~fml/.qmail-fml:org-elena-ctl </screen> よって <screen> /var/qmail/control/virtualdomains </screen> に、あらかじめ次のような設定を仕込んでおけば、 -makefml newml を実行するだけで -qmail でも自動的にＭＬが有効になります。 +makefml newml を実行するだけで自動的にＭＬが有効になります。 <screen> fml.org:fml-fml.org </screen> diff --git a/fml/doc/ja/tutorial/terms.sgml b/fml/doc/ja/tutorial/terms.sgml new file mode 100644 index 00000000..7dafe649 --- /dev/null +++ b/fml/doc/ja/tutorial/terms.sgml @@ -0,0 +1,27 @@ +<!-- + $FML: terms.sgml,v 1.3 2002/07/02 10:39:34 fukachan Exp $ +--> + +<sect1 id="terms"> + +<title> 本チュートリアル中における用語について </title> + +<variablelist> + + <varlistentry> + <term> % </term> + <listitem> + <para> 一般ユーザのプロンプト </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> # </term> + <listitem> + <para> ユーザ root のプロンプト </para> + </listitem> + </varlistentry> + +</variablelist> + +</sect1> |