Print this page
9718 update mandoc to 1.14.4
@@ -601,35 +601,38 @@
.An -nosplit
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
Ao
Begin a block enclosed by angle brackets. Does not have any head
- arguments.
+ arguments. This macro is almost never useful. See Aq for more details.
- Examples:
- .Fl -key= Ns Ao Ar val Ac
-
- See also Aq.
-
Ap
Inserts an apostrophe without any surrounding whitespace. This is
generally used as a grammatical device when referring to the verb form of
a function.
Examples:
.Fn execve Ap d
Aq
- Encloses its arguments in angle brackets.
+ Encloses its arguments in angle brackets. The only important use case is
+ for email addresses. See Mt for an example.
- Examples:
- .Fl -key= Ns Aq Ar val
+ Occasionally, it is used for names of characters and keys, for example:
- Remarks: this macro is often abused for rendering URIs, which should
- instead use Lk or Mt, or to note pre-processor "#include" statements,
- which should use In.
+ Press the
+ .Aq escape
+ key to ...
+ For URIs, use Lk instead, and In for "#include" directives. Never wrap
+ Ar in Aq.
+
+ Since Aq usually renders with non-ASCII characters in non-ASCII output
+ modes, do not use it where the ASCII characters `<' and `>' are required
+ as syntax elements. Instead, use these characters directly in such
+ cases, combining them with the macros Pf, Ns, or Eo as needed.
+
See also Ao.
Ar
Command arguments. If an argument is not provided, the string "file ..."
is used as a default.
@@ -944,12 +947,12 @@
Document date for display in the page footer. This is the mandatory
first macro of any mdoc manual. Its syntax is as follows:
.Dd month day, year
- The month is the full English month name, the day is an optionally zero-
- padded numeral, and the year is the full four-digit year.
+ The month is the full English month name, the day is an integer number,
+ and the year is the full four-digit year.
Other arguments are not portable; the mandoc(1) utility handles them as
follows:
- To have the date automatically filled in by the OpenBSD version of
cvs(1), the special string "$Mdocdate$" can be given as an
@@ -959,12 +962,12 @@
- If a date string cannot be parsed, it is used verbatim.
- If no date string is given, the current date is used.
Examples:
.Dd $Mdocdate$
- .Dd $Mdocdate: July 21 2007$
- .Dd July 21, 2007
+ .Dd $Mdocdate: July 2 2018$
+ .Dd July 2, 2018
See also Dt and Os.
Dl
One-line indented display. This is formatted as literal text and is
@@ -2251,6 +2254,6 @@
utility written by Kristaps Dzonsons appeared in OpenBSD 4.6.
AUTHORS
The mdoc reference was written by Kristaps Dzonsons <kristaps@bsd.lv>.
-illumos July 20, 2017 illumos
+illumos July 28, 2018 illumos