<copy>

[This is preliminary documentation and subject to change.]

Copies a file or set of files to a new file or directory.

Files are only copied if the source file is newer than the destination file, or if the destination file does not exist. However, you can explicitly overwrite files with the overwrite attribute.

When a <fileset> is used to select files to copy, the todir attribute must be set. Files that are located under the base directory of the <fileset> will be copied to a directory under the destination directory matching the path relative to the base directory of the <fileset>, unless the flatten attribute is set to true.

Files that are not located under the the base directory of the <fileset> will be copied directly under to the destination directory, regardless of the value of the flatten attribute.

Encoding

Unless an encoding is specified, the encoding associated with the system's current ANSI code page is used.

An UTF-8, little-endian Unicode, and big-endian Unicode encoded text file is automatically recognized, if the file starts with the appropriate byte order marks.

Note: If you employ filters in your copy operation, you should limit the copy to text files. Binary files will be corrupted by the copy operation.

Parameters

Attribute Type Description Required
file file The file to copy. False
flatten bool Ignore directory structure of source directory, copy all files into a single directory, specified by the todir attribute. The default is false. False
includeemptydirs bool Copy any empty directories included in the <fileset>. The default is true. False
inputencoding Encoding The encoding to use when reading files. The default is the system's current ANSI code page. False
outputencoding Encoding The encoding to use when writing the files. The default is the encoding of the input file. False
overwrite bool Overwrite existing files even if the destination files are newer. The default is false. False
todir directory The directory to copy to. False
tofile file The file to copy to. False
failonerror bool Determines if task failure stops the build, or is just reported. The default is true. False
if bool If true then the task will be executed; otherwise, skipped. The default is true. False
unless bool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbose bool Determines whether the task should report detailed build log messages. The default is false. False

Nested Elements:

<fileset>

Used to select the files to copy. To use a <fileset>, the todir attribute must be set.

</fileset>

<filterchain>

Chain of filters used to alter the file's content as it is copied.

</filterchain>

Examples

Requirements

Assembly: NAnt.Core (0.86.3402.0)