9fans - fans of the OS Plan 9 from Bell Labs
 help / color / mirror / Atom feed
From: jmk@plan9.bell-labs.com
To: 9fans@cse.psu.edu
Subject: Re: [9fans] Capitalization in man pages.
Date: Tue,  6 Dec 2005 10:57:42 -0500	[thread overview]
Message-ID: <9ad360a7d8786a5676d997025cb7f20b@plan9.bell-labs.com> (raw)
In-Reply-To: <B3665C5B-D6B8-4EE6-9821-C8953F7D6433@orthanc.ca>

Seems to me you could satisfy both your desire for consistency
and that of being a frustrated writer by writing the man page that
details how to write a man page in the accepted Plan 9 style.

--jim

On Tue Dec  6 08:03:30 EST 2005, lyndon@orthanc.ca wrote:
> 
> On Dec 6, 2005, at 4:32 AM, Charles Forsyth wrote:
> 
> >> But most importantly, they try to ensure
> >> consistency throughout the documentation set.
> >
> > so does Plan 9; it just doesn't use your rules.
> 
> I'm curious about this comment.  man(6) describes the macros it makes  
> available, but it says nothing about how they should be used in the  
> context of writing the man page itself.  There is no mention  
> whatsoever of style or usage.  (USG derived UNIXen suffered this  
> malady as well, to varying degrees.)
> 
> So how is an author to know how to write something that is congruent  
> with the current style?  They can read existing man pages and try to  
> glean from them, but inevitably errors will creep in.  And those  
> errors will become input to the next generation of authors, and so it  
> goes.
> 
> Wasn't it Steve Johnson who did the original sweep through the UNIX  
> man pages, editing out inconsistent usage and rationalizing the  
> layout?  In the 1970s?
> 
> --lyndon
> 
> P.S.  And no, I am not in any way pissing on Rob's work!


  parent reply	other threads:[~2005-12-06 15:57 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
2005-12-08  4:55                             ` Uriel
2005-12-07  3:56                       ` Jeff Sickel
2005-12-06 15:57               ` jmk [this message]
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=9ad360a7d8786a5676d997025cb7f20b@plan9.bell-labs.com \
    --to=jmk@plan9.bell-labs.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).