flnews_post_proc 1.75 → 1.80

data/doc/fr/rst/flnews_post_proc.rst

@@ -1,28 +1,30 @@
+=======================
 flnews_post_proc
 =======================
+
+.. |program| replace:: **flnews_post_proc**
+
 ------------------------------------------
 Post-Traitement pour flnews
 ------------------------------------------
 
 SYNOPSIS
 =======================
-
 Un article est envoyé au logiciel de post-traitement via STDIN. Cela se fait
 automatiquement lorsque la variable « post_proc » dans le fichier de
-configuration de flnews est définie sur *flnews_post_proc*.
+`configuration`_ de flnews est définie sur |program|.
 
 Si un article a été sauvegardé dans un fichier, il peut servir pour tester le
-fonctionnement de flnews_post_proc, en lançant une commande comme :
+fonctionnement de |program|, en lançant une commande comme :
 
-    **flnews_post_proc < article.txt**
+    |program| < article.txt
 
 ou si vous préférez l'équivalent :
 
-    **cat article.txt | flnews_post_proc**
+    cat article.txt | |program|
 
 DESCRIPTION
 =======================
-
 Le lecteur de news **flnews** est suffisant pour l'accès au Usenet, c'est-à-dire
 pour lire les articles et pour les rédiger et les envoyer aux newsgroups
 de votre choix.
@@ -33,14 +35,13 @@ vous permet de modifier son fonctionnement et de manipuler directement les artic
 qu'il génère, juste avant qu'ils ne soient envoyés au serveur NNTP.
 
 Ce post-traitement peut servir à ajouter et à modifier des détails du message
-d'une manière qui n'est actuellement pas possible avec seulement flnews. Comme
-le logiciel est configurable, il peut probablement répondre aux besoins de
-quelques utilisateurs du Usenet. Quand même, vous devez le comprendre comme un
+d'une manière qui n'est actuellement pas possible avec seulement flnews. Le
+logiciel est configurable et peut probablement répondre aux besoins de quelques
+utilisateurs du Usenet. Quand même, vous devez le comprendre comme un
 exemple pour ce qui est possible et pour inspiration, afin de créer vos propres
 solutions.
 
------------------------------------------------------------------------------
-Les limites d'un lecteur basique de news – ce qui peut faire flnews_post_proc
+Les limites d'un lecteur basique de news – ce qui peut faire |program|
 -----------------------------------------------------------------------------
 
 Bien que les articles créés avec flnews soient complets et prêts pour l'envoi,
@@ -60,10 +61,10 @@ des raisons parfois arbitraires :
   la remplacer contre une autre, selon le groupe dans lequel vous êtes en train
   de poster.
 
-  flnews_post_proc peut faire exactement ça, quand vous avez configuré quel
+  |program| peut faire exactement ça, quand vous avez configuré quel
   signature doit apparaître dans quel newsgroup ou liste de newsgroups. Le
   logiciel peut même choisir par hasard une signature, si un fichier, qui en
-  contient plusieurs, est noté dans la configuration.
+  contient plusieurs, est noté dans la `configuration`_.
 
 * Quelques entêtes supplémentaires peuvent servir à transmettre des informations
   aux lecteurs intéressés, comme l'ID de votre clé GnuPG, vos connaissances en
@@ -71,7 +72,7 @@ des raisons parfois arbitraires :
   êtes libres. Je veux mentionner « face » et « x-face » mais préfère que vous
   ne vous en souveniez pas.
 
-  Ces entêtes, – Custom-Headers – peuvent être définis dans la configuration
+  Ces entêtes, – Custom-Headers – peuvent être définis dans la `configuration`_
   du logiciel et vont être utilisés dans chaque article sortant.
 
 * Les entêtes « Archive » et « X-No-Archive » sont parfois utilisés afin
@@ -80,7 +81,7 @@ des raisons parfois arbitraires :
   les groupes de test, par exemple, ne valent probablement pas qu'on les trouve
   parmi les résultats des recherches.
 
-  Avec flnews_post_proc vous pouvez décider et imposer que vos articles dans
+  Avec |program| vous pouvez décider et imposer que vos articles dans
   certains newsgroups contiendront d'office les deux entêtes **Archive: no** et
   **X-No-Archive: Yes**.
 
