summaryrefslogtreecommitdiff
path: root/fml/doc
diff options
context:
space:
mode:
authorfukachan <fukachan>2005-07-23 01:58:46 +0000
committerfukachan <fukachan>2005-07-23 01:58:46 +0000
commiteec2ead4b34df22168dc2620f46d78d2241a5602 (patch)
tree98f89ed9b05e0f6534339c376a80a71aa3940239 /fml/doc
parent18d7f372358ed3af0161ee56281357ec9b740dcb (diff)
downloadfml8-eec2ead4b34df22168dc2620f46d78d2241a5602.tar.gz
fml8-eec2ead4b34df22168dc2620f46d78d2241a5602.tar.bz2
fml8-eec2ead4b34df22168dc2620f46d78d2241a5602.zip
translated (sync).
Diffstat (limited to 'fml/doc')
-rw-r--r--fml/doc/en/tutorial/book.sgml69
-rw-r--r--fml/doc/en/tutorial/glossary.sgml7
-rw-r--r--fml/doc/en/tutorial/preface.sgml71
-rw-r--r--fml/doc/en/tutorial/terms.sgml88
4 files changed, 187 insertions, 48 deletions
diff --git a/fml/doc/en/tutorial/book.sgml b/fml/doc/en/tutorial/book.sgml
index 6d1f58dd..6773efec 100644
--- a/fml/doc/en/tutorial/book.sgml
+++ b/fml/doc/en/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.1 2003/07/24 15:37:34 fukachan Exp $
+ $FML: book.sgml,v 1.2 2003/07/26 09:10:39 fukachan Exp $
$jaFML: book.sgml,v 1.58 2003/05/31 08:51:07 fukachan Exp $
-->
@@ -19,14 +19,17 @@ to generate various output formats.
<toc></toc>
<part>
- <title> fml fundamental usage </title>
+ <title>
+ fml fundamental usage
+ </title>
+
<partintro>
<para>
- This part describes brief guide for beginners.
+ This part describes a brief guide for beginners.
</para>
<para>
See &www.fml.org; and other sites for more details on
- the mailing list.
+ mechanism of the mailing list.
</para>
</partintro>
@@ -53,11 +56,16 @@ to generate various output formats.
<!-- 2000/nt -->
&chapter.install.fml.nt;
+ <!-- fml4 to fml8, how-to and changes -->
+ &chapter.merge.fml4to8;
+ &chapter.changes;
+
<!-- misc around installation/setup -->
&chapter.upgrade;
<!-- CGI -->
&chapter.setup.cgi;
+ &chapter.setup.apache;
<!-- test -->
&chapter.setup.test;
@@ -65,7 +73,10 @@ to generate various output formats.
<part>
- <title> fml: how to customise </title>
+ <title>
+ fml: how to customise
+ </title>
+
<partintro>
<para>
topics driven in this part.
@@ -89,7 +100,26 @@ to generate various output formats.
<part>
- <title> troubleshooting </title>
+ <title>
+ Operations
+ </title>
+
+ <partintro>
+ <para>
+ This part describes operations.
+ </para>
+ </partintro>
+
+ &chapter.op.log;
+ &chapter.op.backup;
+ </part>
+
+
+ <part>
+ <title>
+ Troubleshoot
+ </title>
+
<partintro>
<para>
This part describes how to shoot troubles.
@@ -103,7 +133,10 @@ to generate various output formats.
<part>
- <title> fml design </title>
+ <title>
+ fml8 Design
+ </title>
+
<partintro>
<para>
THis part describes the design policy of fml.
@@ -116,7 +149,10 @@ to generate various output formats.
<part>
- <title> fml internals </title>
+ <title>
+ fml8 Internals
+ </title>
+
<partintro>
<para>
This part describles the fml internals for developers.
@@ -133,6 +169,7 @@ to generate various output formats.
<!-- delivery and command processing -->
&chapter.delivery;
&chapter.digest;
+ &chapter.language;
&chapter.message;
&chapter.filter;
<!-- &chapter.replybyfml; -->
@@ -159,16 +196,25 @@ to generate various output formats.
<!-- virtual domains -->
&chapter.virtual;
+ <!-- error mails -->
+ &chapter.errormail;
+
<!-- misc -->
&chapter.io.abstraction;
&chapter.lock;
&chapter.db.modules;
&chapter.dbms;
+
+ <!-- merge -->
+ &chapter.merge.internal;
</part>
<part>
- <title> modules </title>
+ <title>
+ Modules
+ </title>
+
<partintro>
<para>
This part descripbes how to use most important modules.
@@ -187,7 +233,9 @@ to generate various output formats.
*************** appendixes hereafter **************
-->
<part>
- <title> Apendixes </title>
+ <title>
+ Apendixes
+ </title>
&chapter.glossary;
@@ -197,7 +245,6 @@ to generate various output formats.
&chapter.docbook;
&chapter.inet6;
- <!-- thread track -->
&chapter.threadtrack.tools;
-->
diff --git a/fml/doc/en/tutorial/glossary.sgml b/fml/doc/en/tutorial/glossary.sgml
index 0fbaf5e6..cddc6c92 100644
--- a/fml/doc/en/tutorial/glossary.sgml
+++ b/fml/doc/en/tutorial/glossary.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: glossary.sgml,v 1.2 2003/07/26 09:10:39 fukachan Exp $
+ $FML: glossary.sgml,v 1.3 2003/07/27 15:31:52 fukachan Exp $
$jaFML: glossary.sgml,v 1.5 2003/04/15 14:51:34 fukachan Exp $
-->
@@ -139,7 +139,7 @@
<glossterm> fp </glossterm>
<glossdef>
<para>
- function pointer == code reference for perl 5.
+ function pointer == code reference of perl 5.
</para>
</glossdef>
</glossentry>
@@ -149,7 +149,7 @@
<glossterm> _foobar </glossterm>
<glossdef>
<para>
- keyword begininng with _ is used for internal function or variable.
+ keyword begining with _ is used for internal function or variable.
</para>
<para>
@@ -237,3 +237,4 @@ $euc_string = STR2EUC($string);
</glossary>
+
diff --git a/fml/doc/en/tutorial/preface.sgml b/fml/doc/en/tutorial/preface.sgml
index b18f7173..2240dfa2 100644
--- a/fml/doc/en/tutorial/preface.sgml
+++ b/fml/doc/en/tutorial/preface.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: preface.sgml,v 1.3 2003/07/26 04:52:00 fukachan Exp $
+ $FML: preface.sgml,v 1.4 2003/07/27 15:31:52 fukachan Exp $
$jaFML: preface.sgml,v 1.18 2003/04/15 14:51:35 fukachan Exp $
-->
@@ -18,20 +18,15 @@
<warning>
<para>
-&fmldevel; already implemented fundamental functions except for
-editing configuration files. Several people uses &fmldevel; as hobby
-and office mailing list system for a test.
+&fml8; already implemented fundamental functions. Several people uses
+&fml8; as hobby and office mailing list system under normal
+operations.
</para>
<para>
-&fml8; is intended to re-implement almost all &fml4; functions but not
-yet enough.
-So, if you are interested in the use of special features,
-please use
-<ulink url="http://www.fml.org/software/fml/menu.html">
-&fml4; stable
-</ulink>
-series.
+When you configure &fml8;, you need to edit configuration files since
+configuration helper tool has basic functions now. Except it, you can
+use &fml8; as same as &fml4;.
</para>
<para>
@@ -39,8 +34,17 @@ See
<ulink url="../../../fml/doc/ja/todo/STATUS.html">
http://www.fml.org/software/fml-devel/fml/doc/ja/todo/STATUS.html
</ulink>
-for the current status of &fmldevel;.
+for the current status of &fml8;.
</para>
+
+<para>
+See
+<link linkend="changes">
+<xref linkend="changes">
+</link>
+on the difference between &fml4; and &fml8;.
+</para>
+
</warning>
</sect1>
@@ -54,34 +58,35 @@ for the current status of &fmldevel;.
</title>
<para>
-&fmldevel; is fully rewritten mailing list driver from scratch to
+&fml8; is fully rewritten mailing list driver from scratch to
re-implement &fml4;. The main purpose of this project is
-re-implementation of fml mailing list driver system with reflecting my
+re-implementation of fml mailing list driver system with reflecting our
10 years experience on mailing list driver developement.
</para>
<para>
-Roughly speaking, the relation between &fml4; and &fmldevel; is
+Roughly speaking, the relation between &fml4; and &fml8; is
similar to one between sendmail and postfix.
</para>
<para>
-&fmldevel; re-implements features of &fml4; functions. We redesign fml
-and clean up the function and variable naming convenstion. Also, We
-reinforce guide line to the coding style for clean source codes.
+&fml8; re-implements almost all features of &fml4; functions. We
+re-design fml and clean up the function and variable naming
+convenstion. Also, We reinforce guide line to the coding style for
+clean source codes.
</para>
<para>
For example, when you use &fml4;, you'll find that fml assumes the
-list of members is found in the text file on the host. &fml4;
-inherits the assumption from version 1.0 through 4.0. It affetcts the
-core part of designs. Hence, it is difficult to extend fml IO for the
-use of RDBMS, redundency et.al. In fact, &fml4; supports RDBMS but the
-code is ugly. We should need to fully rewrite fml core parts.
+list of members is found as text files on the host. &fml4; inherits
+the assumption from version 1.0 through 4.0. It affetcts the core part
+of the design. Hence, it is difficult to extend fml IO for the use of
+RDBMS, redundency et.al. In fact, &fml4; supports RDBMS but the code
+is ugly. We should need to fully rewrite fml core parts.
</para>
<para>
-Also, I want a lot of new features. &fmldevel; should provide tiny bug
+Also, I want a lot of new features. &fml8; should provide tiny bug
tracking system maintatined automatically. It is better to co-relate
fml with cvs log. These features help the support by mail and
developer mailing list. I need it, of course.
@@ -95,7 +100,7 @@ and features, and discard what in &fml4;.
<listitem>
<para>
- What we should inherit into &fmldevel; from &fml4; ?
+ What we should inherit into &fml8; from &fml4; ?
</para>
</listitem>
@@ -109,7 +114,7 @@ and features, and discard what in &fml4;.
<listitem>
<para>
- remove obsolete features.
+ what obsolete features we should remove ?
</para>
</listitem>
@@ -120,14 +125,14 @@ You can find it at the following URL.
</para>
<para>
-<ulink url="http://www.fml.org/software/fml-devel/">
-http://www.fml.org/software/fml-devel/
+<ulink url="http://www.fml.org/software/fml8/">
+http://www.fml.org/software/fml8/
</ulink>
</para>
<para>
-<ulink url="ftp://ftp.fml.org/pub/fml-devel/">
-ftp://ftp.fml.org/pub/fml-devel/
+<ulink url="ftp://ftp.fml.org/pub/fml8/">
+ftp://ftp.fml.org/pub/fml8/
</ulink>
</para>
@@ -137,7 +142,7 @@ ftp://ftp.fml.org/pub/fml-devel/
<!-- ======================================================== -->
<sect1 id="fml.and.fmlng">
<title>
- relation between &fml4; and &fmldevel; development branch.
+ relation between &fml4; and &fml8; development branch.
</title>
<para>
@@ -202,7 +207,7 @@ subscribe Kinomoto Sakura
</title>
<para>
-Please send me the idea on &fmldevel; to the mail address:
+Please send me the idea on &fml8; to the mail address:
<ulink url="mailto:fml-request@fml.org">
fml-request@fml.org
</ulink>
diff --git a/fml/doc/en/tutorial/terms.sgml b/fml/doc/en/tutorial/terms.sgml
index c7ede9c7..a48e351c 100644
--- a/fml/doc/en/tutorial/terms.sgml
+++ b/fml/doc/en/tutorial/terms.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: terms.sgml,v 1.2 2003/07/26 09:10:40 fukachan Exp $
+ $FML: terms.sgml,v 1.3 2003/07/27 15:31:52 fukachan Exp $
$jaFML: terms.sgml,v 1.5 2003/04/15 14:51:35 fukachan Exp $
-->
@@ -8,6 +8,14 @@
Technical terms in this tutorial
</title>
+<para>
+See
+<link linkend="glossary">
+<xref linkend="glossary">
+</link>
+also.
+</para>
+
<variablelist>
<varlistentry>
@@ -24,6 +32,84 @@
</listitem>
</varlistentry>
+ <varlistentry>
+ <term> ~ </term>
+ <listitem>
+ <para> user's home directory </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> CUI </term>
+ <listitem>
+ <para>
+ command line tool such as makefml or fml.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> fml </term>
+ <listitem>
+ <para>
+ fml software in general use.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> fml (command) </term>
+ <listitem>
+ <para>
+ fml command included in &fml8; software.
+ fml is same as makefml command except for the argument order.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> user fml </term>
+ <listitem>
+ <para>
+ a user called as fml.
+ a user account for &fml8; software.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> fml4 </term>
+ <listitem>
+ <para> &fml4; series. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> fml8 </term>
+ <listitem>
+ <para> &fml8; series. </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> GUI </term>
+ <listitem>
+ <para>
+ CGI interface.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> makefml (command) </term>
+ <listitem>
+ <para>
+ configuration helper tool included in &fml4; and &fml8;.
+ You can use them when you login the mailing list server.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</sect1>