On Tue, Apr 24, 2007 at 10:25:05AM -0400, Justin Pryzby wrote:
> On Tue, Apr 24, 2007 at 04:14:15PM +0200, Michael Kerrisk wrote:
> > If you would like to get this pushed upstream, the following would help:
> > 
> > 1. Follow man-pages formatting conventions would help.  In particular, the
> > use of lines containing just a "." (to force a blank line) should be
> > avoided.  Just remove all of those lines.  (Most man-pages do not have the
> > more than one blank line to separate sections.)

For the record, a line containing just a "." doesn't force a blank line;
rather, it does nothing. Compare:

  .TH FOO 1
  .SH NAME
  foo \- bar
  .SH DESCRIPTION
  foo
  .
  bar

... with:

  .TH FOO 1
  .SH NAME
  foo \- bar
  .SH DESCRIPTION
  foo
  
  bar

> I'd actually like to see some resolution to #411303 before changing
> everything back; nobody has commented on it yet.  After spending some
> effort reading documentation, it's not inspiring to be told that the
> documentation is wrong.

I didn't comment on #411303 because I was under the impression I
effectively already had. :-)

man(7) seems to have two purposes: first, it purports to document the
groff man macros; secondly, it acts as a man page style guide, at least
for those manual pages using the man macros. Perhaps it would help if it
dropped the first purpose and referred to groff_man instead, since
that's pretty small?

-- 
Colin Watson                                       [EMAIL PROTECTED]


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to