<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="cmd_run">
  <refmeta>
    <refentrytitle>RUN Command</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>RUN</refname>
    <refpurpose>Execute an operating system command.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>RUN</command>
      <arg choice='plain'><replaceable>data_ref</replaceable></arg>
      <arg rep='repeat' choice='opt'><replaceable>data_ref</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_run_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_run">RUN</link> command executes an operating 
      system command. When using the GNOME runner, commands will be 
      executed on the client PC, while when running in the web environment 
      (browser), commands will be executed on the server where the run 
      Web Service (xobasrund) is running. Execution on 4GL level will 
      wait until the command has finished.
    </para>
  </refsect1>
  <refsect1 id="cmd_run_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>data_ref</replaceable></term>
	<listitem>
	  <simpara>
            any data reference as well as hard coded strings.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_run_example">
    <title>Example</title>
<programlisting>
. . .
. . .
RUN "/opt/scripts/data_synch.sh"
. . .
. . .
</programlisting>
  </refsect1>

  <refsect1 id="cmd_run_related">
    <title>Related Commands</title>
    <para>
      None.
    </para>
  </refsect1>

</refentry>

