man-create-rc-script.xml revision 51607ea01068c9047391e4c8b46bc9dbd0edb7fd
<?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
! 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
! 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 2011-2012 ForgeRock AS
!
-->
<refentry xml:id='create-rc-script-1'
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>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>create-rc-script</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>create-rc-script</refname>
<refpurpose>script to manage OpenDJ as a service on UNIX</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>create-rc-script</command>
<arg choice="req">options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>Create an RC script that may be used to start, stop, and restart
the directory server on UNIX-based systems.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are supported.</para>
<variablelist>
<varlistentry>
<term><option>-f, --outputFile {path}</option></term>
<listitem>
<para>The path to the output file to create.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-j, --javaHome {path}</option></term>
<listitem>
<para>The path to the Java installation that should be used to run
the server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-J, --javaArgs {args}</option></term>
<listitem>
<para>A set of arguments that should be passed to the JVM when running
the server.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-u, --userName {userName}</option></term>
<listitem>
<para>The name of the user account under which the server should
run.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>General Options</title>
<variablelist>
<varlistentry>
<term><option>--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>
</refsect2>
</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>Examples</title>
<para>The following example adds a script to start OpenDJ at boot time
on a Debian-based system, and then updates the runlevel system to use the
script.</para>
$ sudo update-rc.d opendj</screen>
</refsect1>
</refentry>