Tar

説明

tar アーカイブを生成します。

basedir 属性はtar を実行するディレクトリへの参照です。

このタスクはディレクトリベースのタスクであり、暗黙的なファイルセットを構成します。 これは、basedirを相対パスとして、 どのファイルがアーカイブに含まれるかを定義します。 tar タスクは、暗黙的なファイルセットに含まれるファイルの集合を精錬するために、 全てのファイルセットの属性をサポートしています。

暗黙的なファイルセットに加えて、tar タスクはネストされたファイルセットもサポートしています。 これらのファイルセットは、 アクセス権、ユーザ名、およびグループ名の制御が tar の内容に対してなされるように拡張うされています。 例えば、これは、一部のファイルに実行権が必要な Unix システムのアーカイブを準備するのに便利です。

tar の古いバージョンでは、 100 文字以上の長さのパスをサポートしていませんでした。 tar の新しいバージョンではサポートしていますが、 互換性の無い方法で行っています。 そのようなパスに遭遇した場合のtar タスクの振る舞いは、 longfile属性により制御されます。 longfile 属性がfailに設定されていた場合、 どんな長いパスでも tar タスクが失敗します。 longfile 属性がtruncateに設定されていた場合、 どんな長いパスでも、アーカイブに加える前に 100 文字という最大長に縮められます。 longfile 属性の値が omitに設定された場合、 長いパス名を持つファイルはアーカイブを省略されます。 どちらのオプションも tar の全ての互換のバージョンで、 解凍可能なアーカイブとなることを保障します。 パスやファイルの情報の欠落が認められない場合、 それは珍しいケースですが、longfile の値を gnuに 設定することもできます。 その際、tar タスクは任意のパスの長さを持つことのできる GNU tar ファイルを生成します。 しかしながら、生成されたアーカイブは GNU tar によってのみ解凍できるということに注意してください。 longfile 属性のデフォルトは、 制限を超えたファイルに遭遇した場合、その都度警告を出すことを除いて、 GNU オプションのように振舞うwarn です。

このタスクは、 compression 属性を "gzip" または "bzip2" に設定することにより圧縮を実行します。

パラメータ

属性 説明 必須
destfile 生成される tar ファイル Yes
basedir ファイルのtarアーカイブを行うディレクトリ No
longfile 長いパス名(>100 文字以上)の扱いを決めます。 利用可能な値は、 "truncate"、 "fail"、 "warn"、 "omit" および "gnu" です。デフォルトは"warn"です。 No
includes カンマまたは空白文字で区切られた、 包含すべきファイルのパターンのリスト。 省略された場合、全てのファイルが包含されます。 No
includesfile ファイルの名前。このファイルの各行が includes パターンとして扱われる No
excludes カンマあるいは空白で区切られた除外するファイルのパターンのリスト。省略された場合、(デフォルト除外ファイルを除き)何も除外しない。 No
excludesfile ファイルの名前; このファイルの各行が excludes パターンとして扱われる No
defaultexcludes デフォルト除外パターンを使うかどうか指定します。 ("yes"/"no") 省略された場合デフォルト除外パターンは使われます。 No
compression 比較方法。可能な値は、 "none"、"gzip" および"bzip2"です。 デフォルトは"none" No

ネストされる要素

tar タスクはネストされた tarfileset 要素をサポートしています。 これらは、標準の fileset 要素に 3 つの属性を加えた拡張されたファイルセットです。
属性 説明 必須
mode 3 つの数字の8進数文字列。 標準の Unix の方法でユーザ、グループ、一般のアクセス権を指定します。 通常のファイルだけ適用する。デフォルトは644 No
dirmode 3 つの数字の8進数文字列。 標準の Unix の方法でユーザ、グループ、一般のアクセス権を指定します。 ディレクトリだけ適用する。 デフォルトは755Ant 1.6から. No
username tar の項目のユーザ名。これは、 現在の tar タスクで設定されている UID と同じではありません。 No
group tar の項目のグループ名。これは、 現在の tar タスクで設定されている GID と同じではありません。 No
prefix prefix 属性が設定されている場合、 ファイルセット中の全てのファイルに、 アーカイブ中のパスの接頭辞がつけられます。 No
fullpath fullpath 属性が設定された場合、 ファイルセット中のファイルはアーカーブ中にそのパスを書き込まれます。 prefix 属性は、設定されても無視されます。 そのようなファイルセットで一つ以上のファイルを指定した場合、 エラーとなります。 No
preserveLeadingSlashes ファイル名で最初の '/' を残しておくか指定します。 デフォルトは falseです。 No

htdocs/manual ディレクトリにある全てのファイルを ${dist}ディレクトリのmanual.tar という名前のファイルに tar アーカイブし、 圧縮に gzip タスクを使います。

  <tar destfile="${dist}/manual.tar"
       basedir="htdocs/manual"
       excludes="mydocs/**, **/todo.html"
  />

htdocs/manual ディレクトリにある全てのファイルを ${dist}ディレクトリのmanual.tar という名前のファイルに tar アーカイブします。 ディレクトリmydocs中のファイル、あるいは、 todo.html という名前のファイルは 除外されます。

<tar destfile="${basedir}/docs.tar">
  <tarfileset dir="${dir.src}/docs"
              fullpath="/usr/doc/ant/README"
              preserveLeadingSlashes="true">
    <include name="readme.txt"/>
  </tarfileset>
  <tarfileset dir="${dir.src}/docs"
              prefix="/usr/doc/ant"
              preserveLeadingSlashes="true">
    <include name="*.html"/>
  </tarfileset>
</tar>

ファイルdocs/readme.txt/usr/doc/ant/READMEとしてアーカイブに書き込みます。 全てのdocsディレクトリにある*.htmlファイルは パスの先頭に/usr/doc/antがつけられます。 例えば、docs/index.html/usr/doc/ant/index.htmlとしてアーカイブに書き込まれます。

<tar longfile="gnu"
     destfile="${dist.base}/${dist.name}-src.tar" >
  <tarfileset dir="${dist.name}/.." mode="755" username="ant" group="ant">
    <include name="${dist.name}/bootstrap.sh"/>
    <include name="${dist.name}/build.sh"/>
  </tarfileset>
  <tarfileset dir="${dist.name}/.." username="ant" group="ant">
    <include name="${dist.name}/**"/>
    <exclude name="${dist.name}/bootstrap.sh"/>
    <exclude name="${dist.name}/build.sh"/>
  </tarfileset>
</tar> 

この例では、長いパスのために GNU 拡張機能を使い、 一部のファイルを実行ファイル(モード755)であるとし、 残りをデフォルトモード(一般が読み書きできる)にして tar ファイルを生成します。 最初のファイルセットは単に実行ファイルを選択しています。 第二のファイルセットは実行ファイルを除外し他の全てのファイルを包含しています。

注意: tar タスクは一つのファイルが一つのファイルセットにのみ選択されているかを確認はしません。同じファイルが一つ以上のファイルセットで選択された場合、 tar ファイルに同じパスで二度包含されることになります。

注意: パターン中の include および exclude 要素は、 全ての他のファイルセットと関連する dir 属性からの相対パスと見なされます。 上の例では、 ${dist.name} は絶対パスではなく、 ディレクトリの簡潔な名前です。 ですから、${dist.name}${dist.name}/..に関連する有効なパスなのです。


Copyright © 2000-2002,2004 The Apache Software Foundation. All rights Reserved.

[訳注:これは漆島賢二の訳を参考に、横田聡が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]