You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by mb...@apache.org on 2007/05/31 11:39:16 UTC
svn commit: r543098 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools:
tools.pear.merger.xml tools.pear.packager.xml
Author: mbaessler
Date: Thu May 31 02:39:15 2007
New Revision: 543098
URL: http://svn.apache.org/viewvc?view=rev&rev=543098
Log:
UIMA-377
add PearPackager command line documentation
JIRA ticket https://issues.apache.org/jira/browse/UIMA-377
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.merger.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.merger.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.merger.xml?view=diff&rev=543098&r1=543097&r2=543098
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.merger.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.merger.xml Thu May 31 02:39:15 2007
@@ -37,12 +37,10 @@
merging needs to be done by hand. Please see the Restrictions and Limitations section,
below.</para>
- <para>This is a command-line utility; there are shell scripts (.bat for Windows, and .sh for
- Unix) to run it.</para>
+ <para>To run the PearMerger command line utility you can use the runPearMerger scripts (.bat for Windows, and .sh for
+ Unix). The usage of the tooling is shown below:</para>
- <para><command>runPearMerger 1<superscript>st</superscript>_input_pear_file ...
- n<superscript>th</superscript>_input_pear_file -n output_analysis_engine_name [
- -f output_pear_file ]</command></para>
+ <para><programlisting>runPearMerger 1st_input_pear_file ... nth_input_pear_file -n output_analysis_engine_name [-f output_pear_file ]</programlisting></para>
<para>The first group of parameters are the input PEAR files. No duplicates are allowed
here. The <literal>-n</literal> parameter is the name of the generated Aggregate
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml?view=diff&rev=543098&r1=543097&r2=543098
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.pear.packager.xml Thu May 31 02:39:15 2007
@@ -30,18 +30,18 @@
Information Management Architecture) components. The PEAR package can be used for
distribution and reuse by other components or applications. It also allows applications
and tools to manage UIMA components automatically for verification, deployment,
- invocation, testing, etc. Please refer to the PEAR Reference chapter for more
- information about the internal structure of a PEAR file.</para>
+ invocation, testing, etc. Please refer to <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.pear"/>
+ for more information about the internal structure of a PEAR file.</para>
- <para>This chapter describes how to use the PEAR Eclipse Plugin to create PEAR files for
- standard UIMA components. This plugin is installed if you followed the directions in
- <olink targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup"/>
- .</para>
+ <para>This chapter describes how to use the PEAR Eclipse plugin or the PEAR command line packager
+ to create PEAR files for standard UIMA components.</para>
<section id="ugr.tools.pear.packager.using_eclipse_plugin">
<title>Using the PEAR Eclipse Plugin</title>
- <para>Using the PEAR Eclipse Plugin involves the following two steps:</para>
+ <para>The PEAR Eclipse plugin is automatically installed if you followed the directions in
+ <olink targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup"/>. The use of the
+ plugin involves the following two steps:</para>
<itemizedlist spacing="compact"><listitem><para>Add the UIMA nature to your project
</para></listitem>
@@ -307,5 +307,79 @@
</section>
</section>
</section>
+
+ <section id="ugr.tools.pear.packager.using_command_line">
+ <title>Using the PEAR command line packager</title>
+ <para>The PEAR command line packager takes some PEAR package parameter settings on the command line to create an
+ UIMA PEAR file.</para>
+
+ <para>To run the PEAR command line packager you can use the provided runPearPackager (.bat for Windows, and .sh for Unix)
+ scripts. The packager can be used in three different modes.</para>
+ <para><itemizedlist>
+ <listitem>
+ <para>Mode 1: creates a complete PEAR package with the provided information (default mode)</para>
+ <para><programlisting>runPearPackager -compID <componentID> -mainCompDesc <mainComponentDesc> [-classpath <classpath>]
+ [-datapath <datapath>] -mainCompDir <mainComponentDir> -targetDir <targetDir>
+ [-envVars <propertiesFilePath>]</programlisting></para>
+ <para> The created PEAR file has the file name <componentID>.pear and is located in the <targetDir>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Mode 2: creates a PEAR installation descriptor without packaging the PEAR file</para>
+ <para><programlisting>runPearPackager -create -compID <componentID> -mainCompDesc <mainComponentDesc>
+ [-classpath <classpath>] [-datapath <datapath>] -mainCompDir <mainComponentDir>
+ [-envVars <propertiesFilePath>]</programlisting></para>
+ <para> The PEAR installation descriptor is created in the <mainComponentDir>/metadata directory.</para>
+ </listitem>
+
+ <listitem>
+ <para>Mode 3: creates a PEAR package with an existing PEAR installation descriptor</para>
+ <para><programlisting>runPearPackager -package -compID <componentID> -mainCompDir <mainComponentDir>
+ -targetDir <targetDir></programlisting></para>
+ <para> The created PEAR file has the file name <componentID>.pear and is located in the <targetDir>.</para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+ <para>The modes 2 and 3 should be used when you want to manipulate the PEAR installation descriptor before packaging
+ the PEAR file. </para>
+
+ <para>Some more details about the PearPackager parameters is provided in the list below:</para>
+ <para><itemizedlist>
+ <listitem>
+ <simpara><literal><componentID></literal>: PEAR package component ID.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><mainComponentDesc></literal>: Main component descriptor of the PEAR package.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><classpath></literal>: PEAR classpath settings. Use $main_root macros to specify
+ path entries. Use <literal>;</literal> to separate the entries.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><datapath></literal>: PEAR datapath settings. Use $main_root macros to specify
+ path entries. Use <literal>;</literal> to separate the path entries.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><mainComponentDir></literal>: Main component directory that contains the PEAR package content.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><targetDir></literal>: Target directory where the created PEAR file is written to.</simpara>
+ </listitem>
+
+ <listitem>
+ <simpara><literal><propertiesFilePath></literal>: Path name to a properties file that contains environment variables that must be
+ set to run the PEAR content.</simpara>
+ </listitem>
+
+ </itemizedlist>
+
+ </para>
+ </section>
</chapter>