version 1.1, 2011/09/01 10:46:28 |
version 1.9, 2022/03/20 15:41:47 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
|
|
.Nd emit only text of UNIX manuals |
.Nd emit only text of UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm demandoc |
.Nm demandoc |
|
.Op Fl w |
.Op Ar |
.Op Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility emits only the text portions of |
utility emits only the text portions of well-formed |
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
.Ux |
.Ux |
manual files. |
manual files. |
|
.Pp |
|
By default, |
|
.Nm |
|
parses standard input and outputs only text nodes, preserving line |
|
and column position. |
|
Escape sequences are omitted from the output. |
|
.Pp |
Its arguments are as follows: |
Its arguments are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl w |
|
Output a word list. |
|
This outputs each word of text on its own line. |
|
A |
|
.Qq word , |
|
in this case, refers to whitespace-delimited terms beginning with at |
|
least two letters and not consisting of any escape sequences. |
|
Words have their leading and trailing punctuation |
|
.Pq double-quotes, sentence punctuation, etc. |
|
stripped. |
.It Ar |
.It Ar |
The input files. |
The input files. |
.El |
.El |
.Pp |
.Pp |
If |
If a document is not well-formed, it is skipped. |
.Ar file |
|
is not provided, |
|
.Nm |
|
accepts standard input. |
|
.Pp |
.Pp |
.Nm |
The |
output preserves the line numbering and column position of its input. |
.Fl i , |
|
.Fl k , |
|
.Fl m , |
|
and |
|
.Fl p |
|
flags are silently discarded for calling compatibility with the |
|
historical deroff. |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
The |
The |
.Nm |
.Nm |
Line 60 error accessing input files. |
|
Line 80 error accessing input files. |
|
Such errors cause |
Such errors 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. |
The output databases are corrupt and should be removed . |
|
.El |
.El |
|
.Sh EXAMPLES |
|
The traditional usage of |
|
.Nm |
|
is for spell-checking manuals on |
|
.Bx . |
|
This is accomplished as follows (assuming British spelling): |
|
.Pp |
|
.Dl $ demandoc -w file.1 | spell -b |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
|
.Xr man 7 , |
|
.Xr mdoc 7 |
|
.Sh HISTORY |
|
.Nm |
|
replaces the historical deroff utility for handling modern |
.Xr man 7 |
.Xr man 7 |
|
and |
.Xr mdoc 7 |
.Xr mdoc 7 |
|
documents. |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
|