@@ -96,25 +97,25 @@ des raisons parfois arbitraires :
   seulement des références – et les transformer en notes en bas de page. Vous
   pouvez imaginer ça comme le fonctionnement de la balise <ref/> de Wikipedia,
   mais vous pouvez définir votre propre séparateur pour marquer les fragments
-  de texte dans le fichier de configuration.
+  de texte dans le fichier de `configuration`_.
 
   Exemple (avec séparateur **%=** ) :
   « Ceci est un objet %=et ceci devient la note en bas de page, qui décrit
   l'objet plus précisément=% »
 
 Dialogue pour désactiver des options
-------------------------------------
+---------------------------------------
 ATTN! Depuis la version 1.72, YAD et Zenity ne sont plus utilisés pour le
 dialogue. 
 
-Juste avant d'entrer en action, flnews_post_proc peut afficher un dialogue, qui
+Juste avant d'entrer en action, |program| peut afficher un dialogue, qui
 vous laisse **désactiver** des options fixées dans la configuration. Sous
 condition que Whiptail ou seulement xterm soit disponible, vous pouvez choisir
 dans les options suivantes, ceux que vous voulez ignorer pour l'article en
 préparation. 
 Vous **ne pouvez pas** activer des options qui n'ont pas été activées au préalable :
 
-* Signatures, comme définies dans la configuration **peuvent être ignorées**.
+* Signatures, comme définies dans la `configuration`_ **peuvent être ignorées**.
   Soit une signature par défaut sera appliquée, si prévue, ou aucune.
 
 * Entêtes supplémentaires, si définis, peuvent rester absentes de l'article.
@@ -141,7 +142,7 @@ par défaut sera écrite dans */home/[utilisateur]/.flnews_post_proc.conf*.
 C'est ce fichier qui sera désormais utilisé. Si vous l'effacez, il sera recréé à la
 prochaine occasion, mais vos modifications seront perdues.
 
-Le fichier de configuration est en format YAML et plein d'explications. Les
+Le fichier de `configuration`_ est en format YAML et plein d'explications. Les
 variables définies dans ce fichier peuvent être classées en deux catégories :
 
 * Variables qui décrivent des valeurs déterminées par flnews. Elles peuvent être
@@ -151,200 +152,232 @@ variables définies dans ce fichier peuvent être classées en deux catégories
 * Variables qui définissent du nouveau contenu ou des changements dans le
   contenu.
 
-**FUP_NAME**
- Une « expression régulière » (« regular expression ») décrivant la chaîne de
- caractères contenant le nom de l'auteur d'un article précédent, que l'on souhaite
- citer en partie. Cet élément est reconnu dans l'article d'origine et peut
- être utilisé à la place de l'élément correspondant dans *GROUP_INTRO* (voir
- plus bas). Le format de l'expression est celui de la classe Regexp dans Ruby.
- Veillez à masquer le backslash '\\' avec un autre, comme dans l'exemple. Un
- « capture group » '()' sert à extraire le nom du résultat de la comparaison.
+Options de configuration
+------------------------
 
- Laissez ce champ vide afin de maintenir le comportement configuré pour flnews.
+.. Les lignes vides dans les descriptions des options sont en réalité '\ `.
 
- CONTENU    : L'équivalent d'une regular expression en chaîne de caractères.
+.. _fup_name:
 
- PAR DÉFAUT : Vide
+**FUP_NAME**
+        
+    Une « expression régulière » (« regular expression ») décrivant la chaîne
+    de caractères contenant le nom de l'auteur d'un article précédent, que l'on
+    souhaite citer en partie. Cet élément est reconnu dans l'article d'origine
+    et peut être utilisé à la place de l'élément correspondant dans
+    `GROUP_INTROS`_ (voir plus bas). Le format de l'expression est celui de la
+    classe Regexp dans Ruby.  Veillez à masquer le backslash '\\' avec un
+    autre, comme dans l'exemple. Un « capture group » '()' sert à extraire le
+    nom du résultat de la comparaison.
+ 
+    Laissez ce champ vide afin de maintenir le comportement configuré pour
+    flnews.
+ 
+    CONTENU    : L'équivalent d'une regular expression en chaîne de caractères.
 
