← 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/move.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/move.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.Core.Tasks.MoveTask-->
 
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;move&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;move&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;move&gt;</h1>
 
27
    <p> Moves a file or set of files to a new file or directory. </p>
 
28
    <p> Files are only moved if the source file is newer than the destination file, or if the destination file does not exist. However, you can explicitly overwrite files with the <code>overwrite</code> attribute. </p>
 
29
    <p> A <a href="../types/fileset.html">&lt;fileset&gt;</a> can be used to select files to move. To use a <a href="../types/fileset.html">&lt;fileset&gt;</a>, the <code>todir</code> attribute must be set. </p>
 
30
    <h3>Encoding</h3>
 
31
    <p> Unless an encoding is specified, the encoding associated with the system's current ANSI code page is used. </p>
 
32
    <p> An UTF-8, little-endian Unicode, and big-endian Unicode encoded text file is automatically recognized, if the file starts with the appropriate byte order marks. </p>
 
33
    <p class="i2">
 
34
      <b>Note:</b>  If you employ filters in your move operation, you should limit the move to text files. Binary files will be corrupted by the move operation. </p>
 
35
    <h3>Parameters</h3>
 
36
    <div class="table">
 
37
      <table>
 
38
        <tr>
 
39
          <th>Attribute</th>
 
40
          <th style="text-align: center;">Type</th>
 
41
          <th>Description</th>
 
42
          <th style="text-align: center;">Required</th>
 
43
        </tr>
 
44
        <tr>
 
45
          <td valign="top">file</td>
 
46
          <td style="text-align: center;">file</td>
 
47
          <td> The file to move. </td>
 
48
          <td style="text-align: center;">False</td>
 
49
        </tr>
 
50
        <tr>
 
51
          <td valign="top">flatten</td>
 
52
          <td style="text-align: center;">bool</td>
 
53
          <td> Ignore directory structure of source directory, move all files into a single directory, specified by the <code>todir</code> attribute. The default is <b>false</b>. </td>
 
54
          <td style="text-align: center;">False</td>
 
55
        </tr>
 
56
        <tr>
 
57
          <td valign="top">todir</td>
 
58
          <td style="text-align: center;">directory</td>
 
59
          <td> The directory to move to. </td>
 
60
          <td style="text-align: center;">False</td>
 
61
        </tr>
 
62
        <tr>
 
63
          <td valign="top">tofile</td>
 
64
          <td style="text-align: center;">file</td>
 
65
          <td> The file to move to. </td>
 
66
          <td style="text-align: center;">False</td>
 
67
        </tr>
 
68
        <tr>
 
69
          <td valign="top">failonerror</td>
 
70
          <td style="text-align: center;">bool</td>
 
71
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
72
          <td style="text-align: center;">False</td>
 
73
        </tr>
 
74
        <tr>
 
75
          <td valign="top">if</td>
 
76
          <td style="text-align: center;">bool</td>
 
77
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
78
          <td style="text-align: center;">False</td>
 
79
        </tr>
 
80
        <tr>
 
81
          <td valign="top">includeemptydirs</td>
 
82
          <td style="text-align: center;">bool</td>
 
83
          <td> Copy any empty directories included in the <a href="../types/fileset.html">&lt;fileset&gt;</a>. The default is <b>true</b>. </td>
 
84
          <td style="text-align: center;">False</td>
 
85
        </tr>
 
86
        <tr>
 
87
          <td valign="top">inputencoding</td>
 
88
          <td style="text-align: center;">
 
89
            <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemTextEncodingClassTopic.asp">Encoding</a>
 
90
          </td>
 
91
          <td> The encoding to use when reading files. The default is the system's current ANSI code page. </td>
 
92
          <td style="text-align: center;">False</td>
 
93
        </tr>
 
94
        <tr>
 
95
          <td valign="top">outputencoding</td>
 
96
          <td style="text-align: center;">
 
97
            <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemTextEncodingClassTopic.asp">Encoding</a>
 
98
          </td>
 
99
          <td> The encoding to use when writing the files. The default is the encoding of the input file. </td>
 
