version 1.162, 2015/10/06 15:33:29 |
version 1.169, 2017/01/10 12:53:07 |
|
|
.\" $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, 2015 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2012, 2014-2017 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 75 This overrides any earlier |
|
Line 75 This overrides any earlier |
|
and |
and |
.Fl l |
.Fl l |
options. |
options. |
|
.It Fl h |
|
Display only the SYNOPSIS lines. |
|
Implies |
|
.Fl c . |
.It Fl I Cm os Ns = Ns Ar name |
.It Fl I Cm os Ns = Ns Ar name |
Override the default operating system |
Override the default operating system |
.Ar name |
.Ar name |
|
|
.Xr man 7 |
.Xr man 7 |
.Sq \&TH |
.Sq \&TH |
macro. |
macro. |
.It Fl h |
|
Display only the SYNOPSIS lines. |
|
Implies |
|
.Fl c . |
|
.It Fl K Ar encoding |
.It Fl K Ar encoding |
Specify the input encoding. |
Specify the input encoding. |
The supported |
The supported |
Line 349 Equations rendered from |
|
Line 349 Equations rendered from |
|
blocks use MathML. |
blocks use MathML. |
.Pp |
.Pp |
The |
The |
.Pa example.style.css |
.Pa mandoc.css |
file documents style-sheet classes available for customising output. |
file documents style-sheet classes available for customising output. |
If a style-sheet is not specified with |
If a style-sheet is not specified with |
.Fl O Cm style , |
.Fl O Cm style , |
Line 529 The input column number (starting at one). |
|
Line 529 The input column number (starting at one). |
|
A closing parenthesis if the node is a closing delimiter. |
A closing parenthesis if the node is a closing delimiter. |
.It |
.It |
A full stop if the node ends a sentence. |
A full stop if the node ends a sentence. |
|
.It |
|
NOSRC if the node is not in the input file, |
|
but automatically generated from macros. |
|
.It |
|
NOPRT if the node is not supposed to generate output |
|
for any output format. |
.El |
.El |
.El |
.El |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
Line 601 To page manuals to the terminal: |
|
Line 607 To page manuals to the terminal: |
|
.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less |
.Pp |
.Pp |
To produce HTML manuals with |
To produce HTML manuals with |
.Ar style.css |
.Pa mandoc.css |
as the style-sheet: |
as the style-sheet: |
.Pp |
.Pp |
.Dl $ mandoc \-T html -O style=style.css mdoc.7 \*(Gt mdoc.7.html |
.Dl $ mandoc \-T html -O style=mandoc.css mdoc.7 \*(Gt mdoc.7.html |
.Pp |
.Pp |
To check over a large set of manuals: |
To check over a large set of manuals: |
.Pp |
.Pp |
Line 809 This may confuse |
|
Line 815 This may confuse |
|
.Xr makewhatis 8 |
.Xr makewhatis 8 |
and |
and |
.Xr apropos 1 . |
.Xr apropos 1 . |
.It Sy "NAME section without name" |
.It Sy "NAME section without Nm before Nd" |
.Pq mdoc |
.Pq mdoc |
The NAME section does not contain any |
The NAME section does not contain any |
.Ic \&Nm |
.Ic \&Nm |
child macro. |
child macro before the first |
|
.Ic \&Nd |
|
macro. |
.It Sy "NAME section without description" |
.It Sy "NAME section without description" |
.Pq mdoc |
.Pq mdoc |
The NAME section lacks the mandatory |
The NAME section lacks the mandatory |
Line 830 The NAME section contains plain text or macros other t |
|
Line 838 The NAME section contains plain text or macros other t |
|
.Ic \&Nm |
.Ic \&Nm |
and |
and |
.Ic \&Nd . |
.Ic \&Nd . |
|
.It Sy "missing comma before name" |
|
.Pq mdoc |
|
The NAME section contains an |
|
.Ic \&Nm |
|
macro that is neither the first one nor preceded by a comma. |
.It Sy "missing description line, using \(dq\(dq" |
.It Sy "missing description line, using \(dq\(dq" |
.Pq mdoc |
.Pq mdoc |
The |
The |
Line 1147 macro is immediately followed by an |
|
Line 1160 macro is immediately followed by an |
|
.Ic \&Re |
.Ic \&Re |
macro on the next input line. |
macro on the next input line. |
Such an empty block does not produce any output. |
Such an empty block does not produce any output. |
|
.It Sy "missing section argument" |
|
.Pq mdoc |
|
An |
|
.Ic \&Xr |
|
macro lacks its second, section number argument. |
|
The first argument, i.e. the name, is printed, but without subsequent |
|
parentheses. |
.It Sy "missing -std argument, adding it" |
.It Sy "missing -std argument, adding it" |
.Pq mdoc |
.Pq mdoc |
An |
An |
Line 1600 By requesting the inclusion of a sensitive file, a mal |
|
Line 1620 By requesting the inclusion of a sensitive file, a mal |
|
might otherwise trick a privileged user into inadvertently displaying |
might otherwise trick a privileged user into inadvertently displaying |
the file on the screen, revealing the file content to bystanders. |
the file on the screen, revealing the file content to bystanders. |
The argument is ignored including the file name following it. |
The argument is ignored including the file name following it. |
|
.It Sy "skipping display without arguments" |
|
.Pq mdoc |
|
A |
|
.Ic \&Bd |
|
block macro does not have any arguments. |
|
The block is discarded, and the block content is displayed in |
|
whatever mode was active before the block. |
.It Sy "missing list type, using -item" |
.It Sy "missing list type, using -item" |
.Pq mdoc |
.Pq mdoc |
A |
A |
Line 1608 macro fails to specify the list type. |
|
Line 1635 macro fails to specify the list type. |
|
.It Sy "missing manual name, using \(dq\(dq" |
.It Sy "missing manual name, using \(dq\(dq" |
.Pq mdoc |
.Pq mdoc |
The first call to |
The first call to |
.Ic \&Nm |
.Ic \&Nm , |
lacks the required argument. |
or any call in the NAME section, lacks the required argument. |
.It Sy "uname(3) system call failed, using UNKNOWN" |
.It Sy "uname(3) system call failed, using UNKNOWN" |
.Pq mdoc |
.Pq mdoc |
The |
The |