<environment>

A set of environment variables.

Nested elements

<variable>

Environment variable to pass to a program.

Parameters

Attribute Type Description Required
name string
The name of the environment variable.
True
dir directory
The value for a directory-based environment variable. NAnt will convert it to an absolute path.
False
file file
The value for a file-based environment variable. NAnt will convert it to an absolute filename.
False
if bool
Indicates if the environment variable should be passed to the external program. If true then the environment variable will be passed; otherwise, skipped. The default is true.
False
value string
The literal value for the environment variable.
False
path
The value for a PATH like environment variable. You can use : or ; as path separators and NAnt will convert it to the platform's local conventions.
False
unless bool
Indicates if the environment variable should not be passed to the external program. If false then the environment variable will be passed; otherwise, skipped. The default is false.
False

Nested elements

<path>

Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

<variable>

<option>

Environment variable to pass to a program.

Obsolete. Use element instead.

Parameters

Attribute Type Description Required
name string
Name of the option.
True
if bool
Indicates if the option should be passed to the task. If true then the option will be passed; otherwise, skipped. The default is true.
False
unless bool
Indicates if the option should not be passed to the task. If false then the option will be passed; otherwise, skipped. The default is false.
False
value string
Value of the option. The default is null.
False

<option>

Requirements

Assembly
NAnt.Core.dll
Namespace
NAnt.Core.Types