#3663 [RFE] Package help pages for subcommands as man pages
Closed: wontfix 5 years ago Opened 10 years ago by adelton.

As a new person to the command-line tools, when trying to use an example

ipa dnszone-mod

command I found in some documentation, I wanted to check the exact syntax. So I typed

man ipa-dnszone-mod

to get

# man ipa-dnszone-mod
No manual entry for ipa-dnszone-mod

I eventually found

ipa help dnszone-mod

but I wonder if when packaging the rpms, man pages could be generated. Besides, it turned out that I probably wanted

ipa help dns

as well and

ipa help dnszone-mod

did not really point me to that documentation.

For example, with git,

man git-diff

works, and even

man git diff

gives the git-diff man page. Having the man pages pre-generated and distributed in the rpms could make lives of some old-school admins easier when trying to use IPA CLI.


As Ana is moving out of the team, I am moving her unresolved tickets to free-to-take pool.

Metadata Update from @adelton:
- Issue assigned to someone
- Issue set to the milestone: Ticket Backlog

7 years ago

It looks adleton is trying to get man page out of

man ipa-dnsconfig-mod
and getting 'No manual entry for ipa-dnsconfig-mod' found.

But there is man page existent for

man ipa dnszone-mod

Which is the default command 'ipa dnszone-mod'.

I feel current behavior is correct as it's same for other ipa commands as well...

Thank you taking time to submit this request for FreeIPA. Unfortunately this bug was not given priority and the team lacks the capacity to work on it at this time.

Given that we are unable to fulfil this request I am closing the issue as wontfix. To request re-consideration of this decision please reopen this issue and provide additional technical details about its importance to you.

Metadata Update from @rcritten:
- Issue close_status updated to: wontfix
- Issue status updated to: Closed (was: Open)

5 years ago

Login to comment on this ticket.

Metadata