Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 23 Jan 2001 16:42:27 +0200
From:      Alexey Zelkin <phantom@ark.cris.net>
To:        Ruslan Ermilov <ru@FreeBSD.org>
Cc:        Ben Smithurst <csxbcs@comp.leeds.ac.uk>, Sheldon Hearn <sheldonh@FreeBSD.org>, Mike Pritchard <mpp@FreeBSD.org>, doc@FreeBSD.org
Subject:   Re: mdoc(7) questionnaire (was: Re: trailing dot in .Nd)
Message-ID:  <20010123164227.A4978@ark.cris.net>
In-Reply-To: <20010123101530.A98532@sunbay.com>; from ru@FreeBSD.org on Tue, Jan 23, 2001 at 10:15:30AM %2B0200
References:  <20010122175432.A31943@sunbay.com> <20010122185304.B25101@comp.leeds.ac.uk> <20010123101530.A98532@sunbay.com>

next in thread | previous in thread | raw e-mail | index | archive | help
hi,

On Tue, Jan 23, 2001 at 10:15:30AM +0200, 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?

Everything just should be changed in one way. If we have most manpages
lowercased, others should be also lowercased, IMHO. Same for dots at the
end of sentences.

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

YES.

> 2.  Should we consistently change all occurrences of ``.Nm Foo'' to
>     ``.Nm foo'' where the command name is actually ``foo''?  (YES, NO)

Yes, of course, but it just should be changed to construction like

The command/utility/etc
.Nm
...

-- 
/* Alexey Zelkin               && phantom@cris.net       */
/* Tavric National University  && phantom@FreeBSD.org    */
/* Sysadmin/Developer          && phantom@sms.umc.com.ua */


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?20010123164227.A4978>