From 2dba9b9beb52a409bb9d3a5c947704008e8d724e Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 14 Feb 2012 08:11:56 +0000
Subject: [PATCH] Repair discrepancies noticed by Danny Turner
---
opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml | 87 ++++++++++++++---------------
opends/resource/man/man1/ldappasswordmodify.1 | 75 +++++++++++-------------
2 files changed, 77 insertions(+), 85 deletions(-)
diff --git a/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml b/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
index 6f9e680..21e94b8 100644
--- a/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
+++ b/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2012 ForgeRock AS
!
-->
<refentry xml:id='ldappasswordmodify-1'
@@ -30,7 +30,7 @@
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</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -70,6 +70,13 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-A, --provideDNForAuthzID</option></term>
+ <listitem>
+ <para>Use the bind DN as the authorization ID for the password modify
+ operation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-c, --currentPassword {currentPassword}</option></term>
<listitem>
<para>Current password for the target user</para>
@@ -82,12 +89,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-F, --newPasswordFile {file}</option></term>
- <listitem>
- <para>Path to a file containing the new password to provide for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
<listitem>
<para>Use a request control with the provided information</para>
@@ -98,12 +99,33 @@
<listitem>
<para>New password to provide for the target user</para>
</listitem>
- </varlistentry>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-N, --newPasswordFile {file}</option></term>
+ <listitem>
+ <para>Path to a file containing the new password to provide for the
+ target user</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<refsect2>
<title>LDAP Connection Options</title>
<variablelist>
<varlistentry>
+ <term><option>--certNickname {nickname}</option></term>
+ <listitem>
+ <para>Nickname of certificate for SSL client authentication</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--connectTimeout {timeout}</option></term>
+ <listitem>
+ <para>Maximum length of time (in milliseconds) that can be taken to
+ establish a connection. Use '0' to specify no time out.</para>
+ <para>Default: 30000</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-D, --bindDN {bindDN}</option></term>
<listitem>
<para>DN to use to bind to the server</para>
@@ -111,12 +133,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-h, --hostname {host}</option></term>
<listitem>
<para>Directory server hostname or IP address</para>
@@ -136,18 +152,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-p, --port {port}</option></term>
<listitem>
<para>Directory server port number</para>
@@ -167,7 +171,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
+ <term><option>--trustStorePassword {trustStorePassword}</option></term>
<listitem>
<para>Certificate trust store PIN</para>
</listitem>
@@ -185,19 +189,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-w, --bindPassword {bindPassword}</option></term>
<listitem>
<para>Password to use to bind to the server</para>
@@ -241,9 +232,15 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v, --verbose</option></term>
+ <term><option>-?, -H, --help</option></term>
<listitem>
- <para>Use verbose mode</para>
+ <para>Display usage information</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-V, --version</option></term>
+ <listitem>
+ <para>Display directory server version information</para>
</listitem>
</varlistentry>
</variablelist>
@@ -311,10 +308,10 @@
<title>Examples</title>
<para>The following example demonstrates a user changing the password
for her entry.</para>
- <screen>$ cat /tmp/currpwd.txt /tmp/newpwd.txt
+ <screen>$ cat /tmp/currpwd.txt /tmp/newpwd.txt
bribery
secret12
-$ ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -F /tmp/newpwd.txt
+$ ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt
-a "dn:uid=kvaughan,ou=people,dc=example,dc=com"
-D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
The LDAP password modify operation was successful</screen>
diff --git a/opends/resource/man/man1/ldappasswordmodify.1 b/opends/resource/man/man1/ldappasswordmodify.1
index 4795eec..d310384 100644
--- a/opends/resource/man/man1/ldappasswordmodify.1
+++ b/opends/resource/man/man1/ldappasswordmodify.1
@@ -2,12 +2,12 @@
.\" Title: ldappasswordmodify
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: November\ \&21,\ \&2011
+.\" Date: February\ \&14,\ \&2012
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.5.0
.\" Language: English
.\"
-.TH "LDAPPASSWORDMODIFY" "1" "November\ \&21,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "LDAPPASSWORDMODIFY" "1" "February\ \&14,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -54,6 +54,11 @@
u:bjensen\&.
.RE
.PP
+\fB\-A, \-\-provideDNForAuthzID\fR
+.RS 4
+Use the bind DN as the authorization ID for the password modify operation
+.RE
+.PP
\fB\-c, \-\-currentPassword {currentPassword}\fR
.RS 4
Current password for the target user
@@ -64,11 +69,6 @@
Path to a file containing the current password for the target user
.RE
.PP
-\fB\-F, \-\-newPasswordFile {file}\fR
-.RS 4
-Path to a file containing the new password to provide for the target user
-.RE
-.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
@@ -78,8 +78,25 @@
.RS 4
New password to provide for the target user
.RE
+.PP
+\fB\-N, \-\-newPasswordFile {file}\fR
+.RS 4
+Path to a file containing the new password to provide for the target user
+.RE
.SS "LDAP Connection Options"
.PP
+\fB\-\-certNickname {nickname}\fR
+.RS 4
+Nickname of certificate for SSL client authentication
+.RE
+.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: 30000
+.RE
+.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
@@ -87,11 +104,6 @@
Default value: cn=Directory Manager
.RE
.PP
-\fB\-E, \-\-reportAuthzID\fR
-.RS 4
-Use the authorization identity control
-.RE
-.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
@@ -109,16 +121,6 @@
Certificate key store path
.RE
.PP
-\fB\-N, \-\-certNickname {nickname}\fR
-.RS 4
-Nickname of certificate for SSL client authentication
-.RE
-.PP
-\fB\-o, \-\-saslOption {name=value}\fR
-.RS 4
-SASL bind options
-.RE
-.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
@@ -136,7 +138,7 @@
Use StartTLS to secure communication with the server
.RE
.PP
-\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
+\fB\-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
@@ -151,18 +153,6 @@
Certificate trust store PIN file
.RE
.PP
-\fB\-\-usePasswordPolicyControl\fR
-.RS 4
-Use the password policy request control
-.RE
-.PP
-\fB\-V, \-\-ldapVersion {version}\fR
-.RS 4
-LDAP protocol version number
-.sp
-Default value: 3
-.RE
-.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
@@ -194,9 +184,14 @@
Path to the file containing default property values used for command line arguments
.RE
.PP
-\fB\-v, \-\-verbose\fR
+\fB\-?, \-H, \-\-help\fR
.RS 4
-Use verbose mode
+Display usage information
+.RE
+.PP
+\fB\-V, \-\-version\fR
+.RS 4
+Display directory server version information
.RE
.SS "General Options"
.PP
@@ -259,10 +254,10 @@
.RS 4
.\}
.nf
-$ cat /tmp/currpwd\&.txt /tmp/newpwd\&.txt
+$ cat /tmp/currpwd\&.txt /tmp/newpwd\&.txt
bribery
secret12
-$ ldappasswordmodify \-p 1389 \-C /tmp/currpwd\&.txt \-F /tmp/newpwd\&.txt
+$ ldappasswordmodify \-p 1389 \-C /tmp/currpwd\&.txt \-N /tmp/newpwd\&.txt
\-a "dn:uid=kvaughan,ou=people,dc=example,dc=com"
\-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
The LDAP password modify operation was successful
@@ -272,5 +267,5 @@
.\}
.SH "COPYRIGHT"
.br
-Copyright \(co 2011 ForgeRock AS
+Copyright \(co 2011-2012 ForgeRock AS
.br
--
Gitblit v1.10.0