Scroll to navigation

LINUXDOC(1) General Commands Manual LINUXDOC(1)

NOM

linuxdoc – Convertisseur du DTD SGML LinuxDoc en d’autres formats

SYNOPSIS

linuxdoc --backend=format
[--papersize=taille] [--language=langue] [--charset=caractères] [--style=fichier] [--debug] [--define attribut=valeur] [--include entité] [options_dorsal...] fichier(.sgml)

ou (ancienne utilisation obsolète)
sgmlxxxx [options_génériques...] [options_dorsal...]   fichier(.sgml)

DESCRIPTION

La suite linuxdoc est une collection de formateurs de texte qui prennent en charge un fichier source SGML de DTD LinuxDoc. Chaque formateur (ou « dorsal ») transforme le fichier source en divers formats de sortie, dont HTML, TeX, DVI, PostScript, texte simple, et un fichier source groff(1) en page de manuel. La suite LinuxDoc est fournie pour des raisons de rétrocompatibilité, car il existe encore de nombreux documents utiles écrits sous forme de source SGML de DTD LinuxDoc.

Les langages de balisage acceptés par ces formateurs sont décrits dans le Guide d’utilisation Linuxdoc-Tools. Ce sont des variantes d’une définition de type de document SGML conçue par Matt Welsh pour la documentation de Linux.

OPTIONS GÉNÉRIQUES

La plupart des options de ligne de commande sont acceptées par tous les dorsaux. Certains dorsaux ont des options spécifiques supplémentaires pour contrôler le rendu de leurs formats de sortie particuliers :

Définir le dorsal pour le format spécifié. Par défaut, c’est aucun des formats réels, mais l’utilisation de ces suites est affichée. Les formats possibles sont : html, info, latex, lyx, rtf, txt, check.
Définir la taille de papier. Par défaut c’est « a4 » (format européen 297x210 mm). La taille « letter » peut aussi être indiquée.
Spécifier la langue du document (cela peut modifier les fichiers de style utilisés par un dorsal pour le formatage). La langue par défaut est l’anglais. Exécutez une commande faisant partie de LinuxDoc-tools, sans argument, pour connaitre la liste des codes de langue autorisés.
Spécifier l’encodage des caractères de la sortie. Par défaut, c’est « ascii » qui sélectionne l’encodage ASCII. « latin » peut être indiqué pour sélectionner l’encodage ISO 8859-1 (Latin-1). « nippon » et « euc-kr » sont à indiquer pour prendre en charge les fichiers SGML encodés en EUC-JP et EUC-KR. « utf-8 » est aussi accepté bien qu’il ne soit pris en charge que partiellement.
Inclure un DTD supplémentaire (Document Type Definition) à partir du répertoire /usr/share/linuxdoc-tools/dtd.
Définir l’espacement de tabulation pour produire le document. La valeur par défaut est 8.
Ne pas supprimer les fichiers intermédiaires (tels que les fichiers .TeX supprimés pendant leur transformation en fichiers .dvi ou des fichiers .man supprimés pendant leur transformation en fichiers en texte simple).
Passer les paires attribut/valeur pour une correspondance avec les conditions « if » et « unless ». Consultez le Guide d’utilisation pour des explications plus complètes sur cette fonctionnalité. Cette conditionnalité est gérée par la commande sgmlpre. Consultez le manuel de sgmlpre(1) ainsi que le Guide d’utilisation.
Passer l’option -i à nsgmls(1). Cela peut être utilisé pour l’inclusion de condition. Consultez le manuel de nsgmls(1) pour davantage de détails.
Passer une chaine d’option au dorsal. Les sémantiques exactes de cette option dépendent du dorsal et devraient être expliquées dans leur page de manuel.
Le fichier SGML source avec l’extension .sgml, appelé fichier ou fichier.sgml. Il doit utiliser le DTD LinuxDoc. Les autres DTD ne sont pas pris en charge.

L’exécution d’un dorsal sans argument fait qu’il affiche la liste de toutes les options (les messages d’erreur « no filenames given » peuvent être ignorés dans ce cas). Les dorsaux disponibles incluent (les noms entre parenthèses sont des formes anciennes et obsolètes) :

Traduction en HTML
Traduction en GNU info
Traduction en macros de Lyx
Traduction en LaTeX2e
Traduction en Rich Text Format de Microsoft
Traduction en texte simple ou en marquage de page de manuel d’Unix

Il existe aussi un outil linuxdoc -B check (sgmlcheck) disponible pour vérifier la syntaxe SGML d’un DTD LinuxDoc de sources de document sans générer réellement une version traduite.

