~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/tasks/resgen.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.ResGenTask-->
 
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;resgen&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;resgen&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;resgen&gt;</h1>
 
27
    <p> Converts files from one resource format to another. </p>
 
28
    <p class="i2">
 
29
      <b>Note:</b>  If no <code>todir</code> is specified, the resource file will be created next to the input file. </p>
 
30
    <h3>Parameters</h3>
 
31
    <div class="table">
 
32
      <table>
 
33
        <tr>
 
34
          <th>Attribute</th>
 
35
          <th style="text-align: center;">Type</th>
 
36
          <th>Description</th>
 
37
          <th style="text-align: center;">Required</th>
 
38
        </tr>
 
39
        <tr>
 
40
          <td valign="top">input</td>
 
41
          <td style="text-align: center;">file</td>
 
42
          <td> Input file to process. </td>
 
43
          <td style="text-align: center;">False</td>
 
44
        </tr>
 
45
        <tr>
 
46
          <td valign="top">output</td>
 
47
          <td style="text-align: center;">file</td>
 
48
          <td> The resource file to output. </td>
 
49
          <td style="text-align: center;">False</td>
 
50
        </tr>
 
51
        <tr>
 
52
          <td valign="top">target</td>
 
53
          <td style="text-align: center;">string</td>
 
54
          <td> The target type. The default is <code>resources</code>. </td>
 
55
          <td style="text-align: center;">False</td>
 
56
        </tr>
 
57
        <tr>
 
58
          <td valign="top">todir</td>
 
59
          <td style="text-align: center;">directory</td>
 
60
          <td> The directory to which outputs will be stored. </td>
 
61
          <td style="text-align: center;">False</td>
 
62
        </tr>
 
63
        <tr>
 
64
          <td valign="top">usesourcepath</td>
 
65
          <td style="text-align: center;">bool</td>
 
66
          <td> Use each source file's directory as the current directory for resolving relative file paths. The default is <b>false</b>. Only supported when targeting .NET 2.0 (or higher). </td>
 
67
          <td style="text-align: center;">False</td>
 
68
        </tr>
 
69
        <tr>
 
70
          <td valign="top">failonerror</td>
 
71
          <td style="text-align: center;">bool</td>
 
72
          <td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
 
73
          <td style="text-align: center;">False</td>
 
74
        </tr>
 
75
        <tr>
 
76
          <td valign="top">if</td>
 
77
          <td style="text-align: center;">bool</td>
 
78
          <td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
 
79
          <td style="text-align: center;">False</td>
 
80
        </tr>
 
81
        <tr>
 
82
          <td valign="top">timeout</td>
 
83
          <td style="text-align: center;">int</td>
 
84
          <td> The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. </td>
 
85
          <td style="text-align: center;">False</td>
 
86
        </tr>
 
87
        <tr>
 
88
          <td valign="top">unless</td>
 
89
          <td style="text-align: center;">bool</td>
 
90
          <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>
 
91
          <td style="text-align: center;">False</td>
 
92
        </tr>
 
93
        <tr>
 
94
          <td valign="top">verbose</td>
 
95
          <td style="text-align: center;">bool</td>
 
96
          <td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
 
97
          <td style="text-align: center;">False</td>
 
98
        </tr>
 
99
      </table>
 
100
    </div>
 
101
    <h3>Framework-configurable parameters</h3>
 
102
    <div class="table">
 
103
      <table>
 
104
        <tr>
 
105
          <th>Attribute</th>
 
106
          <th style="text-align: center;">Type</th>
 
107
          <th>Description</th>
 
108
          <th style="text-align: center;">Required</th>
 
109
        </tr>
 
110
        <tr>
 
111
          <td valign="top">exename</td>
 
112
          <td style="text-align: center;">string</td>
 
113
          <td> The name of the executable that should be used to launch the external program. </td>
 
114
          <td style="text-align: center;">False</td>
 
115
        </tr>
 
116
        <tr>
 
117
          <td valign="top">managed</td>
 
118
          <td style="text-align: center;">
 
119
            <a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
 
120
          </td>
 
121
          <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>
 
122
          <td style="text-align: center;">False</td>
 
123
        </tr>
 
124
        <tr>
 
125
          <td valign="top">supportsassemblyreferences</td>
 
