書式

説明

file は各引き数をテストして分類する。 ファイルシステムテスト、マジックナンバーテスト、言語テストの 順序で 3 つのテストを行う。 そのうちの最初に成功したテストで、ファイルタイプを表示する。

表示されるタイプには通常以下のうち 1 つの単語が含まれる。 text (このファイルには表示可能文字といくつかの一般的な制御文字のみが含まれ、 ASCII 端末で読んでも多分安全である)、 executable (このファイルにはプログラムをコンパイルした結果が含まれ、 UNIX カーネルなどにより実行可能な形式である)、 data その他のもの (data は通常「バイナリ」または表示不能なファイルである)。 ただしバイナリデータを含んでいる良く知られた形式のフォーマット (core ファイル、tar アーカイブなど) は例外である。 /usr/share/file/magic ファイルや file プログラム自身を変更する場合も、 これらのキーワードは変更しないこと。 人々は、ディレクトリ内の読み取り可能なファイルに対しては、 全て ``text'' が表示されると思っている。 Berkeley がかつてやったように、 ``shell commands text'' を ``shell script'' に変更したりしてはいけない。 ファイル /usr/share/file/magic は、このプログラムのソースディストリビューションのサブディレクトリ Magdir にある数多くの小さなファイルから機械的に作られている点に注意すること。

ファイルシステムのテストは、 stat(2) システムコールの結果の検討に基づいて行われる。 このプログラムは、ファイルが空であるかや、 特殊ファイルであるかをチェックする。 実行中のシステムに特有の既存のファイルタイプ (ソケット・シンボリックリンク・名前付きパイプ (FIFO) (ただしシステムで実装されている場合)) は、 システムのヘッダファイル <sys/stat.h> に定義されていれば、すぐに分かる。

マジックナンバーテストは、 特定の決まった形式のデータを含むファイルをチェックするのに使われる。 もっとも簡単な例は、バイナリ実行可能ファイル (コンパイルされたプログラム) a.out である。 この形式は標準インクルードディレクトリの a.out.h で定義されている (exec.h の場合もある)。 これらのファイルにはファイルの先頭付近の特定位置に 「マジックナンバー」が格納されている。 これにより UNIX オペレーティングシステムは、 ファイルがバイナリ実行可能であることが分かり、 そのうちのどのファイルタイプであるかも分かる。 「マジックナンバー」の考え方は、データファイルに対する拡張にも応用されている。 ファイルの先頭から近い場所に一定の識別子を持つファイルは、 通常はこの方法で記述できる。 これらのファイルについての情報識別子は、コンパイルされたマジックファイル /usr/share/file/magic.mgc から読み込まれる。 このコンパイルされたファイルがない場合は、 /usr/share/file/magic から読み込まれる。 更に file は $HOME/.magic.mgc または $HOME/.magic からマジックファイルのエントリを探す。

ファイルがマジックファイルのどのエントリともマッチしなかった場合、 テキストファイルであるかを調べる。 文字集合内の表示可能なテキストを構成する バイト列の範囲の違いを調べることにより、 ASCII, ISO-8859-x, (Macintosh や IBM PC システムで使用されている) ISO に準拠しない 8 ビット拡張 ASCII 文字集合、 UTF-8 エンコードされたユニコード、UTF-16 エンコードされたユニコード、 EBCDIC 文字集合を識別する。 ファイルがこれらのテストをパスすると、文字集合名が表示される。 ASCII, ISO-8859-x, UTF-8, 拡張 ASCII のファイルは、 これはほぼ全ての端末で読むことができるので、 ``text'' として識別される。 UTF-16 と EBCDIC のファイルは、 たとえテキストを含んでいたとしても読む前に変換が必要なので、 単なる ``character data'' とされる。 さらに file はテキスト型ファイルの他の特徴も決定しようとする。 ファイルの行が Unix で標準的な LF ではなく、 CR, CRLF, NEL で終了している場合は、その旨を表示する。 ファイルに組み込み (embedded) エスケープシーケンスや 重ね打ち (overstriking) が含まれている場合も、その旨を表示する。

