1DVIPDFMX(1)                 General Commands Manual                DVIPDFMX(1)
2
3
4

NAME

6       dvipdfmx,  xdvipdfmx,  dvipdfm  -  produce  PDF files directly from DVI
7       files
8

SYNOPSIS

10       dvipdfmx or dvipdfm [options] file[.dvi]
11

DESCRIPTION

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
17       In TeX Live, dvipdfm is another incarnation of dvipdfmx rather  than  a
18       separate program.  Compatibility is attempted as best as possible.
19
20       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
23       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
34       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
44       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
48       For  issues  related to bounding boxes (and hence image sizes), see ex‐
49       tractbb(1).
50

OPTIONS

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
56       -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
61       --dvipdfm
62            Enable  dvipdfm  emulation  mode.  This is the default if the exe‐
63            cutable name is `dvipdfm'.
64
65       -d number
66            Specify the number of decimal digits in the PDF  output;  must  be
67            between 0 and 5, default is 2.
68
69       -e   Ignored, for (semi-)compatibility with dvipdfm.
70
71       -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
75       --help
76            Show a help message and exit successfully.
77
78       -i  cfgfile
79            Read cfgfile as another include file, after  reading  the  default
80            dvipdfmx.cfg.
81
82       -l   Select  landscape  mode.  In other words, exchange the x and y di‐
83            mensions of the paper.
84
85       -m  mag
86            Magnify the input document by mag.
87
88       -o  filename
89            Set the PDF output file name; use `-' for stdout.  By default, the
90            name  of  the  output  file  is  derived  from the input, that is,
91            file.pdf.
92
93       -p  paper
94            Select  the  papersize  by  name  (e.g.,  letter,  legal,  ledger,
95            tabloid, a3, a4, or a5 )
96
97       -q   Quiet mode.
98
99       -r  size
100            Set   resolution  of  bitmapped  fonts  to  size  dots  per  inch.
101            Bitmapped fonts are generated by the Kpathsea library, which  uses
102            Metafont.  Bitmapped fonts are included as Type 3 fonts in the PDF
103            output file.  Default is 600.
104
105       -s  page_specifications
106            Select the pages of the DVI file to be processed; default is  `-',
107            meaning  all  pages.   The page_specifications consists of a comma
108            separated list of page_ranges:
109            page_specifications := page_specification[,page_specifications]
110            where
111            page_specification := single_page|page_range
112            page_range := [first_page]-[last_page]
113            An empty first_page is treated as the first page of the DVI  file,
114            and  an  empty  last_page  is  treated as the last page of the DVI
115            file.
116
117            Examples:
118
119            -s 1,3,5
120                 includes pages 1, 3, and 5;
121
122            -s - includes all pages;
123
124            -s -,-
125                 includes two copies of all pages in the DVI file; and
126
127            -s 1-10
128                 includes the first ten pages of the DVI file.
129
130       -t   Search for thumbnail images of each page in the directory named by
131            the  TMPDIR  environment  variable.   The thumbnail images must be
132            named in a specific format: the same base name as the DVI file and
133            the  page number as the extension to the file name.  dvipdfmx does
134            not generate such thumbnails itself, but it is distributed with  a
135            wrapper program named dvipdft that does so.
136
137       --version
138            Show a help message and exit successfully.
139
140       -v   Increase  verbosity.   Results  of  the  -v  option are cumulative
141            (e.g., -vv increases the verbosity by  two  increments).   Maximum
142            verbosity is four.
143
144       --kpathsea-debug number
145            Have  Kpathsea  output  debugging information; `-1' for everything
146            (voluminous).
147
148       -x x_offset
149            Set the left margin to  x_offset.   The  default  left  margin  is
150            1.0in.   The dimension may be specified in any units understood by
151            TeX (e.g., bp, pt, in, cm).
152
153       -y y_offset
154            Set the top margin to y_offset.  The default top margin is  1.0in.
155            The  dimension  may  be  specified  in any units understood by TeX
156            (e.g., bpt, pt, in, cm).
157
158       -z number
159            Set the compression level to compression_level.  Compression  lev‐
160            els  range  from 0 (no compression) to 9 (maximum compression) and
161            correspond to the values understood by zlib; default is 9.
162
163       -C number
164            Miscellaneous option flags; see the --help output for details.
165
166       -D template
167            PostScript to PDF conversion command line template; the default is
168            taken  from  the  configuration file, which also gives all the de‐
169            tails and mentions several possibilities.
170
171       -E   Always try to embed fonts, ignoring licensing flags, etc.
172
173       -I number
174            Image cache life in hours; default is -2, meaning to not cache im‐
175            ages at all.  A value of -1 means to erase all old images and also
176            new images; 0 means to erase all old images but leave new images.
177
178       -K number
179            Encryption key length; default 40.
180
181       -M   Process MetaPost PostScript output.
182
183       -O number
184            Set maximum depth of open bookmark items; default 0.
185
186       -P number
187            Set permission flags for PDF encryption; default 0x003C.
188
189       -S   Enable PDF encryption.
190
191       -V number
192            Set PDF minor version; default 5 (from the configuration file).
193

IMAGE BOUNDING BOXES

195       When including images with dvipdfmx, their  bounding  boxes  should  be
196       generated  by  running  extractbb.  The result will be in an .xbb file;
197       the xbb information is the same as for the PDF format.
198

ENVIRONMENT

200       dvipdfmx uses the kpathsea library  for  locating  the  files  that  it
201       opens.  Hence, the environment variables documented in the Kpathsea li‐
202       brary documentation influence dvipdfmx.  It also uses the value of  the
203       environment  variable  TMPDIR  as the directory to search for thumbnail
204       images of each page.
205

FILES

207       The precise location of the following files is determined by the Kpath‐
208       sea  library  configuration.   The  location may be determined by using
209       kpsewhich, e.g.,
210       kpsewhich -progname=dvipdfmx -format='other text files' dvipdfmx.cfg
211
212       dvipdfmx.cfg
213            Default configuration file
214
215       dvipdfmx-unsafe.cfg
216            Configuration file that runs Ghostscript  without  safety  checks;
217            use only for trusted source files. It is currently required to use
218            PSTricks with XeTeX: xetex -output-driver="xdvipdfmx -i  dvipdfmx-
219            unsafe.cfg -q -E" ...
220
221       pdftex.map
222            The  default  font  map  file  (this  may be changed in the config
223            file).
224
225       *.tfm
226            TeX font metrics
227
228       *.vf TeX virtual font files
229
230       *.pfb
231            PostScript Type 1 font files
232
233       texmf.cnf
234            The Kpathsea library configuration file.   The  location  of  this
235            file may be found by typing
236            kpsewhich texmf.cnf
237

SEE ALSO

239       dvipdft(1), extractbb(1),
240       tex(1), luatex(1), xetex(1), dvips(1),
241       groff(1),  grodvi(1),  pic(1),  the Kpathsea library Info documentation
242       (http://tug.org/kpathsea), and the Dvipdfmx User's Manual (in the  dis‐
243       tribution).
244

AUTHOR

246       Primarily Mark A. Wicks; dvipdfmx extensions primarily by Jin-Hwan Cho,
247       Shunsaku Hirata, and Matthias Franz.  For the version in TeX Live,  all
248       bugs  and  other reports should go to the dvipdfmx maintainers at tex-k
249       (at) tug.org.  This man page edited for TeX Live  by  Bob  Tennent  and
250       others.  This man page is public domain.
251
252
253
254                                 15 March 2021                     DVIPDFMX(1)
Impressum