version 1.245, 2020/07/20 16:57:30 |
version 1.251, 2021/06/28 19:50:15 |
|
|
.\" $OpenBSD$ |
.\" $OpenBSD$ |
.\" |
.\" |
.\" Copyright (c) 2012, 2014-2020 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2012, 2014-2021 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
|
|
input files in |
input files in |
.Xr mdoc 7 |
.Xr mdoc 7 |
output style. |
output style. |
Specifically, this suppresses the two additional blank lines near the |
This prints the operating system name rather than the page title |
top and the bottom of each page, and it implies |
on the right side of the footer line, and it implies |
.Fl O Cm indent Ns =5 . |
.Fl O Cm indent Ns =5 . |
One useful application is for checking that |
One useful application is for checking that |
.Fl T Cm man |
.Fl T Cm man |
Line 423 MANPAGER='lynx -force_html' man -T html -O tag=MANPAGE |
|
Line 423 MANPAGER='lynx -force_html' man -T html -O tag=MANPAGE |
|
MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc |
MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc |
.Ed |
.Ed |
.Pp |
.Pp |
This argument does not work with |
Consequently, for HTML output, this argument does not work with |
.Xr more 1 |
.Xr more 1 |
or |
or |
.Xr less 1 . |
.Xr less 1 . |
|
For example, |
|
.Ql MANPAGER=less man -T html -O tag=toc mandoc |
|
does not work because |
|
.Xr less 1 |
|
does not support |
|
.Ic file:// |
|
URIs. |
.It Cm toc |
.It Cm toc |
If an input file contains at least two non-standard sections, |
If an input file contains at least two non-standard sections, |
print a table of contents near the beginning of the output. |
print a table of contents near the beginning of the output. |
Line 468 code is not supported. |
|
Line 475 code is not supported. |
|
.Pp |
.Pp |
If the input format of a file is |
If the input format of a file is |
.Xr man 7 , |
.Xr man 7 , |
the input is copied to the output, expanding any |
the input is copied to the output. |
.Xr roff 7 |
|
.Ic so |
|
requests. |
|
The parser is also run, and as usual, the |
The parser is also run, and as usual, the |
.Fl W |
.Fl W |
level controls which |
level controls which |
Line 918 generated by CVS |
|
Line 922 generated by CVS |
|
or |
or |
.Ic NetBSD |
.Ic NetBSD |
keyword substitution as conventionally used in these operating systems. |
keyword substitution as conventionally used in these operating systems. |
.It Sy "referenced manual not found" |
|
.Pq mdoc |
|
An |
|
.Ic \&Xr |
|
macro references a manual page that is not found in the base system. |
|
The path to look for base system manuals is configurable at compile |
|
time and defaults to |
|
.Pa /usr/share/man : /usr/X11R6/man . |
|
.El |
.El |
.Ss Style suggestions |
.Ss Style suggestions |
.Bl -ohang |
.Bl -ohang |
Line 1012 list contains two consecutive |
|
Line 1008 list contains two consecutive |
|
entries describing the same |
entries describing the same |
.Ic \&Er |
.Ic \&Er |
number. |
number. |
|
.It Sy "referenced manual not found" |
|
.Pq mdoc |
|
An |
|
.Ic \&Xr |
|
macro references a manual page that was not found. |
|
When running with |
|
.Fl W Cm base , |
|
the search is restricted to the base system, by default to |
|
.Pa /usr/share/man : Ns Pa /usr/X11R6/man . |
|
This path can be configured at compile time using the |
|
.Dv MANPATH_BASE |
|
preprocessor macro. |
|
When running with |
|
.Fl W Cm style , |
|
the search is done along the full search path as described in the |
|
.Xr man 1 |
|
manual page, respecting the |
|
.Fl m |
|
and |
|
.Fl M |
|
command line options, the |
|
.Ev MANPATH |
|
environment variable, the |
|
.Xr man.conf 5 |
|
file and falling back to the default of |
|
.Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man , |
|
also configurable at compile time using the |
|
.Dv MANPATH_DEFAULT |
|
preprocessor macro. |
.It Sy "trailing delimiter" |
.It Sy "trailing delimiter" |
.Pq mdoc |
.Pq mdoc |
The last argument of an |
The last argument of an |
|
|
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 "input text line longer than 80 bytes" |
|
Consider breaking the input text line |
|
at one of the blank characters before column 80. |
.It Sy "verbatim \(dq--\(dq, maybe consider using \e(em" |
.It Sy "verbatim \(dq--\(dq, maybe consider using \e(em" |
.Pq mdoc |
.Pq mdoc |
Even though the ASCII output device renders an em-dash as |
Even though the ASCII output device renders an em-dash as |
Line 1846 The invalid character is discarded. |
|
Line 1874 The invalid character is discarded. |
|
A table layout specification contains an opening parenthesis, |
A table layout specification contains an opening parenthesis, |
but no matching closing parenthesis. |
but no matching closing parenthesis. |
The rest of the input line, starting from the parenthesis, has no effect. |
The rest of the input line, starting from the parenthesis, has no effect. |
|
.It Sy "ignoring excessive spacing in tbl layout" |
|
.Pq tbl |
|
A spacing modifier in a table layout is unreasonably large. |
|
The default spacing of 3n is used instead. |
.It Sy "tbl without any data cells" |
.It Sy "tbl without any data cells" |
.Pq tbl |
.Pq tbl |
A table does not contain any data cells. |
A table does not contain any data cells. |