126
          <td style="text-align: center;">bool</td>
 
127
          <td> Indicates whether assembly references are supported by the <code>resgen</code> tool for the current target framework. The default is <b>false</b>. </td>
 
128
          <td style="text-align: center;">False</td>
 
129
        </tr>
 
130
        <tr>
 
131
          <td valign="top">supportsexternalfilereferences</td>
 
132
          <td style="text-align: center;">bool</td>
 
133
          <td> Indicates whether external file references are supported by the <code>resgen</code> tool for the current target framework. The default is <b>false</b>. </td>
 
134
          <td style="text-align: center;">False</td>
 
135
        </tr>
 
136
        <tr>
 
137
          <td valign="top">useruntimeengine</td>
 
138
          <td style="text-align: center;">bool</td>
 
139
          <td>
 
140
            <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>
 
141
          <td style="text-align: center;">False</td>
 
142
        </tr>
 
143
      </table>
 
144
    </div>
 
145
    <h3>Nested Elements:</h3>
 
146
    <!--Element-->
 
147
    <h4>
 
148
      <a id="resources">
 
149
      </a>
 
150
                    &lt;<a href="../types/resourcefileset.html">resources</a>&gt;
 
151
                </h4>
 
152
    <div class="nested-element"> Takes a list of <code>.resx</code> or <code>.txt</code> files to convert to <code>.resources</code> files. <p /></div>
 
153
    <h4>
 
154
      <a id="resources">
 
155
      </a>
 
156
                    &lt;/<a href="../types/resourcefileset.html">resources</a>&gt;
 
157
                </h4>
 
158
    <!--Element-->
 
159
    <h4>
 
160
      <a id="assemblies">
 
161
      </a>
 
162
                    &lt;<a href="../types/assemblyfileset.html">assemblies</a>&gt;
 
163
                </h4>
 
164
    <div class="nested-element"> Reference metadata from the specified assembly files. <p /></div>
 
165
    <h4>
 
166
      <a id="assemblies">
 
167
      </a>
 
168
                    &lt;/<a href="../types/assemblyfileset.html">assemblies</a>&gt;
 
169
                </h4>
 
170
    <!--Array-->
 
171
    <!--NestedElementArray=T:NAnt.Core.Types.Argument-->
 
172
    <h4>
 
173
      <a id="arg">
 
174
      </a>
 
175
                    &lt;arg&gt;
 
176
                </h4>
 
177
    <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>
 
178
                    &lt;<a href="../types/path.html">path</a>&gt;
 
179
                </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>
 
180
                    &lt;/<a href="../types/path.html">path</a>&gt;
 
181
                </h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
 
182
&lt;arg value="-l -a" /&gt;
 
183
    </pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
 
184
&lt;arg line="-l -a" /&gt;
 
185
    </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">
 
186
&lt;arg path="/dir;/dir2:\dir3" /&gt;
 
187
    </pre></li></ul></div>
 
188
    <h4>
 
189
      <a id="arg">
 
190
      </a>
 
191
                    &lt;/arg&gt;
 
192
                </h4>
 
193
    <h3>Examples</h3>
 
194
    <ul class="examples">
 
195
      <li>
 
196
        <p> Convert a resource file from the <code>.resx</code> to the <code>.resources</code> format. </p>
 
197
        <pre class="code">
 
198
&lt;resgen input="translations.resx" output="translations.resources" /&gt;
 
199
    </pre>
 
200
      </li>
 
201
      <li>
 
202
        <p> Convert a set of <code>.resx</code> files to the <code>.resources</code> format. </p>
 
203
        <pre class="code">
 
204
&lt;resgen todir="."&gt;
 
205
    &lt;resources&gt;
 
206
        &lt;include name="*.resx" /&gt;
 
207
    &lt;/resources&gt;
 
208
&lt;/resgen&gt;
 
209
    </pre>
 
210
      </li>
 
211
    </ul>
 
212
    <h3>Requirements</h3>
 
213
    <div style="margin-left: 20px;">
 
214
      <b>Assembly:</b> NAnt.DotNetTasks (0.90.3780.0)
 
215
            </div>
 
216
  </body>
 
217
</html>
 
 
b'\\ No newline at end of file'