Announce: manpages as html in a container
Hi, since the beginning has openSUSE MicroOS one deficit: documentation will not be installed. For standard commands this is no problem: you can read the manpages on Tumbleweed, Leap, ... or other distributions or web pages. But for some MicroOS specific tools this is no option. Back in the "good old times" some decades ago Sun had something I really liked: a documentation server serving all documentation, which you could also install on the local network. This is what I always wanted to have for openSUSE, too :) Now here it is, start your own MicroOS documentation server: podman run -it --rm --name docserv -p 80:80 -p 443:443 opensuse/microos-docserv and connect as http://localhost or https://localhost with your webbrowser to browse, search and read our manual pages. The next goal is, to not only provide a container with the manual pages for MicroOS, but something like "manpages.opensuse.org" containing all manpages from openSUSE Tumbleweed! But for this help is needed: 1. Working style sheet Alexandre was so nice and created something for the start. But this needs more testing and bug fixing, especially the mobile support. 2. Generate somehow the data for the webpages We need access to a full tree of openSUSE Tumbleweed, generate the data and upload it to a webserver 3. manpages.opensuse.org We need that sub-domain, and a machine serving the data 4. Integrate additional documentation How can we integrate other docu? texinfo? HTML docu? Every help is welcome and needed for testing, development, integration. The github repo is https://github.com/thkukuk/rpm2docserv Packages and the container description are already part of Tumbleweed. The whole idea and parts of the code are based on the debiman project from Debian. Thorsten -- Thorsten Kukuk, Distinguished Engineer, Senior Architect SUSE Software Solutions Germany GmbH, Frankenstraße 146, 90461 Nuernberg, Germany Managing Director: Ivo Totev, Andrew Myers, Andrew McDonald, Martje Boudien Moerman (HRB 36809, AG Nürnberg)
On 2022-09-27 12:06, Thorsten Kukuk wrote:
Hi,
Notice that in some tools the good documentation are info pages, not man. And for some others, it is a tree under /usr/share/doc/packages/whatever I don't know if it is of interest, but there was a package called man-all or something similar. -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On Tue, Sep 27, Carlos E. R. wrote:
And why did you remove that part from my mail in your quote then?
And for some others, it is a tree under /usr/share/doc/packages/whatever
Again, why did you remove exactly this part then? Thorsten -- Thorsten Kukuk, Distinguished Engineer, Senior Architect SUSE Software Solutions Germany GmbH, Frankenstraße 146, 90461 Nuernberg, Germany Managing Director: Ivo Totev, Andrew Myers, Andrew McDonald, Martje Boudien Moerman (HRB 36809, AG Nürnberg)
On 9/27/22 12:15, Carlos E. R. wrote:
Notice that info pages are also very legacy format which lacks any richer formatting support. HTML (real HTML) is a format that offers that via tools like Sphinx, please take a look at ReadTheDocs for what it means a nice documentation. One example: https://docs.godotengine.org/en/latest/ Cheers, Martin
And for some others, it is a tree under /usr/share/doc/packages/whatever
I don't know if it is of interest, but there was a package called man-all or something similar.
On 2022-09-27 12:24, Thorsten Kukuk wrote:
Because I did not see it.
And for some others, it is a tree under /usr/share/doc/packages/whatever
Again, why did you remove exactly this part then?
Because I did not see it. -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On 2022-09-27 12:26, Martin Liška wrote:
Sure, but you have no choice if what a package provides are info pages, and a more or less complete summary in the man pages. Example: man date (291 lines) info date (8 chapters) -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On 9/27/22 12:56, Carlos E. R. wrote:
Wait, at least typical GNU packages like coreutils (where date(1) belongs to) offer various formats of the Texinfo manual. E.g. https://www.gnu.org/software/coreutils/manual/ various HTML formats (one page, one page per node, etc.), ASCII, info document, TeX DVI, PDF and finally the Texinfo source. One of the HTML formats or PDF should be fine. Have a nice day, Berny
On 2022-09-27 12:06, Thorsten Kukuk wrote:
Hi,
Notice that in some tools the good documentation are info pages, not man. And for some others, it is a tree under /usr/share/doc/packages/whatever I don't know if it is of interest, but there was a package called man-all or something similar. -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On Tue, Sep 27, Carlos E. R. wrote:
And why did you remove that part from my mail in your quote then?
And for some others, it is a tree under /usr/share/doc/packages/whatever
Again, why did you remove exactly this part then? Thorsten -- Thorsten Kukuk, Distinguished Engineer, Senior Architect SUSE Software Solutions Germany GmbH, Frankenstraße 146, 90461 Nuernberg, Germany Managing Director: Ivo Totev, Andrew Myers, Andrew McDonald, Martje Boudien Moerman (HRB 36809, AG Nürnberg)
On 9/27/22 12:15, Carlos E. R. wrote:
Notice that info pages are also very legacy format which lacks any richer formatting support. HTML (real HTML) is a format that offers that via tools like Sphinx, please take a look at ReadTheDocs for what it means a nice documentation. One example: https://docs.godotengine.org/en/latest/ Cheers, Martin
And for some others, it is a tree under /usr/share/doc/packages/whatever
I don't know if it is of interest, but there was a package called man-all or something similar.
On 2022-09-27 12:24, Thorsten Kukuk wrote:
Because I did not see it.
And for some others, it is a tree under /usr/share/doc/packages/whatever
Again, why did you remove exactly this part then?
Because I did not see it. -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On 2022-09-27 12:26, Martin Liška wrote:
Sure, but you have no choice if what a package provides are info pages, and a more or less complete summary in the man pages. Example: man date (291 lines) info date (8 chapters) -- Cheers / Saludos, Carlos E. R. (from 15.3 x86_64 at Telcontar)
On 9/27/22 12:56, Carlos E. R. wrote:
Wait, at least typical GNU packages like coreutils (where date(1) belongs to) offer various formats of the Texinfo manual. E.g. https://www.gnu.org/software/coreutils/manual/ various HTML formats (one page, one page per node, etc.), ASCII, info document, TeX DVI, PDF and finally the Texinfo source. One of the HTML formats or PDF should be fine. Have a nice day, Berny
participants (4)
-
Bernhard Voelker -
Carlos E. R. -
Martin Liška -
Thorsten Kukuk