search

andykuszyk / noman.el

An Emacs package for browsing CLI command docs without man pages
GNU General Public License v3.0
13 stars 4 forks source link

Feature request: include version information in output #1

Closed suhail-singh closed 4 months ago

suhail-singh commented 5 months ago

For commands that support --version, it would be helpful if the noman output included it as well.

andykuszyk commented 5 months ago

That's a great idea, thanks for the suggestion!

How were you imagining the version being displayed? There noman buffer itself just contains the parsed help output.

I suppose it could display the version and other useful metadata in the buffer header line?

suhail-singh commented 5 months ago

I was imagining the information being included in the noman buffer itself, similar to how some tools such as help2man solve this task (i.e., a NAME section in the beginning with the canonical command name as well as the version information). While we don't have to match the output exactly, it may be helpful to consider this example help2man output: https://www.gnu.org/software/help2man/#Example

Now help2man tries hard to conform the output to standard manpages. I don't believe noman needs to aim for that. But a NAME section at the top with version information would be helpful. Having it be mangled in the name of the buffer generated as well, might have additional utility too.