-
Notifications
You must be signed in to change notification settings - Fork 229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Publish manpages online #872
Comments
Probably you are aware of the following, I just wanted to mention it for others as well:
Be aware that some man pages are are only built when a certain configure flag is enabled/disabled (for example |
Yes, I didn't mention that above either, but it's not significantly harder to build a set of manpages per release.
I'm aware some distros do modify (I did notice there were no pre-rendered manpages while doing some documentation for a distro, but in that case I agree the correct solution is to render & publish the manpage from the distro's packages) |
Hmmm, I already do that for the Linux man-pages (as a PDF book, not as HTML). See https://www.alejandro-colomar.es/share/dist/man-pages/git/HEAD/man-pages-HEAD.pdf; I have a git hook regenerating the PDF every time I push to the main branch. I may do that for shadow stable releases and git HEAD, using the default configuration. The git hook will be in my server, to which I push manually, which means it may be a few commits behind GH, of course. |
https://www.alejandro-colomar.es/share/dist/shadow/git/HEAD/shadow-HEAD.pdf The navigation index of the PDF has some problems. I've reported them to the author of the script, so hopefully that'll get fixed soon. |
And the 4.15.0 ones (this one is PGP-signed, as it's manually uploaded): https://www.alejandro-colomar.es/share/dist/shadow/4/4.15/4.15.0/ |
Thanks to @DeriJames, we already have the PDF for the master branch with proper bookmarks (you can already find it in the link above). I won't regenerate the PDF for 4.15.0, but any new versions will be built with the fixed script. I could also publish the pages in the other languages, but I'd need to build Deri's branch of gropdf from source. I'll need to update the script to allow running a custom gropdf(1) that I'll install in /opt/local/. Cheers, |
Translations are now available at https://www.alejandro-colomar.es/share/dist/shadow/git/HEAD/man/. |
Would it be possible to publish
shadow
's manpages online, as rendered to HTML?I'm aware many distros already have some central service to query all their manpages from, but it would be really useful to have a reference source to link that is distro-agnostic and faithful-to-upstream.
The implementation could be as simple as a GitHub action that automatically builds and publishes the manpages when they are pushed to
master
.The text was updated successfully, but these errors were encountered: