aboutsummaryrefslogtreecommitdiffstatshomepage
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
commit8bc8d59cc1a8d7d555dfd3583e32a8cdd13e3c5b (patch)
tree3690c436ab794b8ce26c4c710c7fb4984d563ce3 /demandoc.1
parentacfe4f96d50c12ef7200840ede40f289416d481c (diff)
downloadmandoc-8bc8d59cc1a8d7d555dfd3583e32a8cdd13e3c5b.tar.gz
mandoc-8bc8d59cc1a8d7d555dfd3583e32a8cdd13e3c5b.tar.zst
mandoc-8bc8d59cc1a8d7d555dfd3583e32a8cdd13e3c5b.zip
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.116
1 files changed, 13 insertions, 3 deletions
diff --git a/demandoc.1 b/demandoc.1
index 9415fe70..dd8e677b 100644
--- a/demandoc.1
+++ b/demandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: demandoc.1,v 1.3 2011/09/01 22:09:50 kristaps Exp $
+.\" $Id: demandoc.1,v 1.4 2011/09/01 22:25:53 kristaps Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
@@ -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