man-control-panel.xml revision 6330
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington<?xml version="1.0" encoding="UTF-8"?>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!--
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! CCPL HEADER START
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! This work is licensed under the Creative Commons
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! To view a copy of this license, visit
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! http://creativecommons.org/licenses/by-nc-nd/3.0/
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! or send a letter to Creative Commons, 444 Castro Street,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! Suite 900, Mountain View, California, 94041, USA.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! You can also obtain a copy of the license at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! See the License for the specific language governing permissions
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! If applicable, add the following below this CCPL HEADER, with the fields
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! enclosed by brackets "[]" replaced with your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! Portions Copyright [yyyy] [name of copyright owner]
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! CCPL HEADER END
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! Copyright 2011-2012 ForgeRock AS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster ! Portions Copyright 2013 Jens Elkner
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster !
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster-->
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington<refentry xml:id="control-panel-1" xmlns="http://docbook.org/ns/docbook"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster version="5.0" xml:lang="en"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xmlns:xlink="http://www.w3.org/1999/xlink"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xmlns:xi="http://www.w3.org/2001/XInclude">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refmeta>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refentrytitle><application>control-panel</application></refentrytitle>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refmeta>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refnamediv>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refname><application>control-panel</application></refname>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refpurpose>start the OpenDJ graphical admin interface</refpurpose>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refnamediv>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refsynopsisdiv>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <cmdsynopsis>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <command>control-panel</command>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <arg>-r</arg>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <sbr/><sbr/>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <xi:include href="common.xml"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xpointer='xpointer(//para[@name="s-remote"]/*)'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <sbr/><sbr/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xpointer='xpointer(//para[@name="s-auth"]/*[@name="sc-dn" or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster @name="sc-pw" or @name="sc-pf" or @name="sc-tAll"])'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <sbr/><sbr/>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <xi:include href="common.xml"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xpointer='xpointer(//para[@name="s-general"]/*)'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </cmdsynopsis>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsynopsisdiv>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refsection>
8d3140b524c0e28c0a49dc7c7d481123ef3cfe11Chris Lee <title>Description</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterThis utility can be used to display the Control Panel window which displays
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterbasic server information and allows to do some basic administration tasks on
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterthe server.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <title>Options</title>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <para>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames PhillpottsThe following options are supported.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <variablelist>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <varlistentry>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <term><option>-r, --remote</option></term>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <listitem>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterConnect to a remote server.
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts </para>
96b66a10984046afc14b24402275abec1f494977James Phillpotts </listitem>
96b66a10984046afc14b24402275abec1f494977James Phillpotts </varlistentry>
96b66a10984046afc14b24402275abec1f494977James Phillpotts </variablelist>
96b66a10984046afc14b24402275abec1f494977James Phillpotts <refsection>
96b66a10984046afc14b24402275abec1f494977James Phillpotts <title>LDAP Connection Options</title>
96b66a10984046afc14b24402275abec1f494977James Phillpotts <variablelist>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xpointer='xpointer(//para[@name="l-remote"]/*)'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml"
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts xpointer='xpointer(//para[@name="l-auth"]/*[@name="lc-dn" or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster @name="lc-pw" or @name="lc-pf" or @name="lc-tAll"])'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </variablelist>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <title>General Options</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <variablelist>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <xi:include href="common.xml"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster xpointer='xpointer(//para[@name="l-general"]/*)'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </variablelist>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <refsection>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <title>Examples</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <informalexample>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan FosterThe following example starts the Control Panel connected to a remote host.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </para>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <literallayout><prompt
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster>$ </prompt><command>control-panel -r -h opendj.example.com -p 4444</command></literallayout>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </informalexample>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </refsection>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
841c74db7cd13c0bb1805982c6b622d81b8ec5cbJames Phillpotts <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</refentry>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster