LEXGROG(1) Utilitaires de l'afficheur des pages de manuel LEXGROG(1) NOM lexgrog - Analyser l'information contenue dans l'en-tete des pages de manuel SYNOPSIS lexgrog [-m|-c] [-dfw?V] [-E encodage] fichier ... DESCRIPTION lexgrog est une implementation de l'utilitaire traditionnel << groff guess >> de lex. Il exploite chacun des fichiers indiques sur sa ligne de commande, soit en tant que fichiers source de page de manuel, soit en tant que page << cat >> preformatee. Il affiche leur nom et leur description selon le format employe par apropos et whatis. La liste des filtres de pretraitement, exiges par la page de manuel avant cela, est passee a nroff ou a troff, ou aux deux. Si les donnees en entree sont mal formatees, lexgrog affichera << parse failed >>. Cela peut etre utile pour les programmes externes qui doivent verifier les pages de manuel. Si l'un des fichiers d'entree de lexgrog est << - >>, le programme lira l'entree standard. Si un des fichiers analyse est compresse, une version decompressee sera exploitee automatiquement. OPTIONS -d, --debug Affiche les informations de mise au point. -m, --man Analyse l'entree en tant que fichier source de page de manuel. C'est le comportement par defaut si ni --man ni --cat ne sont indiquees. -c, --cat Analyse l'entree en tant que page de manuel preformatee (page << cat >>) --man et --cat ne peuvent pas etre indiquees simultanement. -w, --whatis Affiche le nom et la description, tires de l'en-tete de la page de manuel, selon le format employe par apropos et par whatis. C'est le comportement par defaut si ni --whatis ni --filters ne sont indiquees. -f, --filters Affiche la liste des filtres requis pour pretraiter la page de manuel avant sa mise en forme par nroff ou troff. -E encodage, --encoding encodage Force l'encodage a la place du jeu de caracteres devine pour la page. -?, --help Affiche un message d'aide et s'arrete. --usage Affiche un court mode d'emploi et s'arrete. -V, --version Affiche le numero de version. CODE DE RETOUR 0 Programme execute sans erreur. 1 Erreur d'execution. 2 lexgrog n'a pas reussi a analyser un ou plusieurs des fichiers d'entree. EXEMPLES $ lexgrog man.1 man.1: "man - interface de consultation des manuels de reference du systeme" $ lexgrog -fw man.1 man.1 (t): "man - interface de consultation des manuels de reference du systeme" $ 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 meme code que lexgrog) analyse la section NOM en tete de chaque page de manuel et recherche le nom et la description de chaque fonction documentee. Bien que l'analyseur soit tres tolerant, car il doit faire face aux differentes formes qui ont ete historiquement employees, l'extraction de l'information recherchee reste parfois un echec. Pour que les macros de man fonctionnent correctement, la section NOM doit ressembler a ceci : .SH NAME foo \- program to do something Certains afficheurs de pages de manuel exigent << \- >> exactement comme indique. mandb est plus tolerant, mais pour assurer la compatibilite avec d'autres systemes, il est conseille de conserver la contre-oblique (antislash). A gauche, il peut y avoir plusieurs noms, separes par des virgules. Les noms contenant des espaces seront ignores pour eviter le comportement pathologique avec certaines sections NOM mal formees. Le texte a droite n'a pas de structure imposee et peut etre ecrit sur plusieurs lignes. Si plusieurs fonctions, avec des descriptions differentes sont documentees dans la meme page de manuel, la forme suivante sera employee : .SH NAME foo, bar \- programs to do something .br baz \- program to do nothing (A macro which starts a new paragraph, like .PP, may be used instead of the break macro .br.) Pour etre utilisee avec les macros mdoc, derivees de BSD, la section NOM doit ressembler a ceci : .Sh NAME .Nm foo .Nd program to do something Il y a plusieurs raisons habituelles pour lesquelles l'analyse whatis echoue. Parfois les auteurs des pages de manuel remplacent << .SH NOM >> par << .SH MONPROGRAMME >>. De ce fait mandb 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 a ce qui precede devrait etre acceptee. VOIR AUSSI apropos(1), man(1), whatis(1), mandb(8) NOTA BENE lexgrog essaie d'analyser les fichiers contenant des requetes .so, mais il ne pourra le faire efficacement que si les fichiers sont correctement installes dans une structure hierarchique de pages de manuel. AUTEUR Le code utilise dans lexgrog pour analyser les pages de manuel a ete ecrit par : Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org). Colin Watson (cjwatson@debian.org). Colin Watson a ecrit l'interface de la ligne de commande actuelle ainsi que cette page de manuel. BOGUES https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db TRADUCTION Cette traduction est maintenue a l'aide de l'outil po4a par l'equipe francophone de traduction de Debian. Valery Perrin le 2 janvier 2006. David Prevot et l'equipe francophone de traduction de Debian (2010). Veuillez signaler toute erreur de traduction en ecrivant a ou par un rapport de bogue sur le paquet man-db. Vous pouvez toujours avoir acces a la version anglaise de ce document en utilisant la commande << man -L C
>>. 2.12.1 2024-04-05 LEXGROG(1)