aboutsummaryrefslogtreecommitdiffstatshomepage
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
commitc94f8a44e39bddd5b62e05dd047ac8698c1dbce2 (patch)
tree208740a4bbe937a106e4a856b57ba12eece716e6 /demandoc.1
parent8029498c79101ce64d193dd27f61e4d3755fec84 (diff)
downloadmandoc-c94f8a44e39bddd5b62e05dd047ac8698c1dbce2.tar.gz
mandoc-c94f8a44e39bddd5b62e05dd047ac8698c1dbce2.tar.zst
mandoc-c94f8a44e39bddd5b62e05dd047ac8698c1dbce2.zip
Have demandoc throw away deroff's flags.
Diffstat (limited to 'demandoc.1')
-rw-r--r--demandoc.133
1 files changed, 30 insertions, 3 deletions
diff --git a/demandoc.1 b/demandoc.1
index 1136542f..30f6d2e7 100644
--- a/demandoc.1
+++ b/demandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: demandoc.1,v 1.1 2011/09/01 10:46:28 kristaps Exp $
+.\" $Id: demandoc.1,v 1.2 2011/09/01 20:55:50 kristaps Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -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