mcconnell 2004/04/02 20:52:08
Modified: merlin/platform/xdocs/merlin/embedded cli.xml
merlin/platform/xdocs/merlin index.xml
merlin/platform/xdocs/reference/system index.xml
navigation.xml
Added: merlin/platform/xdocs/merlin/systems kernel.xml
Removed: merlin/platform/xdocs/reference/system cli.xml
Log:
Reshuffling and improving docs.
Revision Changes Path
1.2 +114 -8 avalon/merlin/platform/xdocs/merlin/embedded/cli.xml
Index: cli.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/merlin/embedded/cli.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- cli.xml 3 Apr 2004 04:34:08 -0000 1.1
+++ cli.xml 3 Apr 2004 04:52:07 -0000 1.2
@@ -17,22 +17,128 @@
limitations under the License.
-->
+
<document>
- <properties>
- <author email="[EMAIL PROTECTED]">Stephen McConnell</author>
- <title>Command-line Merlin</title>
- </properties>
+ <header>
+ <title>Merlin CLI</title>
+ <authors>
+ <person name="Stephen McConnell" email="[EMAIL PROTECTED]"/>
+ </authors>
+ </header>
<body>
-
- <section name="Commandline Merlin">
-
+ <section name="Merlin CLI (Command Line Interface)">
<subsection name="Overview">
+ <p>
+Merlin CLI is the command line interface to the Merlin system. It provides
support for the declaration of the root block directive, a working home
directory, a kernel directive, and other parameters qualifying debug output and
language policy.
+ </p>
+ <p>
+The prime objective the Merlin CLI is to launch a root block descriptor and
facilitate the deployment of the block and as a consequence, the deployment of
subsidiary blocks, containers and components.
+ </p>
+ </subsection>
+ <subsection name="Command Line">
+ <p>
+The Merlin CLI takes a [block] filename as it's primary argument. The block
may be a block XML file or a jar file containing a block directive.
+ </p>
+ <p>
+ <i>
+Example of block deployment based on a supplied block directive.
+ </i>
+ </p>
+<source><![CDATA[
+ $ merlin -help
+usage: merlin [block] [-lang <code>] [-anchor <directory>]
+ [-help] [-version] [-home <directory>] [-impl <artifact>]
+ [-debug] [-info] [-config <url>] [-context <directory>] [-system
+ <directory>] [-execute] [-repository <directory>] [-kernel <url>]
+]]></source>
</subsection>
+ <subsection name="Command Line Qualifiers">
+ <table>
+ <tr><th>Qualifier</th><th>Parameter</th><th>Description</th></tr>
+ <tr>
+ <td>lang</td>
+ <td>A two letter country code</td>
+ <td>Sets the default language country code to the supplied
value.</td>
+ </tr>
+ <tr>
+ <td>anchor</td>
+ <td>directory</td>
+ <td>Override the default anchor directory for jar extension
references
+ and classpath include relative file references.</td>
+ </tr>
+ <tr>
+ <td>help</td><td></td><td>Prints the help message.</td>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td></td>
+ <td>Prints Merlin version information and exit.</td>
+ </tr>
+ <tr>
+ <td>home</td>
+ <td>directory</td>
+ <td>Overide the ${merlin.dir} directory. This is a relative
+ or absolute path to a working directory. If not suppled,
+ the system will default to ${user.dir}.</td>
+ </tr>
+ <tr>
+ <td>impl</td>
+ <td>artifact-spec</td>
+ <td>Override the ${merlin.implementation} artifact spec. The
specification
+ is the formal of [group]:[artifact];[version] and is used to
direct the
+ boostrap system to load an alternative kernel
implementation.</td>
+ </tr>
+ <tr>
+ <td>debug</td>
+ <td></td>
+ <td>Instructs Merlin to issue internal system debug
messages.</td>
+ </tr>
+ <tr>
+ <td>info</td>
+ <td></td>
+ <td>Lists deployment parameters on startup.</td>
+ </tr>
+ <tr>
+ <td>config</td><td>url</td>
+ <td>A configuration source containing a set of target
configuration fragements that will override configuration entries defined under
a block. This value overrides any ${merlin.override} property value. If the
supplied argument is a file (relative or absolute) Merlin will convert the file
to a url. Relative file references are resolved relative to ${merlin.dir}.</td>
+ </tr>
+ <tr>
+ <td>context</td>
+ <td>directory</td>
+ <td>Overide the ${merlin.context} directory. This is a relative
+ or absolute path to a working context directory. If not
suppled,
+ the system will default to ${merlin.dir}/home.</td>
+ </tr>
+ <tr>
+ <td>system</td>
+ <td>directory</td>
+ <td>Overide the ${merlin.system} directory. This is a relative
+ or absolute path to the merlin system repository. The default
+ value resolves to ${merlin.home}/system.</td>
+ </tr>
+ <tr>
+ <td>execute</td>
+ <td></td>
+ <td>Forces ${merlin.server} to false resulting in the immediate
shutdown
+ of the kernel on completion of the deployment phase. If not
included merlin
+ will apply the default ${merlin.server} mode of 'true'.</td>
+ </tr>
+ <tr>
+ <td>repository</td><td>file</td>
+ <td>Declaration of a local repository cache directory. If not
+ suppplied Merlin will default to
${avalon.home}/repository.</td>
+ </tr>
+ <tr>
+ <td>kernel</td><td>url</td>
+ <td>A url of a kernel configuration overriding the default
kernel
+ directive. The value defaults to
${merlin.config}/kernel.xml.</td>
+ </tr>
+ </table>
+ </subsection>
</section>
-
</body>
</document>
1.4 +2 -2 avalon/merlin/platform/xdocs/merlin/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/merlin/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 3 Apr 2004 04:34:08 -0000 1.3
+++ index.xml 3 Apr 2004 04:52:07 -0000 1.4
@@ -39,14 +39,14 @@
</td>
</tr>
<tr>
- <td><a href="system/index.html">Subsystems</a></td>
+ <td><a href="systems/index.html">Subsystems</a></td>
<td>
Introduction to the respective substems and relationships with
the Merlin system.
</td>
</tr>
<tr>
- <td><a href="deployment/index.html">Embedded</a></td>
+ <td><a href="embedded/index.html">Embedded</a></td>
<td>
Introduction to a set of available applications solutions
the include an embedded Merlin Kernel.
1.4 +0 -6 avalon/merlin/platform/xdocs/reference/system/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/avalon/merlin/platform/xdocs/reference/system/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 2 Apr 2004 08:10:01 -0000 1.3
+++ index.xml 3 Apr 2004 04:52:07 -0000 1.4
@@ -43,12 +43,6 @@
Additional parameters may be defined at the level of the merlin kernel.
These parameters concern security profiles, root container and classloader, and
the application repository.
</td>
</tr>
- <tr>
- <td><a href="cli.html">CLI Options</a></td>
- <td>
-Specification of the available command-line options.
- </td>
- </tr>
</table>
</subsection>
</section>
1.3 +0 -1
avalon/merlin/platform/xdocs/reference/system/navigation.xml
Index: navigation.xml
===================================================================
RCS file:
/home/cvs/avalon/merlin/platform/xdocs/reference/system/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 2 Apr 2004 08:10:01 -0000 1.2
+++ navigation.xml 3 Apr 2004 04:52:07 -0000 1.3
@@ -48,7 +48,6 @@
<item name="System Specification"
href="/reference/system/index.html">
<item name="Properties" href="/reference/system/properties.html"/>
<item name="kernel" href="/reference/system/kernel/index.html"/>
- <item name="CLI" href="/reference/system/cli.html"/>
</item>
</item>
<item name="Download" href="/resources/download.html"/>
1.1 avalon/merlin/platform/xdocs/merlin/systems/kernel.xml
Index: kernel.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<author email="[EMAIL PROTECTED]">Stephen McConnell</author>
<title>Avalon Merlin Kernel Subsystem</title>
</properties>
<body>
<section name="Avalon Merlin Kernel Subsystem">
<subsection name="Introduction">
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
