Linux Certif

Toute la documentation sur la certification Linux LPI

install-info

NOM

install-info - cr�ation ou mise � jour d'une entr�e dans le r�pertoire Info

SYNOPSIS

install-info [--version] [--help] [--debug] [--maxwidth=nnn] [--section regexp title] [--infodir=xxx] [--align=nnn] [--quiet] [--menuentry=xxx] [--description=xxx] [--remove | --remove-exactly ] [--] nom-de-fichier

DESCRIPTION

install-info cr�e, met � jour ou supprime des entr�es dans le fichier dir du r�pertoire Info. Quand, pour la cr�ation ou la mise � jour d'une entr�e, on ne donne aucune description sur la ligne de commande ou dans le fichier Info, install-info essaye d'en deviner une � travers le contenu du fichier.

Voyez la description de l'option --section pour des pr�cisions sur l'emplacement choisi pour l'entr�e et sur le format attendu du fichier dir.

OPTIONS

[--] nom-de-fichier

Donne le nom du fichier Info dont l'entr�e de menu doit �tre cr��e, mise � jour ou supprim�e. Si l'option --remove-exactly est pr�cis�e, nom-de-fichier sera le nom exact de l'entr�e � supprimer (p.ex. � emacs-20/emacs � ou � gcc �) ; dans les autres cas, la partie principale de ce nom sert de r�f�rent pour l'entr�e de menu qui est cr��e, � moins qu'il y ait, dans le fichier donn�, une entr�e START-INFO-DIR. Ce fichier doit donc exister (ou bien �tre sur le point d'�tre install�, ou bien doit avoir exist� en cas de suppression d'entr�e) dans le m�me r�pertoire que le fichier dir (voyez l'option --infodir).

Quand nom-de-fichier se termine par .gz on consid�re qu'il renvoie � un fichier comprim� avec � GNU gzip � ; s'il n'existe pas, mais qu'il y a un nom-de-fichier.gz on utilisera ce dernier.

