Bug 468206

Summary:	slapd and slapcat : man pages details
Product:	Red Hat Enterprise Linux 5	Reporter:	Petr Sklenar <psklenar>
Component:	openldap	Assignee:	Jan Zeleny <jzeleny>
Status:	CLOSED ERRATA	QA Contact:	BaseOS QE <qe-baseos-auto>
Severity:	low	Docs Contact:
Priority:	low
Version:	5.4	CC:	jplans, omoris, ovasik
Target Milestone:	rc
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2010-03-30 08:05:46 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Petr Sklenar 2008-10-23 15:24:06 UTC

Description of problem:
slapd
`man slapd` doesn't describe options "-V" and "-o",  which are described in usage message (slapd --help)

slapcat
Usage message OMITS 1 supported option(s):  -s


Version-Release number of selected component (if applicable):
openldap-2.3.43-2.el5

How reproducible:


Steps to Reproduce:
1.man slapd vs slapd --help, options  "-V" and "-o"
2.man slapcat vs slapcat --help, option "-s"
  
Actual results:
missing option

Expected results:
same option in usage message and man page

Additional info:

Comment 3 Jan Zeleny 2009-11-16 09:50:03 UTC

Patch is in CVS, changing status to MODIFIED.

Comment 5 Ondrej Moriš 2009-11-23 14:58:11 UTC

There are still some minor issues concerning man pages vs. slapd --help

* -V, in man page has bad formatting (missing "empty line" between -o and -V)
* -T, in man page we have {a|c|d|i|p|t|acl|auth} instead of 
  {acl|add|auth|cat|dn|index|passwd|test}, confusing (?)
* -n service_name in man page and -n serverName in --help 

There is actually no --help or -h option of slapd. Usage is printed to stderr when invalid options are given. 

Not sure if this does need respin... does it?

Comment 6 Jan Zeleny 2009-11-23 15:20:25 UTC

I don't think it needs a respin. These are all cosmetic issues:
* empty line isn't really important, no information is missing because of it
* -T options are correct in both forms. And the longer form is used on top of that man page as well
* -n parameter serverName might be a little bit confusing, even though it is described as service name right after.

Now you have my opinion, but it's your call. I don't know exactly what is QA's policy about these minor issues.

Comment 7 Ondrej Moriš 2009-11-25 09:14:07 UTC

Agreed. Probably the best way is to switch this bug into verified (it's fixed) report a new bug with all these cosmetic issues. Thanks!

Comment 9 errata-xmlrpc 2010-03-30 08:05:46 UTC

An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on therefore solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHSA-2010-0198.html