Annotation of mandoc/demandoc.1, Revision 1.6
1.6 ! kristaps 1: .\" $Id: demandoc.1,v 1.5 2011/09/02 13:04:05 kristaps Exp $
1.1 kristaps 2: .\"
3: .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.6 ! kristaps 17: .Dd $Mdocdate: September 2 2011 $
1.1 kristaps 18: .Dt DEMANDOC 1
19: .Os
20: .Sh NAME
21: .Nm demandoc
22: .Nd emit only text of UNIX manuals
23: .Sh SYNOPSIS
24: .Nm demandoc
1.2 kristaps 25: .Op Fl w
1.1 kristaps 26: .Op Ar
27: .Sh DESCRIPTION
28: The
29: .Nm
1.2 kristaps 30: utility emits only the text portions of well-formed
1.1 kristaps 31: .Xr mdoc 7
32: and
33: .Xr man 7
34: .Ux
35: manual files.
1.6 ! kristaps 36: .Pp
! 37: By default,
! 38: .Nm
! 39: parses standard input and outputs only text nodes, preserving line
! 40: and column position.
! 41: Escape sequences are omitted from the output.
! 42: .Pp
1.1 kristaps 43: Its arguments are as follows:
44: .Bl -tag -width Ds
1.2 kristaps 45: .It Fl w
46: Output a word list.
47: This outputs each word of text on its own line.
48: A
1.3 kristaps 49: .Qq word ,
50: in this case, refers to whitespace-delimited terms beginning with at
1.4 kristaps 51: least two letters and not consisting of any escape sequences.
1.5 kristaps 52: Words have their leading and trailing punctuation
1.4 kristaps 53: .Pq double-quotes, sentence punctuation, etc.
54: stripped.
1.1 kristaps 55: .It Ar
56: The input files.
57: .El
58: .Pp
1.3 kristaps 59: If a document is not well-formed, it is skipped.
1.2 kristaps 60: .Pp
61: The
62: .Fl i ,
63: .Fl k ,
64: .Fl m ,
65: and
66: .Fl p
67: flags are silently discarded for calling compatibility with the
68: historical deroff.
1.1 kristaps 69: .Sh EXIT STATUS
70: The
71: .Nm
72: utility exits with one of the following values:
73: .Pp
74: .Bl -tag -width Ds -compact
75: .It 0
76: No errors occurred.
77: .It 6
78: An operating system error occurred, for example memory exhaustion or an
79: error accessing input files.
80: Such errors cause
81: .Nm
82: to exit at once, possibly in the middle of parsing or formatting a file.
83: The output databases are corrupt and should be removed .
84: .El
1.4 kristaps 85: .Sh EXAMPLES
86: The traditional usage of
87: .Nm
88: is for spell-checking manuals on
89: .Bx .
90: This is accomplished as follows (assuming British spelling):
91: .Pp
92: .Dl $ demandoc -w file.1 | spell -b
1.1 kristaps 93: .Sh SEE ALSO
94: .Xr mandoc 1 ,
95: .Xr man 7
96: .Xr mdoc 7
1.2 kristaps 97: .Sh HISTORY
98: .Nm
99: replaces the historical deroff utility for handling modern
100: .Xr man 7
101: and
102: .Xr mdoc 7
103: documents.
1.1 kristaps 104: .Sh AUTHORS
105: The
106: .Nm
107: utility was written by
108: .An Kristaps Dzonsons ,
109: .Mt kristaps@bsd.lv .
CVSweb