Quand on ajoute ou on met � jour des entr�es, ce fichier doit exister dans le chemin sp�cifi� (si possible avec l'extension .gz suppl�mentaire).

--remove

Demande que l'entr�e pour le fichier nom-de-fichier soit d�truite ; par d�faut les entr�es sont cr��es ou mises � jour.

Quand la suppression d'une entr�e vide une section, l'en-t�te (et la ligne blanche d�tach�e) de la section est supprim�e aussi, � moins que ce ne soit la derni�re section du fichier ou bien que l'option --keep-old soit indiqu�e. Voyez l'option --section pour des pr�cisions sur le format attendu du fichier dir.

Quand il y a plusieurs entr�es possibles dans le fichier dir, seules celles qui appartiennent au premier groupe contigu correspondant sont supprim�es ; les autres sont silencieusement ignor�es.

Ne pas trouver d'entr�e possible n'est pas une erreur, bien que install-info avertisse du probl�me quand l'option --quiet n'a pas �t� demand�e.

Quand --remove est sp�cifi�, les options de formatage --maxwidth, --align et --calign sont silencieusement ignor�es.

--remove-exactly

Cette option est pratiquement identique � --remove mais nom-de-fichier est compris comme le nom exact de l'entr�e � supprimer plut�t que comme le nom d'un fichier existant. Cela peut �tre important quand on essaye de supprimer des entr�es pour des fichiers info dans des sous-r�pertoires (p.ex. � emacs-20/emacs �) : --remove op�re sur la partie principale du nom-de-fichier plut�t que sur le nom exact. (p.ex. --remove � emacs-20/emacs � forcerait install-info � chercher � emacs �, pas � emacs-20/emacs �).

--section exp-reg titre

Indique que l'entr�e qui doit �tre cr��e sera plac�e dans la section du fichier dir dont le titre correspond � exp-reg. Si une telle section n'existe pas, une nouvelle derni�re section (voyez ci-apr�s) est cr��e dans le fichier, avec un titre �gal � titre. Une section est un choix possible dans le menu de dir ; les choix sont s�par�s par des lignes blanches ; la premi�re ligne est suppos�e repr�senter le titre.

Quand une nouvelle entr�e doit �tre cr��e, install-info essaye de l'ins�rer dans la section selon l'ordre alphab�tique ; si les entr�es de la section ne sont pas d�j� tri�es, on ne peut pr�voir l'emplacement qui sera choisi. L'ordre existant des entr�es n'est pas modifi�.

Par d�faut, les entr�es nouvelles sont ajout�es � la fin du fichier. La derni�re section doit toujours exister (m�me si elle consiste en une simple ligne de titre) de mani�re que les nouvelles sections puissent �tre cr��es au bon endroit. Le titre de la derni�re section devrait refl�ter le fait que des fichiers Info sans emplacement bien d�fini sont ajout�s � la fin de cette section.

Quand le fichier Info que l'on doit installer poss�de d�j� une entr�e, celle-ci est remplac�e in situ par la nouvelle entr�e.

Quand on supprime une entr�e, une section sp�cifi�e est ignor�e et un avertissement est produit.

Quand on ajoute une entr�e et qu'une section est sp�cifi�e, mais que le fichier ne contient aucun en-t�te de section, install-info cr�e � la fois la section demand�e et une section � Miscellaneous � � la fin du fichier.

--infodir=rep-info

Sp�cifie que le fichier dir est situ� dans rep-info, ou que la copie install�e du nouveau fichier Info �tait, est ou sera situ�e dans rep-info. Par d�faut, c'est /usr/info.

--align=nnn [d�conseill�]

Pr�cise que l'espace d'indentation de la premi�re ligne de la description sera d'au moins nnn caract�res ; des espaces suppl�mentaires peuvent �tre ajout�s. Quand la longueur des �l�ments de l'entr�e du menu dir le demande, on peut le d�caler davantage. Par d�faut ce nombre est �gal � 27.

--calign=nnn [d�conseill�]

Pr�cise que l'espace d'indentation de la deuxi�me ligne et des lignes suivantes de la description sera d'au moins nnn caract�res. Par d�faut ce nombre est �gal � 29.

--maxwidth=nnn [d�conseill�]

Pr�cise que la largeur maximale d'une ligne du fichier Info est de nnn. Cela sert pour � couper � automatiquement les lignes du texte descriptif. Par d�faut ce nombre est �gal � 79.

--quiet

Emp�che l'affichage normal de la nouvelle entr�e du menu juste avant qu'elle soit ins�r�e et l'affichage de messages annon�ant le remplacement ou la suppression d'entr�es existantes ou la cr�ation ou la suppression de section.

--help

option pour afficher une aide sur l'utilisation de install-info

--version

option pour afficher la version et le copyright de install-info

--description=xxx

Pr�cise que la description employ�e apr�s l'entr�e du menu pour une nouvelle entr�e ou bien pour une entr�e mise � jour sera xxx. Par d�faut, on emploie la valeur indiqu�e par le fichier Info lui-m�me ; on peut la trouver en cherchant une section de la forme suivante :
START-INFO-DIR-ENTRY
* Auto-PGP: (auto-pgp). PGP under GNU Emacs.
END-INFO-DIR-ENTRY

Quand l'entr�e trouv�e dans le fichier Info lui-m�me s'�tend sur plusieurs lignes, chacune donnant une entr�e du menu, on reprend le texte trouv� � verbatim �. Dans ce cas, on ne tient pas compte de l'ordre alphab�tique et les entr�es sont ins�r�es au d�but de la section en question. Et les options --menuentry, --maxwidth, --align, --calign sont ignor�es.

Quand il n'y a pas d'entr�e pour dir dans le fichier, le programme essaye de trouver un paragraphe au d�but du fichier qui commence par this file documents. Il met une capitale au premier caract�re de la suite et l'utilise comme description.

C'est une erreur si aucune de ces m�thodes ne peut donner une description.

Quand l'option --remove est donn�e, l'argument pour l'option � description � est ignor� et un avertissement est produit.

--menuentry=xxx

Pr�cise que l'entr�e de menu sera xxx. Par d�faut, on emploie la valeur indiqu�e par le fichier Info lui-m�me. Quand elle n'est pas pr�sente, la partie principale du nom du fichier Info est utilis�e (tout fichier .info est supprim� et la premi�re lettre de l'entr�e est capitalis�e). Voyez ci-dessus pour des pr�cisions sur le format attendu pour l'entr�e de menu dans le fichier Info.

Quand on supprime des entr�es, la valeur de l'option --menuentry doit correspondre au champ r�el de l'entr�e de menu qui doit �tre supprim�e (peu importe la casse). Quand l'option --menuentry est omise, aucune v�rification sur l'entr�e de menu n'est faite.

--keep-old

Emp�che le remplacement d'entr�es existantes et la suppression des sections vides.

Quand le fichier qu'on doit installer poss�de d�j� une entr�e dans le r�pertoire, l'ancienne entr�e est laiss�e seule plut�t que d'�tre remplac�e. Par d�faut, toute entr�e ancienne trouv�e est remplac�e par la nouvelle.

Quand l'option --remove est indiqu�e ,--keep-old emp�che la suppression de l'en-t�te de section qui sans cela serait supprim� si la suppression vidait la section.

--test

met en mode test, lequel emp�che la mise � jour du fichier dir.

--debug

met en mode d�bogage, lequel montre les r�sultats de certaines �tapes du traitement.

VOIR AUSSI

emacs(1), info(1), gzip(1)

TRADUCTION

Philippe Batailler. Dec 2000

COPYRIGHT

Copyright 1994, Ian Jackson. install-info est un logiciel libre ; voyez la � GNU General Public License � version 2 ou sup�rieure pour le copyright. Il n'y a pas de garantie.