<?xml version="1.0"?>

<!--
	description:

		"Geant's builtin variables"

	library: "Gobo Eiffel Ant"
	copyright: "Copyright (c) 2003-2004, Sven Ehrke and others"
	license: "Eiffel Forum License v2 (see forum.txt)"
	date: "$Date: 2005/07/07 13:34:11 $"
	revision: "$Revision: 1.7 $"
-->

<chapter xmlns="http://www.gobosoft.com/eiffel/gobo/documentation" id="geant_builtin_variables">
<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>Geant's built-in variables</title>

	<section id="cwd">
		<title>cwd</title>
		<para>
			Current working directory. The value of this variable changes whenever the current working
			directory changes. This usually happens when the attribute 'dir' is used which is supported
			by tasks and the element 'target'.
		</para>
	</section>

	<section id="GOBO_OS">
		<title>GOBO_OS</title>
		<para>
			The value of this variable contains the name of the used operating system: 'windows', 'unix'
		</para>
	</section>

	<section id="is_windows">
		<title>is_windows</title>
		<para>
			If the used operating system is windows then this variable is set (to the value 'true'). Thus
			you can simply use it in all targets/tasks in the if/unless attributes: ... if="${is_windows}"
		</para>
	</section>

	<section id="is_unix">
		<title>is_unix</title>
		<para>
			If the used operating system is unix then this variable is set (to the value 'true'). Thus
			you can simply use it in all targets/tasks in the if/unless attributes: ... if="${is_unix}"
		</para>
	</section>

	<section id="path_separator">
		<title>path_separator</title>
		<para>
			The value of this variable is '\' if the used operating system is windows and '/' if it is unix.
		</para>
	</section>

	<section id="exe">
		<title>exe</title>
		<para>
			The value of this variable is '.exe' if the used operating system is windows and '' (empty string) if it is unix.
		</para>
	</section>

	<section id="verbose">
		<title>verbose</title>
		<para>
			This variable is set (to 'true') when geant is run in verbose mode.
		</para>
	</section>

</chapter>
