<!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>2. what does Sympa consist of ?</TITLE> <META NAME="description" CONTENT="2. what does Sympa consist of ?"> <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="node4.html"> <LINK REL="previous" HREF="node2.html"> <LINK REL="up" HREF="sympa.html"> <LINK REL="next" HREF="node4.html"> </HEAD> <BODY TEXT="#000000" BGCOLOR="#ffffff"> <!--Navigation Panel--> <A NAME="tex2html408" HREF="node4.html"> <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> <A NAME="tex2html402" HREF="sympa.html"> <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> <A NAME="tex2html396" HREF="node2.html"> <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> <A NAME="tex2html404" HREF="node1.html"> <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> <A NAME="tex2html406" HREF="node17.html"> <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> <BR> <B> Next:</B> <A NAME="tex2html409" HREF="node4.html">3. Installing Sympa</A> <B> Up:</B> <A NAME="tex2html403" HREF="sympa.html">Sympa Mailing Lists Management Software</A> <B> Previous:</B> <A NAME="tex2html397" HREF="node2.html">1. Presentation</A>   <B> <A NAME="tex2html405" HREF="node1.html">Contents</A></B>   <B> <A NAME="tex2html407" 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="tex2html410" HREF="node3.html#SECTION00310000000000000000">2.1 Organization</A> <LI><A NAME="tex2html411" HREF="node3.html#SECTION00320000000000000000">2.2 Binaries</A> <LI><A NAME="tex2html412" HREF="node3.html#SECTION00330000000000000000">2.3 Configuration files</A> <LI><A NAME="tex2html413" HREF="node3.html#SECTION00340000000000000000">2.4 Spools</A> </UL> <!--End of Table of Child-Links--> <HR> <H1><A NAME="SECTION00300000000000000000"> 2. what does <I>Sympa</I> consist of ?</A> </H1> <P> <H1><A NAME="SECTION00310000000000000000"></A> <A NAME="organization"></A> <BR> 2.1 Organization </H1> <P> Here is a snapshot of what <I>Sympa</I> looks like once it has settled down on your system. This also illustrates the <I>Sympa</I> philosophy, I guess. <P> <UL> <LI><A NAME="2686"></A><TT>~sympa/</TT> <BR> The root directory of <I>Sympa</I>. You will find almost everything related to <I>Sympa</I> under this directory, except logs and main configuration files. <P> </LI> <LI><A NAME="2693"></A><TT>~sympa/bin/</TT> <BR> This directory contains the binaries, including CGI. It also contains the default scenarios, templates and configuration files. <P> </LI> <LI><A NAME="2698"></A><TT>~sympa/bin/etc/</TT> <BR> Here <I>Sympa</I> stores the default versions of what it will otherwise find in <A NAME="2704"></A><TT>~sympa/etc/</TT> (scenarios, templates and configuration files, recognized S/Mime certificates). <P> </LI> <LI><A NAME="2709"></A><TT>~sympa/etc/</TT> <BR> This is your site's configuration directory. Consult <A NAME="2714"></A><TT>~sympa/bin/etc/</TT> when drawing up your own. <P> </LI> <LI><A NAME="2719"></A><TT>~sympa/etc/create_list_templates/</TT> <BR> List templates (suggested at list creation time). <P> </LI> <LI><A NAME="2724"></A><TT>~sympa/etc/scenari/</TT> <BR> This directory will contain your scenarii (or scenarios, if you prefer). If you don't know what the hell a scenario is, refer to <A HREF="node9.html#scenarii">8.6</A>, page <A HREF="node9.html#scenarii"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. <P> </LI> <LI><A NAME="2729"></A><TT>~sympa/etc/wws_templates/</TT> <BR> The web interface (<A NAME="2734"></A><I>WWSympa</I>) is composed of template HTML files parsed by the CGI program. <P> </LI> <LI><A NAME="2737"></A><TT>~sympa/etc/templates/</TT> <BR> Some of the mail robot's replies are defined by templates (<A NAME="2742"></A><TT>welcome.tpl</TT> for SUBSCRIBE). You can overload these template files in the individual list directories, but these are the defaults. <P> </LI> <LI><A NAME="2745"></A><TT>~sympa/expl/</TT> <BR> <I>Sympa</I>'s working directory. <P> </LI> <LI><A NAME="2751"></A><TT>~sympa/expl/mylist</TT> <BR> The list directory (refer to <A HREF="node10.html#list-directory">9.2</A>, page <A HREF="node10.html#list-directory"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="2756"></A><TT>~sympa/nls/</TT> <BR> Internationalization directory. It contains XPG4-compatible message catalogues. <I>Sympa</I> has currently been translated into 8 different languages. <P> </LI> <LI><A NAME="2762"></A><TT>~sympa/spool/</TT> <BR> <I>Sympa</I> uses 7 different spools (see <A HREF="node3.html#spools">2.4</A>, page <A HREF="node3.html#spools"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>). <P> </LI> <LI><A NAME="2768"></A><TT>~sympa/src/</TT> <BR> <I>Sympa</I> sources. <P> </LI> </UL> <P> <H1><A NAME="SECTION00320000000000000000"></A> <A NAME="binaries"></A> <BR> 2.2 Binaries </H1> <P> <UL> <LI><A NAME="2774"></A><TT>sympa.pl</TT> <BR> The main daemon ; it processes commands and delivers messages. Continuously scans the <A NAME="2777"></A><TT>msg/</TT> spool. <P> </LI> <LI><A NAME="2780"></A><TT>wwsympa.fcgi</TT> <BR> The CGI program offering a complete web interface to mailing lists. It can work in both classical CGI and FastCGI modes, although we recommend FastCGI mode, being up to 10 times faster. <P> </LI> <LI><A NAME="2783"></A><TT>bounced.pl</TT> <BR> This daemon processes bounces (non-delivered messages), looking for the bad addresses. List owners will later access bounce information via <A NAME="2786"></A><I>WWSympa</I>. Continuously scans the <A NAME="2789"></A><TT>bounce/</TT> spool. <P> </LI> <LI><A NAME="2792"></A><TT>archived.pl</TT> <BR> This daemon feeds the web archives, converting messages to HTML format and linking them. It uses the amazing <A NAME="2795"></A><TT>MhOnArc</TT>. Continuously scans the <A NAME="2798"></A><TT>outgoing/</TT> spool. <P> </LI> <LI><A NAME="2801"></A><TT>queue</TT> <BR> This small program gets the incoming messages from the aliases and stores them in <A NAME="2804"></A><TT>msg/</TT> spool. <P> </LI> <LI><A NAME="2807"></A><TT>bouncequeue</TT> <BR> Same as <A NAME="2810"></A><TT>queue</TT> for bounces. Stores bounces in <A NAME="2813"></A><TT>bounce/</TT> spool. <P> </LI> </UL> <P> <H1><A NAME="SECTION00330000000000000000"> 2.3 Configuration files</A> </H1> <P> <UL> <LI><A NAME="2816"></A><TT>sympa.conf</TT> <BR> The main configuration file. See <A HREF="node5.html#exp-admin">4</A>, page <A HREF="node5.html#exp-admin"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. <P> </LI> <LI><A NAME="2819"></A><TT>wwsympa.conf</TT> <BR> <A NAME="2822"></A><I>WWSympa</I> configuration file. See <A HREF="node2.html#wwsympa">1.2</A>, page <A HREF="node2.html#wwsympa"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. <P> </LI> <LI><A NAME="2825"></A><TT>edit_list.conf</TT> <BR> Defines which parameters/files are editable by owners. See <A HREF="node11.html#list-edition">10.2</A>, page <A HREF="node11.html#list-edition"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. <P> </LI> <LI><A NAME="2828"></A><TT>topics.conf</TT> <BR> Contains the declarations your site's topics (classification in <A NAME="2831"></A><I>WWSympa</I>), along with their titles. A sample is provided in the <A NAME="2834"></A><TT>sample/</TT> directory of the sympa distribution. See <A HREF="node9.html#topics">8.5</A>, page <A HREF="node9.html#topics"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>. <P> </LI> </UL> <P> <H1><A NAME="SECTION00340000000000000000"></A> <A NAME="spools"></A> <BR> 2.4 Spools </H1> <P> See <A HREF="node5.html#spool-related">4.5</A>, page <A HREF="node5.html#spool-related"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A> for spool definition in <A NAME="2837"></A><TT>sympa.conf</TT>. <P> <UL> <LI><A NAME="2840"></A><TT>~sympa/spool/auth/</TT> <BR> For storing messages until they have been confirmed. <P> </LI> <LI><A NAME="2845"></A><TT>~sympa/spool/bounce/</TT> <BR> For storing incoming bouncing messages. <P> </LI> <LI><A NAME="2850"></A><TT>~sympa/spool/digest/</TT> <BR> For storing lists' digests before they are sent. <P> </LI> <LI><A NAME="2855"></A><TT>~sympa/spool/expire/</TT> <BR> Used by the expire process. <P> </LI> <LI><A NAME="2860"></A><TT>~sympa/spool/mod/</TT> <BR> For storing unmoderated messages. <P> </LI> <LI><A NAME="2865"></A><TT>~sympa/spool/msg/</TT> <BR> For storing incoming messages (including commands). <P> </LI> <LI><A NAME="2870"></A><TT>~sympa/spool/outgoing/</TT> <BR> <A NAME="2875"></A><TT>sympa.pl</TT> dumps messages in this spool to await archiving by <A NAME="2878"></A><TT>archived.pl</TT>. <P> </LI> </UL> <P> <HR> <!--Navigation Panel--> <A NAME="tex2html408" HREF="node4.html"> <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> <A NAME="tex2html402" HREF="sympa.html"> <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> <A NAME="tex2html396" HREF="node2.html"> <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> <A NAME="tex2html404" HREF="node1.html"> <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> <A NAME="tex2html406" HREF="node17.html"> <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> <BR> <B> Next:</B> <A NAME="tex2html409" HREF="node4.html">3. Installing Sympa</A> <B> Up:</B> <A NAME="tex2html403" HREF="sympa.html">Sympa Mailing Lists Management Software</A> <B> Previous:</B> <A NAME="tex2html397" HREF="node2.html">1. Presentation</A>   <B> <A NAME="tex2html405" HREF="node1.html">Contents</A></B>   <B> <A NAME="tex2html407" HREF="node17.html">Index</A></B> <!--End of Navigation Panel--> <ADDRESS> root 2001-06-05 </ADDRESS> </BODY> </HTML>