# <unzip>

[This is preliminary documentation and subject to change.]

Extracts files from a zip archive.

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

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
zipfile | file | The archive file to expand. | True
encoding | Encoding | The character encoding that has been used for filenames inside the zip file. The default is the system's OEM code page. | False
todir | directory | The directory where the expanded files should be stored. 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 the file from the zip, preserving the directory structure.

                  <unzip zipfile="backup.zip"/>

### Requirements

Assembly: NAnt.CompressionTasks (0.91.3881.0)