(ITS#4371) ldapsearch man page

[erici@motown.cc.utexas.edu]

Full_Name: Eric Irrgang
Version: 2.3.18
OS: n/a
URL: ftp://ftp.openldap.org/incoming/
Submission from: (NULL) (128.83.217.14)


Here is a partial patch where I've tried to make doc/man/man1/ldapsearch.1 a
little more internally consistent and add in some useful info from the
ldapsearch.c source and from tools/clients/common.c

Still possibly in need of revision are -T and -F.  If I understood them
correctly, they seem a bit redundant and confusing, but the documentation ought
to follow functionality in this case.  Also the trailing slash on urlpre /
def_urlpre in ldapsearch.c muddles matters.  Maybe urlize should strip redundant
trailing slashes?

I wasn't sure whether some of the options inherited from clients/tools/common.c
were applicable to all clients and figure that an ldaptools(1) man page might
eventually exist to catch things like -k|K, -c, -C, etc.

--- doc/man/man1/ldapsearch.1   Tue Jan 24 11:14:23 2006
+++ doc/man/man1/ldapsearch.1       Tue Jan 24 17:09:27 2006
@@ -13,8 +13,12 @@
 [\c
 .BR \-v ]
 [\c
-.BR \-t ]
+.BR \-t[t] ]
 [\c
+.BI \-T \ path\fR]
+[\c
+.BI \-F \ prefix\fR]
+[\c
 .BR \-A ]
 [\c
 .BR \-L[L[L]] ]
@@ -21,10 +25,14 @@
 [\c
 .BR \-M[M] ]
 [\c
+.BI \-S \ attribute\fR]
+[\c
 .BI \-d \ debuglevel\fR]
 [\c
 .BI \-f \ file\fR]
 [\c
+.BR \-x ]
+[\c
 .BI \-D \ binddn\fR]
 [\c
 .BR \-W ]
@@ -39,8 +47,6 @@
 [\c
 .BI \-p \ ldapport\fR]
 [\c
-.BI \-P \ 2\fR\||\|\fI3\fR]
-[\c
 .BI \-b \ searchbase\fR]
 [\c
 .BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
@@ -47,6 +53,12 @@
 [\c
 .BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR]
 [\c
+.BI \-P \ 2\fR\||\|\fI3\fR]
+[\c
+.BR \-e \ [!]ext[=extparam]]
+[\c
+.BR \-E \ [!]ext[=extparam]]
+[\c
 .BI \-l \ timelimit\fR]
 [\c
 .BI \-z \ sizelimit\fR]
@@ -61,8 +73,6 @@
 [\c
 .BI \-R \ realm\fR]
 [\c
-.BR \-x ]
-[\c
 .BI \-X \ authzid\fR]
 [\c
 .BI \-Y \ mech\fR]
@@ -102,11 +112,20 @@
 .B \-v
 Run in verbose mode, with many diagnostics written to standard output.
 .TP
-.B \-t
-Write retrieved non-printable values to a set of temporary files.  This
-is useful for dealing with values containing non-character data such as
-jpegPhoto or audio.
+.B \-t[t]
+A single -t writes retrieved non-printable values to a set of temporary
+files.  This is useful for dealing with values containing non-character
+data such as jpegPhoto or audio. A second -t writes all retrieved values to
+files.
 .TP
+.BI \-T \ path
+Write temporary files to directory specified by \fIpath\fP (default:
+/var/tmp/)
+.TP
+.BI \-F \ prefix
+URL prefix for temporary files.  Default is file://\fIpath\fP/ where
+\fIpath\fP is /var/tmp/ or specified with -T.
+.TP
 .B \-A
 Retrieve attributes only (no values).  This is useful when you just want to
 see if an attribute is present in an entry and are not interested in the
@@ -211,6 +230,35 @@
 .BI \-P \ 2\fR\||\|\fI3
 Specify the LDAP protocol version to use.
 .TP
+.B \-e \fI[!]ext[=extparam]\fP
+.TP
+.B \-E \fI[!]ext[=extparam]\fP
+
+Specify general extensions with -e and search extensions with -E.
+\'!\' indicates criticality.
+
+General extensions:
+.nf
+  [!]assert=<filter>   (an RFC 2254 Filter)
+  [!]authzid=<authzid> ("dn:<dn>" or "u:<user>")
+  [!]manageDSAit
+  [!]noop
+  ppolicy
+  [!]postread[=<attrs>]        (a comma-separated attribute list)
+  [!]preread[=<attrs>] (a comma-separated attribute list)
+  abandon, cancel (SIGINT sends abandon/cancel; not really controls)
+.fi
+
+Search extensions:
+.nf
+  [!]domainScope                               (domain scope)
+  [!]mv=<filter>                               (matched values filter)
+  [!]pr=<size>[/prompt|noprompt]       (paged results/prompt)
+  [!]subentries[=true|false]           (subentries)
+  [!]sync=ro[/<cookie>]                        (LDAP Sync refreshOnly)
+          rp[/<cookie>][/<slimit>]     (LDAP Sync refreshAndPersist)
+.fi
+.TP
 .BI \-l \ timelimit
 wait at most \fItimelimit\fP seconds for a search to complete.
 A timelimit of