svn commit: r464696 - in /db/derby/docs/branches/10.2/src/tools: rtoolsdblookexamples.dita rtoolssysinfo1002629.dita

[jt...@apache.org]

Author: jta
Date: Mon Oct 16 15:16:00 2006
New Revision: 464696

URL: http://svn.apache.org/viewvc?view=rev&rev=464696
Log:
DERBY-1954 Update sysinfo output in the Tools and Utilities Guide.
Merged revision 464694 from trunk to 10.2 branch.

Modified:
    db/derby/docs/branches/10.2/src/tools/rtoolsdblookexamples.dita
    db/derby/docs/branches/10.2/src/tools/rtoolssysinfo1002629.dita

Modified: db/derby/docs/branches/10.2/src/tools/rtoolsdblookexamples.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.2/src/tools/rtoolsdblookexamples.dita?view=diff&rev=464696&r1=464695&r2=464696
==============================================================================
--- db/derby/docs/branches/10.2/src/tools/rtoolsdblookexamples.dita (original)
+++ db/derby/docs/branches/10.2/src/tools/rtoolsdblookexamples.dita Mon Oct 16 15:16:00 2006
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+ 
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "../dtd/reference.dtd">
 <!-- 
@@ -19,70 +20,67 @@
 -->
 <reference id="rtoolsdblookexamples" xml:lang="en-us">
 <title>dblook examples</title>
-<prolog></prolog>
+<prolog><metadata>
+<keywords><indexterm>dblook<indexterm>examples</indexterm></indexterm><indexterm>examples<indexterm>dblook</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
 <refbody>
 <section><p>The following examples demonstrate how the various <codeph>dblook</codeph> utility
-options might be specified from a command line.  Each example is preceded
-by a brief description of how the <codeph>dblook</codeph> utility behaves
-given the specified options.</p></section>
-<example> <codeblock>Dump the DDL for everything in database 'sample' (in the current directory)
-to the console.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample
-</b>
-
-Dump the DDL for everything in database 'sample' (in the current directory)
-to the console,
-and include error/warning messages (with the latter being printed via System.err)
-<b>java org.apache.derby.tools.dblook 
-   -d jdbc:derby:sample -verbose
-</b>
-
-Dump the DDL for everything in database 'sample' (in the current directory)
-to a file called "myDB_DDL.sql" (in the current directory). 
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample -o myDB_DDL.sql
-</b>
-
-Dump the DDL for everything in database 'sample' (in a specified directory)
-to a file called "newDB.sql" (in a specified directory). 
-<b>java org.apache.derby.tools.dblook -d 'jdbc:derby:c:\private\stuff\sample'
-	-o 'C:\temp\newDB.sql'
-</b>
-
-Dump the DDL for all objects in database 'sample' with schema 'SAMP'
-to the console.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample -z samp </b>
-
-Dump the DDL for all objects in remote database 'sample' on 'localhost:1527'
-with schema 'SAMP' to the console.
-<b>java org.apache.derby.tools.dblook -d 
-	'jdbc:derby://localhost:1527/"C:\temp\sample";
-	user=someusr;password=somepwd' -z samp
-</b>
-
-Dump the DDL for all objects with schema 'SAMP' in database 'sample'
-that are related to the table name 'My Table' to the console.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample -z samp -t "My Table"
-</b>
-
-Dump the DDL for all objects in database 'sample' that are related
-to either of the table names 'STAFF' or 'My Table' to the console.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample -t "My Table" staff
-</b>
-
-Dump the DDL for all objects in database 'sample' to myDB_DDL.sql,
-with no statement delimiter (i.e. leave off the default semi-colon),
-and append to the output files if they are already there.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample
-	-o myDB_DDL.sql -td '' -append
-</b>
-
-Dump the DDL for all objects EXCEPT views in database 'sample'
-to the console.
-<b>java org.apache.derby.tools.dblook -d jdbc:derby:sample -noview
-</b></codeblock></example>
-<section><p>Status messages are printed to the output (either a -o filename,
-if specified, or the console) as SQL script comments. These status messages
-serve as headers to show which types of database objects are being (or have
-been) processed by the dblook utility.</p></section>
+options can be specified from a command line. These examples use the <codeph>sample</codeph> database.</p><note>The
+quotations marks shown in these examples are part of the command argument
+and must be passed to <codeph>dblook</codeph>. The way in which quotation
+marks are passed depends on the operating system and command line that you
+are using. With some systems it might be necessary to escape the quotation
+marks by using a forward slash before the quotation mark, for example: <codeph>"\"My
+Table"\"</codeph></note><p>Status messages are written to the output (either
+a -o filename, if specified, or the console) as SQL script comments. These
+status messages serve as headers to show which types of database objects are
+being, or have been, processed by the <codeph>dblook</codeph> utility.</p></section>
+<example><title>Writing the DDL to the console</title><p>You can write the
+DDL to the console for everything that is in the <codeph>sample</codeph> database.
+In this example, the database is in the current directory. For example:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample
+</codeblock></p></example>
+<example><title>Including error and warning messages in the dblook command</title><p>You
+can write error and warning messages when you write the DDL to the console.
+The messages are written using <codeph>System.err</codeph>. For example:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -verbose</codeblock
+></p></example>
+<example><title>Writing the DDL to a file</title><p>You can write the DDL
+to a file called <codeph>myDB_DDL.sql</codeph> for everything that is in the <codeph>sample</codeph> database.
+In this example, the database and file are in the current directory. For example:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -o myDB_DDL.sql</codeblock
+></p></example>
+<example><title>Specifying directory paths in the dblook command</title><p>If
+the database or file are not in the current directory, you must specify the
+directory paths. For example:<codeblock>java org.apache.derby.tools.dblook -d 'jdbc:derby:c:\private\stuff\sample'
+   -o 'C:\temp\newDB.sql'</codeblock></p></example>
+<example><title>Specifying a schema in the dblook command</title><p>You can
+specify the schema for the database. To write the DDL to the console, for
+all of the objects in the <codeph>sample</codeph> database where the database
+is in the SAMP schema, use the following command:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -z samp
+</codeblock></p></example>
+<example><title>Specifying a remote database and host</title><p>If the <codeph>sample</codeph> database
+is in the SAMP schema on localhost:1527, you must specify your user ID and
+password. For example, use the following command to write the DDL to the console: <codeblock>java org.apache.derby.tools.dblook 
+   -d 'jdbc:derby://localhost:1527/"C:\temp\sample";
+   user=someusername;password=somepassword' -z samp
+</codeblock></p></example>
+<example><title>Specifying a schema and a table within the database in the
+dblook command</title><p>You can specify that only the objects in the <codeph>sample</codeph> database
+that are associated with the SAMP and the <codeph>My Table</codeph> table
+are written to the console. For example:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -z samp -t "My Table"
+</codeblock></p></example>
+<example><title>Specifying multiple tables in the dblook command</title>You
+can specify more than one table in the dblook command by separating the names
+of the tables with a space. For example, for objects in the <codeph>sample</codeph> database
+that are associated with either the <codeph>My Table</codeph> table or the <codeph>STAFF</codeph> table,
+use the following command:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -t "My Table" staff</codeblock></example>
+<example><title>Writing DDL to a file without a statement delimiter</title><p>To
+write the DDL for all of the objects in<codeph>sample</codeph> database to
+the <codeph>myDB_DDL.sql</codeph> file without a statement delimiter, you
+must omit the default semi-colon. You can append the DDL to the output files
+if the files are already there. For example:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample
+   -o myDB_DDL.sql -td '' -append</codeblock></p></example>
+<example><title>Excluding views from the DDL</title><p>To write the DDL to
+the console for all of the objects in the <codeph>sample</codeph> database
+except for views, use the following command:<codeblock>java org.apache.derby.tools.dblook -d jdbc:derby:sample -noview</codeblock></p></example>
 </refbody>
 </reference>

Modified: db/derby/docs/branches/10.2/src/tools/rtoolssysinfo1002629.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.2/src/tools/rtoolssysinfo1002629.dita?view=diff&rev=464696&r1=464695&r2=464696
==============================================================================
--- db/derby/docs/branches/10.2/src/tools/rtoolssysinfo1002629.dita (original)
+++ db/derby/docs/branches/10.2/src/tools/rtoolssysinfo1002629.dita Mon Oct 16 15:16:00 2006
@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2005, v.4002-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
 <!-- 
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
@@ -15,13 +18,15 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "../dtd/reference.dtd">
-<reference xml:lang="en-us" id="rtoolssysinfo1002629">
+<reference id="rtoolssysinfo1002629" xml:lang="en-us">
 <title>sysinfo example</title>
-<prolog>
-</prolog>
-<refbody><example>
-<codeblock><b>$ java org.apache.derby.tools.sysinfo</b>
+<prolog><metadata>
+<keywords><indexterm>sysinfo<indexterm>example</indexterm></indexterm><indexterm>examples<indexterm>sysinfo</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<example>When you have derby.jar and derbytools.jar listed in your classpath,
+the output from running the <cmdname>sysinfo</cmdname> command is shown below: <codeblock><b>$ java org.apache.derby.tools.sysinfo</b>
 ------------------ Java Information ------------------
 Java Version: 1.4.2_07
 Java Vendor: Sun Microsystems Inc.
@@ -64,6 +69,8 @@
 Found support for locale: [zh_CN]
          version: <ph conref="toolsconrefs.dita#vers/shortversionnumber"></ph>.1.0 - (190628)
 Found support for locale: [zh_TW]</codeblock></example>
-<section><p>When requesting help from <ph conref="toolsconrefs.dita#prod/productshortname"></ph> technical support or posting on the
-forum, include a copy of the information provided by sysinfo.</p></section>
-</refbody></reference>
+<section><p>When requesting help from <ph conref="toolsconrefs.dita#prod/productshortname"></ph> technical
+support or posting on the forum, include a copy of the information provided
+by the <codeph>sysinfo</codeph> utility.</p></section>
+</refbody>
+</reference>