summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/usage
diff options
context:
space:
mode:
authorfukachan <fukachan>2005-09-18 13:55:54 +0000
committerfukachan <fukachan>2005-09-18 13:55:54 +0000
commitd5bc53045bad01b54232c5793387509dadf053ef (patch)
tree4b672810c2d816f1fa6f4aa9003548981df4bfbd /fml/doc/en/tutorial/usage
parent9562005ee99278bd272f81497c9d5e87a9a84fa5 (diff)
downloadfml8-d5bc53045bad01b54232c5793387509dadf053ef.tar.gz
fml8-d5bc53045bad01b54232c5793387509dadf053ef.tar.bz2
fml8-d5bc53045bad01b54232c5793387509dadf053ef.zip
clean up.
Diffstat (limited to 'fml/doc/en/tutorial/usage')
-rw-r--r--fml/doc/en/tutorial/usage/chaddr.sgml19
-rw-r--r--fml/doc/en/tutorial/usage/chapter.onhost.sgml34
-rw-r--r--fml/doc/en/tutorial/usage/chapter.user.sgml4
-rw-r--r--fml/doc/en/tutorial/usage/command.sgml27
-rw-r--r--fml/doc/en/tutorial/usage/fml.sgml13
-rw-r--r--fml/doc/en/tutorial/usage/fmladdr.sgml17
-rw-r--r--fml/doc/en/tutorial/usage/fmlalias.sgml14
-rw-r--r--fml/doc/en/tutorial/usage/fmlconf.sgml8
-rw-r--r--fml/doc/en/tutorial/usage/fmldoc.sgml4
-rw-r--r--fml/doc/en/tutorial/usage/fmlhtmlify.sgml8
-rw-r--r--fml/doc/en/tutorial/usage/get.sgml13
-rw-r--r--fml/doc/en/tutorial/usage/guide.sgml10
-rw-r--r--fml/doc/en/tutorial/usage/help.sgml10
-rw-r--r--fml/doc/en/tutorial/usage/makefml.sgml92
-rw-r--r--fml/doc/en/tutorial/usage/post.sgml44
-rw-r--r--fml/doc/en/tutorial/usage/subscribe.sgml16
-rw-r--r--fml/doc/en/tutorial/usage/unsubscribe.sgml14
17 files changed, 199 insertions, 148 deletions
diff --git a/fml/doc/en/tutorial/usage/chaddr.sgml b/fml/doc/en/tutorial/usage/chaddr.sgml
index b146c579..59fa29b1 100644
--- a/fml/doc/en/tutorial/usage/chaddr.sgml
+++ b/fml/doc/en/tutorial/usage/chaddr.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: chaddr.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $
+ $FML: chaddr.sgml,v 1.2 2005/07/20 10:37:44 fukachan Exp $
$jaFML: chaddr.sgml,v 1.2 2003/04/15 14:51:45 fukachan Exp $
-->
<sect1 id="usage.user.chaddr">
<title>
- change registered address
+ Change Registered Address
</title>
<para>
@@ -16,18 +16,19 @@ chaddr OLD-ADDRESS NEW-ADDRESS
</screen>
to elena-ctl@fml.org.
<screen>
-Example:
+[Example]
+
chaddr rudo@nuinui.net rudo-new@nuinui.net
</screen>
-You can send this mail from both OLD-ADDRESS and NEW-ADDRESS.
+You can send this mail from both OLD-ADDRESS and NEW-ADDRESS. &fml8;
+treats this command as an exceptiona of From: based authentication.
</para>
<para>
-&fml8; sends back confirmation to both addresses.
-Please reply the confirmation and send back it to elena-ctl again.
-When you request is confirmed to be valid,
-&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to the recipient and
-member list.
+&fml8; sends back the confirmation to both addresses. Please reply
+the confirmation and send back it to elena-ctl@fml.org from either
+address again. When you reply is confirmed to be valid, &fml8; remove
+OLD-ADDRESS and add NEW-ADDRESS to the recipient and member list.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/chapter.onhost.sgml b/fml/doc/en/tutorial/usage/chapter.onhost.sgml
index e35b30f4..dc1a8d18 100644
--- a/fml/doc/en/tutorial/usage/chapter.onhost.sgml
+++ b/fml/doc/en/tutorial/usage/chapter.onhost.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: chapter.onhost.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $
+ $FML: chapter.onhost.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: chapter.onhost.sgml,v 1.8 2003/04/15 14:51:46 fukachan Exp $
-->
<chapter id="usage.onhost">
<title>
- What can we do on the mailing list server host ?
+ What Can You Do On The Mailing List Server
</title>
@@ -16,8 +16,8 @@ greatest administrator :)
</para>
<para>
-makefml of fml8 is same as fml4 as could as possible to preserve
-compatibility.
+"makefml" command of &fml8; is same as &fml4; as could as possible to
+preserve compatibility.
</para>
<para>
@@ -31,7 +31,7 @@ on the detail of the difference.
<sect1 id="usage.onhost.priviledge">
<title>
- On the host
+ On The Host
</title>
<para>
@@ -52,11 +52,12 @@ But He/She may do wrong operations.
To avoid careless wrong operations, in usual cases you should use CUI
(makefml or fml) to configure fml. Of course you can edit files
directly if you can understand fml structures. By default we recommend
-you should use CUI even on the host.
+you should use CUI always on the host.
</para>
<para>
-fml command is same as makefml command except for the argument order.
+"fml" command is same as "makefml" command except for the argument
+order.
<screen>
makefml COMMAND ML OPTIONS
fml ML COMMAND OPTIONS
@@ -69,7 +70,7 @@ Please either as you like.
<sect1 id="usage.commandpolicy">
<title>
- Policy of command creation
+ Policy Of Command Creation
</title>
<para>
@@ -82,7 +83,7 @@ such commands can be shared among CUI, GUI and commmnd mail.
<sect2>
<title>
- operation may modify the specific ML (read/write).
+ Operation May Modify The Specific ML (Read + Write)
</title>
<para>
@@ -95,7 +96,7 @@ modify the specific ML.
<sect2>
<title>
- operation read only the data of the specific ML (read only).
+ Operation For Read Only Data Of The Specific ML (Read Only)
</title>
<para>
@@ -108,7 +109,7 @@ the specific ML.
<sect2>
<title>
- see the general data (read only)
+ Show The General Data (Read Only)
</title>
<para>
@@ -129,20 +130,21 @@ fmlconf [-n] ML
<sect2>
<title>
- ML specific but a command wrapper
+ ML Specific But A Command Wrapper
</title>
<para>
PGP / GPG related command (e.g. fmlpgp) is very command speicific.
-So, it is difficult to incorporate them into makefml/fml.
-We implement it as another command such as fmlpgp, fmlgpg, ...
+So, it looks difficult to incorporate them into "makefml" and "fml"
+framework. So we implement it as another command such as fmlpgp,
+fmlgpg, ...
</para>
</sect2>
<sect2>
<title>
- misc
+ Misc
</title>
<para>
@@ -151,7 +153,7 @@ This command name begins with fml prefix.
</para>
<para>
-The conveter from text to html form.
+For example, "fmlhtmlify" is a conveter from text to html form.
This command is used to convert both fml spool and MH folders.
<screen>
fmlhtmlify [-I DIR] $src_dir $dst_dir
diff --git a/fml/doc/en/tutorial/usage/chapter.user.sgml b/fml/doc/en/tutorial/usage/chapter.user.sgml
index 8aaaa38b..14b082ca 100644
--- a/fml/doc/en/tutorial/usage/chapter.user.sgml
+++ b/fml/doc/en/tutorial/usage/chapter.user.sgml
@@ -1,11 +1,11 @@
<!--
- $FML$
+ $FML: chapter.user.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $
$jaFML: chapter.user.sgml,v 1.2 2002/07/28 12:20:19 fukachan Exp $
-->
<chapter id="usage.user">
<title>
- What the user can do ?
+ What A User Can
</title>
diff --git a/fml/doc/en/tutorial/usage/command.sgml b/fml/doc/en/tutorial/usage/command.sgml
index 7d10919a..95b19450 100644
--- a/fml/doc/en/tutorial/usage/command.sgml
+++ b/fml/doc/en/tutorial/usage/command.sgml
@@ -1,21 +1,27 @@
<!--
- $FML$
+ $FML: command.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $
$jaFML: command.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $
-->
<sect1 id="fml.command.bymail">
<title>
- command mail (control fml by sendmail mails)
+ Command Mail (Control fml By Sending Mail)
</title>
<para>
-fml accepts control commands which is sent as a mail.
+&fml8; accepts control commands which is sent as a mail.
It is called "command mail".
</para>
<important>
<para>
-The use of CUI (makefml/fml) is basic in fml world.
+The use of CUI (makefml/fml) is basic in fml world. It is expected you
+should use CUI if you can login the mailing list server.
+</para>
+
+<para>
+The role of command mail is to delegate fml control priviledge to
+users who cannot login the mailing list server.
</para>
</important>
@@ -23,11 +29,11 @@ The use of CUI (makefml/fml) is basic in fml world.
<sect2 id="fml.command.bymail.flow">
<title>
- flow
+ Flow
</title>
<para>
-Consider elena ML. Send the command mail to elena-ctl@fml.org which
+Consider elena ML. Send the command mail to elena-ctl@fml.org which
is the address for command mail. MTA receives the mail and finally
kicks off /usr/local/libexec/fml/command program. This program
receives the mail (command mail) from STDIN , processes the requests
@@ -50,7 +56,7 @@ MIME/Multipart
<sect2>
<title>
- perl modules of command mails
+ Perl Modules For Command Mail
</title>
<para>
@@ -58,6 +64,13 @@ All modules which CUI, GUI and command mail uses are implented as
FML::Command:: class.
</para>
+<para>
+In fact, a sub set of FML::Command:: class is allowed as command mail.
+$user_command_mail_allowed_commands,
+$anonymous_command_mail_allowed_commands and
+$admin_command_mail_allowed_commands variables defines it.
+</para>
+
</sect2>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/fml.sgml b/fml/doc/en/tutorial/usage/fml.sgml
index 04b8850c..77ddf45d 100644
--- a/fml/doc/en/tutorial/usage/fml.sgml
+++ b/fml/doc/en/tutorial/usage/fml.sgml
@@ -1,25 +1,22 @@
<!--
- $FML$
+ $FML: fml.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fml.sgml,v 1.1 2003/01/05 08:03:23 fukachan Exp $
-->
<sect1 id="usage.fml">
<title>
- fml command and makefml command
+ "fml" And "makefml" Command
</title>
<para>
-fml (/usr/local/bin/fml) and makefml (/usr/local/bin/makefml) is same
-except for argument order.
-Please use it as you like.
+"fml" (/usr/local/bin/fml) and "makefml" (/usr/local/bin/makefml) is
+same except for argument order. Please use it as you like.
</para>
<para>
<screen>
% fml ML COMMNAD [OPTIONS]
-</screen>
-instead
-<screen>
+
% makefml COMMAND ML [OPTIONS]
</screen>
</para>
diff --git a/fml/doc/en/tutorial/usage/fmladdr.sgml b/fml/doc/en/tutorial/usage/fmladdr.sgml
index 1a7eecee..c00e7a53 100644
--- a/fml/doc/en/tutorial/usage/fmladdr.sgml
+++ b/fml/doc/en/tutorial/usage/fmladdr.sgml
@@ -1,17 +1,16 @@
<!--
- $FML$
+ $FML: fmladdr.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fmladdr.sgml,v 1.1 2002/11/09 14:16:19 fukachan Exp $
-->
<sect1 id="usage.fmladdr">
<title>
- show all valid addresses (users and aliases)
+ Show Addresses (Users + Aliases)
</title>
<para>
-fmladdr (/usr/local/bin/fmladdr)
-lists up all users on this host.
-It shows users defined in /etc/passwd and aliases defined in postfix.
+"fmladdr" (/usr/local/bin/fmladdr) lists up all users on this host.
+It shows users defined in /etc/passwd and aliases defined in Postfix.
</para>
<para>
@@ -23,10 +22,10 @@ It shows users defined in /etc/passwd and aliases defined in postfix.
<para>
<warning>
<para>
-The difference between fmladdr and fmlalias is whether
-it contais users defined at /etc/passwd or not.
-fmladdr contains it but fmlalias not.
-fmlalias lists up users defined at aliases.
+The difference between "fmladdr" and "fmlalias" is whether
+it contains users defined at /etc/passwd or not.
+"fmladdr" contains it but "fmlalias" not.
+"fmlalias" lists up all users defined at aliases.
</para>
</warning>
</para>
diff --git a/fml/doc/en/tutorial/usage/fmlalias.sgml b/fml/doc/en/tutorial/usage/fmlalias.sgml
index 7687cac8..4d100689 100644
--- a/fml/doc/en/tutorial/usage/fmlalias.sgml
+++ b/fml/doc/en/tutorial/usage/fmlalias.sgml
@@ -1,17 +1,17 @@
<!--
- $FML$
+ $FML: fmlalias.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fmlalias.sgml,v 1.1 2002/11/09 14:16:19 fukachan Exp $
-->
<sect1 id="usage.fmlalias">
<title>
- show alias configuration
+ Show Alias
</title>
<para>
fmlalias (/usr/local/bin/fmlalias) shows all aliases.
Precisely speaking, it shows
-all aliases defined as valid aliases of postfix.
+all aliases defined as valid aliases of Postfix.
</para>
<para>
@@ -23,10 +23,10 @@ all aliases defined as valid aliases of postfix.
<para>
<warning>
<para>
-The difference between fmladdr and fmlalias is whether
-it contais users defined at /etc/passwd or not.
-fmladdr contains it but fmlalias not.
-fmlalias lists up users defined at aliases.
+The difference between "fmladdr" and "fmlalias" is whether
+it contains users defined at /etc/passwd or not.
+"fmladdr" contains it but "fmlalias" not.
+"fmlalias" lists up all users defined at aliases.
</para>
</warning>
</para>
diff --git a/fml/doc/en/tutorial/usage/fmlconf.sgml b/fml/doc/en/tutorial/usage/fmlconf.sgml
index 8ed2756b..0a8a5baf 100644
--- a/fml/doc/en/tutorial/usage/fmlconf.sgml
+++ b/fml/doc/en/tutorial/usage/fmlconf.sgml
@@ -1,17 +1,17 @@
<!--
- $FML$
+ $FML: fmlconf.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fmlconf.sgml,v 1.4 2002/07/28 06:26:58 fukachan Exp $
-->
<sect1 id="usage.fmlconf">
<title>
- show configuration of one ML
+ Show Configuration
</title>
<para>
-fmlconf (/usr/local/bin/fmlconf) takes ML name as an argument.
+"fmlconf" (/usr/local/bin/fmlconf) takes ML name as an argument.
It shows all variables of the specified ML.
-If -n option specified, it shows variables different from default ones.
+If "-n" option specified, it shows variables different from default ones.
</para>
<para>
diff --git a/fml/doc/en/tutorial/usage/fmldoc.sgml b/fml/doc/en/tutorial/usage/fmldoc.sgml
index 45629772..715f3cb7 100644
--- a/fml/doc/en/tutorial/usage/fmldoc.sgml
+++ b/fml/doc/en/tutorial/usage/fmldoc.sgml
@@ -1,11 +1,11 @@
<!--
- $FML$
+ $FML: fmldoc.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fmldoc.sgml,v 1.3 2002/07/28 06:26:58 fukachan Exp $
-->
<sect1 id="usage.fmldoc">
<title>
- show document of perl module
+ Show Perl Module Document
</title>
<para>
diff --git a/fml/doc/en/tutorial/usage/fmlhtmlify.sgml b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml
index 91a36bac..3b2f55d7 100644
--- a/fml/doc/en/tutorial/usage/fmlhtmlify.sgml
+++ b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml
@@ -1,11 +1,11 @@
<!--
- $FML$
+ $FML: fmlhtmlify.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
$jaFML: fmlhtmlify.sgml,v 1.6 2002/11/26 11:16:38 fukachan Exp $
-->
<sect1 id="usage.fmlhtmlify">
<title>
- convert article to HTML form.
+ Convert Articles To HTML Form
</title>
<para>
@@ -16,9 +16,11 @@ to initialize the html archive.
<para>
<screen>
+[Usage]
+
% fmlhtmlify SPOOL_DIRECTORY HTML_ARCHIVE_DIRECTORY
-Example:
+[Example]
% fmlhtmlify /var/spool/ml/elena/spool /some/where/mlarchive/elena
</screen>
diff --git a/fml/doc/en/tutorial/usage/get.sgml b/fml/doc/en/tutorial/usage/get.sgml
index 7bf7d875..e1b62f39 100644
--- a/fml/doc/en/tutorial/usage/get.sgml
+++ b/fml/doc/en/tutorial/usage/get.sgml
@@ -1,27 +1,26 @@
<!--
- $FML: get.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
+ $FML: get.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: get.sgml,v 1.2 2003/04/15 14:51:46 fukachan Exp $
-->
<sect1 id="usage.user.get">
<title>
- read past articles
+ Get Past Articles
</title>
<para>
-send the mail with
+Send the mail with
<screen>
get NUMBER
</screen>
-to elena-ctl@fml.org address.
-NUMBER is the article number.
-fml sends back articles by mime/multipart form to the sender.
+to elena-ctl@fml.org address where NUMBER is the article number.
+&fml8; sends back articles by mime/multipart form to the sender.
</para>
<para>
You can use MH style arguments as NUMBER.
<screen>
-Example:
+[Example]
get 100
get 1-100
diff --git a/fml/doc/en/tutorial/usage/guide.sgml b/fml/doc/en/tutorial/usage/guide.sgml
index 3eb83e91..12728f95 100644
--- a/fml/doc/en/tutorial/usage/guide.sgml
+++ b/fml/doc/en/tutorial/usage/guide.sgml
@@ -1,25 +1,25 @@
<!--
- $FML: guide.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
+ $FML: guide.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: guide.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $
-->
<sect1 id="usage.user.guide">
<title>
- get ML guide
+ Get ML Guide
</title>
<para>
-send the mail with
+Send the mail with
<screen>
guide
</screen>
to elena-ctl@fml.org address.
-fml sends back the guide file to the sender.
+&fml8; sends back the guide message to the sender.
</para>
<para>
If a file named "guide" is found at $ml_home_dir, it is used as a
-template.
+message template.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/help.sgml b/fml/doc/en/tutorial/usage/help.sgml
index 01a2a8a1..05ef27b0 100644
--- a/fml/doc/en/tutorial/usage/help.sgml
+++ b/fml/doc/en/tutorial/usage/help.sgml
@@ -1,25 +1,25 @@
<!--
- $FML: help.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
+ $FML: help.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: help.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $
-->
<sect1 id="usage.user.help">
<title>
- if you know the usage of ML
+ Help: When You Want To know The Usage
</title>
<para>
-send the mail with
+Send the mail with
<screen>
help
</screen>
to elena-ctl@fml.org address.
-sends back the help file to the sender.
+It sends back the help message to the sender.
</para>
<para>
If a file named "help" is found at $ml_home_dir, it is used as a
-template.
+message template.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/makefml.sgml b/fml/doc/en/tutorial/usage/makefml.sgml
index 3ad3a588..f2951bec 100644
--- a/fml/doc/en/tutorial/usage/makefml.sgml
+++ b/fml/doc/en/tutorial/usage/makefml.sgml
@@ -1,12 +1,12 @@
<!--
- $FML: makefml.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
+ $FML: makefml.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: makefml.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $
-->
<sect1 id="usage.makefml.newml">
<title>
- create ML
+ Create A New ML
</title>
<para>
@@ -14,14 +14,17 @@
% su fml
% makefml newml ML
</screen>
-If ML without @domain part, the domain of the ML is the default
-domain. Both ML and ML@DOMAIN form is o.k. for the default domain.
+If ML without @domain part is specified, the domain of the ML is
+treated as the default domain. Both ML and ML@DOMAIN form is o.k. for
+the default domain.
<screen>
+Example: In the case of default domain:
+
% makefml newml elena
% makefml newml elena@fml.org
</screen>
-In the case of virtual domain, you should specify the full address
-user@domain as ML string.
+In the case of virtual domain, you should specify the address with the
+domain such as user@domain form as ML string.
</para>
<para>
@@ -37,25 +40,29 @@ for more details.
<sect1 id="usage.makefml.rmml">
<title>
- remove the ML
+ Remove An ML
</title>
<para>
<screen>
+Example:
+
% su fml
% makefml rmml ML
</screen>
fml accepts ML string without @domain as the default domain.
Both user and user@domain syntax is acceptable.
<screen>
+Example: in the case of default domain:
+
% makefml rmml elena
% makefml rmml elena@fml.org
</screen>
-use user@domain syntax for virtual domains.
+Please use user@domain syntax for virtual domains.
</para>
<para>
-revert the action newml did.
+It reverts the action newml did.
It removes ML home directory, alias entries and ~fml/.qmail-*.
</para>
@@ -64,19 +71,23 @@ It removes ML home directory, alias entries and ~fml/.qmail-*.
<sect1 id="usage.makefml.user.adddel">
<title>
- subscribe/unsubscribe
+ Subscribe and Unsubscribe
</title>
<para>
-Use useradd to subscribe the user,
-userdel to unsubscribe the user.
+Use "useradd" commadn to subscribe the user,
+"userdel" to unsubscribe the user.
<screen>
+Example:
+
% su fml
% makefml useradd ML ADDRESS
% makefml userdel ML ADDRESS
</screen>
fml treats ML without @domain part as one of the default domain.
<screen>
+Examle:
+
% su fml
% makefml useradd elena rudo@nuinui.net
% makefml userdel elena rudo@nuinui.net
@@ -86,14 +97,15 @@ fml treats ML without @domain part as one of the default domain.
</para>
<para>
-For convenience, useradd is an acronym.
+For convenience, useradd is an acronym.
+The following commands,
<screen>
useradd
adduser
subscribe
add
</screen>
-are same as useradd.
+, are same as useradd.
In the same way,
<screen>
userdel
@@ -113,18 +125,22 @@ are same as userdel.
<sect1 id="usage.makefml.user.chaddr">
<title>
- change registered address
+ Change the registered address
</title>
<para>
<screen>
+Example:
+
% su fml
% makefml chaddr ML OLD-ADDRESS NEW-ADDRESS
</screen>
fml treats ML without @domain part as one of the default domain.
For example,
<screen>
+Example: in the case of a virtual domain
+
% su fml
% makefml chaddr elena rudo@nuinui.net teddy@nuinui.net
% makefml chaddr elena@fml.org rudo@nuinui.net teddy@nuinui.net
@@ -137,7 +153,7 @@ For example,
<sect1 id="usage.makefml.off">
<title>
- stop delivery for a user
+ Stop Realtime Delivery
</title>
<para>
@@ -146,12 +162,16 @@ For example,
</screen>
</para>
+<para>
+Delivery to ADDRESS is switched to digest.
+</para>
+
</sect1>
<sect1 id="usage.makefml.on">
<title>
- start delivery for a user
+ Start Realtime Delivery
</title>
<para>
@@ -160,12 +180,16 @@ For example,
</screen>
</para>
+<para>
+Delivery to ADDRESS is switched from digest to real time.
+</para>
+
</sect1>
<sect1 id="usage.makefml.log">
<title>
- See log of elena ML
+ See Log
</title>
<para>
@@ -180,7 +204,7 @@ For example,
<sect1 id="usage.makefml.list">
<title>
- see the member list of ML
+ See The Member List
</title>
<para>
@@ -191,7 +215,7 @@ It shows recipients of this ML. Also,
<screen>
% makefml list elena recipient
</screen>
-lists up recipients of this ML. Instead
+lists up only recipients of this ML. Instead
<screen>
% makefml list elena member
</screen>
@@ -212,7 +236,7 @@ you can use "xxx" as MAP to imply "primary_xxx_map" or "xxx_maps".
<sect1 id="usage.makefml.config">
<title>
- Modify configuration
+ Modify Configuration
</title>
<para>
@@ -220,7 +244,7 @@ Edit config.cf directly now.
</para>
<para>
-Tools are incompletely implemented.
+Configuration helper tool is incompletely implemented.
</para>
</sect1>
@@ -228,29 +252,35 @@ Tools are incompletely implemented.
<sect1 id="usage.makefml.admin.adddel">
<title>
- add/remove remote administrator.
+ Add or Remove A Remote Administrator.
</title>
<warning>
<para>
-A remote administor is person who cannot login to the mail server but
-control an ML by sending command mail (admin command).
+A remote administor is a person who cannot login to the mail server
+but control an ML by sending a command mail (which is called "admin
+command").
</para>
<para>
-CUI can control remote administrators since
-the use of CUI needs login to this host.
+Please use CUI to control remote administrators. If you use CUI, you
+can have priviledge to do since the use of CUI needs login to this
+host.
</para>
</warning>
<para>
<screen>
+[Example]
+
% su fml
% makefml addadmin ML ADDRESS
% makefml deladmin ML ADDRESS
</screen>
fml treats ML without @domain part as one of the default domain.
<screen>
+[Example: in the case of a virtual domain]
+
% su fml
% makefml addadmin elena rudo@nuinui.net
% makefml deladmin elena rudo@nuinui.net
@@ -265,7 +295,7 @@ For convenience,
adminadd
addpriv
</screen>
-are asme as addadmin.
+are same as addadmin.
<screen>
byeadmin
byepriv
@@ -280,17 +310,21 @@ are same as deladmin.
<sect1 id="usage.makefml.moderator.adddel">
<title>
- add/remove a moderator
+ Add or Remove A Modrator
</title>
<para>
<screen>
+[Example]
+
% su fml
% makefml addmoderator ML ADDRESS
% makefml delmoderator ML ADDRESS
</screen>
fml treats ML without @domain part as one of the default domain.
<screen>
+[Example: in the case of a virtual domain]
+
% su fml
% makefml addmoderator elena rudo@nuinui.net
% makefml delmoderator elena rudo@nuinui.net
diff --git a/fml/doc/en/tutorial/usage/post.sgml b/fml/doc/en/tutorial/usage/post.sgml
index 7ea3f904..291e29a8 100644
--- a/fml/doc/en/tutorial/usage/post.sgml
+++ b/fml/doc/en/tutorial/usage/post.sgml
@@ -1,33 +1,36 @@
<!--
- $FML: post.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $
+ $FML: post.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: post.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $
-->
<sect1 id="usage.post">
<title>
- post article
+ Posting Article
</title>
<para>
-Send the mail to elena@fml.org.
-MTA (on e.g. ahodori.fml.org) receives the mail and
-finally kicks off
+Send a mail to elena@fml.org.
+MTA running on the mailing list server host (on e.g. ahodori.fml.org)
+receives the mail and finally kicks off
/usr/local/libexec/fml/distribute command.
</para>
<para>
-distribute recieves the message from STDIN, rewrites the header, save
-it in the spool directory and pass it back to MTA for delivery.
+"distribute" command recieves the message from STDIN,
+rewrites the header,
+save it in the spool directory and
+pass it back to MTA for delivery.
</para>
<sect2>
<title>
- process of distribution
+ Distribution Process
</title>
<para>
-add a tag to subject, update the article sequence number.
+1) &fml8 adds a tag to the subject,
+update the article sequence number.
<screen>
Example:
@@ -37,15 +40,15 @@ Subject: [elena:00100] teddy bear is cute.
</para>
<para>
-save article (as a text file).
+2) save article (as a text file).
</para>
<para>
-create a HTML version of the article under ~fml/public_html/ directory.
+3) create a HTML version of the article under ~fml/public_html/ directory.
</para>
<para>
-update database on thread.
+4) update database (udb) on thread.
</para>
</sect2>
@@ -53,12 +56,12 @@ update database on thread.
<sect2>
<title>
- variables to control the article.
+ Variables
</title>
<warning>
<para>
-not yet written.
+*** sorry, not yet written ***
</para>
</warning>
@@ -67,18 +70,18 @@ not yet written.
<sect2>
<title>
- Boot Sequence
+ Example: Boot Sequence Of Distribute Process
</title>
<para>
<link linkend="bootloader">
fml boot loader
</link>
-boots off in this way.
+boots off in the following way.
</para>
<para>
-/usr/local/libexec/fml/distribute is symlink-ed to
+/usr/local/libexec/fml/distribute command is symlink-ed to
/usr/local/libexec/fml/loader. These files are same.
</para>
@@ -91,10 +94,11 @@ perl modules under it.
</para>
<para>
-&fml8; sets up @INC properly, fml loader loads FML::Process::Switch
-module and check $0 (process name). fml knows the process role from
+&fml8; sets up @INC properly. fml loader loads FML::Process::Switch
+module and check $0 (process name). fml knows the process role from
$0. In this case of distribute, fml loads FML::Process::Distribute
-module, switch itself to it and processes distribution.
+module (defined as /usr/local/etc/fml/$fml_version/modules),
+switch itself to it and processes distribution.
</para>
</sect2>
diff --git a/fml/doc/en/tutorial/usage/subscribe.sgml b/fml/doc/en/tutorial/usage/subscribe.sgml
index 4e2fd866..dc3f41b1 100644
--- a/fml/doc/en/tutorial/usage/subscribe.sgml
+++ b/fml/doc/en/tutorial/usage/subscribe.sgml
@@ -1,27 +1,27 @@
<!--
- $FML$
+ $FML: subscribe.sgml,v 1.1 2003/07/26 04:29:14 fukachan Exp $
$jaFML: subscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $
-->
<sect1 id="usage.user.subscribe">
<title>
- subscribe to ML
+ Subscribe
</title>
<para>
Suppose elena@fml.org ML.
-send the mail with
+Firstly, send the mail with
<screen>
subscribe YOUR-NAME
</screen>
-to elena-ctl@fml.org ML.
+to elena-ctl@fml.org address.
</para>
<para>
-&fml8; sends back confirmation to both addresses.
-Please send back the confirmation to elena-ctl again.
-When you request is confirmed to be valid,
-&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to member lists.
+&fml8; sends back the confirmation to both addresses.
+Please send back the reply for the confirmation to elena-ctl@fml.org again.
+When your reply to the confirmation is confirmed to be valid,
+&fml8; add the address as a new ML member.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/unsubscribe.sgml b/fml/doc/en/tutorial/usage/unsubscribe.sgml
index 7ad289f1..d488edc6 100644
--- a/fml/doc/en/tutorial/usage/unsubscribe.sgml
+++ b/fml/doc/en/tutorial/usage/unsubscribe.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: unsubscribe.sgml,v 1.1 2003/07/26 04:29:14 fukachan Exp $
+ $FML: unsubscribe.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $
$jaFML: unsubscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $
-->
<sect1 id="usage.user.unsubscribe">
<title>
- unsubscribe ML
+ Unsubscribe
</title>
<para>
@@ -14,14 +14,14 @@ send the mail with
<screen>
unsubscribe YOUR-NAME
</screen>
-to elena-ctl@fml.org .
+to elena-ctl@fml.org (control address).
</para>
<para>
-&fml8; sends back confirmation to both addresses.
-Please send back the confirmation to elena-ctl again.
-When you request is confirmed to be valid,
-&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to member lists.
+&fml8; sends back the confirmation to the sender.
+Please send back the reply for the confirmation to elena-ctl@fml.org again.
+When your reply to the confirmation is confirmed to be valid,
+&fml8; removes the address.
</para>
</sect1>