9fans - fans of the OS Plan 9 from Bell Labs
 help / color / mirror / Atom feed
From: Russ Cox <rsc@swtch.com>
To: Fans of the OS Plan 9 from Bell Labs <9fans@cse.psu.edu>
Subject: Re: [9fans] Capitalization in man pages.
Date: Wed,  7 Dec 2005 23:10:22 -0500	[thread overview]
Message-ID: <ee9e417a0512072010i32939f94k15d328225ab36af0@mail.gmail.com> (raw)
In-Reply-To: <DDE9B7B1-DC54-40CB-8574-671F978A27E9@orthanc.ca>

Please don't rewrite all the man pages unless you
first establish the value in doing so.  Converting from
one troff macro package to another does not on first
glance seem to offer any benefit at all.  In fact, things
like man2html would then have to be updated, and
no doubt all the errors introduced would have to be
tracked down, and so on.  It hardly seems worth it,
especially considering that the outward appearance
would remain the same.

On the other hand, checking that the man pages reflect
reality (command line arguments, function signatures,
and so on) would be genuinely useful.  I encouraged some
others to do this a few years ago and they formed a group
called the Plan 9 Documentation Task Force and fixed a
few man pages but then I think they lost interest.

I made a bunch of updates to the plan9port man pages
when I did the "first fully documented release" a year ago.
Diffing those against the Plan 9 ones would be a good start.

Russ


  reply	other threads:[~2005-12-08  4:10 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-12-05 12:07 [9fans] irc answers - man and memmove Russ Cox
2005-12-05 19:07 ` Sascha Retzki
2005-12-06  1:09 ` Paul Lalonde
2005-12-06  1:14   ` Rob Pike
2005-12-06  1:17     ` Paul Lalonde
2005-12-06  1:48       ` Russ Cox
2005-12-07  9:57         ` Gorka guardiola
2005-12-07 10:41           ` Lucio De Re
2005-12-06  1:22     ` erik quanstrom
2005-12-06  6:31     ` [9fans] Capitalization in man pages Lyndon Nerenberg
2005-12-06  7:01       ` Rob Pike
2005-12-06  9:44         ` Charles Forsyth
2005-12-06 11:01         ` Lyndon Nerenberg
2005-12-06 11:17           ` Charles Forsyth
2005-12-06 11:27             ` Lyndon Nerenberg
2005-12-06 11:12         ` Lyndon Nerenberg
2005-12-06 11:18           ` Lucio De Re
2005-12-06 12:22         ` Lyndon Nerenberg
2005-12-06 12:32           ` Charles Forsyth
2005-12-06 12:40             ` Lyndon Nerenberg
2005-12-06 13:02             ` Lyndon Nerenberg
2005-12-06 13:41               ` Charles Forsyth
2005-12-06 13:54                 ` Lyndon Nerenberg
2005-12-06 14:30                   ` John Stalker
2005-12-06 18:11                     ` Charles Forsyth
2005-12-06 18:31                       ` Rob Pike
2005-12-08  3:58                         ` Lyndon Nerenberg
2005-12-08  4:10                           ` Russ Cox [this message]
2005-12-08  4:55                             ` Uriel
2005-12-07  3:56                       ` Jeff Sickel
2005-12-06 15:57               ` jmk
2005-12-07  0:11                 ` geoff
2005-12-07  0:17                   ` Francisco J Ballesteros
2005-12-07  0:22                   ` Steve Simon
2005-12-08  3:55                 ` Lyndon Nerenberg
2005-12-06 12:46         ` erik quanstrom
2005-12-06 15:02           ` Brantley Coile

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=ee9e417a0512072010i32939f94k15d328225ab36af0@mail.gmail.com \
    --to=rsc@swtch.com \
    --cc=9fans@cse.psu.edu \
    /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.
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).