9fans - fans of the OS Plan 9 from Bell Labs
 help / color / mirror / Atom feed
From: Lyndon Nerenberg <lyndon@orthanc.ca>
To: Fans of the OS Plan 9 from Bell Labs <9fans@cse.psu.edu>
Subject: Re: [9fans] Capitalization in man pages.
Date: Tue,  6 Dec 2005 05:54:43 -0800	[thread overview]
Message-ID: <67E460A9-15ED-4A18-97DD-69415399CEB1@orthanc.ca> (raw)
In-Reply-To: <0efa86b8841cd02d62f592d615c7579d@terzarima.net>


On Dec 6, 2005, at 5:41 AM, Charles Forsyth wrote:

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

They do avoid talking about writing style.  What I was getting at was  
the macros themselves try to enforce a consistent design (i.e.  
consistent use of unique typefaces to highlight function names vs.  
parameters vs. manifest constants, etc.), thus enforcing the visual  
cues I mentioned before.  (And they even work to a limited extent  
with nroffed pages, although most of what I'm alluding to is based on  
the typeset pages.)  But the unwritten style guide for BSD man pages  
says function names (and almost everything else) are case preserved.

--lyndon


  reply	other threads:[~2005-12-06 13:54 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 [this message]
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=67E460A9-15ED-4A18-97DD-69415399CEB1@orthanc.ca \
    --to=lyndon@orthanc.ca \
    --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).