<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <!--Converted with LaTeX2HTML 99.2beta8 (1.42) original version by: Nikos Drakos, CBLU, University of Leeds * revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan * with significant contributions from: Jens Lippmann, Marek Rouchal, Martin Wilck and others --> <HTML> <HEAD> <TITLE>15. Using Sympa commands</TITLE> <META NAME="description" CONTENT="15. Using Sympa commands"> <META NAME="keywords" CONTENT="sympa"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> <META NAME="Generator" CONTENT="LaTeX2HTML v99.2beta8"> <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> <LINK REL="STYLESHEET" HREF="sympa.css"> <LINK REL="next" HREF="node17.html"> <LINK REL="previous" HREF="node15.html"> <LINK REL="up" HREF="sympa.html"> <LINK REL="next" HREF="node17.html"> </HEAD> <BODY TEXT="#000000" BGCOLOR="#ffffff"> <!--Navigation Panel--> <A NAME="tex2html815" HREF="node17.html"> <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> <A NAME="tex2html809" HREF="sympa.html"> <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> <A NAME="tex2html803" HREF="node15.html"> <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> <A NAME="tex2html811" HREF="node1.html"> <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> <A NAME="tex2html813" HREF="node17.html"> <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> <BR> <B> Next:</B> <A NAME="tex2html816" HREF="node17.html">Index</A> <B> Up:</B> <A NAME="tex2html810" HREF="sympa.html">Sympa Mailing Lists Management Software</A> <B> Previous:</B> <A NAME="tex2html804" HREF="node15.html">14. Antivirus</A>   <B> <A NAME="tex2html812" HREF="node1.html">Contents</A></B>   <B> <A NAME="tex2html814" HREF="node17.html">Index</A></B> <BR> <BR> <!--End of Navigation Panel--> <!--Table of Child-Links--> <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A> <UL> <LI><A NAME="tex2html817" HREF="node16.html#SECTION001610000000000000000">15.1 User commands</A> <LI><A NAME="tex2html818" HREF="node16.html#SECTION001620000000000000000">15.2 Owner commands</A> <LI><A NAME="tex2html819" HREF="node16.html#SECTION001630000000000000000">15.3 Moderator commands</A> </UL> <!--End of Table of Child-Links--> <HR> <H1><A NAME="SECTION001600000000000000000"> 15. Using <I>Sympa</I> commands</A> </H1> <P> Users interact with <I>Sympa</I>, of course, when they send messages to one of the lists, but also indirectly through administrative requests (subscription, list of users, etc.). <P> This section describes administrative requests, as well as interaction modes in the case of private and moderated lists. Administrative requests are messages whose body contains commands understood by <I>Sympa</I>, one per line. These commands can be indiscriminately placed in the <A NAME="5310"></A><TT>Subject:</TT> or in the body of the message. The <A NAME="5313"></A><TT>To:</TT> address is generally the <TT>sympa@domain</TT> alias, although it is also advisable to recognize the <TT>listserv@domain</TT> address. <P> Example: <P><PRE> From: pda@prism.uvsq.fr To: sympa@cru.fr LISTS INFO sympa-users REVIEW sympa-users QUIT </PRE> <P> Most user commands can have three-letter abbreviations (e.g. <TT>REV</TT> instead of <A NAME="5320"></A><TT>REVIEW</TT>). <P> <H1><A NAME="SECTION001610000000000000000"> 15.1 User commands</A> </H1> <P> <UL> <LI><A NAME="5323"></A><TT>HELP</TT> <P> Provides instructions for the use of <I>Sympa</I> commands. The result is the content of the <A NAME="5327"></A><TT>helpfile.tpl</TT> template file. <P> </LI> <LI><A NAME="5330"></A><TT>INFO</TT> <I>listname</I> <P> Provides the welcome message for the specified list. The result is the content of <A NAME="5333"></A><TT>~welcome[.mime]</TT>. <P> </LI> <LI><A NAME="5338"></A><TT>LISTS</TT> <A NAME="cmd-lists"></A> <P> Provides the names of lists managed by <I>Sympa</I>. This list can either be generated dynamically, using the <A NAME="5342"></A><TT>visibility</TT> (see <A HREF="node12.html#par-visibility">11.1.7</A>, page <A HREF="node12.html#par-visibility"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and <TT>subject</TT> list parameters (<A HREF="node12.html#par-subject">11.1.5</A>, page <A HREF="node12.html#par-subject"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>), as well as <A NAME="5345"></A><TT>~sympa/expl/lists.header</TT> and <A NAME="5350"></A><TT>~sympa/expl/lists.footer</TT>). It can also be generated statically by including the contents of the <A NAME="5355"></A><TT>~sympa/expl/lists</TT> file, which must be updated manually by the robot <A NAME="5360"></A>administrator. <P> </LI> <LI><A NAME="5361"></A><TT>REVIEW</TT> <I>listname</I> <A NAME="cmd-review"></A> <P> Provides the parameters of the specified list (owner, subscription mode, etc.), as well as the addresses of subscribers if the run mode authorizes it. See the <A NAME="5364"></A><TT>review</TT> parameter (<A HREF="node12.html#par-review">11.3.7</A>, page <A HREF="node12.html#par-review"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) for the configuration file of each list, which controls consultation authorizations for the subscriber list. Since subscriber addresses can be abused by spammers, it is strongly recommended that you <B>only authorize owners to access the subscriber list</B>. <P> </LI> <LI><A NAME="5367"></A><TT>WHICH</TT> <A NAME="cmd-which"></A> <P> Returns the list of lists to which one is subscribed, as well as the configuration of his or her subscription to each of the lists (DIGEST, NOMAIL, SUMMARY, CONCEAL). <P> </LI> <LI><A NAME="5370"></A><TT>STATS</TT> <I>listname</I> <A NAME="cmd-stats"></A> <P> Provides statistics for the specified list: number of messages received, number of messages sent, megabytes received, megabytes sent. This is the contents of the <A NAME="5373"></A><TT>~sympa/expl/stats</TT> file. <P> </LI> <LI><A NAME="5378"></A><TT>INDEX</TT> <I>listname</I> <A NAME="cmd-index"></A> <P> Provides index of archives for specified list. Access rights to this function are the same as for the <A NAME="5381"></A><TT>GET</TT> command. <P> </LI> <LI><A NAME="5384"></A><TT>GET</TT> <I>listname</I> <I>archive</I> <A NAME="cmd-get"></A> <P> To retrieve archives for list (see above). Access rights are the same as for the <A NAME="5387"></A><TT>REVIEW</TT> command. See <A NAME="5390"></A><TT>review</TT> parameter (<A HREF="node12.html#par-review">11.3.7</A>, page <A HREF="node12.html#par-review"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5393"></A><TT>LAST</TT> <I>listname</I> <A NAME="cmd-last"></A> <P> To receive the last message distributed in a list (see above). Access rights are the same as for the <A NAME="5396"></A><TT>GET</TT> command. <P> </LI> <LI><A NAME="5399"></A><TT>SUBSCRIBE</TT> <I>listname firstname name</I> <A NAME="cmd-subscribe"></A> <P> Requests sign-up to the specified list. The <I>firstname</I> and <I>name</I> are optional. If the list is parameterized with a restricted subscription (see <A NAME="5402"></A><TT>subscribe</TT> parameter, <A HREF="node12.html#par-subscribe">11.3.1</A>, page <A HREF="node12.html#par-subscribe"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>), this command is sent to the list owner for approval. <P> </LI> <LI><A NAME="5405"></A><TT>INVITE</TT> <I>listname user@host name</I> <A NAME="cmd-invite"></A> <P> Invite someone to subscribe to the specified list. The <I>name</I> is optional. The command is similar to the <A NAME="5408"></A><TT>ADD</TT> but the specified person is not added to the list but invited to subscribe to it in accordance with the <A NAME="5411"></A><TT>subscribe</TT> parameter, <A HREF="node12.html#par-subscribe">11.3.1</A>, page <A HREF="node12.html#par-subscribe"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5414"></A><TT>SIGNOFF</TT> <I>listname</I> [ <I>user@host</I> ] <A NAME="cmd-signoff"></A> <P> Requests unsubscription from the specified list. <A NAME="5417"></A><TT>SIGNOFF *</TT> means unsubscription from all lists. <P> </LI> <LI><A NAME="5420"></A><TT>SET</TT> <I>listname</I> <TT>DIGEST</TT> <A NAME="cmd-setdigest"></A> <P> Puts the subscriber in <I>digest</I> mode for the <I>listname</I> list. Instead of receiving mail from the list in a normal manner, the subscriber will periodically receive it in a DIGEST. This DIGEST compiles a group of messages from the list, using multipart/digest mime format. <P> The sending period for these DIGESTS is regulated by the list owner using the <A NAME="5423"></A><TT>digest</TT> parameter (see <A HREF="node12.html#par-digest">11.4.7</A>, page <A HREF="node12.html#par-digest"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). See the <A NAME="5426"></A><TT>SET LISTNAME MAIL</TT> command (<A HREF="node16.html#cmd-setmail">15.1</A>, page <A HREF="node16.html#cmd-setmail"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and the <A NAME="5429"></A><TT>reception</TT> parameter (<A HREF="node10.html#par-reception">9.5</A>, page <A HREF="node10.html#par-reception"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5432"></A><TT>SET</TT> <I>listname</I> <TT>SUMMARY</TT> <A NAME="cmd-setsummary"></A> <P> Puts the subscriber in <I>summary</I> mode for the <I>listname</I> list. Instead of receiving mail from the list in a normal manner, the subscriber will periodically receive the list of messages. This mode is very close to the DIGEST reception mode but the subscriber receives only the list of messages. <P> This option is available only if the digest mode is set. <P> </LI> <LI><A NAME="5435"></A><TT>SET</TT> <I>listname</I> <TT>NOMAIL</TT> <A NAME="cmd-setnomail"></A> <P> Puts subscriber in <I>nomail</I> mode for the <I>listname</I> list. This mode is used when a subscriber no longer wishes to receive mail from the list, but nevertheless wishes to retain the possibility of posting to the list. This mode therefore prevents the subscriber from unsubscribing and subscribing later on. See the <A NAME="5438"></A><TT>SET LISTNAME MAIL</TT> command (<A HREF="node16.html#cmd-setmail">15.1</A>, page <A HREF="node16.html#cmd-setmail"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and the <A NAME="5441"></A><TT>reception</TT> (<A HREF="node10.html#par-reception">9.5</A>, page <A HREF="node10.html#par-reception"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5444"></A><TT>SET</TT> <I>listname</I> <TT>MAIL</TT> <A NAME="cmd-setmail"></A> <P> Puts the subscriber in normal mode (default) for the <I>listname</I> list. This option is mainly used to cancel the <I>nomail</I>, <I>summary</I> or <I>digest</I> modes. If the subscriber was in <I>nomail</I> mode, he or she will again receive mail from the list in a normal manner. See the <A NAME="5447"></A><TT>SET LISTNAME NOMAIL</TT> command (<A HREF="node16.html#cmd-setnomail">15.1</A>, page <A HREF="node16.html#cmd-setnomail"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and the <A NAME="5450"></A><TT>reception</TT> parameter (<A HREF="node10.html#par-reception">9.5</A>, page <A HREF="node10.html#par-reception"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5453"></A><TT>SET</TT> <I>listname</I> <TT>CONCEAL</TT> <A NAME="cmd-setconceal"></A> <P> Puts the subscriber in <I>conceal</I> mode for the <I>listname</I> list. The subscriber will then become invisible during <A NAME="5456"></A><TT>REVIEW</TT> on this list. Only owners will see the whole subscriber list. <P> See the <A NAME="5459"></A><TT>SET LISTNAME NOCONCEAL</TT> command (<A HREF="node16.html#cmd-setnoconceal">15.1</A>, page <A HREF="node16.html#cmd-setnoconceal"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and the <A NAME="5462"></A><TT>visibility</TT> parameter (<A HREF="node12.html#par-visibility">11.1.7</A>, page <A HREF="node12.html#par-visibility"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5465"></A><TT>SET</TT> <I>listname</I> <TT>NOCONCEAL</TT> <A NAME="cmd-setnoconceal"></A> <P> Puts the subscriber in <I>noconceal</I> mode (default) for <I>listname</I> list. The subscriber will then become visible during <A NAME="5468"></A><TT>REVIEW</TT> of this list. The <I>conceal</I> mode is then cancelled. <P> See <A NAME="5471"></A><TT>SET LISTNAME CONCEAL</TT> command (<A HREF="node16.html#cmd-setconceal">15.1</A>, page <A HREF="node16.html#cmd-setconceal"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>) and <A NAME="5474"></A><TT>visibility</TT> parameter (<A HREF="node12.html#par-visibility">11.1.7</A>, page <A HREF="node12.html#par-visibility"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="5477"></A><TT>QUIT</TT> <A NAME="cmd-quit"></A> <P> Ends acceptance of commands. This can prove useful when the message contains additional lines, as for example in the case where a signature is automatically added by the user's mail program (MUA). <P> </LI> <LI><A NAME="5480"></A><TT>CONFIRM</TT> <I>key</I> <A NAME="cmd-confirm"></A> <P> If the <A NAME="5483"></A><TT>send</TT> parameter of a list is set to <TT>privatekey, publickey</TT> or <TT>privateorpublickey</TT>, messages are only distributed in the list after an <A NAME="5486"></A>authentication phase by return mail, using a one-time password (numeric key). For this authentication, the sender of the message is requested to post the ``<A NAME="5487"></A><TT>CONFIRM</TT> <I>key</I>'' command to <I>Sympa</I>. <P> </LI> <LI><A NAME="5491"></A><TT>QUIET</TT> <P> This command is used for silent (mute) processing: no performance report is returned for commands prefixed with <A NAME="5494"></A><TT>QUIET</TT>). <P> </LI> </UL> <P> <H1><A NAME="SECTION001620000000000000000"> 15.2 Owner commands</A> </H1> <P> Some administrative requests are only available to list owner(s). They are indispensable for all procedures in limited access mode, and to perform requests in place of users. These requests are: <P> <UL> <LI><A NAME="5497"></A><TT>ADD</TT> <I>listname user@host firstname name</I> <A NAME="cmd-add"></A> <P> Add command similar to <A NAME="5500"></A><TT>SUBSCRIBE</TT> <P> </LI> <LI><A NAME="5503"></A><TT>DELETE</TT> <I>listname user@host</I> <A NAME="cmd-delete"></A> <P> Delete command similar to <A NAME="5506"></A><TT>SIGNOFF</TT> <P> </LI> <LI><A NAME="5509"></A><TT>REMIND</TT> <I>listname</I> or <A NAME="5512"></A><TT>REMIND</TT> <I>*</I> <A NAME="cmd-remind"></A> <P> <A NAME="5515"></A><TT>REMIND</TT> is used usually by list owner in order to send an individual service message to each subscriber. This message is make by parsing the remind.tpl file. <P> <A NAME="5518"></A><TT>REMIND</TT> is used to send to each subscriber of any list a single message with a summary of his/her subscriptions. In this case the message sent is constructed by parsing the global_remind.tpl file. For each list, <I>Sympa</I> tests whether the list is configured as hidden to each subscriber (parameter lparam visibility). By default the use of this command is restricted to listmasters. Processing may take a lot of time ! <P> </LI> <LI><A NAME="5522"></A><TT>EXPIRE</TT> <A NAME="cmd-expire"></A> <P> <I>listname</I> <I>age (in days)</I> <I>deadline (in days)</I> (listname) (age (in days)) (deadline (in days)) <I>explanatory text to be sent to the subscribers concerned</I> <P> This command activates an <A NAME="5525"></A>expiration process for former subscribers of the designated list. Subscribers for which no procedures have been enabled for more than <I>age</I> days receive the explanatory text appended to the <A NAME="5526"></A><TT>EXPIRE</TT> command. This text, which must be adapted by the list owner for each subscriber population, should explain to the people receiving this message that they can update their subscription date so as to not be deleted from the subscriber list, within a deadline of <I>deadline</I> days. <P> Past this deadline, the initiator of the <A NAME="5529"></A><TT>EXPIRE</TT> command receives the list of persons who have not confirmed their subscription. It is up to the initiator to send <I>Sympa</I> the corresponding <A NAME="5533"></A><TT>DELETE</TT> commands. <P> Any operation updating the subscription date of an address serves as confirmation of subscription. This is also the case for <A NAME="5536"></A><TT>SET</TT> option selecting commands and for the <A NAME="5539"></A><TT>SUBSCRIBE</TT> subscription command itself. The fact of sending a message to the list also updates the subscription date. <P> The explanatory message should contain at least 20 words; it is possible to delimit it by the word <A NAME="5542"></A><TT>QUIT</TT>, in particular in order not to include a signature, which would systematically end the command message. <P> A single expiration process can be activated at any given time for a given list. The <A NAME="5545"></A><TT>EXPIRE</TT> command systematically gives rise to <A NAME="5548"></A>authentication by return mail. The <A NAME="5549"></A><TT>EXPIRE</TT> command has <B>no effect on the subscriber list</B>. <P> </LI> <LI><A NAME="5552"></A><TT>EXPIREINDEX</TT> <I>listname</I> <A NAME="cmd-expireindex"></A> <P> Makes it possible, at any time, for an expiration process activated using an <A NAME="5555"></A><TT>EXPIRE</TT> command to receive the list of addresses for which no enabling has been received. <P> </LI> <LI><A NAME="5558"></A><TT>EXPIREDEL</TT> <I>listname</I> <A NAME="cmd-expiredel"></A> <P> Deletion of a process activated using the <A NAME="5561"></A><TT>EXPIRE</TT> command. The <A NAME="5564"></A><TT>EXPIREDEL</TT> command has no effect on subscribers, but it possible to activate a new expiration process with new deadlines. <P> </LI> </UL> <P> As above, these commands can be prefixed with <A NAME="5567"></A><TT>QUIET</TT> to indicate processing without acknowledgment of receipt. <P> <H1><A NAME="SECTION001630000000000000000"></A> <A NAME="moderation"></A> <BR> 15.3 Moderator commands </H1> <P> If a list is moderated, <I>Sympa</I> only distributes messages enabled by one of its moderators (editors). Moderators have several methods for enabling message distribution, depending on the <A NAME="5571"></A><TT>send</TT> list parameter (<A HREF="node12.html#par-send">11.3.6</A>, page <A HREF="node12.html#par-send"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> <UL> <LI><A NAME="5574"></A><TT>DISTRIBUTE</TT> <I>listname</I> <I>key</I> <A NAME="cmd-distribute"></A> <P> If the <A NAME="5577"></A><TT>send</TT> parameter of a list is set to <TT>editorkey</TT> or <TT>editorkeyonly</TT>, each message queued for <A NAME="5580"></A>moderation is stored in a spool (see <A HREF="node5.html#cf:queuemod">4.5.3</A>, page <A HREF="node5.html#cf:queuemod"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>), and linked to a key. <P> The <A NAME="5581"></A>moderator must use this command to enable message distribution. <P> </LI> <LI><A NAME="5582"></A><TT>REJECT</TT> <I>listname</I> <I>key</I> <A NAME="cmd-reject"></A> <P> The message with the <I>key</I> key is deleted from the moderation <A NAME="5585"></A>spool of the <I>listname</I> list. <P> </LI> <LI><A NAME="5586"></A><TT>MODINDEX</TT> <I>listname</I> <A NAME="cmd-modindex"></A> <P> This command returns the list of messages queued for moderation for the <I>listname</I> list. <P> The result is presented in the form of an index, which supplies, for each message, its sending date, its sender, its size, and its associated key, as well as all messages in the form of a digest. <P> </LI> </UL> <P> See also the <A NAME="tex2html26" HREF="http://listes.cru.fr/admin/moderation.html">recommendations for moderators</A>. <P> <HR> <!--Navigation Panel--> <A NAME="tex2html815" HREF="node17.html"> <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> <A NAME="tex2html809" HREF="sympa.html"> <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> <A NAME="tex2html803" HREF="node15.html"> <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> <A NAME="tex2html811" HREF="node1.html"> <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> <A NAME="tex2html813" HREF="node17.html"> <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> <BR> <B> Next:</B> <A NAME="tex2html816" HREF="node17.html">Index</A> <B> Up:</B> <A NAME="tex2html810" HREF="sympa.html">Sympa Mailing Lists Management Software</A> <B> Previous:</B> <A NAME="tex2html804" HREF="node15.html">14. Antivirus</A>   <B> <A NAME="tex2html812" HREF="node1.html">Contents</A></B>   <B> <A NAME="tex2html814" HREF="node17.html">Index</A></B> <!--End of Navigation Panel--> <ADDRESS> root 2001-06-05 </ADDRESS> </BODY> </HTML>