UNIX findとxargsコマンドで-print0オプションを使う理由

このドキュメントの内容は、以下の通りです。

• はじめに
• Unix系OSでファイルを探す方法
• findコマンドとほかのコマンドを連携する方法
• xargs コマンド とは
• findとxargsの連携で問題になるケースとは
• findとxargsを組み合わせて失敗する例
• スペースが含まれるファイル名を正しく扱う方法
• まとめ

はじめに

2018-05-03 に ページのタイトルはそのままですが、「真 UNIX findとxargsコマンドで-print0オプションを使う理由」として記事をアップデート致しました。

毎日やることの１つに、なにかを探すことが含まれます。インターネットで何かを調べていたり、作ったファイルやダウンロードしたファイルを探したりしています。ファイルを探すと同時に探したファイルに対して、何らかの変更を加えることもしばしばあります。

ファイルを検索とファイルの編集を一度にできたら、と思うこともあるでしょう。 find には、 exec オプションがあったり、 xargs などと組み合わせて扱うことができます。 find と xargs を組み合わせて使うときに、ファイル名にスペースやタブが入っていると、思わなく結果になることがあります。findとxargsを空白などの配慮なく実行してしまうと、 read me.txtというファイル名があるときに、xargs によって read と me.txt として扱われてしまう、ということです。そういうときに、正しく処理する方法を紹介します。

Unix系OSでファイルを探す方法

Linux や FreeBSD などのUNIX OSでファイルを検索する方法として、以下のコマンドがあります。

• find
• locate

findコマンドとほかのコマンドを連携する方法

Unix の find コマンドにはいろいろなオプションがあり、パワフルな検索機能を提供してくれます。find の exec を使えば、ほかのコマンドを連携できますが、 UNIXで findコマンドをパイプでxargsとつなぐこともよくあります。

find . -name '*.txt'  | xargs ls

xargs コマンド とは

xargsとは、 Unix 系 OS に用意されているコマンドの１つです。

xargs は、標準入力 を読み込みます。xargs には、引数で実行するコマンドを指定します。 xargs は、標準入力から「読み込んだ文字列」を「引数で指定されたコマンド」の引数にして、「引数で指定されたコマンド」を実行します。

findとxargsの連携で問題になるケースとは

下記のケースだと問題になることがあります。それはどんなケースかというと、ファイル名にスペースが含まれるときです。

find . -name '*.txt'  | xargs ls

例えば、こんな名前だったら

read me.txt

read と me.txt として xargs が扱ってしまいます。
echo と xargs でやってみると

$ echo 'read me.txt' | xargs -n1 echo
read
me.txt

こんな感じになります。

上記の問題がおきるケースでの解決策を先に示しておくと、以下の-print0や-0オプションを使うことになります。

find . -name '*.txt' -print0 | xargs -0 ls

この謎のオプション達(-print0と-0)については、後述します。

findとxargsを組み合わせて失敗する例

失敗する例を示してみます。 ファイル名にスペースが含まれたファイルを作成し、findの結果をxargsに渡して、lsを実行させます。

mkdir tmp
cd tmp
touch 'abc def.txt'
find . -name '*.txt'  | xargs  ls
ls: ./abc: No such file or directory
ls: def.txt: No such file or directory

lsコマンドの結果からわかるように、スペースが含まれるファイル名は、別々なものとして認識されています。
この問題は、xargsが区切り文字(デミリタ, delimiter) としてスペースを使っているからです。xargsは、デミリタとして、スペース、タブ、改行です。

スペースが含まれるファイル名を正しく扱う方法

スペースやタブなどが含まれるファイル名は、ファイル名が xargs によって、スペースやタブなどで縊られてしまいます。この問題を回避するためには、区切り文字をスペース以外のものにする必要があります。findコマンドでは、-print0というオプションが用意されています。-print0オプションを有効にすると区切り文字がスペースから \0(ヌル文字)に変更されます。xargsコマンドは、-0オプションを指定されると \0を区切り文字(デミリタ)として扱います。\0(ヌル文字)は、C言語で文字列の終端に使われているものです。

findの-print0オプションとxargsの-0オプションを有効にした結果です。

% find . -name '*.txt' -print0 | xargs -0 ls
./abc def.txt

-0オプションは、 --nullという別名も持っています。

まとめ

find からパイプで xargs につなぐ場合には、ファイル名にスペース(スペース、タブ)が含まれている場合には、 find に -print0 オプションを指定し、 xargs に -0 オプションを指定することで、スペースが含まれるファイル名を正しくハンドルできます。

---