version 1.267, 2017/06/29 13:17:00 |
version 1.270, 2017/10/23 13:54:41 |
Line 477 in the alphabetical |
|
Line 477 in the alphabetical |
|
.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off |
.It Sx \&Sm Ta switch horizontal spacing mode: Op Cm on | off |
.It Sx \&Bk , \&Ek Ta keep block: Fl words |
.It Sx \&Bk , \&Ek Ta keep block: Fl words |
.El |
.El |
.Ss Semantic markup for command line utilities: |
.Ss Semantic markup for command line utilities |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility |
.It Sx \&Nm Ta start a SYNOPSIS block with the name of a utility |
.It Sx \&Fl Ta command line options (flags) (>=0 arguments) |
.It Sx \&Fl Ta command line options (flags) (>=0 arguments) |
Line 488 in the alphabetical |
|
Line 488 in the alphabetical |
|
.It Sx \&Ev Ta environmental variable (>0 arguments) |
.It Sx \&Ev Ta environmental variable (>0 arguments) |
.It Sx \&Pa Ta file system path (>=0 arguments) |
.It Sx \&Pa Ta file system path (>=0 arguments) |
.El |
.El |
.Ss Semantic markup for function libraries: |
.Ss Semantic markup for function libraries |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&Lb Ta function library (one argument) |
.It Sx \&Lb Ta function library (one argument) |
.It Sx \&In Ta include file (one argument) |
.It Sx \&In Ta include file (one argument) |
Line 509 in the alphabetical |
|
Line 509 in the alphabetical |
|
.It Sx \&Er Ta error constant (>0 arguments) |
.It Sx \&Er Ta error constant (>0 arguments) |
.It Sx \&Ev Ta environmental variable (>0 arguments) |
.It Sx \&Ev Ta environmental variable (>0 arguments) |
.El |
.El |
.Ss Various semantic markup: |
.Ss Various semantic markup |
.Bl -column "Brq, Bro, Brc" description |
.Bl -column "Brq, Bro, Brc" description |
.It Sx \&An Ta author name (>0 arguments) |
.It Sx \&An Ta author name (>0 arguments) |
.It Sx \&Lk Ta hyperlink: Ar uri Op Ar name |
.It Sx \&Lk Ta hyperlink: Ar uri Op Ar name |
|
|
.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 . |
Line 3198 but produces large indentations. |
|
Line 3222 but produces large indentations. |
|
.Xr tbl 7 |
.Xr tbl 7 |
.Pp |
.Pp |
The web page |
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 |
provides a few tutorial-style pages for beginners, an extensive style |
guide for advanced authors, and an alphabetic index helping to choose |
guide for advanced authors, and an alphabetic index helping to choose |
the best macros for various kinds of content. |
the best macros for various kinds of content. |