- EXEMPLE 1  : "On \\\\d+.\\\\d+.\\\\d{2,4} at \\\\d+:\\\\d+ **(.*)** wrote:"
+    PAR DÉFAUT : Vide
+
+    EXEMPLE 1  : "On \\\\d+.\\\\d+.\\\\d{2,4} at \\\\d+:\\\\d+ **(.*)** wrote:"
  
- EXEMPLE 2  : "**(.*)** wrote:"
+    EXEMPLE 2  : "**(.*)** wrote:"
+
+.. _fup_group:
 
 **FUP_GROUP**
- Une « expression régulière » (« regular expression ») décrivant la chaîne de
- caractères qui contient le newsgroup où a été publié l'article précédent à qui nous
- faisons référence dans un « followup ».
 
- Laissez ce champ vide afin d'ignorer le groupe précis.
+    Une « expression régulière » (« regular expression ») décrivant la chaîne
+    de caractères qui contient le newsgroup où a été publié l'article précédent
+    à qui nous faisons référence dans un « followup ».
 
- CONTENU    : L'équivalent d'une regular expression en chaîne de caractères.
+    Laissez ce champ vide afin d'ignorer le groupe précis.
 
- PAR DÉFAUT : Vide
+    CONTENU    : L'équivalent d'une regular expression en chaîne de caractères.
 
- EXEMPLE    : "wrote in **(.*)**:"
+    PAR DÉFAUT : Vide
+
+    EXEMPLE    : "wrote in **(.*)**:"
+
+.. _group_intros:
 
 **GROUP_INTROS**
- Des introductions qui font référence à l'auteur de l'article précédent que
- nous souhaitons citer. Si vous avez trouvé le newsgroup où l'article a été
- publié (voir : FUP_GROUP, ci-dessus), et le nom de son auteur
- (FUP_NAME), vous pouvez utiliser ces valeurs ici.
 
- Jusqu'à prochaine ordre, seulement %fup_name% et %fup_group% sont reproduits
- dans l'introduction résultante.
+    Des introductions qui font référence à l'auteur de l'article précédent que
+    nous souhaitons citer. Si vous avez trouvé le newsgroup où l'article a été
+    publié (voir : `FUP_GROUP`_, ci-dessus), et le nom de son auteur
+    (`FUP_NAME`_), vous pouvez utiliser ces valeurs ici.
+
+    Jusqu'à prochaine ordre, seulement %fup_name% et %fup_group% sont
+    reproduits dans l'introduction résultante.
 
- | CONTENU    : Un newsgroup ou regexp par ligne, suivi de deux points, un espace et
- |              une chaîne de caractères.
+    CONTENU : Un newsgroup ou regexp par ligne, suivi de deux points, un espace et une chaîne de caractères.
 
- PAR DÉFAUT : Comme configuré dans flnews.
+    PAR DÉFAUT : Comme configuré dans flnews.
  
- | EXEMPLE (un groupe et une hiérarchie) : 
- |   alt.test: "Thus spoke %fup_name%:"
- |   fr.soc:  "%fup_name% dans %fup_group% écrit:"
+    EXEMPLE (un groupe et une hiérarchie) ::
+
+     alt.test: "Thus spoke %fup_name%:"
+     fr.soc:  "%fup_name% dans %fup_group% écrit:"
 
 **GROUP_SIGS**
- Une signature par newsgroup ou expression ou le chemin d'accès d'un fichier,
- contenant plusieurs signatures, séparé par une ligne vide. Vous pouvez inclure
- (“source”) le contenu d'autres fichiers dans la liste des signatures, en
- indiquant dans le fichier d'origine le nom de l'autre fichier après un point
- et un espace, comme dans: 
- . /home/user/.plus_de_signatures
- Ceci ne fonctionne que dans le fichier indiqué dans la configuration, pas dans
- les fichiers inclus. Prenez soin d'insérer une ligne vide entre chaque ligne
- qui inclut un fichier et la suivante.
 
