diff options
| author | fukachan <fukachan> | 2005-07-20 10:37:40 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2005-07-20 10:37:40 +0000 |
| commit | 4829badef574589c3e6fd9588a6ffc482322fa1a (patch) | |
| tree | dd2ae298b39405f1a4c5a5f69775b83d3d3c97c1 /fml/doc/en/tutorial/usage | |
| parent | 8295ed65d40f99906e12bfb945cf51be18d09ce8 (diff) | |
| download | fml8-4829badef574589c3e6fd9588a6ffc482322fa1a.tar.gz fml8-4829badef574589c3e6fd9588a6ffc482322fa1a.tar.bz2 fml8-4829badef574589c3e6fd9588a6ffc482322fa1a.zip | |
translated.
Diffstat (limited to 'fml/doc/en/tutorial/usage')
| -rw-r--r-- | fml/doc/en/tutorial/usage/chaddr.sgml | 7 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/chapter.onhost.sgml | 89 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/get.sgml | 15 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/guide.sgml | 7 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/help.sgml | 7 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/makefml.sgml | 24 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/post.sgml | 31 | ||||
| -rw-r--r-- | fml/doc/en/tutorial/usage/unsubscribe.sgml | 4 |
8 files changed, 141 insertions, 43 deletions
diff --git a/fml/doc/en/tutorial/usage/chaddr.sgml b/fml/doc/en/tutorial/usage/chaddr.sgml index c3bbdc27..b146c579 100644 --- a/fml/doc/en/tutorial/usage/chaddr.sgml +++ b/fml/doc/en/tutorial/usage/chaddr.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: chaddr.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ $jaFML: chaddr.sgml,v 1.2 2003/04/15 14:51:45 fukachan Exp $ --> @@ -24,9 +24,10 @@ You can send this mail from both OLD-ADDRESS and NEW-ADDRESS. <para> &fml8; sends back confirmation to both addresses. -Please send back the confirmation to elena-ctl again. +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 member lists. +&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 83c33898..e35b30f4 100644 --- a/fml/doc/en/tutorial/usage/chapter.onhost.sgml +++ b/fml/doc/en/tutorial/usage/chapter.onhost.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: chapter.onhost.sgml,v 1.1 2003/07/26 04:29:12 fukachan Exp $ $jaFML: chapter.onhost.sgml,v 1.8 2003/04/15 14:51:46 fukachan Exp $ --> @@ -10,13 +10,26 @@ <para> -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 which serves ML driver, you can use CUI (makefml and fml) +and edit all configuration files as you like. It implies you are the +greatest administrator :) +</para> + +<para> +makefml of fml8 is same as fml4 as could as possible to preserve +compatibility. +</para> + +<para> +See +<link linkend="changes.cui"> +<xref linkend="changes.cui"> +</link> +on the detail of the difference. </para> -<sect1> +<sect1 id="usage.onhost.priviledge"> <title> On the host </title> @@ -26,14 +39,17 @@ You need no confirmation in using makefml. </para> <para> -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. +Person who can login the host of mailing list server has priviledge +for all ML's on the host. So, He/She can edit all configuration +files. +</para> + +<para> But He/She may do wrong operations. </para> <para> -To avoid careless miss operations, in usual cases you should use CUI +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. @@ -57,9 +73,10 @@ Please either as you like. </title> <para> -&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. +&fmldevel; provides a different command for each function. Its policy +makes the number of commands infinite. So, 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. </para> @@ -69,7 +86,7 @@ since such commands can be shared among CUI, GUI and commmnd mail. </title> <para> -We should implement sub-command of makefml when some operation may +We should implement sub-command of makefml/fml when some operation may modify the specific ML. </para> @@ -82,7 +99,7 @@ modify the specific ML. </title> <para> -you should implement it as a makefml command since it is related to +We should implement it as a makefml/fml command since it is related to the specific ML. </para> @@ -98,7 +115,7 @@ the specific ML. 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. +This command name begins with "fml" prefix. <screen> fmladdr [-n] fmlalias [-n] @@ -112,12 +129,25 @@ fmlconf [-n] ML <sect2> <title> + 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, ... +</para> + +</sect2> + +<sect2> + <title> misc </title> <para> -we implement specific commands other than makefml/fml. -This command begins with ^fml. +We implement specific commands other than makefml/fml. +This command name begins with fml prefix. </para> <para> @@ -134,6 +164,31 @@ fmlhtmlify [-I DIR] $src_dir $dst_dir </sect1> +<sect1 id="usage.command.line.options"> + <title> + Common Command Line Options + </title> + +<para> +Programs under libexec/ and bin/ supports +the following common command line options. +<screen> +--debug +--help +-c file +-o key=value +</screen> +Use -c to specify non default main.cf path. +-o overwrites configuration variables. +Plural -o are acceptable. +<screen> +-o key1=value1 -o key2=value2 +</screen> +</para> + +</sect1> + + §.usage.makefml; §.usage.fml; §.usage.fmladdr; diff --git a/fml/doc/en/tutorial/usage/get.sgml b/fml/doc/en/tutorial/usage/get.sgml index a433da4e..7bf7d875 100644 --- a/fml/doc/en/tutorial/usage/get.sgml +++ b/fml/doc/en/tutorial/usage/get.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: get.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: get.sgml,v 1.2 2003/04/15 14:51:46 fukachan Exp $ --> @@ -18,4 +18,17 @@ NUMBER is the article number. fml sends back articles by mime/multipart form to the sender. </para> +<para> +You can use MH style arguments as NUMBER. +<screen> +Example: + +get 100 +get 1-100 +get first:3 +get last:3 +get 1-100,first:3,last:3 +</screen> +</para> + </sect1> diff --git a/fml/doc/en/tutorial/usage/guide.sgml b/fml/doc/en/tutorial/usage/guide.sgml index 0582b19e..3eb83e91 100644 --- a/fml/doc/en/tutorial/usage/guide.sgml +++ b/fml/doc/en/tutorial/usage/guide.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: guide.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: guide.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> @@ -17,4 +17,9 @@ to elena-ctl@fml.org address. fml sends back the guide file to the sender. </para> +<para> +If a file named "guide" is found at $ml_home_dir, it is used as a +template. +</para> + </sect1> diff --git a/fml/doc/en/tutorial/usage/help.sgml b/fml/doc/en/tutorial/usage/help.sgml index 5d76669e..01a2a8a1 100644 --- a/fml/doc/en/tutorial/usage/help.sgml +++ b/fml/doc/en/tutorial/usage/help.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: help.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: help.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> @@ -17,4 +17,9 @@ to elena-ctl@fml.org address. sends back the help file to the sender. </para> +<para> +If a file named "help" is found at $ml_home_dir, it is used as a +template. +</para> + </sect1> diff --git a/fml/doc/en/tutorial/usage/makefml.sgml b/fml/doc/en/tutorial/usage/makefml.sgml index 322d3b0b..3ad3a588 100644 --- a/fml/doc/en/tutorial/usage/makefml.sgml +++ b/fml/doc/en/tutorial/usage/makefml.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: makefml.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: makefml.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $ --> @@ -187,11 +187,24 @@ For example, <screen> % makefml list elena </screen> -It shows addresses who can post this ML. Instead +It shows recipients of this ML. Also, <screen> % makefml list elena recipient </screen> -lists up recipients of this ML. +lists up recipients of this ML. Instead +<screen> +% makefml list elena member +</screen> +shows the list who can post this ML. +</para> + +<para> +You can specify arbitrary MAP as an argument to show it. +<screen> +% makefml list elena MAP +</screen> +MAP can be an abbrebiation. For example, +you can use "xxx" as MAP to imply "primary_xxx_map" or "xxx_maps". </para> </sect1> @@ -204,7 +217,10 @@ lists up recipients of this ML. <para> Edit config.cf directly now. -Tools are not yet implemented. +</para> + +<para> +Tools are incompletely implemented. </para> </sect1> diff --git a/fml/doc/en/tutorial/usage/post.sgml b/fml/doc/en/tutorial/usage/post.sgml index 70d544f7..7ea3f904 100644 --- a/fml/doc/en/tutorial/usage/post.sgml +++ b/fml/doc/en/tutorial/usage/post.sgml @@ -1,5 +1,5 @@ <!-- - $FML$ + $FML: post.sgml,v 1.1 2003/07/26 04:29:13 fukachan Exp $ $jaFML: post.sgml,v 1.7 2003/04/15 14:51:46 fukachan Exp $ --> @@ -16,9 +16,8 @@ finally kicks off </para> <para> -distribute recieves the message from STDIN, -rewrites the header, save it in spool and -pass it back to MTA. +distribute recieves the message from STDIN, rewrites the header, save +it in the spool directory and pass it back to MTA for delivery. </para> @@ -28,7 +27,7 @@ pass it back to MTA. </title> <para> -add a tag to sufbject, update the article number. +add a tag to subject, update the article sequence number. <screen> Example: @@ -68,7 +67,7 @@ not yet written. <sect2> <title> - boot sequence + Boot Sequence </title> <para> @@ -78,20 +77,24 @@ fml boot loader boots off in this way. </para> +<para> +/usr/local/libexec/fml/distribute is symlink-ed to +/usr/local/libexec/fml/loader. These files are same. +</para> <para> -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. +/usr/local/libexec/fml/loader reads /usr/local/etc/fml/main.cf +firstly. $fml_vesrion such as "current-20010501" is defined + in the 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. </para> <para> &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. +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. </para> </sect2> diff --git a/fml/doc/en/tutorial/usage/unsubscribe.sgml b/fml/doc/en/tutorial/usage/unsubscribe.sgml index 001e5152..7ad289f1 100644 --- a/fml/doc/en/tutorial/usage/unsubscribe.sgml +++ b/fml/doc/en/tutorial/usage/unsubscribe.sgml @@ -1,5 +1,5 @@ -!-- - $FML$ +<!-- + $FML: unsubscribe.sgml,v 1.1 2003/07/26 04:29:14 fukachan Exp $ $jaFML: unsubscribe.sgml,v 1.1 2002/07/28 12:20:20 fukachan Exp $ --> |
