summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-01-01 16:27:32 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-01-01 16:27:32 +0000
commit45345e5f831672717b0177259a49cdf17cc09ae9 (patch)
tree552bb2fc482d10528eb070e8270d2970b6813a27 /mdoc.7
parent5447072295942b0ec781ef69debc82e96708f2f9 (diff)
downloadmandoc-45345e5f831672717b0177259a49cdf17cc09ae9.tar.gz
Issue of `Pa' put to rest by Jason McIntyre. Noted in COMPATIBILITY.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.784
1 files changed, 79 insertions, 5 deletions
diff --git a/mdoc.7 b/mdoc.7
index 7ee2b70e..0928a928 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -419,6 +419,11 @@ The
macro(s) must precede the
.Sx \&Nd
macro.
+.Pp
+See
+.Sx \&Nm
+and
+.Sx \&Nd .
.
.It Em LIBRARY
The name of the library containing the documented material, which is
@@ -429,8 +434,7 @@ this is as follows:
.Ed
.Pp
See
-.Sx \&Lb
-for details.
+.Sx \&Lb .
.
.It Em SYNOPSIS
Documents the utility invocation syntax, function call syntax, or device
@@ -467,6 +471,14 @@ And for the third, configurations (section 4):
.Pp
Manuals not in these sections generally don't need a
.Em SYNOPSIS .
+.Pp
+See
+.Sx \&Op ,
+.Sx \&Cd ,
+.Sx \&Fn ,
+.Sx \&Ft ,
+and
+.Sx \&Vt .
.
.It Em DESCRIPTION
This expands upon the brief, one-line description in
@@ -480,6 +492,7 @@ The arguments are as follows:
Print verbose information.
\&.El
.Ed
+.Pp
Manuals not documenting a command won't include the above fragment.
.
.It Em IMPLEMENTATION NOTES
@@ -535,7 +548,8 @@ for manuals in sections 1, 6, and 8; however, this practise is
discouraged.
.Pp
See
-.Sx \&Bl No \-diag .
+.Sx \&Bl
+.Fl diag .
.
.It Em ERRORS
Documents error handling in sections 2, 3, and 9.
@@ -1160,7 +1174,60 @@ and
.Ss \&Bf
.Ss \&Bk
.Ss \&Bl
-.
+.\" Begins a list composed of one or more list entries. A list entry is
+.\" specified by the
+.\" .Sx \&It
+.\" macro, which consists of a head and optional body. By default, a list
+.\" is preceded by a blank line. A list must specify one of the following
+.\" list types:
+.\" .Bl -tag -width 12n
+.\" .It Fl bullet
+.\" A list offset by a bullet. The head of list entries must be empty.
+.\" List entry bodies are justified after the bullet.
+.\" .It Fl column
+.\" A columnated list. The number of columns is specified as arguments to
+.\" the
+.\" .Sx \&Bl
+.\" macro (the deprecated form of following the invocation of
+.\" .Fl column
+.\" is also accepted). Arguments dictate the width of columns specified in
+.\" list entries. List entry bodies must be left empty. Columns specified
+.\" in the list entry head are justified to their position in the sequence
+.\" of columns.
+.\" .It Fl dash
+.\" A list offset by a dash (hyphen). The head of list entries must be
+.\" empty. List entry bodies are justified past the dash.
+.\" .It Fl diag
+.\" Like
+.\" .Fl inset
+.\" lists, but with additional formatting to the head.
+.\" .It Fl enum
+.\" A list offset by a number indicating list entry position. The head of
+.\" list entries must be empty. List entry bodies are justified past the
+.\" enumeration.
+.\" .It Fl hang
+.\" Like
+.\" .Fl tag ,
+.\" but instead of list bodies justifying to the head on the first line,
+.\" they trail the head text.
+.\" .It Fl hyphen
+.\" Synonym for
+.\" .Fl dash .
+.\" .It Fl inset
+.\" Like
+.\" .Fl tag ,
+.\" but list entry bodies aren't justified.
+.\" .It Fl item
+.\" An un-justified list. This produces blocks of text.
+.\" .It Fl ohang
+.\" List bodies are placed on the line following the head.
+.\" .It Fl tag
+.\" A list offset by list entry heads. List entry bodies are justified
+.\" after the head.
+.\" .El
+.\" .Pp
+.\" More...
+.\" .
.Ss \&Bo
Begins a block enclosed by square brackets. Does not have any head
arguments.
@@ -1846,6 +1913,13 @@ file re-write
.Pp
.Bl -dash -compact
.It
+In
+.Xr groff 1 ,
+the
+.Sx \&Pa
+macro does not format its arguments when used in the FILES section under
+certain list types. This irregular behaviour has been discontinued.
+.It
Historic
.Xr groff 1
does not print a dash for empty
@@ -1861,7 +1935,7 @@ normalised.
Negative scaling units are now truncated to zero instead of creating
interesting conditions, such as with
.Sx \&sp
-.Cm \-1i .
+.Fl 1i .
Furthermore, the
.Sq f
scaling unit, while accepted, is rendered as the default unit.