PageRenderTime 58ms CodeModel.GetById 32ms app.highlight 18ms RepoModel.GetById 1ms app.codeStats 1ms

/doc/French/manpage-fr.html

http://txt2tags.googlecode.com/
HTML | 475 lines | 419 code | 54 blank | 2 comment | 0 complexity | ea3e2a0b6732404a4ccaa92cde87edfd MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2<HTML>
  3<HEAD>
  4<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>
  5<META NAME="generator" CONTENT="http://txt2tags.org">
  6<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
  7<TITLE>TXT2TAGS</TITLE>
  8</HEAD><BODY BGCOLOR="white" TEXT="black">
  9<CENTER>
 10<H1>TXT2TAGS</H1>
 11<FONT SIZE="4">Aug, 2010</FONT>
 12</CENTER>
 13
 14<P></P>
 15<HR NOSHADE SIZE=1>
 16<P></P>
 17
 18  <UL>
 19  <LI><A HREF="#nom">NOM</A>
 20  <LI><A HREF="#synopsis">SYNOPSIS</A>
 21  <LI><A HREF="#description">DESCRIPTION</A>
 22  <LI><A HREF="#balises">BALISES</A>
 23  <LI><A HREF="#options">OPTIONS</A>
 24  <LI><A HREF="#source">FICHIERS SOURCE</A>
 25  <LI><A HREF="#configurations">CONFIGURATIONS</A>
 26  <LI><A HREF="#commandes">COMMANDES</A>
 27  <LI><A HREF="#macros">MACROS</A>
 28  <LI><A HREF="#exemples">EXEMPLES</A>
 29  <LI><A HREF="#fichiers">FICHIERS</A>
 30  <LI><A HREF="#environnement">ENVIRONNEMENT</A>
 31  <LI><A HREF="#auteur">AUTEUR</A>
 32  <LI><A HREF="#bogues">BOGUES</A>
 33  <LI><A HREF="#copyright">COPYRIGHT</A>
 34  </UL>
 35
 36<P></P>
 37<HR NOSHADE SIZE=1>
 38<P></P>
 39
 40<A NAME="nom"></A>
 41<H1>NOM</H1>
 42
 43<P>
 44txt2tags -  outil de conversion et de formatage de texte
 45</P>
 46
 47<A NAME="synopsis"></A>
 48<H1>SYNOPSIS</H1>
 49
 50<P>
 51<B>txt2tags</B> [<I>options</I>] [<I>FICHIER</I>...]
 52</P>
 53
 54<A NAME="description"></A>
 55<H1>DESCRIPTION</H1>
 56
 57<P>
 58<B>txt2tags</B> lit un fichier texte avec des balises minimales et peut le convertir en :
 59<I>ASCII Art</I>,
 60<I>AsciiDoc</I>,
 61<I>Creole</I>,
 62<I>DocBook</I>,
 63<I>DokuWiki</I>,
 64<I>Google Code Wiki</I>,
 65<I>HTML</I>,
 66<I>LaTeX</I>,
 67<I>Lout</I>,
 68<I>MagicPoint</I>,
 69<I>Man page</I>,
 70<I>MoinMoin</I>,
 71<I>PageMaker</I>,
 72<I>Plain Text</I>,
 73<I>PmWiki</I>,
 74<I>SGML</I>,
 75<I>Wikipedia</I> et
 76<I>XHTML</I>.
 77</P>
 78<P>
 79Cette page de man a été créée grâce à <B>txt2tags</B> depuis un simple fichier textuel. Le même fichier texte a été également converti en HTML pour la version en ligne de ce manuel.
 80</P>
 81<P>
 82UNE source, des sorties MULTIPLES - <A HREF="http://txt2tags.org">http://txt2tags.org</A>
 83</P>
 84
 85<A NAME="balises"></A>
 86<H1>BALISES</H1>
 87
 88<PRE>
 89  Entête               Les 3 premières lignes du fichier source
 90  Titre                = mots =
 91  Titre numéroté       + mots +
 92  Commentaires         % commentaires
 93  Ligne de séparation  -----------------------...
 94  Ligne plus épaisse   =======================...
 95  Image                [fichier.jpg]
 96  Liens                [label url]
 97  
 98  Gras                 **mots**
 99  Italique             //mots//