100
          <td style="text-align: center;">False</td>
 
101
        </tr>
 
102
        <tr>
 
103
          <td valign="top">overwrite</td>
 
104
          <td style="text-align: center;">bool</td>
 
105
          <td> Overwrite existing files even if the destination files are newer. The default is <b>false</b>. </td>
 
106
          <td style="text-align: center;">False</td>
 
107
        </tr>
 
108
        <tr>
 
109
          <td valign="top">unless</td>
 
110
          <td style="text-align: center;">bool</td>
 
111
          <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>
 
112
          <td style="text-align: center;">False</td>
 
113
        </tr>
 
114
        <tr>
 
115
          <td valign="top">verbose</td>
 
116
          <td style="text-align: center;">bool</td>
 
117
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
118
          <td style="text-align: center;">False</td>
 
119
        </tr>
 
120
      </table>
 
121
    </div>
 
122
    <h3>Nested Elements:</h3>
 
123
    <!--Element-->
 
124
    <h4>
 
125
      <a id="fileset">
 
126
      </a>
 
127
                    &lt;<a href="../types/fileset.html">fileset</a>&gt;
 
128
                </h4>
 
129
    <div class="nested-element"> Used to select the files to move. To use a <a href="../types/fileset.html">&lt;fileset&gt;</a>, the <code>todir</code> attribute must be set. <p /></div>
 
130
    <h4>
 
131
      <a id="fileset">
 
132
      </a>
 
133
                    &lt;/<a href="../types/fileset.html">fileset</a>&gt;
 
134
                </h4>
 
135
    <!--Element-->
 
136
    <h4>
 
137
      <a id="filterchain">
 
138
      </a>
 
139
                    &lt;<a href="../types/filterchain.html">filterchain</a>&gt;
 
140
                </h4>
 
141
    <div class="nested-element"> Chain of filters used to alter the file's content as it is moved. <p /></div>
 
142
    <h4>
 
143
      <a id="filterchain">
 
144
      </a>
 
145
                    &lt;/<a href="../types/filterchain.html">filterchain</a>&gt;
 
146
                </h4>
 
147
    <h3>Examples</h3>
 
148
    <ul class="examples">
 
149
      <li>
 
150
        <p> Move a single file while changing its encoding from "latin1" to "utf-8". </p>
 
151
        <pre class="code">
 
152
&lt;move
 
153
    file="myfile.txt"
 
154
    tofile="mycopy.txt"
 
155
    inputencoding="latin1"
 
156
    outputencoding="utf-8" /&gt;
 
157
    </pre>
 
158
      </li>
 
159
      <li>
 
160
        <p>Move a set of files.</p>
 
161
        <pre class="code">
 
162
&lt;move todir="${build.dir}"&gt;
 
163
    &lt;fileset basedir="bin"&gt;
 
164
        &lt;include name="*.dll" /&gt;
 
165
    &lt;/fileset&gt;
 
166
&lt;/move&gt;
 
167
    </pre>
 
168
      </li>
 
169
      <li>
 
170
        <p> Move a set of files to a directory, replacing <code>@TITLE@</code> with "Foo Bar" in all files. </p>
 
171
        <pre class="code">
 
172
&lt;move todir="../backup/dir"&gt;
 
173
    &lt;fileset basedir="src_dir"&gt;
 
174
        &lt;include name="**/*" /&gt;
 
175
    &lt;/fileset&gt;
 
176
    &lt;filterchain&gt;
 
177
        &lt;replacetokens&gt;
 
178
            &lt;token key="TITLE" value="Foo Bar" /&gt;
 
179
        &lt;/replacetokens&gt;
 
180
    &lt;/filterchain&gt;
 
181
&lt;/move&gt;
 
182
    </pre>
 
183
      </li>
 
184
    </ul>
 
185
    <h3>Requirements</h3>
 
186
    <div style="margin-left: 20px;">
 
187
      <b>Assembly:</b> NAnt.Core (0.90.3780.0)
 
188
            </div>
 
189
  </body>
 
190
</html>
 
 
b'\\ No newline at end of file'