Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 918719

Summary: Create MAN pages for command line scripts
Product: Red Hat Enterprise Linux 7 Reporter: Nathan Kinder <nkinder>
Component: 389-ds-baseAssignee: Rich Megginson <rmeggins>
Status: CLOSED CURRENTRELEASE QA Contact: Sankar Ramalingam <sramling>
Severity: unspecified Docs Contact:
Priority: medium    
Version: 7.0CC: jgalipea, mreynolds, nhosoi
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: 389-ds-base-1.3.1.2-1.el7 Doc Type: Enhancement
Doc Text:
Cause: The previous server instance specific scripts were centralized. Consequence: "man" pages did not exist for a system-wide available script. Change: "man" pages were created for all the new scripts that were made available /usr/bin. Result: The new centralized server scripts now have "man" pages.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2014-06-13 12:30:38 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 Nathan Kinder 2013-03-06 18:17:24 UTC 
This bug is created as a clone of upstream ticket:
https://fedorahosted.org/389/ticket/588

Since we have changed the instance specific scripts to be global (Ticket 528), there should be MAN pages for each script.
Comment 1 Rich Megginson 2013-10-01 23:27:07 UTC 
moving all ON_QA bugs to MODIFIED in order to add them to the errata (can't add bugs in the ON_QA state to an errata).  When the errata is created, the bugs should be automatically moved back to ON_QA.
Comment 3 Jenny Severance 2014-01-29 22:23:47 UTC 
The following binaries do not have man pages.  If this is okay - please set back to ON_QA.

# ./man-page-day.sh 389-ds-base | grep Error
[ Error ] binary /usr/bin/cl-dump.pl has no man page!
[ Error ] binary /usr/bin/dbscan-bin has no man page!
[ Error ] binary /usr/bin/dsktune-bin has no man page!
[ Error ] binary /usr/bin/infadd-bin has no man page!
[ Error ] binary /usr/bin/ldclt-bin has no man page!
[ Error ] binary /usr/bin/ldif-bin has no man page!
[ Error ] binary /usr/bin/migratecred-bin has no man page!
[ Error ] binary /usr/bin/mmldif-bin has no man page!
[ Error ] binary /usr/bin/pwdhash-bin has no man page!
[ Error ] binary /usr/bin/repl-monitor.pl has no man page!
[ Error ] binary /usr/bin/rsearch-bin has no man page!
[ Error ] binary /usr/sbin/ldap-agent-bin has no man page!

# rpm -qi 389-ds-base
Name        : 389-ds-base
Version     : 1.3.1.6
Release     : 15.el7
Architecture: x86_64
Install Date: Wed 29 Jan 2014 02:44:37 PM EST
Group       : System Environment/Daemons
Size        : 5531885
License     : GPLv2 with exceptions
Signature   : RSA/SHA256, Wed 22 Jan 2014 05:25:47 AM EST, Key ID 938a80caf21541eb
Source RPM  : 389-ds-base-1.3.1.6-15.el7.src.rpm
Build Date  : Tue 21 Jan 2014 05:50:44 PM EST
Build Host  : x86-024.build.eng.bos.redhat.com
Relocations : (not relocatable)
Packager    : Red Hat, Inc. <http://bugzilla.redhat.com/bugzilla>
Vendor      : Red Hat, Inc.
URL         : http://port389.org/
Summary     : 389 Directory Server (base)
Description :
389 Directory Server is an LDAPv3 compliant server.  The base package includes
the LDAP server and command line utilities for server administration.


The following do have man pages ...

# ./man-page-day.sh 389-ds-base | grep OK
[ OK ] binary /usr/bin/cl-dump has man page /usr/share/man/man1/cl-dump.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/dbgen.pl has man page /usr/share/man/man1/dbgen.pl.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/dbscan has man page /usr/share/man/man1/dbscan.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/ds-logpipe.py has man page /usr/share/man/man1/ds-logpipe.py.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/dsktune has man page /usr/share/man/man1/dsktune.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/infadd has man page /usr/share/man/man1/infadd.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/ldclt has man page /usr/share/man/man1/ldclt.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/ldif has man page /usr/share/man/man1/ldif.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/logconv.pl has man page /usr/share/man/man1/logconv.pl.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/migratecred has man page /usr/share/man/man1/migratecred.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/mmldif has man page /usr/share/man/man1/mmldif.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/pwdhash has man page /usr/share/man/man1/pwdhash.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/repl-monitor has man page /usr/share/man/man1/repl-monitor.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/bin/rsearch has man page /usr/share/man/man1/rsearch.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/sbin/bak2db has man page /usr/share/man/man8/bak2db.8.gz
[ OK ] binary /usr/sbin/bak2db.pl has man page /usr/share/man/man8/bak2db.pl.8.gz
[ OK ] binary /usr/sbin/cleanallruv.pl has man page /usr/share/man/man8/cleanallruv.pl.8.gz
[ OK ] binary /usr/sbin/db2bak has man page /usr/share/man/man8/db2bak.8.gz
[ OK ] binary /usr/sbin/db2bak.pl has man page /usr/share/man/man8/db2bak.pl.8.gz
[ OK ] binary /usr/sbin/db2index has man page /usr/share/man/man8/db2index.8.gz
[ OK ] binary /usr/sbin/db2index.pl has man page /usr/share/man/man8/db2index.pl.8.gz
[ OK ] binary /usr/sbin/db2ldif has man page /usr/share/man/man8/db2ldif.8.gz
[ OK ] binary /usr/sbin/db2ldif.pl has man page /usr/share/man/man8/db2ldif.pl.8.gz
[ OK ] binary /usr/sbin/dbverify has man page /usr/share/man/man8/dbverify.8.gz
[ OK ] binary /usr/sbin/dn2rdn has man page /usr/share/man/man8/dn2rdn.8.gz
[ OK ] binary /usr/sbin/fixup-linkedattrs.pl has man page /usr/share/man/man8/fixup-linkedattrs.pl.8.gz
[ OK ] binary /usr/sbin/fixup-memberof.pl has man page /usr/share/man/man8/fixup-memberof.pl.8.gz
[ OK ] binary /usr/sbin/ldap-agent has man page /usr/share/man/man1/ldap-agent.1.gz
[ OK ] man page is in section 1
[ OK ] binary /usr/sbin/ldif2db has man page /usr/share/man/man8/ldif2db.8.gz
[ OK ] binary /usr/sbin/ldif2db.pl has man page /usr/share/man/man8/ldif2db.pl.8.gz
[ OK ] binary /usr/sbin/ldif2ldap has man page /usr/share/man/man8/ldif2ldap.8.gz
[ OK ] binary /usr/sbin/migrate-ds.pl has man page /usr/share/man/man8/migrate-ds.pl.8.gz
[ OK ] binary /usr/sbin/monitor has man page /usr/share/man/man8/monitor.8.gz
[ OK ] binary /usr/sbin/ns-accountstatus.pl has man page /usr/share/man/man8/ns-accountstatus.pl.8.gz
[ OK ] binary /usr/sbin/ns-activate.pl has man page /usr/share/man/man8/ns-activate.pl.8.gz
[ OK ] binary /usr/sbin/ns-inactivate.pl has man page /usr/share/man/man8/ns-inactivate.pl.8.gz
[ OK ] binary /usr/sbin/ns-newpwpolicy.pl has man page /usr/share/man/man8/ns-newpwpolicy.pl.8.gz
[ OK ] binary /usr/sbin/ns-slapd has man page /usr/share/man/man8/ns-slapd.8.gz
[ OK ] binary /usr/sbin/remove-ds.pl has man page /usr/share/man/man8/remove-ds.pl.8.gz
[ OK ] binary /usr/sbin/restart-dirsrv has man page /usr/share/man/man8/restart-dirsrv.8.gz
[ OK ] binary /usr/sbin/restoreconfig has man page /usr/share/man/man8/restoreconfig.8.gz
[ OK ] binary /usr/sbin/saveconfig has man page /usr/share/man/man8/saveconfig.8.gz
[ OK ] binary /usr/sbin/schema-reload.pl has man page /usr/share/man/man8/schema-reload.pl.8.gz
[ OK ] binary /usr/sbin/setup-ds.pl has man page /usr/share/man/man8/setup-ds.pl.8.gz
[ OK ] binary /usr/sbin/start-dirsrv has man page /usr/share/man/man8/start-dirsrv.8.gz
[ OK ] binary /usr/sbin/stop-dirsrv has man page /usr/share/man/man8/stop-dirsrv.8.gz
[ OK ] binary /usr/sbin/suffix2instance has man page /usr/share/man/man8/suffix2instance.8.gz
[ OK ] binary /usr/sbin/syntax-validate.pl has man page /usr/share/man/man8/syntax-validate.pl.8.gz
[ OK ] binary /usr/sbin/upgradedb has man page /usr/share/man/man8/upgradedb.8.gz
[ OK ] binary /usr/sbin/upgradednformat has man page /usr/share/man/man8/upgradednformat.8.gz
[ OK ] binary /usr/sbin/usn-tombstone-cleanup.pl has man page /usr/share/man/man8/usn-tombstone-cleanup.pl.8.gz
[ OK ] binary /usr/sbin/verify-db.pl has man page /usr/share/man/man8/verify-db.pl.8.gz
[ OK ] binary /usr/sbin/vlvindex has man page /usr/share/man/man8/vlvindex.8.gz
Comment 4 Rich Megginson 2014-01-29 22:31:02 UTC 
(In reply to Jenny Galipeau from comment #3)
> The following binaries do not have man pages.  If this is okay - please set
> back to ON_QA.
> 
> # ./man-page-day.sh 389-ds-base | grep Error
> [ Error ] binary /usr/bin/cl-dump.pl has no man page!
> [ Error ] binary /usr/bin/dbscan-bin has no man page!
> [ Error ] binary /usr/bin/dsktune-bin has no man page!
> [ Error ] binary /usr/bin/infadd-bin has no man page!
> [ Error ] binary /usr/bin/ldclt-bin has no man page!
> [ Error ] binary /usr/bin/ldif-bin has no man page!
> [ Error ] binary /usr/bin/migratecred-bin has no man page!
> [ Error ] binary /usr/bin/mmldif-bin has no man page!
> [ Error ] binary /usr/bin/pwdhash-bin has no man page!
> [ Error ] binary /usr/bin/repl-monitor.pl has no man page!
> [ Error ] binary /usr/bin/rsearch-bin has no man page!

For all of these, we document to use the name of the file without the "-bin" or the ".pl" - so cl-dump, not cl-dump.pl, and cl-dump has a man page, etc.

> [ Error ] binary /usr/sbin/ldap-agent-bin has no man page!

This is not mean to be run by humans (aliens?).  At any rate, we've been waiving this for several years now - we should probably move it to /usr/libexec or something like that, but for now, this is ok.

> 
> # rpm -qi 389-ds-base
> Name        : 389-ds-base
> Version     : 1.3.1.6
> Release     : 15.el7
> Architecture: x86_64
> Install Date: Wed 29 Jan 2014 02:44:37 PM EST
> Group       : System Environment/Daemons
> Size        : 5531885
> License     : GPLv2 with exceptions
> Signature   : RSA/SHA256, Wed 22 Jan 2014 05:25:47 AM EST, Key ID
> 938a80caf21541eb
> Source RPM  : 389-ds-base-1.3.1.6-15.el7.src.rpm
> Build Date  : Tue 21 Jan 2014 05:50:44 PM EST
> Build Host  : x86-024.build.eng.bos.redhat.com
> Relocations : (not relocatable)
> Packager    : Red Hat, Inc. <http://bugzilla.redhat.com/bugzilla>
> Vendor      : Red Hat, Inc.
> URL         : http://port389.org/
> Summary     : 389 Directory Server (base)
> Description :
> 389 Directory Server is an LDAPv3 compliant server.  The base package
> includes
> the LDAP server and command line utilities for server administration.
> 
> 
> The following do have man pages ...
> 
> # ./man-page-day.sh 389-ds-base | grep OK
> [ OK ] binary /usr/bin/cl-dump has man page /usr/share/man/man1/cl-dump.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/dbgen.pl has man page
> /usr/share/man/man1/dbgen.pl.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/dbscan has man page /usr/share/man/man1/dbscan.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/ds-logpipe.py has man page
> /usr/share/man/man1/ds-logpipe.py.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/dsktune has man page /usr/share/man/man1/dsktune.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/infadd has man page /usr/share/man/man1/infadd.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/ldclt has man page /usr/share/man/man1/ldclt.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/ldif has man page /usr/share/man/man1/ldif.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/logconv.pl has man page
> /usr/share/man/man1/logconv.pl.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/migratecred has man page
> /usr/share/man/man1/migratecred.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/mmldif has man page /usr/share/man/man1/mmldif.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/pwdhash has man page /usr/share/man/man1/pwdhash.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/repl-monitor has man page
> /usr/share/man/man1/repl-monitor.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/bin/rsearch has man page /usr/share/man/man1/rsearch.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/sbin/bak2db has man page /usr/share/man/man8/bak2db.8.gz
> [ OK ] binary /usr/sbin/bak2db.pl has man page
> /usr/share/man/man8/bak2db.pl.8.gz
> [ OK ] binary /usr/sbin/cleanallruv.pl has man page
> /usr/share/man/man8/cleanallruv.pl.8.gz
> [ OK ] binary /usr/sbin/db2bak has man page /usr/share/man/man8/db2bak.8.gz
> [ OK ] binary /usr/sbin/db2bak.pl has man page
> /usr/share/man/man8/db2bak.pl.8.gz
> [ OK ] binary /usr/sbin/db2index has man page
> /usr/share/man/man8/db2index.8.gz
> [ OK ] binary /usr/sbin/db2index.pl has man page
> /usr/share/man/man8/db2index.pl.8.gz
> [ OK ] binary /usr/sbin/db2ldif has man page /usr/share/man/man8/db2ldif.8.gz
> [ OK ] binary /usr/sbin/db2ldif.pl has man page
> /usr/share/man/man8/db2ldif.pl.8.gz
> [ OK ] binary /usr/sbin/dbverify has man page
> /usr/share/man/man8/dbverify.8.gz
> [ OK ] binary /usr/sbin/dn2rdn has man page /usr/share/man/man8/dn2rdn.8.gz
> [ OK ] binary /usr/sbin/fixup-linkedattrs.pl has man page
> /usr/share/man/man8/fixup-linkedattrs.pl.8.gz
> [ OK ] binary /usr/sbin/fixup-memberof.pl has man page
> /usr/share/man/man8/fixup-memberof.pl.8.gz
> [ OK ] binary /usr/sbin/ldap-agent has man page
> /usr/share/man/man1/ldap-agent.1.gz
> [ OK ] man page is in section 1
> [ OK ] binary /usr/sbin/ldif2db has man page /usr/share/man/man8/ldif2db.8.gz
> [ OK ] binary /usr/sbin/ldif2db.pl has man page
> /usr/share/man/man8/ldif2db.pl.8.gz
> [ OK ] binary /usr/sbin/ldif2ldap has man page
> /usr/share/man/man8/ldif2ldap.8.gz
> [ OK ] binary /usr/sbin/migrate-ds.pl has man page
> /usr/share/man/man8/migrate-ds.pl.8.gz
> [ OK ] binary /usr/sbin/monitor has man page /usr/share/man/man8/monitor.8.gz
> [ OK ] binary /usr/sbin/ns-accountstatus.pl has man page
> /usr/share/man/man8/ns-accountstatus.pl.8.gz
> [ OK ] binary /usr/sbin/ns-activate.pl has man page
> /usr/share/man/man8/ns-activate.pl.8.gz
> [ OK ] binary /usr/sbin/ns-inactivate.pl has man page
> /usr/share/man/man8/ns-inactivate.pl.8.gz
> [ OK ] binary /usr/sbin/ns-newpwpolicy.pl has man page
> /usr/share/man/man8/ns-newpwpolicy.pl.8.gz
> [ OK ] binary /usr/sbin/ns-slapd has man page
> /usr/share/man/man8/ns-slapd.8.gz
> [ OK ] binary /usr/sbin/remove-ds.pl has man page
> /usr/share/man/man8/remove-ds.pl.8.gz
> [ OK ] binary /usr/sbin/restart-dirsrv has man page
> /usr/share/man/man8/restart-dirsrv.8.gz
> [ OK ] binary /usr/sbin/restoreconfig has man page
> /usr/share/man/man8/restoreconfig.8.gz
> [ OK ] binary /usr/sbin/saveconfig has man page
> /usr/share/man/man8/saveconfig.8.gz
> [ OK ] binary /usr/sbin/schema-reload.pl has man page
> /usr/share/man/man8/schema-reload.pl.8.gz
> [ OK ] binary /usr/sbin/setup-ds.pl has man page
> /usr/share/man/man8/setup-ds.pl.8.gz
> [ OK ] binary /usr/sbin/start-dirsrv has man page
> /usr/share/man/man8/start-dirsrv.8.gz
> [ OK ] binary /usr/sbin/stop-dirsrv has man page
> /usr/share/man/man8/stop-dirsrv.8.gz
> [ OK ] binary /usr/sbin/suffix2instance has man page
> /usr/share/man/man8/suffix2instance.8.gz
> [ OK ] binary /usr/sbin/syntax-validate.pl has man page
> /usr/share/man/man8/syntax-validate.pl.8.gz
> [ OK ] binary /usr/sbin/upgradedb has man page
> /usr/share/man/man8/upgradedb.8.gz
> [ OK ] binary /usr/sbin/upgradednformat has man page
> /usr/share/man/man8/upgradednformat.8.gz
> [ OK ] binary /usr/sbin/usn-tombstone-cleanup.pl has man page
> /usr/share/man/man8/usn-tombstone-cleanup.pl.8.gz
> [ OK ] binary /usr/sbin/verify-db.pl has man page
> /usr/share/man/man8/verify-db.pl.8.gz
> [ OK ] binary /usr/sbin/vlvindex has man page
> /usr/share/man/man8/vlvindex.8.gz
Comment 5 Jenny Severance 2014-01-29 22:37:35 UTC 
Thanks Rich!

There are a couple that are not *-bin

[ Error ] binary /usr/bin/cl-dump.pl has no man page!
[ Error ] binary /usr/bin/repl-monitor.pl has no man page!
Comment 6 Rich Megginson 2014-01-29 22:50:13 UTC 
(In reply to Jenny Galipeau from comment #5)
> Thanks Rich!
> 
> There are a couple that are not *-bin
> 
> [ Error ] binary /usr/bin/cl-dump.pl has no man page!
> [ Error ] binary /usr/bin/repl-monitor.pl has no man page!

Right - should use cl-dump and repl-monitor instead, and those have man pages.
Comment 7 Jenny Severance 2014-01-30 21:08:00 UTC 
Marking verified - man pages exist for cl-dump and repl-monitor
Thanks Rich
Comment 8 Ludek Smid 2014-06-13 12:30:38 UTC 
This request was resolved in Red Hat Enterprise Linux 7.0.

Contact your manager or support representative in case you have further questions about the request.