xref: /freebsd/contrib/mandoc/demandoc.1 (revision c1c95add8c80843ba15d784f95c361d795b1f593)
1*c1c95addSBrooks Davis.\" $Id: demandoc.1,v 1.9 2022/03/20 15:41:47 schwarze Exp $
261d06d6bSBaptiste Daroussin.\"
361d06d6bSBaptiste Daroussin.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
461d06d6bSBaptiste Daroussin.\"
561d06d6bSBaptiste Daroussin.\" Permission to use, copy, modify, and distribute this software for any
661d06d6bSBaptiste Daroussin.\" purpose with or without fee is hereby granted, provided that the above
761d06d6bSBaptiste Daroussin.\" copyright notice and this permission notice appear in all copies.
861d06d6bSBaptiste Daroussin.\"
961d06d6bSBaptiste Daroussin.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1061d06d6bSBaptiste Daroussin.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1161d06d6bSBaptiste Daroussin.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1261d06d6bSBaptiste Daroussin.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1361d06d6bSBaptiste Daroussin.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1461d06d6bSBaptiste Daroussin.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1561d06d6bSBaptiste Daroussin.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1661d06d6bSBaptiste Daroussin.\"
17*c1c95addSBrooks Davis.Dd $Mdocdate: March 20 2022 $
1861d06d6bSBaptiste Daroussin.Dt DEMANDOC 1
1961d06d6bSBaptiste Daroussin.Os
2061d06d6bSBaptiste Daroussin.Sh NAME
2161d06d6bSBaptiste Daroussin.Nm demandoc
2261d06d6bSBaptiste Daroussin.Nd emit only text of UNIX manuals
2361d06d6bSBaptiste Daroussin.Sh SYNOPSIS
2461d06d6bSBaptiste Daroussin.Nm demandoc
2561d06d6bSBaptiste Daroussin.Op Fl w
2661d06d6bSBaptiste Daroussin.Op Ar
2761d06d6bSBaptiste Daroussin.Sh DESCRIPTION
2861d06d6bSBaptiste DaroussinThe
2961d06d6bSBaptiste Daroussin.Nm
3061d06d6bSBaptiste Daroussinutility emits only the text portions of well-formed
3161d06d6bSBaptiste Daroussin.Xr mdoc 7
3261d06d6bSBaptiste Daroussinand
3361d06d6bSBaptiste Daroussin.Xr man 7
3461d06d6bSBaptiste Daroussin.Ux
3561d06d6bSBaptiste Daroussinmanual files.
3661d06d6bSBaptiste Daroussin.Pp
3761d06d6bSBaptiste DaroussinBy default,
3861d06d6bSBaptiste Daroussin.Nm
3961d06d6bSBaptiste Daroussinparses standard input and outputs only text nodes, preserving line
4061d06d6bSBaptiste Daroussinand column position.
4161d06d6bSBaptiste DaroussinEscape sequences are omitted from the output.
4261d06d6bSBaptiste Daroussin.Pp
4361d06d6bSBaptiste DaroussinIts arguments are as follows:
4461d06d6bSBaptiste Daroussin.Bl -tag -width Ds
4561d06d6bSBaptiste Daroussin.It Fl w
4661d06d6bSBaptiste DaroussinOutput a word list.
4761d06d6bSBaptiste DaroussinThis outputs each word of text on its own line.
4861d06d6bSBaptiste DaroussinA
4961d06d6bSBaptiste Daroussin.Qq word ,
5061d06d6bSBaptiste Daroussinin this case, refers to whitespace-delimited terms beginning with at
5161d06d6bSBaptiste Daroussinleast two letters and not consisting of any escape sequences.
5261d06d6bSBaptiste DaroussinWords have their leading and trailing punctuation
5361d06d6bSBaptiste Daroussin.Pq double-quotes, sentence punctuation, etc.
5461d06d6bSBaptiste Daroussinstripped.
5561d06d6bSBaptiste Daroussin.It Ar
5661d06d6bSBaptiste DaroussinThe input files.
5761d06d6bSBaptiste Daroussin.El
5861d06d6bSBaptiste Daroussin.Pp
5961d06d6bSBaptiste DaroussinIf a document is not well-formed, it is skipped.
6061d06d6bSBaptiste Daroussin.Pp
6161d06d6bSBaptiste DaroussinThe
6261d06d6bSBaptiste Daroussin.Fl i ,
6361d06d6bSBaptiste Daroussin.Fl k ,
6461d06d6bSBaptiste Daroussin.Fl m ,
6561d06d6bSBaptiste Daroussinand
6661d06d6bSBaptiste Daroussin.Fl p
6761d06d6bSBaptiste Daroussinflags are silently discarded for calling compatibility with the
6861d06d6bSBaptiste Daroussinhistorical deroff.
6961d06d6bSBaptiste Daroussin.Sh EXIT STATUS
7061d06d6bSBaptiste DaroussinThe
7161d06d6bSBaptiste Daroussin.Nm
7261d06d6bSBaptiste Daroussinutility exits with one of the following values:
7361d06d6bSBaptiste Daroussin.Pp
7461d06d6bSBaptiste Daroussin.Bl -tag -width Ds -compact
7561d06d6bSBaptiste Daroussin.It 0
7661d06d6bSBaptiste DaroussinNo errors occurred.
7761d06d6bSBaptiste Daroussin.It 6
7861d06d6bSBaptiste DaroussinAn operating system error occurred, for example memory exhaustion or an
7961d06d6bSBaptiste Daroussinerror accessing input files.
8061d06d6bSBaptiste DaroussinSuch errors cause
8161d06d6bSBaptiste Daroussin.Nm
8261d06d6bSBaptiste Daroussinto exit at once, possibly in the middle of parsing or formatting a file.
8361d06d6bSBaptiste Daroussin.El
8461d06d6bSBaptiste Daroussin.Sh EXAMPLES
8561d06d6bSBaptiste DaroussinThe traditional usage of
8661d06d6bSBaptiste Daroussin.Nm
8761d06d6bSBaptiste Daroussinis for spell-checking manuals on
8861d06d6bSBaptiste Daroussin.Bx .
8961d06d6bSBaptiste DaroussinThis is accomplished as follows (assuming British spelling):
9061d06d6bSBaptiste Daroussin.Pp
9161d06d6bSBaptiste Daroussin.Dl $ demandoc -w file.1 | spell -b
9261d06d6bSBaptiste Daroussin.Sh SEE ALSO
9361d06d6bSBaptiste Daroussin.Xr mandoc 1 ,
9461d06d6bSBaptiste Daroussin.Xr man 7 ,
9561d06d6bSBaptiste Daroussin.Xr mdoc 7
9661d06d6bSBaptiste Daroussin.Sh HISTORY
9761d06d6bSBaptiste Daroussin.Nm
9861d06d6bSBaptiste Daroussinreplaces the historical deroff utility for handling modern
9961d06d6bSBaptiste Daroussin.Xr man 7
10061d06d6bSBaptiste Daroussinand
10161d06d6bSBaptiste Daroussin.Xr mdoc 7
10261d06d6bSBaptiste Daroussindocuments.
10361d06d6bSBaptiste Daroussin.Sh AUTHORS
10461d06d6bSBaptiste DaroussinThe
10561d06d6bSBaptiste Daroussin.Nm
10661d06d6bSBaptiste Daroussinutility was written by
10761d06d6bSBaptiste Daroussin.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
108