← Back to branch summary

~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/tar.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/tar.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.TarTask-->
 
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;tar&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;tar&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;tar&gt;</h1>
 
27
    <p> Creates a tar file from the specified filesets. </p>
 
28
    <p>Uses <a href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</a> (SharpZipLib), an open source Tar/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">destfile</td>
 
40
          <td style="text-align: center;">file</td>
 
41
          <td> The tar file to create. </td>
 
42
          <td style="text-align: center;">True</td>
 
43
        </tr>
 
44
        <tr>
 
45
          <td valign="top">compression</td>
 
46
          <td style="text-align: center;">
 
47
            <a href="../enums/NAnt.Compression.Types.TarCompressionMethod.html">TarCompressionMethod</a>
 
48
          </td>
 
49
          <td> The compression method. The default is <code>None</code>. </td>
 
50
          <td style="text-align: center;">False</td>
 
51
        </tr>
 
52
        <tr>
 
53
          <td valign="top">includeemptydirs</td>
 
54
          <td style="text-align: center;">bool</td>
 
55
          <td> Include empty directories in the generated tar file. The default is <b>false</b>. </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">unless</td>
 
72
          <td style="text-align: center;">bool</td>
 
73
          <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>
 
74
          <td style="text-align: center;">False</td>
 
75
        </tr>
 
76
        <tr>
 
77
          <td valign="top">verbose</td>
 
78
          <td style="text-align: center;">bool</td>
 
79
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
80
          <td style="text-align: center;">False</td>
 
81
        </tr>
 
82
      </table>
 
83
    </div>
 
84
    <h3>Nested Elements:</h3>
 
85
    <!--Array-->
 
86
    <!--NestedElementArray=T:NAnt.Compression.Types.TarFileSet-->
 
87
    <h4>
 
88
      <a id="fileset">
 
89
      </a>
 
90
                    &lt;<a href="../types/tarfileset.html">fileset</a>&gt;
 
91
                </h4>
 
92
    <div class="nested-element"> The set of files to be included in the archive. </div>
 
93
    <h4>
 
94
      <a id="fileset">
 
95
      </a>
 
96
                    &lt;/<a href="../types/tarfileset.html">fileset</a>&gt;
 
97
                </h4>
 
98
    <h3>Examples</h3>
 
99
    <ul class="examples">
 
100
      <li>
 
101
        <p> Tar all files in <code>${build.dir}</code> and <code>${doc.dir}</code> into a file called "backup.tar.gz", and apply gzip compression to it. </p>
 
102
        <pre class="code">
 
103
            &lt;tar destfile="backup.tar.gz" compression="GZip"&gt;
 
104
                &lt;fileset basedir="${bin.dir}" prefix="bin"&gt;
 
105
                    &lt;include name="**/*" /&gt;
 
106
                &lt;/fileset&gt;
 
107
                &lt;fileset basedir="${doc.dir}" prefix="doc"&gt;
 
108
                    &lt;include name="**/*" /&gt;
 
109
                &lt;/fileset&gt;
 
110
            &lt;/tar&gt;
 
111
                </pre>
 
112
      </li>
 
113
    </ul>
 
114
    <h3>Requirements</h3>
 
115
    <div style="margin-left: 20px;">
 
116
      <b>Assembly:</b> NAnt.CompressionTasks (0.90.3780.0)
 
117
            </div>
 
118
  </body>
 
119
</html>
 
 
b'\\ No newline at end of file'