Zip

Description

説明

Creates a zipfile.

ZIPファイルを作成します。

The basedir attribute is the reference directory from where to zip.

basedir属性はZIPを行うディレクトリです。

Note that file permissions will not be stored in the resulting zipfile.

ファイルのパーミッションは、生成したZIPファイルには保存されないことに注意してください。

It is possible to refine the set of files that are being zipped. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns.

ZIPにするファイルの集合を絞り込むことが可能です。 これには、includesincludesfileexcludesexcludesfiledefaultexcludes属性を使用します。 includesincludesfile属性によって、 パターンを使用して包括したいファイルを指定します。 excludeexcludesfile属性では、 除外したいファイルを指定します。これもまたパターンを使用します。 最後に、defaultexcludes属性によって、 デフォルト除外集合を使うかどうかを指定できます。 ファイルの包括/除外の処理方法や、パターンを記述する方法については、 ディレクトリベースのタスク の節を参照してください。

This task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and <patternset> elements.

このタスクは暗黙のファイルセットを作成して、 ネストした<include><exclude><patternset>要素のように、 <fileset>のすべての属性 (dirbasedirになります) をサポートします。

Or, you may place within it nested file sets, or references to file sets. In this case basedir is optional; the implicit file set is only used if basedir is set. You may use any mixture of the implicit file set (with basedir set, and optional attributes like includes and optional subelements like <include>); explicit nested <fileset> elements so long as at least one fileset total is specified. The ZIP file will only reflect the relative paths of files within each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below).

または、ネストしたファイルセットか、ファイルセットへの参照を指定することができます。 この場合には、basedirは省略可能ですが、 暗黙のファイルセットはbasedirを指定した場合だけ使用されます。 暗黙のファイルセットを混在して使うことができます。 (basedirを設定し、 includes<include> のような付加的な副要素を追加します)。 少なくともひとつのfilesetを指定して、 ネストした<fileset>要素を明示してください。 ZIPファイルはそれぞれのfilesetの中の相対パスだけを反映します。 ZIPタスクとその派生タスクは、 zipfilesetという追加属性(以下に記述されています)の 特別なファイルセットを使用できます。

The Zip task also supports the merging of multiple zip files into the zip file. This is possible through either the src attribute of any nested filesets or by using the special nested fileset zipgroupfileset.

ZIPタスクはまた、複数のZIPファイルからひとつのZIPファイルへの マージをサポートしています。 これは、ネストしたファイルセットのsrc属性と 特別なネストしたファイルセットzipgroupfileset を使うことで可能です。

The update parameter controls what happens if the ZIP file already exists. When set to yes, the ZIP file is updated with the files specified. (New files are added; old files are replaced with the new versions.) When set to no (the default) the ZIP file is overwritten.

ZIPファイルが既に存在した場合、 updateパラメータが適用されます。 yesがセットされた場合、 ZIPファイルは指定したファイルで更新されます (新しいファイルが追加され、古いファイルは新しいバージョンに置き換えられます)。 no(デフォルト)がセットされた場合、 ZIPファイルは上書きされます。

The whenempty parameter controls what happens when no files match. If skip (the default), the ZIP is not created and a warning is issued. If fail, the ZIP is not created and the build is halted with an error. If create, an empty ZIP file (explicitly zero entries) is created, which should be recognized as such by compliant ZIP manipulation tools.

whenemptyパラメータは、マッチするファイルがない時にどうするかを制御します。 skip(デフォルト)の場合には、ZIPファイルを作成せずに、警告を出力します。 failの場合には、ZIPファイルを作成せずに、ビルドがエラーで停止します。 createの場合には、ZIP互換の処理ツールに空だと認識されるZIPファイル(明示的に0エントリ)を作成します。

This task will now use the platform's default character encoding for filenames - this is consistent with the command line ZIP tools, but causes problems if you try to open them from within Java and your filenames contain non US-ASCII characters. Use the encoding attribute and set it to UTF8 to create zip files that can safely be read by Java.

このタスクは現在、ファイル名にプラットホームのデフォルト文字エンコーディングを使います。 これはコマンドラインのZIPツールと同じやり方ですが、 Javaから、US-ASCIIでない文字コードを含むファイル名を 読み込もうとすると問題が発生します。 Javaで安全にZIPファイルを読み込めるように、 encoding属性を使用して、属性にUTF8にセットしてZIPファイルを作成してくだしい。

