NAnt
Help
Element Reference
CompilerBase |
v0.85 |
Provides the abstract base class for compiler tasks.
| Attribute | Type | Description | Required |
|---|---|---|---|
| output | file | The output file created by the compiler. | True |
| target | string | Output type. Possible values are exe, winexe, library or module. |
True |
| debug | bool | Generate debug output. The default is false. | False |
| define | string | Define conditional compilation symbol(s). | False |
| keycontainer | string | Specifies the key pair container used to strongname the assembly. | False |
| keyfile | file | Specifies a strong name key file. | False |
| main | string | Specifies which type contains the Main method that you want to use as the entry point into the program. | False |
| nowarn | string | Deprecated. Specifies a comma-separated list of warnings that should be suppressed by the compiler. | False |
| rebuild | bool | Instructs NAnt to recompile the output file regardless of the file timestamps. | False |
| warnaserror | bool | Instructs the compiler to treat all warnings as errors. The default is false. | False |
| win32icon | file | Icon to associate with the application. | 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 |
| Attribute | Type | Description | Required |
|---|---|---|---|
| exename | string | The name of the executable that should be used to launch the external program. | False |
| supportskeycontainer | bool | Indicates whether the compiler for a given target framework supports the "keycontainer" option. The default is false. | False |
| supportskeyfile | bool | Indicates whether the compiler for a given target framework supports the "keyfile" option. The default is false. | False |
| supportsnowarnlist | bool | Indicates whether the compiler for a given target framework supports a command line option that allows a list of warnings to be suppressed. The default is false. | False |
| supportspackagereferences | bool | Indicates whether package references are supported by compiler for a given target framework. The default is false. | False |
| supportswarnaserrorlist | bool | Indicates whether the compiler for a given target framework supports the "warnaserror" option that takes a list of warnings. The default is false. | False |
| useruntimeengine | bool | Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. | False |
Represents a compiler warning.
| Attribute | Type | Description | Required |
|---|---|---|---|
| number | string | A warning number, or comma-separated list of warnings, that you want the compiler to suppress or report. | True |
| if | bool | If true then the element will be processed; otherwise, skipped. The default is true. | False |
| unless | bool | If true then the element will be skipped; otherwise, processed. The default is false. | False |
Represents a package.
| Attribute | Type | Description | Required |
|---|---|---|---|
| name | string | Name of the package to reference. Multiple package can be specified with a single element as a semi-colon separated list of package names. | True |
| if | bool | Indicates if the package should be passed to the task. If true then the package will be passed; otherwise, skipped. The default is true. | False |
| unless | bool | Indicates if the package should not be passed to the task. If false then the package will be passed; otherwise, skipped. The default is false. | False |
Represents a command-line argument.
| 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 |
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" />