Bug 1706386

Summary: [RFE] Discoverable man page names for DNF plugins
Product: Red Hat Enterprise Linux 8 Reporter: Michal Domonkos <mdomonko>
Component: dnf-plugins-coreAssignee: Lukáš Hrázký <lhrazky>
Status: CLOSED ERRATA QA Contact: Jan Blazek <jblazek>
Severity: unspecified Docs Contact:
Priority: low    
Version: 8.0CC: amatej, james.antill, lhrazky
Target Milestone: rcKeywords: FutureFeature, Triaged
Target Release: 8.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: dnf-4.2.17-1.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-04-28 16:47:49 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Michal Domonkos 2019-05-04 14:50:38 UTC 
Currently, it's quite difficult to discover the man pages for DNF subcommands (those that have a separate man page; that is, mostly plugins).  For example, for the "dnf config-manager" command, you have to type "man dnf.plugin.config_manager".  That's bad UX.  For end-users, whether a subcommand is implemented as a plugin or not is irrelevant.

I like how git does this (and probably other programs as well):

  $ git format-patch
  $ man git-format-patch

So, how about:

  $ dnf config-manager
  $ man dnf-config-manager

Obviously, not all the subcommands have a dedicated man page in DNF; and that's fine; for those, we can perhaps redirect to the main dnf(8).
Comment 1 Lukáš Hrázký 2019-11-08 13:55:44 UTC 
PRs:
https://github.com/rpm-software-management/dnf-plugins-core/pull/369
https://github.com/rpm-software-management/dnf-plugins-extras/pull/169
Comment 3 Lukáš Hrázký 2019-11-20 10:14:54 UTC 
There's also this PR for a minor reference change in DNF man page: https://github.com/rpm-software-management/dnf/pull/1528
Comment 8 errata-xmlrpc 2020-04-28 16:47:49 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:1823