6331N/A<?xml version="1.0" encoding="UTF-8"?>
6331N/A<!--
6331N/A ! CCPL HEADER START
6331N/A !
6331N/A ! This work is licensed under the Creative Commons
6331N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6331N/A ! To view a copy of this license, visit
6331N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6331N/A ! or send a letter to Creative Commons, 444 Castro Street,
6331N/A ! Suite 900, Mountain View, California, 94041, USA.
6331N/A !
6331N/A ! You can also obtain a copy of the license at
6331N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6331N/A ! See the License for the specific language governing permissions
6331N/A ! and limitations under the License.
6331N/A !
6331N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6331N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6331N/A ! Portions Copyright [yyyy] [name of copyright owner]
6331N/A !
6331N/A ! CCPL HEADER END
6331N/A !
6331N/A ! Copyright 2011-2012 ForgeRock AS
6331N/A ! Portions Copyright 2013 Jens Elkner
6331N/A !
6331N/A-->
6331N/A<refentry xml:id='create-rc-script-1' xmlns='http://docbook.org/ns/docbook'
6331N/A version='5.0'
6331N/A xml:lang='en' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
6331N/A xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
6331N/A xmlns:xlink='http://www.w3.org/1999/xlink'
6331N/A xmlns:xi='http://www.w3.org/2001/XInclude'>
6331N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6331N/A <refmeta>
6331N/A <refentrytitle><application>create-rc-script</application></refentrytitle>
6331N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6331N/A </refmeta>
6331N/A <refnamediv>
6331N/A <refname>create-rc-script</refname>
6331N/A <refpurpose>script to manage OpenDJ as a service on UNIX</refpurpose>
6331N/A </refnamediv>
6331N/A <refsynopsisdiv>
6331N/A <cmdsynopsis>
6331N/A <command>create-rc-script</command>
6331N/A <arg>-f <replaceable class="parameter">file</replaceable></arg>
6331N/A <arg>-j <replaceable class="parameter">dir</replaceable></arg>
6331N/A <arg>-J <replaceable class="parameter">args</replaceable></arg>
6331N/A <arg>-u <replaceable class="parameter">username</replaceable></arg>
6331N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6331N/A </cmdsynopsis>
6331N/A </refsynopsisdiv>
6331N/A <refsection>
6331N/A <title>Description</title>
6331N/A <para>
6331N/ACreate an RC script that may be used to start, stop, and restart the directory
6331N/Aserver on UNIX-based systems.
6331N/A </para>
6331N/A </refsection>
6331N/A <refsection>
6331N/A <title>Options</title>
6331N/A <para>
6331N/AThe following options are supported.
6331N/A </para>
6331N/A <variablelist>
6331N/A <varlistentry>
6331N/A <term><option>-f, --outputFile</option> <replaceable
6331N/A class="parameter">file</replaceable></term>
6331N/A <listitem>
6331N/A <para>
6331N/AThe path to the output file to create.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6331N/A <varlistentry>
6331N/A <term><option>-j, --javaHome</option> <replaceable
6331N/A class="parameter">dir</replaceable> </term>
6331N/A <listitem>
6331N/A <para>
6331N/AThe path to the Java installation that should be used to run the server.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6331N/A <varlistentry>
6331N/A <term><option>-J, --javaArgs</option> <replaceable
6331N/A class="parameter">args</replaceable></term>
6331N/A <listitem>
6331N/A <para>
6331N/AA set of arguments that should be passed to the JVM when running the server.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6331N/A <varlistentry>
6331N/A <term><option>-u, --userName</option> <replaceable
6331N/A class="parameter">username</replaceable></term>
6331N/A <listitem>
6331N/A <para>
6331N/AThe name of the user account under which the server should run.
6331N/A </para>
6331N/A </listitem>
6331N/A </varlistentry>
6331N/A </variablelist>
6331N/A </refsection>
6331N/A <refsection>
6331N/A <title>General Options</title>
6331N/A <variablelist>
6331N/A <xi:include href="common.xml"
6331N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6331N/A </variablelist>
6331N/A </refsection>
6331N/A <refsection>
6331N/A <title>Examples</title>
6331N/A <informalexample>
6331N/A <para>
6331N/AThe following example adds a script to start OpenDJ at boot time on a
6331N/ADebian-based system, and then updates the runlevel system to use the script.
6331N/A </para>
6331N/A <literallayout><prompt
6331N/A>$ </prompt><command>sudo create-rc-script -f /etc/init.d/opendj -u mark</command>
6331N/A<prompt>$ </prompt><command>sudo update-rc.d opendj</command></literallayout>
6331N/A </informalexample>
6331N/A </refsection>
6331N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6331N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6331N/A</refentry>