1 .\" This file was generated with po4a. Translate the source file.
3 .TH ENEMIES\-OF\-CARLOTTA 1
5 enemies\-of\-carlotta \- Gestionnaire simple de listes de diffusion
7 \fBenemies\-of\-carlotta\fP [\fIoptions\fP] [\fIadresses\fP]
9 \fBenemies\-of\-carlotta\fP est un gestionnaire simple de listes de diffusion.
11 Enemies of Carlotta conserve toutes les données des listes dans le
12 répertoire \fI~/.enemies\-of\-carlotta\fP. Celui\-ci sera créé automatiquement
13 lors de la création de la première liste. Le traitement des courriels par
14 le gestionnaire de listes doit être configuré manuellement. Les détails
15 peuvent varier d'un système à l'autre. Pour QMail et Postfix, voir
18 Chaque liste possède un ou plusieurs propriétaires, qui modèrent également
19 les inscriptions ou certains messages, voire tous. Sur les listes non
20 modérées, les propriétaires de la liste sont chargés de répondre aux
21 questions concernant la liste. Sur les listes totalement modérées, ils
22 doivent approuver chaque message avant qu'il ne soit envoyé sur la liste.
23 Sur les liste où \fIposting=auto\fP, les messages des abonnés sont
24 automatiquement envoyés à la liste, et les modérateurs n'ont besoin
25 d'approuver que les messages qui ne proviennent pas des abonnés.
28 \fB\-\-name=\fPfoo@example.com
29 préciser la liste sur laquelle la commande doit être effectuée. La plupart
30 des options doivent être accompagnées du nom de la liste concernée. Avec les
31 options \-\-edit, \-\-subscribe, \-\-unsubscribe et \-\-list, le nom peut être
32 abrégé en enlevant le signe @ et le domaine.
35 créer une nouvelle liste de diffusion. Au moins un propriétaire doit être
36 précisé à l'aide de \fB\-\-owner\fP.
38 \fB\-\-owner=\fP\fIadresse\fP
39 ajouter un propriétaire à la liste lors de sa création
41 \fB\-\-moderator=\fP\fIadresse\fP
42 ajouter un modérateur à la liste lors de sa création ou de son édition
44 \fB\-\-language=\fP\fIcode\-de\-la\-langue\fP
45 configurer le code de la langue utilisé pour récupérer les fichiers
46 modèles. Le code peut être vide (l'anglais sera utilisé par défaut) ou
47 composé de deux lettres comme \fBfr\fP ou \fBes\fP.
49 \fB\-\-cleaning\-woman\fP
50 gérer les adresses invalides et nettoyer quelques autres éléments. La
51 commande \fBenemies\-of\-carlotta \-\-cleaning\-woman\fP doit être lancée
52 périodiquement, comme une fois par heure, pour nettoyer l'ensemble des
59 modifier la configuration d'une liste
61 \fB\-\-subscription=\fP\fItype\fP
62 définir le mode d'abonnement à \fIfree\fP (libre) ou \fImoderated\fP (modéré) lors
63 de la création de la liste. À utiliser en combinaison avec \fB\-\-edit\fP ou
66 \fB\-\-posting=\fP\fItype\fP
67 définir le mode d'envoi à \fIfree\fP (libre), \fIauto\fP (automatique) ou
68 \fImoderated\fP (modéré). À utiliser en combinaison avec \fB\-\-edit\fP ou
71 \fB\-\-archived=\fP\fIyes\-ou\-no\fP
72 définir si les messages de la liste doivent être archivés dans le
73 sous\-répertoire \fBarchive\-box\fP du répertoire de la liste, lui\-même présent
74 dans le répertoire \fB~/.enemies\-of\-carlotta\fP. Utiliser \fIyes\fP (oui) ou \fIno\fP
77 \fB\-\-mail\-on\-subscription\-changes=\fP\fIyes\-ou\-no\fP
78 définir si les propriétaires de la liste doivent être avertis lors d'un
79 abonnement ou d'un désabonnement. Utiliser \fIyes\fP (oui) ou \fIno\fP (non). La
80 valeur par défaut est no.
82 \fB\-\-mail\-on\-forced\-unsubscription=\fP\fIyes\-ou\-no\fP
83 définir si les propriétaires de la liste doivent être avertis lorsque
84 quelqu'un est retiré de la liste en raison d'une adresse trop souvent
85 invalide. Utiliser \fIyes\fP (oui) ou \fIno\fP (non). La valeur par défaut est no.
87 \fB\-\-ignore\-bounce=\fP\fIyes\-ou\-no\fP
88 définir si les renvois pour adresse invalide doivent être ignorés. Utiliser
89 \fIyes\fP (oui) ou \fIno\fP (non). La valeur par défaut est no.
92 lister l'ensemble des abonnés à une liste.
95 ajouter des abonnés à la liste. Les arguments qui ne sont pas des options
96 sont les adresses à abonner. Les adresses ajoutées de cette façon ne
97 recevront pas de demande de confirmation.
100 enlever des abonnés de la liste. Les arguments qui ne sont pas des options
101 sont les adresses à désabonner. Les adresses enlevées de cette manière ne
102 recevront pas de demande de confirmation.
105 traiter un message entrant sur l'entrée standard. L'adresse de l'expéditeur
106 de l'enveloppe SMTP doit être précisée par la variable d'environnement
107 \fISENDER\fP et l'adresse du destinataire de l'enveloppe SMTP doit être
108 précisée par la variable d'environnement \fIRECIPIENT\fP. (QMail et Postfix
109 traitent cela automatiquement.)
111 \fB\-\-skip\-prefix=\fP\fIchaîne\fP
112 retirer \fIchaîne\fP du début de l'adresse de destination avant de l'analyser
113 pour déterminer à quelle liste le message est destiné. Ceci permet le
114 traitement des domaines virtuels avec QMail et Postfix, voir ci\-dessous.
116 \fB\-\-domain=\fP\fInom.du.domaine\fP
117 remplacer le nom de domaine par \fInom.du.domaine\fP dans l'adresse de
118 destination pour déterminer à quelle liste le message est destiné. Ceci
119 permet le traitement des domaines virtuels avec QMail et Postfix.
122 déterminer si l'adresse indiquée par \fB\-\-name\fP fait référence à une liste
123 valide. Le code de sortie zéro (succès) est retourné si c'est le cas, un
124 (échec) dans le cas contraire.
126 \fB\-\-sendmail=\fP\fIchemin\fP
127 utiliser \fIchemin\fP au lieu de \fB/usr/sbin/sendmail\fP pour envoyer des
128 courriels via une interface en ligne de commande. Cette commande doit
129 respecter l'interface de la ligne de commande sendmail.
131 \fB\-\-smtp\-server=\fP\fIhôte\fP
132 envoyer les courriels en utilisant le serveur SMTP sur \fIhôte\fP (port 25). Le
133 serveur doit être configuré pour permettre à la machine sur laquelle
134 fonctionne la liste de l'utiliser comme relais. Par défaut, l'interface en
135 ligne de commande est utilisée. L'envoi par SMTP n'est utilisé qu'avec cette
138 \fB\-\-qmqp\-server=\fP\fIhôte\fP
139 envoyer les courriels en utilisant le serveur QMQP sur \fIhôte\fP (port
140 628). Le serveur doit être configuré pour permettre à la machine sur
141 laquelle fonctionne la liste de l'utiliser comme relais. Par défaut,
142 l'interface en ligne de commande est utilisée. L'envoi par QMQP n'est
143 utilisé qu'avec cette option.
146 forcer un message entrant à être modéré, même s'il est envoyé à une liste où
147 l'envoi est libre. Cela peut être utilisé pour filtrer les courriers
148 indésirables\ : les messages entrants peuvent être filtrés par n'importe
149 quel système de filtrage des courriels\ ; dès lors qu'un message semble être
150 indésirable, une modération par un humain peut être demandée.
153 forcer un message entrant à être envoyé, même s'il est envoyé à une liste où
154 l'envoi est modéré. Cela peut être utilisé lorsqu'une vérification externe a
155 lieu pour définir si le courriel est acceptable sur la liste, par exemple en
156 vérifiant les signatures électroniques.
159 ne pas envoyer les messages de débogage des journaux sur la sortie d'erreur
160 standard, contrairement au comportement par défaut.
162 \fB\-\-sender=\fP\fIfoo@example.com\fP
164 \fB\-\-recipient=\fP\fIfoo@example.com\fP
165 écraser les variables d'environnement \fBSENDER\fP et \fBRECIPIENT\fP
166 respectivement, à utiliser en combinaison avec \fB\-\-incoming\fP et
170 obtenir les valeurs d'une ou plusieurs variables de configuration. Le nom
171 des variables est indiqué sur la ligne de commande après les options. Chaque
172 valeur est affichée sur une ligne séparée.
175 configurer les valeurs d'une ou plusieurs variables de configuration. Les
176 noms et valeurs sont donnés sur la ligne de commande après les options et
177 séparés par un signe d'égalité («\ =\ »). Par exemple, la commande suivante
178 configurerait une liste en français\ : \fBenemies\-of\-carlotta \-\-name=foo@bar
179 \-\-set language=fr\fP
182 afficher la version du programme
184 \fB\-\-show\-lists\fP
185 lister les listes connues de enemies\-of\-carlotta
187 Chaque liste est représentée par un répertoire, nommé d'après le nom de la
188 liste, sous le répertoire \fI~/.enemies\-of\-carlotta\fP. Ce répertoire contient
189 plusieurs fichiers et répertoires décrits ci\-dessous. En général, il n'est
190 pas nécessaire de toucher à ces répertoires. Cependant, certaines
191 configurations ésotériques peuvent uniquement être faites en éditant le
192 fichier de configuration de la liste.
195 Fichier de configuration de la liste. Le contenu est décrit ci\-dessous.
198 Base de données des abonnés. Chaque ligne contient un groupe d'abonnés, dont
199 les cinq premiers espaces délimitent les champs qui sont l'identifiant du
200 groupe, l'état, la date de création du groupe, la date du message de retour
201 qui a fait passer l'état de la liste de «\ ok\ » à «\ bounced\ », et
202 l'identifiant du message de retour.
208 Groupes des messages de retour qui ne sont pas dans l'état «\ ok\ ».
210 \fBheaders\-to\-add\fP
211 En\-têtes à ajouter aux courriels envoyés à la liste. Ceux\-ci sont copiés aux
212 débuts des en\-têtes existants exactement tels qu'ils sont dans ce fichier,
213 après que les en\-têtes de la liste (comme «\ List\-ID\ ») ont été ajoutés et
214 que ceux mentionnés dans \fBheaders\-to\-remove\fP ont été retirés.
216 \fBheaders\-to\-remove\fP
217 En\-têtes à retirer des messages envoyés à la liste.
219 \fBmoderation\-box\fP
220 Messages en attente d'approbation du modérateur.
222 \fBsubscription\-box\fP
223 Requêtes d'abonnement et de désabonnement en attente de confirmation de la
224 part de l'utilisateur.
227 Répertoires qui contiennent les modèles spécifiques à une liste
228 (optionnel). Les modèles seront recherchés d'abord dans ce répertoire, s'il
229 existe, puis dans les répertoires du système. Un fichier vide signifie que
230 le message correspondant ne doit pas être envoyé. Cela peut être utilisé par
231 exemple pour activer uniquement pour certaines listes les messages du type
232 «\ veuillez attendre la modération de votre message\ ».
235 Répertoires contenant des grephons, à savoir des fichiers source en Python
236 qui sont chargés automatiquement par EoC au démarrage. Ces grephons peuvent
237 modifier le comportement d'EoC.
239 Le fichier \fBconfig\fP possède un format de type \fImot\-clé\fP=\fIvaleur\fP\ :
244 owners = liw@liw.iki.fi
248 mail\-on\-subscription\-changes = yes
249 mail\-on\-forced\-unsubscribe = yes
254 Les mots clés \fBarchived\fP, \fBposting\fP, et \fBsubscription\fP correspondent aux
255 options qui portent les mêmes noms. Les autres mots\-clés sont\ :
258 Liste des adresses des propriétaires, définie avec l'option \fI\-\-owner\fP.
261 Liste des adresses des modérateurs, définie avec l'option \fI\-\-moderator\fP.
263 \fBmail\-on\-subscription\-changes\fP
264 Valeur définissant si les propriétaires doivent être avertis lorsqu'un
265 utilisateur s'abonne ou se désabonne.
267 \fBmail\-on\-forced\-unsubscribe\fP
268 Valeur définissant si les propriétaires doivent être avertis si quelqu'un
269 est retiré d'une liste suite à une adresse trop souvent invalide.
272 Valeur définissant si les messages de retour sont ignorés sur la
273 liste. Utilisé par exemple lorsque la liste devrait avoir un nombre stable
277 Suffixe pour les modèles, pour permettre la gestion de plusieurs
278 langues. (Si \fIlanguage\fP est défini à «\ fr\ », alors le modèle «\ foo\ »
279 est d'abord recherché en tant que modèle «\ foo.fr\ ».)
281 \fBpristine\-headers\fP
282 Valeur définissant si les en\-têtes doivent être encodés au format MIME. Si
283 la valeur vaut «\ yes\ », l'encodage aura lieu.
285 Créer une liste nommée \fImoviefans@example.com\fP, dont le propriétaire est
286 \fIding@example.com\fP (tout sur la même ligne)\ :
290 enemies\-of\-carlotta \-\-name=moviefans@example.com
291 \-\-owner=ding@example.com \-\-create
295 Le système de messagerie doit être configuré pour que ces messages arrivent
296 sur la liste (et à ses adresses de commande). Pour Qmail et Postfix, voir
299 Afficher la liste de tous les abonnés à cette liste\ :
303 enemies\-of\-carlotta \-\-name=moviefans@example.com \-\-list
307 Les personnes voulant s'abonner à la liste doivent envoyer un courriel à
311 moviefans\-subscribe@example.com
315 Avec Qmail, pour faire en sorte que les courriels entrants soient traités
316 par Enemies of Carlotta, quelques fichiers \fI.qmail\-extension\fP sont
317 nécessaires pour chaque liste. Par exemple, si joe est un nom
318 d'utilisateur, pour initialiser la liste de diffusion joe\-fans, deux
319 fichiers doivent être créés\ : \fI.qmail\-fans\fP et \fI.qmail\-fans\-default\fP, qui
323 |enemies\-of\-carlotta \-\-incoming
326 Si les messages à destination d'un domaine virtuel, example.com, délivrés
327 via \fI/var/qmail/control/virtualdomains\fP à \fIjoe\-exampledotcom\fP, les
328 fichiers seront nommés \fI.qmail\-exampledotcom\-fans\fP et
329 \&\fI.qmail\-exampledotcom\-fans\-default\fP et contiendront
332 |enemies\-of\-carlotta \-\-incoming \-\-skip\-prefix=joe\-exampledotcom\-
335 (tout sur la même ligne).
337 Avec Postfix, un fichier \fI.forward\fP contenant
343 sera nécessaire, ainsi qu'un fichier \fI.procmailrc\fP contenant
348 * ? enemies\-of\-carlotta \-\-name=$RECIPIENT \-\-is\-list
350 | enemies\-of\-carlotta \-\-incoming
353 Pour utiliser Enemies of Carlotta avec un domaine virtuel Postfix, une
354 \fIcarte virtuelle d'expressions rationnelles\fP généralement appelée
355 \fI/etc/postfix/virtual_regexp\fP devra être créée (pour l'activer, ajouter
356 \fIvirtual_maps = regexp:/etc/postfix/virtual_regexp\fP dans le fichier
357 \fI/etc/postfix/main.cf\fP). Le fichier d'expressions rationnelles doit faire
358 des choses horribles pour conserver l'adresse de destination. Il faut donc
362 /^your.virtual.domain$/ dummy
364 /^(yourlist|yourlist\-.*)@(your.virtual.domain)$/ joe+virtual\-$1
367 Soit deux lignes. Si \fIrecipient_delimiter\fP pour Postfix est configuré avec
368 un moins au lieu d'un plus, utiliser \fBjoe\-virtual\fP. Ensuite dans le fichier
369 \&\fI.procmailrc\fP, ajouter les options \fI\-\-skip\-prefix=joe\-virtual\-\fP et
370 \fI\-\-domain=your.virtual.domain\fP pour les deux appels à
371 \fBenemies\-of\-carlotta\fP.
373 Ces manipulations restent complexes.
374 .SH "COMMANDES PAR MESSAGE"
375 Les utilisateurs et propriétaires utilisent Enemies of Carlotta par courriel
376 en utilisant des adresses de commande comme
377 \fBfoo\-subscribe@example.com\fP. Voici une liste de toutes les adresses de
378 commande accessibles aux utilisateurs et propriétaires. Dans tous ces
379 exemples, le nom de la liste de diffusion sera \fBfoo@example.com\fP.
380 .SS "Commandes par message accessibles à tout le monde"
381 Ces commandes peuvent servir à tout le monde et ne demandent aucun privilège
384 \fBfoo@example.com\fP
385 Envoie un courriel à tous les abonnés. Le message peut avoir à être approuvé
386 d'abord par les modérateurs de la liste, qui ont aussi le pouvoir de le
389 \fBfoo\-owner@example.com\fP
390 Envoie un courriel au(x) propriétaire(s) de la liste.
392 \fBfoo\-help@example.com\fP
393 Retourne en réponse à ce courriel un message contenant l'aide de la liste.
395 \fBfoo\-subscribe@example.com\fP
396 Inscrit l'auteur du courriel à la liste. Le gestionnaire de listes répondra
397 en demandant une confirmation. L'inscription n'aura lieu qu'en cas de
398 réponse à cette demande. De cette manière, les personnes malveillantes ne
399 peuvent ajouter votre adresse sur une ou beaucoup de listes de diffusion.
401 \fBfoo\-subscribe\-joe=example.com@example.com\fP
402 Inscrit joe@example.com à la liste. Pour inscrire une adresse différente de
403 celle utilisée pour la demande d'abonnement, utiliser cette forme. La
404 demande de confirmation sera envoyée à joe@example.com puisque cette adresse
405 seulement sera abonnée à la liste.
407 \fBfoo\-unsubscribe@example.com\fP
408 Désinscrit l'auteur du courriel de la liste. Encore une fois, une demande de
409 confirmation sera envoyée pour éviter que des personnes malveillantes
410 désinscrivent d'autres personnes.
412 \fBfoo\-unsubscribe\-joe=example.com@example.com\fP
413 Désinscrit joe@example.com de la liste. Encore une fois, cette dernière
414 adresse recevra la demande de confirmation.
415 .SS "Commandes par message pour les propriétaires de la liste."
416 Les commandes suivantes peuvent être utilisées pour administrer la liste.
418 \fBfoo\-subscribe\-joe=example.com@example.com\fP
419 Si un propriétaire envoie un courriel de ce type, il recevra la demande de
420 confirmation à la place de joe@example.com. Il est souvent préférable de
421 laisser les gens s'inscrire eux\-mêmes, mais parfois cela peut être utile que
422 le propriétaire s'en occupe.
424 \fBfoo\-unsubscribe\-joe=example.com@example.com\fP
425 Les propriétaires peuvent également désinscrire d'autres personnes.
427 \fBfoo\-list@example.com\fP
428 Retourne la liste des abonnés à la liste. Cela ne marche que si l'adresse de
429 l'expéditeur est celle de l'un des propriétaires. L'adresse de l'expéditeur
430 est celle utilisée au niveau SMTP et non celle dans l'en\-tête From:.
432 \fBfoo\-setlist@example.com\fP
433 Permet à un propriétaire de configurer la liste des abonnés en un seul
434 coup. Cela correspond à une suite de commandes \-subscribe et \-unsubscribe,
435 mais en plus simple. Tous ceux qui seront ajoutés à la liste recevront un
436 message de bienvenue, alors que ceux qui seront retirés recevront un message
439 \fBfoo\-setlistsilently@example.com\fP
440 Commande similaire à \-setlist, sans les envois des messages de bienvenue et
443 Enemies of Carlotta accepte des grephons. Des connaissances en Python sont
444 nécessaires pour comprendre cette section.
446 Un grephon est un module Python (un fichier avec un suffixe \fB.py\fP), placé
447 dans le répertoire \fB~/.enemies\-of\-carlotta/plugins\fP. Les grephons sont
448 chargés automatiquement au démarrage, si la version déclarée de l'interface
449 correspond à celle utilisée par Enemies of Carlotta. La version de
450 l'interface est déclarée par la variable globale \fBPLUGIN_INTERFACE_VERSION\fP
453 Les grephons peuvent définir des fonctions d'ancrage appelées au bon endroit
454 dans le code d'EoC. Pour le moment, la seule fonction d'ancrage est
455 \fBsend_mail_to_subscribers_hook\fP, qui peut modifier un courriel avant qu'il
456 ne soit envoyé aux abonnés. La fonction devrait ressembler à\ :
459 def send_mail_to_subscribers_hook(list, text):
461 L'argument \fIlist\fP est une référence à l'objet \fIMailingList\fP qui correspond
462 à la liste concernée, et \fItext\fP est le texte complet du courriel tel qu'il
463 existe actuellement. La fonction devrait retourner le nouveau contenu de ce
467 \fI~/.enemies\-of\-carlotta\fP
468 Ensemble des fichiers en rapport avec les listes de diffusion.
470 \fI~/.enemies\-of\-carlotta/secret\fP
471 Mots de passe secrets utilisés pour générer des adresses signées pour le
472 contrôle des messages de retour et la validation des abonnements.
474 \fI~/.enemies\-of\-carlotta/foo@example.com\fP
475 Répertoire contenant les données appartenant à la liste de diffusion
476 foo@example.com. À l'exception du fichier de \fIconfig\fP qui se trouve dans
477 ce répertoire, rien ne devrait être à modifier.
479 \fI~/.enemies\-of\-carlotta/foo@example.com/config\fP
480 Fichier de configuration pour la liste de diffusion. Ce fichier devra être
481 édité pour modifier les options de modération ou les propriétaires de la
484 Page web d'\fI«\ Enemies of Carlotta\ »\fP\ : \fIhttp://www.iki.fi/liw/eoc/\fP.
486 Pierre Machard <pmachard@tuxfamily.org>, 2003
488 Thomas Huriaux <thomas.huriaux@gmail.com>, 2005