If messages are shown and output is printed without a pager, display

[mandoc.git] / mandoc.1

diff --git a/mandoc.1 b/mandoc.1
index bea806b4782de9db2e8daacaf95f9d99fce5f882..298d5dc706102eef370d4b79a9c00592b3587a67 100644 (file)
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,7 +1,7 @@
-.\"    $Id: mandoc.1,v 1.232 2018/12/15 19:30:26 schwarze Exp $
+.\"    $Id: mandoc.1,v 1.240 2019/07/10 19:39:01 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, 2014-2018 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2012, 2014-2019 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: December 15 2018 $
+.Dd $Mdocdate: July 10 2019 $

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


@@ -222,7 +222,8 @@ reads from standard input.
 .Pp
 The options
 .Fl fhklw
 .Pp
 The options
 .Fl fhklw

-are also supported and are documented in man(1).
+are also supported and are documented in
+.Xr man 1 .

 In
 .Fl f
 and
 In
 .Fl f
 and


@@ -256,10 +257,28 @@ where
 is the back-space character number 8.
 Emboldened characters are rendered as
 .Sq c Ns \e[bs] Ns c .
 is the back-space character number 8.
 Emboldened characters are rendered as
 .Sq c Ns \e[bs] Ns c .

+This markup is typically converted to appropriate terminal sequences by
+the pager or
+.Xr ul 1 .
+To remove the markup, pipe the output to
+.Xr col 1
+.Fl b
+instead.

 .Pp
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.
 .Pp
 The special characters documented in
 .Xr mandoc_char 7
 are rendered best-effort in an ASCII equivalent.

+In particular, opening and closing
+.Sq single quotes
+are represented as characters number 0x60 and 0x27, respectively,
+which agrees with all ASCII standards from 1965 to the latest
+revision (2012) and which matches the traditional way in which
+.Xr roff 7
+formatters represent single quotes in ASCII output.
+This correct ASCII rendering may look strange with modern
+Unicode-compatible fonts because contrary to ASCII, Unicode uses
+the code point U+0060 for the grave accent only, never for an opening
+quote.

 .Pp
 The following
 .Fl O
 .Pp
 The following
 .Fl O


@@ -300,8 +319,16 @@ If no
 is specified, reuse the first command line argument that is not a
 .Ar section
 number.
 is specified, reuse the first command line argument that is not a
 .Ar section
 number.

-This is useful when it is the name of a manual page,
-in particular the name of a library function.
+If that argument is in
+.Xr apropos 1
+.Ar key Ns = Ns Ar val
+format, only the
+.Ar val
+is used rather than the argument as a whole.
+This is useful for commands like
+.Ql man -akO tag Ic=ulimit
+to search for a keyword and jump right to its definition
+in the matching manual pages.

 .It Cm width Ns = Ns Ar width
 The output width is set to
 .Ar width
 .It Cm width Ns = Ns Ar width
 The output width is set to
 .Ar width


@@ -320,9 +347,9 @@ Equations rendered from
 .Xr eqn 7
 blocks use MathML.
 .Pp
 .Xr eqn 7
 blocks use MathML.
 .Pp

-The
-.Pa mandoc.css
-file documents style-sheet classes available for customising output.
+The file
+.Pa /usr/share/misc/mandoc.css
+documents style-sheet classes available for customising output.

 If a style-sheet is not specified with
 .Fl O Cm style ,
 .Fl T Cm html
 If a style-sheet is not specified with
 .Fl O Cm style ,
 .Fl T Cm html


@@ -671,7 +698,7 @@ No input files have been read.
 .It 6
 An operating system error occurred, for example exhaustion
 of memory, file descriptors, or process table entries.
 .It 6
 An operating system error occurred, for example exhaustion
 of memory, file descriptors, or process table entries.

-Such errors cause
+Such errors may cause

 .Nm
 to exit at once, possibly in the middle of parsing or formatting a file.
 .El
 .Nm
 to exit at once, possibly in the middle of parsing or formatting a file.
 .El


@@ -686,10 +713,10 @@ To page manuals to the terminal:
 .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
 .Pp
 To produce HTML manuals with
 .Dl $ mandoc -l mandoc.1 man.1 apropos.1 makewhatis.8
 .Pp
 To produce HTML manuals with

-.Pa mandoc.css
+.Pa /usr/share/misc/mandoc.css

 as the style-sheet:
 .Pp
 as the style-sheet:
 .Pp

-.Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html
+.Dl $ mandoc \-T html -O style=/usr/share/misc/mandoc.css mdoc.7 > mdoc.7.html

 .Pp
 To check over a large set of manuals:
 .Pp
 .Pp
 To check over a large set of manuals:
 .Pp


@@ -697,7 +724,7 @@ To check over a large set of manuals:
 .Pp
 To produce a series of PostScript manuals for A4 paper:
 .Pp
 .Pp
 To produce a series of PostScript manuals for A4 paper:
 .Pp

-.Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 \*(Gt manuals.ps
+.Dl $ mandoc \-T ps \-O paper=a4 mdoc.7 man.7 > manuals.ps

 .Pp
 Convert a modern
 .Xr mdoc 7
 .Pp
 Convert a modern
 .Xr mdoc 7


@@ -707,20 +734,36 @@ format, for use on systems lacking an
 .Xr mdoc 7
 parser:
 .Pp
 .Xr mdoc 7
 parser:
 .Pp

-.Dl $ mandoc \-T man foo.mdoc \*(Gt foo.man
+.Dl $ mandoc \-T man foo.mdoc > foo.man

 .Sh DIAGNOSTICS
 Messages displayed by
 .Nm
 follow this format:
 .Bd -ragged -offset indent
 .Nm :
 .Sh DIAGNOSTICS
 Messages displayed by
 .Nm
 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
 .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.
 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
 The
 .Ar os
 operating system specifier is omitted for messages that are relevant


@@ -735,6 +778,13 @@ fields.
 .Pp
 Message levels have the following meanings:
 .Bl -tag -width "warning"
 .Pp
 Message levels have the following meanings:
 .Bl -tag -width "warning"

+.It Cm syserr
+An operating system error occurred.
+There isn't necessarily anything wrong with the input files.
+Output may all the same be missing or incomplete.
+.It Cm badarg
+Invalid command line arguments were specified.
+No input files have been read and no output is produced.

 .It Cm unsupp
 An input file uses unsupported low-level
 .Xr roff 7
 .It Cm unsupp
 An input file uses unsupported low-level
 .Xr roff 7


@@ -783,8 +833,7 @@ Messages of the
 .Cm error ,
 and
 .Cm unsupp
 .Cm error ,
 and
 .Cm unsupp

-levels except those about non-existent or unreadable input files
-are hidden unless their level, or a lower level, is requested using a
+levels are hidden unless their level, or a lower level, is requested using a

 .Fl W
 option or
 .Fl T Cm lint
 .Fl W
 option or
 .Fl T Cm lint


@@ -1657,9 +1706,12 @@ The meaning of blank input lines is only well-defined in non-fill mode:
 In fill mode, line breaks of text input lines are not supposed to be
 significant.
 However, for compatibility with groff, blank lines in fill mode
 In fill mode, line breaks of text input lines are not supposed to be
 significant.
 However, for compatibility with groff, blank lines in fill mode

-are replaced with
+are formatted like

 .Ic \&sp
 requests.
 .Ic \&sp
 requests.

+To request a paragraph break, use
+.Ic \&Pp
+instead of a blank line.

 .It Sy "tab in filled text"
 .Pq mdoc , man
 The meaning of tab characters is only well-defined in non-fill mode:
 .It Sy "tab in filled text"
 .Pq mdoc , man
 The meaning of tab characters is only well-defined in non-fill mode:


@@ -2196,6 +2248,43 @@ macro or of an undefined macro.
 The macro is ignored, and its arguments are handled
 as if they were a text line.
 .El
 The macro is ignored, and its arguments are handled
 as if they were a text line.
 .El

+.Ss Bad command line arguments
+.Bl -ohang
+.It Sy "bad command line argument"
+The argument following one of the
+.Fl IKMmOTW
+command line options is invalid, or a
+.Ar file
+given as a command line argument cannot be opened.
+.It Sy "duplicate command line argument"
+The
+.Fl I
+command line option was specified twice.
+.It Sy "option has a superfluous value"
+An argument to the
+.Fl O
+option has a value but does not accept one.
+.It Sy "missing option value"
+An argument to the
+.Fl O
+option has no argument but requires one.
+.It Sy "bad option value"
+An argument to the
+.Fl O
+.Cm indent
+or
+.Cm width
+option has an invalid value.
+.It Sy "duplicate option value"
+The same
+.Fl O
+option is specified more than once.
+.It Sy "no such tag"
+The
+.Fl O Cm tag
+option was specified but the tag was not found in any of the displayed
+manual pages.
+.El

 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr man 1 ,
 .Sh SEE ALSO
 .Xr apropos 1 ,
 .Xr man 1 ,