=================================================================== RCS file: /cvs/mandoc/mdoc.7,v retrieving revision 1.203 retrieving revision 1.208 diff -u -p -r1.203 -r1.208 --- mandoc/mdoc.7 2011/08/19 10:19:55 1.203 +++ mandoc/mdoc.7 2011/09/02 19:37:35 1.208 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.203 2011/08/19 10:19:55 kristaps Exp $ +.\" $Id: mdoc.7,v 1.208 2011/09/02 19:37:35 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 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: August 19 2011 $ +.Dd $Mdocdate: September 2 2011 $ .Dt MDOC 7 .Os .Sh NAME @@ -98,9 +98,9 @@ or a single one character sequence. Examples: .Bl -tag -width Ds -offset indent -compact .It Li \e(em -em dash +Two-letter em dash escape. .It Li \ee -backslash +One-letter backslash escape. .El .Pp See @@ -126,9 +126,9 @@ scope. Examples: .Bl -tag -width Ds -offset indent -compact .It Li \efBbold\efR -write in bold, then switch to regular +Write in bold, then switch to regular font mode. .It Li \efIitalic\efP -write in italic, then return to previous +Write in italic, then return to previous font mode. .El .Pp Text decoration is @@ -152,9 +152,9 @@ and N-character Examples: .Bl -tag -width Ds -offset indent -compact .It Li \e*(Am -ampersand -.It Li \e*(Ba -vertical bar +Two-letter ampersand predefined string. +.It Li \e*q +One-letter double-quote predefined string. .El .Pp These strings are set using @@ -176,7 +176,7 @@ In the rare case that a blank character is needed at t input line, it may be forced by .Sq \e\ \e& . .Pp -In general, space characters can be considered as non-whitespace +In general, space characters can be rendered as literal characters by using non-breaking space escapes or .Sx Quotation . .Pp @@ -197,15 +197,21 @@ terminates the literal, regardless of surrounding whit Examples: .Bl -tag -width Ds -offset indent -compact .It Li .Fn strlen \(dqconst char *s\(dq -groups +Group arguments .Qq const char *s -into one term -.Pq see Sx \&Fn +into one function argument. +If unspecified, +.Qq const , +.Qq char , +and +.Qq *s +would be considered separate arguments. +.Pq See Sx \&Fn . .It Li .Op \(dqFl a\(dq -considers +Consider .Qq \&Fl a -as literal text -.Pq see Sx \&Op , \&Fl +as literal text instead of a flag macro. +.Pq Aee Sx \&Op , \&Fl . .El .Ss Scaling Widths Many macros support scaled widths for their arguments. @@ -683,8 +689,7 @@ contain a head. \(lBbody...\(rB \&.Yc .Ed -.Pp -.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXX" +.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXX" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope .It Sx \&Bd Ta \&No Ta \&No Ta closed by Sx \&Ed .It Sx \&Bf Ta \&No Ta \&No Ta closed by Sx \&Ef @@ -716,8 +721,7 @@ has multiple heads. \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead... \(lBTa head...\(rB\(rB \(lBbody...\(rB .Ed -.Pp -.Bl -column -compact -offset indent "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" +.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXXXXXXXXX" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope .It Sx \&It Ta \&No Ta Yes Ta closed by Sx \&It , Sx \&El .It Sx \&Nd Ta \&No Ta \&No Ta closed by Sx \&Sh @@ -752,8 +756,7 @@ and/or tail \&.Yo \(lB\-arg \(lBparm...\(rB\(rB \(lBhead...\(rB \ \(lBbody...\(rB \&Yc \(lBtail...\(rB .Ed -.Pp -.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent +.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope .It Sx \&Ac Ta Yes Ta Yes Ta opened by Sx \&Ao .It Sx \&Ao Ta Yes Ta Yes Ta closed by Sx \&Ac @@ -786,8 +789,7 @@ end of the line. .Bd -literal -offset indent \&.Yo \(lB\-arg \(lBval...\(rB\(rB \(lBbody...\(rB \(lBres...\(rB .Ed -.Pp -.Bl -column "MacroX" "CallableX" "ParsedX" -compact -offset indent +.Bl -column "MacroX" "CallableX" "ParsedX" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed .It Sx \&Aq Ta Yes Ta Yes .It Sx \&Bq Ta Yes Ta Yes @@ -822,8 +824,7 @@ in lists. It delimits blocks representing table cells; these blocks have bodies, but no heads. -.Pp -.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -compact -offset indent +.Bl -column "MacroX" "CallableX" "ParsedX" "closed by XXXX" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Scope .It Sx \&Ta Ta Yes Ta Yes Ta closed by Sx \&Ta , Sx \&It .El @@ -841,8 +842,7 @@ then the macro accepts an arbitrary number of argument \&.Yo \(lB\-arg \(lBval...\(rB\(rB arg0 arg1 argN .Ed -.Pp -.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -compact -offset indent +.Bl -column "MacroX" "CallableX" "ParsedX" "Arguments" -offset indent .It Em Macro Ta Em Callable Ta Em Parsed Ta Em Arguments .It Sx \&%A Ta \&No Ta \&No Ta >0 .It Sx \&%B Ta \&No Ta \&No Ta >0 @@ -2302,7 +2302,7 @@ line itself; on following lines, only the .Sx \&Ta macro can be used to delimit cells, and .Sx \&Ta -is only recognized as a macro when called by other macros, +is only recognised as a macro when called by other macros, not as the first macro on a line. .Pp Note that quoted strings may span tab-delimited cells on an @@ -3094,7 +3094,7 @@ Newer groff and mandoc print and the arguments. .It .Sx \&Bl Fl column -does not recognize trailing punctuation characters when they immediately +does not recognise trailing punctuation characters when they immediately precede tabulator characters, but treats them as normal text and outputs a space before them. .It @@ -3206,7 +3206,7 @@ The following features are unimplemented in mandoc: .Fl offset Ar center and .Fl offset Ar right . -Groff does not implement centered and flush-right rendering either, +Groff does not implement centred and flush-right rendering either, but produces large indentations. .It The