[haiku] Re: Documenting your package

  • From: pete.goodeve@xxxxxxxxxxxx
  • To: haiku@xxxxxxxxxxxxx
  • Date: Tue, 5 Apr 2016 22:28:42 -0700

On Tue, Apr 05, 2016 at 07:39:02AM -0700, Urias McCullough wrote:

On Tue, Apr 5, 2016 at 1:51 AM, Luposian <luposian@xxxxxxx> wrote:
Can't we just translate all documentation to a standard format, like plain 
ASCII or HTML or PDF or a cross-platform format that anyone can read 
without terminal commands or such?  Why continue to do things in such an 
archaic CLI fashion, in 2016, concerning, of all things, documentation?

You do realize we're talking about documentation of CLI tools here...
which should absolutely be accessible from a CLI. But as pointed out
by Thomas earlier in the thread, Konqueror (GUI web browser) was able
to view them and that is probably something we can do as well.

Converting them to another format makes very little sense, as they're
completely translatable on-the-fly if desired and they are packaged
this way on nearly every other platform already..

I don't think anyone's arguing that the man and info commands should be dumped.
However, one of my perennial gotos is the old "Shell Tools" collection of 
HTMLized
man pages from BeOS (which I've copied over to Haiku).  Much quicker to bring up
that index and find the relevant docs.  The 'rman' app does a reasonable job of
converting the nroff format [though not perfect].

        -- Pete --

Other related posts: