version 1.269, 2017/07/20 16:24:53 |
version 1.273, 2018/12/23 16:55:34 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" 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 |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
Line 449 in the alphabetical |
|
Line 449 in the alphabetical |
|
.It Sx \&Ss Ta subsection header (one line) |
.It Sx \&Ss Ta subsection header (one line) |
.It Sx \&Sx Ta internal cross reference to a section or subsection |
.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 \&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 |
.El |
.Ss Displays and lists |
.Ss Displays and lists |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
Line 522 in the alphabetical |
|
Line 522 in the alphabetical |
|
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments) |
.It Sx \&Em Ta italic font or underline (emphasis) (>0 arguments) |
.It Sx \&Sy Ta boldface font (symbolic) (>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 \&No Ta return to roman font (normal) (no arguments) |
.It Sx \&Bf , \&Ef Ta font block: |
.It Sx \&Bf , \&Ef Ta font block: |
.Op Fl Ar type | Cm \&Em | \&Li | \&Sy |
.Op Fl Ar type | Cm \&Em | \&Li | \&Sy |
|
|
.Ss \&Ao |
.Ss \&Ao |
Begin a block enclosed by angle brackets. |
Begin a block enclosed by angle brackets. |
Does not have any head arguments. |
Does not have any head arguments. |
.Pp |
This macro is almost never useful. |
Examples: |
See |
.Dl \&.Fl -key= \&Ns \&Ao \&Ar val \&Ac |
.Sx \&Aq |
.Pp |
for more details. |
See also |
|
.Sx \&Aq . |
|
.Ss \&Ap |
.Ss \&Ap |
Inserts an apostrophe without any surrounding whitespace. |
Inserts an apostrophe without any surrounding whitespace. |
This is generally used as a grammatical device when referring to the verb |
This is generally used as a grammatical device when referring to the verb |
|
|
.Dl \&.Fn execve \&Ap d |
.Dl \&.Fn execve \&Ap d |
.Ss \&Aq |
.Ss \&Aq |
Encloses its arguments in angle brackets. |
Encloses its arguments in angle brackets. |
|
The only important use case is for email addresses. |
|
See |
|
.Sx \&Mt |
|
for an example. |
.Pp |
.Pp |
Examples: |
Occasionally, it is used for names of characters and keys, for example: |
.Dl \&.Fl -key= \&Ns \&Aq \&Ar val |
.Bd -literal -offset indent |
|
Press the |
|
\&.Aq escape |
|
key to ... |
|
.Ed |
.Pp |
.Pp |
.Em Remarks : |
For URIs, use |
this macro is often abused for rendering URIs, which should instead use |
|
.Sx \&Lk |
.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 |
or |
.Sx \&Mt , |
.Sx \&Eo |
or to note pre-processor |
as needed. |
.Dq Li #include |
|
statements, which should use |
|
.Sx \&In . |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Ao . |
.Sx \&Ao . |
|
|
.Ar month |
.Ar month |
is the full English month name, the |
is the full English month name, the |
.Ar day |
.Ar day |
is an optionally zero-padded numeral, and the |
is an integer number, and the |
.Ar year |
.Ar year |
is the full four-digit year. |
is the full four-digit year. |
.Pp |
.Pp |
Line 1240 If no date string is given, the current date is used. |
|
Line 1263 If no date string is given, the current date is used. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.Dl \&.Dd $\&Mdocdate$ |
.Dl \&.Dd $\&Mdocdate$ |
.Dl \&.Dd $\&Mdocdate: July 21 2007$ |
.Dl \&.Dd $\&Mdocdate: July 2 2018$ |
.Dl \&.Dd July 21, 2007 |
.Dl \&.Dd July 2, 2018 |
.Pp |
.Pp |
See also |
See also |
.Sx \&Dt |
.Sx \&Dt |
Line 1450 to save the pattern space for subsequent retrieval. |
|
Line 1473 to save the pattern space for subsequent retrieval. |
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
|
.Sx \&Li , |
|
.Sx \&No , |
.Sx \&No , |
|
.Sx \&Ql , |
and |
and |
.Sx \&Sy . |
.Sx \&Sy . |
.Ss \&En |
.Ss \&En |
|
|
.Dl \&.Ic alias |
.Dl \&.Ic alias |
.Pp |
.Pp |
Note that using |
Note that using |
.Sx \&Bd Fl literal |
.Sx \&Ql , |
|
.Sx \&Dl , |
or |
or |
.Sx \&D1 |
.Sx \&Bd Fl literal |
is preferred for displaying code; the |
is preferred for displaying code samples; the |
.Sx \&Ic |
.Sx \&Ic |
macro is used when referring to specific instructions. |
macro is used when referring to an individual command name. |
.Ss \&In |
.Ss \&In |
The name of an include file. |
The name of an include file. |
This macro is most often used in section 2, 3, and 9 manual pages. |
This macro is most often used in section 2, 3, and 9 manual pages. |
|
|
.Dl \&.Lb libz |
.Dl \&.Lb libz |
.Dl \&.Lb libmandoc |
.Dl \&.Lb libmandoc |
.Ss \&Li |
.Ss \&Li |
Denotes text that should be in a |
Request a typewriter (literal) font. |
.Li literal |
Deprecated because on terminal output devices, this is usually |
font mode. |
indistinguishable from normal text. |
Note that this is a presentation term and should not be used for |
For literal displays, use |
stylistically decorating technical terms. |
.Sx \&Ql Pq in-line , |
.Pp |
.Sx \&Dl Pq single line , |
On terminal output devices, this is often indistinguishable from |
or |
normal text. |
.Sx \&Bd Fl literal Pq multi-line |
.Pp |
instead. |
See also |
|
.Sx \&Bf , |
|
.Sx \&Em , |
|
.Sx \&No , |
|
and |
|
.Sx \&Sy . |
|
.Ss \&Lk |
.Ss \&Lk |
Format a hyperlink. |
Format a hyperlink. |
Its syntax is as follows: |
Its syntax is as follows: |
|
|
See also |
See also |
.Sx \&Mt . |
.Sx \&Mt . |
.Ss \&Lp |
.Ss \&Lp |
Synonym for |
Deprecated synonym for |
.Sx \&Pp . |
.Sx \&Pp . |
.Ss \&Ms |
.Ss \&Ms |
Display a mathematical symbol. |
Display a mathematical symbol. |
|
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Em , |
.Sx \&Em , |
.Sx \&Li , |
.Sx \&Ql , |
and |
and |
.Sx \&Sy . |
.Sx \&Sy . |
.Ss \&Ns |
.Ss \&Ns |
Line 2220 Close quoted context opened by |
|
Line 2237 Close quoted context opened by |
|
.Sx \&Qo . |
.Sx \&Qo . |
.Ss \&Ql |
.Ss \&Ql |
In-line literal display. |
In-line literal display. |
This can for example be used for complete command invocations and |
This can be used for complete command invocations and for multi-word |
for multi-word code fragments when more specific markup is not |
code examples when an indented display is not desired. |
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. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&Dl |
.Sx \&Dl |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bf , |
|
.Sx \&Em , |
.Sx \&Em , |
.Sx \&Li , |
.Sx \&No , |
and |
and |
.Sx \&No . |
.Sx \&Ql . |
.Ss \&Ta |
.Ss \&Ta |
Table cell separator in |
Table cell separator in |
.Sx \&Bl Fl column |
.Sx \&Bl Fl column |