Debian Codegraph @

upstream/debian-unstable/man1/pdfmom.1

raw
1 .TH pdfmom 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 pdfmom \- produce PDF documents using the
4 .I mom
5 macro package for
6 .I groff
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright 2012-2023 Free Software Foundation, Inc.
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_pdfmom_1_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY pdfmom
56 .RB [ \-\-roff ]
57 .RB [ \-Tpdf ]
58 .RI [ groff-options ]
59 .RI [ file\~ .\|.\|.]
60 .YS
61 .
62 .
63 .P
64 .SY pdfmom
65 .RB [ \-\-roff ]
66 .B \-Tps
67 .RI [ pdfroff-options ]
68 .RI [ groff-options ]
69 .RI [ file\~ .\|.\|.]
70 .YS
71 .
72 .
73 .P
74 .SY pdfmom
75 .B \-v
76 .YS
77 .
78 .SY pdfmom
79 .B \%\-\-version
80 .YS
81 .
82 .
83 .\" ====================================================================
84 .SH Description
85 .\" ====================================================================
86 .
87 .I pdfmom
88 is a wrapper around
89 .MR groff 1
90 that facilitates the production of PDF documents from files
91 formatted with the
92 .I mom
93 macros.
94 .
95 .
96 .P
97 If the
98 .B \-\-roff
99 option is used,
100 the wrapper can be used with macro packages other than
101 .MR groff_mom 7 .
102 .
103 This is also true if the wrapper is renamed or linked as a
104 pseudonym;
105 for example,
106 creating a
107 .I pdfms
108 link pointing to the
109 .I pdfmom
110 executable makes a wrapper for producing PDFs with the
111 .I ms
112 package.
113 .
114 .
115 .P
116 .I pdfmom
117 prints to the standard output,
118 so output must usually be redirected to a destination file.
119 .
120 The size of the final PDF can be reduced by piping the output
121 through
122 .MR ps2pdf 1 .
123 .
124 .
125 .P
126 If called with the
127 .B \-Tpdf
128 option (which is the default),
129 .I pdfmom
130 processes files using
131 .IR groff 's
132 native PDF driver,
133 .MR gropdf 1 .
134 .
135 If
136 .B \-Tps
137 is given,
138 processing is passed over to
139 .IR pdfroff ,
140 which uses
141 .IR groff 's
142 PostScript driver.
143 .
144 In either case,
145 multiple runs of the source file are performed in order to satisfy any
146 forward references in the document.
147 .
148 .
149 .P
150 .I pdfmom
151 accepts all the same options as
152 .IR groff .
153 .
154 If
155 .B \-Tps
156 is given,
157 the options associated with
158 .I pdfroff
159 are accepted as well.
160 .
161 When
162 .I pdfmom
163 calls
164 .IR pdfroff ,
165 the options
166 .RB \[lq] "\-mpdfmark \-mom \-\-no\-toc" \[rq]
167 options are implied and should not be given on the command line.
168 .
169 Equally,
170 it is not necessary to supply the
171 .B \-mom
172 or
173 .B "\-m\~mom"
174 options when
175 .B \-Tps
176 is absent.
177 .
178 .
179 .P
180 PDF integration with the
181 .I mom
182 macros is discussed in full in the manual
183 \[lq]Producing PDFs with
184 .I groff
185 and
186 .IR mom \[rq],
187 which was itself produced with
188 .IR pdfmom .
189 .
190 .
191 .P
192 If called with the
193 .B \-v
194 or
195 .B \%\-\-version
196 options,
197 .I pdfmom
198 displays its version information and exits.
199 .
200 Using the
201 .B \-\-help
202 option displays a usage message and exits.
203 .
204 .
205 .\" ====================================================================
206 .SH Authors
207 .\" ====================================================================
208 .
209 .I pdfmom
210 was written by
211 .MT deri@\:chuzzlewit\:.myzen\:.co\:.uk
212 Deri James
213 .ME
214 and
215 .MT peter@\:schaffter\:.ca
216 Peter Schaffter
217 .ME ,
218 and is maintained by James.
219 .
220 .
221 .\" ====================================================================
222 .SH "See also"
223 .\" ====================================================================
224 .
225 .TP
226 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%pdf/\:mom\-pdf.pdf
227 \[lq]Producing PDFs with
228 .I groff
229 and
230 .IR mom \[rq],
231 by Deri James and Peter Schaffter.
232 .
233 This file,
234 together with its source,
235 .IR mom\-pdf.mom ,
236 is part of the
237 .I groff
238 distribution.
239 .
240 .
241 .P
242 .MR groff 1 ,
243 .MR gropdf 1 ,
244 .MR pdfroff 1 ,
245 .MR ps2pdf 1
246 .
247 .
248 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
249 .cp \n[*groff_pdfmom_1_man_C]
250 .do rr *groff_pdfmom_1_man_C
251 .
252 .
253 .\" Local Variables:
254 .\" fill-column: 72
255 .\" mode: nroff
256 .\" End:
257 .\" vim: set filetype=groff textwidth=72: