From db1f00b67632d5a638f0b30129d547db9338059b Mon Sep 17 00:00:00 2001
From: Ludovic Poitou <ludovic.poitou@forgerock.com>
Date: Thu, 20 Oct 2011 15:57:55 +0000
Subject: [PATCH] Fix OpenDJ-222: Remove more references to OpenDS. Also update/adds the man-pages for tools.
---
opends/resource/man/man1/control-panel.1 | 212 +++++++++++++++++++++++++++++++++++++---------------
1 files changed, 151 insertions(+), 61 deletions(-)
diff --git a/opends/resource/man/man1/control-panel.1 b/opends/resource/man/man1/control-panel.1
index b40e7a6..b0372a6 100644
--- a/opends/resource/man/man1/control-panel.1
+++ b/opends/resource/man/man1/control-panel.1
@@ -1,67 +1,157 @@
-'\" te
-.\" Copyright (c) 2008, Sun Microsystems Inc. All
-.\" Rights Reserved.
-.TH control-panel 1 "December 2008" "1.1" "User Commands"
-.SH NAME
-control-panel \- launches a graphical user interface
-that displays server status information and enables you to perform basic directory
-server administration
-.SH SYNOPSIS
-.LP
+'\" t
+.\" Title: control-panel
+.\" Author: Mark Craig
+.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: October\ \&20,\ \&2011
+.\" Manual: Tools Reference
+.\" Source: OpenDJ 2.5.0
+.\" Language: English
+.\"
+.TH "CONTROL\-PANEL" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+control-panel \- start the OpenDJ graphical admin interface
+.SH "SYNOPSIS"
+.HP \w'\fBcontrol\-panel\fR\ 'u
+\fBcontrol\-panel\fR {options}
+.SH "DESCRIPTION"
+.PP
+This utility can be used to display the Control Panel window which displays basic server information and allows to do some basic administration tasks on the server\&.
+.SH "OPTIONS"
+.PP
+The following options are supported\&.
+.PP
+\fB\-r, \-\-remote\fR
+.RS 4
+Connect to a remote server
+.RE
+.SS "LDAP Connection Options"
+.PP
+\fB\-\-connectTimeout {timeout}\fR
+.RS 4
+Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
+.sp
+Default value: 30000
+.RE
+.PP
+\fB\-D, \-\-bindDN {bindDN}\fR
+.RS 4
+DN to use to bind to the server
+.sp
+Default value: cn=Directory Manager
+.RE
+.PP
+\fB\-h, \-\-hostname {host}\fR
+.RS 4
+Directory server hostname or IP address
+.sp
+Default value: localhost\&.localdomain
+.RE
+.PP
+\fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR
+.RS 4
+Global administrator password file
+.RE
+.PP
+\fB\-p, \-\-port {port}\fR
+.RS 4
+Directory server administration port number
+.sp
+Default value: 4444
+.RE
+.PP
+\fB\-w, \-\-adminPassword {bindPassword}\fR
+.RS 4
+Password for the global administrator
+.RE
+.PP
+\fB\-X, \-\-trustAll\fR
+.RS 4
+Trust all server SSL certificates
+.RE
+.SS "General Options"
+.PP
+\fB\-\-version\fR
+.RS 4
+Display version information
+.RE
+.PP
+\fB\-?, \-H, \-\-help\fR
+.RS 4
+Display usage information
+.RE
+.SH "EXIT CODES"
+.PP
+0
+.RS 4
+The command completed successfully\&.
+.RE
+.PP
+> 0
+.RS 4
+An error occurred\&.
+.RE
+.SH "EXAMPLES"
+.PP
+The following example starts the Control Panel on a remote host\&.
+.sp
+.if n \{\
+.RS 4
+.\}
.nf
-\fBcontrol-panel\fR \fIoptions\fR
+$ control\-panel \-r \-h opendj\&.example\&.com \-p 4444 &
.fi
-
-.SH DESCRIPTION
-.sp
-.LP
-The \fBcontrol-panel\fR command launches a graphical user
-interface that displays server status information and enables you to perform
-basic directory server administration. The control panel enables you to perform
-certain data management tasks such as managing entries, importing and exporting
-data, and backing up and restoring data. The control panel also enables you
-to manage directory schema and indexes, and to set server runtime options.
-.SH OPTIONS
-.sp
-.LP
-The following options are supported:
-.sp
-.ne 2
-.mk
-.na
-\fB\fB-V\fR, \fB--version\fR\fR
-.ad
-.RS 18n
-.rt
-Display Directory Server version information.
+.if n \{\
.RE
-
-.sp
-.ne 2
-.mk
-.na
-\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
-.ad
-.RS 18n
-.rt
-Displays usage information.
+.\}
+.SH "AUTHORS"
+.PP
+\fBMark Craig\fR
+.RS 4
+Author.
.RE
-
-.SH ATTRIBUTES
+.PP
+\fBNemanja Lukić\fR
+.RS 4
+Author.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2011 ForgeRock AS
+.br
.sp
-.LP
-See \fBattributes\fR(5) for
-descriptions of the following attributes:
+.RS 4
+[IMAGE]
+.PP
+This work is licensed under the
+\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
+.RE
+.PP
+To view a copy of this license, visit
+http://creativecommons.org/licenses/by-nc-nd/3.0/
+or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
+.PP
+Trademarks are the property of their respective owners.
+.PP
+UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+.PP
+EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp
-
-.sp
-.TS
-tab() box;
-cw(2.75i) |cw(2.75i)
-lw(2.75i) |lw(2.75i)
-.
-ATTRIBUTE TYPEATTRIBUTE VALUE
-_
-Interface StabilityUncommitted
-.TE
-
--
Gitblit v1.10.0