[GRLUG] Documentation

[Bob Kline]

OK.  It seems to me that documentation
has fallen somewhat in to disarray.  Man
pages were once the expected place to
look.  Even in a day of HTML now, I'd
think there'd at least just be a link in a
man page. They were an early, and sensible
way to approach the matter, like many of
the early concepts in Unix.

    -- Bob


On Mon, Feb 21, 2011 at 11:31 PM, Jeff DeFouw <jeffd at i2k.com> wrote:

> On Mon, Feb 21, 2011 at 05:47:31PM -0500, Bob Kline wrote:
> > Could someone put together a little word
> > salad about current day Linux documentation?
> > e.g., I see something like openssl-doc.  What's
> > a standard way to access that?
> >
> > /usr/share/doc is the main repository?
>
> It depends on the project and how they document.  Long manuals tend to
> end up in -doc packages, and the man pages tell you to go there for all
> but a brief overview.  There doesn't seem to be a standard structure,
> except that it all goes under /usr/share/doc/related-package.  Some
> documentation goes in /package/, some goes in /package-doc/.  Often it's
> HTML, but that's not always true.  Sometimes you just get a README file
> in /usr/share/doc/package, or Debian makes one.  If it's HTML, you can
> point your browser at it, but you have to figure out the directory
> yourself.  If you install apache, Debian automatically sets up
> http://localhost/doc/ , and some packages depend on that for easy
> navigation, but again, you have to know what directory to start in.
>
> --
> Jeff DeFouw <jeffd at i2k.com>
>
> --
> This message has been scanned for viruses and
> dangerous content by MailScanner, and is
> believed to be clean.
>
> _______________________________________________
> grlug mailing list
> grlug at grlug.org
> http://shinobu.grlug.org/cgi-bin/mailman/listinfo/grlug
>

-- 
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://shinobu.grlug.org/pipermail/grlug/attachments/20110222/4d4f4a0e/attachment.html>