You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by fu...@apache.org on 2007/02/09 01:04:03 UTC
svn commit: r505092 - in /db/derby/docs/trunk/src: adminguide/ getstart/
tools/
Author: fuzzylogic
Date: Thu Feb 8 16:04:02 2007
New Revision: 505092
URL: http://svn.apache.org/viewvc?view=rev&rev=505092
Log:
DERBY-1662: Document derbyrun.jar
Patch committed for Kim Haase <ca...@sun.com>
Removed:
db/derby/docs/trunk/src/adminguide/tadminconfig814934.dita
db/derby/docs/trunk/src/adminguide/tadminconfigalteringthestartnetworkserverscr.dita
Modified:
db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
db/derby/docs/trunk/src/adminguide/tadminapps811302.dita
db/derby/docs/trunk/src/adminguide/tadminapps811345.dita
db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita
db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita
db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
db/derby/docs/trunk/src/tools/ctoolsdblook.dita
db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita
db/derby/docs/trunk/src/tools/rtools1003161.dita
db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita
db/derby/docs/trunk/src/tools/rtoolssysinfo41288.dita
db/derby/docs/trunk/src/tools/ttoolsij11815.dita
db/derby/docs/trunk/src/tools/ttoolsij30600.dita
Modified: db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap (original)
+++ db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap Thu Feb 8 16:04:02 2007
@@ -72,10 +72,6 @@
<topicref href="tadminappschangingyourclasspath.dita" navtitle="Installing required jar files and adding them to the classpath">
</topicref>
<topicref collection-type="family" href="tadmincbdjhhfd.dita" navtitle="Starting the Network Server">
-<topicref href="tadminconfigalteringthestartnetworkserverscr.dita" navtitle="Altering the startNetworkServer script">
-</topicref>
-<topicref href="tadminconfig814934.dita" navtitle="Starting the Network Server without using the script">
-</topicref>
<topicref href="tadminconfig814963.dita" navtitle="Starting the Network Server from a Java application">
</topicref>
<topicref href="tadminconfigipx.dita" navtitle="Starting the Network Server on IPv6/Ipv4 dual stack Windows machines">
Modified: db/derby/docs/trunk/src/adminguide/tadminapps811302.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminapps811302.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminapps811302.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminapps811302.dita Thu Feb 8 16:04:02 2007
@@ -26,15 +26,21 @@
<taskbody>
<context> To use the ij tool with the network client driver:</context>
<steps>
-<step><cmd>Startup ij in
-one of the following ways:</cmd>
+<step><cmd>Start ij in
+one of the following ways. For details, see "Starting ij" in the
+<ph conref="adminconrefs.dita#pub/citutilities"></ph>.</cmd>
<substeps>
-<substep><cmd>Use a script.</cmd><stepxmp>Run the ij.bat script on Windows
-systems and the ij.ksh script on UNIX systems. These scripts are located in
-the $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/frameworks/NetworkServer/bin/ directory.</stepxmp>
+<substep><cmd>Use a script.</cmd><stepxmp>Run the <codeph>ij.bat</codeph> script on Windows
+systems and the <codeph>ij</codeph> script on UNIX systems. These scripts are located in
+the <codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/bin</codeph> directory.</stepxmp>
</substep>
-<substep><cmd>Run the ij tool from the command line.</cmd><stepxmp><codeblock>java org.apache.derby.tools.ij </codeblock
-></stepxmp></substep>
+<substep><cmd>Run the ij tool using the
+<codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/lib/derbyrun.jar</codeph> file.</cmd><stepxmp>
+<codeblock><b><userinput>java -jar derbyrun.jar ij</userinput></b></codeblock>
+</stepxmp></substep>
+<substep><cmd>Run the ij tool by specifying the class name.</cmd><stepxmp>
+<codeblock><b><userinput>java org.apache.derby.tools.ij</userinput></b></codeblock>
+</stepxmp></substep>
</substeps>
</step>
<step><cmd>Connect by specifying the URL:</cmd><stepxmp><codeblock>ij> CONNECT 'jdbc:derby://localhost:1527/sample'
Modified: db/derby/docs/trunk/src/adminguide/tadminapps811345.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminapps811345.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminapps811345.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminapps811345.dita Thu Feb 8 16:04:02 2007
@@ -27,9 +27,12 @@
<context> <p>To use the dblook tool with the Network Client driver, make sure
the Network Server is running (see <xref href="tadmincbdjhhfd.dita#tadmincbdjhhfd"></xref>),
and then include the necessary <ph conref="adminconrefs.dita#prod/productshortname"></ph> and
-Network Client driver connection attributes as part of the database URL.</p></context>
-<example><codeblock>java org.apache.derby.tools.dblook -d 'jdbc:derby://localhost:1527/sample;
-user=user1;password=secret4me;'</codeblock><?Pub Caret?></example>
+Network Client driver connection attributes as part of the database URL, as
+in the following example:</p></context>
+<example><codeblock><b>java org.apache.derby.tools.dblook -d 'jdbc:derby://localhost:1527/sample;
+user=user1;password=secret4me;'</b></codeblock>
+<p>For details on using the dblook tool, see the
+<ph conref="adminconrefs.dita#pub/citutilities"></ph>.
+</p></example>
</taskbody>
</task>
-<?Pub *0000001680?>
Modified: db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita Thu Feb 8 16:04:02 2007
@@ -21,34 +21,50 @@
<title>Installing required jar files and adding them to the classpath</title>
<prolog><metadata>
<keywords><indexterm>derbyclient.jar</indexterm><indexterm>derby.jar</indexterm>
-<indexterm>derbynet.jar</indexterm></keywords>
+<indexterm>derbynet.jar</indexterm><indexterm>derbyrun.jar</indexterm></keywords>
</metadata></prolog>
<taskbody>
<context> <p>To use the Network Server and network client driver, add the
-following jar files to your server classpath:</p> </context>
+following jar file to your server classpath:</p>
+<ul>
+<li><codeph>derbyrun.jar</codeph></li>
+</ul>
+<p>Adding this file to your classpath has the effect of including all of the
+<ph conref="adminconrefs.dita#prod/productshortname"></ph> classes in your
+classpath. These classes are in the following jar files, which you can also add
+to your classpath separately:</p>
+</context>
<steps-unordered>
-<step><cmd>derbynet.jar</cmd><info><p>This jar file contains the Network Server
-code. It is only necessary for the process that starts the Network Server
-in addition to the standard <ph conref="adminconrefs.dita#prod/productshortname"></ph> .jar
-files.</p></info></step>
-<step><cmd>derby.jar</cmd><info><p>This file must be in your classpath to
-use any of the <ph conref="adminconrefs.dita#prod/productshortname"></ph> Network
-Server functions.</p></info></step>
-<step><cmd>derbyclient.jar</cmd><info><p>This jar file must be in your class
-path to use the Network Client driver. The jar file is necessary for client-side
-communication with the Network Server using the <ph conref="adminconrefs.dita#prod/productshortname"></ph> Network
-Client driver. It needs to be in the client-side classpath to use the Network
-Client driver to access <ph conref="adminconrefs.dita#prod/productshortname"></ph>.</p></info>
+<step><cmd><codeph>derbynet.jar</codeph></cmd><info><p>This jar file contains the Network Server
+code. It must be in your classpath to start the Network Server.</p></info></step>
+<step><cmd><codeph>derby.jar</codeph></cmd><info><p>This jar file contains the
+<ph conref="adminconrefs.dita#prod/productshortname"></ph> database engine code.
+It must be in the classpath in order for the Network Server to access
+<ph conref="adminconrefs.dita#prod/productshortname"></ph> databases.
+<codeph>derby.jar</codeph> is included in the Class-Path attribute of
+<codeph>derbynet.jar</codeph>'s manifest file. If you have <codeph>derbynet.jar</codeph>
+in the classpath and <codeph>derby.jar</codeph> is in the same directory as
+<codeph>derbynet.jar</codeph>, it is not necessary to include <codeph>derby.jar</codeph>
+explicitly.</p></info></step>
+<step><cmd><codeph>derbyclient.jar</codeph></cmd><info><p>This jar file contains
+the <ph conref="adminconrefs.dita#prod/productshortname"></ph> Network Client
+JDBC driver that is necessary for communication with the Network Server. It must
+be in the classpath of the application on the client side in order to access
+<ph conref="adminconrefs.dita#prod/productshortname"></ph> databases over a network.
+</p></info>
</step>
</steps-unordered>
-<example><p><ph conref="adminconrefs.dita#prod/productshortname"></ph> provides
+<example><p>All of the jar files are in the
+<codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/lib</codeph>
+directory.</p>
+<p><ph conref="adminconrefs.dita#prod/productshortname"></ph> provides
script files for setting the classpath to work with the Network Server. The
-scripts are located in the $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>\frameworks\NetworkServer\bin
+scripts are located in the <codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
directory.</p><ul>
-<li>setNetworkClientCP.bat (Windows)</li>
-<li>setNetworkClientCP.ksh (UNIX)</li>
-<li>setNetworkServerCP.bat (Windows)</li>
-<li>setNetworkServerCP.ksh (UNIX)</li>
+<li><codeph>setNetworkClientCP.bat</codeph> (Windows)</li>
+<li><codeph>setNetworkClientCP</codeph> (UNIX)</li>
+<li><codeph>setNetworkServerCP.bat</codeph> (Windows)</li>
+<li><codeph>setNetworkServerCP</codeph> (UNIX)</li>
</ul></example>
<postreq>See <xref href="cadminconfig86869.dita#cadminconfig86869"></xref> and <cite><ph
conref="adminconrefs.dita#pub/citgetstart"></ph></cite> for more information
Modified: db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita Thu Feb 8 16:04:02 2007
@@ -19,31 +19,140 @@
-->
<task id="tadmincbdjhhfd" xml:lang="en-us">
<title>Starting the Network Server</title>
+<shortdesc>To start the Network Server, you can invoke a script, a jar file, or
+a class.
+</shortdesc>
<prolog><metadata>
<keywords><indexterm>Starting the Network Server<indexterm>from scripts</indexterm></indexterm>
<indexterm>Network Server<indexterm>starting</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>Note that you should always properly shut down the Network Server
+<context> <note type="important">Note that you should always properly shut down the Network Server
after use, because failure to do so might result in unpredictable side-effects,
-such as blocked ports on the server.</p><p>Use the startNetworkServer.bat
-script to start the Network Server on Windows machines and the startNetworkServer.ksh
+such as blocked ports on the server.</note></context>
+<example>
+<p>You can start the Network Server in any of the following ways:</p>
+<ul>
+<li><p>If you are relatively new to the Java programming language, follow the
+instructions in "Setting up your environment" in
+<ph conref="adminconrefs.dita#pub/citgetstart"></ph> to set the
+<codeph><ph conref="adminconrefs.dita#prod/productinstallpath"></ph></codeph>
+and <codeph>JAVA_HOME</codeph> environment variables and to add
+<codeph><ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+to your path. Then use the <codeph>startNetworkServer.bat</codeph>
+script to start the Network Server on Windows machines and the <codeph>startNetworkServer</codeph>
script to start the Network Server on UNIX systems. These scripts are located
-in $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/frameworks/NetworkServer/bin,
-where $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph> is the
+in <codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>,
+where <codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph></codeph> is the
directory where you installed <ph conref="adminconrefs.dita#prod/productshortname"></ph>.</p><p>You
can run NetworkServerControl commands only from the host that started the
-Network Server.</p> </context>
-<example>To start the Network Server, you run the appropriate script from
-the command line. For example, on a Windows system, if you have installed <ph
-conref="adminconrefs.dita#prod/productshortname"></ph> in the default directory
-on the C drive and you have set up your classpath correctly, type the following
-command:<codeblock>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>\frameworks\NetworkServer\bin\startNetworkserver.bat</codeblock>The
-default system directory is the directory in which <ph conref="adminconrefs.dita#prod/productshortname"></ph> was
-started. (See the <cite><ph conref="adminconrefs.dita#pub/citdevelop"></ph></cite> for
-more information about the default system directory.)<note type="tip">You
-can set $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>\frameworks\NetworkServer\bin
-in your path to shorten the command.</note></example>
+Network Server.</p>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>set DERBY_HOME=C:\derby</userinput></b>
+<b><userinput>set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_10</userinput></b>
+<b><userinput>set PATH=%DERBY_HOME%\bin;%PATH%</userinput></b>
+<b><userinput>startNetworkServer</userinput></b>
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>export DERBY_HOME=/opt/derby</userinput></b>
+<b><userinput>export JAVA_HOME=/usr/j2se</userinput></b>
+<b><userinput>export PATH="$DERBY_HOME/bin:$PATH"</userinput></b>
+<b><userinput>startNetworkServer</userinput></b>
+</codeblock></stentry>
+</strow>
+</simpletable>
+</li>
+<li><p>If you are a regular Java user but are new to Derby, set the
+<codeph><ph conref="adminconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable, then use a <codeph>java</codeph> command to invoke the
+<codeph>derbyrun.jar</codeph> or <codeph>derbynet.jar</codeph> file:</p>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>set DERBY_HOME=C:\derby</userinput></b>
+<b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar server start</userinput></b>
+or
+<b><userinput>java -jar %DERBY_HOME%\lib\derbynet.jar start</userinput></b>
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>export DERBY_HOME=/opt/derby</userinput></b>
+<b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar server start</userinput></b>
+or
+<b><userinput>java -jar $DERBY_HOME/lib/derbynet.jar start</userinput></b>
+</codeblock></stentry>
+</strow>
+</simpletable>
+<p>To see the command syntax, invoke <codeph>derbyrun.jar server</codeph> or
+<codeph>derbynet.jar</codeph> with no arguments.</p>
+</li>
+<li><p>If you are familiar with both the Java programming language and Derby,
+you have already set
+<codeph><ph conref="adminconrefs.dita#prod/productinstallpath"></ph></codeph>.
+Set your classpath to include the
+<ph conref="adminconrefs.dita#prod/productshortname"></ph>
+jar files. Then use a <codeph>java</codeph> command to invoke the
+<codeph>NetworkServerControl</codeph> class directly.</p>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock>
+<b><userinput>%DERBY_HOME%\bin\setNetworkServerCP</userinput></b>
+<b><userinput>java org.apache.derby.drda.NetworkServerControl start</userinput></b>
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock>
+<b><userinput>$DERBY_HOME/bin/setNetworkServerCP</userinput></b>
+<b><userinput>java org.apache.derby.drda.NetworkServerControl start</userinput></b>
+</codeblock></stentry>
+</strow>
+</simpletable>
+</li>
+</ul>
+<p>The default system directory is the directory in which
+<ph conref="adminconrefs.dita#prod/productshortname"></ph> was started. (See
+the <cite><ph conref="adminconrefs.dita#pub/citdevelop"></ph></cite> for
+more information about the default system directory.)</p>
+<p>You can specify a different host or port number when you start the Network
+Server by specifying an option to the command.</p>
+<ul>
+<li>
+<p>Specify a port number other than the default (1527) by using the
+<codeph>-p <varname>portnumber</varname></codeph> option, as shown in the
+following example:</p>
+<codeblock><b><userinput>java org.apache.derby.drda.NetworkServerControl start -p 1368</userinput></b>
+</codeblock>
+</li>
+<li><p>Specify a specific interface (host name or IP address) to listen on other
+than the default (<codeph>localhost</codeph>) by using the <codeph>-h</codeph>
+option, as shown in the following example:</p>
+<codeblock><b><userinput>$DERBY_HOME/bin/startNetworkServer -h myhost -p 1368</userinput></b>
+</codeblock>
+<p>where <varname>myhost</varname> is the host name or IP address.</p>
+<note type="remember">Before using the <codeph>-h</codeph> option, you should
+run under the Java security manager and enable user authentication.</note>
+</li>
+</ul>
+</example>
<postreq><p>By default, the Network Server will listen to requests only on
the loopback address, which means that it will only accept connections from
the local host.</p></postreq>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita Thu Feb 8 16:04:02 2007
@@ -20,10 +20,13 @@
<task id="tadminconfig815768" xml:lang="en-us">
<title>Obtaining system information by using the command line</title>
<taskbody>
-<context> <p>To run <b>sysinfo</b> from the command line, use the following
-command while the Network Server is running:</p><codeblock>java org.apache.derby.drda.NetworkServerControl
-sysinfo [-h <<i>hostname</i>>][-p <<i>portnumber</i>>] </codeblock><p>Administrative
-commands such as <codeph>org.apache.derby.drda.NetworkServerControl sysinfo</codeph> can
+<context> <p>To run <codeph>sysinfo</codeph> from the command line, use
+a command like one of the following while the Network Server is running:</p>
+<codeblock><b>java -jar $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/lib/derbyrun.jar server sysinfo
+ [-h <varname>hostname</varname>][-p <varname>portnumber</varname>]</b></codeblock>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl sysinfo
+ [-h <varname>hostname</varname>][-p <varname>portnumber</varname>]</b></codeblock><p>Administrative
+commands such as <codeph>sysinfo</codeph> can
only execute on the host where the server was started, even if the server
was started with the <codeph>-h</codeph> option.</p></context>
</taskbody>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita Thu Feb 8 16:04:02 2007
@@ -22,19 +22,22 @@
<taskbody>
<context> <p>You can obtain information about the Network Server, such as
version and current property values, Java information, and <ph conref="adminconrefs.dita#prod/productshortname"></ph> database
-server information, by using the <b>sysinfo</b> utility. The <b>sysinfo</b> utility
+server information, by using the <codeph>sysinfo</codeph> utility. The <codeph>sysinfo</codeph> utility
is available from scripts, the command line, the NetworkServerControl API,
and through the servlet interface.</p><p>The following scripts are located
-in the $<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/frameworks/NetworkServer/bin
+in the <codeph>$<ph conref="adminconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
directory. Before running these scripts, make sure that the <ph conref="adminconrefs.dita#prod/productshortname"></ph> Network
Server is started.</p> </context>
<steps-unordered>
-<step><cmd>Run the following <b>sysinfo</b> script to obtain information about
-the Network Server on a Windows system:</cmd><stepxmp><codeblock>sysinfo.bat [-h <<i>hostname</i>>][-p <<i>portnumber</i>>] </codeblock
-></stepxmp></step>
-<step><cmd>Run the following <b>sysinfo</b> script to obtain information about
-the Network Server on a UNIX system:</cmd><stepxmp><codeblock>sysinfo.ksh [-h <<i>hostname</i>>] [<-p <i>portnumber</i>>] </codeblock
-></stepxmp></step>
+<step><cmd>Run the following script to obtain information about
+the Network Server on a Windows system:</cmd><stepxmp><codeblock><b><userinput>NetworkServerControl.bat sysinfo [-h <varname>hostname</varname>][-p <varname>portnumber</varname>]</userinput></b></codeblock>
+</stepxmp></step>
+<step><cmd>Run the following script to obtain information about
+the Network Server on a UNIX system:</cmd><stepxmp><codeblock><b><userinput>NetworkServerControl sysinfo [-h <varname>hostname</varname>] [-p <varname>portnumber</varname>]</userinput></b></codeblock>
+</stepxmp></step>
</steps-unordered>
+<example><p>For more information on the <codeph>sysinfo</codeph> utility, see
+the <ph conref="adminconrefs.dita#pub/citutilities"></ph>.</p>
+</example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsusingtoolsutils.dita Thu Feb 8 16:04:02 2007
@@ -32,29 +32,108 @@
<conbody>
<p>The tools that are included with <ph conref="gsconrefs.dita#prod/productshortname"></ph> are <cmdname>dblook</cmdname>, <cmdname>ij</cmdname>,
and <cmdname>sysinfo</cmdname>. You can use the <ph conref="gsconrefs.dita#prod/productshortname"></ph> scripts
-to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools.</p>
-<p>There are Derby utilities that are system procedures that you can call
-by using the <cmdname>ij</cmdname> tool. . For example, there are system procedures
-that you can use to import and export external files. Instructions on how
-to use these system procedures are included in the <cite><ph conref="gsconrefs.dita#pub/citutilities"></ph></cite> and
-the <cite><ph conref="gsconrefs.dita#pub/citref"></ph></cite>.</p>
-<p>The scripts that run these tools are in the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory.
+located in the <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
+to start the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools.
These scripts also help you set up your classpath.</p>
-<p>The scripts in <ph conref="gsconrefs.dita#prod/productinstallpath"></ph><filepath>/bin</filepath> directory
-are setup to run in the embedded mode. To run these tools with the Network
+<p>The scripts
+are set up to run in embedded mode. To run these tools with the Network
Server, use the following commands: <ul>
<li>For the <cmdname>dblook</cmdname> tool, call the script and specify the
--d option and the full URL to the Network Server database. For example: <codeph>dblook
--d 'jdbc:derby://localhost/myDB;user=usr'</codeph> </li>
-<li>For the <cmdname>ij</cmdname> tool, issue the command <codeph>set DERBY_OPTS=-Dij.protocol=jdbc:derby://localhost/</codeph> and
-then start <cmdname>ij</cmdname> by issuing the command <codeph>ij</codeph>.</li>
-<li>For the <cmdname>sysinfo</cmdname> tool, issue the command <codeph>NetworkServerControl
-sysinfo</codeph>.</li>
+<codeph>-d</codeph> option and the full URL to the Network Server database. For
+example: <codeblock>dblook -d 'jdbc:derby://localhost/myDB;user=usr'</codeblock> </li>
+<li>For the <cmdname>ij</cmdname> tool, issue the command
+<codeblock>set DERBY_OPTS=-Dij.protocol=jdbc:derby://localhost/</codeblock>
+and then start <cmdname>ij</cmdname> by issuing the command <codeph>ij</codeph>.</li>
+<li>For the <cmdname>sysinfo</cmdname> tool, issue the command
+<codeblock>NetworkServerControl sysinfo</codeblock></li>
</ul></p>
<p>To show how to use the <ph conref="gsconrefs.dita#prod/productshortname"></ph> scripts
to launch the <ph conref="gsconrefs.dita#prod/productshortname"></ph> tools,
-the examples in the <cite><ph conref="gsconrefs.dita#pub/citgetstart"></ph></cite> assume
+the examples in <cite><ph conref="gsconrefs.dita#pub/citgetstart"></ph></cite> assume
that you are using the embedded mode of the <ph conref="gsconrefs.dita#prod/productshortname"></ph> database
engine.</p>
+<p>In addition, there are Derby utilities that are system procedures that you can call
+by using the <cmdname>ij</cmdname> tool. For example, there are system procedures
+that you can use to import and export external files. Instructions on how
+to use these system procedures are included in the <cite><ph conref="gsconrefs.dita#pub/citutilities"></ph></cite> and
+the <cite><ph conref="gsconrefs.dita#pub/citref"></ph></cite>.</p>
+<section>
+<title>Ways to run the tools</title>
+<p>There are several ways to run the tools:</p>
+<ul>
+<li>Follow the instructions in
+<xref href="tgssetupjavaenvir.dita#tgssetupjavaenvir"></xref>, then
+run the tools as standalone commands, as described in this section. You may
+prefer this method if you will run the tools often, because it saves typing.</li>
+<li>Do not set your path, but run the tools using the jar file where the
+tools reside. For example:
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</userinput></b>
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar ij</userinput></b>
+</codeblock></stentry>
+</strow>
+</simpletable>
+<p>You may prefer this method if you you already have a Java executable in your
+path and you do not want to change your path in order to run the tools. This
+may be the case if you do not run the tools often or if you want to start
+running the tools as quickly as possible. </p>
+<p>The syntax for using <codeph>derbyrun.jar</codeph> for each of the tools is
+as follows. To see this syntax reminder, run the command
+<codeph>java -jar derbyrun.jar</codeph> with no arguments.</p>
+<simpletable relcolwidth="1* 3*">
+<sthead>
+<stentry>Operating System</stentry>
+<stentry>Command</stentry>
+</sthead>
+<strow>
+<stentry>Windows</stentry>
+<stentry><codeblock>
+java -jar %DERBY_HOME%\lib\derbyrun.jar ij [-p <i>propertiesfile</i>] [<i>sql_script</i>]
+java -jar %DERBY_HOME%\lib\derbyrun.jar sysinfo [-cp ...] [-cp help]
+java -jar %DERBY_HOME%\lib\derbyrun.jar dblook [<i>arg</i>]* (or no arguments for usage)
+java -jar %DERBY_HOME%\lib\derbyrun.jar server [<i>arg</i>]* (or no arguments for usage)
+</codeblock></stentry>
+</strow>
+<strow>
+<stentry>UNIX (Korn Shell)</stentry>
+<stentry><codeblock>
+java -jar $DERBY_HOME/lib/derbyrun.jar ij [-p <i>propertiesfile</i>] [<i>sql_script</i>]
+java -jar $DERBY_HOME/lib/derbyrun.jar sysinfo [-cp ...] [-cp help]
+java -jar $DERBY_HOME/lib/derbyrun.jar dblook [<i>arg</i>]* (or no arguments for usage)
+java -jar $DERBY_HOME/lib/derbyrun.jar server [<i>arg</i>]* (or no arguments for usage)
+</codeblock></stentry>
+</strow>
+</simpletable>
+<p>The <codeph>server</codeph> argument is a shortcut for running the
+<codeph>NetworkServerControl</codeph> tool. For details on using this tool, see
+the <cite><ph conref="gsconrefs.dita#pub/citadmin"></ph></cite>.
+</p>
+<p>For more information on using <codeph>derbyrun.jar</codeph> to run the
+<codeph>ij</codeph>, <codeph>sysinfo</codeph>, and <codeph>dblook</codeph>
+tools, see the <cite><ph conref="gsconrefs.dita#pub/citutilities"></ph></cite>.</p>
+</li>
+<li>Set your classpath to include the
+<codeph>$DERBY_HOME/lib/derbyrun.jar</codeph> file and then use the
+<codeph>java</codeph> command to run the tools, specifying the class name.
+For example:
+<codeblock><b><userinput>java org.apache.derby.tools.ij</userinput></b>
+</codeblock>
+<p>You may prefer this method if you need to run the tools on a number of
+different systems and if you use scripts to set your environment for
+each one. For details on setting the classpath, see
+<xref href="tgs26250.dita#tgs26250"></xref>.</p>
+</li>
+</ul>
+</section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsdblook.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsdblook.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsdblook.dita Thu Feb 8 16:04:02 2007
@@ -25,5 +25,36 @@
</prolog>
<conbody>
<p>Use the <codeph>dblook</codeph> utility to view all or parts of the Data Definition
-Language (DDL) for a given database. You must place the <ph conref="toolsconrefs.dita#prod/productshortname"></ph> <codeph>derbytools.jar</codeph> file in the classpath directory to use the <codeph>dblook</codeph> utility.</p>
+Language (DDL) for a given database.
+To use the <codeph>dblook</codeph> utility, do one of the following:</p>
+<ul>
+<li>If you are relatively new to the Java programming language, follow the
+instructions in "Setting up your environment" in
+<ph conref="toolsconrefs.dita#pub/citgetstart"></ph> to set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+and <codeph>JAVA_HOME</codeph> environment variables and to add
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+to your path. Then use the following command:
+<codeblock><b>dblook -d <i>databaseURL</i> [<i>options</i>]</b></codeblock>
+</li>
+<li>If you are a regular Java user but are new to Derby, set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable, then use a <codeph>java</codeph> command to invoke the
+<codeph>derbyrun.jar</codeph> file (all on one line):
+<codeblock>(UNIX) <b>java [<i>options</i>] -jar $DERBY_HOME/lib/derbyrun.jar dblook
+ -d <i>databaseURL</i> [<i>options</i>]</b>
+</codeblock>
+<codeblock>(Windows) <b>java [<i>options</i>] -jar %DERBY_HOME%\lib\derbyrun.jar dblook
+ -d <i>databaseURL</i> [<i>options</i>]</b>
+</codeblock>
+</li>
+<li>If you are familiar with both the Java programming language and Derby,
+you have already set
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>.
+Set your classpath to include the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph>
+jar files. Then use a <codeph>java</codeph> command to invoke the
+<codeph>dblook</codeph> class directly.
+<codeblock><b>java org.apache.derby.tools.dblook -d <i>databaseURL</i> [<i>options</i>]</b></codeblock></li>
+</ul>
</conbody></concept>
Modified: db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsusingdblook.dita Thu Feb 8 16:04:02 2007
@@ -23,15 +23,14 @@
<conbody>
<p>The syntax for the command to launch the <codeph>dblook</codeph> utility
is:</p>
-<codeblock>java org.apache.derby.tools.dblook -d <databaseURL> [OPTIONS]</codeblock>
-<p>The value for <synph><var>databaseUrl</var></synph> is the complete URL
+<codeblock>dblook -d <i>databaseURL</i> [<i>options</i>]</codeblock>
+<p>The value for <varname>databaseURL</varname> is the complete URL
for the database. Where appropriate, the URL includes any connection attributes
or properties that might be required to access the database. </p>
<p>For example, to connect to the database 'myDB', the URL would simply be <codeph>'jdbc:derby:myDB';</codeph> to
connect using the Network Server to a database 'C:\private\tmp\myDB' on a
remote server (port 1527), the URL would be:</p>
-<codeblock>'jdbc:derby://localhost:1527/"C:\private\tmp\myDB"
-;user=someusr;password=somepwd'</codeblock>
+<codeblock>'jdbc:derby://localhost:1527/"C:\private\tmp\myDB";user=someusr;password=somepwd'</codeblock>
<p>As with other <ph conref="toolsconrefs.dita#prod/productshortname"></ph> utilities,
you must ensure that no other JVMs are started against the database when you
call the <codeph>dblook</codeph> utility, or an exception will occur and will
Modified: db/derby/docs/trunk/src/tools/rtools1003161.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtools1003161.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/rtools1003161.dita (original)
+++ db/derby/docs/trunk/src/tools/rtools1003161.dita Thu Feb 8 16:04:02 2007
@@ -23,26 +23,19 @@
<keywords></keywords>
</metadata></prolog>
<refbody>
-<section><p>To simplify the process of setting up the <i>CLASSPATH</i> environment
-variable to run Derby and the tools a new jarfile,<i>derbyrun.jar</i>, has
-been added to the Derby distribution. This is the only jarfile that needs
-to be in your classpath. The following information is provided for people
-using Derby distributions that do not contain <i>derbyrun.jar</i> or who prefer
-to setup the classpath manually.</p><p>The following lists the files that
-need to be in the <ph conref="toolsconrefs.dita#prod/productshortname"></ph> classpath
-for each tool and configuration:</p></section>
-<section><p> <ul>
-<li>To use <codeph>ij</codeph>, you must have <i>derbytools.jar</i> in your
-classpath. If you are using the embedded driver, you must also include <i>derby.jar</i>.</li>
-<li>To use the import and export utilities and the database class loading
-utilities, you must have <i>derby.jar</i> in your classpath.</li>
-<li>To use sysinfo, either <i>derby.jar</i> or <i>derbytools.jar</i> must
-be in your classpath.</li>
-<li>To use <ph conref="toolsconrefs.dita#prod/productshortname"></ph> tools
-from a client with the <ph conref="toolsconrefs.dita#prod/productshortname"></ph> Network
-Server, you must have <i>derbyclient.jar</i> and <i>derbytools.jar</i> in
-your classpath. See the <cite><ph conref="toolsconrefs.dita#pub/citadmin"></ph></cite> for
-more information.</li>
-</ul></p></section>
+<section><p>To simplify the process of setting up the
+<codeph>CLASSPATH</codeph> environment variable to run
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> and the tools, a new
+jar file, <codeph>derbyrun.jar</codeph>, has been added to the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> distribution. Adding
+this jar file to your classpath has the effect of putting all the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> jar files in your
+classpath.</p>
+<p>For details on using the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> jar files for
+deploying applications, see the sections on deploying
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> applications in the
+<ph conref="toolsconrefs.dita#pub/citdevelop"></ph>.
+</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita Thu Feb 8 16:04:02 2007
@@ -25,23 +25,17 @@
</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>
+<example>When you run the <cmdname>sysinfo</cmdname> command using the
+<codeph>derbyrun.jar</codeph> file, the output looks something like this:
+<codeblock><b>java -jar c:\Derby_10\lib\derbyrun.jar sysinfo</b>
------------------ Java Information ------------------
-Java Version: 1.4.2_07
+Java Version: 1.4.2_13
Java Vendor: Sun Microsystems Inc.
Java home: c:\p4main\jdk142\jre
-Java classpath: c:\Derby_10\lib\derby.jar;c:\Derby_10\lib\derbytools.jar;
-c:\Derby_10\lib\derbyLocale_cs.jar;c:\Derby_10\lib\derbyLocale_de_DE.jar;
-c:\Derby_10\lib\derbyLocale_es.jar;c:\Derby_10\lib\derbyLocale_fr.jar;
-c:\Derby_10\lib\derbyLocale_hu.jar;c:\Derby_10\lib\derbyLocale_it.jar;
-c:\Derby_10\lib\derbyLocale_ja_JP.jar;c:\Derby_10\lib\derbyLocale_ko_KR.jar;
-c:\Derby_10\lib\derbyLocale_pl.jar;c:\Derby_10\lib\derbyLocale_pt_BR.jar;
-c:\Derby_10\lib\derbyLocale_ru.jar;c:\Derby_10\lib\derbyLocale_zh_CN.jar;
-c:\Derby_10\lib\derbyLocale_zh_TW.jar
-OS name: Windows 2000
+Java classpath: c:\Derby_10\lib\derbyrun.jar
+OS name: Windows XP
OS architecture: x86
-OS version: 5.0
+OS version: 5.1
Java user name: user1
Java user home: C:\Documents and Settings\myhome
Java user dir: C:\Derby_10\test
@@ -79,8 +73,8 @@
Found support for locale: [zh_CN]
version: <ph conref="toolsconrefs.dita#vers/shortversionnumber"></ph>.2.0 - (483632)
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
+<section><p>When you request help for a problem by posting to the derby-user
+mailing list, include a copy of the information provided
by the <codeph>sysinfo</codeph> utility.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/tools/rtoolssysinfo41288.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolssysinfo41288.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolssysinfo41288.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolssysinfo41288.dita Thu Feb 8 16:04:02 2007
@@ -24,7 +24,35 @@
</metadata>
</prolog>
<refbody>
-<section><p>Use the sysinfo utility to display information about your Java environment
-and <ph conref="toolsconrefs.dita#prod/productshortname"></ph> (including version information). To use sysinfo, either <i>derby.jar</i> or <i>derbytools</i><i>.jar</i> must be in your classpath.
-<codeblock><b>java org.apache.derby.tools.sysinfo</b></codeblock></p></section>
+<section><p>Use the <codeph>sysinfo</codeph> utility to display information about your Java environment
+and <ph conref="toolsconrefs.dita#prod/productshortname"></ph> (including version information).
+To use <codeph>sysinfo</codeph>, do one of the following:</p>
+<ul>
+<li>If you are relatively new to the Java programming language, follow the
+instructions in "Setting up your environment" in
+<ph conref="toolsconrefs.dita#pub/citgetstart"></ph> to set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+and <codeph>JAVA_HOME</codeph> environment variables and to add
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+to your path. Then use the following command:
+<codeblock><b>sysinfo</b></codeblock>
+</li>
+<li>If you are a regular Java user but are new to Derby, set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable, then use a <codeph>java</codeph> command to invoke the
+<codeph>derbyrun.jar</codeph> file:
+<codeblock>(UNIX) <b>java [<i>options</i>] -jar $DERBY_HOME/lib/derbyrun.jar sysinfo</b>
+</codeblock>
+<codeblock>(Windows) <b>java [<i>options</i>] -jar %DERBY_HOME%\lib\derbyrun.jar sysinfo</b>
+</codeblock>
+</li>
+<li>If you are familiar with both the Java programming language and Derby,
+you have already set
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>.
+Set your classpath to include the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph>
+jar files. Then use a <codeph>java</codeph> command to invoke the
+<codeph>sysinfo</codeph> class directly.
+<codeblock><b>java org.apache.derby.tools.sysinfo</b></codeblock></li>
+</ul></section>
</refbody></reference>
Modified: db/derby/docs/trunk/src/tools/ttoolsij11815.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij11815.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij11815.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij11815.dita Thu Feb 8 16:04:02 2007
@@ -22,32 +22,43 @@
<taskbody>
<context> <p><ph conref="toolsconrefs.dita#prod/productshortname"></ph> provides
batch and shell scripts for users in Windows and UNIX environments that can
-be used to start IJ. By calling the appropriate script you will start ij and
-be able to connect with a simple command. These scripts set the <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref> property,
-which simplifies the process of connecting to a database by eliminating the
-need to specify the protocol portion of the connection URL. The scripts are
-found in the %<ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>%/frameworks/
-directory tree. You can also customize the ij scripts to suit your environment.</p><p>If
-you are starting ij from a command line, be sure that derbyrun.jar is in your
+be used to start ij. By calling the appropriate script you will start ij and
+be able to connect with a simple command. The scripts are
+found in the <codeph>bin</codeph> directory of your <ph conref="toolsconrefs.dita#prod/productshortname"></ph>
+installation. You can also customize the ij scripts to suit your environment.</p><p> If you are using <ph conref="toolsconrefs.dita#prod/productshortname"></ph> as
+a client/server environment, start the Network Server before connecting to the
+<ph conref="toolsconrefs.dita#prod/productshortname"></ph> database. (See
+"Starting the Network Server" in the
+<ph conref="toolsconrefs.dita#pub/citadmin"></ph> for details.) You can start
+ij by running the ij scripts for your environment. Follow the instructions in
+"Setting up your environment" in
+<ph conref="toolsconrefs.dita#pub/citgetstart"></ph> to set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+and <codeph>JAVA_HOME</codeph> environment variables and to add
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+to your path. Then use the following command:</p><codeblock><b><userinput>ij [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock></context>
+<example>Alternatively, set the
+<codeph><ph conref="toolsconrefs.dita#prod/productinstallpath"></ph></codeph>
+environment variable, then use one of these commands:
+<codeblock>(UNIX) <b><userinput>java [<varname>options</varname>] -jar $DERBY_HOME/lib/derbyrun.jar ij
+ [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
+<codeblock>(Windows) <b><userinput>java [<varname>options</varname>] -jar %DERBY_HOME%\lib\derbyrun.jar ij
+ [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
+<codeblock><b><userinput>java [<varname>options</varname>] org.apache.derby.tools.ij
+ [-p <varname>propertyFile</varname>] [<varname>inputFile</varname>]</userinput></b></codeblock>
+<p>If you use the last form of the command, be sure that derbyrun.jar is in your
classpath (for pre-10.2 distributions derbytools.jar and usually derby.jar
-were required in the classpath). If you are using <ph conref="toolsconrefs.dita#prod/productshortname"></ph> as
-a client/server environment, start the server before connecting to the <ph
-conref="toolsconrefs.dita#prod/productshortname"></ph> database. You can start
-ij by running the ij scripts for your environment in the %<ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>%/frameworks/embedded/bin/
-directory or in the %<ph conref="toolsconrefs.dita#prod/productinstallpath"></ph>%/frameworks/NetworkServer/bin/
-directory.</p> </context>
-<example>To start ij, run the script provided or use this command: <codeblock>java [<<i>options</i>>] org.apache.derby.tools.ij
- [-p <<i>propertyFile</i>>] [<<i>inputFile</i>>]</codeblock>The command
-line items are: <ul>
-<li id="rtoolsij42358">java <p>Start the JVM. </p></li>
-<li id="rtoolsij26546">options <p>The options that the JVM uses. You can
-use the -D command to set ij properties (see <xref href="ttoolsij30600.dita#ttoolsij30600"></xref>)
+were required in the classpath).</p>
+<p>The command line items are:</p> <ul>
+<li id="rtoolsij42358"><b><userinput>java</userinput></b> <p>Start the JVM. </p></li>
+<li id="rtoolsij26546"><b><userinput><varname>options</varname></userinput></b> <p>The options that the JVM uses. You can
+use the -D option to set ij properties (see <xref href="ttoolsij30600.dita#ttoolsij30600"></xref>)
or system properties, such as <ph conref="toolsconrefs.dita#prod/productshortname"></ph> properties. </p></li>
-<li id="rtoolsij40855">propertyFile <p>A file you can use to set ij properties
-(instead of the -D command). The property file should be in the format created
+<li id="rtoolsij40855"><b><userinput><varname>propertyFile</varname></userinput></b> <p>A file you can use to set ij properties
+(instead of the -D option). The property file should be in the format created
by the java.tools.Properties.save methods, which is the same format as the
derby.properties file.</p></li>
-<li id="rtoolsij39639">inputFile <p>A file from which to read commands.
+<li id="rtoolsij39639"><b><userinput><varname>inputFile</varname></userinput></b> <p>A file from which to read commands.
The ij tool exits at the end of the file or an exit command. Using an input
file causes ij to print out the commands as it runs them. If you reroute standard
input, ij does not print out the commands. If you do not supply an input file,
Modified: db/derby/docs/trunk/src/tools/ttoolsij30600.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ttoolsij30600.dita?view=diff&rev=505092&r1=505091&r2=505092
==============================================================================
--- db/derby/docs/trunk/src/tools/ttoolsij30600.dita (original)
+++ db/derby/docs/trunk/src/tools/ttoolsij30600.dita Thu Feb 8 16:04:02 2007
@@ -21,28 +21,32 @@
<title>Starting ij using properties</title>
<taskbody>
<context> <p>You set ij properties in any of the following ways:</p><ol>
-<li>by using the -D command on the command line</li>
+<li>by using the -D option on the command line</li>
<li>by specifying a properties file using the <codeph>-p propertyfile</codeph> option
on the command line</li>
</ol><p><note type="remember">ij property names are case-sensitive, while
commands are case-insensitive.</note></p><p>The following examples illustrate
how to use ij properties:</p> </context>
<example><p>To start ij by using a properties file called <codeph>ij.properties</codeph>,
-use the following command: <codeblock>java org.apache.derby.tools.ij -p ij.properties</codeblock></p><p>To
-start ij with a maximumDisplayWidth of 1000: <codeblock>java -Dij.maximumDisplayWidth=1000 org.apache.derby.tools.ij </codeblock></p><p>To
+use a command like the following (with the addition of the file paths):
+<codeblock><b><userinput>java -jar derbyrun.jar -p ij.properties</userinput></b></codeblock></p><p>To
+start ij with a maximumDisplayWidth of 1000:
+<codeblock><b><userinput>java -Dij.maximumDisplayWidth=1000 -jar derbyrun.jar</userinput></b></codeblock></p><p>To
start ij with an <xref href="rtoolsijpropref35032.dita#rtoolsijpropref35032">ij.protocol</xref> of <b>jdbc:derby:</b> and
an <xref href="rtoolsijpropref28146.dita#rtoolsijpropref28146">ij.database</xref> of <b>sample</b>,
-use the following command: <codeblock>java -Dij.protocol=jdbc:derby: -Dij.database=sample
- org.apache.derby.tools.ij</codeblock></p><p>To start ij with two named
+use the following command:
+<codeblock><b><userinput>java -Dij.protocol=jdbc:derby: -Dij.database=sample derbyrun.jar</userinput></b></codeblock></p><p>To start ij with two named
connections, using the <xref href="rtoolsijpropref10135.dita#rtoolsijpropref10135">ij.connection.connectionName</xref> property,
-use the following command: <codeblock>java -Dij.connection.sample=jdbc:derby:sample
+use a command like the following (all on one line):
+<codeblock><b><userinput>java -Dij.connection.sample=jdbc:derby:sample
-Dij.connection.History=jdbc:derby:History
-Dderby.system.home=c:\derby\demo\databases
-org.apache.derby.tools.ij</codeblock>To see a list of connection names and
-the URL's used to connect to them, use the following command: (If there is
+-jar c:\derby\lib\derbyrun.jar</userinput></b></codeblock>To see a list of connection names and
+the URLs used to connect to them, use the following command. (If there is
a connection that is currently active, it will show up with an * after its
-name.) <codeblock>ij version <ph conref="toolsconrefs.dita#vers/shortversionnumber"></ph>
-ij(HISTORY)> show connections;
+name.)
+<codeblock>ij version <ph conref="toolsconrefs.dita#vers/shortversionnumber"></ph>
+ij(HISTORY)> <b><userinput>show connections;</userinput></b>
HISTORY* - jdbc:derby:History
SAMPLE - jdbc:derby:sample
* = current connection