Represents a command-line argument.
When passed to an external application, the argument will be quoted
when appropriate. This does not apply to the NAnt.Core.Types.Argument.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 |
|
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
Sets a single command-line argument and treats it like a PATH - ensures
the right separator for the local platform is used.
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" />
Requirements
