summaryrefslogtreecommitdiff
path: root/fml/doc
diff options
context:
space:
mode:
authorfukachan <fukachan>2003-08-02 14:53:24 +0000
committerfukachan <fukachan>2003-08-02 14:53:24 +0000
commit2965c40b48e1c20f221d5a171972f5cd828f5db7 (patch)
treec171e81cb56d44585dce3e215abb8f223f5c9bdc /fml/doc
parent1af06412d44bc880f00a827e55a4e42b6ad6d768 (diff)
downloadfml8-2965c40b48e1c20f221d5a171972f5cd828f5db7.tar.gz
fml8-2965c40b48e1c20f221d5a171972f5cd828f5db7.tar.bz2
fml8-2965c40b48e1c20f221d5a171972f5cd828f5db7.zip
clean up
Diffstat (limited to 'fml/doc')
-rw-r--r--fml/doc/en/tutorial/devel/create_program.sgml32
-rw-r--r--fml/doc/en/tutorial/digest/chapter.sgml27
-rw-r--r--fml/doc/en/tutorial/virtual/chapter.sgml41
3 files changed, 53 insertions, 47 deletions
diff --git a/fml/doc/en/tutorial/devel/create_program.sgml b/fml/doc/en/tutorial/devel/create_program.sgml
index 4268fe76..5fb9796a 100644
--- a/fml/doc/en/tutorial/devel/create_program.sgml
+++ b/fml/doc/en/tutorial/devel/create_program.sgml
@@ -1,5 +1,5 @@
<!--
- $FML$
+ $FML: create_program.sgml,v 1.1 2003/08/02 01:19:11 fukachan Exp $
$jaFML: create_program.sgml,v 1.6 2003/04/15 14:51:38 fukachan Exp $
-->
@@ -11,12 +11,12 @@
<sect1>
<title>
- Create a pgoram (CUI)
+ Create a program (CUI)
</title>
<para>
Firstly, prepare a new module in FML::Process class. See
-FML::Process::Scheduler as the least model, see
+FML::Process::Scheduler as the least functional model and see
FML::Process::Distribute for the most complicated class.
</para>
@@ -32,7 +32,6 @@ verify_request()
run()
finish()
</screen>
-See FML::Process::Distribute as a complicated example.
</para>
<para>
@@ -41,7 +40,7 @@ See FML::Process::Distribute as a complicated example.
| uses-a FML::Process::{Flow,Utils} FML::Parse ...
|
A
- FML::Process::???
+ FML::Process::MODULE
uses-a FML::Something
uses-a CPAN module
uses-a ...
@@ -49,13 +48,13 @@ See FML::Process::Distribute as a complicated example.
</para>
<para>
-If you have prepared FML::Process::MODULE, define relation at
-etc/modules. Define available command line options at
-etc/command_line_options if needed.
+If you have prepared FML::Process::MODULE, define relation between the
+program name and the module at fml/etc/modules. Also, define available
+command line options at fml/etc/command_line_options if needed.
</para>
<para>
-The preparation is done. Symlink loader and the new program name.
+After it is prepared, symlink the loader and the new program name.
For example,
<screen>
% ls -l /usr/local/libexec/fml
@@ -77,6 +76,9 @@ lrwxr-xr-x 1 root wheel 6 Apr 14 18:25 fmlserv@ -> loader
lrwxr-xr-x 1 root wheel 6 Apr 14 18:25 makefml@ -> loader
lrwxr-xr-x 1 root wheel 6 Apr 14 18:25 mead@ -> loader
</screen>
+As a test, you symlink it explicitly. For the canonical programs, fml
+installer symlinks them according to fml/etc/install.cf. You need to
+define the program as $bin_programs or $exec_programs in install.cf.in.
</para>
</sect1>
@@ -88,8 +90,8 @@ lrwxr-xr-x 1 root wheel 6 Apr 14 18:25 mead@ -> loader
</title>
<para>
-The main CGI program locates at FML::CGI::XXX class.
-These modules has the following relation.
+The main part of CGI program is implemented as an FML::CGI::XXX class.
+These modules have the following relation.
<screen>
FML::Process::Kernel
|
@@ -105,14 +107,14 @@ These modules has the following relation.
</para>
<para>
-How to write CGI programs are same as one of CUI.
-CUI modules locates under FML::CGI to clarifyd CUI and GUI.
+How to write CGI programs is same as one of CUI. CUI modules locate
+under FML::CGI to clarify the difference between CUI and GUI.
</para>
<para>
-In the case of CGI,
-prepare the following methods for looks on screen:
+In the case of CGI, prepare the following methods for screen control
+in FML::CGI::MODULE.
<screen>
html_start()
html_end()
diff --git a/fml/doc/en/tutorial/digest/chapter.sgml b/fml/doc/en/tutorial/digest/chapter.sgml
index 3fe37655..d7093d22 100644
--- a/fml/doc/en/tutorial/digest/chapter.sgml
+++ b/fml/doc/en/tutorial/digest/chapter.sgml
@@ -1,11 +1,11 @@
<!--
- $FML$
+ $FML: chapter.sgml,v 1.1 2003/07/28 15:20:17 fukachan Exp $
$jaFML: chapter.sgml,v 1.3 2003/04/15 14:51:39 fukachan Exp $
-->
<chapter id="digest">
<title>
- digest
+ Digest delivery
</title>
<para>
@@ -13,19 +13,20 @@ run
<screen>
/usr/local/libexec/fml/digest $ml_name
</screen>
-periodically for digest delivery.
+periodically for digest delivery. It aggregates articles into one
+message and send it to members defined by $digest_recipient_maps.
</para>
<warning>
<para>
-simple version yet now.
+Digest delivery program is a simple version yet now.
</para>
</warning>
<sect1 id="digest.config.files">
<title>
- files userd by digest delivery
+ Files used for digest delivery control
</title>
<para>
@@ -44,11 +45,12 @@ seq-digest holds the last sequence delivered as digest.
<para>
members-digest is dummy.
recipients-digest is a recipient list.
+$digest_recipient_maps is this recipients-digest file only by default.
</para>
<para>
-The argument of $digest_recipient_maps is IO::Adapter, so you can use
-mysql here.
+The argument of $digest_recipient_maps is IO::Adapter,
+so you can use mysql here.
</para>
</sect1>
@@ -56,7 +58,7 @@ mysql here.
<sect1 id="digest.command">
<title>
- idea: digest related commands
+ Idea: digest related commands
</title>
@@ -87,7 +89,7 @@ makefml digeston $ml $address
makefml digest $ml $address off
makefml digestoff $ml $address
</screen>
-(These commnds are implemented already).
+(These commands are implemented already).
</para>
<para>
@@ -106,7 +108,7 @@ makefml digestoff $ml $address
admin digest $address on
admin digest $address off
</screen>
-(These commnds are implemented already).
+(These commands are implemented already).
</para>
</sect2>
@@ -118,12 +120,11 @@ admin digest $address off
</title>
<para>
-(not implemented).
+(not yet implemented).
<screen>
digest on
digest off
</screen>
-Enforce confirmation ?
</para>
<para>
@@ -146,7 +147,7 @@ as could as possible.
digeston
digestoff
</screen>
-?
+ok?
</para>
</sect2>
diff --git a/fml/doc/en/tutorial/virtual/chapter.sgml b/fml/doc/en/tutorial/virtual/chapter.sgml
index 84cca9a1..90a18be0 100644
--- a/fml/doc/en/tutorial/virtual/chapter.sgml
+++ b/fml/doc/en/tutorial/virtual/chapter.sgml
@@ -1,34 +1,35 @@
<!--
- $FML$
+ $FML: chapter.sgml,v 1.1 2003/07/27 15:04:27 fukachan Exp $
$jaFML: chapter.sgml,v 1.2 2003/04/15 14:51:47 fukachan Exp $
-->
<chapter id="virtualdomain">
<title>
- virtual domain handling
+ Virtual domain handling
</title>
<para>
It is difficult to handle virtual domains and the default domain in
-same ways.
+the same way.
</para>
<para>
-We user "user@domain" form for the ML name if it is an ML of a virtual
-domain. For example, for a virtual domain, use makefml like this
+You can use "user@domain" as an argument if needed, for example,
+ambiguous. So, use "user@domain" form for the ML name if it is an ML
+of a virtual domain. For example, for a virtual domain, use makefml
+like this
<screen>
% makefml newml mlname@virtualdomain
</screen>
-but both syntaxes are ok for the default domain.
+but both syntaxes are acceptable for the default domain.
<screen>
% makefml newml mlname@defaultdomain
% makefml newml mlname
</screen>
-fml treats these properly as could as possible but fml needs some
-hints such as the ml home directory information.
-You need to prepare /usr/local/etc/fml/virtual file for a hint on
-domain to directory mappings.
-This file name is $virtual_maps in main.cf.
+Fml treats these properly as could as possible. But fml needs some
+hints such as ml home directory information. You need to prepare
+/usr/local/etc/fml/virtual file for a hint on mappping between domain
+and directory. This file name is defined as $virtual_maps in main.cf.
</para>
@@ -38,12 +39,14 @@ This file name is $virtual_maps in main.cf.
</title>
<para>
-It is easy. Prepare
+It is easy in use.
+Edit
<link linkend="install.virtual">
-/etc/fml/virtual
+/usr/local/etc/fml/virtual
</link>
-file.
-After that, use "user@domain" form in makefml for virtual domains.
+file and define it as $virtual_maps in main.cf.
+After that, you can use "user@domain" form in makefml arguments
+in handling virtual domains.
<screen>
makefml newml ML@virtualdomain
makefml add ML@virtualdomain address
@@ -55,7 +58,7 @@ accpetable.
<para>
When you use CGI, you need not to use user@domain syntax
-since the url of config.cgi includes the domain name.
+since config.cgi knows the domain name the cgi handles.
<screen>
http://lists/~fml/cgi-bin/fml/$domain/admin/config.cgi
</screen>
@@ -63,9 +66,9 @@ http://lists/~fml/cgi-bin/fml/$domain/admin/config.cgi
<warning>
<para>
-The domain name is hard-coded within config.cgi. makefml inject the
-domain name in creating config.cgi when "makefml newml" runs.
-config.cgi does not resolve its domain by URL.
+The domain name is hard-coded within config.cgi since makefml injects
+the domain name in creating config.cgi when "makefml newml" runs.
+"config.cgi" does not resolve its domain by URL.
</para>
</warning>