1DVIPDFMX(1) General Commands Manual DVIPDFMX(1)
2
6 dvipdfmx, xdvipdfmx, dvipdfm - produce PDF files directly from DVI
7 files
8
10 dvipdfmx or dvipdfm [options] file[.dvi]
11
13 The program dvipdfmx generates a PDF file from a DVI file. DVI files
14 are the output produced by TeX. groff can also generate DVI files us‐
15 ing grodvi(-Tdvi).
16 In TeX Live, dvipdfm is another incarnation of dvipdfmx rather than a
18 separate program. Compatibility is attempted as best as possible.
19 xdvipdfmx is another incarnation. It is used as the back end for xe‐
21 tex(1) and is not intended to be invoked directly.
22 dvipdfmx recognizes several commonly used \special commands, which are
24 extensions to the DVI format. Specifically, it understands color spe‐
25 cials, papersize specials, tpic specials (which allow it to be used
26 with pic), hypertex specials, and some PostScript specials. These ex‐
27 tensions allow documents to contain color, figures, and hyperlinks.
28 The program tries to mimic the behavior of dvips where possible, so
29 that many macro packages produced for use with dvips will also work
30 with dvipdfmx. In addition, dvipdfmx understands its own specific
31 \special commands to allow access to PDF features such as annotations
32 and bookmarks.
33 As of December 2018, one such special specific to dvipdfmx is pdf:trai‐
35 lerid, which specifies the /ID in the PDF trailer. It is used like
36 this (from the TeX level):
37 \special{pdf:trailerid [ (0123456789abcdef) (01234567890abcdef) ]}
38 That is, the special takes an array (the square brackets) of two
39 16-byte PDF strings (the parentheses). This is the same syntax as Lua‐
40 TeX's \pdfvariable trailerid, while different from pdfTeX's \pdftrai‐
41 lerid. It must appear on the first output page, otherwise it is ig‐
42 nored.
43 Unrecognized specials will generate warning messages. Packages that may
45 need a dvipdfm or dvipdfmx driver option include geometry, hyperref,
46 bookmark, graphicx, and xcolor.
47 For issues related to bounding boxes (and hence image sizes), see ex‐
49 tractbb(1).
50
52 Unlike with many other programs, argument values must be separated from
53 option names by a space, not an = sign; option names cannot be abbrevi‐
54 ated; and - and -- cannot be used interchangeably.
55 -c Ignore (or accept) color \specials. By default, color \specials
57 are interpreted normally (changeable in the configuration file).
58 The -c option may be used to produce a black and white document
59 from a document containing color TeX \special commands.
60 --dvipdfm
62 Enable dvipdfm emulation mode. This is the default if the exe‐
63 cutable name is `dvipdfm'.
64 -d number
66 Specify the number of decimal digits in the PDF output; must be
67 between 0 and 5, default is 2.
68 -e Ignored, for (semi-)compatibility with dvipdfm.
70 -f map_file
72 Read the font map file given by map_file. The default map file in
73 TeX Live is pdftex.map, as defined in the configuration file.
74 --help
76 Show a help message and exit successfully.
77 -i cfgfile
79 Read cfgfile as another include file, after reading the default
80 dvipdfmx.cfg.
81 --kpathsea-debug number
83 Have Kpathsea output debugging information; `-1' for everything
84 (voluminous).
85 -l Select landscape mode. In other words, exchange the x and y di‐
87 mensions of the paper.
88 -m mag
90 Magnify the input document by mag.
91 -o filename
93 Set the PDF output file name; use `-' for stdout. By default, the
94 name of the output file is derived from the input, that is,
95 file.pdf.
96 -p paper
98 Select the papersize by name (e.g., letter, legal, ledger,
99 tabloid, a3, a4, or a5 )
100 --pdfm-str-utf8
102 Assume PDFMark strings in \special commands are encoded in UTF-8.
103 -q Quiet mode.
105 -r size
107 Set resolution of bitmapped fonts to size dots per inch.
108 Bitmapped fonts are generated by the Kpathsea library, which uses
109 Metafont. Bitmapped fonts are included as Type 3 fonts in the PDF
110 output file. Default is 600.
111 -s page_specifications
113 Select the pages of the DVI file to be processed; default is `-',
114 meaning all pages. The page_specifications consists of a comma
115 separated list of page_ranges:
116 page_specifications := page_specification[,page_specifications]
117 where
118 page_specification := single_page|page_range
119 page_range := [first_page]-[last_page]
120 An empty first_page is treated as the first page of the DVI file,
121 and an empty last_page is treated as the last page of the DVI
122 file.
123 Examples:
125 -s 1,3,5
127 includes pages 1, 3, and 5;
128 -s - includes all pages;
130 -s -,-
132 includes two copies of all pages in the DVI file; and
133 -s 1-10
135 includes the first ten pages of the DVI file.
136 -t Search for thumbnail images of each page in the directory named by
138 the TMPDIR environment variable. The thumbnail images must be
139 named in a specific format: the same base name as the DVI file and
140 the page number as the extension to the file name. dvipdfmx does
141 not generate such thumbnails itself, but it is distributed with a
142 wrapper program named dvipdft that does so.
143 --version
145 Show a help message and exit successfully.
146 -v Increase verbosity. Results of the -v option are cumulative
148 (e.g., -vv increases the verbosity by two increments). Maximum
149 verbosity is four.
150 -x x_offset
152 Set the left margin to x_offset. The default left margin is
153 1.0in. The dimension may be specified in any units understood by
154 TeX (e.g., bp, pt, in, cm).
155 -y y_offset
157 Set the top margin to y_offset. The default top margin is 1.0in.
158 The dimension may be specified in any units understood by TeX
159 (e.g., bpt, pt, in, cm).
160 -z number
162 Set the compression level to compression_level. Compression lev‐
163 els range from 0 (no compression) to 9 (maximum compression) and
164 correspond to the values understood by zlib; default is 9.
165 -C number
167 Miscellaneous option flags; see the --help output for details.
168 -D template
170 PostScript to PDF conversion command line template; the default is
171 taken from the configuration file, which also gives all the de‐
172 tails and mentions several possibilities.
173 -E Always try to embed fonts, ignoring licensing flags, etc.
175 -I number
177 Image cache life in hours; default is -2, meaning to not cache im‐
178 ages at all. A value of -1 means to erase all old images and also
179 new images; 0 means to erase all old images but leave new images.
180 -K number
182 Encryption key length; default 40.
183 -M Process MetaPost PostScript output.
185 -O number
187 Set maximum depth of open bookmark items; default 0.
188 -P number
190 Set permission flags for PDF encryption; default 0x003C.
191 -S Enable PDF encryption.
193 -V number
195 Set PDF minor version; default 5 (from the configuration file).
196
198 When including images with dvipdfmx, their bounding boxes should be
199 generated by running extractbb. The result will be in an .xbb file;
200 the xbb information is the same as for the PDF format.
201
203 dvipdfmx uses the kpathsea library for locating the files that it
204 opens. Hence, the environment variables documented in the Kpathsea li‐
205 brary documentation influence dvipdfmx. It also uses the value of the
206 environment variable TMPDIR as the directory to search for thumbnail
207 images of each page.
208
210 The precise location of the following files is determined by the Kpath‐
211 sea library configuration. The location may be determined by using
212 kpsewhich, e.g.,
213 kpsewhich -progname=dvipdfmx -format='other text files' dvipdfmx.cfg
214 dvipdfmx.cfg
216 Default configuration file
217 dvipdfmx-unsafe.cfg
219 Configuration file that runs Ghostscript without safety checks;
220 use only for trusted source files. It is currently required to use
221 PSTricks with XeTeX: xetex -output-driver="xdvipdfmx -i dvipdfmx-
222 unsafe.cfg -q -E" ...
223 pdftex.map
225 The default font map file (this may be changed in the config
226 file).
227 *.tfm
229 TeX font metrics
230 *.vf TeX virtual font files
232 *.pfb
234 PostScript Type 1 font files
235 texmf.cnf
237 The Kpathsea library configuration file. The location of this
238 file may be found by typing
239 kpsewhich texmf.cnf
240
242 dvipdft(1), extractbb(1),
243 tex(1), luatex(1), xetex(1), dvips(1),
244 groff(1), grodvi(1), pic(1), the Kpathsea library Info documentation
245 (https://tug.org/kpathsea), and the Dvipdfmx User's Manual (in the dis‐
246 tribution, and linked from https://tug.org/dvipdfmx).
247
249 Primarily Mark A. Wicks; dvipdfmx extensions primarily by Jin-Hwan Cho,
250 Shunsaku Hirata, and Matthias Franz. For the version in TeX Live,
251 please send bugs and other reports to the maintainers at dvipdfmx (at)
252 tug.org (https://lists.tug.org/dvipdfmx).
253 This man page edited for TeX Live by Bob Tennent and others. This man
255 page is public domain.
256 1 June 2021 DVIPDFMX(1)