install-info.8 8.6 KB

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