=================================================================== RCS file: /cvs/mandoc/roff.7,v retrieving revision 1.92 retrieving revision 1.106 diff -u -p -r1.92 -r1.106 --- mandoc/roff.7 2017/06/14 22:51:25 1.92 +++ mandoc/roff.7 2018/10/04 15:16:23 1.106 @@ -1,7 +1,7 @@ -.\" $Id: roff.7,v 1.92 2017/06/14 22:51:25 schwarze Exp $ +.\" $Id: roff.7,v 1.106 2018/10/04 15:16:23 schwarze Exp $ .\" .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons -.\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze +.\" Copyright (c) 2010-2018 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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: June 14 2017 $ +.Dd $Mdocdate: October 4 2018 $ .Dt ROFF 7 .Os .Sh NAME @@ -86,13 +86,9 @@ character, and, in certain circumstances, the tab char The backslash character .Sq \e indicates the start of an escape sequence, used for example for -.Sx Comments , -.Sx Special Characters , -.Sx Predefined Strings , +.Sx Comments and -user-defined strings defined using the -.Sx ds -request. +.Sx Special Characters . For a listing of escape sequences, consult the .Sx ESCAPE SEQUENCE REFERENCE below. @@ -169,34 +165,6 @@ Text decoration is recommended for .Xr mdoc 7 , which encourages semantic annotation. -.Ss Predefined Strings -Predefined strings, like -.Sx Special Characters , -mark special output glyphs. -Predefined strings are escaped with the slash-asterisk, -.Sq \e* : -single-character -.Sq \e*X , -two-character -.Sq \e*(XX , -and N-character -.Sq \e*[N] . -.Pp -Examples: -.Bl -tag -width Ds -offset indent -compact -.It Li \e*(Am -Two-letter ampersand predefined string. -.It Li \e*q -One-letter double-quote predefined string. -.El -.Pp -Predefined strings are not recommended for use, -as they differ across implementations. -Those supported by -.Xr mandoc 1 -are listed in -.Xr mandoc_char 7 . -Manuals using these predefined strings are almost certainly not portable. .Ss Whitespace Whitespace consists of the space character. In text lines, whitespace is preserved within a line. @@ -206,7 +174,7 @@ Unescaped trailing spaces are stripped from text line literal context. In general, trailing whitespace on any input line is discouraged for reasons of portability. -In the rare case that a blank character is needed at the end of an +In the rare case that a space character is needed at the end of an input line, it may be forced by .Sq \e\ \e& . .Pp @@ -341,7 +309,7 @@ Macros are provided by the and .Xr man 7 languages and can be defined by the -.Sx \&de +.Ic \&de request. When called, they follow the same syntax as requests, except that macro arguments may optionally be quoted by enclosing them @@ -447,7 +415,7 @@ compatibility mode at all, it handles this request as .It Ic \&as Ar stringname Op Ar string Append to a user-defined string. The syntax of this request is the same as that of -.Sx \&ds . +.Ic \&ds . If a user-defined string with the specified name does not yet exist, it is set to the empty string before appending. .It Ic \&as1 Ar stringname Op Ar string @@ -539,9 +507,16 @@ This is a groff extension and currently ignored. .It Ic \&ch Ar macroname Op Ar dist Change a trap location. Currently ignored. -.It Ic \&char Ar glyphname Op Ar string -Define a new glyph. -Currently unsupported. +.It Ic \&char Ar glyph Op Ar string +Define or redefine the ASCII character or character escape sequence +.Ar glyph +to be rendered as +.Ar string , +which can be empty. +Only partially supported in +.Xr mandoc 1 ; +may interact incorrectly with +.Ic \&tr . .It Ic \&chop Ar stringname Remove the last character from a macro, string, or diversion. Currently unsupported. @@ -665,7 +640,9 @@ produces .Pp in the input stream, and thus in the output: \fI\^XtFree\^\fP. Each occurrence of \e\e$* is replaced with all the arguments, -joined together with single blank characters. +joined together with single space characters. +The variant \e\e$@ is similar, except that each argument is +individually quoted. .Pp Since macros and user-defined strings share a common string table, defining a macro @@ -922,15 +899,15 @@ The following .Ar font arguments are supported: .Bl -tag -width 4n -offset indent -.It Cm B , BI , 3 , 4 +.It Cm B , BI , CB , 3 , 4 switches to .Sy bold font -.It Cm I , 2 +.It Cm I , CI , 2 switches to .Em underlined font -.It Cm R , CW , 1 +.It Cm R , CR , CW , 1 switches to normal font .It Cm P No "or no argument" switches back to the previous font @@ -1037,13 +1014,13 @@ is or .Sq o .Pq odd page , -it evaluates to true. +it evaluates to true, and the +.Ar body +starts with the next character. .It If the first character of .Ar condition is -.Sq c -.Pq character available , .Sq e .Pq even page , .Sq t @@ -1051,11 +1028,24 @@ is or .Sq v .Pq vroff mode , -it evaluates to false. +it evaluates to false, and the +.Ar body +starts with the next character. .It If the first character of .Ar condition is +.Sq c +.Pq character available , +it evaluates to true if the following character is an ASCII character +or a valid character escape sequence, or to false otherwise. +The +.Ar body +starts with the character following that next character. +.It +If the first character of +.Ar condition +is .Sq d , it evaluates to true if the rest of .Ar condition @@ -1219,7 +1209,7 @@ While evaluating the the unit suffixes described below .Sx Scaling Widths are ignored. -.It Ic \&it Ar expression macro +.It Ic \&itc Ar expression macro Set an input line trap, not counting lines ending with \ec. Currently unsupported. .It Ic \&IX Ar class keystring @@ -1346,9 +1336,12 @@ Currently unsupported. Temporarily turn off line numbering. Currently unsupported. .It Ic \&nop Ar body -Execute the rest of the input line as a request or macro line. -Currently unsupported. -.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression +Execute the rest of the input line as a request, macro, or text line, +skipping the +.Ic \&nop +request and any space characters immediately following it. +This is mostly used to indent text lines inside macro definitions. +.It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression Op Ar stepsize Define or change a register. A register is an arbitrary string value that defines some sort of state, which influences parsing and/or formatting. @@ -1360,6 +1353,14 @@ below. If it is prefixed by a sign, the register will be incremented or decremented instead of assigned to. .Pp +The +.Ar stepsize +is used by the +.Ic \en+ +auto-increment feature. +It remains unchanged when omitted while changing an existing register, +and it defaults to 0 when defining a new register. +.Pp The following .Ar register is handled specially: @@ -1471,15 +1472,15 @@ This is a groff extension and currently ignored. .It Ic \&rchar Ar glyph ... Remove glyph definitions. Currently unsupported. -.It Ic \&rd Op Ar prompt Op Ar agument ... +.It Ic \&rd Op Ar prompt Op Ar argument ... Read from standard input. Currently ignored. .It Ic \&recursionlimit Ar maxrec maxtail Set the maximum stack depth for recursive macros. This is a Heirloom extension and currently ignored. .It Ic \&return Op Ar twice -Exit a macro and return to the caller. -Currently unsupported. +Exit the presently executed macro and return to the caller. +The argument is currently ignored. .It Ic \&rfschar Ar font glyph ... Remove font-specific fallback glyph definitions. Currently unsupported. @@ -1528,8 +1529,11 @@ This is a Heirloom extension and currently ignored. Change the soft hyphen character. Currently ignored. .It Ic \&shift Op Ar number -Shift macro arguments. -Currently unsupported. +Shift macro arguments +.Ar number +times, by default once: \e\e$i becomes what \e\e$i+number was. +Also decrement \en(.$ by +.Ar number . .It Ic \&sizes Ar size ... Define permissible point sizes. This is a groff extension and currently ignored. @@ -1594,7 +1598,7 @@ Ignored because insecure. Re-start a table layout, retaining the options of the prior table invocation. See -.Sx \&TS . +.Ic \&TS . .It Ic \&ta Op Ar width ... Op Cm T Ar width ... Set tab stops. Each @@ -1615,7 +1619,7 @@ Currently unsupported. .It Ic \&TE End a table context. See -.Sx \&TS . +.Ic \&TS . .It Ic \&ti Oo Cm + Ns | Ns Cm - Oc Ns Ar width Break the output line and indent the next output line by .Ar width . @@ -1718,8 +1722,12 @@ This is a Heirloom extension and currently ignored. Set a page location trap. Currently unsupported. .It Ic \&while Ar condition body -Repeated execution while a condition is true. -Currently unsupported. +Repeated execution while a +.Ar condition +is true, with syntax similar to +.Ic \&if . +Currently implemented with two restrictions: cannot nest, +and each loop must start and end in the same scope. .It Ic \&write Oo \(dq Oc Ns Ar string Write to an open file. Ignored because insecure. @@ -1735,10 +1743,10 @@ This is a Heirloom extension and currently ignored. .El .Ss Numerical expressions The -.Sx \&nr , -.Sx \&if , +.Ic \&nr , +.Ic \&if , and -.Sx \&ie +.Ic \&ie requests accept integer numerical expressions as arguments. These are always evaluated using the C .Vt int @@ -1826,82 +1834,111 @@ described in the .Sx LANGUAGE SYNTAX section above. .Pp -A backslash followed by any character not listed here +In +.Xr mandoc 1 , +a backslash followed by any character not listed here simply prints that character itself. -.Ss \e +.Bl -tag -width Ds +.It Ic \e A backslash at the end of an input line can be used to continue the logical input line on the next physical input line, joining the text on both lines together as if it were on a single input line. -.Ss \e +.It Ic \e The escape sequence backslash-space .Pq Sq \e\ \& is an unpaddable space-sized non-breaking space character; see .Sx Whitespace . -.Ss \e\(dq +.It Ic \e\(dq The rest of the input line is treated as .Sx Comments . -.Ss \e% +.It Ic \e# +Line continuation with comment. +Discard the rest of the physical input line and continue the logical +input line on the next physical input line, joining the text on +both lines together as if it were on a single input line. +This is a groff extension. +.It Ic \e$ Ns Ar arg +Macro argument expansion, see +.Ic \&de . +.It Ic \e% Hyphenation allowed at this point of the word; ignored by .Xr mandoc 1 . -.Ss \e& +.It Ic \e& Non-printing zero-width character; see .Sx Whitespace . -.Ss \e\(aq +.It Ic \e\(aq Acute accent special character; use -.Sq \e(aa +.Ic \e(aa instead. -.Ss \e( Ns Ar cc +.It Ic \e( Ns Ar cc .Sx Special Characters with two-letter names, see .Xr mandoc_char 7 . -.Ss \e*[ Ns Ar name ] +.It Ic \e*[ Ns Ar name Ns Ic \&] Interpolate the string with the -.Ar name ; -see -.Sx Predefined Strings -and -.Sx ds . +.Ar name . For short names, there are variants -.No \e* Ns Ar c +.Ic \e* Ns Ar c and -.No \e*( Ns Ar cc . -.Ss \e, +.Ic \e*( Ns Ar cc . +.Pp +One string is predefined on the +.Nm +language level: +.Ic \e*(.T +expands to the name of the output device, +for example ascii, utf8, ps, pdf, html, or markdown. +.Pp +Macro sets traditionally predefine additional strings which are not +portable and differ across implementations. +Those supported by +.Xr mandoc 1 +are listed in +.Xr mandoc_char 7 . +.Pp +Strings can be defined, changed, and deleted with the +.Ic \&ds , +.Ic \&as , +and +.Ic \&rm +requests. +.It Ic \e, Left italic correction (groff extension); ignored by .Xr mandoc 1 . -.Ss \e- +.It Ic \e- Special character .Dq mathematical minus sign . -.Ss \e/ +.It Ic \e/ Right italic correction (groff extension); ignored by .Xr mandoc 1 . -.Ss \e[ Ns Ar name ] +.It Ic \e[ Ns Ar name Ns Ic \&] .Sx Special Characters with names of arbitrary length, see .Xr mandoc_char 7 . -.Ss \e^ +.It Ic \e^ One-twelfth em half-narrow space character, effectively zero-width in .Xr mandoc 1 . -.Ss \e` +.It Ic \e` Grave accent special character; use -.Sq \e(ga +.Ic \e(ga instead. -.Ss \e{ +.It Ic \e{ Begin conditional input; see -.Sx if . -.Ss \e\(ba +.Ic \&if . +.It Ic \e\(ba One-sixth em narrow space character, effectively zero-width in .Xr mandoc 1 . -.Ss \e} +.It Ic \e} End conditional input; see -.Sx if . -.Ss \e~ +.Ic \&if . +.It Ic \e~ Paddable non-breaking space character. -.Ss \e0 +.It Ic \e0 Digit width space character. -.Ss \eA\(aq Ns Ar string Ns \(aq +.It Ic \eA\(aq Ns Ar string Ns Ic \(aq Anchor definition; ignored by .Xr mandoc 1 . -.Ss \eB\(aq Ns Ar string Ns \(aq +.It Ic \eB\(aq Ns Ar string Ns Ic \(aq Interpolate .Sq 1 if @@ -1911,136 +1948,145 @@ conforms to the syntax of explained above and .Sq 0 otherwise. -.Ss \eb\(aq Ns Ar string Ns \(aq +.It Ic \eb\(aq Ns Ar string Ns Ic \(aq Bracket building function; ignored by .Xr mandoc 1 . -.Ss \eC\(aq Ns Ar name Ns \(aq +.It Ic \eC\(aq Ns Ar name Ns Ic \(aq .Sx Special Characters with names of arbitrary length. -.Ss \ec +.It Ic \ec When encountered at the end of an input text line, the next input text line is considered to continue that line, even if there are request or macro lines in between. No whitespace is inserted. -.Ss \eD\(aq Ns Ar string Ns \(aq +.It Ic \eD\(aq Ns Ar string Ns Ic \(aq Draw graphics function; ignored by .Xr mandoc 1 . -.Ss \ed +.It Ic \ed Move down by half a line; ignored by .Xr mandoc 1 . -.Ss \ee +.It Ic \ee Backslash special character. -.Ss \eF[ Ns Ar name ] +.It Ic \eF[ Ns Ar name Ns Ic \&] Switch font family (groff extension); ignored by .Xr mandoc 1 . For short names, there are variants -.No \eF Ns Ar c +.Ic \eF Ns Ar c and -.No \eF( Ns Ar cc . -.Ss \ef[ Ns Ar name ] +.Ic \eF( Ns Ar cc . +.It Ic \ef[ Ns Ar name Ns Ic \&] Switch to the font .Ar name , see .Sx Text Decoration . For short names, there are variants -.No \ef Ns Ar c +.Ic \ef Ns Ar c and -.No \ef( Ns Ar cc . -.Ss \eg[ Ns Ar name ] +.Ic \ef( Ns Ar cc . +.It Ic \eg[ Ns Ar name Ns Ic \&] Interpolate the format of a number register; ignored by .Xr mandoc 1 . For short names, there are variants -.No \eg Ns Ar c +.Ic \eg Ns Ar c and -.No \eg( Ns Ar cc . -.Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq +.Ic \eg( Ns Ar cc . +.It Ic \eH\(aq Ns Oo +|- Oc Ns Ar number Ns Ic \(aq Set the height of the current font; ignored by .Xr mandoc 1 . -.Ss \eh\(aq Ns Ar width Ns \(aq -Horizontal motion relative to the current position. +.It Ic \eh\(aq Ns Oo Cm \&| Oc Ns Ar width Ns Ic \(aq +Horizontal motion. +If the vertical bar is given, the motion is relative to the current +indentation. +Otherwise, it is relative to the current position. The default scaling unit is .Cm m . -.Ss \ek[ Ns Ar name ] +.It Ic \ek[ Ns Ar name Ns Ic \&] Mark horizontal input place in register; ignored by .Xr mandoc 1 . For short names, there are variants -.No \ek Ns Ar c +.Ic \ek Ns Ar c and -.No \ek( Ns Ar cc . -.Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq +.Ic \ek( Ns Ar cc . +.It Ic \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns Ic \(aq Vertical line drawing function; ignored by .Xr mandoc 1 . -.Ss \el\(aq Ns Ar width Ns Oo Ar c Oc Ns \(aq +.It Ic \el\(aq Ns Ar width Ns Oo Ar c Oc Ns Ic \(aq Draw a horizontal line of .Ar width using the glyph .Ar c . -.Ss \eM[ Ns Ar name ] +.It Ic \eM[ Ns Ar name Ns Ic \&] Set fill (background) color (groff extension); ignored by .Xr mandoc 1 . For short names, there are variants -.No \eM Ns Ar c +.Ic \eM Ns Ar c and -.No \eM( Ns Ar cc . -.Ss \em[ Ns Ar name ] +.Ic \eM( Ns Ar cc . +.It Ic \em[ Ns Ar name Ns Ic \&] Set glyph drawing color (groff extension); ignored by .Xr mandoc 1 . For short names, there are variants -.No \em Ns Ar c +.Ic \em Ns Ar c and -.No \em( Ns Ar cc . -.Ss \eN\(aq Ns Ar number Ns \(aq +.Ic \em( Ns Ar cc . +.It Ic \eN\(aq Ns Ar number Ns Ic \(aq Character .Ar number on the current font. -.Ss \en[ Ns Ar name ] +.It Ic \en Ns Oo +|- Oc Ns Ic \&[ Ns Ar name Ns Ic \&] Interpolate the number register .Ar name . For short names, there are variants -.No \en Ns Ar c +.Ic \en Ns Ar c and -.No \en( Ns Ar cc . -.Ss \eo\(aq Ns Ar string Ns \(aq +.Ic \en( Ns Ar cc . +If the optional sign is specified, +the register is first incremented or decremented by the +.Ar stepsize +that was specified in the relevant +.Ic \&nr +request, and the changed value is interpolated. +.It Ic \eo\(aq Ns Ar string Ns Ic \(aq Overstrike, writing all the characters contained in the .Ar string to the same output position. In terminal and HTML output modes, only the last one of the characters is visible. -.Ss \ep +.It Ic \ep Break the output line at the end of the current word. -.Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq +.It Ic \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns Ic \(aq Set number register; ignored by .Xr mandoc 1 . -.Ss \eS\(aq Ns Ar number Ns \(aq +.It Ic \eS\(aq Ns Ar number Ns Ic \(aq Slant output; ignored by .Xr mandoc 1 . -.Ss \es\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq +.It Ic \es\(aq Ns Oo +|- Oc Ns Ar number Ns Ic \(aq Change point size; ignored by .Xr mandoc 1 . Alternative forms -.No \es Ns Oo +|- Oc Ns Ar n , -.No \es Ns Oo +|- Oc Ns \(aq Ns Ar number Ns \(aq , -.No \es Ns [ Oo +|- Oc Ns Ar number ] , +.Ic \es Ns Oo +|- Oc Ns Ar n , +.Ic \es Ns Oo +|- Oc Ns Ic \(aq Ns Ar number Ns Ic \(aq , +.Ic \es[ Ns Oo +|- Oc Ns Ar number Ns Ic \&] , and -.No \es Ns Oo +|- Oc Ns [ Ar number Ns ] +.Ic \es Ns Oo +|- Oc Ns Ic \&[ Ns Ar number Ns Ic \&] are also parsed and ignored. -.Ss \et +.It Ic \et Horizontal tab; ignored by .Xr mandoc 1 . -.Ss \eu +.It Ic \eu Move up by half a line; ignored by .Xr mandoc 1 . -.Ss \eV[ Ns Ar name ] +.It Ic \eV[ Ns Ar name Ns Ic \&] Interpolate an environment variable; ignored by .Xr mandoc 1 . For short names, there are variants -.No \eV Ns Ar c +.Ic \eV Ns Ar c and -.No \eV( Ns Ar cc . -.Ss \ev\(aq Ns Ar number Ns \(aq +.Ic \eV( Ns Ar cc . +.It Ic \ev\(aq Ns Ar number Ns Ic \(aq Vertical motion; ignored by .Xr mandoc 1 . -.Ss \ew\(aq Ns Ar string Ns \(aq +.It Ic \ew\(aq Ns Ar string Ns Ic \(aq Interpolate the width of the .Ar string . The @@ -2049,28 +2095,29 @@ implementation assumes that after expansion of user-de .Ar string only contains normal characters, no escape sequences, and that each character has a width of 24 basic units. -.Ss \eX\(aq Ns Ar string Ns \(aq +.It Ic \eX\(aq Ns Ar string Ns Ic \(aq Output .Ar string as device control function; ignored in nroff mode and by .Xr mandoc 1 . -.Ss \ex\(aq Ns Ar number Ns \(aq +.It Ic \ex\(aq Ns Ar number Ns Ic \(aq Extra line space function; ignored by .Xr mandoc 1 . -.Ss \eY[ Ns Ar name ] +.It Ic \eY[ Ns Ar name Ns Ic \&] Output a string as a device control function; ignored in nroff mode and by .Xr mandoc 1 . For short names, there are variants -.No \eY Ns Ar c +.Ic \eY Ns Ar c and -.No \eY( Ns Ar cc . -.Ss \eZ\(aq Ns Ar string Ns \(aq +.Ic \eY( Ns Ar cc . +.It Ic \eZ\(aq Ns Ar string Ns Ic \(aq Print .Ar string with zero width and height; ignored by .Xr mandoc 1 . -.Ss \ez +.It Ic \ez Output the next character without advancing the cursor position. +.El .Sh COMPATIBILITY The .Xr mandoc 1 @@ -2084,7 +2131,7 @@ Unimplemented features include: For security reasons, .Xr mandoc 1 never reads or writes external files except via -.Sx \&so +.Ic \&so requests with safe relative paths. .It There is no automatic hyphenation, no adjustment to the right margin, @@ -2119,10 +2166,6 @@ macro control character does not suppress output line .It Diversions are not implemented, and support for traps is very incomplete. -.It -While recursion is supported, -.Sx \&while -loops are not. .El .Pp The special semantics of the