Commit 74f0a362 authored by Howard Chu's avatar Howard Chu Committed by Quanah Gibson-Mount
Browse files

ITS#7177 make manpages more consistent

parent aabec0dc
...@@ -7,6 +7,10 @@ ldapcompare \- LDAP compare tool ...@@ -7,6 +7,10 @@ ldapcompare \- LDAP compare tool
.SH SYNOPSIS .SH SYNOPSIS
.B ldapcompare .B ldapcompare
[\c [\c
.BR \-V [ V ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
.BR \-n ] .BR \-n ]
[\c [\c
.BR \-v ] .BR \-v ]
...@@ -15,7 +19,7 @@ ldapcompare \- LDAP compare tool ...@@ -15,7 +19,7 @@ ldapcompare \- LDAP compare tool
[\c [\c
.BR \-M [ M ]] .BR \-M [ M ]]
[\c [\c
.BI \-d \ debuglevel\fR] .BR \-x ]
[\c [\c
.BI \-D \ binddn\fR] .BI \-D \ binddn\fR]
[\c [\c
...@@ -37,7 +41,7 @@ ldapcompare \- LDAP compare tool ...@@ -37,7 +41,7 @@ ldapcompare \- LDAP compare tool
[\c [\c
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
[\c [\c
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ]] .BI \-o \ opt \fR[= optparam \fR]]
[\c [\c
.BI \-O \ security-properties\fR] .BI \-O \ security-properties\fR]
[\c [\c
...@@ -45,12 +49,12 @@ ldapcompare \- LDAP compare tool ...@@ -45,12 +49,12 @@ ldapcompare \- LDAP compare tool
[\c [\c
.BR \-Q ] .BR \-Q ]
[\c [\c
.BR \-N ]
[\c
.BI \-U \ authcid\fR] .BI \-U \ authcid\fR]
[\c [\c
.BI \-R \ realm\fR] .BI \-R \ realm\fR]
[\c [\c
.BR \-x ]
[\c
.BI \-X \ authzid\fR] .BI \-X \ authzid\fR]
[\c [\c
.BI \-Y \ mech\fR] .BI \-Y \ mech\fR]
...@@ -79,6 +83,15 @@ TRUE, FALSE, or UNDEFINED on standard output. ...@@ -79,6 +83,15 @@ TRUE, FALSE, or UNDEFINED on standard output.
.LP .LP
.SH OPTIONS .SH OPTIONS
.TP .TP
.BR \-V [ V ]
Print version info.
If \fB\-VV\fP is given, only the version information is printed.
.TP
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.B ldapcompare
must be compiled with LDAP_DEBUG defined for this option to have any effect.
.TP
.B \-n .B \-n
Show what would be done, but don't actually perform the compare. Useful for Show what would be done, but don't actually perform the compare. Useful for
debugging in conjunction with \fB\-v\fP. debugging in conjunction with \fB\-v\fP.
...@@ -95,11 +108,6 @@ Enable manage DSA IT control. ...@@ -95,11 +108,6 @@ Enable manage DSA IT control.
.B \-MM .B \-MM
makes control critical. makes control critical.
.TP .TP
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.B ldapcompare
must be compiled with LDAP_DEBUG defined for this option to have any effect.
.TP
.B \-x .B \-x
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
...@@ -176,7 +184,7 @@ Compare extensions: ...@@ -176,7 +184,7 @@ Compare extensions:
!dontUseCopy !dontUseCopy
.fi .fi
.TP .TP
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ] .BI \-o \ opt \fR[= optparam \fR]
Specify general options. Specify general options.
...@@ -196,6 +204,9 @@ only as needed. ...@@ -196,6 +204,9 @@ only as needed.
.B \-Q .B \-Q
Enable SASL Quiet mode. Never prompt. Enable SASL Quiet mode. Never prompt.
.TP .TP
.B \-N
Do not use reverse DNS to canonicalize SASL host name.
.TP
.BI \-U \ authcid .BI \-U \ authcid
Specify the authentication ID for SASL bind. The form of the ID Specify the authentication ID for SASL bind. The form of the ID
depends on the actual SASL mechanism used. depends on the actual SASL mechanism used.
......
...@@ -7,17 +7,25 @@ ldapdelete \- LDAP delete entry tool ...@@ -7,17 +7,25 @@ ldapdelete \- LDAP delete entry tool
.SH SYNOPSIS .SH SYNOPSIS
.B ldapdelete .B ldapdelete
[\c [\c
.BR \-V [ V ]]
[\c
.BI \-d \ debuglevel\fR]
[\c
.BR \-n ] .BR \-n ]
[\c [\c
.BR \-v ] .BR \-v ]
[\c [\c
.BR \-c ] .BR \-c ]
[\c [\c
.BR \-M [ M ]] .BI \-f \ file\fR]
[\c [\c
.BI \-d \ debuglevel\fR] .BR \-r ]
[\c [\c
.BI \-f \ file\fR] .BI \-z \ sizelimit\fR]
[\c
.BR \-M [ M ]]
[\c
.BR \-x ]
[\c [\c
.BI \-D \ binddn\fR] .BI \-D \ binddn\fR]
[\c [\c
...@@ -31,36 +39,32 @@ ldapdelete \- LDAP delete entry tool ...@@ -31,36 +39,32 @@ ldapdelete \- LDAP delete entry tool
[\c [\c
.BI \-h \ ldaphost\fR] .BI \-h \ ldaphost\fR]
[\c [\c
.BI \-p \ ldapport\fR]
[\c
.BR \-P \ { 2 \||\| 3 }] .BR \-P \ { 2 \||\| 3 }]
[\c [\c
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
[\c [\c
.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
[\c [\c
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ]] .BI \-o \ opt \fR[= optparam \fR]]
[\c
.BI \-p \ ldapport\fR]
[\c [\c
.BI \-O \ security-properties\fR] .BI \-O \ security-properties\fR]
[\c [\c
.BI \-U \ authcid\fR] .BR \-I ]
[\c
.BI \-R \ realm\fR]
[\c [\c
.BR \-r ] .BR \-Q ]
[\c [\c
.BR \-x ] .BR \-N ]
[\c [\c
.BR \-I ] .BI \-U \ authcid\fR]
[\c [\c
.BR \-Q ] .BI \-R \ realm\fR]
[\c [\c
.BI \-X \ authzid\fR] .BI \-X \ authzid\fR]
[\c [\c
.BI \-Y \ mech\fR] .BI \-Y \ mech\fR]
[\c [\c
.BI \-z \ sizelimit\fR]
[\c
.BR \-Z [ Z ]] .BR \-Z [ Z ]]
[\c [\c
.IR DN \ [ ... ]] .IR DN \ [ ... ]]
...@@ -80,6 +84,15 @@ are provided, a list of DNs is read from standard input (or from ...@@ -80,6 +84,15 @@ are provided, a list of DNs is read from standard input (or from
\fIfile\fP if the \fB\-f\fP flag is used). \fIfile\fP if the \fB\-f\fP flag is used).
.SH OPTIONS .SH OPTIONS
.TP .TP
.BR \-V [ V ]
Print version info.
If \fB\-VV\fP is given, only the version information is printed.
.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 \-n .B \-n
Show what would be done, but don't actually delete entries. Useful for Show what would be done, but don't actually delete entries. Useful for
debugging in conjunction with \fB\-v\fP. debugging in conjunction with \fB\-v\fP.
...@@ -93,20 +106,26 @@ Continuous operation mode. Errors are reported, but ...@@ -93,20 +106,26 @@ Continuous operation mode. Errors are reported, but
will continue with deletions. The default is to exit after will continue with deletions. The default is to exit after
reporting an error. reporting an error.
.TP .TP
.BI \-f \ file
Read a series of DNs from \fIfile\fP, one per line, performing an
LDAP delete for each.
.TP
.B \-r
Do a recursive delete. If the DN specified isn't a leaf, its
children, and all their children are deleted down the tree. No
verification is done, so if you add this switch, ldapdelete will
happily delete large portions of your tree. Use with care.
.TP
.BI \-z \ sizelimit
Use \fIsizelimit\fP when searching for children DN to delete,
to circumvent any server-side size limit. Only useful in conjunction
with \fB\-r\fP.
.TP
.BR \-M [ M ] .BR \-M [ M ]
Enable manage DSA IT control. Enable manage DSA IT control.
.B \-MM .B \-MM
makes control critical. makes control critical.
.TP .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
.BI \-f \ file
Read a series of DNs from \fIfile\fP, one per line, performing an
LDAP delete for each.
.TP
.B \-x .B \-x
Use simple authentication instead of SASL. Use simple authentication instead of SASL.
.TP .TP
...@@ -171,7 +190,7 @@ Delete extensions: ...@@ -171,7 +190,7 @@ Delete extensions:
(none) (none)
.fi .fi
.TP .TP
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ] .BI \-o \ opt \fR[= optparam \fR]
Specify general options. Specify general options.
...@@ -181,17 +200,6 @@ General options: ...@@ -181,17 +200,6 @@ General options:
ldif-wrap=<width> (in columns, or "no" for no wrapping) ldif-wrap=<width> (in columns, or "no" for no wrapping)
.fi .fi
.TP .TP
.B \-r
Do a recursive delete. If the DN specified isn't a leaf, its
children, and all their children are deleted down the tree. No
verification is done, so if you add this switch, ldapdelete will
happily delete large portions of your tree. Use with care.
.TP
.BI \-z \ sizelimit
Use \fIsizelimit\fP when searching for children DN to delete,
to circumvent any server-side size limit. Only useful in conjunction
with \fB\-r\fP.
.TP
.BI \-O \ security-properties .BI \-O \ security-properties
Specify SASL security properties. Specify SASL security properties.
.TP .TP
...@@ -202,6 +210,9 @@ only as needed. ...@@ -202,6 +210,9 @@ only as needed.
.B \-Q .B \-Q
Enable SASL Quiet mode. Never prompt. Enable SASL Quiet mode. Never prompt.
.TP .TP
.B \-N
Do not use reverse DNS to canonicalize SASL host name.
.TP
.BI \-U \ authcid .BI \-U \ authcid
Specify the authentication ID for SASL bind. The form of the identity depends on the Specify the authentication ID for SASL bind. The form of the identity depends on the
actual SASL mechanism used. actual SASL mechanism used.
......
...@@ -20,52 +20,50 @@ ldapexop \- issue LDAP extended operations ...@@ -20,52 +20,50 @@ ldapexop \- issue LDAP extended operations
.SH SYNOPSIS .SH SYNOPSIS
ldapexop ldapexop
[\c [\c
.BI \-d \ level\fR] .BR \-V [ V ]]
[\c [\c
.BI \-D \ binddn\fR] .BI \-d \ debuglevel\fR]
[\c [\c
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] .BR \-n ]
[\c [\c
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ]] .BR \-v ]
[\c [\c
.BI \-f \ file\fR] .BI \-f \ file\fR]
[\c [\c
.BI \-h \ host\fR] .BR \-x ]
[\c [\c
.BI \-H \ URI\fR] .BI \-D \ binddn\fR]
[\c [\c
.BR \-I ] .BR \-W ]
[\c [\c
.BR \-n ] .BI \-w \ passwd\fR]
[\c [\c
.BR \-N ] .BI \-y \ passwdfile\fR]
[\c [\c
.BI \-O \ security-properties\fR] .BI \-H \ URI\fR]
[\c [\c
.BI \-o \ opt\fR[\fP = optparam\fR]] .BI \-h \ ldaphost\fR]
[\c [\c
.BI \-p \ port\fR] .BI \-p \ ldapport\fR]
[\c [\c
.BR \-Q ] .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
[\c [\c
.BI \-R \ realm\fR] .BI \-o \ opt \fR[= optparam \fR]]
[\c [\c
.BI \-U \ authcid\fR] .BI \-O \ security-properties\fR]
[\c [\c
.BR \-v ] .BR \-I ]
[\c [\c
.BR \-V ] .BR \-Q ]
[\c [\c
.BI \-w \ passwd\fR] .BR \-N ]
[\c [\c
.BR \-W ] .BI \-U \ authcid\fR]
[\c [\c
.BR \-x ] .BI \-R \ realm\fR]
[\c [\c
.BI \-X \ authzid\fR] .BI \-X \ authzid\fR]
[\c [\c
.BI \-y \ file\fR]
[\c
.BI \-Y \ mech\fR] .BI \-Y \ mech\fR]
[\c [\c
.BR \-Z [ Z ]] .BR \-Z [ Z ]]
...@@ -123,12 +121,53 @@ results in ...@@ -123,12 +121,53 @@ results in
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-d \ level .BI \-V [ V ]
Set the LDAP debugging level to \fIlevel\fP. Print version info.
If\fB\-VV\fP is given, only the version information is printed.
.TP
.BI \-d \ debuglevel
Set the LDAP debugging level to \fIdebuglevel\fP.
.TP
.BI \-n
Show what would be done but don't actually do it.
Useful for debugging in conjunction with \fB\-v\fP.
.TP
.BI \-v
Run in verbose mode, with many diagnostics written to standard output.
.TP
.BI \-f \ file
Read operations from \fIfile\fP.
.TP
.BI \-x
Use simple authentication instead of SASL.
.TP .TP
.BI \-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.
.TP .TP
.BI \-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
.BI \-y \ passwdfile
Use complete contents of \fIpasswdfile\fP as the password for
simple authentication.
.TP
.BI \-H \ URI
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 the host on which the ldap server is running.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-p \ ldapport
Specify the TCP port where the ldap server is listening.
Deprecated in favor of \fB\-H\fP.
.TP
.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ] .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
Specify general extensions. \'!\' indicates criticality. Specify general extensions. \'!\' indicates criticality.
.nf .nf
...@@ -148,7 +187,7 @@ Specify general extensions. \'!\' indicates criticality. ...@@ -148,7 +187,7 @@ Specify general extensions. \'!\' indicates criticality.
not really controls) not really controls)
.fi .fi
.TP .TP
.BR \-o \ \fIopt\fP [ =\fIoptparam\fP ] .BI \-o \ opt \fR[= optparam \fR]
Specify general options. Specify general options.
...@@ -158,69 +197,26 @@ General options: ...@@ -158,69 +197,26 @@ General options:
ldif-wrap=<width> (in columns, or "no" for no wrapping) ldif-wrap=<width> (in columns, or "no" for no wrapping)
.fi .fi
.TP .TP
.BI \-f \ file .BI \-O \ security-properties
Read operations from \fIfile\fP. Specify SASL security properties.
.TP
.BI \-h \ host
Specify the host on which the ldap server is running.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-H \ URI
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 .TP
.BI \-I .BI \-I
Enable SASL Interactive mode. Always prompt. Default is to prompt Enable SASL Interactive mode. Always prompt. Default is to prompt
only as needed. only as needed.
.TP .TP
.BI \-n
Show what would be done but don't actually do it.
Useful for debugging in conjunction with \fB\-v\fP.
.TP
.BI \-N
Do not use reverse DNS to canonicalize SASL host name.
.TP
.BI \-O \ security-properties
Specify SASL security properties.
.TP
.BI \-o \ opt\fR[\fP = optparam\fR]
Specify general options:
.nf
nettimeout=<timeout> (in seconds, or "none" or "max")
.fi
.TP
.BI \-p \ port
Specify the TCP port where the ldap server is listening.
Deprecated in favor of \fB\-H\fP.
.TP
.BI \-Q .BI \-Q
Enable SASL Quiet mode. Never prompt. Enable SASL Quiet mode. Never prompt.
.TP .TP
.BI \-R \ realm .B \-N
Specify the realm of authentication ID for SASL bind. The form of the realm Do not use reverse DNS to canonicalize SASL host name.
depends on the actual SASL mechanism used.
.TP .TP
.BI \-U \ authcid .BI \-U \ authcid
Specify the authentication ID for SASL bind. The form of the ID Specify the authentication ID for SASL bind. The form of the ID
depends on the actual SASL mechanism used. depends on the actual SASL mechanism used.
.TP .TP
.BI \-v .BI \-R \ realm
Run in verbose mode, with many diagnostics written to standard output. Specify the realm of authentication ID for SASL bind. The form of the realm
.TP depends on the actual SASL mechanism used.
.BI \-V
Print version info and usage message.
If\fB\-VV\fP is given, only the version information is printed.
.TP
.BI \-w \ passwd
Use \fIpasswd\fP as the password for simple authentication.
.TP
.BI \-W
Prompt for simple authentication.
This is used instead of specifying the password on the command line.
.TP
.BI \-x
Use simple authentication instead of SASL.
.TP .TP
.BI \-X \ authzid .BI \-X \ authzid
Specify the requested authorization ID for SASL bind. Specify the requested authorization ID for SASL bind.
...@@ -230,10 +226,6 @@ must be one of the following formats: ...@@ -230,10 +226,6 @@ must be one of the following formats:
or or
.BI u: <username> .BI u: <username>
.TP .TP
.BI \-y \ file
Use complete contents of \fIfile\fP as the password for
simple authentication.
.TP
.BI \-Y \ mech .BI \-Y \ mech
Specify the SASL mechanism to be used for authentication. Specify the SASL mechanism to be used for authentication.
Without this option, the program will choose the best mechanism the server knows. Without this option, the program will choose the best mechanism the server knows.
......
...@@ -7,19 +7,25 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools ...@@ -7,19 +7,25 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools
.SH SYNOPSIS .SH SYNOPSIS
.B ldapmodify .B ldapmodify
[\c [\c
.BR \-a ] .BR \-V [ V ]]
[\c
.BR \-c ]
[\c [\c
.BI \-S \ file\fR] .BI \-d \ debuglevel\fR]
[\c [\c
.BR \-n ] .BR \-n ]
[\c [\c
.BR \-v ] .BR \-v ]
[\c [\c
.BR \-a ]
[\c
.BR \-c ]
[\c
.BI \-f \ file\fR]
[\c
.BI \-S \ file\fR]
[\c
.BR \-M [ M ]] .BR \-M [ M ]]
[\c [\c
.BI \-d \ debuglevel\fR] .BR \-x ]
[\c [\c
.BI \-D \ binddn\fR]