Merge remote-tracking branch 'origin/mdb.master'

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

diff --git a/doc/man/man1/ldapmodrdn.1 b/doc/man/man1/ldapmodrdn.1
index 8d24b38ec3d4dce2771838cae0b6a559e909ecaf..77864398fd9e22b2bf02254ce81bcb6194f980b6 100644 (file)
--- a/doc/man/man1/ldapmodrdn.1
+++ b/doc/man/man1/ldapmodrdn.1
@@ -1,25 +1,31 @@
 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .TH LDAPMODRDN 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$

-.\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapmodrdn \- LDAP rename entry tool
 .SH SYNOPSIS
 .B ldapmodrdn
 [\c
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapmodrdn \- LDAP rename entry tool
 .SH SYNOPSIS
 .B ldapmodrdn
 [\c

-.BR \-r ]
+.BR \-V [ V ]]

 [\c
 [\c

-.BI \-s \ newsup\fR]
+.BI \-d \ debuglevel\fR]

 [\c
 .BR \-n ]
 [\c
 .BR \-v ]
 [\c
 [\c
 .BR \-n ]
 [\c
 .BR \-v ]
 [\c

+.BR \-r ]
+[\c
+.BI \-s \ newsup\fR]
+[\c

 .BR \-c ]
 [\c
 .BR \-c ]
 [\c

-.BR \-M[M] ]
+.BI \-f \ file\fR]

 [\c
 [\c

-.BI \-d \ debuglevel\fR]
+.BR \-M [ M ]]
+[\c
+.BR \-x ]

 [\c
 .BI \-D \ binddn\fR]
 [\c
 [\c
 .BI \-D \ binddn\fR]
 [\c


@@ -35,27 +41,31 @@ ldapmodrdn \- LDAP rename entry tool
 [\c
 .BI \-p \ ldapport\fR]
 [\c
 [\c
 .BI \-p \ ldapport\fR]
 [\c

-.BI \-P \ 2\fR\||\|\fI3\fR]
+.BR \-P \ { 2 \||\| 3 }]
+[\c
+.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BI \-o \ opt \fR[= optparam \fR]]

 [\c
 [\c

-.BR \-O \ security-properties ]
+.BI \-O \ security-properties\fR]

 [\c
 .BR \-I ]
 [\c
 .BR \-Q ]
 [\c
 [\c
 .BR \-I ]
 [\c
 .BR \-Q ]
 [\c

+.BR \-N ]
+[\c

 .BI \-U \ authcid\fR]
 [\c
 .BI \-R \ realm\fR]
 [\c
 .BI \-U \ authcid\fR]
 [\c
 .BI \-R \ realm\fR]
 [\c

-.BR \-x ]
-[\c

 .BI \-X \ authzid\fR]
 [\c
 .BI \-Y \ mech\fR]
 [\c
 .BI \-X \ authzid\fR]
 [\c
 .BI \-Y \ mech\fR]
 [\c

-.BR \-Z[Z] ]
-[\c
-.BI \-f \ file\fR]
+.BR \-Z [ Z ]]

 [\c
 .I dn  rdn\fR]
 .SH DESCRIPTION
 [\c
 .I dn  rdn\fR]
 .SH DESCRIPTION


@@ -73,51 +83,55 @@ option, or from the command-line pair \fIdn\fP and
 \fIrdn\fP.
 .SH OPTIONS
 .TP
 \fIrdn\fP.
 .SH OPTIONS
 .TP

-.B \-r
-Remove old RDN values from the entry.  Default is to keep old values.
+.BR \-V [ V ]
+Print version info.
+If \fB\-VV\fP is given, only the version information is printed.

 .TP
 .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.
+.BI \-d \ debuglevel
+Set the LDAP debugging level to \fIdebuglevel\fP.
+.B ldapmodrdn
+must be compiled with LDAP_DEBUG defined for this option to have any effect.

 .TP
 .B \-n
 Show what would be done, but don't actually change entries.  Useful for
 .TP
 .B \-n
 Show what would be done, but don't actually change entries.  Useful for

-debugging in conjunction with -v.
+debugging in conjunction with \fB\-v\fP.

 .TP
 .B \-v
 Use verbose mode, with many diagnostics written to standard output.
 .TP
 .TP
 .B \-v
 Use verbose mode, with many diagnostics written to standard output.
 .TP

+.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 \-c
 Continuous operation mode.  Errors  are  reported,  but ldapmodrdn
 will  continue  with  modifications.   The default is to exit after
 reporting an error.
 .TP
 .B \-c
 Continuous operation mode.  Errors  are  reported,  but ldapmodrdn
 will  continue  with  modifications.   The default is to exit after
 reporting an error.
 .TP

-.B \-M[M]
+.BI \-f \ file
+Read the entry modification information from \fIfile\fP instead of from
+standard input or the command-line.
+.TP
+.BR \-M [ M ]

 Enable manage DSA IT control.
 .B \-MM
 makes control critical.
 .TP
 Enable manage DSA IT control.
 .B \-MM
 makes control critical.
 .TP

-.B \-d debuglevel
-Set the LDAP debugging level to \fIdebuglevel\fP.
-.B ldapmodrdn
-must be
-compiled with LDAP_DEBUG defined for this option to have any effect.
-.TP
-.B \-f file
-Read the entry modification information from \fIfile\fP instead of from
-standard input or the command-line.
-.TP

 .B \-x 
 Use simple authentication instead of SASL.
 .TP
 .B \-x 
 Use simple authentication instead of SASL.
 .TP

-.B \-D binddn
+.BI \-D \ binddn

 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.

+For SASL binds, the server is expected to ignore this value.

 .TP
 .B \-W
 Prompt for simple authentication.
 This is used instead of specifying the password on the command line.
 .TP
 .TP
 .B \-W
 Prompt for simple authentication.
 This is used instead of specifying the password on the command line.
 .TP

-.B \-w passwd
+.BI \-w \ passwd

 Use \fIpasswd\fP as the password for simple authentication.
 .TP
 .BI \-y \ passwdfile
 Use \fIpasswd\fP as the password for simple authentication.
 .TP
 .BI \-y \ passwdfile


@@ -131,15 +145,55 @@ is expected.
 .TP
 .BI \-h \ ldaphost
 Specify an alternate host on which the ldap server is running.
 .TP
 .BI \-h \ ldaphost
 Specify an alternate host on which the ldap server is running.

-Deprecated in favor of -H.
+Deprecated in favor of \fB\-H\fP.

 .TP
 .BI \-p \ ldapport
 Specify an alternate TCP port where the ldap server is listening.
 .TP
 .BI \-p \ ldapport
 Specify an alternate TCP port where the ldap server is listening.

-Deprecated in favor of -H.
+Deprecated in favor of \fB\-H\fP.

 .TP
 .TP

-.BI \-P \ 2\fR\||\|\fI3
+.BR \-P \ { 2 \||\| 3 }

 Specify the LDAP protocol version to use.
 .TP
 Specify the LDAP protocol version to use.
 .TP

+.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
+.TP
+.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
+
+Specify general extensions with \fB\-e\fP and modrdn extensions with \fB\-E\fP.
+\'\fB!\fP\' indicates criticality.
+
+General extensions:
+.nf
+  [!]assert=<filter>    (an RFC 4515 Filter)
+  !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
+  [!]bauthzid           (RFC 3829 authzid control)
+  [!]chaining[=<resolve>[/<cont>]]
+  [!]manageDSAit
+  [!]noop
+  ppolicy
+  [!]postread[=<attrs>] (a comma-separated attribute list)
+  [!]preread[=<attrs>]  (a comma-separated attribute list)
+  [!]relax
+  sessiontracking[=<username>]
+  abandon,cancel,ignore (SIGINT sends abandon/cancel,
+  or ignores response; if critical, doesn't wait for SIGINT.
+  not really controls)
+.fi
+
+Modrdn extensions:
+.nf
+  (none)
+.fi
+.TP
+.BI \-o \ opt \fR[= optparam \fR]
+
+Specify general options.
+
+General options:
+.nf
+  nettimeout=<timeout>  (in seconds, or "none" or "max")
+  ldif-wrap=<width>     (in columns, or "no" for no wrapping)
+.fi
+.TP

 .BI \-O \ security-properties
 Specify SASL security properties.
 .TP
 .BI \-O \ security-properties
 Specify SASL security properties.
 .TP


@@ -150,6 +204,9 @@ only as needed.
 .B \-Q
 Enable SASL Quiet mode.  Never prompt.
 .TP
 .B \-Q
 Enable SASL Quiet mode.  Never prompt.
 .TP

+.B \-N
+Do not use reverse DNS to canonicalize SASL host name.
+.TP

 .BI \-U \ authcid
 Specify the authentication ID for SASL bind. The form of the ID
 depends on the actual SASL mechanism used.
 .BI \-U \ authcid
 Specify the authentication ID for SASL bind. The form of the ID
 depends on the actual SASL mechanism used.


@@ -162,28 +219,23 @@ depends on the actual SASL mechanism used.
 Specify the requested authorization ID for SASL bind.
 .I authzid
 must be one of the following formats:
 Specify the requested authorization ID for SASL bind.
 .I authzid
 must be one of the following formats:

-.B dn:\c
-.I <distinguished name>
+.BI dn: "<distinguished name>"

 or
 or

-.B u:\c
-.I <username>
+.BI u: <username>

 .TP
 .BI \-Y \ mech
 Specify the SASL mechanism to be used for authentication. If it's not
 specified, the program will choose the best mechanism the server knows.
 .TP
 .TP
 .BI \-Y \ mech
 Specify the SASL mechanism to be used for authentication. If it's not
 specified, the program will choose the best mechanism the server knows.
 .TP

-.B \-Z[Z]
+.BR \-Z [ Z ]

 Issue StartTLS (Transport Layer Security) extended operation. If you use
 Issue StartTLS (Transport Layer Security) extended operation. If you use

-.B \-ZZ\c
-, the command will require the operation to be successful.
+\fB\-ZZ\fP, the command will require the operation to be successful.

 .SH INPUT FORMAT
 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 .LP
 Otherwise, the contents of \fIfile\fP (or standard input if
 .SH INPUT FORMAT
 If the command-line arguments \fIdn\fP and \fIrdn\fP are given, \fIrdn\fP
 will replace the RDN of the entry specified by the DN, \fIdn\fP.
 .LP
 Otherwise, the contents of \fIfile\fP (or standard input if

-no
-.RI \- f
-flag is given) should consist of one or more entries.
+no \fB\-f\fP flag is given) should consist of one or more entries.

 .LP
 .nf
     Distinguished Name (DN)
 .LP
 .nf
     Distinguished Name (DN)


@@ -204,7 +256,7 @@ exists and has the contents:
 the command:
 .LP
 .nf
 the command:
 .LP
 .nf

-    ldapmodrdn -r -f /tmp/entrymods
+    ldapmodrdn \-r \-f /tmp/entrymods

 .fi
 .LP
 will change the RDN of the "Modify Me" entry from "Modify Me" to
 .fi
 .LP
 will change the RDN of the "Modify Me" entry from "Modify Me" to