Print this page
9718 update mandoc to 1.14.4
*** 1,9 ****
! .\" $Id: mandoc.1,v 1.217 2017/07/20 15:26:41 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
! .\" Copyright (c) 2012, 2014-2017 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
.\" copyright notice and this permission notice appear in all copies.
.\"
--- 1,9 ----
! .\" $Id: mandoc.1,v 1.226 2018/07/28 18:34:15 schwarze Exp $
.\"
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
! .\" Copyright (c) 2012, 2014-2018 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
.\" copyright notice and this permission notice appear in all copies.
.\"
*** 13,23 ****
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
! .Dd $Mdocdate: July 20 2017 $
.Dt MANDOC 1
.Os
.Sh NAME
.Nm mandoc
.Nd format manual pages
--- 13,23 ----
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
! .Dd $Mdocdate: July 28 2018 $
.Dt MANDOC 1
.Os
.Sh NAME
.Nm mandoc
.Nd format manual pages
*** 32,44 ****
.Op Fl W Ar level
.Op Ar
.Sh DESCRIPTION
The
.Nm
! utility formats
! .Ux
! manual pages for display.
.Pp
By default,
.Nm
reads
.Xr mdoc 5
--- 32,42 ----
.Op Fl W Ar level
.Op Ar
.Sh DESCRIPTION
The
.Nm
! utility formats manual pages for display.
.Pp
By default,
.Nm
reads
.Xr mdoc 5
*** 116,126 ****
With
.Fl man ,
all input files are interpreted as
.Xr man 5 .
By default, the input language is automatically detected for each file:
! if the the first macro is
.Ic \&Dd
or
.Ic \&Dt ,
the
.Xr mdoc 5
--- 114,124 ----
With
.Fl man ,
all input files are interpreted as
.Xr man 5 .
By default, the input language is automatically detected for each file:
! if the first macro is
.Ic \&Dd
or
.Ic \&Dt ,
the
.Xr mdoc 5
*** 130,146 ****
With other arguments,
.Fl m
is silently ignored.
.It Fl O Ar options
Comma-separated output options.
.It Fl T Ar output
! Output format.
! See
! .Sx Output Formats
! for available formats.
! Defaults to
! .Fl T Cm locale .
.It Fl W Ar level
Specify the minimum message
.Ar level
to be reported on the standard error output and to affect the exit status.
The
--- 128,163 ----
With other arguments,
.Fl m
is silently ignored.
.It Fl O Ar options
Comma-separated output options.
+ See the descriptions of the individual output formats for supported
+ .Ar options .
.It Fl T Ar output
! Select the output format.
! Supported values for the
! .Ar output
! argument are
! .Cm ascii ,
! .Cm html ,
! the default of
! .Cm locale ,
! .Cm man ,
! .Cm markdown ,
! .Cm pdf ,
! .Cm ps ,
! .Cm tree ,
! and
! .Cm utf8 .
! .Pp
! The special
! .Fl T Cm lint
! mode only parses the input and produces no output.
! It implies
! .Fl W Cm all
! and redirects parser messages, which usually appear on standard
! error output, to standard output.
.It Fl W Ar level
Specify the minimum message
.Ar level
to be reported on the standard error output and to affect the exit status.
The
*** 194,270 ****
and
.Cm stop
are requested, they can be joined with a comma, for example
.Fl W Cm error , Ns Cm stop .
.It Ar file
! Read input from zero or more files.
! If unspecified, reads from stdin.
! If multiple files are specified,
.Nm
! will halt with the first failed parse.
.El
- .Ss Output Formats
- The
- .Nm
- utility accepts the following
- .Fl T
- arguments, which correspond to output modes:
- .Bl -tag -width "-T markdown"
- .It Fl T Cm ascii
- Produce 7-bit ASCII output.
- See
- .Sx ASCII Output .
- .It Fl T Cm html
- Produce HTML5, CSS1, and MathML output.
- See
- .Sx HTML Output .
- .It Fl T Ns Cm lint
- Parse only: produce no output.
- Implies
- .Fl W Cm all
- and redirects parser messages, which usually appear
- on standard error output, to standard output.
- .It Fl T Cm locale
- Encode output using the current locale.
- This is the default.
- See
- .Sx Locale Output .
- .It Fl T Cm man
- Produce
- .Xr man 5
- format output.
- See
- .Sx Man Output .
- .It Fl T Cm markdown
- Produce output in
- .Sy markdown
- format.
- See
- .Sx Markdown Output .
- .It Fl T Cm pdf
- Produce PDF output.
- See
- .Sx PDF Output .
- .It Fl T Cm ps
- Produce PostScript output.
- See
- .Sx PostScript Output .
- .It Fl T Cm tree
- Produce an indented parse tree.
- .It Fl T Cm utf8
- Encode output in the UTF\-8 multi-byte format.
- See
- .Sx UTF\-8 Output .
- .El
- .Pp
- If multiple input files are specified, these will be processed by the
- corresponding filter in-order.
.Ss ASCII Output
! Output produced by
.Fl T Cm ascii
! is rendered in standard 7-bit ASCII documented in
! .Xr ascii 5 .
.Pp
Font styles are applied by using back-spaced encoding such that an
underlined character
.Sq c
is rendered as
--- 211,234 ----
and
.Cm stop
are requested, they can be joined with a comma, for example
.Fl W Cm error , Ns Cm stop .
.It Ar file
! Read from the given input file.
! If multiple files are specified, they are processed in the given order.
! If unspecified,
.Nm
! reads from standard input.
.El
.Ss ASCII Output
! Use
.Fl T Cm ascii
! to force text output in 7-bit ASCII character encoding documented in the
! .Xr ascii 5
! manual page, ignoring the
! .Xr locale 1
! set in the environment.
.Pp
Font styles are applied by using back-spaced encoding such that an
underlined character
.Sq c
is rendered as
*** 277,289 ****
.Pp
The special characters documented in
.Xr mandoc_char 5
are rendered best-effort in an ASCII equivalent.
.Pp
- Output width is limited to 78 visible columns unless literal input lines
- exceed this limit.
- .Pp
The following
.Fl O
arguments are accepted:
.Bl -tag -width Ds
.It Cm indent Ns = Ns Ar indent
--- 241,250 ----
*** 293,305 ****
.Xr mdoc 5
and seven for
.Xr man 5 .
Increasing this is not recommended; it may result in degraded formatting,
for example overfull lines or ugly line breaks.
.It Cm width Ns = Ns Ar width
The output width is set to
! .Ar width .
.El
.Ss HTML Output
Output produced by
.Fl T Cm html
conforms to HTML5 using optional self-closing tags.
--- 254,287 ----
.Xr mdoc 5
and seven for
.Xr man 5 .
Increasing this is not recommended; it may result in degraded formatting,
for example overfull lines or ugly line breaks.
+ When output is to a pager on a terminal that is less than 66 columns
+ wide, the default is reduced to three columns.
+ .It Cm mdoc
+ Format
+ .Xr man 5
+ input files in
+ .Xr mdoc 5
+ output style.
+ Specifically, this suppresses the two additional blank lines near the
+ top and the bottom of each page, and it implies
+ .Fl O Cm indent Ns =5 .
+ One useful application is for checking that
+ .Fl T Cm man
+ output formats in the same way as the
+ .Xr mdoc 5
+ source it was generated from.
.It Cm width Ns = Ns Ar width
The output width is set to
! .Ar width
! instead of the default of 78.
! When output is to a pager on a terminal that is less than 79 columns
! wide, the default is reduced to one less than the terminal width.
! In any case, lines that are output in literal mode are never wrapped
! and may exceed the output width.
.El
.Ss HTML Output
Output produced by
.Fl T Cm html
conforms to HTML5 using optional self-closing tags.
*** 316,326 ****
.Fl T Cm html
defaults to simple output (via an embedded style-sheet)
readable in any graphical or text-based web
browser.
.Pp
! Special characters are rendered in decimal-encoded UTF\-8.
.Pp
The following
.Fl O
arguments are accepted:
.Bl -tag -width Ds
--- 298,309 ----
.Fl T Cm html
defaults to simple output (via an embedded style-sheet)
readable in any graphical or text-based web
browser.
.Pp
! Non-ASCII characters are rendered
! as hexadecimal Unicode character references.
.Pp
The following
.Fl O
arguments are accepted:
.Bl -tag -width Ds
*** 366,392 ****
is used for an external style-sheet.
This must be a valid absolute or
relative URI.
.El
.Ss Locale Output
! Locale-depending output encoding is triggered with
.Fl T Cm locale .
- This is the default.
.Ss Man Output
! Translate input format into
.Xr man 5
output format.
This is useful for distributing manual sources to legacy systems
lacking
.Xr mdoc 5
formatters.
.Pp
! If
! .Xr mdoc 5
! is passed as input, it is translated into
! .Xr man 5 .
! If the input format is
.Xr man 5 ,
the input is copied to the output, expanding any
.Xr mandoc_roff 5
.Ic so
requests.
--- 349,388 ----
is used for an external style-sheet.
This must be a valid absolute or
relative URI.
.El
.Ss Locale Output
! By default,
! .Nm
! automatically selects UTF-8 or ASCII output according to the current
! .Xr locale 1 .
! If any of the environment variables
! .Ev LC_ALL ,
! .Ev LC_CTYPE ,
! or
! .Ev LANG
! are set and the first one that is set
! selects the UTF-8 character encoding, it produces
! .Sx UTF-8 Output ;
! otherwise, it falls back to
! .Sx ASCII Output .
! This output mode can also be selected explicitly with
.Fl T Cm locale .
.Ss Man Output
! Use
! .Fl T Cm man
! to translate
! .Xr mdoc 5
! input into
.Xr man 5
output format.
This is useful for distributing manual sources to legacy systems
lacking
.Xr mdoc 5
formatters.
.Pp
! If the input format of a file is
.Xr man 5 ,
the input is copied to the output, expanding any
.Xr mandoc_roff 5
.Ic so
requests.
*** 394,408 ****
.Fl W
level controls which
.Sx DIAGNOSTICS
are displayed before copying the input to the output.
.Ss Markdown Output
! Translate
.Xr mdoc 5
! input to the
! .Sy markdown
! format conforming to
.Lk http://daringfireball.net/projects/markdown/syntax.text\
"John Gruber's 2004 specification" .
The output also almost conforms to the
.Lk http://commonmark.org/ CommonMark
specification.
--- 390,404 ----
.Fl W
level controls which
.Sx DIAGNOSTICS
are displayed before copying the input to the output.
.Ss Markdown Output
! Use
! .Fl T Cm markdown
! to translate
.Xr mdoc 5
! input to the markdown format conforming to
.Lk http://daringfireball.net/projects/markdown/syntax.text\
"John Gruber's 2004 specification" .
The output also almost conforms to the
.Lk http://commonmark.org/ CommonMark
specification.
*** 469,485 ****
width by height in millimetres.
If an unknown value is encountered,
.Ar letter
is used.
.El
! .Ss UTF\-8 Output
Use
.Fl T Cm utf8
! to force a UTF\-8 locale.
See
! .Sx Locale Output
! for details and options.
.Ss Syntax tree output
Use
.Fl T Cm tree
to show a human readable representation of the syntax tree.
It is useful for debugging the source code of manual pages.
--- 465,492 ----
width by height in millimetres.
If an unknown value is encountered,
.Ar letter
is used.
.El
! .Ss UTF-8 Output
Use
.Fl T Cm utf8
! to force text output in UTF-8 multi-byte character encoding,
! ignoring the
! .Xr locale 1
! settings in the environment.
See
! .Sx ASCII Output
! regarding font styles and
! .Fl O
! arguments.
! .Pp
! On operating systems lacking locale or wide character support, and
! on those where the internal character representation is not UCS-4,
! .Nm
! always falls back to
! .Sx ASCII Output .
.Ss Syntax tree output
Use
.Fl T Cm tree
to show a human readable representation of the syntax tree.
It is useful for debugging the source code of manual pages.
*** 542,551 ****
--- 549,568 ----
Skip validation and show the unvalidated syntax tree.
This can help to find out whether a given behaviour is caused by
the parser or by the validator.
Meta data is not available in this case.
.El
+ .Sh ENVIRONMENT
+ .Bl -tag -width Ev
+ .It Ev LC_CTYPE
+ The character encoding
+ .Xr locale 1 .
+ When
+ .Sx Locale Output
+ is selected, it decides whether to use ASCII or UTF-8 output format.
+ It never affects the interpretation of input files.
+ .El
.Sh EXIT STATUS
The
.Nm
utility exits with one of the following values, controlled by the message
.Ar level
*** 682,692 ****
so it may occasionally issue bogus suggestions.
Please use your good judgement to decide whether any particular
.Cm style
suggestion really justifies a change to the input file.
.It Cm base
! A convertion used in the base system of a specific operating system
is not adhered to.
These are not markup mistakes, and neither the quality of formatting
nor portability are in danger.
Messages of the
.Cm base
--- 699,709 ----
so it may occasionally issue bogus suggestions.
Please use your good judgement to decide whether any particular
.Cm style
suggestion really justifies a change to the input file.
.It Cm base
! A convention used in the base system of a specific operating system
is not adhered to.
These are not markup mistakes, and neither the quality of formatting
nor portability are in danger.
Messages of the
.Cm base
*** 790,799 ****
--- 807,826 ----
Consider using the conventional
.Xr mdoc 5
date format
.Dq "Month dd, yyyy"
instead.
+ .It Sy "normalizing date format to" : No ...
+ .Pq mdoc , man
+ The
+ .Ic \&Dd
+ or
+ .Ic \&TH
+ macro provides an abbreviated month name or a day number with a
+ leading zero.
+ In the formatted output, the month name is written out in full
+ and the leading zero is omitted.
.It Sy "lower case character in document title"
.Pq mdoc , man
The title is still used as given in the
.Ic \&Dt
or
*** 802,812 ****
.It Sy "duplicate RCS id"
A single manual page contains two copies of the RCS identifier for
the same operating system.
Consider deleting the later instance and moving the first one up
to the top of the page.
! .It Sy "typo in section name"
.Pq mdoc
Fuzzy string matching revealed that the argument of an
.Ic \&Sh
macro is similar, but not identical to a standard section name.
.It Sy "unterminated quoted argument"
--- 829,839 ----
.It Sy "duplicate RCS id"
A single manual page contains two copies of the RCS identifier for
the same operating system.
Consider deleting the later instance and moving the first one up
to the top of the page.
! .It Sy "possible typo in section name"
.Pq mdoc
Fuzzy string matching revealed that the argument of an
.Ic \&Sh
macro is similar, but not identical to a standard section name.
.It Sy "unterminated quoted argument"
*** 879,888 ****
--- 906,921 ----
An
.Ic \&nf
request occurs even though the document already switched to no-fill mode
and did not switch back to fill mode yet.
It has no effect.
+ .It Sy "verbatim \(dq--\(dq, maybe consider using \e(em"
+ .Pq mdoc
+ Even though the ASCII output device renders an em-dash as
+ .Qq \-\- ,
+ that is not a good way to write it in an input file
+ because it renders poorly on all other output devices.
.It Sy "function name without markup"
.Pq mdoc
A word followed by an empty pair of parentheses occurs on a text line.
Consider using an
.Ic \&Fn