- | CONTENU : un newsgroup ou expression par ligne, suivi de deux poins, un espace
- | et une chaîne de caractères.
+    Une signature par newsgroup ou expression ou le chemin d'accès d'un
+    fichier, contenant plusieurs signatures, séparé par une ligne vide. Vous
+    pouvez inclure (“source”) le contenu d'autres fichiers dans la liste des
+    signatures, en indiquant dans le fichier d'origine le nom de l'autre
+    fichier après un point et un espace, comme dans: 
+    \ \ */home/user/.plus_de_signatures* Ceci ne fonctionne que dans le fichier
+    indiqué dans la configuration, pas dans les fichiers inclus. Prenez soin
+    d'insérer une ligne vide entre chaque ligne qui inclut un fichier et la
+    suivante.
+
+    CONTENU : un newsgroup ou expression par ligne, suivi de deux poins, un
+    \ \ \ \ \ espace et une chaîne de caractères.
 
- PAR DÉFAUT : Comme configuré dans flnews.
+    PAR DÉFAUT : Comme configuré dans flnews.
 
- | EXEMPLE : fr.test: "Signature pour alt.test\\r\\nseconde ligne"
+    EXEMPLE ::
 
- | EXEMPLE : alt.fr.test: /home/[utilisateur]/.signatures
+     fr.test: "Signature pour alt.test\\r\\nseconde ligne"
+     alt.fr.test: /home/[utilisateur]/.signatures
 
 **CUSTOM_HEADERS**
- Entêtes supplémentaires pour l'article sortant.
 
- CONTENU : 1 ligne par entête : un trait d'union, un espace, puis une chaîne de
- caractères comprenant le nom de l'entête, puis deux points et la valeur de
- l'entête.
+    Entêtes supplémentaires pour l'article sortant.
+
+    CONTENU : 1 ligne par entête : un trait d'union, un espace, puis une chaîne
+    de caractères comprenant le nom de l'entête, puis deux points et la valeur
+    de l'entête.
+
+    PAR DÉFAUT : Vide ( pas défini )
 
- PAR DÉFAUT : Vide ( pas défini )
+    EXEMPLE (2 entêtes)::   
 
- | EXEMPLE ( 2 entêtes ) : 
- |    - 'X-My-Header: nothing fancy'
- |    - 'X-Another-Header: care not!' 
+        - 'X-My-Header: nothing fancy'
+        - 'X-Another-Header: care not!' 
 
 **NO_ARCHIVE_GROUPS**
- Les newsgroups, où les entêtes « Archive: no » et « X-No-Archive: yes »
- doivent être présents.
 
- CONTENU : Un trait d'union et un espace, puis une chaîne de caractères,
- contenant le nom du groupe ou une expression.
+    Les newsgroups, où les entêtes « Archive: no » et « X-No-Archive: yes »
+    doivent être présents.
 
- PAR DÉFAUT : Vide
+    CONTENU : Un trait d'union et un espace, puis une chaîne de caractères,
+    contenant le nom du groupe ou une expression.
 
- | EXEMPLE ( 1 groupe, 1 hiérarchie ) : 
- |     - "alt.test"
- |     - "^news.*"
+    PAR DÉFAUT : Vide
+
+    EXEMPLE ( 1 groupe, 1 hiérarchie ) ::
+
+     - "alt.test"
+     - "^news.*"
 
 **DEBUG_LOG**
- Le nom d'un fichier, qui va servir comme protocol. Si le nom d'un fichier
- valide est donné, le protocol est activé. Laissez vide pour désactiver le
- protocol.
 
- | CONTENU : Le nom d'un fichier dont les droits permettent l'écriture.
- |    Il sera créé s'il n'existe pas encore et remplacé à chaque exécution 
- |    du logiciel.
+    Le nom d'un fichier, qui va servir comme protocol. Si le nom d'un fichier
+    valide est donné, le protocol est activé. Laissez vide pour désactiver le
+    protocol.
 
- PAR DÉFAUT : Vide
+    CONTENU : Le nom d'un fichier dont les droits permettent l'écriture.
+    Il sera créé s'il n'existe pas encore et remplacé à chaque exécution 
+    du logiciel.
 
- EXEMPLE : '/tmp/a_log-file.txt'
+    PAR DÉFAUT : Vide
+
+    EXEMPLE : '/tmp/a_log-file.txt'
 
 **LOG LEVEL**
- Un de debug, fatal, error, info, warn
 
