install-info.8 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. .\" Install-info and this manpage are Copyright 1994 by Ian Jackson.
  2. .\"
  3. .\" This is free software; see the GNU General Public Licence version 2
  4. .\" or later for copying conditions. There is NO warranty.
  5. .\" traduction de la version cvs 1.4
  6. .TH INSTALL-INFO 8 "29th November 1995" "Projet Debian " "Utilitaires de dpkg"
  7. .SH NOM
  8. install\-info \- création ou mise à jour d'une entrée dans le répertoire Info
  9. .SH SYNOPSIS
  10. .B install\-info
  11. [\-\-version] [\-\-help] [\-\-debug] [\-\-maxwidth=nnn]
  12. [\-\-section regexp title] [\-\-infodir=xxx] [\-\-align=nnn]
  13. [\-\-quiet] [\-\-menuentry=xxx] [\-\-description=xxx]
  14. [\-\-remove | \-\-remove-exactly ]
  15. [\-\-] nom-de-fichier
  16. .SH DESCRIPTION
  17. .PP
  18. .B install-info
  19. crée, met à jour ou supprime des entrées dans le fichier
  20. .B dir
  21. du répertoire Info.
  22. Quand, pour la création ou la mise à jour d'une entrée, on ne donne aucune
  23. description sur la ligne de commande ou dans le fichier Info,
  24. .B install-info
  25. essaye d'en deviner une à travers le contenu du fichier.
  26. Voyez la description de l'option
  27. .B \-\-section
  28. pour des précisions sur l'emplacement choisi pour l'entrée et sur le format attendu du
  29. fichier
  30. .B dir.
  31. .SS OPTIONS
  32. .TP
  33. .BI "[\-\-] " nom-de-fichier
  34. Donne le nom du fichier Info dont l'entrée de menu doit être créée, mise à
  35. jour ou supprimée. Si l'option
  36. .B \-\-remove-exactly
  37. est précisée,
  38. .I nom-de-fichier sera le nom exact de l'entrée à supprimer (p.ex.
  39. «\ emacs-20/emacs\ » ou «\ gcc\ ») ; dans les autres cas, la partie principale
  40. de ce nom sert de référent pour l'entrée de menu qui est créée, à moins qu'il
  41. y ait, dans le fichier donné, une entrée START-INFO-DIR. Ce fichier doit donc
  42. exister (ou bien être sur le point d'être installé, ou bien doit avoir existé
  43. en cas de suppression d'entrée) dans le même répertoire que le fichier
  44. .B dir (voyez l'option
  45. .B \-\-infodir).
  46. Quand
  47. .I nom-de-fichier
  48. se termine par
  49. .B .gz
  50. on considère qu'il renvoie à un fichier comprimé avec « GNU gzip » ; s'il
  51. n'existe pas, mais qu'il y a un
  52. .IB nom-de-fichier .gz
  53. on utilisera ce dernier.
  54. Quand on ajoute ou on met à jour des entrées, ce fichier doit exister dans le
  55. chemin spécifié (si possible avec l'extension
  56. .B .gz
  57. supplémentaire).
  58. .TP
  59. .B \-\-remove
  60. Demande que l'entrée pour le fichier
  61. .I nom-de-fichier
  62. soit détruite ; par défaut les entrées sont créées ou mises à jour.
  63. Quand la suppression d'une entrée vide une section, l'en-tête (et la ligne
  64. blanche détachée) de la section est supprimée aussi, à moins que ce ne soit la
  65. dernière section du fichier ou bien que l'option
  66. .B \-\-keep\-old
  67. soit indiquée. Voyez l'option
  68. .B \-\-section
  69. pour des précisions sur le format attendu du fichier
  70. .B dir.
  71. Quand il y a plusieurs entrées possibles dans le fichier
  72. .B dir,
  73. seules celles qui appartiennent au premier groupe contigu correspondant
  74. sont supprimées ; les autres sont silencieusement ignorées.
  75. Ne pas trouver d'entrée possible n'est pas une erreur, bien que
  76. .B install\-info
  77. avertisse du problème quand l'option
  78. .B \-\-quiet
  79. n'a pas été demandée.
  80. Quand
  81. .B \-\-remove
  82. est spécifié, les options de formatage
  83. .BR \-\-maxwidth ", " \-\-align " et " \-\-calign
  84. sont silencieusement ignorées.
  85. .TP
  86. .B \-\-remove-exactly
  87. Cette option est pratiquement identique à
  88. .B \-\-remove
  89. mais
  90. .I nom-de-fichier
  91. est compris comme le nom exact de l'entrée à supprimer plutôt que comme le
  92. nom d'un fichier existant. Cela peut être important quand on essaye de
  93. supprimer des entrées pour des fichiers info dans des sous-répertoires
  94. (p.ex. «\ emacs-20/emacs\ »)\ :
  95. .B \-\-remove
  96. opère sur la partie principale du
  97. .I nom-de-fichier
  98. plutôt que sur le nom exact. (p.ex.
  99. .B \-\-remove
  100. «\ emacs-20/emacs\ » forcerait
  101. .B install-info
  102. à chercher «\ emacs\ », pas «\ emacs-20/emacs\ »).
  103. .TP
  104. .BI "\-\-section " "exp-reg titre"
  105. Indique que l'entrée qui doit être créée sera placée dans la section du fichier
  106. .B dir
  107. dont le titre correspond à
  108. .IR exp-reg .
  109. Si une telle section n'existe pas, une nouvelle dernière section
  110. (voyez ci-après) est créée dans le fichier, avec un titre égal à
  111. .IR titre.
  112. Une section est un choix possible dans le menu de
  113. .B dir ;
  114. les choix sont séparés par des lignes blanches ; la première ligne est
  115. supposée représenter le titre.
  116. Quand une nouvelle entrée doit être créée,
  117. .B install-info
  118. essaye de l'insérer dans la section selon l'ordre alphabétique ; si les
  119. entrées de la section ne sont pas déjà triées, on ne peut prévoir
  120. l'emplacement qui sera choisi. L'ordre existant des entrées n'est pas
  121. modifié.
  122. Par défaut, les entrées nouvelles sont ajoutées à la fin du fichier.
  123. La dernière section doit toujours exister (même si elle consiste en une
  124. simple ligne de titre) de manière que les nouvelles sections puissent être
  125. créées au bon endroit. Le titre de la dernière section devrait refléter le fait
  126. que des fichiers Info sans emplacement bien défini sont ajoutés à la fin de
  127. cette section.
  128. Quand le fichier Info que l'on doit installer possède déjà une entrée, celle-ci
  129. est remplacée in situ par la nouvelle entrée.
  130. Quand on supprime une entrée, une section spécifiée est ignorée et un
  131. avertissement est produit.
  132. Quand on ajoute une entrée et qu'une section est spécifiée, mais que le
  133. fichier ne contient aucun en-tête de section,
  134. .B install-info
  135. crée à la fois la section demandée et une section « Miscellaneous » à la fin
  136. du fichier.
  137. .TP
  138. .BI \-\-infodir= rep-info
  139. Spécifie que le fichier
  140. .B dir
  141. est situé dans
  142. .IR rep-info ,
  143. ou que la copie installée du nouveau fichier Info était, est ou sera située
  144. dans
  145. .IR rep-info .
  146. Par défaut, c'est
  147. .BR /usr/info .
  148. .TP
  149. .BI \-\-align= nnn " [déconseillé]"
  150. Précise que l'espace d'indentation de la première ligne de la description
  151. sera d'au moins
  152. .I nnn
  153. caractères ; des espaces supplémentaires peuvent être ajoutés.
  154. Quand la longueur des éléments de l'entrée du menu
  155. .B dir
  156. le demande, on peut le décaler davantage. Par défaut ce nombre est égal à 27.
  157. .TP
  158. .BI \-\-calign= nnn " [déconseillé]"
  159. Précise que l'espace d'indentation de la deuxième ligne et des lignes
  160. suivantes de la description sera d'au moins
  161. .I nnn
  162. caractères. Par défaut ce nombre est égal à 29.
  163. .TP
  164. .BI \-\-maxwidth= nnn " [déconseillé]"
  165. Précise que la largeur maximale d'une ligne du fichier Info est de
  166. .IR nnn .
  167. Cela sert pour « couper » automatiquement les lignes du texte descriptif.
  168. Par défaut ce nombre est égal à 79.
  169. .TP
  170. .B \-\-quiet
  171. Empêche l'affichage normal de la nouvelle entrée du menu juste avant qu'elle
  172. soit insérée et l'affichage de messages annonçant le remplacement ou la
  173. suppression d'entrées existantes ou la création ou la suppression de
  174. section.
  175. .TP
  176. .B \-\-help
  177. option pour afficher une aide sur l'utilisation de
  178. .B install-info
  179. .TP
  180. .B \-\-version
  181. option pour afficher la version et le copyright de
  182. .B install-info
  183. .TP
  184. .BI \-\-description= xxx
  185. Précise que la description employée après l'entrée du menu pour une nouvelle
  186. entrée ou bien pour une entrée mise à jour sera
  187. .IR xxx .
  188. Par défaut, on emploie la valeur indiquée par le fichier Info lui-même ;
  189. on peut la trouver en cherchant une section de la forme suivante :
  190. .br
  191. .B START\-INFO\-DIR\-ENTRY
  192. .br
  193. .B * Auto-PGP: (auto-pgp). PGP under GNU Emacs.
  194. .br
  195. .B END\-INFO\-DIR\-ENTRY
  196. Quand l'entrée trouvée dans le fichier Info lui-même s'étend sur plusieurs
  197. lignes, chacune donnant une entrée du menu, on reprend le texte trouvé
  198. « verbatim ». Dans ce cas, on ne tient pas compte de l'ordre alphabétique et
  199. les entrées sont insérées au début de la section en question.
  200. Et les options
  201. .BR \-\-menuentry ", " \-\-maxwidth ", " \-\-align ", " \-\-calign
  202. sont ignorées.
  203. Quand il n'y a pas d'entrée pour
  204. .B dir
  205. dans le fichier, le programme essaye de trouver un paragraphe au début du
  206. fichier qui commence par
  207. .BR "this file documents" .
  208. Il met une capitale au premier caractère de la suite et l'utilise comme
  209. description.
  210. C'est une erreur si aucune de ces méthodes ne peut donner une description.
  211. Quand l'option
  212. .B \-\-remove
  213. est donnée, l'argument pour l'option « description » est ignoré et un
  214. avertissement est produit.
  215. .TP
  216. .BI \-\-menuentry= xxx
  217. Précise que l'entrée de menu sera
  218. .IR xxx .
  219. Par défaut, on emploie la valeur indiquée par le fichier Info lui-même.
  220. Quand elle n'est pas présente, la partie principale du nom du fichier Info
  221. est utilisée
  222. .RB "(tout fichier " ".info " "est supprimé et la première lettre de l'entrée
  223. est capitalisée).
  224. Voyez ci-dessus pour des précisions sur le format attendu pour l'entrée de
  225. menu dans le fichier Info.
  226. Quand on supprime des entrées, la valeur de l'option
  227. .B \-\-menuentry
  228. doit correspondre au champ réel de l'entrée de menu qui doit être supprimée
  229. (peu importe la casse).
  230. Quand l'option
  231. .B \-\-menuentry
  232. est omise, aucune vérification sur l'entrée de menu n'est faite.
  233. .TP
  234. .B \-\-keep\-old
  235. Empêche le remplacement d'entrées existantes et la suppression des sections
  236. vides.
  237. Quand le fichier qu'on doit installer possède déjà une entrée dans le
  238. répertoire, l'ancienne entrée est laissée seule plutôt que d'être remplacée.
  239. Par défaut, toute entrée ancienne trouvée est remplacée par la nouvelle.
  240. Quand l'option
  241. .BR \-\-remove " est indiquée ", \-\-keep\-old
  242. empêche la suppression de l'en-tête de section qui sans cela serait
  243. supprimé si la suppression vidait la section.
  244. .TP
  245. .B \-\-test
  246. met en mode test, lequel empêche la mise à jour du fichier dir.
  247. .TP
  248. .B \-\-debug
  249. met en mode débogage, lequel montre les résultats de certaines étapes du
  250. traitement.
  251. .SH "VOIR AUSSI"
  252. emacs(1), info(1), gzip(1)
  253. .SH "TRADUCTION"
  254. Philippe Batailler. Dec 2000
  255. .SH COPYRIGHT
  256. Copyright 1994, Ian Jackson.
  257. .B install\-info
  258. est un logiciel libre ; voyez la « GNU General Public Licence » version 2 ou
  259. supérieure pour le copyright. Il
  260. .I n'y a pas
  261. de garantie.