<tarfileset>

[This is preliminary documentation and subject to change.]

A <tarfileset> is a <fileset> with extra attributes useful in the context of the <tar> task.

Parameters

Attribute Type Description Required
dirmode int A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories. The default is 755. False
filemode int A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files. The default is 644. False
gid int The group identifier (GID) for the tar entry. False
groupname string The groupname for the tar entry. False
prefix string The top level directory prefix. If set, all file and directory paths in the fileset will have this value prepended. Can either be a single directory name or a "/" separated path. False
uid int The user identifier (UID) for the tar entry. False
username string The username for the tar entry. False
basedir directory The base of the directory of this fileset. The default is the project base directory. False
casesensitive bool Indicates whether include and exclude patterns must be treated in a case-sensitive way. The default is true on Unix; otherwise, false. False
defaultexcludes bool Indicates whether default excludes should be used or not. The default is true. False
failonempty bool When set to true, causes the fileset element to throw a ValidationException when no files match the includes and excludes criteria. The default is false. False
id string The ID used to be referenced later. False
refid string The ID to use as the reference. False

Nested Elements:

<includes>

Deprecated. The items to include in the fileset.

Parameters

AttributeTypeDescriptionRequired
namestring The pattern or file name to include. True
asisbool If true then the file name will be added to the <fileset> without pattern matching or checking if the file exists. The default is false. False
frompathbool If true then the file will be searched for on the path. The default is false. False
ifbool If true then the pattern will be included; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the pattern will be included; otherwise, skipped. The default is false. False

</includes>

<include>

The items to include in the fileset.

Parameters

AttributeTypeDescriptionRequired
namestring The pattern or file name to include. True
asisbool If true then the file name will be added to the <fileset> without pattern matching or checking if the file exists. The default is false. False
frompathbool If true then the file will be searched for on the path. The default is false. False
ifbool If true then the pattern will be included; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the pattern will be included; otherwise, skipped. The default is false. False

</include>

<excludes>

Deprecated. The items to exclude from the fileset.

Parameters

AttributeTypeDescriptionRequired
namestring The pattern or file name to exclude. True
ifbool If true then the pattern will be excluded; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the pattern will be excluded; otherwise, skipped. The default is false. False

</excludes>

<exclude>

The items to exclude from the fileset.

Parameters

AttributeTypeDescriptionRequired
namestring The pattern or file name to exclude. True
ifbool If true then the pattern will be excluded; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the pattern will be excluded; otherwise, skipped. The default is false. False

</exclude>

<includesList>

Deprecated. The files from which a list of patterns or files to include should be obtained.

Parameters

AttributeTypeDescriptionRequired
asisbool If true then the patterns in the include file will be added to the <fileset> without pattern matching or checking if the file exists. The default is false. False
frompathbool If true then the patterns in the include file will be searched for on the path. The default is false. False
ifbool If true then the patterns will be included; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the patterns will be included; otherwise, skipped. The default is false. False
namefile The name of a file; each line of this file is taken to be a pattern. True

</includesList>

<includesfile>

The files from which a list of patterns or files to include should be obtained.

Parameters

AttributeTypeDescriptionRequired
asisbool If true then the patterns in the include file will be added to the <fileset> without pattern matching or checking if the file exists. The default is false. False
frompathbool If true then the patterns in the include file will be searched for on the path. The default is false. False
ifbool If true then the patterns will be included; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the patterns will be included; otherwise, skipped. The default is false. False
namefile The name of a file; each line of this file is taken to be a pattern. True

</includesfile>

<excludesfile>

The files from which a list of patterns or files to exclude should be obtained.

Parameters

AttributeTypeDescriptionRequired
namefile The name of a file; each line of this file is taken to be a pattern. True
ifbool If true then the patterns will be excluded; otherwise, skipped. The default is true. False
unlessbool Opposite of if. If false then the patterns will be excluded; otherwise, skipped. The default is false. False

</excludesfile>

<patternset>

Adds a nested set of patterns, or references a standalone patternset.

</patternset>

Requirements

Assembly: NAnt.CompressionTasks (0.91.3954.0)