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

[plavin]

Author: plavin
Date: 2006-12-06 18:02:25 +0100 (Wed, 06 Dec 2006)
New Revision: 4131

Log:
Using the GRT shell outside GUI Tools

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 17:01:06 UTC (rev 4130)
+++ trunk/gui-common/chapter-grt-shell.xml	2006-12-06 17:02:25 UTC (rev 4131)
Changed blocks: 6, Lines Added: 103, Lines Deleted: 9; 5564 bytes

@@ -93,7 +93,7 @@
 
     <para>
       On the right, is the <literal>GRT Globals
-      Tree</literal>&mdash;showing the various objects, structures, and
+      Tree</literal>&mdash;showing the various objects, variables,  structures,
and
       code modules used by the application. These objects are all
       directly accessible from the shell.
     </para>

@@ -380,17 +380,16 @@
         <title>The <literal>Struct</literal> Tab</title>
 
         <para>
-          This tab contains the definitions of the structs
+          A <literal>struct</literal> is a user-defined data type
+          formed by combining primitive data types.
+          This tab shows the definitions of the structs
           used by the objects in the <literal>Values</literal> tab
           and the modules in the <literal>Modules</literal> tab.
-          <remark>
-            Structures - C struct data types?
-          </remark>
-        </para>
+         </para>
 
         <para>
           When the <literal>Structs</literal> tab is selected right
-          clicking an object in the Globals Tree panel opens a pop-up
+          clicking a structure in the list opens a pop-up
           menu with the options:
 
           <itemizedlist>

@@ -421,6 +420,31 @@
             Note this pop-up menu only shows under Windows.
           </para>
         </note>
+        
+        <para>
+          The default view for this tab is by package,
+          a grouping of elements by functionality.          
+          Double-click a package to show related
+          structures. Under <literal>db.mgmt</literal>,
+          for example, you should see elements you are already
+          familiar with from the user interface,
<literal>Connection</literal>,
+          <literal>Driver</literal>, and so forth.
+          If an element can be further decomposed, an arrow
+          will show on it's left. Double-click the item to
+          reveal its constituent elements. 
+        </para>
+        
+        <para>
+          If you switch to the hierarchical view
+          you'll find the <literal>db.mgmt.driver</literal>
+          object under the <literal>GRT Object</literal>
+          since this is the parent object from which it is derived.
+        </para>
+        
+        <para>
+          Ordering by name simply shows all the different
+          objects arranged alphabetically.
+        </para>
 
       </section>
 

@@ -466,7 +490,7 @@
 
         <listitem>
           <para>
-            <literal>grtV</literal> &ndash; for accessing any object in
+            <literal>grtV</literal> &ndash; for accessing any
object/variable in
             the <literal>Values</literal> tab
           </para>
         </listitem>

@@ -492,6 +516,7 @@
     <para>
       All items in all the tabs are accessible from the GRT
       shell.
+      <remark>You can use the structs defined ...</remark>
     </para>
 
     <para>

@@ -561,8 +586,77 @@
     </para>
 
   </section>
+  
+  <section id="directly-invoking-grt">
+    <title>Directly Invoking the GRT Shell</title>
+    
+    <note>
+      <para>
+        This capability is currently only available 
+        under Windows.
+      </para>
+    </note>
+    
+    <para>
+      In addition to using the GRT shell from within the 
+      &workbench; or the &migration_toolkit;, you can invoke it directly from
+      the command line.
+      If the location of the &gui_tools; is not
+      included in the <literal>PATH</literal> variable, navigate to
+      the installation directory and find the <filename>grtsh.exe</filename>
+      file.
+    </para>
+    
+    <para>
+      Execute this file by typing:  
+   </para>
+    
+    <programlisting>   
+C:\&gt; <userinput>grtsh -?</userinput>
+</programlisting>
+    
+    <para>
+      Do this and you should see the following listing:
+    </para>
+    
+    <programlisting>
+Usage: C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe [-classpath path]
[-modulepath path] [-jvm library] [-d path] [-listen port] [-verbose] [-x] [luafile] 
+       C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -j structsfile outputdir
+       C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -p structsfile outputdir
 
+  -lua ......... Use the Lua shell (default).
+  -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).
+  -basedir ..... Path to the data files location.
+  -d path ...... Modules directory
+  -x ........... Exits the shell after running the specified file
+  luafile ...... File that is run at startup.
+
+  -listen port . Runs in 'remote agent' mode on the given port number.
+  -verbose ..... Prints detailed startup information.
+  -j ........... Generates Java classes from the given structs file.
+  -p ........... Generates PHP classes from the given structs file.
+  -D var=value . Sets a global shell variable to the given value.
+Environment variables:
+GRT_MODULE_PATH  Equivalent to -modulepath, must point to the directory
+                 where the grtsh binary resides
+</programlisting>
+    
+    
+  </section>
+  
+  
 <!--End Using -->
-
+  <!--section id="grt-creating-plugins">
+    <title>Creating Plugins</title>
+    
+    <para>
+      
+    </para>
+  </section-->
+  
+  
 </chapter>
 <!-- end GRT Shell -->