notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1094 - in trunk/main/central/src/docs: metro/runtime transit/cli

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1094 - in trunk/main/central/src/docs: metro/runtime transit/cli
Date: Tue, 14 Feb 2006 14:05:01 +0100

Author: mcconnell
Date: 2006-02-14 14:04:57 +0100 (Tue, 14 Feb 2006)
New Revision: 1094

Added:
trunk/main/central/src/docs/transit/cli/load.xml
Modified:
trunk/main/central/src/docs/metro/runtime/types.xml
trunk/main/central/src/docs/transit/cli/index.xml
trunk/main/central/src/docs/transit/cli/navigation.xml
Log:
1. update docs re. transit plugin loading capability
2. fix broken link in metro runtime docs

Modified: trunk/main/central/src/docs/metro/runtime/types.xml
===================================================================
--- trunk/main/central/src/docs/metro/runtime/types.xml 2006-02-14 10:14:37
UTC (rev 1093)
+++ trunk/main/central/src/docs/metro/runtime/types.xml 2006-02-14 13:04:57
UTC (rev 1094)
@@ -50,8 +50,8 @@
InfoDescriptor</a></td>
<td>The <tt>InfoDescriptor</tt> class holds information about
component name, the component implementation classname, the
- implementation version, the component <a
href="profiles/lifestyle.html">lifestyle</a>,
- and garbage <a href="profiles/collection.html">collection</a>
policy.
+ implementation version, the component <a
href="parts/lifestyle.html">lifestyle</a>,
+ and garbage <a href="parts/collection.html">collection</a>
policy.
</td>
</tr>
<tr>

Modified: trunk/main/central/src/docs/transit/cli/index.xml
===================================================================
--- trunk/main/central/src/docs/transit/cli/index.xml 2006-02-14 10:14:37
UTC (rev 1093)
+++ trunk/main/central/src/docs/transit/cli/index.xml 2006-02-14 13:04:57
UTC (rev 1094)
@@ -24,13 +24,14 @@

<subsection name="Commandline">

-<pre><![CDATA[$ transit info | add <id> | set <id> | remove <id> | revert |
help [-profile <uri>]]]></pre>
+<pre><![CDATA[$ transit load <uri> | info | add <id> | set <id> | remove
<id> | revert | help [-profile <uri>]]]></pre>

</subsection>

<subsection name="Options">

<table>
+ <tr><td>load</td><td>Loads a plugin refernced by a supplied
uri.</td></tr>
<tr><td>info</td><td>Lists the current configration to
console.</td></tr>
<tr><td>add</td><td>Add a new host, layout or content
handler.</td></tr>
<tr><td>set</td><td>Update a feature of a host, layout, content
handler,
@@ -49,10 +50,10 @@
$ transit help]]></pre>
<source><![CDATA[
Usage:
-transit [-profile <uri> info|add|set|remove|revert|help]
+transit [-profile <uri> info|add|set|remove|revert|load <uri>|help]
command
-profile <uri> Configuration profile
uri.
- info|add|set|remove|revert|help
+ info|add|set|remove|revert|load|help
info List configuration.
add
host handler layout
@@ -125,6 +126,7 @@
layout <id> Layout scheme
selection.
proxy Delete proxy settings.
revert Set configuration to
default.
+ load <uri> Load a transit plugin.
help Print command
help.]]></source>

</subsection>

Added: trunk/main/central/src/docs/transit/cli/load.xml
===================================================================
--- trunk/main/central/src/docs/transit/cli/load.xml 2006-02-14 10:14:37
UTC (rev 1093)
+++ trunk/main/central/src/docs/transit/cli/load.xml 2006-02-14 13:04:57
UTC (rev 1094)
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<document>
+
+ <properties>
+ <author email="mcconnell AT dpml.net">Stephen McConnell</author>
+ <title>DPML Transit Info Command</title>
+ </properties>
+
+ <body>
+
+ <section name="Load Command">
+
+ <subsection name="Description">
+
+ <p>
+ The <tt>load</tt> command may be used to invoke the deployment of a
+ transit plugin.
+ </p>
+
+ </subsection>
+
+ <subsection name="Commandline">
+
+<pre><![CDATA[$ transit info [<args1> [<args2> ...]]]]></pre>
+
+ </subsection>
+
+ <subsection name="Example">
+
+ <p>The following example demonstrates the loading of a test plugin
+ that uses JNI to access the Windows registry and print information
+ back to the console.</p>
+
+<pre><![CDATA[$ transit load
artifact:plugin:osm/registry-main#SNAPSHOT]]></pre>
+<source><![CDATA[
+
+Sys Account: true
+SYSTEM\CurrentControlSet\Control\Session Manager\Environment
+DPML_HOME = C:\dpml
+DPML_SYSTEM = null
+]]></source>
+
+ </subsection>
+ </section>
+
+ </body>
+
+</document>
+

Modified: trunk/main/central/src/docs/transit/cli/navigation.xml
===================================================================
--- trunk/main/central/src/docs/transit/cli/navigation.xml 2006-02-14
10:14:37 UTC (rev 1093)
+++ trunk/main/central/src/docs/transit/cli/navigation.xml 2006-02-14
13:04:57 UTC (rev 1094)
@@ -29,6 +29,7 @@
<item name="Add" href="add/index.html"/>
<item name="Set" href="set/index.html"/>
<item name="Remove" href="remove/index.html"/>
+ <item name="Load" href="load.html"/>
</menu>

</body>

r1094 - in trunk/main/central/src/docs: metro/runtime transit/cli, mcconnell at BerliOS, 02/14/2006