From: Charles Forsyth <forsyth@terzarima.net>
To: 9fans@cse.psu.edu
Subject: Re: [9fans] Capitalization in man pages.
Date: Tue, 6 Dec 2005 18:11:03 +0000 [thread overview]
Message-ID: <91a834f68df7b1af7de479b2062c27d7@terzarima.net> (raw)
In-Reply-To: <200512061430.aa89515@salmon.maths.tcd.ie>
>> the typeset pages.) But the unwritten style guide for BSD man pages
>> says function names (and almost everything else) are case preserved.
>>
>> --lyndon
>
> Are you sure? I just looked at Rob's example, qsort(3), on my FreeBSD
> system. It mostly follows his usage, but there was
>
> Mergesort() is optimized for data with pre-existing order
actually, the amusing thing for me is that most pages in plan 9's section 2
use the latter style: Open opens, Create creates, Lalloc allocates a Layer,
Read reads, Write writes, Seek sets an offset, and so on. Qsort sorts an array.
few pages use `the function ...', although some do when it makes sense.
outside section 2, Cat reads each file, Clock draws a clock, ...
one can see why, when there are many functions.
with the `Lalloc allocates' style, the function name is often the start
of a paragraph describing the function. when several are
discussed in one paragraph, and a function name is just the start of a line not a paragraph, the
capital helps it stand out from the preceding sentence.
of course, i don't write my own throwaway e-mail following any of those conventions!
i'm anyway currently stuck in a grim world of
public abstract SocketChannel extends java.nio.channels.spi.AbstractSelectableChannel
implements ByteChannel, GatheringByteChannel, ScatteringByteChannel
where clearly no names are used lightly; and there are many.
next prev parent reply other threads:[~2005-12-06 18:11 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 [this message]
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=91a834f68df7b1af7de479b2062c27d7@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).