From 0f8a45b45d759f9e192b8ea3e0865ef31e697b78 Mon Sep 17 00:00:00 2001 From: fukachan Date: Sat, 26 Jul 2003 04:29:12 +0000 Subject: translated --- fml/doc/en/tutorial/usage/chaddr.sgml | 32 +++ fml/doc/en/tutorial/usage/chapter.onhost.sgml | 145 +++++++++++++ fml/doc/en/tutorial/usage/chapter.user.sgml | 21 ++ fml/doc/en/tutorial/usage/command.sgml | 63 ++++++ fml/doc/en/tutorial/usage/fml.sgml | 27 +++ fml/doc/en/tutorial/usage/fmladdr.sgml | 34 +++ fml/doc/en/tutorial/usage/fmlalias.sgml | 34 +++ fml/doc/en/tutorial/usage/fmlconf.sgml | 28 +++ fml/doc/en/tutorial/usage/fmldoc.sgml | 23 +++ fml/doc/en/tutorial/usage/fmlhtmlify.sgml | 28 +++ fml/doc/en/tutorial/usage/get.sgml | 21 ++ fml/doc/en/tutorial/usage/guide.sgml | 20 ++ fml/doc/en/tutorial/usage/help.sgml | 20 ++ fml/doc/en/tutorial/usage/makefml.sgml | 286 ++++++++++++++++++++++++++ fml/doc/en/tutorial/usage/post.sgml | 100 +++++++++ fml/doc/en/tutorial/usage/subscribe.sgml | 27 +++ fml/doc/en/tutorial/usage/unsubscribe.sgml | 27 +++ 17 files changed, 936 insertions(+) create mode 100644 fml/doc/en/tutorial/usage/chaddr.sgml create mode 100644 fml/doc/en/tutorial/usage/chapter.onhost.sgml create mode 100644 fml/doc/en/tutorial/usage/chapter.user.sgml create mode 100644 fml/doc/en/tutorial/usage/command.sgml create mode 100644 fml/doc/en/tutorial/usage/fml.sgml create mode 100644 fml/doc/en/tutorial/usage/fmladdr.sgml create mode 100644 fml/doc/en/tutorial/usage/fmlalias.sgml create mode 100644 fml/doc/en/tutorial/usage/fmlconf.sgml create mode 100644 fml/doc/en/tutorial/usage/fmldoc.sgml create mode 100644 fml/doc/en/tutorial/usage/fmlhtmlify.sgml create mode 100644 fml/doc/en/tutorial/usage/get.sgml create mode 100644 fml/doc/en/tutorial/usage/guide.sgml create mode 100644 fml/doc/en/tutorial/usage/help.sgml create mode 100644 fml/doc/en/tutorial/usage/makefml.sgml create mode 100644 fml/doc/en/tutorial/usage/post.sgml create mode 100644 fml/doc/en/tutorial/usage/subscribe.sgml create mode 100644 fml/doc/en/tutorial/usage/unsubscribe.sgml (limited to 'fml/doc/en/tutorial/usage') diff --git a/fml/doc/en/tutorial/usage/chaddr.sgml b/fml/doc/en/tutorial/usage/chaddr.sgml new file mode 100644 index 00000000..c3bbdc27 --- /dev/null +++ b/fml/doc/en/tutorial/usage/chaddr.sgml @@ -0,0 +1,32 @@ + + + + + change registered address + + + +In the case of elena@fml.org ML, +send the mail with + +chaddr OLD-ADDRESS NEW-ADDRESS + +to elena-ctl@fml.org. + +Example: +chaddr rudo@nuinui.net rudo-new@nuinui.net + +You can send this mail from both OLD-ADDRESS and NEW-ADDRESS. + + + +&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. + + + diff --git a/fml/doc/en/tutorial/usage/chapter.onhost.sgml b/fml/doc/en/tutorial/usage/chapter.onhost.sgml new file mode 100644 index 00000000..83c33898 --- /dev/null +++ b/fml/doc/en/tutorial/usage/chapter.onhost.sgml @@ -0,0 +1,145 @@ + + + + + What can we do on the mailing list server host ? + + + + +On the host which serves ML driver, +you can use CUI and edit all configuration files as you like. +It implies you are the greatest administrator :) + + + + + + On the host + + + +You need no confirmation in using makefml. + + + +Person who can login the host of mailing list server has all +priviledge for all ML's on the host. +So, He/She can edit all configuration files. +But He/She may do wrong operations. + + + +To avoid careless miss 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. + + + +fml command is same as makefml command except for the argument order. + +makefml COMMAND ML OPTIONS +fml ML COMMAND OPTIONS + +Please either as you like. + + + + + + + + Policy of command creation + + + +&fmldevel; provides command for each function. Except for some +special cases, we should unify all functions into makefml/fml command +since such commands can be shared among CUI, GUI and commmnd mail. + + + + + + operation may modify the specific ML (read/write). + + + +We should implement sub-command of makefml when some operation may +modify the specific ML. + + + + + + + + operation read only the data of the specific ML (read only). + + + +you should implement it as a makefml command since it is related to +the specific ML. + + + + + + + + see the general data (read only) + + + +If the data is not related to the specific ML, for example, +see the module manual, aliases on the host, +we implement specific commands other than makefml/fml. +This command begins with ^fml. + +fmladdr [-n] +fmlalias [-n] +fmldoc MODULE +fmlconf [-n] ML + + + + + + + + + misc + + + +we implement specific commands other than makefml/fml. +This command begins with ^fml. + + + +The conveter from text to html form. +This command is used to convert both fml spool and MH folders. + +fmlhtmlify [-I DIR] $src_dir $dst_dir + + + + + + + + + +§.usage.makefml; +§.usage.fml; +§.usage.fmladdr; +§.usage.fmlalias; +§.usage.fmlconf; +§.usage.fmldoc; +§.usage.fmlhtmlify; + + diff --git a/fml/doc/en/tutorial/usage/chapter.user.sgml b/fml/doc/en/tutorial/usage/chapter.user.sgml new file mode 100644 index 00000000..8aaaa38b --- /dev/null +++ b/fml/doc/en/tutorial/usage/chapter.user.sgml @@ -0,0 +1,21 @@ + + + + + What the user can do ? + + + +§.usage.guide; +§.usage.subscribe; +§.usage.post; +§.usage.help; +§.usage.get; +§.usage.unsubscribe; + +§.usage.command; + + diff --git a/fml/doc/en/tutorial/usage/command.sgml b/fml/doc/en/tutorial/usage/command.sgml new file mode 100644 index 00000000..7d10919a --- /dev/null +++ b/fml/doc/en/tutorial/usage/command.sgml @@ -0,0 +1,63 @@ + + + + + command mail (control fml by sendmail mails) + + + +fml accepts control commands which is sent as a mail. +It is called "command mail". + + + + +The use of CUI (makefml/fml) is basic in fml world. + + + + + + + + flow + + + +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 +and sends back the result to the sender. +The mail to send back is passed to MTA for delivery via SMTP. + + + + +The result is aggreagated to one msssage as + +MIME/Multipart + +. This is different from &fml4; behaviour. + + + + + + + + + perl modules of command mails + + + +All modules which CUI, GUI and command mail uses are implented as +FML::Command:: class. + + + + + diff --git a/fml/doc/en/tutorial/usage/fml.sgml b/fml/doc/en/tutorial/usage/fml.sgml new file mode 100644 index 00000000..04b8850c --- /dev/null +++ b/fml/doc/en/tutorial/usage/fml.sgml @@ -0,0 +1,27 @@ + + + + + fml command and makefml command + + + +fml (/usr/local/bin/fml) and makefml (/usr/local/bin/makefml) is same +except for argument order. +Please use it as you like. + + + + +% fml ML COMMNAD [OPTIONS] + +instead + +% makefml COMMAND ML [OPTIONS] + + + + diff --git a/fml/doc/en/tutorial/usage/fmladdr.sgml b/fml/doc/en/tutorial/usage/fmladdr.sgml new file mode 100644 index 00000000..1a7eecee --- /dev/null +++ b/fml/doc/en/tutorial/usage/fmladdr.sgml @@ -0,0 +1,34 @@ + + + + + show all valid addresses (users and aliases) + + + +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 + + + + + + +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. + + + + + diff --git a/fml/doc/en/tutorial/usage/fmlalias.sgml b/fml/doc/en/tutorial/usage/fmlalias.sgml new file mode 100644 index 00000000..7687cac8 --- /dev/null +++ b/fml/doc/en/tutorial/usage/fmlalias.sgml @@ -0,0 +1,34 @@ + + + + + show alias configuration + + + +fmlalias (/usr/local/bin/fmlalias) shows all aliases. +Precisely speaking, it shows +all aliases defined as valid aliases of postfix. + + + + +% fmlalias + + + + + + +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. + + + + + diff --git a/fml/doc/en/tutorial/usage/fmlconf.sgml b/fml/doc/en/tutorial/usage/fmlconf.sgml new file mode 100644 index 00000000..8ed2756b --- /dev/null +++ b/fml/doc/en/tutorial/usage/fmlconf.sgml @@ -0,0 +1,28 @@ + + + + + show configuration of one ML + + + +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. + + + +To list up all variable list, + +% fmlconf elena + +To list up variables different from the default one, + +% fmlconf -n elena + + + + diff --git a/fml/doc/en/tutorial/usage/fmldoc.sgml b/fml/doc/en/tutorial/usage/fmldoc.sgml new file mode 100644 index 00000000..45629772 --- /dev/null +++ b/fml/doc/en/tutorial/usage/fmldoc.sgml @@ -0,0 +1,23 @@ + + + + + show document of perl module + + + +The usage of fmldoc is same as perldoc. +This is a wrapper for perldoc. + + + +To see FML::Process::Kernel perl module document, + +% fmldoc FML::Process::Kernel + + + + diff --git a/fml/doc/en/tutorial/usage/fmlhtmlify.sgml b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml new file mode 100644 index 00000000..91a36bac --- /dev/null +++ b/fml/doc/en/tutorial/usage/fmlhtmlify.sgml @@ -0,0 +1,28 @@ + + + + + convert article to HTML form. + + + +By default, fml converts the article to HTML form. +"fmlhtmlify" command is a tool to convert all articles +to initialize the html archive. + + + + +% fmlhtmlify SPOOL_DIRECTORY HTML_ARCHIVE_DIRECTORY + +Example: + +% fmlhtmlify /var/spool/ml/elena/spool /some/where/mlarchive/elena + + + + + diff --git a/fml/doc/en/tutorial/usage/get.sgml b/fml/doc/en/tutorial/usage/get.sgml new file mode 100644 index 00000000..a433da4e --- /dev/null +++ b/fml/doc/en/tutorial/usage/get.sgml @@ -0,0 +1,21 @@ + + + + + read past articles + + + +send the mail with + +get NUMBER + +to elena-ctl@fml.org address. +NUMBER is the article number. +fml sends back articles by mime/multipart form to the sender. + + + diff --git a/fml/doc/en/tutorial/usage/guide.sgml b/fml/doc/en/tutorial/usage/guide.sgml new file mode 100644 index 00000000..0582b19e --- /dev/null +++ b/fml/doc/en/tutorial/usage/guide.sgml @@ -0,0 +1,20 @@ + + + + + get ML guide + + + +send the mail with + +guide + +to elena-ctl@fml.org address. +fml sends back the guide file to the sender. + + + diff --git a/fml/doc/en/tutorial/usage/help.sgml b/fml/doc/en/tutorial/usage/help.sgml new file mode 100644 index 00000000..5d76669e --- /dev/null +++ b/fml/doc/en/tutorial/usage/help.sgml @@ -0,0 +1,20 @@ + + + + + if you know the usage of ML + + + +send the mail with + +help + +to elena-ctl@fml.org address. +sends back the help file to the sender. + + + diff --git a/fml/doc/en/tutorial/usage/makefml.sgml b/fml/doc/en/tutorial/usage/makefml.sgml new file mode 100644 index 00000000..322d3b0b --- /dev/null +++ b/fml/doc/en/tutorial/usage/makefml.sgml @@ -0,0 +1,286 @@ + + + + + + create ML + + + + +% su fml +% makefml newml ML + +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. + +% makefml newml elena +% makefml newml elena@fml.org + +In the case of virtual domain, you should specify the full address +user@domain as ML string. + + + +See the section + + + +for more details. + + + + + + + + remove the ML + + + + +% su fml +% makefml rmml ML + +fml accepts ML string without @domain as the default domain. +Both user and user@domain syntax is acceptable. + +% makefml rmml elena +% makefml rmml elena@fml.org + +use user@domain syntax for virtual domains. + + + +revert the action newml did. +It removes ML home directory, alias entries and ~fml/.qmail-*. + + + + + + + + subscribe/unsubscribe + + + +Use useradd to subscribe the user, +userdel to unsubscribe the user. + +% su fml +% makefml useradd ML ADDRESS +% makefml userdel ML ADDRESS + +fml treats ML without @domain part as one of the default domain. + +% su fml +% makefml useradd elena rudo@nuinui.net +% makefml userdel elena rudo@nuinui.net +% makefml useradd elena@fml.org rudo@nuinui.net +% makefml userdel elena@fml.org rudo@nuinui.net + + + + +For convenience, useradd is an acronym. + +useradd +adduser +subscribe +add + +are same as useradd. +In the same way, + +userdel +deluser +bye +remove +resign +signoff +unsubscribe + +are same as userdel. + + + + + + + + + change registered address + + + + + +% su fml +% makefml chaddr ML OLD-ADDRESS NEW-ADDRESS + +fml treats ML without @domain part as one of the default domain. +For example, + +% su fml +% makefml chaddr elena rudo@nuinui.net teddy@nuinui.net +% makefml chaddr elena@fml.org rudo@nuinui.net teddy@nuinui.net + + + + + + + + + + stop delivery for a user + + + + +% makefml off elena ADDRESS + + + + + + + + + start delivery for a user + + + + +% makefml on elena ADDRESS + + + + + + + + + See log of elena ML + + + + +% makefml log elena +% makefml log elena@fml.org + + + + + + + + + see the member list of ML + + + + +% makefml list elena + +It shows addresses who can post this ML. Instead + +% makefml list elena recipient + +lists up recipients of this ML. + + + + + + + + Modify configuration + + + +Edit config.cf directly now. +Tools are not yet implemented. + + + + + + + + add/remove remote administrator. + + + + +A remote administor is person who cannot login to the mail server but +control an ML by sending command mail (admin command). + + + +CUI can control remote administrators since +the use of CUI needs login to this host. + + + + + +% su fml +% makefml addadmin ML ADDRESS +% makefml deladmin ML ADDRESS + +fml treats ML without @domain part as one of the default domain. + +% su fml +% makefml addadmin elena rudo@nuinui.net +% makefml deladmin elena rudo@nuinui.net +% makefml addadmin elena@fml.org rudo@nuinui.net +% makefml deladmin elena@fml.org rudo@nuinui.net + + + + +For convenience, + +adminadd +addpriv + +are asme as addadmin. + +byeadmin +byepriv + +are same as deladmin. + + + + + + + + + + add/remove a moderator + + + + +% su fml +% makefml addmoderator ML ADDRESS +% makefml delmoderator ML ADDRESS + +fml treats ML without @domain part as one of the default domain. + +% su fml +% makefml addmoderator elena rudo@nuinui.net +% makefml delmoderator elena rudo@nuinui.net +% makefml addmoderator elena@fml.org rudo@nuinui.net +% makefml delmoderator elena@fml.org rudo@nuinui.net + + + + diff --git a/fml/doc/en/tutorial/usage/post.sgml b/fml/doc/en/tutorial/usage/post.sgml new file mode 100644 index 00000000..70d544f7 --- /dev/null +++ b/fml/doc/en/tutorial/usage/post.sgml @@ -0,0 +1,100 @@ + + + + + post article + + + +Send the mail to elena@fml.org. +MTA (on e.g. ahodori.fml.org) receives the mail and +finally kicks off +/usr/local/libexec/fml/distribute command. + + + +distribute recieves the message from STDIN, +rewrites the header, save it in spool and +pass it back to MTA. + + + + + + process of distribution + + + +add a tag to sufbject, update the article number. + +Example: + +Subject: [elena:00100] teddy bear is cute. + +(no tag by default). + + + +save article (as a text file). + + + +create a HTML version of the article under ~fml/public_html/ directory. + + + +update database on thread. + + + + + + + + variables to control the article. + + + + +not yet written. + + + + + + + + + boot sequence + + + + +fml boot loader + +boots off in this way. + + + + +libexec/loader reads etc/fml/main.cf firstly. +Suppose $fml_vesrion is defined as current-20010501 in main.cf. +&fml8; resolves $fml_version from it and determines the library path +as /usr/local/lib/fml/current-20010501/. +&fml8; loads perl modules under it. + + + +&fml8; sets up @INC properly, fml loader loads FML::Process::Switch +module and check $0. fml knowns the role from $0. In this case of +distribute, fml loads FML::Process::Distribute module and processes +distribution. + + + + + + diff --git a/fml/doc/en/tutorial/usage/subscribe.sgml b/fml/doc/en/tutorial/usage/subscribe.sgml new file mode 100644 index 00000000..4e2fd866 --- /dev/null +++ b/fml/doc/en/tutorial/usage/subscribe.sgml @@ -0,0 +1,27 @@ + + + + + subscribe to ML + + + +Suppose elena@fml.org ML. +send the mail with + +subscribe YOUR-NAME + +to elena-ctl@fml.org ML. + + + +&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. + + + diff --git a/fml/doc/en/tutorial/usage/unsubscribe.sgml b/fml/doc/en/tutorial/usage/unsubscribe.sgml new file mode 100644 index 00000000..001e5152 --- /dev/null +++ b/fml/doc/en/tutorial/usage/unsubscribe.sgml @@ -0,0 +1,27 @@ +!-- + $FML$ + $jaFML: unsubscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ +--> + + + + unsubscribe ML + + + +In the case of elena@fml.org ML, +send the mail with + +unsubscribe YOUR-NAME + +to elena-ctl@fml.org . + + + +&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. + + + -- cgit v1.2.1