- | EXEMPLE : 
- |    LOG_LEVEL: 'debug'
+    Un de debug, fatal, error, info, warn
+
+    EXEMPLE ::
+
+       LOG_LEVEL: 'debug'
 
 **REFERENCES_SEPARATOR**
- Un symbole ou une séquence de symboles qui marquent la fin du corps du message
- et le début d'une liste de « références » ou « notes de pied de page ». Il
- apparaîtra seulement, si  le message contient du text marqué pour servir comme
- note de pied de page.  À voir *REFERENCES_DELIMITER* ci-dessous.
 
- Si l'option n'est pas défini ou vide, la liste suit à la dernière ligne du
- corps du message, sans séparation supplémentaire. 
+    Un symbole ou une séquence de symboles qui marquent la fin du corps du
+    message et le début d'une liste de « références » ou « notes de pied de
+    page ». Il apparaîtra seulement, si  le message contient du text marqué
+    pour servir comme note de pied de page.  À voir *REFERENCES_DELIMITER*
+    ci-dessous.
+
+    Si l'option n'est pas défini ou vide, la liste suit à la dernière ligne du
+    corps du message, sans séparation supplémentaire. 
 
- CONTENU    : Un symbol ou séquence de symboles entre guillemets " " ou ' '.
+    CONTENU    : Un symbol ou séquence de symboles entre guillemets " " ou ' '.
 
- PAR DÉFAUT : Vide
+    PAR DÉFAUT : Vide
 
- EXEMPLE    : '---------'
+    EXEMPLE    : '---------'
 
 **REFERENCES_DELIMITER**
- Une séquence d'au moins deux symboles qui marque le début  d'un text qui sera
- transformé en note de pied de page ( ou référence ). La **séquence inversée**
- doit marquer la fin du même fragment de text. La présence de cette séquence
- dans le message d'origine, a comme conséquence que le text marqué sera déplacé
- vers la fin, au-dessous du corps du message.
- Si *REFERENCES_SEPARATOR* ( option ci-dessus ) est défini, il va séparer le message
- de la liste des notes du pied de page.  
 
- Laissez ce champs vide pour éviter la création des noted du pied de page.
+    Une séquence d'au moins deux symboles qui marque le début  d'un text qui
+    sera transformé en note de pied de page ( ou référence ). La **séquence
+    inversée** doit marquer la fin du même fragment de text. La présence de
+    cette séquence dans le message d'origine, a comme conséquence que le text
+    marqué sera déplacé vers la fin, au-dessous du corps du message.  Si
+    *REFERENCES_SEPARATOR* ( option ci-dessus ) est défini, il va séparer le
+    message de la liste des notes du pied de page.  
 
- CONTENU : Une séquence de symboles entre guillemets ( '' )
+    Laissez ce champs vide pour éviter la création des noted du pied de page.
 
- PAR DÉFAUT : Vide
+    CONTENU : Une séquence de symboles entre guillemets ( '' )
 
- EXEMPLE: '%?'
+    PAR DÉFAUT : Vide
+
+    EXEMPLE: '%?'
 
 **REFERENCE_FORMAT**
- Une chaîne de formatage, contenant %s pour représenter une nombre, qui
- remplace le texte d'une future note du pied de page dans le corps du message.
 
- PAR DÉFAUT : " %s)" -> devient 1) ... 2) ... 3)
+    Une chaîne de formatage, contenant %s pour représenter une nombre, qui
+    remplace le texte d'une future note du pied de page dans le corps du
+    message.
+
+    PAR DÉFAUT : " %s)" -> devient 1) ... 2) ... 3)
 
- EXEMPLE : "(%s)" -> devient (1) ... (2) ... (3)
+    EXEMPLE : "(%s)" -> devient (1) ... (2) ... (3)
 
 **VFY_URLS**
- Une constante booléen. Elle détermine si le programme doit essayer de corriger
- des URLs. Même si les URLs sont identifiables, seulement quelques manipulations
- sont tentées :
 
- * '<' et '>' sont ajoutés, si manquants
- * Des slashes sont insérés, s'ils manquent après "http(s):"
+    Une constante booléen. Elle détermine si le programme doit essayer de
+    corriger des URLs. Même si les URLs sont identifiables, seulement quelques
+    manipulations sont tentées :
 
