276 lines
8.6 KiB
HTML
276 lines
8.6 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of LEXGROG</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>LEXGROG</H1>
|
|
Section: Utilitaires de l'afficheur des pages de manuel (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NOM</H2>
|
|
|
|
lexgrog - Analyser l'information contenue dans l'en-tête des pages de manuel
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>lexgrog</B> [<B>-m</B>|<B>-c</B>] [<B>-dfw?V</B>] [<B>-E</B> <I>encodage</I>]
|
|
<I>fichier</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>lexgrog</B> est une implémentation de l'utilitaire traditionnel « groff
|
|
guess » de <B>lex</B>. Il exploite chacun des fichiers indiqués sur sa ligne de
|
|
commande, soit en tant que fichiers source de page de manuel, soit en tant
|
|
que page « cat » préformatée. Il affiche leur nom et leur description
|
|
selon le format employé par <B>apropos</B> et <B>whatis</B>. La liste des filtres de
|
|
prétraitement, exigés par la page de manuel avant cela, est passée à
|
|
<B>nroff</B> ou à <B>troff</B>, ou aux deux.
|
|
<P>
|
|
|
|
Si les données en entrée sont mal formatées, <B>lexgrog</B> affichera « parse
|
|
failed ». Cela peut être utile pour les programmes externes qui doivent
|
|
vérifier les pages de manuel. Si l'un des fichiers d'entrée de <B>lexgrog</B>
|
|
est « - », le programme lira l'entrée standard. Si un des fichiers analysé
|
|
est compressé, une version décompressée sera exploitée automatiquement.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Affiche les informations de mise au point.
|
|
<DT id="2"><B>-m</B>, <B>--man</B>
|
|
|
|
|
|
<DD>
|
|
Analyse l'entrée en tant que fichier source de page de manuel. C'est le
|
|
comportement par défaut si ni <B>--man</B> ni <B>--cat</B> ne sont indiquées.
|
|
<DT id="3"><B>-c</B>, <B>--cat</B>
|
|
|
|
|
|
<DD>
|
|
Analyse l'entrée en tant que page de manuel préformatée (page « cat »)
|
|
<B>--man</B> et <B>--cat</B> ne peuvent pas être indiquées simultanément.
|
|
<DT id="4"><B>-w</B>, <B>--whatis</B>
|
|
|
|
|
|
<DD>
|
|
Affiche le nom et la description, tirés de l'en-tête de la page de manuel,
|
|
selon le format employé par <B>apropos</B> et par <B>whatis</B>. C'est le
|
|
comportement par défaut si ni <B>--whatis</B> ni <B>--filters</B> ne sont indiquées.
|
|
<DT id="5"><B>-f</B>, <B>--filters</B>
|
|
|
|
|
|
<DD>
|
|
Affiche la liste des filtres requis pour prétraiter la page de manuel avant
|
|
sa mise en forme par <B>nroff</B> ou <B>troff</B>.
|
|
<DT id="6"><B>-E</B> <I>encodage</I>, <B>--encoding</B> <I>encodage</I><DD>
|
|
Force l'<I>encodage</I> à la place du jeu de caractères deviné pour la page.
|
|
<DT id="7"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Affiche un message d'aide et s'arrête.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Affiche un court mode d'emploi et s'arrête.
|
|
<DT id="9"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Affiche le numéro de version.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CODE DE RETOUR</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Programme exécuté sans erreur.
|
|
<DT id="11"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Erreur d'exécution.
|
|
<DT id="12"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
<B>lexgrog</B> n'a pas réussi à analyser un ou plusieurs des fichiers d'entrée.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXEMPLES</H2>
|
|
|
|
<PRE>
|
|
$ lexgrog man.1
|
|
man.1: "man - an interface to the system reference manuals"
|
|
$ lexgrog -fw man.1
|
|
man.1 (t): "man - an interface to the system reference manuals"
|
|
$ lexgrog -c whatis.cat1
|
|
whatis.cat1: "whatis - display manual page descriptions"
|
|
$ lexgrog broken.1
|
|
broken.1: parse failed
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ANALYSE WHATIS</H2>
|
|
|
|
<B>mandb</B> (qui emploie le même code que <B>lexgrog</B>) analyse la section
|
|
<B>NOM</B> en tête de chaque page de manuel et recherche le nom et la
|
|
description de chaque fonction documentée. Bien que l'analyseur soit très
|
|
tolérant, car il doit faire face aux différentes formes qui ont été
|
|
historiquement employées, l'extraction de l'information recherchée reste
|
|
parfois un échec.
|
|
<P>
|
|
|
|
Pour que les macros de <I>man</I> fonctionnent correctement, la section <B>NOM</B>
|
|
doit ressembler à ceci :
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<PRE>
|
|
<TT>.SH NOM
|
|
toto \- programme qui fait quelque chose</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Certains afficheurs de pages de manuel exigent « \- » exactement comme
|
|
indiqué. <B>mandb</B> est plus tolérant, mais pour assurer la compatibilité
|
|
avec d'autres systèmes, il est conseillé de conserver la contre-oblique
|
|
(antislash).
|
|
<P>
|
|
|
|
À gauche, il peut y avoir plusieurs noms, séparés par des virgules. Les noms
|
|
contenant des espaces seront ignorés pour éviter le comportement
|
|
pathologique avec certaines sections <B>NOM</B> mal formées. Le texte à droite
|
|
n'a pas de structure imposée et peut être écrit sur plusieurs lignes. Si
|
|
plusieurs fonctions, avec des descriptions différentes sont documentées dans
|
|
la même page de manuel, la forme suivante sera employée :
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="14"><DD>
|
|
<PRE>
|
|
<TT>.SH NOM
|
|
toto, titi \- programmes qui font quelque chose
|
|
.br
|
|
tutu \- programme qui ne fait pas grand chose</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Une macro, marquant le début d'un nouveau paragraphe, comme <TT>.PP</TT>, peut
|
|
être employée à la place de la macro de rupture <TT>.br</TT>.
|
|
<P>
|
|
|
|
Pour être utilisée avec les macros <I>mdoc</I>, dérivées de BSD, la section
|
|
<B>NOM</B> doit ressembler à ceci :
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="15"><DD>
|
|
<PRE>
|
|
<TT>.Sh NOM
|
|
.Nm toto
|
|
.Nd programme qui fait quelque chose</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Il y a plusieurs raisons habituelles pour lesquelles l'analyse whatis
|
|
échoue. Parfois les auteurs des pages de manuel remplacent « .SH NOM » par
|
|
« .SH MONPROGRAMME ». De ce fait <B>mandb</B> ne peut pas trouver la section
|
|
dont il a besoin pour extraire l'information. Parfois les auteurs incluent
|
|
une section NOM, mais y placent le texte descriptif sans respecter le format
|
|
« nom \- description ». Cependant, n'importe quelle syntaxe ressemblant à
|
|
ce qui précède devrait être acceptée.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>VOIR AUSSI</H2>
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+man">man</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+whatis">whatis</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></I>(8)
|
|
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>NOTA BENE</H2>
|
|
|
|
<B>lexgrog</B> essaie d'analyser les fichiers contenant des requêtes .so, mais
|
|
il ne pourra le faire efficacement que si les fichiers sont correctement
|
|
installés dans une structure hiérarchique de pages de manuel.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>AUTEUR</H2>
|
|
|
|
Le code utilisé dans <B>lexgrog</B> pour analyser les pages de manuel a été
|
|
écrit par :
|
|
<P>
|
|
|
|
<PRE>
|
|
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).</PRE>
|
|
|
|
<P>
|
|
|
|
Colin Watson a écrit l'interface de la ligne de commande actuelle ainsi que
|
|
cette page de manuel.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>TRADUCTION</H2>
|
|
|
|
Cette traduction est maintenue à l'aide de l'outil
|
|
po4a <URL:<A HREF="https://po4a.org/">https://po4a.org/</A>> par l'équipe
|
|
francophone de traduction de Debian.
|
|
<P>
|
|
|
|
Valéry Perrin <<A HREF="mailto:valery.perrin.debian@free.fr">valery.perrin.debian@free.fr</A>> le 2 janvier 2006.
|
|
David Prévot <<A HREF="mailto:david@tilapin.org">david@tilapin.org</A>> et l'équipe francophone de traduction de Debian (2010).
|
|
<P>
|
|
|
|
Veuillez signaler toute erreur de traduction en écrivant à
|
|
<<A HREF="mailto:debian-l10n-french@lists.debian.org">debian-l10n-french@lists.debian.org</A>> ou par un rapport de bogue sur
|
|
le paquet man-db.
|
|
<P>
|
|
|
|
Vous pouvez toujours avoir accès à la version anglaise de ce document en
|
|
utilisant la commande
|
|
« <B>man -L C</B> <I><section></I> <I><page_de_man></I> ».
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NOM</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">CODE DE RETOUR</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">EXEMPLES</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">ANALYSE WHATIS</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">VOIR AUSSI</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">NOTA BENE</A><DD>
|
|
<DT id="25"><A HREF="#lbAK">AUTEUR</A><DD>
|
|
<DT id="26"><A HREF="#lbAL">TRADUCTION</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:01 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|