NOM
lexgrog - analyse l'information contenue dans l'en-tte des pages de
manuel
SYNOPSIS
lexgrog [-m|-c] [-fhwV] fichier ...
lexgrog est une implmentation de l'utilitaire traditionnel groff
guess de lex. Il exploite chacun des fichiers indiqus sur sa ligne de
commande, soit en tant que fichiers source de page de manuel, soit en
tant que page cat prformate. Il affiche leur nom et leur description
selon le format employ par apropos et whatis. La liste des filtres de
prtraitement, exigs par la page de manuel avant cela, est passe nroff
ou troff, ou aux deux.
Si les donnes en entre sont mal formates, lexgrog affichera parse
failed . Cela peut tre utile pour les programmes externes qui doivent
vrifier les pages de manuel. Si l'un des fichiers d'entre de lexgrog
est - , le programme lira l'entre standard. Si un des fichiers analys
est compress, une version dcompresse sera exploite automatiquement.
OPTIONS
-m, --man
Analyse l'entre en tant que fichier source de page de manuel.
C'est le comportement par dfaut si ni --man ni --cat ne sont
indiques.
-c, --cat
Analyse l'entre en tant que page de manuel prformate (page
cat ) --man et --cat ne peuvent pas tre indiques simultanment.
-w, --whatis
Affiche le nom et la description, tirs de l'en-tte de la page de
manuel, selon le format employ par apropos et par whatis. C'est
le comportement par dfaut si ni --whatis ni --filters ne sont
indiques.
-f, --filters
Affiche la liste des filtres requis pour prtraiter la page de
manuel avant sa mise en forme par nroff ou troff.
-h, --help
Affiche un message d'aide et s'arrte.
-V, --version
Affiche le numro de version.
VALEUR DE RETOUR
0 Programme excut sans erreur.
1 Erreur d'excution.
2 lexgrog n'a pas russi analyser un ou plusieurs des fichiers
d'entre.
EXEMPLES
$ lexgrog man.1
man.1: "man - Interface de consultation des manuels de rfrence en ligne"
$ lexgrog -fw man.1
man.1 (t): "man - Interface de consultation des manuels de rfrence en ligne"
$ lexgrog -c whatis.cat1
whatis.cat1: "whatis - Affiche la description des pages de manuel"
$ lexgrog broken.1
broken.1: parse failed
ANALYSE WHATIS
mandb (qui emploie le mme code que lexgrog) analyse la section NAME en
tte de chaque page de manuel et recherche le nom et la description de
chaque fonction documente. Bien que l'analyseur soit trs tolrant, car
il doit faire face aux diffrentes formes qui ont t historiquement
employes, il peut parfois ne pas arriver extraire l'information
recherche.
Pour que les macros de man fonctionnent correctement, la section NAME
doit ressembler ceci :
.SH NAME
toto \- programme qui fait quelque chose
Certains afficheurs de pages de manuel exigent \- exactement comme
indiqu. mandb est plus tolrant, mais pour assurer la compatibilit avec
d'autres systmes c'est une bonne ide de conserver la contre-oblique
(antislash).
gauche, il peut y avoir plusieurs noms, spars par des virgules. Le
texte
droite n'a pas de structure impose et peut tre crit sur plusieurs
lignes. Si plusieurs fonctions, avec des descriptions diffrentes sont
documentes dans la mme page de manuel, la forme suivante sera employe :
.SH NAME
toto, titi \- programmes qui font quelque chose
.br
tutu \- programme qui ne fait pas grand chose
Une macro, marquant le dbut d'un nouveau paragraphe, comme .PP, peut
tre employe la place de la macro de rupture .br.
Pour tre utilise avec les macros mdoc, drives de BSD, la section NAME
doit ressembler ceci :
.Sh NAME
.Nm toto
.Nd programme qui fait quelque chose
Il y a plusieurs raisons habituelles pour lesquelles l'analyse whatis
choue. Parfois les auteurs des pages de manuel remplacent .SH NAME
par .SH MYPROGRAM . De ce fait mandb ne peut pas trouver la section
dont il a besoin pour extraire l'information. Parfois les auteurs
incluent une section NAME, mais y placent le texte descriptif sans
respecter le format nom \- description . Cependant, n'importe quelle
syntaxe ressemblant ce qui prcde devrait tre accepte.
VOIR AUSSI
man(1), mandb(8), apropos(1), whatis(1).
NOTA BENE
lexgrog essaie d'analyser les fichiers contenant des requtes .so, mais
il ne pourra le faire efficacement que si les fichiers sont
correctement installs dans une structure hirarchique de pages de
manuel.
AUTEUR
Le code utilis dans lexgrog pour analyser les pages de manuel a t crit
par :
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
Colin Watson a crit l'interface de la ligne de commande actuelle ainsi
que cette page de manuel.
TRADUCTION
Valry Perrin <valery.perrin.debian@free.fr> le 2 janvier 2006.
L'quipe de traduction a fait le maximum pour raliser une adaptation
franaise de qualit.
La version anglaise la plus jour de ce document est toujours
consultable via la commande man -L en nom_de_la_page .
N'hsitez pas signaler l'auteur ou au traducteur, selon le cas, toute
erreur dans cette page de manuel.