source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mandoc: The .HP macro was deprecated by groff, and that makes sense
@ 2018-12-16  2:21 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2018-12-16  2:21 UTC (permalink / raw)
  To: source

Log Message:
-----------
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.

Modified Files:
--------------
    mandoc:
        man.7

Revision Data
-------------
Index: man.7
===================================================================
RCS file: /home/cvs/mandoc/mandoc/man.7,v
retrieving revision 1.140
retrieving revision 1.141
diff -Lman.7 -Lman.7 -u -p -r1.140 -r1.141
--- man.7
+++ man.7
@@ -100,7 +100,6 @@ but can be found in the alphabetical ref
 .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
--
 To unsubscribe send an email to source+unsubscribe@mandoc.bsd.lv

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2018-12-16  2:21 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-12-16  2:21 mandoc: The .HP macro was deprecated by groff, and that makes sense schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).