INSTALL-INFO(8)

名前
install-info - Info ディレクトリにエントリを作成したり更新したりする

書式
install-info [--version] [--help] [--debug] [--maxwidth=nnn] [--section regexp title] [--infodir=xxx] [--align=nnn] [--quiet] [--menuentry=xxx] [--description=xxx] [--remove | --remove-exactly ] [--] filename

説明

install-info は、Info ディレクトリの dir ファイルにエントリを作成・更新・削除する。作成か更新の場合、 コマンドラインにも Info ファイルにも説明文が指定されていなかったら、 ファイルの中身から説明文を推測しようとする。

エントリの置かれる位置や dir ファイルの望ましい形式の説明については、 --section の記述を見られよ。

  オプション

[--] filename
    メニューエントリを作成・更新・削除したい Info ファイルのファイル名を与える。 --remove-exactly が指定された場合は、 filename は削除対象の正確なエントリ名 (例えば "emacs-20/emacs" とか "gcc") でなければならない。 指定されなかった場合は、このファイル名のベースネームが 作成されるメニューエントリのリファレンスとして使われる (ただしそのファイルの内部で START-INFO-DIR による上書きがされている場合は除く)。 従ってこのファイルは dir ファイルと同じディレクトリに存在していなけらばならない。 あるいは、ほぼインストールされているか、 エントリ削除の場合は以前存在していたか、でなければならない。 --infodir オプションを参照せよ。

    filename が .gz で終わっていたら、GNU gzip で圧縮されているファイルであるとみなされる。 filename は存在しないがこれに対応する filename.gz が存在する場合は、替わりに filename.gz が使われる。

    エントリを追加か更新するときは、ファイル（拡張子 .gz が付加的に付いているかもしれない は指定されたパスに存在していなければならない。

--remove
    ファイル filename のエントリを削除することを指定する。 デフォルトではエントリは作成もしくは更新される。

    削除の結果セクションが空っぽになる場合、 これがファイルの最後のセクションでないか --keep-old が指定されるかしていなかったら、セクション見出しも同様に削除される。 dir ファイルの望ましい形式の説明については、 --section の記述を見られよ。

    あてはまるエントリが dir ファイルにいくつかある場合、 最初にマッチしたカテゴリグループのものが削除され、 残りは無視される。

    install-info は --quiet オプションが指定されない限り警告を発するが、このオプションについては、 あてはまるエントリが見つからなくてもエラーにはならない。

    --remove オプションが指定された場合、 --maxwidth , --align ,--calign の整形オプションは無視される。

--remove-exactly
    このオプションは基本的には --remove と同じだが、ただし filename を削除対象となる既存のファイルとしてではなく、 削除対象のエントリそのものとみなす。 この違いは、サブディレクトリの info ファイルを参照しているエントリ (例えば "emacs-20/emacs" など) を削除しようとする場合に重要となる。 なぜなら --remove は与えられた filename そのものではなく、そのベースネームに作用するからである (つまり --remove "emacs-20/emacs" とすると、 install-info は "emacs-20/emacs" ではなく "emacs" を対象とする)。

--section regexp title
    新しいエントリを作るときに、 dir ファイルの中でタイトルが regexp にマッチするセクションに配置することを指定する。 該当するセクションが存在しなかったら、 ファイルの最後から二番目のセクション（後述）として title というタイトルで作られる。 セクションとは dir メニューの中の一部で、空白行で区切られたものである。 セクションの先頭行はタイトルとして扱われる。

    新たなエントリを作るとき、 install-info はセクションの中でアルファベット順にそれを挿入しようとする。 セクション中のエントリがあらかじめソートされていなかったら、 セクション中の位置は予測できない。 すでに存在するエントリの順番は変更されない。

    デフォルトでは新たなエントリをファイルの終わりに付け加える。 最後のセクションは、 タイトル行だけであっても常に存在していなけらばならない。 これは新たなセクションが正しい場所に作られるようにするためである。 最後のセクションは、位置が正しく指定されていない Info ファイルがそこに付け加えられるようにタイトルを付けなければならない。

    Info ファイルのエントリがすでにインストールされていたら、 その位置で新たなエントリに置き換えられる。

    エントリ削除時にセクションを指定すると、 セクションは無視され警告が発せられる。

    エントリを加えるときにセクションが必要となるにもかかわらず ファイルにセクション見出しが一つもなかったら、 install-info は必要となるセクションとファイルの終わりの Miscellaneous というセクションとの両方を作る。

