summaryrefslogtreecommitdiff
path: root/fml/doc/ja
diff options
context:
space:
mode:
authorfukachan <fukachan>2001-04-25 14:30:19 +0000
committerfukachan <fukachan>2001-04-25 14:30:19 +0000
commita0ec7d2f43ded31fdd563b13d36b6200c811dacb (patch)
tree4dfaf6e2f79286c998b0450bf9a62a49bdaa9dc9 /fml/doc/ja
parent04684326209adbee15228488fb4f51ef30cfae79 (diff)
downloadfml8-a0ec7d2f43ded31fdd563b13d36b6200c811dacb.tar.gz
fml8-a0ec7d2f43ded31fdd563b13d36b6200c811dacb.tar.bz2
fml8-a0ec7d2f43ded31fdd563b13d36b6200c811dacb.zip
merge guide.html and mailinglist.html
Diffstat (limited to 'fml/doc/ja')
-rw-r--r--fml/doc/ja/htdocs/guide.html177
-rw-r--r--fml/doc/ja/htdocs/mailinglist.html57
-rw-r--r--fml/doc/ja/htdocs/menubar.html8
-rw-r--r--fml/doc/ja/tutorial/fml-devel.sgml3
-rw-r--r--fml/doc/ja/tutorial/include.sgml3
-rw-r--r--fml/doc/ja/tutorial/overview.sgml204
-rw-r--r--fml/doc/ja/tutorial/overview/chapter.sgml204
-rw-r--r--fml/doc/ja/tutorial/preface.sgml52
8 files changed, 468 insertions, 240 deletions
diff --git a/fml/doc/ja/htdocs/guide.html b/fml/doc/ja/htdocs/guide.html
deleted file mode 100644
index 48ce0081..00000000
--- a/fml/doc/ja/htdocs/guide.html
+++ /dev/null
@@ -1,177 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<HTML>
-<HEAD>
-<TITLE>
-簡単なガイド
-</TITLE>
-<META http-equiv="Content-Type"
- content="text/html; charset=EUC-JP">
-</HEAD>
-
-<BODY BGCOLOR="#E6E6FA">
-<!-- ================== body =========================================== -->
-
-<CENTER>
-簡単な設定ガイド
-</CENTER>
-
-注: 特に触れていない概念については fml 4.0 と同じなので、4.0 の資料を
-参照して下さい。
-
-これは動くとはいえ、まだまだ開発者向けのプログラムであることに注意して
-下さい。実運用には
-<A HREF="http://www.fml.org/fml/">fml 4.0</A>
-系を御利用下さい。
-
-<UL>
- <LI>
- <A HREF="ftp://ftp.fml.org/pub/fml-devel/" TARGET="right">
- ダウンロードする。
- </A>
-
- <LI>
- <A HREF="install.ja.html">
- ユーザ root でインストールをする。
- </A>
-
- <LI>
- <A HREF="#programs"> 使用できるコマンドについて </A>
-
- <LI>
- <A HREF="#newml">ユーザ fml で MLを作る。 </A>
-
- <LI>
- <A HREF="#config.cf"> カスタマイズをする。 </A>
-</UL>
-
-<HR>
-<A NAME="programs">
-<P> コマンドについて
-<BR>
-
-インストーラは /usr/local/bin に
-
- fmldoc fmlconf fmlticket makefml
-
-をインストールします。これらは実は /usr/local/libexec/fml の下の実体を
-呼び出す単なる wrapper です。
-
-fmldoc の使い方は perldoc と同様です。fml の任意のモジュールに対しその
-ドキュメントを表示します。
-実のところ perldoc への wrapper です。
-<PRE>
-例:
-% fmldoc FML::Process::Kernel
-</PRE>
-
-fmlconf は引数にML名をとり、そのMLの変数一覧を表示します。
--n をつけるとデフォルトと異なる変数のみを表示します。
-<PRE>
-例:
-% fmlconf elena
-% fmlconf -n elena
-</PRE>
-
-fmlticket は引数にコマンドとML名をとります。
-チケットシステムへのインターフェイスです。
-まだ製作途中です。
-<PRE>
-例: close されていないチケット一覧を表示
-% fmlticket list elena
-
-例: チケットを close する。
-% fmlticket close elena チケット番号
-</PRE>
-
-makefml の使い方は fml 4.0 の makefml と同様です。
-現在使えるコマンドは以下のものだけです。
-<UL>
- <LI>メンバーの登録
- <LI>メンバーの削除
- <LI>MLの作成( newml )
-</UL>
-
-
-<HR>
-<A NAME="newml">
-<P> MLを作る
-
-fml 4.0 と同様です。
-が、config.cf という設定ファイルをインストールしてくれるだけです。
-<PRE>
-% su fml
-% makefml newml elena
-% ls /var/spool/ml/elena
-config.cf
-</PRE>
-
-とりあえず config.cf の先頭の ml_domain と ml_name を
-自分のMLに変更して下さい。
-まだ自動変換できません(そのうちします)。
-<PRE>
-config.cf の例
-
-# ドメイン名 (参照: 以下のアドレスを見よ $ml_domain がこの値に展開される)
-ml_domain = fml.org
-
-# ML の名前
-ml_name = elena
-
-# 管理者のアドレス
-maintainer = $ml_name-admin@$ml_domain
-
-# 投稿用のアドレス
-address_for_post = $ml_name@$ml_domain
-
-# コマンド用のアドレス
-address_for_command = $ml_name-ctl@$ml_domain
-</PRE>
-
-
-include include-ctl aliases も fml 4.0 と同様です。
-が、まだ、makefml newml で自動生成できるようになっていません _o_
-
-/var/spool/ml/elena/include ファイルは
-<PRE>
-"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena"
-</PRE>
-
-/var/spool/ml/elena/include-ctl ファイルは
-<PRE>
-"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena --ctladdr"
-</PRE>
-
-aliases への追加は次のようにして下さい。
-<PRE>
-elena: :include:/var/spool/ml/elena/include
-elena-ctl: :include:/var/spool/ml/elena/include-ctl
-elena-admin: fml
-owner-elena: fml
-owner-elena-ctl: fml
-</PRE>
-
-
-<HR>
-<A NAME="config.cf">
-<P> カスタマイズをする
-
-elena MLの設定のカスタマイズは /var/spool/ml/elena/config.cf を編集
-して下さい。フォーマットは fml 4.0 の cf に近いですが、postfix の設定
-ファイルと同様です。
-
-必要な項目を追加して下さい。それ以外はデフォルト値が使われます。
-デフォルト値はインストールしたバージョンに依存し、
-<PRE>
-/etc/fml/defaults/バージョン番号/default_config.cf
-</PRE>
-というファイルで定義されています。
-これは perl のライブラリが /usr/local/lib/perl/5.00503/ のように
-バージョン番号付のディレクトリに置かれるのと同様です。
-
-インストールした fml のバージョンごとに全部別のディレクトリに
-置かれることに注意して下さい。
-この仕組みのおかげでアップグレードしても元に戻すのが簡単です。
-
-
-</BODY>
-</HTML>
diff --git a/fml/doc/ja/htdocs/mailinglist.html b/fml/doc/ja/htdocs/mailinglist.html
deleted file mode 100644
index d9e4a04f..00000000
--- a/fml/doc/ja/htdocs/mailinglist.html
+++ /dev/null
@@ -1,57 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<HTML>
-<HEAD>
-<TITLE>
-fml5 (仮名) プロジェクトのメーリングリスト
-</TITLE>
-<META http-equiv="Content-Type"
- content="text/html; charset=EUC-JP">
-</HEAD>
-
-<BODY BGCOLOR="#E6E6FA">
-<!-- ================== body =========================================== -->
-
-<CENTER>
-fml5 (仮名) プロジェクトのメーリングリスト
-</CENTER>
-
-<PRE>
-fml 5 の議論のためのメーリングリストを用意してあります。
-投稿用のアドレスは
-
-<address>fml-devel@ffs.fml.org (日本語)</address>
-
-です。fml-devel MLのログは
-<A HREF="http://www.fml.org/mlarchives/">
-http://www.fml.org/mlarchives/
-</A>
-で公開しています。
-
-MLに参加しないが、要望等を送りたいという場合、MLではなく
-
-<address>fml-request@fml.org</address>
-
-へメールを送って下さい。このメールは適宜 fml-devel 等に流して議論した
-いと思います。他にフォワードなどされたくない場合はその旨を一筆書いてお
-いて下さい。
-
-
-<P> <B>登録の仕方</B>
-<BR>
-
-登録の仕方はいつもと一緒です。
-
-fml-devel MLへの自動登録は fml-devel-ctl@ffs.fml.org へ
-subscribe の後に自分の名前をローマ字で続けたフレーズをメールの"本文"
-(注意: メールの本文)に書いて送って下さい。例えば次のようになります。
-<PRE>
- To: fml-devel-ctl@ffs.fml.org
-
- subscribe Kinomoto Sakura
-</PRE>
-このメールに対し、登録意志確認のメールが送り返されてきます。
-そのメールに返事をしてください。
-MLに登録されます。
-
-</BODY>
-</HTML>
diff --git a/fml/doc/ja/htdocs/menubar.html b/fml/doc/ja/htdocs/menubar.html
index a04bb65d..d7d7aa28 100644
--- a/fml/doc/ja/htdocs/menubar.html
+++ b/fml/doc/ja/htdocs/menubar.html
@@ -45,7 +45,8 @@ fml-devel (fml 5.0) project menu
</A>
<LI>
- <A HREF="mailinglist.html" TARGET="right">
+ <A HREF="../../../../Documentation/ja/tutorial/mailinglist.html"
+ TARGET="right">
メーリングリスト
</A>
<BR>
@@ -55,8 +56,9 @@ fml-devel (fml 5.0) project menu
</A>
<LI>
- <A HREF="guide.html" TARGET="right">
- 設定ガイド
+ <A HREF="../../../../Documentation/ja/tutorial/overview.html"
+ TARGET="right">
+ 設定のおおまかな流れ
</A>
<LI>
diff --git a/fml/doc/ja/tutorial/fml-devel.sgml b/fml/doc/ja/tutorial/fml-devel.sgml
index e75f1e04..23db0e84 100644
--- a/fml/doc/ja/tutorial/fml-devel.sgml
+++ b/fml/doc/ja/tutorial/fml-devel.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: fml-devel.sgml,v 1.12 2001/04/25 02:55:56 fukachan Exp $
+$FML: fml-devel.sgml,v 1.13 2001/04/25 03:54:02 fukachan Exp $
-->
<!doctype book public "-//OASIS//DTD DocBook V3.1//EN" [
@@ -36,6 +36,7 @@ $FML: fml-devel.sgml,v 1.12 2001/04/25 02:55:56 fukachan Exp $
<!-- 以下、各章が並ぶ -->
&intro;
+ &overview;
&download;
&install;
&available;
diff --git a/fml/doc/ja/tutorial/include.sgml b/fml/doc/ja/tutorial/include.sgml
index 3a79f1ba..f7300d57 100644
--- a/fml/doc/ja/tutorial/include.sgml
+++ b/fml/doc/ja/tutorial/include.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: include.sgml,v 1.11 2001/04/25 02:55:56 fukachan Exp $
+ $FML: include.sgml,v 1.12 2001/04/25 03:54:02 fukachan Exp $
-->
<!entity versin "1.1">
@@ -19,6 +19,7 @@
<!entity main.cf SYSTEM "main.cf.sgml">
<!entity commands SYSTEM "commands.sgml">
+<!entity overview SYSTEM "overview.sgml">
<!entity design SYSTEM "design.sgml">
<!entity bootloader SYSTEM "bootloader.sgml">
diff --git a/fml/doc/ja/tutorial/overview.sgml b/fml/doc/ja/tutorial/overview.sgml
new file mode 100644
index 00000000..996474c3
--- /dev/null
+++ b/fml/doc/ja/tutorial/overview.sgml
@@ -0,0 +1,204 @@
+<!--
+ $FML$
+-->
+
+<chapter id="overview">
+<title> おおまかな流れ </title>
+
+<sect1>
+ <title> 概要 </title>
+
+<warning>
+<para>
+fml-devel
+は動くとはいえ、まだまだ開発者向けのプログラムであることに注意して
+下さい。実運用には
+ <ulink url="http://www.fml.org/fml/">
+ fml 4.0
+ </ulink>
+系を御利用下さい。
+</para>
+</warning>
+
+
+<para>
+以下で、特に触れていない概念(例: MLとは?)については fml 4.0 と同様
+です。4.0 の資料を適宜参照して下さい。
+</para>
+
+<para>
+いつものように elena MLを例にとりましょう。
+elena MLを作成するまでのおおまかな流れは次のようになります。
+</para>
+
+
+<orderedlist>
+ <listitem>
+ <para>
+ <link linkend="download">
+ ソースをダウンロードをする。
+ </link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="install">
+ ユーザ root でインストールをする。
+ </link>
+
+ インストーラは /usr/local/bin に
+ fmldoc fmlconf fmlticket makefml
+ をインストールします。
+
+ これらは、
+ 実は、
+ /usr/local/libexec/fml の下の実体を呼び出す単なる
+ wrapper です。
+
+ なお、インストールされるコマンドの一覧は
+ <link linkend="available">
+ ここ
+ </link>
+ にあります。
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <link linkend="guide.newml">
+ ユーザ fml で elena MLを作る。
+ </link>
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <link linkend="guide.config.cf">
+ カスタマイズをする。
+ </link>
+ </para>
+ </listitem>
+
+</orderedlist>
+
+</sect1>
+
+
+
+
+<sect1 id="guide.newml">
+
+ <title> MLを作る </title>
+
+<para>
+fml 4.0 と同様です。
+が、config.cf という設定ファイルをインストールしてくれるだけです。
+
+インストール後は、次のようになるはずです。
+<screen>
+% su fml
+% makefml newml elena
+% ls /var/spool/ml/elena
+config.cf
+</screen>
+</para>
+
+
+<para>
+とりあえず config.cf の先頭の ml_domain と ml_name を
+自分のMLに変更して下さい。
+まだ自動変換できません(そのうちします)。
+</para>
+
+
+<para>
+<screen>
+config.cf の例
+
+# ドメイン名 (参照: 以下のアドレスを見よ $ml_domain がこの値に展開される)
+ml_domain = fml.org
+
+# ML の名前
+ml_name = elena
+
+# 管理者のアドレス
+maintainer = $ml_name-admin@$ml_domain
+
+# 投稿用のアドレス
+address_for_post = $ml_name@$ml_domain
+
+# コマンド用のアドレス
+address_for_command = $ml_name-ctl@$ml_domain
+</screen>
+</para>
+
+
+<para>
+include include-ctl aliases も fml 4.0 と同様です。
+が、まだ、makefml newml で自動生成できるようになっていません _o_
+</para>
+
+<para>
+/var/spool/ml/elena/include ファイルは
+<screen>
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena"
+</screen>
+
+/var/spool/ml/elena/include-ctl ファイルは
+<screen>
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena --ctladdr"
+</screen>
+</para>
+
+
+<para>
+aliases への追加は次のようにして下さい。
+<screen>
+elena: :include:/var/spool/ml/elena/include
+elena-ctl: :include:/var/spool/ml/elena/include-ctl
+elena-admin: fml
+owner-elena: fml
+owner-elena-ctl: fml
+</screen>
+</para>
+
+</sect1>
+
+
+
+<sect1 id="guide.config.cf">
+
+<title> カスタマイズをする </title>
+
+<para>
+elena MLの設定のカスタマイズは /var/spool/ml/elena/config.cf を編集
+して下さい。フォーマットは fml 4.0 の cf に近いですが、postfix の設定
+ファイルと同様です。
+</para>
+
+<para>
+必要な項目を追加して下さい。それ以外はデフォルト値が使われます。
+デフォルト値はインストールしたバージョンに依存し、
+
+<screen>
+/etc/fml/defaults/バージョン番号/default_config.cf
+</screen>
+
+というファイルで定義されています。
+
+これは perl のライブラリが /usr/local/lib/perl/5.00503/ のように
+バージョン番号付のディレクトリに置かれるのと同様です。
+</para>
+
+<para>
+インストールした fml のバージョンごとに全部別のディレクトリに
+置かれることに注意して下さい。
+この仕組みのおかげでアップグレードしても元に戻すのが簡単です。
+</para>
+
+</sect1>
+
+</chapter>
diff --git a/fml/doc/ja/tutorial/overview/chapter.sgml b/fml/doc/ja/tutorial/overview/chapter.sgml
new file mode 100644
index 00000000..996474c3
--- /dev/null
+++ b/fml/doc/ja/tutorial/overview/chapter.sgml
@@ -0,0 +1,204 @@
+<!--
+ $FML$
+-->
+
+<chapter id="overview">
+<title> おおまかな流れ </title>
+
+<sect1>
+ <title> 概要 </title>
+
+<warning>
+<para>
+fml-devel
+は動くとはいえ、まだまだ開発者向けのプログラムであることに注意して
+下さい。実運用には
+ <ulink url="http://www.fml.org/fml/">
+ fml 4.0
+ </ulink>
+系を御利用下さい。
+</para>
+</warning>
+
+
+<para>
+以下で、特に触れていない概念(例: MLとは?)については fml 4.0 と同様
+です。4.0 の資料を適宜参照して下さい。
+</para>
+
+<para>
+いつものように elena MLを例にとりましょう。
+elena MLを作成するまでのおおまかな流れは次のようになります。
+</para>
+
+
+<orderedlist>
+ <listitem>
+ <para>
+ <link linkend="download">
+ ソースをダウンロードをする。
+ </link>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <link linkend="install">
+ ユーザ root でインストールをする。
+ </link>
+
+ インストーラは /usr/local/bin に
+ fmldoc fmlconf fmlticket makefml
+ をインストールします。
+
+ これらは、
+ 実は、
+ /usr/local/libexec/fml の下の実体を呼び出す単なる
+ wrapper です。
+
+ なお、インストールされるコマンドの一覧は
+ <link linkend="available">
+ ここ
+ </link>
+ にあります。
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <link linkend="guide.newml">
+ ユーザ fml で elena MLを作る。
+ </link>
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <link linkend="guide.config.cf">
+ カスタマイズをする。
+ </link>
+ </para>
+ </listitem>
+
+</orderedlist>
+
+</sect1>
+
+
+
+
+<sect1 id="guide.newml">
+
+ <title> MLを作る </title>
+
+<para>
+fml 4.0 と同様です。
+が、config.cf という設定ファイルをインストールしてくれるだけです。
+
+インストール後は、次のようになるはずです。
+<screen>
+% su fml
+% makefml newml elena
+% ls /var/spool/ml/elena
+config.cf
+</screen>
+</para>
+
+
+<para>
+とりあえず config.cf の先頭の ml_domain と ml_name を
+自分のMLに変更して下さい。
+まだ自動変換できません(そのうちします)。
+</para>
+
+
+<para>
+<screen>
+config.cf の例
+
+# ドメイン名 (参照: 以下のアドレスを見よ $ml_domain がこの値に展開される)
+ml_domain = fml.org
+
+# ML の名前
+ml_name = elena
+
+# 管理者のアドレス
+maintainer = $ml_name-admin@$ml_domain
+
+# 投稿用のアドレス
+address_for_post = $ml_name@$ml_domain
+
+# コマンド用のアドレス
+address_for_command = $ml_name-ctl@$ml_domain
+</screen>
+</para>
+
+
+<para>
+include include-ctl aliases も fml 4.0 と同様です。
+が、まだ、makefml newml で自動生成できるようになっていません _o_
+</para>
+
+<para>
+/var/spool/ml/elena/include ファイルは
+<screen>
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena"
+</screen>
+
+/var/spool/ml/elena/include-ctl ファイルは
+<screen>
+"| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena --ctladdr"
+</screen>
+</para>
+
+
+<para>
+aliases への追加は次のようにして下さい。
+<screen>
+elena: :include:/var/spool/ml/elena/include
+elena-ctl: :include:/var/spool/ml/elena/include-ctl
+elena-admin: fml
+owner-elena: fml
+owner-elena-ctl: fml
+</screen>
+</para>
+
+</sect1>
+
+
+
+<sect1 id="guide.config.cf">
+
+<title> カスタマイズをする </title>
+
+<para>
+elena MLの設定のカスタマイズは /var/spool/ml/elena/config.cf を編集
+して下さい。フォーマットは fml 4.0 の cf に近いですが、postfix の設定
+ファイルと同様です。
+</para>
+
+<para>
+必要な項目を追加して下さい。それ以外はデフォルト値が使われます。
+デフォルト値はインストールしたバージョンに依存し、
+
+<screen>
+/etc/fml/defaults/バージョン番号/default_config.cf
+</screen>
+
+というファイルで定義されています。
+
+これは perl のライブラリが /usr/local/lib/perl/5.00503/ のように
+バージョン番号付のディレクトリに置かれるのと同様です。
+</para>
+
+<para>
+インストールした fml のバージョンごとに全部別のディレクトリに
+置かれることに注意して下さい。
+この仕組みのおかげでアップグレードしても元に戻すのが簡単です。
+</para>
+
+</sect1>
+
+</chapter>
diff --git a/fml/doc/ja/tutorial/preface.sgml b/fml/doc/ja/tutorial/preface.sgml
index 0b73637b..b4945e65 100644
--- a/fml/doc/ja/tutorial/preface.sgml
+++ b/fml/doc/ja/tutorial/preface.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: preface.sgml,v 1.3 2001/04/24 13:33:34 fukachan Exp $
+ $FML: preface.sgml,v 1.4 2001/04/25 02:55:56 fukachan Exp $
-->
<preface>
@@ -157,6 +157,56 @@ fml-devel で作られたモジュールのマージおよび
<!-- ======================================================== -->
+<sect1 id="mailinglist">
+
+ <title> メーリングリスト </title>
+
+<para>
+fml 5 の議論のためのメーリングリストを用意してあります。
+</para>
+
+<para>
+登録の仕方はいつもと一緒です。
+
+fml-devel MLへの自動登録は fml-devel-ctl@ffs.fml.org へ
+subscribe の後に自分の名前をローマ字で続けたフレーズをメールの"本文"
+(注意: メールの本文)に書いて送って下さい。例えば次のようになります。
+
+<screen>
+To: fml-devel-ctl@ffs.fml.org
+
+subscribe Kinomoto Sakura
+</screen>
+
+このメールに対し、登録意志確認のメールが送り返されてきます。
+そのメールに返事をしてください。
+MLに登録されます。
+</para>
+
+<para>
+fml-devel MLのログは
+ <ulink url="http://www.fml.org/mlarchives/">
+ http://www.fml.org/mlarchives/
+ </ulink>
+で公開しています。
+</para>
+
+<para>
+MLに参加しないが、要望等を送りたいという場合、MLではなく
+
+ <ulink url="mailto:fml-request@fml.org">
+ fml-request@fml.org
+ </ulink>
+
+へメールを送って下さい。このメールは適宜 fml-devel 等に流して議論した
+いと思います。他にフォワードなどされたくない場合はその旨を一筆書いてお
+いて下さい。
+</para>
+
+</sect1>
+
+
+<!-- ======================================================== -->
<sect1>
<title> ご意見募集中 </title>