PILOTES DE DORSAL

Voici une description de chaque pilote de dorsal.


****************************************************

linuxdoc -B html (sgml2html) transforme un fichier source SGML de DTD LinuxDoc en une sortie HTML. Celle-ci apparait dans le fichier de premier niveau fichier.html et les fichiers fichier-n.html pour chaque section (action par défaut pouvant être modifiée par une option), où fichier est le nom du fichier SGML source et n est le nom de la section.

La paire attribut/valeur « output=html » est définie pour exprimer des conditions.

linuxdoc -B html accepte les options suivantes : [--split 0|1|2 ] [--dosnames] [--imagebuttons] [--toc 0|1|2 ]

Leurs significations sont :

Niveau de division du document source : 0 = aucune division, 1 = diviser selon les sections principales, 2 = diviser selon les sous-sections.
Niveau de création de table des matières :
0 = absence totale de TDM
1 = inclusion des sections principales (parties, chapitres)
2 = inclusion des sous-sections
Utiliser « .htm » au lieu de « .html » comme extension des fichiers HTML.
Utiliser les icônes d’image de flèche « next », « previous » et « contents » incluses dans /usr/share/linuxdoc-tools comme boutons de navigation.
Utiliser le fichier indiqué comme pied de page dans chaque fichier HTML généré. Par défaut, le pied de page est simplement du texte simple. 



 </BODY>\n </HTML>\n
Utiliser le fichier spécifié comme partie haute de l’entête du fichier HTML résultant. Remarquez que ce n’est pas l’entête entier, c’est-à-dire que le titre et les liens (next, previous, content) de l’entête par défaut sont conservés. Par défaut, c’est 



 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\n


 <HTML>\n <HEAD>\n
Définir la direction du fichier HTML de droite vers gauche.


****************************************************

linuxdoc -B info (sgml2info) transforme un fichier source SGML de DTD LinuxDoc en une sortie au format GNU info. Celle-ci apparait dans le fichier fichier.info où fichier est le nom du fichier source SGML.

La paire attribut/valeur « output=info » est définie pour exprimer des conditions.

linuxdoc -B info n’a pas d’options spécifiques au dorsal.


****************************************************

linuxdoc -B latex (sgml2latex) transforme un fichier source SGML de DTD LinuxDoc en une sortie au format LaTeX en utilisant les analyseurs syntaxiques nsgmls(1) ou onsgmls(1), et le traducteur sgmlsasp(1). En utilisant la sortie LaTeX et le formateur de texte latex(1), il est possible de créer une sortie DVI et PostScript en utilisant le convertisseur dvips(1). La sortie apparait dans fichier.tex pour la sortie LaTeX, fichier.dvi pour la sortie DVI ou fichier.ps pour la sortie PostScript, où fichier est le nom du fichier source SGML.

En utilisant la sortie LaTeX et le formateur de texte pdflatex(1), il est possible de créer une jolie sortie PDF adaptée aux afficheurs de PDF tels que xpdf(1), acroread(1) ou ghostview(1).

La paire attribut/valeur « output=latex2e » est définie pour exprimer des conditions.

linuxdoc -B latex accepte les options spécifiques au dorsal : [--output=tex|dvi|ps|pdf] [--bibtex] [--makeindex] [--pagenumber=n] --quick [--latex=latex|hlatexp|platex|jlatex] [--dvips=dvips|dvi2ps] [--verbosity=n]

Leurs significations sont :

Spécifier le format de sortie désiré. format peut être « tex », « dvi », « ps » ou « pdf ».

Remarque : cette version n’écrase pas ni ne supprime les fichiers intermédiaires tex pour la sortie DVI ou tex/dvi pour la sortie PS. C’est un comportement différent de celui du SGML-Tools 1.0.9 originel, vous voilà prévenu.

