Arch Linux

Please read this before reporting a bug:
https://wiki.archlinux.org/index.php/Reporting_Bug_Guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#61508 - [git] html manuals

Attached to Project: Arch Linux
Opened by Alexander Epaneshnikov (erik_pro) - Wednesday, 23 January 2019, 14:02 GMT
Last edited by Andreas Radke (AndyRTR) - Saturday, 16 October 2021, 05:37 GMT
Task Type Feature Request
Category Packages: Extra
Status Assigned   Reopened
Assigned To Christian Hesse (eworm)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 0%
Votes 0
Private No

Details

Is it possible to add html manuals to the package?


Additional info:
* package version(s)
* config and/or log files etc.


Steps to reproduce:
This task depends upon

Comment by Eli Schwartz (eschwartz) - Wednesday, 23 January 2019, 16:59 GMT
Why? What is the advantage of shipping the same content as the manpage manuals in a second format?
Comment by Alexander Epaneshnikov (erik_pro) - Wednesday, 23 January 2019, 19:25 GMT
because, in a graphical environment, such a help format seems more convenient to me.
perhaps it is worth at least creating an option to enable this.
Comment by Eli Schwartz (eschwartz) - Thursday, 24 January 2019, 16:42 GMT
"creating an option" to enable it? This isn't Gentoo and packages don't build from source, with options or otherwise. Either the official package provides it, or it doesn't.

If you want html documentation in a graphical environment, which requires opening a browser, why not use the online documentation?

Failing that, have you tried `man -H git` (converts a manpage to HTML and opens it in $BROWSER) or one of the other graphical programs which can read any manpage, which are listed at https://wiki.archlinux.org/index.php/Man_page#Viewer_applications ?
GNOME Yelp or KDE's KHelpCenter are in fact likely on many users' machines already.

If this can satisfy your use case (and in a manner which is IMO superior to navigating to file:///usr/share/doc/git/ every time you wish to read a manual) then I don't see the utility in adding HTML to the package. :)
Comment by Alexander Epaneshnikov (erik_pro) - Thursday, 24 January 2019, 17:45 GMT
hello eli.
oh man -H thanks... I feel stupid.
thanks for the explanation. I am ashamed of this report. please close it.
Comment by Jade (lf) - Thursday, 14 October 2021, 22:00 GMT
I would like to request that this choice to not ship git html manuals be reconsidered. man -H doesn't work properly for me with Firefox, but more to the point, is a strictly inferior experience than the git html manuals: those have hyperlinks to sections and other pages, and CSS, unlike man -H output. See, for example, git-pull(1), where, under "<repository>", there are hyperlinks to the "GIT URLS" and "REMOTES" sections.

Loading...