ITS#5294

[openldap] / doc / man / man1 / ldapmodrdn.1

diff --git a/doc/man/man1/ldapmodrdn.1 b/doc/man/man1/ldapmodrdn.1
index 1a9ccf45de25e37e27f0aaa6b666242d5e50ed3d..b82ed1d7e78a8b8c074cc9197b055fed51ab1088 100644 (file)
--- a/doc/man/man1/ldapmodrdn.1
+++ b/doc/man/man1/ldapmodrdn.1
@@ -1,6 +1,6 @@
-.TH LDAPMODRDN 1 "12 July 2000" "OpenLDAP LDVERSION"
+.TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapmodrdn \- LDAP rename entry tool
@@ -9,18 +9,14 @@ ldapmodrdn \- LDAP rename entry tool
 [\c
 .BR \-r ]
 [\c
+.BI \-s \ newsup\fR]
+[\c
 .BR \-n ]
 [\c
 .BR \-v ]
 [\c
-.BR \-k ]
-[\c
-.BR \-K ]
-[\c
 .BR \-c ]
 [\c
-.BR \-C ]
-[\c
 .BR \-M[M] ]
 [\c
 .BI \-d \ debuglevel\fR]
@@ -31,6 +27,10 @@ ldapmodrdn \- LDAP rename entry tool
 [\c
 .BI \-w \ passwd\fR]
 [\c
+.BI \-y \ passwdfile\fR]
+[\c
+.BI \-H \ ldapuri\fR]
+[\c
 .BI \-h \ ldaphost\fR]
 [\c
 .BI \-p \ ldapport\fR]
@@ -39,7 +39,13 @@ ldapmodrdn \- LDAP rename entry tool
 [\c
 .BR \-O \ security-properties ]
 [\c
-.BI \-U \ username\fR]
+.BR \-I ]
+[\c
+.BR \-Q ]
+[\c
+.BI \-U \ authcid\fR]
+[\c
+.BI \-R \ realm\fR]
 [\c
 .BR \-x ]
 [\c
@@ -55,7 +61,7 @@ ldapmodrdn \- LDAP rename entry tool
 .SH DESCRIPTION
 .B ldapmodrdn
 is a shell-accessible interface to the
-.BR ldap_modrdn2 (3)
+.BR ldap_rename (3)
 library call.
 .LP
 .B ldapmodrdn
@@ -70,6 +76,10 @@ option, or from the command-line pair \fIdn\fP and
 .B \-r
 Remove old RDN values from the entry.  Default is to keep old values.
 .TP
+.BI \-s \ newsup
+Specify a new superior entry. (I.e., move the target entry and make it a
+child of the new superior.)  This option is not supported in LDAPv2.
+.TP
 .B \-n
 Show what would be done, but don't actually change entries.  Useful for
 debugging in conjunction with -v.
@@ -77,22 +87,8 @@ debugging in conjunction with -v.
 .B \-v
 Use verbose mode, with many diagnostics written to standard output.
 .TP
-.B \-k
-Use Kerberos authentication instead of simple authentication.  It is
-assumed that you already have a valid ticket granting ticket.
-.B ldapmodrdn
-must be compiled with KERBEROS defined for this option to have effect.
-.TP
-.B \-K
-Same as \-k, but only does step 1 of the kerberos bind.  This is useful
-when connecting to a slapd and there is no x500dsa.hostname principal
-registered with your kerberos servers.
-.TP
-.B \-C
-Automatically chase referrals.
-.TP
 .B \-c
-Continuous operation mode.  Errors  are  reported,  but ldapmodify
+Continuous operation mode.  Errors  are  reported,  but ldapmodrdn
 will  continue  with  modifications.   The default is to exit after
 reporting an error.
 .TP
@@ -115,8 +111,7 @@ standard input or the command-line.
 Use simple authentication instead of SASL.
 .TP
 .B \-D binddn
-Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be
-a string-represented DN as defined in RFC 1779.
+Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 .TP
 .B \-W
 Prompt for simple authentication.
@@ -125,11 +120,22 @@ This is used instead of specifying the password on the command line.
 .B \-w passwd
 Use \fIpasswd\fP as the password for simple authentication.
 .TP
-.B \-h ldaphost
+.BI \-y \ passwdfile
+Use complete contents of \fIpasswdfile\fP as the password for
+simple authentication.
+.TP
+.BI \-H \ ldapuri
+Specify URI(s) referring to the ldap server(s); only the protocol/host/port
+fields are allowed; a list of URI, separated by whitespace or commas
+is expected.
+.TP
+.BI \-h \ ldaphost
 Specify an alternate host on which the ldap server is running.
+Deprecated in favor of -H.
 .TP
-.B \-p ldapport
+.BI \-p \ ldapport
 Specify an alternate TCP port where the ldap server is listening.
+Deprecated in favor of -H.
 .TP
 .BI \-P \ 2\fR\||\|\fI3
 Specify the LDAP protocol version to use.
@@ -137,9 +143,20 @@ Specify the LDAP protocol version to use.
 .BI \-O \ security-properties
 Specify SASL security properties.
 .TP
-.BI \-U \ username
-Specify the username for SASL bind. The syntax of the username depends on the
-actual SASL mechanism used.
+.B \-I
+Enable SASL Interactive mode.  Always prompt.  Default is to prompt
+only as needed.
+.TP
+.B \-Q
+Enable SASL Quiet mode.  Never prompt.
+.TP
+.BI \-U \ authcid
+Specify the authentication ID for SASL bind. The form of the ID
+depends on the actual SASL mechanism used.
+.TP
+.BI \-R \ realm
+Specify the realm of authentication ID for SASL bind. The form of the realm
+depends on the actual SASL mechanism used.
 .TP
 .BI \-X \ authzid
 Specify the requested authorization ID for SASL bind.
@@ -180,14 +197,14 @@ Assuming that the file
 exists and has the contents:
 .LP
 .nf
-    cn=Modify Me, dc=OpenLDAP, dc=org
+    cn=Modify Me,dc=example,dc=com
     cn=The New Me
 .fi
 .LP
 the command:
 .LP
 .nf
-    ldapmodify -r -f /tmp/entrymods
+    ldapmodrdn -r -f /tmp/entrymods
 .fi
 .LP
 will change the RDN of the "Modify Me" entry from "Modify Me" to
@@ -203,19 +220,8 @@ status and a diagnostic message being written to standard error.
 .BR ldapsearch (1),
 .BR ldap.conf (5),
 .BR ldap (3),
-.BR ldap_modrdn2 (3)
-.LP
-Kille, S.,
-.IR "A String Representation of Distinguished Names",
-.SM RFC
-1779,
-ISODE Consortium, March 1995.
-.SH BUGS
-There is no interactive mode, but there probably should be.
+.BR ldap_rename (3)
 .SH AUTHOR
 The OpenLDAP Project <http://www.openldap.org/>
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.  
+.so ../Project