1XDVI(1) General Commands Manual XDVI(1)
2
6 xdvi - DVI Previewer for the X Window System
7
9 xdvi [+[page]] [--help] [-allowshell] [-altfont font] [-bg color]
10 [-browser WWWbrowser] [-copy] [-cr color] [-debug
11 bitmask|string[,string ...]] [-display host:display] [-dvipspath path]
12 [-editor command] [-expert] [-expertmode flag] [-fg color] [-findstring
13 string] [-text-encoding encoding] [-font font] [-fullscreen ] [-gamma
14 g] [-geometry geometry] [-gsalpha] [-gspalette palette] [-h] [-help]
15 [-hl color] [-anchorposition anchor] [-hush] [-hushchars]
16 [-hushchecksums] [-warnpecials] [-hushstdout] [-hushbell]
17 [-icongeometry geometry] [-iconic] [-install] [-interpreter path]
18 [-keep] [-l] [-license] [-linkcolor color] [-linkstyle 0|1|2|3]
19 [-margins dimen] [-mfmode mode-def[:dpi]] [-mgs[n] size] [-mousemode
20 0|1|2] [-nocolor] [-nofork] [-noghostscript] [-nogrey] [-nogssafer]
21 [-noinstall] [-nomakepk] [-nomatchinverted] [-noomega] [-noscan]
22 [-not1lib] [-notempfile] [-offsets dimen] [-p pixels] [-paper
23 papertype] [-pause] [-pausespecial special-string] [-postscript flag]
24 [-rulecolor color] [-rv] [-S density] [-s shrink] [-safer] [-sidemargin
25 dimen] [-sourceposition line[:col][ ]filename] [-statusline]
26 [-thorough] [-topmargin dimen] [-unique] [-version] [-visitedlinkcolor
27 color] [-warnspecials] [-watchfile secs] [-wheelunit pixels] [-xoffset
28 dimen] [-yoffset dimen] [dvi_file]
29
31 Xdvi is a program for previewing dvi files, as produced e.g. by the
32 tex(1) program, under the X window system.
33 Xdvi can show the file shrunken by various integer factors, and it has
35 a ``magnifying glass'' for viewing parts of the page enlarged (see the
36 section MAGNIFIER below). This version of xdvi is also referred to as
37 xdvik since it uses the kpathsea library to locate and generate font
38 files. In addition to that, it supports the following features:
39 - hyperlinks in DVI files (section HYPERLINKS),
41 - direct rendering of Postscript<tm> Type1 fonts (section T1LIB),
43 - source specials in the DVI file (section SOURCE SPECIALS),
45 - string search in DVI files (section STRING SEARCH),
47 - saving or printing (parts of) the DVI file (sections PRINT DIALOG
49 and SAVE DIALOG).
50 Xdvi can be compiled with the Motif toolkit or the Xaw (Athena) toolkit
52 (and variants of it), and the Motif version has a slightly different
53 GUI; these differences are noted below.
54 Before displaying a page of a DVI file, xdvi will check to see if the
56 file has changed since the last time it was displayed. If this is the
57 case, it will reload the file. This feature allows you to preview many
58 versions of the same file while running xdvi only once. Since it cannot
59 read partial DVI files, xdvik versions starting from 22.74.3 will cre‐
60 ate a temporary copy of the DVI file being viewed, to ensure that the
61 file can be viewed without interruptions. (The -notempfile can be used
62 to turn off this feature).
63 Xdvi can show PostScript<tm> specials by any of three methods. It will
65 try first to use Display PostScript<tm>, then NeWS, then it will try to
66 use Ghostscript to render the images. All of these options depend on
67 additional software to work properly; moreover, some of them may not be
68 compiled into this copy of xdvi.
69 For performance reasons, xdvi does not render PostScript specials in
71 the magnifying glass.
72 If no file name has been specified on the command line, xdvi will try
74 to open the most recently opened file; if the file history (accessible
75 via the File > Open Recent menu) is empty, or if none of the files in
76 the history are valid DVI files, it will pop up a file selector for
77 choosing a file name. (In previous versions, which didn't have a file
78 history, the file selector was always used; you can set the X resource
79 noFileArgUseHistory to false to get back the old behaviour.)
80
82 In addition to specifying the dvi file (with or without the .dvi exten‐
83 sion), xdvi supports the following command line options. If the option
84 begins with a `+' instead of a `-', the option is restored to its de‐
85 fault value. By default, these options can be set via the resource
86 names given in parentheses in the description of each option.
87 +page Specifies the first page to show. If + is given without a num‐
89 ber, the last page is assumed; the first page is the default.
90 -allowshell
92 (.allowShell) This option enables the shell escape in PostScript
93 specials. (For security reasons, shell escapes are disabled by
94 default.) This option should be rarely used; in particular it
95 should not be used just to uncompress files: that function is
96 done automatically if the file name ends in .Z, .gz, or .bz2.
97 Shell escapes are always turned off if the -safer option is
98 used.
99 -altfont font
101 (.altFont) Declares a default font to use when the font in the
102 dvi file cannot be found. This is useful, for example, with
103 PostScript <tm> fonts.
104 -background color
106 (.background) Determines the color of the background. Same as
107 -bg.
108 -bg color
110 (.background) Determines the color of the background.
111 -browser browser
113 (.wwwBrowser) Defines the web browser used for handling external
114 URLs. The value of this option or resource has the same syntax
115 as the BROWSER environment variable; see the explanation of that
116 variable in the section `ENVIRONMENT' below for a detailed de‐
117 scription. If neither the option nor the X resource wwwBrowser
118 is specified, the environment variables BROWSER and WWWBROWSER
119 (in that order) are used to determine the browser command. If
120 these are not set either, the following default value is used:
121 xdg-open %s:htmlview %s:firefox -remote -remote "openURL(%s,new-
122 window)":mozilla -remote "openURL(%s,new-window)":netscape
123 -raise -remote "openURL(%s,new-window)":xterm -e w3m %s:xterm -e
124 lynx %s:xterm -e wget %s
125 -copy (.copy) Always use the copy operation when writing characters to
127 the display. This option may be necessary for correct operation
128 on a color display, but overstrike characters will be incorrect.
129 If greyscale anti-aliasing is in use, the -copy operation will
130 disable the use of colorplanes and make overstrikes come out in‐
131 correctly. See also -thorough.
132 -cr color
134 (.cursorColor) Determines the color of the mouse cursor. The
135 default is the same as the foreground color.
136 -debug bitmask|string[,string ...]
138 (.debugLevel) If nonzero, prints additional information on stan‐
139 dard output. The argument can be either a bitmask specified as
140 a decimal number, or comma-separated list of strings.
141 For the bitmask representation, multiple values can be specified
142 by adding the numbers that represent the individual bits; e.g.
143 to debug all all file searching and opening commands, use 4032
144 (= 2048 + 1024 + 512 + 256 + 128 + 64). Use -1 to turn on debug‐
145 ging of everything (this will produce huge output).
146 For the string representation, use the strings listed in the
147 following table, with a comma to separate the values; e.g. to
148 debug all file searching and opening commands, use search,ex‐
149 pand,paths,hash,stat,open. (The option `kpathsea' is provided
150 as a shorthand for these.) Note that such a list may need to be
151 quoted to prevent the shell from interpreting commas or spaces
152 in the list.
153 The individual numbers and strings have the following meanings:
154 1 bitmap Bitmap creation
156 2 dvi DVI translation
157 4 pk PK fonts
158 8 batch Batch mode: Exit after
159 reading the DVI file
160 16 event Event handling
161 32 ps PostScript interpreter calls
162 64 stat Kpathsea stat(2) calls
163 128 hash Kpathsea hash table lookups
164 256 open Kpathsea file opening
165 512 paths Kpathsea path definitions
166 1024 expand Kpathsea path expansion
167 2048 search Kpathsea searching
168 4032 kpathsea All Kpathsea options
169 4096 htex Hypertex specials
170 8192 src Source specials
171 16384 client Client/server mode (see -unique
172 and -sourceposition options)
173 32768 t1 Type1 font library messages
174 65536 t1_verbose Verbose Type1 library messages
175 131072 gui GUI elements
176 Some of the Kpathsea debugging options are actually provided by
178 Kpathsea; see the Debugging section in the Kpathsea manual for
179 more information on these.
180 -density density
182 (.densityPercent) Determines the density used when shrinking
183 bitmaps for fonts. A higher value produces a lighter font. The
184 default value is 40. If greyscaling is in use, this argument
185 does not apply; use -gamma instead. See also the `S' keystroke.
186 Same as -S.
187 -display host:display
189 Specifies the host and screen to be used for displaying the dvi
190 file. By default this is obtained from the environment variable
191 DISPLAY.
192 -dvipspath path
194 (.dvipsPath) Use path as the dvips program to use when printing.
195 The default for this is dvips. The program or script should
196 read the DVI file from standard input, and write the Postscript
197 file to standard output.
198 -editor editor
200 (.editor) Specifies the editor that will be invoked when the
201 source-special() action is triggered to start a reverse search
202 (by default via Ctrl-Mouse 1). The argument to this option is a
203 format string in which occurrences of ``%f'' are replaced by the
204 file name, occurrences of ``%l'' are replaced by the line number
205 within the file, and optional occurrences of ``%c'' are replaced
206 by the column number within the line.
207 If neither the option nor the X resource .editor is specified,
209 the following environment variables are checked to determine the
210 editor command: XEDITOR, VISUAL, and EDITOR (in this sequence).
211 If the string is found as the value of the VISUAL or EDITOR en‐
212 vironment variables, then ``xterm -e '' is prepended to the
213 string; if the editor is specified by other means, then it must
214 be in the form of a shell command to pop up an X window with an
215 editor in it. If none of these variables is set, a warning mes‐
216 sage is displayed and the command ``xterm -e vi +%l %f'' is
217 used.
218 If no ``%f'' or ``%l'' occurs in the string, the missing format
220 strings are appended automatically. (This is for compatibility
221 with other programs when using one of the environment vari‐
222 ables).
223 A new instance of the editor is started each time this command
225 is used; therefore it is preferable to use an editor that can be
226 invoked in `client' mode to load new files into the same in‐
227 stance. Example settings are:
228 emacsclient --no-wait
230 (older Emacsen)
231 gnuclient -q
233 (XEmacs and newer Emacsen)
234 gvim --servername xdvi --remote
236 (VIM v6.0+; the `--servername xdvi' option will cause
237 gvim to run a dedicated instance for the files opened by
238 xdvi.)
239 nc (nedit)
241 Note that those strings need to be enclosed into quotes when us‐
243 ing them on the command-line to protect them from the shell;
244 when using them as argument for the .editor resource in an X re‐
245 source file, no quotes should be used.
246 NOTE ON SECURITY: The argument of this option isn't executed as
248 a shell command, but via exec() to prevent evil tricks with the
249 contents of source specials.
250 -expert
252 This option is only supported for backwards compatibility; it is
253 equivalent to -expertmode 0, which should be preferred.
254 -expertmode flag
256 (.expertMode) With an argument of 0, this option switches off
257 the display of the buttons, scrollbars, the toolbar (Motif on‐
258 ly), the statusline and the page list. These GUI elements can
259 also be (de)activated separately, by combining the appropriate
260 values in the flag argument. This acts similar to the -debug op‐
261 tion: The integer flag is treated as a bitmap where each bit
262 represents one element. If the bit has the value 1, the element
263 is switched on, if it has the value 0, the element is switched
264 off. The meaning of the bits is as follows:
265 1 statusline
267 2 scrollbars
268 4 Motif: pagelist, Xaw: buttons and pagelist
269 8 toolbar (Motif only)
270 16 menubar (Motif only)
271 For example, to turn on only the statusline and the scrollbars,
273 use 3 (= 1 + 2). See also the `x' keystroke, where the bits are
274 addressed by their positions, from 1 to 3 (Xaw) or 5 (Motif),
275 respectively.
276 If the statusline is not active, all messages that would normally be
278 printed to the statusline will be printed to stdout, unless the -hush‐
279 stdout option is used.
280 -fg color
282 (.foreground) Determines the color of the text (foreground).
283 -text-encoding encoding
285 (.textEncoding) Use encoding as text encoding of the string in
286 the "Find" window. Usually, this shouldn't be needed since the
287 encoding is determined from the locale settings.
288 -findstring string
290 This option triggers a search for string in the DVI file men‐
291 tioned on the command-line, similar to forward search (see the
292 description of the sourceposition option): If there is already
293 another instance of xdvi running on the displaying that DVI
294 file, it will cause that instance to perform the search instead.
295 The search starts at the top of the current page of the DVI
296 file.
297 -font font
299 (*font) Sets the font used in menus, buttons etc., as described
300 in the X(7x) man page. The font for child windows can be set
301 separately, e.g.:
302 xdvi*statusline*font: \
304 -*-helvetica-medium-r-*-*-12-*-*-*-*-*-*-*
305 -foreground color
308 Same as -fg.
309 -fullscreen
311 When this option is used, xdvi will (try to) run in fullscreen
312 mode, with no window decorations. This option is not guaranteed
313 to work with all windowmanagers/desktops; if you're experiencing
314 problems with it, please use the -geometry option instead, and a
315 suitable window manager setting to remove the window decora‐
316 tions. When using this option for presentations, you might want
317 to get rid of all the control widgets as well, using the -ex‐
318 pertmode option. This option can also be toggled at runtime us‐
319 ing the fullscreen action (by default bound to Ctrl-l).
320 -gamma gamma
322 (.gamma) Controls the interpolation of colors in the greyscale
323 anti-aliasing color palette. Default value is 1.0. For 0 <
324 gamma < 1, the fonts will be lighter (more like the background),
325 and for gamma > 1, the fonts will be darker (more like the fore‐
326 ground). Negative values behave the same way, but use a slight‐
327 ly different algorithm. For color and grayscale displays; for
328 monochrome, see -density. See also the `S' keystroke.
329 -geometry geometry
331 (.geometry) Specifies the initial geometry of the main window,
332 as described in the X(7x) man page. The geometry of child win‐
333 dows can be set separately, e.g.:
334 xdvi*helpwindow.geometry: 600x800
335 -gsalpha
337 (.gsAlpha) Causes Ghostscript to be called with the x11alpha
338 driver instead of the x11 driver. The x11alpha driver enables
339 anti-aliasing in PostScript specials, for a nicer appearance.
340 It is available on newer versions of Ghostscript. This option
341 can also be toggled with the `V' keystroke.
342 -gspalette palette
344 (.palette) Specifies the palette to be used when using Ghost‐
345 script for rendering PostScript specials. Possible values are
346 Color, Greyscale, and Monochrome. The default is Color.
347 -h, -help, --help
349 Prints a short help text with an overview of the command-line
350 options to standard output.
351 -hl color
353 (.highlight) Determines the color of the page border, of the
354 ruler in `ruler mode', and of the highlighting markers in for‐
355 ward search and string search. The default is the foreground
356 color.
357 -anchorposition anchor
359 Jump to anchor after opening the DVI file. This is only useful
360 when invoking xdvi from other applications.
361 -hush (.Hush) Causes xdvi to suppress all suppressible warnings.
363 -hushchars
365 (.hushLostChars) Causes xdvi to suppress warnings about refer‐
366 ences to characters which are not defined in the font.
367 -hushchecksums
369 (.hushChecksums) Causes xdvi to suppress warnings about checksum
370 mismatches between the dvi file and the font file.
371 -hushstdout
373 (.hushStdout) Suppresses printing of status messages to stdout.
374 Note that errors or warnings will still be printed to stderr
375 even if this option is used.
376 -hushbell
378 (.hushBell) Don't sound the X bell when an error occurs.
379 -icongeometry geometry
381 (.iconGeometry) Specifies the initial position for the icon.
382 -iconic
384 (.iconic) Causes the xdvi window to start in the iconic state.
385 The default is to start with the window open.
386 -install
388 (.install) If xdvi is running under a PseudoColor visual, then
389 (by default) it will check for TrueColor visuals with more bits
390 per pixel, and switch to such a visual if one exists. If no
391 such visual exists, it will use the current visual and colormap.
392 If -install is selected, however, it will still use a TrueColor
393 visual with a greater depth, if one is available; otherwise, it
394 will install its own colormap on the current visual. If the
395 current visual is not PseudoColor, then xdvi will not switch the
396 visual or colormap, regardless of its options. The default val‐
397 ue of the install resource is the special value, maybe. There
398 is no +install option. See also -noinstall, and the GREYSCALING
399 AND COLORMAPS section.
400 -interpreter filename
402 (.interpreter) Use filename as the Ghostscript interpreter. By
403 default it uses gs.
404 -keep (.keepPosition) Sets a flag to indicate that xdvi should not
406 move to the home position when moving to a new page. See also
407 the `k' keystroke. This flag is honored by all page switching
408 actions and by up-or-previous() / down-or-next(), although the
409 latter only honor the horizontal postion, not the vertical one.
410 This allows for a "continuous" scrolling back an forth through a
411 document with a display window narrower than a page width.
412 -l (.listFonts) List the names of all fonts used.
414 -license
416 Prints licensing information.
417 -linkcolor
419 (.linkColor) Color used for unvisited hyperlinks (`Blue2' by de‐
420 fault). Hyperlinks are unvisited before you click on them, or
421 after the DVI file has been reloaded. The value should be ei‐
422 ther a valid X color name (such as DarkGoldenrod4) or a hexadec‐
423 imal color string (such as #8b6508). See also -visitedlinkcolor
424 and -linkstyle.
425 -linkstyle
427 (.LinkStyle) Determines the style in which hyperlinks are dis‐
428 played. Possible values and their meanings are:
429 0 No highlighting of links
431 1 Underline links with link color
432 2 No underlining, color text with link color
433 3 Underline and display text colored with
434 link color
435 The values for link color are specified by the options/resources
437 -linkcolor and -visitedlinkcolor (which see).
438 -margins dimen
440 (.Margin) Specifies the size of both the top margin and side
441 margin. This determines the ``home'' position of the page with‐
442 in the window as follows. If the entire page fits in the win‐
443 dow, then the margin settings are ignored. If, even after re‐
444 moving the margins from the left, right, top, and bottom, the
445 page still cannot fit in the window, then the page is put in the
446 window such that the top and left margins are hidden, and pre‐
447 sumably the upper left-hand corner of the text on the page will
448 be in the upper left-hand corner of the window. Otherwise, the
449 text is centered in the window. The dimension should be a deci‐
450 mal number optionally followed by any of the two-letter abbrevi‐
451 ations for units accepted by TeX (pt, pc, in, bp, cm, mm, dd,
452 cc, or sp). By default, the unit will be cm (centimeters). See
453 also -sidemargin, -topmargin, and the keystroke `M.'
454 -mfmode mode-def
456 (.mfMode) Specifies a mode-def string, which can be used in
457 searching for fonts (see ENVIRONMENT, below). Generally, when
458 changing the mode-def, it is also necessary to change the font
459 size to the appropriate value for that mode. This is done by
460 adding a colon and the value in dots per inch; for example, -mf‐
461 mode ljfour:600. This method overrides any value given by the
462 pixelsPerInch resource or the -p command-line argument. The
463 metafont mode is also passed to metafont during automatic cre‐
464 ation of fonts. By default, it is unspecified.
465 -mgs size
467 Same as -mgs1.
468 -mgs[n] size
470 (.magnifierSize[n]) Specifies the size of the window to be used
471 for the ``magnifying glass'' for Button n. The size may be giv‐
472 en as an integer (indicating that the magnifying glass is to be
473 square), or it may be given in the form widthxheight. See the
474 MOUSE ACTIONS section. Defaults are 200x150, 400x250, 700x500,
475 1000x800, and 1200x1200.
476 -mousemode [0|1|2]
478 (.mouseMode) Specifies the default mode of xdvi at startup: Mag‐
479 nifier (0), Text Selection Mode (1) or Ruler Mode (2). See the
480 section MODES, below, for more information.
481 -nocolor
483 (.color) Turns off the use of color specials. This option can
484 be toggled with the `C' keystroke. (Note: -nocolor corresponds
485 to color:off; +nocolor to color:on.)
486 -nofork
488 (.fork) With the -sourceposition and -unique options, the de‐
489 fault behavior is for xdvi to put itself into the background
490 (like a daemon) if there is no appropriate instance of xdvi al‐
491 ready running. This argument makes it run in the foreground in‐
492 stead. This is useful for debugging, or if your client applica‐
493 tion cannot deal well with a program self-backgrounding itself
494 in this way -- e.g., the IPC functions in emacs are known to
495 have problems with this. If no -sourceposition or -unique argu‐
496 ment is given, then this option has no effect. (Note: -nofork
497 corresponds to fork:off; +nofork to fork:on.)
498 -noghostscript
500 (.ghostscript) Inhibits the use of Ghostscript for displaying
501 PostScript<tm> specials. (Note: -noghostscript corresponds to
502 ghostscript:off; +noghostscript to ghostscript:on.)
503 -nogrey
505 (.grey) Turns off the use of greyscale anti-aliasing when print‐
506 ing shrunken bitmaps. (Note: -nogrey corresponds to grey:off;
507 +nogrey to grey:on.) See also the `G' keystroke.
508 -nogssafer
510 (.gsSafer) Normally, if Ghostscript is used to render PostScript
511 specials, the Ghostscript interpreter is run with the option
512 -dSAFER. The -nogssafer option runs Ghostscript without
513 -dSAFER. The -dSAFER option in Ghostscript disables PostScript
514 operators such as deletefile, to prevent possibly malicious
515 PostScript programs from having any effect. If the -safer op‐
516 tion is specified, then this option has no effect; in that case
517 Ghostscript is always run with -dSAFER. (Note: -nogssafer cor‐
518 responds to gsSafer:off; +nogssafer to gsSafer:on.)
519 -noinstall
521 (.install) Inhibit the default behavior of switching to a True‐
522 Color visual if one is available with more bits per pixel than
523 the current visual. (Note: -noinstall corresponds install:off;
524 there is no +noinstall option.) See also -install, and the
525 GREYSCALING AND COLORMAPS section.
526 -nomakepk
528 (.makePk) Turns off automatic generation of font files that can‐
529 not be found by other means. (Note: -nomakepk corresponds to
530 makePk:off; +nomakepk to makePK:on.)
531 -nomatchinverted
533 (.matchInverted) Don't highlight string search matches in in‐
534 verted color; instead, draw a rectangle in highlight color (see
535 the -hl option) around the match. This option is activated auto‐
536 matically if the display isn't running in TrueColor. (Note:
537 -nomatchinverted corresponds to matchInverted:off; +nomatchin‐
538 verted to matchInverted:on.)
539 -noomega
541 (.omega) This will disable the use of Omega extensions when in‐
542 terpreting DVI files. By default, the additional opcodes 129
543 and 134 are recognized by xdvi as Omega extensions and inter‐
544 preted as requests to set 2-byte characters. The only drawback
545 is that the virtual font array will require 65536 positions in‐
546 stead of the default 256 positions, i.e. the memory requirements
547 of xdvi will be slightly larger. If you find this unacceptable
548 or encounter another problem with the Omega extensions, you can
549 switch this extension off by using -noomega (but please do send
550 a bug report if you find such problems - see the bug address in
551 the AUTHORS section below).
552 (Note: -noomega corresponds to omega: off; +noomega to omega:
553 on.)
554 -noscan
556 (.prescan) By default, xdvi does a preliminary scan of the dvi
557 file to process any papersize specials; this is especially im‐
558 portant at startup since the paper size may be needed to deter‐
559 mine the window size. If PostScript<tm> is in use, then pres‐
560 canning is also necessary in order to properly process header
561 files. In addition, prescanning is needed to correctly deter‐
562 mine the background color of a page. This option turns off such
563 prescanning. (Prescanning will be automatically be turned back
564 on if xdvi detects any of the specials mentioned above.) (Note:
565 -noscan corresponds to prescan:off; +noscan to prescan:on.)
566 -not1lib
568 (.t1lib) This will disable the use of T1Lib to display Post‐
569 Script<tm> fonts. Use this option as a workaround when you en‐
570 counter problems with the display of T1Lib (but please don't
571 forget to send a bug report in this case, to the URL mentioned
572 in the section AUTHORS below).
573 (Note: -not1lib corresponds to t1lib:off; +not1lib to t1lib:on.)
574 -notempfile
576 (.tempFile) As mentioned in the section DESCRIPTION above, xdvi
577 will create a temporary copy of the DVI file so that it can be
578 accessed without interruptions even while the file is being
579 rewritten by TeX. Since this introduces the overhead of copying
580 the file every time it has changed, the -notempfile allows you
581 to turn off this behaviour. In this case, exposing parts of the
582 window while the DVI file is being written by TeX will erase the
583 current window contents until the DVI file can be completely
584 reread.
585 (Note: -notempfile corresponds to tempFile:off; +notempfile to
586 tempFile:on.)
587 -offsets dimen
589 (.Offset) Specifies the size of both the horizontal and vertical
590 offsets of the output on the page. By decree of the Stanford
591 TeX Project, the default TeX page origin is always 1 inch over
592 and down from the top-left page corner, even when non-American
593 paper sizes are used. Therefore, the default offsets are 1.0
594 inch. The argument dimen should be a decimal number optionally
595 followed by any of the two-letter abbreviations for units ac‐
596 cepted by TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). By de‐
597 fault, the unit will be cm (centimeters). See also -xoffset and
598 -yoffset.
599 -p pixels
601 (.pixelsPerInch) Defines the size of the fonts to use, in pixels
602 per inch. The default value is 600. This option is provided
603 only for backwards compatibility; the preferred way is to set
604 both the resolution and the Metafont mode via the -mfmode option
605 (which see).
606 -paper papertype
608 (.paper) Specifies the size of the printed page. Note that in
609 most cases it's best to specify the paper size in the TeX input
610 file via the line
611 \usepackage[dvips]{geometry}
613 which will be recognized by both dvips and xdvi; in that case
615 the use of a `-paper' option should be unnecessary.
616 The paper size may be specified in the form widthxheight option‐
617 ally followed by a unit, where width and height are decimal num‐
618 bers giving the width and height of the paper, respectively, and
619 the unit is any of the two-letter abbreviations for units ac‐
620 cepted by TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). By de‐
621 fault, the unit is cm (centimeters).
622 There are also synonyms which may be used: us (8.5x11in), legal
623 (8.5x14in), foolscap (13.5x17in), as well as the ISO sizes
624 a1-a7, b1-b7, c1-c7. Each of these also has a landscape or `ro‐
625 tated' variant: usr (11x8.5in), a1r-a7r, etc. For compatibility
626 with dvips, the formats letter (8.5x11in), ledger (17x11in) and
627 tabloid (11x17in) are also supported (these don't have rotated
628 variants).
629 Any of the above sizes may be preceded by a plus sign (`+');
630 this causes the paper size given here to override any paper size
631 given in the dvi file. The default paper size is 21 x 29.7 cm
632 (A4 size).
633 -pause (.pause) This option provides a simple implementation of incre‐
635 mental (stepwise) display, which can be used for presentations.
636 When this option is used, xdvi will pause the display of the
637 current page whenever it encounters a special special-string
638 (xdvi:pause by default; the string can be customized via -paus‐
639 especial, see below), and the cursor will change its shape. The
640 action unpause-or-next() (by default bound to the Space key)
641 will display the next portion of the page up to the following
642 special-string, or until the end of the page is reached. When
643 the option is not used, specials containing special-string will
644 be ignored.
645 -pausespecial special-string
647 (.pauseSpecial) Sets the special string that causes xdvi to
648 pause when the -pause option is active. The default value of
649 special-string is xdvi:pause.
650 -postscript flag
652 (.postscript) If flag = 0, rendering of PostScript<tm> specials
653 is disabled; instead, bounding boxes will be displayed (if
654 available). A value of 1 (the default) switches PostScript<tm>
655 specials on. With a value of 2, the PostScript<tm> specials are
656 displayed along with their bounding boxes; this allows you to
657 visually check the correctness of the bounding boxes. The values
658 can also be toggled at runtime with the `v' keystroke and the
659 corresponding numerical prefix arguments 0, 1 and 2.
660 -ps2pdfpath path
662 (.ps2pdfPath) Use path as a conversion program from Postscript
663 to PDF. The program or script should accept two command-line ar‐
664 guments: The Postscript file as first argument, and the PDF out‐
665 put file as second argument.
666 -rulecolor color
668 (.ruleColor) Determines the color of the rules used for the the
669 magnifier (default: foreground color).
670 -q (.noInitFile) Ignore the $HOME/.xdvirc startup file (i.e. don't
672 read it at startup, and don't write it at exit). This forces the
673 defaults defined in $HOME/.Xdefaults to be used. See FILES for
674 more information on $HOME/.xdvirc.
675 -rv (.reverseVideo) Causes the page to be displayed with white char‐
677 acters on a black background, instead of vice versa.
678 -S density
680 (.densityPercent) Same as -density (which see).
681 -s shrink
683 (.shrinkFactor) Defines the initial shrink factor. The default
684 value is 8. If shrink is given as 0, then the initial shrink
685 factor is computed so that the page fits within the window (as
686 if the `s' keystroke were given without a number).
687 -safer (.safer) This option turns on all available security options; it
689 is designed for use when xdvi is called by a browser that ob‐
690 tains a dvi or TeX file from another site. This option selects
691 +nogssafer and +allowshell.
692 -sidemargin dimen
694 (.sideMargin) Specifies the side margin (see -margins).
695 -sourceposition line[:col][ ]filename
697 This option makes xdvi search in the dvi file for the place cor‐
698 responding to the indicated line (and, optionally, column) in
699 the .tex source file, and highlight the place found by drawing a
700 rectangle in the highlight color (see the -hl option) around the
701 corresponding text. In addition, when run with this argument
702 (and the -nofork option is not given, which see), xdvi will al‐
703 ways return immediately: if it finds another instance of xdvi
704 already showing dvi_file, then it will cause that instance to
705 raise its window and move to the given place in the dvi file;
706 otherwise it will start up its own instance in the background.
707 If several instances of xdvi are displaying the respective dvi
708 file, the instance which was last raised to the foreground will
709 be used.
710 The space before filename is only needed if the filename starts
712 with a digit. When the space is used, the argument needs to be
713 enclosed in quotes to prevent the shell from misinterpreting the
714 space as argument separator.
715 This option requires that dvi_file be prepared with source spe‐
717 cial information. See the section on SOURCE SPECIALS for de‐
718 tails on how to do this.
719 Here is a more detailed description of how the filename in the
721 -sourceposition argument is matched with the filename in the
722 source specials:
723 1. If neither of the filenames contains a path name component,
725 the filenames are compared ignoring the `.tex' extensions in
726 both filenames.
727 2. Otherwise, if one of the filenames does contain a path compo‐
729 nent (e.g.: ./test.tex, ../test.tex, /my/homedir/tex/test.tex
730 or any combination of these), both filenames are expanded to
731 a full path, with any occurrences of ../ and ./ expanded, and
732 multiple slashes removed.
733 The pathname in the -sourceposition is expanded relative to
734 the current working directory of the xdvi -sourceposition in‐
735 vocation, and the pathnames in the source specials are ex‐
736 panded relative to the path of the current DVI file being
737 viewed.
738 The path names are then compared ignoring the `.tex' exten‐
739 sions in both path names.
740 -statusline
742 (.statusline) This option is obsolete; use -expertmode flag in‐
743 stead (which see).
744 -thorough
746 (.thorough) Xdvi will usually try to ensure that overstrike
747 characters (e.g., \notin) are printed correctly. On monochrome
748 displays, this is always possible with one logical operation,
749 either and or or. On color displays, however, this may take two
750 operations, one to set the appropriate bits and one to clear
751 other bits. If this is the case, then by default xdvi will in‐
752 stead use the copy operation, which does not handle overstriking
753 correctly. The -thorough option chooses the slower but more
754 correct choice. See also -copy.
755 -topmargin dimen
757 (.topMargin) Specifies the top and bottom margins (see -mar‐
758 gins).
759 -unique
761 (.unique) This option will make another instance of xdvi running
762 on the same display act as a `server'. For example, the invoca‐
763 tion
764 xdvi -unique +5 file.dvi
766 will cause this other instance to load file.dvi on page 5 in
768 place of the file that it is currently displaying. If there is
769 already another instance of xdvi already displaying the file
770 file.dvi, then it will just jump to page 5. If the other in‐
771 stance of xdvi is displaying a different file, it will load
772 file.dvi instead. Otherwise, if no other instance of xdvi is
773 currently running on the display, this option instead starts a
774 new instance of xdvi in the background (unless the -nofork op‐
775 tion is specified, which see) displaying page 5 of file.dvi.
776 The filename and the +n option for the page number are the only
777 options available for controlling a remote instance of xdvi like
778 this; all other options are currently ignored.
779 -useTeXpages
781 Use logical TeX pages (the values of the \count0 register) in‐
782 stead of physical pages for the pagelist labels and when jumping
783 to a page in a document with the `g' keystroke (or the goto-
784 page() action). This option can be toggled via the `T' key‐
785 stroke.
786 -version
788 Print information on the version of xdvi.
789 -visitedlinkcolor
791 (.visitedLinkColor) Color used for visited hyperlinks (`Purple4'
792 by default). Hyperlinks become visited once you click on them.
793 As for linkColor, the value should be either a valid X color
794 name or a hexadecimal color string.
795 -warnspecials
797 (.warnSpecials) Causes xdvi to print warnings about \special
798 strings that it cannot process to stderr. These warnings are
799 suppressed by default.
800 -watchfile n
802 (.watchFile) If this option is set to a value larger than 0, xd‐
803 vi will check the DVI file for changes every n seconds. If the
804 DVI file has been completely written by TeX, it will be reloaded
805 automatically. Fractional values (e.g. `2.5') are possible. The
806 default for this option is 0, i.e. no watching.
807 Since xdvi cannot handle partial DVI files, it tries not to
808 reload the file while it is being rewritten. However, use of
809 the magnifier or switching of pages requires reading (a part of)
810 the DVI file, and if the tempfile option is switched off, this
811 will erase the current contents of the window until the DVI file
812 can be read entirely.
813 -wheelunit pixels
815 (.wheelUnit) Sets the number of pixels that a motion of a wheel
816 mouse will move the image up, down, left, or right. (See the
817 wheel and hwheel actions, below, for more information on this.)
818 If set to zero, the wheel mouse functionality is (essentially)
819 disabled. The default value is 80.
820 -xoffset dimen
822 (.xOffset) Specifies the size of the horizontal offset of the
823 output on the page. See -offsets.
824 -yoffset dimen
826 (.yOffset) Specifies the size of the vertical offset of the out‐
827 put on the page. See -offsets.
828
830 Xdvi recognizes the following keystrokes when typed in its window.
831 Each may optionally be preceded by a (positive or negative) number, a
832 `prefix argument', whose interpretation will depend on the particular
833 keystroke. This prefix argument can be discarded by pressing the ``Es‐
834 cape'' key. If present, the ``Help'', ``Prior'' and ``Next'' keys are
835 synonyms for `?', `b', and `f' keys, respectively.
836 The key bindings listed here are those that xdvi assigns by default.
838 The names appearing in brackets at the beginning of the descriptions
839 are the names of the actions associated with the keys; these can be
840 used to customize the key bindings, as explained in more detail in the
841 section CUSTOMIZATION below. If only a lowercase binding is listed,
842 both upper- and lowercase keys will work for that binding.
843 ESC key
845 [discard-number()] The escape key discards the numerical prefix
846 for all actions (useful when you mistyped a number).
847 Return key
849 [forward-page()] Moves to the next page (or to the nth next page
850 if a number is given). Synonyms are `n', `f' and Line Feed.
851 Backspace key
853 [back-pagee()] Moves to the previous page (or back n pages).
854 Synonyms are `p', `b' and Ctrl-h.
855 Delete key
857 [up-or-previous()] Moves up two-thirds of a window-full, or to
858 the top of the previous page if already at the top of the page.
859 With a float argument, moves up the corresponding fraction of a
860 window-full.
861 Space key
863 [unpause-or-next()] Moves down two-thirds of a window-full, or
864 to the next page if already at the bottom of the page.
865 When the option -pause special-string is used and the display is
866 currently paused, this key will instead display the next portion
867 of the page until the next special-string or the end of the page
868 is encountered. See the description of the -pause option for
869 details. The action [down-or-next()] does a similar thing, but
870 without pausing; it is not bound to a key by default.
871 Ctrl-Home (Xaw), Ctrl-osfBeginLine (Motif)
873 [goto-page(1)] Moves to the first page of the document.
874 Ctrl-End (Xaw), Ctrl-osfEndLine (Motif)
876 [goto-page()] Moves to the last page of the document.
877 Home (Xaw), osfBeginLine (Motif)
879 [home-or-top()] Move to the ``home'' position of the page, or to
880 the top of the page if the keep flag is set (in this case, the
881 page doesn't scroll horizontally).
882 End (Xaw), osfEndLine (Motif)
884 [end-or-bottom()] Move to the ``end'' position of the page (the
885 lower right-hand corner), or to the bottom of the page if the
886 keep flag is set (in this case, the page doesn't scroll horizon‐
887 tally).
888 Down arrow
890 [down(0.015)] Scrolls page down.
891 Up arrow
893 [up(0.015)] Scrolls page up.
894 Right arrow
896 [right(0.015)] Scrolls page right.
897 Left arrow
899 [left(0.015)] Scrolls page left.
900 Alt-Ctrl-+
902 [change-density(25)] Increase the darkness of the fonts in the
903 DVI window by adding to the gamma value (see also the `S' key‐
904 stroke).
905 Alt-Ctrl--
907 [change-density(-25)] Decrease the darkness of the fonts in the
908 DVI window by subtracting from the gamma value (see also the `S'
909 keystroke).
910 Ctrl-+ [set-shrink-factor(+)] Increase the shrink factor (see also the
912 `s' keystroke).
913 Ctrl-- [set-shrink-factor(-)] Decrease the shrink factor (see also the
915 `s' keystroke).
916 Ctr-[ [pagehistory-delete-backward()] Delete the current item in the
918 page history and move to the history item before the deleted
919 one. With a prefix argument n, delete n previous history items.
920 See PAGE HISTORY for details.
921 [ [pagehistory-back()] Move back in the page history (see PAGE
923 HISTORY for details). With a prefix argument n, move back n his‐
924 tory items.
925 Ctr-] [pagehistory-delete-forward()] Delete the current item in the
927 page history and move to the history item after the deleted one.
928 With a prefix argument n, delete n next history items. See PAGE
929 HISTORY for details.
930 ] [pagehistory-forward()] Move forward in the page history (see
932 PAGE HISTORY for details). With a prefix argument n, move for‐
933 ward n history items.
934 ^ [home()] Move to the ``home'' position of the page. This is
936 normally the upper left-hand corner of the page, depending on
937 the margins as described in the -margins option, above.
938 ? [help()] Same as the h key (which see).
940 B [htex-back()] This key jumps back to the previous hyperlink an‐
942 chor. See the section HYPERLINKS for more information on navi‐
943 gating the links.
944 b [back-page()] Moves to the previous page (or back n pages).
946 Synonyms are `p', Ctrl-h and Backspace.
947 C [set-color()] This key toggles the use of color specials. The
949 key sequences `0C' and `1C' turn interpretation of color spe‐
950 cials off and on, respectively. See also the -nocolor option.
951 c [center()] Moves the page so that the point currently beneath
953 the mouse cursor is moved to the middle of the window, and warps
954 the mouse cursor to the same place.
955 D [toggle-grid-mode()] This key toggles the use of a grid on the
957 displayed page. If no number is given, the grid mode is
958 switched on or off. By prepending a number from 1 to 3, 3 dif‐
959 ferent grid levels can be set. The units of the grid are inches
960 or centimeters, depending on whether the paper format is letter
961 (in) or a4 (cm).
962 d [down()] Moves page down two thirds of a window-full. With a
964 float argument to ``down'', moves down the corresponding frac‐
965 tion of a window-full.
966 Ctrl-f [find()] Pop up a window to search for a string in the DVI file.
968 See the section STRING SEARCH, below, for more details.
969 f [forward-page()] Moves to the next page (or to the nth next page
971 if a number is given). Synonyms are `n', Return, and Line Feed.
972 G [set-greyscaling()] This key toggles the use of greyscale anti-
974 aliasing for displaying shrunken bitmaps. In addition, the key
975 sequences `0G' and `1G' clear and set this flag, respectively.
976 See also the -nogrey option.
977 If given a numeric argument that is not 0 or 1, greyscale anti-
979 aliasing is turned on, and the gamma resource is set to the val‐
980 ue divided by 100. E.g., `150G' turns on greyscale and sets gam‐
981 ma to 1.5.
982 Ctrl-g [find-next()] Find the next match string in the DVI file; this
984 can be used instead of pressing the `Find' button in the search
985 window.
986 g [goto-page()] Moves to the page with the given number. If no
988 page number is given, xdvi jumps to the last page.
989 If the option/resource useTeXpages is active, the numbers corre‐
990 spond to the actual page numbers in the TeX file; otherwise, ab‐
991 solute page numbers (starting from 1) are used. In the latter
992 case, the page numbers can be changed with the `P' keystroke,
993 below. Note that with the useTeXpages option it is possible
994 that the same page number occurs multiple times; in such a case,
995 xdvi will use the first page number that matches.
996 h Pops up a help window with a short explanation of the most im‐
998 portant key bindings and concepts.
999 k [set-keep-flag()] Normally when xdvi switches pages, it moves to
1001 the home position as well. The `k' keystroke toggles a `keep-
1002 position' flag which, when set, will keep the same position when
1003 moving between pages. Also `0k' and `1k' clear and set this
1004 flag, respectively. See also the -keep option.
1005 Ctrl-l [fullscreen(toggle)] Toggles fullscreen mode (see the descrip‐
1007 tion of the -fullscreen option for more information on this).
1008 This is even more flaky than using the command-line option:
1009 There is no universal standard how a window could change its own
1010 geometry or window decorations at run-time, so this will not
1011 work with most window managers or desktops. Generally, it's bet‐
1012 ter to use the window manager controls to change the size or
1013 decorations of the xdvi window.
1014 l [left()] Moves page left two thirds of a window-full.
1016 M [set-margins()] Sets the margins so that the point currently un‐
1018 der the mouse cursor defines the upper left-hand corner of the
1019 text in the page. Note that the command does not move the im‐
1020 age, but only determines the margins for the page switching com‐
1021 mands. For details on how the margins are used, see the -margins
1022 option.
1023 m [toggle-mark()] Toggles the mark for the current page in the
1025 page list. When a page is marked, it is displayed with a small
1026 star `*' next to the page number. The marked pages can then be
1027 printed or saved to a file. A page or several pages can also be
1028 marked by clicking or dragging Mouse-2 in the page list.
1029 Ctrl-n [toggle-mark()forward-page()] Toggles the mark for the current
1031 page in the page list, and moves to the next page. This lets you
1032 quickly mark a series of subsequent pages.
1033 n [forward-page()] Moves to the next page (or to the nth next page
1035 if a number is given). Synonyms are `f', Return, and Line Feed.
1036 Ctrl-o [select-dvi-file()] Read a new dvi file. A file-selection widget
1038 is popped up for you to choose the DVI file from. If a prefix
1039 argument n is given, the n th file from the file history is
1040 opened instead.
1041 P [declare-page-number()] ``This is page number n.'' This can be
1043 used to make the `g' keystroke refer to a different page number
1044 than the physical page. (If you want to use `logical' or TeX
1045 page numbers instead of physical pages, consider using the op‐
1046 tion -useTeXpages instead.) The argument n should be given as
1047 prefix to this key.
1048 Ctrl-p [print()] Opens a popup window for printing the DVI file, or
1050 parts of it. See the section PRINT DIALOG for an explanation of
1051 the options available, and the resources to customize the de‐
1052 fault behaviour.
1053 p [back-page()] Moves to the previous page (or back n pages).
1055 Synonyms are `b', Ctrl-h and Backspace.
1056 q [quit()] Quits the program.
1058 Ctrl-r [forward-page(0)] Redisplays the current page.
1060 R [reread-dvi-file()] Forces the dvi file to be reread. This al‐
1062 lows you to preview many versions of the same file while running
1063 xdvi only once.
1064 r [right()] Moves page right two thirds of a window-full.
1066 Ctrl-s [save()] Opens a popup window for saving the DVI file, or parts
1068 of it. See the section SAVE DIALOG below for more information on
1069 this.
1070 S [set-density()] Sets the density factor to be used when shrink‐
1072 ing bitmaps. This should be a number between 0 and 100; higher
1073 numbers produce lighter characters. If greyscaling mode is in
1074 effect, this changes the value of gamma instead. The new value
1075 of gamma is the given number divided by 100; negative values are
1076 allowed.
1077 s [set-shrink-factor()] Changes the shrink factor to the given
1079 number. If no number is given, the smallest factor that makes
1080 the entire page fit in the window will be used. (Margins are
1081 ignored in this computation.)
1082 T [use-tex-pages()] Use logical TeX pages (the values of the
1084 \count0 register) instead of physical pages for the pagelist la‐
1085 bels and when jumping to a page in a document via goto-page().
1086 See also the -useTeXpages option.
1087 t [switch-magnifier-units()] Switches the units used for the mag‐
1089 nifier tick marks, and for reporting the distance between the
1090 mouse pointer and the ruler centre in ruler mode (see the sec‐
1091 tion MODES). The default value is specified by the X resource
1092 tickUnits (`mm' by default). The units toggle through the fol‐
1093 lowing values; except for `px', they all correspond to TeX's
1094 units: mm (millimeters) pt (TeX points), in (inches), sp (scaled
1095 points, the unit used internally by TeX) bp (big points or
1096 `Postscript points'), cc (cicero points), dd (didot points), pc
1097 (pica), and px (screen pixels).
1098 Ctrl-u [back-page()toggle-mark()] Moves to the previous page, and tog‐
1100 gles the mark for that page. This is the dual action to Ctrl-n.
1101 u [up()] Moves page up two thirds of a window-full. With a float
1103 argument to ``up'', moves up the corresponding fraction of a
1104 window-full.
1105 Ctrl-v [show-source-specials()] Show bounding boxes for every source
1107 special on the current page, and print the strings contained in
1108 these specials to stderr. With prefix 1, show every bounding box
1109 on the page. This is for debugging purposes mainly.
1110 V [set-gs-alpha()] This key toggles the anti-aliasing of Post‐
1112 Script<tm> specials when Ghostscript is used as renderer. In
1113 addition the key sequences `0V' and `1V' clear and set this
1114 flag, respectively. See also the -gsalpha option.
1115 v [set-ps()] This key toggles the rendering of PostScript<tm> spe‐
1117 cials between 3 states:
1118 - specials (like EPS graphics) are displayed;
1120 - specials are displayed along with their bounding box (if
1122 available);
1123 - only the bounding box is displayed.
1125 The states can also be selected directly by using `1v', `2v' and
1127 `0v' respectively. See also the -postscript option.
1128 Ctrl-x [source-what-special()] Display information about the source
1130 special next to the mouse cursor in the statusline. This is the
1131 same special that would be found by source-special(), but with‐
1132 out invoking the editor. For debugging purposes.
1133 x [set-expert-mode()] Toggles expert mode, in which the sta‐
1135 tusline, the scrollbars, the menu buttons, the toolbar (Motif
1136 only) and the page list are not shown. Typing `1x' toggles the
1137 display of the statusline at the bottom of the window. Typing
1138 `2x' toggles the scrollbars (if available). For Xaw, `3x' tog‐
1139 gles the menu buttons and the page list, for Motif, it toggles
1140 the page list. In Motif, the additional bindings `4x' toggle the
1141 toolbar, and `5x' the menu bar.
1142 Without a prefix argument, all of the mentioned GUI elements are
1143 either switched on (if they had been invisible before) or off.
1144 Toggling the scrollbars may behave erratically with the Xaw wid‐
1145 gets; e.g. the scrollbars may reappear after resizing the win‐
1146 dow, and at certain window sizes one of the scrollbars may fail
1147 to disappear.
1148 See also the option -expertmode (the numbers above correspond to
1149 the bits in the argument to -expertmode).
1150
1152 The mouse actions can be customized by setting the X resource mouse‐
1153 Translations. Since there are three different mouse modes (see the
1154 section MODES below), there is a special action mouse-modes which lists
1155 the actions for each of the three modes: mouse-modes("ACTIONS-FOR-
1156 MODE1", "ACTIONS-FOR-MODE2", "ACTIONS-FOR-MODE3"). If only one argu‐
1157 ment is specified, this action is used for all modes. The default
1158 bindings are as follows:
1159 xdvi.mouseTranslations: \
1161 Shift<Btn1Down>:mouse-modes("drag(+)")\n\
1162 Shift<Btn2Down>:mouse-modes("drag(|)")\n\
1163 Shift<Btn3Down>:mouse-modes("drag(-)")\n\
1164 Ctrl<Btn1Down>:mouse-modes("source-special()")\n\
1165 <Btn1Down>: mouse-modes("do-href()magnifier(*2)", "text-selection()", "ruler()")\n\
1166 <Btn2Down>: mouse-modes("do-href-newwindow()magnifier(*2)", "text-selection()", "ruler()")\n\
1167 <Btn3Down>: mouse-modes("magnifier(*3)")\n\
1168 <Btn4Down>: mouse-modes("wheel(-0.2)")\n\
1169 <Btn5Down>: mouse-modes("wheel(0.2)")\n\
1170 <Btn6Down>: mouse-modes("hwheel(-0.2)")\n\
1171 <Btn7Down>: mouse-modes("hwheel(0.2)")\n\
1172 All of these actions are described in more detail below. Note the use
1174 of quote symbols around the action strings, which are necessary to
1175 group them into one argument. Buttons 4, 5, 6, and 7 refer to wheel
1176 movements (wheel up/down/left/right) on wheel mice. Not all mice sup‐
1177 port horizontal scrolling.
1178 The X Toolkit routines that implement translations do not support event
1180 types of Btn6Down or Btn7Down. Because of this, xdvi implements its
1181 own parser for translations given in mouseTranslations. This parser is
1182 more limited than the parser built in to the X Toolkit. The string
1183 given in mouseTranslations should not begin with ``#replace'', ``#aug‐
1184 ment'', or ``#override''. Modifiers of the form @keysym are not sup‐
1185 ported, and the event type must be of the form BtnDown or BtnnDown,
1186 where n is a positive integer without leading zeroes. Also, some limi‐
1187 tations apply to the action field.
1188 do-href()
1190 do-href-newwindow()
1192 Usually, if a binding specifies more then one action, all ac‐
1193 tions are executed in a sequence. The hyperlink bindings do-
1194 href() and do-href-newwindow() are special in that they are used
1195 as an alternative to other actions that might follow them if the
1196 mouse is currently located on a hyperlink. In this case, none
1197 of the other actions will be executed; otherwise, only the other
1198 actions are executed.
1199 The action do-href() jumps to the link target in the current xd‐
1200 vi window (eventually switching to another page), and do-href-
1201 newwindow() opens a new instance of xdvi for the link target.
1202 In both cases, the location of the target is indicated by a
1203 small arrow drawn in the same color as a visited link in the
1204 left corner of the window.
1205 magnifier(n x m)
1207 magnifier(*n)
1209 This action will pop up a ``magnifying glass'' which shows the
1210 unshrunk image of the region around the mouse pointer. The mag‐
1211 nifier disappears when the mouse button is released. Moving the
1212 mouse cursor while holding the button down will move the magni‐
1213 fier.
1214 Different mouse buttons produce different sized windows, as in‐
1215 dicated by the the argument of the magnifier() action. Its argu‐
1216 ment is either a string of the form widthxheight, as in the
1217 -mgsn command-line option, or one of the strings *1 through *5,
1218 referring to the value specified by the corresponding -mgsn op‐
1219 tion.
1220 drag(+)
1222 drag(|)
1224 drag(-)
1226 Drags the page with the mouse. This action should have one pa‐
1227 rameter, the character ``|'', ``-'', or ``+'', indicating verti‐
1228 cal dragging only, horizontal dragging only, or dragging in all
1229 directions.
1230 source-special()
1232 This action starts a ``reverse search'', opening the editor at
1233 the location in the TeX file corresponding to the pointer loca‐
1234 tion in the DVI file. See the section on SOURCE SPECIALS, be‐
1235 low, for more information on this.
1236 wheel()
1238 This action can be used to scroll the image with a wheel mouse,
1239 where it is usually bound to mouse button 4 (wheel up) or 5
1240 (wheel down). The action takes one parameter, giving the dis‐
1241 tance to scroll the image. If the parameter contains a decimal
1242 point, the distance is given in wheel units; otherwise, pixels.
1243 A negative value scrolls up, a positive value scrolls down.
1244 hwheel()
1246 This action can be used to scroll the image horizontally with a
1247 wheel mouse, where it is usually bound to mouse button 6 (wheel
1248 left) or 7 (wheel right). The action takes one parameter, giv‐
1249 ing the distance to scroll the image. If the parameter contains
1250 a decimal point, the distance is given in wheel units; other‐
1251 wise, pixels. A negative value scrolls left, a positive value
1252 scrolls right. Not all mice support horizontal scrolling; this
1253 is mostly for touchpads, trackpads, etc.
1254 text-selection()
1256 This action allows you to mark a rectangular region of text in
1257 the DVI file. The text is put into the X selection buffer and
1258 can be pasted into other applictions (e.g. text editors). This
1259 works similar to the Plain text option in the Save dialog; see
1260 the discussion there for more information on encoding issues.
1261 ruler()
1263 This action creates a cross-shaped ruler. Moving the mouse and
1264 holding the button down drags the ruler and lets you measure
1265 distances on the page. See the section Ruler Mode for more in‐
1266 formation on this.
1267
1269 The following actions are not bound to a key by default, but are avail‐
1270 able for customization.
1271 quit-confirm()
1273 Pops up a confirmation window to quit xdvi. To bind it to the
1274 `q' key instead of the default `quit()' action, put the follow‐
1275 ing into your ~/.Xdefaults file:
1276 xdvi.mainTranslations: #override\
1278 <Key>q: quit-confirm()\n
1279 down-or-next()
1281 Similar to unpause-or-next(): Moves down two-thirds of a window-
1282 full, or to the next page if already at the bottom of the page.
1283 shrink-to-dpi()
1285 This action takes one (required) argument. It sets the shrink
1286 factor to an integer so as to approximate the use of fonts with
1287 the corresponding number of dots per inch. If xdvi is using
1288 fonts scaled for p dots per inch, and the argument to shrink-to-
1289 dpi is n, then the corresponding shrink factor is the ratio p/n,
1290 rounded to the nearest integer.
1291
1293 Key and mouse button assignments can be changed by setting the main‐
1294 Translations resource to a string of translations as defined in the
1295 documentation for the X toolkit. The actions should take the form of
1296 action names listed in the KEYSTROKES and MOUSE ACTIONS sections.
1297 An exception to this are the Motif keys osfPageUp (PgUp), osfPageDown
1299 (PgDown), osfBeginLine (Home) and osfEndLine (End) which are currently
1300 not customizable in the Motif version.
1301 Key actions will usually be without arguments; if they are passed an
1303 argument, it represents the optional number or `prefix argument' typed
1304 prior to the action.
1305 Some key actions may take special arguments, as follows: The argument
1307 of goto-page may be the letter `e', indicating the action of going to
1308 the end of the document. The argument of set-shrink-factor may be the
1309 letter `a', indicating that the shrink factor should be set to the
1310 smallest value such that the page will fit in the window, or one of the
1311 signs `+' or `-', indicating that the shrink factor should be increased
1312 or decreased, respectively. Finally, actions that would perform a tog‐
1313 gle, such as set-keep-flag, may receive an argument `t', indicating
1314 that the action should toggle regardless of the current prefix argu‐
1315 ment.
1316 Mouse actions should refer only to ButtonPress events (e.g.,
1318 <Btn1Down>:magnifier(*1)). The corresponding motion and release events
1319 will be handled internally. A key action may be bound to a mouse
1320 event, but not vice versa.
1321 Usually the string of translations should begin with ``#override'', in‐
1323 dicating that the default key and mouse button assignments should not
1324 be discarded.
1325 When keys or mouse buttons involving modifiers (such as Ctrl or Shift)
1327 are customized together with their non-modified equivalents, the modi‐
1328 fied keys should come first, for example:
1329 xdvi.mainTranslations: #override \
1331 Shift<Key>s: select-dvi-file()\n\
1332 Ctrl<Key>s: save()\n\
1333 <Key>s: find()\n
1334 Because xdvi needs to capture pointer motion events, and because the X
1337 Toolkit translations mechanism cannot accommodate both motion events
1338 and double-click events at the same time, it is not possible to specify
1339 double-click actions in xdvi customizations. For information on this
1340 and other aspects of translations, see the X Toolkit Intrinsics docu‐
1341 mentation.
1342 There is no command-line option to set the mainTranslations resource,
1344 since changing this resource on the command line would be cumbersome.
1345 To set the resource for testing purposes, use the -xrm command-line op‐
1346 tion provided by the X toolkit. For example, xdvi -xrm 'XDvi.main‐
1347 Translations: #override "z":quit()' ... or xdvi -xrm 'XDvi.mainTrans‐
1348 lations: #override <Key>z:quit()' ... will cause the key `z' to quit
1349 xdvi.
1350 Some resources are provided to allow customization of the geometry of
1352 the Xaw command buttons. Again, they are not changeable via command-
1353 line options, other than via the -xrm option. All of these resources
1354 take integer values.
1355 buttonSideSpacing
1357 The number of pixels to be placed on either side of the buttons.
1358 The default value is 6.
1359 buttonTopSpacing
1361 The number of pixels between the top button and the top of the
1362 window. The default value is 50.
1363 buttonBetweenSpacing
1365 The number of pixels between the buttons. The default value is
1366 20.
1367 buttonBetweenExtra
1369 The number of pixels of additional space to be inserted if the
1370 buttonTranslations resource string contains an extra newline
1371 character. The default value is 50.
1372 buttonBorderWidth
1374 The border width of the button windows. The default value is 1.
1375
1377 The scrollable page list on the right of the main window allows you to
1378 jump directly to a page in the DVI file.
1379 Mouse-1
1381 Jumps to the page the mouse is located on.
1382 Mouse-2
1384 [toggle-mark()] Toggle the mark of the current page. The marks
1385 are used by the `Print' and `Save to file' dialogs to select on‐
1386 ly marked pages from the DVI file.
1387 When the mouse pointer is inside the page list, the mouse wheel switch‐
1389 es to the next or previous page.
1390
1392 The scrollbars (if present) behave in the standard way: pushing Button
1393 2 in a scrollbar moves the top or left edge of the scrollbar to that
1394 point and optionally drags it; pushing Button 1 moves the image up or
1395 right by an amount equal to the distance from the button press to the
1396 upper left-hand corner of the window; pushing Button 3 moves the image
1397 down or left by the same amount.
1398 The scrollbars can be removed via the -expertmode flag/keystroke (which
1400 see).
1401
1403 By default, the mouse buttons 1 to 5 will pop up a ``magnifying glass''
1404 that shows an unshrunken image of the page (i.e. an image at the reso‐
1405 lution determined by the option/X resource pixels or mfmode) at varying
1406 sizes. When the magnifier is moved, small ruler-like tick marks are
1407 displayed at the edges of the magnifier (unless the X resource de‐
1408 layRulers is set to false, in which case the tick marks will always be
1409 displayed). The unit of the marks is determined by the X resource
1410 tickUnits (mm by default). This unit can be changed at runtime via the
1411 action switch-magnifier-units(), by default bound to the keystroke `t'
1412 (see the description of that key, and of switch-magnifier-units() for
1413 more details on the units available).
1414 The length of the tick marks can be changed via the X resource tick‐
1415 Length (4 by default). A zero or negative value suppresses the tick
1416 marks.
1417
1419 Xdvi keeps a history of viewed pages, and you can move through the his‐
1420 tory and delete items using the keys [ (pagehistory-back()), ] (page‐
1421 history-forward()), Ctr-[ (pagehistory-delete-backward()) and Ctr-]
1422 (pagehistory-delete-forward()).
1423 When one of the history commands is used, the page history is displayed
1425 in the status line at the bottom of the window, with the current list
1426 item marked by square brackets `[', `]' and a left and right context of
1427 at most 10 items. File boundaries are marked by `#'.
1428 The size of the history can be customized with the X resource pageHis‐
1430 torySize (the default size is 1000 items). If the size is set to 0, the
1431 history commands are disabled.
1432
1434 The actions do-href() and do-href-newwindow() (by default bound to
1435 Mouse-1 and Mouse-2 if the pointer is currently located on a hyperlink)
1436 can be used to open the link target in the same window (do-href()) or
1437 in a new window (do-href-newwindow()).
1438 If the link target is not a file on the local disk, xdvi tries to
1440 launch a web browser (as specified by the -browser command line option,
1441 the BROWSER environment variable or the wwwBrowser X resource, in this
1442 order) to retrieve the document. See the description of the BROWSER en‐
1443 vironment variable, below, for an example setting.
1444 If the file is a local file, xdvi tries to determine if it is a DVI
1446 file. If it is, xdvi will try to display the file; otherwise it will
1447 try to determine the MIME type of the file, and from that an applica‐
1448 tion suitable for opening the file. This is done by parsing the files
1449 specified by the environment variable EXTENSIONMAPS for a mapping of
1450 filename extensions to MIME types, and the files determined by the en‐
1451 vironment variable MAILCAPS for a mapping of MIME types to application
1452 programs. See the descriptions of these variables in the section ENVI‐
1453 RONMENT, below, for a more detailed description and the default values
1454 of these variables. If no suitable files are found, a set of built-in
1455 default MIME types and applications is used.
1456 Xdvi currently uses no heuristics apart from the filename suffix to de‐
1458 termine the mime type of a file. If a filename has no suffix, the value
1459 of the resource noMimeSuffix is used (by default application/x-un‐
1460 known). If the suffix doesn't match any of the suffixes in mime.types,
1461 the value of the resource unknownMimeSuffix is used (by default appli‐
1462 cation/x-unknown). If the mailcap entries do not list a viewer for a
1463 given mime type, xdvi will show a warning popup. If you want to avoid
1464 this warning, and for example want to always use the netscape browser
1465 for unknown MIME types, you could add the following line to your
1466 ~/.mailcap file:
1467 application/xdvi-unknown; \
1469 netscape -raise -remote 'openURL(%s,new-window)'
1470
1473 The keystroke Ctrl-f or the menu entry File > Find ... (or the `Binoc‐
1474 ulars' symbol in the toolbar, for Motif) opens a dialog window to
1475 search for a text string or a regular expression in the DVI file. The
1476 keystroke Ctrl-g jumps to the next match (like pressing the `Find' but‐
1477 ton in the search window).
1478 By default, the matches are highlighted in inverted color. If the dis‐
1480 play isn't running in TrueColor, or if the X resource matchHighlightIn‐
1481 verted is set to false or the command-line option -nomatchinverted is
1482 used, xdvi will instead draw a rectangle in highlight color (see the
1483 -hl option) around the match.
1484 If a match crosses a page boundary, only the part on the first page is
1486 highlighted. Xdvi will scan up to 2 adjacent pages to match strings
1487 crossing page boundaries; but note that header or footer lines, or in‐
1488 tervening float pages will be treated as parts of the scanned text.
1489 Such text will usually cause multi-page matching to fail.
1490 This emphasizes the fact that searching in the formatted text (the DVI
1492 output) works differently from searching in the source text: Searching
1493 in the DVI file makes it easier to skip formatting instructions, and
1494 makes it possible to search for e.g. hyphenation and equation numbers;
1495 but sometimes the formatting results can also get in the way, e.g. in
1496 the case of footnotes. In these cases it's better to search in the TeX
1497 source instead. The use of source specials will make switching between
1498 the xdvi display and the editor with the TeX source easier; see the
1499 section SOURCE SPECIALS below for more information on this.
1500 The text extracted from the DVI file is in encoded in UTF-8 (you can
1502 view that text by saving the file in UTF-8 format via the File > Save
1503 as ... menu item). If xdvi has been compiled with locale, nl_langin‐
1504 fo() and iconv support, the search term is converted from the character
1505 set specified by the current locale into UTF-8. (See the output of lo‐
1506 cale -a for a list of locale settings available on your system). If
1507 nl_langinfo() is not available, but iconv is, you can specify the input
1508 encoding for iconv via the X resource textEncoding (see the output of
1509 iconv -l for a list of valid encodings). If iconv support is not avail‐
1510 able, only the encodings ISO-8859-1 and UTF-8 are supported (these
1511 names are case-insensitive).
1512 Ideographic characters from CJKV fonts are treated specially: All white
1514 space (spaces and newlines) before and after such characters is ignored
1515 in the search string and in the DVI file.
1516 To match a newline character, use \n in the search string; to match the
1518 string \n, use \\n.
1519 If the checkbox Regular Expression is activated, the string is treated
1521 as a regular expression in extended POSIX syntax, with the following
1522 properties:
1523 - a? matches a zero or one times.
1525 - a* matches a zero or more times.
1527 - a+ matches a one or more times. Note that * and + are greedy, i.e.
1529 they match the longest possible substring.
1530 - The pattern . matches any character except for newline. To also
1532 match a newline, use `(.|\n)'.
1533 - a{n} matches a exactly n times.
1535 - a{n,m} matches a at least n and no more than m times.
1537 - a|b matches a or b. Brackets can be used for grouping, e.g.:
1539 (a|b)|c.
1540 - The string matched by the nth group can be referenced by \n, e.g.
1542 \1 refers to the first match.
1543 - The characters ^ and $ match the beginning and the end of a line,
1545 respectively.
1546 - [abc] matches any of the letters a, b, c, and [a-z] matches all
1548 characters from a to z.
1549 - Each item in a regular expression can also be one of the following
1551 POSIX character classes:
1552 [[:alnum:]] [[:alpha:]] [[:blank:]] [[:cntrl:]] [[:digit:]]
1553 [[:graph:]] [[:lower:]] [[:print:]] [[:space:]] [[:upper:]]
1554 These can be negated by inserting a ^ symbol after the first brack‐
1557 et: [^[:alpha:]]
1558 For more details on POSIX regular expressions, see e.g. the IEEE
1560 Std 1003.1 standard definition available online from:
1561 http://www.opengroup.org/onlinepubs/007904975/basedefs/xbd_chap09.html
1563 - As a non-standard extension, the following Perl-like abbreviations
1565 can be used instead of the POSIX classes:
1566 Symbol Meaning POSIX Class
1568 \w an alphanumeric character [[:alnum:]]
1570 \W a non-alphanumeric character [^[:alnum:]]
1571 \d a digit character [[:digit:]]
1572 \D a non-digit character [^[:digit:]]
1573 \s a whitespace character [[:space:]]
1574 \S a non-whitespace character [^[:space:]]
1575 - The following characters are special symbols; they need to be es‐
1578 caped with \ in order to match them literally: ( ) [ ] . * ? + ^ $
1579 \.
1580 - Matches of length zero are silently skipped.
1582 The dialog also provides checkboxes to:
1584 - search backwards;
1586 - match in a case-sensitive manner (the default is to ignore case,
1588 i.e. a search string Test will match both the strings test and TEST
1589 in the DVI file);
1590 - ignore line breaks and hyphens: This removes all hyphens at the
1592 ends of lines and the following newline characters, and replaces
1593 all remaining newline characters by white spaces. So hyphenated
1594 words will appear as one word to the search, and a search for two
1595 words with a space in between will also match the words if they are
1596 separated by a linebreak.
1597 Note that the hyphen removal may cause unwanted side effects for
1598 compound words containing hyphens that are wrapped after the hy‐
1599 phen, and that replacing the newlines affects the interpretation of
1600 regular expressions as follows: The . pattern will also match new‐
1601 lines, and ^ and $ won't match begin and end of lines any more.
1602 (Since currently there is no option for turning off the greediness
1603 of * and +, turning on this option will usually result in matches
1604 that are longer than desired.)
1605 The current checkbox settings are saved in the ~/.xdvirc file.
1607
1609 The print dialog window allows you to print all pages, marked pages
1610 (click or drag Mouse-2 in the page list to mark them), or a range of
1611 pages. Note that the page numbers always refer to physical pages, so if
1612 you're using the option `use TeX pages', you may want to disable it to
1613 make it easier to determine the correct page numbers (or avoid this
1614 problem altogether by marking the pages to be printed).
1615 The value of the Printer text filed is passed to dvips via the -o!
1617 mechanism, as a single argument after the `!'. Any arguments listed in
1618 the Dvips options field are segmented at whitespaces and passed as sep‐
1619 arate arguments to dvips. If you e.g. want to print the file 2-up, you
1620 should enter the following string into the Printer field:
1621 psnup -2 -q | lpr -Plp
1623 There are several resources for customizing the behaviour and the de‐
1626 fault entries of the print dialog:
1627 dvipsPrinterString
1629 dvipsOptionsString
1631 These can be used to provide default entries for the Printer and
1632 the Dvips options text fields, respectively. If no paper size is
1633 specified in the DVI file (via e.g. \usepackage[dvips]{geometry}
1634 - this is the preferred method), the input field is initialized
1635 with the current value of the command line option/X resource pa‐
1636 per. E.g., the option -paper a4r is translated into the dvips
1637 options -t a4 -t landscape. Note that no check is performed
1638 whether dvips actually understands these options (it will ignore
1639 them if it can't); currently not all options used by xdvi are
1640 also covered by dvips.
1641 dvipsHangTime
1643 dvipsFailHangTime
1645 These specify the time (in milliseconds) that the printing
1646 progress window will stay open after the dvips process has ter‐
1647 minated. The value of dvipsHangTime is used if the process ter‐
1648 minates successfully; dvipsFailHangTime is used if it terminates
1649 with an error. The default values are 1.5 and 5 seconds, respec‐
1650 tively. If both values are negative, the window will stay open
1651 until it is closed by the user.
1652
1654 This dialog allows you to save all or selected/marked pages in the cur‐
1655 rent DVI file. You can save in one of the following formats:
1656 - Postscript (uses dvips to convert the DVI file to a Postscript
1658 file, just like when printing to a Postscript file).
1659 - PDF (first uses dvips to convert the DVI file to a Postscript file,
1661 then uses ps2pdf to convert the Postscript file to PDF).
1662 - Plain text in ISO-8859-1 or UTF-8 encoding. The latter will pre‐
1664 serve more of the special LaTeX characters e.g. from mathematical
1665 mode. Note however that e.g. only few of LaTeX's mathematical sym‐
1666 bols can be rendered correctly as text; so this funcionality works
1667 best for plain text documents. If a character cannot be displayed
1668 in the selected charset, it is replaced by `\' followed by the
1669 hexadecimal character code. If a character is not recognized at
1670 all, it is replaced by `?'.
1671 The programs for Postscript and PDF conversion can be customized via
1673 the command line options or X resources -dvipspath/.dvipsPath and
1674 -ps2pdfpath/.ps2pdfPath, respectively; see the explanation of these op‐
1675 tions above for more details.
1676
1678 The keystroke Ctrl-m [switch-mode()] switches between three different
1679 mouse bindings, which can also be activated via the Modes menu (in Mo‐
1680 tif, this is a submenu of the Options menu called Mouse Mode). The de‐
1681 fault mode at startup can be customized via the X resource mouseMode or
1682 the command-line option -mousemode. The default startup mode is Magni‐
1683 fier Mode.
1684 Note: The modes are implemented by changing the magnifier() action.
1686 Switching the mode will not work if Mouse-1 has been customized to an
1687 action sequence that does not contain the magnifier() action.
1688 Magnifier Mode
1690 In this mode, the mouse buttons 1 to 5 pop up a ``magnifying
1691 glass'' that shows an unshrunken image of the page (i.e. an im‐
1692 age at the resolution determined by the option/X resource pixels
1693 or mfmode) at varying sizes. When the magnifier is moved, small
1694 ruler-like tick marks are displayed at the edges of the magnifi‐
1695 er (unless the X resource delayRulers is set to false, in which
1696 case the tick marks are always displayed). The unit of the
1697 marks is determined by the X resource tickUnits (mm by default).
1698 This unit can be changed at runtime via the action switch-magni‐
1699 fier-units(), by default bound to the keystroke `t' (see the de‐
1700 scription of that key, and of switch-magnifier-units() for more
1701 details on the units available).
1702 The length of the tick marks can be changed via the X resource
1703 tickLength (4 by default). A zero or negative value suppresses
1704 the tick marks.
1705 Text Selection Mode
1707 This mode allows you to select a rectangular region of text in
1708 the DVI file by holding down Mouse-1 and moving the mouse. The
1709 text is put into the X primary selection so that it can be past‐
1710 ed into other X applications with Mouse-2 as usual.
1711 If xdvi has been compiled with locale, nl_langinfo() and iconv
1712 support, the selected text is converted into the character set
1713 of the current locale (see the output of locale -a for a list of
1714 locale settings available on your system). If nl_langinfo() is
1715 not available, but iconv is, you can specify the input encoding
1716 for iconv via the X resource textEncoding (see the output of
1717 iconv -l for a list of valid encodings). If iconv support is not
1718 available, only the encodings ISO-8859-1 and UTF-8 are supported
1719 (these names are case-insensitive).
1720 Note that UTF-8 is the only encoding that can render all charac‐
1721 ters (e.g. mathematical symbols) of a DVI file. If ISO-8859-1 is
1722 active, characters that cannot be displayed are replaced by `\'
1723 followed by the hexadecimal character code. For other encod‐
1724 ings, such characters may trigger iconv error messages. If a
1725 character is not recognized at all, it is replaced by `?'.
1726 To extract larger portions of text, you can alternatively save
1727 selected pages or the entire file in text format via the File >
1728 Save as ... menu.
1729 Ruler Mode
1731 This mode provides a simple way of measuring distances on the
1732 page.
1733 When this mode is activated, the mouse cursor changes into a
1734 thin cross, and a larger, cross-shaped ruler is drawn in the
1735 highlight color at the mouse location. The ruler doesn't have
1736 units attached to it; instead, the current distance between the
1737 ruler and the mouse cursor is continuously printed to the sta‐
1738 tusline.
1739 When activating Ruler Mode, the ruler is at first attached to
1740 the mouse and can be moved around. It can then be positioned at
1741 a fixed place by clicking Mouse-1. After that, the mouse cursor
1742 can be moved to measure the horizontal (dx), vertical (dy) and
1743 direct (shortest) (dr) distance between the ruler center point
1744 and the mouse.
1745 Clicking Mouse-1 again will move the ruler to the current mouse
1746 position, and holding down Mouse-1 will drag the ruler around.
1747 In Ruler Mode, the following special keybindings extend or re‐
1748 place the default bindings:
1749 o [ruler-snap-origin()] Snap the ruler back to the origin
1751 coordinate (0,0).
1752 t [overrides switch-magnifier-units()] Toggle between vari‐
1754 ous ruler units, which can be specified by the X resource
1755 tickUnits (`mm' by default).
1756 P [overrides declare-page-number()] Print the distances
1758 shown in the statusline to standard output.
1759
1761 The Motif toolbar can also be customized. The XPM file used for the
1762 toolbar icons can be specified via the resource toolbarPixmapFile,
1763 which should contain a filename that can be found in one of XFILE‐
1764 SEARCHPATH or XDVIINPUTS (see the section FILE SEARCHING below for more
1765 information on these variables). Xdvi will try to split this pixmap
1766 horizontally into n pieces, where each piece is as wide as the pixmap
1767 is high and is treated as an image for toolbar button n. This means
1768 that each icon should be a square, and that the entire pixmap should
1769 have width n x h if h is the height of the pixmap.
1770 The resource toolbarTranslations can be used to map icons/buttons to
1772 specific actions. The resource should contain a string separated by
1773 newline characters, similar to the resources mainTranslations and menu‐
1774 Translations. Every line must contain either a spacer definition, or
1775 an icon definition:
1776 A spacer definition is a string SPACER(n), where n is the number of
1778 pixels inserted as separator to the following button.
1779 An icon definition is a colon-separated list containing the following
1781 elements:
1782 - the index of an icon in the pixmap file (starting from zero);
1784 - a long tooltip string, displayed in the status area;
1786 - a short tooltip string, displayed as popup;
1788 - a sequence of actions to be performed when the corresponding tool‐
1790 bar button is pushed.
1791 To illustrate this, the default value of toolbarTranslations looks as
1793 follows:
1794 xdvi.toolbarTranslations: \
1796 SPACER(5)\n\
1797 0:Open a new document (Key\\: Ctrl-f):\
1798 Open file:select-dvi-file()\n\
1799 SPACER(10)\n\
1800 1:Reread this document (Key\\: R):\
1801 Reread file:reread-dvi-file()\n\
1802 SPACER(10)\n\
1803 2:Go to the first page of this document (Key\\: 1g):\
1804 Go to first page:goto-page(1)\n\
1805 3:Go to the previous page of this document (Key\\: p):\
1806 Go to previous page:back-page(1)\n\
1807 4:Go to the next page of this document (Key\\: n):\
1808 Go to next page:forward-page(1)\n\
1809 5:Go to the last page of this document (Key\\: g):\
1810 Go to last page:goto-page()\n\
1811 SPACER(10)\n\
1812 6:Enlarge the display (Key\\: Ctrl-+):Zoom in:\
1813 set-shrink-factor(+)\n\
1814 7:Shrink the display (Key\\: Ctrl--):Zoom out:\
1815 set-shrink-factor(-)\n\
1816 SPACER(10)\n\
1817 8:Jump back to the previous hyperlink (Key\\: B):\
1818 Back hyperlink:htex-back()\n\
1819 SPACER(10)\n\
1820 10:Print this document:Print:print()\n\
1821 SPACER(10)\n\
1822 11:Toggle marks for odd pages (Key\\: 1m):\
1823 Toggle odd:toggle-mark(1)\n\
1824 12:Toggle marks for even pages (Key\\: 2m):\
1825 Toggle even:toggle-mark(2)\n\
1826 13:Toggle mark for current page (Key\\: 2m):\
1827 Toggle current:toggle-mark()\n\
1828 14:Unmark all pages (Key\\: 0m):\
1829 Unmark all:toggle-mark(0)\n\
1830 SPACER(10)\n\
1831 18:Display fonts darker (Key\\: Alt-Ctrl-+):\
1832 Fonts darker:change-density(5)\n\
1833 19:Display fonts lighter (Key\\: Alt-Ctrl--):\
1834 Fonts lighter:change-density(-5)\n
1835 When the mouse remains over a toolbar button for a certain period, a
1838 `tooltip' window is shown, describing what the button does using the
1839 short tooltip string from the above resource. At the same time, the
1840 long tooltip string is displayed in the statusline. The appearance and
1841 behaviour of these tooltips can be customized via the following re‐
1842 sources:
1843 tipShell.background
1845 Background color of the tooltip window.
1846 tipShell.fontSet
1848 Font used for the tooltip.
1849 tipShell.waitPeriod
1851 The time (in milliseconds) the mouse pointer needs to be over
1852 the button before the tooltip is shown. Set it to a negative
1853 value to suppress the tooltips altogether.
1854
1857 The greyscale anti-aliasing feature in xdvi will not work at its best
1858 if the display does not have enough colors available. This can happen
1859 if other applications are using most of the colormap (even if they are
1860 iconified). If this occurs, then xdvi will print an error message and
1861 turn on the -copy option. This will result in overstrike characters
1862 appearing wrong; it may also result in poor display quality if the num‐
1863 ber of available colors is very small.
1864 Typically this problem occurs on displays that allocate eight bits of
1866 video memory per pixel. To see how many bits per pixel your display
1867 uses, type xwininfo in an xterm window, and then click the mouse on the
1868 root window when asked. The ``Depth:'' entry will tell you how many
1869 bits are allocated per pixel.
1870 Displays using at least 15 bits per pixel are typically TrueColor visu‐
1872 als, which do not have this problem, since their colormap is permanent‐
1873 ly allocated and available to all applications. (The visual class is
1874 also displayed by xwininfo.) For more information on visual classes
1875 see the documentation for the X Window System.
1876 To alleviate this problem, therefore, one may (a) run with more bits
1878 per pixel (this may require adding more video memory or replacing the
1879 video card), (b) shut down other applications that may be using much of
1880 the colormap and then restart xdvi, or (c) run xdvi with the -install
1881 option.
1882 One application which is often the cause of this problem is Netscape.
1884 In this case there are two more alternatives to remedying the situa‐
1885 tion. One can run ``netscape -install'' to cause Netscape to install a
1886 private colormap. This can cause colors to change in bizarre ways when
1887 the mouse is moved to a different window. Or, one can run ``netscape
1888 -ncols 220'' to limit Netscape to a smaller number of colors. A small‐
1889 er number will ensure that other applications have more colors avail‐
1890 able, but will degrade the color quality in the Netscape window.
1891
1894 Xdvi can display Encapsulated PostScript (EPS) files included in the
1895 dvi file. Such files are first searched for in the directory where the
1896 dvi file is, and then using normal Kpathsea rules. There is an excep‐
1897 tion to this, however: if the file name begins with a backtick (`),
1898 then the remaining characters in the file name give a shell command
1899 (often zcat) which is executed; its standard output is then sent to be
1900 interpreted as PostScript. Since the execution of arbitrary shell com‐
1901 mands with the user's permissions is a huge security risk, evaluation
1902 of these backtick commands is disabled by default. It needs to be acti‐
1903 vated via the -allowshell command-line option. NOTE: You should never
1904 use this option when viewing documents that you didn't compile your‐
1905 self. The backtick specials are not needed for uncompressing gzipped
1906 Postscript files, since xdvi can do that on the fly if the filename
1907 ends with .eps.gz or .eps.Z (and if the first bytes of the file indi‐
1908 cate that the file is indeed compressed). This is both safer and more
1909 flexible than the backtick approach, since the default file searching
1910 rules will apply to such filenames too.
1911
1913 Using T1Lib, a library written by Rainer Menzner (see ftp://sun‐
1914 site.unc.edu/pub/Linux/libs/graphics/), xdvi can render Postscript<tm>
1915 Type1 fonts directly, without the route via TeX pixel (pk) fonts. The
1916 advantage of this is that only one size of each font needs to be stored
1917 on disk. Unless the -not1lib option is used, xdvi will try to render
1918 every font using T1Lib. Only as a fallback it will invoke an external
1919 program (like mktexpk, which in turn may invoke utilities like ps2pk or
1920 gsftopk) to generate a pixel font from the Type1 source. The direct
1921 rendering of the Computer Modern fonts should work out-of-the box,
1922 whereas other Type1 fonts such as the 35 `standard' Postscript<tm>
1923 fonts resident in printers may need to be made accessible for use with
1924 xdvi, unless your system administrator or TeX distribution has already
1925 done so (which is the case e.g. for current teTeX systems). The xdvik
1926 distribution comes with a utility called t1mapper to make these fonts
1927 available for xdvi; see the manual page for t1mapper(1) for usage de‐
1928 tails.
1929
1931 Any of the specials used by xdvi may be preceded by the characters
1932 ``xdvi:''. Doing so does not change the behavior of the special under
1933 xdvi, but it tells other dvi drivers (such as e.g. dvips) to ignore the
1934 special.
1935
1937 Some TeX implementations or macro packages provide the facility to au‐
1938 tomatically include so-called `source specials' into a DVI file. These
1939 contain the line number, eventually a column number, and the filename
1940 of the .tex source. This makes it possible to jump from a .dvi file to
1941 the corresponding place in the .tex source and vice versa (also called
1942 `inverse search' - jumping from the DVI file to the TeX file is also
1943 known as `reverse search', and jumping from the TeX file to the DVI
1944 file as `forward search').
1945 To be usable with xdvi, source specials in the dvi file must have one
1947 of the following formats:
1948 src:line[ ]filename
1950 src:line:col[ ]filename
1951 src:line
1952 src:line:col
1953 src::col
1954 If filename or line are omitted, the most recent values are used. The
1956 first source special on each page must be in one of the first two
1957 forms, since defaults are not inherited across pages.
1958 You will need a TeX implementation that provides an appropriate switch
1960 (e.g. -src) or a macro package (such as srcltx.sty or srctex.sty,
1961 available from CTAN:macros/latex/contrib/supported/srcltx/) to insert
1962 such source specials into the DVI file.
1963 For reverse search, the combination Ctrl-Mouse 1 will make xdvi open an
1965 editor (the value of the -editor command line option) with the file and
1966 the line number of the .tex source. See the description of the -editor
1967 option for more information and example settings.
1968 For forward search, xdvi has a -sourceposition option that makes xdvi
1970 jump to the page in the DVI file corresponding to the given line (or
1971 the closest line having a source special) of the specified file and
1972 highlight the found region. See the description of the -sourceposition
1973 option for more details.
1974 More information on setting up various editors for use with source spe‐
1976 cials can be found at:
1977 http://xdvi.sourceforge.net/inverse-search.html
1979
1982 xdvi accepts specials to set the paper size for the document. These
1983 specials should be of the form
1984 papersize=[*]width,height
1986 where width and height give the width and height of the paper, respec‐
1989 tively. Each of these should appear in the form of a decimal number
1990 followed by any of the two-letter abbreviations for units accepted by
1991 TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). If an asterisk (*) ap‐
1992 pears just before the width, then the measurements refer to the docu‐
1993 ment dimensions (e.g., pt as opposed to truept). This allows a macro
1994 package to vary the page size according to elements of the document;
1995 e.g.,
1996 \special{xdvi: papersize=*\number\wd\mybox sp,
1998 \number\ht\mybox sp}
1999 Except for the asterisk, this format is compatible with dvips.
2002 The last papersize special on a page determines the size of that page.
2004 If there is no such special on a given page, the most recent papersize
2005 is used, or, if there are no papersize specials on any preceding page,
2006 then the value of the paper resource (or -paper option on the command
2007 line) is used. Thus the paper size may vary for different pages of the
2008 dvi file.
2009 If the paper resource (or -paper command-line option) begins with a
2011 plus sign (`+'), then all papersize specials in the dvi file are ig‐
2012 nored.
2013
2015 The color specials supported by xdvi are the same as those supported by
2016 dvips, except that the literal PostScript color specification (as in
2017 the AggiePattern example in the dvips documentation) is not supported.
2018 There are also some restrictions due to the way xdvi's drawing rou‐
2019 tines are implemented; e.g. the \colorbox and \fcolorbox macros don't
2020 work with xdvi. See the section LIMITATIONS below for more information
2021 on these restrictions. Xdvi supports the same list of named colors as
2022 dvips does, namely:
2023 Apricot, Aquamarine, Bittersweet, Black, Blue, BlueGreen, BlueViolet,
2025 BrickRed, Brown, BurntOrange, CadetBlue, CarnationPink, Cerulean, Corn‐
2026 flowerBlue, Cyan, Dandelion, DarkOrchid, Emerald, ForestGreen, Fuchsia,
2027 Goldenrod, Gray, Green, GreenYellow, JungleGreen, Lavender, LimeGreen,
2028 Magenta, Mahogany, Maroon, Melon, MidnightBlue, Mulberry, NavyBlue,
2029 OliveGreen, Orange, OrangeRed, Orchid, Peach, Periwinkle, PineGreen,
2030 Plum, ProcessBlue, Purple, RawSienna, Red, RedOrange, RedViolet, Rho‐
2031 damine, RoyalBlue, RoyalPurple, RubineRed, Salmon, SeaGreen, Sepia,
2032 SkyBlue, SpringGreen, Tan, TealBlue, Thistle, Turquoise, Violet, Viole‐
2033 tRed, White, WildStrawberry, Yellow, YellowGreen, YellowOrange.
2034 Note that these names are case sensitive.
2036 The documentation of the LaTeX color package provides more details on
2038 how to use such specials with LaTeX; see the dvips documentation for a
2039 detailed description of the syntax and semantics of the color specials.
2040
2042 When xdvi receives a SIGUSR1 signal, it rereads the dvi file.
2043
2045 Xdvik uses the same environment variables and algorithms for searching
2046 for font files as TeX and friends. See the documentation for the
2047 Kpathsea library, kpathsea.dvi, for a detailed description of these.
2048 In addition, xdvik accepts the following variables:
2050 DISPLAY
2052 Specifies which graphics display terminal to use.
2053 KPATHSEA_DEBUG
2055 Trace Kpathsea lookups; set it to -1 (= all bits on) for com‐
2056 plete tracing.
2057 EXTENSIONMAPS
2059 A list of files to be searched for mime types entries (as for
2060 Acrobat Reader). Earlier entries in one of these files override
2061 later ones. If this variable is not set, the following default
2062 path is used:
2063 $HOME/.mime.types:/etc/mime.types:\
2065 /usr/etc/mime.types:/usr/local/etc/mime.types
2066 MAILCAPS
2070 A list of files to be searched for mailcap entries, as defined
2071 by RFC 1343. See this RFC or the mailcap(4) manual page for a
2072 detailed description of the mailcap file format. Currently, on‐
2073 ly the following mailcap features are supported:
2074 test=command
2076 The entry is only used if command can be executed via the
2077 system() call and if the system() call returns with value
2078 0 (success). The command string may contain the format
2079 string %s, which will be replaced by the file name.
2080 needsterminal
2082 If this flag is used, the command will be executed in a
2083 new xterm window by prepending ``xterm -e '' to the com‐
2084 mand string.
2085 All other fields in the mailcap entry are ignored by xdvi. Ear‐
2087 lier entries in one of these files override later ones. If the
2088 variable is not defined, the following default path is used:
2089 $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:\
2091 /usr/local/etc/mailcap
2092 For security reasons, some special characters (i.e.: ( ) ` \ ;)
2094 are escaped in the argument before passing it to system().
2095 BROWSER
2097 Determines the web browser used to open external links (i.e.,
2098 all URLs that don't start with the `file:' scheme and are not
2099 relative links in the local DVI file), and to open links for
2100 which no viewer has been specified in the mailcap files. The
2101 value of this variable is a colon-separated list of commands.
2102 Xdvi will try each of them in sequence until one succeeds (i.e.
2103 doesn't immediately return with status 0). This allows you to
2104 specify your favourite browser at the beginning, and fallback
2105 browsers at the end. Every occurrence of %s in the string is re‐
2106 placed by the target URL; every occurrence of %% is replaced by
2107 a single %. If no %s is present, the URL string is added as an
2108 extra argument.
2109 An example setting is:
2110 netscape -raise -remote 'openURL(%s,new-window)':xterm -e lynx
2112 %s:xterm -e wget %s:lynx %s:wget %s
2113 See
2115 http://www.catb.org/~esr/BROWSER/
2117 for more details on the BROWSER environment variable.
2119 TMPDIR The directory to use for storing temporary files created when
2121 uncompressing PostScript files.
2122 XEDITOR
2124 Determines the editor command used for source special `reverse
2125 search', if neither the -editor command-line option nor the .ed‐
2126 itor resource are specified. See the description of the -ed‐
2127 itor command line option for details on the format.
2128 VISUAL Determines an editor to be opened in an xterm window if neither
2130 of -editor, .editor, or XEDITOR is specified.
2131 EDITOR Determines an editor to be opened in an xterm window if neither
2133 of -editor, .editor, XEDITOR or VISUAL is specified.
2134 WWWBROWSER
2136 Obsolete; use BROWSER instead.
2137
2139 xdvi accepts many but not all types of PostScript specials accepted by
2140 dvips. For example, it accepts most specials generated by epsf and ps‐
2141 fig. It does not, however, support bop-hook or eop-hook, nor does it
2142 allow PostScript commands to affect the rendering of things that are
2143 not PostScript (for example, the ``NEAT'' and rotated ``A'' examples in
2144 the dvips manual). These restrictions are due to the design of xdvi;
2145 in all likelihood they will always remain.
2146 LaTeX2e rotation specials are currently not supported.
2148 MetaPost files containing included text are not supported.
2150 Xdvi's color handling doesn't support the \colorbox and \fcolorbox
2152 macros; this is not likely to change in the near future. This also
2153 means that e.g. colored tables (as created by the colortbl package)
2154 may render incorrectly: Text in colors different from the default fore‐
2155 ground color may not be displayed. When the page is redrawn (e.g. after
2156 using the magnifier), the background color of the cells may overdraw
2157 the text.
2158
2160 $HOME/.xdvirc
2161 A file that holds all settings that the user changed via the
2162 keys, the `Options' and the Xaw `Modes' menu and the dialogs, as
2163 X resources. These resources override the settings in
2164 $HOME/.Xdefaults. This file is ignored if the -q option is used
2165 or the noInitFile X resource is set.
2166 xdvi.cfg
2168 A configuration file for the T1 font setup which needs to be
2169 supplied in the directory determined by the XDVIINPUTS environ‐
2170 ment variable. Please see the file http://xdvi.source‐
2171 forge.net/README.t1fonts if that file is missing.
2172
2174 X(1), dvips(1), mktexpk(1), ps2pk(1), gsftopk(1), t1mapper(1), mail‐
2175 cap(4), the Kpathsea documentation, and the Xdvik home page at
2176 http://xdvi.sourceforge.net/.
2177
2179 Eric Cooper, CMU, did a version for direct output to a QVSS. Modified
2180 for X by Bob Scheifler, MIT Laboratory for Computer Science. Modified
2181 for X11 by Mark Eichin, MIT SIPB. Additional enhancements by many oth‐
2182 ers.
2183 The current maintainer of the original xdvi is Paul Vojta, U.C. Berke‐
2185 ley.
2186 Code for the xdvik variant has been contributed by many people, whose
2188 names are scattered across the source files. Xdvik is hosted on
2189 CTAN:dviware/xdvik and on SourceForge; for the most up-to-date informa‐
2190 tion, please visit:
2191 http://xdvi.sourceforge.net
2193 Please report all bugs to the SourceForge bug tracker:
2195 http://sourceforge.net/tracker/?func=add&group_id=23164&atid=377580
2197Xdvik 22.85 2012-04-01 XDVI(1)