install-info.8 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441
  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. .\"
  6. .\" Japanese Version Copyright (c) 1998 Koichi Sekido
  7. .\" all rights reserved.
  8. .\" Translated Tue Jul 7 11:31:24 JST 1998
  9. .\" by Koichi Sekido <sekido@mbox.kyoto-inet.or.jp>
  10. .\"
  11. .\" WORD: basename ベースネーム
  12. .\"
  13. .\" $Id$
  14. .\"
  15. .TH INSTALL-INFO 8 "29th November 1995" "Debian Project" "Debian GNU/Linux"
  16. .\" .SH NAME
  17. .SH 名前
  18. .\" install\-info \- create or update entry in Info directory
  19. install\-info \- Info ディレクトリにエントリを作成したり更新したりする
  20. .\" .SH SYNOPSIS
  21. .SH 書式
  22. .B install\-info
  23. [\-\-version] [\-\-help] [\-\-debug] [\-\-maxwidth=nnn]
  24. [\-\-section regexp title] [\-\-infodir=xxx] [\-\-align=nnn]
  25. [\-\-quiet] [\-\-menuentry=xxx] [\-\-description=xxx] [\-\-remove]
  26. [\-\-] filename
  27. .\" .SH DESCRIPTION
  28. .SH 説明
  29. .\" .PP
  30. .\" .B install-info
  31. .\" makes, updates or removes entries in the Info directory, the
  32. .\" .B dir
  33. .\" file. When updating or creating entries, if no description is
  34. .\" specified on the command line or in the Info file it attempts to guess
  35. .\" a description from the contents of the file.
  36. .PP
  37. .B install-info
  38. は、Info ディレクトリの
  39. .B dir
  40. ファイルにエントリを作成・更新・削除する。作成か更新の場合、コマンドライ
  41. ンにも Info ファイルにも説明文が指定されていなかったら、ファイルの中身か
  42. ら説明文を推測しようとする。
  43. .\" See the description of the
  44. .\" .B \-\-section
  45. .\" option for details of where the entry will be placed and a description
  46. .\" of the expected format of the
  47. .\" .B dir
  48. .\" file.
  49. エントリの置かれる位置や
  50. .B dir
  51. ファイルの望ましい形式の説明については、
  52. .B \-\-section
  53. の記述を見られよ。
  54. .\" .SS OPTIONS
  55. .SS オプション
  56. .TP
  57. .BI "[\-\-] " filename
  58. .\" Gives the filename of the Info file whose menu entry is to be created,
  59. .\" updated or removed. The basename of this filename is used as the
  60. .\" referent of the menu entry which is created. This file must therefore
  61. .\" exist (or be about to be installed, or have previously existed when
  62. .\" removing an entry) in the same directory as the
  63. .\" .B dir
  64. .\" file (see the
  65. .\" .B \-\-infodir
  66. .\" option).
  67. メニューエントリを作成・更新・削除したい Info ファイルのファイル名を与え
  68. る。このファイル名のベースネームは、作成されるメニューエントリのリファレ
  69. ンスとして使われる。従ってこのファイルは
  70. .B dir
  71. ファイルと同じディレクトリに存在していなけらばならない。あるいは、ほぼイ
  72. ンストールされているか、エントリ削除の場合は以前存在していたか、でなけら
  73. ばならない。
  74. .B \-\-infodir
  75. オプションを参照せよ。
  76. .\" If
  77. .\" .I filename
  78. .\" ends in
  79. .\" .B .gz
  80. .\" it is taken to refer to a file compressed with GNU gzip; if it doesn't
  81. .\" exist, but a corresponding
  82. .\" .IB filename .gz
  83. .\" does, the latter is used instead.
  84. .I filename
  85. .B .gz
  86. で終わっていたら、GNU gzip で圧縮されているファイルであるとみなされる。
  87. .I filename
  88. は存在しないがこれに対応する
  89. .IB filename .gz
  90. が存在する場合は、替わりに
  91. .IB filename .gz
  92. が使われる。
  93. .\" When adding or updating entries the file must exist at the path
  94. .\" specified (possibly with an additional
  95. .\" .B .gz
  96. .\" extension).
  97. エントリを追加か更新するときは、ファイル(拡張子
  98. .B .gz
  99. が付加的に付いているかもしれない)は指定されたパスに存在していなければな
  100. らない。
  101. .TP
  102. .B \-\-remove
  103. .\" Specifies that the entry for the file
  104. .\" .I filename
  105. .\" is to be removed; by default entries are created or updated.
  106. ファイル
  107. .I filename
  108. のエントリを削除することを指定する。デフォルトではエントリは作成もしくは
  109. 更新される。
  110. .\" If the removal results in a section becoming empty the section heading
  111. .\" (and the spare blank line) will be removed as well, unless this is the
  112. .\" last section in the file or
  113. .\" .B \-\-keep\-old
  114. .\" is specified. See the
  115. .\" .B \-\-section
  116. .\" option for details about the expected format of the
  117. .\" .B dir
  118. .\" file.
  119. 削除の結果セクションが空っぽになる場合、これがファイルの最後のセクション
  120. でないか
  121. .B \-\-keep\-old
  122. が指定されるかしていなかったら、セクション見出しも同様に削除される。
  123. .B dir
  124. ファイルの望ましい形式の説明については、
  125. .B \-\-section
  126. の記述を見られよ。
  127. .\" If there are several suitable entries in the
  128. .\" .B dir
  129. .\" file only those in the first matching contiguous group will be removed
  130. .\" and the others silently ignored.
  131. あてはまるエントリが
  132. .B dir
  133. ファイルにいくつかある場合、最初にマッチしたカテゴリグループのものが削除
  134. され、残りは無視される。
  135. .\" It is not an error for no suitable entry to be found, though
  136. .\" .B install\-info
  137. .\" will issue a warning unless the
  138. .\" .B \-\-quiet
  139. .\" option was specified.
  140. .B install\-info
  141. .B \-\-quiet
  142. オプションが指定されない限り警告を発するが、このオプションについては、
  143. あてはまるエントリが見つからなくてもエラーにはならない。
  144. .\" When
  145. .\" .B \-\-remove
  146. .\" is specified the
  147. .\" .BR \-\-maxwidth ", " \-\-align " and " \-\-calign
  148. .\" formatting options are silently ignored.
  149. .B \-\-remove
  150. オプションが指定された場合、
  151. .BR \-\-maxwidth " , " \-\-align " ," \-\-calign
  152. の整形オプションは無視される。
  153. .TP
  154. .BI "\-\-section " "regexp title"
  155. .\" Specifies that, if a new entry is to be made, it should be placed in a
  156. .\" section of the
  157. .\" .B dir
  158. .\" file whose title matches
  159. .\" .IR regexp .
  160. .\" If no such section exists one will be created as the second last
  161. .\" section in the file (see below), with title
  162. .\" .IR title .
  163. .\" A section is a part of the
  164. .\" .B dir
  165. .\" menu delimited by blank lines; the first line is assumed to be the
  166. .\" title.
  167. 新しいエントリを作るときに、
  168. .B dir
  169. ファイルの中でタイトルが
  170. .IR regexp
  171. にマッチするセクションに配置することを指定する。該当するセクションが存在
  172. しなかったら、ファイルの最後から二番目のセクション(後述)として
  173. .IR title
  174. というタイトルで作られる。
  175. セクションとは
  176. .B dir
  177. メニューの中の一部で、空白行で区切られたものである。セクションの先頭行は
  178. タイトルとして扱われる。
  179. .\" If a new entry is to be created
  180. .\" .B install-info
  181. .\" will attempt to insert it within the section according in alphabetic
  182. .\" order; if the entries in the section aren't already sorted the new
  183. .\" location within the section will be unpredictable. The order of
  184. .\" existing entries will not be changed.
  185. 新たなエントリを作るとき、
  186. .B install-info
  187. はセクションの中でアルファベット順にそれを挿入しようとする。セクション中
  188. のエントリがあらかじめソートされていなかったら、セクション中の位置は予測
  189. できない。すでに存在するエントリの順番は変更されない。
  190. .\" The default is to append new entries to the end of the file. The last
  191. .\" section (even if it only consists of the title line) should always
  192. .\" exist, to ensure that new sections are created in the right place.
  193. .\" The final section should be titled to reflect the fact that Info files
  194. .\" with no more well specified location are appended to it.
  195. デフォルトでは新たなエントリをファイルの終わりに付け加える。最後のセクショ
  196. ンは、タイトル行だけであっても常に存在していなけらばならない。これは新た
  197. なセクションが正しい場所に作られるようにするためである。最後のセクション
  198. は、位置が正しく指定されていない Info ファイルがそこに付け加えられるよう
  199. にタイトルを付けなければならない。
  200. .\" If there is already an entry for the Info file being installed it is
  201. .\" replaced in situ with the new entry.
  202. Info ファイルのエントリがすでにインストールされていたら、その位置で新た
  203. なエントリに置き換えられる。
  204. .\" If a section is specified when removing an entry the section is
  205. .\" ignored and a warning is issued.
  206. エントリ削除時にセクションを指定すると、セクションは無視され警告が発せら
  207. れる。
  208. .\" If a section is requested when adding an entry but the file contains
  209. .\" no section headings at all then
  210. .\" .B install-info
  211. .\" will create both the requested section and a Miscellaneous section at
  212. .\" the end of the file.
  213. エントリを加えるときにセクションが必要となるにもかかわらずファイルにセク
  214. ション見出しが一つもなかったら、
  215. .B install-info
  216. は必要となるセクションとファイルの終わりの Miscellaneous というセクショ
  217. ンとの両方を作る。
  218. .TP
  219. .BI \-\-infodir= infodir
  220. .\" Specifies that the
  221. .\" .B dir
  222. .\" file is, and the installed copy of the new Info file was, is or will
  223. .\" be located in
  224. .\" .IR infodir .
  225. .\" The default is
  226. .\" .BR /usr/info .
  227. .B dir
  228. ファイルと、インストールされる新たな Info ファイルのコピーが
  229. .IR infodir
  230. にあることを指定する。デフォルトは
  231. .BR /usr/info
  232. である。
  233. .TP
  234. .BI \-\-align= nnn
  235. .\" Specifies that the first line of the description should be indented at
  236. .\" least
  237. .\" .I nnn
  238. .\" characters; extra spaces will be added as required. If necessary
  239. .\" because of the length of the
  240. .\" .B dir
  241. .\" menu entry details it may be offset more. The default is 27.
  242. 説明文の最初の行を少なくとも
  243. .I nnn
  244. 字だけ字下げすべきものと指定する。余分な空白が必要なものとして加えられる。
  245. .B dir
  246. のメニューエントリの詳細の長さのため、より多くのオフセットが必要かもしれ
  247. ない。デフォルトは 27 である。
  248. .TP
  249. .BI \-\-calign= nnn
  250. .\" Specifies that the second and subsequent lines of the description
  251. .\" should be indented at least
  252. .\" .I nnn
  253. .\" characters. The default is 29.
  254. 説明文の二行目以降の行を少なくとも
  255. .I nnn
  256. だけ字下げすべきものと指定する。デフォルトは 29 である。
  257. .TP
  258. .BI \-\-maxwidth= nnn
  259. .\" Specifies that the maximum width for the Info file is
  260. .\" .IR nnn .
  261. .\" This is used when wordwrapping the descriptive text.
  262. .\" The default is 79.
  263. Info ファイルの最大幅を
  264. .IR nnn
  265. と指定する。説明文をワードラップするときに使われる。
  266. デフォルトは 79 である。
  267. .TP
  268. .B \-\-quiet
  269. .\" Prevents the usual display of the new menu entry just before it is
  270. .\" inserted, and of the messages announcing the replacement and removal
  271. .\" of existing entries and the creation and deletion of sections.
  272. 挿入される直前の新たなメニューエントリと、現存するエントリの置換・削除や
  273. セクションの作成・削除の案内のメッセージを表示しない。
  274. .TP
  275. .B \-\-help
  276. .\" Causes
  277. .\" .B install-info
  278. .\" to display its usage information and exit.
  279. .B install-info
  280. の使用法を表示して終了する。
  281. .TP
  282. .B \-\-version
  283. .\" Causes
  284. .\" .B install-info
  285. .\" to display its version and copyright information and exit.
  286. .B install-info
  287. のバージョンと著作権の情報を表示して終了する。
  288. .TP
  289. .BI \-\-description= xxx
  290. .\" Specifies that the description to use after the menu entry in new or
  291. .\" updated entries be
  292. .\" .IR xxx .
  293. .\" The default is to use the the value specified in the Info file itself;
  294. .\" this is found by searching for a section of the form
  295. .\" .br
  296. .\" .B START\-INFO\-DIR\-ENTRY
  297. .\" .br
  298. .\" .B * Auto-PGP: (auto-pgp). PGP under GNU Emacs.
  299. .\" .br
  300. .\" .B END\-INFO\-DIR\-ENTRY
  301. 新規・更新のメニューエントリの説明文を
  302. .IR xxx
  303. とする。デフォルトでは Info ファイル自身の中で指定された値を使う。これは
  304. .br
  305. .B START\-INFO\-DIR\-ENTRY
  306. .br
  307. .B * Auto-PGP: (auto-pgp). PGP under GNU Emacs.
  308. .br
  309. .B END\-INFO\-DIR\-ENTRY
  310. .br
  311. という形式のセクションを探すことで見つけられる。
  312. .\" If the entry found in the Info file itself extends across several
  313. .\" lines, each giving a menu entry, the text found in the file is used
  314. .\" verbatim. In this case the alphabetic ordering scheme is turned off,
  315. .\" and the entries are inserted at the top of section in question. In
  316. .\" this case the
  317. .\" .BR \-\-menuentry ", " \-\-maxwidth ", " \-\-align ", " \-\-calign
  318. .\" .RB " and " \-\-menuentry
  319. .\" options are ignored.
  320. Info ファイルに見つかったエントリ自身がそれだけで数行に渡り、それぞれに
  321. メニューのエントリがある場合、ファイルの中に見つかったテキストがそのまま
  322. 使われる。このときは、アルファベット順の配置は行われず、エントリは問い合
  323. わせのセクションの先頭に挿入される。また
  324. .BR \-\-menuentry ", " \-\-maxwidth ", " \-\-align ", " \-\-calign
  325. .RB ", " \-\-menuentry
  326. のオプションは無視される。
  327. .\" If there is no
  328. .\" .B dir
  329. .\" entry in the file the program will try to find a paragraph early in
  330. .\" the file starting
  331. .\" .BR "this file documents" .
  332. .\" It will capitalise the first character of the remainder, and use that.
  333. ファイルに
  334. .B dir
  335. エントリがなかったら、ファイルの最初のほうに
  336. .BR "this file documents"
  337. で始まる段落がないかを見つけようとする。その後の最初の文字を大文字にして
  338. それを使う。
  339. .\" It is an error for none of these methods to yield a description.
  340. これらの方法で説明文を得ることができなかったらエラーになる。
  341. .\" If a description argument is given when
  342. .\" .B \-\-remove
  343. .\" is specified it is ignored and a warning is issued.
  344. .B \-\-remove
  345. が指定されたときには説明文の引数が与えられても無視され、警告が発せられる。
  346. .TP
  347. .BI \-\-menuentry= xxx
  348. .\" Specifies that the entry in the menu should be
  349. .\" .IR xxx .
  350. .\" The default is to use the the value specified in the Info file itself.
  351. .\" If this is not present the basename of the Info file is used
  352. .\" .RB "(any " ".info " "is deleted, and the entry is made mixed case)."
  353. .\" See above for details of the format expected for the menu entry in the
  354. .\" Info file.
  355. メニューの中のエントリを
  356. .IR xxx
  357. とする。デフォルトでは、 Info ファイル自身の中で指定された値を使う。それ
  358. がなかった場合は、Info ファイルのベースネームが使われる。.info が取り除
  359. かれ、大文字小文字混在のエントリ名が作られる。Info ファイルのメニューエ
  360. ントリの望ましい形式の説明については、上記の記述を参照されたい。
  361. .\" When removing entries the value of the
  362. .\" .B \-\-menuentry
  363. .\" option must match the actual menu entry field in the menu item to be
  364. .\" removed (case not significant). If
  365. .\" .B \-\-menuentry
  366. .\" is omitted no check on the menu entry is done.
  367. エントリを削除するとき、
  368. .B \-\-menuentry
  369. オプションの値は、削除されるメニューアイテムの実際のメニューエントリフィー
  370. ルドと一致しなければならない。
  371. .B \-\-menuentry
  372. を省略したときは、メニューエントリのチェックは行われない。
  373. .TP
  374. .B \-\-keep\-old
  375. .\" Inhibits the replacement of existing entries and the removal of empty
  376. .\" sections.
  377. 現存するエントリの置換や空セクションの削除を行わない。
  378. .\" If the file being installed alreay has an entry in the directory the
  379. .\" old entry will be left alone instead of being replaced; the default is
  380. .\" to overwrite any old entry found with the newly generated one.
  381. すでにインストールされているファイルがディレクトリにエントリを持っている
  382. 場合、古いエントリは置き換えられずそのまま残る。デフォルトでは、古いエン
  383. トリはいずれも新規作成されたものによって置き換えられる。
  384. .\" If
  385. .\" .BR \-\-remove " is specified " \-\-keep\-old
  386. .\" will prevent the removal of the section heading which would otherwise
  387. .\" happen if the section is made empty by the removal.
  388. .B \-\-remove
  389. が指定されている場合、削除の結果セクションが空っぽになるかもしれないが、
  390. .B \-\-keep\-old
  391. はセクション見出しを削除しない。
  392. .TP
  393. .B \-\-test
  394. .\" Enables test mode, which inhibits the update of the directory file.
  395. テストモードを有効にし、ディレクトリファイルを更新しない。
  396. .TP
  397. .B \-\-debug
  398. .\" Enables debugging mode, in which the results of some internal
  399. .\" processing steps are shown.
  400. デバッグモードを有効にし、内部の処理ステップをいくらか表示する。
  401. .\" .SH "SEE ALSO"
  402. .SH "関連項目"
  403. emacs(1), info(1), gzip(1)
  404. .\" .SH COPYRIGHT
  405. .SH 著作権
  406. Copyright 1994, Ian Jackson.
  407. .B install\-info
  408. is free software; see the GNU General Public Licence version 2 or
  409. later for copying conditions. There is
  410. .I no
  411. warranty.
  412. .SH 翻訳者
  413. 関戸 幸一 <sekido@mbox.kyoto-inet.or.jp>
  414. .\"
  415. .\" Local Variables:
  416. .\" mode: nroff
  417. .\" comment-start: ".\\\" "
  418. .\" End: