spelling; patch from jsg@

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index d689fffa7e86ef129f35856a21a11809ba6fed6d..706b0bc8ecc50b6e07cc83a3e485a5bb6f7aa8a9 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.258 2022/04/28 16:21:09 schwarze Exp $
+.\" $Id: mandoc.1,v 1.262 2022/07/03 14:36:00 schwarze Exp $

 .\"
 .\" Copyright (c) 2012, 2014-2022 Ingo Schwarze <schwarze@openbsd.org>
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" Copyright (c) 2012, 2014-2022 Ingo Schwarze <schwarze@openbsd.org>
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>


@@ -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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: April 28 2022 $
+.Dd $Mdocdate: July 3 2022 $

 .Dt MANDOC 1
 .Os
 .Sh NAME
 .Dt MANDOC 1
 .Os
 .Sh NAME


@@ -342,7 +342,6 @@ and may exceed the output width.
 Output produced by
 .Fl T Cm html
 conforms to HTML5 using optional self-closing tags.
 Output produced by
 .Fl T Cm html
 conforms to HTML5 using optional self-closing tags.

-Default styles use only CSS1.

 Equations rendered from
 .Xr eqn 7
 blocks use MathML.
 Equations rendered from
 .Xr eqn 7
 blocks use MathML.


@@ -1797,23 +1796,10 @@ it is hard to predict which tab stop position the tab will advance to.
 .Pq mdoc
 A new sentence starts in the middle of a text line.
 Start it on a new input line to help formatters produce correct spacing.
 .Pq mdoc
 A new sentence starts in the middle of a text line.
 Start it on a new input line to help formatters produce correct spacing.

-.It Sy "invalid escape sequence"
+.It Sy "invalid escape sequence argument"

 .Pq roff
 .Pq roff

-An escape sequence has an invalid opening argument delimiter, lacks the
-closing argument delimiter, the argument is of an invalid form, or it is
-a character escape sequence with an invalid name.
-If the argument is incomplete,
-.Ic \e*
-and
-.Ic \en
-expand to an empty string,
-.Ic \eB
-to the digit
-.Sq 0 ,
-and
-.Ic \ew
-to the length of the incomplete argument.
-All other invalid escape sequences are ignored.
+The argument of an escape sequence is of an invalid form.
+Invalid escape sequences are ignored.

 .It Sy "undefined escape, printing literally"
 .Pq roff
 In an escape sequence, the first character
 .It Sy "undefined escape, printing literally"
 .Pq roff
 In an escape sequence, the first character


@@ -2285,6 +2271,60 @@ with invalid arguments
 .El
 The excess arguments are ignored.
 .El
 .El
 The excess arguments are ignored.
 .El

+.Ss "Errors related to escape sequences"
+.Bl -ohang
+.It Sy "incomplete escape sequence"
+.Pq roff
+The end of the input line is encountered
+while parsing the argument of an escape sequence.
+In this case,
+.Ic \e*
+and
+.Ic \en
+expand to an empty string,
+.Ic \eB
+to the digit
+.Sq 0 ,
+and
+.Ic \ew
+to the length of the incomplete argument.
+All other incomplete escape sequences are ignored.
+.It Sy "invalid special character"
+.Pq roff
+A special character escape sequence is invalid,
+for example a Unicode sequence pointing to a surrogate
+or beyond the Unicode range, a \e[char...] escape sequence
+representing a control character or pointing beyond the
+.Vt unsigned char
+range, or an invalid variable-length form
+of a single-byte character escape sequence, for example writing
+.Qq \e[e]
+or
+.Qq \e[~]
+instead of
+.Qq \ee
+or
+.Qq \e~ ,
+respectively.
+The escape sequence is ignored.
+.It Sy "unknown special character"
+.Pq roff
+The name given in a special character escape sequence is not known to
+.Nm .
+The escape sequence is ignored.
+.It Sy "invalid escape argument delimiter"
+.Pq roff
+An escape sequence that expects a numerical argument
+attempts to employ one of the characters
+.Qq " %&()*+-./0123456789:<=>"
+as an argument delimiter.
+The escape sequence is ignored including the invalid opening delimiter
+and the rest of the argument may appear as output text.
+While various characters can be used as argument delimiters,
+using the apostrophe-quote character
+.Pq Sq \(aq
+is recommended for readability and robustness.
+.El

 .Ss Unsupported features
 .Bl -ohang
 .It Sy "input too large"
 .Ss Unsupported features
 .Bl -ohang
 .It Sy "input too large"