← Back to branch summary

~ggalancs/ubuntuone-windows-installer/add_vs2010

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/unzip.html

  • Committer: Manuel de la Pena
  • Date: 2010-07-08 13:22:59 UTC
  • Revision ID: mandel@themacaque.com-20100708132259-y1jgyuyqfe9stt8u
Updated build script to run tests and added all the required tools so far.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/Nant/doc/help/tasks/unzip.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
  <!-- Documenting T:NAnt.Compression.Tasks.UnZipTask-->
 
4
  <head>
 
5
    <meta http-equiv="Content-Language" content="en-ca" />
 
6
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
7
    <link rel="stylesheet" type="text/css" href="../style.css" />
 
8
    <title>&lt;unzip&gt; Task</title>
 
9
  </head>
 
10
  <body>
 
11
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
 
12
      <tr>
 
13
        <td class="NavBar-Cell">
 
14
          <a href="http://nant.sourceforge.net">
 
15
            <b>NAnt</b>
 
16
          </a>
 
17
          <img alt="-&gt;" src="../images/arrow.gif" />
 
18
          <a href="../index.html">Help</a>
 
19
          <img alt="-&gt;" src="../images/arrow.gif" />
 
20
          <a href="../tasks/index.html">Task Reference</a>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;unzip&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;unzip&gt;</h1>
 
27
    <p> Extracts files from a zip archive. </p>
 
28
    <p> Uses <a href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</a> (SharpZipLib), an open source Zip/GZip library written entirely in C#. </p>
 
29
    <h3>Parameters</h3>
 
30
    <div class="table">
 
31
      <table>
 
32
        <tr>
 
33
          <th>Attribute</th>
 
34
          <th style="text-align: center;">Type</th>
 
35
          <th>Description</th>
 
36
          <th style="text-align: center;">Required</th>
 
37
        </tr>
 
38
        <tr>
 
39
          <td valign="top" class="required">zipfile</td>
 
40
          <td style="text-align: center;">file</td>
 
41
          <td> The archive file to expand. </td>
 
42
          <td style="text-align: center;">True</td>
 
43
        </tr>
 
44
        <tr>
 
45
          <td valign="top">encoding</td>
 
46
          <td style="text-align: center;">
 
47
            <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemTextEncodingClassTopic.asp">Encoding</a>
 
48
          </td>
 
49
          <td> The character encoding that has been used for filenames inside the zip file. The default is the system's OEM code page. </td>
 
50
          <td style="text-align: center;">False</td>
 
51
        </tr>
 
52
        <tr>
 
53
          <td valign="top">todir</td>
 
54
          <td style="text-align: center;">directory</td>
 
55
          <td> The directory where the expanded files should be stored. The default is the project base directory. </td>
 
56
          <td style="text-align: center;">False</td>
 
57
        </tr>
 
58
        <tr>
 
59
          <td valign="top">failonerror</td>
 
60
          <td style="text-align: center;">bool</td>
 
61
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
62
          <td style="text-align: center;">False</td>
 
63
        </tr>
 
64
        <tr>
 
65
          <td valign="top">if</td>
 
66
          <td style="text-align: center;">bool</td>
 
67
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
68
          <td style="text-align: center;">False</td>
 
69
        </tr>
 
70
        <tr>
 
71
          <td valign="top">overwrite</td>
 
72
          <td style="text-align: center;">bool</td>
 
73
          <td> Overwrite files, even if they are newer than the corresponding entries in the archive. The default is <b>true</b>. </td>
 
74
          <td style="text-align: center;">False</td>
 
75
        </tr>
 
76
        <tr>
 
77
          <td valign="top">unless</td>
 
78
          <td style="text-align: center;">bool</td>
 
79
          <td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
 
80
          <td style="text-align: center;">False</td>
 
81
        </tr>
 
82
        <tr>
 
83
          <td valign="top">verbose</td>
 
84
          <td style="text-align: center;">bool</td>
 
85
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
86
          <td style="text-align: center;">False</td>
 
87
        </tr>
 
88
      </table>
 
89
    </div>
 
90
    <h3>Examples</h3>
 
91
    <ul class="examples">
 
92
      <li>
 
93
        <p>Extracts all the file from the zip, preserving the directory structure.</p>
 
94
        <pre class="code">
 
95
            &lt;unzip zipfile="backup.zip"/&gt;
 
96
                </pre>
 
97
      </li>
 
98
    </ul>
 
99
    <h3>Requirements</h3>
 
100
    <div style="margin-left: 20px;">
 
101
      <b>Assembly:</b> NAnt.CompressionTasks (0.90.3780.0)
 
102
            </div>
 
103
  </body>
 
104
</html>
 
 
b'\\ No newline at end of file'