diff options
| author | fukachan <fukachan> | 2004-04-07 11:06:58 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2004-04-07 11:06:58 +0000 |
| commit | 9984504f77ff7549b9d5c9e10fe2076dcc70b743 (patch) | |
| tree | ea06550eac32452aefcff116a0ebfb800910b449 /fml/doc/ja/tutorial/internals | |
| parent | ddf915222f9b488b7ade43178d8d65dcf122391e (diff) | |
| download | fml8-9984504f77ff7549b9d5c9e10fe2076dcc70b743.tar.gz fml8-9984504f77ff7549b9d5c9e10fe2076dcc70b743.tar.bz2 fml8-9984504f77ff7549b9d5c9e10fe2076dcc70b743.zip | |
fix description to catch up current implementation.
fix variable names to current ones.
clean up.
Diffstat (limited to 'fml/doc/ja/tutorial/internals')
| -rw-r--r-- | fml/doc/ja/tutorial/internals/bootloader.sgml | 7 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/config.cf.sgml | 36 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/design.sgml | 24 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/directory.sgml | 4 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/errormail.sgml | 6 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/filter.sgml | 15 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/language.sgml | 24 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/main.cf.sgml | 24 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/style.sgml | 10 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/internals/userctl.sgml | 34 |
10 files changed, 102 insertions, 82 deletions
diff --git a/fml/doc/ja/tutorial/internals/bootloader.sgml b/fml/doc/ja/tutorial/internals/bootloader.sgml index 8f786e4f..bb2e1140 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.9 2003/03/09 08:29:10 fukachan Exp $ + $FML: bootloader.sgml,v 1.10 2003/04/15 14:51:40 fukachan Exp $ --> <chapter id="bootloader"> @@ -108,7 +108,7 @@ FML::Process::Mead >-| | <para> libexec/loader (wrapper) Bootstrap() を実行する。 - fml.pl などはこの loader へのシンボリックリンクです。 + libexec/distribute などは、皆この loader へのシンボリックリンクです。 /usr/local/libexec/fml/ を参照して下さい。 </para> </listitem> @@ -191,7 +191,8 @@ $process->finish($args); </para> <para> -以下、2、3の走り書き/おぼえがきを残しておきます。 +以下、内部構造について、2、3の走り書き/おぼえがきを残しておきます。 +一応、こういった構造を鑑みて、prepare() のあたりに持ってきているわけです。 <screen> main::Bootstrap() diff --git a/fml/doc/ja/tutorial/internals/config.cf.sgml b/fml/doc/ja/tutorial/internals/config.cf.sgml index cbf9364f..67d2460c 100644 --- a/fml/doc/ja/tutorial/internals/config.cf.sgml +++ b/fml/doc/ja/tutorial/internals/config.cf.sgml @@ -1,8 +1,8 @@ <!-- - $FML: config.cf.sgml,v 1.10 2003/06/15 05:23:13 fukachan Exp $ + $FML: config.cf.sgml,v 1.11 2003/06/20 22:23:14 fukachan Exp $ --> -<chapter> +<chapter id="internal.config.cf"> <title> 設定ファイル config.cf </title> @@ -18,9 +18,9 @@ </para> <para> -そのために &fml4; では各MLのホームディレクトリ $DIR に config.ph と -いうファイルがあります。これは .ph という名前でわかる通り perl script -です。 +そのために &fml4; では各MLのホームディレクトリ $DIR (例: +/var/spool/ml/elena)に config.ph というファイルがあります。これは .ph +という名前でわかる通り perl script です。 </para> <para> @@ -68,12 +68,14 @@ cf というファイルと config.ph という <!-- ======================================= --> <sect1 id="config.cf.format"> - <title> config.cf のフォーマット </title> + <title> + config.cf のフォーマット + </title> <para> config.cf のフォーマットは <link linkend="main.cf"> - /etc/fml/main.cf + /usr/local/etc/fml/main.cf </link> と同様です。 <screen> @@ -124,7 +126,7 @@ b = 値4/値2/値3 <!-- ======================================= --> -<sect1> +<sect1 id="config.cf.format.extension"> <title> postfix style のさらなる拡張 </title> @@ -146,7 +148,7 @@ x -= b <screen> x = a c d </screen> -などとなる。 +と解釈されます。 </para> <para> @@ -159,7 +161,7 @@ x += e <screen> x = a b c d e </screen> -などとなる。 +となります。 </para> </sect1> @@ -167,7 +169,9 @@ x = a b c d e <!-- ======================================= --> <sect1 id="config.cf.overload"> - <title> config.cf の多重読み込み(変数定義の上書き) </title> + <title> + config.cf の多重読み込み(変数定義の上書き) + </title> <para> 複数の config.cf を読み込み、定義の上書きを行なうことができます。 @@ -179,7 +183,7 @@ x = a b c d e 『サイト固有の定義』、 『ドメイン固有の定義』 などを別のファイルに分離することができます。 -デフォルトではいくつかの .cf ファイルに分離されています。 +デフォルトでは、いくつかの .cf ファイルに分離されています。 </para> <para> @@ -192,7 +196,9 @@ fml は起動時にそれらのファイルを順番に読みこみ、 <!-- ======================================= --> <sect1> - <title> 展開後に変数を代入すると? </title> + <title> + 展開後に変数を代入すると? + </title> <para> $ をふくむ変数の値の代入が行なわれると、 @@ -219,7 +225,9 @@ $config->{ another_key } <sect2> - <title> 内部構造: 変数展開 </title> + <title> + 内部構造: 変数展開 + </title> <para> 内部構造の話をすると、 diff --git a/fml/doc/ja/tutorial/internals/design.sgml b/fml/doc/ja/tutorial/internals/design.sgml index e2bb716e..0f7fa609 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.8 2002/07/06 14:55:18 fukachan Exp $ + $FML: design.sgml,v 1.9 2003/04/15 14:51:40 fukachan Exp $ --> <chapter id="design"> <title> - 原案: &fmldevel; (仮名) のデザインコンセプト + 原案: &fml8; (仮名) のデザインコンセプト </title> @@ -22,7 +22,7 @@ <ulink url="http://www.fml.org/software/fml-devel/"> fml-devel </ulink> -とも呼ばれている &fmldevel; プロジェクトは、 +とも呼ばれている &fml8; プロジェクトは、 &fml4; の再構想(refactoring)とその実装(例)の構築 を行なっています。 </PARA> @@ -51,7 +51,7 @@ http://www.fml.org/software/fml-devel/ </PARA> <para> -ものによっては &fmldevel; 用に作られたモジュールを &fml4; へ輸入/輸出 +ものによっては &fml8; 用に作られたモジュールを &fml4; へ輸入/輸出 することも検討しています。IPv6 はすでに輸出されました。たとえば 4.0 で も独立性の高い mead (エラーメール解析プログラム)などはその良い例だろう し、新機能を提供するモジュールなども再輸入(輸出)可能なものは順次マージ @@ -59,12 +59,12 @@ http://www.fml.org/software/fml-devel/ </PARA> <para> -これらのマージおよび 4.0 自体のコードの保守をしつつ 4.0 および &fmldevel; は +これらのマージおよび 4.0 自体のコードの保守をしつつ 4.0 および &fml8; は 並行開発されていく予定です。 そのため 4.0 系は stable に近い current という位置付けになります。 そして 4.0 の bug fix は 4.0.x (4.0.1 4.0.2 …)としてまとめられリリー スれていく予定です。 -逆に &fmldevel; は本当の開発用のコード( fml-current )ということになります。 +逆に &fml8; は本当の開発用のコード( fml-current )ということになります。 </PARA> </sect1> @@ -87,7 +87,7 @@ http://www.fml.org/software/fml-devel/ <listitem> <para> - 全部 perl module 形式 (要 &fmldevel;04 以降) + 全部 perl module 形式 (要 perl 5.00504 以降) </para> </listitem> @@ -161,7 +161,7 @@ http://www.fml.org/software/fml-devel/ <listitem> <para> - SQL (プロトタイプは実装済み) + SQL (MySQL は実装済み) </para> </listitem> @@ -219,7 +219,7 @@ http://www.fml.org/software/fml-devel/ <entry> </entry> <entry> イメージ/モティーフ</entry> <entry> - &fml4; から &fmldevel; へは、 + &fml4; から &fml8; へは、 sendmail から postfix への移行のようなイメージで。 最低限の config.ph コンバータは用意する。 </entry> @@ -302,7 +302,7 @@ http://www.fml.org/software/fml-devel/ </row> <row> - <entry> 手づかず </entry> + <entry> done. (でも lmtp を実装してない;-) </entry> <entry> queue manager </entry> <entry> 再送処理のため (e.g. smtpfeed ) @@ -311,7 +311,7 @@ http://www.fml.org/software/fml-devel/ <row> - <entry> may be </entry> + <entry> </entry> <entry> tools </entry> <entry> BSD make を使わない。 @@ -356,7 +356,7 @@ http://www.fml.org/software/fml-devel/ <sect1 id="design.releng"> <TITLE> - リリース・エンジニアリングについて + リリース・エンジニアリングについて (目標!) </TITLE> <para> diff --git a/fml/doc/ja/tutorial/internals/directory.sgml b/fml/doc/ja/tutorial/internals/directory.sgml index 26394b7c..e17eb0e4 100644 --- a/fml/doc/ja/tutorial/internals/directory.sgml +++ b/fml/doc/ja/tutorial/internals/directory.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: directory.sgml,v 1.3 2003/04/15 14:51:40 fukachan Exp $ --> <chapter id="directory"> @@ -14,6 +14,8 @@ </title> <para> +たとえば、HTML化された記事は、こんな階層に置かれていますが、どうでしょ +う? <screen> 200201/msg○○.html </screen> diff --git a/fml/doc/ja/tutorial/internals/errormail.sgml b/fml/doc/ja/tutorial/internals/errormail.sgml index 8356a7f3..b4cf9f05 100644 --- a/fml/doc/ja/tutorial/internals/errormail.sgml +++ b/fml/doc/ja/tutorial/internals/errormail.sgml @@ -1,5 +1,5 @@ <!-- - $FML: errormail.sgml,v 1.2 2003/11/24 14:37:34 fukachan Exp $ + $FML: errormail.sgml,v 1.3 2004/02/24 14:26:58 fukachan Exp $ --> @@ -13,8 +13,8 @@ libexec/error は &fml4; の libexec/mead に相当するものです。 </para> <para> -$use_error_analyzer_program を yes にすると、エラー解析機能が有効にな -ります。ちなみに、デフォルトで $use_error_analyzer_program は yes つま +$use_error_mail_analyzer_function を yes にすると、エラー解析機能が有効にな +ります。ちなみに、デフォルトで $use_error_mail_analyzer_function は yes つま りエラー解析機能は有効になっています。このへんは &fml4; と異なります。 &fml8; では、&fml4; でよく使う機能は始めから有効になっています。 </para> diff --git a/fml/doc/ja/tutorial/internals/filter.sgml b/fml/doc/ja/tutorial/internals/filter.sgml index 968eef5c..87b88b44 100644 --- a/fml/doc/ja/tutorial/internals/filter.sgml +++ b/fml/doc/ja/tutorial/internals/filter.sgml @@ -1,5 +1,5 @@ <!-- - $FML: filter.sgml,v 1.4 2003/06/19 16:24:53 fukachan Exp $ + $FML: filter.sgml,v 1.5 2003/06/20 22:03:13 fukachan Exp $ --> <chapter id="internals.filter"> @@ -14,7 +14,7 @@ </title> <para> -フィルタには大きく分けて3種類あります。それは、 +コンテンツを検査するフィルタには大きく分けて3種類あります。それは、 ヘッダ、 メール本文、 MIME 構造を元にしたフィルタ(mime component filter)の3つです。 @@ -44,6 +44,12 @@ text/plain に対してより厳しいシンタックスチェックを行なうフィルタも ください。 </para> +<!-- XXX-TODO トラフィックベースのフィルタ --> +<para> +また、これら以外にトラフィックベースのフィルタがあります(まだかなりの +部分が未実装なので省略します)。 +</para> + </sect1> @@ -53,7 +59,7 @@ text/plain に対してより厳しいシンタックスチェックを行なうフィルタも </title> <para> -配送やコマンドメールといった機能別に、「フィルタを使うか使わないか?」 +配送やコマンドメールといった機能別に「フィルタを使うか使わないか?」 「使うフィルタルールは?」などが定義されています。 </para> @@ -86,7 +92,8 @@ use_機能A = yes </para> <para> -parse() する時にサイズもはかっているので、このフィルタの実装は簡単だ。 +余談: + parse() する時にサイズもはかっているので、このフィルタの実装は簡単です:) </para> &var.filter.size; diff --git a/fml/doc/ja/tutorial/internals/language.sgml b/fml/doc/ja/tutorial/internals/language.sgml index 00f7a3be..fe24f7f9 100644 --- a/fml/doc/ja/tutorial/internals/language.sgml +++ b/fml/doc/ja/tutorial/internals/language.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: language.sgml,v 1.1 2004/02/26 10:36:05 fukachan Exp $ --> @@ -15,9 +15,10 @@ </title> <para> -一番単純なモデルは、「このMLは日本人用」と設定してあるならメッセージ -は常に日本語で返すというものです。 -ML作成時に何言語用かを指定する必要があります。 +一番単純なモデルは「このMLは日本人用と設定しているなら、メッセージは +常に日本語で返す」というものです。このモデルでは、ML作成時に何言語用 +かを指定する必要があります。また、間違って(日本語が読めない人から)送ら +れてきたメールに対しても、日本語でエラーを返します。 </para> <para> @@ -31,7 +32,8 @@ たとえば、Accept-Language: ja などとしてある場合はja が優先だと分かり ます。しかしながら、そういったものがなく、かつ、「日本人が help という メールを送ってきた」場合、返事を us-ascii なのか iso-2022-jp で返すべ -きなのか?が、プログラムには良く分かりません。 +きなのか?が、プログラムには良く分かりません。たとえば、こんなメールで +は、どう判断するのが正しいでしょう? <screen> 例: @@ -54,8 +56,8 @@ charsetを素直に考えると、英語で返すべきですが、これは本文が英語だけな <para> 逆に、Accept-Lanaguage: が指定されていれば、それを尊重するべきです。英 語のML(language_preference_order = en)の場合でも、Accept-Lanaguage: -ja なら(できるだけ)日本語で返事をするべきでしょう。 -標準のメッセージであれば、このサポートは可能なので、優先するべきでしょう。 +ja なら(できるだけ)日本語で返事をするべきでしょう。&fml8; 標準のメッ +セージであれば、この動作が可能です。なので、そうするべきと考えます。 </para> </sect1> @@ -63,16 +65,16 @@ ja なら(できるだけ)日本語で返事をするべきでしょう。 <sect1 id="language.preference.ml.ja"> <title> - 日本語のML + 日本語優先のML </title> <para> language_preference_order という変数があります。 -これが、次のように指定されています。 +日本語がデフォルトのMLでは、これが、次のように指定されています。 <screen> language_preference_order = ja en </screen> -このヒントを使い、以下のように処理をするようにしています。 +このヒントを使い、以下のような処理をするようにしています。 </para> @@ -142,7 +144,7 @@ language_preference_order = ja en <sect1 id="language.preference.ml.en"> <title> - 英語のML + 英語優先のML </title> <para> diff --git a/fml/doc/ja/tutorial/internals/main.cf.sgml b/fml/doc/ja/tutorial/internals/main.cf.sgml index 57d8af66..19cedf24 100644 --- a/fml/doc/ja/tutorial/internals/main.cf.sgml +++ b/fml/doc/ja/tutorial/internals/main.cf.sgml @@ -1,17 +1,17 @@ <!-- - $FML: main.cf.sgml,v 1.7 2002/09/15 02:11:24 fukachan Exp $ + $FML: main.cf.sgml,v 1.8 2003/04/15 14:51:41 fukachan Exp $ --> <sect2 id="main.cf"> <title> - 例: /etc/fml/main.cf + 例: /usr/local/etc/fml/main.cf </title> <para> -/etc/fml/main.cf は各MLの設定ではありません。fml のバージョンなどメ -タレベルの依存性を解決するための設定ファイルで、fml のプログラム群が起 -動する時に参照します。また、main.cf には ディレクトリやプロセスのユー -ザの指定など最も基本的な情報のみが書かれています。 +/usr/local/etc/fml/main.cf は各MLの設定ではありません。fml のバージョ +ンなどメタレベルの依存性を解決するための設定ファイルで、fml のプログラ +ム群が起動する時に参照します。また、main.cf には ディレクトリやプロセ +スのユーザの指定など最も基本的な情報のみが書かれています。 </para> <para> @@ -29,7 +29,7 @@ main.cf のフォーマットは他の .cf と同様 <screen> # -# $FML: main.cf.sgml,v 1.7 2002/09/15 02:11:24 fukachan Exp $ +# $FML: main.cf.sgml,v 1.8 2003/04/15 14:51:41 fukachan Exp $ # # fml version @@ -54,10 +54,10 @@ exec_prefix = ${prefix} # $config_dir holds the global main configuration and # several version-dependent default configurations -# Example: /etc/fml -config_dir = /etc/fml +# Example: /usr/local/etc/fml +config_dir = /usr/local/etc/fml -# Example: /etc/fml/defaults/$fml_version +# Example: /usr/local/etc/fml/defaults/$fml_version default_config_dir = $config_dir/defaults/$fml_version # defined for convenience, for example, we need this variable @@ -98,12 +98,12 @@ default_domain = fml.org # version dependent default_config.cf location # whic holds -# Example: /etc/fml/defaults/8.0/default_config.cf +# Example: /usr/local/etc/fml/defaults/8.0/default_config.cf default_config_cf = $default_config_dir/default_config.cf # domain specific configurations -# Example: /etc/fml/domains/fml.org/default_config.cf +# Example: /usr/local/etc/fml/domains/fml.org/default_config.cf domain_default_config = $config_dir/domains/$default_domain/config.cf diff --git a/fml/doc/ja/tutorial/internals/style.sgml b/fml/doc/ja/tutorial/internals/style.sgml index 7f512046..8be16438 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.10 2003/11/30 09:16:55 fukachan Exp $ + $FML: style.sgml,v 1.11 2004/03/31 06:29:38 fukachan Exp $ --> <chapter id="programingstyle"> @@ -60,7 +60,7 @@ mail は「いわゆるメール」つまり messager/rfc822 形式のものです。 fml システムへ入力されるものも mail だし、出ていくものも mail です。 それらは mail から派生したサブクラスと考えられるため、 「PREFIX_mail_属性」形式に統一する方が良いでしょう。 -が、ものすごく厳密にやると逆にわけ分からないので程ほどに。 +が、ものすごく厳密にやると、逆に、わけがわからないのでほどほどに。 </para> <para> @@ -78,7 +78,7 @@ use_report_mail_何とか report_mail_何とか </screen> この例でも、厳密には outgoing_report_mail とかするべきなんでしょうけど、 -そこまではやらないのが程ほどってところですね。 +そこまではやらないのがほどほどってところですね。 </para> <para> @@ -99,7 +99,7 @@ use_command_mail_header_なんとか <link linkend="list.variables.by.class"> クラスの階層構造 </link> -で現すと、こーんな感じになるとおもいます。 +であらわすと、こーんな感じになるとおもいます。 <screen> command { SOMETHING_command @@ -335,7 +335,7 @@ Srting::is_japanese_string() libexec/ や libkern.pl にある関数は、 main:: に記述される部分は基本的なフローを記述している。 これらは基本的な枠組を示すものであるため、 - $CurProc (C でいえば struct *curproc にあたるもの) + $curproc (C でいえば struct *curproc にあたるもの) を受け渡す、構造化プログラミング的な書き方をしている。 </para> diff --git a/fml/doc/ja/tutorial/internals/userctl.sgml b/fml/doc/ja/tutorial/internals/userctl.sgml index 0d920c32..727169fa 100644 --- a/fml/doc/ja/tutorial/internals/userctl.sgml +++ b/fml/doc/ja/tutorial/internals/userctl.sgml @@ -1,10 +1,10 @@ <!-- - $FML: db.sgml,v 1.7 2003/04/15 14:51:40 fukachan Exp $ + $FML: userctl.sgml,v 1.1 2003/05/12 10:16:40 fukachan Exp $ --> <chapter id="userctl"> <title> - ユーザの制御 + ユーザの登録、削除について </title> @@ -14,45 +14,45 @@ </title> <para> -追加は primary_*_map に対しておこなう。 -削除も primary_*_map に対しておこなう。 +ユーザの追加と削除は何に対して行なうか?というと +追加は primary_*_map に対しておこないます。 +削除も primary_*_map に対しておこないます。 </para> <para> たとえば、リモート管理者は primary_admin_member_map と primary_admin_recipient_map の両方に -アドレスを追加する。 +アドレスを追加します。 削除の際は、 primary_admin_member_map と primary_admin_recipient_map から -アドレスを削除する。 +アドレスを削除します。 </para> <para> -これを admin_member_maps と admin_recipient_maps にすると問題だ。 +これを admin_member_maps と admin_recipient_maps にすると問題があります。 </para> <para> -追加は、明らかに複数の map に追加してしまうので、一つに限定するべきだ。 +追加は、明らかに複数の map に追加してしまうので、一つに限定するべきです。 だから、primary_*_map 一つに対して行なう。 -メンバーは primary_xxx_member_map ひとつに、 -受信者は primary_xxx_recipient_map 一つに対して行なう。 +つまり、メンバーは primary_xxx_member_map ひとつに、 +受信者は primary_xxx_recipient_map 一つに対して行ないます。 </para> <para> -削除だが、一見 *_maps でもよいような気がするが、 -実は駄目だ。消し過ぎになってしまうことがある。 -特に問題になるのは、権限の異なる map が混在している場合である。 +削除は、一見 *_maps でもよいような気がしますが、 +実は駄目です。消し過ぎになってしまうことがあるからです。 +特に問題になるのは、権限の異なる map が混在している場合です。 </para> <para> -たとえば、 -member_maps はデフォルトで、リモート管理者を含んでいる。 +たとえば、member_maps はデフォルトで、リモート管理者を含んでいます。 <screen> member_maps = $primary_member_map $admin_member_maps </screen> -そのため、member_maps に対して削除を試みると、 -勢いあまってリモート管理者の分も削除してしまうことになる +そのため、member_maps に対して削除を試みると、勢いあまってリモート管理 +者の分も削除してしまうことになるというわけです。 </para> </sect1> |
