install-info.8 8.6 KB

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