=================================================================== RCS file: /cvs/mandoc/demandoc.1,v retrieving revision 1.2 retrieving revision 1.8 diff -u -p -r1.2 -r1.8 --- mandoc/demandoc.1 2011/09/01 20:55:50 1.2 +++ mandoc/demandoc.1 2014/09/12 00:10:26 1.8 @@ -1,4 +1,4 @@ -.\" $Id: demandoc.1,v 1.2 2011/09/01 20:55:50 kristaps Exp $ +.\" $Id: demandoc.1,v 1.8 2014/09/12 00:10:26 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -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 12 2014 $ .Dt DEMANDOC 1 .Os .Sh NAME @@ -33,29 +33,29 @@ 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 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 .Pp -If -.Ar file -is not provided, -.Nm -accepts standard input. -.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. .Pp The @@ -82,9 +82,17 @@ 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 +.Xr man 7 , .Xr mdoc 7 .Sh HISTORY .Nm @@ -97,5 +105,4 @@ documents. The .Nm utility was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .