path: root/fml/doc/en/tutorial/usage/makefml.sgml

<!--
   $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 A New ML
	</title>

<para>
<screen>
% su fml
% makefml newml ML
</screen>
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 address with the
domain such as user@domain form as ML string.
</para>

<para>
See the section
<link linkend="setup.newml">
<xref linkend="setup.newml">
</link>
for more details.
</para>

</sect1>


<sect1 id="usage.makefml.rmml">
	<title>
	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>
Please use user@domain syntax for virtual domains.
</para>

<para>
It reverts the action newml did.
It removes ML home directory, alias entries and ~fml/.qmail-*.
</para>

</sect1>


<sect1 id="usage.makefml.user.adddel">
	<title>
	Subscribe and Unsubscribe
	</title>

<para>
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
% makefml useradd elena@fml.org rudo@nuinui.net
% makefml userdel elena@fml.org rudo@nuinui.net
</screen>
</para>

<para>
For convenience, useradd is an acronym. 
The following commands, 
<screen>	
useradd
adduser	
subscribe
add
</screen>	
, are same as useradd.
In the same way, 
<screen>
userdel
deluser
bye
remove
resign
signoff
unsubscribe
</screen>
are same as userdel.
</para>


</sect1>


<sect1 id="usage.makefml.user.chaddr">
	<title>
	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
</screen>
</para>


</sect1>


<sect1 id="usage.makefml.off">
	<title>
	Stop Realtime Delivery
	</title>

<para>
<screen>
% makefml off elena ADDRESS
</screen>
</para>

<para>
Delivery to ADDRESS is switched to digest.
</para>

</sect1>


<sect1 id="usage.makefml.on">
	<title>
	Start Realtime Delivery
	</title>

<para>
<screen>
% makefml on elena ADDRESS
</screen>
</para>

<para>
Delivery to ADDRESS is switched from digest to real time.
</para>

</sect1>


<sect1 id="usage.makefml.log">
	<title>
	See Log
	</title>

<para>
<screen>
% makefml log elena
% makefml log elena@fml.org
</screen>
</para>

</sect1>


<sect1 id="usage.makefml.list">
	<title>
	See The Member List
	</title>

<para>
<screen>
% makefml list elena
</screen>
It shows recipients of this ML. Also,
<screen>
% makefml list elena recipient
</screen>
lists up only 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>


<sect1 id="usage.makefml.config">
	<title>
	Modify Configuration
	</title>

<para>
Edit config.cf directly now.
</para>

<para>
Configuration helper tool is incompletely implemented.
</para>

</sect1>


<sect1 id="usage.makefml.admin.adddel">
	<title>
	Add or Remove A Remote Administrator.
	</title>

<warning>
<para>
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>
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
% makefml addadmin elena@fml.org rudo@nuinui.net
% makefml deladmin elena@fml.org rudo@nuinui.net
</screen>
</para>

<para>
For convenience, 
<screen>	
adminadd
addpriv
</screen>	
are same as addadmin.
<screen>
byeadmin
byepriv
</screen>
are same as deladmin.
</para>


</sect1>



<sect1 id="usage.makefml.moderator.adddel">
	<title>
	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
% makefml addmoderator elena@fml.org rudo@nuinui.net
% makefml delmoderator elena@fml.org rudo@nuinui.net
</screen>
</para>

</sect1>