diff options
| author | fukachan <fukachan> | 2005-09-18 13:55:54 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2005-09-18 13:55:54 +0000 |
| commit | d5bc53045bad01b54232c5793387509dadf053ef (patch) | |
| tree | 4b672810c2d816f1fa6f4aa9003548981df4bfbd /fml/doc | |
| parent | 9562005ee99278bd272f81497c9d5e87a9a84fa5 (diff) | |
| download | fml8-d5bc53045bad01b54232c5793387509dadf053ef.tar.gz fml8-d5bc53045bad01b54232c5793387509dadf053ef.tar.bz2 fml8-d5bc53045bad01b54232c5793387509dadf053ef.zip | |
clean up.
Diffstat (limited to 'fml/doc')
35 files changed, 398 insertions, 330 deletions
diff --git a/fml/doc/en/tutorial/book.sgml b/fml/doc/en/tutorial/book.sgml index 6773efec..bee0067c 100644 --- a/fml/doc/en/tutorial/book.sgml +++ b/fml/doc/en/tutorial/book.sgml @@ -2,7 +2,7 @@ This is an sgml using DocBook dtd. Use sgmltools version 2.0.x or above to generate various output formats. - $FML: book.sgml,v 1.2 2003/07/26 09:10:39 fukachan Exp $ + $FML: book.sgml,v 1.3 2005/07/23 01:58:46 fukachan Exp $ $jaFML: book.sgml,v 1.58 2003/05/31 08:51:07 fukachan Exp $ --> @@ -20,7 +20,7 @@ to generate various output formats. <part> <title> - fml fundamental usage + Fml Fundamental Usage </title> <partintro> @@ -40,10 +40,13 @@ to generate various output formats. <part> - <title> fml: how to set up ML.</title> + <title> + How To Set Up ML + </title> + <partintro> <para> - topics driven in this part. + Topics driven in this part. </para> </partintro> @@ -74,12 +77,12 @@ to generate various output formats. <part> <title> - fml: how to customise + How To Customise </title> <partintro> <para> - topics driven in this part. + Topics driven in this part. </para> </partintro> @@ -139,7 +142,7 @@ to generate various output formats. <partintro> <para> - THis part describes the design policy of fml. + This part describes the design policy of fml. </para> </partintro> diff --git a/fml/doc/en/tutorial/setup/apache.sgml b/fml/doc/en/tutorial/setup/apache.sgml index 728a29d4..cf217055 100644 --- a/fml/doc/en/tutorial/setup/apache.sgml +++ b/fml/doc/en/tutorial/setup/apache.sgml @@ -1,11 +1,11 @@ <!-- - $FML: apache.sgml,v 1.4 2005/06/25 15:11:36 fukachan Exp $ + $FML: apache.sgml,v 1.1 2005/07/23 01:57:36 fukachan Exp $ --> <chapter id="setup.apache"> <title> - Apache configuration + Apache Configuration </title> @@ -24,17 +24,17 @@ for the &fml8; CGI internals. <sect1 id="setup.apache.suexec"> <title> - Use suexec of apache + Use Suexec Of Apache </title> <para> Build apache enabled with suexec. -Run configure by +Run configure by <screen> (apache 1.x) configure --enable-suexec --suexec-caller=www </screen> -The user "www" can call suexec. +In this case, the user "www" can call suexec. Please prepare a user specific for suexec-ed environment. </para> diff --git a/fml/doc/en/tutorial/setup/cgi.sgml b/fml/doc/en/tutorial/setup/cgi.sgml index 8e051b8e..27c7f5f3 100644 --- a/fml/doc/en/tutorial/setup/cgi.sgml +++ b/fml/doc/en/tutorial/setup/cgi.sgml @@ -1,5 +1,5 @@ <!-- - $FML: cgi.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: cgi.sgml,v 1.2 2005/07/23 01:57:36 fukachan Exp $ $jaFML: cgi.sgml,v 1.4 2003/04/15 14:51:43 fukachan Exp $ --> @@ -28,8 +28,8 @@ you use suexec under apache. <para> Now &fml8; provides both the master cgi to control all ML's in one -domain and a cgi for each ml. -You can add and remove a user, or view member list et.al by this interface. +domain and a cgi for each ML. +You can add and remove a user, or view member list et.al. by this interface. Editing of configuration on this cgi is incomplete. </para> @@ -43,7 +43,7 @@ configuration for cgi specific reason. <sect1 id="setupcgi.install"> <title> - "makefml newml" creates CGI script always. + "makefml newml" Creates CGI Script Always </title> <para> @@ -58,15 +58,18 @@ In creating elena@fml.org ML, makefml creates the following cgi <screen> http://lists.fml.org/~fml/cgi-bin/fml/$domain/admin/config.cgi -Example: +[Example] http://lists.fml.org/~fml/cgi-bin/fml/fml.org/admin/config.cgi </screen> for all ML's of fml.org. +</para> + +<para> To control only elena ML, please use <screen> http://lists.fml.org/~fml/cgi-bin/fml/$domain/ml-admin/${ml_name}/config.cgi -Example: +[Example] http://lists.fml.org/~fml/cgi-bin/fml/fml.org/ml-admin/elena/config.cgi </screen> </para> @@ -80,7 +83,7 @@ http://lists.fml.org/~fml/cgi-bin/fml/fml.org/ml-admin/elena/config.cgi <sect1 id="setupcgi.htaccess"> <title> - edit .htaccess + Edit .htaccess </title> <para> @@ -88,7 +91,7 @@ http://lists.fml.org/~fml/cgi-bin/fml/fml.org/ml-admin/elena/config.cgi <screen> http://lists.fml.org/~fml/cgi-bin/fml/$domain/.htaccess -Example: +[Example] http://lists.fml.org/~fml/cgi-bin/fml/fml.org/.htaccess </screen> </para> @@ -104,7 +107,7 @@ Please edit .htaccess properly. </para> <para> -Apache dos not support ~user style access by default. +Apache does not support ~user style access by default. Please set up apache to enable it. </para> @@ -113,14 +116,14 @@ Please set up apache to enable it. <sect1 id="setupcgi.admin.cgi.overview"> <title> - Example: master cgi + Example: Master Cgi </title> <para> -The role of this cgi is limited makefml (CUI). +The role of this cgi is same as limited makefml (CUI). Though this cgi permits ML creation and destruction, all functions makefml has are not supported. -The functions is limited. +The function is limited. </para> <para> @@ -156,16 +159,16 @@ options Language: list <sect1 id="setupcgi.admin.cgi.newml"> <title> - CGI Example: create an ML + CGI Example: Create ML </title> <para> Select newml and push "submit". -no need to select ML name in this stage. +No need to select ML name in this stage. </para> <para> -You find nother menu at the center. +You find another menu at the center. Specify the ML name you create and push "submit" at the center. </para> @@ -178,7 +181,7 @@ Specify the ML name you create and push "submit" at the center. <sect1 id="setupcgi.admin.cgi.subscribe"> <title> - CGI example: subscribe + CGI Example: subscribe </title> <para> @@ -199,7 +202,7 @@ Specify the address to subscribe and push "submit" at the center. <sect1 id="setupcgi.admin.cgi.skin"> <title> - CGI skin selection + CGI Skin Selection </title> <para> diff --git a/fml/doc/en/tutorial/setup/config.cf.sgml b/fml/doc/en/tutorial/setup/config.cf.sgml index f05bc2ff..8db5ad80 100644 --- a/fml/doc/en/tutorial/setup/config.cf.sgml +++ b/fml/doc/en/tutorial/setup/config.cf.sgml @@ -1,11 +1,11 @@ <!-- - $FML: config.cf.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: config.cf.sgml,v 1.2 2005/07/23 01:57:36 fukachan Exp $ $jaFML: config.cf.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $ --> <sect1 id="setup.config.cf"> <title> - customize config.cf + Customize config.cf </title> <para> diff --git a/fml/doc/en/tutorial/setup/merge.fml4to8.sgml b/fml/doc/en/tutorial/setup/merge.fml4to8.sgml index d67ff48d..8fea16cf 100644 --- a/fml/doc/en/tutorial/setup/merge.fml4to8.sgml +++ b/fml/doc/en/tutorial/setup/merge.fml4to8.sgml @@ -1,11 +1,11 @@ <!-- - $FML: merge.fml4to8.sgml,v 1.6 2005/06/25 15:11:37 fukachan Exp $ + $FML: merge.fml4to8.sgml,v 1.1 2005/07/23 01:57:36 fukachan Exp $ --> <chapter id="mergeml.fml4to8"> <title> - Convert &fml4; style ML to &fml8; style ML + Convert &fml4; Style ML To &fml8; Style ML </title> <para> @@ -28,37 +28,33 @@ It enables easy upgrade from &fml4; to &fml8;. <sect1 id="mergeml.fml4to8.overview"> <title> - Overview: &fml4; to &fml8; (1) + Overview: &fml4; To &fml8; (1) </title> <para> -It is wrong that &fml8; works if &fml8; overwrites &fml4; programs. +It is a little wrong that &fml8; works if &fml8; overwrites &fml4; +programs. Currently &fml8; can work but it needs automatic conversion +in the background. Hence, &fml8; modifies &fml4; to emulate &fml4;. </para> <para> -Currently &fml8; can work but it needs automatic conversion in the -background. -</para> - -<para> -Firstly you want to upgrade all ML's at the same time from &fml4; to -&fml8; ? -It is better to upgrade from one to one ? +Firstly there is a problem. You want to upgrade all ML's at the same +time from &fml4; to &fml8;? It is better to upgrade from one to one ? When something fails, you want to downgrade your system if could. </para> <para> -We want to support that upgrade of each ML. So it is available that -some ML's are &fml8;, other ML's are &fml4; in one domein. -Downgrading if needed are supported. +We want to support both types. So it is available that some ML's are +&fml8;, other ML's are &fml4; in one domain +simultaneously. Downgrading if needed are supported. </para> <para> One example of upgrade operation follows: <screen> -1. install fml8 +1. install &fml8; -2. (in the case of postfix) add &fml8; aliases to postfix's alias_maps. +2. (in the case of Postfix) add &fml8; aliases to postfix's alias_maps. Example: alias_maps = hash:/etc/mail/aliases @@ -76,15 +72,16 @@ Apply 3. for ML's which would be converted to &fml8;. </para> <para> -You can use "makefml mergeml" command of aliases, include files, -&fml4; configuration files and member lists from &fml4; to &fml8;. +You can use "makefml mergeml" command to convert aliases, include +files, &fml4; configuration files and member lists from &fml4; to +&fml8;. </para> <para> -It is not easy to convert difficult config.ph file. Now we can convert -simple config.ph to &fml8; config.cf style file automatically. We -support this simple config.ph is generatd by &fml4;'s "makefml config" -command. +It is not easy to convert difficult &fml4;'s config.ph file. Now we +can convert simple config.ph to &fml8; config.cf style file +automatically. We suppose this simple config.ph is generated by +&fml4;'s "makefml config" command. </para> </sect1> @@ -92,7 +89,7 @@ command. <sect1 id="mergeml.fml4.overview"> <title> - Overview: convert &fml4; to &fml8; (2) + Overview: Convert &fml4; To &fml8; (2) </title> <para> @@ -102,10 +99,15 @@ command. <para> Configure like this. <screen> +[1. Install &fml8;] + % su fml -% make configure +% sh configure % su root # make install + +[2. Emulate &fml4;] + # mv /usr/local/fml/fml.pl /usr/local/fml/fml.pl.orig # ln -s /usr/local/libexec/fml/fml.pl /usr/local/fml/fml.pl # ln -s /usr/local/libexec/fml/msend.pl /usr/local/fml/msend.pl @@ -116,7 +118,7 @@ Configure like this. <para> Precisely &fml8; can not read &fml4; configuration file. If &fml8;'s fml.pl cannot find config.cf, it tries to convert config.ph in ML's -home directory to config.cf, read it and starts to run. +home directory to &fml8; config.cf, read it and starts to run. </para> <para> @@ -129,7 +131,7 @@ configurations manipulated by &fml4; CUI or GUI. <sect1 id="mergeml.fml4to8.config.diff"> <title> - Overview: difference between &fml4; and &fml8; + Overview: Difference Between &fml4; and &fml8; </title> <para> @@ -138,7 +140,7 @@ There are several &fml8; variables and functions not related with </para> <para> -Also not one to one if the relation found. +Also not one to one even if the relation found. </para> <para> @@ -148,11 +150,11 @@ Let's see a few examples below. <sect2> <title> - Anyone can post + Anyone Can Post </title> <para> -Users registered as members can post ML. +Users registered as members can post ML by default. This default behaviour is common between &fml4; and &fml8;. To set "anyone can post", in the case of &fml4;, <screen> @@ -171,34 +173,35 @@ article_post_restrictions = reject_system_special_accounts <sect2> <title> - Subject tag + Subject Tag </title> <para> -no subject tag by default. +No subject tag defined by default. This is common between &fml4; and &fml8; To set the tag such as '[ML_NAME:00100]', in the case of &fml4;, <screen> $SUBJECT_TAG_TYPE = '[:]'; </screen> -This corresponds to the &fml8; configuration: +This corresponds to the following &fml8; configuration: <screen> article_header_rewrite_rules = rewrite_article_subject_tag article_subject_tag = [$ml_name:%05d] </screen> +&fml8; configuration concepts are more orthogonal. </para> </sect2> <sect2> <title> - Disable specific command in command mail + Disable Specific Command In Command Mail </title> <para> -Commands such as members are prohibited in &fml8; by default. -&fml4; needs the following configurations: +Commands such as "members" are prohibited in &fml8; by default. +&fml4; needs the following configurations to disable dangerous commands: <screen> &DENY_PROCEDURE('member'); &DENY_PROCEDURE('active'); @@ -215,8 +218,8 @@ Old &fml4; use no filter by default but &fml8; uses filter by default. <para> &fml8; applies confirmation for subscribe, chaddr, unsubscribe -commands by default. &fml4; not. Currently &fml8; always applies -confirmation, which is not disabled by configuration. +commands by default. &fml4; not. Currently &fml8; always applies +confirmation, which can not be disabled by configuration. </para> </sect2> @@ -226,7 +229,7 @@ confirmation, which is not disabled by configuration. <sect1 id="mergeml.fml4to8.boot"> <title> - Implementation: boot process + Discussion </title> <para> @@ -239,9 +242,9 @@ files below. </para> <para> -Firstly, we need MTA runs &fml4; and &fml4; runs &fml8; too. Our purpose is to run &fml8; anyway. If &fml8; runs, converter of config.ph runs too. +So, we need MTA runs &fml4; and &fml4; runs &fml8;. </para> <para> @@ -253,9 +256,9 @@ section. </para> <para> -For example, when you use postfix, postfix reads aliases and +For example, when you use Postfix, Postfix reads aliases and recognizes it needs to read include file. By reading include file, -postfix knows how to call &fml8; process. Finally, postfix runs +Postfix knows how to call &fml8; process. Finally, postfix runs /usr/local/libexec/fml/distribute command. </para> @@ -265,7 +268,7 @@ member lists and processes et.al. </para> <para> -That is, when &fml8; starts, +That is, when &fml8; process starts, the following two phases <screen> aliases (MTA configuration) @@ -283,7 +286,7 @@ alias_maps = hash:/etc/mail/aliases hash:/var/spool/ml/etc/aliases (fml4) hash:/var/spool/ml/etc/mail/aliases (fml8) </screen> -aliases of &fml4; and &fml8; has no duplication. +aliases of &fml4; and &fml8; should not have duplication. </para> <para> diff --git a/fml/doc/en/tutorial/setup/newml.recipes.sgml b/fml/doc/en/tutorial/setup/newml.recipes.sgml index cbb4b55f..7204c4ee 100644 --- a/fml/doc/en/tutorial/setup/newml.recipes.sgml +++ b/fml/doc/en/tutorial/setup/newml.recipes.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: newml.recipes.sgml,v 1.1 2005/07/23 01:57:36 fukachan Exp $ $jaFML: newml.recipes.sgml,v 1.3 2004/10/06 09:07:42 fukachan Exp $ --> @@ -17,7 +17,7 @@ <question> <para> -specify administrator's mail address in alias file +Specify administrator's mail address in alias file when "newml" command runs. </para> </question> @@ -33,7 +33,7 @@ where ADDRESS is defined by $newml_command_ml_admin_default_address. By default, $newml_command_ml_admin_default_address == $fml_owner defined in /usr/local/etc/fml/main.cf file. -Specify +To change the value, specify $newml_command_ml_admin_default_address in site_default_config.cf. <screen> @@ -62,9 +62,9 @@ Not create a configuration file for a specific MTA not used. <answer> <para> -$newml_command_mta_config_list defines -examples of MTA list "newml" command creates. -Remove the specific MTA from the list. +$newml_command_mta_config_list defines list of MTA. +"makefml newml" command creates examples of the specified MTA's. +Remove the specific MTA from the list to disable example creation. </para> <para> diff --git a/fml/doc/en/tutorial/setup/newml.sgml b/fml/doc/en/tutorial/setup/newml.sgml index 2d7d91f0..99e9eb25 100644 --- a/fml/doc/en/tutorial/setup/newml.sgml +++ b/fml/doc/en/tutorial/setup/newml.sgml @@ -1,24 +1,24 @@ <!-- - $FML: newml.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: newml.sgml,v 1.2 2005/07/23 01:57:37 fukachan Exp $ $jaFML: newml.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $ --> <chapter id="setup.newml"> <title> - Create ML on UNIX + Create ML On Unix </title> <sect1> <title> - run "makefml newml" to create an ML (in the case of default domain) + Run "makefml newml" To Create An ML (In The Case Of Default Domain) </title> <caution> <para> The usage of &fml8; makefml is same as &fml4; in the case of default -domain. But not in the virtual domain case. See +domain. But differs in the virtual domain case. See <link linkend="setup.newml.nondefault"> <xref linkend="setup.newml.nondefault"> </link> @@ -37,7 +37,7 @@ To create an ML, use "makefml" command (CUI) in the same way as &fml4;. <para> In the case of non default domain (virtual domain), -run "makefml newdomain" command before run "makefml newml". +run "makefml newdomain" command before running "makefml newml". <screen> % su root # makefml newdomain fml.org /var/spool/virtual/fml.org @@ -55,7 +55,7 @@ run "makefml newdomain" command before run "makefml newml". <listitem> <para> - create files such as + Create files such as <screen> config.cf include @@ -68,26 +68,26 @@ run "makefml newdomain" command before run "makefml newml". <listitem> <para> - add elena ML entry into /var/spool/ml/etc/mail/aliases. - run postalias to rebuild /var/spool/ml/etc/mail/aliases.db. + Add elena ML entry into /var/spool/ml/etc/mail/aliases. + Run postalias to rebuild /var/spool/ml/etc/mail/aliases.db. </para> </listitem> <listitem> <para> - create ~fml/.qmail-* files for qmail. + Create ~fml/.qmail-* files for qmail. </para> </listitem> <listitem> <para> - update procmailrc as a sample. + Update procmailrc as a sample. </para> </listitem> <listitem> <para> - prepare the directory + Prepare the directory <screen> ~fml/public_html/fml/mlarchive/$domain/$ml/ </screen> @@ -103,7 +103,7 @@ run "makefml newdomain" command before run "makefml newml". <listitem> <para> - prepare CGI (GUI). set up + Prepare CGI (GUI). Set up <screen> ~fml/public_html/cgi-bin/fml/$domain/admin/config.cgi </screen> @@ -123,7 +123,7 @@ run "makefml newdomain" command before run "makefml newml". <sect1 id="setup.newml.nondefault"> <title> - run "makefml newml" to create an ML (in the case of non default domain) + Run "makefml newml" To Create An ML (In The Case Of Virtual Domain) </title> <caution> @@ -181,7 +181,7 @@ for several MTA's such as /var/spool/ml/etc/postfix/virtual </screen> . -No example for qmail. +No example for qmail (not needed). No example for procmail since .procmailrc contains domain. </para> diff --git a/fml/doc/en/tutorial/setup/postfix.sgml b/fml/doc/en/tutorial/setup/postfix.sgml index 7b80d257..88de2969 100644 --- a/fml/doc/en/tutorial/setup/postfix.sgml +++ b/fml/doc/en/tutorial/setup/postfix.sgml @@ -1,18 +1,17 @@ <!-- - $FML$ + $FML: postfix.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ $jaFML: postfix.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $ --> <sect1 id="setup.postfix.aliases"> <title> - MTA configuration (postfix) + MTA Configuration (postfix) </title> <important> <para> -If $alias_maps of postfix is properly set up, -makefml automatically prepare fml and postfix configuration -for the new ML. +If $alias_maps of Postfix is properly set up, "makefml newml" +automatically prepares fml and postfix configuration for the new ML. </para> <para> @@ -26,16 +25,16 @@ for the detail of postfix configuration. <para> -makefml do not update system aliases (e.g. /etc/mail/aliases), but +"makefml" does not update system aliases (e.g. /etc/mail/aliases), but updates only alias file $ml_home_prefix/etc/mail/aliases file, which is used only for fml. -makefml rebuilds aliases.db automatically, too. +"makefml" rebuilds $ml_home_prefix/etc/mail/aliases.db automatically, too. </para> <sect2> <title> - NOTE: format of /var/spool/ml/etc/mail/aliases + NOTE: Format Of /var/spool/ml/etc/mail/aliases </title> <para> diff --git a/fml/doc/en/tutorial/setup/procmail.sgml b/fml/doc/en/tutorial/setup/procmail.sgml index 9e6af891..c95fbf30 100644 --- a/fml/doc/en/tutorial/setup/procmail.sgml +++ b/fml/doc/en/tutorial/setup/procmail.sgml @@ -1,39 +1,39 @@ <!-- - $FML: procmail.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: procmail.sgml,v 1.2 2005/07/23 01:57:37 fukachan Exp $ $jaFML: procmail.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $ --> <sect1 id="setup.procmail"> <title> - I want to use ML by my account. + I Want To Use ML By My Account. </title> <para> -When you set up a ML within your account, for example when you are +When you set up an ML within your account, for example when you are using virtual domain service of ISP, you need to use a mail processor such as procmail. </para> <para> To catch up messages to ML's, you need to filter messages according to -To: or Cc: in the mail header and redistribute it. +To: or Cc: in the mail header. </para> <para> &fml8; expects the user uses a filter tool such as procmail in such a -situation. &fml8; itself does not provide such a tool. +situation. &fml8; distribution itself does not provide such a tool. </para> <para> -makefml creates/updates ~/.procmailrc sample in running "makefml -newml" at /var/spool/ml/etc/procmail/procmailrc. Please use it as a +When running "makefml newml", "makefml" creates/updates ~/.procmailrc +sample at /var/spool/ml/etc/procmail/procmailrc. Please use it as a sample. </para> <sect2 id="setup.procmailrc"> <title> - ~/.procmailrc example + ~/.procmailrc Example </title> <para> @@ -63,12 +63,13 @@ inbox/. <sect2> <title> - virtual domain case + Virtual Domain Case </title> <para> The procmail rules above contains ml_name and ml_domain within it. So it does not need special handling for virtual domain. +It is same for both default domain and virtual domain. </para> <para> diff --git a/fml/doc/en/tutorial/setup/qmail.sgml b/fml/doc/en/tutorial/setup/qmail.sgml index 2655a699..74486520 100644 --- a/fml/doc/en/tutorial/setup/qmail.sgml +++ b/fml/doc/en/tutorial/setup/qmail.sgml @@ -1,18 +1,21 @@ <!-- - $FML: qmail.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: qmail.sgml,v 1.2 2005/07/23 01:57:37 fukachan Exp $ $jaFML: qmail.sgml,v 1.2 2002/07/06 14:55:20 fukachan Exp $ --> <sect1 id="setup.qmail.aliases"> <title> - MTA configuration (qmail) + MTA Configuration (qmail) </title> <para> "makefml newml" creates the following files for qmail: <screen> ~fml/.qmail-fml:org-elena +~fml/.qmail-fml:org-elena-admin ~fml/.qmail-fml:org-elena-ctl +~fml/.qmail-fml:org-elena-default +~fml/.qmail-fml:org-elena-request </screen> Hence, if /var/qmail/control/virtualdomains contains the following definition @@ -32,7 +35,7 @@ ML's uses the whole one domain only for mailing list. <sect2> <title> - virtual domain case + Virtual Domain </title> <para> diff --git a/fml/doc/en/tutorial/setup/test.sgml b/fml/doc/en/tutorial/setup/test.sgml index 8b37fe3c..83f24d64 100644 --- a/fml/doc/en/tutorial/setup/test.sgml +++ b/fml/doc/en/tutorial/setup/test.sgml @@ -1,22 +1,22 @@ <!-- - $FML: test.sgml,v 1.1 2003/07/25 17:05:47 fukachan Exp $ + $FML: test.sgml,v 1.2 2005/07/23 01:57:37 fukachan Exp $ $jaFML: test.sgml,v 1.4 2003/04/15 14:51:44 fukachan Exp $ --> <chapter id="test"> <title> - test + Test </title> <sect1> <title> - before test + Before Test </title> <warning> <para> -set up MTA properly before test of fml. +Set up MTA properly before test of fml. </para> </warning> @@ -31,7 +31,7 @@ the mail server. <sect1> <title> - test of MTA + Test Of MTA </title> <para> @@ -50,12 +50,13 @@ receives the mail. % echo test |Mail rudo@fml.org </screen> If it not works, check MTA configuration. +See /var/log/maillog et.al to track errors. </para> <para> Secondary, verify mail delivery over network. Send a mail to rudo@fml.org from other host (not ahodori.fml.org). -If rudo receives the mail, o.k. +If rudo receives the mail, MTA is o.k. </para> <para> @@ -67,7 +68,7 @@ If both work well, MTA configuration must be ok. <sect1> <title> - send a mail to ML + Send A Mail To ML </title> <para> @@ -82,22 +83,22 @@ Create elena ML (elena@fml.org) and subscribe rudo@fml.org to elena ML. <para> Send a test mail to elena@fml.org from on the host and from other host (not ahodori.fml.org). Verify the header of this test mail should be -"From: rudo@fml.org" since &fml8; checks the From:. +"From: rudo@fml.org" since &fml8; checks the From: header field. </para> <sect2> <title> - checkpoints + Checkpoints </title> <para> -If someting not work well, check the following points: +If something not work well, check the following points: <screen> check the mail server log (e.g. /var/log/maillog) check the fml log (e.g. /var/spool/m/elena/log) -fml can pass the message to MTA ? -MTA succeeds to deliver it? +fml can pass the message to MTA ? (e.g. /var/spool/m/elena/log) +MTA succeeds to deliver it? (e.g. /var/log/maillog) </screen> </para> @@ -108,11 +109,11 @@ MTA succeeds to deliver it? <sect1> <title> - test of fml8 itself. + Test Of &fml8; Itself. </title> <para> -not yet implemented. +*** not yet implemented ***. </para> </sect1> @@ -120,7 +121,7 @@ not yet implemented. <sect1> <title> - reset after test. + Reset After Test. </title> <para> @@ -130,11 +131,11 @@ It is easy to re-create this mailing list (e.g. test ML). % makefml rmml test % makefml newml test </screen> -The removed ML home is left as /var/spool/ml/@test.$DATE. +The removed ML home is left as /var/spool/ml/@test.$DATE.$SEQUENCE. Please remove it since this is a test to avoid the duplication in the future. <screen> -% rm -fr /var/spool/ml/@test.$DATE +% rm -fr /var/spool/ml/@test.$DATE.* </screen> </para> diff --git a/fml/doc/en/tutorial/terms.sgml b/fml/doc/en/tutorial/terms.sgml index a48e351c..cd2764f4 100644 --- a/fml/doc/en/tutorial/terms.sgml +++ b/fml/doc/en/tutorial/terms.sgml @@ -1,11 +1,11 @@ <!-- - $FML: terms.sgml,v 1.3 2003/07/27 15:31:52 fukachan Exp $ + $FML: terms.sgml,v 1.4 2005/07/23 01:58:47 fukachan Exp $ $jaFML: terms.sgml,v 1.5 2003/04/15 14:51:35 fukachan Exp $ --> <sect1 id="terms"> <title> - Technical terms in this tutorial + Technical Terms In This Tutorial </title> <para> @@ -61,7 +61,7 @@ also. <term> fml (command) </term> <listitem> <para> - fml command included in &fml8; software. + command named "fml" included in &fml8; software. fml is same as makefml command except for the argument order. </para> </listitem> diff --git a/fml/doc/en/tutorial/troubleshoot/chapter.sgml b/fml/doc/en/tutorial/troubleshoot/chapter.sgml index 53ac7c18..9a81d89d 100644 --- a/fml/doc/en/tutorial/troubleshoot/chapter.sgml +++ b/fml/doc/en/tutorial/troubleshoot/chapter.sgml @@ -1,12 +1,12 @@ <!-- - $FML: chapter.sgml,v 1.2 2003/08/03 01:47:18 fukachan Exp $ + $FML: chapter.sgml,v 1.3 2005/07/23 01:57:37 fukachan Exp $ $jaFML: chapter.sgml,v 1.3 2002/11/09 14:16:19 fukachan Exp $ --> <chapter id="troubleshoot"> <title> - Troubleshooting + Troubleshoot </title> diff --git a/fml/doc/en/tutorial/troubleshoot/filesystem.sgml b/fml/doc/en/tutorial/troubleshoot/filesystem.sgml index caca7ecc..536d75b3 100644 --- a/fml/doc/en/tutorial/troubleshoot/filesystem.sgml +++ b/fml/doc/en/tutorial/troubleshoot/filesystem.sgml @@ -1,17 +1,19 @@ <!-- - $FML: filesystem.sgml,v 1.5 2005/06/25 15:11:38 fukachan Exp $ + $FML: filesystem.sgml,v 1.1 2005/07/23 01:57:38 fukachan Exp $ --> <sect1 id="troubleshoot.filesystem"> <title> - When the file system error occurs ? + When The File System Error Ocuurs </title> <para> -Fundamentally, &fml8; exit abnormally to make MTA re-deliver it or -&fml8; re-delivers it by itself. &fml8; do not lost received messages -whereas log or summary file lacks something. +When the file system error occurs, &fml8; exit abnormally to make MTA +re-deliver the message again to &fml8; or &fml8; re-delivers it by +itself without saving the article on the file system. So &fml8; do not +lost received messages whereas both log or summary file lack +something. </para> <para> @@ -22,11 +24,11 @@ delivery process. <sect2> <title> - When passed from MTA to &fml8; + When Passed From MTA MTA To &fml8; </title> <para> -&fml8; read a message and writes it into the disk once. If succeeded, +&fml8; reads a message and writes it into the disk once. If succeeded, it processes more. If failed, &fml8; exits abnormally as exit(EX_TEMPFAIL) for MTA to re-deliver it. See <link linkend="message.queue.incoming"> @@ -36,7 +38,7 @@ for more details. </para> <para> -In this case, incoming queue may have a incomplete message. +In this case, incoming message queue may have a incomplete message. &fml8; tries to remove it in abnormal exit. Even if failed, the queue management system removes it later. </para> @@ -46,19 +48,20 @@ Even if failed, the queue management system removes it later. <sect2> <title> - If the article sequence number update failed + If Updating Of The Article Sequence Number Failed </title> <para> In normal case, &fml8; updates the article sequence number and -re-reads it and compare it again. +re-reads it and compares it again. If the check fails, &fml8; exit(EX_TEMPFAIL) for MTA to re-deliver it. </para> <caution> <para> -The article sequence number updated. After that, -&fml8; should not do exit(EX_TEMPFAIL). +The article sequence number updated. After that, &fml8; does not do +exit(EX_TEMPFAIL) to deliver the message on memory as could as +possible. </para> </caution> @@ -67,7 +70,7 @@ The article sequence number updated. After that, <sect2> <title> - When saving the article failed + When Saving Of Article Failed </title> <caution> @@ -77,7 +80,7 @@ In this stage, the article sequence has been updated. </caution> <para> -In this case, &fml8; do not create a new article file but the original +In this case, &fml8; does not create a new article file but the original message is already on the disk. The header of the article differs from the original one but the body content is same. So &fml8; tries to link(2) the original mail in the incoming queue to the article file to @@ -91,13 +94,13 @@ the article header later. It is not implemented. </para> <para> -&fml8; tries to deliver the message on the memory. +&fml8; tries to deliver the message on memory. </para> <para> If the delivery process exits abnormally, -the delivery process ends incompletely -since &fml8; can not use outgoing queue. +distribution of article ends incompletely +since &fml8; can not use outgoing queue due to file system error. </para> </sect2> diff --git a/fml/doc/en/tutorial/troubleshoot/recipe.listup.addresses.sgml b/fml/doc/en/tutorial/troubleshoot/recipe.listup.addresses.sgml index 3598f3e3..61b1db6c 100644 --- a/fml/doc/en/tutorial/troubleshoot/recipe.listup.addresses.sgml +++ b/fml/doc/en/tutorial/troubleshoot/recipe.listup.addresses.sgml @@ -1,12 +1,12 @@ <!-- - $FML: recipe.listup.addresses.sgml,v 1.1 2003/07/25 17:05:48 fukachan Exp $ + $FML: recipe.listup.addresses.sgml,v 1.2 2003/08/03 01:47:18 fukachan Exp $ $jaFML: recipe.listup.addresses.sgml,v 1.2 2003/04/15 14:51:45 fukachan Exp $ --> <qandaentry> <question> <para> -List up pre-defined addresses on the system. +List up pre-defined addresses on this host. </para> </question> @@ -23,10 +23,10 @@ aliases. <para> <warning> <para> -The difference between fmladdr and fmlalias is whether +The difference between "fmladdr" and "fmlalias" is whether it contains users defined at /etc/passwd or not. -fmladdr contains it but fmlalias not. -fmlalias lists up only users defined at aliases. +"fmladdr" contains it but fmlalias not. +"fmlalias" lists up only users defined at aliases. </para> </warning> </para> diff --git a/fml/doc/en/tutorial/troubleshoot/recipe.listup.aliases.sgml b/fml/doc/en/tutorial/troubleshoot/recipe.listup.aliases.sgml index 399a0389..ea810789 100644 --- a/fml/doc/en/tutorial/troubleshoot/recipe.listup.aliases.sgml +++ b/fml/doc/en/tutorial/troubleshoot/recipe.listup.aliases.sgml @@ -1,12 +1,12 @@ <!-- - $FML: recipe.listup.aliases.sgml,v 1.1 2003/07/25 17:05:48 fukachan Exp $ + $FML: recipe.listup.aliases.sgml,v 1.2 2003/08/03 01:47:18 fukachan Exp $ $jaFML: recipe.listup.aliases.sgml,v 1.1 2002/11/09 14:16:19 fukachan Exp $ --> <qandaentry> <question> <para> -List up defined aliases +List up defined aliases on this host </para> </question> @@ -22,10 +22,10 @@ Run "fmlalias". It shows all addresses defined in aliases files. <para> <warning> <para> -The difference between fmladdr and fmlalias is whether +The difference between "fmladdr" and "fmlalias" is whether it contains users defined at /etc/passwd or not. -fmladdr contains it but fmlalias not. -fmlalias lists up only users defined at aliases. +"fmladdr" contains it but fmlalias not. +"fmlalias" lists up only users defined at aliases. </para> </warning> </para> diff --git a/fml/doc/en/tutorial/troubleshoot/recipe.version.sgml b/fml/doc/en/tutorial/troubleshoot/recipe.version.sgml index 5e0151a2..92d867f2 100644 --- a/fml/doc/en/tutorial/troubleshoot/recipe.version.sgml +++ b/fml/doc/en/tutorial/troubleshoot/recipe.version.sgml @@ -1,5 +1,5 @@ <!-- - $FML: recipe.version.sgml,v 1.1 2003/07/25 17:05:48 fukachan Exp $ + $FML: recipe.version.sgml,v 1.2 2003/08/03 01:47:18 fukachan Exp $ $jaFML: recipe.version.sgml,v 1.4 2003/04/15 14:51:45 fukachan Exp $ --> @@ -12,10 +12,9 @@ I want to know fml version. <answer> <para> -run "fmlconf" to show all variables. -You can find $fml_version in it. <screen> -% fmlconf test |grep fml_version +[Example: in the case of "test" ML] +% fmlconf test fml_version fml_version = fml-devel current-20021029 </screen> </para> diff --git a/fml/doc/en/tutorial/usage/chaddr.sgml b/fml/doc/en/tutorial/usage/chaddr.sgml index b146c579..59fa29b1 100644 --- a/fml/doc/en/tutorial/usage/chaddr.sgml +++ b/fml/doc/en/tutorial/usage/chaddr.sgml @@ -1,11 +1,11 @@ <!-- - $FML: chaddr.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ + $FML: chaddr.sgml,v 1.2 2005/07/20 10:37:44 fukachan Exp $ $jaFML: chaddr.sgml,v 1.2 2003/04/15 14:51:45 fukachan Exp $ --> <sect1 id="usage.user.chaddr"> <title> - change registered address + Change Registered Address </title> <para> @@ -16,18 +16,19 @@ chaddr OLD-ADDRESS NEW-ADDRESS </screen> to elena-ctl@fml.org. <screen> -Example: +[Example] + chaddr rudo@nuinui.net rudo-new@nuinui.net </screen> -You can send this mail from both OLD-ADDRESS and NEW-ADDRESS. +You can send this mail from both OLD-ADDRESS and NEW-ADDRESS. &fml8; +treats this command as an exceptiona of From: based authentication. </para> <para> -&fml8; sends back confirmation to both addresses. -Please reply the confirmation and send back it to elena-ctl again. -When you request is confirmed to be valid, -&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to the recipient and -member list. +&fml8; sends back the confirmation to both addresses. Please reply +the confirmation and send back it to elena-ctl@fml.org from either +address again. When you reply is confirmed to be valid, &fml8; remove +OLD-ADDRESS and add NEW-ADDRESS to the recipient and member list. </para> </sect1> diff --git a/fml/doc/en/tutorial/usage/chapter.onhost.sgml b/fml/doc/en/tutorial/usage/chapter.onhost.sgml index e35b30f4..dc1a8d18 100644 --- a/fml/doc/en/tutorial/usage/chapter.onhost.sgml +++ b/fml/doc/en/tutorial/usage/chapter.onhost.sgml @@ -1,11 +1,11 @@ <!-- - $FML: chapter.onhost.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ + $FML: chapter.onhost.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: chapter.onhost.sgml,v 1.8 2003/04/15 14:51:46 fukachan Exp $ --> <chapter id="usage.onhost"> <title> - What can we do on the mailing list server host ? + What Can You Do On The Mailing List Server </title> @@ -16,8 +16,8 @@ greatest administrator :) </para> <para> -makefml of fml8 is same as fml4 as could as possible to preserve -compatibility. +"makefml" command of &fml8; is same as &fml4; as could as possible to +preserve compatibility. </para> <para> @@ -31,7 +31,7 @@ on the detail of the difference. <sect1 id="usage.onhost.priviledge"> <title> - On the host + On The Host </title> <para> @@ -52,11 +52,12 @@ But He/She may do wrong operations. To avoid careless wrong operations, in usual cases you should use CUI (makefml or fml) to configure fml. Of course you can edit files directly if you can understand fml structures. By default we recommend -you should use CUI even on the host. +you should use CUI always on the host. </para> <para> -fml command is same as makefml command except for the argument order. +"fml" command is same as "makefml" command except for the argument +order. <screen> makefml COMMAND ML OPTIONS fml ML COMMAND OPTIONS @@ -69,7 +70,7 @@ Please either as you like. <sect1 id="usage.commandpolicy"> <title> - Policy of command creation + Policy Of Command Creation </title> <para> @@ -82,7 +83,7 @@ such commands can be shared among CUI, GUI and commmnd mail. <sect2> <title> - operation may modify the specific ML (read/write). + Operation May Modify The Specific ML (Read + Write) </title> <para> @@ -95,7 +96,7 @@ modify the specific ML. <sect2> <title> - operation read only the data of the specific ML (read only). + Operation For Read Only Data Of The Specific ML (Read Only) </title> <para> @@ -108,7 +109,7 @@ the specific ML. <sect2> <title> - see the general data (read only) + Show The General Data (Read Only) </title> <para> @@ -129,20 +130,21 @@ fmlconf [-n] ML <sect2> <title> - ML specific but a command wrapper + ML Specific But A Command Wrapper </title> <para> PGP / GPG related command (e.g. fmlpgp) is very command speicific. -So, it is difficult to incorporate them into makefml/fml. -We implement it as another command such as fmlpgp, fmlgpg, ... +So, it looks difficult to incorporate them into "makefml" and "fml" +framework. So we implement it as another command such as fmlpgp, +fmlgpg, ... </para> </sect2> <sect2> <title> - misc + Misc </title> <para> @@ -151,7 +153,7 @@ This command name begins with fml prefix. </para> <para> -The conveter from text to html form. +For example, "fmlhtmlify" is a conveter from text to html form. This command is used to convert both fml spool and MH folders. <screen> fmlhtmlify [-I DIR] $src_dir $dst_dir diff --git a/fml/doc/en/tutorial/usage/chapter.user.sgml b/fml/doc/en/tutorial/usage/chapter.user.sgml index 8aaaa38b..14b082ca 100644 --- a/fml/doc/en/tutorial/usage/chapter.user.sgml +++ b/fml/doc/en/tutorial/usage/chapter.user.sgml @@ -1,11 +1,11 @@ <!-- - $FML$ + $FML: chapter.user.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ $jaFML: chapter.user.sgml,v 1.2 2002/07/28 12:20:19 fukachan Exp $ --> <chapter id="usage.user"> <title> - What the user can do ? + What A User Can </title> diff --git a/fml/doc/en/tutorial/usage/command.sgml b/fml/doc/en/tutorial/usage/command.sgml index 7d10919a..95b19450 100644 --- a/fml/doc/en/tutorial/usage/command.sgml +++ b/fml/doc/en/tutorial/usage/command.sgml @@ -1,21 +1,27 @@ <!-- - $FML$ + $FML: command.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ $jaFML: command.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $ --> <sect1 id="fml.command.bymail"> <title> - command mail (control fml by sendmail mails) + Command Mail (Control fml By Sending Mail) </title> <para> -fml accepts control commands which is sent as a mail. +&fml8; accepts control commands which is sent as a mail. It is called "command mail". </para> <important> <para> -The use of CUI (makefml/fml) is basic in fml world. +The use of CUI (makefml/fml) is basic in fml world. It is expected you +should use CUI if you can login the mailing list server. +</para> + +<para> +The role of command mail is to delegate fml control priviledge to +users who cannot login the mailing list server. </para> </important> @@ -23,11 +29,11 @@ The use of CUI (makefml/fml) is basic in fml world. <sect2 id="fml.command.bymail.flow"> <title> - flow + Flow </title> <para> -Consider elena ML. Send the command mail to elena-ctl@fml.org which +Consider elena ML. Send the command mail to elena-ctl@fml.org which is the address for command mail. MTA receives the mail and finally kicks off /usr/local/libexec/fml/command program. This program receives the mail (command mail) from STDIN , processes the requests @@ -50,7 +56,7 @@ MIME/Multipart <sect2> <title> - perl modules of command mails + Perl Modules For Command Mail </title> <para> @@ -58,6 +64,13 @@ All modules which CUI, GUI and command mail uses are implented as FML::Command:: class. </para> +<para> +In fact, a sub set of FML::Command:: class is allowed as command mail. +$user_command_mail_allowed_commands, +$anonymous_command_mail_allowed_commands and +$admin_command_mail_allowed_commands variables defines it. +</para> + </sect2> </sect1> diff --git a/fml/doc/en/tutorial/usage/fml.sgml b/fml/doc/en/tutorial/usage/fml.sgml index 04b8850c..77ddf45d 100644 --- a/fml/doc/en/tutorial/usage/fml.sgml +++ b/fml/doc/en/tutorial/usage/fml.sgml @@ -1,25 +1,22 @@ <!-- - $FML$ + $FML: fml.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fml.sgml,v 1.1 2003/01/05 08:03:23 fukachan Exp $ --> <sect1 id="usage.fml"> <title> - fml command and makefml command + "fml" And "makefml" Command </title> <para> -fml (/usr/local/bin/fml) and makefml (/usr/local/bin/makefml) is same -except for argument order. -Please use it as you like. +"fml" (/usr/local/bin/fml) and "makefml" (/usr/local/bin/makefml) is +same except for argument order. Please use it as you like. </para> <para> <screen> % fml ML COMMNAD [OPTIONS] -</screen> -instead -<screen> + % makefml COMMAND ML [OPTIONS] </screen> </para> diff --git a/fml/doc/en/tutorial/usage/fmladdr.sgml b/fml/doc/en/tutorial/usage/fmladdr.sgml index 1a7eecee..c00e7a53 100644 --- a/fml/doc/en/tutorial/usage/fmladdr.sgml +++ b/fml/doc/en/tutorial/usage/fmladdr.sgml @@ -1,17 +1,16 @@ <!-- - $FML$ + $FML: fmladdr.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fmladdr.sgml,v 1.1 2002/11/09 14:16:19 fukachan Exp $ --> <sect1 id="usage.fmladdr"> <title> - show all valid addresses (users and aliases) + Show Addresses (Users + Aliases) </title> <para> -fmladdr (/usr/local/bin/fmladdr) -lists up all users on this host. -It shows users defined in /etc/passwd and aliases defined in postfix. +"fmladdr" (/usr/local/bin/fmladdr) lists up all users on this host. +It shows users defined in /etc/passwd and aliases defined in Postfix. </para> <para> @@ -23,10 +22,10 @@ It shows users defined in /etc/passwd and aliases defined in postfix. <para> <warning> <para> -The difference between fmladdr and fmlalias is whether -it contais users defined at /etc/passwd or not. -fmladdr contains it but fmlalias not. -fmlalias lists up users defined at aliases. +The difference between "fmladdr" and "fmlalias" is whether +it contains users defined at /etc/passwd or not. +"fmladdr" contains it but "fmlalias" not. +"fmlalias" lists up all users defined at aliases. </para> </warning> </para> diff --git a/fml/doc/en/tutorial/usage/fmlalias.sgml b/fml/doc/en/tutorial/usage/fmlalias.sgml index 7687cac8..4d100689 100644 --- a/fml/doc/en/tutorial/usage/fmlalias.sgml +++ b/fml/doc/en/tutorial/usage/fmlalias.sgml @@ -1,17 +1,17 @@ <!-- - $FML$ + $FML: fmlalias.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fmlalias.sgml,v 1.1 2002/11/09 14:16:19 fukachan Exp $ --> <sect1 id="usage.fmlalias"> <title> - show alias configuration + Show Alias </title> <para> fmlalias (/usr/local/bin/fmlalias) shows all aliases. Precisely speaking, it shows -all aliases defined as valid aliases of postfix. +all aliases defined as valid aliases of Postfix. </para> <para> @@ -23,10 +23,10 @@ all aliases defined as valid aliases of postfix. <para> <warning> <para> -The difference between fmladdr and fmlalias is whether -it contais users defined at /etc/passwd or not. -fmladdr contains it but fmlalias not. -fmlalias lists up users defined at aliases. +The difference between "fmladdr" and "fmlalias" is whether +it contains users defined at /etc/passwd or not. +"fmladdr" contains it but "fmlalias" not. +"fmlalias" lists up all users defined at aliases. </para> </warning> </para> diff --git a/fml/doc/en/tutorial/usage/fmlconf.sgml b/fml/doc/en/tutorial/usage/fmlconf.sgml index 8ed2756b..0a8a5baf 100644 --- a/fml/doc/en/tutorial/usage/fmlconf.sgml +++ b/fml/doc/en/tutorial/usage/fmlconf.sgml @@ -1,17 +1,17 @@ <!-- - $FML$ + $FML: fmlconf.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fmlconf.sgml,v 1.4 2002/07/28 06:26:58 fukachan Exp $ --> <sect1 id="usage.fmlconf"> <title> - show configuration of one ML + Show Configuration </title> <para> -fmlconf (/usr/local/bin/fmlconf) takes ML name as an argument. +"fmlconf" (/usr/local/bin/fmlconf) takes ML name as an argument. It shows all variables of the specified ML. -If -n option specified, it shows variables different from default ones. +If "-n" option specified, it shows variables different from default ones. </para> <para> diff --git a/fml/doc/en/tutorial/usage/fmldoc.sgml b/fml/doc/en/tutorial/usage/fmldoc.sgml index 45629772..715f3cb7 100644 --- a/fml/doc/en/tutorial/usage/fmldoc.sgml +++ b/fml/doc/en/tutorial/usage/fmldoc.sgml @@ -1,11 +1,11 @@ <!-- - $FML$ + $FML: fmldoc.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fmldoc.sgml,v 1.3 2002/07/28 06:26:58 fukachan Exp $ --> <sect1 id="usage.fmldoc"> <title> - show document of perl module + Show Perl Module Document </title> <para> diff --git a/fml/doc/en/tutorial/usage/fmlhtmlify.sgml b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml index 91a36bac..3b2f55d7 100644 --- a/fml/doc/en/tutorial/usage/fmlhtmlify.sgml +++ b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml @@ -1,11 +1,11 @@ <!-- - $FML$ + $FML: fmlhtmlify.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: fmlhtmlify.sgml,v 1.6 2002/11/26 11:16:38 fukachan Exp $ --> <sect1 id="usage.fmlhtmlify"> <title> - convert article to HTML form. + Convert Articles To HTML Form </title> <para> @@ -16,9 +16,11 @@ to initialize the html archive. <para> <screen> +[Usage] + % fmlhtmlify SPOOL_DIRECTORY HTML_ARCHIVE_DIRECTORY -Example: +[Example] % fmlhtmlify /var/spool/ml/elena/spool /some/where/mlarchive/elena </screen> diff --git a/fml/doc/en/tutorial/usage/get.sgml b/fml/doc/en/tutorial/usage/get.sgml index 7bf7d875..e1b62f39 100644 --- a/fml/doc/en/tutorial/usage/get.sgml +++ b/fml/doc/en/tutorial/usage/get.sgml @@ -1,27 +1,26 @@ <!-- - $FML: get.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ + $FML: get.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: get.sgml,v 1.2 2003/04/15 14:51:46 fukachan Exp $ --> <sect1 id="usage.user.get"> <title> - read past articles + Get Past Articles </title> <para> -send the mail with +Send the mail with <screen> get NUMBER </screen> -to elena-ctl@fml.org address. -NUMBER is the article number. -fml sends back articles by mime/multipart form to the sender. +to elena-ctl@fml.org address where NUMBER is the article number. +&fml8; sends back articles by mime/multipart form to the sender. </para> <para> You can use MH style arguments as NUMBER. <screen> -Example: +[Example] get 100 get 1-100 diff --git a/fml/doc/en/tutorial/usage/guide.sgml b/fml/doc/en/tutorial/usage/guide.sgml index 3eb83e91..12728f95 100644 --- a/fml/doc/en/tutorial/usage/guide.sgml +++ b/fml/doc/en/tutorial/usage/guide.sgml @@ -1,25 +1,25 @@ <!-- - $FML: guide.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ + $FML: guide.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: guide.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> <sect1 id="usage.user.guide"> <title> - get ML guide + Get ML Guide </title> <para> -send the mail with +Send the mail with <screen> guide </screen> to elena-ctl@fml.org address. -fml sends back the guide file to the sender. +&fml8; sends back the guide message to the sender. </para> <para> If a file named "guide" is found at $ml_home_dir, it is used as a -template. +message template. </para> </sect1> diff --git a/fml/doc/en/tutorial/usage/help.sgml b/fml/doc/en/tutorial/usage/help.sgml index 01a2a8a1..05ef27b0 100644 --- a/fml/doc/en/tutorial/usage/help.sgml +++ b/fml/doc/en/tutorial/usage/help.sgml @@ -1,25 +1,25 @@ <!-- - $FML: help.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ + $FML: help.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: help.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> <sect1 id="usage.user.help"> <title> - if you know the usage of ML + Help: When You Want To know The Usage </title> <para> -send the mail with +Send the mail with <screen> help </screen> to elena-ctl@fml.org address. -sends back the help file to the sender. +It sends back the help message to the sender. </para> <para> If a file named "help" is found at $ml_home_dir, it is used as a -template. +message template. </para> </sect1> diff --git a/fml/doc/en/tutorial/usage/makefml.sgml b/fml/doc/en/tutorial/usage/makefml.sgml index 3ad3a588..f2951bec 100644 --- a/fml/doc/en/tutorial/usage/makefml.sgml +++ b/fml/doc/en/tutorial/usage/makefml.sgml @@ -1,12 +1,12 @@ <!-- - $FML: makefml.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ + $FML: makefml.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: makefml.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $ --> <sect1 id="usage.makefml.newml"> <title> - create ML + Create A New ML </title> <para> @@ -14,14 +14,17 @@ % su fml % makefml newml ML </screen> -If ML without @domain part, the domain of the ML is the default -domain. Both ML and ML@DOMAIN form is o.k. for the default domain. +If ML without @domain part is specified, the domain of the ML is +treated as the default domain. Both ML and ML@DOMAIN form is o.k. for +the default domain. <screen> +Example: In the case of default domain: + % makefml newml elena % makefml newml elena@fml.org </screen> -In the case of virtual domain, you should specify the full address -user@domain as ML string. +In the case of virtual domain, you should specify the address with the +domain such as user@domain form as ML string. </para> <para> @@ -37,25 +40,29 @@ for more details. <sect1 id="usage.makefml.rmml"> <title> - remove the ML + Remove An ML </title> <para> <screen> +Example: + % su fml % makefml rmml ML </screen> fml accepts ML string without @domain as the default domain. Both user and user@domain syntax is acceptable. <screen> +Example: in the case of default domain: + % makefml rmml elena % makefml rmml elena@fml.org </screen> -use user@domain syntax for virtual domains. +Please use user@domain syntax for virtual domains. </para> <para> -revert the action newml did. +It reverts the action newml did. It removes ML home directory, alias entries and ~fml/.qmail-*. </para> @@ -64,19 +71,23 @@ It removes ML home directory, alias entries and ~fml/.qmail-*. <sect1 id="usage.makefml.user.adddel"> <title> - subscribe/unsubscribe + Subscribe and Unsubscribe </title> <para> -Use useradd to subscribe the user, -userdel to unsubscribe the user. +Use "useradd" commadn to subscribe the user, +"userdel" to unsubscribe the user. <screen> +Example: + % su fml % makefml useradd ML ADDRESS % makefml userdel ML ADDRESS </screen> fml treats ML without @domain part as one of the default domain. <screen> +Examle: + % su fml % makefml useradd elena rudo@nuinui.net % makefml userdel elena rudo@nuinui.net @@ -86,14 +97,15 @@ fml treats ML without @domain part as one of the default domain. </para> <para> -For convenience, useradd is an acronym. +For convenience, useradd is an acronym. +The following commands, <screen> useradd adduser subscribe add </screen> -are same as useradd. +, are same as useradd. In the same way, <screen> userdel @@ -113,18 +125,22 @@ are same as userdel. <sect1 id="usage.makefml.user.chaddr"> <title> - change registered address + Change the registered address </title> <para> <screen> +Example: + % su fml % makefml chaddr ML OLD-ADDRESS NEW-ADDRESS </screen> fml treats ML without @domain part as one of the default domain. For example, <screen> +Example: in the case of a virtual domain + % su fml % makefml chaddr elena rudo@nuinui.net teddy@nuinui.net % makefml chaddr elena@fml.org rudo@nuinui.net teddy@nuinui.net @@ -137,7 +153,7 @@ For example, <sect1 id="usage.makefml.off"> <title> - stop delivery for a user + Stop Realtime Delivery </title> <para> @@ -146,12 +162,16 @@ For example, </screen> </para> +<para> +Delivery to ADDRESS is switched to digest. +</para> + </sect1> <sect1 id="usage.makefml.on"> <title> - start delivery for a user + Start Realtime Delivery </title> <para> @@ -160,12 +180,16 @@ For example, </screen> </para> +<para> +Delivery to ADDRESS is switched from digest to real time. +</para> + </sect1> <sect1 id="usage.makefml.log"> <title> - See log of elena ML + See Log </title> <para> @@ -180,7 +204,7 @@ For example, <sect1 id="usage.makefml.list"> <title> - see the member list of ML + See The Member List </title> <para> @@ -191,7 +215,7 @@ It shows recipients of this ML. Also, <screen> % makefml list elena recipient </screen> -lists up recipients of this ML. Instead +lists up only recipients of this ML. Instead <screen> % makefml list elena member </screen> @@ -212,7 +236,7 @@ you can use "xxx" as MAP to imply "primary_xxx_map" or "xxx_maps". <sect1 id="usage.makefml.config"> <title> - Modify configuration + Modify Configuration </title> <para> @@ -220,7 +244,7 @@ Edit config.cf directly now. </para> <para> -Tools are incompletely implemented. +Configuration helper tool is incompletely implemented. </para> </sect1> @@ -228,29 +252,35 @@ Tools are incompletely implemented. <sect1 id="usage.makefml.admin.adddel"> <title> - add/remove remote administrator. + Add or Remove A Remote Administrator. </title> <warning> <para> -A remote administor is person who cannot login to the mail server but -control an ML by sending command mail (admin command). +A remote administor is a person who cannot login to the mail server +but control an ML by sending a command mail (which is called "admin +command"). </para> <para> -CUI can control remote administrators since -the use of CUI needs login to this host. +Please use CUI to control remote administrators. If you use CUI, you +can have priviledge to do since the use of CUI needs login to this +host. </para> </warning> <para> <screen> +[Example] + % su fml % makefml addadmin ML ADDRESS % makefml deladmin ML ADDRESS </screen> fml treats ML without @domain part as one of the default domain. <screen> +[Example: in the case of a virtual domain] + % su fml % makefml addadmin elena rudo@nuinui.net % makefml deladmin elena rudo@nuinui.net @@ -265,7 +295,7 @@ For convenience, adminadd addpriv </screen> -are asme as addadmin. +are same as addadmin. <screen> byeadmin byepriv @@ -280,17 +310,21 @@ are same as deladmin. <sect1 id="usage.makefml.moderator.adddel"> <title> - add/remove a moderator + Add or Remove A Modrator </title> <para> <screen> +[Example] + % su fml % makefml addmoderator ML ADDRESS % makefml delmoderator ML ADDRESS </screen> fml treats ML without @domain part as one of the default domain. <screen> +[Example: in the case of a virtual domain] + % su fml % makefml addmoderator elena rudo@nuinui.net % makefml delmoderator elena rudo@nuinui.net diff --git a/fml/doc/en/tutorial/usage/post.sgml b/fml/doc/en/tutorial/usage/post.sgml index 7ea3f904..291e29a8 100644 --- a/fml/doc/en/tutorial/usage/post.sgml +++ b/fml/doc/en/tutorial/usage/post.sgml @@ -1,33 +1,36 @@ <!-- - $FML: post.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ + $FML: post.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: post.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $ --> <sect1 id="usage.post"> <title> - post article + Posting Article </title> <para> -Send the mail to elena@fml.org. -MTA (on e.g. ahodori.fml.org) receives the mail and -finally kicks off +Send a mail to elena@fml.org. +MTA running on the mailing list server host (on e.g. ahodori.fml.org) +receives the mail and finally kicks off /usr/local/libexec/fml/distribute command. </para> <para> -distribute recieves the message from STDIN, rewrites the header, save -it in the spool directory and pass it back to MTA for delivery. +"distribute" command recieves the message from STDIN, +rewrites the header, +save it in the spool directory and +pass it back to MTA for delivery. </para> <sect2> <title> - process of distribution + Distribution Process </title> <para> -add a tag to subject, update the article sequence number. +1) &fml8 adds a tag to the subject, +update the article sequence number. <screen> Example: @@ -37,15 +40,15 @@ Subject: [elena:00100] teddy bear is cute. </para> <para> -save article (as a text file). +2) save article (as a text file). </para> <para> -create a HTML version of the article under ~fml/public_html/ directory. +3) create a HTML version of the article under ~fml/public_html/ directory. </para> <para> -update database on thread. +4) update database (udb) on thread. </para> </sect2> @@ -53,12 +56,12 @@ update database on thread. <sect2> <title> - variables to control the article. + Variables </title> <warning> <para> -not yet written. +*** sorry, not yet written *** </para> </warning> @@ -67,18 +70,18 @@ not yet written. <sect2> <title> - Boot Sequence + Example: Boot Sequence Of Distribute Process </title> <para> <link linkend="bootloader"> fml boot loader </link> -boots off in this way. +boots off in the following way. </para> <para> -/usr/local/libexec/fml/distribute is symlink-ed to +/usr/local/libexec/fml/distribute command is symlink-ed to /usr/local/libexec/fml/loader. These files are same. </para> @@ -91,10 +94,11 @@ perl modules under it. </para> <para> -&fml8; sets up @INC properly, fml loader loads FML::Process::Switch -module and check $0 (process name). fml knows the process role from +&fml8; sets up @INC properly. fml loader loads FML::Process::Switch +module and check $0 (process name). fml knows the process role from $0. In this case of distribute, fml loads FML::Process::Distribute -module, switch itself to it and processes distribution. +module (defined as /usr/local/etc/fml/$fml_version/modules), +switch itself to it and processes distribution. </para> </sect2> diff --git a/fml/doc/en/tutorial/usage/subscribe.sgml b/fml/doc/en/tutorial/usage/subscribe.sgml index 4e2fd866..dc3f41b1 100644 --- a/fml/doc/en/tutorial/usage/subscribe.sgml +++ b/fml/doc/en/tutorial/usage/subscribe.sgml @@ -1,27 +1,27 @@ <!-- - $FML$ + $FML: subscribe.sgml,v 1.1 2003/07/26 04:29:14 fukachan Exp $ $jaFML: subscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> <sect1 id="usage.user.subscribe"> <title> - subscribe to ML + Subscribe </title> <para> Suppose elena@fml.org ML. -send the mail with +Firstly, send the mail with <screen> subscribe YOUR-NAME </screen> -to elena-ctl@fml.org ML. +to elena-ctl@fml.org address. </para> <para> -&fml8; sends back confirmation to both addresses. -Please send back the confirmation to elena-ctl again. -When you request is confirmed to be valid, -&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to member lists. +&fml8; sends back the confirmation to both addresses. +Please send back the reply for the confirmation to elena-ctl@fml.org again. +When your reply to the confirmation is confirmed to be valid, +&fml8; add the address as a new ML member. </para> </sect1> diff --git a/fml/doc/en/tutorial/usage/unsubscribe.sgml b/fml/doc/en/tutorial/usage/unsubscribe.sgml index 7ad289f1..d488edc6 100644 --- a/fml/doc/en/tutorial/usage/unsubscribe.sgml +++ b/fml/doc/en/tutorial/usage/unsubscribe.sgml @@ -1,11 +1,11 @@ <!-- - $FML: unsubscribe.sgml,v 1.1 2003/07/26 04:29:14 fukachan Exp $ + $FML: unsubscribe.sgml,v 1.2 2005/07/20 10:37:45 fukachan Exp $ $jaFML: unsubscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> <sect1 id="usage.user.unsubscribe"> <title> - unsubscribe ML + Unsubscribe </title> <para> @@ -14,14 +14,14 @@ send the mail with <screen> unsubscribe YOUR-NAME </screen> -to elena-ctl@fml.org . +to elena-ctl@fml.org (control address). </para> <para> -&fml8; sends back confirmation to both addresses. -Please send back the confirmation to elena-ctl again. -When you request is confirmed to be valid, -&fml8; remove OLD-ADDRESS and add NEW-ADDRESS to member lists. +&fml8; sends back the confirmation to the sender. +Please send back the reply for the confirmation to elena-ctl@fml.org again. +When your reply to the confirmation is confirmed to be valid, +&fml8; removes the address. </para> </sect1> diff --git a/fml/doc/en/tutorial/virtual/chapter.sgml b/fml/doc/en/tutorial/virtual/chapter.sgml index 9264a693..4e1fafe0 100644 --- a/fml/doc/en/tutorial/virtual/chapter.sgml +++ b/fml/doc/en/tutorial/virtual/chapter.sgml @@ -1,15 +1,16 @@ <!-- - $FML: chapter.sgml,v 1.2 2003/08/02 14:53:25 fukachan Exp $ + $FML: chapter.sgml,v 1.3 2005/07/20 10:37:45 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 </title> <para> -2003/10: We enhanced fml8 to handle virtual domains handling. +2003/10: We enhanced fml8 to handle virtual domains as same way as +default domain. </para> <para> @@ -24,15 +25,15 @@ makefml like this <screen> % makefml newml mlname@virtualdomain </screen> -but both syntaxes are acceptable for the default domain. +The following two 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 ml home directory information. You need to prepare -/usr/local/etc/fml/ml_home_prefix file for a hint on mappping between -domain and directory. +hints such as ml home directory information for each domain. You need +to prepare /usr/local/etc/fml/ml_home_prefix file for a hint on +mappping between domain and directory. </para> <para> @@ -49,13 +50,13 @@ To handle $ml_home_prefix_maps, you can use "makefml newdomain" and <sect1 id="virtualdomain.fml8.overview"> <title> - Overview: virtual domain handling in &fmldevel; + Overview: virtual domain handling in &fml8; </title> <para> It is easy in use. -For the first time, use "newdomain" command to add {domain => -directory} relation to +For the first time to use a virtual domain, +run "newdomain" command to add {domain => directory} relation to <link linkend="install.virtual"> ml_home_prefix_maps </link> @@ -70,8 +71,9 @@ makefml newml ML@virtualdomain makefml add ML@virtualdomain address makefml bye ML@virtualdomain address </screen> -Instead, for the default domain, either of user and user@domain is -accpetable. +Instead, for the default domain, +definitions in ml_home_prefix_maps is not needed +and either of user and user@domain is accpetable. </para> <para> @@ -86,7 +88,7 @@ http://lists/~fml/cgi-bin/fml/$domain/admin/config.cgi <para> 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 the URL. +That is, "config.cgi" does not resolve its domain by the URL. </para> </warning> @@ -99,7 +101,7 @@ the domain name in creating config.cgi when "makefml newml" runs. </title> <para> -NOT YET WRITTEN. +*** SORRY, NOT YET WRITTEN ***. </para> </sect1> |