Traiter le TeX généré avec bibtex(1).
Générer un fichier d’index TeX adapté au traitement avec makeindex(1) à partir des balises <idx> et <cdx> présentes dans le fichier source SGML.
Définir la page de départ dans le fichier de sortie DVI ou PS.
Ne faire qu’une seule passe pour le formatage en LaTeX. Ce n’est souvent pas suffisant pour produire le document final (à cause des références, etc.) mais c’est utile pour repérer les erreurs de TeX et les problèmes de justification.
L’argument de l’option pass est inséré juste après le préambule de LaTeX généré par l’étiquette de type de document. Spécifiez le format de sortie désiré. Le spécificateur format peut être « tex », « dvi », « ps » ou « pdf ».
Cette option concerne actuellement le coréen et le japonais. La commande_latex_remplaçante peut être « latex » (par défaut), « hlatexp » (pour le coréen), « platex » ou « jlatex » (pour le japonais). Cette option peut être utilisée pour le rendu des documents coréens en utilisant HLaTeXp ou pour le rendu des documents japonais en utilisant pLaTeX/jLaTeX. Sinon, HLaTeX doit être installé pour le rendu des documents coréens. En outre, les documents japonais peuvent être rendus en utilisant jLaTeX (par défaut quand « -c nippon » est spécifié), par conséquent si jLaTeX est installé, nul besoin de pLaTeX.
Cette option concerne actuellement le japonais. La commande_latex_remplaçante peut être « dvips » ou « dvi2ps ». Si vous ne le savez pas, vous n’avez probablement pas besoin de ça.
Définir la prolixité : « 0 » (par défaut) affiche des informations à propos des exécutions de LaTeX seulement en cas d’erreur, « 1 » affiche toujours les informations à propos de la dernière exécution, « 2 » affiche des informations à propos de toutes les exécutions.


****************************************************

linuxdoc -B lyx (sgml2lyx) transforme un fichier source SGML de DTD LinuxDoc en une sortie LyX. La sortie apparait dans le fichier.lyx où fichier est le nom du fichier source SGML.

La paire attribut/valeur « output=lyx » est définie pour exprimer des conditions.

linuxdoc -B lyx n’a pas d’options spécifiques au dorsal.


****************************************************

linuxdoc -B rtf (sgml2rtf) transforme un fichier source SGML de DTD LinuxDoc en une sortie RTF, le Rich Text Format utilisé par le système d’aide de Microsoft Windows. La sortie apparait dans le fichier de premier niveau fichier.rtf et dans fichier-n.rtf pour chaque section, où fichier est le nom du fichier source SGML. La sortie RTF est adaptée pour une compilation par le Windows Help Compiler (hc31.exe).

La paire attribut/valeur « output=rtf » est définie pour exprimer des conditions.

linuxdoc -B rtf accepte --twosplit comme option spécifique au dorsal. Sa signification est la suivante :

Diviser les fichiers à n sections et n.m sous-sections.


****************************************************

linuxdoc -B txt (sgml2txt) transforme un fichier source SGML de DTD LinuxDoc en une sortie ASCII, ISO-8859-1 ou EUC-JP. La sortie apparait dans le fichier.txt, où fichier est le nom du fichier source SGML.

La paire attribut/valeur « output=txt » est définie pour exprimer des conditions.

linuxdoc -B txt accepte les options de dorsal suivantes ; [--manpage] [--filter] [--blanks=n]

Leurs significations sont les suivantes :

Produire un fichier groff(1) source, adapté pour un formatage avec groff -man pour des pages de manuel (man).
Supprimer les retours arrière/superposition de la forme intermédiaire générée par groff(1).
L’argument de l’option pass est ajouté aux options de ligne de commande fournies à groff(1).
Définir le nombre limite de lignes blanches contigües pour la création du document final. La valeur par défaut est 3. Si 0 (zéro) est indiqué, le résultat comportera un nombre important de lignes blanches contigües.


****************************************************

linuxdoc -B check (sgmlcheck) réalise une analyse du document source spécifié. Toute erreur est rapportée sur la sortie standard. Aucune version de formatage du fichier source n’est réalisé.

Remarquez que linuxdoc -B check prétraite le fichier source SGML de DTD LinuxDoc, satisfaisant les conditions décrites par toute balise <#if></#if> et <#unless></#unless>. Les sources de document contenant ces balises risquent de désorienter un analyseur SGML autonome. linuxdoc -B check n’a pas d’option spécifique au dorsal.
****************************************************

FICHIERS

Plusieurs fichiers et exécutables dans /usr/share/linuxdoc-tools et /usr/bin sont utilisés.

BOGUES

Il peut encore en exister. N’hésitez pas à envoyer votre rapport au responsable actuel.

RESPONSABLE

Cette page était entretenue par Cees de Groot <cg@cdegroot.com> dans SGML-Tools (v1) et Taketoshi Sano <sano@debian.org> pour Linuxdoc-Tools. Elle est actuellement entretenue par Agustin Martin <agustin6martin AT gmail com>.

TRADUCTION

La traduction française de cette page de manuel a été créée par Jean-Paul Guillonneau <guillonneau.jeanpaul@free.fr>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n'y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à debian-l10n-french@lists.debian.org.

2 avril 2025