From 2386bcc06f34586119cafb7e5d3fa2a9c39a627f Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 16 Jul 2013 14:00:23 +0000
Subject: [PATCH] CR-2007 Fix for OPENDJ-1047: Create a reference entry for windows-service.bat
---
opends/src/main/docbkx/admin-guide/index.xml | 1
opends/src/main/docbkx/admin-guide/man-windows-service.xml | 143 +++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 144 insertions(+), 0 deletions(-)
diff --git a/opends/src/main/docbkx/admin-guide/index.xml b/opends/src/main/docbkx/admin-guide/index.xml
index 4c9afe9..32152fe 100644
--- a/opends/src/main/docbkx/admin-guide/index.xml
+++ b/opends/src/main/docbkx/admin-guide/index.xml
@@ -136,6 +136,7 @@
<xinclude:include href='man-uninstall.xml' />
<xinclude:include href='man-upgrade.xml' />
<xinclude:include href='man-verify-index.xml' />
+ <xinclude:include href='man-windows-service.xml' />
</reference>
<xinclude:include href="../shared/glossary.xml" />
diff --git a/opends/src/main/docbkx/admin-guide/man-windows-service.xml b/opends/src/main/docbkx/admin-guide/man-windows-service.xml
new file mode 100644
index 0000000..cc97d51
--- /dev/null
+++ b/opends/src/main/docbkx/admin-guide/man-windows-service.xml
@@ -0,0 +1,143 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2013 ForgeRock AS
+ !
+-->
+<refentry xml:id='windows-service'
+ xmlns='http://docbook.org/ns/docbook'
+ version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xlink='http://www.w3.org/1999/xlink'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ <info><copyright><year>2013</year><holder>ForgeRock AS</holder></copyright></info>
+ <refmeta>
+ <refentrytitle>windows-service</refentrytitle><manvolnum>1</manvolnum>
+ <refmiscinfo class="software">OpenDJ</refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>windows-service</refname>
+ <refpurpose>register OpenDJ as a Windows Service</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>windows-service</command>
+ <arg choice="req">options</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>This utility can be used to run OpenDJ directory server as a Windows
+ Service.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Service Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-c, --cleanupService <replaceable>serviceName</replaceable></option></term>
+ <listitem>
+ <para>Disable the service and clean up the windows registry information
+ associated with the provided service name</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-d, --disableService</option></term>
+ <listitem>
+ <para>Disable the server as a Windows service and stop the server</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-e, --enableService</option></term>
+ <listitem>
+ <para>Enable the server as a Windows service</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s, --serviceState</option></term>
+ <listitem>
+ <para>Provide information about the state of the server as a Windows
+ service</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>General Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-V, --version</option></term>
+ <listitem>
+ <para>Display version information</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-?, -H, --help</option></term>
+ <listitem>
+ <para>Display usage information</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Exit Codes</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+ <para>The command completed successfully.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>> 0</term>
+ <listitem>
+ <para>An error occurred.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
+
+ <para>The following command registers OpenDJ directory server as a Windows
+ Service.</para>
+
+ <screen>C:\path\to\opendj\bat> windows-service.bat --enableService</screen>
+
+ <para>After running this command, you can manage the service using Windows
+ administration tools</para>
+ </refsect1>
+</refentry>
--
Gitblit v1.10.0