<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="commands.jclient" xml:lang="en"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:svg="http://www.w3.org/2000/svg"
         xmlns:mml="http://www.w3.org/1998/Math/MathML"
         xmlns:html="http://www.w3.org/1999/xhtml"
         xmlns:db="http://docbook.org/ns/docbook">
  <title>jclient command</title>

  <para>Start a client container.</para>

  <section>
    <title>Options</title>

    <cmdsynopsis>
      <command>jclient</command>

      <arg>-cp classpath</arg>

      <arg>-security</arg>

      <arg>-jarClient</arg>

      <arg>-traceFile</arg>

      <arg>-carolFile</arg>

      <arg>-tmpDir</arg>

      <arg>-nowsgen</arg>

      <arg choice="plain">java-class</arg>

      <arg>args</arg>
    </cmdsynopsis>

    <variablelist>
      <varlistentry>
        <term>-jarClient</term>

        <listitem>
          <para>Specify the client jar to use of the ear if many.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-traceFile</term>

        <listitem>
          <para>Specify the configuration file to use for the traces of this
          client instead of the default file</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-carolFile</term>

        <listitem>
          <para>Specify the carol.properties file to use instead of the
          default carol.properties file of the client.jar</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-tmpDir</term>

        <listitem>
          <para>Specify the temp directory where unpack the ear.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-cp classpath</term>

        <listitem>
          <para>Add an additional classpath before running the java
          program.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-nowsgen</term>

        <listitem>
          <para>Specify if the Container shouldn't use Automated WsGen.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-security</term>

        <listitem>
          <para>Set a security manager using the policy file in
          <filename>$JONAS_BASE/conf/java.policy</filename>. (Used for
          automatic stubs downloading)</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </section>

  <section>
    <title>Description</title>

    <para>The jclient command allows the user to easily start a "heavy" java
    client that will be able to reach beans in remote <xi:include
    href="../variables.xml" xpointer="appserver" /> servers and start
    distributed transactions.</para>

    <para>It is not the J2EE compliant way to run a java client which is to
    package the java client into a J2EE container client (refer to Client
    Packaging).</para>
  </section>
</chapter>
