← 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/types/tarfileset.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/types/tarfileset.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.Types.TarFileSet-->
 
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;tarfileset&gt; Type</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="../types/index.html">Type Reference</a>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;tarfileset&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;tarfileset&gt;</h1>
 
27
    <p> A <a href="../types/tarfileset.html">&lt;tarfileset&gt;</a> is a <a href="../types/fileset.html">&lt;fileset&gt;</a> with extra attributes useful in the context of the <a href="../tasks/tar.html">&lt;tar&gt;</a> task. </p>
 
28
    <h3>Parameters</h3>
 
29
    <div class="table">
 
30
      <table>
 
31
        <tr>
 
32
          <th>Attribute</th>
 
33
          <th style="text-align: center;">Type</th>
 
34
          <th>Description</th>
 
35
          <th style="text-align: center;">Required</th>
 
36
        </tr>
 
37
        <tr>
 
38
          <td valign="top">dirmode</td>
 
39
          <td style="text-align: center;">int</td>
 
40
          <td> A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to directories. The default is <code>755</code>. </td>
 
41
          <td style="text-align: center;">False</td>
 
42
        </tr>
 
43
        <tr>
 
44
          <td valign="top">filemode</td>
 
45
          <td style="text-align: center;">int</td>
 
46
          <td> A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion. Only applies to plain files. The default is <code>644</code>. </td>
 
47
          <td style="text-align: center;">False</td>
 
48
        </tr>
 
49
        <tr>
 
50
          <td valign="top">gid</td>
 
51
          <td style="text-align: center;">int</td>
 
52
          <td> The group identifier (GID) for the tar entry. </td>
 
53
          <td style="text-align: center;">False</td>
 
54
        </tr>
 
55
        <tr>
 
56
          <td valign="top">groupname</td>
 
57
          <td style="text-align: center;">string</td>
 
58
          <td> The groupname for the tar entry. </td>
 
59
          <td style="text-align: center;">False</td>
 
60
        </tr>
 
61
        <tr>
 
62
          <td valign="top">prefix</td>
 
63
          <td style="text-align: center;">string</td>
 
64
          <td> The top level directory prefix. If set, all file and directory paths in the fileset will have this value prepended. Can either be a single directory name or a "/" separated path. </td>
 
65
          <td style="text-align: center;">False</td>
 
66
        </tr>
 
67
        <tr>
 
68
          <td valign="top">uid</td>
 
69
          <td style="text-align: center;">int</td>
 
70
          <td> The user identifier (UID) for the tar entry. </td>
 
71
          <td style="text-align: center;">False</td>
 
72
        </tr>
 
73
        <tr>
 
74
          <td valign="top">username</td>
 
75
          <td style="text-align: center;">string</td>
 
76
          <td> The username for the tar entry. </td>
 
77
          <td style="text-align: center;">False</td>
 
78
        </tr>
 
79
        <tr>
 
80
          <td valign="top">basedir</td>
 
81
          <td style="text-align: center;">directory</td>
 
82
          <td> The base of the directory of this fileset. The default is the project base directory. </td>
 
83
          <td style="text-align: center;">False</td>
 
84
        </tr>
 
85
        <tr>
 
86
          <td valign="top">casesensitive</td>
 
87
          <td style="text-align: center;">bool</td>
 
88
          <td> Indicates whether include and exclude patterns must be treated in a case-sensitive way. The default is <b>true</b> on Unix; otherwise, <b>false</b>. </td>
 
89
          <td style="text-align: center;">False</td>
 
90
        </tr>
 
91
        <tr>
 
92
          <td valign="top">defaultexcludes</td>
 
93
          <td style="text-align: center;">bool</td>
 
94
          <td> Indicates whether default excludes should be used or not. The default is <b>true</b>. </td>
 
95
          <td style="text-align: center;">False</td>
 
96
        </tr>
 
97
        <tr>
 
98
          <td valign="top">failonempty</td>
 
99
          <td style="text-align: center;">bool</td>
 
100
          <td> When set to <b>true</b>, causes the fileset element to throw a <a href="../../sdk/NAnt.Core.ValidationException.html">ValidationException</a> when no files match the includes and excludes criteria. The default is <b>false</b>. </td>
 
101
          <td style="text-align: center;">False</td>
 
102
        </tr>
 
103
        <tr>
 
104
          <td valign="top">id</td>
 
105
          <td style="text-align: center;">string</td>
 
106
          <td> The ID used to be referenced later. </td>
 
107
          <td style="text-align: center;">False</td>
 
108
        </tr>
 
109
        <tr>
 
