src/devices/gropdf/pdfmom.1.man

   1 .TH PDFMOM @MAN1EXT@ "@MDATE@" "groff @VERSION@"
   2 .SH NAME
   3 pdfmom \- produce PDF documents using the mom macro package for groff
   4 .
   5 .
   6 .\" ====================================================================
   7 .\" Legal Terms
   8 .\" ====================================================================
   9 .\"
  10 .\" Copyright (C) 2012-2018 Free Software Foundation, Inc.
  11 .\"
  12 .\" Permission is granted to make and distribute verbatim copies of this
  13 .\" manual provided the copyright notice and this permission notice are
  14 .\" preserved on all copies.
  15 .\"
  16 .\" Permission is granted to copy and distribute modified versions of
  17 .\" this manual under the conditions for verbatim copying, provided that
  18 .\" the entire resulting derived work is distributed under the terms of
  19 .\" a permission notice identical to this one.
  20 .\"
  21 .\" Permission is granted to copy and distribute translations of this
  22 .\" manual into another language, under the above conditions for
  23 .\" modified versions, except that this permission notice may be
  24 .\" included in translations approved by the Free Software Foundation
  25 .\" instead of in the original English.
  26 .
  27 .
  28 .\" ====================================================================
  29 .SH SYNOPSIS
  30 .\" ====================================================================
  31 .
  32 .SY pdfmom
  33 .OP \-Tpdf
  34 .RI [ groff-options ]
  35 .I file
  36 \&.\|.\|.\&
  37 .YS
  38 .
  39 .SY pdfmom
  40 .B \-Tps
  41 .RI [ pdfroff-options ]
  42 .RI [ groff-options ]
  43 .I file
  44 \&.\|.\|.\&
  45 .YS
  46 .
  47 .SY pdfmom
  48 .B \-v
  49 .YS
  50 .
  51 .
  52 .\" ====================================================================
  53 .SH DESCRIPTION
  54 .\" ====================================================================
  55 .
  56 .I pdfmom
  57 is a wrapper around
  58 .IR groff (@MAN1EXT@)
  59 that facilitates the production of PDF documents from files
  60 formatted with the
  61 .I mom
  62 macros.
  63 .
  64 .
  65 .P
  66 .I pdfmom
  67 prints to the standard output,
  68 so output must usually be redirected to a destination file.
  69 The size of the final PDF can be reduced by piping the output
  70 through
  71 .IR ps2pdf (1).
  72 .
  73 .
  74 .P
  75 If called with the
  76 .B \-Tpdf
  77 option (which is the default),
  78 .I pdfmom
  79 processes files using groff's native PDF driver,
  80 .IR gropdf (@MAN1EXT@).
  81 .
  82 If
  83 .B \-Tps
  84 is given, processing is passed over to
  85 .IR pdfroff ,
  86 which uses
  87 .IR groff 's
  88 PostScript driver.
  89 .
  90 In either case, multiple runs of the source file are performed in
  91 order to satisfy any forward references in the document.
  92 .
  93 .
  94 .P
  95 .I pdfmom
  96 accepts all the same options as
  97 .IR groff .
  98 If
  99 .B \-Tps
 100 is given, the options associated with
 101 .I pdfroff
 102 are accepted as well.
 103 .
 104 Please note that when
 105 .I pdfmom
 106 calls
 107 .IR pdfroff ,
 108 the
 109 .RS
 110 .B \-mpdfmark \-mom \-\-no-toc
 111 .RE
 112 options are implied and should not be given on the
 113 command line.
 114 .
 115 Equally, it is not necessary to supply the
 116 .B \-mom
 117 or
 118 .B "\-m\~mom"
 119 options when
 120 .B \-Tps
 121 is absent.
 122 .
 123 .
 124 .P
 125 PDF integration with the
 126 .I mom
 127 macros is discussed in full in the manual
 128 .IR "Producing PDFs with groff and mom" ,
 129 which was itself produced with
 130 .IR pdfmom .
 131 .
 132 .
 133 .P
 134 If called with the
 135 .B \-v
 136 option,
 137 .I pdfmom
 138 simply displays its version information and exits.
 139 .
 140 .
 141 .\" ====================================================================
 142 .SH BUGS
 143 .\" ====================================================================
 144 .
 145 .I pdfmom
 146 sometimes issues warnings of the type
 147 .RS
 148 \&.\|.\|.:
 149 can't transparently output node at top level
 150 .RE
 151 .
 152 but this is more of an annoyance than a bug, and may safely be ignored.
 153 .
 154 .
 155 .\" ====================================================================
 156 .SH AUTHORS
 157 .\" ====================================================================
 158 .
 159 .I pfdmom
 160 was written by
 161 .MT deri@\:chuzzlewit.demon.co.uk
 162 Deri James
 163 .ME
 164 and
 165 .MT peter@\:schaffter.ca
 166 Peter Schaffter
 167 .ME .
 168 .
 169 .
 170 .\" ====================================================================
 171 .SH "SEE ALSO"
 172 .\" ====================================================================
 173 .
 174 .IR "Producing PDFs with groff and mom" ,
 175 by Deri James and Peter Schaffter;
 176 a copy is installed at
 177 .IR \%@PDFDOCDIR@/\:mom\-pdf.pdf .
 178 .
 179 .
 180 .P
 181 .IR groff (@MAN1EXT@),
 182 .IR gropdf (@MAN1EXT@),
 183 .IR pdfroff (@MAN1EXT@),
 184 .IR ps2pdf (1)
 185 .
 186 .
 187 .\" Local Variables:
 188 .\" mode: nroff
 189 .\" End:
 190 .\" vim: set filetype=groff: