summaryrefslogtreecommitdiff
path: root/fml/doc/ja/tutorial/usage
diff options
context:
space:
mode:
authorfukachan <fukachan>2003-04-15 14:51:34 +0000
committerfukachan <fukachan>2003-04-15 14:51:34 +0000
commit6c6f43a3af38974d872778f2b355e6e3a61af961 (patch)
tree40c4d17cfbe26fe516f3429fe587c450c7eb30f9 /fml/doc/ja/tutorial/usage
parentf511a32e5c36f9a16f5f33373c2f24cd3d413055 (diff)
downloadfml8-6c6f43a3af38974d872778f2b355e6e3a61af961.tar.gz
fml8-6c6f43a3af38974d872778f2b355e6e3a61af961.tar.bz2
fml8-6c6f43a3af38974d872778f2b355e6e3a61af961.zip
clean up. catch up the current status.
Diffstat (limited to 'fml/doc/ja/tutorial/usage')
-rw-r--r--fml/doc/ja/tutorial/usage/chaddr.sgml4
-rw-r--r--fml/doc/ja/tutorial/usage/chapter.onhost.sgml61
-rw-r--r--fml/doc/ja/tutorial/usage/command.sgml24
-rw-r--r--fml/doc/ja/tutorial/usage/fmlsummary.sgml27
-rw-r--r--fml/doc/ja/tutorial/usage/fmlthread.sgml26
-rw-r--r--fml/doc/ja/tutorial/usage/get.sgml4
-rw-r--r--fml/doc/ja/tutorial/usage/makefml.sgml28
-rw-r--r--fml/doc/ja/tutorial/usage/post.sgml13
8 files changed, 73 insertions, 114 deletions
diff --git a/fml/doc/ja/tutorial/usage/chaddr.sgml b/fml/doc/ja/tutorial/usage/chaddr.sgml
index b648506f..6477fc99 100644
--- a/fml/doc/ja/tutorial/usage/chaddr.sgml
+++ b/fml/doc/ja/tutorial/usage/chaddr.sgml
@@ -1,5 +1,5 @@
<!--
- $FML$
+ $FML: chaddr.sgml,v 1.1 2002/07/28 12:20:19 fukachan Exp $
-->
<sect1 id="usage.user.chaddr">
@@ -18,7 +18,7 @@ elena-ctl@fml.org に送って下さい。
旧アドレス、新アドレス
どちらのアドレスから送っても構いません。
confirmatin が返送されます。
-その confirmation に返答すると登録されます。
+その confirmation に返答すると変更されます。
</para>
</sect1>
diff --git a/fml/doc/ja/tutorial/usage/chapter.onhost.sgml b/fml/doc/ja/tutorial/usage/chapter.onhost.sgml
index 06f76c14..709829f7 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.6 2003/04/12 15:21:22 fukachan Exp $
+ $FML: chapter.onhost.sgml,v 1.7 2003/04/13 04:36:13 fukachan Exp $
-->
<chapter id="usage.onhost">
@@ -11,26 +11,26 @@
<para>
makefml の基本的な使い方は &fml4; の makefml と同様です。
-というより、できるだけ互換性を保つように構築する予定です。
+できるだけ同じ使い勝手になるように、
+つまり互換性を保つようにしてあります。
</para>
+
<sect1>
<title>
ホスト上でできること、その権限について
</title>
<para>
-現状 makefml に命令を与えると admin コマンドと同じ動作をするようになっ
-ています。
-つまり特権的な動作ということです。
+makefml を使う操作は
例えば、メンバーの登録に confirmation は必要ありません。
</para>
<para>
-MLサーバのホストに入ることができる(例: slogin してシェルが取れる)
-人は、通常MLにとって最強の人を意味します。
-ファイルを直接編集することで、どんなことでもできるわけですから、
-無敵です。
+MLサーバのホストに入ることができる(例: slogin してシェルが取れる)人
+は、MLにとって最強の権限を持つ人を意味します。ファイルを直接編集する
+ことで、どんなことでもできるわけですから、無敵です。
+だから特権的な操作であるわけです。
</para>
<para>
@@ -39,20 +39,20 @@ makefml の基本的な使い方は &fml4; の makefml と同様です。
</para>
<para>
-そのため、通常は makefml ( /usr/local/bin/makefml )を
-使うことで、fml を操作して下さい。
-というのが fml の操作ポリシーです。
-もちろんファイルを編集しても構いませんが。
+そのためファイルの直接編集などはせずに、通常は「makefml (
+/usr/local/bin/makefml )を使うことで fml の設定を変更して下さい」とい
+うポリシーが推奨されています。もちろんファイルを編集しても構いませんが、
+内部構造などを良く理解してからにしてください。
</para>
<para>
なお、fml コマンドは引数の順番の異なる makefml です。
-コマンドの中身/動作は同じですので、
-シンタックスの好き嫌いでどちらかを選んで使って下さい。
<screen>
makefml コマンド ML名 オプション
fml ML名 コマンド オプション
</screen>
+コマンドの中身/動作は同じですので、
+シンタックスの好き嫌いで、どちらかを選んで使ってもらえばよいでしょう。
</para>
</sect1>
@@ -65,25 +65,22 @@ fml ML名 コマンド オプション
<para>
&fmldevel; では、機能ごとに個別にコマンドを用意するようにしていますが、
-やたらと多くなるだけなので、以下のような基準に基づき用意することにしま
-す(2003/03 記)。
-</para>
-
-<para>
-できるだけ分離しないで makefml に統合するべきかな〜と思います。
-てきぎ admin コマンドや CGI でも使えるようになりうるので、
-再利用性が高いですしね。
+どうも、このポリシーでは、やたらと多くなるだけのようです。「できるだけ
+分離せずに makefml に統合するべき」でしょう。そこで、以下のような基準
+に基づき用意することにします(2003/03 記)。makefml に統合してある方が
+admin コマンドや CGI でも使えるようになりうるので、再利用性が高いので
+有益です。
</para>
<sect2>
<title>
- 特定のMLに操作を施すコマンド
+ 特定のMLに操作を施すコマンド (read/write)
</title>
<para>
-特定のMLに対し、何らかのデータを見るだけでなく操作をする可能性がある
-なら、makefml (or fml) のコマンドとして実装する。
+特定のMLに対し、何らかのデータを見るだけでなく変更/書き込み操作をす
+る可能性があるなら、makefml (or fml) のコマンドとして実装します。
<screen>
makefml コマンド ML名 オプション
fml ML名 コマンド オプション
@@ -95,7 +92,7 @@ fml ML名 コマンド オプション
<sect2>
<title>
- 特定のMLのデータを見るコマンド
+ 特定のMLのデータを見るコマンド (read only)
</title>
<para>
@@ -112,10 +109,9 @@ fml ML名 コマンド オプション
<sect2>
<title>
- データを見るだけのコマンド
+ データを見るだけのコマンド (read only)
</title>
-
<para>
特定のMLと関わりのないものもある。モジュールのドキュメントを見るとか、
OS のアカウントやエイリアス一覧を表示させる類のものだ。
@@ -134,12 +130,11 @@ fmlconf [-n] $ml
<sect2>
<title>
操作を施すコマンドだが、
- 特定のMLとの関わりはないかも知れないタイプ
+ 特定のMLとの関わりはないかも知れないタイプ (read / write ?)
</title>
<para>
-これが一番困るケースのような気がする。
-どうしても作る必要があるなら、
+これが一番困るケースのような気がする。どうしても作る必要があるなら、
fml が頭文字につくコマンドを別途用意する。
</para>
@@ -163,8 +158,6 @@ fmlhtmlify [-I DIR] $src_dir $dst_dir
&sect.usage.fmlalias;
&sect.usage.fmlconf;
&sect.usage.fmldoc;
-&sect.usage.fmlthread;
&sect.usage.fmlhtmlify;
-&sect.usage.fmlsummary;
</chapter>
diff --git a/fml/doc/ja/tutorial/usage/command.sgml b/fml/doc/ja/tutorial/usage/command.sgml
index 828c24f7..c62dfaf5 100644
--- a/fml/doc/ja/tutorial/usage/command.sgml
+++ b/fml/doc/ja/tutorial/usage/command.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: command.sgml,v 1.5 2002/07/28 06:26:57 fukachan Exp $
+ $FML: command.sgml,v 1.6 2002/09/28 14:14:07 fukachan Exp $
-->
<sect1 id="fml.command.bymail">
@@ -16,14 +16,19 @@ fml にメールで文字列(コマンド)を送り込むことで、fml に特定の処理をして
<important>
<para>
fml の基本的な使い方は makefml を使った操作です。
-makefml ではすべての作業が許されます。
</para>
<para>
-一方、コマンドメールなどでユーザに提供されているコマンド操作は
-makefml による操作のごく一部です。
-それは makefml のコマンドの一部を使えなくし、
-適宜 confirmation を付け加えたコマンド体系といってよいでしょう。
+makefml を使えるということは、MLサーバのホストのシェルが取れている、
+つまり SSH なりでそのホストに入る際にMLの管理者であると認証されてい
+るわけです。よって、特権的な操作といえます。
+</para>
+
+<para>
+一方、コマンドメールなどでユーザに提供されているコマンド操作は makefml
+で可能な操作のごく一部です。つまり、コマンドメールとは makefml のコマ
+ンドの一部を使えなくし、適宜 confirmation を付け加えたコマンド体系といっ
+てよいでしょう。
</para>
</important>
@@ -37,10 +42,9 @@ makefml による操作のごく一部です。
elena MLの場合、
コマンドメールを elena-ctl@fml.org に送信してください。
メールは MTA が受け、最終的に MTA は
-/usr/local/libexec/fml/fml.pl --ctladdr
-(もしくは /usr/local/libexec/fml/command )
-というコマンドを実行します。
-fml.pl はメールを標準入力から受けとり、
+/usr/local/libexec/fml/command
+というプログラムを実行します。
+command はメールを標準入力から受けとり、
MLとして必要な処理をした後、MTA へ配送を委ねます。
</para>
diff --git a/fml/doc/ja/tutorial/usage/fmlsummary.sgml b/fml/doc/ja/tutorial/usage/fmlsummary.sgml
deleted file mode 100644
index 49c5088a..00000000
--- a/fml/doc/ja/tutorial/usage/fmlsummary.sgml
+++ /dev/null
@@ -1,27 +0,0 @@
-<!--
- $FML: fmlsummary.sgml,v 1.5 2002/09/28 12:45:21 fukachan Exp $
--->
-
-<sect1 id="usage.fmlsummary">
- <title>
- サマリファイルの生成ユーティリティ (fmlsummary コマンド)
- </title>
-
-<para>
-summary ファイルの操作をするコマンドです。fml4 の
-/usr/local/fml/bin/summary.pl をもうちょっと賢くしてみた(?)ものといえ
-ます。
-</para>
-
-<para>
-summary を再生成するには、次のように実行して下さい。
-<screen>
-% fmlsummary コマンド ML名
-
-% fmlsummary rebuild elena
-% fmlsummary rebuild elena@fml.org
-</screen>
-
-</para>
-
-</sect1>
diff --git a/fml/doc/ja/tutorial/usage/fmlthread.sgml b/fml/doc/ja/tutorial/usage/fmlthread.sgml
deleted file mode 100644
index cd975917..00000000
--- a/fml/doc/ja/tutorial/usage/fmlthread.sgml
+++ /dev/null
@@ -1,26 +0,0 @@
-<!--
- $FML: fmlthread.sgml,v 1.2 2002/07/07 01:57:12 fukachan Exp $
--->
-
-<sect1 id="usage.fmlthread">
- <title>
- スレッドを表示する (fmlthread コマンド)
- </title>
-
-<para>
-fmlthread は引数にコマンドとML名をとります。
-疑似チケットシステムへのインターフェイスです。
-
-close されていないチケット一覧を表示
-<screen>
-% fmlthread list elena
-</screen>
-
-チケットを close する。
-<screen>
-% fmlthread close elena チケット番号
-</screen>
-
-</para>
-
-</sect1>
diff --git a/fml/doc/ja/tutorial/usage/get.sgml b/fml/doc/ja/tutorial/usage/get.sgml
index c99ec072..bc3a3c7b 100644
--- a/fml/doc/ja/tutorial/usage/get.sgml
+++ b/fml/doc/ja/tutorial/usage/get.sgml
@@ -1,5 +1,5 @@
<!--
- $FML$
+ $FML: get.sgml,v 1.1 2002/07/28 12:20:19 fukachan Exp $
-->
<sect1 id="usage.user.get">
@@ -15,7 +15,7 @@ get 記事番号
</screen>
と書いたメールを
elena-ctl@fml.org に送って下さい。
-記事が送り返されます。
+記事が mime/multipart で送り返されます。
</para>
</sect1>
diff --git a/fml/doc/ja/tutorial/usage/makefml.sgml b/fml/doc/ja/tutorial/usage/makefml.sgml
index 7f47e521..9608fee2 100644
--- a/fml/doc/ja/tutorial/usage/makefml.sgml
+++ b/fml/doc/ja/tutorial/usage/makefml.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: makefml.sgml,v 1.5 2002/07/28 06:26:58 fukachan Exp $
+ $FML: makefml.sgml,v 1.6 2002/07/28 23:33:43 fukachan Exp $
-->
@@ -13,10 +13,10 @@
% su fml
% makefml newml ML名
</screen>
-ML名は @ 抜きの場合デフォルトのドメイン、
-アドレスを完全に指定すればバーチャルドメインまで含めて
-makefml がよろしくがんばります。
-例えば
+ML名は@抜きの場合、デフォルトのドメインとなり、アドレスを完全に指定
+すればバーチャルドメインまで含めてmakefml がよろしくがんばることになっ
+ています。もちろんデフォルトかバーチャルかにかかわらず、常に@ドメイン
+つきで指定して構いません。例えば
<screen>
% makefml newml elena
% makefml newml elena@fml.org
@@ -109,7 +109,7 @@ resign
signoff
unsubscribe
</screen>
-でも同様です。
+どれを使っても同じです。
</para>
@@ -125,7 +125,7 @@ unsubscribe
<para>
<screen>
% su fml
-% makefml useradd ML名 古いメールアドレス 新しいメールアドレス
+% makefml chaddr ML名 古いメールアドレス 新しいメールアドレス
</screen>
ML名は @ 抜きの場合デフォルトのドメイン、
アドレスを完全に指定すればバーチャルドメインまで含めて
@@ -195,8 +195,18 @@ off の反対
<screen>
% makefml list elena
</screen>
+これはメンバーのリスト(投稿可能者のリスト)を表示します。
+<screen>
+% makefml list elena recipient
+</screen>
+は受信者のリストを表示します。
+この形式でいいのか疑問なんですが…
</para>
+<!--
+ XXX-TODO この形式でいいのか疑問なんですが… (makefml list elena recipient)
+-->
+
</sect1>
@@ -207,7 +217,7 @@ off の反対
<para>
(まだ、できません;-)。
-config.cf などを編集して下さい。
+config.cf などをエディタで編集して下さい。
</para>
</sect1>
@@ -258,7 +268,7 @@ addpriv
byeadmin
byepriv
</screen>
-でも同様です。
+どれを使っても同じです。
</para>
diff --git a/fml/doc/ja/tutorial/usage/post.sgml b/fml/doc/ja/tutorial/usage/post.sgml
index 9e6e7590..0f4d8c64 100644
--- a/fml/doc/ja/tutorial/usage/post.sgml
+++ b/fml/doc/ja/tutorial/usage/post.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: post.sgml,v 1.5 2002/07/07 01:57:12 fukachan Exp $
+ $FML: post.sgml,v 1.6 2002/09/28 14:14:07 fukachan Exp $
-->
<sect1 id="usage.post">
@@ -11,8 +11,7 @@
fml.org の elena MLへの投稿は、
普通にメールを elena@fml.org に送信することです。
メールは MTA が受け、最終的に MTA は
-/usr/local/libexec/fml/fml.pl
-(もしくは /usr/local/libexec/fml/distribute )
+/usr/local/libexec/fml/distribute
というコマンドを実行します。
fml.pl はメールを標準入力から受けとり、
MLとして必要な処理(記事の保存やヘッダの書き換え)をした後、
@@ -29,6 +28,8 @@ MTA へ配送処理を委ねます。
<para>
subject のタグをつける、もしくは記事番号などを更新するなど
<screen>
+例
+
Subject: [elena:00100] えれなさん素敵
</screen>
(デフォルトではつけません)
@@ -55,6 +56,10 @@ HTML 化された記事を作る。
投稿記事の振舞いを制御する変数
</title>
+<!--
+XXX-TODO 投稿記事の振舞いを制御する変数
+-->
+
<warning>
<para>
ごめん、まだ、書いてない
@@ -76,7 +81,7 @@ fml ブートローダ
<para>
-libexec/loader は /etc/fml/main.cf を読みこみます。
+libexec/loader は etc/fml/main.cf を読みこみます。
fml_version 変数から使うべきライブラリのバージョンを決めます。
例えば fml_vesrion が current-20010501 となっていたら
/usr/local/lib/fml/current-20010501/ 以下にあるライブラリを使うといった