diff options
| author | fukachan <fukachan> | 2005-09-28 11:05:48 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2005-09-28 11:05:48 +0000 |
| commit | 8ff58391fa2519616abc3fdc8929f9c8cafbb9a0 (patch) | |
| tree | 17a189889db62f1608b4e92023f320153bf0f976 /fml/doc/en/tutorial | |
| parent | d4c6b7a0d8d7d8d7bfffee7d1f2d8c15950bc194 (diff) | |
| download | fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.tar.gz fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.tar.bz2 fml8-8ff58391fa2519616abc3fdc8929f9c8cafbb9a0.zip | |
clean up
Diffstat (limited to 'fml/doc/en/tutorial')
23 files changed, 255 insertions, 240 deletions
diff --git a/fml/doc/en/tutorial/changes/CUI.txt b/fml/doc/en/tutorial/changes/CUI.txt index e7f486fa..d42d8f6e 100644 --- a/fml/doc/en/tutorial/changes/CUI.txt +++ b/fml/doc/en/tutorial/changes/CUI.txt @@ -19,7 +19,7 @@ Q: installation of fml 8: run "configure" and "make install" at the source top directory. In fact "make install" executes install.pl script. -Q: Behaviour of install script +Q: behaviour of install script 4: interactive by default. You can use interactive menu for most important options. 8: not interactive. @@ -36,7 +36,7 @@ Q: create ML Q: templates of alias files "makefml newml" generates. 4: only for sendmail (also used as postfix for compatibility). -8: all for postfix, sendmail, qmail, procmail MTA's. +8: postfix, sendmail, qmail and procmail. Q: alias file path "makefml newml" generates. 4: /var/spool/ml/etc/aliases @@ -64,7 +64,7 @@ Q: test of fml Q: set up LISTSERV style server. 4: makefml fmlserv ML - listserv majordomo is same as. + listserv and majordomo is same as. 8: not implemented @@ -208,7 +208,7 @@ Q: set up password of remote administrator (3). # Q: menu style configuration tool. 4: makefml config ML -8: incomplete. +8: makefml config ML, though it is incomplete. Q: edit configuration file. 4: "makefml edit ML". @@ -223,7 +223,7 @@ Q: fml4 specific configuration file conversion (generate cf to config.ph) 4: "makefml update-config ML". Commands (update config-update update-config.ph) are same. the operations is shown. -8: no corresponding idea (one configuration file). +8: no corresponding idea (since &fml8; uses one configuration file). # @@ -341,7 +341,7 @@ Q: dist-encrypt (PGP, GPG KEY RING operation) # Q: set up popfml (emulate MTA and ML via POP). 4: makefml popfml -8: fetchfml +8: not corresponding one. use fetchfml. Q: set up password for POP. 4: makefml pop_passwd diff --git a/fml/doc/en/tutorial/changes/chapter.sgml b/fml/doc/en/tutorial/changes/chapter.sgml index a0243d83..90657e80 100644 --- a/fml/doc/en/tutorial/changes/chapter.sgml +++ b/fml/doc/en/tutorial/changes/chapter.sgml @@ -1,11 +1,11 @@ <!-- - $FML: chapter.sgml,v 1.4 2005/06/25 15:11:28 fukachan Exp $ + $FML: chapter.sgml,v 1.1 2005/08/03 13:26:43 fukachan Exp $ --> <chapter id="changes"> <title> - Difference between &fml4; and &fml8; + Difference Between &fml4; And &fml8; </title> @@ -14,14 +14,14 @@ In this chapter, we describe the difference beetween &fml4; and &fml8; </para> <para> -Intuitively fml4 vs fml8 is equal to sendmail vs postfix. +Intuitively fml4 vs fml8 is equal to sendmail vs Postfix. It is good image. </para> <sect1 id="changes.license"> <title> - Difference between &fml4; and &fml8;: License. + Difference Between &fml4; And &fml8;: License. </title> <para> @@ -58,7 +58,7 @@ You need to clarify the license before installation. <sect1 id="changes.command.mail"> <title> - Difference between &fml4; and &fml8;: Command mail and error messages. + Difference Between &fml4; And &fml8;: Command Mail And Error Messages. </title> <para> @@ -81,7 +81,7 @@ tar.gz and zip formats are not supported.. <sect1 id="changes.cui"> <title> - Difference between &fml4; and &fml8;: CUI + Difference Between &fml4; And &fml8;: CUI </title> <para> @@ -138,7 +138,7 @@ This behaviour is UNIX style. <sect1 id="changes.gui"> <title> - Difference between &fml4; and &fml8;: GUI (CGI) + Difference Between &fml4; And &fml8;: GUI (CGI) </title> <para> @@ -175,7 +175,7 @@ See <xref linkend="filename"> </link> for the file naming convention. -You need not ot know the detail, +You need not to know the detail, since the conversion tools convert files from &fml4; style to &fml8; one. But it is useful to know it to see files. </para> diff --git a/fml/doc/en/tutorial/devel/create_program.sgml b/fml/doc/en/tutorial/devel/create_program.sgml index 4a8a91ac..a9b05591 100644 --- a/fml/doc/en/tutorial/devel/create_program.sgml +++ b/fml/doc/en/tutorial/devel/create_program.sgml @@ -1,5 +1,5 @@ <!-- - $FML: create_program.sgml,v 1.2 2003/08/02 14:53:24 fukachan Exp $ + $FML: create_program.sgml,v 1.3 2005/09/25 04:27:17 fukachan Exp $ $jaFML: create_program.sgml,v 1.6 2003/04/15 14:51:38 fukachan Exp $ --> @@ -78,7 +78,8 @@ 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. +define the program as $bin_programs or $exec_programs in install.cf.in +(configure generates install.cf). </para> </sect1> @@ -107,7 +108,7 @@ These modules have the following relation. </para> <para> -How to write CGI programs is same as one of CUI. CUI modules locate +How to write CGI programs is same as one of CUI. GUI modules locate under FML::CGI to clarify the difference between CUI and GUI. </para> diff --git a/fml/doc/en/tutorial/digest/chapter.sgml b/fml/doc/en/tutorial/digest/chapter.sgml index 3ef5a64e..f9f2844a 100644 --- a/fml/doc/en/tutorial/digest/chapter.sgml +++ b/fml/doc/en/tutorial/digest/chapter.sgml @@ -1,20 +1,21 @@ <!-- - $FML: chapter.sgml,v 1.2 2003/08/02 14:53:25 fukachan Exp $ + $FML: chapter.sgml,v 1.3 2005/07/20 10:39:17 fukachan Exp $ $jaFML: chapter.sgml,v 1.3 2003/04/15 14:51:39 fukachan Exp $ --> <chapter id="digest"> <title> - Digest delivery + Digest Delivery </title> <para> -run +Run <screen> /usr/local/libexec/fml/digest $ml_name </screen> periodically for digest delivery. It aggregates articles into one -message and send it to members defined by $digest_recipient_maps. +MIME/multipart message and send it to members defined by +$digest_recipient_maps. </para> <warning> @@ -26,7 +27,7 @@ Digest delivery program is a simple version yet now. <sect1 id="digest.config.files"> <title> - Files used for digest delivery control + Files Used For Digest Delivery Control </title> <para> @@ -58,7 +59,7 @@ so you can use mysql here. <sect1 id="digest.command"> <title> - Idea: digest related commands + Idea: Digest Related Commands </title> diff --git a/fml/doc/en/tutorial/internals/bootloader.sgml b/fml/doc/en/tutorial/internals/bootloader.sgml index e7c9d6b8..2b68d4e4 100644 --- a/fml/doc/en/tutorial/internals/bootloader.sgml +++ b/fml/doc/en/tutorial/internals/bootloader.sgml @@ -1,16 +1,16 @@ <!-- - $FML: bootloader.sgml,v 1.13 2005/06/25 15:11:33 fukachan Exp $ + $FML: bootloader.sgml,v 1.1 2005/07/27 12:21:35 fukachan Exp $ --> <chapter id="bootloader"> <title> - &fml8; boot loader to resolv version dependence dynamically + &fml8; Boot Loader To Resolve Version Dependence Dynamically </title> <para> -&fml8; provides a boot loader to resolv version dependence dynamically. -For example, the loader boot straps &fml8; as follows: +&fml8; provides a boot loader to resolve version dependence +dynamically. For example, the loader boot straps &fml8; as follows: <screen> fml (libexec/distribute) boots like this ... @@ -36,7 +36,7 @@ fml (libexec/distribute) boots like this ... <sect1 id="bootloader.example.distribute"> <title> - Case: distribution + Case: Distribution </title> <para> @@ -44,10 +44,11 @@ fml (libexec/distribute) boots like this ... </para> <para> -/usr/local/libexec/fml/distributre (== /usr/local/libexec/fml/loader -in fact) reads /usr/local/etc/fml/main.cf and resolvers the version it -should use from $fml_version variable. Let $fml_version -current-20010501. The loader uses library perl modules under +/usr/local/libexec/fml/distributre (is same as +/usr/local/libexec/fml/loader in fact) reads +/usr/local/etc/fml/main.cf and resolvers the version it should use +from $fml_version variable. Let $fml_version current-20010501. The +loader uses library perl modules under /usr/local/lib/fml/current-20010501/. </para> @@ -74,7 +75,7 @@ argument and drives the object. <sect1 id="bootloader.classes"> <title> - FML::Process:: class structure + FML::Process:: Class Structure </title> <para> @@ -94,7 +95,7 @@ FML::Process::Mead >-| | <sect1 id="bootloader.classes2"> <title> - Modules in process execution + Modules In Process Execution </title> <itemizedlist> @@ -172,7 +173,7 @@ $process->finish($args); <sect1 id="bootloader.resolv.mlxxx"> <title> - Discussion: where function should resolve $ml_name and $ml_domain. + Discussion: Where Function Should Resolve $ml_name And $ml_domain. </title> <para> diff --git a/fml/doc/en/tutorial/internals/cgi.examples.sgml b/fml/doc/en/tutorial/internals/cgi.examples.sgml index bf10702d..7fa66bbf 100644 --- a/fml/doc/en/tutorial/internals/cgi.examples.sgml +++ b/fml/doc/en/tutorial/internals/cgi.examples.sgml @@ -1,15 +1,15 @@ <!-- - $FML: cgi.examples.sgml,v 1.3 2005/06/25 15:11:33 fukachan Exp $ + $FML: cgi.examples.sgml,v 1.1 2005/07/27 12:21:35 fukachan Exp $ --> <sect1 id="cgi.internal.example.isa"> <title> - CGI implementation: inheritance among CGI classes + CGI Implementation: Inheritance Among CGI Classes </title> <para> -@ISA of config.cgi follow: +@ISA of config.cgi follows: <screen> FML::CGI::Menu FML::Process::CGI::Kernel FML::Process::CGI::Param </screen> diff --git a/fml/doc/en/tutorial/internals/cgi.sgml b/fml/doc/en/tutorial/internals/cgi.sgml index 67046cd8..495694ec 100644 --- a/fml/doc/en/tutorial/internals/cgi.sgml +++ b/fml/doc/en/tutorial/internals/cgi.sgml @@ -1,11 +1,11 @@ <!-- - $FML: cgi.sgml,v 1.14 2005/06/25 15:11:33 fukachan Exp $ + $FML: cgi.sgml,v 1.1 2005/07/28 13:27:47 fukachan Exp $ --> <chapter id="cgi.internal"> <title> - Internal of CGI process + Internal Of CGI Process </title> @@ -58,7 +58,7 @@ finish() <sect1 id="cgi.internal.frames"> <title> - Screen of CGI and the method + Screen Of CGI And The Method </title> <para> @@ -96,7 +96,7 @@ sw south se <sect2> <title> - Screen of the current CGI + Screen Of The Current CGI </title> <para> @@ -138,15 +138,15 @@ run_cgi_menu() print out the data. <sect1 id="cgi.internal.trampoline"> <title> - Screen and trampolin mechanism + Screen And Trampolin Mechanism </title> <para> CGI print engine is moved to FML::Command:: class. -However FML::Command:: does not contains all content of pritn engine. +However FML::Command:: does not contains all content of print engine. By object composition, -some modules us methods FML::CGI:: provides. +some modules use methods FML::CGI:: provides. For example, subscribe command internal is as follows. <screen> FML::CGI::Admin::Main -> @@ -162,7 +162,7 @@ The flow goes and back again like trampolin mechanism. <sect1 id="cgi.internal.problems"> <title> - MISC: hard coding is mandatory ? + MISC: Hard Coding Is Mandatory ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/config.cf.sgml b/fml/doc/en/tutorial/internals/config.cf.sgml index db55cee8..8ca66464 100644 --- a/fml/doc/en/tutorial/internals/config.cf.sgml +++ b/fml/doc/en/tutorial/internals/config.cf.sgml @@ -1,18 +1,18 @@ <!-- - $FML: config.cf.sgml,v 1.2 2003/08/03 05:28:48 fukachan Exp $ + $FML: config.cf.sgml,v 1.3 2005/07/27 12:21:35 fukachan Exp $ $jaFML: config.cf.sgml,v 1.11 2003/06/20 22:23:14 fukachan Exp $ --> <chapter id="internal.config.cf"> <title> - Configuration file: config.cf + Configuration File: config.cf </title> <!-- ======================================= --> <sect1 id="config.cf"> <title> - ML specific configuration file: config.cf + ML Specific Configuration File: config.cf </title> <para> @@ -26,7 +26,7 @@ $DIR (e.g. /var/spool/ml). This "config.ph" file is a perl script. </para> <para> -There is a config.cf file in &fmldevel;, too. +There is one configuration file (config.cf) in &fmldevel;, too. But the format is different. The format is like this: <screen> variable = value @@ -61,8 +61,9 @@ It is similar to the conversion from .mc to .cf in sendmail. <para> The use of cf is suitable for configuration tools but introduces another difficulty such as inconsistency between cf and config.ph -since human may edit config.ph but forgets cf editing. So, &fmldevel; -introduces a new format as .cf files. This format is postfix flavour. +since human may edit config.ph but forgets editing cf. So, &fmldevel; +introduces only one configuration file. +It is a new format which is similar to Postfix main.cf. </para> </sect2> @@ -73,12 +74,12 @@ introduces a new format as .cf files. This format is postfix flavour. <!-- ======================================= --> <sect1 id="config.cf.format"> <title> - config.cf format + config.cf Format </title> <para> The format of "config.cf" is "variable = value syntax". -If plural values are required, space or "\n" is a separator. +If plural values are required, space or "\n\s" is a separator. <screen> variable = value @@ -134,7 +135,7 @@ since the last $a overwrites the previous one. <!-- ======================================= --> <sect1 id="config.cf.format.extension"> <title> - Extension to postfix style + Extension To Postfix Style </title> <para> @@ -176,7 +177,7 @@ x = a b c d e <!-- ======================================= --> <sect1 id="config.cf.overload"> <title> - Overload variables in config.cf + Overload Variables In config.cf </title> <para> @@ -194,8 +195,8 @@ ML specific file. </para> <para> -Fml reads these files sequentially. At the last, fml reads ML specific -config.cf and expand variables when variable reading is requested. +&fml8; reads these files sequentially. At the last, &fml8; expands +variables when variable reading is requested. </para> </sect1> @@ -203,8 +204,8 @@ config.cf and expand variables when variable reading is requested. <!-- ======================================= --> <sect1> <title> - Modifying/adding variables - after all configuration files have been loaded. + Modifying/Adding Variables + After All Configuration Files Have Been Loaded. </title> <para> @@ -235,7 +236,7 @@ $config->{ another_key } <sect2> <title> - Internal of variable expansion + Internal Of Variable Expansion </title> <para> @@ -253,7 +254,7 @@ The variable is expanded in calling get() method. <sect1 id="list.variables.by.alphabeticalorder"> <title> - Variable list (alphabetical order) + Variable List (Alphabetical Order) </title> &var.table.list.variables; @@ -263,7 +264,7 @@ The variable is expanded in calling get() method. <sect1 id="list.variables.by.class"> <title> - Variable list (class based) + Variable List (Class Based) </title> &var.table.class.variables; diff --git a/fml/doc/en/tutorial/internals/db_modules.sgml b/fml/doc/en/tutorial/internals/db_modules.sgml index 40f5bd91..55c855a7 100644 --- a/fml/doc/en/tutorial/internals/db_modules.sgml +++ b/fml/doc/en/tutorial/internals/db_modules.sgml @@ -1,5 +1,5 @@ <!-- - $FML: db_modules.sgml,v 1.3 2005/06/25 15:11:33 fukachan Exp $ + $FML: db_modules.sgml,v 1.1 2005/08/03 13:22:06 fukachan Exp $ --> <!-- @@ -9,7 +9,7 @@ <chapter id="db.module"> <title> - Database related module + Database Related Modules </title> @@ -19,16 +19,17 @@ </title> <para> -ML driver needs to hold some data on mail. -some data persistently but some data with expiration (data is -discarded after the interval). +ML driver needs to hold some data on mail. Some data exixsts +persistently but some data with expiration (data is discarded after +some interval). </para> <para> An example of permisistent data is thread database. -The latter case, an exapmle of non persistent data is message-id cache. -The thread database also has message-id cache in it. -But we handle these two data separately. +The latter case, an exapmle of non persistent data, is message-id cache. +The thread database also has message-id cache in it, which is a +sub-set of all message-id set of incoming messages. We handle these +two data separately. </para> <para> @@ -49,7 +50,7 @@ FML::Cache::Ring classes. <para> It is better to use RDBMS for important persistent data such as -address list. This chapter describes persistent data handling for +address list. This chapter describes persistent data handling only for &fml8; internal use. </para> @@ -58,7 +59,7 @@ address list. This chapter describes persistent data handling for <sect1 id="db.module.persistent"> <title> - Persistent data use + Persistent Data Use </title> <para> @@ -76,7 +77,7 @@ for important data. </para> <para> -This chapter describes &fml8; internal use. +This chapter describes only &fml8; internal use. </para> <para> @@ -89,7 +90,7 @@ The type is time saving or space saving. <sect1 id="db.module.Tie.JournaledFile"> <title> - Tie::JournaledFile class + Tie::JournaledFile Class </title> <para> @@ -136,7 +137,7 @@ key => [ <warning> <para> -search algorithm select either of first match or last match. last +Search algorithm is either of first match or last match. The last match by default since the last appended data is latest. </para> </warning> @@ -146,7 +147,7 @@ match by default since the last appended data is latest. <sect1 id="db.module.FML.Cache.Ring"> <title> - FML::Cache::Ring class + FML::Cache::Ring Class </title> <para> diff --git a/fml/doc/en/tutorial/internals/design.sgml b/fml/doc/en/tutorial/internals/design.sgml index ab33f15b..dd9c55f4 100644 --- a/fml/doc/en/tutorial/internals/design.sgml +++ b/fml/doc/en/tutorial/internals/design.sgml @@ -1,11 +1,11 @@ <!-- - $FML: design.sgml,v 1.11 2004/10/06 09:07:38 fukachan Exp $ + $FML: design.sgml,v 1.1 2005/07/28 13:27:47 fukachan Exp $ --> <chapter id="design"> <title> - [LOG] Original Idea of &fml8; project + [LOG] Original Idea Of &fml8; Project </title> @@ -16,7 +16,7 @@ <sect1 id="design.overview"> <title> - the original idea of &fml8; (fml-devel) project + The Original Idea Of &fml8; (fml-devel) Project </title> <para> @@ -48,7 +48,7 @@ of fml-current. <sect1 id="design.idea.detail"> <title> - Details of idea + Details Of Idea </title> <itemizedlist> @@ -153,7 +153,7 @@ of fml-current. <!-- ======================================================== --> <sect1 id="design.refactoring"> <title> - refactoring + Refactoring </title> <table> @@ -176,7 +176,7 @@ of fml-current. </row> <row> - <entry> </entry> + <entry> underway. </entry> <entry> image </entry> <entry> &fml4; to &fml8; is similar to diff --git a/fml/doc/en/tutorial/internals/errormail.sgml b/fml/doc/en/tutorial/internals/errormail.sgml index 020dd96c..39fbbe90 100644 --- a/fml/doc/en/tutorial/internals/errormail.sgml +++ b/fml/doc/en/tutorial/internals/errormail.sgml @@ -1,5 +1,5 @@ <!-- - $FML: errormail.sgml,v 1.7 2005/06/25 14:43:08 fukachan Exp $ + $FML: errormail.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> @@ -14,9 +14,9 @@ mead (/usr/local/fml/libexec/mead) of &fml4; </para> <para> -set "$use_error_mail_analyzer_function = yes" to enable error mail +Set "$use_error_mail_analyzer_function = yes" to enable error mail analyzer function. By default, $use_error_mail_analyzer_function is -yes. That is, &fml8; error analyzer is enabled by default but &fml4; +"yes". That is, &fml8; error analyzer is enabled by default but &fml4; not. This default behaviour differs from &fml4;. </para> @@ -31,14 +31,14 @@ In fact, typical functions of &fml8; are enabled by default. </title> <para> -&fml8; sets up that $ml-admin address (address error messages returned -to) calls /usr/local/libexec/fml/error in creating a ML. +In creating a ML, &fml8; sets up that $ml-admin address (address error +messages returned to) calls /usr/local/libexec/fml/error. </para> <para> /usr/local/libexec/fml/error reads a message, analyzes it and creates a chain of Mail::Message objects on memory. Mail::Bounce class -analyzes the detail of error based on the object. +analyzes the detail of error based on the objects. </para> <para> @@ -62,7 +62,7 @@ member/recipient list. <sect1 id="error.internal.algorithm"> <title> - Algorithm of error detection + Algorithm Of Error Detection </title> <para> @@ -83,10 +83,9 @@ determine whether the address is effective or not. </para> <para> -This logic depends on just the total number of errors. If the traffic -of ML is high, little configuration error of recipients caueses -removal of the address soon. -This is the main problem of this logic. +This logic depends on just the total number of errors. If the traffic +of ML is high, even a little configuration error of recipients caueses +removal of the address soon. This is the main problem of this logic. </para> </sect2> @@ -101,10 +100,11 @@ This is the main problem of this logic. Count up the number of continuous days that error messages returned. If the number oversomes the threshold, &fml8; removes the corresponding address. The threshold is 14 days by default. +That implies continuous errors in 14 days. </para> <para> -This logic assumes that the traffic of a ML is at least one message +This logic assumes that the traffic of an ML is at least one message per day. In other words, this logic requires the continuous error. So, little configuration error in the side of recipient has no effect. </para> @@ -125,7 +125,7 @@ message per day, this algorithm does not work. <sect1 id="error.internal.cache"> <title> - Cache of error messages data + Cache Of Error Messages Data </title> <para> @@ -147,14 +147,17 @@ class. All IO should be done via methods provided by FML::Error::Cache. <sect1 id="error.internal.message.forward"> <title> - Forward error messages + Forward Error Messages </title> <para> You can specify the location the error message is forwarded to as $maintainer_recipient_maps variable. -Undefiend by default. +</para> + +<para> +Undefined by default. Error messages are logged at a log file but not forwarded. </para> diff --git a/fml/doc/en/tutorial/internals/filter.sgml b/fml/doc/en/tutorial/internals/filter.sgml index 98625316..86dd8440 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.1 2005/08/03 13:22:06 fukachan Exp $ + $FML: filter.sgml,v 1.2 2005/09/25 04:27:18 fukachan Exp $ --> @@ -32,12 +32,12 @@ e.g. line length limit of one line. <sect1 id="internals.filter.overview"> <title> - Overview of filter system + Overview Of Filter System </title> <para> There are three types of filter system for content check such as for -header, body and mime structure based. Other than the tree cases, we +header, body and mime structure based. Other than the tree cases, we should consider text/plain and non mime text (text/?) filter. So there may be four types of filter. <screen> @@ -64,7 +64,7 @@ may be four types of filter. </screen> Other than these filters, content_filter using SMTP/LMTP can be needed but not implemented. If you need content_filter, please use the -function of postfix. +function of Postfix. </para> <!-- XXX-TODO traffic filter --> @@ -77,7 +77,7 @@ Traffic based filter is also needed but not implemented yet. <sect1 id="internals.filter.config"> <title> - Configuration variables + Configuration Variables </title> <para> @@ -101,7 +101,7 @@ function_A_rules = rule_01 urle_02 <sect1 id="internals.filter.size"> <title> - Size limit + Size Limit </title> <para> @@ -121,7 +121,7 @@ the input message is analyzed already. <sect1 id="internals.filter.command"> <title> - limit for command mail + Limit For Command Mail </title> <para> @@ -137,7 +137,7 @@ the input message is analyzed already. <sect1 id="internals.filter.mimecomponent"> <title> - mime component filter rules + Mime Component Filter Rules </title> <para> @@ -176,14 +176,14 @@ But there are several problems of rule construction. <sect2> <title> - first match vs last match ? + First Match Vs Last Match ? </title> <para> -This is a filter but not a router filter. Router filter is first -match almost cases. But both first match and last match are not -suitable for mime component filter when we consider the meaning of -"cutoff" operation. +This is a filter but not a router filter. Router filter is first match +in almost cases. But both first match and last match are not suitable +for mime component filter when we consider the meaning of "cutoff" +operation. </para> <para> @@ -197,7 +197,7 @@ suitable for mime component filter when we consider the meaning of <sect1 id="internals.filter.mimecomponent.functions"> <title> - Discussion: mime component filter needs what functions ? + Discussion: Mime Component Filter Needs What Functions ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/hook.sgml b/fml/doc/en/tutorial/internals/hook.sgml index f0c7b015..206e4d5c 100644 --- a/fml/doc/en/tutorial/internals/hook.sgml +++ b/fml/doc/en/tutorial/internals/hook.sgml @@ -1,11 +1,11 @@ <!-- - $FML: hook.sgml,v 1.6 2004/10/06 09:07:39 fukachan Exp $ + $FML: hook.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> <chapter id="hook"> <title> - HOOK + Hook </title> @@ -15,7 +15,7 @@ </title> <para> -Hooks are requierd to resolve complicated problems or for compilcated +Hooks are required to resolve complicated problems or for compilcated customization. But there are several problems in implemantation. </para> @@ -31,7 +31,7 @@ $ROLE_FUNCTION_end_hook </para> <para> -There is no common hook amongh processes. Each process has each hook. +There is no common hook among processes. Each process has each hook. In other words, there is no common hook. You need to define plural hooks for different processes even if the hook is same content. <screen> @@ -48,12 +48,12 @@ since perl beginners may code it. use strict; </screen> definition but not effective in evalauating hooks. -In evaluating a hook, apply +In evaluating a hook, &fml8; evaluate it as <screen> no strict; HOOK CONTENT </screen> -, that is disable the strict check, and evaluates the hook. +to disable the strict check. </para> <para> @@ -68,11 +68,11 @@ We should provide hooks when we can see $curproc. <sect1 id="hook.naming.convention"> <title> - Hook naming convension + Hook Naming Convension </title> <para> -hook standard form is +Hook standard form is <screen> ROLE_METHOD_start_hook ROLE_METHOD_end_hook @@ -90,7 +90,7 @@ the following hooks: fmlconf_run_start_hook fmlconf_run_end_hook </screen> -The actual code calling hooks follows: +The actual code calling hooks as follows: <screen> sub run { diff --git a/fml/doc/en/tutorial/internals/io_abstraction.sgml b/fml/doc/en/tutorial/internals/io_abstraction.sgml index c66eb10a..5dcf7cd5 100644 --- a/fml/doc/en/tutorial/internals/io_abstraction.sgml +++ b/fml/doc/en/tutorial/internals/io_abstraction.sgml @@ -1,11 +1,11 @@ <!-- - $FML: io_abstraction.sgml,v 1.5 2005/06/25 15:11:34 fukachan Exp $ + $FML: io_abstraction.sgml,v 1.1 2005/07/28 13:27:48 fukachan Exp $ --> <chapter id="io.abstraction"> <title> - IO Interface and operations + IO Interface And Operations </title> <para> @@ -38,7 +38,7 @@ abstraction layer. <sect1 id="io.abstraction.overview"> <title> - Fundamentals of IO::Adapter + Fundamentals Of IO::Adapter </title> <para> @@ -94,7 +94,7 @@ At least, enough to write user management codes. <sect1 id="io.abstraction.ops"> <title> - Methods / operation vector + Methods / Operation Vector </title> <para> @@ -131,7 +131,7 @@ The argument is a map which calls map dependent constructor. </title> <para> -For a file, call open(2), for RDBMS, connect to the specified sql +For a file, call open(2), for RDBMS, connect to the specified SQL server. </para> @@ -144,7 +144,7 @@ server. </title> <para> -reverse of open(). +Reverse of open(). </para> </sect2> @@ -167,7 +167,7 @@ It is similar to RDBMS. <para> The primary key is a mail address. This assumption is correct in the -case of mailing list deriver. This is basic data structure. +case of mailing list driver. This is basic data structure. </para> </sect2> @@ -179,7 +179,7 @@ case of mailing list deriver. This is basic data structure. </title> <para> -delete KEY and the associated VALUE. +Delete KEY and the associated VALUE. </para> </sect2> @@ -191,7 +191,7 @@ delete KEY and the associated VALUE. </title> <para> -search data corresponding with the primary key within an object. +Search data corresponding with the primary key within an object. </para> <para> @@ -200,7 +200,7 @@ Regular expression search is useful. </para> <para> -The returl value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). +The return value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). </para> </sect2> @@ -212,7 +212,7 @@ The returl value is STR of ARRAY_REF (KEY => [ VALUE, VALUE2, VALUE3 ]). </title> <para> -return the list of primary keys like this: +Return the list of primary keys like this: <screen> while ($obj->get_next_key()) { ... } </screen> @@ -240,7 +240,7 @@ This operation corresponds to FIRST_KEY() and NEXT_KEY() of perl hash. <para> What expected in using ARRAY_REF as the return value ? -a list of PRIMARY KEY ? +A list of PRIMARY KEY ? </para> </sect2> @@ -248,13 +248,13 @@ a list of PRIMARY KEY ? <sect2> <title> - How to get all primary keys ? + How To Get All Primary Keys ? </title> <para> -We need to call get_next_keys() again and again. It may be useful to -implement special method to return a list of keys but it is not -implemented. +We need to call get_next_keys() again and again to retrieve all +keys. It may be useful to implement special method to return a list of +keys but it is not implemented. </para> <para> @@ -268,7 +268,7 @@ It is of no use to implement specific method for this. <sect2> <title> - HASH_REF as return value ? + HASH_REF As Return Value ? </title> <para> diff --git a/fml/doc/en/tutorial/internals/language.sgml b/fml/doc/en/tutorial/internals/language.sgml index dc4aa124..439518f4 100644 --- a/fml/doc/en/tutorial/internals/language.sgml +++ b/fml/doc/en/tutorial/internals/language.sgml @@ -1,23 +1,23 @@ <!-- - $FML: language.sgml,v 1.3 2004/10/06 09:07:39 fukachan Exp $ + $FML: language.sgml,v 1.1 2005/07/27 12:21:36 fukachan Exp $ --> <chapter id="language.preference"> <title> - Language preference in processing + Language Preference In Processing </title> <sect1 id="language.preference.overview"> <title> - Problems of language preference + Problems Of Language Preference </title> <para> The simplest model is that we suppose we should return the japanese -message when the ML is configures as for Japanese. -This model needs the language of a ML is fixed. +message when the ML is configured as for Japanese. +This model needs that the language of a ML is fixed. This ML always returns the error message in Japanese. </para> @@ -35,7 +35,7 @@ with the body content "help" (English) ? In that case we cannot determine we should return the reply in us-ascii or iso-2022-jp. For example, how about the following example ? <screen> -Example: +[Example] From: rudo@example.co.jp Subject: help @@ -49,9 +49,9 @@ help <para> We should return the English reply message based on charset information since this message contains English only, so charset is -us-ascii. But this case we should return Japanese message since the +us-ascii. But in this case we should return Japanese message since the sender is a Japanese. So we should return the help message in both -English and Japanese if the ML is configures as Japanese +English and Japanese if the ML is configured as Japanese preferrable. If English is preferrable, the reply is English only. </para> @@ -68,12 +68,12 @@ Japanese help message. <sect1 id="language.preference.ml.ja"> <title> - Japanese preferred ML + Japanese Preferred ML </title> <para> language_preference_order variable controls the behaviour. -By default, an ML for Japanese is configures as +By default, an ML for Japanese is configured as <screen> language_preference_order = ja en </screen> diff --git a/fml/doc/en/tutorial/module/IO.sgml b/fml/doc/en/tutorial/module/IO.sgml index 1db6a7bc..ed326efb 100644 --- a/fml/doc/en/tutorial/module/IO.sgml +++ b/fml/doc/en/tutorial/module/IO.sgml @@ -1,17 +1,17 @@ <!-- - $FML: IO.sgml,v 1.1 2003/07/28 10:41:30 fukachan Exp $ + $FML: IO.sgml,v 1.2 2003/08/03 01:47:17 fukachan Exp $ $jaFML: IO.sgml,v 1.4 2003/04/15 14:51:42 fukachan Exp $ --> <chapter id="module.io.adapter"> <title> - IO abstraction layer (IO::Adapter class) + IO Abstraction Layer (IO::Adapter Class) </title> <sect1 id="module.io.adapter.overview"> <title> - IO::Adapter overview + IO::Adapter Overview </title> <para> @@ -35,8 +35,8 @@ file:/var/spool/ml/elena/recipients unix.group:root nis.group:root mysql:id -postgresql:id (not yet implemented) -ldap:id (not yet implemented) +postgresql:id +ldap:id </screen> </para> @@ -55,7 +55,7 @@ IO::Adapter". <sect1 id="module.io.adapter.methods"> <title> - IO::Adapter methods + IO::Adapter Methods </title> <para> @@ -103,14 +103,14 @@ between &fml4; and &fml8; but it is mandatory for further abstraction. <sect1> <title> - Argument type of methods + Argument Type Of Methods </title> <para> -The argument needs nothing or STR as the argument and the return value -is STR. get_next_key() is typical as the no argument case. This method -is used to list up the content of files or retrieve the specific -address in the file. +The argument needs nothing, STR or ARRAY_REF as the argument and the +return value is STR. get_next_key() is typical as the no argument +case. This method is used to list up the content of files or retrieve +the specific address in the file. </para> <para> @@ -122,7 +122,7 @@ KEY_STR => [ VALUE_STR_3 ] </screen> -This is used as the return value to represent ARRAY. For example, +This is used as the return value to represent ARRAY_REF. For example, "actives" file of &fml4; consists of lines which have plural space separeted entries. So it can be representated as a type of array. <screen> @@ -137,8 +137,13 @@ rudo@nuinui.net => [ </para> <para> +If retrieval value could be represented as ARRAY_REF, argument of +store operations alsot needs ARRAY_REF. +</para> + +<para> It is summarized as follows. -The argument is one of "nothing" or "STR". +The argument is one of "nothing", "STR" or ARRAY_REF. The return value is either of STR of ARRAY_REF (array reference). <screen> argument return value @@ -158,7 +163,7 @@ STR => [STR, STR, ... ] <sect1 id="module.io.adapter.map.file"> <title> - File map + File Map </title> <para> @@ -172,7 +177,7 @@ The format of text file is space separated. <sect1 id="module.io.adapter.map.unixgroup"> <title> - Unixgroup map + Unixgroup Map </title> <para> @@ -204,7 +209,7 @@ kenken <sect1 id="module.io.adapter.map.nis"> <title> - NIS map + Nis Map </title> <para> @@ -216,13 +221,13 @@ It is same as one of /etc/group but the data is retrieved from NIS/YP. <sect1 id="module.io.adapter.map.mysql"> <title> - MySQL map + MySQL Map </title> <para> For easy maintenance, it is better to write all mysql configurations in one file. For example, it is good that we have only to write SQL -configuratinos in config.cf. +configurations in config.cf. </para> <para> @@ -274,12 +279,12 @@ method. <sect2> <title> Discussion: - How to write sql statements in config.cf ? + How To Write SQL Statements In config.cf ? (fml-devel 204) </title> <para> -How about lexical scope ? The .cf files cannot define all variables +How about lexical scope ? The .cf files cannot contain all variables since lexical scope variables exist. We use &varname syntax for such lexical scope variables. </para> diff --git a/fml/doc/en/tutorial/module/Message.sgml b/fml/doc/en/tutorial/module/Message.sgml index 2d162867..2eeb8b45 100644 --- a/fml/doc/en/tutorial/module/Message.sgml +++ b/fml/doc/en/tutorial/module/Message.sgml @@ -1,16 +1,16 @@ <!-- - $FML: Message.sgml,v 1.1 2003/07/28 10:41:30 fukachan Exp $ + $FML: Message.sgml,v 1.2 2003/08/03 01:47:17 fukachan Exp $ $jaFML: Message.sgml,v 1.2 2003/04/15 14:51:42 fukachan Exp $ --> <chapter id="module.mail.message"> <title> - Mail::Message module + Mail::Message Module </title> <sect1 id="module.mail.message.overview"> <title> - Mail::Message overview + Mail::Message Overview </title> <para> @@ -28,7 +28,7 @@ If not multipart else if multipart - header -> preamble -> part1 -> part2 -> trailor + header -> preamble -> part1 -> part2 -> ... -> trailor </screen> The link between objects is double link list. Mail::Message class provides several methods to manipulate these structures. @@ -59,7 +59,7 @@ Mail::Message module manual. <sect1 id="module.mail.message.parse"> <title> - Mail::Message module: analyze + Mail::Message Module: Analyze </title> <para> @@ -91,7 +91,7 @@ the whole message (content-type in the mail header). <sect1 id="module.mail.message.create"> <title> - Mail::Message module: create a new object + Mail::Message Module: Create A New Object </title> <para> @@ -120,7 +120,7 @@ is MIME::Lite class in fact :-) <sect1 id="module.mail.message.headerop"> <title> - Mail::Message module: header manipulations + Mail::Message Module: Header Manipulations </title> <para> @@ -153,7 +153,7 @@ It tells whether this message is text or multipart. <sect1 id="module.mail.message.bodyop"> <title> - Mail::Message module: manipulate messabe body + Mail::Message Module: Manipulate Messabe Body </title> <para> @@ -165,14 +165,14 @@ header -> body else if multipart -header -> preamble -> part1 -> part2 -> trailor +header -> preamble -> part1 -> part2 -> ... -> trailor </screen> </para> <para> header_data_type() return the type of the whole type. -It is the information from Content-Type: in the whole message header. +It is known from Content-Type: in the whole message header. </para> <para> @@ -191,7 +191,7 @@ system checks the first text field in a lot of cases. <sect1 id="module.mail.message.search"> <title> - Mail::Message module: search + Mail::Message Module: Search </title> <para> @@ -204,7 +204,7 @@ chain and returns the first matched object. <sect1 id="module.mail.message.print"> <title> - Mail::Message module: print + Mail::Message Module: Print </title> <para> @@ -224,7 +224,7 @@ codes. <sect1 id="module.mail.message.utils"> <title> - Mail::Message module: utility functions + Mail::Message Module: Utility Functions </title> <sect2> @@ -248,7 +248,7 @@ is_empty() tells the object data is empty or not. <sect2> <title> - General information + General Information </title> <para> @@ -272,7 +272,7 @@ encoding mechanism. <sect2> <title> - Mail::Message internals + Mail::Message Internals </title> <para> @@ -288,7 +288,7 @@ Caution that N starts from 1 not 0. <para> -header() return the header part of a multipart block (header part of +header() returns the header part of a multipart block (header part of an object). data() returns the data part (data part of an object). Respectively, alias of message_fields($size) and message_text($size). </para> @@ -300,7 +300,7 @@ Respectively, alias of message_fields($size) and message_text($size). <sect1 id="module.mail.message.ref"> <title> - Refernces + References </title> <para> diff --git a/fml/doc/en/tutorial/module/create.sgml b/fml/doc/en/tutorial/module/create.sgml index 30da7477..db0cdf25 100644 --- a/fml/doc/en/tutorial/module/create.sgml +++ b/fml/doc/en/tutorial/module/create.sgml @@ -1,11 +1,11 @@ <!-- - $FML: create.sgml,v 1.2 2003/08/03 01:47:17 fukachan Exp $ + $FML: create.sgml,v 1.3 2005/07/20 10:39:17 fukachan Exp $ $jaFML: create.sgml,v 1.2 2003/04/15 14:51:42 fukachan Exp $ --> <chapter id="module.create"> <title> - Execise: create a new program + Execise: Create A New Program </title> @@ -18,19 +18,19 @@ framework. Here the program name is "fmlsch" and the cgi is <sect1> <title> - Case study: create a fmlsch + Case Study: Create A fmlsch </title> <sect2> <title> - Step 1: add fmlsch into installer configuration + Step 1: Add fmlsch Into Installer Configuration </title> <para> Prepare fml/bin/fmlsch.in, add fmlsch into $bin_programs in fml/etc/install.cf.in. -Run configreu to re-create fml/etc/install.cf. +Run configure to re-create fml/etc/install.cf. </para> </sect2> @@ -38,7 +38,7 @@ Run configreu to re-create fml/etc/install.cf. <sect2> <title> - Step 2: build a module + Step 2: Build A Module </title> @@ -51,6 +51,7 @@ Import other libraries if needed. For fmlsch we import HTML-CalendarMonthSimple-1.02.tar.gz from CPAN. +See cpan/ directory. </para> <para> @@ -62,13 +63,12 @@ Also, install Date-Calc if your system has not it. <sect2> <title> - Step 3: modify FML::Process:: class + Step 3: Modify FML::Process:: Class </title> <para> -FML::Demo::Calendar works mainly but we build the machanism how &fml8; -loads and runs it. We modify FML::Process class for &fml8; bootloader -to call FML::Demo::Calendar. +FML::Demo::Calendar works mainly. We need to prepare FML::Process +class for &fml8; bootloader to call FML::Demo::Calendar. </para> <para> @@ -87,7 +87,7 @@ command line options parsed by Getopt::Long(). <para> Create FML::Process::Calender module by copy-and-pasting other -FML::Process:: modules :-) However fmlsch has only to contain least +FML::Process:: modules :-) Though fmlsch has only to contain least functions, you need to write FML::Process::Calender::run() method. For undefined methods, fml loads FML::Process::Kernel functions (inheritence). @@ -100,13 +100,13 @@ For undefined methods, fml loads FML::Process::Kernel functions <sect1> <title> - Case study: fmlsch.cgi + Case Study: fmlsch.cgi </title> <para> -The way of hacking is similar to fmlsch. The differnce is that the -target to modify is FML::CGI:: class. FML::CGI::Calender is a +The way of hacking is similar to fmlsch. The differnce is the target +to modify, which is FML::CGI:: class. FML::CGI::Calender is a sub-class of FML::Process::CGI. </para> diff --git a/fml/doc/en/tutorial/module/encode.sgml b/fml/doc/en/tutorial/module/encode.sgml index 370e48b4..8cfa0885 100644 --- a/fml/doc/en/tutorial/module/encode.sgml +++ b/fml/doc/en/tutorial/module/encode.sgml @@ -1,11 +1,11 @@ <!-- - $FML: encode.sgml,v 1.1 2003/07/28 10:41:31 fukachan Exp $ + $FML: encode.sgml,v 1.2 2003/08/03 01:47:17 fukachan Exp $ $jaFML: encode.sgml,v 1.2 2003/04/15 14:51:42 fukachan Exp $ --> <chapter id="module.mail.message.encode"> <title> - Mail::Message::Encode class + Mail::Message::Encode Class </title> <para> @@ -27,7 +27,7 @@ my $fp = sub { ... }; $encode->run_in_chcode( $fp, $oout, $in ); - * 4.0 compatible functions are available. + * If you want to use 4.0 compatible functions, ues Mail::Message::Encode qw(STR2EUC); my $euc_s = STR2EUC( $s ); </screen> @@ -35,7 +35,7 @@ <sect1> <title> - Mail::Message::Encode specification + Mail::Message::Encode Specification </title> <para> diff --git a/fml/doc/en/tutorial/module/nativelanguage.sgml b/fml/doc/en/tutorial/module/nativelanguage.sgml index 6252870c..d9faae91 100644 --- a/fml/doc/en/tutorial/module/nativelanguage.sgml +++ b/fml/doc/en/tutorial/module/nativelanguage.sgml @@ -1,15 +1,15 @@ <!-- - $FML: nativelanguage.sgml,v 1.1 2003/07/28 15:20:18 fukachan Exp $ + $FML: nativelanguage.sgml,v 1.2 2003/08/03 01:47:17 fukachan Exp $ $jaFML: nativelanguage.sgml,v 1.3 2003/04/15 14:51:43 fukachan Exp $ --> <chapter> <title> - Language dependent functions + Language Dependent Functions </title> <para> -Fml needs language dependent functions internally. Especially, JIS +&fml8; needs language dependent functions internally. Especially, JIS to/from EUC-JP Janapese code conversion is used anywhere since Japanese mail messages are written in JIS code but programs are easy to use strings in EUC-JP. @@ -26,7 +26,7 @@ for the language dependence handling in messages. <sect1> <title> - Something::Language:: class + Something::Language:: Class </title> <para> diff --git a/fml/doc/en/tutorial/overview/fml.sgml b/fml/doc/en/tutorial/overview/fml.sgml index 27ce618b..f64d0b91 100644 --- a/fml/doc/en/tutorial/overview/fml.sgml +++ b/fml/doc/en/tutorial/overview/fml.sgml @@ -1,11 +1,11 @@ <!-- - $FML: fml.sgml,v 1.2 2003/07/27 18:11:40 fukachan Exp $ + $FML: fml.sgml,v 1.3 2005/07/23 01:57:40 fukachan Exp $ $jaFML: fml.sgml,v 1.4 2003/04/15 14:51:43 fukachan Exp $ --> <chapter id="overview.fml"> <title> - &fmldevel; overview + &fmldevel; Overview </title> <para> @@ -20,7 +20,7 @@ on the detail of difference between &fml4; and &fml8;. <!-- ======================================================== --> <sect1 id="overview.fml8"> <title> - &fmldevel; features + &fmldevel; Features </title> <para> @@ -31,7 +31,7 @@ on the detail of difference between &fml4; and &fml8;. <para> &fml8; configuration file format is changed to <link linkend="internal.config.cf"> - new postfix style format configuration files (.cf files). + new Postfix style format configuration files (.cf files). </link> </para> </listitem> @@ -211,7 +211,7 @@ on the detail of difference between &fml4; and &fml8;. <!-- ======================================================== --> <sect1 id="overview.fml8.install"> <title> - installation overview + Installation Overview </title> @@ -309,7 +309,7 @@ The brief flow of installation is as follows: % makefml newml elena </screen> You can use "fml" instead of makefml. -Both are same except for the syntax. +Both are same except for the argument order. <screen> % su fml % fml elena newml @@ -337,7 +337,7 @@ Both are same except for the syntax. <listitem> <para> <link linkend="guide.config.cf"> - Cutomize your ML. + Customize your ML. </link> </para> </listitem> @@ -357,7 +357,7 @@ It is different from &fml4;. <!-- ============================================================= --> <sect1 id="guide.newml"> <title> - Create an ML + Create An ML </title> <para> @@ -408,7 +408,7 @@ for the virtual domain case detail. <!-- ============================================================= --> <sect1 id="guide.subscribe"> <title> - add a new user to ML + Add A New User To ML </title> <para> @@ -431,7 +431,7 @@ specify the whole adress of ML name. <!-- ============================================================= --> <sect1 id="guide.unsubscribe"> <title> - remove the user + Remove The User </title> <para> @@ -454,7 +454,7 @@ specify the whole adress of ML name. <!-- ============================================================= --> <sect1 id="guide.config.cf"> <title> - customize + Customize </title> <warning> @@ -472,7 +472,7 @@ Edit configuration files anyway now. <sect2> <title> - common configurations on this host + Common Configurations On This Host </title> <para> @@ -504,7 +504,7 @@ for the configurable variation. <sect2> <title> - elena ML's configuration + elena ML's Configuration </title> <para> @@ -514,7 +514,7 @@ format is a little modified postfix style. </link> It is different from both &fml4;'s config.ph and cf. -Add hooks after =cut line. +Add hooks after =cut line if needed. </para> <para> diff --git a/fml/doc/en/tutorial/overview/ml.sgml b/fml/doc/en/tutorial/overview/ml.sgml index f62408d8..12757f9e 100644 --- a/fml/doc/en/tutorial/overview/ml.sgml +++ b/fml/doc/en/tutorial/overview/ml.sgml @@ -1,11 +1,11 @@ <!-- - $FML: ml.sgml,v 1.1 2003/07/24 15:37:37 fukachan Exp $ + $FML: ml.sgml,v 1.2 2003/07/27 18:11:40 fukachan Exp $ $jaFML: ml.sgml,v 1.3 2003/04/15 14:51:43 fukachan Exp $ --> <chapter id="overview.ml"> <title> - mailing list ? + What Is Mailing List ? </title> <sect1 id="overview.email"> @@ -19,9 +19,11 @@ Email is an electirc version of mail. <para> One email has the following structure which consists of two parts. -The former is the header, the latter is the body. The separator -between them is one null line (empty line). +The former is header, the latter is body. The separator between them +is one null line (empty line). <screen> +[Example] + From: rudo@nuinui.net To: kenken@nuinui.net Subject: asobo. @@ -39,7 +41,7 @@ See RFC822 and RFC2822 for more details of definitions. <sect1 id="overview.mailinglist"> <title> - mailing list (ML) + Mailing List (Ml) </title> <para> @@ -51,7 +53,7 @@ the ML. <sect2 id="overview.mldriver"> <title> - model of an ML. + Model Of An ML. </title> <para> diff --git a/fml/doc/en/tutorial/preface.sgml b/fml/doc/en/tutorial/preface.sgml index 2240dfa2..ed1871e0 100644 --- a/fml/doc/en/tutorial/preface.sgml +++ b/fml/doc/en/tutorial/preface.sgml @@ -1,5 +1,5 @@ <!-- - $FML: preface.sgml,v 1.4 2003/07/27 15:31:52 fukachan Exp $ + $FML: preface.sgml,v 1.5 2005/07/23 01:58:47 fukachan Exp $ $jaFML: preface.sgml,v 1.18 2003/04/15 14:51:35 fukachan Exp $ --> @@ -12,14 +12,14 @@ <sect1 id="status"> <title> - &fml8; status + &fml8; Status </title> <warning> <para> -&fml8; already implemented fundamental functions. Several people uses -&fml8; as hobby and office mailing list system under normal +&fml8; has already implemented fundamental functions. Several people +uses &fml8; as hobby and office mailing list system under normal operations. </para> @@ -54,7 +54,7 @@ on the difference between &fml4; and &fml8;. <sect1 id="way.to.fmlng"> <title> - The road to the next generation of fml + The Road To The Next Generation Of Fml </title> <para> @@ -66,7 +66,7 @@ re-implementation of fml mailing list driver system with reflecting our <para> Roughly speaking, the relation between &fml4; and &fml8; is -similar to one between sendmail and postfix. +similar to one between sendmail and Postfix. </para> <para> @@ -78,9 +78,9 @@ clean source codes. <para> For example, when you use &fml4;, you'll find that fml assumes the -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 +list of members is a text file 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> @@ -142,7 +142,7 @@ ftp://ftp.fml.org/pub/fml8/ <!-- ======================================================== --> <sect1 id="fml.and.fmlng"> <title> - relation between &fml4; and &fml8; development branch. + Relation Between &fml4; And &fml8; Development Branch. </title> <para> @@ -173,7 +173,7 @@ We only have to bug-fix at &fml4; branch. <sect1 id="mailinglist"> <title> - mailing list + Mailing List </title> <para> @@ -203,7 +203,7 @@ subscribe Kinomoto Sakura <sect1> <title> - Please let me know your opinion ... + Please Let Me Know Your Opinion ... </title> <para> @@ -225,7 +225,7 @@ directly. <sect1> <title> - On this tutorial + On This Tutorial </title> <para> |