Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

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

diff --git a/doc/man/man1/ldapmodify.1 b/doc/man/man1/ldapmodify.1
index e752feddf14ad068f834c76d379e440d87b7ab53..026801294699a43bffba4a853d4e280d27c86d4f 100644 (file)
--- a/doc/man/man1/ldapmodify.1
+++ b/doc/man/man1/ldapmodify.1
@@ -1,6 +1,6 @@
 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$

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

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools


@@ -17,7 +17,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BR \-v ]
 [\c
 [\c
 .BR \-v ]
 [\c

-.BR \-M[M] ]
+.BR \-M [ M ]]

 [\c
 .BI \-d \ debuglevel\fR]
 [\c
 [\c
 .BI \-d \ debuglevel\fR]
 [\c


@@ -35,9 +35,13 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BI \-p \ ldapport\fR]
 [\c
 [\c
 .BI \-p \ ldapport\fR]
 [\c

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

 [\c
 [\c

-.BR \-O \ security-properties ]
+.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BI \-O \ security-properties\fR]

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


@@ -53,7 +57,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BI \-Y \ mech\fR]
 [\c
 [\c
 .BI \-Y \ mech\fR]
 [\c

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

 [\c
 .BI \-f \ file\fR]
 .LP
 [\c
 .BI \-f \ file\fR]
 .LP


@@ -67,7 +71,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BR \-v ]
 [\c
 [\c
 .BR \-v ]
 [\c

-.BR \-M[M] ]
+.BR \-M [ M ]]

 [\c
 .BI \-d \ debuglevel\fR]
 [\c
 [\c
 .BI \-d \ debuglevel\fR]
 [\c


@@ -85,9 +89,9 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BI \-p \ ldapport\fR]
 [\c
 [\c
 .BI \-p \ ldapport\fR]
 [\c

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

 [\c
 [\c

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

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


@@ -103,7 +107,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
 [\c
 .BI \-Y \ mech\fR]
 [\c
 [\c
 .BI \-Y \ mech\fR]
 [\c

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

 [\c
 .BI \-f \ file\fR]
 .SH DESCRIPTION
 [\c
 .BI \-f \ file\fR]
 .SH DESCRIPTION


@@ -118,12 +122,12 @@ library calls.
 .B ldapadd
 is implemented as a hard link to the ldapmodify tool.  When invoked as
 .B ldapadd
 .B ldapadd
 is implemented as a hard link to the ldapmodify tool.  When invoked as
 .B ldapadd

-the -a (add new entry) flag is turned on automatically.
+the \fB\-a\fP (add new entry) flag is turned on automatically.

 .LP
 .B ldapmodify
 opens a connection to an LDAP server, binds, and modifies or adds entries.
 The entry information is read from standard input or from \fIfile\fP through
 .LP
 .B ldapmodify
 opens a connection to an LDAP server, binds, and modifies or adds entries.
 The entry information is read from standard input or from \fIfile\fP through

-the use of the -f option.
+the use of the \fB\-f\fP option.

 .SH OPTIONS
 .TP
 .B \-a
 .SH OPTIONS
 .TP
 .B \-a


@@ -142,16 +146,16 @@ reporting an error.
 .BI \-S \ file
 Add or change records which where skipped due to an error are written to \fIfile\fP 
 and the error message returned by the server is added as a comment. Most useful in 
 .BI \-S \ file
 Add or change records which where skipped due to an error are written to \fIfile\fP 
 and the error message returned by the server is added as a comment. Most useful in 

-conjunction with -c.
+conjunction with \fB\-c\fP.

 .TP
 .B \-n
 Show what would be done, but don't actually modify entries.  Useful for
 .TP
 .B \-n
 Show what would be done, but don't actually modify 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 \-M[M]
+.BR \-M [ M ]

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


@@ -170,7 +174,7 @@ Use simple authentication instead of SASL.
 .TP
 .BI \-D \ binddn
 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 .TP
 .BI \-D \ binddn
 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.

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

 .TP
 .B \-W
 Prompt for simple authentication.
 .TP
 .B \-W
 Prompt for simple authentication.


@@ -190,18 +194,48 @@ 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
 .BI \-O \ security-properties
 Specify SASL security properties.
 .TP
 Specify the LDAP protocol version to use.
 .TP
 .BI \-O \ security-properties
 Specify SASL security properties.
 .TP

+.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
+.TP
+.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
+
+Specify general extensions with \fB\-e\fP and modify 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
+
+Modify extensions:
+.nf
+  [!]txn[=abort|commit]
+.fi
+.TP

 .B \-I
 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 only as needed.
 .B \-I
 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 only as needed.


@@ -221,22 +255,20 @@ 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
 .B \-ZZ\c
 , the command will require the operation to be successful.
 .SH INPUT FORMAT
 Issue StartTLS (Transport Layer Security) extended operation. If you use
 .B \-ZZ\c
 , the command will require the operation to be successful.
 .SH INPUT FORMAT

-The contents of \fIfile\fP (or standard input if no \-f flag is given on
+The contents of \fIfile\fP (or standard input if no \fB\-f\fP flag is given on

 the command line) must conform to the format defined in
 .BR ldif (5)
 (LDIF as defined in RFC 2849).
 the command line) must conform to the format defined in
 .BR ldif (5)
 (LDIF as defined in RFC 2849).


@@ -250,21 +282,21 @@ exists and has the contents:
     changetype: modify
     replace: mail
     mail: modme@example.com
     changetype: modify
     replace: mail
     mail: modme@example.com

-    -
+    \-

     add: title
     title: Grand Poobah
     add: title
     title: Grand Poobah

-    -
+    \-

     add: jpegPhoto
     jpegPhoto:< file:///tmp/modme.jpeg
     add: jpegPhoto
     jpegPhoto:< file:///tmp/modme.jpeg

-    -
+    \-

     delete: description
     delete: description

-    -
+    \-

 .fi
 .LP
 the command:
 .LP
 .nf
 .fi
 .LP
 the command:
 .LP
 .nf

-    ldapmodify -f /tmp/entrymods
+    ldapmodify \-f /tmp/entrymods

 .fi
 .LP
 will replace the contents of the "Modify Me" entry's
 .fi
 .LP
 will replace the contents of the "Modify Me" entry's


@@ -296,7 +328,7 @@ exists and has the contents:
 the command:
 .LP
 .nf
 the command:
 .LP
 .nf

-    ldapadd -f /tmp/newentry
+    ldapadd \-f /tmp/newentry

 .fi
 .LP
 will add a new entry for Babs Jensen, using the values from the
 .fi
 .LP
 will add a new entry for Babs Jensen, using the values from the


@@ -315,7 +347,7 @@ exists and has the contents:
 the command:
 .LP
 .nf
 the command:
 .LP
 .nf

-    ldapmodify -f /tmp/entrymods
+    ldapmodify \-f /tmp/entrymods

 .fi
 .LP
 will remove Babs Jensen's entry.
 .fi
 .LP
 will remove Babs Jensen's entry.