mailing list of musl libc
 help / color / mirror / code / Atom feed
From: Rich Felker <dalias@aerifal.cx>
To: musl@lists.openwall.com
Subject: Re: documenting musl
Date: Sat, 8 Sep 2012 08:46:58 -0400	[thread overview]
Message-ID: <20120908124658.GX27715@brightrain.aerifal.cx> (raw)
In-Reply-To: <CAPLrYETBXXOb7VpucBApU=ih0wK=x5DUR6RMAc0=fGQQrOLfbw@mail.gmail.com>

On Sat, Sep 08, 2012 at 02:35:22PM +0200, Daniel Cegiełka wrote:
> 2012/9/8 Kurt H Maier <khm-lists@intma.in>:
> > On Sat, Sep 08, 2012 at 10:44:03AM +0200, Daniel Cegiełka wrote:
> >> btw. documentation - mandoc is a better option than (old/big/ugly)
> >> groff for documentation.
> >
> > None of those links explain why they seem to think it's either groff or
> > roll-your-own, when there are plenty of lightweight roff
> > implementations.  Any hints?
> 
> hmm... mandoc isn't lightweight? :)
> 
> # du -h | grep image/
> 20.0K	./image/usr/share/man/man1
> 8.0K	./image/usr/share/man/man8
> 32.0K	./image/usr/share/man
> 36.0K	./image/usr/share
> 248.0K	./image/usr/bin
> 288.0K	./image/usr
> # ls -lh image/usr/bin/
> total 244
> lrwxrwxrwx    1 root     root           6 Sep  8 12:24 apropos -> mandoc
> lrwxrwxrwx    1 root     root           6 Sep  8 12:24 makewhatis -> mandoc
> -rwxr-xr-x    1 root     root      243.9K Sep  8 12:24 mandoc
> lrwxrwxrwx    1 root     root           6 Sep  8 12:24 mandocdb -> mandoc
> lrwxrwxrwx    1 root     root           6 Sep  8 12:24 whatis -> mandoc
> 
> compared to groff (gentoo):
> 
> (cut...)
> 
> 7.1M	./image/usr/share
> 4.0K	./image/usr/lib64/groff/site-tmac
> 60K	./image/usr/lib64/groff/groffer
> 68K	./image/usr/lib64/groff
> 72K	./image/usr/lib64
> 3.4M	./image/usr/bin
> 11M	./image/usr
> 11M	./image

mandoc may be interesting, but I think the whole mandoc vs groff thing
is a distraction from the real topic. groff is a really ugly (GNU,
C++) version of the standard troff, of which there's a perfectly good
version based on the original troff somewhere, perhaps in heirloom.

At some point we may want man pages for various things, but the
documentation I started this thread to consider is something that
would probably be desirable to have in html and pdf output formats;
the input format is open not something I've thought too much about.

The content is the important part, and content may eventually be
derived/adapted into man pages too.. :)

Rich


  reply	other threads:[~2012-09-08 12:46 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-09-08  2:40 Rich Felker
2012-09-08  6:36 ` Isaac Dunham
2012-09-08  8:44   ` Daniel Cegiełka
2012-09-08 11:48     ` Kurt H Maier
2012-09-08 12:35       ` Daniel Cegiełka
2012-09-08 12:46         ` Rich Felker [this message]
2012-09-08 12:53           ` Daniel Cegiełka
2012-09-08 12:47         ` Kurt H Maier
2012-09-08 13:12           ` Daniel Cegiełka
2012-09-08 13:16             ` Kurt H Maier
2012-09-08 13:42               ` Daniel Cegiełka
2012-09-08 14:09                 ` Kurt H Maier
2012-09-09  1:43             ` John Spencer
2012-09-08 14:24           ` Isaac Dunham
2012-09-08 15:07   ` Isaac Dunham
2012-09-08 19:46   ` Szabolcs Nagy
2012-09-08 11:44 ` Justin Cormack
2012-09-08 14:53   ` Isaac Dunham
2012-09-09  3:09 ` nwmcsween
2012-09-09  4:15   ` Rich Felker
2012-09-09  4:15     ` nwmcsween
2012-09-09  6:12       ` Rich Felker
2012-09-09  8:04     ` Justin Cormack

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20120908124658.GX27715@brightrain.aerifal.cx \
    --to=dalias@aerifal.cx \
    --cc=musl@lists.openwall.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/musl/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).