reorder, enrich part II

9 files changed, 478 insertions, 4 deletions

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: available.sgml,v 1.3 2001/11/23 15:00:47 fukachan Exp $
+-->
+
+<chapter id="available">
+	<title>
+	fml-devel の実行形式プログラム
+	</title>
+
+<para>
+プログラムには
+/usr/local/bin 以下にインストールされるものと、
+/usr/local/libexec/fml 以下にインストールされるものがあります。
+</para>
+
+<para>
+/usr/local/bin 以下にインストールされるものも、
+実体は /usr/local/libexec/fml 以下の同名のファイルです。
+そして、
+/usr/local/libexec/fml 以下のファイルは
+/usr/local/libexec/fml/loader へのリンクです。
+</para>
+
+<para>
+fml5 ではすべてのプログラムは /usr/local/libexec/fml/loader を経由して
+起動されます。バージョン依存性を処理するためです。
+</para>
+
+<para>
+loader は起動される時の名前で振舞いを変えています。
+</para>
+
+
+<sect1 id="usr.local.libexec.fml">
+
+	<title> /usr/local/libexec/fml/ のプログラム </title>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/distribute </title>
+
+<para>
+配送処理をするプログラムです。
+subject を書き換える。
+スプールに記事として溜める。
+IPv6 をしゃべる。
+チケット番号をふる。
+et. al. 
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/fml.pl </title>
+
+<para>
+distribute と同じ。
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/command </title>
+
+<para>
+command は fml.pl --ctladdr と同じです。
+</para>
+
+<para>  
+プログラム自体は動きますが、
+機能するコマンドはまだないです。
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/makefml.cgi </title>
+
+<para>
+makefml の CGI インターフェイス。
+うごくけど、まだプロトタイプ。
+動く機能は makefml と同等のものです。
+それは最終的に makefml と同じ関数を呼び出しているからです。
+</para>
+
+<programlisting>
+例:
+/cgi-bin/makefml.cgi?ml_name=elena&amp;method=bye&amp;address=rudo@nuinui.net
+</programlisting>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/fmlticket.cgi </title>
+
+
+<para>  
+fmlticket の CGI 版。
+チケットを close する。
+あるチケットに該当する記事群を表示する。
+</para>
+</sect2>
+		
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/mead </title>
+
+<para>  
+ま〜だだよ
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/libexec/fml/fmlserv </title>
+
+<para>  
+ま〜だだよ
+</para>
+
+</sect2>
+
+
+</sect1>
+<!-- 
+	###########################
+ -->
+<sect1 id="usr.local.bin">
+
+	<title> /usr/local/bin/ のプログラム </title>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/bin/makefml </title>
+
+
+<para>  
+登録と削除関係、および最低限のＭＬの作成だけは動きます
+(add subscribe bye unsubscribe resign remove そして newml)。
+</para>  
+
+<para>  
+使い方は fml 4.0 と一緒です。
+<screen>
+% makefml add elena アドレス
+% makefml bye elena アドレス
+% makefml newml elena
+</screen>
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+
+	<title>	/usr/local/bin/fmlconf	</title>
+
+<para>  変数一覧を表示します</para>
+</sect2>
+   
+
+<!-- ================================================== -->
+<sect2>
+	<title>	/usr/local/bin/fmldoc	</title>
+
+<para>
+モジュールのマニュアルを表示する
+perldoc への wrapper です。
+</para>
+
+</sect2>
+
+
+<!-- ================================================== -->
+<sect2>
+	<title>	/usr/local/bin/fmlticket	</title>
+
+<para>  
+現在のチケットシステムのサマリを表示する。
+チケットの close をする。
+</para>
+</sect2>
+
+</sect1>
+
+
+</chapter>
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: chapter.sgml,v 1.3 2001/10/13 08:47:54 fukachan Exp $
+-->
+
+<chapter id="fml.command.bymail">
+	<title>
+	コマンドメール (fml をメールで操作する)
+	</title>
+
+<para>
+fml にメールで文字列(コマンド)を送り込むことで、fml に特定の処理をして
+もらうことができます。例えば、メンバーの登録、削除や、過去の記事を取り
+寄せるなどの処理です。
+</para>
+
+
+<para>
+fml 5.0  では
+<screen>
+メールによるコマンド処理
+makefml によるコマンド処理
+CGI でのコマンド処理
+</screen>
+これらすべての機能が FML::Command:: クラスのモジュールを使うように
+設計されています。
+</para>
+
+
+<sect1 id="fml.command.bymail.flow">
+	<title>
+	処理の流れ
+	</title>
+
+<para>
+elena ＭＬの場合、
+コマンドメールを elena-ctl@fml.org に送信してください。
+メールは MTA が受け、最終的に MTA は
+/usr/local/libexec/fml/fml.pl --ctladdr
+(もしくは /usr/local/libexec/fml/command )
+というコマンドを実行します。
+fml.pl はメールを標準入力から受けとり、
+ＭＬとして必要な処理をした後、MTA へ配送を委ねます。
+</para>
+
+<warning>
+<para>
+4.0 と違い、5.0 ではコマンドの結果を
+<link linkend="message.reply">
+一通のメール ( MIME/Multipart )にまとめて返送
+</link>
+しています。
+</para>
+</warning>
+
+</sect1>
+
+
+<!-- モジュールの使い方について、 FML::Command:: 以下の話 -->
+&sect.command.module;
+
+<!-- コマンドの拡張例 -->
+&sect.command.extension;
+
+&sect.command.internal;
+
+</chapter>
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 @@
+<!--
+	$FML: fmlconf.sgml,v 1.2 2001/04/26 11:02:39 fukachan Exp $
+-->
+
+<sect1 id="usage.fmlconf">
+
+<title> 設定を表示する (fmlconf) </title>
+
+<para>
+fmlconf (/usr/local/bin/fmlconf) 
+は引数にＭＬ名をとり、そのＭＬの変数一覧を表示します。
+-n をつけるとデフォルトと異なる変数のみを表示します。
+
+<screen>
+% fmlconf elena
+% fmlconf -n elena
+</screen>
+
+</para>
+
+</sect1>
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 @@
+<!--
+	$FML: fmldoc.sgml,v 1.2 2001/04/26 11:02:39 fukachan Exp $
+-->
+
+<sect1 id="usage.fmldoc">
+
+<title> モジュールのドキュメントを表示する (fmldoc) </title>
+
+<para>
+fmldoc の使い方は perldoc と同様です。
+fml の任意のモジュールに対し、そのドキュメントを表示します。
+実のところ perldoc への wrapper です。
+</para>
+
+<para>
+例えば、FML::Process::Kernel のドキュメントが見たい場合、
+<screen>
+% fmldoc FML::Process::Kernel
+</screen>
+</para>
+
+</sect1>
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 @@
+<!--
+	$FML: fmlhtmlify.sgml,v 1.2 2001/04/26 11:02:39 fukachan Exp $
+-->
+
+<sect1 id="usage.fmlhtmlify">
+
+<title> 記事を HTML 化する (fmlhtmlify) </title>
+
+<para>
+<screen>
+% fmlhtmlify ＭＬ名
+</screen>
+
+</para>
+
+</sect1>
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 @@
+<!--
+	$FML: fmlthread.sgml,v 1.2 2001/04/26 11:02:40 fukachan Exp $
+-->
+
+<sect1 id="usage.fmlthread">
+
+<title> スレッドを表示する (fmlthread) </title>
+
+<para>
+fmlthread は引数にコマンドとＭＬ名をとります。
+疑似チケットシステムへのインターフェイスです。
+
+close されていないチケット一覧を表示
+<screen>
+% fmlthread list elena
+</screen>
+
+チケットを close する。
+<screen>
+% fmlthread close elena チケット番号
+</screen>
+
+</para>
+
+</sect1>
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 @@
+<!--
+   $FML: makefml.sgml,v 1.4 2001/10/13 08:47:58 fukachan Exp $
+-->
+
+<sect1 id="usage.makefml">
+
+<title> makefml を使って、ユーザの登録/削除他(あらゆる:) </title>
+
+<para>
+makefml の基本的な使い方は fml 4.0 の makefml と同様です。
+というより、できるだけ互換性を保つように構築する予定です。
+</para>
+
+<para>
+現状 makefml に命令を与えると admin コマンドと同じ動作をするようになっ
+ています。
+つまり特権的な動作ということです。
+例えば、メンバーの登録に confirmation は必要ありません。
+</para>
+
+<para>
+現在使えるコマンドは以下のものです。
+<itemizedlist>
+	<listitem>
+	<para>
+	メンバーの登録
+	(
+		subscribe
+		add
+	)
+	</para>
+	</listitem>
+
+	<listitem>
+	<para>
+	メンバーの削除
+	(
+		bye
+		remove
+		resign
+		signoff
+		unsubscribe
+	)
+	</para>
+	</listitem>
+
+	<listitem>
+	<para>
+	ＭＬの作成
+	(
+		newml 
+	)
+	</para>
+	</listitem>
+
+	<listitem>
+	<para>
+	ファイルを送り返す
+	(
+		get
+		mget
+	)
+	</para>
+	</listitem>
+
+</itemizedlist>
+</para>
+
+</sect1>
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 @@
+<!--
+	$FML: makefml.sgml,v 1.4 2001/10/13 08:47:58 fukachan Exp $
+-->
+
+<chapter id="usage.onhost">
+	<title>
+	ＭＬ管理者にできること (ＭＬサーバのホスト上)
+	</title>
+
+
+<sect1>
+	<title>
+	ホスト上でできること
+	</title>
+
+<para>
+ＭＬサーバのホストに入ることができる(例: slogin してシェルが取れる)
+人は、通常ＭＬにとって最強の人を意味します。
+</para>
+
+<para>
+ファイルを直接編集することで、どんなことでもできるわけですから、
+無敵です。
+</para>
+
+<para>
+しかしながら、人間間違いを犯すもので、ついフォーマットを
+間違えるといったことがあります。
+</para>
+
+<para>
+そのため、通常は makefml ( /usr/local/bin/makefml )を
+使うことで、fml を操作して下さい。
+</para>
+
+</sect1>
+
+
+&sect.usage.makefml;
+&sect.usage.fmlconf;
+&sect.usage.fmldoc;
+&sect.usage.fmlthread;
+&sect.usage.fmlhtmlify;
+
+
+</chapter>
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 @@
 <!--
-   $FML: bootloader.sgml,v 1.2 2001/05/10 03:11:43 fukachan Exp $
+   $FML: post.sgml,v 1.1.1.1 2001/11/23 15:47:37 fukachan Exp $
 -->
 
 <chapter id="usage.post">
@@ -20,7 +20,7 @@ fml.pl はメールを標準入力から受けとり、
 
 <sect1>
 	<title>
-	ＭＬとして処理するべきこと
+	fml.pl が ＭＬとして処理するべきこと
 	</title>
 
 
@@ -29,7 +29,7 @@ subject のタグをつける、もしくは記事番号などを更新するなど
 <screen>
 Subject: [elena:00100] えれなさん素敵
 </screen>
- (デフォルトではつけません)
+(デフォルトではつけません)
 </para>
 
 <para>
@@ -54,7 +54,7 @@ Subject: [elena:00100] えれなさん素敵
 
 
 <sect1>
-   <title> 備考: ブートしていく様子 </title>
+   <title> 解説: ブートしていく様子 </title>
 
 <para>
 <link linkend="bootloader">