file はテキスト型ファイルで使われている文字集合を決定した後は、 ファイルが書かれている言語を決定しようとする。 言語テストではファイルの最初の数ブロックのどこかに現れる特定の文字列 (names.h を参照) を探す。 例えばキーワード .br があれば、そのファイルは多くの場合 troff(1) の入力ファイルであることを示しており、 キーワード struct は C 言語プログラムであることを示している。 これらのテストは前のテストに比べると信頼性が低いので、 最後に実行される。 言語テストのルーチンは他のファイルタイプ (例えば tar(1) アーカイブ) に関するテストも行う。

上に挙げた文字集合のどれにも当てはまらないファイルは、 単に ``data'' と表示される。

オプション

-b, --brief

出力行の最初にファイル名を表示しない (簡易モード)。

-c, --checking-printout

マジックファイルの解析形式を表示してチェックする。 通常は -m オプションと一緒に用いて、 新しいマジックファイルをインストールする前のデバッグに使う。

-C, --compile

マジックファイルを事前に解析した内容を含む出力ファイル magic.mgc を書き出す。

-f, --files-from namefile

他の引き数リストより先に、検査するファイルの名前を namefile ファイルから読み込む (1 行に 1 つのファイル名)。 namefile または少なくとも 1 つのファイル名引き数がなければいけない。 標準入力をテストする場合は、ファイル名引き数として ``-'' を使うこと。

-F, --separator separator

指定した文字列をファイル名とファイルをテストした結果の区切り文字とする。 デフォルトは ``:'' である。

-i, --mime

file コマンドの出力を人間が読みやすい昔ながらのものではなく、 mime タイプ文字列にする。 したがって ``ASCII text'' ではなく、 ``text/plain; charset=us-ascii'' のように出力される。 このオプションを動作させるため、 file コマンドが認識するファイルの取り扱い方法 (多くのテキストファイルタイプやディレクトリ) を変更し、 別の ``magic'' ファイルを使うようにした。 (下記の「ファイル」のセクションを参照)。

-k, --keep-going

最初にマッチしたもので停止せず、次のマッチングに進む。

-L, --dereference

(システムがシンボリックリンクをサポートしている場合は) ls(1) の同じ名前のオプションと同様に、シンボリックリンクを辿るようにさせる。

-m, --magic-file list

マジックナンバーが書かれた別のファイルのリストを指定する。 1 つのファイルでも、コンマで区切られたファイルのリストでもよい。 コンパイル済みのマジックファイルが一緒に指定された場合は、 代りにそれを使う。

-n, --no-buffer

1 つのファイルをチェックする毎に、標準出力をフラッシュする。 これは複数のファイルをチェックするときにのみ役立つ。 このオプションは、ファイルタイプをパイプから出力する プログラムで使われることを意図している。 -i または --mime オプションと一緒に指定すると、 このプログラムは各ファイル名の後に ".mime" を追加する。

-N, --no-pad

出力を整列するためのファイル名への空白の追加を行わない。

-p, --preserve-date

utime(2) または utimes(2) をサポートするシステムでは、 file(1) が解析したファイルを読み込まれなかったかのようにするため、 アクセス時刻を保存しようとする。

-r, --raw

印字不能文字を \ooo に変換しない。 通常、 file は印字不能文字を 8 進数表現に変換する。

-s, --special-files

通常 file は、引き数で指定されたファイルのうち stat(2) で通常のファイル (ordinary file) とされたファイルのみを読み込んで、 タイプの決定を行う。 特殊ファイルを読み込むと異常な結果を引き起こすかも知れないため、 この動作により問題を防止している。 -s オプションを指定すると、 file は引き数で指定されたブロックスペシャルファイルや キャラクタスペシャルファイルも読み込む。 ブロックスペシャルファイルである raw ディスクパーティションのデータの ファイルシステムタイプを決定するのに役立つ。 このオプションを指定すると file は stat(2) が返すファイルサイズを無視する。 これは raw ディスクパーティションのサイズを 0 として返すシステムも存在するためである。

-v, --version

プログラムのバージョンを表示して終了する。

-z, --uncompress

圧縮ファイルの中も検査する。

--help

ヘルプメッセージを表示して終了する。

ファイル

/usr/share/file/magic.mgc

デフォルトのコンパイル済みのマジックナンバーのリスト。

/usr/share/file/magic

デフォルトのマジックナンバーのリスト。

/usr/share/file/magic.mime.mgc

