=================================================================== RCS file: /cvs/mandoc/roff.7,v retrieving revision 1.106 retrieving revision 1.108 diff -u -p -r1.106 -r1.108 --- mandoc/roff.7 2018/10/04 15:16:23 1.106 +++ mandoc/roff.7 2018/12/15 19:30:26 1.108 @@ -1,4 +1,4 @@ -.\" $Id: roff.7,v 1.106 2018/10/04 15:16:23 schwarze Exp $ +.\" $Id: roff.7,v 1.108 2018/12/15 19:30:26 schwarze Exp $ .\" .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons .\" Copyright (c) 2010-2018 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 4 2018 $ +.Dd $Mdocdate: December 15 2018 $ .Dt ROFF 7 .Os .Sh NAME @@ -39,17 +39,14 @@ or code. To properly format such manuals, the .Xr mandoc 1 -utility supports a tiny subset of +utility supports a subset of .Nm requests and escapes. -Only these requests and escapes supported by +Even though this manual page lists all +.Nm +requests, it only has partial information about requests not supported by .Xr mandoc 1 -are documented in the present manual, -together with the basic language syntax shared by -.Nm , -.Xr mdoc 7 , -and -.Xr man 7 . +and about language features that do not matter for manual pages. For complete .Nm manuals, consult the @@ -193,7 +190,6 @@ Many requests and macros support scaled widths for the The syntax for a scaled width is .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] , where a decimal must be preceded or followed by at least one digit. -Negative numbers, while accepted, are truncated to zero. .Pp The following scaling units are accepted: .Pp @@ -1848,6 +1844,11 @@ The escape sequence backslash-space .Pq Sq \e\ \& is an unpaddable space-sized non-breaking space character; see .Sx Whitespace . +.It Ic \e! +Embed text up to and including the end of the input line into the +current diversion or into intermediate output without interpreting +requests, macros, and escapes. +Currently unsupported. .It Ic \e\(dq The rest of the input line is treated as .Sx Comments . @@ -1874,6 +1875,10 @@ instead. .Sx Special Characters with two-letter names, see .Xr mandoc_char 7 . +.It Ic \e) +Zero-width space transparent to end-of-sentence detection; +ignored by +.Xr mandoc 1 . .It Ic \e*[ Ns Ar name Ns Ic \&] Interpolate the string with the .Ar name . @@ -1911,6 +1916,15 @@ Special character .It Ic \e/ Right italic correction (groff extension); ignored by .Xr mandoc 1 . +.It Ic \e: +Breaking the line is allowed at this point of the word +without inserting a hyphen. +.It Ic \e? +Embed the text up to the next +.Ic \e? +into the current diversion without interpreting requests, macros, +and escapes. +This is a groff extension and currently unsupported. .It Ic \e[ Ns Ar name Ns Ic \&] .Sx Special Characters with names of arbitrary length, see @@ -1918,6 +1932,10 @@ with names of arbitrary length, see .It Ic \e^ One-twelfth em half-narrow space character, effectively zero-width in .Xr mandoc 1 . +.It Ic \e_ +Underline special character; use +.Ic \e(ul +instead. .It Ic \e` Grave accent special character; use .Ic \e(ga @@ -1938,6 +1956,9 @@ Digit width space character. .It Ic \eA\(aq Ns Ar string Ns Ic \(aq Anchor definition; ignored by .Xr mandoc 1 . +.It Ic \ea +Leader character; ignored by +.Xr mandoc 1 . .It Ic \eB\(aq Ns Ar string Ns Ic \(aq Interpolate .Sq 1 @@ -1965,6 +1986,13 @@ Draw graphics function; ignored by .It Ic \ed Move down by half a line; ignored by .Xr mandoc 1 . +.It Ic \eE +Escape character intended to not be interpreted in copy mode. +In +.Xr mandoc 1 , +it does the same as +.Ic \e +itself for now. .It Ic \ee Backslash special character. .It Ic \eF[ Ns Ar name Ns Ic \&] @@ -2046,6 +2074,14 @@ the register is first incremented or decremented by th that was specified in the relevant .Ic \&nr request, and the changed value is interpolated. +.It Ic \eO Ns Ar digit , Ic \eO[5 Ns arguments Ns Ic \&] +Suppress output. +This is a groff extension and currently unsupported. +With an argument of +.Ic 1 , 2 , 3 , +or +.Ic 4 , +it is ignored. .It Ic \eo\(aq Ns Ar string Ns Ic \(aq Overstrike, writing all the characters contained in the .Ar string @@ -2057,6 +2093,9 @@ Break the output line at the end of the current word. .It Ic \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns Ic \(aq Set number register; ignored by .Xr mandoc 1 . +.It Ic \er +Move up by one line; ignored by +.Xr mandoc 1 . .It Ic \eS\(aq Ns Ar number Ns Ic \(aq Slant output; ignored by .Xr mandoc 1 . @@ -2123,8 +2162,8 @@ The .Xr mandoc 1 implementation of the .Nm -language is intentionally incomplete. -Unimplemented features include: +language is incomplete. +Major unimplemented features include: .Pp .Bl -dash -compact .It @@ -2135,10 +2174,9 @@ never reads or writes external files except via requests with safe relative paths. .It There is no automatic hyphenation, no adjustment to the right margin, -and no centering; the output is always set flush-left. +and very limited support for centering; the output is always set flush-left. .It -Support for setting tabulator positions -and tabulator and leader characters is missing, +Support for setting tabulator and leader characters is missing, and support for manually changing indentation is limited. .It The @@ -2149,14 +2187,14 @@ output media. .It Width measurements are implemented in a crude way and often yield wrong results. -Explicit movement requests and escapes are ignored. +Support for explicit movement requests and escapes is limited. .It There is no concept of output pages, no support for floats, graphics drawing, and picture inclusion; terminal output is always continuous. .It -Requests regarding color, font families, and glyph manipulation -are ignored. +Requests regarding color, font families, font sizes, +and glyph manipulation are ignored. Font support is very limited. Kerning is not implemented, and no ligatures are produced. .It @@ -2164,8 +2202,12 @@ The .Qq \(aq macro control character does not suppress output line breaks. .It -Diversions are not implemented, +Diversions and environments are not implemented, and support for traps is very incomplete. +.It +Use of macros is not supported inside +.Xr tbl 7 +code. .El .Pp The special semantics of the