Annotation of mandoc/demandoc.1, Revision 1.2
1.2 ! kristaps 1: .\" $Id: demandoc.1,v 1.1 2011/09/01 10:46:28 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.2 ! kristaps 17: .Dd $Mdocdate: September 1 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.
36: Its arguments are as follows:
37: .Bl -tag -width Ds
1.2 ! kristaps 38: .It Fl w
! 39: Output a word list.
! 40: This outputs each word of text on its own line.
! 41: A
! 42: .Qq word
! 43: starts with at least two letters and consists of at least three letters
! 44: total.
1.1 kristaps 45: .It Ar
46: The input files.
47: .El
48: .Pp
49: If
50: .Ar file
51: is not provided,
52: .Nm
53: accepts standard input.
54: .Pp
1.2 ! kristaps 55: By default,
1.1 kristaps 56: .Nm
1.2 ! kristaps 57: parses its input and outputs only text nodes, preserving line column
! 58: position.
! 59: If a document is not well-formed, it is skipped.
! 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
85: .Sh SEE ALSO
86: .Xr mandoc 1 ,
87: .Xr man 7
88: .Xr mdoc 7
1.2 ! kristaps 89: .Sh HISTORY
! 90: .Nm
! 91: replaces the historical deroff utility for handling modern
! 92: .Xr man 7
! 93: and
! 94: .Xr mdoc 7
! 95: documents.
1.1 kristaps 96: .Sh AUTHORS
97: The
98: .Nm
99: utility was written by
100: .An Kristaps Dzonsons ,
101: .Mt kristaps@bsd.lv .
CVSweb