summaryrefslogtreecommitdiffstats
path: root/demandoc.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-09-01 20:55:50 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-09-01 20:55:50 +0000
commita3561601a4adc8f988b95b6bc5356bf369a5d198 (patch)
tree4f7b028a30bf3dba0690c180d59dd14be65a1ce3 /demandoc.1
parent857ad0869399503297c5b7af159469cc1f795d30 (diff)
downloadmandoc-a3561601a4adc8f988b95b6bc5356bf369a5d198.tar.gz
Have demandoc throw away deroff's flags.
Diffstat (limited to 'demandoc.1')
-rw-r--r--demandoc.131
1 files changed, 29 insertions, 2 deletions
diff --git a/demandoc.1 b/demandoc.1
index 23463af1..0b909514 100644
--- a/demandoc.1
+++ b/demandoc.1
@@ -22,11 +22,12 @@
.Nd emit only text of UNIX manuals
.Sh SYNOPSIS
.Nm demandoc
+.Op Fl w
.Op Ar
.Sh DESCRIPTION
The
.Nm
-utility emits only the text portions of
+utility emits only the text portions of well-formed
.Xr mdoc 7
and
.Xr man 7
@@ -34,6 +35,13 @@ and
manual files.
Its arguments are as follows:
.Bl -tag -width Ds
+.It Fl w
+Output a word list.
+This outputs each word of text on its own line.
+A
+.Qq word
+starts with at least two letters and consists of at least three letters
+total.
.It Ar
The input files.
.El
@@ -44,8 +52,20 @@ is not provided,
.Nm
accepts standard input.
.Pp
+By default,
.Nm
-output preserves the line numbering and column position of its input.
+parses its input and outputs only text nodes, preserving line column
+position.
+If a document is not well-formed, it is skipped.
+.Pp
+The
+.Fl i ,
+.Fl k ,
+.Fl m ,
+and
+.Fl p
+flags are silently discarded for calling compatibility with the
+historical deroff.
.Sh EXIT STATUS
The
.Nm
@@ -66,6 +86,13 @@ The output databases are corrupt and should be removed .
.Xr mandoc 1 ,
.Xr man 7
.Xr mdoc 7
+.Sh HISTORY
+.Nm
+replaces the historical deroff utility for handling modern
+.Xr man 7
+and
+.Xr mdoc 7
+documents.
.Sh AUTHORS
The
.Nm