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

IMAGE BOUNDING BOXES

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

ENVIRONMENT

195       dvipdfmx  uses  the  kpathsea  library  for  locating the files that it
196       opens.  Hence, the environment variables  documented  in  the  Kpathsea
197       library  documentation  influence  dvipdfmx.  It also uses the value of
198       the environment variable TMPDIR as the directory to search  for  thumb‐
199       nail images of each page.
200

FILES

202       The precise location of the following files is determined by the Kpath‐
203       sea library configuration.  The location may  be  determined  by  using
204       kpsewhich, e.g.,
205       kpsewhich -progname=dvipdfmx -format='other text files' dvipdfmx.cfg
206
207       dvipdfmx.cfg
208            Default configuration file
209
210       pdftex.map
211            The  default  font  map  file  (this  may be changed in the config
212            file).
213
214       *.tfm
215            TeX font metrics
216
217       *.vf TeX virtual font files
218
219       *.pfb
220            PostScript Type 1 font files
221
222       texmf.cnf
223            The Kpathsea library configuration file.   The  location  of  this
224            file may be found by typing
225            kpsewhich texmf.cnf
226

SEE ALSO

228       dvipdft(1), extractbb(1),
229       tex(1), luatex(1), xetex(1), dvips(1),
230       groff(1),  grodvi(1),  pic(1),  the Kpathsea library Info documentation
231       (http://tug.org/kpathsea), and the Dvipdfmx User's Manual (in the  dis‐
232       tribution).
233

AUTHOR

235       Primarily Mark A. Wicks; dvipdfmx extensions primarily by Jin-Hwan Cho,
236       Shunsaku Hirata, and Matthias Franz.  For the version in TeX Live,  all
237       bugs  and  other reports should go to the dvipdfmx maintainers at tex-k
238       (at) tug.org.  This man page edited for TeX Live  by  Bob  Tennent  and
239       others.  This man page is public domain.
240
241
242
243                               24 December 2018                    DVIPDFMX(1)
Impressum