- ATTN! Le programme ne peut pas différencier entre "mailto:" et "news:". Si ni l'un
- ni l'autre est donné, mais '@' est présent, "news:" est ajouté automatiquement.
+    * '<' et '>' sont ajoutés, si manquants
+    * Des slashes sont insérés, s'ils manquent après "http(s):"
 
- Si la variable n'est pas défini, la valeur 'yes' est présumée.
+    ATTN! Le programme ne peut pas différencier entre "mailto:" et "news:". Si
+    ni l'un ni l'autre est donné, mais '@' est présent, "news:" est ajouté
+    automatiquement.
 
- CONTENU: Un de YES, yes, NO, no, et autres telles variations 
+    Si la variable n'est pas défini, la valeur 'yes' est présumée.
 
- PAR DÉFAUT: yes
+    CONTENU: Un de YES, yes, NO, no, et autres telles variations 
 
- EXEMPLE: No
+    PAR DÉFAUT: yes
+
+    EXEMPLE: No
 
 **OVERRIDE_CONFIG**
- Une constante booléenne. Vous pouvez décider d'ignorer les options suivantes
- avant qu'un article est posté : GROUP_SIGS, XNAY_GROUPS, CUSTOM_HEADERS,
- VFY_URLS et DEBUG_LOG.  Un dialogue peut être affiché, qui permet la
- désactivation de chacune de ces options. Les valeurs par défaut, définis pour
- flnews, vont donc prévaloir.
 
- ATTN ! En poussant Esc ou le bouton « Annuler » du dialogue, vous interrompez 
- le programme et flnews ne va rien envoyer.
+    Une constante booléenne. Vous pouvez décider d'ignorer les options
+    suivantes avant qu'un article est posté : GROUP_SIGS, XNAY_GROUPS,
+    CUSTOM_HEADERS, VFY_URLS et DEBUG_LOG.  Un dialogue peut être affiché, qui
+    permet la désactivation de chacune de ces options. Les valeurs par défaut,
+    définis pour flnews, vont donc prévaloir.
+
+    ATTN ! En poussant Esc ou le bouton « Annuler » du dialogue, vous
+    interrompez le programme et flnews ne va rien envoyer.
 
- Notez la valeur 'no', 'NO' ou pareil pour désactiver le dialogue.
+    Notez la valeur 'no', 'NO' ou pareil pour désactiver le dialogue.
 
- PAR DÉFAUT : yes
+    PAR DÉFAUT : yes
 
- EXEMPLE: No
+    EXEMPLE: No
 
 Autres Informations
 ===================
 
-------
 Tester
 ------
 L'effet qu'aura l'exécution du programme peut être vérifié de deux manières :
@@ -356,7 +389,7 @@ L'effet qu'aura l'exécution du programme peut être vérifié de deux manières
    Ceci va vous présenter la nouvelle version de l'article sur l'écran, mais 
    vous pouvez aussi diriger le résultat dans un autre fichier. C'est une 
    excellente technique pour tester un logiciel pendant le développement ou
-   votre configuration avant que vous vous en serviez.
+   votre `configuration`_ avant que vous vous en serviez.
 
 2. En envoyant un message directement dans un groupe de test ( comme alt.test,
    fr.test ou similaires ). 
@@ -365,7 +398,7 @@ L'effet qu'aura l'exécution du programme peut être vérifié de deux manières
 
 Code source
 -----------
-Le  fichier flnews_post_proc.gem, que vous recevez à l'aide de l'outil *gem* ou
+Le  fichier |program|.gem, que vous recevez à l'aide de l'outil *gem* ou
 directement du site *rubygems.org*, contient tout le code source du logiciel et
 de la documentation ( cette page notamment ). Pour lire le code du logiciel,
 vous devez 
@@ -379,13 +412,13 @@ vous devez
 
 License
 -------
-flnews_post_proc est distribué sous les conditions de la WTFPL-2.0 ou plus
+|program| est distribué sous les conditions de la WTFPL-2.0 ou plus
 récent ( À voir http://www.wtfpl.net/txt/copying/ ou license-text dans le
 répertoire « doc » de la gem ).
 
 Auteur
 ------
-| flnews_post_proc a été développé par 
+| |program| a été développé par 
 | Michael Uplawski <michael.uplawski@uplawski.eu>
 
 Ω