Below DIAGNOSTICS, document the SYSERR message level;

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index 9a0271503996778b597167d083d6b2dc5588a5a1..745dd504ed61e08fac1d746076dd3faecdb3a79c 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,7 +1,7 @@
-.\"    $Id: mandoc.1,v 1.101 2012/05/27 17:48:57 schwarze Exp $
+.\"    $Id: mandoc.1,v 1.105 2014/06/23 22:03:30 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

-.\" Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" 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.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: May 27 2012 $
+.Dd $Mdocdate: June 23 2014 $

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


@@ -347,7 +347,7 @@ for font style specification and available command-line arguments.
 Translate input format into
 .Xr man 7
 output format.
 Translate input format into
 .Xr man 7
 output format.

-This is useful for distributing manual sources to legancy systems
+This is useful for distributing manual sources to legacy systems

 lacking
 .Xr mdoc 7
 formatters.
 lacking
 .Xr mdoc 7
 formatters.


@@ -498,9 +498,7 @@ parser:
 .Sh DIAGNOSTICS
 Standard error messages reporting parsing errors are prefixed by
 .Pp
 .Sh DIAGNOSTICS
 Standard error messages reporting parsing errors are prefixed by
 .Pp

-.Sm off
-.D1 Ar file : line : column : \ level :
-.Sm on
+.D1 Nm Ns : Ar file : Ns Ar line : Ns Ar column : level :

 .Pp
 where the fields have the following meanings:
 .Bl -tag -width "column"
 .Pp
 where the fields have the following meanings:
 .Bl -tag -width "column"


@@ -518,8 +516,17 @@ points to the first character of the word.
 The message level, printed in capital letters.
 .El
 .Pp
 The message level, printed in capital letters.
 .El
 .Pp

+The
+.Ar line
+and
+.Ar column
+fields are omitted when meaningless.
+.Pp

 Message levels have the following meanings:
 .Bl -tag -width "warning"
 Message levels have the following meanings:
 .Bl -tag -width "warning"

+.It Cm syserr
+Opening or reading an input file failed, so the parser cannot
+even be started and no output is produced from that input file.

 .It Cm fatal
 The parser is unable to parse a given input file at all.
 No formatted output is produced from that input file.
 .It Cm fatal
 The parser is unable to parse a given input file at all.
 No formatted output is produced from that input file.


@@ -555,9 +562,8 @@ output mode.
 The
 .Nm
 utility may also print messages related to invalid command line arguments
 The
 .Nm
 utility may also print messages related to invalid command line arguments

-or operating system errors, for example when memory is exhausted or
-input files cannot be read.
-Such messages do not carry the prefix described above.
+or operating system errors, for example when memory is exhausted.
+Such messages may not carry the prefix described above.

 .Sh COMPATIBILITY
 This section summarises
 .Nm
 .Sh COMPATIBILITY
 This section summarises
 .Nm


@@ -650,8 +656,7 @@ lists render similarly.
 The
 .Nm
 utility was written by
 The
 .Nm
 utility was written by

-.An Kristaps Dzonsons ,
-.Mt kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

 .Sh CAVEATS
 In
 .Fl T Ns Cm html
 .Sh CAVEATS
 In
 .Fl T Ns Cm html