info/GNU_which/draft/text/which.txt

   1
   2 このファイルは ‘which’ version 2.x を説明するものです。
   3
   4 Copyright © 2000 - 2015, by
   5
   6 Carlo Wood, Run on IRC <carlo@alinoe.com>
   7 RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
   8 Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
   9
  10 Permission is granted to make and distribute verbatim copies of
  11 this manual provided the copyright notice and this permission notice
  12 are preserved on all copies.
  13
  14 ‘which’: コマンドのフルパス表示
  15 *******************************
  16
  17 ‘which’ プログラムは（シェル）コマンドのフルパスを表示します。
  18
  19 This file documents ‘which’ version 2.21, updated 20 March 2015.
  20
  21 1 ‘which’ プログラム
  22 ********************
  23
  24 ‘which’ は 1 つまたは複数の引数を取ります。その引数それぞれに対して、そ
  25 の引数がシェルプロンプトから入力された際に、実行されることになる実行モジ
  26 ュールのフルパスを stdout に出力します。 これを実現する際には、環境変数
  27 ‘PATH’ に列記されたディレクトリ内から実行ファイルやスクリプトを検索しま
  28 す。 これは ‘bash(1)’ と同じアルゴリズムを用いています。
  29
  30 2 ‘which’ の実行
  31 ****************
  32
  33 ‘which’ の実行書式は以下のとおりです。
  34
  35      which [options] [--] programname [...]
  36
  37 3 オプションの概要
  38 ******************
  39
  40 ‘--all’
  41 ‘-a’
  42      ‘PATH’ において見つかった実行ファイルをすべて表示します。最初に見つ
  43      かった一つだけではありません。
  44
  45 ‘--read-alias’
  46 ‘-i’
  47      標準入力からエイリアスを読み込んで、合致したものを標準出力します。
  48      これは which そのものを含む alias において、本オプションを合わせて
  49      利用すると便利です。 たとえば以下です。
  50      ‘alias which='alias | which -i'’
  51
  52 ‘--skip-alias’
  53      ‘--read-alias’ が指定されても無視します。which に対するエイリアスや
  54      関数の中で ‘--read-alias’ オプションを利用している場合であっても、
  55      明示的に通常の実行ファイルを検索する場合に利用できます。
  56
  57 ‘--read-functions’
  58      標準入力からシェル関数定義を読み込んで、合致したものを標準出力しま
  59      す。これは which そのものを含むシェル関数において、本オプションを合
  60      わせて利用すると便利です。たとえば以下です。
  61      ‘which() { declare -f | which --read-functions $@ }
  62      export -f which’
  63
  64 ‘--skip-functions’
  65      ‘--read-functions’ が指定されても無視します。which に対するエイリア
  66      スや関数の中で ‘--read-functions’ オプションを利用している場合であ
  67      っても、明示的に通常の実行ファイルを検索する場合に利用できます。
  68
  69 ‘--skip-dot’
  70      ‘PATH’ 内のディレクトリにうち、ドットで始まるディレクトリは除外しま
  71      す。
  72
  73 ‘--skip-tilde’
  74      チルダで始まる ‘PATH’ 内のディレクトリ、および ‘HOME’ ディレクトリ
  75      内に存在する実行ファイルは除外します。
  76
  77 ‘--show-dot’
  78      ‘PATH’ 内にドットで始まるディレクトリがあって、合致した実行ファイル
  79      がその中に見つかった場合には、フルパスでなく "./programname" と表示
  80      します。
  81
  82 ‘--show-tilde’
  83      ディレクトリが ‘HOME’ に合致した場合、チルダを表示します。 このオプ
  84      ションは root ユーザーが実行した際には無視されます。
  85
  86 ‘--tty-only’
  87      tty 上でない場合、この右側に指定されたオプションの実行を停止します
  88      。
  89
  90 ‘--version, -v, -V’
  91      バージョン情報を標準出力して正常終了します。
  92
  93 ‘--help’
  94      利用方法を標準出力して正常終了します。
  95
  96 4 返り値
  97 ********
  98
  99 ‘which’ は、処理に失敗した引数の数を返します。また ‘programname’ が指定
 100 されなかった場合は -1 を返します。
 101
 102 5 例
 103 ****
 104
 105 本ユーティリティーを利用するには、‘which’ に対して、エイリアスを追加する
 106 (C シェルの場合) 、あるいはシェル関数を追加する (Bourne シェル) 方法が推
 107 奨されます。たとえば以下のようにします。
 108
 109    [ba]sh:
 110
 111      which ()
 112      {
 113        (alias; declare -f) | /usr/bin/which --tty-only --read-alias --read-functions --show-tilde --show-dot $@
 114      }
 115      export -f which
 116
 117    [t]csh:
 118
 119      alias which 'alias | /usr/bin/which --tty-only --read-alias --show-dot --show-tilde'
 120
 121 この方法にすると、端末から起動した際には、わかりやすく ~/ や ./ を表示し
 122 ます。一方でスクリプトから実行した際には、フルパスを表示します。
 123
 124      > which q2
 125      ~/bin/q2
 126      > echo `which q2`
 127      /home/carlo/bin/q2
 128
 129 6 バグ
 130 ******
 131
 132 ‘HOME’ ディレクトリは、環境変数 ‘HOME’ を調べることで決定されますが、こ
 133 の変数が存在しない場合には、その処理がキャンセルされます。‘which’ は 2 つ
 134 の同等のディレクトリであっても、その 1 つにシンボリックリンクを使ったパ
 135 スが含まれている場合に、別のディレクトリと取り扱ってしまいます。
 136
 137 7 関連項目
 138 **********
 139
 140 ‘bash(1)’
 141
 142 さくいん
 143 ********
 144
 145 * Menu:
 146
 147 * --all:                                 オプションの概要.    (line  39)
 148 * --help:                                オプションの概要.    (line  92)
 149 * --read-alias:                          オプションの概要.    (line  44)
 150 * --read-functions:                      オプションの概要.    (line  56)
 151 * --show-dot:                            オプションの概要.    (line  76)
 152 * --show-tilde:                          オプションの概要.    (line  81)
 153 * --skip-alias:                          オプションの概要.    (line  51)
 154 * --skip-dot:                            オプションの概要.    (line  68)
 155 * --skip-functions:                      オプションの概要.    (line  63)
 156 * --skip-tilde:                          オプションの概要.    (line  72)
 157 * --tty-only:                            オプションの概要.    (line  85)
 158 * --version:                             オプションの概要.    (line  89)
 159 * -a:                                    オプションの概要.    (line  39)
 160 * -i:                                    オプションの概要.    (line  44)
 161 * -v:                                    オプションの概要.    (line  89)
 162 * -V:                                    オプションの概要.    (line  89)
 163 * aliases, handling of:                  例.                  (line 104)
 164 * Bugs, known:                           バグ.                (line 131)
 165 * Command line Options:                  オプションの概要.    (line  39)
 166 * Description of which:                  which プログラム.    (line  23)
 167 * Examples:                              例.                  (line 104)
 168 * Options, command line:                 オプションの概要.    (line  39)
 169 * Overview of command line options:      オプションの概要.    (line  39)
 170 * Return value of which:                 返り値.              (line  98)
 171 * Synopsis:                              which の起動.        (line  32)
 172 * which の実行:                          which の起動.        (line  32)
 173
 174 ‘which’: コマンドのフルパス表示
 175 1 ‘which’ プログラム
 176 2 ‘which’ の実行
 177 3 オプションの概要
 178 4 返り値
 179 5 例
 180 6 バグ
 181 7 関連項目
 182 さくいん