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
15 using 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 In addition, xdvipdfmx is yet another incarnation. It is used as the
21 back end for xetex(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
27 extensions 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 Unrecognized specials will generate warning messages. Packages that may
35 need a dvipdfm or dvipdfmx driver option include geometry, hyperref,
36 bookmark, graphicx, and xcolor.
37 For issues related to bounding boxes (and hence image sizes), see
39 extractbb(1).
40
42 Unlike with many other programs, argument values must be separated from
43 option names by a space, not an = sign; option names cannot be abbrevi‐
44 ated; and - and -- cannot be used interchangeably.
45 -c Ignore (or accept) color \specials. By default, color \specials
47 are interpreted normally (changeable in the configuration file).
48 The -c option may be used to produce a black and white document
49 from a document containing color TeX \special commands.
50 --dvipdfm
52 Enable dvipdfm emulation mode. This is the default if the exe‐
53 cutable name is `dvipdfm'.
54 -d number
56 Specify the number of decimal digits in the PDF output; must be
57 between 0 and 5, default is 2.
58 -e Ignored, for (semi-)compatibility with dvipdfm.
60 -f map_file
62 Read the font map file given by map_file. The default map file in
63 TeX Live is pdftex.map, as defined in the configuration file.
64 --help Show a help message and exit successfully.
65 -l Select landscape mode. In other words, exchange the x and y
67 dimensions of the paper.
68 -m mag
70 Magnify the input document by mag.
71 -o filename
73 Set the PDF output file name; use `-' for stdout. By default, the
74 name of the output file is derived from the input, that is,
75 file.pdf.
76 -p paper
78 Select the papersize by name (e.g., letter, legal, ledger,
79 tabloid, a3, a4, or a5 )
80 -q Quiet mode.
82 -r size
84 Set resolution of bitmapped fonts to size dots per inch.
85 Bitmapped fonts are generated by the Kpathsea library, which uses
86 Metafont. Bitmapped fonts are included as Type 3 fonts in the PDF
87 output file. Default is 600.
88 -s page_specifications
90 Select the pages of the DVI file to be processed; default is `-',
91 meaning all pages. The page_specifications consists of a comma
92 separated list of page_ranges:
93 page_specifications := page_specification[,page_specifications]
94 where
95 page_specification := single_page|page_range
96 page_range := [first_page]-[last_page]
97 An empty first_page is treated as the first page of the DVI file,
98 and an empty last_page is treated as the last page of the DVI
99 file.
100 Examples:
102 -s 1,3,5
104 includes pages 1, 3, and 5;
105 -s - includes all pages;
107 -s -,-
109 includes two copies of all pages in the DVI file; and
110 -s 1-10
112 includes the first ten pages of the DVI file.
113 -t Search for thumbnail images of each page in the directory named by
115 the TMPDIR environment variable. The thumbnail images must be
116 named in a specific format: the same base name as the DVI file and
117 the page number as the extension to the file name. dvipdfmx does
118 not generate such thumbnails itself, but it is distributed with a
119 wrapper program named dvipdft that does so.
120 --version
122 Show a help message and exit successfully.
123 -v Increase verbosity. Results of the -v option are cumulative
125 (e.g., -vv increases the verbosity by two increments). Maximum
126 verbosity is four.
127 --kpathsea-debug number
129 Have Kpathsea output debugging information; `-1' for everything
130 (voluminous).
131 -x x_offset
133 Set the left margin to x_offset. The default left margin is
134 1.0in. The dimension may be specified in any units understood by
135 TeX (e.g., bp, pt, in, cm).
136 -y y_offset
138 Set the top margin to y_offset. The default top margin is 1.0in.
139 The dimension may be specified in any units understood by TeX
140 (e.g., bpt, pt, in, cm).
141 -z number
143 Set the compression level to compression_level. Compression lev‐
144 els range from 0 (no compression) to 9 (maximum compression) and
145 correspond to the values understood by zlib; default is 9.
146 -C number
148 Miscellaneous option flags; see the --help output for details.
149 -D template
151 PostScript to PDF conversion command line template; the default is
152 taken from the configuration file, which also gives all the
153 details and mentions several possibilities.
154 -E Always try to embed fonts, ignoring licensing flags, etc.
156 -I number
158 Image cache life in hours; default is -2, meaning to not cache
159 images at all. A value of -1 means to erase all old images and
160 also new images; 0 means to erase all old images but leave new
161 images.
162 -K number
164 Encryption key length; default 40.
165 -M Process MetaPost PostScript output.
167 -O number
169 Set maximum depth of open bookmark items; default 0.
170 -P number
172 Set permission flags for PDF encryption; default 0x003C.
173 -S Enable PDF encryption.
175 -V number
177 Set PDF minor version; default 5 (from the configuration file).
178
180 When including images with dvipdfmx, their bounding boxes should be
181 generated by running extractbb. The result will be in an .xbb file;
182 the xbb information is the same as for the PDF format.
183
185 dvipdfmx uses the kpathsea library for locating the files that it
186 opens. Hence, the environment variables documented in the Kpathsea
187 library documentation influence dvipdfmx. It also uses the value of
188 the environment variable TMPDIR as the directory to search for thumb‐
189 nail images of each page.
190
192 The precise location of the following files is determined by the Kpath‐
193 sea library configuration. The location may be determined by using
194 kpsewhich, e.g.,
195 kpsewhich -progname=dvipdfmx -format='other text files' dvipdfmx.cfg
196 dvipdfmx.cfg
198 Default configuration file
199 pdftex.map
201 The default font map file (this may be changed in the config
202 file).
203 *.tfm
205 TeX font metrics
206 *.vf TeX virtual font files
208 *.pfb
210 PostScript Type 1 font files
211 texmf.cnf
213 The Kpathsea library configuration file. The location of this
214 file may be found by typing
215 kpsewhich texmf.cnf
216
218 dvipdft(1), extractbb(1), tex(1), dvips(1), groff(1), grodvi(1),
219 pic(1), and the Kpathsea library Info documentation
220 (http://tug.org/kpathsea).
221
223 Primarily Mark A. Wicks; dvipdfmx extensions primarily by Jin-Hwan Cho,
224 Shunsaku Hirata, and Matthias Franz. For the version in TeX Live, all
225 bugs and other reports should go to the dvipdfmx maintainers at tex-k
226 (at) tug.org. This man page edited for TeX Live by Bob Tennent and
227 others.
228 7 March 2016 DVIPDFMX(1)