===================================================================
RCS file: /cvs/mandoc/mdoc.7,v
retrieving revision 1.268
retrieving revision 1.273
diff -u -p -r1.268 -r1.273
--- mandoc/mdoc.7	2017/07/05 12:25:17	1.268
+++ mandoc/mdoc.7	2018/12/23 16:55:34	1.273
@@ -1,7 +1,7 @@
-.\"	$Id: mdoc.7,v 1.268 2017/07/05 12:25:17 schwarze Exp $
+.\"	$Id: mdoc.7,v 1.273 2018/12/23 16:55:34 schwarze Exp $
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
-.\" Copyright (c) 2010, 2011, 2013-2017 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010, 2011, 2013-2018 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: July 5 2017 $
+.Dd $Mdocdate: December 23 2018 $
 .Dt MDOC 7
 .Os
 .Sh NAME
@@ -449,7 +449,7 @@ in the alphabetical
 .It Sx \&Ss Ta subsection header (one line)
 .It Sx \&Sx Ta internal cross reference to a section or subsection
 .It Sx \&Xr Ta cross reference to another manual page: Ar name section
-.It Sx \&Pp , \&Lp Ta start a text paragraph (no arguments)
+.It Sx \&Pp Ta start a text paragraph (no arguments)
 .El
 .Ss Displays and lists
 .Bl -column "Brq, Bro, Brc" description
@@ -522,7 +522,6 @@ in the alphabetical
 .Bl -column "Brq, Bro, Brc" description
 .It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments)
 .It Sx \&Sy Ta boldface font (symbolic) (>0 arguments)
-.It Sx \&Li Ta typewriter font (literal) (>0 arguments)
 .It Sx \&No Ta return to roman font (normal) (no arguments)
 .It Sx \&Bf , \&Ef Ta font block:
 .Op Fl Ar type | Cm \&Em | \&Li | \&Sy
@@ -674,12 +673,10 @@ Examples:
 .Ss \&Ao
 Begin a block enclosed by angle brackets.
 Does not have any head arguments.
-.Pp
-Examples:
-.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac
-.Pp
-See also
-.Sx \&Aq .
+This macro is almost never useful.
+See
+.Sx \&Aq
+for more details.
 .Ss \&Ap
 Inserts an apostrophe without any surrounding whitespace.
 This is generally used as a grammatical device when referring to the verb
@@ -689,19 +686,45 @@ Examples:
 .Dl \&.Fn execve \&Ap d
 .Ss \&Aq
 Encloses its arguments in angle brackets.
+The only important use case is for email addresses.
+See
+.Sx \&Mt
+for an example.
 .Pp
-Examples:
-.Dl \&.Fl -key= \&Ns \&Aq \&Ar val
+Occasionally, it is used for names of characters and keys, for example:
+.Bd -literal -offset indent
+Press the
+\&.Aq escape
+key to ...
+.Ed
 .Pp
-.Em Remarks :
-this macro is often abused for rendering URIs, which should instead use
+For URIs, use
 .Sx \&Lk
+instead, and
+.Sx \&In
+for
+.Dq #include
+directives.
+Never wrap
+.Sx \&Ar
+in
+.Sx \&Aq .
+.Pp
+Since
+.Sx \&Aq
+usually renders with non-ASCII characters in non-ASCII output modes,
+do not use it where the ASCII characters
+.Sq <
+and
+.Sq >
+are required as syntax elements.
+Instead, use these characters directly in such cases, combining them
+with the macros
+.Sx \&Pf ,
+.Sx \&Ns ,
 or
-.Sx \&Mt ,
-or to note pre-processor
-.Dq Li #include
-statements, which should use
-.Sx \&In .
+.Sx \&Eo
+as needed.
 .Pp
 See also
 .Sx \&Ao .
@@ -1210,7 +1233,7 @@ The
 .Ar month
 is the full English month name, the
 .Ar day
-is an optionally zero-padded numeral, and the
+is an integer number, and the
 .Ar year
 is the full four-digit year.
 .Pp
@@ -1240,8 +1263,8 @@ If no date string is given, the current date is used.
 .Pp
 Examples:
 .Dl \&.Dd $\&Mdocdate$
