Author: plavin
Date: 2006-12-06 22:53:59 +0100 (Wed, 06 Dec 2006)
New Revision: 4144
Log:
Reformat the GRT shell chapter
Added:
trunk/userguide/tools-tricks.xml
Modified:
trunk/gui-common/chapter-grt-shell.xml
trunk/userguide/Makefile
trunk/userguide/introduction.xml
trunk/userguide/userguide.xml
Property changes on: trunk/userguide/tools-tricks.xml
___________________________________________________________________
Name: svn:executable
+ *
Modified: trunk/gui-common/chapter-grt-shell.xml
===================================================================
--- trunk/gui-common/chapter-grt-shell.xml 2006-12-06 21:40:04 UTC (rev 4143)
+++ trunk/gui-common/chapter-grt-shell.xml 2006-12-06 21:53:59 UTC (rev 4144)
Changed blocks: 16, Lines Added: 167, Lines Deleted: 169; 20102 bytes
@@ -93,9 +93,9 @@
<para>
On the right, is the <literal>GRT Globals
- Tree</literal>—showing the various objects, variables, structures, and
- code modules used by the application. These objects are all
- directly accessible from the shell.
+ Tree</literal>—showing the various objects, variables,
+ structures, and code modules used by the application. These
+ objects are all directly accessible from the shell.
</para>
<section id="grt-menu-items">
@@ -124,7 +124,7 @@
<guimenu>Exit</guimenu>, which simply exits the GRT shell,
and <guimenu>Open Script</guimenu>. The <guimenu>Open
Script</guimenu> option is for opening existing
- <literal>lua</literal> scripts and is only implemented under
+ <literal>Lua</literal> scripts and is only implemented under
Windows.
</para>
@@ -145,17 +145,15 @@
<title>Linux Shell Menu</title>
<para>
- Under Linux the <guimenu>Shell</guimenu> menu
- shows menu items
- for closing the shell, refreshing the objects
- listed in the Global tree or saving the object tree.
+ Under Linux the <guimenu>Shell</guimenu> menu shows menu
+ items for closing the shell, refreshing the objects listed
+ in the Global tree or saving the object tree.
</para>
<para>
- The <guimenu>Save Tree ...</guimenu> menu option saves an XML
- file of all the data types and classes shown in the
- three tabs of the
- <literal>Objects Tree</literal>.
+ The <guimenu>Save Tree ...</guimenu> menu option saves an
+ XML file of all the data types and classes shown in the
+ three tabs of the <literal>Objects Tree</literal>.
</para>
<para>
@@ -245,8 +243,8 @@
</para>
<para>
- Some OS-specific commands are also available. For
- instance, under Windows you can clear the screen by typing
+ Some OS-specific commands are also available. For instance,
+ under Windows you can clear the screen by typing
<command>cls</command>. Unlike most shells, you can cut and
paste text to and from the shell window.
</para>
@@ -258,8 +256,8 @@
<para>
The <literal>Snippets</literal> tab functions as a scratch pad
- for saving code snippets. This makes it easy to reuse code
- and does away with the need to retype it at the command line.
+ for saving code snippets. This makes it easy to reuse code and
+ does away with the need to retype it at the command line.
</para>
<para>
@@ -288,16 +286,15 @@
How are these different?
</remark>
</para>
-
<section>
<title>The <literal>Values</literal> Tab</title>
<para>
- The objects shown in this tab differ
- depending upon which &gui_tools; application you are running.
- For example, if you are running &workbench; you should find a
+ The objects shown in this tab differ depending upon which
+ &gui_tools; application you are running. For example, if you
+ are running &workbench; you should find a
<literal>workbench</literal> object beneath the
<literal>root</literal> object. If you currently have a schema
loaded you should be able to find it beneath the
@@ -312,14 +309,13 @@
loaded. Detailed information about the currently selected
object appears in the window below the module tree.
</para>
-
+
<para>
If you are running &migration_toolkit;, the
- <literal>workbench</literal> object
- is absent but you will find a <literal>migration</literal>
- object beneath the
- <literal>root</literal> object. Both applications
- show the <literal>rdbmsMgmt</literal> object.
+ <literal>workbench</literal> object is absent but you will
+ find a <literal>migration</literal> object beneath the
+ <literal>root</literal> object. Both applications show the
+ <literal>rdbmsMgmt</literal> object.
</para>
<para>
@@ -380,17 +376,17 @@
<title>The <literal>Struct</literal> Tab</title>
<para>
- 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.
- </para>
+ 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.
+ </para>
<para>
When the <literal>Structs</literal> tab is selected right
- clicking a structure in the list opens a pop-up
- menu with the options:
+ clicking a structure in the list opens a pop-up menu with the
+ options:
<itemizedlist>
@@ -420,30 +416,28 @@
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.
+ 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.
+ 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.
+ Ordering by name simply shows all the different objects
+ arranged alphabetically.
</para>
</section>
@@ -453,19 +447,17 @@
<title>The <literal>Modules</literal> Tab</title>
<para>
- A module can be either a Python or Lua script or a
- Java class file. Information about modules appears
- in the window below the
- module tree. For example,
- go to the <literal>Modules</literal> tab and click on the
- <literal>ReverseEngineeringGeneric</literal> module.
- Double click a module and you will see its
- methods.
+ A module can be either a Python or Lua script or a Java class
+ file. Information about modules appears in the window below
+ the module tree. For example, go to the
+ <literal>Modules</literal> tab and click on the
+ <literal>ReverseEngineeringGeneric</literal> module. Double
+ click a module and you will see its methods.
</para>
<para>
- Double clicking a method name will copy it into the
- GRT shell window. You will see how useful this can be in
+ Double clicking a method name will copy it into the GRT shell
+ window. You will see how useful this can be in
<xref linkend="using-grt-shell"/>.
</para>
@@ -482,7 +474,6 @@
<title>Using the GRT Shell</title>
<para>
-
There are three built-in Lua modules that assist working from the
GRT shell:
@@ -490,15 +481,15 @@
<listitem>
<para>
- <literal>grtV</literal> – for accessing any object/variable in
- the <literal>Values</literal> tab
+ <literal>grtV</literal> – for accessing any
+ object/variable in the <literal>Values</literal> tab
</para>
</listitem>
<listitem>
<para>
- <literal>grtS</literal> – for viewing the structs defined in
- the <literal>Structures</literal> tab
+ <literal>grtS</literal> – for viewing the structs
+ defined in the <literal>Structures</literal> tab
</para>
</listitem>
@@ -511,19 +502,19 @@
</itemizedlist>
</para>
-
-
+
<para>
- All items in all the tabs are accessible from the GRT
- shell.
- <remark>You can use the structs defined ...</remark>
+ All items in all the tabs are accessible from the GRT shell.
+
+ <remark>
+ You can use the structs defined ...
+ </remark>
</para>
<para>
The script example below uses the <literal>getGlobal</literal>
- method of the <literal>grtV</literal> object to return a list
- of databases and then iterates through
- this list.
+ method of the <literal>grtV</literal> object to return a list of
+ databases and then iterates through this list.
</para>
<programlisting>
@@ -535,15 +526,16 @@
<para>
The <literal>getGlobal</literal> method returns the object found
- at the path parameter passed to it. In this case, the object is a list
- that is traversed using a <literal>for</literal> loop
- controlled by the <literal>getn</literal> method which returns
- the number of elements in the database list.
+ at the path parameter passed to it. In this case, the object is a
+ list that is traversed using a <literal>for</literal> loop
+ controlled by the <literal>getn</literal> method which returns the
+ number of elements in the database list.
</para>
-
+
<para>
- Running this <literal>for</literal> loop outputs the names of the database
- formats supported by the &workbench; and the &migration_toolkit;:
+ Running this <literal>for</literal> loop outputs the names of the
+ database formats supported by the &workbench; and the
+ &migration_toolkit;:
</para>
<programlisting>
@@ -578,48 +570,48 @@
Type 'help grtV.<command>' to get help on a specific command.
</programlisting>
+
<para>
<remark>
- Add an object that will appear in the tab?
- i.e definition of an different database struct?
+ Add an object that will appear in the tab? i.e definition of an
+ different database struct?
</remark>
</para>
</section>
-
+
<section id="invoking-grt-from-command-line">
+
<title>Invoking the GRT Shell From the Command Line</title>
-
+
<note>
<para>
- This capability is currently only available
- under Windows.
+ 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>
+ 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>
+ Execute this file by typing:
+ </para>
+
+<programlisting>
C:\> <userinput>grtsh -?</userinput>
</programlisting>
-
+
<para>
Do this and you should see the following listing:
</para>
-
- <programlisting>
+
+<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
@@ -642,98 +634,104 @@
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>/ ></literal> prompt. Using the <option>-py</option>
- option opens a Python shell, indicated by the <literal>/>>></literal> prompt.
+ The default shell is the <literal>Lua</literal> shell and is
+ indicated by the <literal>/ ></literal> prompt. Using the
+ <option>-py</option> option opens a Python shell, indicated by the
+ <literal>/>>></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
+ 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>.
+ 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>
+ 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.
+ 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.
+ 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.
+ 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.
+ 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.
+ 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>
-
-
+ The appearance of the GRT shell run from the command line 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>
-
-
+
<!--End Using -->
- <!--section id="grt-creating-plugins">
+
+<!--section id="grt-creating-plugins">
<title>Creating Plugins</title>
<para>
</para>
</section-->
-
-
+
</chapter>
<!-- end GRT Shell -->
Modified: trunk/userguide/Makefile
===================================================================
--- trunk/userguide/Makefile 2006-12-06 21:40:04 UTC (rev 4143)
+++ trunk/userguide/Makefile 2006-12-06 21:53:59 UTC (rev 4144)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 1370 bytes
@@ -39,7 +39,7 @@
USERGUIDE_SRCS_EXTRA = ../common/fixedchars.ent
-USERGUIDE_SRCS = $(USERGUIDE_SRCS_EXTRA) userguide.xml configuring.xml copyright.xml creating.xml disaster.xml dotnet.xml glossary.xml images/indexing-displaying-administrator.png images/logfiles-slow-query-log-administrator-settings.png images/logfiles-slow-query-log-administrator-view.png indexing.xml installing.xml introduction.xml java.xml legalnotice.en.xml logfiles.xml modifying.xml php-mysqli.xml populating.xml querying.xml security.xml storage-engines.xml stored-procedures.xml views.xml
+USERGUIDE_SRCS = $(USERGUIDE_SRCS_EXTRA) userguide.xml configuring.xml copyright.xml creating.xml disaster.xml dotnet.xml glossary.xml images/indexing-displaying-administrator.png images/logfiles-slow-query-log-administrator-settings.png images/logfiles-slow-query-log-administrator-view.png indexing.xml installing.xml introduction.xml java.xml legalnotice.en.xml logfiles.xml modifying.xml php-mysqli.xml populating.xml querying.xml security.xml storage-engines.xml stored-procedures.xml tools-tricks.xml views.xml
userguide-prepped.xml: $(USERGUIDE_SRCS) $(IDMAP_OBJS)
Modified: trunk/userguide/introduction.xml
===================================================================
--- trunk/userguide/introduction.xml 2006-12-06 21:40:04 UTC (rev 4143)
+++ trunk/userguide/introduction.xml 2006-12-06 21:53:59 UTC (rev 4144)
Changed blocks: 1, Lines Added: 15, Lines Deleted: 0; 554 bytes
@@ -5,6 +5,21 @@
<title>Introduction</title>
+ <section id="about-book">
+
+ <title>About This Book</title>
+
+ <para>
+
+ </para>
+
+ <para>
+
+ </para>
+
+ </section>
+
+
<section id="introduction-what-is-rdb">
<title>What is a Relational Database?</title>
Added: trunk/userguide/tools-tricks.xml
===================================================================
--- trunk/userguide/tools-tricks.xml (rev 0)
+++ trunk/userguide/tools-tricks.xml 2006-12-06 21:53:59 UTC (rev 4144)
Changed blocks: 1, Lines Added: 78, Lines Deleted: 0; 1970 bytes
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<chapter id="tools-tricks">
+
+ <title>Tools and Tricks</title>
+
+ <para>
+ various tools available for
+ You may already be familiar with mysqladmin
+ </para>
+
+ <para>
+ There's no getting around that primary means of using
+ </para>
+
+ <para>
+ administering or etc you're only option will
+ </para>
+
+ <para>
+ if you are unfamiliar with working from the command line
+ there are
+ </para>
+
+ <para>
+ will cover those tools that are available for all OS's and
+ and you'll get the most mileage
+ </para>
+
+
+ <section>
+
+ <title>Command-Line Options</title>
+
+ <para>
+ the
+ ie tee, ! execute shell commands (for the non-Unix user)
+
+ prompt is also useful -- esp not used to command line
+ if you know what want set it up in the my.cnf file and forget about it
+
+ pager is also useful but only for Unix -- avoid anything OS specific ?
+ </para>
+
+ <para>
+ on start up and on my.cnf mention by xref in later section
+ </para>
+
+ </section>
+ <!-- End Command-Line Options -->
+
+ <section id="tools">
+
+ <title>Command-Line Tools</title>
+
+
+
+ <para>
+
+ </para>
+
+ </section>
+
+<!-- End Command-Line Tools -->
+
+ <section id="gui-tools">
+
+ <title>GUI Tools</title>
+
+ <para></para>
+
+ </section>
+
+ <!-- End GUI Tools -->
+
+</chapter>
+<!-- End Tools Chapter -->
Property changes on: trunk/userguide/tools-tricks.xml
___________________________________________________________________
Name: svn:executable
+ *
Modified: trunk/userguide/userguide.xml
===================================================================
--- trunk/userguide/userguide.xml 2006-12-06 21:40:04 UTC (rev 4143)
+++ trunk/userguide/userguide.xml 2006-12-06 21:53:59 UTC (rev 4144)
Changed blocks: 5, Lines Added: 12, Lines Deleted: 5; 1102 bytes
@@ -28,9 +28,16 @@
</bookinfo>
<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
+
<part label="I">
+ <title>Basic Administration</title>
+
+ <xi:include href="tools-tricks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ </part>
+ <part label="II">
+
<title>Using MySQL</title>
<xi:include href="creating.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@@ -43,7 +50,7 @@
</part>
- <part label="II">
+ <part label="III">
<title>Advanced MySQL Usage</title>
@@ -57,7 +64,7 @@
</part>
- <part label="III">
+ <part label="IV">
<title>MySQL Server Administration</title>
@@ -73,7 +80,7 @@
</part>
- <part label="IV">
+ <part label="V">
<title>Using the MySQL APIs</title>
@@ -85,7 +92,7 @@
</part>
- <part label="V">
+ <part label="VI">
<title>Appendices</title>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4144 - in trunk: gui-common userguide | plavin | 6 Dec |
