version 1.218, 2017/08/19 22:00:05 |
version 1.223, 2018/04/13 19:55:30 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2012, 2014-2018 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
all input files are interpreted as |
all input files are interpreted as |
.Xr man 7 . |
.Xr man 7 . |
By default, the input language is automatically detected for each file: |
By default, the input language is automatically detected for each file: |
if the the first macro is |
if the first macro is |
.Ic \&Dd |
.Ic \&Dd |
or |
or |
.Ic \&Dt , |
.Ic \&Dt , |
Line 299 The special characters documented in |
|
Line 299 The special characters documented in |
|
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
are rendered best-effort in an ASCII equivalent. |
are rendered best-effort in an ASCII equivalent. |
.Pp |
.Pp |
Output width is limited to 78 visible columns unless literal input lines |
|
exceed this limit. |
|
.Pp |
|
The following |
The following |
.Fl O |
.Fl O |
arguments are accepted: |
arguments are accepted: |
|
|
.Xr man 7 . |
.Xr man 7 . |
Increasing this is not recommended; it may result in degraded formatting, |
Increasing this is not recommended; it may result in degraded formatting, |
for example overfull lines or ugly line breaks. |
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 |
.It Cm mdoc |
Format |
Format |
.Xr man 7 |
.Xr man 7 |
Line 331 output formats in the same way as the |
|
Line 330 output formats in the same way as the |
|
source it was generated from. |
source it was generated from. |
.It Cm width Ns = Ns Ar width |
.It Cm width Ns = Ns Ar width |
The output width is set to |
The output width is set to |
.Ar width . |
.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 |
.El |
.Ss HTML Output |
.Ss HTML Output |
Output produced by |
Output produced by |
Line 755 Please use your good judgement to decide whether any p |
|
Line 759 Please use your good judgement to decide whether any p |
|
.Cm style |
.Cm style |
suggestion really justifies a change to the input file. |
suggestion really justifies a change to the input file. |
.It Cm base |
.It Cm base |
A convertion used in the base system of a specific operating system |
A convention used in the base system of a specific operating system |
is not adhered to. |
is not adhered to. |
These are not markup mistakes, and neither the quality of formatting |
These are not markup mistakes, and neither the quality of formatting |
nor portability are in danger. |
nor portability are in danger. |
Line 875 A single manual page contains two copies of the RCS id |
|
Line 879 A single manual page contains two copies of the RCS id |
|
the same operating system. |
the same operating system. |
Consider deleting the later instance and moving the first one up |
Consider deleting the later instance and moving the first one up |
to the top of the page. |
to the top of the page. |
.It Sy "typo in section name" |
.It Sy "possible typo in section name" |
.Pq mdoc |
.Pq mdoc |
Fuzzy string matching revealed that the argument of an |
Fuzzy string matching revealed that the argument of an |
.Ic \&Sh |
.Ic \&Sh |
|
|
request occurs even though the document already switched to no-fill mode |
request occurs even though the document already switched to no-fill mode |
and did not switch back to fill mode yet. |
and did not switch back to fill mode yet. |
It has no effect. |
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" |
.It Sy "function name without markup" |
.Pq mdoc |
.Pq mdoc |
A word followed by an empty pair of parentheses occurs on a text line. |
A word followed by an empty pair of parentheses occurs on a text line. |