man-windows-service.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2013-2015 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
<info>
<copyright>
<year>2013-2015</year>
<holder>ForgeRock AS.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>windows-service</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version">${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>
</screen>
<para>
After running this command,
you can manage the service using Windows administration tools.
</para>
</refsect1>
</refentry>