DPML Notify

[pneubauer AT netcompartner.com]

Author: pneubauer
Date: Mon Jan  3 22:25:27 2005
New Revision: 1368

Modified:
   development/main/central/site/src/docs/products/transit/launcher/index.xml
   
development/main/transit/plugin/src/main/net/dpml/transit/control/CommandHandler.java
Log:
Tried to update docs on the CLI options


Modified: 
development/main/central/site/src/docs/products/transit/launcher/index.xml
==============================================================================
--- 
development/main/central/site/src/docs/products/transit/launcher/index.xml  
(original)
+++ 
development/main/central/site/src/docs/products/transit/launcher/index.xml  
Mon Jan  3 22:25:27 2005
@@ -28,15 +28,82 @@
     <section name="Transit Application Launcher">
 
       <source>@METRO-PLUGIN-URI@</source>
+         <subsection name="Environment variables">
 
-      <subsection name="CLI Options">
+      <p>
 
+      <table>
+          <tr>
+            <th>Property</th>
+            <th>Default Value</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>DPML_HOME</td>
+            <td>${user.home}/.dpml</td>
+            <td>The DPML home directory</td>
+          </tr>
+        </table>
+      </p>
+      </subsection>
+      <subsection name="CLI Options">
       <p>
-WRITE ME - PLEASE
+        The CLI Options include both the setting of system properties using 
the -Xfoo=bar method,
+        and "real" command line options understood by the Transit system.
+      <table>
+          <tr>
+            <th>Option</th>
+            <th>Value</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>-lang</td>
+            <td><code>language-code</code></td>
+            <td>A two-letter language code to provide hooks for I18N.</td>
+          </tr>
+          <tr>
+            <td>-debug</td>
+            <td>none, is a switch</td>
+            <td>
+                Enable stacktrace and debug message reporting.
+            </td>
+          </tr>
+          <tr>
+            <td>-Xhelp</td>
+            <td>none, is a switch</td>
+            <td>
+                Prints a help message on the available transit plugin CLI 
options
+            </td>
+          </tr>
+          <tr>
+            <td>-Xversion</td>
+            <td>not activated</td>
+            <td>
+                Prints version information of the transit plugin version
+            </td>
+          </tr>
+          <tr>
+            <td>-get [URI1, URI2, ...]</td>
+            <td>none</td>
+            <td>
+                downloads the supplied artifacts into the local cache
+            </td>
+          </tr>
+          <tr>
+            <td>-load [URI] [arg1 arg2 ...]</td>
+            <td></td>
+            <td>
+                Transit loads the (single) plugin from the supplied artifact 
URI.
+                If the plugin is an instance of 
<code>java.lang.Runnable</code>, it will be started by the controller using 
the <code>start()</code>
+                method. The arguments after the URI specification are 
forwarded to the plugin.
+                A shutdown hook is added to the newly loaded plugin to 
enable clean shutdown together with the transit instance.
+                <br/>For instance, Metro is started via:
+                <br/><code>transit -load 
artifact:meta:dpml/metro/tools/dpml-metro-main#SNAPSHOT</code>
+            </td>
+          </tr>
+        </table>
       </p>
-
       </subsection>
-
     </section>
   </body>
 </document>

Modified: 
development/main/transit/plugin/src/main/net/dpml/transit/control/CommandHandler.java
==============================================================================
--- 
development/main/transit/plugin/src/main/net/dpml/transit/control/CommandHandler.java
       (original)
+++ 
development/main/transit/plugin/src/main/net/dpml/transit/control/CommandHandler.java
       Mon Jan  3 22:25:27 2005
@@ -239,9 +239,9 @@
     }
 
    /**
-    * Internal utility method to handle the load command during which a 
single
+    * Internal utility method to handle the load command during which a 
single artifact
     * is deployed.
-    * @param target the artifacts to get
+    * @param target the artifact to get
     */
     public void handleLoadCommand( String target )
     {