<?xml version="1.0"?>

<!--
	description:

		"Move 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="move_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>move</title>

	<section id="move_description">
		<title>Description</title>
		<para>
			Move a file or fileset to a new file or directory.
		</para>
	</section>

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

		<variablelist>
			<varlistentry>
				<term>file</term>
				<listitem>
					<para><emphasis>Description: </emphasis>File to be moved</para>
				</listitem>
				<listitem>
					<para><emphasis>Domain: </emphasis>Valid filename pointing to existing file</para>
				</listitem>
				<listitem>
					<para><emphasis>Default: </emphasis>-</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>to_file</term>
				<listitem>
					<para><emphasis>Description: </emphasis>File to move to</para>
				</listitem>
				<listitem>
					<para><emphasis>Domain: </emphasis>Valid filename</para>
				</listitem>
				<listitem>
					<para><emphasis>Default: </emphasis>-</para>
				</listitem>
			</varlistentry>

			<varlistentry>
				<term>to_directory</term>
				<listitem>
					<para><emphasis>Description: </emphasis>Directory to which file(s) should be moved to</para>
				</listitem>
				<listitem>
					<para><emphasis>Domain: </emphasis>Valid directoryname pointing to existing directory</para>
				</listitem>
				<listitem>
					<para><emphasis>Default: </emphasis>-</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</section>

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

		<programlisting><![CDATA[
  <define name="move">
    <element name="move">
      <ref name="dir_if_unless"/>
      <choice>
        <group>
          <attribute name="file"/>
          <attribute name="to_file"/>
        </group>
        <group>
          <attribute name="file"/>
          <attribute name="to_directory"/>
        </group>
        <group>
          <attribute name="to_directory"/>
          <ref name="fileset"/>
        </group>
      </choice>
    </element>
  </define>
]]>
	</programlisting>
	</section>

	<section id="move_examples">
		<title>Examples</title>
	<programlisting><![CDATA[
  <move file="readme.txt" to_file="readme1.txt"/>

  <move file="readme.txt" to_directory="/tmp"/>

  <move to_directory="/tmp">
    <fileset dir="kernel" include="@(**/*.ge)"/>
  </move>
]]>
	</programlisting>
	</section>

</chapter>
