summaryrefslogtreecommitdiffstats
path: root/demandoc.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-09-01 22:25:53 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-09-01 22:25:53 +0000
commitc78c9e8936467a043d7391bd6994eb881eb0cc70 (patch)
treec23f82e7005e0866a7a1100df4fd5bfa0462f3fe /demandoc.1
parent20e26486c747057a6426ded8d6a1f89bf2154c6e (diff)
downloadmandoc-c78c9e8936467a043d7391bd6994eb881eb0cc70.tar.gz
Finishing touches on demandoc. It now backs over ending punctuation as
well as leading punctuation. Again, this isn't the same as deroff (which uses, I think, some punctuation as delimiters), but it's easier to explain and simpler to audit.
Diffstat (limited to 'demandoc.1')
-rw-r--r--demandoc.114
1 files changed, 12 insertions, 2 deletions
diff --git a/demandoc.1 b/demandoc.1
index 169616d2..1c1cd585 100644
--- a/demandoc.1
+++ b/demandoc.1
@@ -41,8 +41,10 @@ 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 after opening punctuation and not consisting of any
-escape sequences.
+least two letters and not consisting of any escape sequences.
+Terms have their leading and trailing punctuation
+.Pq double-quotes, sentence punctuation, etc.
+stripped.
.It Ar
The input files.
.El
@@ -84,6 +86,14 @@ Such errors cause
to exit at once, possibly in the middle of parsing or formatting a file.
The output databases are corrupt and should be removed .
.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
.Xr mandoc 1 ,
.Xr man 7