summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/command
diff options
context:
space:
mode:
authorfukachan <fukachan>2003-08-02 03:05:53 +0000
committerfukachan <fukachan>2003-08-02 03:05:53 +0000
commitfb58227e2c2a6d061372a27409b96ea27ea75451 (patch)
treeeeb1171a255fef728b9604cafc39a027f288d78b /fml/doc/en/tutorial/command
parent26f88d05d24fa845ab0c73f34cae9cf3d99cc91c (diff)
downloadfml8-fb58227e2c2a6d061372a27409b96ea27ea75451.tar.gz
fml8-fb58227e2c2a6d061372a27409b96ea27ea75451.tar.bz2
fml8-fb58227e2c2a6d061372a27409b96ea27ea75451.zip
clean up
Diffstat (limited to 'fml/doc/en/tutorial/command')
-rw-r--r--fml/doc/en/tutorial/command/chapter.sgml4
-rw-r--r--fml/doc/en/tutorial/command/dataflow.sgml4
-rw-r--r--fml/doc/en/tutorial/command/extension.sgml34
-rw-r--r--fml/doc/en/tutorial/command/internal.sgml41
-rw-r--r--fml/doc/en/tutorial/command/module.sgml42
5 files changed, 61 insertions, 64 deletions
diff --git a/fml/doc/en/tutorial/command/chapter.sgml b/fml/doc/en/tutorial/command/chapter.sgml
index 0515ce65..c47cb8b9 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.1 2003/07/24 15:37:35 fukachan Exp $
+ $FML: chapter.sgml,v 1.2 2003/07/26 09:10:40 fukachan Exp $
$jaFML: chapter.sgml,v 1.7 2002/12/25 11:50:42 fukachan Exp $
-->
<chapter>
<title>
- command (command mail, CUI, 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 1fa1961a..ff3750d3 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.1 2003/07/24 15:37:35 fukachan Exp $
+ $FML: dataflow.sgml,v 1.2 2003/07/26 09:10:40 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>
diff --git a/fml/doc/en/tutorial/command/extension.sgml b/fml/doc/en/tutorial/command/extension.sgml
index bf1cf0a7..53f7018e 100644
--- a/fml/doc/en/tutorial/command/extension.sgml
+++ b/fml/doc/en/tutorial/command/extension.sgml
@@ -1,41 +1,41 @@
<!--
- $FML$
+ $FML: extension.sgml,v 1.1 2003/07/24 15:37:35 fukachan Exp $
$jaFML: extension.sgml,v 1.10 2003/04/15 14:51:36 fukachan Exp $
-->
<sect1 id="fml.command.hack.commandmail">
<title>
- command extensoin: command mail
+ Command extension: command mail
</title>
<warning>
<para>
To make a new command usable for all ML's on this host,
-put the module you wrote at
+you need to put the module you wrote at
<screen>
/usr/local/lib/fml/site_local/
</screen>
-
+.
If you permit the command is used only for the specifiec ML
(e.g. elena ML), put it at the ML local library path
<screen>
/var/spool/ml/elena/local/lib/
</screen>
-.
+where $ml_home_dir = /var/spool/ml/elena.
</para>
<para>
-In this section, we consider the former case.
-In both cases, the module codes are same.
+In this section, we consider the former case. In both cases, the way
+of writing the module codes are same. Only path differs.
</para>
</warning>
<sect2>
<title>
- create a new user command
+ Create a new user command
</title>
<para>
@@ -50,6 +50,8 @@ to permit the user of "uja" command.
<screen>
commands_for_user += uja
</screen>
+It you allow the command only for the specific elena ML,
+edit /var/spool/ml/elena/config.cf in the same way.
</para>
</sect2>
@@ -57,13 +59,13 @@ commands_for_user += uja
<sect2>
<title>
- create a new admin command "admin uja"
+ Create a new admin command "admin uja"
</title>
<para>
-In the same way describe above, hack the module!:)
-but the location differs.
-Put it at the FML::Command::Admin:: class.
+In the same way described above, hack the module!:)
+but the module path differs.
+Put it at the FML::Command::Admin:: class. For example
<screen>
/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm
</screen>
@@ -111,9 +113,9 @@ Create a module "uja" and put it at
<screen>
/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm
</screen>
-No editing of .cf files.
-The existence of module file enables the command automatically
-in the case CUI since the use of CUI implies administrator use.
+You do not need to edit .cf files. The existence of module file
+enables the command automatically in the CUI case since the usability
+of CUI implies administrator use.
</para>
</sect1>
@@ -149,7 +151,7 @@ In both cases, the module codes are same.
<para>
-craete a module "uja" and put it at
+Craete a module "uja" and put it at
<screen>
/usr/local/lib/fml/site_local/FML/Command/Admin/uja.pm
</screen>
diff --git a/fml/doc/en/tutorial/command/internal.sgml b/fml/doc/en/tutorial/command/internal.sgml
index d671dcf0..75a4785f 100644
--- a/fml/doc/en/tutorial/command/internal.sgml
+++ b/fml/doc/en/tutorial/command/internal.sgml
@@ -1,5 +1,5 @@
<!--
- $FML$
+ $FML: internal.sgml,v 1.1 2003/07/29 12:13:54 fukachan Exp $
$jaFML: internal.sgml,v 1.6 2003/04/15 14:51:36 fukachan Exp $
-->
@@ -9,12 +9,8 @@
</title>
<para>
-(... not yet translated ...)
-</para>
-
-<para>
-Consider help command which send back help message to the sender, an
-example of command.
+Consider "help" command an an example of command,
+which sends back help message to the sender.
</para>
<para>
@@ -25,10 +21,10 @@ FML::Process::Command via AUTOLOAD of FML::Command.
<warning>
<para>
-All commands are implemented as either of FML::Command::User
-FML::Command::Admin classes. CUI (makefml, fml) and GUI (CGI) uses
-FML::Command::Admin class. Command mail users both classes according
-to the context.
+All commands are implemented at either of FML::Command::User
+FML::Command::Admin classes. Both CUI (makefml, fml) and GUI (CGI)
+uses FML::Command::Admin class. Instead command mail users both
+classes according to the context.
</para>
</warning>
@@ -66,24 +62,24 @@ sub process
where $curproc is an object, which type is hash reference.
It corresponds to %Envelope of &fml4;.
It contains several references to objects for this process.
-$config is an object, but global in $fml4;.
+For exmple, variable $config is an object holding configuration variables.
</para>
<para>
prepare_file_to_return() converts the message language and expands the
-arguments in the message templtes.
+arguments in the message templates.
</para>
<para>
$curproc->reply_message() inserts the specified mesage string into the
-queue.
+message queue of this process on memory.
</para>
<para>
-The error/log messages queued in are aggergated to one message at the
-last of the current process. It is driven by Mail::Delivery class to
-send it. If needed, the aggregator handles text strings and multipart
-properly.
+The error/log messages queued in on memory are aggergated to one
+message at the last of the current process. Mail::Delivery class
+handles the aggregation and send it. If needed, the aggregator handles
+text strings and multipart properly to build one message.
</para>
<para>
@@ -92,9 +88,12 @@ is different.
</para>
<para>
-FYI: commands such as get for the file manipulation uses the same
-message queuing mechanism. This is different from &fml4;'s Notify()
-fundamentally.
+FYI: commands such as "get" for the file manipulation uses the same
+message queuing mechanism. Notify() sends back immediately. This is
+different from &fml4;'s Notify() fundamentally.
</para>
</sect1>
+
+
+
diff --git a/fml/doc/en/tutorial/command/module.sgml b/fml/doc/en/tutorial/command/module.sgml
index e2738b3e..aed20036 100644
--- a/fml/doc/en/tutorial/command/module.sgml
+++ b/fml/doc/en/tutorial/command/module.sgml
@@ -1,38 +1,36 @@
<!--
- $FML$
+ $FML: module.sgml,v 1.1 2003/07/24 15:37:35 fukachan Exp $
$jaFML: module.sgml,v 1.4 2003/04/15 14:51:36 fukachan Exp $
-->
<sect1 id="fml.command.module.hierarchy">
<title>
- modules for commands
+ Modules for commands
</title>
<para>
-In &fmldevel;, all command modules are shared among command mail,
-CUI(makefml, fml) and GUI.
-Commands are caregorized into user and administrative ones by the
-priviledge.
+In &fmldevel;, all command modules are shared among command mail, CUI
+(makefml, fml) and GUI (CGI). Commands are caregorized into user and
+administrative ones by the priviledge.
</para>
<para>
-FML::Command:: consists of the following classes:
+FML::Command class consists of the following classes:
<screen>
FML::Command entrance into FML::Command
-FML::Command::User command for usual ML users.
-FML::Command::Admin command for administrators.
+FML::Command::User command for general ML users.
+FML::Command::Admin command for remote administrators.
</screen>
-For example, a user command in a command mail kicks off
-FML::Command firstly, after some steps,
-calls FML::Command::User::$command where $command is the specified
-command name.
+For example, a user command in a command mail kicks off FML::Command
+firstly, after some steps, calls FML::Command::User::$command where
+$command is the specified command name.
</para>
<sect2>
<title>
- usre command in command mail
+ User command in command mail
</title>
<para>
@@ -41,20 +39,18 @@ via FML::Command.
</para>
<para>
-
-Finally, some module calls FML::Command::Admin::$command for real work even if it is
-a user command.
-For example,
-FML::Command::Admin::subscribe works for subscription.
-In this case,
-FML::Command::User::subscribe module is a wrapper or an entrance for
-confirmation before the real subscription work.
+FYI: some module calls FML::Command::Admin::$command for real work
+even if it is a user command. For example,
+FML::Command::Admin::subscribe works for subscription. In this case,
+FML::Command::User::subscribe module is a wrapper/entrance for
+confirmation before the real subscription process runs.
</para>
+
</sect2>
<sect2>
<title>
- admin command (administrative command in command mail)
+ Admin command (administrative command in command mail)
</title>
<para>