version 1.262, 2017/02/16 14:38:12 |
version 1.271, 2018/07/28 18:34:15 |
|
|
.\" $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 476 in the alphabetical |
|
Line 476 in the alphabetical |
|
.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments) |
.It Sx \&Ap Ta apostrophe without surrounding whitespace (no arguments) |
.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 |
.It Sx \&br Ta force output line break in text mode (no arguments) |
|
.It Sx \&sp Ta force vertical space: Op Ar height |
|
.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 490 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 511 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 . |
|
|
.At . |
.At . |
.It Cm III |
.It Cm III |
.At III . |
.At III . |
.It Cm V[.[1-4]]? |
.It Cm V | V.[1-4] |
A version of |
A version of |
.At V . |
.At V . |
.El |
.El |
|
|
.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 1242 If no date string is given, the current date is used. |
|
Line 1264 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 1852 The tab cell delimiter may only be used within the |
|
Line 1874 The tab cell delimiter may only be used within the |
|
.Sx \&It |
.Sx \&It |
line itself; on following lines, only the |
line itself; on following lines, only the |
.Sx \&Ta |
.Sx \&Ta |
macro can be used to delimit cells, and |
macro can be used to delimit cells, and portability requires that |
.Sx \&Ta |
.Sx \&Ta |
is only recognised as a macro when called by other macros, |
is called by other macros: some parsers do not recognize it when |
not as the first macro on a line. |
it appears as the first macro on a line. |
.Pp |
.Pp |
Note that quoted strings may span tab-delimited cells on an |
Note that quoted strings may span tab-delimited cells on an |
.Sx \&It |
.Sx \&It |
Line 2577 The second and last Technical Corrigendum. |
|
Line 2599 The second and last Technical Corrigendum. |
|
.br |
.br |
This standard is also called |
This standard is also called |
X/Open Portability Guide version 7. |
X/Open Portability Guide version 7. |
.Pp |
|
.It \-p1003.1-2013 |
|
.St -p1003.1-2013 |
|
.br |
|
This is the first Technical Corrigendum. |
|
.El |
.El |
.It Other standards |
.It Other standards |
.Pp |
.Pp |
|
|
.Dl \&.Xr mandoc 1 |
.Dl \&.Xr mandoc 1 |
.Dl \&.Xr mandoc 1 \&; |
.Dl \&.Xr mandoc 1 \&; |
.Dl \&.Xr mandoc 1 \&Ns s behaviour |
.Dl \&.Xr mandoc 1 \&Ns s behaviour |
.Ss \&br |
|
Emits a line-break. |
|
This macro should not be used; it is implemented for compatibility with |
|
historical manuals. |
|
.Pp |
|
Consider using |
|
.Sx \&Pp |
|
in the event of natural paragraph breaks. |
|
.Ss \&sp |
|
Emits vertical space. |
|
This macro should not be used; it is implemented for compatibility with |
|
historical manuals. |
|
Its syntax is as follows: |
|
.Pp |
|
.D1 Pf \. Sx \&sp Op Ar height |
|
.Pp |
|
The |
|
.Ar height |
|
argument is a scaling width as described in |
|
.Xr roff 7 . |
|
If unspecified, |
|
.Sx \&sp |
|
asserts a single vertical space. |
|
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
The syntax of a macro depends on its classification. |
The syntax of a macro depends on its classification. |
In this section, |
In this section, |
Line 3043 then the macro accepts an arbitrary number of argument |
|
Line 3037 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Va Ta Yes Ta Yes Ta n |
.It Sx \&Va Ta Yes Ta Yes Ta n |
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
.It Sx \&Vt Ta Yes Ta Yes Ta >0 |
.It Sx \&Xr Ta Yes Ta Yes Ta 2 |
.It Sx \&Xr Ta Yes Ta Yes Ta 2 |
.It Sx \&br Ta \&No Ta \&No Ta 0 |
|
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
|
.El |
.El |
.Ss Delimiters |
.Ss Delimiters |
When a macro argument consists of one single input character |
When a macro argument consists of one single input character |
Line 3230 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. |