version 1.256, 2015/10/11 18:56:51 |
version 1.269, 2017/07/20 16:24:53 |
|
|
.\" $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 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010, 2011, 2013-2017 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 304 Print verbose information. |
|
Line 304 Print verbose information. |
|
\&.El |
\&.El |
.Ed |
.Ed |
.Pp |
.Pp |
|
List the options in alphabetical order, |
|
uppercase before lowercase for each letter and |
|
with no regard to whether an option takes an argument. |
|
Put digits in ascending order before all letter options. |
|
.Pp |
Manuals not documenting a command won't include the above fragment. |
Manuals not documenting a command won't include the above fragment. |
.Pp |
.Pp |
Since the |
Since the |
Line 471 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 485 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 506 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 |
|
|
.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 |
|
|
A columnated list. |
A columnated list. |
The |
The |
.Fl width |
.Fl width |
argument has no effect; instead, each argument specifies the width |
argument has no effect; instead, the string length of each argument |
of one column, using either the scaling width syntax described in |
specifies the width of one column. |
.Xr roff 7 |
|
or the string length of the argument. |
|
If the first line of the body of a |
If the first line of the body of a |
.Fl column |
.Fl column |
list is not an |
list is not an |
|
|
list is the most complicated. |
list is the most complicated. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ... |
|
.D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ... |
.D1 Pf \. Sx \&It Ar cell Op Sx \&Ta Ar cell ... |
|
.D1 Pf \. Sx \&It Ar cell Op <TAB> Ar cell ... |
.Pp |
.Pp |
The arguments consist of one or more lines of text and macros |
The arguments consist of one or more lines of text and macros |
representing a complete table line. |
representing a complete table line. |
Cells within the line are delimited by tabs or by the special |
Cells within the line are delimited by the special |
.Sx \&Ta |
.Sx \&Ta |
block macro. |
block macro or by literal tab characters. |
|
.Pp |
|
Using literal tabs is strongly discouraged because they are very |
|
hard to use correctly and |
|
.Nm |
|
code using them is very hard to read. |
|
In particular, a blank character is syntactically significant |
|
before and after the literal tab character. |
|
If a word precedes or follows the tab without an intervening blank, |
|
that word is never interpreted as a macro call, but always output |
|
literally. |
|
.Pp |
The tab cell delimiter may only be used within the |
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. |
line. |
For example, |
For example, |
.Pp |
.Pp |
.Dl .It \(dqcol1 ; <TAB> col2 ;\(dq \&; |
.Dl .It \(dqcol1 ,\& <TAB> col2 ,\(dq \&; |
.Pp |
.Pp |
will preserve the semicolon whitespace except for the last. |
will preserve the whitespace before both commas, |
|
but not the whitespace before the semicolon. |
.Pp |
.Pp |
See also |
See also |
.Sx \&Bl . |
.Sx \&Bl . |
Line 2562 The second and last Technical Corrigendum. |
|
Line 2575 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 |
Line 2709 Link to another manual |
|
Line 2717 Link to another manual |
|
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Xr Ar name Op section |
.D1 Pf \. Sx \&Xr Ar name section |
.Pp |
.Pp |
Cross reference the |
Cross reference the |
.Ar name |
.Ar name |
and |
and |
.Ar section |
.Ar section |
number of another man page; |
number of another man page. |
omitting the section number is rarely useful. |
|
.Pp |
.Pp |
Examples: |
Examples: |
.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 3028 then the macro accepts an arbitrary number of argument |
|
Line 3012 then the macro accepts an arbitrary number of argument |
|
.It Sx \&Ux Ta Yes Ta Yes Ta n |
.It Sx \&Ux Ta Yes Ta Yes Ta n |
.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 >0 |
.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 3048 For many macros, when the leading arguments are openin |
|
Line 3030 For many macros, when the leading arguments are openin |
|
these delimiters are put before the macro scope, |
these delimiters are put before the macro scope, |
and when the trailing arguments are closing delimiters, |
and when the trailing arguments are closing delimiters, |
these delimiters are put after the macro scope. |
these delimiters are put after the macro scope. |
|
Spacing is suppressed after opening delimiters |
|
and before closing delimiters. |
For example, |
For example, |
.Pp |
.Pp |
.D1 Pf \. \&Aq "( [ word ] ) ." |
.D1 Pf \. \&Aq "( [ word ] ) ." |
|
|
.D1 Fl a ( b | c \*(Ba d ) e |
.D1 Fl a ( b | c \*(Ba d ) e |
.Pp |
.Pp |
This applies to both opening and closing delimiters, |
This applies to both opening and closing delimiters, |
and also to the middle delimiter: |
and also to the middle delimiter, which does not suppress spacing: |
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
.It \&| |
.It \&| |
Line 3212 but produces large indentations. |
|
Line 3196 but produces large indentations. |
|
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
.Xr roff 7 , |
.Xr roff 7 , |
.Xr tbl 7 |
.Xr tbl 7 |
|
.Pp |
|
The web page |
|
.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. |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |