2 ms·
Can't we just convert all man pages to a modern format like HTML, and never look back?
by amelius 2y ago
Can't we just convert all man pages to a modern format like HTML, and never look back?
- happosai 2y agoWell I read man pages Via debians web server precisely because they are easier to read in html. https://manpages.debian.org/bookworm/manpages-dev/syslog.3.en.html https://manpages.debian.org/bookworm/manpages-dev/syslog.3.e... Bit I don't think html would be a good source format.
- oneshtein 2y agoTry HTML version: man --html=firefox man
- Cthulhu_ 2y agoTriggered by your "modern format" comment, if my sleuthing is correct, the mdoc format was first introduced with "4.4BSD" from 1995, with a major update in the early 2000s', whereas HTML was first conceptualized in the 80's with a first major release in the early 90's; mdoc IS the modern format. Granted, it may not be the ideal format for documentation, but I'd argue neither is HTML - too much cruft for reading in a terminal and not very ergonomic to type out. I'd argue markdown or something like that would be a better fit, it's got support for the formatting and linking needed, most developers are familiar enough with it, you don't actually need to parse or render it to be able to read it, etc.
- amelius 2y agoFrom the mdoc manpage: > Many aspects of the basic syntax of the mdoc language are based on the roff(7) language So, I wouldn't say that mdoc is the modern format here ...
- pavon 2y agoAnd the basic syntax of HTML is based on SGML which was standardized in 1986, and which in turn was based on GML and COCOA from the 1960's.
- Lammy 2y agoRelevant: Compiled HTML Help (1997) https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help