Parameters

パラメータ

Attribute Description Required
destfile the zip-file to create. Yes
zipfile the deprecated old name of destfile. Yes
basedir the directory from which to zip the files. No
compress Not only store data but also compress them, defaults to true No
encoding The character encoding to use for filenames inside the zip file. For a list of possible values see http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html. Defaults to the platform's default character encoding. No
filesonly Store only file entries, defaults to false No
includes comma- or space-separated list of patterns of files that must be included. All files are included when omitted. No
includesfile the name of a file. Each line of this file is taken to be an include pattern No
excludes comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted. No
excludesfile the name of a file. Each line of this file is taken to be an exclude pattern No
defaultexcludes indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted. No
update indicates whether to update or overwrite the destination file if it already exists. No
whenempty behavior when no files match. Valid values are "fail", "skip", and "create". Default is "skip". No
duplicate behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
属性 説明 必須
destfile 作成するZIPファイル。 Yes
zipfile 推奨されません。destfileの古い名前。 Yes
basedir ファイルをZIPするディレクトリ No
compress 保存するだけでなく、圧縮します。デフォルトはtrue。 No
encoding ZIPファイル内のファイル名に使われる文字エンコーディング。 使用できる値のリストは http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.htmlを見てください。 デフォルトはプラットホームのデフォルト文字エンコーディング。 No
filesonly ファイルエントリーのみ格納します。デフォルトはfalse。 No
includes カンマかスペースで区切られた、包括するファイルのパターンのリスト。 省略時はすべてのファイルが含まれます。 No
includesfile ファイル名。 このファイルの各行が包括パターンとして解釈されます。 No
excludes カンマかスペースで区切られた、除外するファイルのパターンのリスト。 省略時は、(デフォルト除外集合を除いて)除外されるファイルはありません。 No
excludesfile ファイル名。 このファイルの各行が除外パターンとして解釈されます。 No
defaultexcludes デフォルト除外集合を使うかどうかを指定します("yes"/"no")。 省略時はデフォルト除外集合が使用されます。 No
update 出力ファイルが既に存在していた場合、 更新するか、上書きするかを指定します。 No
whenempty ファイルがマッチしない場合の動作。 有効な値は、"fail"、 "skip"、"create"。 デフォルトは"skip"です。 No
duplicate 同じファイルが見つかった場合の動作。 有効な値は"add"、"preserve"、"fail"。 デフォルトの値は"add"です。 No

Parameters specified as nested elements

ネストした要素として指定されるパラメータ

fileset

The zip task supports any number of nested <fileset> elements to specify the files to be included in the archive.

ZIPタスクは、アーカイブに含めるファイルを指定する、どのような数の <fileset> もサポートします。

zipfileset

A <zipfileset> has three additional attributes: prefix, fullpath, and src. The prefix and fullpath attributes modify the location of the files when they are placed inside the archive. If the prefix attribute is set, all files in the fileset are prefixed with that path in the archive. If the fullpath attribute is set, the file described by the fileset is placed at that exact location in the archive. (The fullpath attribute can only be set for filesets that represent a single file. The prefix and fullpath attributes cannot both be set on the same fileset.) The src attribute may be used in place of the dir attribute to specify a zip file whose contents will be extracted and included in the archive. As with directories, include and exclude patterns may be used to specify a subset of the zip file for inclusion in the archive.

<zipfileset>は3つの追加属性 prefixfullpathsrcを持ちます。 prefixfullpath属性は、 アーカイブの中に存在する、ファイルの位置を更新します。 prefix属性がセットされた場合、 ファイルセット内のすべてのファイルには、指定されたパスが先頭に付加されます。 fullpath属性がセットされた場合、 ファイルセットに指定されたファイルは、アーカイブ内の指定した位置におかれます (fullpath属性は、ファイルセットが 単一のファイルを表している場合にのみ適用されます。 prefixfullpath属性は 同じファイルセットで両方指定することはできません)。 src属性は、アーカイブの中で、 抽出、包括する元となるZIPファイルを指定するために、 dir属性の代わりに使われます。 ディレクトリのように、 包括と除外のパターンで、 アーカイブに含めるZIPファイルのサブセットを指定できます。

zipgroupfileset

