avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: avalon-sandbox/merlin/merlin-platform/xdocs/merlin/kernel cli.xml
Date Sun, 14 Sep 2003 13:05:06 GMT
mcconnell    2003/09/14 06:05:06

  Modified:    merlin/merlin-platform/xdocs/merlin/kernel cli.xml
  Log:
  Bring command line parameters up-to-date and including info about -repository parameter.
  
  Revision  Changes    Path
  1.4       +52 -16    avalon-sandbox/merlin/merlin-platform/xdocs/merlin/kernel/cli.xml
  
  Index: cli.xml
  ===================================================================
  RCS file: /home/cvs/avalon-sandbox/merlin/merlin-platform/xdocs/merlin/kernel/cli.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- cli.xml	11 Sep 2003 02:35:04 -0000	1.3
  +++ cli.xml	14 Sep 2003 13:05:06 -0000	1.4
  @@ -79,10 +79,12 @@
           </p>
   <source><![CDATA[
    $ merlin -help
  -usage: merlin [block] [-info]  [-debug] [-config <file>] [-lang <code>] 
  -  [-system <directory>] [-kernel <file>] [-home <directory>] [-version]
[-help]
  -]]></source>
  +usage: merlin [block] [-lang <code>] [-install <url>] [-library
  +       <directory>] [-help] [-version] [-home <directory>] [-debug] [-info]
  +       [-config <url>] [-jmx] [-execute] [-repository <directory>] [-kernel
  +       <url>]]></source>
         </subsection>
  +
         <subsection name="Command Line Qualifiers">
           <table>
             <tr><th>Qualifier</th><th>Parameter</th><th>Description</th></tr>
  @@ -90,38 +92,72 @@
               <td>-help</td><td></td><td>Prints the help message.</td>
             </tr>
             <tr>
  -            <td>-lang</td><td>A two letter country code</td><td>Sets
the default language country code to the supplied value.</td>
  +            <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>-version</td><td></td>
  -            <td>Prints Merlin version information.</td>
  +            <td>-version</td>
  +            <td></td>
  +            <td>Prints Merlin version information and exit.</td>
             </tr>
             <tr>
  -            <td>-info</td><td></td>
  +            <td>-info</td>
  +            <td></td>
               <td>Lists deployment parameters on startup.</td>
             </tr>
             <tr>
  -            <td>-debug</td><td></td>
  +            <td>-debug</td>
  +            <td></td>
               <td>Instructs Merlin to issue internal system debug messages.</td>
             </tr>
             <tr>
  -            <td>-home</td><td>directory</td>
  -            <td>A relative or absolute path to a working home directory. If not suppled,
the system will default to the current directory. If the resolved home path does not exist
it will be created.</td>
  +            <td>-home</td>
  +            <td>directory</td>
  +            <td>A relative or absolute path to a working home directory. If not suppled,
the system will default to ${user.dir}/home.</td>
             </tr>
             <tr>
  -            <td>-kernel</td><td>file</td>
  -            <td>The filename of a kernel configuration overriding the default kernel
directive.  The value defaults to the system kernel.xml file.</td>
  +            <td>-kernel</td><td>url</td>
  +            <td>A url of a kernel configuration overriding the default kernel directive.
 The value defaults to ${merlin.home}/config/kernel.xml.</td>
             </tr>
             <tr>
  -            <td>-config</td><td>file</td>
  -            <td>A configuration file containing a set of target qualified configuration
fragements that will override configuration entries defined under a block.</td>
  +            <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.</td>
             </tr>
             <tr>
  -            <td>-system</td><td>file</td>
  -            <td>Override the MERLIN_HOME installation directory with an alternative
system directory.</td>
  +            <td>-repository</td><td>file</td>
  +            <td>Declaration of a local repository.  If not suppplied Merlin will
default to ${merlin.home}/repository/.</td>
             </tr>
           </table>
         </subsection>
  +
  +      <subsection name="Command Line Qualifiers (non-standard)">
  +
  +        <p>
  +Non-standard command line arguments should be considered as experimental 
  +and subject to change.  Usage without a good understanding of the internals 
  +of the Merlin platform is not recommended.
  +        </p>
  +
  +        <table>
  +          <tr><th>Qualifier</th><th>Parameter</th><th>Description</th></tr>
  +          <tr>
  +            <td>-jmx</td>
  +            <td></td>
  +            <td>
  +Launches a jmx server and registeres the merlin kernal as a managed entity.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td>-install</td>
  +            <td>url</td>
  +            <td>
  +Installation of a block archive (.bar file) into the local repository and exists.  The
-repository argument may be used to select the destination repository for the installation.
 Resource will be included relative to the bar file group identifier.  Existing resources
with a modification date equal to or later than the archived entry will be ignored.
  +            </td>
  +          </tr>
  +        </table>
  +      </subsection>
  +
       </section>
     </body>
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org


Mime
View raw message