version 1.239, 2019/05/26 01:28:09 |
version 1.245, 2020/07/20 16:57:30 |
|
|
.\" $Id$ |
.\" $OpenBSD$ |
.\" |
.\" |
|
.\" Copyright (c) 2012, 2014-2020 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> |
.\" 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 |
Line 52 The options are as follows: |
|
Line 52 The options are as follows: |
|
If the standard output is a terminal device and |
If the standard output is a terminal device and |
.Fl c |
.Fl c |
is not specified, use |
is not specified, use |
.Xr more 1 |
.Xr less 1 |
to paginate the output, just like |
to paginate the output, just like |
.Xr man 1 |
.Xr man 1 |
would. |
would. |
.It Fl c |
.It Fl c |
Copy the formatted manual pages to the standard output without using |
Copy the formatted manual pages to the standard output without using |
.Xr more 1 |
.Xr less 1 |
to paginate them. |
to paginate them. |
This is the default. |
This is the default. |
It can be specified to override |
It can be specified to override |
|
|
is used for an external style-sheet. |
is used for an external style-sheet. |
This must be a valid absolute or |
This must be a valid absolute or |
relative URI. |
relative URI. |
|
.It Cm tag Ns Op = Ns Ar term |
|
Same syntax and semantics as for |
|
.Sx ASCII Output . |
|
This is implemented by passing a |
|
.Ic file:// |
|
URI ending in a fragment identifier to the pager |
|
rather than passing merely a file name. |
|
When using this argument, use a pager supporting such URIs, for example |
|
.Bd -literal -offset 3n |
|
MANPAGER='lynx -force_html' man -T html -O tag=MANPAGER man |
|
MANPAGER='w3m -T text/html' man -T html -O tag=toc mandoc |
|
.Ed |
|
.Pp |
|
This argument does not work with |
|
.Xr more 1 |
|
or |
|
.Xr less 1 . |
.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 443 This is useful for distributing manual sources to lega |
|
Line 460 This is useful for distributing manual sources to lega |
|
lacking |
lacking |
.Xr mdoc 7 |
.Xr mdoc 7 |
formatters. |
formatters. |
|
Embedded |
|
.Xr eqn 7 |
|
and |
|
.Xr tbl 7 |
|
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 , |
Line 628 It never affects the interpretation of input files. |
|
Line 650 It never affects the interpretation of input files. |
|
Any non-empty value of the environment variable |
Any non-empty value of the environment variable |
.Ev MANPAGER |
.Ev MANPAGER |
is used instead of the standard pagination program, |
is used instead of the standard pagination program, |
.Xr more 1 ; |
.Xr less 1 ; |
see |
see |
.Xr man 1 |
.Xr man 1 |
for details. |
for details. |
Line 642 Specifies the pagination program to use when |
|
Line 664 Specifies the pagination program to use when |
|
.Ev MANPAGER |
.Ev MANPAGER |
is not defined. |
is not defined. |
If neither PAGER nor MANPAGER is defined, |
If neither PAGER nor MANPAGER is defined, |
.Xr more 1 |
.Xr less 1 |
.Fl s |
|
is used. |
is used. |
Only used if |
Only used if |
.Fl a |
.Fl a |
Line 698 No input files have been read. |
|
Line 719 No input files have been read. |
|
.It 6 |
.It 6 |
An operating system error occurred, for example exhaustion |
An operating system error occurred, for example exhaustion |
of memory, file descriptors, or process table entries. |
of memory, file descriptors, or process table entries. |
Such errors cause |
Such errors may cause |
.Nm |
.Nm |
to exit at once, possibly in the middle of parsing or formatting a file. |
to exit at once, possibly in the middle of parsing or formatting a file. |
.El |
.El |
|
|
.Pp |
.Pp |
Message levels have the following meanings: |
Message levels have the following meanings: |
.Bl -tag -width "warning" |
.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 |
.It Cm unsupp |
An input file uses unsupported low-level |
An input file uses unsupported low-level |
.Xr roff 7 |
.Xr roff 7 |
|
|
.Cm error , |
.Cm error , |
and |
and |
.Cm unsupp |
.Cm unsupp |
levels except those about non-existent or unreadable input files |
levels are hidden unless their level, or a lower level, is requested using a |
are hidden unless their level, or a lower level, is requested using a |
|
.Fl W |
.Fl W |
option or |
option or |
.Fl T Cm lint |
.Fl T Cm lint |
Line 1067 macro lacks the mandatory section argument. |
|
Line 1094 macro lacks the mandatory section argument. |
|
The section number in a |
The section number in a |
.Ic \&Dt |
.Ic \&Dt |
line is invalid, but still used. |
line is invalid, but still used. |
.It Sy "missing date, using today's date" |
.It Sy "filename/section mismatch" |
|
.Pq mdoc , man |
|
The name of the input file being processed is known and its file |
|
name extension starts with a non-zero digit, but the |
|
.Ic \&Dt |
|
or |
|
.Ic \&TH |
|
macro contains a |
|
.Ar section |
|
argument that starts with a different non-zero digit. |
|
The |
|
.Ar section |
|
argument is used as provided anyway. |
|
Consider checking whether the file name or the argument need a correction. |
|
.It Sy "missing date, using \(dq\(dq" |
.Pq mdoc, man |
.Pq mdoc, man |
The document was parsed as |
The document was parsed as |
.Xr mdoc 7 |
.Xr mdoc 7 |
|
|
macro or of an undefined macro. |
macro or of an undefined macro. |
The macro is ignored, and its arguments are handled |
The macro is ignored, and its arguments are handled |
as if they were a text line. |
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 |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr apropos 1 , |
.Xr apropos 1 , |