demandoc.1

   1 .\"     $Id: demandoc.1,v 1.1 2011/09/01 10:46:28 kristaps Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: September 1 2011 $
  18 .Dt DEMANDOC 1
  19 .Os
  20 .Sh NAME
  21 .Nm demandoc
  22 .Nd emit only text of UNIX manuals
  23 .Sh SYNOPSIS
  24 .Nm demandoc
  25 .Op Ar
  26 .Sh DESCRIPTION
  27 The
  28 .Nm
  29 utility emits only the text portions of
  30 .Xr mdoc 7
  31 and
  32 .Xr man 7
  33 .Ux
  34 manual files.
  35 Its arguments are as follows:
  36 .Bl -tag -width Ds
  37 .It Ar
  38 The input files.
  39 .El
  40 .Pp
  41 If
  42 .Ar file
  43 is not provided,
  44 .Nm
  45 accepts standard input.
  46 .Pp
  47 .Nm
  48 output preserves the line numbering and column position of its input.
  49 .Sh EXIT STATUS
  50 The
  51 .Nm
  52 utility exits with one of the following values:
  53 .Pp
  54 .Bl -tag -width Ds -compact
  55 .It 0
  56 No errors occurred.
  57 .It 6
  58 An operating system error occurred, for example memory exhaustion or an
  59 error accessing input files.
  60 Such errors cause
  61 .Nm
  62 to exit at once, possibly in the middle of parsing or formatting a file.
  63 The output databases are corrupt and should be removed .
  64 .El
  65 .Sh SEE ALSO
  66 .Xr mandoc 1 ,
  67 .Xr man 7
  68 .Xr mdoc 7
  69 .Sh AUTHORS
  70 The
  71 .Nm
  72 utility was written by
  73 .An Kristaps Dzonsons ,
  74 .Mt kristaps@bsd.lv .