--infodir=infodir
    dir ファイルと、インストールされる新たな Info ファイルのコピーとが infodir にあることを指定する。デフォルトは /usr/info である。

--align=nnn [非推奨]
    説明文の最初の行を少なくとも nnn 字だけ字下げすべきものと指定する。余分な空白が必要なものとして加えられる。 dir のメニューエントリの詳細の長さのため、 より多くのオフセットが必要かもしれない。デフォルトは 27 である。

--calign=nnn [非推奨]
    説明文の二行目以降の行を少なくとも nnn だけ字下げすべきものと指定する。デフォルトは 29 である。

--maxwidth=nnn [非推奨]
    Info ファイルの最大幅を nnn にする。説明文をワードラップするときに使われる。 デフォルトは 79 である。

--quiet
    挿入される直前の新たなメニューエントリと、現存するエントリの置換・削除や セクションの作成・削除の案内のメッセージを表示しない。

--help
    install-info の使用法を表示して終了する。

--version
    install-info のバージョンと著作権の情報を表示して終了する。

--description=xxx
    新規・更新のメニューエントリの説明文を xxx とする。デフォルトでは Info ファイル自身の中で指定された値を使う。これは
    START-INFO-DIR-ENTRY
    * Auto-PGP: (auto-pgp). PGP under GNU Emacs.
    END-INFO-DIR-ENTRY という形式のセクションを探すことで見つけられる。

    Info ファイルに見つかったエントリ自身がそれだけで数行に渡り、 それぞれにメニューのエントリがある場合、 ファイルの中に見つかったテキストがそのまま使われる。 このときは、アルファベット順の配置は行われず、 エントリは問い合わせのセクションの先頭に挿入される。また --menuentry, --maxwidth, --align, --calign , --menuentry のオプションは無視される。

    ファイルに dir エントリがなかったら、ファイルの最初のほうに this file documents で始まる段落がないかを見つけようとする。 その後の最初の文字を大文字にしてそれを使う。

    これらの方法で説明文を得ることができなかったらエラーになる。

    --remove が指定されたときには説明文の引数が与えられても無視され、警告が発せられる。

--menuentry=xxx
    メニューの中のエントリを xxx とする。デフォルトでは、 Info ファイル自身の中で指定された値を使う。 それがなかった場合は、 Info ファイルのベースネームが使われる。.info が取り除かれ、 大文字小文字混在のエントリ名が作られる。 Info ファイルのメニューエントリの望ましい形式の説明については、 上記の記述を参照されたい。

    エントリを削除するとき、 --menuentry オプションの値は、削除されるメニューアイテムの 実際のメニューエントリフィールドと一致しなければならない。 --menuentry を省略したときは、メニューエントリのチェックは行われない。

--keep-old
    現存するエントリの置換や空セクションの削除を行わない。

    すでにインストールされているファイルが ディレクトリにエントリを持っている場合、 古いエントリは置き換えられずそのまま残る。デフォルトでは、 古いエントリはいずれも新規作成されたものによって置き換えられる。

    --remove が指定されている場合、削除の結果セクションが空っぽになるかもしれないが、 --keep-old はセクション見出しを削除しない。

--test
    テストモードを有効にし、ディレクトリファイルを更新しない。

--debug
    デバッグモードを有効にし、内部の処理ステップをいくらか表示する。

関連項目
emacs(1), info(1), gzip(1)

著作権
Copyright 1994, Ian Jackson. install-info is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is no warranty.

翻訳者
関戸 幸一 <sekido@mbox.kyoto-inet.or.jp>

翻訳者注
このマニュアルページは dpkg パッケージに付属の install-info(8) の日本語訳である。 翻訳対象は dpkg パッケージのバージョン 1.10.20 に付属のものである。