mirror of
https://github.com/apache/ant.git
synced 2025-05-18 22:14:47 +00:00
e3ce39634b
of user and group. PR: 19120 Reported by: Dale Sherwood git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@276236 13f79535-47bb-0310-9956-ffa450edef68
258 lines
11 KiB
HTML
258 lines
11 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Tar Task</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="tar">Tar</a></h2>
|
|
<h3>Description</h3>
|
|
<p>Creates a tar archive.</p>
|
|
<p>The <i>basedir</i> attribute is the reference directory from where to tar.</p>
|
|
<p>This task is a <a href="../dirtasks.html#directorybasedtasks">directory based task</a>
|
|
and, as such, forms an implicit <a href="../CoreTypes/fileset.html">Fileset</a>. This
|
|
defines which files, relative to the <i>basedir</i>, will be included in the
|
|
archive. The tar task supports all the attributes of Fileset to refine the
|
|
set of files to be included in the implicit fileset.</p>
|
|
|
|
<p>In addition to the implicit fileset, the tar task supports nested filesets. These
|
|
filesets are extended to allow control over the access mode, username and groupname
|
|
to be applied to the tar entries. This is useful, for example, when preparing archives for
|
|
Unix systems where some files need to have execute permission.</p>
|
|
|
|
<p>Early versions of tar did not support path lengths greater than 100
|
|
characters. Modern versions of tar do so, but in incompatible ways.
|
|
The behaviour of the tar task when it encounters such paths is
|
|
controlled by the <i>longfile</i> attribute.
|
|
If the longfile attribute is set to <code>fail</code>, any long paths will
|
|
cause the tar task to fail. If the longfile attribute is set to
|
|
<code>truncate</code>, any long paths will be truncated to the 100 character
|
|
maximum length prior to adding to the archive. If the value of the longfile
|
|
attribute is set to <code>omit</code> then files containing long paths will be
|
|
omitted from the archive. Either option ensures that the archive can be
|
|
untarred by any compliant version of tar. If the loss of path or file
|
|
information is not acceptable, and it rarely is, longfile may be set to the
|
|
value <code>gnu</code>. The tar task will then produce a GNU tar file which
|
|
can have arbitrary length paths. Note however, that the resulting archive will
|
|
only be able to be untarred with GNU tar. The default for the longfile
|
|
attribute is <code>warn</code> which behaves just like the gnu option except
|
|
that it produces a warning for each file path encountered that does not match
|
|
the limit.</p>
|
|
|
|
<p>This task can perform compression by setting the compression attribute to "gzip"
|
|
or "bzip2".</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td valign="top" align="center"><b>Required</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">destfile</td>
|
|
<td valign="top">the tar-file to create.</td>
|
|
<td align="center" valign="top">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">basedir</td>
|
|
<td valign="top">the directory from which to tar the files.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">longfile</td>
|
|
<td valign="top">Determines how long files (>100 chars) are to be
|
|
handled. Allowable values are "truncate", "fail",
|
|
"warn", "omit" and "gnu". Default is
|
|
"warn".</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">includes</td>
|
|
<td valign="top">comma- or space-separated list of patterns of files that must be
|
|
included. All files are included when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">includesfile</td>
|
|
<td valign="top">the name of a file. Each line of this file is
|
|
taken to be an include pattern</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">excludes</td>
|
|
<td valign="top">comma- or space-separated list of patterns of files that must be
|
|
excluded. No files (except default excludes) are excluded when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">excludesfile</td>
|
|
<td valign="top">the name of a file. Each line of this file is
|
|
taken to be an exclude pattern</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">defaultexcludes</td>
|
|
<td valign="top">indicates whether default excludes should be used or not
|
|
("yes"/"no"). Default excludes are used when omitted.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">compression</td>
|
|
<td valign="top">compression method. Allowable values are
|
|
"none", "gzip" and "bzip2". Default is
|
|
"none".</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Nested Elements</h3>
|
|
The tar task supports nested <a href="../CoreTypes/fileset.html">tarfileset</a> elements. These are
|
|
extended Filesets which, in addition to the standard fileset elements, support three additional
|
|
attributes
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td valign="top" align="center"><b>Required</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">mode</td>
|
|
<td valign="top">A 3 digit octal string, specify the user, group
|
|
and other modes in the standard Unix fashion. Only applies to
|
|
plain files. Default is 644.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">dirmode</td>
|
|
<td valign="top">A 3 digit octal string, specify the user, group
|
|
and other modes in the standard Unix fashion. Only applies to
|
|
directories. Default is 755. <em>since Ant 1.6</em>.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">username</td>
|
|
<td valign="top">The username for the tar entry. This is not the same as the UID.
|
|
</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">group</td>
|
|
<td valign="top">The groupname for the tar entry. This is not the same as the GID.
|
|
</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">uid</td>
|
|
<td valign="top">The user identifier (UID) for the tar entry. This is an integer value
|
|
and is not the same as the username. <em>since Ant 1.6.2</em>.
|
|
</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">gid</td>
|
|
<td valign="top">The group identifier (GID) for the tar entry. <em>since Ant 1.6.2</em>.
|
|
</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">prefix</td>
|
|
<td valign="top">If the prefix attribute is set, all files in the fileset
|
|
are prefixed with that path in the archive.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">fullpath</td>
|
|
<td valign="top">If the fullpath attribute is set, the file in the fileset
|
|
is written with that path in the archive. The prefix attribute, if specified, is
|
|
ignored. It is an error to have more than one file specified in
|
|
such a fileset.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">preserveLeadingSlashes</td>
|
|
<td valign="top">Indicates whether leading `/'s should
|
|
be preserved in the file names. Default is <code>false</code>.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Examples</h3>
|
|
<pre> <tar tarfile="${dist}/manual.tar" basedir="htdocs/manual"/>
|
|
<gzip zipfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/></pre>
|
|
<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>
|
|
in the <code>${dist}</code> directory, then applies the gzip task to compress
|
|
it.</p>
|
|
<pre> <tar destfile="${dist}/manual.tar"
|
|
basedir="htdocs/manual"
|
|
excludes="mydocs/**, **/todo.html"
|
|
/></pre>
|
|
<p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>
|
|
in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,
|
|
or files with the name <code>todo.html</code> are excluded.</p>
|
|
|
|
<pre>
|
|
<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></pre>
|
|
|
|
<p>
|
|
Writes the file <code>docs/readme.txt</code> as
|
|
<code>/usr/doc/ant/README</code> into the archive. All
|
|
<code>*.html</code> files in the <code>docs</code> directory are
|
|
prefixed by <code>/usr/doc/ant</code>, so for example
|
|
<code>docs/index.html</code> is written as
|
|
<code>/usr/doc/ant/index.html</code> to the archive.
|
|
</p>
|
|
|
|
|
|
<pre><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> </pre>
|
|
|
|
<p>This example shows building a tar which uses the GNU extensions for long paths and
|
|
where some files need to be marked as executable (mode 755)
|
|
and the rest are use the default mode (read-write by owner). The first
|
|
fileset selects just the executable files. The second fileset must exclude
|
|
the executable files and include all others. </p>
|
|
|
|
<p><strong>Note: </strong> The tar task does not ensure that a file is only selected
|
|
by one fileset. If the same file is selected by more than one fileset, it will be included in the
|
|
tar file twice, with the same path.</p>
|
|
|
|
<p><strong>Note:</strong> The patterns in the include and exclude
|
|
elements are considered to be relative to the corresponding dir
|
|
attribute as with all other filesets. In the example above,
|
|
<code>${dist.name}</code> is not an absolute path, but a simple name
|
|
of a directory, so <code>${dist.name}</code> is a valid path relative
|
|
to <code>${dist.name}/..</code>.</p>
|
|
|
|
<hr>
|
|
<p align="center">Copyright © 2000-2002,2004 The Apache Software Foundation. All rights
|
|
Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|