From c2db986060723d5a22aa85bcc2b31a85d50455b8 Mon Sep 17 00:00:00 2001 From: Jan Vcelak Date: Wed, 22 Feb 2012 15:37:14 +0100 Subject: [PATCH] fix: missing options in manual pages of client tools Resolves: #796232 --- openldap-man-clients-missing-options.patch | 639 +++++++++++++++++++++ openldap.spec | 7 +- 2 files changed, 645 insertions(+), 1 deletion(-) create mode 100644 openldap-man-clients-missing-options.patch diff --git a/openldap-man-clients-missing-options.patch b/openldap-man-clients-missing-options.patch new file mode 100644 index 0000000..1a71b1a --- /dev/null +++ b/openldap-man-clients-missing-options.patch @@ -0,0 +1,639 @@ +man: add missing options to the client tools + +Summary of changes: + - typo in '-o' in --help output + - missing '-C' in ldapsearch and ldapcompare + - manpages all tools: + + add -o description (general options) + + add -N description (reverse DNS SASL host name canonicalization) + - manpages ldapsearch, ldapcompare: + + add -C (perform referral chasing) + +Author: Jan Vcelak +Upstream ITS: #7177 +Resolves: #796232 + +diff --git a/clients/tools/common.c b/clients/tools/common.c +index 0eacbbb..63e246c 100644 +--- a/clients/tools/common.c ++++ b/clients/tools/common.c +@@ -341,7 +341,7 @@ N_(" -I use SASL Interactive mode\n"), + N_(" -n show what would be done but don't actually do it\n"), + N_(" -N do not use reverse DNS to canonicalize SASL host name\n"), + N_(" -O props SASL security properties\n"), +-N_(" -o [=[=] general options\n"), + N_(" nettimeout= (in seconds, or \"none\" or \"max\")\n"), + N_(" ldif-wrap= (in columns, or \"no\" for no wrapping)\n"), + N_(" -p port port on LDAP server\n"), +diff --git a/clients/tools/ldapcompare.c b/clients/tools/ldapcompare.c +index 831f116..9808fb2 100644 +--- a/clients/tools/ldapcompare.c ++++ b/clients/tools/ldapcompare.c +@@ -83,6 +83,7 @@ usage( void ) + fprintf( stderr, _(" b64value\tbase64 encoding of assertion value\n")); + + fprintf( stderr, _("Compare options:\n")); ++ fprintf( stderr, _(" -C enable referrals chasing\n")); + fprintf( stderr, _(" -E [!][=] compare extensions (! indicates criticality)\n")); + fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n")); + fprintf( stderr, _(" -M enable Manage DSA IT control (-MM to make critical)\n")); +diff --git a/clients/tools/ldapsearch.c b/clients/tools/ldapsearch.c +index 8aaccd4..eabfd52 100644 +--- a/clients/tools/ldapsearch.c ++++ b/clients/tools/ldapsearch.c +@@ -124,6 +124,7 @@ usage( void ) + fprintf( stderr, _(" -A retrieve attribute names only (no values)\n")); + fprintf( stderr, _(" -b basedn base dn for search\n")); + fprintf( stderr, _(" -c continuous operation mode (do not stop on errors)\n")); ++ fprintf( stderr, _(" -C enable referrals chasing\n")); + fprintf( stderr, _(" -E [!][=] search extensions (! indicates criticality)\n")); + fprintf( stderr, _(" [!]domainScope (domain scope)\n")); + fprintf( stderr, _(" !dontUseCopy (Don't Use Copy)\n")); +diff --git a/doc/man/man1/ldapcompare.1 b/doc/man/man1/ldapcompare.1 +index a732522..dba49fd 100644 +--- a/doc/man/man1/ldapcompare.1 ++++ b/doc/man/man1/ldapcompare.1 +@@ -9,6 +9,8 @@ ldapcompare \- LDAP compare tool + [\c + .BR \-n ] + [\c ++.BR \-C ] ++[\c + .BR \-v ] + [\c + .BR \-z ] +@@ -37,12 +39,18 @@ ldapcompare \- LDAP compare tool + [\c + .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -81,6 +89,9 @@ TRUE, FALSE, or UNDEFINED on standard output. + Show what would be done, but don't actually perform the compare. Useful for + debugging in conjunction with \fB\-v\fP. + .TP ++.B \-C ++Enable referrals chasing. ++.TP + .B \-v + Run in verbose mode, with many diagnostics written to standard output. + .TP +@@ -174,6 +185,30 @@ Search extensions: + rp[/][/] (LDAP Sync refreshAndPersist) + .fi + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -184,6 +219,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldapdelete.1 b/doc/man/man1/ldapdelete.1 +index c437074..e0822d0 100644 +--- a/doc/man/man1/ldapdelete.1 ++++ b/doc/man/man1/ldapdelete.1 +@@ -39,6 +39,10 @@ ldapdelete \- LDAP delete entry tool + [\c + .BI \-p \ ldapport\fR] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BI \-U \ authcid\fR] +@@ -53,6 +57,8 @@ ldapdelete \- LDAP delete entry tool + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-X \ authzid\fR] + [\c + .BI \-Y \ mech\fR] +@@ -180,6 +186,30 @@ 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 \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++or infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -190,6 +220,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the identity depends on the + actual SASL mechanism used. +diff --git a/doc/man/man1/ldapexop.1 b/doc/man/man1/ldapexop.1 +index f857dd2..84fb158 100644 +--- a/doc/man/man1/ldapexop.1 ++++ b/doc/man/man1/ldapexop.1 +@@ -36,16 +36,18 @@ ldapexop + [\c + .BR \-n ] + [\c +-.BR \-N ] ++.BI \-o \ option=value\fR] + [\c +-.BI \-O \ security-properties\fR] ++.BR \-V [ V ]] + [\c +-.BI \-o \ opt\fR[\fP = optparam\fR]] ++.BI \-O \ security-properties\fR] + [\c + .BI \-p \ port\fR] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-R \ realm\fR] + [\c + .BI \-U \ authcid\fR] +@@ -166,18 +168,33 @@ only as needed. + 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. ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. + .TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +-.BI \-o \ opt\fR[\fP = optparam\fR] +-Specify general options: +-.nf +- nettimeout= (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. +@@ -185,6 +202,9 @@ Deprecated in favor of \fB\-H\fP. + .BI \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.BI \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-R \ realm + Specify the realm of authentication ID for SASL bind. The form of the realm + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldapmodify.1 b/doc/man/man1/ldapmodify.1 +index 72740c6..afe7aae 100644 +--- a/doc/man/man1/ldapmodify.1 ++++ b/doc/man/man1/ldapmodify.1 +@@ -41,12 +41,18 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools + [\c + .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -91,12 +97,18 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools + [\c + .BR \-P \ { 2 \||\| 3 }] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -203,6 +215,30 @@ Deprecated in favor of \fB\-H\fP. + .BR \-P \ { 2 \||\| 3 } + Specify the LDAP protocol version to use. + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -243,6 +279,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldapmodrdn.1 b/doc/man/man1/ldapmodrdn.1 +index 4eb14e7..3f04fa9 100644 +--- a/doc/man/man1/ldapmodrdn.1 ++++ b/doc/man/man1/ldapmodrdn.1 +@@ -41,12 +41,18 @@ ldapmodrdn \- LDAP rename entry tool + [\c + .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -145,6 +151,30 @@ Deprecated in favor of \fB\-H\fP. + .BR \-P \ { 2 \||\| 3 } + Specify the LDAP protocol version to use. + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -185,6 +215,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldappasswd.1 b/doc/man/man1/ldappasswd.1 +index 6860ac4..647aac7 100644 +--- a/doc/man/man1/ldappasswd.1 ++++ b/doc/man/man1/ldappasswd.1 +@@ -39,12 +39,18 @@ ldappasswd \- change the password of an LDAP entry + [\c + .BI \-y \ passwdfile\fR] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -142,6 +148,30 @@ Use \fIpasswd\fP as the password to bind with. + Use complete contents of \fIpasswdfile\fP as the password for + simple authentication. + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -152,6 +182,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldapsearch.1 b/doc/man/man1/ldapsearch.1 +index 1b147e6..9243e3e 100644 +--- a/doc/man/man1/ldapsearch.1 ++++ b/doc/man/man1/ldapsearch.1 +@@ -11,6 +11,8 @@ ldapsearch \- LDAP search tool + [\c + .BR \-c ] + [\c ++.BR \-C ] ++[\c + .BR \-u ] + [\c + .BR \-v ] +@@ -65,12 +67,18 @@ ldapsearch \- LDAP search tool + [\c + .BI \-z \ sizelimit\fR] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -116,6 +124,9 @@ Continuous operation mode. Errors are reported, but ldapsearch will continue + with searches. The default is to exit after reporting an error. Only useful + in conjunction with \fB\-f\fP. + .TP ++.B \-C ++Enable referrals chasing. ++.TP + .B \-u + Include the User Friendly Name form of the Distinguished Name (DN) + in the output. +@@ -310,6 +321,30 @@ means the maximum integer allowable by the protocol. + A server may impose a maximal sizelimit which only + the root user may override. + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -320,6 +355,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +diff --git a/doc/man/man1/ldapwhoami.1 b/doc/man/man1/ldapwhoami.1 +index 39653d0..6891a5d 100644 +--- a/doc/man/man1/ldapwhoami.1 ++++ b/doc/man/man1/ldapwhoami.1 +@@ -33,12 +33,18 @@ ldapwhoami \- LDAP who am i? tool + [\c + .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] + [\c ++.BI \-o \ option=value\fR] ++[\c ++.BR \-V [ V ]] ++[\c + .BI \-O \ security-properties\fR] + [\c + .BR \-I ] + [\c + .BR \-Q ] + [\c ++.BR \-N ] ++[\c + .BI \-U \ authcid\fR] + [\c + .BI \-R \ realm\fR] +@@ -103,6 +109,30 @@ Deprecated in favor of \fB\-H\fP. + Specify an alternate TCP port where the ldap server is listening. + Deprecated in favor of \fB\-H\fP. + .TP ++.BR \-o \ \fIoption \fB= \fIvalue\fP ++Specify general options. ++.RS ++.TP ++.B nettimeout ++Network timeout after which the remote side inactivity will be assumed. The ++.I value ++is either a number of seconds, ++.B none ++for zero timeout, or ++.B max ++for infinite timeout. ++.TP ++.B ldif-wrap ++Width of the LDIF output. The ++.I value ++is either a number of columns, or ++.B no ++to disable output wrapping. ++.RE ++.TP ++.BR \-V [ V ] ++Print version info. If \fB\-VV\fP is used, the command will exit afterwards. ++.TP + .BI \-O \ security-properties + Specify SASL security properties. + .TP +@@ -143,6 +173,9 @@ only as needed. + .B \-Q + Enable SASL Quiet mode. Never prompt. + .TP ++.B \-N ++Disable reverse DNS lookups to canonicalize SASL host names. ++.TP + .BI \-U \ authcid + Specify the authentication ID for SASL bind. The form of the ID + depends on the actual SASL mechanism used. +-- +1.7.6.5 + diff --git a/openldap.spec b/openldap.spec index 6c73a24..1e92587 100644 --- a/openldap.spec +++ b/openldap.spec @@ -8,7 +8,7 @@ Name: openldap Version: 2.4.29 -Release: 3%{?dist} +Release: 4%{?dist} Summary: LDAP support libraries Group: System Environment/Daemons License: OpenLDAP @@ -39,6 +39,7 @@ Patch7: openldap-dns-priority.patch Patch8: openldap-syncrepl-unset-tls-options.patch Patch9: openldap-result-write-polling.patch Patch10: openldap-constraint-count.patch +Patch11: openldap-man-clients-missing-options.patch # Fedora specific patches Patch100: openldap-fedora-systemd.patch @@ -144,6 +145,7 @@ pushd openldap-%{version} %patch8 -p1 %patch9 -p1 %patch10 -p1 +%patch11 -p1 %patch100 -p1 @@ -655,6 +657,9 @@ exit 0 %{evolution_connector_prefix}/ %changelog +* Wed Feb 22 2012 Jan Vcelak 2.4.29-4 +- fix: missing options in manual pages of client tools (#796232) + * Tue Feb 21 2012 Jan Vcelak 2.4.29-3 - fix: ldap_result does not succeed for sssd (#771484) - Jan Synáček :