summaryrefslogtreecommitdiff
path: root/fml/doc/en
diff options
context:
space:
mode:
authorfukachan <fukachan>2005-09-25 04:27:16 +0000
committerfukachan <fukachan>2005-09-25 04:27:16 +0000
commit35fe1529a15c092b4851d16fdb3074fa3a9f3586 (patch)
tree4a927b936736f4397efe9c72b06c2b5f3e672c9b /fml/doc/en
parent28287653d036a5ca84a28809aac9fa930f778f7a (diff)
downloadfml8-35fe1529a15c092b4851d16fdb3074fa3a9f3586.tar.gz
fml8-35fe1529a15c092b4851d16fdb3074fa3a9f3586.tar.bz2
fml8-35fe1529a15c092b4851d16fdb3074fa3a9f3586.zip
clean up
Diffstat (limited to 'fml/doc/en')
-rw-r--r--fml/doc/en/tutorial/command/chapter.sgml4
-rw-r--r--fml/doc/en/tutorial/command/dataflow.sgml23
-rw-r--r--fml/doc/en/tutorial/command/extension.sgml20
-rw-r--r--fml/doc/en/tutorial/command/internal.sgml8
-rw-r--r--fml/doc/en/tutorial/command/module.sgml8
-rw-r--r--fml/doc/en/tutorial/delivery/chapter.sgml14
-rw-r--r--fml/doc/en/tutorial/delivery/queue.sgml24
-rw-r--r--fml/doc/en/tutorial/delivery/recipe.forward.sgml4
-rw-r--r--fml/doc/en/tutorial/devel/create_program.sgml10
-rw-r--r--fml/doc/en/tutorial/internals/credential.sgml8
-rw-r--r--fml/doc/en/tutorial/internals/dbms.sgml4
-rw-r--r--fml/doc/en/tutorial/internals/directory.sgml6
-rw-r--r--fml/doc/en/tutorial/internals/filename.sgml16
-rw-r--r--fml/doc/en/tutorial/internals/filter.sgml6
-rw-r--r--fml/doc/en/tutorial/internals/lock.sgml6
-rw-r--r--fml/doc/en/tutorial/internals/main.cf.sgml6
-rw-r--r--fml/doc/en/tutorial/internals/merge.sgml14
-rw-r--r--fml/doc/en/tutorial/internals/restriction.sgml19
-rw-r--r--fml/doc/en/tutorial/internals/struct.sgml8
-rw-r--r--fml/doc/en/tutorial/internals/style.sgml32
-rw-r--r--fml/doc/en/tutorial/internals/userctl.sgml10
-rw-r--r--fml/doc/en/tutorial/message/chapter.sgml16
-rw-r--r--fml/doc/en/tutorial/message/discussion.sgml18
-rw-r--r--fml/doc/en/tutorial/message/language.sgml13
-rw-r--r--fml/doc/en/tutorial/operations/backup.sgml26
-rw-r--r--fml/doc/en/tutorial/operations/log.sgml23
-rw-r--r--fml/doc/en/tutorial/usage/command.sgml11
-rw-r--r--fml/doc/en/tutorial/variables/list.sgml8
28 files changed, 181 insertions, 184 deletions
diff --git a/fml/doc/en/tutorial/command/chapter.sgml b/fml/doc/en/tutorial/command/chapter.sgml
index 2662b58a..78005cf3 100644
--- a/fml/doc/en/tutorial/command/chapter.sgml
+++ b/fml/doc/en/tutorial/command/chapter.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: chapter.sgml,v 1.3 2003/08/02 03:05:53 fukachan Exp $
+ $FML: chapter.sgml,v 1.4 2005/07/20 10:37:41 fukachan Exp $
$jaFML: chapter.sgml,v 1.7 2002/12/25 11:50:42 fukachan Exp $
-->
<chapter id="fml.command.modules">
<title>
- Command (command mail, CUI and GUI)
+ Command (Command Mail, CUI And GUI)
</title>
diff --git a/fml/doc/en/tutorial/command/dataflow.sgml b/fml/doc/en/tutorial/command/dataflow.sgml
index 37d1976b..d0cce180 100644
--- a/fml/doc/en/tutorial/command/dataflow.sgml
+++ b/fml/doc/en/tutorial/command/dataflow.sgml
@@ -1,12 +1,12 @@
<!--
- $FML: dataflow.sgml,v 1.3 2003/08/02 03:05:53 fukachan Exp $
+ $FML: dataflow.sgml,v 1.4 2005/07/20 10:37:42 fukachan Exp $
$jaFML: dataflow.sgml,v 1.1 2002/12/25 11:50:42 fukachan Exp $
-->
<sect1 id="fml.command.dataflow">
<title>
- Data flow of command request processing
+ Data Flow Of Command Request Processing
</title>
@@ -23,7 +23,7 @@ processing stage.
<sect2>
<title>
- command mail procssing
+ Command Mail Procssing
</title>
<caution>
@@ -33,7 +33,7 @@ We adopt new frame work after 2004/03/05.
</caution>
<para>
-Firstly, parse and analyze each line.
+Firstly, parse and analyze each line in one message.
</para>
<para>
@@ -47,20 +47,21 @@ For example,
</para>
<para>
-1) if anonymous command such as "guide" or "subscribe", call command
-processor. Allowd list of commands are defined in
-$anonymous_command_mail_allowed_commands.
+1) if this command matches anonymous command such as "guide" or
+"subscribe", call command processor. Allowd list of commands are
+defined in $anonymous_command_mail_allowed_commands.
</para>
<para>
-2) if a normal command which are allowd for a member, check other
-conditions based on rules of $command_mail_restrictions. Allowd list
-of commands are defined in $user_command_mail_allowed_commands.
+2) if this command matches a normal command which are allowd for a
+member, check other conditions based on rules of
+$command_mail_restrictions. Allowd list of commands are defined in
+$user_command_mail_allowed_commands.
</para>
<para>
Command dispatcher checks the return path dependent on the command and
-the syntax, finally execute the command via FML::Command class.
+the syntax, finally executes the command via FML::Command class.
This process runs as normal user priviledge.
</para>
diff --git a/fml/doc/en/tutorial/command/extension.sgml b/fml/doc/en/tutorial/command/extension.sgml
index 3c10fa11..ab910912 100644
--- a/fml/doc/en/tutorial/command/extension.sgml
+++ b/fml/doc/en/tutorial/command/extension.sgml
@@ -1,18 +1,18 @@
<!--
- $FML: extension.sgml,v 1.2 2003/08/02 03:05:53 fukachan Exp $
+ $FML: extension.sgml,v 1.3 2005/07/20 10:37:42 fukachan Exp $
$jaFML: extension.sgml,v 1.10 2003/04/15 14:51:36 fukachan Exp $
-->
<sect1 id="fml.command.hack.commandmail">
<title>
- Command extension: command mail
+ Command Extension: Command Mail
</title>
<warning>
<para>
-To make a new command usable for all ML's on this host,
+To make a new local command usable for all ML's on this host,
you need to put the module you wrote at
<screen>
/usr/local/lib/fml/site_local/
@@ -31,11 +31,11 @@ where $ml_home_dir = /var/spool/ml/elena.
<sect2>
<title>
- Create a new user command
+ Create A New User Command
</title>
<para>
-Consider to make a new user command "uja".
+Consider to make a new local user command "uja".
Pick up a command at FML::Command::User, cut and paste it.
Please put it at
<screen>
@@ -59,7 +59,7 @@ user_command_mail_allowed_commands += uja
<sect2>
<title>
- Create a new admin command such as "admin uja"
+ Create A New Admin Command Such As "admin uja"
</title>
<para>
@@ -84,12 +84,12 @@ admin_command_mail_allowed_commands += uja
<sect1 id="fml.command.hack.makefml">
<title>
- CUI command extension: makefml/fml
+ CUI Command Extension: makefml/fml
</title>
<warning>
<para>
-To make a new command usable for all ML's on this host,
+To make a new local command usable for all ML's on this host,
put the module you wrote at
<screen>
/usr/local/lib/fml/site_local/
@@ -124,7 +124,7 @@ of CUI implies administrator use.
<sect1 id="fml.command.hack.cgi">
<title>
- GUI command extension: CGI
+ GUI Command Extension: CGI
</title>
@@ -134,7 +134,7 @@ You need another work to create a menu screen.
</para>
<para>
-To make a new command usable for all ML's on this host,
+To make a new local command usable for all ML's on this host,
put the module you wrote at
<screen>
/usr/local/lib/fml/site_local/
diff --git a/fml/doc/en/tutorial/command/internal.sgml b/fml/doc/en/tutorial/command/internal.sgml
index eb17c87d..a7872c48 100644
--- a/fml/doc/en/tutorial/command/internal.sgml
+++ b/fml/doc/en/tutorial/command/internal.sgml
@@ -1,16 +1,16 @@
<!--
- $FML: internal.sgml,v 1.3 2004/03/12 14:05:04 fukachan Exp $
+ $FML: internal.sgml,v 1.4 2005/07/20 10:37:42 fukachan Exp $
$jaFML: internal.sgml,v 1.6 2003/04/15 14:51:36 fukachan Exp $
-->
<sect1 id="fml.command.internal.change">
<title>
- How differ coding style among &fml4; and &fml8;
+ How Differ Coding Style Among &fml4; And &fml8;
</title>
<para>
-Consider "help" command as an example of an fml command,
-which sends back help message to the sender.
+Consider localization of "help" command as an example of an fml
+command, which sends back help message to the sender.
</para>
<para>
diff --git a/fml/doc/en/tutorial/command/module.sgml b/fml/doc/en/tutorial/command/module.sgml
index 9493df06..912fdc4d 100644
--- a/fml/doc/en/tutorial/command/module.sgml
+++ b/fml/doc/en/tutorial/command/module.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: module.sgml,v 1.2 2003/08/02 03:05:53 fukachan Exp $
+ $FML: module.sgml,v 1.3 2005/07/20 10:37:42 fukachan Exp $
$jaFML: module.sgml,v 1.4 2003/04/15 14:51:36 fukachan Exp $
-->
@@ -30,7 +30,7 @@ $command is the specified command name.
<sect2>
<title>
- User command in command mail
+ User Command In Command Mail
</title>
<para>
@@ -50,11 +50,11 @@ confirmation before the real subscription process runs.
<sect2>
<title>
- Admin command (administrative command in command mail)
+ Admin Command (Administrative Command In Command Mail)
</title>
<para>
-call FML::Command::Admin::$command for $command via FML::Command
+It calles FML::Command::Admin::$command for $command via FML::Command
via FML::Process::Command.
</para>
diff --git a/fml/doc/en/tutorial/delivery/chapter.sgml b/fml/doc/en/tutorial/delivery/chapter.sgml
index 11f916b2..5f12be26 100644
--- a/fml/doc/en/tutorial/delivery/chapter.sgml
+++ b/fml/doc/en/tutorial/delivery/chapter.sgml
@@ -1,20 +1,20 @@
<!--
- $FML: chapter.sgml,v 1.1 2003/08/02 01:19:11 fukachan Exp $
+ $FML: chapter.sgml,v 1.2 2005/07/20 10:39:17 fukachan Exp $
$jaFML: chapter.sgml,v 1.12 2003/04/15 14:51:37 fukachan Exp $
-->
<chapter id="delivery">
<TITLE>
- &fml8; mail delivery system
+ &fml8; Mail Delivery System
</TITLE>
<sect1 id="fml8-delivery">
<title>
- The difference between &fml4; and &fml8;
+ The Difference Between &fml4; And &fml8;
</title>
<para>
-One of puposes of &fml8; is unification and abstraction of member
+One of purposes of &fml8; is unification and abstraction of member
list operations. Mail distribution is based on the following module
Mail::Delivery.
</para>
@@ -58,12 +58,12 @@ object.
<link linkend="module.mail.message">
Mail::Message
</link>
- object
+ Object
</title>
<para>
This object provies message analyzer.
-It analyzes a message and build the following object chains
+It analyzes a message and build the following object chains on memory.
<screen>
header -> body
header -> preamble -> part1 -> part2 -> trailor (multipart)
@@ -99,7 +99,7 @@ system like MTA. Now fml8 can deliver again messages by itself.
<sect1>
<title>
- Discussion: FML::Mailer is apropriate ?
+ Discussion: FML::Mailer Is Apropriate ?
</title>
<para>
diff --git a/fml/doc/en/tutorial/delivery/queue.sgml b/fml/doc/en/tutorial/delivery/queue.sgml
index 639adb79..78f9e88b 100644
--- a/fml/doc/en/tutorial/delivery/queue.sgml
+++ b/fml/doc/en/tutorial/delivery/queue.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: queue.sgml,v 1.1 2003/08/02 01:19:11 fukachan Exp $
+ $FML: queue.sgml,v 1.2 2005/07/20 10:39:17 fukachan Exp $
$jaFML: queue.sgml,v 1.3 2003/04/15 14:51:37 fukachan Exp $
-->
<sect1 id="message.queue.incoming">
<TITLE>
- incoming queuing
+ Incoming Queuing
</TITLE>
<para>
@@ -16,12 +16,12 @@ MTA kicks off a fml process. It reads a message from STDIN.
The fml process reads a message once and write it onto the hard disk
(write it into the incoming queue). After the queuing succeeded, the
process starts to analyze a message. For this logic, the original mail
-is saved after that.
+is saved before main processing starts.
</para>
<para>
-If the queuing fails, call exit(EX_TEMPFAIL). In almost cases,
-exit(75). If MTA receives this exit code, MTA tries to deliver again
+If the queuing fails, fml calls exit(EX_TEMPFAIL). In almost cases,
+exit(75). If MTA receives this exit code, MTA tries to deliver again
later.
</para>
@@ -35,7 +35,7 @@ The queus is removed when the process ends.
<sect1 id="message.queue.outgoing">
<TITLE>
- fml sends back a mail message
+ fml Sends Back A Mail Message
</TITLE>
<para>
@@ -45,7 +45,7 @@ process.
</para>
<para>
-article delivery processing is a little diffferent but based on
+Article delivery processing is a little diffferent but based on
queueing by Mail::Delivery::Queue. If someting error occurs in
delivery, another fml process tries to deliver it later.
</para>
@@ -53,11 +53,11 @@ delivery, another fml process tries to deliver it later.
<sect2>
<title>
- Coding in &fml8; sources.
+ Coding In &fml8; Sources.
</title>
<para>
-Code like this to send back a message:
+Code is like this to send back a message:
<screen>
$curproc->reply_message( "you are not a ML member." );
</screen>
@@ -92,7 +92,7 @@ $curproc->reply_message( {
<sect1 id="message.queue">
<TITLE>
- mail queue and delivery system
+ Mail Queue And Delivery System
</TITLE>
<para>
@@ -124,7 +124,7 @@ In manipulating queue, we should lock the target queue by flock(2).
<sect1>
<TITLE>
- mail queue directory
+ Mail Queue Directory
</TITLE>
<para>
@@ -152,7 +152,7 @@ Hence files under active/ is delivery ready.
<sect2>
<title>
- lock the queue
+ Lock The Queue
</title>
<para>
diff --git a/fml/doc/en/tutorial/delivery/recipe.forward.sgml b/fml/doc/en/tutorial/delivery/recipe.forward.sgml
index 90041840..ca089d13 100644
--- a/fml/doc/en/tutorial/delivery/recipe.forward.sgml
+++ b/fml/doc/en/tutorial/delivery/recipe.forward.sgml
@@ -1,12 +1,12 @@
<!--
- $FML$
+ $FML: recipe.forward.sgml,v 1.1 2003/07/28 10:41:29 fukachan Exp $
$jaFML: recipe.forward.sgml,v 1.2 2003/04/15 14:51:38 fukachan Exp $
-->
<qandaentry>
<question>
<para>
-switch forwarding address regarding the mail content.
+Wwitch forwarding address regarding the mail content.
</para>
</question>
diff --git a/fml/doc/en/tutorial/devel/create_program.sgml b/fml/doc/en/tutorial/devel/create_program.sgml
index 5fb9796a..4a8a91ac 100644
--- a/fml/doc/en/tutorial/devel/create_program.sgml
+++ b/fml/doc/en/tutorial/devel/create_program.sgml
@@ -1,22 +1,22 @@
<!--
- $FML: create_program.sgml,v 1.1 2003/08/02 01:19:11 fukachan Exp $
+ $FML: create_program.sgml,v 1.2 2003/08/02 14:53:24 fukachan Exp $
$jaFML: create_program.sgml,v 1.6 2003/04/15 14:51:38 fukachan Exp $
-->
<chapter id="program.create">
<title>
- Create a new program
+ Create A New Program
</title>
<sect1>
<title>
- Create a program (CUI)
+ Create A Program (CUI)
</title>
<para>
Firstly, prepare a new module in FML::Process class. See
-FML::Process::Scheduler as the least functional model and see
+FML::Process::Calendar as the least functional model and see
FML::Process::Distribute for the most complicated class.
</para>
@@ -86,7 +86,7 @@ define the program as $bin_programs or $exec_programs in install.cf.in.
<sect1>
<title>
- Create a program (CGI)
+ Create A Program (CGI)
</title>
<para>
diff --git a/fml/doc/en/tutorial/internals/credential.sgml b/fml/doc/en/tutorial/internals/credential.sgml
index e771ea31..819bfac0 100644
--- a/fml/doc/en/tutorial/internals/credential.sgml
+++ b/fml/doc/en/tutorial/internals/credential.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: credential.sgml,v 1.2 2003/08/03 05:28:48 fukachan Exp $
+ $FML: credential.sgml,v 1.3 2005/07/27 12:21:36 fukachan Exp $
$jaFML: credential.sgml,v 1.3 2003/04/15 14:51:40 fukachan Exp $
-->
<chapter id="credential">
<title>
- User authentication
+ User Authentication
</title>
<para>
@@ -16,13 +16,13 @@ User authentication is provided by methods of FML::Credential class.
<sect1 id="credential.implementation">
<title>
- Discussion: FML::Credential implementation
+ Discussion: FML::Credential Implementation
</title>
<sect2>
<title>
- Case sensitive / case insensitive
+ Case Sensitive / Case Insensitive
</title>
<para>
diff --git a/fml/doc/en/tutorial/internals/dbms.sgml b/fml/doc/en/tutorial/internals/dbms.sgml
index ae23be7e..f2395017 100644
--- a/fml/doc/en/tutorial/internals/dbms.sgml
+++ b/fml/doc/en/tutorial/internals/dbms.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: dbms.sgml,v 1.2 2003/08/03 05:28:49 fukachan Exp $
+ $FML: dbms.sgml,v 1.3 2005/07/27 12:21:36 fukachan Exp $
$jaFML: dbms.sgml,v 1.5 2003/05/31 08:51:09 fukachan Exp $
-->
<chapter id="dbms">
<title>
- Database management system
+ Database Management System
</title>
diff --git a/fml/doc/en/tutorial/internals/directory.sgml b/fml/doc/en/tutorial/internals/directory.sgml
index 1e78e791..5e1e1c4d 100644
--- a/fml/doc/en/tutorial/internals/directory.sgml
+++ b/fml/doc/en/tutorial/internals/directory.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: directory.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $
+ $FML: directory.sgml,v 1.2 2005/08/03 13:22:06 fukachan Exp $
-->
@@ -11,7 +11,7 @@
<sect1 id="directory.subdir.hier.level">
<title>
- Q: how recursively sub directory can be created ?
+ Q: How Recursively Sub Directory Can Be Created ?
</title>
<para>
@@ -22,7 +22,7 @@ The structore holding the html-ized article is as follows:
</para>
<para>
-one sub-directory by default.
+One sub-directory by default.
</para>
<para>
diff --git a/fml/doc/en/tutorial/internals/filename.sgml b/fml/doc/en/tutorial/internals/filename.sgml
index d1c450e2..d842627b 100644
--- a/fml/doc/en/tutorial/internals/filename.sgml
+++ b/fml/doc/en/tutorial/internals/filename.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: filename.sgml,v 1.1 2003/07/26 07:58:26 fukachan Exp $
+ $FML: filename.sgml,v 1.2 2003/08/03 05:28:49 fukachan Exp $
$jaFML: filename.sgml,v 1.3 2003/04/15 14:51:41 fukachan Exp $
-->
<chapter id="filename">
<title>
- [Caution] file names
+ [Caution] File Names
</title>
<para>
@@ -16,7 +16,7 @@ References: fml-devel 205
<sect1 id="filename.basic">
<title>
- Filename structure
+ Filename Structure
</title>
<para>
@@ -49,7 +49,7 @@ for several password files.
<sect1>
<title>
- Case study: address list
+ Case Study: Address List
</title>
<para>
@@ -67,7 +67,7 @@ recipient_maps = recipients
<sect1>
<title>
- Case study: list of remote administrators
+ Case Study: List Of Remote Administrators
</title>
<para>
@@ -82,7 +82,7 @@ members-admin
<sect1>
<title>
- Case study: list of moderators
+ Case Study: List Of Moderators
</title>
@@ -99,7 +99,7 @@ members-moderator
<sect1>
<title>
- Case study: remote administrator password files
+ Case Study: Remote Administrator Password Files
</title>
@@ -111,7 +111,7 @@ etc/passwd-admin
<warning>
<para>
-etc/passwd is used in the case of &fml4;.
+etc/passwd, lack of role name, was used in the case of &fml4;.
</para>
</warning>
diff --git a/fml/doc/en/tutorial/internals/filter.sgml b/fml/doc/en/tutorial/internals/filter.sgml
index efd18599..98625316 100644
--- a/fml/doc/en/tutorial/internals/filter.sgml
+++ b/fml/doc/en/tutorial/internals/filter.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: filter.sgml,v 1.9 2005/06/25 15:11:34 fukachan Exp $
+ $FML: filter.sgml,v 1.1 2005/08/03 13:22:06 fukachan Exp $
-->
@@ -186,12 +186,12 @@ suitable for mime component filter when we consider the meaning of
"cutoff" operation.
</para>
-</sect2>
-
<para>
( NOT TRANSLATED AFTER THIS )
</para>
+</sect2>
+
</sect1>
diff --git a/fml/doc/en/tutorial/internals/lock.sgml b/fml/doc/en/tutorial/internals/lock.sgml
index 54b05194..3b6be85a 100644
--- a/fml/doc/en/tutorial/internals/lock.sgml
+++ b/fml/doc/en/tutorial/internals/lock.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: lock.sgml,v 1.5 2005/06/25 15:11:34 fukachan Exp $
+ $FML: lock.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $
-->
@@ -16,7 +16,7 @@ Synchronization among processes uses lock.
<sect1 id="lock.overview">
<title>
- Overview: lock
+ Overview: Lock
</title>
<para>
@@ -70,7 +70,7 @@ Currently we attension we use short critical region.
</title>
<para>
-mutex lock in calling *_maps.
+Mutex lock in calling *_maps.
</para>
<para>
diff --git a/fml/doc/en/tutorial/internals/main.cf.sgml b/fml/doc/en/tutorial/internals/main.cf.sgml
index 43eaf7ef..70ebe1fd 100644
--- a/fml/doc/en/tutorial/internals/main.cf.sgml
+++ b/fml/doc/en/tutorial/internals/main.cf.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: main.cf.sgml,v 1.10 2004/10/06 09:07:39 fukachan Exp $
+ $FML: main.cf.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $
-->
@@ -9,7 +9,7 @@
</title>
<para>
-/usr/local/etc/fml/main.cf is not specific.
+/usr/local/etc/fml/main.cf is not ML specific.
This is meta file to define fundamental variables
e.g. fml version, directory path et.al.
&fml8; loader reads them.
@@ -29,7 +29,7 @@ style.
<screen>
#
-# $FML: main.cf.sgml,v 1.10 2004/10/06 09:07:39 fukachan Exp $
+# $FML: main.cf.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $
#
# fml version
diff --git a/fml/doc/en/tutorial/internals/merge.sgml b/fml/doc/en/tutorial/internals/merge.sgml
index 100172f5..a32a55e4 100644
--- a/fml/doc/en/tutorial/internals/merge.sgml
+++ b/fml/doc/en/tutorial/internals/merge.sgml
@@ -1,22 +1,22 @@
<!--
- $FML: merge.sgml,v 1.3 2005/06/25 15:11:34 fukachan Exp $
+ $FML: merge.sgml,v 1.1 2005/07/27 12:21:37 fukachan Exp $
-->
<chapter id="merge.internal.to.fml8">
<title>
- Convert another ML system to &fml8;
+ Convert Another ML System To &fml8;
</title>
<sect1 id="merge.internal.fml4to8">
<title>
- Implementation: &fml4; to &fml8;
+ Implementation: &fml4; To &fml8;
</title>
<sect2>
<title>
- Case 1: /var/spool/ml/elena/ from &fml4; to &fml8;
+ Case 1: /var/spool/ml/elena/ From &fml4; To &fml8;
</title>
<para>
@@ -69,7 +69,7 @@ case of &fml8;. We should warn it ?
<sect2>
<title>
- Case 2: convert the whole /var/spool/ml/ from &fml4; to &fml8;
+ Case 2: Convert The Whole /var/spool/ml/ From &fml4; To &fml8;
</title>
<para>
@@ -79,7 +79,7 @@ Apply case 1 for all ML's.
<para>
If we can stop all ML's, it is easy to remove
/var/spool/ml/etc/fml/aliases of &fml4; firstly and apply case 1 steps.
-stop MTA in migration.
+Please stop MTA in migration.
</para>
</sect2>
@@ -87,7 +87,7 @@ stop MTA in migration.
<sect2>
<title>
- Discussion: use half and half of &fml4; and &fml8; softwares.
+ Discussion: Use Half And Half Of &fml4; And &fml8; Softwares.
</title>
<para>
diff --git a/fml/doc/en/tutorial/internals/restriction.sgml b/fml/doc/en/tutorial/internals/restriction.sgml
index 60731434..e456d352 100644
--- a/fml/doc/en/tutorial/internals/restriction.sgml
+++ b/fml/doc/en/tutorial/internals/restriction.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: restriction.sgml,v 1.9 2005/06/25 15:11:35 fukachan Exp $
+ $FML: restriction.sgml,v 1.1 2005/07/27 12:21:37 fukachan Exp $
-->
<chapter id="restriction">
<title>
- Restrict input data
+ Restrict Input Data
</title>
<para>
@@ -16,16 +16,16 @@ provides.
<sect1 id="restriction.overview">
<title>
- Overview: checks of input data
+ Overview: Checks Of Input Data
</title>
<sect2>
<title>
- Restriction for article posting
+ Restriction For Article Posting
</title>
<para>
-Restrictions for article are ambiguous or too restrictive. In fact
+Restrictions for article are ambiguous or too restrictive. In fact
FML::Restriction class does not provide restriction rules for article
posting.
</para>
@@ -39,7 +39,7 @@ Instead FML::Filter filter system checks each line of content.
<sect2>
<title>
- Restrictions for command mail
+ Restrictions For Command Mail
</title>
<para>
@@ -97,6 +97,7 @@ though no checks by FML::Restriction at the entrance.
For example, "adduser" module checks whether the input address
is valid or not even in the case of CUI.
These restrictions are dependent command specific modules.
+These are applied even in the case of CUI.
</para>
</sect2>
@@ -106,7 +107,7 @@ These restrictions are dependent command specific modules.
<sect1 id="restriction.class">
<title>
- FML::Restriction class
+ FML::Restriction Class
</title>
<para>
@@ -137,7 +138,7 @@ if ($value =~ /^$allowed_regexp{$key}$) { ... ok, do something ... ;}
<sect1 id="restrictioncgi.input.data">
<title>
- How CGI restricts the input
+ How CGI Restricts The Input
</title>
<para>
@@ -178,7 +179,7 @@ for my $key (param()) {
<sect1>
<title>
- Discussion: FML::Restriction is too restrictive ?
+ Discussion: FML::Restriction Is Too Restrictive ?
</title>
<para>
diff --git a/fml/doc/en/tutorial/internals/struct.sgml b/fml/doc/en/tutorial/internals/struct.sgml
index 2d42b866..75b6336b 100644
--- a/fml/doc/en/tutorial/internals/struct.sgml
+++ b/fml/doc/en/tutorial/internals/struct.sgml
@@ -1,17 +1,17 @@
<!--
- $FML: struct.sgml,v 1.2 2003/08/03 05:28:49 fukachan Exp $
+ $FML: struct.sgml,v 1.3 2005/07/27 12:21:37 fukachan Exp $
$jaFML: struct.sgml,v 1.2 2003/04/15 14:51:41 fukachan Exp $
-->
<appendix id="structure">
<title>
- Struct curproc (object in fact)
+ Struct curproc (Object In Fact)
</title>
<sect1 id="structure.curproc">
<title>
- curproc object
+ curproc Object
</title>
<para>
@@ -25,7 +25,7 @@ Example of FML::Process::Distribute object.
<sect1 id="structure.pcb">
<title>
- PCB category list
+ PCB Category List
</title>
<para>
diff --git a/fml/doc/en/tutorial/internals/style.sgml b/fml/doc/en/tutorial/internals/style.sgml
index a79b1a20..84e1d264 100644
--- a/fml/doc/en/tutorial/internals/style.sgml
+++ b/fml/doc/en/tutorial/internals/style.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: style.sgml,v 1.14 2005/06/25 15:11:35 fukachan Exp $
+ $FML: style.sgml,v 1.1 2005/08/03 13:22:06 fukachan Exp $
-->
<chapter id="programingstyle">
<TITLE>
- Programming style
+ Programming Style
</TITLE>
<para>
@@ -24,7 +24,7 @@ on FML.ORG programming style.
<!-- ==================================================== -->
<sect1 id="variable-naming-convention">
<title>
- Variable naming convension
+ Variable Naming Convension
</title>
<para>
@@ -39,14 +39,14 @@ We expect $article_* variables for them.
</para>
<para>
-Iit seems better to use CLASS_default_XXX syntax not
+It seems better to use CLASS_default_XXX syntax not
default_XXX.
</para>
<sect2>
<title>
- Structure of variable naming
+ Structure Of Variable Naming
</title>
<para>
@@ -78,7 +78,7 @@ report_mail_XXX
</para>
<para>
-Other example (header);
+Other example (header):
<screen>
header_XXX
header_default_XXX
@@ -133,7 +133,7 @@ article {
<sect2>
<title>
- Example: Standard pattern (e.g. log.cf lock.cf)
+ Example: Standard Pattern (e.g. log.cf lock.cf)
</title>
<screen>
@@ -198,7 +198,7 @@ PROGRAM_VARIABLE_ATTRIBUTE
<!-- ==================================================== -->
<sect1 id="design.policy">
<title>
- A few topics on design and coding style
+ A Few Topics On Design And Coding Style
</title>
<warning>
@@ -212,17 +212,17 @@ on style.
<sect2>
<title>
- A few cautions
+ A Few Cautions
</title>
<para>
-apply quotemeta() for search key.
+Apply quotemeta() for search key.
</para>
<para>
-use access method for object not handle directly within objects.
+Use access method for object not handle directly within objects.
Example: To access to main.cf object, not use
<screen>
$curproc->{ ... }->{ main_cf }
@@ -236,13 +236,13 @@ style.
<para>
-better not to use @EXPORT and @EXPORT_OK.
+It is better not to use @EXPORT and @EXPORT_OK.
</para>
<para>
How depth of classes is allowed ?
-two such as Srting::is_japanese_string() ?
+two such as String::is_japanese_string() ?
At least 3, I think.
</para>
@@ -254,7 +254,7 @@ At least 3, I think.
<!-- ==================================================== -->
<sect1>
<title>
- Programming style original idea
+ Programming Style Original Idea
</title>
<warning>
@@ -269,7 +269,7 @@ Here is the original idea log.
<listitem>
<para>
We can use polymorphism in perl.
- use it and object composition instaed of multiple inheritence.
+ Use it and object composition instaed of multiple inheritence.
</para>
</listitem>
@@ -319,7 +319,7 @@ Here is the original idea log.
<para>
- polymorphism and re-use is important
+ Polymorphism and re-use is important
especially in sub-classes.
</para>
diff --git a/fml/doc/en/tutorial/internals/userctl.sgml b/fml/doc/en/tutorial/internals/userctl.sgml
index 29bb95d5..8c15eb9a 100644
--- a/fml/doc/en/tutorial/internals/userctl.sgml
+++ b/fml/doc/en/tutorial/internals/userctl.sgml
@@ -1,28 +1,28 @@
<!--
- $FML: userctl.sgml,v 1.3 2004/10/06 09:07:40 fukachan Exp $
+ $FML: userctl.sgml,v 1.1 2005/07/27 12:21:37 fukachan Exp $
-->
<chapter id="userctl">
<title>
- subscribe / unsubscribe
+ Subscribe / Unsubscribe
</title>
<sect1 id="userctl.deladd">
<title>
- which map subscribe/unsubscribe is operated to ?
+ Which Map Subscribe/Unsubscribe Is Operated To ?
</title>
<para>
-Subscribe/unsubscribe is operated to $primary_*map.
+Subscribe/unsubscribe is operated to $primary_*_map.
</para>
<para>
For example,
subscription of remote administrators is operated into
both $primary_admin_member_map and $primary_admin_recipient_map.
-unsubscription of remote administrators is operated into
+Unsubscription of remote administrators is operated into
both $primary_admin_member_map and $primary_admin_recipient_map.
</para>
diff --git a/fml/doc/en/tutorial/message/chapter.sgml b/fml/doc/en/tutorial/message/chapter.sgml
index 95cdb65d..d8038162 100644
--- a/fml/doc/en/tutorial/message/chapter.sgml
+++ b/fml/doc/en/tutorial/message/chapter.sgml
@@ -1,11 +1,11 @@
<!--
- $FML: chapter.sgml,v 1.1 2003/07/28 15:20:18 fukachan Exp $
+ $FML: chapter.sgml,v 1.2 2003/08/03 05:28:49 fukachan Exp $
$jaFML: chapter.sgml,v 1.5 2003/04/15 14:51:42 fukachan Exp $
-->
<chapter id="mail.manipulation">
<title>
- Manipulate message (mail message)
+ Manipulate Message (Mail Message)
</title>
<para>
@@ -22,16 +22,16 @@ Mail::Bounce, Mail::Delivery depend on this class.
<!-- ======================================= -->
<sect1>
<title>
- Mail::Message class
+ Mail::Message Class
</title>
<para>
A mail consists of one header and one body.
-A multipart mail consists of several parts.
+A multipart mail body consists of several parts.
</para>
<para>
-The mail delivery needs not to know the detail of a message.
+The mail delivery module needs not to know the detail of a message.
But the filter system needs to know the structure of the message.
</para>
@@ -41,7 +41,7 @@ These modules depend
Mail::Message class
</link>
to know the message structure.
-For eample, Mail::Bounce, Mail::Delivery et.al. uses this.
+For example, Mail::Bounce, Mail::Delivery et.al. use this class.
</para>
<para>
@@ -66,7 +66,7 @@ The usage is as follows:
<!-- ======================================= -->
<sect1>
<title>
- Mail::Message::Parse class
+ Mail::Message::Parse Class
</title>
<para>
@@ -87,7 +87,7 @@ class.
<!-- ======================================= -->
<sect1>
<title>
- Mail::Message::Compose class
+ Mail::Message::Compose Class
</title>
<para>
diff --git a/fml/doc/en/tutorial/message/discussion.sgml b/fml/doc/en/tutorial/message/discussion.sgml
index 0491d830..0d89637d 100644
--- a/fml/doc/en/tutorial/message/discussion.sgml
+++ b/fml/doc/en/tutorial/message/discussion.sgml
@@ -1,15 +1,15 @@
<!--
- $FML: discussion.sgml,v 1.1 2003/07/29 12:13:55 fukachan Exp $
+ $FML: discussion.sgml,v 1.2 2003/08/03 05:28:49 fukachan Exp $
$jaFML: discussion.sgml,v 1.4 2003/04/15 14:51:42 fukachan Exp $
-->
<sect1>
<title>
- Discussion: how to send back language dependent error mesages
+ Discussion: How To Send Back Language Dependent Error Mesages
</title>
<para>
-Fml needs to send back language dependent error messages.
+fml needs to send back language dependent error messages.
How we should implement it ?
</para>
@@ -21,11 +21,11 @@ How we should implement it ?
<!-- ===================================================== -->
<sect2>
<title>
- &fml4; case
+ &fml4; Case
</title>
<para>
-In the case of &fml4;, &fml4; call language dependent message
+In the case of &fml4;, &fml4; calls language dependent message
converter like this:
<screen>
Mesg(*e, KEYWORD, DEFAULT MESSAGE, ARGUMENT);
@@ -50,7 +50,7 @@ For example, the keyword not_found matches not_found entry in
<!-- ===================================================== -->
<sect2>
<title>
- What &fmldevel; should do ?
+ What &fmldevel; Should Do ?
</title>
<para>
@@ -78,7 +78,7 @@ For example, the usage is as follows:
<screen>
printf(catgets(catd, 30, 4, "%s: Internal match error.\n"), progname);
</screen>
-This function uses se 30 and entry 4 in the local definition file such
+This function uses set 30 and entry 4 in the local definition file such
as /usr/pkg/share/nls/ja_JP.EUC/PROGNAME.cat.
</para>
@@ -86,7 +86,7 @@ as /usr/pkg/share/nls/ja_JP.EUC/PROGNAME.cat.
<sect3>
<title>
- &fmldevel;: design (temporary ?)
+ &fmldevel;: Design (Temporary ?)
</title>
<para>
@@ -151,7 +151,7 @@ $sender is ... something ...
_EOF_
}
</screen>
-hmm, is it good ???
+Hmm, is it good ???
</para>
</sect3>
diff --git a/fml/doc/en/tutorial/message/language.sgml b/fml/doc/en/tutorial/message/language.sgml
index 7b98a921..76a5f41e 100644
--- a/fml/doc/en/tutorial/message/language.sgml
+++ b/fml/doc/en/tutorial/message/language.sgml
@@ -1,13 +1,12 @@
<!--
- $FML: language.sgml,v 1.1 2003/07/29 12:13:55 fukachan Exp $
+ $FML: language.sgml,v 1.2 2003/08/03 05:28:50 fukachan Exp $
$jaFML: language.sgml,v 1.5 2003/04/15 14:51:42 fukachan Exp $
-->
<sect1 id="message.nl">
<title>
- Message internationalization: a
- the usage of reply_message_nl()
+ Message Internationalization: The Usage Of reply_message_nl()
</title>
<para>
@@ -39,10 +38,10 @@ reply_mesage_nl().
</para>
<para>
-Usual $VARIABLE is also expaned by replacing it with value of config.cf.
-For example, $ml_name is expanded to ML name defined in config.cf.
-$_arg_ prefix is used for lexical scope variables to avoid
-conflicts against variables in config.cf.
+Usual $VARIABLE is also expaned by replacing it with value of config
+name space. For example, $ml_name is expanded to ML name defined in
+config.cf. In fact $_arg_ prefix is used for lexical scope variables
+to avoid conflicts against variables in config.cf.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/operations/backup.sgml b/fml/doc/en/tutorial/operations/backup.sgml
index ce0557f3..ad2b449f 100644
--- a/fml/doc/en/tutorial/operations/backup.sgml
+++ b/fml/doc/en/tutorial/operations/backup.sgml
@@ -1,12 +1,12 @@
<!--
- $FML$
+ $FML: backup.sgml,v 1.1 2005/07/23 01:57:38 fukachan Exp $
$jaFML: backup.sgml,v 1.3 2004/10/06 09:07:41 fukachan Exp $
-->
<chapter id="operations.backup">
<title>
- Back up of configurations
+ Back Up Of Configurations
</title>
@@ -21,13 +21,13 @@ These directories holds all articles, log files and others et.al.
</para>
<para>
-It is better to back up MTA configurations.
+It is better to back up MTA configurations, too.
For example, /etc/postfix in the case of Postfix.
</para>
<para>
-In summary,
-the following three (2 + number of domains fml8 operatates) are targets.
+In summary, the following three (generally speaking 2 + number of
+domains fml8 operatates) are targets.
<screen>
/etc/postfix/
/usr/local/etc/fml/
@@ -38,7 +38,7 @@ $ml_home_prefix (e.g. /var/spool/ml/)
<sect1 id="operations.backup.fml8.include">
<title>
- Back up &fml8; configurations
+ Back Up &fml8; Configurations
</title>
<para>
@@ -64,7 +64,7 @@ following files.
<sect2>
<title>
- Configuration files back up
+ Configuration Files To Back Up
</title>
<para>
@@ -107,7 +107,7 @@ So back up all under them.
<sect2>
<title>
- Address list back up
+ Address List To Back Up
</title>
<para>
@@ -116,13 +116,13 @@ Lists of mail addresses are
/ML_HOME_DIRECTORY/members*
/ML_HOME_DIRECTORY/recipients*
</screen>
-Article delivery uses recipients and members. For other roles,
-&fml8; uses members-$role and recipients-$role.
-So, back up all members* and recipients* files.
+Article delivery uses both recipients and members. For other roles,
+&fml8; uses members-$role and recipients-$role. So, back up all
+members* and recipients* files.
</para>
<para>
-Remoto administration by command mail (admin command mail) uses
+Remote administration by command mail (admin command mail) uses
the following password files
<screen>
/ML_HOME_DIRECTORY/etc/passwd-$role
@@ -137,7 +137,7 @@ the following password files
<sect1 id="operations.backup.fml8.exclude">
<title>
- Back up all files except for some large directories.
+ Back Up All Files Except For Some Large Directories.
</title>
<para>
diff --git a/fml/doc/en/tutorial/operations/log.sgml b/fml/doc/en/tutorial/operations/log.sgml
index bced7c02..fc0480c6 100644
--- a/fml/doc/en/tutorial/operations/log.sgml
+++ b/fml/doc/en/tutorial/operations/log.sgml
@@ -1,5 +1,5 @@
<!--
- $FML$
+ $FML: log.sgml,v 1.1 2005/07/23 01:57:38 fukachan Exp $
$jaFML: log.sgml,v 1.2 2004/10/06 09:07:41 fukachan Exp $
-->
@@ -12,7 +12,7 @@
<sect1 id="operations.log.see">
<title>
- See log
+ See Log
</title>
<para>
@@ -32,15 +32,12 @@ GUI uses log command.
<sect1 id="operations.log.computeroutput">
<title>
- Show computer oriented log
+ Show Computer Oriented Log
</title>
<para>
-When another command or CGI calls &fml8; CUI and wants to analyze the
-output, please use the following option.
-</para>
-
-<para>
+When not fml program or CGI calls &fml8; CUI and such program wants to
+analyze the output, you can use use the following option.
<screen>
% makefml --log-computer-output COMMAND ML_NAME
% fml --log-computer-output ML_NAME COMMAND
@@ -65,20 +62,20 @@ The command line option --log-computer-output is same effect as
<screen>
use_log_computer_output = yes
</screen>
-in config.cf
+in config.cf file.
</para>
<para>
When "use_log_computer_output = yes" specified in config.cf, all
-programs are affected. So all programs shows the computer oriented log
-to STDERR. So use of command line option is recommended.
+programs are affected. All programs shows the computer oriented log to
+STDERR. So use of command line option is recommended.
</para>
<para>
-We should use perl module which holds a set of functions. In this
+We should use perl module which holds a set of functions. In this
case, the print out engine is the class called as
FML::Log::Print::Simple. The output style is contolled by
-$log_computer_output_engine in config.cf
+$log_computer_output_engine in config.cf file.
</para>
</sect1>
diff --git a/fml/doc/en/tutorial/usage/command.sgml b/fml/doc/en/tutorial/usage/command.sgml
index 95b19450..87a13f32 100644
--- a/fml/doc/en/tutorial/usage/command.sgml
+++ b/fml/doc/en/tutorial/usage/command.sgml
@@ -1,5 +1,5 @@
<!--
- $FML: command.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $
+ $FML: command.sgml,v 1.2 2005/09/18 13:55:57 fukachan Exp $
$jaFML: command.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $
-->
@@ -42,13 +42,12 @@ The mail to send back is passed to MTA for delivery via SMTP.
</para>
<warning>
+
<para>
-The result is aggreagated to one msssage as
-<link linkend="message.reply">
-MIME/Multipart
-</link>
-. This is different from &fml4; behaviour.
+The result is aggreagated to one msssage as MIME/Multipart. This is
+different from &fml4; behaviour.
</para>
+
</warning>
</sect2>
diff --git a/fml/doc/en/tutorial/variables/list.sgml b/fml/doc/en/tutorial/variables/list.sgml
index 0a65529f..e77cf73d 100644
--- a/fml/doc/en/tutorial/variables/list.sgml
+++ b/fml/doc/en/tutorial/variables/list.sgml
@@ -1114,8 +1114,8 @@ ldap_query_add_as_ldif</entry>
<entry>
attributes to add into $ldap_base_dn entry.</entry>
<entry>
-fmlrecipient:&address
- fmlmember:&address
+fmlrecipient:&amp;address
+ fmlmember:&amp;address
</entry>
</row>
<row>
@@ -1124,8 +1124,8 @@ ldap_query_delete_as_ldif</entry>
<entry>
attributes to remove from $ldap_base_dn entry.</entry>
<entry>
-fmlrecipient:&address
- fmlmember:&address
+fmlrecipient:&amp;address
+ fmlmember:&amp;address
</entry>
</row>
<row>