Date: Tue, 23 Jan 2001 10:15:30 +0200 From: Ruslan Ermilov <ru@FreeBSD.org> To: Ben Smithurst <csxbcs@comp.leeds.ac.uk> Cc: Sheldon Hearn <sheldonh@FreeBSD.org>, Alexey Zelkin <phantom@cris.net>, Mike Pritchard <mpp@FreeBSD.org>, doc@FreeBSD.org Subject: mdoc(7) questionnaire (was: Re: trailing dot in .Nd) Message-ID: <20010123101530.A98532@sunbay.com> In-Reply-To: <20010122185304.B25101@comp.leeds.ac.uk>; from csxbcs@comp.leeds.ac.uk on Mon, Jan 22, 2001 at 06:53:04PM %2B0000 References: <20010122175432.A31943@sunbay.com> <20010122185304.B25101@comp.leeds.ac.uk>
next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Jan 22, 2001 at 06:53:04PM +0000, Ben Smithurst wrote:
> Ruslan Ermilov wrote:
>
> > There are 26 -CURRENT manpages (in mdoc(7) format) in the base system
> > that have a trailing dot (`.') after the .Nd macro. In your opinion,
> > should I remove these (dots)?
> >
> > gnu/lib/libdialog/dialog.3:.Nd provide a simple ncurses-based GUI interface.
>
> No objections from me, and it would certainmly make things more consistent.
> We should also be consistent about not starting with a capital letter...
>
I did not want to mix the things in one message, but I also think this should
be done. Anyone else's opinions?
> > lib/libc/sys/jail.2:.Nd Imprison current process and future decendants.
> > lib/libcalendar/calendar.3:.Nd Calendar arithmetic for the Christian era.
> > share/man/man9/DELAY.9:.Nd Busy loop for an interval.
> > share/man/man9/bios.9:.Nd Interact with PC BIOS.
>
> They should be lowercase, IMO.
>
Seconded. But what do others think?
> I'm tempted also to change things like ".Nm Foo" to just ".Nm" at the
> start of sentences, when the name really is "foo". IMO even at the
> start of a sentence we shouldn't capitalize things wrong. There's a lot
> more of these to change though, so there may be stronger objections. I
> don't feel that strongly about it, it just seems "wrong" to capitalize
> things wrong.
>
I would say "yes". Can we please come up once and for all to some rule
about this?
So, readers, please answer this short questionnaire.
1. Should the short manual page description be in lower case (except
registered (trade) names like TCP? (YES, NO)
2. Should we consistently change all occurrences of ``.Nm Foo'' to
``.Nm foo'' where the command name is actually ``foo''? (YES, NO)
I will collect answers till and publish the results on the next Monday.
Thanks,
--
Ruslan Ermilov Oracle Developer/DBA,
ru@sunbay.com Sunbay Software AG,
ru@FreeBSD.org FreeBSD committer,
+380.652.512.251 Simferopol, Ukraine
http://www.FreeBSD.org The Power To Serve
http://www.oracle.com Enabling The Information Age
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010123101530.A98532>