# <resgen>

[This is preliminary documentation and subject to change.]

Converts files from one resource format to another.

Note: If no `todir` is specified, the resource file will be created next to the input file.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
input | file | Input file to process. | False
output | file | The resource file to output. | False
target | string | The target type. The default is `resources`. | False
todir | directory | The directory to which outputs will be stored. | False
usesourcepath | bool | Use each source file's directory as the current directory for resolving relative file paths. The default is false. Only supported when targeting .NET 2.0 (or higher). | False
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False
timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False

### Framework-configurable parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
exename | string | The name of the executable that should be used to launch the external program. | False
managed | ManagedExecution | 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. | False
supportsassemblyreferences | bool | Indicates whether assembly references are supported by the `resgen` tool for the current target framework. The default is false. | False
supportsexternalfilereferences | bool | Indicates whether external file references are supported by the `resgen` tool for the current target framework. The default is false. | False
useruntimeengine | bool | Deprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false. | False

### Nested Elements:

#### <resources>

Takes a list of `.resx` or `.txt` files to convert to `.resources` files.

#### </resources>

#### <assemblies>

Reference metadata from the specified assembly files.

#### </assemblies>

#### <arg>

The command-line arguments for the external program.

Represents a command-line argument.

When passed to an external application, the argument will be quoted when appropriate. This does not apply to the `line` parameter, which is always passed as is.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
dir | directory | The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. | False
file | file | The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. | False
if | bool | Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. | False
line | string | List of command-line arguments; will be passed to the executable as is. | False
path | <path> | The value for a PATH-like command-line argument; you can use `:` or `;` as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. | False
unless | bool | Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. | False
value | string | A single command-line argument; can contain space characters. | False

### Nested Elements:

#### <path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

#### </path>

### Examples

- A single command-line argument containing a space character.

      <arg value="-l -a" />

- Two separate command-line arguments.

      <arg line="-l -a" />

- A single command-line argument with the value `\dir;\dir2;\dir3` on DOS-based systems and `/dir:/dir2:/dir3` on Unix-like systems.

      <arg path="/dir;/dir2:\dir3" />

#### </arg>

### Examples

- Convert a resource file from the `.resx` to the `.resources` format.

      <resgen input="translations.resx" output="translations.resources" />

- Convert a set of `.resx` files to the `.resources` format.

      <resgen todir=".">
          <resources>
              <include name="*.resx" />
          </resources>
      </resgen>

### Requirements

Assembly: NAnt.DotNetTasks (0.91.3881.0)