110
          <td valign="top">refid</td>
 
111
          <td style="text-align: center;">string</td>
 
112
          <td> The ID to use as the reference. </td>
 
113
          <td style="text-align: center;">False</td>
 
114
        </tr>
 
115
      </table>
 
116
    </div>
 
117
    <h3>Nested Elements:</h3>
 
118
    <!--Array-->
 
119
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include-->
 
120
    <h4>
 
121
      <a id="includes">
 
122
      </a>
 
123
                    &lt;includes&gt;
 
124
                </h4>
 
125
    <div class="nested-element">
 
126
      <i>Deprecated.</i>  The items to include in the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
127
    <h4>
 
128
      <a id="includes">
 
129
      </a>
 
130
                    &lt;/includes&gt;
 
131
                </h4>
 
132
    <!--Array-->
 
133
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include-->
 
134
    <h4>
 
135
      <a id="include">
 
136
      </a>
 
137
                    &lt;include&gt;
 
138
                </h4>
 
139
    <div class="nested-element"> The items to include in the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
140
    <h4>
 
141
      <a id="include">
 
142
      </a>
 
143
                    &lt;/include&gt;
 
144
                </h4>
 
145
    <!--Array-->
 
146
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude-->
 
147
    <h4>
 
148
      <a id="excludes">
 
149
      </a>
 
150
                    &lt;excludes&gt;
 
151
                </h4>
 
152
    <div class="nested-element">
 
153
      <i>Deprecated.</i>  The items to exclude from the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
154
    <h4>
 
155
      <a id="excludes">
 
156
      </a>
 
157
                    &lt;/excludes&gt;
 
158
                </h4>
 
159
    <!--Array-->
 
160
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude-->
 
161
    <h4>
 
162
      <a id="exclude">
 
163
      </a>
 
164
                    &lt;exclude&gt;
 
165
                </h4>
 
166
    <div class="nested-element"> The items to exclude from the fileset. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
167
    <h4>
 
168
      <a id="exclude">
 
169
      </a>
 
170
                    &lt;/exclude&gt;
 
171
                </h4>
 
172
    <!--Array-->
 
173
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile-->
 
174
    <h4>
 
175
      <a id="includesList">
 
176
      </a>
 
177
                    &lt;includesList&gt;
 
178
                </h4>
 
179
    <div class="nested-element">
 
180
      <i>Deprecated.</i>  The files from which a list of patterns or files to include should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div>
 
181
    <h4>
 
182
      <a id="includesList">
 
183
      </a>
 
184
                    &lt;/includesList&gt;
 
185
                </h4>
 
186
    <!--Array-->
 
187
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile-->
 
188
    <h4>
 
189
      <a id="includesfile">
 
190
      </a>
 
191
                    &lt;includesfile&gt;
 
192
                </h4>
 
193
    <div class="nested-element"> The files from which a list of patterns or files to include should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be included; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div>
 
194
    <h4>
 
195
      <a id="includesfile">
 
196
      </a>
 
197
                    &lt;/includesfile&gt;
 
198
                </h4>
 
199
    <!--Array-->
 
200
    <!--NestedElementArray=T:NAnt.Core.Types.FileSet.ExcludesFile-->
 
201
    <h4>
 
202
      <a id="excludesfile">
 
203
      </a>
 
204
                    &lt;excludesfile&gt;
 
205
                </h4>
 
206
    <div class="nested-element"> The files from which a list of patterns or files to exclude should be obtained. <p></p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be excluded; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Opposite of <code>if</code>. If <b>false</b> then the patterns will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
207
    <h4>
 
208
      <a id="excludesfile">
 
209
      </a>
 
210
                    &lt;/excludesfile&gt;
 
211
                </h4>
 
212
    <!--Element-->
 
213
    <h4>
 
214
      <a id="patternset">
 
215
      </a>
 
216
                    &lt;<a href="../types/patternset.html">patternset</a>&gt;
 
217
                </h4>
 
218
    <div class="nested-element"> Adds a nested set of patterns, or references a standalone patternset. <p /></div>
 
219
    <h4>
 
220
      <a id="patternset">
 
221
      </a>
 
222
                    &lt;/<a href="../types/patternset.html">patternset</a>&gt;
 
223
                </h4>
 
224
    <h3>Requirements</h3>
 
225
    <div style="margin-left: 20px;">
 
226
      <b>Assembly:</b> NAnt.CompressionTasks (0.90.3780.0)
 
227
            </div>
 
228
  </body>
 
229
</html>
 
 
b'\\ No newline at end of file'