From effaddf23f9905893690d21644aff675476bbe33 Mon Sep 17 00:00:00 2001 From: Kurt Zeilenga Date: Thu, 15 Jul 1999 22:57:22 +0000 Subject: [PATCH] Add [-M[M]] to manual pages --- doc/man/man1/ldapdelete.1 | 76 +++++++++++++----- doc/man/man1/ldapmodify.1 | 118 ++++++++++++++++++++-------- doc/man/man1/ldapmodrdn.1 | 66 ++++++++++++---- doc/man/man1/ldapsearch.1 | 159 ++++++++++++++++++++++++++------------ 4 files changed, 300 insertions(+), 119 deletions(-) diff --git a/doc/man/man1/ldapdelete.1 b/doc/man/man1/ldapdelete.1 index ea2f4726c2..492de10202 100644 --- a/doc/man/man1/ldapdelete.1 +++ b/doc/man/man1/ldapdelete.1 @@ -1,20 +1,38 @@ -.TH LDAPDELETE 1 "13 November 1995" "U-M LDAP LDVERSION" +.TH LDAPDELETE 1 "10 November 1998" "OpenLDAP LDVERSION" .SH NAME ldapdelete \- ldap delete entry tool .SH SYNOPSIS .B ldapdelete -.B [\-n] -.B [\-v] -.B [\-k] -.B [\-K] -.B [\-c] -.B [\-d debuglevel] -.B [\-f file] -.B [\-D binddn] -.B [\-w passwd] -.B [\-h ldaphost] -.B [\-p ldapport] -.B [dn]... +[\c +.BR \-n ] +[\c +.BR \-v ] +[\c +.BR \-k ] +[\c +.BR \-K ] +[\c +.BR \-c ] +[\c +.BR \-M[M] ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-f \ file\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BR \-W ] +[\c +.BI \-w \ passwd\fR] +[\c +.BI \-h \ ldaphost\fR] +[\c +.BI \-P \ 2\fR\||\|\fI3\fR] +[\c +.BI \-p \ ldapport\fR] +[\c +.IR dn ]... .SH DESCRIPTION .I ldapdelete is a shell-accessible interface to the @@ -55,29 +73,41 @@ Continuous operation mode. Errors are reported, but will continue with deletions. The default is to exit after reporting an error. .TP -.B \-d debuglevel +.B \-M[M] +Enable manage DSA IT control. +.B \-MM +makes control critical. +.TP +.BI \-d \ debuglevel Set the LDAP debugging level to \fIdebuglevel\fP. .B ldapdelete must be compiled with LDAP_DEBUG defined for this option to have any effect. .TP -.B \-f file +.BI \-f \ file Read a series of lines from \fIfile\fP, performing one LDAP search for each line. In this case, the \fIfilter\fP given on the command line is treated as a pattern where the first occurrence of \fB%s\fP is replaced with a line from \fIfile\fP. .TP -.B \-D binddn -Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be +.BI \-D \ binddn +Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be a string-represented DN as defined in RFC 1779. .TP -.B \-w passwd +.B \-W +Prompt for simple authentication. +This is used instead of specifying the password on the command line. +.TP +.BI \-w \ passwd Use \fIpasswd\fP as the password for simple authentication. .TP -.B \-h ldaphost +.BI \-h \ ldaphost Specify an alternate host on which the ldap server is running. .TP -.B \-p ldapport +.BI \-p \ ldapport Specify an alternate TCP port where the ldap server is listening. +.TP +.BI \-P \ 2\fR\||\|\fI3 +Specify the LDAP protocol version to use. .SH EXAMPLE The following command: .LP @@ -93,6 +123,7 @@ course it would probably be necessary to supply a \fIbinddn\fP and Exit status is 0 if no errors occur. Errors result in a non-zero exit status and a diagnostic message being written to standard error. .SH "SEE ALSO" +.BR ldap.conf (5), .BR ldapadd (1), .BR ldapmodify (1), .BR ldapmodrdn (1), @@ -107,3 +138,8 @@ Kille, S., ISODE Consortium, March 1995. .SH BUGS There is no interactive mode, but there probably should be. +.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. diff --git a/doc/man/man1/ldapmodify.1 b/doc/man/man1/ldapmodify.1 index 3ffbe59a92..8da1462d44 100644 --- a/doc/man/man1/ldapmodify.1 +++ b/doc/man/man1/ldapmodify.1 @@ -1,36 +1,68 @@ -.TH LDAPMODIFY 1 "13 November 1995" "U-M LDAP LDVERSION" +.TH LDAPMODIFY 1 "10 November 1998" "OpenLDAP LDVERSION" .SH NAME ldapmodify, ldapadd \- ldap modify entry and ldap add entry tools .SH SYNOPSIS .B ldapmodify -.B [\-a] -.B [\-b] -.B [\-c] -.B [\-r] -.B [\-n] -.B [\-v] -.B [\-k] -.B [\-d debuglevel] -.B [\-D binddn] -.B [\-w passwd] -.B [\-h ldaphost] -.B [\-p ldapport] -.B [\-f file] +[\c +.BR \-a ] +[\c +.BR \-b ] +[\c +.BR \-c ] +[\c +.BR \-r ] +[\c +.BR \-n ] +[\c +.BR \-v ] +[\c +.BR \-k ] +[\c +.BR \-M[M] ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BR \-W ] +[\c +.BI \-w \ passwd\fR] +[\c +.BI \-h \ ldaphost\fR] +[\c +.BI \-p \ ldapport\fR] +[\c +.BI \-P \ 2\fR\||\|\fI3\fR] +[\c +.BI \-f \ file\fR] .LP .B ldapadd -.B [\-b] -.B [\-c] -.B [\-r] -.B [\-n] -.B [\-v] -.B [\-k] -.B [\-K] -.B [\-d debuglevel] -.B [\-D binddn] -.B [\-w passwd] -.B [\-h ldaphost] -.B [\-p ldapport] -.B [\-f file] +[\c +.BR \-b ] +[\c +.BR \-c ] +[\c +.BR \-r ] +[\c +.BR \-n ] +[\c +.BR \-v ] +[\c +.BR \-k ] +[\c +.BR \-K ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BI \-w \ passwd\fR] +[\c +.BI \-h \ ldaphost\fR] +[\c +.BI \-p \ ldapport\fR] +[\c +.BI \-f \ file\fR] .SH DESCRIPTION .B ldapmodify is a shell-accessible interface to the @@ -94,27 +126,39 @@ lines that begin with (by default, replica: lines are compared against the LDAP server host and port in use to decide if a replog record should actually be applied). .TP -.B \-d debuglevel +.B \-M[M] +Enable manage DSA IT control. +.B \-MM +makes control critical. +.TP +.BI \-d \ debuglevel Set the LDAP debugging level to \fIdebuglevel\fP. .B ldapmodify must be compiled with LDAP_DEBUG defined for this option to have any effect. .TP -.B \-f file +.BI \-f \ file Read the entry modification information from \fIfile\fP instead of from standard input. .TP -.B \-D binddn -Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be +.BI \-D \ binddn +Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be a string-represented DN as defined in RFC 1779. .TP -.B \-w passwd +.B \-W +Prompt for simple authentication. +This is used instead of specifying the password on the command line. +.TP +.BI \-w \ passwd Use \fIpasswd\fP as the password for simple authentication. .TP -.B \-h ldaphost +.BI \-h \ ldaphost Specify an alternate host on which the ldap server is running. .TP -.B \-p ldapport +.BI \-p \ ldapport Specify an alternate TCP port where the ldap server is listening. +.TP +.BI \-P \ 2\fR\||\|\fI3 +Specify the LDAP protocol version to use. .SH INPUT FORMAT The contents of \fIfile\fP (or standard input if no \-f flag is given on the command line) should conform to the format defined in @@ -285,6 +329,7 @@ status and a diagnostic message being written to standard error. .BR ldapdelete (1), .BR ldapmodrdn (1), .BR ldapsearch (1), +.BR ldap.conf (5), .BR ldap (3), .BR ldap_add (3), .BR ldap_delete (3), @@ -299,3 +344,8 @@ Kille, S., ISODE Consortium, March 1995. .SH BUGS There is no interactive mode, but there probably should be. +.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. diff --git a/doc/man/man1/ldapmodrdn.1 b/doc/man/man1/ldapmodrdn.1 index 8468e7a4e5..1d9dd12e21 100644 --- a/doc/man/man1/ldapmodrdn.1 +++ b/doc/man/man1/ldapmodrdn.1 @@ -1,20 +1,40 @@ -.TH LDAPMODRDN 1 "13 November 1995" "U-M LDAP LDVERSION" +.TH LDAPMODRDN 1 "10 November 1998" "OpenLDAP LDVERSION" .SH NAME ldapmodrdn \- ldap modify entry RDN tool .SH SYNOPSIS .B ldapmodrdn -.B [\-r] -.B [\-n] -.B [\-v] -.B [\-k] -.B [\-K] -.B [\-c] -.B [\-d debuglevel] -.B [\-D binddn] -.B [\-w passwd] -.B [\-h ldaphost] -.B [\-p ldapport] -.B [\-f file] [dn rdn] +[\c +.BR \-r ] +[\c +.BR \-n ] +[\c +.BR \-v ] +[\c +.BR \-k ] +[\c +.BR \-K ] +[\c +.BR \-c ] +[\c +.BR \-M[M] ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BR \-W ] +[\c +.BI \-w \ passwd\fR] +[\c +.BI \-h \ ldaphost\fR] +[\c +.BI \-p \ ldapport\fR] +[\c +.BI \-P \ 2\fR\||\|\fI3\fR] +[\c +.BI \-f \ file\fR] +[\c +.I dn rdn\fR] .SH DESCRIPTION .B ldapmodrdn is a shell-accessible interface to the @@ -56,6 +76,11 @@ Continuous operation mode. Errors are reported, but ldapmodify will continue with modifications. The default is to exit after reporting an error. .TP +.B \-M[M] +Enable manage DSA IT control. +.B \-MM +makes control critical. +.TP .B \-d debuglevel Set the LDAP debugging level to \fIdebuglevel\fP. .B ldapmodrdn @@ -67,9 +92,13 @@ Read the entry modification information from \fIfile\fP instead of from standard input or the command-line. .TP .B \-D binddn -Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be +Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be a string-represented DN as defined in RFC 1779. .TP +.B \-W +Prompt for simple authentication. +This is used instead of specifying the password on the command line. +.TP .B \-w passwd Use \fIpasswd\fP as the password for simple authentication. .TP @@ -78,6 +107,9 @@ Specify an alternate host on which the ldap server is running. .TP .B \-p ldapport Specify an alternate TCP port where the ldap server is listening. +.TP +.BI \-P \ 2\fR\||\|\fI3 +Specify the LDAP protocol version to use. .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. @@ -120,6 +152,7 @@ status and a diagnostic message being written to standard error. .BR ldapdelete (1), .BR ldapmodify (1), .BR ldapsearch (1), +.BR ldap.conf (5), .BR ldap (3), .BR ldap_modrdn2 (3) .LP @@ -130,3 +163,8 @@ Kille, S., ISODE Consortium, March 1995. .SH BUGS There is no interactive mode, but there probably should be. +.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. diff --git a/doc/man/man1/ldapsearch.1 b/doc/man/man1/ldapsearch.1 index 2d66334d80..96b38ea6f9 100644 --- a/doc/man/man1/ldapsearch.1 +++ b/doc/man/man1/ldapsearch.1 @@ -1,32 +1,61 @@ -.TH LDAPSEARCH 1 "29 March 1996" "U-M LDAP LDVERSION" +.TH LDAPSEARCH 1 "10 November 1998" "OpenLDAP LDVERSION" .SH NAME ldapsearch \- ldap search tool .SH SYNOPSIS .B ldapsearch -.B [\-n] -.B [\-u] -.B [\-v] -.B [\-k] -.B [\-K] -.B [\-t] -.B [\-A] -.B [\-B] -.B [\-L] -.B [\-R] -.B [\-d debuglevel] -.B [\-F sep] -.B [\-f file] -.B [\-D binddn] -.B [\-w bindpasswd] -.B [\-h ldaphost] -.B [\-p ldapport] -.B [\-b searchbase] -.B [\-s scope ] -.B [\-a deref] -.B [\-l time limit] -.B [\-z size limit] -.B filter -.B [attrs....] +[\c +.BR \-n ] +[\c +.BR \-u ] +[\c +.BR \-v ] +[\c +.BR \-k ] +[\c +.BR \-K ] +[\c +.BR \-t ] +[\c +.BR \-A ] +[\c +.BR \-B ] +[\c +.BR \-L ] +[\c +.BR \-M[M] ] +[\c +.BR \-R ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-F \ sep\fR] +[\c +.BI \-f \ file\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BR \-W ] +[\c +.BI \-w \ bindpasswd\fR] +[\c +.BI \-h \ ldaphost\fR] +[\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] +[\c +.BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR] +[\c +.BI \-l \ timelimit\fR] +[\c +.BI \-z \ sizelimit\fR] +.I filter +[\c +.IR attrs... ] .SH DESCRIPTION .I ldapsearch is a shell-accessible interface to the @@ -87,18 +116,23 @@ Display search results in format. This option also turns on the -B option, and causes the -F option to be ignored. .TP +.B \-M[M] +Enable manage DSA IT control. +.B \-MM +makes control critical. +.TP .B \-R Do not automatically follow referrals returned while searching. .B ldapsearch must be compiled with LDAP_REFERRALS defined for referrals to be automatically followed by default, and for this option to have any effect. .TP -.B \-F sep +.BI \-F \ sep Use \fIsep\fP as the field separator between attribute names and values. The default separator is `=', unless the -L flag has been specified, in which case this option is ignored. .TP -.B \-S attribute +.BI \-S \ attribute Sort the entries returned based on \fIattribute\fP. The default is not to sort entries returned. If \fIattribute\fP is a zero-length string (""), the entries are sorted by the components of their Distingished Name. See @@ -110,61 +144,78 @@ normally prints out entries as it receives them. The use of the option defeats this behavior, causing all entries to be retrieved, then sorted, then printed. .TP -.B \-d debuglevel +.BI \-d \ debuglevel Set the LDAP debugging level to \fIdebuglevel\fP. .B ldapsearch must be compiled with LDAP_DEBUG defined for this option to have any effect. .TP -.B \-f file +.BI \-f \ file Read a series of lines from \fIfile\fP, performing one LDAP search for each line. In this case, the \fIfilter\fP given on the command line is treated as a pattern where the first occurrence of \fB%s\fP is replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP character, then the lines are read from standard input. .TP -.B \-D binddn -Use \fIbinddn\fP to bind to the X.500 directory. \fIbinddn\fP should be +.BI \-D \ binddn +Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should be a string-represented DN as defined in RFC 1779. .TP -.B \-w bindpasswd +.B \-W +Prompt for simple authentication. +This is used instead of specifying the password on the command line. +.TP +.BI \-w \ bindpasswd Use \fIbindpasswd\fP as the password for simple authentication. .TP -.B \-h ldaphost +.BI \-h \ ldaphost Specify an alternate host on which the ldap server is running. .TP -.B \-p ldapport +.BI \-p \ ldapport Specify an alternate TCP port where the ldap server is listening. .TP -.B \-b searchbase +.BI \-b \ searchbase Use \fIsearchbase\fP as the starting point for the search instead of the default. .TP -.B \-s scope -Specify the scope of the search. \fIscope\fP should be one of -.B base, -.B one, +.BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub +Specify the scope of the search to be one of +.IR base , +.IR one , or -.B sub +.I sub to specify a base object, one-level, or subtree search. The default is -.BR sub . +.IR sub . .TP -.B \-a deref -Specify how aliases dereferencing is done. \fIderef\fP should be one of -.B never, -.B always, -.B search, +.BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind +Specify how aliases dereferencing is done. Should be one of +.IR never , +.IR always , +.IR search , or -.B find +.I find to specify that aliases are never dereferenced, always dereferenced, dereferenced when searching, or dereferenced only when locating the base object for the search. The default is to never dereference aliases. .TP -.B \-l timelimit -wait at most \fItimelimit\fP seconds for a search to complete. +.BI \-P \ 2\fR\||\|\fI3 +Specify the LDAP protocol version to use. +.TP +.BI \-l \ timelimit +wait at most \fItimelimit\fP seconds for a search to complete. A +timelimit of +.I 0 +(zero) removes the +.B ldap.conf +limit. .TP -.B \-z sizelimit -retrieve at most \fIsizelimit\fP seconds for a search to complete. +.BI \-z \ sizelimit +retrieve at most \fIsizelimit\fP entries for a search. A sizelimit +of +.I 0 +(zero) removes the +.B ldap.conf +limit. .SH OUTPUT FORMAT If one or more entries are found, each entry is written to standard output in the form: @@ -275,6 +326,7 @@ status and a diagnostic message being written to standard error. .BR ldapdelete (1), .BR ldapmodify (1), .BR ldapmodrdn (1), +.BR ldap.conf (5), .BR ldap (3), .BR ldap_search (3) .LP @@ -289,3 +341,8 @@ Howes, T., .SM RFC 1558, University of Michigan, December 1993. +.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. -- 2.39.5