[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
.Nm causes a line break in SYNOPSIS
From: |
Krzysztof Żelechowski |
Subject: |
.Nm causes a line break in SYNOPSIS |
Date: |
Fri, 4 Jun 2010 10:15:48 +0200 |
User-agent: |
KMail/1.12.4 (Linux/2.6.31.12-0.2-desktop; KDE/4.3.5; x86_64; ; ) |
GROFF VERSION: 1.20
MACHINE: noname
OS: openSuSE 11.2
COMPILER: g++ 4.4
INPUT FILES: test.n
.Dd
.Sh NAME
.Nm name
.Nm
.Sh SYNOPSIS
.Nm
.Nm
COMMAND LINE: './test-groff' '-mandoc' '-Tascii' 'test.n'
DESCRIPTION OF INCORRECT BEHAVIOUR:
The command '.Nm' causes a line break in SYNOPSIS. This is probably desirable
because manual pages such as "pftp.1" depend on it; however, this feature is
not mentioned in "tmac/groff_mdoc.n".
Here is the result:
NAME
name name
SYNOPSIS
name
name
SUGGESTED FIX:
Add a statement to that effect to groff_mdoc manual page.
*** tmac/groff_mdoc.man 2010-02-24 09:24:47.000000000 +0100
--- tmac/groff_mdoc.n 2010-06-04 10:11:07.122847482 +0200
*************** When called without arguments,
*** 1786,1798 ****
.Ql .Nm
regurgitates this initial name for the sole purpose of making less work for
the author.
Note: A section two or three document function name is addressed with the
.Ql .Nm
in the
.Sx NAME
section, and with
.Ql .Fn
! in the
.Sx SYNOPSIS
and remaining sections.
For interactive commands, such as the
--- 1786,1803 ----
.Ql .Nm
regurgitates this initial name for the sole purpose of making less work for
the author.
+ .Ql .Nm
+ causes a line break within the
+ .Sx SYNOPSIS
+ section.
+ .Pp
Note: A section two or three document function name is addressed with the
.Ql .Nm
in the
.Sx NAME
section, and with
.Ql .Fn
! in the
.Sx SYNOPSIS
and remaining sections.
For interactive commands, such as the