<?xml version="1.0"?>

<!--
	description:

		"Setenv Tasks"

	library: "Gobo Eiffel Ant"
	copyright: "Copyright (c) 2002, Sven Ehrke and others"
	license: "MIT License"
-->

<chapter xmlns="https://www.gobosoft.com/eiffel/gobo/documentation" id="setenv_task">
<chapterinfo>
	<copyright>
		<year>2002-2005</year>
		<holder>Sven Ehrke</holder>
	</copyright>
	<author>
		<firstname>Sven</firstname><surname>Ehrke</surname>
	</author>
	<email>ericb@gobosoft.com</email>
	<date>7 July 2005</date>
</chapterinfo>

	<title>setenv</title>

	<section id="setenv_description">
		<title>Description</title>
		<para>
			Set an environment variable's value (for the current geant process).
		</para>
	</section>

	<section id="setenv_parameters">
		<title>Parameters</title>

		<variablelist>
			<varlistentry>
				<term>name</term>
				<listitem>
					<para><emphasis>Description: </emphasis>Name of variable</para>
				</listitem>
				<listitem>
					<para><emphasis>Domain: </emphasis>Identifier</para>
				</listitem>
				<listitem>
					<para><emphasis>Default: </emphasis>-</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>value</term>
				<listitem>
					<para><emphasis>Description: </emphasis>Value to be assigned</para>
				</listitem>
				<listitem>
					<para><emphasis>Domain: </emphasis>String</para>
				</listitem>
				<listitem>
					<para><emphasis>Default: </emphasis>-</para>
				</listitem>
			</varlistentry>

		</variablelist>

	</section>

	<section id="setenv_specification">
		<title>RNG Specification</title>

		<programlisting><![CDATA[
  <define name="setenv">
    <element name="setenv">
      <ref name="dir_if_unless"/>
      <attribute name="name"/>
      <attribute name="value"/>
    </element>
  </define>
]]>
		</programlisting>
	</section>

	<section id="setenv_examples">
		<title>Examples</title>

		<programlisting><![CDATA[
  <setenv name="MY_ENV" value="some_value"/>
]]>
		</programlisting>
	</section>

</chapter>
