version 1.257, 2015/11/05 12:06:45 |
version 1.261, 2017/02/05 22:30:29 |
|
|
.\" $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 |
|
|
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 |
Line 1853 Note that quoted strings may span tab-delimited cells |
|
Line 1864 Note that quoted strings may span tab-delimited cells |
|
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 2714 Link to another manual |
|
Line 2726 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 |
Line 3033 then the macro accepts an arbitrary number of argument |
|
Line 3044 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 \&br Ta \&No Ta \&No Ta 0 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.It Sx \&sp Ta \&No Ta \&No Ta 1 |
.El |
.El |
Line 3053 For many macros, when the leading arguments are openin |
|
Line 3064 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 3217 but produces large indentations. |
|
Line 3230 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://mdocml.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 |