# <untar>

[This is preliminary documentation and subject to change.]

Extracts files from a tar archive.

Uses #ziplib (SharpZipLib), an open source Zip/GZip library written entirely in C#.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
src | file | The archive file to expand. | True
compression | TarCompressionMethod | The compression method. The default is `None`. | False
dest | directory | The directory where to store the expanded file(s). The default is the project base directory. | 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
overwrite | bool | Overwrite files, even if they are newer than the corresponding entries in the archive. 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

### Examples

- Extracts all files from a gzipped tar, preserving the directory structure.

                  <untar src="nant-bin.tar.gz" dest="bin" compression="gzip" />

### Requirements

Assembly: NAnt.CompressionTasks (0.91.3881.0)