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 ch...@apache.org on 2013/11/11 15:37:27 UTC
svn commit: r1540743 [1/2] - /db/derby/docs/trunk/src/adminguide/
Author: chaase3
Date: Mon Nov 11 14:37:26 2013
New Revision: 1540743
URL: http://svn.apache.org/r1540743
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 36 Admin Guide task topics.
Patch: DERBY-6379-admintasks.diff
Modified:
db/derby/docs/trunk/src/adminguide/tadminadv804410.dita
db/derby/docs/trunk/src/adminguide/tadminadv804451.dita
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/tadminappsruntimeinfo.dita
db/derby/docs/trunk/src/adminguide/tadminappssettingportnumbers.dita
db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita
db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita
db/derby/docs/trunk/src/adminguide/tadminconfig814963.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815853.dita
db/derby/docs/trunk/src/adminguide/tadminconfigipx.dita
db/derby/docs/trunk/src/adminguide/tadminconfigsettingnetwrokserverproperties.dita
db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita
db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita
db/derby/docs/trunk/src/adminguide/tadminconfigverifyingstartup.dita
db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita
db/derby/docs/trunk/src/adminguide/tadminexporting.dita
db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita
db/derby/docs/trunk/src/adminguide/tadminimporting.dita
db/derby/docs/trunk/src/adminguide/tadminlog800206.dita
db/derby/docs/trunk/src/adminguide/tadminlogfile.dita
db/derby/docs/trunk/src/adminguide/tadminnetservbasic.dita
db/derby/docs/trunk/src/adminguide/tadminnetservcustom.dita
db/derby/docs/trunk/src/adminguide/tadminnetservopen.dita
db/derby/docs/trunk/src/adminguide/tadminnetservrun.dita
db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita
db/derby/docs/trunk/src/adminguide/tadminovclirun.dita
db/derby/docs/trunk/src/adminguide/tadminovnsrundemo.dita
db/derby/docs/trunk/src/adminguide/tadminovrunsrvprgm.dita
db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita
Modified: db/derby/docs/trunk/src/adminguide/tadminadv804410.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminadv804410.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminadv804410.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminadv804410.dita Mon Nov 11 14:37:26 2013
@@ -19,44 +19,48 @@ limitations under the License.
-->
<task id="tadminadv804410" xml:lang="en-us">
<title>Turning on the trace facility</title>
+<shortdesc>Follow these steps to turn on the trace facility.</shortdesc>
<taskbody>
<steps>
-<step><cmd>Turn on tracing for all sessions by specifying the following property:</cmd>
-<stepxmp><codeblock>derby.drda.traceAll=true </codeblock>Alternatively, while
-the Network Server is running, you can use the following command to turn on
-the trace facility:<codeblock>java org.apache.derby.drda.NetworkServerControl
- trace on [-s <<i>connection number</i>>] [-h <<i>hostname</i>>][-p <<i>portnumber</i>>] </codeblock></stepxmp>
-<info>If you specify a <<i>connection number</i>>, tracing will be turned
-on only for that connection.</info></step>
+<step><cmd>Turn on tracing for all sessions by specifying the following
+property:</cmd>
+<stepxmp>
+<codeblock>derby.drda.traceAll=true</codeblock>
+<p>See <xref href="radminconfig.dita#radminconfig"></xref> for information on
+this property.</p>
+<p>Alternatively, while the Network Server is running, you can use the following
+command (all on one line) to turn on the trace facility:</p>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl
+ trace on [-s <i>connection-number</i>] [-h <i>hostname</i>][-p <i>portnumber</i>]</b></codeblock>
+</stepxmp>
+<info>If you specify a <i>connection-number</i>, tracing will be turned on only
+for that connection.</info></step>
<step><cmd>Set the location of the tracing files by specifying the following
-property:</cmd><stepxmp><codeblock>derby.drda.traceDirectory=<<i>directory for tracing files</i>></codeblock>
-Alternatively,
-while the Network Server is running, enter the following command
-to set the trace directory:<codeblock>java org.apache.derby.drda.NetworkServerControl traceDirectory
-<<i>directory for tracing files</i>> [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock>
-<p>You need to specify only the directory where the tracing files will
-reside. The names of the tracing files are determined by the system. If you
-do not set a trace directory, the tracing files will be placed in derby.system.home.</p>
-<p>
- The Network Server will attempt to create the trace directory
- (and any parent directories) if they do not exist.
- This will require that the Java security policy for
- <codeph>derbynet.jar</codeph>
- permits verification of the existence of the named trace directory
- and all necessary parent directories.
- For each directory created, the policy must allow
- <codeblock>
- permission java.io.FilePermission "<<i>directory</i>>", "read,write";
- </codeblock>
- and for the trace directory itself, the policy must allow
- <codeblock>
- permission java.io.FilePermission "<<i>tracedirectory</i>>${/}-", "write";
- </codeblock>
-</p>
-<p>
- See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
- information about customizing the Network Server's security policy.
-</p></stepxmp>
+property:</cmd>
+<stepxmp>
+<codeblock>derby.drda.traceDirectory=<i>directory-for-tracing-files</i></codeblock>
+<p>See
+<xref href="radminconfigdb2jdrdatracedirectory.dita#radminconfigdb2jdrdatracedirectory"></xref>
+for information on this property.</p>
+<p>Alternatively, while the Network Server is running, use the following
+command (all on one line) to set the trace directory:</p>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl traceDirectory
+ <i>directory-for-tracing-files</i> [-h <i>hostname</i>] [-p <i>portnumber</i>]</b></codeblock>
+<p>You need to specify only the directory where the tracing files will reside.
+The names of the tracing files are determined by the system. If you do not set a
+trace directory, the tracing files will be placed in
+<codeph>derby.system.home</codeph>.</p>
+<p>The Network Server will attempt to create the trace directory (and any parent
+directories) if they do not exist. This will require that the Java security
+policy for <codeph>derbynet.jar</codeph> permits verification of the existence
+of the named trace directory and all necessary parent directories. For each
+directory created, the policy must allow</p>
+<codeblock>permission java.io.FilePermission "<i>directory</i>", "read,write";</codeblock>
+<p>For the trace directory itself, the policy must allow</p>
+<codeblock>permission java.io.FilePermission "<i>tracedirectory</i>${/}-", "write";</codeblock>
+<p>See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
+information about customizing the Network Server's security policy.</p>
+</stepxmp>
</step>
</steps>
</taskbody>
Modified: db/derby/docs/trunk/src/adminguide/tadminadv804451.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminadv804451.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminadv804451.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminadv804451.dita Mon Nov 11 14:37:26 2013
@@ -19,10 +19,14 @@ limitations under the License.
-->
<task id="tadminadv804451" xml:lang="en-us">
<title>Turning off the trace facility</title>
+<shortdesc>Enter the following command (all on one line) to turn off
+tracing.</shortdesc>
<taskbody>
-<context> <p>Enter the following command to turn off tracing:<codeblock>java org.apache.derby.drda.NetworkServerControl trace off [-s <<i>connection number</i
->>]
-[-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock></p><p>The
-tracing files are named ServerX.trace, where X is a connection number.</p></context>
+<context>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl trace off
+ [-s <i>connection number</i>] [-h <i>hostname</i>] [-p <i>portnumber</i>]</b></codeblock>
+<p>The tracing files are named <codeph>Server<i>X</i>.trace</codeph>, where
+<i>X</i> is a connection number.</p>
+</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminapps811302.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminapps811302.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminapps811302.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminapps811302.dita Mon Nov 11 14:37:26 2013
@@ -18,15 +18,17 @@ See the License for the specific languag
limitations under the License.
-->
<task id="tadminapps811302" xml:lang="en-us">
-<title>Using the Derby ij tool with the Network Server</title>
+<title>Using the <ph conref="../conrefs.dita#prod/productshortname"></ph> ij
+tool with the Network Server</title>
+<shortdesc> To use the <codeph>ij</codeph> tool with the network client driver,
+follow these steps.</shortdesc>
<prolog><metadata>
<keywords><indexterm>ij<indexterm>using with Network Server</indexterm></indexterm>
<indexterm>Network Server<indexterm>ij and</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> To use the ij tool with the network client driver:</context>
<steps>
-<step><cmd>Start ij in
+<step><cmd>Start <codeph>ij</codeph> in
one of the following ways. For details, see "Starting ij" in the
<ph conref="../conrefs.dita#pub/citutilities"></ph>.</cmd>
<substeps>
@@ -34,11 +36,11 @@ one of the following ways. For details,
systems and the <codeph>ij</codeph> script on UNIX systems. These scripts are located in
the <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph> directory.</stepxmp>
</substep>
-<substep><cmd>Run the ij tool using the
+<substep><cmd>Run the <codeph>ij</codeph> tool using the
<codeph>$<ph conref="../conrefs.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>
+<substep><cmd>Run the <codeph>ij</codeph> tool by specifying the class name.</cmd><stepxmp>
<codeblock><b><userinput>java org.apache.derby.tools.ij</userinput></b></codeblock>
</stepxmp></substep>
</substeps>
Modified: db/derby/docs/trunk/src/adminguide/tadminapps811345.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminapps811345.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminapps811345.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminapps811345.dita Mon Nov 11 14:37:26 2013
@@ -18,21 +18,30 @@ See the License for the specific languag
limitations under the License.
-->
<task id="tadminapps811345" xml:lang="en-us">
-<title>Using the Derby dblook tool with the Network Server</title>
+<title>Using the <ph conref="../conrefs.dita#prod/productshortname"></ph> dblook
+tool with the Network Server</title>
+<shortdesc>To use the <codeph>dblook</codeph> tool with the network client
+driver, follow these steps.</shortdesc>
<prolog><metadata>
<keywords><indexterm>dblook<indexterm>using with Network Server</indexterm></indexterm>
<indexterm>Network Server<indexterm>dblook and</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<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="../conrefs.dita#prod/productshortname"></ph> and
-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;
+<steps>
+<step><cmd>Make sure the Network Server is running. See
+<xref href="tadmincbdjhhfd.dita#tadmincbdjhhfd"></xref> for more information.
+</cmd>
+</step>
+<step><cmd>Include the necessary
+<ph conref="../conrefs.dita#prod/productshortname"></ph> and network client
+driver connection attributes as part of the database URL, as in the following
+example:</cmd>
+<stepxmp><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="../conrefs.dita#pub/citutilities"></ph>.
-</p></example>
+<p>For details on using the <codeph>dblook</codeph> tool, see the
+<ph conref="../conrefs.dita#pub/citutilities"></ph>.</p>
+</stepxmp>
+</step>
+</steps>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminappschangingyourclasspath.dita Mon Nov 11 14:37:26 2013
@@ -19,13 +19,14 @@ limitations under the License.
-->
<task id="tadminappschangingyourclasspath" xml:lang="en-us">
<title>Installing required jar files and adding them to the classpath</title>
+<shortdesc>To use the Network Server and network client driver, add the
+following jar file to your server classpath.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derbyclient.jar</indexterm><indexterm>derby.jar</indexterm>
<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 file to your server classpath:</p>
+<context>
<ul>
<li><codeph>derbyrun.jar</codeph></li>
</ul>
@@ -35,39 +36,43 @@ classpath. These classes are in the foll
to your classpath separately:</p>
</context>
<steps-unordered>
-<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
+<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="../conrefs.dita#prod/productshortname"></ph> database engine code.
It must be in the classpath in order for the Network Server to access
<ph conref="../conrefs.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="../conrefs.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="../conrefs.dita#prod/productshortname"></ph> databases over a network.
-</p></info>
+<codeph>derby.jar</codeph> is included in the <codeph>Class-Path</codeph>
+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="../conrefs.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="../conrefs.dita#prod/productshortname"></ph> databases over a
+network.</p></info>
</step>
</steps-unordered>
<example><p>All of the jar files are in the
<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/lib</codeph>
directory.</p>
-<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-script files for setting the classpath to work with the Network Server. The
-scripts are located in the <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides script
+files for setting the classpath to work with the Network Server. The scripts are
+located in the
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
directory.</p><ul>
<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="../conrefs.dita#pub/citgetstart"></ph></cite> for more information
-on setting the classpath.</postreq>
+<postreq>See <xref href="cadminconfig86869.dita#cadminconfig86869"></xref> and
+<ph conref="../conrefs.dita#pub/citgetstart"></ph> for more information on
+setting the classpath.</postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminappsruntimeinfo.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminappsruntimeinfo.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminappsruntimeinfo.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminappsruntimeinfo.dita Mon Nov 11 14:37:26 2013
@@ -19,16 +19,21 @@ limitations under the License.
-->
<task id="tadminappsruntimeinfo" xml:lang="en-us">
<title>Obtaining Network Server runtime information</title>
+<shortdesc>Use the <codeph>runtimeinfo</codeph> command or the
+<codeph>getRuntimeInfo</codeph> method to get memory usage and current session
+information about the Network Server, including user, database, and prepared
+statement information.</shortdesc>
<taskbody>
-<context> <p>Use the <b>runtimeinfo</b> command or <b>getRuntimeInfo</b> method
-to get memory usage and current session information about the Network Server
-including user, database, and prepared statement information.</p> </context>
<steps-unordered>
-<step><cmd>To run <b>runtimeinfo</b> from the command line:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl runtimeinfo
- [-h <<i>hostname</i>>][<-p <i>portnumber</i>>] </codeblock></stepxmp></step>
-<step><cmd>The <b>getRuntimeInfo</b> method returns the same information as
-the <b>runtimeinfo</b> command. The signature for the getRuntimeInfo method
-is String getRuntimeInfo(). For example:</cmd><stepxmp><codeblock>NetworkServerControl serverControl = new NetworkServerControl();
+<step><cmd>To run <codeph>runtimeinfo</codeph> from the command line:</cmd>
+<stepxmp><codeblock><b>java org.apache.derby.drda.NetworkServerControl runtimeinfo
+ [-h <<i>hostname</i>>][<-p <i>portnumber</i>>]</b></codeblock>
+</stepxmp></step>
+<step><cmd>The <codeph>getRuntimeInfo</codeph> method returns the same
+information as the <codeph>runtimeinfo</codeph> command. The signature for the
+<codeph>getRuntimeInfo</codeph> method is</cmd>
+<stepxmp><codeblock>String getRuntimeInfo()</codeblock><p>For example:</p>
+<codeblock>NetworkServerControl serverControl = new NetworkServerControl();
String <i>myinfo</i> = serverControl.getRuntimeInfo(); </codeblock></stepxmp>
</step>
</steps-unordered>
Modified: db/derby/docs/trunk/src/adminguide/tadminappssettingportnumbers.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminappssettingportnumbers.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminappssettingportnumbers.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminappssettingportnumbers.dita Mon Nov 11 14:37:26 2013
@@ -20,22 +20,27 @@ limitations under the License.
-->
<task id="tadminappssettingportnumbers" xml:lang="en-us">
<title>Setting port numbers</title>
+<shortdesc>By default, the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server listens
+on TCP/IP port number 1527. If you want to use a different port number, you can
+specify it on the command line when starting the Network Server. </shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>setting port numbers for</indexterm></indexterm>
<indexterm>Port numbers<indexterm>Network Server and</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>By default, <ph conref="../conrefs.dita#prod/productshortname"></ph> using
-the Network Server listens on TCP/IP port number 1527. If you want to use
-a different port number, you can specify it on the command line when starting
-the Network Server. For example:</p> <codeblock>java org.apache.derby.drda.NetworkServerControl start -p 1088</codeblock> </context>
+<context><p>For example:</p>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl start -p 1088</b></codeblock>
+</context>
<steps>
-<step><cmd>However, it is better to specify the port numbers by using any
-of the following methods</cmd>
+<step><cmd>However, it is better to specify the port numbers by using any of the
+following methods:</cmd>
<choices>
-<choice>Change the startNetworkServer.bat or startNetworkServer.ksh scripts </choice>
-<choice>Use the <codeph>derby.drda.portNumber</codeph> property in <codeph>derby.properties</codeph></choice>
+<choice>Change the <codeph>startNetworkServer.bat</codeph> or
+<codeph>startNetworkServer.ksh</codeph> script </choice>
+<choice>Use the <codeph>derby.drda.portNumber</codeph> property in
+<codeph>derby.properties</codeph></choice>
</choices>
</step>
</steps>
Modified: db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmincbdjhhfd.dita Mon Nov 11 14:37:26 2013
@@ -20,15 +20,14 @@ limitations under the License.
<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>
+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> <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,
+<context><note type="important">Always shut down the Network Server properly
+after use, because failure to do so might result in unpredictable side effects,
such as blocked ports on the server.</note></context>
<example>
<p>
@@ -37,10 +36,10 @@ you run a Network Server. For details on
see "Working with user authentication" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>. For information on user
authorization, see "Users and authorization identifiers" and "User
-authorizations" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.
-You are also urged to install a Java security manager with a
-customized security policy. For details on how to do this, see
-<xref href="tadminnetservcustom.dita"></xref>.</p>
+authorizations" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>. You
+are also urged to install a Java security manager with a customized security
+policy. For details on how to do this, see
+<xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref>.</p>
<p>If you are running Java SE 7 or later, and if you start the
<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server from the
command line as described here, access to databases and to other
@@ -57,12 +56,15 @@ instructions in "Setting up your environ
and <codeph>JAVA_HOME</codeph> environment variables and to add
<codeph><ph conref="../conrefs.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 <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>,
-where <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph> is the
-directory where you installed <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p><p>You
-can run NetworkServerControl commands only from the host that started the
+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
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>,
+where
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph> is
+the directory where you installed
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<p>You can run NetworkServerControl commands only from the host that started the
Network Server. The following table shows the sequence of commands.</p>
<table>
<title>Commands to run the <codeph>startNetworkServer</codeph> command</title>
@@ -89,8 +91,7 @@ Network Server. The following table show
<entry colname="col2"><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></entry>
+<b><userinput>startNetworkServer</userinput></b></codeblock></entry>
</row>
</tbody>
</tgroup>
@@ -136,8 +137,8 @@ or
<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
+<li><p>If you are familiar with both the Java programming language and
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, you have already set
<codeph><ph conref="../conrefs.dita#prod/productinstallpath"></ph></codeph>.
Set your classpath to include the
<ph conref="../conrefs.dita#prod/productshortname"></ph>
@@ -172,10 +173,10 @@ table.</p>
</table>
</li>
</ul>
-<p>The default system directory is the directory in which
-<ph conref="../conrefs.dita#prod/productshortname"></ph> was started. (See
-the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite> for
-more information about the default system directory.)</p>
+<p>The default system directory is the directory in which
+<ph conref="../conrefs.dita#prod/productshortname"></ph> was started. (See the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph> 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>
@@ -183,14 +184,12 @@ Server by specifying an option to the co
<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>
+<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>
+<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 with a customized security policy
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita Mon Nov 11 14:37:26 2013
@@ -19,47 +19,61 @@ limitations under the License.
-->
<task id="tadminconfig813694" xml:lang="en-us">
<title>Using the NetworkServerControl API</title>
+<shortdesc>You need to create an instance of the
+<codeph>NetworkServerControl</codeph> class if you are using the
+API.</shortdesc>
<prolog><metadata>
<keywords><indexterm>NetworkServerControl class</indexterm><indexterm>NetworkServerControl
API<indexterm>NetworkServerControl class and</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>You need to create an instance of the NetworkServerControl class
-if you are using the API. There are four constructors for this class:</p><note>Before
-enabling connections from other systems, ensure that you are running under
-a security manager.</note></context>
+<context><p>There are four constructors for this class.</p>
+<note>Before enabling connections from other systems, ensure that you are
+running under a security manager.</note>
+</context>
<steps-unordered>
-<step><cmd>NetworkServerControl()</cmd><stepresult><p>This constructor
-creates an instance that listens either on the default port (1527) or the
-port that is set by the <codeph>derby.drda.portNumber</codeph> property. It
-will also listen on the host set by the <codeph>derby.drda.host</codeph> property
-or the loopback address if the property is not set. This is the default constructor;
-it does not allow remote connections. It is equivalent to calling NetworkServerControl(InetAddress.getByName("localhost"),1527)
-if no properties are set.</p></stepresult></step>
-<step><cmd>NetworkServerControl(InetAddress address, int portNumber)</cmd>
-<stepresult><p>This constructor creates an instance that listens on
-the specified <codeph>portNumber</codeph> on the specified address. The <codeph>InetAddress</codeph> will
-be passed to <codeph>ServerSocket</codeph>. NULL is an invalid address value.
- The following examples show how you might allow Network Server to accept
-connections from other hosts: <codeblock>//accepts connections from other hosts on an IPv4 system
+<step><cmd><codeph>NetworkServerControl()</codeph></cmd>
+<stepresult>
+<p>This constructor creates an instance that listens either on the default port
+(1527) or the port that is set by the <codeph>derby.drda.portNumber</codeph>
+property. It will also listen on the host set by the
+<codeph>derby.drda.host</codeph> property or the loopback address if the
+property is not set. This is the default constructor; it does not allow remote
+connections. It is equivalent to calling
+<codeph>NetworkServerControl(InetAddress.getByName("localhost"),1527)</codeph>
+if no properties are set.</p>
+</stepresult></step>
+<step><cmd><codeph>NetworkServerControl(InetAddress address, int portNumber)</codeph></cmd>
+<stepresult>
+<p>This constructor creates an instance that listens on the specified
+<codeph>portNumber</codeph> on the specified address. The
+<codeph>InetAddress</codeph> will be passed to <codeph>ServerSocket</codeph>.
+NULL is an invalid address value. The following examples show how you might
+allow the Network Server to accept connections from other hosts:
+<codeblock>// accepts connections from other hosts on an IPv4 system
NetworkServerControl serverControl =
- new NetworkServerControl(InetAddress.getByName("0.0.0.0"),1527);</codeblock> <codeblock>//accepts connections from other hosts on an IPv6 system
+ new NetworkServerControl(InetAddress.getByName("0.0.0.0"),1527);</codeblock>
+<codeblock>// accepts connections from other hosts on an IPv6 system
NetworkServerControl serverControl =
- new NetworkServerControl(InetAddress.getByName("::"),1527);</codeblock></p></stepresult>
+ new NetworkServerControl(InetAddress.getByName("::"),1527);</codeblock></p>
+</stepresult>
</step>
-<step><cmd>NetworkServerControl(String userName, String password)</cmd>
-<stepresult><p>If a network server should run with user authentication,
-certain operations like NetworkServerControl.shutdown()
-require that you provide user credentials. This constructor creates an instance
-with user credentials, which are then used for operations
-that require them. In all other aspects, this constructor behaves like
-NetworkServerControl().</p></stepresult>
+<step><cmd><codeph>NetworkServerControl(String userName, String password)</codeph></cmd>
+<stepresult>
+<p>If a network server should run with user authentication, certain operations
+like <codeph>NetworkServerControl.shutdown()</codeph> require that you provide
+user credentials. This constructor creates an instance with user credentials,
+which are then used for operations that require them. In all other aspects, this
+constructor behaves like <codeph>NetworkServerControl()</codeph>.</p>
+</stepresult>
</step>
-<step><cmd>NetworkServerControl(InetAddress address, int portNumber, String userName, String password)</cmd>
-<stepresult><p>This constructor creates an instance with user
-credentials, which are then used for operations that require them. In
-all other aspects, this constructor behaves like
-NetworkServerControl(InetAddress address, int portNumber).</p></stepresult>
+<step><cmd><codeph>NetworkServerControl(InetAddress address, int portNumber, String userName, String password)</codeph></cmd>
+<stepresult>
+<p>This constructor creates an instance with user credentials, which are then
+used for operations that require them. In all other aspects, this constructor
+behaves like <codeph>NetworkServerControl(InetAddress address,
+int portNumber)</codeph>.</p>
+</stepresult>
</step>
</steps-unordered>
</taskbody>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig814963.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig814963.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig814963.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig814963.dita Mon Nov 11 14:37:26 2013
@@ -19,29 +19,35 @@ limitations under the License.
-->
<task id="tadminconfig814963" xml:lang="en-us">
<title>Starting the Network Server from a Java application</title>
+<shortdesc>Always shut down the Network Server properly after use, because
+failure to do so might result in unpredictable side effects, such as blocked
+ports on the server.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>starting from the API</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context><p>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>There are two ways to start the
-Network Server from a Java application.</p> </context>
+<context><p>There are two ways to start the Network Server from a Java
+application.</p></context>
<steps-unordered>
-<step><cmd>You can include the following line in the <codeph>derby.properties</codeph> file: </cmd>
-<stepxmp><codeblock>derby.drda.startNetworkServer=true</codeblock>This starts
-the server on the default port, 1527, listening on <codeph>localhost</codeph> (all
-interfaces).</stepxmp><stepxmp><p>To specify a different port or a specific
-interface in the <codeph>derby.properties</codeph> file, include the following
-lines, respectively:</p><codeblock>derby.drda.portNumber=1110
-derby.drda.host=<i>myhost</i></codeblock></stepxmp><stepxmp>You can also specify
-the <codeph>startNetworkServer</codeph> and <codeph>portNumber</codeph> properties
-by using a Java command: <codeblock>java -Dderby.drda.startNetworkServer=true
--Dderby.drda.portNumber=1110
--Dderby.drda.host=<i>myhost yourApp</i></codeblock></stepxmp></step>
+<step><cmd>You can include the following line in the <codeph>derby.properties</codeph>
+file:</cmd>
+<stepxmp><codeblock>derby.drda.startNetworkServer=true</codeblock>
+This starts the server on the default port, 1527, listening on
+<codeph>localhost</codeph> (all interfaces).</stepxmp>
+<stepxmp><p>To specify a different port or a specific interface in the
+<codeph>derby.properties</codeph> file, include the following lines,
+respectively:</p>
+<codeblock>derby.drda.portNumber=1110
+derby.drda.host=<i>myhost</i></codeblock></stepxmp>
+<stepxmp>You can also specify the <codeph>startNetworkServer</codeph> and
+<codeph>portNumber</codeph> properties by using a Java command:
+<codeblock><b>java -Dderby.drda.startNetworkServer=true \
+-Dderby.drda.portNumber=1110 \
+-Dderby.drda.host=<i>myhost yourApp</i></b></codeblock></stepxmp></step>
<step><cmd>You can use the NetworkServerControl API to start the Network Server
-from a separate thread within a Java application: </cmd><stepxmp><codeblock>NetworkServerControl server = new NetworkServerControl();
+from a separate thread within a Java application:</cmd>
+<stepxmp><codeblock>NetworkServerControl server = new NetworkServerControl();
server.start (null);</codeblock></stepxmp></step>
</steps-unordered>
</taskbody>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita Mon Nov 11 14:37:26 2013
@@ -20,30 +20,31 @@ limitations under the License.
-->
<task id="tadminconfig815333" xml:lang="en-us">
<title>Shutting down by using the command line</title>
+<shortdesc>From the command line, you can shut down the Network Server by
+invoking a jar file or a class.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Shutting down Network Server<indexterm>from the command
line</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
<context>
-<p>From the command line, you can shut down a Network Server by invoking a
-jar file or a class. </p>
-<p>Note that you need to provide user credential arguments to shut down a server running with user authentication.</p>
+<p>You must provide user credential arguments to shut down a server running with
+user authentication.</p>
</context>
<steps-unordered>
<step><cmd>To shut down the Network Server by invoking a jar file from the
<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"/>/lib</codeph>
directory, use:</cmd><stepxmp>
-<codeblock>java -jar derbyrun.jar server shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]
-</codeblock></stepxmp>
+<codeblock><b>java -jar derbyrun.jar server shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]</b></codeblock>
+</stepxmp>
<stepxmp>or
-<codeblock>java -jar derbynet.jar shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]
-</codeblock></stepxmp>
+<codeblock><b>java -jar derbynet.jar shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]</b></codeblock>
+</stepxmp>
</step>
-<step><cmd>To shut down the Network Server by invoking a class,
-use:</cmd><stepxmp>
-<codeblock>java org.apache.derby.drda.NetworkServerControl shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]
-</codeblock></stepxmp></step>
+<step><cmd>To shut down the Network Server by invoking a class, use:</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl shutdown [-h <i><hostname></i>] [-p <i><portnumber></i>] [-user <i><username></i>] [-password <i><password></i>]</b></codeblock>
+</stepxmp></step>
</steps-unordered>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita Mon Nov 11 14:37:26 2013
@@ -20,27 +20,24 @@ limitations under the License.
-->
<task id="tadminconfig815357" xml:lang="en-us">
<title>Shutting down by using the API</title>
+<shortdesc>You can use the NetworkServerControl API to shut down the Network
+Server from within a Java application.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>shutting down using the API</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>You can use the NetworkServerControl API to shut down the Network
-Server from within a Java application. The name of the method that you use
-to shutdown the Network Server is <codeph>shutdown()</codeph>.</p> </context>
+<context><p>The name of the method that you use to shut down the Network Server
+is <codeph>shutdown()</codeph>.</p></context>
<example>
<p>For example, the following command shuts down the Network Server
running on the current machine using the default port number (1527):</p>
-<codeblock>
-NetworkServerControl server = new NetworkServerControl();
-server.shutdown();
-</codeblock>
+<codeblock>NetworkServerControl server = new NetworkServerControl();
+server.shutdown();</codeblock>
<p>To shut down a server running with user authentication, you need to use
a NetworkServerControl instance created with user credentials:</p>
-<codeblock>
-NetworkServerControl server = new NetworkServerControl(username, password);
-server.shutdown();
-</codeblock>
+<codeblock>NetworkServerControl server = new NetworkServerControl(username, password);
+server.shutdown();</codeblock>
</example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815768.dita Mon Nov 11 14:37:26 2013
@@ -19,9 +19,10 @@ limitations under the License.
-->
<task id="tadminconfig815768" xml:lang="en-us">
<title>Obtaining system information by using the command line</title>
+<shortdesc>To run <codeph>sysinfo</codeph> from the command line, use a command
+like one of the following while the Network Server is running.</shortdesc>
<taskbody>
-<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>
+<context>
<codeblock><b>java -jar $<ph conref="../conrefs.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
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita Mon Nov 11 14:37:26 2013
@@ -19,24 +19,27 @@ See the License for the specific languag
limitations under the License.
-->
<task id="tadminconfig815822" xml:lang="en-us">
-<title>Obtaining Network Server properties by using the getCurrent Properties
+<title>Obtaining Network Server properties by using the getCurrentProperties
method</title>
+<shortdesc>The <codeph>getCurrentProperties</codeph> method is a Java method
+that you can use to obtain information about the Network Server.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>properties information, getCurrentProperties
method</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>The getCurrentProperties method is a Java method that you can
-use to obtain information about the Network Server. It returns a Properties
-object with the value of all the Network Server properties as they are currently
-set.</p><p>The signature of this method is:<codeblock>Properties getCurrentProperties();</codeblock></p></context>
+<context><p>It returns a <codeph>Properties</codeph> object with the value of
+all the Network Server properties as they are currently set.</p>
+<p>The signature of this method is:
+<codeblock>Properties getCurrentProperties()</codeblock>
+</p></context>
<example>For example:<codeblock>NetworkServerControl server = new NetworkServerControl();
Properties p = server.getCurrentProperties();
p.list(System.out);
-System.out.println(p.getProperty("derby.drda.host"));</codeblock><p>As shown
-in the previous example, you can look up the current properties and then work
-with individual properties if needed by using various APIs on the Properties
-class. You can also print out all the properties by using the Properties.list()
-method.</p></example>
+System.out.println(p.getProperty("derby.drda.host"));</codeblock>
+<p>As shown in the previous example, you can look up the current properties and
+then work with individual properties if needed by using various APIs on the
+<codeph>Properties</codeph> class. You can also print out all the properties by
+using the <codeph>Properties.list</codeph> method.</p></example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815853.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815853.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815853.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815853.dita Mon Nov 11 14:37:26 2013
@@ -20,17 +20,20 @@ limitations under the License.
-->
<task id="tadminconfig815853" xml:lang="en-us">
<title>Obtaining system information by using the API</title>
+<shortdesc>The <codeph>getSysinfo</codeph> method produces the same information
+as the <codeph>sysinfo</codeph> command.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>sysinfo method</indexterm></indexterm>
<indexterm>Network Server<indexterm>system information, obtaining</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>The <codeph>sysinfo</codeph> method produces the same information
-as the <cmdname>sysinfo</cmdname> command. The signature for this method is</p><codeblock>String getSysinfo();</codeblock> </context>
+<context><p>The signature for this method is</p>
+<codeblock>String getSysinfo();</codeblock> </context>
<example><p>For example:</p><codeblock>NetworkServerControl serverControl = new NetworkServerControl();
-String myinfo = serverControl.getSysinfo();</codeblock><p>The <codeph>getSysinfo()</codeph> method
-returns information about the Network Server that is running on the current
-machine on the default port number (1527).</p></example>
+String myinfo = serverControl.getSysinfo();</codeblock>
+<p>The <codeph>getSysinfo</codeph> method returns information about the Network
+Server that is running on the current machine on the default port number
+(1527).</p></example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigipx.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigipx.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigipx.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigipx.dita Mon Nov 11 14:37:26 2013
@@ -19,13 +19,14 @@ limitations under the License.
-->
<task id="tadminconfigipx" xml:lang="en-us">
<title>Starting the Network Server on IPv6/IPv4 dual stack Windows machines</title>
+<shortdesc>Add the following JVM properties to the command when you start the
+server on an IPv6/IPv4 dual stack Windows machine.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>starting from IPv6/IPv4 dual
stack Windows machines</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>The following JVM properties need to be added to the command
-when starting the server on IPv6/IPv4 dual stack Windows machines:</p><codeblock>-Djava.net.preferIPv4Stack=false
+<context><codeblock>-Djava.net.preferIPv4Stack=false
-Djava.net.preferIPv6Addresses=true</codeblock></context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigsettingnetwrokserverproperties.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigsettingnetwrokserverproperties.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigsettingnetwrokserverproperties.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigsettingnetwrokserverproperties.dita Mon Nov 11 14:37:26 2013
@@ -19,19 +19,23 @@ limitations under the License.
-->
<task id="tadminconfigsettingnetwrokserverproperties" xml:lang="en-us">
<title>Setting Network Server properties</title>
+<shortdesc>You can specify Network Server properties in the following
+ways.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>properties</indexterm></indexterm>
<indexterm>Properties<indexterm>Network Server</indexterm></indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>You can specify Network Server properties in three ways: <ul>
+<context><ul>
<li>On the command line</li>
-<li>In the <codeph>.bat</codeph> or <codeph>.ksh</codeph> files (loading the
+<li>In the <codeph>.bat</codeph> or <codeph>.ksh</codeph> files (load the
properties by executing <codeph>java -D</codeph>)</li>
-<li>In the <codeph>derby.properties</codeph> file. </li>
-</ul></p><p>Properties in the command line or in the <codeph>.bat </codeph>or <codeph>.ksh</codeph> files
-take precedence over the properties in the <codeph>derby.properties</codeph> file.
-Arguments included on commands that are issued on the command line take precedence
-over property values.</p> </context>
+<li>In the <codeph>derby.properties</codeph> file</li>
+</ul>
+<p>Properties specified on the command line or in the <codeph>.bat </codeph> or
+<codeph>.ksh</codeph> files take precedence over the properties in the
+<codeph>derby.properties</codeph> file. Arguments included in commands that are
+issued on the command line take precedence over property values.</p>
+</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita Mon Nov 11 14:37:26 2013
@@ -19,7 +19,7 @@ limitations under the License.
-->
<task id="tadminconfigshuttingdownthenetworkserver" xml:lang="en-us">
<title>Shutting down the Network Server</title>
-<shortdesc>To shut down a Network Server, you can invoke a script, a jar
+<shortdesc>To shut down the Network Server, you can invoke a script, a jar
file, or a class.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Shutting down Network Server<indexterm>from scripts</indexterm></indexterm>
@@ -28,7 +28,7 @@ file, or a class.</shortdesc>
</metadata></prolog>
<taskbody>
<context>
-<p>The scripts to shut down a Network Server are located in the
+<p>The scripts to shut down the Network Server are located in the
<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"/>/bin</codeph>
directory.</p>
<note type="important">If user authentication is enabled, you must specify a
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita Mon Nov 11 14:37:26 2013
@@ -19,14 +19,18 @@ limitations under the License.
-->
<task id="tadminconfigsysteminformation" xml:lang="en-us">
<title>Obtaining system information</title>
+<shortdesc>You can obtain information about the Network Server, such as version
+and current property values, Java information, and
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database server
+information, by using the <codeph>sysinfo</codeph> utility.</shortdesc>
<taskbody>
-<context> <p>You can obtain information about the Network Server, such as
-version and current property values, Java information, and <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-server information, by using the <codeph>sysinfo</codeph> utility. The <codeph>sysinfo</codeph> utility
-is available from scripts, the command line, and the NetworkServerControl API.</p><p>The following scripts are located
-in the <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
-directory. Before running these scripts, make sure that the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
-Server is started.</p> </context>
+<context><p>The <codeph>sysinfo</codeph> utility is available from scripts, the
+command line, and the NetworkServerControl API.</p>
+<p>The following scripts are located in the
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
+directory. Before running these scripts, make sure that the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server is
+started.</p></context>
<steps-unordered>
<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>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita Mon Nov 11 14:37:26 2013
@@ -20,42 +20,56 @@ limitations under the License.
-->
<task id="tadminconfiguringthenetworkserver" xml:lang="en-us">
<title>Configuring the Network Server to handle connections</title>
+<shortdesc>You can configure the Network Server to use a specific number of
+threads to handle connections. You can change the configuration on the command
+line.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>derby.drda.minthreads</indexterm></keywords>
+<keywords><indexterm>derby.drda.minthreads</indexterm>
+<indexterm>derby.drda.maxthreads</indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>You can configure the Network Server to use a specific number
-of threads to handle connections. You can change the configuration on the
-command line.</p> <p>The minimum number
-of threads is the number of threads that are started when the Network Server
-is booted. This value is specified as a property, <codeph>derby.drda.minThreads
-= <<i>min</i>></codeph>. The maximum number of threads is the maximum
-number of threads that will be used for connections. If more connections are
-active than there are threads available, the extra connections must wait until the next
-thread becomes available. Threads can become available after a specified time,
-which is checked only when a thread has finished processing a communication.</p> </context>
+<context><p>The minimum number of threads is the number of threads that are
+started when the Network Server is booted. This value is specified as a
+property, <codeph>derby.drda.minThreads=<i>min</i></codeph>. The
+maximum number of threads is the maximum number of threads that will be used for
+connections. If more connections are active than there are threads available,
+the extra connections must wait until the next thread becomes available. Threads
+can become available after a specified time, which is checked only when a thread
+has finished processing a communication.</p>
+</context>
<steps-unordered>
<step><cmd>You can change the maximum number of threads by using the following
-command:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl maxthreads <<i>max</i>> [-h <<i>hostname</i>>]
-[-p <<i>portnumber</i>>] </codeblock></stepxmp><info>You can also use
-the <codeph>derby.drda.maxThreads</codeph> property to assign the maximum
-value. A <<i>max</i>> value of 0 means that there is no maximum and
-a new thread will be generated for a connection if there are no current threads
-available. This is the default. The <<i>max</i>> and <<i>min</i>>
-values are stored as integers, so the theoretical maximum is 2147483647 (the
-maximum size of an integer). But the practical maximum is determined by the
-machine configuration. </info></step>
+command (all on one line):</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl maxthreads <i>max</i>
+ [-h <i>hostname</i>] [-p <i>portnumber</i></b></codeblock>
+</stepxmp>
+<info>You can also use the <codeph>derby.drda.maxThreads</codeph> property to
+assign the maximum value. A <i>max</i> value of 0 means that there is no maximum
+and a new thread will be generated for a connection if there are no current
+threads available. This is the default. The <i>max</i> and <i>min</i> values are
+stored as integers, so the theoretical maximum is 2147483647 (the maximum size
+of an integer). But the practical maximum is determined by the machine
+configuration.</info>
+</step>
<step><cmd>To change the time that a thread should work on one session's request
-and check if there are waiting sessions, use the following command: </cmd>
-<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
-timeslice <<i>milliseconds</i>> [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock></stepxmp>
-<info><p>You can also use the derby.drda.timeSlice property
-to set this value. A value of 0 milliseconds indicates that the thread will
-not give up working on the session until the session ends. A value of -1 milliseconds
-indicates to use the default. The default value is 0. The maximum number of
-milliseconds that can be specified is 2147483647 (the maximum size of an integer).</p> </info>
+and check if there are waiting sessions, use the following command (all on one
+line):</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl
+ timeslice <i>milliseconds</i> [-h <i>hostname</i>] [-p <i>portnumber</i>]</b></codeblock></stepxmp>
+<info><p>You can also use the <codeph>derby.drda.timeSlice</codeph> property to
+set this value. A value of 0 milliseconds indicates that the thread will not
+give up working on the session until the session ends. A value of -1
+milliseconds indicates to use the default. The default value is 0. The maximum
+number of milliseconds that can be specified is 2147483647 (the maximum size of
+an integer).</p> </info>
</step>
</steps-unordered>
+<result>For more information on these properties, see
+<xref href="radmindrdaminthreads.dita#radmindrdaminthreads"></xref>,
+<xref href="radmindrdamaxthreads.dita#radmindrdamaxthreads"></xref>, and
+<xref href="radmindrdatimeslice.dita#radmindrdatimeslice"></xref>.</result>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigverifyingstartup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigverifyingstartup.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigverifyingstartup.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigverifyingstartup.dita Mon Nov 11 14:37:26 2013
@@ -18,42 +18,50 @@ See the License for the specific languag
limitations under the License.
-->
<task id="tadminconfigverifyingstartup" xml:lang="en-us">
-<title>Verifying Startup</title>
-<shortdesc>To verify that the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
-Server is currently running, use the ping command.</shortdesc>
+<title>Verifying startup</title>
+<shortdesc>To verify that the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server is
+currently running, use the <codeph>ping</codeph> command.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>verifying startup</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>You can use the ping command in the following ways:</p> </context>
+<context><p>You can use the <codeph>ping</codeph> command in the following
+ways:</p></context>
<steps-unordered>
-<step><cmd>You can use the scripts NetworkServerControl.bat for Windows systems
-or NetworkServerControl.ksh for UNIX systems with the <b>ping</b> command.
-For example: </cmd><stepxmp><codeblock>NetworkServerControl ping [-h <<i>hostname</i>>;] [-p <<i>portnumber</i>>]</codeblock></stepxmp>
+<step><cmd>You can use the script <codeph>NetworkServerControl.bat</codeph> for
+Windows systems or <codeph>NetworkServerControl.ksh</codeph> for UNIX systems
+with the <codeph>ping</codeph> command. For example:</cmd>
+<stepxmp><codeblock>NetworkServerControl ping [-h <<i>hostname</i>>;] [-p <<i>portnumber</i>>]</codeblock>
+</stepxmp>
+</step>
+<step><cmd>You can use the NetworkServerControl <codeph>ping</codeph>
+command:</cmd>
+<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
+ ping [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>]</codeblock>
+</stepxmp>
</step>
-<step><cmd>You can use the NetworkServerControl command:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
- ping [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock></stepxmp></step>
<step><cmd>You can use the NetworkServerControl API to verify startup from
-within a Java application: </cmd><stepxmp><codeblock>ping(); </codeblock></stepxmp>
+within a Java application:</cmd>
+<stepxmp><codeblock>ping(); </codeblock></stepxmp>
</step>
</steps-unordered>
<example>The following example uses a method to verify startup. It will try
-to verify for the specified number of seconds: <codeblock>private static boolean isServerStarted(NetworkServerControl server, int ntries)
- {
- for (int i = 1; i <= ntries; i ++)
- {
- try {
- Thread.sleep(500);
- server.ping();
- return true;
- }
- catch (Exception e) {
- if (i == ntries)
- return false;
- }
- }
- return false;
- }</codeblock></example>
+to verify for the specified number of seconds:
+<codeblock>private static boolean isServerStarted(NetworkServerControl server, int ntries) {
+ for (int i = 1; i <= ntries; i ++) {
+ try {
+ Thread.sleep(500);
+ server.ping();
+ return true;
+ } catch (Exception e) {
+ if (i == ntries) {
+ return false;
+ }
+ }
+ }
+ return false;
+}</codeblock></example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmincrtdbbkup.dita Mon Nov 11 14:37:26 2013
@@ -20,23 +20,26 @@ limitations under the License.
<task id="tadmincrtdbbkup" xml:lang="en-us">
<title>Creating a database from a backup copy</title>
<shortdesc>To create a database from a full backup copy at a specified location,
-specify the <codeph>createFrom=<i>Path</i></codeph> attribute in the boot
-time connection URL.</shortdesc>
+specify the <codeph>createFrom=<i>path</i></codeph> attribute in the boot-time
+connection URL.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Creating a database from a backup copy</indexterm></keywords>
</metadata></prolog>
<taskbody>
-<context> <p>If there is already a database with the same name in derby.system.home,
-an error will occur and the existing database will be left intact. If there
-is not an existing database with the same name in the current derby.system.home
-location, the system will copy the whole database from the backup location
-to derby.system.home and start it.</p><p>The log files are also copied to
-the default location. You can use the <codeph>logDevice</codeph> attribute
-in conjunction with the <codeph>createFrom=Path</codeph> attribute to store
-logs in a different location. With the <codeph>createFrom=Path</codeph> attribute,
-you do not need to copy the individual log files to the log directory.</p> </context>
-<example>For example, to create the sample database from a backup copy in <filepath>c:\mybackups\sample</filepath>,
-the connection URL should be: <codeblock>jdbc:derby:sample;createFrom=c:\mybackups\sample</codeblock>
+<context> <p>If there is already a database with the same name in
+<codeph>derby.system.home</codeph>, an error will occur and the existing
+database will be left intact. If there is not an existing database with the same
+name in the current <codeph>derby.system.home</codeph> location, the system will
+copy the whole database from the backup location to
+<codeph>derby.system.home</codeph> and start it.</p>
+<p>The log files are also copied to the default location. You can use the
+<codeph>logDevice</codeph> attribute in conjunction with the
+<codeph>createFrom=<i>path</i></codeph> attribute to store logs in a different
+location. With the <codeph>createFrom=<i>path</i></codeph> attribute, you do not
+need to copy the individual log files to the log directory.</p> </context>
+<example>For example, to create the sample database from a backup copy in
+<codeph>c:\mybackups\sample</codeph>, the connection URL should be:
+<codeblock>jdbc:derby:sample;createFrom=c:\mybackups\sample</codeblock>
<p>For more information, see "createFrom=path attribute" in the
<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
</example>
Modified: db/derby/docs/trunk/src/adminguide/tadminexporting.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminexporting.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminexporting.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminexporting.dita Mon Nov 11 14:37:26 2013
@@ -71,7 +71,7 @@ data into a separate export file</entry>
IN <xref href="radminexportarguments.dita#radminexportarguments/radminexportcolumndelimiter">COLUMNDELIMITER</xref> CHAR(1),
IN <xref href="radminexportarguments.dita#radminexportarguments/radminexportcharacterdelimiter">CHARACTERDELIMITER</xref> CHAR(1),
IN <xref href="radminexportarguments.dita#radminexportarguments/radminexportcodeset">CODESET</xref> VARCHAR(128),
- IN <xref href="radminexportarguments.dita#radminexportarguments/radminexportlobsfilename">LOBSFILNAME</xref> VARCHAR(32672))</codeblock>
+ IN <xref href="radminexportarguments.dita#radminexportarguments/radminexportlobsfilename">LOBSFILENAME</xref> VARCHAR(32672))</codeblock>
<p>A reference to the location of the LOB data is placed in the LOB column in
the main export file.</p></entry>
</row>
Modified: db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminhubbkup44.dita Mon Nov 11 14:37:26 2013
@@ -19,18 +19,20 @@ limitations under the License.
-->
<task id="tadminhubbkup44" xml:lang="en-us">
<title>Restoring a database from a backup copy</title>
-<shortdesc>To restore a database by using a full backup from a specified location,
-specify the <codeph>restoreFrom=<i>Path</i></codeph> attribute in the boot
-time connection URL.</shortdesc>
+<shortdesc>To restore a database by using a full backup from a specified
+location, specify the <codeph>restoreFrom=<i>path</i></codeph> attribute in the
+boot-time connection URL.</shortdesc>
<taskbody>
-<context><p>If a database with the same name exists in the derby.system.home
-location, the system will delete the database, copy it from the backup location,
-and then restart it.</p><p>The log files are copied to the same location they
-were in when the backup was taken. You can use the <codeph>logDevice</codeph> attribute
-in conjunction with the <codeph>restoreFrom=<i>Path</i></codeph> attribute
-to store logs in a different location.</p></context>
+<context><p>If a database with the same name exists in the
+<codeph>derby.system.home</codeph> location, the system will delete the
+database, copy it from the backup location, and then restart it.</p>
+<p>The log files are copied to the same location they were in when the backup
+was taken. You can use the <codeph>logDevice</codeph> attribute in conjunction
+with the <codeph>restoreFrom=<i>path</i></codeph> attribute to store logs in a
+different location.</p></context>
<example> For example, to restore the sample database by using a backup copy
-in <filepath>c:\mybackups\sample</filepath>, the connection URL should be: <codeblock>jdbc:derby:sample;restoreFrom=c:\mybackups\sample</codeblock>
+in <codeph>c:\mybackups\sample</codeph>, the connection URL should be:
+<codeblock>jdbc:derby:sample;restoreFrom=c:\mybackups\sample</codeblock>
<p>For more information, see "restoreFrom=path attribute" in the
<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
</example>
Modified: db/derby/docs/trunk/src/adminguide/tadminimporting.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminimporting.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminimporting.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminimporting.dita Mon Nov 11 14:37:26 2013
@@ -76,7 +76,8 @@ data with a reference to the LOB data</e
IN <xref href="radminimport64241.dita#radminimport64241/radminimportreplace">REPLACE</xref> SMALLINT)</codeblock>
<p>The import utility looks in the main import file for a reference to the
location of the LOB data. The format of the reference to the LOB stored in the
-main import file must be <codeph>lobsFileName.Offset.length/</codeph>.</p>
+main import file must be
+<codeph><i>lobsFileName</i>.<i>Offset</i>.<i>length</i>/</codeph>.</p>
</entry>
</row>
<row>
@@ -92,9 +93,10 @@ table, where the import file contains th
IN <xref href="radminimport64241.dita#radminimport64241/radminimportcharacterdelimiter">CHARACTERDELIMITER</xref> CHAR(1),
IN <xref href="radminimport64241.dita#radminimport64241/radminimportcodesetarg">CODESET</xref> VARCHAR(128),
IN <xref href="radminimport64241.dita#radminimport64241/radminimportreplace">REPLACE</xref> SMALLINT)</codeblock>
-<p>You must specify the INSERTCOLUMNS parameter on the table into which data
-will be imported. You must specify the COLUMNINDEXES parameter to import data
-fields from a file to column in a table.</p></entry>
+<p>You must specify the <codeph>INSERTCOLUMNS</codeph> parameter on the table
+into which data will be imported. You must specify the
+<codeph>COLUMNINDEXES</codeph> parameter to import data fields from a file to
+a column in a table.</p></entry>
</row>
<row>
<entry colname="col1">To import data to a subset of columns in a table, where
@@ -112,7 +114,8 @@ of the other data with a reference to th
IN <xref href="radminimport64241.dita#radminimport64241/radminimportreplace">REPLACE</xref> SMALLINT)</codeblock>
<p>The import utility looks in the main import file for a reference to the
location of the LOB data. The format of the reference to the LOB stored in the
-main import file must be <codeph>lobsFileName.Offset.length/</codeph>.</p>
+main import file must be
+<codeph><i>lobsFileName</i>.<i>Offset</i>.<i>length</i>/</codeph>.</p>
</entry>
</row>
</tbody>
Modified: db/derby/docs/trunk/src/adminguide/tadminlog800206.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminlog800206.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminlog800206.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminlog800206.dita Mon Nov 11 14:37:26 2013
@@ -34,13 +34,14 @@ when you are restoring a database using
as a path that is relative to the directory where the JVM is executed.</p>
<p>Setting <codeph>logDevice=<i>logDirectoryPath</i></codeph> on
the database connection URL when you create the database adds an entry to the
-<i>service.properties</i> file.
-If you ever move the log manually, you will need to alter the entry in <i>service.properties</i>.
-If you move the log back to the default location, remove the <i>logDevice</i> entry
-from the <i>service.properties</i> file.</p> </context>
+<codeph>service.properties</codeph> file. If you ever move the log manually, you
+will need to alter the entry in <codeph>service.properties</codeph>. If you move
+the log back to the default location, remove the <codeph>logDevice</codeph>
+entry from the <codeph>service.properties</codeph> file.</p> </context>
<example><p>To check the log location for an existing database, you can retrieve
-the <codeph>logDevice=<i>logDirectoryPath</i></codeph> attribute as a database property by using the
-following statement:</p><codeblock>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('logDevice')</codeblock>
+the <codeph>logDevice=<i>logDirectoryPath</i></codeph> attribute as a database
+property by using the following statement:</p>
+<codeblock><b>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('logDevice')</b></codeblock>
<p>For more information, see
<xref href="cadminrollforward.dita#cadminrollforward"></xref> in this manual and
"logDevice=logDirectoryPath attribute" in the
Modified: db/derby/docs/trunk/src/adminguide/tadminlogfile.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminlogfile.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminlogfile.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminlogfile.dita Mon Nov 11 14:37:26 2013
@@ -19,32 +19,46 @@ limitations under the License.
-->
<task id="tadminlogfile" xml:lang="en-us">
<title>Controlling logging by using the log file</title>
+<shortdesc>The Network Server uses the <codeph>derby.log</codeph> file to log
+problems that it encounters. It also logs connections when the property
+<codeph>derby.drda.logConnections</codeph> is set to
+<codeph>true</codeph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.infolog.append</indexterm><indexterm>derby.drda.logConnections</indexterm>
<indexterm>derby.log<indexterm>and the Network Server</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>The Network Server uses the <codeph>derby.log</codeph> file to
-log problems that it encounters. It also logs connections when the property <codeph>derby.drda.logConnections</codeph> is
-set to <codeph>true</codeph>. The <codeph>derby.log</codeph> file is created
-when the <ph conref="../conrefs.dita#prod/productshortname"></ph> server
-is started. The Network Server then records the time and version. If a log
-file exists, it is overwritten, unless the property <codeph>derby.infolog.append</codeph> is
-set to <codeph>true</codeph>. </p><p> When the Network Server is logging connections,
-it also logs the Connection Number; this log message is written both to the <codeph>derby.log</codeph> file
-and to the Network Server console.</p> </context>
+<context><p>See <xref
+href="radminconfigdb2jdrdalogconnections.dita#radminconfigdb2jdrdalogconnections"></xref>
+for information on this property.</p>
+<p>The <codeph>derby.log</codeph> file is created when the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> server is started. The
+Network Server then records the time and version. If a log file exists, it is
+overwritten, unless the property <codeph>derby.infolog.append</codeph> is
+set to <codeph>true</codeph>.See "derby.infolog.append" in the
+<ph conref="../conrefs.dita#pub/citref"></ph> for information on this
+property.</p>
+<p>When the Network Server is logging connections, it also logs the Connection
+Number; this log message is written both to the <codeph>derby.log</codeph> file
+and to the Network Server console.</p></context>
<steps-unordered>
-<step><cmd>To turn on connection logging, issue the following command:</cmd>
-<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
- logconnections on [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock></stepxmp>
+<step><cmd>To turn on connection logging, use the following command (all on
+one line):</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl
+ logconnections on [-h <i>hostname</i>] [-p <i>portnumber</i>]</b></codeblock>
+</stepxmp>
</step>
-<step><cmd>To turn off connection logging, issue the following command:</cmd>
-<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
- logconnections off [-h <<i>hostname</i>>][-p <<i>portnumber</i>>] </codeblock></stepxmp>
+<step><cmd>To turn off connection logging, use the following command (all on
+one line):</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl
+ logconnections off [-h <i>hostname</i>][-p <i>portnumber</i>]</b></codeblock>
+</stepxmp>
</step>
</steps-unordered>
-<postreq>See the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite> for
-more information about the <codeph>derby.log</codeph> file.</postreq>
+<postreq>See the <ph conref="../conrefs.dita#pub/citdevelop"></ph> for more
+information about the <codeph>derby.log</codeph> file.</postreq>
</taskbody>
</task>