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