0N/A<?xml version="1.0" encoding="UTF-8"?>
2362N/A<!--
0N/A ! CCPL HEADER START
0N/A !
0N/A ! This work is licensed under the Creative Commons
0N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
0N/A ! To view a copy of this license, visit
0N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
0N/A ! or send a letter to Creative Commons, 444 Castro Street,
0N/A ! Suite 900, Mountain View, California, 94041, USA.
0N/A !
0N/A ! You can also obtain a copy of the license at
0N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
0N/A ! See the License for the specific language governing permissions
2362N/A ! and limitations under the License.
0N/A !
0N/A ! If applicable, add the following below this CCPL HEADER, with the fields
0N/A ! enclosed by brackets "[]" replaced with your own identifying information:
0N/A ! Portions Copyright [yyyy] [name of copyright owner]
0N/A !
0N/A ! CCPL HEADER END
0N/A !
0N/A ! Copyright 2013-2014 ForgeRock AS
0N/A !
0N/A-->
0N/A<refentry xml:id='windows-service'
0N/A xmlns='http://docbook.org/ns/docbook'
0N/A version='5.0' xml:lang='en'
0N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
0N/A xsi:schemaLocation='http://docbook.org/ns/docbook
0N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'>
0N/A <info><copyright><year>2013-2014</year><holder>ForgeRock AS</holder></copyright></info>
0N/A <refmeta>
0N/A <refentrytitle>windows-service</refentrytitle><manvolnum>1</manvolnum>
0N/A <refmiscinfo class="software">OpenDJ</refmiscinfo>
0N/A <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
0N/A </refmeta>
0N/A <refnamediv>
0N/A <refname>windows-service</refname>
0N/A <refpurpose>register OpenDJ as a Windows Service</refpurpose>
0N/A </refnamediv>
0N/A <refsynopsisdiv>
0N/A <cmdsynopsis>
0N/A <command>windows-service</command>
0N/A <arg choice="req">options</arg>
0N/A </cmdsynopsis>
0N/A </refsynopsisdiv>
0N/A
0N/A <refsect1>
0N/A <title>Description</title>
0N/A <para>This utility can be used to run OpenDJ directory server as a Windows
0N/A Service.</para>
0N/A </refsect1>
0N/A
0N/A <refsect1>
0N/A <title>Service Options</title>
0N/A
0N/A <variablelist>
0N/A <varlistentry>
0N/A <term><option>-c, --cleanupService <replaceable>serviceName</replaceable></option></term>
0N/A <listitem>
0N/A <para>Disable the service and clean up the windows registry information
0N/A associated with the provided service name</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term><option>-d, --disableService</option></term>
0N/A <listitem>
0N/A <para>Disable the server as a Windows service and stop the server</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term><option>-e, --enableService</option></term>
0N/A <listitem>
0N/A <para>Enable the server as a Windows service</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term><option>-s, --serviceState</option></term>
0N/A <listitem>
0N/A <para>Provide information about the state of the server as a Windows
0N/A service</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A </variablelist>
0N/A </refsect1>
0N/A
0N/A <refsect1>
0N/A <title>General Options</title>
0N/A
0N/A <variablelist>
0N/A <varlistentry>
0N/A <term><option>-V, --version</option></term>
0N/A <listitem>
0N/A <para>Display version information</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term><option>-?, -H, --help</option></term>
0N/A <listitem>
0N/A <para>Display usage information</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A </variablelist>
0N/A </refsect1>
0N/A
0N/A <refsect1>
0N/A <title>Exit Codes</title>
<variablelist>
<varlistentry>
<term>0</term>
<listitem>
<para>The command completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>&gt; 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> <userinput>windows-service.bat --enableService</userinput>
</screen>
<para>After running this command, you can manage the service using Windows
administration tools.</para>
</refsect1>
</refentry>