install-info.8 17 KB

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