100  Souligné             __mots__
101  Barré                --mots--
102  Monospaced           ``mots``
103  Raw                  ""mots""
104  Tagged               ''mots''
105  
106  Paragraphe           mots
107  Citation             &lt;TAB&gt;mots
108  Liste                - mots
109  Liste numérotée      + mots
110  Liste de définitions : mots
111  Table                | cellule1 | cellule2 | cellule3...
112  
113  Ligne verbatim       ``` mots
114  Ligne raw            """ mots
115  Ligne tagged         ''' mots
116  
117  Bloc verbatim        ```
118                       lignes
119                       ```
120  Bloc raw             """
121                       lignes
122                       """
123  Bloc tagged          '''
124                       lignes
125                       '''
126</PRE>
127
128<A NAME="options"></A>
129<H1>OPTIONS</H1>
130
131<DL>
132<DT>    <B>--art-chars</B>=<I>MOTIF</I></DT><DD>
133Utilise le <I>MOTIF</I> pour définir les caractères du mode ASCII Art, respectivement pour les coins, les bordures, les côtés, les barres 1 et 2, les niveaux 2, niveaux 3, niveaux 4 et niveau 5. Le motif par défaut est +-|-==-^". Cette option est uniquement valable pour la cible ASCII Art.
134<P></P>
135<DT><B>-C</B>, <B>--config-file</B>=<I>FICHIER</I></DT><DD>
136Lit la configuration depuis le fichier extérieur <I>FICHIER</I>. La configuration doit être de la forme <I>%!mot-clé:valeur</I>. Se référer à la section <A HREF="#configurations">CONFIGURATIONS</A> pour plus de détails.
137<P></P>
138<DT>    <B>--css-sugar</B></DT><DD>
139Améliore l'utilisation de feuilles CSS par rapport au code HTML/XHTML généré. Les attributs éventuels des balises sont retirés, les balises de présentation sont évités, l'entête est composé de balises H1, H2 et H3, de nouveaux DIVs sont créés : <I>#header</I>, <I>#body</I>, <I>.toc</I>.
140<P></P>
141<DT>    <B>--css-inside</B></DT><DD>
142Insère le contenu du fichier CSS dans l'entête HTML/XHTML. Utilisez <CODE>--style</CODE> pour spécifier le fichier CSS à inclure.
143<P></P>
144<DT>    <B>--dump-config</B></DT><DD>
145Affiche toute la configuration trouvée et sort.
146<P></P>
147<DT>    <B>--dump-source</B></DT><DD>
148Affiche la source du document, avec toutes les inclusions (<CODE>%!include</CODE>) éventuelles.
149<P></P>
150<DT>    <B>--encoding</B>=<I>CODE</I></DT><DD>
151Définit l'encodage de la sortie utilisé par le document source vers <I>CODE</I>. Par exemple UTF-8, iso-8859-1, etc.
152<P></P>
153<DT>    <B>--gui</B></DT><DD>
154Appelle l'interface graphique Tk.
155<P></P>
156<DT><B>-h</B>, <B>--help</B></DT><DD>
157Affiche l'aide et sort.
158<P></P>
159<DT><B>-H</B>, <B>--no-headers</B></DT><DD>
160Supprime les entêtes, les titres et les pieds de page de la sortie. Seul le contenu (body) sera affiché.
161<P></P>
162<DT>    <B>--headers</B></DT><DD>
163Montre les entêtes, les titres et les pieds de page dans la sortie. ACTIVÉ par défaut.
164<P></P>
165<DT>    <B>--height</B>=<I>NOMBRE</I></DT><DD>
166Définit la hauteur de sortie à <I>NOMBRE</I> de lignes. Cette option est uniquement utilisée par la cible ASCI ART (-t art), en utilisant également l'option <CODE>--slides</CODE>.
167<P></P>
168<DT><B>-i</B>, <B>--infile</B>=<I>FICHIER</I></DT><DD>
169Définit <I>FICHIER</I> comme fichier d'entrée pour le document source. Utilisez '-' pour lire la source depuis STDIN.
170<P></P>
171<DT>    <B>--mask-email</B></DT><DD>
172Masque les courriels contre les robots spammeurs. Retire @ et les points. Ainsi l'adresse foo@bar.com devient &lt;foo (a) bar com&gt;.
173<P></P>
174<DT><B>-n</B>, <B>--enum-title</B></DT><DD>
175Numérote automatiquement les titres. Ils seront préfixés par 1, 1.1, 1.1.1, ...
176<P></P>
177<DT>    <B>--no-dump-config</B></DT><DD>
178Annule l'affichage de configuration via <CODE>--dump-config</CODE>.
179<P></P>
180<DT>    <B>--no-dump-source</B></DT><DD>
181Annule l'affichage de la source via <CODE>--dump-source</CODE>.
182<P></P>
183<DT>    <B>--no-encoding</B></DT><DD>
184Annule la configuration d'encodage.
185<P></P>
186<DT>    <B>--no-enum-title</B></DT><DD>
187Annule la numérotation automatique des titres.
188<P></P>
189<DT>    <B>--no-infile</B></DT><DD>
190Annule toutes les déclarations précédentes de fichiers d'entrée.
191<P></P>
192<DT>    <B>--no-targets</B></DT><DD>
193Annule l'action <CODE>--targets</CODE>.
194<P></P>
195<DT>    <B>--no-mask-email</B></DT><DD>
196Annule l'action de masquer les courriels.
197<P></P>
198<DT>    <B>--no-outfile</B></DT><DD>
199Annule la précédente déclaration de fichier de sortie.
200<P></P>
201<DT>    <B>--no-quiet</B></DT><DD>
202Affiche les messages, annule l'option <CODE>--quiet</CODE>.
203<P></P>
204<DT>    <B>--no-rc</B></DT><DD>
205Ne lit pas le fichier de configuration utilisateur ~/.txt2tagsrc.
206<P></P>
207<DT>    <B>--no-slides</B></DT><DD>
208N'utilise pas les slides (-t art).
209<P></P>
210<DT>    <B>--no-style</B></DT><DD>
211Supprime la déclaration de style.
212<P></P>
213<DT>    <B>--no-toc</B></DT><DD>
214N'ajoute pas de table des matières au document de sortie.
215<P></P>
216<DT>    <B>--no-toc-only</B></DT><DD>
217Annule l'action de <CODE>--toc-only</CODE>.
218<P></P>
219<DT><B>-o</B>, <B>--outfile</B>=<I>FICHIER</I></DT><DD>
220Génère le nom <I>FICHIER</I> en tant que fichier de sortie. Utilisez '-' pour envoyer le résultat vers STDOUT.
221<P></P>
222<DT><B>-q</B>, <B>--quiet</B></DT><DD>
223Mode silencieux, supprime toutes les sorties (sauf les erreurs).
224<P></P>
225<DT>    <B>--rc</B></DT><DD>
226Lit le fichier de configuration utilisateur ~/.txt2tagsrc. ACTIVÉ par défaut.
227<P></P>
228<DT>    <B>--slides</B></DT><DD>
229Formate la sortie en tant que slide de présentation. Cette option est uniquement utilisée par la cible ASCII Art.
230<P></P>
231<DT>    <B>--style</B>=<I>FICHIER</I></DT><DD>
232Utilise <I>FICHIER</I> en tant que fichier de style pour le document. Utilisé pour définir les fichiers CSS pour les documents HTML/XHTML et les paquets pour LaTeX. Cette option peut être appelée à plusieurs reprises pour inclure de multiples fichiers.
233<P></P>
234<DT><B>-t</B>, <B>--target</B>=<I>TYPE</I></DT><DD>
235Choisit la cible document de sortie en la définissant à <I>TYPE</I>. Des cibles courantes sont : <I>html</I>, <I>xhtml</I>, <I>tex</I>, <I>man</I>, <I>txt</I>. Utilisez l'option <CODE>--targets</CODE> pour lister toutes les cibles disponibles.
236<P></P>
237<DT>    <B>--targets</B></DT><DD>
238Affiche une liste de toutes les cibles disponibles, et sort.
239<P></P>
240<DT>    <B>--toc</B></DT><DD>
241Ajoute une table des matières (Table of Contents ; TOC), générée automatiquement, au document de sortie, entre son entête et son contenu. Vous pouvez également spécifier la place de cette table des matières en utilisant la macro <CODE>%%TOC</CODE>.
242<P></P>
243<DT>    <B>--toc-level</B>=<I>NOMBRE</I></DT><DD>
244Assigne le niveau maximum de la table des matières à <I>NOMBRE</I>. Tous les titres au-delà de <I>NOMBRE</I> ne seront pas inclus dans la table des matières.
245<P></P>
246<DT>    <B>--toc-only</B></DT><DD>
247Affiche la table des matières et sort.
248<P></P>
249<DT><B>-v</B>, <B>--verbose</B></DT><DD>
250Affiche les messages d'information durant la conversion. Cette option peut être appelée à plusieurs reprises pour augmenter le nombre de messages affichés.
251<P></P>
252<DT><B>-V</B>, <B>--version</B></DT><DD>
253Affiche la version du programme et sort.
254<P></P>
255<DT>    <B>--width</B>=<I>NOMBRE</I></DT><DD>
256Assigne la largeur de sortie à <I>NOMBRE</I> de colonnes. Cette option est uniquement utilisée par la cible ASCII Art.
257</DL>
258
259<A NAME="source"></A>
260<H1>FICHIERS SOURCE</H1>
261
262<P>
263Les fichiers source sont généralement identifiés par l'extension <I>.t2t</I> (par exemple <CODE>mon_fichier.t2t</CODE>). Vous pouvez avoir trois zones dans vos sources :
264</P>
265
266<DL>
267<DT><B>Entête</B> (optionel)</DT><DD>
268Les trois premières lignes du fichier. Laissez la première ligne vide si vous n'avez pas besoin d'entêtes. Utilisé dans le document pour le titre, l'auteur, la version, et la date.
269<P></P>
270<DT><B>Configuration</B> (optionel)</DT><DD>
271Commence juste après l'entête (4ème ou 2nde ligne) et se termine quand le corps du texte débute.
272Utilisé pour les configurations, dans le format <CODE>%!mot-clé:valeur</CODE>.
273<P></P>
274<DT><B>Corps</B></DT><DD>
275Commence à la première ligne de texte valide (pas de commentaire ou de configuration), après la zone d'entête et continue jusqu'à la fin du document. Utilisé pour le contenu du document proprement dit.
276</DL>
277
278<A NAME="configurations"></A>
279<H1>CONFIGURATIONS</H1>
280
281<P>
282Les configurations vous permettent de personnaliser <B>txt2tags</B>, elles sont similaires aux options. Elles peuvent être utilisées : dans la zone de configurations du document source, dans un fichier <CODE>~/.txt2tagsrc</CODE>, dans un fichier extérieur appelé avec l'option <CODE>--config-file</CODE>.
283</P>
284
285<DL>
286<DT><B>%!target</B></DT><DD>
287Définit le format de sortie, de la même manière que <CODE>--target</CODE>. Par exemple :
288
289<PRE>
290  %!target: html
291</PRE>
292
293<P></P>
294<DT><B>%!options(target)</B></DT><DD>
295Définit les options par défaut de chaque cible. Vous devez utiliser la même syntaxe qu'en ligne de commande. Par exemple :
296
297<PRE>
298  %!options(html): --toc --toc-level 3 --css-sugar
299</PRE>
300
301<P></P>
302<DT><B>%!includeconf</B></DT><DD>
303Inclut une configuration à partir d'un fichier externe, de la même manière que <CODE>--config-file</CODE>. Par exemple :
304
305<PRE>
306  %!includeconf: myconfig.t2t
307</PRE>
308
309<P></P>
310<DT><B>%!style</B></DT><DD>
311Définit un fichier de style pour le document, de la même manière que <CODE>--style</CODE>. Peut être appelée à plusieurs reprises. Par exemple :
312
313<PRE>
314  %!style: colors.css
315</PRE>
316
317<P></P>
318<DT><B>%!encoding</B></DT><DD>
319Définit l'encodage de la cible, de la même manière que <CODE>--encoding</CODE>. Par exemple :
320
321<PRE>
322  %!encoding: UTF-8
323</PRE>
324
325<P></P>
326<DT><B>%!preproc</B></DT><DD>
327Filtre de recherche et remplacement utilisé pour modifier le corps de la source AVANT les remplacements habituels de txt2tags. La fonction de recherche utilise les expressions rationnelles (regex) de Python. Par exemple :
328
329<PRE>
330  %!preproc:  "JJS"  "John J. Smith"
331</PRE>
332
333<P></P>
334<DT><B>%!postproc</B></DT><DD>
335Filtre de recherche et remplacement utilisé pour modifier le document généré APRÈS les remplacements habituels de txt2tags. La fonction de recherche utilise les expressions rationnelles (regex) de Python. Par exemple :
336
337<PRE>
338  %!postproc(html):  "&lt;B&gt;"  "&lt;STRONG&gt;"
339</PRE>
340
341</DL>
342
343<P>
344Si le même mot apparaît plusieurs fois, le dernier trouvé sera celui utilisé (à l'exception des options, preproc et postproc, qui sont cumulatifs). Les mots-clés non-valides sont ignorés. L'ordre de priorité est : fichier <CODE>~/.txt2tagsrc</CODE>, zone de configuration du document, option <CODE>--config-file</CODE> passée en ligne de commandes.
345</P>
346
347<A NAME="commandes"></A>
348<H1>COMMANDES</H1>
349
350<P>
351Les commandes font diverses tâches durant la conversion. Elles doivent être placées dans le corps du document.
352</P>
353
354<DL>
355<DT><B>%!csv: fichier.csv</B></DT><DD>
356Inclut un fichier externe CSV file en tant que tableau.
357<P></P>
358<DT><B>%!include: fichier.t2t</B></DT><DD>
359Inclut un fichier txt2tags dans le document.
360<P></P>
361<DT><B>%!include: ``fichier.txt``</B></DT><DD>
362Inclut un fichier texte (verbatim) dans le document.
363<P></P>
364<DT><B>%!include: ''fichier.html''</B></DT><DD>
365Inclut un fichier html dans le document.
366</DL>
367
368<A NAME="macros"></A>
369<H1>MACROS</H1>
370
371<P>
372Les macros sont des raccourcis pratiques pour insérer du contenu dynamique dans votre document. Elles doivent être placées dans le corps du document source. À l'exception de <CODE>%%toc</CODE>, toutes les macros peuvent être personnalisées avec des directives spécifiques, comme <CODE>%Y</CODE> ou <CODE>%f</CODE>. Voir le guide complet de txt2tags pour plus de détails.
373</P>
374
375<DL>
376<DT><B>%%date</B></DT><DD>
377Insère la date actuelle. Le format par défaut est <CODE>%%date(%Y%m%d)</CODE>, ce qui donne AAAAMMJJ.
378<P></P>
379<DT><B>%%infile</B></DT><DD>
380Insère le chemin du fichier source. Le format par défaut est <CODE>%%infile(%f)</CODE>. Utile pour inclure des bas de page de type  <CODE>[Voir la source %%infile]</CODE>.
381<P></P>
382<DT><B>%%mtime</B></DT><DD>
383Insère la date de modification du fichier source. Le format par défaut est <CODE>%%date(%Y%m%d)</CODE>, ce qui donne AAAAMMJJ.
384<P></P>
385<DT><B>%%outfile</B></DT><DD>
386Insère le chemin du fichier de sortie. Le format par défaut est <CODE>%%outfile(%f)</CODE>. Utile pour une description de type "C'est le fichier manpage-fr.html".
387<P></P>
388<DT><B>%%toc</B></DT><DD>
389Indique où sera placée la table des matières. Vous pouvez même l'appeler à de multiples reprises. Notez que vous devez également utiliser l'option <CODE>--toc</CODE>.
390</DL>
391
392<A NAME="exemples"></A>
393<H1>EXEMPLES</H1>
394
395<DL>
396<DT><CODE>txt2tags -t html fichier.t2t</CODE></DT><DD>
397<P></P>
398Conversion HTML, vers le fichier fichier.html.
399<P></P>
400<DT><CODE>txt2tags -t html -o - fichier.t2t</CODE></DT><DD>
401<P></P>
402Conversion HTML, envoie le résultat vers STDOUT.
403<P></P>
404<DT><CODE>txt2tags -t html --toc fichier.t2t</CODE></DT><DD>
405<P></P>
406Conversion HTML, incluant une table des matières automatiquement générée.
407<P></P>
408<DT><CODE>txt2tags -t html --toc --toc-level 2 -n fichier.t2t</CODE></DT><DD>
409<P></P>
410Conversion HTML, avec une table des matières de niveau deux et des titres numérotés.
411<P></P>
412<DT><CODE>txt2tags --toc-only fichier.t2t</CODE></DT><DD>
413<P></P>
414Affiche juste la table des matières dans le terminal, aucune conversion ne sera faite.
415<P></P>
416<DT><CODE>txt2tags -t html --css-sugar --style base.css --style ui.css fichier.t2t</CODE></DT><DD>
417<P></P>
418Convertion HTML, préparant le code résultant à être utilisé avec des CSS, et incluant également deux fichiers CSS externes.
419<P></P>
420<DT><CODE>txt2tags -t art --slides --width 80 --height 25 -o - fichier.t2t | more</CODE></DT><DD>
421<P></P>
422Crée une présentation en ASCII Art, prête à être visualisée dans un terminal en 80x25.
423<P></P>
424<DT><CODE>(echo ; echo "**bold**") | txt2tags -t html -H -</CODE></DT><DD>
425<P></P>
426Test rapide en une ligne avec entrée depuis la console STDIN.
427<P></P>
428<DT><CODE>txt2tags -t html -o - fichier.t2t | tidy &gt; fichier.html</CODE></DT><DD>
429<P></P>
430Envoie le résultat vers STDOUT, puis ajuste le code avec un programme externe avant de sauvegarder le résultat dans un fichier externe.
431</DL>
432
433<A NAME="fichiers"></A>
434<H1>FICHIERS</H1>
435
436<DL>
437<DT>~/.txt2tagsrc</DT><DD>
438Fichier de configuration par défaut de l'utilisateur.
439</DL>
440
441<A NAME="environnement"></A>
442<H1>ENVIRONNEMENT</H1>
443
444<DL>
445<DT>T2TCONFIG</DT><DD>
446Si cette variable d'environnement n'est pas nulle, elle définit alors le chemin complet pour la configuration par défaut de l'utilisateur.
447</DL>
448
449<A NAME="auteur"></A>
450<H1>AUTEUR</H1>
451
452<P>
453Aurelio Jargas &lt;&lt;verde (a) aurelio net&gt;&gt;
454</P>
455<P>
456Page de man traduite en français par Eric Forgeot &lt;<A HREF="http://esclinux.tk">http://esclinux.tk</A>&gt;, en réutilisant parfois le travail original de Claude Hiebel &lt;&lt;chiebel (a) free fr&gt;&gt;
457</P>
458
459<A NAME="bogues"></A>
460<H1>BOGUES</H1>
461
462<P>
463<A HREF="http://bugs.txt2tags.org">http://bugs.txt2tags.org</A>
464</P>
465
466<A NAME="copyright"></A>
467<H1>COPYRIGHT</H1>
468
469<P>
470Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2
471</P>
472
473<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
474<!-- cmdline: txt2tags -t html doc/French/manpage-fr.t2t -->
475</BODY></HTML>