=================================================================== RCS file: /cvs/mandoc/mdoc.7,v retrieving revision 1.162 retrieving revision 1.169 diff -u -p -r1.162 -r1.169 --- mandoc/mdoc.7 2010/10/24 14:49:35 1.162 +++ mandoc/mdoc.7 2010/12/06 16:37:32 1.169 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.162 2010/10/24 14:49:35 schwarze Exp $ +.\" $Id: mdoc.7,v 1.169 2010/12/06 16:37:32 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010 Kristaps Dzonsons .\" Copyright (c) 2010 Ingo Schwarze @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: October 24 2010 $ +.Dd $Mdocdate: December 6 2010 $ .Dt MDOC 7 .Os .Sh NAME @@ -604,20 +604,21 @@ closes it out. .Pp The .Em Callable -column indicates that the macro may be called subsequent to the initial -line-macro. -If a macro is not callable, then its invocation after the initial line -macro is interpreted as opaque text, such that +column indicates that the macro may also be called by passing its name +as an argument to another macro. +If a macro is not callable but its name appears as an argument +to another macro, it is interpreted as opaque text. +For example, .Sq \&.Fl \&Sh produces .Sq Fl \&Sh . .Pp The .Em Parsed -column indicates whether the macro may be followed by further -(ostensibly callable) macros. -If a macro is not parsed, subsequent macro invocations on the line -will be interpreted as opaque text. +column indicates whether the macro may call other macros by receiving +their names as arguments. +If a macro is not parsed but the name of another macro appears +as an argument, it is interpreted as opaque text. .Pp The .Em Scope @@ -1076,8 +1077,7 @@ implementations render it poorly. Left- and right-justify the block. .It Fl literal Do not justify the block at all. -Preserve white space and newlines as they appear in the input, including -if it follows a macro. +Preserve white space as it appears in the input. .It Fl ragged Only left-justify the block. .It Fl unfilled @@ -1871,9 +1871,9 @@ Examples: \&.Fn funcname .Ed .Pp -When referring to a function documented in another manual page, +When referring to a function documented in another manual page, use .Sx \&Xr -is usually preferable. +instead. See also .Sx MANUAL STRUCTURE and @@ -2124,6 +2124,9 @@ Examples: Format a .Dq mailto: hyperlink. +If an argument is not provided, the string +.Dq \(ti +is used as a default. Its syntax is as follows: .Pp .D1 Pf \. Sx \&Mt Cm address @@ -2305,6 +2308,9 @@ and .Sx \&Ux . .Ss \&Pa A file-system path. +If an argument is not provided, the string +.Dq \(ti +is used as a default. .Pp Examples: .D1 \&.Pa /usr/bin/mandoc @@ -2715,10 +2721,10 @@ troff implementations, at this time limited to GNU tro .Pq Qq groff . The term .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 -file re-write -.Pq somewhere between 1.15 and 1.19 . +file. .Pp Heirloom troff, the other significant troff implementation accepting \-mdoc, is similar to historic groff. @@ -2728,6 +2734,11 @@ The following problematic behaviour is found in groff: .Pp .Bl -dash -compact .It +Display macros +.Pq Sx \&Bd , Sx \&Dl , and Sx \&D1 +may not be nested. +\*[hist] +.It .Sx \&At with unknown arguments produces no output at all. \*[hist] @@ -2808,6 +2819,11 @@ can only be called by other macros, but not at the beg .It .Sx \&%C 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 Historic groff has many un-callable macros. Most of these (excluding some block-level macros) are callable