Debian Codegraph @

upstream/debian-trixie/man1/pdfmom.1

raw
1 .TH pdfmom 1 "3 June 2025" "groff 1.23.0"
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 (C) 2012-2020 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 [ \-Tpdf ]
57 .RI [ groff-options ]
58 .RI [ file\~ .\|.\|.]
59 .YS
60 .
61 .
62 .SY pdfmom
63 .B \-Tps
64 .RI [ pdfroff-options ]
65 .RI [ groff-options ]
66 .RI [ file\~ .\|.\|.]
67 .YS
68 .
69 .
70 .SY pdfmom
71 .B \-v
72 .
73 .SY pdfmom
74 .B \-\-version
75 .YS
76 .
77 .
78 .\" ====================================================================
79 .SH Description
80 .\" ====================================================================
81 .
82 .I pdfmom
83 is a wrapper around
84 .MR groff 1
85 that facilitates the production of PDF documents from files
86 formatted with the
87 .I mom
88 macros.
89 .
90 .
91 .P
92 .I pdfmom
93 prints to the standard output,
94 so output must usually be redirected to a destination file.
95 .
96 The size of the final PDF can be reduced by piping the output
97 through
98 .MR ps2pdf 1 .
99 .
100 .
101 .P
102 If called with the
103 .B \-Tpdf
104 option (which is the default),
105 .I pdfmom
106 processes files using
107 .IR groff 's
108 native PDF driver,
109 .MR gropdf 1 .
110 .
111 If
112 .B \-Tps
113 is given,
114 processing is passed over to
115 .IR pdfroff ,
116 which uses
117 .IR groff 's
118 PostScript driver.
119 .
120 In either case,
121 multiple runs of the source file are performed in order to satisfy any
122 forward references in the document.
123 .
124 .
125 .P
126 .I pdfmom
127 accepts all the same options as
128 .IR groff .
129 .
130 If
131 .B \-Tps
132 is given,
133 the options associated with
134 .I pdfroff
135 are accepted as well.
136 .
137 When
138 .I pdfmom
139 calls
140 .IR pdfroff ,
141 the options
142 .RB \[lq] "\-mpdfmark \-mom \-\-no\-toc" \[rq]
143 options are implied and should not be given on the command line.
144 .
145 Equally,
146 it is not necessary to supply the
147 .B \-mom
148 or
149 .B "\-m\~mom"
150 options when
151 .B \-Tps
152 is absent.
153 .
154 .
155 .P
156 PDF integration with the
157 .I mom
158 macros is discussed in full in the manual
159 \[lq]Producing PDFs with
160 .I groff
161 and
162 .IR mom \[rq],
163 which was itself produced with
164 .IR pdfmom .
165 .
166 .
167 .P
168 If called with the
169 .B \-v
170 or
171 .B \-\-version
172 options,
173 .I pdfmom
174 displays its version information and exits.
175 .
176 .
177 .\" ====================================================================
178 .SH Authors
179 .\" ====================================================================
180 .
181 .I pdfmom
182 was written by
183 .MT deri@\:chuzzlewit\:.myzen\:.co\:.uk
184 Deri James
185 .ME
186 and
187 .MT peter@\:schaffter\:.ca
188 Peter Schaffter
189 .ME ,
190 and is maintained by James.
191 .
192 .
193 .\" ====================================================================
194 .SH "See also"
195 .\" ====================================================================
196 .
197 .TP
198 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%pdf/\:mom\-pdf.pdf
199 \[lq]Producing PDFs with
200 .I groff
201 and
202 .IR mom \[rq],
203 by Deri James and Peter Schaffter.
204 .
205 This file,
206 together with its source,
207 .IR mom\-pdf.mom ,
208 is part of the
209 .I groff
210 distribution.
211 .
212 .
213 .P
214 .MR groff 1 ,
215 .MR gropdf 1 ,
216 .MR pdfroff 1 ,
217 .MR ps2pdf 1
218 .
219 .
220 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
221 .cp \n[*groff_pdfmom_1_man_C]
222 .do rr *groff_pdfmom_1_man_C
223 .
224 .
225 .\" Local Variables:
226 .\" fill-column: 72
227 .\" mode: nroff
228 .\" End:
229 .\" vim: set filetype=groff textwidth=72: