version 1.152, 2010/08/24 12:18:49 |
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> |
|
|
\&.Sh NAME |
\&.Sh NAME |
\&.Nm foo |
\&.Nm foo |
\&.Nd a description goes here |
\&.Nd a description goes here |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .Sh LIBRARY |
\&.\e\*q .Sh LIBRARY |
|
\&.\e\*q For sections 2, 3, & 9 only. |
|
\&.\e\*q Not used in OpenBSD. |
\&.Sh SYNOPSIS |
\&.Sh SYNOPSIS |
\&.Nm foo |
\&.Nm foo |
\&.Op Fl options |
\&.Op Fl options |
|
|
\&.Nm |
\&.Nm |
utility processes files ... |
utility processes files ... |
\&.\e\*q .Sh IMPLEMENTATION NOTES |
\&.\e\*q .Sh IMPLEMENTATION NOTES |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q Not used in OpenBSD. |
\&.\e\*q .Sh RETURN VALUES |
\&.\e\*q .Sh RETURN VALUES |
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q .Sh ENVIRONMENT |
\&.\e\*q .Sh ENVIRONMENT |
|
\&.\e\*q For sections 1, 6, 7, & 8 only. |
\&.\e\*q .Sh FILES |
\&.\e\*q .Sh FILES |
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .Sh EXIT STATUS |
\&.\e\*q .Sh EXIT STATUS |
|
\&.\e\*q For sections 1, 6, & 8 only. |
\&.\e\*q .Sh EXAMPLES |
\&.\e\*q .Sh EXAMPLES |
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .Sh DIAGNOSTICS |
\&.\e\*q .Sh DIAGNOSTICS |
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q For sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .Sh ERRORS |
\&.\e\*q .Sh ERRORS |
|
\&.\e\*q For sections 2, 3, & 9 only. |
\&.\e\*q .Sh SEE ALSO |
\&.\e\*q .Sh SEE ALSO |
\&.\e\*q .Xr foobar 1 |
\&.\e\*q .Xr foobar 1 |
\&.\e\*q .Sh STANDARDS |
\&.\e\*q .Sh STANDARDS |
Line 362 utility processes files ... |
|
Line 364 utility processes files ... |
|
\&.\e\*q .Sh CAVEATS |
\&.\e\*q .Sh CAVEATS |
\&.\e\*q .Sh BUGS |
\&.\e\*q .Sh BUGS |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
\&.\e\*q .Sh SECURITY CONSIDERATIONS |
|
\&.\e\*q Not used in OpenBSD. |
.Ed |
.Ed |
.Pp |
.Pp |
The sections in an |
The sections in an |
|
|
.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 |
Line 1073 implementations render it poorly. |
|
Line 1077 implementations render it poorly. |
|
Left- and right-justify the block. |
Left- and right-justify the block. |
.It Fl literal |
.It Fl literal |
Do not justify the block at all. |
Do not justify the block at all. |
Preserve white space as it appears in the input. |
Preserve white space and newlines as they appear in the input, including |
|
if it follows a macro. |
.It Fl ragged |
.It Fl ragged |
Only left-justify the block. |
Only left-justify the block. |
.It Fl unfilled |
.It Fl unfilled |
Line 1643 It must be one of |
|
Line 1648 It must be one of |
|
.Ar luna88k , |
.Ar luna88k , |
.Ar mac68k , |
.Ar mac68k , |
.Ar macppc , |
.Ar macppc , |
|
.Ar mips64 , |
.Ar mvme68k , |
.Ar mvme68k , |
.Ar mvme88k , |
.Ar mvme88k , |
.Ar mvmeppc , |
.Ar mvmeppc , |
|
|
\&.Fn funcname |
\&.Fn funcname |
.Ed |
.Ed |
.Pp |
.Pp |
|
When referring to a function documented in another manual page, use |
|
.Sx \&Xr |
|
instead. |
See also |
See also |
.Sx MANUAL STRUCTURE |
.Sx MANUAL STRUCTURE |
and |
and |
|
|
Format a |
Format a |
.Dq mailto: |
.Dq mailto: |
hyperlink. |
hyperlink. |
|
If an argument is not provided, the string |
|
.Dq \(ti |
|
is used as a default. |
Its syntax is as follows: |
Its syntax is as follows: |
.Pp |
.Pp |
.D1 Pf \. Sx \&Mt Cm address |
.D1 Pf \. Sx \&Mt Cm address |
|
|
.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 2707 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 2801 can only be called by other macros, but not at the beg |
|
Line 2820 can only be called by other macros, but not at the beg |
|
.Sx \&%C |
.Sx \&%C |
is not implemented. |
is not implemented. |
.It |
.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 |
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 |
in new groff and mandoc. |
in new groff and mandoc. |
|
|
.Pq text filling colour , |
.Pq text filling colour , |
.Sq \ez |
.Sq \ez |
.Pq zero-length character , |
.Pq zero-length character , |
|
.Sq \ew |
|
.Pq string length , |
|
.Sq \ek |
|
.Pq horizontal position marker , |
|
.Sq \eo |
|
.Pq text overstrike , |
and |
and |
.Sq \es |
.Sq \es |
.Pq text size |
.Pq text size |
.Sx Text Decoration |
escape sequences are all discarded in mandoc. |
escapes are all discarded in mandoc. |
|
.It |
.It |
The |
The |
.Sq \ef |
.Sq \ef |
Line 2861 standalone double-quote in formatted output. |
|
Line 2890 standalone double-quote in formatted output. |
|
This is not supported by mandoc. |
This is not supported by mandoc. |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
.Sh HISTORY |
.Sh HISTORY |
|
|
language first appeared as a troff macro package in |
language first appeared as a troff macro package in |
.Bx 4.4 . |
.Bx 4.4 . |
It was later significantly updated by Werner Lemberg and Ruslan Ermilov |
It was later significantly updated by Werner Lemberg and Ruslan Ermilov |
in groff-1.20.1. |
in groff-1.17. |
The standalone implementation that is part of the |
The standalone implementation that is part of the |
.Xr mandoc 1 |
.Xr mandoc 1 |
utility written by Kristaps Dzonsons appeared in |
utility written by Kristaps Dzonsons appeared in |