1*54ba9607SSascha Wildner.\" $Id: demandoc.1,v 1.8 2014/09/12 00:10:26 schwarze Exp $ 236342e81SSascha Wildner.\" 336342e81SSascha Wildner.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> 436342e81SSascha Wildner.\" 536342e81SSascha Wildner.\" Permission to use, copy, modify, and distribute this software for any 636342e81SSascha Wildner.\" purpose with or without fee is hereby granted, provided that the above 736342e81SSascha Wildner.\" copyright notice and this permission notice appear in all copies. 836342e81SSascha Wildner.\" 936342e81SSascha Wildner.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 1036342e81SSascha Wildner.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 1136342e81SSascha Wildner.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 1236342e81SSascha Wildner.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1336342e81SSascha Wildner.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1436342e81SSascha Wildner.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1536342e81SSascha Wildner.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 1636342e81SSascha Wildner.\" 17*54ba9607SSascha Wildner.Dd $Mdocdate: September 12 2014 $ 1836342e81SSascha Wildner.Dt DEMANDOC 1 1936342e81SSascha Wildner.Os 2036342e81SSascha Wildner.Sh NAME 2136342e81SSascha Wildner.Nm demandoc 2236342e81SSascha Wildner.Nd emit only text of UNIX manuals 2336342e81SSascha Wildner.Sh SYNOPSIS 2436342e81SSascha Wildner.Nm demandoc 2536342e81SSascha Wildner.Op Fl w 2636342e81SSascha Wildner.Op Ar 2736342e81SSascha Wildner.Sh DESCRIPTION 2836342e81SSascha WildnerThe 2936342e81SSascha Wildner.Nm 3036342e81SSascha Wildnerutility emits only the text portions of well-formed 3136342e81SSascha Wildner.Xr mdoc 7 3236342e81SSascha Wildnerand 3336342e81SSascha Wildner.Xr man 7 3436342e81SSascha Wildner.Ux 3536342e81SSascha Wildnermanual files. 3636342e81SSascha Wildner.Pp 3736342e81SSascha WildnerBy default, 3836342e81SSascha Wildner.Nm 3936342e81SSascha Wildnerparses standard input and outputs only text nodes, preserving line 4036342e81SSascha Wildnerand column position. 4136342e81SSascha WildnerEscape sequences are omitted from the output. 4236342e81SSascha Wildner.Pp 4336342e81SSascha WildnerIts arguments are as follows: 4436342e81SSascha Wildner.Bl -tag -width Ds 4536342e81SSascha Wildner.It Fl w 4636342e81SSascha WildnerOutput a word list. 4736342e81SSascha WildnerThis outputs each word of text on its own line. 4836342e81SSascha WildnerA 4936342e81SSascha Wildner.Qq word , 5036342e81SSascha Wildnerin this case, refers to whitespace-delimited terms beginning with at 5136342e81SSascha Wildnerleast two letters and not consisting of any escape sequences. 5236342e81SSascha WildnerWords have their leading and trailing punctuation 5336342e81SSascha Wildner.Pq double-quotes, sentence punctuation, etc. 5436342e81SSascha Wildnerstripped. 5536342e81SSascha Wildner.It Ar 5636342e81SSascha WildnerThe input files. 5736342e81SSascha Wildner.El 5836342e81SSascha Wildner.Pp 5936342e81SSascha WildnerIf a document is not well-formed, it is skipped. 6036342e81SSascha Wildner.Pp 6136342e81SSascha WildnerThe 6236342e81SSascha Wildner.Fl i , 6336342e81SSascha Wildner.Fl k , 6436342e81SSascha Wildner.Fl m , 6536342e81SSascha Wildnerand 6636342e81SSascha Wildner.Fl p 6736342e81SSascha Wildnerflags are silently discarded for calling compatibility with the 6836342e81SSascha Wildnerhistorical deroff. 6936342e81SSascha Wildner.Sh EXIT STATUS 7036342e81SSascha WildnerThe 7136342e81SSascha Wildner.Nm 7236342e81SSascha Wildnerutility exits with one of the following values: 7336342e81SSascha Wildner.Pp 7436342e81SSascha Wildner.Bl -tag -width Ds -compact 7536342e81SSascha Wildner.It 0 7636342e81SSascha WildnerNo errors occurred. 7736342e81SSascha Wildner.It 6 7836342e81SSascha WildnerAn operating system error occurred, for example memory exhaustion or an 7936342e81SSascha Wildnererror accessing input files. 8036342e81SSascha WildnerSuch errors cause 8136342e81SSascha Wildner.Nm 8236342e81SSascha Wildnerto exit at once, possibly in the middle of parsing or formatting a file. 8336342e81SSascha WildnerThe output databases are corrupt and should be removed . 8436342e81SSascha Wildner.El 8536342e81SSascha Wildner.Sh EXAMPLES 8636342e81SSascha WildnerThe traditional usage of 8736342e81SSascha Wildner.Nm 8836342e81SSascha Wildneris for spell-checking manuals on 8936342e81SSascha Wildner.Bx . 9036342e81SSascha WildnerThis is accomplished as follows (assuming British spelling): 9136342e81SSascha Wildner.Pp 9236342e81SSascha Wildner.Dl $ demandoc -w file.1 | spell -b 9336342e81SSascha Wildner.Sh SEE ALSO 9436342e81SSascha Wildner.Xr mandoc 1 , 95*54ba9607SSascha Wildner.Xr man 7 , 9636342e81SSascha Wildner.Xr mdoc 7 9736342e81SSascha Wildner.Sh HISTORY 9836342e81SSascha Wildner.Nm 9936342e81SSascha Wildnerreplaces the historical deroff utility for handling modern 10036342e81SSascha Wildner.Xr man 7 10136342e81SSascha Wildnerand 10236342e81SSascha Wildner.Xr mdoc 7 10336342e81SSascha Wildnerdocuments. 10436342e81SSascha Wildner.Sh AUTHORS 10536342e81SSascha WildnerThe 10636342e81SSascha Wildner.Nm 10736342e81SSascha Wildnerutility was written by 108f88b6c16SFranco Fichtner.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . 109