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 [2/2] - /db/derby/docs/trunk/src/adminguide/
Modified: db/derby/docs/trunk/src/adminguide/tadminnetservbasic.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservbasic.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservbasic.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservbasic.dita Mon Nov 11 14:37:26 2013
@@ -20,48 +20,52 @@ limitations under the License.
-->
<task id="tadminnetservbasic" xml:lang="en-us">
<title>Basic Network Server security policy</title>
+<shortdesc>If you boot the Network Server without specifying a security
+manager, the Network Server will install a default Java security manager that
+enforces a Basic policy.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>basic policy</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p> If you boot the Network Server without specifying a security
-manager, the Network Server will install a default Java security manager enforcing
-a Basic policy. This happens if you boot the Network Server as your VM's entry
-point, e.g.: </p> <codeblock>
-java org.apache.derby.drda.NetworkServerControl start ...
-</codeblock> <p>Note that you should run your Network Server with user
-authentication and user authorization enabled. For details on how to enable user
-authentication, see "Working with user authentication" in the
+<context><p>This happens if you boot the Network Server as your VM's entry
+point, using a command like the following:</p>
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl start ...</b></codeblock>
+<p>You should run your Network Server with user authentication and user
+authorization enabled. For details on how to enable user authentication, 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>.</p>
-<p> Some
-of your application code may run as procedures and functions which you have
-declared using the CREATE PROCEDURE and CREATE FUNCTION statements. You will
-need to add privileged blocks to your declared procedures and functions if
+<p>Some of your application code may run as procedures and functions which you
+have declared using the CREATE PROCEDURE and CREATE FUNCTION statements. You
+will need to add privileged blocks to your declared procedures and functions if
they perform sensitive operations such as file and network i/o, classloading,
system property reading, etc.</p> <p> If for some reason you do not want
to run your client/server application under a security manager, you may override
-the Network Server's impulse to install a default policy. For details, see <xref
-href="tadminnetservopen.dita"></xref>. </p> <p> Note that the Network Server
-attempts to install a security manager only if you boot the server as the
-entry point of your VM. The Network Server will not attempt to install a security
-manager if you start the server from your application using the programmatic
-API described in the following section: <xref href="tadminconfig814963.dita"></xref>. </p> <p> You
-will find a template security policy in the Derby distribution at <i>demo/templates/server.policy</i>.
-Most likely, you will want to customize this policy. For example, probably
-you will want to restrict the server's liberal file i/o permissions which
-let the server backup/restore and export/import to or from any location in the local file system.
-For details on how to customize the Template policy, please see <xref href="tadminnetservcustom.dita"></xref>.
-The following example is a copy of the Basic policy: </p>
+the Network Server's impulse to install a default policy. For details, see
+<xref href="tadminnetservopen.dita#tadminnetservopen"></xref>.</p>
+<p> Note that the Network Server attempts to install a security manager only if
+you boot the server as the entry point of your VM. The Network Server will not
+attempt to install a security manager if you start the server from your
+application using the programmatic API described in
+<xref href="tadminconfig814963.dita#tadminconfig814963"></xref>.</p>
+<p>You will find a template security policy in the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> distribution at
+<codeph>demo/templates/server.policy</codeph>. Most likely, you will want to
+customize this policy. For example, probably you will want to restrict the
+server's liberal file i/o permissions which let the server backup/restore and
+export/import to or from any location in the local file system. For details on
+how to customize the Template policy, see
+<xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref>. The following
+example is a copy of the Basic policy:</p>
<codeblock>// This template policy file gives examples of how to configure the
-// permissions needed to run a Derby network server with the Java
+// permissions needed to run a <ph conref="../conrefs.dita#prod/productshortname"></ph> network server with the Java
// Security manager.
//
grant codeBase "${derby.install.url}derby.jar"
{
- // These permissions are needed for everyday, embedded Derby usage.
+ // These permissions are needed for everyday, embedded <ph conref="../conrefs.dita#prod/productshortname"></ph> usage.
//
permission java.lang.RuntimePermission "createClassLoader";
permission java.util.PropertyPermission "derby.*", "read";
@@ -100,9 +104,9 @@ grant codeBase "${derby.install.url}derb
//
permission javax.management.MBeanServerPermission "createMBeanServer";
//
- // Allows access to Derby's built-in MBeans, within the domain
+ // Allows access to <ph conref="../conrefs.dita#prod/productshortname"></ph>'s built-in MBeans, within the domain
// org.apache.derby.
- // Derby must be allowed to register and unregister these MBeans.
+ // <ph conref="../conrefs.dita#prod/productshortname"></ph> must be allowed to register and unregister these MBeans.
// It is possible to allow access only to specific MBeans, attributes
// or operations. To fine tune this permission, see the javadoc of
// javax.management.MBeanPermission or the JMX Instrumentation and
@@ -112,7 +116,7 @@ grant codeBase "${derby.install.url}derb
"org.apache.derby.*#[org.apache.derby:*]",
"registerMBean,unregisterMBean";
//
- // Trusts Derby code to be a source of MBeans and to register these in
+ // Trusts <ph conref="../conrefs.dita#prod/productshortname"></ph> code to be a source of MBeans and to register these in
// the MBean server.
//
permission javax.management.MBeanTrustPermission "register";
@@ -139,7 +143,7 @@ grant codeBase "${derby.install.url}derb
// This permission lets the Network Server manage connections from
// clients.
- // Accept connections from any host. Derby is listening to the host
+ // Accept connections from any host. <ph conref="../conrefs.dita#prod/productshortname"></ph> is listening to the host
// interface specified via the -h option to "NetworkServerControl
// start" on the command line, via the address parameter to the
// org.apache.derby.drda.NetworkServerControl constructor in the API
@@ -177,7 +181,7 @@ grant codeBase "${derby.install.url}derb
// sysinfo classes. If that is not the case, then you will want
// to grant this block of permissions to the first jar file
// in your classpath which contains the sysinfo classes.
- // Those classes are bundled into the following Derby
+ // Those classes are bundled into the following <ph conref="../conrefs.dita#prod/productshortname"></ph>
// jar files:
//
// derbynet.jar
Modified: db/derby/docs/trunk/src/adminguide/tadminnetservcustom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservcustom.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservcustom.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservcustom.dita Mon Nov 11 14:37:26 2013
@@ -20,51 +20,54 @@ limitations under the License.
-->
<task id="tadminnetservcustom" xml:lang="en-us">
<title>Customizing the Network Server's security policy</title>
+<shortdesc>You will probably want to customize the Network Server's Basic
+security policy.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>custom policy</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p> The Network Server's Basic security policy is documented in
-the section <xref href="tadminnetservbasic.dita"></xref>. Most likely, you
-will want to customize your own security policy. For example, you might want
-to restrict the server's liberal file I/O permissions, which let the server
-backup/restore and export/import to or from any location in the local file
-system. Customizing the security policy is simple: </p>
+<context><p>The Network Server's Basic security policy is documented in
+<xref href="tadminnetservbasic.dita#tadminnetservbasic"></xref>.</p>
+<p>For example, you might want to restrict the server's liberal file I/O
+permissions, which let the server backup/restore and export/import to or from
+any location in the local file system. Customizing the security policy is
+simple:</p>
<ol>
<li>A template policy lives in the
<ph conref="../conrefs.dita#prod/productshortname"></ph> distribution at
-<i>demo/templates/server.policy</i>.
-Copy the file from this location to your own file, say <i>myCustomized.policy</i>.
-All of the following edits take place in your custom file.</li>
-<li>Replace the <i>${derby.install.url}</i> variable with the location of
-the <ph conref="../conrefs.dita#prod/productshortname"></ph> jars in your local
-file system.</li>
-<li>Replace the <i>${derby.system.home}</i> variable with the location of
-your <ph conref="../conrefs.dita#prod/productshortname"></ph> system directory.
-Alternatively, rather than replacing this variable, you can simply set the value
-of the <i>derby.system.home</i> system property when you boot the server.</li>
-<li>Replace the <i>${derby.drda.traceDirectory}</i> variable with the location
-of your server trace file if you plan to use tracing.</li>
-<li>Grant <i>java.net.SocketPermission</i> to <codeph>derby.jar</codeph> if you
-are using LDAP authentication, so that the
+<codeph>demo/templates/server.policy</codeph>. Copy the file from this location
+to your own file, say <codeph>myCustomized.policy</codeph>. All of the following
+edits take place in your custom file.</li>
+<li>Replace the <codeph>${derby.install.url}</codeph> variable with the location
+of the <ph conref="../conrefs.dita#prod/productshortname"></ph> jars in your
+local file system.</li>
+<li>Replace the <codeph>${derby.system.home}</codeph> variable with the location
+of your <ph conref="../conrefs.dita#prod/productshortname"></ph> system
+directory. Alternatively, rather than replacing this variable, you can simply
+set the value of the <codeph>derby.system.home</codeph> system property when you
+boot the server.</li>
+<li>Replace the <codeph>${derby.drda.traceDirectory}</codeph> variable with the
+location of your server trace file if you plan to use tracing.</li>
+<li>Grant <codeph>java.net.SocketPermission</codeph> to
+<codeph>derby.jar</codeph> if you are using LDAP authentication, so that the
<ph conref="../conrefs.dita#prod/productshortname"></ph> code is allowed to
contact the LDAP server to perform the authentication.</li>
-<li>You may want to restrict the socket permission for <codeph>derbynet.jar</codeph>,
-which by default accepts connections from any host (<codeph>"*"</codeph>).
-Note that the special wildcard address <codeph>"0.0.0.0"</codeph> is not
-understood by SocketPermission, even though
+<li>You may want to restrict the socket permission for
+<codeph>derbynet.jar</codeph>, which by default accepts connections from any
+host (<codeph>"*"</codeph>). Note that the special wildcard address
+<codeph>"0.0.0.0"</codeph> is not understood by
+<codeph>SocketPermission</codeph>, even though
<ph conref="../conrefs.dita#prod/productshortname"></ph> accepts this wildcard
as a valid value for accepting connections on all network interfaces
(IPv4).</li>
<li>Refine the file permissions needed by backup/restore, import/export, and
the loading of application jars.</li>
</ol>
-<p>The following example is a copy of a sample customized policy file: </p>
- <codeblock>
-grant codeBase "file:/usr/local/share/sw/derby/lib/derby.jar"
+<p>The following is a sample customized policy file:</p>
+<codeblock>grant codeBase "file:/usr/local/share/sw/derby/lib/derby.jar"
{
- // These permissions are needed for everyday, embedded Derby usage.
+ // These permissions are needed for everyday, embedded <ph conref="../conrefs.dita#prod/productshortname"></ph> usage.
//
permission java.lang.RuntimePermission "createClassLoader";
permission java.util.PropertyPermission "derby.*", "read";
@@ -129,8 +132,8 @@ grant codeBase "file:/usr/local/share/sw
// permission javax.management.MBeanServerPermission
// "createMBeanServer";
//
- // Allows access to Derby's built-in MBeans, within the domain
- // org.apache.derby. Derby must be allowed to register and unregister
+ // Allows access to <ph conref="../conrefs.dita#prod/productshortname"></ph>'s built-in MBeans, within the domain
+ // org.apache.derby. <ph conref="../conrefs.dita#prod/productshortname"></ph> must be allowed to register and unregister
// these MBeans. It is possible to allow access only to specific
// MBeans, attributes or operations. To fine-tune this permission, see
// the API documentation for javax.management.MBeanPermission or the
@@ -140,7 +143,7 @@ grant codeBase "file:/usr/local/share/sw
// "org.apache.derby.*#[org.apache.derby:*]",
// "registerMBean, unregisterMBean";
//
- // Trusts Derby code to be a source of MBeans and to register these
+ // Trusts <ph conref="../conrefs.dita#prod/productshortname"></ph> code to be a source of MBeans and to register these
// in the MBean server:
//
// permission javax.management.MBeanTrustPermission "register";
@@ -208,7 +211,7 @@ grant codeBase "file:/usr/local/share/sw
// classpath which contains the sysinfo classes. If that is not the
// case, then you will want to grant this block of permissions to
// the first jar file in your classpath which contains the sysinfo
- // classes. Those classes are bundled into the following Derby jar
+ // classes. Those classes are bundled into the following <ph conref="../conrefs.dita#prod/productshortname"></ph> jar
// files:
//
// derbynet.jar
@@ -226,12 +229,12 @@ grant codeBase "file:/usr/local/share/sw
"/usr/local/shoppingCartApp/jars/-", "read";
permission java.io.FilePer mission "java.runtime.version", "read";
permission java.io.FilePermission "java.fullversion", "read";
-};
-</codeblock> <p> After customizing the Basic policy, you may bring up the
-Network Server as follows: </p> <codeblock>
-java -Djava.security.manager \
+};</codeblock>
+<p> After customizing the Basic policy, you may bring up the Network Server as
+follows:</p>
+<codeblock><b>java -Djava.security.manager \
-Djava.security.policy=/usr/local/shoppingCartApp/lib/myCustomized.policy \
-org.apache.derby.drda.NetworkServerControl start -h localhost
-</codeblock> </context>
+org.apache.derby.drda.NetworkServerControl start -h localhost</b></codeblock>
+</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminnetservopen.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservopen.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservopen.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservopen.dita Mon Nov 11 14:37:26 2013
@@ -20,33 +20,23 @@ limitations under the License.
-->
<task id="tadminnetservopen" xml:lang="en-us">
<title>Running the Network Server without a security policy</title>
+<shortdesc>You may override the Network Server's impulse to install a security
+manager if, for some reason, you need to run your application outside
+Java's security protections.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>no security manager</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
<context>
-<p>
-You may override the Network Server's impulse to install a security
-manager if, for some reason, you need to run your application outside
-Java's security protections.
-</p>
-
-<note othertype="" type="caution">
-You incur a severe security risk by opening
-up the server to all clients without limiting access via user
-authentication and a security policy.
-</note>
-
-<p>
-Use the <i>-noSecurityManager</i> option to force the Network Server
-to come up without a security manager. E.g.:
+<note othertype="" type="caution">You incur a severe security risk by opening
+up the server to all clients without limiting access via user authentication and
+a security policy.</note>
+<p>Use the <codeph>-noSecurityManager</codeph> option to force the Network
+Server to come up without a security manager. For example:
</p>
-
-<codeblock>
-java org.apache.derby.drda.NetworkServerControl start -h localhost -noSecurityManager
-</codeblock>
-
+<codeblock><b>java org.apache.derby.drda.NetworkServerControl start \
+ -h localhost -noSecurityManager</b></codeblock>
</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminnetservrun.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservrun.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservrun.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservrun.dita Mon Nov 11 14:37:26 2013
@@ -20,18 +20,17 @@ limitations under the License.
-->
<task id="tadminnetservrun" xml:lang="en-us">
<title>Running the Network Server under the security manager</title>
+<shortdesc>By default, the Network Server boots with a Basic security policy.
+You are encouraged to customize this policy to fit the security needs of your
+application and its runtime environment.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>running under security manager</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
<context>
-<p>
-By default, the Network Server boots with a Basic security policy. You
-are encouraged to customize this policy to fit the security needs of
-your application and its runtime environment. You may also run the
-Network Server without a security manager, although this is not recommended.
-</p>
+<p>You may also run the Network Server without a security manager, although this
+is not recommended.</p>
</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita Mon Nov 11 14:37:26 2013
@@ -19,20 +19,18 @@ See the License for the specific languag
limitations under the License.
-->
<task id="tadminnetservusrauth" xml:lang="en-us">
-<title>Running the Network Server with User Authentication</title>
+<title>Running the Network Server with user authentication</title>
+<shortdesc>By default, the Network Server boots with user authentication
+disabled. However, it is strongly recommended that you run your Network Server
+with user authentication enabled.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>running with user authentication</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
<context>
-<p>
-By default, the Network Server boots with user
-authentication disabled. However, it is strongly recommended that you run your Network Server with user
-authentication enabled. For details on how to enable user authentication,
-please see "Working with user authentication" in the
-<ph conref="../conrefs.dita#pub/citdevelop"/>.
-</p>
+<p>For details on how to enable user authentication, see "Working with user
+authentication" in the <ph conref="../conrefs.dita#pub/citdevelop"/>.</p>
</context>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminovclirun.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminovclirun.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminovclirun.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminovclirun.dita Mon Nov 11 14:37:26 2013
@@ -19,22 +19,32 @@ limitations under the License.
-->
<task id="tadminovclirun" xml:lang="en-us">
<title>Running the SimpleNetworkClientSample program</title>
+<shortdesc>To connect to the Network Server that has been started with the
+<codeph>SimpleNetworkServerSample</codeph> program, follow these
+steps.</shortdesc>
<taskbody>
-<context> <p>To connect to the Network Server that has been started with the
-SimpleNetworkServerSample program: </p></context>
<steps>
-<step><cmd>Open a command prompt and change directories to the%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\nserverdemo
-directory, where %<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%
-is the directory where you installed <ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
+<step><cmd>Open a command prompt and change directories to the
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\nserverdemo</codeph>
+directory, where
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%</codeph>
+is the directory where you installed
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
</step>
-<step><cmd>Set the classpath to include the following jar files: </cmd><info><ul>
+<step><cmd>Set the classpath to include the following jar files:</cmd>
+<info><ul>
<li>The current directory (".")</li>
-<li>derbyclient.jar</li>
+<li><codeph>derbyclient.jar</codeph></li>
</ul></info></step>
-<step><cmd>After you set up your environment correctly, run the SimpleNetworkClientSample
-program from the same directory: </cmd><stepxmp><codeblock>java SimpleNetworkClientSample</codeblock></stepxmp>
+<step><cmd>After you set up your environment correctly, run the
+<codeph>SimpleNetworkServerSample</codeph> program from the same
+directory:</cmd>
+<stepxmp>
+<codeblock><b>java SimpleNetworkClientSample</b></codeblock>
+</stepxmp>
<stepresult>If the program runs successfully, you will receive output similar
-to that shown in the following example: <codeblock>Starting Sample client program
+to that shown in the following example:
+<codeblock>Starting Sample client program
Got a client connection via the DriverManager.
connection from datasource;
Got a client connection via a DataSource.
Modified: db/derby/docs/trunk/src/adminguide/tadminovnsrundemo.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminovnsrundemo.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminovnsrundemo.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminovnsrundemo.dita Mon Nov 11 14:37:26 2013
@@ -19,40 +19,54 @@ limitations under the License.
-->
<task id="tadminovnsrundemo" xml:lang="en-us">
<title>Running the NsSample sample program</title>
+<shortdesc>To run the <codeph>NsSample</codeph> program, follow these
+steps.</shortdesc>
<taskbody>
-<context> <p>To run the NsSample program: </p> </context>
<steps>
-<step><cmd>Open a command prompt and change directories to the %<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\
-directory, where %<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%
-is the directory where you installed <ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
+<step><cmd>Open a command prompt and change to the
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\</codeph>
+directory, where
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%</codeph> is
+the directory where you installed
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
</step>
-<step><cmd>Set the CLASSPATH to the current directory (".") and also include
+<step><cmd>Set the CLASSPATH to the current directory ("."), and also include
the following jar files in order to use the Network Server and the network
-client driver:</cmd><info><dl><dlentry>
-<dt>derbynet.jar</dt>
+client driver:</cmd>
+<info><dl><dlentry>
+<dt><codeph>derbynet.jar</codeph></dt>
<dd>The Network Server jar file. It must be in your CLASSPATH to use any of
the Network Server functions.</dd>
</dlentry><dlentry>
-<dt>derbyclient.jar</dt>
-<dd>This jar file must be in your CLASSPATH to use the Network Client driver.</dd>
+<dt><codeph>derbyclient.jar</codeph></dt>
+<dd>This jar file must be in your CLASSPATH to use the Network Client
+driver.</dd>
</dlentry><dlentry>
-<dt>derby.jar</dt>
+<dt><codeph>derby.jar</codeph></dt>
<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> database
engine jar file.</dd>
</dlentry><dlentry>
-<dt>derbytools.jar</dt>
+<dt><codeph>derbytools.jar</codeph></dt>
<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools jar
file.</dd>
</dlentry></dl></info></step>
-<step><cmd>Test the CLASSPATH settings by running the following Java command:</cmd>
-<stepxmp><codeblock> java org.apache.derby.tools.sysinfo</codeblock></stepxmp>
-<stepresult>This command shows the <ph conref="../conrefs.dita#prod/productshortname"></ph> jar
-files that are in the classpath as well as their respective versions.</stepresult>
+<step><cmd>Test the CLASSPATH settings by running the following Java
+command:</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.tools.sysinfo</b></codeblock>
+</stepxmp>
+<stepresult>This command shows the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files that are in
+the classpath as well as their respective versions.</stepresult>
</step>
-<step><cmd>After you set up your environment correctly, run the NsSample program
-from the same directory: </cmd><stepxmp><codeblock>java nserverdemo.NsSample</codeblock></stepxmp>
+<step><cmd>After you set up your environment correctly, run the
+<codeph>NsSample</codeph> program from the same directory:</cmd>
+<stepxmp>
+<codeblock><b>java nserverdemo.NsSample</b></codeblock>
+</stepxmp>
<stepresult>If the program runs successfully, you will receive output similar
-to that shown in the following table:<codeblock><ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server created
+to the following:
+<codeblock><ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server created
Server is ready to accept connections on port 1621.
Connection number: 1.
[NsSample] <ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server started.
@@ -96,14 +110,15 @@ Connection number: 4.
Shutdown successful.
</codeblock></stepresult></step>
</steps>
-<result>Running the <i>NsSample</i> program also creates the following new
-directories and files:<dl><dlentry>
-<dt>NSSampledb</dt>
-<dd>This directory makes up the <i>NSSampledb</i> database.</dd>
+<result>Running the <codeph>NsSample</codeph> program also creates the following
+new directory and file:<dl><dlentry>
+<dt><codeph>NSSampledb</codeph></dt>
+<dd>This directory makes up the <codeph>NSSampledb</codeph> database.</dd>
</dlentry><dlentry>
-<dt>derby.log </dt>
-<dd>This log file contains <ph conref="../conrefs.dita#prod/productshortname"></ph> progress
-and error messages.</dd>
+<dt><codeph>derby.log</codeph></dt>
+<dd>This log file contains
+<ph conref="../conrefs.dita#prod/productshortname"></ph> progress and error
+messages.</dd>
</dlentry></dl></result>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminovrunsrvprgm.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminovrunsrvprgm.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminovrunsrvprgm.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminovrunsrvprgm.dita Mon Nov 11 14:37:26 2013
@@ -19,35 +19,48 @@ limitations under the License.
-->
<task id="tadminovrunsrvprgm" xml:lang="en-us">
<title>Running the SimpleNetworkServerSample program</title>
+<shortdesc>To run the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+Network Server sample program, follow these steps.</shortdesc>
<taskbody>
-<context> <p>To run the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
-Server sample program: </p> </context>
<steps>
-<step><cmd>Open a command prompt and change directories to the %<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\nserverdemo
-directory, where %<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%
-is the directory where you installed <ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
+<step><cmd>Open a command prompt and change directories to the
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%\demo\nserverdemo</codeph>
+directory, where
+<codeph>%<ph conref="../conrefs.dita#prod/productinstallpath"></ph>%</codeph>
+is the directory where you installed
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</cmd>
</step>
-<step><cmd>Set the classpath to include the current directory ("."), and the
-following jar files: </cmd><info><dl><dlentry>
-<dt>derbynet.jar</dt>
-<dd>The Network Server jar file. It must be in your CLASSPATH because you
-start the Network Server in this program.</dd>
+<step><cmd>Set the classpath to include the current directory (".") and the
+following jar files:</cmd>
+<info><dl><dlentry>
+<dt><codeph>derbynet.jar</codeph></dt>
+<dd>The Network Server jar file. It must be in your CLASSPATH because you start
+the Network Server in this program.</dd>
</dlentry><dlentry>
-<dt>derby.jar</dt>
+<dt><codeph>derby.jar</codeph></dt>
<dd>The database engine jar file.</dd>
</dlentry><dlentry>
-<dt>derbytools.jar</dt>
+<dt><codeph>derbytools.jar</codeph></dt>
<dd>The <ph conref="../conrefs.dita#prod/productshortname"></ph> tools jar
file.</dd>
</dlentry></dl></info></step>
-<step><cmd>Test the CLASSPATH settings by running the following Java command:
- </cmd><stepxmp><codeblock>java org.apache.derby.tools.sysinfo</codeblock></stepxmp>
-<stepresult>This command displays the <ph conref="../conrefs.dita#prod/productshortname"></ph> jar
-files that are in the classpath.</stepresult></step>
-<step><cmd>After you set up your environment correctly, run the SimpleNetworkServerSample
-program from the same directory: </cmd><stepxmp><codeblock>java SimpleNetworkServerSample</codeblock></stepxmp>
+<step><cmd>Test the CLASSPATH settings by running the following Java
+command:</cmd>
+<stepxmp>
+<codeblock><b>java org.apache.derby.tools.sysinfo</b></codeblock>
+</stepxmp>
+<stepresult>This command displays the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> jar files that are in
+the classpath.</stepresult></step>
+<step><cmd>After you set up your environment correctly, run the
+<codeph>SimpleNetworkServerSample</codeph> program from the same
+directory:</cmd>
+<stepxmp>
+<codeblock><b>java SimpleNetworkServerSample</b></codeblock>
+</stepxmp>
<stepresult>If the program runs successfully, you will receive output that
-is similar to that shown in the following exampleS: <codeblock>Starting Network Server
+is similar to that shown in the following example:
+<codeblock>Starting Network Server
Testing if Network Server is up and running!
<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server now running
Got an embedded connection.
@@ -62,14 +75,16 @@ While my app is busy with embedded work,
Clients can continue to connect:
Press [Enter] to stop Server</codeblock></stepresult></step>
</steps>
-<result><p>Running the SimpleNetworkServerSample program also creates the
-following new directories and files: <dl><dlentry>
-<dt>NSSimpleDB</dt>
-<dd>This directory makes up the NSSimpleDB database.</dd>
+<result><p>Running the <codeph>SimpleNetworkServerSample</codeph> program also
+creates the following new directory and file:
+<dl><dlentry>
+<dt><codeph>NSSimpleDB</codeph></dt>
+<dd>This directory makes up the <codeph>NSSimpleDB</codeph> database.</dd>
</dlentry><dlentry>
-<dt>derby.log</dt>
-<dd>This log file contains <ph conref="../conrefs.dita#prod/productshortname"></ph> progress
-and error messages.</dd>
+<dt><codeph>derby.log</codeph></dt>
+<dd>This log file contains
+<ph conref="../conrefs.dita#prod/productshortname"></ph> progress and error
+messages.</dd>
</dlentry></dl></p></result>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita?rev=1540743&r1=1540742&r2=1540743&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita Mon Nov 11 14:37:26 2013
@@ -19,13 +19,13 @@ limitations under the License.
-->
<task id="tadmintracefacility" xml:lang="en-us">
<title>Controlling tracing by using the trace facility</title>
+<shortdesc>Use the trace facility only if you are working with technical
+support and they require tracing information.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Network Server<indexterm>trace facility</indexterm></indexterm>
<indexterm>Trace facility<indexterm>for the Network Server</indexterm></indexterm>
</keywords>
</metadata></prolog>
<taskbody>
-<context> <p>Use the trace facility only if you are working with technical
-support and they require tracing information.</p> </context>
</taskbody>
</task>