diff options
| author |   Ingo Schwarze <schwarze@openbsd.org> | 2018-12-20 18:24:12 +0000 |
|---|---|---|
| committer | Ingo Schwarze <schwarze@openbsd.org> | 2018-12-20 18:24:12 +0000 |
| commit | a72e5e50e1299fb4a5a88975ce1d68a543f8ac2f (patch) | |
| tree | 36ee7304b04baa57602bfae2bdc3f8b93c8236ec | |
| parent | 923bf6b6b20172d100e1515ad7a4f93d3a4b233e (diff) | |
| download | mandoc-a72e5e50e1299fb4a5a88975ce1d68a543f8ac2f.tar.gz mandoc-a72e5e50e1299fb4a5a88975ce1d68a543f8ac2f.tar.zst mandoc-a72e5e50e1299fb4a5a88975ce1d68a543f8ac2f.zip | |
Explain what the fields in mandoc messages mean,
rather than merely specifying the message syntax.
Gap in documentation found while looking at a bug
report from Raf Czlonka <rczlonka at gmail dot com>.
| -rw-r--r-- | mandoc.1 | 26 |
1 files changed, 21 insertions, 5 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.232 2018/12/15 19:30:26 schwarze Exp $ +.\" $Id: mandoc.1,v 1.233 2018/12/20 18:24:12 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2012, 2014-2018 Ingo Schwarze <schwarze@openbsd.org> @@ -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: December 15 2018 $ +.Dd $Mdocdate: December 20 2018 $ .Dt MANDOC 1 .Os .Sh NAME @@ -714,13 +714,29 @@ Messages displayed by follow this format: .Bd -ragged -offset indent .Nm : -.Ar file : Ns Ar line : Ns Ar column : level : message : macro args +.Ar file : Ns Ar line : Ns Ar column : level : message : macro arguments .Pq Ar os .Ed .Pp -Line and column numbers start at 1. +The first three fields identify the +.Ar file +name, +.Ar line +number, and +.Ar column +number of the input file where the message was triggered. +The line and column numbers start at 1. Both are omitted for messages referring to an input file as a whole. -Macro names and arguments are omitted where meaningless. +All +.Ar level +and +.Ar message +strings are explained below. +The name of the +.Ar macro +triggering the message and its +.Ar arguments +are omitted where meaningless. The .Ar os operating system specifier is omitted for messages that are relevant |