~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/ilasm.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:
 
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.DotNet.Tasks.IlasmTask-->
 
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;ilasm&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;ilasm&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;ilasm&gt;</h1>
 
27
    <p> Compiles ILASM programs. </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" class="required">output</td>
 
39
          <td style="text-align: center;">file</td>
 
40
          <td> Specifies the name of the output file created by the compiler. </td>
 
41
          <td style="text-align: center;">True</td>
 
42
        </tr>
 
43
        <tr>
 
44
          <td valign="top" class="required">target</td>
 
45
          <td style="text-align: center;">string</td>
 
46
          <td> Specifies which output type should be generated. </td>
 
47
          <td style="text-align: center;">True</td>
 
48
        </tr>
 
49
        <tr>
 
50
          <td valign="top">alignment</td>
 
51
          <td style="text-align: center;">int</td>
 
52
          <td> Instructs the compiler to set the <i xmlns="">FileAlignment</i> value in the PE header. </td>
 
53
          <td style="text-align: center;">False</td>
 
54
        </tr>
 
55
        <tr>
 
56
          <td valign="top">base</td>
 
57
          <td style="text-align: center;">int</td>
 
58
          <td> Instructs the compiler to set the <i xmlns="">ImageBase</i> value in the PE header. </td>
 
59
          <td style="text-align: center;">False</td>
 
60
        </tr>
 
61
        <tr>
 
62
          <td valign="top">clock</td>
 
63
          <td style="text-align: center;">bool</td>
 
64
          <td> Specifies whether or not the compiler should measure and report the compilation times. </td>
 
65
          <td style="text-align: center;">False</td>
 
66
        </tr>
 
67
        <tr>
 
68
          <td valign="top">debug</td>
 
69
          <td style="text-align: center;">bool</td>
 
70
          <td> Specifies whether or not the compiler should generate debug information. </td>
 
71
          <td style="text-align: center;">False</td>
 
72
        </tr>
 
73
        <tr>
 
74
          <td valign="top">error</td>
 
75
          <td style="text-align: center;">bool</td>
 
76
          <td> Specifies whether or not the compiler should attempt to create a PE file even if compilation errors have been reported. </td>
 
77
          <td style="text-align: center;">False</td>
 
78
        </tr>
 
79
        <tr>
 
80
          <td valign="top">flags</td>
 
81
          <td style="text-align: center;">int</td>
 
82
          <td> Instructs the compiler to set the <i xmlns="">Flags</i> value in the CLR header. </td>
 
83
          <td style="text-align: center;">False</td>
 
84
        </tr>
 
85
        <tr>
 
86
          <td valign="top">keyfile</td>
 
87
          <td style="text-align: center;">file</td>
 
88
          <td> Instructs the compiler to generate a strong signature of the PE file. </td>
 
89
          <td style="text-align: center;">False</td>
 
90
        </tr>
 
91
        <tr>
 
92
          <td valign="top">keysource</td>
 
93
          <td style="text-align: center;">string</td>
 
94
          <td> Instructs the compiler to generate a strong signature of the PE file. </td>
 
95
          <td style="text-align: center;">False</td>
 
96
        </tr>
 
97
        <tr>
 
98
          <td valign="top">listing</td>
 
99
          <td style="text-align: center;">bool</td>
 
100
          <td> Specifies whether or not the compiler should type a formatted listing of the compilation result. </td>
 
101
          <td style="text-align: center;">False</td>
 
102
        </tr>
 
103
        <tr>
 
104
          <td valign="top">rebuild</td>
 
105
          <td style="text-align: center;">bool</td>
 
106
          <td> Instructs NAnt to recompile the output file regardless of the file timestamps. </td>
 
107
          <td style="text-align: center;">False</td>
 
108
        </tr>
 
109
        <tr>
 
110
          <td valign="top">resourcefile</td>
 
111
          <td style="text-align: center;">file</td>
 
112
          <td> Instructs the compiler to link the specified unmanaged resource file into the resulting PE file. </td>
 
113
          <td style="text-align: center;">False</td>
 
114
        </tr>
 
115
        <tr>
 
116
          <td valign="top">subsystem</td>
 
117
          <td style="text-align: center;">int</td>
 
118
          <td> Instructs the compiler to set the <i xmlns="">Subsystem</i> value in the PE header. </td>
 
119
          <td style="text-align: center;">False</td>
 
120
        </tr>
 
121
        <tr>
 
122
          <td valign="top">failonerror</td>
 
123
          <td style="text-align: center;">bool</td>
 
124
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
125
          <td style="text-align: center;">False</td>
 
