summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2018-12-16 02:21:00 +0000
committerIngo Schwarze <schwarze@openbsd.org>2018-12-16 02:21:00 +0000
commit3f3ba36406a16c5a308bca995cea3bf9160e2e3e (patch)
tree56d2cad6244686c3d5903e926f6b0913d6d5894b
parent671dbf3b558e579316dae09e8c28aaab4dec0e86 (diff)
downloadmandoc-3f3ba36406a16c5a308bca995cea3bf9160e2e3e.tar.gz
The .HP macro was deprecated by groff, and that makes sense
because it serves no real purpose and works poorly with HTML. While here, describe the section argument of .TH, clarify the syntax display of .TP, and polish some wordings.
-rw-r--r--man.728
1 files changed, 18 insertions, 10 deletions
diff --git a/man.7 b/man.7
index 3399032f..1deec7a1 100644
--- a/man.7
+++ b/man.7
@@ -100,7 +100,6 @@ but can be found in the alphabetical reference below.
.It Sx RS , RE Ta reset the left margin: Op Ar width
.It Sx IP Ta indented paragraph: Op Ar head Op Ar width
.It Sx TP Ta tagged paragraph: Op Ar width
-.It Sx HP Ta hanged paragraph: Op Ar width
.It Sx PD Ta set vertical paragraph distance: Op Ar height
.It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
.It Sx in Ta additional indent: Op Ar width
@@ -185,8 +184,13 @@ The
argument is a
.Xr roff 7
scaling width.
-If specified, it's saved for later paragraph left-margins; if unspecified, the
-saved or default width is used.
+If specified, it's saved for later paragraph left margins;
+if unspecified, the saved or default width is used.
+.Pp
+This macro is portable, but deprecated
+because it has no good representation in HTML output,
+usually ending up indistinguishable from
+.Sx \&PP .
.Ss \&I
Text is rendered in italics.
.Ss \&IB
@@ -380,6 +384,9 @@ and footer with the following syntax:
Conventionally, the document
.Ar name
is given in all caps.
+The
+.Ar section
+is usually a single digit, in a few cases followed by a letter.
The recommended
.Ar date
format is
@@ -399,21 +406,22 @@ uses its
argument.
The
.Ar volume
-string replaces the default rendered volume, which is dictated by the
-manual section.
+string replaces the default volume title of the
+.Ar section .
.Pp
Examples:
.Pp
.Dl \&.TH CVS 5 "1992-02-12" GNU
.Ss \&TP
Begin a paragraph where the head, if exceeding the indentation width, is
-followed by a newline; if not, the body follows on the same line after a
-buffer to the indentation width.
+followed by a newline; if not, the body follows on the same line after
+advancing to the indentation width.
Subsequent output lines are indented.
The syntax is as follows:
-.Bd -filled -offset indent
-.Pf \. Sx \&TP
-.Op Ar width
+.Bd -unfilled -offset indent
+.Pf \. Sx \&TP Op Ar width
+.Ar head No \e" one line
+.Ar body
.Ed
.Pp
The