デフォルトのコンパイル済みのマジックナンバーのリスト。 -i オプションが指定された場合に、mime タイプを出力するのに使用される。

/usr/share/file/magic.mime

デフォルトのマジックナンバーのリスト。 -i オプションが指定された場合に、mime タイプを出力するのに使用される。

/etc/magic

マジックナンバーについてのローカルな追加情報。

環境変数

標準への準拠

System V バージョンとの重要な違いは、 このバージョンでは空白を区切り文字として扱うために、 パターン文字列における空白文字をしなければならないという点にある。 例えば、
>10    string  language impress        (imPRESS data)

という既存のマジックファイルは、
>10    string  language\ impress       (imPRESS data)

のように変更しなければならない。 更にこのバージョンでは、バックスラッシュを含むパターン文字列は エスケープしなければならない。 例えば、
0      string          \begindata      Andrew Toolkit document

という既存のマジックファイルは、
0      string          \\begindata     Andrew Toolkit document

のように変更しなければならない。

Sun Microsystems の SunOS releases 3.2 以降には、 System V のものから派生した file(1) コマンドが含まれているが、いくつか拡張されている。 私の作ったバージョンは、Sun のものと些細な違いしかない。 Sun のバージョンは `&' オペレータの拡張が含まれ、 例えば以下のように使われる。
>16    long&0x7fffffff >0              not stripped

マジックディレクトリ

マジックファイルのエントリは順番が重要である。 使用しているシステムによっては、順番の組みが不正であるかもしれない。 古い file コマンドがマジックファイルを使っている場合、 比較のために古いマジックファイルを残しておくこと (/usr/share/file/magic.orig に名前を変更しておく)。

例

$ file file.c file /dev/{wd0a,hda}
file.c:   C program text
file:     ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV),
          dynamically linked (uses shared libs), stripped
/dev/wd0a: block special (0/0)
/dev/hda: block special (3/0)
$ file -s /dev/wd0{b,d}
/dev/wd0b: data
/dev/wd0d: x86 boot sector
$ file -s /dev/hda{,1,2,3,4,5,6,7,8,9,10}
/dev/hda:   x86 boot sector
/dev/hda1:  Linux/i386 ext2 filesystem
/dev/hda2:  x86 boot sector
/dev/hda3:  x86 boot sector, extended partition table
/dev/hda4:  Linux/i386 ext2 filesystem
/dev/hda5:  Linux/i386 swap file
/dev/hda6:  Linux/i386 swap file
/dev/hda7:  Linux/i386 swap file
/dev/hda8:  Linux/i386 swap file
/dev/hda9:  empty
/dev/hda10: empty
$ file -i file.c file /dev/{wd0a,hda}
file.c:      text/x-c
file:        application/x-executable, dynamically linked (uses shared libs),
not stripped
/dev/hda:    application/x-not-regular-file
/dev/wd0a:   application/x-not-regular-file

履歴

System V バージョンをベースにしたこのプログラムは、 誰のソースコードも見ずに Ian Darwin <[email protected]> によって書かれた。

John Gilmore はコードを広範囲にわたって改訂し、 最初のバージョンより改良した。 Geoff Collyer はいくつかの欠点を見つけ、 マジックファイルエントリを提供した。 `&' オペレータについては 1989 年に Rob McMahon, [email protected] が貢献した。

Guy Harris, [email protected] は 1993 年から現在に至るまで 多くの変更を行っている。

Christos Zoulas ([email protected]) は 1990 年に最初の開発を行い、 現在までメンテナンスを行っている。

2000 年の Chris Lowth, [email protected] による変更: 別のマジックファイルと内部ロジックを使い、 ``-i'' で mime タイプ文字列を出力するようにした。

2000 年 7 月の Eric Fischer ([email protected]) による変更: 文字コードを識別し、非 ASCII ファイルの言語を識別するようにした。

"Magdir" ディレクトリ (/etc/magic ファイルのソース) の貢献者のリストは、 長すぎるのでここには含められない。 貢献してくれた人は自分が貢献したことを知っているでしょう。 感謝します。

法的な注意

ファイル tar.h と is_tar.c は John Gilmore によって書かれたもので、 彼のパブリックドメイン tar プログラムに由来する。 この 2 つのファイルには上記のライセンスが適用されない。

入手方法