catch up with the changed interface of mparse_alloc(), see mandoc.h rev 1.100

[mandoc.git] / demandoc.1

diff --git a/demandoc.1 b/demandoc.1
index 9415fe7016a1ea07928a88fbcd061dce287deeab..845b9c14b55b57e2d01abb9b3e163e693fa4c8db 100644 (file)
--- 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.6 2011/12/25 19:35:44 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: December 25 2011 $
 .Dt DEMANDOC 1
 .Os
 .Sh NAME
@@ -33,6 +33,13 @@ and
 .Xr man 7
 .Ux
 manual files.
+.Pp
+By default,
+.Nm
+parses standard input and outputs only text nodes, preserving line
+and column position.
+Escape sequences are omitted from the output.
+.Pp
 Its arguments are as follows:
 .Bl -tag -width Ds
 .It Fl w
@@ -41,25 +48,16 @@ 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.
+Words have their leading and trailing punctuation
+.Pq double-quotes, sentence punctuation, etc.
+stripped.
 .It Ar
 The input files.
 .El
 .Pp
-If
-.Ar file
-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.
-Escape sequences are omitted from the output.
-.Pp
 The
 .Fl i ,
 .Fl k ,
@@ -84,6 +82,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