-.Dl \&.Dd $\&Mdocdate: July 21 2007$
-.Dl \&.Dd July 21, 2007
+.Dl \&.Dd $\&Mdocdate: July 2 2018$
+.Dl \&.Dd July 2, 2018
 .Pp
 See also
 .Sx \&Dt
@@ -1450,9 +1473,8 @@ to save the pattern space for subsequent retrieval.
 .Ed
 .Pp
 See also
-.Sx \&Bf ,
-.Sx \&Li ,
 .Sx \&No ,
+.Sx \&Ql ,
 and
 .Sx \&Sy .
 .Ss \&En
@@ -1752,12 +1774,13 @@ Examples:
 .Dl \&.Ic alias
 .Pp
 Note that using
-.Sx \&Bd Fl literal
+.Sx \&Ql ,
+.Sx \&Dl ,
 or
-.Sx \&D1
-is preferred for displaying code; the
+.Sx \&Bd Fl literal
+is preferred for displaying code samples; the
 .Sx \&Ic
-macro is used when referring to specific instructions.
+macro is used when referring to an individual command name.
 .Ss \&In
 The name of an include file.
 This macro is most often used in section 2, 3, and 9 manual pages.
@@ -1891,21 +1914,15 @@ Examples:
 .Dl \&.Lb libz
 .Dl \&.Lb libmandoc
 .Ss \&Li
-Denotes text that should be in a
-.Li literal
-font mode.
-Note that this is a presentation term and should not be used for
-stylistically decorating technical terms.
-.Pp
-On terminal output devices, this is often indistinguishable from
-normal text.
-.Pp
-See also
-.Sx \&Bf ,
-.Sx \&Em ,
-.Sx \&No ,
-and
-.Sx \&Sy .
+Request a typewriter (literal) font.
+Deprecated because on terminal output devices, this is usually
+indistinguishable from normal text.
+For literal displays, use
+.Sx \&Ql Pq in-line ,
+.Sx \&Dl Pq single line ,
+or
+.Sx \&Bd Fl literal Pq multi-line
+instead.
 .Ss \&Lk
 Format a hyperlink.
 Its syntax is as follows:
@@ -1919,7 +1936,7 @@ Examples:
 See also
 .Sx \&Mt .
 .Ss \&Lp
-Synonym for
+Deprecated synonym for
 .Sx \&Pp .
 .Ss \&Ms
 Display a mathematical symbol.
@@ -2022,7 +2039,7 @@ Examples:
 .Pp
 See also
 .Sx \&Em ,
-.Sx \&Li ,
+.Sx \&Ql ,
 and
 .Sx \&Sy .
 .Ss \&Ns
@@ -2220,14 +2237,8 @@ Close quoted context opened by
 .Sx \&Qo .
 .Ss \&Ql
 In-line literal display.
-This can for example be used for complete command invocations and
-for multi-word code fragments when more specific markup is not
-appropriate and an indented display is not desired.
-While
-.Xr mandoc 1
-always encloses the arguments in single quotes, other formatters
-usually omit the quotes on non-terminal output devices when the
-arguments have three or more characters.
+This can be used for complete command invocations and for multi-word
+code examples when an indented display is not desired.
 .Pp
 See also
 .Sx \&Dl
@@ -2631,11 +2642,10 @@ program.
 .Ed
 .Pp
 See also
-.Sx \&Bf ,
 .Sx \&Em ,
-.Sx \&Li ,
+.Sx \&No ,
 and
-.Sx \&No .
+.Sx \&Ql .
 .Ss \&Ta
 Table cell separator in
 .Sx \&Bl Fl column
@@ -3198,7 +3208,7 @@ but produces large indentations.
 .Xr tbl 7
 .Pp
 The web page
-.Lk http://mdocml.bsd.lv/mdoc/ "extended documentation for the mdoc language"
+.Lk http://mandoc.bsd.lv/mdoc/ "extended documentation for the mdoc language"
 provides a few tutorial-style pages for beginners, an extensive style
 guide for advanced authors, and an alphabetic index helping to choose
 the best macros for various kinds of content.