svn commit - mysqldoc@docsrva: r4140 - trunk/gui-common

[plavin]

Author: plavin
Date: 2006-12-06 20:29:17 +0100 (Wed, 06 Dec 2006)
New Revision: 4140

Log:
More using GRT from the command line

Modified:
   trunk/gui-common/chapter-grt-shell.xml


Modified: trunk/gui-common/chapter-grt-shell.xml
===================================================================
--- trunk/gui-common/chapter-grt-shell.xml	2006-12-06 19:09:36 UTC (rev 4139)
+++ trunk/gui-common/chapter-grt-shell.xml	2006-12-06 19:29:17 UTC (rev 4140)
Changed blocks: 3, Lines Added: 81, Lines Deleted: 4; 4436 bytes

@@ -587,8 +587,8 @@
 
   </section>
   
-  <section id="directly-invoking-grt">
-    <title>Directly Invoking the GRT Shell</title>
+  <section id="invoking-grt-from-command-line">
+    <title>Invoking the GRT Shell From the Command Line</title>
     
     <note>
       <para>

@@ -628,7 +628,7 @@
   -py .......... Use the Python shell.
   -classpath ... Sets the java classpath to the given value.
   -modulepath .. Sets the location of the GRT module directory.
-  -jvm ......... The java virtual machine library to use (with absolut path).
+  -jvm ......... The java virtual machine library to use (with absolute path).
   -basedir ..... Path to the data files location.
   -d path ...... Modules directory
   -x ........... Exits the shell after running the specified file

@@ -642,9 +642,86 @@
 Environment variables:
 GRT_MODULE_PATH  Equivalent to -modulepath, must point to the directory
                  where the grtsh binary resides
-</programlisting>
+</programlisting>   
     
+    <para>
+      The default shell is the <literal>lua</literal> shell and is indicated
+      by the <literal>/ &gt;</literal> prompt. Using the
<option>-py</option>
+      option opens a Python shell, indicated by the
<literal>/&gt;&gt;&gt;</literal> prompt.
+    </para>
     
+    <para>
+      If you wish to set the classpath for Java classes 
+      use the <option>classpath</option> option. You may also change the
+      Java Virtual Machine (JVM) by using the <option>jvm</option> option
+      with the absolute path to the JVM you wish to use.
+    </para>
+    
+    <para>
+      The <option>modulepath</option> option sets the location of
+      the <filename>dll</filename> files used with the GRT shell.
+      These files are located in the same directory as the
<filename>grtsh.exe</filename>
+      file. You can also set this directory by defining the environment
+      variable, <literal>GRT_MODULE_PATH</literal>.
+    </para>
+    
+    <para>
+      The location of any data files you wish to use may be set using 
+      the <option>basedir</option> option. 
+      <remark>What are data files?</remark>
+    </para>
+    
+    <para>
+      To see the various modules that are loaded at startup
+      use the <option>verbose</option> option. The java modules are
+      stored in the <filename>java\com\mysql\grt\modules</filename>
+      directory immediately below the installation directory and the
+      <literal>lua</literal> modules in the
<filename>lua</filename>
+      directory. Currently, importation of Python
+      modules is not supported.
+    </para>
+    
+    <para>
+      To include modules other than the default modules,
+      use the <option>d</option> option with a path.
+    </para>
+    
+    <para>
+      It is also possible to use the GRT shell to convert XML
+      files to Java or PHP class files, by opening the shell
+      using the <option>j</option> 
+      or the <option>p</option> option and specifying the XML
+      source file and the destination directory.
+    </para>
+    
+    <para>
+      Use the <option>listen</option> option with a port number to run the
GRT shell
+      as a service that can be accessed from a remote location. 
+    </para>
+      
+    <para>
+      Perhaps most importantly, you can pass a <literal>lua</literal> file
+      to the shell on startup. This allows you to perform tasks using a
+      script file without even opening the &workbench; or
+      the &migration_toolkit;. This is an especially useful feature
+      if you need to migrate the same database a number of times
+      or you want to customize a migration.
+      <remark>Can't xref an id that only exists in MT?</remark>
+      Passing a <literal>lua</literal> file to the shell is usually invoked
+      using the <option>x</option> option so that the shell closes after
+      the script has executed.
+    </para>
+    
+    <para>
+      The appearance of the GRT shell is identical to
+      its appearance when run from within the &workbench; or
+      the &migration_toolkit;.
+      All the commands and options described in
+      <xref linkend="using-grt-shell"/> are available when
+      the GRT shell is invoked from the command line.
+    </para>   
+    
+    
   </section>