9fans - fans of the OS Plan 9 from Bell Labs
 help / color / mirror / Atom feed
From: Charles Forsyth <forsyth@terzarima.net>
To: 9fans@cse.psu.edu
Subject: Re: [9fans] Capitalization in man pages.
Date: Tue,  6 Dec 2005 13:41:12 +0000	[thread overview]
Message-ID: <0efa86b8841cd02d62f592d615c7579d@terzarima.net> (raw)
In-Reply-To: <B3665C5B-D6B8-4EE6-9821-C8953F7D6433@orthanc.ca>

>> 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.)

sorry, i meant only that the pages themselves are reasonably consistent in their style
and usually in the way they use man(6), though that's less visible.
you're quite right, though, that neither is codified.
i probably just misunderstood the following, or read it too quickly,
and thought you were implying there was no (real) consistency.

>I confess to being a fan of the BSD mdoc macros.  They recommend a  
>writing style that strikes a reasonable balance between the goals of  
>prose vs. precise.  But most importantly, they try to ensure  
>consistency throughout the documentation set.  When it comes to  
>laying out documentation -- especially reference documentation --  
>consistency of style is critical to making it easy for the reader to  
>find what they need.  The correct use of layout and typeface ...

i took it to mean that the 9 man pages didn't do (enough) of that;
i was asserting the contrary, but as i've just said, i was referring to the
style on the page, not to the underlying macro usage or whether
guidance or templates were provided anywhere.

i did look at mdoc(7) and mdoc.samples(7)
but although the latter provided a useful tutorial on using mdoc,
it didn't seem to touch significantly on writing style.



  reply	other threads:[~2005-12-06 13:41 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 [this message]
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
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=0efa86b8841cd02d62f592d615c7579d@terzarima.net \
    --to=forsyth@terzarima.net \
    --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).