Do not cast void pointers to pointers requiring alignment.

[mandoc.git] / demandoc.1

diff --git a/demandoc.1 b/demandoc.1
index 30f6d2e7b19cb502eef7c82d51ecc8eaa1a32908..9d4ad2180d20bfd80c870b43408a7dd0c0bf8e25 100644 (file)
--- a/demandoc.1
+++ b/demandoc.1
@@ -1,4 +1,4 @@
-.\"    $Id: demandoc.1,v 1.2 2011/09/01 20:55:50 kristaps Exp $
+.\"    $Id: demandoc.1,v 1.5 2011/09/02 13:04:05 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: September 1 2011 $
+.Dd $Mdocdate: September 2 2011 $
 .Dt DEMANDOC 1
 .Os
 .Sh NAME
@@ -39,9 +39,12 @@ Its arguments are as follows:
 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.
+.Qq word ,
+in this case, refers to whitespace-delimited terms beginning with at
+least two letters and not consisting of any escape sequences.
+Words have their leading and trailing punctuation
+.Pq double-quotes, sentence punctuation, etc.
+stripped.
 .It Ar
 The input files.
 .El
@@ -51,12 +54,13 @@ If
 is not provided,
 .Nm
 accepts standard input.
+If a document is not well-formed, it is skipped.
 .Pp
 By default,
 .Nm
 parses its input and outputs only text nodes, preserving line column
 position.
-If a document is not well-formed, it is skipped.
+Escape sequences are omitted from the output.
 .Pp
 The
 .Fl i ,
@@ -82,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