=================================================================== RCS file: /cvs/mandoc/man.7,v retrieving revision 1.44 retrieving revision 1.54 diff -u -p -r1.44 -r1.54 --- mandoc/man.7 2009/11/02 09:53:15 1.44 +++ mandoc/man.7 2009/11/16 08:46:59 1.54 @@ -1,4 +1,4 @@ -.\" $Id: man.7,v 1.44 2009/11/02 09:53:15 kristaps Exp $ +.\" $Id: man.7,v 1.54 2009/11/16 08:46:59 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,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: November 2 2009 $ +.Dd $Mdocdate: November 16 2009 $ .Dt MAN 7 .Os . @@ -67,15 +67,7 @@ line termination. Blank lines are acceptable; where found, the output will assert a vertical space. . -.Pp -The -.Sq \ec -escape is common in historical -.Nm -documents; if encountered at the end of a word, it ensures that the -subsequent word isn't off-set by whitespace. . -. .Ss Comments Text following a .Sq \e\*" , @@ -109,8 +101,45 @@ and .Ss Text Decoration Terms may be text-decorated using the .Sq \ef -escape followed by an indicator: B (bold), I, (italic), or P and R -(Roman, or reset). +escape followed by an indicator: B (bold), I, (italic), R (Roman), or P +(revert to previous mode): +.Pp +.D1 \efBbold\efR \efIitalic\efP +.Pp +A numerical representation 3, 2, or 1 (bold, italic, and Roman, +respectively) may be used instead. A text decoration is only valid, if +specified in free-form text, until the next macro invocation; if +specified within a macro, it's only valid until the macro closes scope. +Note that macros like +.Sx \&BR +open and close a font scope with each argument. +.Pp +Text may also be sized with the +.Sq \es +escape, whose syntax is one of +.Sq \es+-n +for one-digit numerals; +.Sq \es(+-nn +or +.Sq \es+-(nn +for two-digit numerals; and +.Sq \es[+-N] , +.Sq \es+-[N] , +.Sq \es'+-N' , +or +.Sq \es+-'N' +for arbitrary-digit numerals: +.Pp +.D1 \es+1bigger\es-1 +.D1 \es[+10]much bigger\es[-10] +.D1 \es+(10much bigger\es-(10 +.D1 \es+'100'much much bigger\es-'100' +.Pp +Both +.Sq \es +and +.Sq \ef +attributes are forgotten when entering or exiting a macro block. . . .Ss Whitespace @@ -547,11 +576,9 @@ and render in italics. Whitespace between arguments is omitted in output. .Pp Examples: -.Bd -filled -offset indent -.Pf \. Sx \&BI -bold italic bold italic -.Ed .Pp +.D1 \&.BI bold italic bold italic +.Pp The output of this example will be emboldened .Dq bold and italicised @@ -604,12 +631,12 @@ If specified, it's saved for later paragraph left-marg saved or default width is used. .Pp See also -.Sx IP , -.Sx LP , -.Sx P , -.Sx PP , +.Sx \&IP , +.Sx \&LP , +.Sx \&P , +.Sx \&PP , and -.Sx TP . +.Sx \&TP . . . .Ss \&I @@ -661,12 +688,12 @@ argument is used as a leading term, flushed to the lef useful for bulleted paragraphs and so on. .Pp See also -.Sx HP , -.Sx LP , -.Sx P , -.Sx PP , +.Sx \&HP , +.Sx \&LP , +.Sx \&P , +.Sx \&PP , and -.Sx TP . +.Sx \&TP . . . .Ss \&IR @@ -692,12 +719,12 @@ subsequent paragraph, sub-section, section, or end of paragraph left-margin width is re-set to the default. .Pp See also -.Sx HP , -.Sx IP , -.Sx P , -.Sx PP , +.Sx \&HP , +.Sx \&IP , +.Sx \&P , +.Sx \&PP , and -.Sx TP . +.Sx \&TP . . . .Ss \&P @@ -705,12 +732,12 @@ Synonym for .Sx \&LP . .Pp See also -.Sx HP , -.Sx IP , -.Sx LP , -.Sx PP , +.Sx \&HP , +.Sx \&IP , +.Sx \&LP , +.Sx \&PP , and -.Sx TP . +.Sx \&TP . . . .Ss \&PP @@ -718,12 +745,12 @@ Synonym for .Sx \&LP . .Pp See also -.Sx HP , -.Sx IP , -.Sx LP , -.Sx P , +.Sx \&HP , +.Sx \&IP , +.Sx \&LP , +.Sx \&P , and -.Sx TP . +.Sx \&TP . . . .Ss \&R @@ -841,9 +868,8 @@ string replaces the default rendered volume, which is manual section. .Pp Examples: -.Bd -filled -offset indent -\&.TH CVS 5 "1992-02-12" GNU -.Ed +.Pp +.D1 \&.TH CVS 5 "1992-02-12" GNU . . .Ss \&TP @@ -864,12 +890,12 @@ If specified, it's saved for later paragraph left-marg unspecified, the saved or default width is used. .Pp See also -.Sx HP , -.Sx IP , -.Sx LP , -.Sx P , +.Sx \&HP , +.Sx \&IP , +.Sx \&LP , +.Sx \&P , and -.Sx PP . +.Sx \&PP . . . .Ss \&PD @@ -893,8 +919,8 @@ End literal mode begun by . . .Ss \&i -Italicise arguments. If no arguments are specified, all subsequent text -is italicised. +Italicise arguments. Synonym for +.Sx \&I . .Pp See also .Sx \&B , @@ -950,14 +976,21 @@ See also This section documents compatibility with other roff implementations, at this time limited to .Xr groff 1 . -.Bl -hyphen +.Pp +.Bl -dash -compact .It +The +.Xr groff 1 +.Sx \&i +macro will italicise all subsequent text if a line argument is not +provided. This behaviour is not implemented. +.It In quoted literals, groff allowed pair-wise double-quotes to produce a standalone double-quote in formatted output. This idiosyncratic behaviour is no longer applicable. .It The -.Sq sp +.Sx \&sp macro does not accept negative numbers. .It Blocks of whitespace are stripped from both macro and free-form text