version 1.147, 2010/08/07 10:26:07 |
version 1.158, 2010/09/04 17:22:41 |
|
|
\&.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 .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 363 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 |
Line 2095 Its syntax is as follows: |
|
Line 2097 Its syntax is as follows: |
|
.D1 Pf \. Sx \&Lk Cm uri Op Cm name |
.D1 Pf \. Sx \&Lk Cm uri Op Cm name |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Lk http://bsd.lv "The BSD.lv Project" |
.D1 \&.Lk http://bsd.lv \*qThe BSD.lv Project\*q |
.D1 \&.Lk http://bsd.lv |
.D1 \&.Lk http://bsd.lv |
.Pp |
.Pp |
See also |
See also |
Line 2672 is followed by non-punctuation, an |
|
Line 2674 is followed by non-punctuation, an |
|
.Sx \&Ns |
.Sx \&Ns |
is inserted into the token stream. |
is inserted into the token stream. |
This behaviour is for compatibility with |
This behaviour is for compatibility with |
.Xr groff 1 . |
GNU troff. |
.Pp |
.Pp |
Examples: |
Examples: |
.D1 \&.Xr mandoc 1 |
.D1 \&.Xr mandoc 1 |
|
|
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. |
.Pp |
.Pp |
|
The following problematic behaviour is found in groff: |
|
.ds hist (Historic groff only.) |
|
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
The |
.Sx \&At |
.Sq \&%C |
with unknown arguments produces no output at all. |
macro is not implemented in GNU troff. |
\*[hist] |
|
Newer groff and mandoc print |
|
.Qq AT&T UNIX |
|
and the arguments. |
.It |
.It |
An empty |
.Sx \&Bd Fl column |
.Sq \&Dd |
does not recognize trailing punctuation characters when they immediately |
macro in groff prints |
precede tabulator characters, but treats them as normal text and |
|
outputs a space before them. |
|
.It |
|
.Sx \&Bd Fl ragged compact |
|
does not start a new line. |
|
\*[hist] |
|
.It |
|
.Sx \&Dd |
|
without an argument prints |
.Dq Epoch . |
.Dq Epoch . |
In mandoc, it resolves to the current date. |
In mandoc, it resolves to the current date. |
.It |
.It |
The \es (font size), \em (font colour), and \eM (font filling colour) |
.Sx \&Fl |
font decoration escapes are all discarded in mandoc. |
does not print a dash for an empty argument. |
|
\*[hist] |
.It |
.It |
Old groff fails to assert a newline before |
.Sx \&Fn |
.Sx \&Bd Fl ragged compact . |
does not start a new line unless invoked as the line macro in the |
|
.Em SYNOPSIS |
|
section. |
|
\*[hist] |
.It |
.It |
groff behaves inconsistently when encountering |
|
.Pf non- Sx \&Fa |
|
children of |
|
.Sx \&Fo |
.Sx \&Fo |
regarding spacing between arguments. |
with |
In mandoc, this is not the case: each argument is consistently followed |
.Pf non- Sx \&Fa |
by a single space and the trailing |
children causes inconsistent spacing between arguments. |
.Sq \&) |
In mandoc, a single space is always inserted between arguments. |
suppresses prior spacing. |
|
.It |
.It |
groff behaves inconsistently when encountering |
|
.Sx \&Ft |
.Sx \&Ft |
and |
|
.Sx \&Fn |
|
in the |
in the |
.Em SYNOPSIS : |
.Em SYNOPSIS |
at times newline(s) are suppressed depending on whether a prior |
causes inconsistent vertical spacing, depending on whether a prior |
.Sx \&Fn |
.Sx \&Fn |
has been invoked. |
has been invoked. |
In mandoc, this is not the case. |
|
See |
See |
.Sx \&Ft |
.Sx \&Ft |
and |
and |
.Sx \&Fn |
.Sx \&Fn |
for the normalised behaviour. |
for the normalised behaviour in mandoc. |
.It |
.It |
Historic groff does not break before an |
|
.Sx \&Fn |
|
when not invoked as the line macro in the |
|
.Em SYNOPSIS |
|
section. |
|
.It |
|
Historic groff formats the |
|
.Sx \&In |
.Sx \&In |
badly: trailing arguments are trashed and |
ignores additional arguments and is not treated specially in the |
.Em SYNOPSIS |
.Em SYNOPSIS . |
is not specially treated. |
\*[hist] |
.It |
.It |
groff does not accept the |
.Sx \&It |
.Sq \&Ta |
sometimes requires a |
pseudo-macro as a line macro. |
.Fl nested |
mandoc does. |
flag. |
|
\*[hist] |
|
In new groff and mandoc, any list may be nested by default and |
|
.Fl enum |
|
lists will restart the sequence only for the sub-list. |
.It |
.It |
The comment syntax |
.Sx \&Li |
.Sq \e\." |
followed by a reserved character is incorrectly used in some manuals |
is no longer accepted. |
instead of properly quoting that character, which sometimes works with |
|
historic groff. |
.It |
.It |
In groff, the |
.Sx \&Lk |
|
only accepts a single link-name argument; the remainder is misformatted. |
|
.It |
.Sx \&Pa |
.Sx \&Pa |
macro does not format its arguments when used in the FILES section under |
does not format its arguments when used in the FILES section under |
certain list types. |
certain list types. |
mandoc does. |
|
.It |
.It |
Historic groff does not print a dash for empty |
.Sx \&Ta |
.Sx \&Fl |
can only be called by other macros, but not at the beginning of a line. |
arguments. |
|
mandoc and newer groff implementations do. |
|
.It |
.It |
groff behaves irregularly when specifying |
.Sx \&%C |
|
is not implemented. |
|
.It |
|
Historic groff has many un-callable macros. |
|
Most of these (excluding some block-level macros) are callable |
|
in new groff and mandoc. |
|
.It |
|
.Sq \(ba |
|
(vertical bar) is not fully supported as a delimiter. |
|
\*[hist] |
|
.It |
.Sq \ef |
.Sq \ef |
|
.Pq font face |
|
and |
|
.Sq \ef |
|
.Pq font family face |
.Sx Text Decoration |
.Sx Text Decoration |
within line-macro scopes. |
escapes behave irregularly when specified within line-macro scopes. |
mandoc follows a consistent system. |
|
.It |
.It |
In mandoc, negative scaling units are truncated to zero; groff would |
Negative scaling units return to prior lines. |
move to prior lines. |
Instead, mandoc truncates them to zero. |
Furthermore, the |
.El |
.Sq f |
.Pp |
scaling unit, while accepted, is rendered as the default unit. |
The following features are unimplemented in mandoc: |
|
.Pp |
|
.Bl -dash -compact |
.It |
.It |
In quoted literals, groff allowed pairwise double-quotes to produce a |
.Sx \&Bd |
standalone double-quote in formatted output. |
.Fl file Ar file . |
This idiosyncratic behaviour is not applicable in mandoc. |
|
.It |
.It |
Display offsets |
|
.Sx \&Bd |
.Sx \&Bd |
.Fl offset Ar center |
.Fl offset Ar center |
and |
and |
.Fl offset Ar right |
.Fl offset Ar right . |
are disregarded in mandoc. |
Groff does not implement centered and flush-right rendering either, |
Furthermore, troff specifies a |
but produces large indentations. |
.Fl file Ar file |
|
argument that is not supported in mandoc. |
|
Lastly, since text is not right-justified in mandoc (or even groff), |
|
.Fl ragged |
|
and |
|
.Fl filled |
|
are aliases, as are |
|
.Fl literal |
|
and |
|
.Fl unfilled . |
|
.It |
.It |
Historic groff has many un-callable macros. |
The |
Most of these (excluding some block-level macros) are now callable. |
.Sq \eh |
.It |
.Pq horizontal position , |
The vertical bar |
.Sq \ev |
.Sq \(ba |
.Pq vertical position , |
made historic groff |
.Sq \em |
.Qq go orbital |
.Pq text colour , |
but has been a proper delimiter since then. |
.Sq \eM |
.It |
.Pq text filling colour , |
.Sx \&It Fl nested |
.Sq \ez |
is assumed for all lists (it wasn't in historic groff): any list may be |
.Pq zero-length character , |
nested and |
.Sq \ew |
.Fl enum |
.Pq string length , |
lists will restart the sequence only for the sub-list. |
.Sq \ek |
.It |
.Pq horizontal position marker , |
Some manuals use |
.Sq \eo |
.Sx \&Li |
.Pq text overstrike , |
incorrectly by following it with a reserved character and expecting the |
|
delimiter to render. |
|
This is not supported in mandoc. |
|
.It |
|
In groff, the |
|
.Sx \&Cd , |
|
.Sx \&Er , |
|
.Sx \&Ex , |
|
and |
and |
.Sx \&Rv |
.Sq \es |
macros were stipulated only to occur in certain manual sections. |
.Pq text size |
mandoc does not have these restrictions. |
escape sequences are all discarded in mandoc. |
.It |
.It |
Newer groff and mandoc print |
The |
.Qq AT&T UNIX |
.Sq \ef |
prior to unknown arguments of |
scaling unit is accepted by mandoc, but rendered as the default unit. |
.Sx \&At ; |
.It |
older groff did nothing. |
In quoted literals, groff allows pairwise double-quotes to produce a |
|
standalone double-quote in formatted output. |
|
This is not supported by mandoc. |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
|
.Sh HISTORY |
|
The |
|
.Nm |
|
language first appeared as a troff macro package in |
|
.Bx 4.4 . |
|
It was later significantly updated by Werner Lemberg and Ruslan Ermilov |
|
in groff-1.17. |
|
The standalone implementation that is part of the |
|
.Xr mandoc 1 |
|
utility written by Kristaps Dzonsons appeared in |
|
.Ox 4.6 . |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |