version 1.164, 2010/11/29 13:02:47 |
version 1.166, 2010/11/30 20:45:55 |
|
|
.\" $Id$ |
.\" $OpenBSD$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
|
|
.Pp |
.Pp |
The |
The |
.Em Callable |
.Em Callable |
column indicates that the macro may be called subsequent to the initial |
column indicates that the macro may also be called by passing its name |
line-macro. |
as an argument to another macro. |
If a macro is not callable, then its invocation after the initial line |
If a macro is not callable but its name appears as an argument |
macro is interpreted as opaque text, such that |
to another macro, it is interpreted as opaque text. |
|
For example, |
.Sq \&.Fl \&Sh |
.Sq \&.Fl \&Sh |
produces |
produces |
.Sq Fl \&Sh . |
.Sq Fl \&Sh . |
.Pp |
.Pp |
The |
The |
.Em Parsed |
.Em Parsed |
column indicates whether the macro may be followed by further |
column indicates whether the macro may call other macros by receiving |
(ostensibly callable) macros. |
their names as arguments. |
If a macro is not parsed, subsequent macro invocations on the line |
If a macro is not parsed but the name of another macro appears |
will be interpreted as opaque text. |
as an argument, it is interpreted as opaque text. |
.Pp |
.Pp |
The |
The |
.Em Scope |
.Em Scope |
|
|
.Sx \&Ux . |
.Sx \&Ux . |
.Ss \&Pa |
.Ss \&Pa |
A file-system path. |
A file-system path. |
|
If an argument is not provided, the string |
|
.Dq \(ti |
|
is used as a default. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Pa /usr/bin/mandoc |
.D1 \&.Pa /usr/bin/mandoc |
|
|
Close a scope opened by |
Close a scope opened by |
.Sx \&Xo . |
.Sx \&Xo . |
.Ss \&Xo |
.Ss \&Xo |
Open an extension scope. |
Extend the header of an |
This macro originally existed to extend the 9-argument limit of troff; |
.Sx \&It |
since this limit has been lifted, the macro has been deprecated. |
macro or the body of a partial-implicit block macro |
|
beyond the end of the input line. |
|
This macro originally existed to work around the 9-argument limit |
|
of historic |
|
.Xr roff 7 . |
.Ss \&Xr |
.Ss \&Xr |
Link to another manual |
Link to another manual |
.Pq Qq cross-reference . |
.Pq Qq cross-reference . |
Line 2718 troff implementations, at this time limited to GNU tro |
|
Line 2726 troff implementations, at this time limited to GNU tro |
|
.Pq Qq groff . |
.Pq Qq groff . |
The term |
The term |
.Qq historic groff |
.Qq historic groff |
refers to groff versions before the |
refers to groff versions before 1.17, |
|
which featured a significant update of the |
.Pa doc.tmac |
.Pa doc.tmac |
file re-write |
file. |
.Pq somewhere between 1.15 and 1.19 . |
|
.Pp |
.Pp |
Heirloom troff, the other significant troff implementation accepting |
Heirloom troff, the other significant troff implementation accepting |
\-mdoc, is similar to historic groff. |
\-mdoc, is similar to historic groff. |
Line 2811 can only be called by other macros, but not at the beg |
|
Line 2819 can only be called by other macros, but not at the beg |
|
.It |
.It |
.Sx \&%C |
.Sx \&%C |
is not implemented. |
is not implemented. |
|
.It |
|
Historic groff only allows up to eight or nine arguments per macro input |
|
line, depending on the exact situation. |
|
Providing more arguments causes garbled output. |
|
The number of arguments on one input line is not limited with mandoc. |
.It |
.It |
Historic groff has many un-callable macros. |
Historic groff has many un-callable macros. |
Most of these (excluding some block-level macros) are callable |
Most of these (excluding some block-level macros) are callable |