PageRenderTime 16ms CodeModel.GetById 11ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/French/manpage-fr.man

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