You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by rd...@apache.org on 2008/12/13 14:12:15 UTC

svn commit: r726197 - in /james/mpt/trunk: app/src/site/xdoc/index.xml src/site/site.xml src/site/xdoc/index.xml

Author: rdonkin
Date: Sat Dec 13 05:12:14 2008
New Revision: 726197

URL: http://svn.apache.org/viewvc?rev=726197&view=rev
Log:
Website for app module

Modified:
    james/mpt/trunk/app/src/site/xdoc/index.xml
    james/mpt/trunk/src/site/site.xml
    james/mpt/trunk/src/site/xdoc/index.xml

Modified: james/mpt/trunk/app/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/mpt/trunk/app/src/site/xdoc/index.xml?rev=726197&r1=726196&r2=726197&view=diff
==============================================================================
--- james/mpt/trunk/app/src/site/xdoc/index.xml (original)
+++ james/mpt/trunk/app/src/site/xdoc/index.xml Sat Dec 13 05:12:14 2008
@@ -41,8 +41,33 @@
 </section>
 <section name='Development Interface'>
 <p>
-This module contains an executable interface useful when developing scripts. 
+This module contains an executable interface useful when developing scripts. The application ships as a 
+self-contained executable jar. To run:
 </p>
+<source>
+java -jar apache-james-mtp-app-<em>version</em>.jar
+</source>
+<p>
+Usage:
+</p>
+<source><pre><![CDATA[
+ -f,--file <file>         run this script
+ -h,--host <host>         runs against this host (defaults to localhost)
+ -p,--port <port>         runs against this port
+ -s,--shabang <shabang>   sets shabang (defaults to empty)
+ -v,--verbose             prints lots of logging
+]]></pre></source>
+</section>
+<section name='Features'>
+<subsection name='Run Single Script'>
+<p>
+Executes a single script from a file against a given port and host. The host default to <code>localhost</code>.
+For example, to run the script in file <code>&lt;file&gt;</code> against localhost port <code>&lt;port&gt;</code>:
+</p>
+<source>
+java -jar apache-james-mtp-app-<em>version</em>.jar -f <![CDATA[<file> -p <port> ]]>
+</source>
+</subsection>
 </section>
 </body>
 </document>

Modified: james/mpt/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/mpt/trunk/src/site/site.xml?rev=726197&r1=726196&r2=726197&view=diff
==============================================================================
--- james/mpt/trunk/src/site/site.xml (original)
+++ james/mpt/trunk/src/site/site.xml Sat Dec 13 05:12:14 2008
@@ -36,6 +36,7 @@
       <item name="Overview" href="http://james.apache.org/mpt/index.html"/>
       <item name='Main Library' href='http://james.apache.org/mpt/main'/>
       <item name='AntLib' href='http://james.apache.org/mpt/antlib'/>
+      <item name='Application' href='http://james.apache.org/mpt/app'/>
     </menu>
 
     <menu name="Useful Information" inherit='bottom'>

Modified: james/mpt/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/mpt/trunk/src/site/xdoc/index.xml?rev=726197&r1=726196&r2=726197&view=diff
==============================================================================
--- james/mpt/trunk/src/site/xdoc/index.xml (original)
+++ james/mpt/trunk/src/site/xdoc/index.xml Sat Dec 13 05:12:14 2008
@@ -47,6 +47,10 @@
 to create functional testing tasks suitable for execution against a 
 indepedently running server.
 </p>
+<p>
+The <a href='app'>Application</a> module provides an executable interface
+for MPT.
+</p>
 </subsection>
 </section>
 <section name='More Information'>



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org