書式
update-alternatives [option...] command説明
update-alternatives は Debian の alternatives システムを構成するシンボリックリンクを生成・削除・管理したり、リンクの情報を表示したりするツールである。同一の、あるいは類似の機能を持つ複数のプログラムを一つのシステムに同時にインストールし、共存させることができる。例えば多くのシステムでは、複数のテキストエディタを共存させている。これにより、システムのユーザは好みに応じて別々のエディタを使うことができるようになる。しかしプログラムからすると、特に指定がなかったときにどのエディタを起動すれば良いのかという、なかなか難しい問題を抱えることになる。
Debian の alternatives システムは、この問題を解決するためのものである。互いに置き換え可能な機能を提供する全てのファイルは、ファイルシステム中の「一般名 (generic name)」を共有する。その一般名が実際にどのファイルを参照するかは、 alternatives システムとシステム管理者とが決定する。例えば、テキストエディタである ed(1) と nvi(1) の両方がシステムにインストールされていたとすると、一般名である /usr/bin/editor は、デフォルトでは /usr/bin/nvi を参照する。システム管理者はこれを上書きし、 /usr/bin/ed を参照させるようにすることもできる。こうすると、その後明示的な設定がなければ、 alternatives システムはその設定を変更しない。
一般名は、選ばれた「選択肢 (alternative)」への直接のシンボリックリンクではなく、 alternatives ディレクトリ にある名前へのシンボリックリンクになっており、その名前が実際に参照されるファイルへのシンボリックリンクになっている。こうなっている理由は、システム管理者による変更を /etc ディレクトリ以下で完結させるためである。なぜこうするのが良いかについては FHS に説明がある。
ある機能を持ったファイルを提供するパッケージがインストール・変更・削除されると、 update-alternatives が呼ばれ、そのファイルに対する alternatives システムの情報を更新する。 update-alternatives は、通常 Debian パッケージの postinst (configure) または prerm (install) スクリプトから呼び出される。
複数の選択肢を同期させ、グループとして変更すると便利なことが多い。例えば vi(1) エディタのいろいろな派生システムが同時にインストールされていたとすると、 /usr/share/man/man1/vi.1 が参照する man ページは、 /usr/bin/vi が参照する実行ファイルに対応しているべきであろう。 update-alternatives は、 master リンクと slave リンクによってこれを取り扱う。 master が変更されると、それに関連づけされた各 slave も同時に変更される。 master リンクとそれに関連づけされた slave とは、 リンクグループ を形成する。
各リンクグループは、いかなる時点においても、 automatic または manual の 2 つのモードのいずれかにある。グループが automatic モードにある場合は、パッケージのインストール・削除の際にリンクを更新するか、どのように更新するかは、 alternatives システムが自動的に決定する。 manual モードでは、 alternatives システムは (何らかの問題が発生した場合を除き) リンクを変更せず、システム管理者の行った設定が保持される。
リンクグループがシステムに導入されると、まず automatic モードとして機能する。システム管理者がその設定を変更すると、次に update-alternatives がリンクグループに対して実行されたときに変更が認識され、そのリンクグループは自動的に manual モードに切り換わる。
各選択肢は priority 属性を持っている。リンクグループが automatic モードにあるときは、 priority のもっとも高いものが、そのグループのメンバーが参照する選択肢になる。
--config オプションを使用すると、 update-alternatives は name で指定された master リンクのリンクグループに対応する選択肢をすべてリストし、現在選択されているものに '*' マークを付与した上で、そのリンクグループの選択肢を確認するプロンプトを表示する。ここで変更を行うと、その一般名は automatic モードではなくなる。 automatic モードに戻すには、 --auto オプションを使用する (もしくは --config オプションで再実行した上で、 automatic モードの選択肢を選択する) 必要がある。
非対話的に設定をしたい場合は --set オプションを代わりに使用する (以下を参照)。
同一のファイルを提供する異なるパッケージは、これを 協調して 行う必要がある。言い換えると、こうした場合、関連するパッケージのすべてで update-alternatives の使用が必須となる。update-alternatives 機構を使用していないパッケージのファイルを上書きすることはできない。
用語
update-alternatives の動作は極めて複雑なので、ここでいくつかの固有の用語を説明し、動作の理解の助けとしたい。- 一般名 (generic name / alternative link)
- /usr/bin/editor のような名前。 alternatives システムによって、類似の機能を持つ複数のファイルのいずれかを参照する。
- 選択肢名 (alternative name)
- alternatives ディレクトリに存在するシンボリックリンク名
- 選択肢 (alternative / alternative path)
- ファイルシステム中の特定ファイルの名称、alternatives システムによって、一般名からのアクセスが可能となる。
- alternatives ディレクトリ
- シンボリックリンクを保持するディレクトリ。デフォルトは /etc/alternatives。
- administrative ディレクトリ
- update-alternatives の状態情報を保持するディレクトリ。デフォルトは /var/lib/dpkg/alternatives。
- リンクグループ
- 関連するシンボリックリンクのセットで、グループ単位での更新を行うためのもの。
- master リンク
- リンクグループに属する選択肢のリンクで、グループ内の他のリンクの設定を決定するもの。
- slave リンク
- リンクグループに属する選択肢のリンクで、 master リンクの設定によって設定されるもの。
- automatic モード
- リンクグループが automatic モードにある場合、alternatives システムは、グループ内の各リンクが priority のもっとも高い選択肢を参照することを担保する。
- manual モード
- リンクグループが manual モードにある場合、alternatives システムはシステム管理者の行った設定を一切変更しない。
コマンド
- --install link name path priority [--slave link name path]...
- 選択肢のグループをシステムに追加する。link は master リンクの一般名、name は alternatives ディレクトリにおけるシンボリックリンクの名前、 path は master リンクとなる選択肢の名前となる。--slave オプションに続く引数は、alternatives ディレクトリでの一般名およびシンボリックリンクの名前と slave リンクとなる選択肢のパスの順となる。--slave オプションと、それにに続く 3 つの引数のセットは、いくつ設定してもよく、まったく設定しないこともできる。master となる選択肢は必ず存在している必要があり、存在していない場合は失敗となるが、slave の選択肢がインストールされていない場合は、(依然として警告が表示されるものの) 対応する slave の選択肢のリンクが単にインストールされないだけである。選択肢のリンクがインストールされるパスに、何らかの実ファイルがインストールされている場合、--force が指定されない限り、それらのファイルは保持される。
- 指定された選択肢の名前が既に alternatives システム内に存在している場合、与えられた情報は、グループに対する新たな選択肢として追加される。それ以外の場合は、与えられた情報を用いて、新しいグループが automatic モードで追加される。グループが automatic モードにあり、新たに追加された選択肢の priority がそのグループに対してインストールされている他の選択肢のものより高い場合、シンボリックリンクは新たに追加された選択肢を参照するように更新される。
- --set name path
- プログラム path を name の選択肢として設定する。 --config と同等だが、こちらは非対話的であるため、スクリプト向けである。
- --remove name path
- (master の) 選択肢とそれに関連する全ての slave リンクを削除する。 name は alternatives ディレクトリ内の名前であり、 path は name のリンク先に指定されうるファイル名の絶対パスである。 name が実際に path にリンクされている場合には、 name は他の適切な選択肢を参照するよう更新される (グループは automatic モードに戻される) が、そのような選択肢が残っていなければ削除される。関連する slave リンクも対応して更新 (削除) される。 name が現在その path を参照していなければ、リンクの変更は行われない。その選択肢の情報が削除されるだけである。
- --remove-all name
- すべての選択肢と、それに関連するすべての slave リンクを削除する。 name は、alternatives ディレクトリ内の名前である。
- --all
- すべての選択肢に対して --config を呼び出す。これは --skip-auto と組み合わせることで、automatic モードで設定されていないすべての選択肢を確認、設定する際に有用である。問題のある選択肢も表示される。問題のある選択肢をすべて修正するためには yes '' | update-alternatives --force --all を実行すればよい。
- --auto name
- name で指定される選択肢のリンクグループを、automatic モードに変更する。この処理を行う際に、master のシンボリックリンクと対応する各 slave は、現在インストールされている選択肢のうち、もっとも priority の高いものを参照するように更新される。
- --display name
- リンクグループの情報を表示する。表示される情報は、グループのモード (auto か manual か)、master リンクの現在の参照先となる選択肢、他に利用可能な選択肢 (とそれに対応した slave の選択肢)、現在インストールされている選択肢のうち、もっとも priority の高いものである。
- --get-selections
- すべての master の選択肢名 (これらはリンクグループを制御する) と、その状況を列挙する。各行には、(1 つ以上の空白で区切られた) 3 つのフィールドからなる。1 番目のフィールドは選択肢の名前、2 番目は状況 ("auto" か "manual" か)、3 番目は現在の選択肢の選択状況 (これはファイル名であるため、空白を含む可能性のあることに留意) である。
- --set-selections
- 選択肢の設定を、update-alternatives --get-selections の生成する形式で標準入力から読み取り、その内容に従って再設定を行う。
- --query name
- --display と同様に、リンクグループについての情報を表示するが、コンピュータが解析するのに適した形式で行う (以下の QUERY FORMAT セクションも参照のこと)。
- --list name
- リンクグループのすべての対象を表示する。
- --config name
- リンクグループで利用可能なすべての選択肢を表示し、対話的に選択肢の 1 つを選択できるようにする。これにより、リンクグループが更新される。
- --help
- 利用方法を表示して終了する。
- --version
- バージョン情報を表示して終了する。
オプション
- --altdir directory
- alternatives ディレクトリをデフォルトから変えたいときに指定する。
- --admindir directory
- administrative ディレクトリをデフォルトから変えたいときに指定する。
- --log file
- alternatives ディレクトリをデフォルト (/var/log/alternatives.log) から変えたいときに指定する。
- --force
- 選択肢のリンクがインストールもしくは削除されるパスに実ファイルがインストールされていた場合に、update-alternatives にそれらを置き換え、削除させる。
- --skip-auto
- automatic モードで適切に設定されている選択肢について、設定の確認を行わない。このオプションは --config および --all とともに指定した場合のみ有効である。
- --verbose
- update-alternatives の実行内容に付いて、より詳細なコメントを生成する。
- --quiet
- エラー以外のコメントを出力しない。
環境変数
- DPKG_ADMINDIR
- --admindir オプションが指定されていない場合に、この変数が設定されていると、この値が administrative ディレクトリの起点として使用される。
ファイル
- /etc/alternatives/
- デフォルトの alternatives ディレクトリ。 --altdir オプションによって変更できる。
- /var/lib/dpkg/alternatives/
- デフォルトの administration ディレクトリ。 --admindir オプションによって変更できる。
終了ステータス
- 0
- 指定したアクションが正しく実行された。
- 2
- コマンドラインの解釈か、アクションの実行時に問題が発生した。
QUERY FORMAT
update-alternatives --query の形式としては、RFC822 に似たフラットなものが使用されている。これは n + 1 ブロックからなっており、ここで n はクエリ対象のリンクグループで利用可能な選択肢の数を意味する。最初のブロックには、以下のフィールドが含まれる:- Name: name
- alternative ディレクトリに存在する選択肢の名前
- Link: link
- 選択肢の一般名
- Slaves: list-of-slaves
- このヘッダが存在している場合、以降の 行には、この選択肢の master リンクに対応するすべての slave リンクが記述される。これは、slave 毎に 1 行ずつ記述され、各行は、1 文字のスペースに続き、slave の選択肢の一般名、スペース、slave リンクのパスが記述される。
- Status: status
- 選択肢の状況 (auto もしくは manual)
- Best: best-choice
- このリンクグループで最適な選択肢のパス。利用可能な選択肢が存在しない場合、存在しない。
- Value: currently-selected-alternative
- 現在選択されている選択肢のパス。リンクが存在しない場合、none という特別な値が設定される場合がある。
- これ以外のブロックは、クエリ対象のリンクグループにおいて利用可能な選択肢を表示する。
-
- Alternative: path-of-this-alternative
- このブロックの選択肢のパス。
- Priority: priority-value
- この選択肢の priority の値。
- Slaves: list-of-slaves
- When this header is present, the next lines hold all slave alternatives associated to the master link of the alternative. There is one slave per line. Each line contains one space, the generic name of the slave alternative, another space, and the path to the slave alternative.
- 実行例
-
$ update-alternatives --query editor Name: editor Link: /usr/bin/editor Slaves: editor.1.gz /usr/share/man/man1/editor.1.gz editor.fr.1.gz /usr/share/man/fr/man1/editor.1.gz editor.it.1.gz /usr/share/man/it/man1/editor.1.gz editor.pl.1.gz /usr/share/man/pl/man1/editor.1.gz editor.ru.1.gz /usr/share/man/ru/man1/editor.1.gz Status: auto Best: /usr/bin/vim.basic Value: /usr/bin/vim.basic Alternative: /bin/ed Priority: -100 Slaves: editor.1.gz /usr/share/man/man1/ed.1.gz Alternative: /usr/bin/vim.basic Priority: 50 Slaves: editor.1.gz /usr/share/man/man1/vim.1.gz editor.fr.1.gz /usr/share/man/fr/man1/vim.1.gz editor.it.1.gz /usr/share/man/it/man1/vim.1.gz editor.pl.1.gz /usr/share/man/pl/man1/vim.1.gz editor.ru.1.gz /usr/share/man/ru/man1/vim.1.gz
診断メッセージ
--verbose を指定した場合、update-alternatives は、実行中の処理内容を逐一標準出力に出力する。問題が起きると、 update-alternatives はエラーメッセージを標準エラー出力に出力し、終了ステータス 2 を返す。これらの診断メッセージは、読めばわかるはずである。もしわからなければ、バグとして報告して欲しい。例
例えば nvi や vim のように、テキストエディタ vi と互換性のあるプログラムを提供するパッケージが複数ある。どのパッケージが使われるかは、リンクグループ vi によって制御される。リンクグループ vi にはプログラム自身のリンクと、関連する man ページのリンクが含まれる。vi を提供するパッケージとその現在の設定を表示するには、--display アクションを使用する:
-
update-alternatives --display vi
特定の vi の実装を選ぶには、root としてこのコマンドを実行し、一覧から数字を選ぶ:
-
update-alternatives --config vi
vi 実装の選択を自動的に行なうように戻すには、root としてこのコマンドを実行する:
-
update-alternatives --auto vi
バグ
バグを見つけた場合、 Debian バグ追跡システムを使って報告してほしい。update-alternatives の動作とこのマニュアルページの記述に矛盾があれば、実装かドキュメントどちらかのバグである。報告をお願いしたい。