<!--
* 
*
*  ProLinga-UI
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-UI.
*
*  ProLinga-UI 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-UI 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-UI.  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="prolinga-ui-prolingaui">
  <refmeta>
    <refentrytitle>prolingaui</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>prolingaui</refname>
    <refpurpose>ProLinga user interface.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>prolingaui</command>
	<arg><option>--noconnectiondialog</option></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>prolingarun</command>
	<arg><option>--version</option></arg>
  </cmdsynopsis>
    <cmdsynopsis>
      <command>prolingarun</command>
	<arg><option>--servicefile <replaceable>file_name</replaceable></option></arg>
  </cmdsynopsis>
    <cmdsynopsis>
      <command>prolingarun</command>
	<arg><option>--uiservice <replaceable>service_name</replaceable></option></arg>
  </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="prolingaui_introduction">
    <title>Introduction</title>
    <para>
      The prolingaui program contacts a prolinga run environment and starts an user
      interface to interact with this run environment.
      prolingaui will get the information as hostname and TCP portnumber of the
      various run environment services from the configuration file etc/prolingauisvc.xml.
    </para>
  </refsect1>
  <refsect1 id="prolingaui_options">
    <title>Options</title>
    <variablelist>
      <varlistentry>
	<term><option>--noconnectiondialog</option></term>
	<listitem>
	  <simpara>
	    Suppress the connection dialog box. (Not applicable for stand-alone configurations.)
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--version</option></term>
	<listitem>
	  <simpara>
	    Displays version information.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--service file_name</option></term>
	<listitem>
	  <simpara>
	   Service configuration file to be used. (Optional)
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--uiservice service_name</option></term>
	<listitem>
	  <simpara>
	   UI Service to be used. (Optional)
	  </simpara>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
</refentry>

<refentry id="prolinga-ui-service_file">
  <refmeta>
    <refentrytitle>Service File</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
                                                                                                                                             
  <refnamediv>
    <refname>Service File</refname>
    <refpurpose>File containing settings for the various run environment services.</refpurpose>
  </refnamediv>

  <refsect1 id="prolinga-ui-svc_file_introduction">
    <title>Introduction</title>
    <para>
      ProLinga-UI comes with a configuration file where various service endpoints
      can be entered. 
      Default installation of ProLinga-UI will put the default service file 
      <parameter>prolingauisvc.xml</parameter> in the etc directory.</para>

      <para>A default configuration file looks like this:</para>

<programlisting><![CDATA[
<?xml version="1.0" encoding="utf-8" ?>

<!-- ProLinga-UI WebServices File -->
<!-- Copyright (C) 2002-2008 The ProLinga Team. -->
<!-- All Rights Reserved. -->
                                                                                                                                             
<ProLinga>
        <UIServices>
                <UIService Name="Default">
                        <ServiceHost>localhost</ServiceHost>
                        <ServicePort>8005</ServicePort>
                </UIService>
                <UIService Name="LiveStock">
                        <ServiceHost>localhost</ServiceHost>
                        <ServicePort>8005</ServicePort>
                </UIService>
        </UIServices>
</ProLinga>
                                                                                                                                             
]]></programlisting>

      <para>
        There is a section for every service available.
        The setup of this configuration file is such that it can be combined with
        configuration files from other ProLinga projects.
      </para>

  </refsect1>

  <refsect1 id="prolinga-ui-svc_options">
    <title>Service Options</title>
    <variablelist>
      <varlistentry>
	<term><option>ServiceHost</option></term>
	<listitem>
	  <simpara>
	    The name or IP number of the host where to connect to, to present
            a UI Command.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>ServicePort</option></term>
	<listitem>
	  <simpara>
	    The TCP port of the host where to connect to, to present
            a UI Command.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
</refentry>

