translated

7 files changed, 661 insertions, 0 deletions

diff --git a/fml/doc/en/tutorial/setup/cgi.sgml b/fml/doc/en/tutorial/setup/cgi.sgml
new file mode 100644
index 00000000..7a44906b
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/cgi.sgml
@@ -0,0 +1,191 @@
+<!--
+   $FML$
+   $jaFML: cgi.sgml,v 1.4 2003/04/15 14:51:43 fukachan Exp $
+-->
+
+<chapter id="setupcgi">
+	<title>
+	Configure CGI
+	</title>
+
+
+<warning>
+
+<para>
+See the section
+<link linkend="internalcgi.method">
+<xref linkend="internalcgi.method">
+</link>
+for CGI Internal details.
+</para>
+
+<para>
+We assumes you use suexec under apache.
+</para>
+
+<para>
+Now &fml8; provides the master cgi to control all ML's in one domain,
+but not support a ecgi for each ml. It is not yet implemented.
+</para>
+
+<para>
+If you use postfix and qmail, you do not need to modify MTA
+configuration.
+</para>
+
+</warning>
+
+
+<sect1 id="setupcgi.install">
+	<title>
+	"makefml newml" creates CGI script.
+	</title>
+
+<para>
+"makefml newml" sets up CGI scripts such as config.cgi under 
+~fml/public_html/... directory.
+There are two types of cgi scripts.
+One is for the whole domain, one for each ML. 
+</para>
+
+<para>
+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:
+http://lists.fml.org/~fml/cgi-bin/fml/fml.org/admin/config.cgi
+</screen>
+for all ML's of fml.org.
+To control only elena ML, please use 
+<screen>
+http://lists.fml.org/~fml/cgi-bin/fml/$domain/ml-admin/${ml_name}/config.cgi
+
+Example:
+http://lists.fml.org/~fml/cgi-bin/fml/fml.org/ml-admin/elena/config.cgi
+</screen>
+which is not yet created (not implemented _o_).
+</para>
+
+<para>
+<graphic entityref="image.cgi.newml"></graphic>
+</para>
+
+</sect1>
+
+
+<sect1 id="setupcgi.htaccess">
+	<title>
+	edit .htaccess
+	</title>
+
+<para>
+.htaccess is created but it is configured to deny all.
+<screen>
+http://lists.fml.org/~fml/cgi-bin/fml/$domain/.htaccess
+
+Example:
+http://lists.fml.org/~fml/cgi-bin/fml/fml.org/.htaccess
+</screen>
+</para>
+
+<para>
+The default .htaccess is dummy like this:
+<screen>
+AuthName ByPassword
+AuthType Basic
+require valid-user
+</screen>
+Please edit .htaccess properly.
+</para>
+
+</sect1>
+
+
+<sect1 id="setupcgi.admin.cgi.overview">
+	<title>
+	Example: master cgi
+	</title>
+
+<para>
+The role of this cgi is limited makefml (CUI).
+Though this cgi permits ML creation and destruction,
+all functions makefml has are not supported.
+The functions is limited.
+</para>
+
+<para>
+<screen>
+Eample: TOP MENU
+
+                     @home.fml.org CGI for configuration
+
+fml admin menu             fml CGI interface for @home.fml.org ML's
+mailing list:
+[elena]              
+command:             	.. help message ...
+[subscribe  ]        
+[submit][reset]
+                     subscribe   
+                     unsubscribe 
+                     addadmin    
+                     byeadmin    
+options Language:    list        
+[Japanese] [change]  log         
+                     newml       
+                     rmml        
+</screen>
+</para>
+
+<para>
+<graphic entityref="image.cgi.top"></graphic>
+</para>
+
+
+</sect1>
+
+
+<sect1 id="setupcgi.admin.cgi.newml">
+	<title>
+	CGI Example: create an ML
+	</title>
+
+<para>
+Select newml and push "submit".
+no need to select ML name in this stage.
+</para>
+
+<para>
+You find nother menu at the center.
+Specify the ML name you create and push "submit" at the center.
+</para>
+
+<para>
+<graphic entityref="image.cgi.newml"></graphic>
+</para>
+
+</sect1>
+
+
+<sect1 id="setupcgi.admin.cgi.subscribe">
+	<title>
+	CGI example: subscribe
+	</title>
+
+<para>
+Specify the ML name and select "subscribe", push "submit".
+</para>
+
+<para>
+You find another menu at the center.
+Specify the address to subscribe and push "submit" at the center.
+</para>
+
+<para>
+<graphic entityref="image.cgi.useradd"></graphic>
+</para>
+
+</sect1>
+
+
+</chapter>
diff --git a/fml/doc/en/tutorial/setup/config.cf.sgml b/fml/doc/en/tutorial/setup/config.cf.sgml
new file mode 100644
index 00000000..290c9a03
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/config.cf.sgml
@@ -0,0 +1,49 @@
+<!--
+   $FML$
+   $jaFML: config.cf.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $
+-->
+
+<sect1 id="setup.config.cf">
+	<title>
+	customize config.cf
+	</title>
+
+<para>
+In running "makefml newml", makefml sets up
+configuration files such as config.cf,
+include files for sendmail and postfix, 
+~fml/.qmail-* files. 
+<screen>
+% su fml
+% makefml newml elena
+   ... snip ...
+% ls /var/spool/ml/elena
+config.cf include include-ctl include-error
+	... snip ...
+</screen>
+</para>
+
+<para>
+To customize one ML configuraiton,
+edit config.cf.
+</para>
+
+<warning>
+<para>
+no menu tool to edit config.cf yet implemented.
+</para>
+</warning>
+
+
+<para>
+config.cf contains little definition.
+For example,
+/var/spool/ml/elena/include file follows:
+<screen>
+"| /usr/local/libexec/fml/distribute elena@fml.org"
+</screen>
+elena@fml.org in this argument determins 
+values of $ml_domain and $ml_name.
+</para>
+
+</sect1>
diff --git a/fml/doc/en/tutorial/setup/newml.sgml b/fml/doc/en/tutorial/setup/newml.sgml
new file mode 100644
index 00000000..3d415881
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/newml.sgml
@@ -0,0 +1,115 @@
+<!--
+   $FML$
+   $jaFML: newml.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $
+-->
+
+
+<chapter id="setup.newml">
+	<title>
+	Create ML on UNIX
+	</title>
+
+
+<sect1>
+	<title>
+	run "makefml newml" to create an ML
+	</title>
+
+<para>
+To create an ML, use "makefml" command (CUI).
+<screen>
+% su fml
+% makefml newml elena
+</screen>
+</para>
+
+
+<para>
+"makefml newml" processes the following steps.
+
+<itemizedlist>
+
+   <listitem>
+        <para>
+	create files such as
+	<screen>
+	config.cf
+	include
+	include-ctl
+	</screen>
+	at /var/spool/ml/elena.
+	The domai name et.al.  in these files is replaced to proper value.
+        </para>
+   </listitem>
+
+   <listitem>
+        <para>
+	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.
+        </para>
+   </listitem>
+
+   <listitem>
+        <para>
+	update procmailrc as a sample.
+        </para>
+   </listitem>
+
+   <listitem>
+        <para>
+	create samples for each MTA.
+        </para>
+   </listitem>
+
+   <listitem>
+        <para>
+	prepare the directory
+	<screen>
+	~fml/public_html/fml/mlarchive/$domain/$ml/
+	</screen>
+	for html archive.
+	For example, for elena@fml.org
+	<screen>
+	~fml/public_html/fml/mlarchive/fml.org/elena/
+	</screen>
+	is creatd.
+	HTML archive of ML articles is created by default.
+        </para>
+   </listitem>
+
+   <listitem>
+        <para>
+	prepare CGI (GUI). set up 
+	<screen>
+	~fml/public_html/cgi-bin/fml/$domain/admin/config.cgi
+	</screen>
+	for the master cgi, instead cgi to control one ML $ml@$domain
+	is set up at
+	<screen>
+	~fml/public_html/cgi-bin/fml/$domain/ml-admin/$ml/config.cgi
+	</screen>
+        </para>
+   </listitem>
+
+</itemizedlist>
+</para>
+
+</sect1>
+
+
+<!-- MTA config -->
+&sect.setup.postfix;
+&sect.setup.qmail;
+
+
+<!-- each ML config -->
+&sect.setup.config.cf;
+
+
+</chapter>
diff --git a/fml/doc/en/tutorial/setup/postfix.sgml b/fml/doc/en/tutorial/setup/postfix.sgml
new file mode 100644
index 00000000..7b80d257
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/postfix.sgml
@@ -0,0 +1,72 @@
+<!--
+   $FML$
+   $jaFML: postfix.sgml,v 1.3 2003/04/15 14:51:44 fukachan Exp $
+-->
+
+<sect1 id="setup.postfix.aliases">
+	<title>
+	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.
+</para>
+
+<para>
+See 
+<link linkend="install.postfix">
+<xref linkend="install.postfix">
+</link>
+for the detail of postfix configuration.
+</para>
+</important>
+
+
+<para>
+makefml do 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.
+</para>
+
+
+<sect2>
+	<title>
+	NOTE: format of /var/spool/ml/etc/mail/aliases
+	</title>
+
+<para>
+$ml_home_prefix/etc/mail/aliases has the following entry
+for elena@home.fml.org ML.
+<screen>
+### &lt;ALIASES elena@home.fml.org ML&gt; ###
+
+# address for post
+elena: :include:/var/spool/ml/elena/include
+owner-elena: fukachan
+
+# address for command
+elena-ctl: :include:/var/spool/ml/elena/include-ctl
+owner-elena-ctl: fukachan
+
+# maintainer
+elena-request: elena-admin
+elena-admin: fukachan, elena-error
+
+# error analyzer
+elena-error: :include:/var/spool/ml/elena/include-error
+owner-elena-error: fukachan
+
+### &lt;/ALIASES elena@home.fml.org ML&gt; ###
+</screen>
+In the case of virtual domain, 
+$ml_home_prefix varies with $virtual_maps.
+</para>
+
+</sect2>
+
+
+</sect1>
diff --git a/fml/doc/en/tutorial/setup/procmail.sgml b/fml/doc/en/tutorial/setup/procmail.sgml
new file mode 100644
index 00000000..8f48faff
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/procmail.sgml
@@ -0,0 +1,57 @@
+<!--
+   $FML$
+   $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.
+	</title>
+
+<para>
+When you need to set up a ML on your account, for example virtual
+domain service of ISP, use a mail processor such as procmail.
+</para>
+
+<para>
+You need to filter messages according to To: or Cc: in the mail header
+and redistribute it.
+</para>
+
+<para>
+makefml creates/updates ~/.procmailrc sample in newml 
+at /var/spool/ml/etc/procmail/procmailrc.
+</para>
+
+
+<sect2 id="setup.procmailrc">
+	<title>
+	~/.procmailrc example
+	</title>
+
+<para>
+<screen>
+PATH=$HOME/bin:/usr/bin:/usr/ucb:/bin:/usr/local/bin:/usr/pkg/bin
+MAILDIR=$HOME/Mail	# You'd better make sure it exists
+DEFAULT=$HOME/Mail/mbox
+LOGFILE=$MAILDIR/procmail.log
+LOCKFILE=$HOME/.lockmail
+VERBOSE=on
+
+:0
+* To.*elena@fml.org
+| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena
+
+:0
+* To.*elena-ctl@fml.org
+| /usr/local/libexec/fml/fml.pl /var/spool/ml/elena --ctladdr
+
+# last resort, mail for me et. al.
+:0
+inbox/.
+</screen>
+</para>
+
+</sect2>
+
+</sect1>
diff --git a/fml/doc/en/tutorial/setup/qmail.sgml b/fml/doc/en/tutorial/setup/qmail.sgml
new file mode 100644
index 00000000..d52ca167
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/qmail.sgml
@@ -0,0 +1,36 @@
+<!--
+   $FML$
+   $jaFML: qmail.sgml,v 1.2 2002/07/06 14:55:20 fukachan Exp $
+-->
+
+<sect1 id="setup.qmail.aliases">
+	<title>
+	MTA configuration (qmail)
+	</title>
+
+<para>
+"makefml newml" creates the following files for qmail:
+<screen>
+~fml/.qmail-fml:org-elena
+~fml/.qmail-fml:org-elena-ctl
+</screen>
+Hence, 
+<screen>
+/var/qmail/control/virtualdomains
+</screen>
+is prepared like this, 
+<screen>
+fml.org:fml-fml.org
+</screen>
+you have only to run "makefml newml" to create an ML in the case of
+qmail.
+</para>
+
+<warning>
+<para>
+This configuration assumuss
+ML's uses the whole one domain only for mailing list.
+</para>
+</warning>
+
+</sect1>
diff --git a/fml/doc/en/tutorial/setup/test.sgml b/fml/doc/en/tutorial/setup/test.sgml
new file mode 100644
index 00000000..970e389d
--- /dev/null
+++ b/fml/doc/en/tutorial/setup/test.sgml
@@ -0,0 +1,141 @@
+<!--
+   $FML$
+   $jaFML: test.sgml,v 1.4 2003/04/15 14:51:44 fukachan Exp $
+-->
+
+<chapter id="test">
+	<title>
+	test
+	</title>
+
+
+<sect1>
+	<title>
+	before test
+	</title>
+
+<warning>
+<para>
+set up MTA properly before test of fml.
+</para>
+</warning>
+
+<para>
+In this chapter,
+&fmldevel; and MTA works on ahodori.fml.org, which is called as 
+the mail server.
+</para>
+
+</sect1>
+
+
+<sect1>
+	<title>
+	test of only MTA
+	</title>
+
+<para>
+check MTA without fml on ahodori.fml.org.
+</para>
+
+<para>
+FIrstly, 
+prepare one personal user address such as rudo@fml.org.
+Usually, just create a user named as "rudo".
+<screen>
+# useradd rudo
+</screen>
+</para>
+
+<para>
+You should verify SMTP over network.
+Send a mail to rudo@fml.org from other host (not ahodori.fml.org).
+If rudo receives the mail, o.k.
+</para>
+
+<para>
+Secondly check the local delivery.
+send a mail to rudo@fml.org on ahodori.fml.org.
+<screen>
+% echo test |Mail rudo@fml.org
+</screen>
+</para>
+
+</sect1>
+
+
+<sect1>
+	<title>
+	send a mail to ML
+	</title>
+
+<para>
+Create elena ML (elena@fml.org) and subscribe rudo@fml.org to elena ML.
+<screen>
+% su fml
+% makefml newml elena
+% makefml add elena rudo@fml.org
+</screen>
+</para>
+
+<para>
+Send a test mail to elena@fml.org from other host (not ahodori.fml.org).
+Verify the header of this test mail should be "From: rudo@fml.org".
+</para>
+
+<sect2>
+	<title>
+	checks
+	</title>
+
+<para>
+If not works well, check the following: 
+<screen>
+check the mail server log (e.g. /var/log/maillog)
+check the fml log (e.g. /var/spool/m/elena/log)
+fml pass the message to MTA ?
+MTA succeeds to deliver it?
+</screen>
+</para>
+
+</sect2>
+
+</sect1>
+
+
+<sect1>
+	<title>
+	test of fml8 itself.
+	</title>
+
+<para>
+not yet implemented.
+</para>
+
+</sect1>
+
+
+<sect1>
+	<title>
+	reset after test.
+	</title>
+
+<para>
+It is easy to re-create this mailing list (e.g. test ML).
+<screen>
+% su fml
+% makefml rmml test
+% makefml newml test
+</screen>
+The removed ML home is left as /var/spool/ml/@test.
+Please remove it since this is a test to avoid the duplication in the
+future.
+<screen>
+% rm -fr /var/spool/ml/@test
+</screen>
+</para>
+
+</sect1>
+
+
+</chapter>