A <zipgroupfileset> allows for multiple zip files to be merged into the archive. Each file found in this fileset is added to the archive the same way that zipfileset src files are added.

<zipgroupfileset>は複数のZIPファイルをマージして 1つのアーカイブにすることを可能にします。 zipfileset srcでファイルが追加されるのと同じ方法で、 このファイルセット内で見つかったそれぞれのファイルは、アーカイブに追加されます。

Examples

  <zip destfile="${dist}/manual.zip"
       basedir="htdocs/manual"
  />

zips all files in the htdocs/manual directory into a file called manual.zip in the ${dist} directory.

htdocs/manualディレクトリ内のすべてのファイルを、 ${dist}ディレクトリのmanual.zipにZIPします。

  <zip destfile="${dist}/manual.zip"
       basedir="htdocs/manual"
       update="true"
  />

zips all files in the htdocs/manual directory into a file called manual.zip in the ${dist} directory. If manual.zip doesn't exist, it is created; otherwise it is updated with the new/changed files.

htdocs/manualディレクトリ内のすべてのファイルを、 ${dist}ディレクトリのmanual.zipにZIPします。 manual.zipが存在しなかった場合は作成され、 そうでない場合は、新たな/変更したファイルで更新されます。

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

zips all files in the htdocs/manual directory. Files in the directory mydocs, or files with the name todo.html are excluded.

htdocs/manualディレクトリ内のすべてのファイルをZIPします。 ディレクトリmydocs直下のファイルや、 todo.htmlという名前のファイルは除外されます。

  <zip destfile="${dist}/manual.zip"
       basedir="htdocs/manual"
       includes="api/**/*.html"
       excludes="**/todo.html"
  />

zips all files in the htdocs/manual directory. Only html files under the directory api are zipped, and files with the name todo.html are excluded.

htdocs/manualディレクトリ内のすべてのファイルをZIPします。 ただし、apiディレクトリ以下のファイルのみZIPされ、 またtodo.htmlという名前のファイルは除外されます。

  <zip destfile="${dist}/manual.zip">
    <fileset dir="htdocs/manual"/>
    <fileset dir="." includes="ChangeLog.txt"/>
  </zip>

zips all files in the htdocs/manual directory, and also adds the file ChangeLog.txt in the current directory. ChangeLog.txt will be added to the top of the ZIP file, just as if it had been located at htdocs/manual/ChangeLog.txt.

htdocs/manualディレクトリ内のすべてのファイルをZIPし、 また、カレントディレクトリのファイルChangeLog.txtを追加します。 ChangeLog.txtは、 ちょうどhtdocs/manual/ChangeLog.txtの場所にあったかのように、 ZIPファイルのルートに追加されます。

  <zip destfile="${dist}/manual.zip">
    <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/>
    <zipfileset dir="." includes="ChangeLog27.txt" fullpath="docs/ChangeLog.txt"/>
    <zipfileset src="examples.zip" includes="**/*.html" prefix="docs/examples"/>
  </zip>

zips all files in the htdocs/manual directory into the docs/user-guide directory in the archive, adds the file ChangeLog27.txt in the current directory as docs/ChangeLog.txt, and includes all the html files in examples.zip under docs/examples. The archive might end up containing the files:

htdocs/manualディレクトリ内のすべてのファイルを アーカイブ内のdocs/user-guideディレクトリにZIPし、 カレントディレクトリのファイルChangeLog27.txtdocs/ChangeLog.txtとして追加し、 examples.zip内の すべてのhtmlファイルをdocs/examples以下に含めます。 作成されたアーカイブは、以下のファイルを含むでしょう。

    docs/user-guide/html/index.html
    docs/ChangeLog.txt
    docs/examples/index.html

The code

次のコードは、

  <zip destfile="${dist}/manual.zip">
    <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/>
    <zipgroupfileset dir="." includes="examples*.zip"/>
  </zip>

zips all files in the htdocs/manual directory into the docs/user-guide directory in the archive and includes all the files in any file that maches examples*.zip, such as all files within examples1.zip or examples_for_brian.zip.

htdocs/manualディレクトリ内のすべてのファイルを アーカイブ内のdocs/user-guideディレクトリにZIPし、 examples1.zipexamples_for_brian.zip のような examples*.zipにマッチするファイルを含めます。


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

[訳注:これは風間一洋、宮本信二が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]