man-dsjavaproperties.xml revision ae57abea41b1a1c805fee27ffcfeabc0ae07e969
970N/A<?xml version="1.0" encoding="UTF-8"?>
970N/A<!--
1610N/A ! CCPL HEADER START
970N/A !
970N/A ! This work is licensed under the Creative Commons
970N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
970N/A ! To view a copy of this license, visit
970N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
970N/A ! or send a letter to Creative Commons, 444 Castro Street,
970N/A ! Suite 900, Mountain View, California, 94041, USA.
970N/A !
970N/A ! You can also obtain a copy of the license at
970N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
970N/A ! See the License for the specific language governing permissions
970N/A ! and limitations under the License.
970N/A !
970N/A ! If applicable, add the following below this CCPL HEADER, with the fields
970N/A ! enclosed by brackets "[]" replaced with your own identifying information:
970N/A ! Portions Copyright [yyyy] [name of copyright owner]
970N/A !
970N/A ! CCPL HEADER END
970N/A !
970N/A ! Copyright 2011-2014 ForgeRock AS
970N/A !
970N/A-->
970N/A<refentry xml:id='dsjavaproperties-1'
970N/A xmlns='http://docbook.org/ns/docbook'
970N/A version='5.0' xml:lang='en'
970N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
970N/A xsi:schemaLocation='http://docbook.org/ns/docbook
1356N/A http://docbook.org/xml/5.0/xsd/docbook.xsd'>
1356N/A <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
1392N/A <refmeta>
1356N/A <refentrytitle>dsjavaproperties</refentrytitle><manvolnum>1</manvolnum>
970N/A <refmiscinfo class="software">OpenDJ</refmiscinfo>
970N/A <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
970N/A </refmeta>
1018N/A <refnamediv>
1018N/A <refname>dsjavaproperties</refname>
1018N/A <refpurpose>apply OpenDJ Java home and JVM settings</refpurpose>
970N/A </refnamediv>
970N/A <refsynopsisdiv>
970N/A <cmdsynopsis>
970N/A <command>dsjavaproperties</command>
970N/A <arg choice="opt">options</arg>
970N/A </cmdsynopsis>
970N/A </refsynopsisdiv>
970N/A <refsect1>
970N/A <title>Description</title>
970N/A <para>This utility can be used to change the Java arguments and Java home
970N/A that are used by other server commands.</para>
970N/A <para>Before launching the command, edit the properties file located in
970N/A <filename>/path/to/opendj/config/java.properties</filename> to specify the
970N/A Java arguments and Java home. When you have edited the properties file, run
970N/A this command for the changes to be taken into account.</para>
970N/A <para>Changes apply to the current server installation. No modifications
970N/A are made to your environment variables.</para>
1356N/A </refsect1>
1356N/A <refsect1>
1356N/A <title>Options</title>
1356N/A <para>The following options are supported.</para>
970N/A <variablelist>
970N/A <varlistentry>
970N/A <term><option>-Q, --quiet</option></term>
970N/A <listitem>
970N/A <para>Run the tool in quiet mode. Quiet mode will not output progress
970N/A information to standard output.</para>
970N/A </listitem>
970N/A </varlistentry>
970N/A <varlistentry>
970N/A <term><option>-V, --version</option></term>
970N/A <listitem>
970N/A <para>Display version information.</para>
970N/A </listitem>
970N/A </varlistentry>
970N/A <varlistentry>
1610N/A <term><option>-?, -H, --help</option></term>
1610N/A <listitem>
970N/A <para>Display usage information.</para>
1529N/A </listitem>
970N/A </varlistentry>
970N/A </variablelist>
970N/A </refsect1>
1610N/A <refsect1>
970N/A <title>Files</title>
970N/A <para>This command depends on the content of the
970N/A <filename>config/java.properties</filename> file.</para>
970N/A </refsect1>
1610N/A <refsect1>
<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>Examples</title>
<screen>
$ <userinput>dsjavaproperties</userinput>
<computeroutput>The operation was successful. The server commands will use the java arguments
and java home specified in the properties file located in
/path/to/opendj/config/java.properties</computeroutput>
</screen>
</refsect1>
</refentry>