126
        </tr>
 
127
        <tr>
 
128
          <td valign="top">if</td>
 
129
          <td style="text-align: center;">bool</td>
 
130
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
131
          <td style="text-align: center;">False</td>
 
132
        </tr>
 
133
        <tr>
 
134
          <td valign="top">timeout</td>
 
135
          <td style="text-align: center;">int</td>
 
136
          <td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
 
137
          <td style="text-align: center;">False</td>
 
138
        </tr>
 
139
        <tr>
 
140
          <td valign="top">unless</td>
 
141
          <td style="text-align: center;">bool</td>
 
142
          <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>
 
143
          <td style="text-align: center;">False</td>
 
144
        </tr>
 
145
        <tr>
 
146
          <td valign="top">verbose</td>
 
147
          <td style="text-align: center;">bool</td>
 
148
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
149
          <td style="text-align: center;">False</td>
 
150
        </tr>
 
151
      </table>
 
152
    </div>
 
153
    <h3>Framework-configurable parameters</h3>
 
154
    <div class="table">
 
155
      <table>
 
156
        <tr>
 
157
          <th>Attribute</th>
 
158
          <th style="text-align: center;">Type</th>
 
159
          <th>Description</th>
 
160
          <th style="text-align: center;">Required</th>
 
161
        </tr>
 
162
        <tr>
 
163
          <td valign="top">exename</td>
 
164
          <td style="text-align: center;">string</td>
 
165
          <td> The name of the executable that should be used to launch the external program. </td>
 
166
          <td style="text-align: center;">False</td>
 
167
        </tr>
 
168
        <tr>
 
169
          <td valign="top">managed</td>
 
170
          <td style="text-align: center;">
 
171
            <a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
 
172
          </td>
 
173
          <td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
 
174
          <td style="text-align: center;">False</td>
 
175
        </tr>
 
176
        <tr>
 
177
          <td valign="top">useruntimeengine</td>
 
178
          <td style="text-align: center;">bool</td>
 
179
          <td>
 
180
            <i>Deprecated.</i>  Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
 
181
          <td style="text-align: center;">False</td>
 
182
        </tr>
 
183
      </table>
 
184
    </div>
 
185
    <h3>Nested Elements:</h3>
 
186
    <!--Element-->
 
187
    <h4>
 
188
      <a id="sources">
 
189
      </a>
 
190
                    &lt;<a href="../types/fileset.html">sources</a>&gt;
 
191
                </h4>
 
192
    <div class="nested-element"> Specifies the set of source files to compile. <p /></div>
 
193
    <h4>
 
194
      <a id="sources">
 
195
      </a>
 
196
                    &lt;/<a href="../types/fileset.html">sources</a>&gt;
 
197
                </h4>
 
198
    <!--Array-->
 
199
    <!--NestedElementArray=T:NAnt.Core.Types.Argument-->
 
200
    <h4>
 
201
      <a id="arg">
 
202
      </a>
 
203
                    &lt;arg&gt;
 
204
                </h4>
 
205
    <div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
 
206
                    &lt;<a href="../types/path.html">path</a>&gt;
 
207
                </h4><div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
 
208
                    &lt;/<a href="../types/path.html">path</a>&gt;
 
209
                </h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
 
210
&lt;arg value="-l -a" /&gt;
 
211
    </pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
 
212
&lt;arg line="-l -a" /&gt;
 
213
    </pre></li><li><p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p><pre class="code">
 
214
&lt;arg path="/dir;/dir2:\dir3" /&gt;
 
215
    </pre></li></ul></div>
 
216
    <h4>
 
217
      <a id="arg">
 
218
      </a>
 
219
                    &lt;/arg&gt;
 
220
                </h4>
 
221
    <h3>Examples</h3>
 
222
    <ul class="examples">
 
223
      <li>
 
224
        <p> Compiles <code>helloworld.il</code> to <code>helloworld.exe</code>. </p>
 
225
        <pre class="code">
 
226
            &lt;ilasm target="exe" output="helloworld.exe" debug="true"&gt;
 
227
                &lt;sources&gt;
 
228
                    &lt;include name="helloworld.il" /&gt;
 
229
                &lt;/sources&gt;
 
230
            &lt;/ilasm&gt;
 
231
                </pre>
 
232
      </li>
 
233
    </ul>
 
234
    <h3>Requirements</h3>
 
235
    <div style="margin-left: 20px;">
 
236
      <b>Assembly:</b> NAnt.DotNetTasks (0.90.3780.0)
 
237
            </div>
 
238
  </body>
 
239
</html>
 
 
b'\\ No newline at end of file'