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 -warnspecials
373 (.warnSpecials) Causes xdvi to print warnings about \special
374 strings that it cannot process to stderr. These warnings are
375 suppressed by default.
376 -hushstdout
378 (.hushStdout) Suppresses printing of status messages to stdout.
379 Note that errors or warnings will still be printed to stderr
380 even if this option is used.
381 -hushbell
383 (.hushBell) Don't sound the X bell when an error occurs.
384 -icongeometry geometry
386 (.iconGeometry) Specifies the initial position for the icon.
387 -iconic
389 (.iconic) Causes the xdvi window to start in the iconic state.
390 The default is to start with the window open.
391 -install
393 (.install) If xdvi is running under a PseudoColor visual, then
394 (by default) it will check for TrueColor visuals with more bits
395 per pixel, and switch to such a visual if one exists. If no
396 such visual exists, it will use the current visual and colormap.
397 If -install is selected, however, it will still use a TrueColor
398 visual with a greater depth, if one is available; otherwise, it
399 will install its own colormap on the current visual. If the
400 current visual is not PseudoColor, then xdvi will not switch the
401 visual or colormap, regardless of its options. The default val‐
402 ue of the install resource is the special value, maybe. There
403 is no +install option. See also -noinstall, and the GREYSCALING
404 AND COLORMAPS section.
405 -interpreter filename
407 (.interpreter) Use filename as the Ghostscript interpreter. By
408 default it uses gs.
409 -keep (.keepPosition) Sets a flag to indicate that xdvi should not
411 move to the home position when moving to a new page. See also
412 the `k' keystroke. This flag is honored by all page switching
413 actions and by up-or-previous() / down-or-next(), although the
414 latter only honor the horizontal postion, not the vertical one.
415 This allows for a "continuous" scrolling back an forth through a
416 document with a display window narrower than a page width.
417 -l (.listFonts) List the names of all fonts used.
419 -license
421 Prints licensing information.
422 -linkcolor
424 (.linkColor) Color used for unvisited hyperlinks (`Blue2' by de‐
425 fault). Hyperlinks are unvisited before you click on them, or
426 after the DVI file has been reloaded. The value should be ei‐
427 ther a valid X color name (such as DarkGoldenrod4) or a hexadec‐
428 imal color string (such as #8b6508).Seealso -visitedlinkcolor
429 and -linkstyle.
430 -linkstyle
432 (.LinkStyle) Determines the style in which hyperlinks are dis‐
433 played. Possible values and their meanings are:
434 0 No highlighting of links
436 1 Underline links with link color
437 2 No underlining, color text with link color
438 3 Underline and display text colored with
439 link color
440 The values for link color are specified by the options/resources
442 -linkcolor and -visitedlinkcolor (which see).
443 -margins dimen
445 (.Margin) Specifies the size of both the top margin and side
446 margin. This determines the ``home'' position of the page with‐
447 in the window as follows. If the entire page fits in the win‐
448 dow, then the margin settings are ignored. If, even after re‐
449 moving the margins from the left, right, top, and bottom, the
450 page still cannot fit in the window, then the page is put in the
451 window such that the top and left margins are hidden, and pre‐
452 sumably the upper left-hand corner of the text on the page will
453 be in the upper left-hand corner of the window. Otherwise, the
454 text is centered in the window. The dimension should be a deci‐
455 mal number optionally followed by any of the two-letter abbrevi‐
456 ations for units accepted by TeX (pt, pc, in, bp, cm, mm, dd,
457 cc, or sp). By default, the unit will be cm (centimeters). See
458 also -sidemargin, -topmargin, and the keystroke `M.'
459 -mfmode mode-def
461 (.mfMode) Specifies a mode-def string, which can be used in
462 searching for fonts (see ENVIRONMENT, below). Generally, when
463 changing the mode-def, it is also necessary to change the font
464 size to the appropriate value for that mode. This is done by
465 adding a colon and the value in dots per inch; for example, -mf‐
466 mode ljfour:600. This method overrides any value given by the
467 pixelsPerInch resource or the -p command-line argument. The
468 metafont mode is also passed to metafont during automatic cre‐
469 ation of fonts. By default, it is unspecified.
470 -mgs size
472 Same as -mgs1.
473 -mgs[n] size
475 (.magnifierSize[n]) Specifies the size of the window to be used
476 for the ``magnifying glass'' for Button n. The size may be giv‐
477 en as an integer (indicating that the magnifying glass is to be
478 square), or it may be given in the form widthxheight. See the
479 MOUSE ACTIONS section. Defaults are 200x150, 400x250, 700x500,
480 1000x800, and 1200x1200.
481 -mousemode [0|1|2]
483 (.mouseMode) Specifies the default mode of xdvi at startup: Mag‐
484 nifier (0), Text Selection Mode (1) or Ruler Mode (2). See the
485 section MODES, below, for more information.
486 -nocolor
488 (.color) Turns off the use of color specials. This option can
489 be toggled with the `C' keystroke. (Note: -nocolor corresponds
490 to color:off; +nocolor to color:on.)
491 -nofork
493 (.fork) With the -sourceposition and -unique options, the de‐
494 fault behavior is for xdvi to put itself into the background
495 (like a daemon) if there is no appropriate instance of xdvi al‐
496 ready running. This argument makes it run in the foreground in‐
497 stead. This is useful for debugging, or if your client applica‐
498 tion cannot deal well with a program self-backgrounding itself
499 in this way -- e.g., the IPC functions in emacs are known to
500 have problems with this. If no -sourceposition or -unique argu‐
501 ment is given, then this option has no effect. (Note: -nofork
502 corresponds to fork:off; +nofork to fork:on.)
503 -noghostscript
505 (.ghostscript) Inhibits the use of Ghostscript for displaying
506 PostScript<tm> specials. (Note: -noghostscript corresponds to
507 ghostscript:off; +noghostscript to ghostscript:on.)
508 -nogrey
510 (.grey) Turns off the use of greyscale anti-aliasing when print‐
511 ing shrunken bitmaps. (Note: -nogrey corresponds to grey:off;
512 +nogrey to grey:on.) See also the `G' keystroke.
513 -nogssafer
515 (.gsSafer) Normally, if Ghostscript is used to render PostScript
516 specials, the Ghostscript interpreter is run with the option
517 -dSAFER. The -nogssafer option runs Ghostscript without
518 -dSAFER. The -dSAFER option in Ghostscript disables PostScript
519 operators such as deletefile, to prevent possibly malicious
520 PostScript programs from having any effect. If the -safer op‐
521 tion is specified, then this option has no effect; in that case
522 Ghostscript is always run with -dSAFER. (Note: -nogssafer cor‐
523 responds to gsSafer:off; +nogssafer to gsSafer:on.)
524 -noinstall
526 (.install) Inhibit the default behavior of switching to a True‐
527 Color visual if one is available with more bits per pixel than
528 the current visual. (Note: -noinstall corresponds install:off;
529 there is no +noinstall option.) See also -install, and the
530 GREYSCALING AND COLORMAPS section.
531 -nomakepk
533 (.makePk) Turns off automatic generation of font files that can‐
534 not be found by other means. (Note: -nomakepk corresponds to
535 makePk:off; +nomakepk to makePK:on.)
536 -nomatchinverted
538 (.matchInverted) Don't highlight string search matches in in‐
539 verted color; instead, draw a rectangle in highlight color (see
540 the -hl option) around the match. This option is activated auto‐
541 matically if the display isn't running in TrueColor. (Note:
542 -nomatchinverted corresponds to matchInverted:off; +nomatchin‐
543 verted to matchInverted:on.)
544 -noomega
546 (.omega) This will disable the use of Omega extensions when in‐
547 terpreting DVI files. By default, the additional opcodes 129
548 and 134 are recognized by xdvi as Omega extensions and inter‐
549 preted as requests to set 2-byte characters. The only drawback
550 is that the virtual font array will require 65536 positions in‐
551 stead of the default 256 positions, i.e. the memory requirements
552 of xdvi will be slightly larger. If you find this unacceptable
553 or encounter another problem with the Omega extensions, you can
554 switch this extension off by using -noomega (but please do send
555 a bug report if you find such problems - see the bug address in
556 the AUTHORS section below).
557 (Note: -noomega corresponds to omega: off; +noomega to omega:
558 on.)
559 -noscan
561 (.prescan) By default, xdvi does a preliminary scan of the dvi
562 file to process any papersize specials; this is especially im‐
563 portant at startup since the paper size may be needed to deter‐
564 mine the window size. If PostScript<tm> is in use, then pres‐
565 canning is also necessary in order to properly process header
566 files. In addition, prescanning is needed to correctly deter‐
567 mine the background color of a page. This option turns off such
568 prescanning. (Prescanning will be automatically be turned back
569 on if xdvi detects any of the specials mentioned above.) (Note:
570 -noscan corresponds to prescan:off; +noscan to prescan:on.)
571 -not1lib
573 (.t1lib) This will disable the use of T1Lib to display Post‐
574 Script<tm> fonts. Use this option as a workaround when you en‐
575 counter problems with the display of T1Lib (but please don't
576 forget to send a bug report in this case, to the URL mentioned
577 in the section AUTHORS below).
578 (Note: -not1lib corresponds to t1lib:off; +not1lib to t1lib:on.)
579 -notempfile
581 (.tempFile) As mentioned in the section DESCRIPTION above, xdvi
582 will create a temporary copy of the DVI file so that it can be
583 accessed without interruptions even while the file is being
584 rewritten by TeX. Since this introduces the overhead of copying
585 the file every time it has changed, the -notempfile allows you
586 to turn off this behaviour. In this case, exposing parts of the
587 window while the DVI file is being written by TeX will erase the
588 current window contents until the DVI file can be completely
589 reread.
590 (Note: -notempfile corresponds to tempFile:off; +notempfile to
591 tempFile:on.)
592 -offsets dimen
594 (.Offset) Specifies the size of both the horizontal and vertical
595 offsets of the output on the page. By decree of the Stanford
596 TeX Project, the default TeX page origin is always 1 inch over
597 and down from the top-left page corner, even when non-American
598 paper sizes are used. Therefore, the default offsets are 1.0
599 inch. The argument dimen should be a decimal number optionally
600 followed by any of the two-letter abbreviations for units ac‐
601 cepted by TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). By de‐
602 fault, the unit will be cm (centimeters). See also -xoffset and
603 -yoffset.
604 -p pixels
606 (.pixelsPerInch) Defines the size of the fonts to use, in pixels
607 per inch. The default value is 600. This option is provided
608 only for backwards compatibility; the preferred way is to set
609 both the resolution and the Metafont mode via the -mfmode option
610 (which see).
611 -paper papertype
613 (.paper) Specifies the size of the printed page. Note that in
614 most cases it's best to specify the paper size in the TeX input
615 file via the line
616 \usepackage[dvips]{geometry}
618 which will be recognized by both dvips and xdvi; in that case
620 the use of a `-paper' option should be unnecessary.
621 The paper size may be specified in the form widthxheight option‐
622 ally followed by a unit, where width and height are decimal num‐
623 bers giving the width and height of the paper, respectively, and
624 the unit is any of the two-letter abbreviations for units ac‐
625 cepted by TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). By de‐
626 fault, the unit is cm (centimeters).
627 There are also synonyms which may be used: us (8.5x11in), legal
628 (8.5x14in), foolscap (13.5x17in), as well as the ISO sizes
629 a1-a7, b1-b7, c1-c7. Each of these also has a landscape or `ro‐
630 tated' variant: usr (11x8.5in), a1r-a7r, etc. For compatibility
631 with dvips, the formats letter (8.5x11in), ledger (17x11in) and
632 tabloid (11x17in) are also supported (these don't have rotated
633 variants).
634 Any of the above sizes may be preceded by a plus sign (`+');
635 this causes the paper size given here to override any paper size
636 given in the dvi file. The default paper size is 21 x 29.7 cm
637 (A4 size).
638 -pause (.pause) This option provides a simple implementation of incre‐
640 mental (stepwise) display, which can be used for presentations.
641 When this option is used, xdvi will pause the display of the
642 current page whenever it encounters a special special-string
643 (xdvi:pause by default; the string can be customized via -paus‐
644 especial, see below), and the cursor will change its shape. The
645 action unpause-or-next() (by default bound to the Space key)
646 will display the next portion of the page up to the following
647 special-string, or until the end of the page is reached. When
648 the option is not used, specials containing special-string will
649 be ignored.
650 -pausespecial special-string
652 (.pauseSpecial) Sets the special string that causes xdvi to
653 pause when the -pause option is active. The default value of
654 special-string is xdvi:pause.
655 -postscript flag
657 (.postscript) If flag = 0, rendering of PostScript<tm> specials
658 is disabled; instead, bounding boxes will be displayed (if
659 available). A value of 1 (the default) switches PostScript<tm>
660 specials on. With a value of 2, the PostScript<tm> specials are
661 displayed along with their bounding boxes; this allows you to
662 visually check the correctness of the bounding boxes. The values
663 can also be toggled at runtime with the `v' keystroke and the
664 corresponding numerical prefix arguments 0, 1 and 2.
665 -ps2pdfpath path
667 (.ps2pdfPath) Use path as a conversion program from Postscript
668 to PDF. The program or script should accept two command-line ar‐
669 guments: The Postscript file as first argument, and the PDF out‐
670 put file as second argument.
671 -rulecolor color
673 (.ruleColor) Determines the color of the rules used for the the
674 magnifier (default: foreground color).
675 -q (.noInitFile) Ignore the $HOME/.xdvirc startup file (i.e. don't
677 read it at startup, and don't write it at exit). This forces the
678 defaults defined in $HOME/.Xdefaults to be used. See FILES for
679 more information on $HOME/.xdvirc.
680 -rv (.reverseVideo) Causes the page to be displayed with white char‐
682 acters on a black background, instead of vice versa.
683 -S density
685 (.densityPercent) Same as -density (which see).
686 -s shrink
688 (.shrinkFactor) Defines the initial shrink factor. The default
689 value is 8. If shrink is given as 0, then the initial shrink
690 factor is computed so that the page fits within the window (as
691 if the `s' keystroke were given without a number).
692 -safer (.safer) This option turns on all available security options; it
694 is designed for use when xdvi is called by a browser that ob‐
695 tains a dvi or TeX file from another site. This option selects
696 +nogssafer and +allowshell.
697 -sidemargin dimen
699 (.sideMargin) Specifies the side margin (see -margins).
700 -sourceposition line[:col][ ]filename
702 This option makes xdvi search in the dvi file for the place cor‐
703 responding to the indicated line (and, optionally, column) in
704 the .tex source file, and highlight the place found by drawing a
705 rectangle in the highlight color (see the -hl option) around the
706 corresponding text. In addition, when run with this argument
707 (and the -nofork option is not given, which see), xdvi will al‐
708 ways return immediately: if it finds another instance of xdvi
709 already showing dvi_file, then it will cause that instance to
710 raise its window and move to the given place in the dvi file;
711 otherwise it will start up its own instance in the background.
712 If several instances of xdvi are displaying the respective dvi
713 file, the instance which was last raised to the foreground will
714 be used.
715 The space before filename is only needed if the filename starts
717 with a digit. When the space is used, the argument needs to be
718 enclosed in quotes to prevent the shell from misinterpreting the
719 space as argument separator.
720 This option requires that dvi_file be prepared with source spe‐
722 cial information. See the section on SOURCE SPECIALS for de‐
723 tails on how to do this.
724 Here is a more detailed description of how the filename in the
726 -sourceposition argument is matched with the filename in the
727 source specials:
728 1. If neither of the filenames contains a path name component,
730 the filenames are compared ignoring the `.tex' extensions in
731 both filenames.
732 2. Otherwise, if one of the filenames does contain a path compo‐
734 nent (e.g.: ./test.tex, ../test.tex, /my/homedir/tex/test.tex
735 or any combination of these), both filenames are expanded to
736 a full path, with any occurrences of ../ and ./ expanded, and
737 multiple slashes removed.
738 The pathname in the -sourceposition is expanded relative to
739 the current working directory of the xdvi -sourceposition in‐
740 vocation, and the pathnames in the source specials are ex‐
741 panded relative to the path of the current DVI file being
742 viewed.
743 The path names are then compared ignoring the `.tex' exten‐
744 sions in both path names.
745 -statusline
747 (.statusline) This option is obsolete; use -expertmode flag in‐
748 stead (which see).
749 -thorough
751 (.thorough) Xdvi will usually try to ensure that overstrike
752 characters (e.g., \notin) are printed correctly. On monochrome
753 displays, this is always possible with one logical operation,
754 either and or or. On color displays, however, this may take two
755 operations, one to set the appropriate bits and one to clear
756 other bits. If this is the case, then by default xdvi will in‐
757 stead use the copy operation, which does not handle overstriking
758 correctly. The -thorough option chooses the slower but more
759 correct choice. See also -copy.
760 -topmargin dimen
762 (.topMargin) Specifies the top and bottom margins (see -mar‐
763 gins).
764 -unique
766 (.unique) This option will make another instance of xdvi running
767 on the same display act as a `server'. For example, the invoca‐
768 tion
769 xdvi -unique +5 file.dvi
771 will cause this other instance to load file.dvi on page 5 in
773 place of the file that it is currently displaying. If there is
774 already another instance of xdvi already displaying the file
775 file.dvi, then it will just jump to page 5. If the other in‐
776 stance of xdvi is displaying a different file, it will load
777 file.dvi instead. Otherwise, if no other instance of xdvi is
778 currently running on the display, this option instead starts a
779 new instance of xdvi in the background (unless the -nofork op‐
780 tion is specified, which see) displaying page 5 of file.dvi.
781 The filename and the +n option for the page number are the only
782 options available for controlling a remote instance of xdvi like
783 this; all other options are currently ignored.
784 -useTeXpages
786 Use logical TeX pages (the values of the \count0 register) in‐
787 stead of physical pages for the pagelist labels and when jumping
788 to a page in a document with the `g' keystroke (or the goto-
789 page() action). This option can be toggled via the `T' key‐
790 stroke.
791 -version
793 Print information on the version of xdvi.
794 -visitedlinkcolor
796 (.visitedLinkColor) Color used for visited hyperlinks (`Purple4'
797 by default). Hyperlinks become visited once you click on them.
798 As for linkColor, the value should be either a valid X color
799 name or a hexadecimal color string.
800 -warnspecials
802 (.warnSpecials) Causes xdvi to issue warnings about \special
803 strings that it cannot process.
804 -watchfile n
806 (.watchFile) If this option is set to a value larger than 0, xd‐
807 vi will check the DVI file for changes every n seconds. If the
808 DVI file has been completely written by TeX, it will be reloaded
809 automatically. Fractional values (e.g. `2.5') are possible. The
810 default for this option is 0, i.e. no watching.
811 Since xdvi cannot handle partial DVI files, it tries not to
812 reload the file while it is being rewritten. However, use of
813 the magnifier or switching of pages requires reading (a part of)
814 the DVI file, and if the tempfile option is switched off, this
815 will erase the current contents of the window until the DVI file
816 can be read entirely.
817 -wheelunit pixels
819 (.wheelUnit) Sets the number of pixels that a motion of a wheel
820 mouse will move the image up or down. (See the wheel action, be‐
821 low, for more information on this.) If set to zero, the wheel
822 mouse functionality is disabled. The default value is 80.
823 -xoffset dimen
825 (.xOffset) Specifies the size of the horizontal offset of the
826 output on the page. See -offsets.
827 -yoffset dimen
829 (.yOffset) Specifies the size of the vertical offset of the out‐
830 put on the page. See -offsets.
831
833 Xdvi recognizes the following keystrokes when typed in its window.
834 Each may optionally be preceded by a (positive or negative) number, a
835 `prefix argument', whose interpretation will depend on the particular
836 keystroke. This prefix argument can be discarded by pressing the ``Es‐
837 cape'' key. If present, the ``Help'', ``Prior'' and ``Next'' keys are
838 synonyms for `?', `b', and `f' keys, respectively.
839 The key bindings listed here are those that xdvi assigns by default.
841 The names appearing in brackets at the beginning of the descriptions
842 are the names of the actions associated with the keys; these can be
843 used to customize the key bindings, as explained in more detail in the
844 section CUSTOMIZATION below. If only a lowercase binding is listed,
845 both upper- and lowercase keys will work for that binding.
846 ESC key
848 [discard-number()] The escape key discards the numerical prefix
849 for all actions (useful when you mistyped a number).
850 Return key
852 [forward-page()] Moves to the next page (or to the nth next page
853 if a number is given). Synonyms are `n', `f' and Line Feed.
854 Backspace key
856 [back-pagee()] Moves to the previous page (or back n pages).
857 Synonyms are `p', `b' and Ctrl-h.
858 Delete key
860 [up-or-previous()] Moves up two-thirds of a window-full, or to
861 the top of the previous page if already at the top of the page.
862 With a float argument, moves up the corresponding fraction of a
863 window-full.
864 Space key
866 [unpause-or-next()] Moves down two-thirds of a window-full, or
867 to the next page if already at the bottom of the page.
868 When the option -pause special-string is used and the display is
869 currently paused, this key will instead display the next portion
870 of the page until the next special-string or the end of the page
871 is encountered. See the description of the -pause option for
872 details. The action [down-or-next()] does a similar thing, but
873 without pausing; it is not bound to a key by default.
874 Ctrl-Home (Xaw), Ctrl-osfBeginLine (Motif)
876 [goto-page(1)] Moves to the first page of the document.
877 Ctrl-End (Xaw), Ctrl-osfEndLine (Motif)
879 [goto-page()] Moves to the last page of the document.
880 Home (Xaw), osfBeginLine (Motif)
882 [home-or-top()] Move to the ``home'' position of the page, or to
883 the top of the page if the keep flag is set (in this case, the
884 page doesn't scroll horizontally).
885 End (Xaw), osfEndLine (Motif)
887 [end-or-bottom()] Move to the ``end'' position of the page (the
888 lower right-hand corner), or to the bottom of the page if the
889 keep flag is set (in this case, the page doesn't scroll horizon‐
890 tally).
891 Down arrow
893 [down(0.015)] Scrolls page down.
894 Up arrow
896 [up(0.015)] Scrolls page up.
897 Right arrow
899 [right(0.015)] Scrolls page right.
900 Left arrow
902 [left(0.015)] Scrolls page left.
903 Alt-Ctrl-+
905 [change-density(25)] Increase the darkness of the fonts in the
906 DVI window by adding to the gamma value (see also the `S' key‐
907 stroke).
908 Alt-Ctrl--
910 [change-density(-25)] Decrease the darkness of the fonts in the
911 DVI window by subtracting from the gamma value (see also the `S'
912 keystroke).
913 Ctrl-+ [set-shrink-factor(+)] Increase the shrink factor (see also the
915 `s' keystroke).
916 Ctrl-- [set-shrink-factor(-)] Decrease the shrink factor (see also the
918 `s' keystroke).
919 Ctr-[ [pagehistory-delete-backward()] Delete the current item in the
921 page history and move to the history item before the deleted
922 one. With a prefix argument n, delete n previous history items.
923 See PAGE HISTORY for details.
924 [ [pagehistory-back()] Move back in the page history (see PAGE
926 HISTORY for details). With a prefix argument n, move back n his‐
927 tory items.
928 Ctr-] [pagehistory-delete-forward()] Delete the current item in the
930 page history and move to the history item after the deleted one.
931 With a prefix argument n, delete n next history items. See PAGE
932 HISTORY for details.
933 ] [pagehistory-forward()] Move forward in the page history (see
935 PAGE HISTORY for details). With a prefix argument n, move for‐
936 ward n history items.
937 ^ [home()] Move to the ``home'' position of the page. This is
939 normally the upper left-hand corner of the page, depending on
940 the margins as described in the -margins option, above.
941 ? [help()] Same as the h key (which see).
943 B [htex-back()] This key jumps back to the previous hyperlink an‐
945 chor. See the section HYPERLINKS for more information on navi‐
946 gating the links.
947 b [back-page()] Moves to the previous page (or back n pages).
949 Synonyms are `p', Ctrl-h and Backspace.
950 C [set-color()] This key toggles the use of color specials. The
952 key sequences `0C' and `1C' turn interpretation of color spe‐
953 cials off and on, respectively. See also the -nocolor option.
954 c [center()] Moves the page so that the point currently beneath
956 the mouse cursor is moved to the middle of the window, and warps
957 the mouse cursor to the same place.
958 D [toggle-grid-mode()] This key toggles the use of a grid on the
960 displayed page. If no number is given, the grid mode is
961 switched on or off. By prepending a number from 1 to 3, 3 dif‐
962 ferent grid levels can be set. The units of the grid are inches
963 or centimeters, depending on whether the paper format is letter
964 (in) or a4 (cm).
965 d [down()] Moves page down two thirds of a window-full. With a
967 float argument to ``down'', moves down the corresponding frac‐
968 tion of a window-full.
969 Ctrl-f [find()] Pop up a window to search for a string in the DVI file.
971 See the section STRING SEARCH, below, for more details.
972 f [forward-page()] Moves to the next page (or to the nth next page
974 if a number is given). Synonyms are `n', Return, and Line Feed.
975 G [set-greyscaling()] This key toggles the use of greyscale anti-
977 aliasing for displaying shrunken bitmaps. In addition, the key
978 sequences `0G' and `1G' clear and set this flag, respectively.
979 See also the -nogrey option.
980 If given a numeric argument that is not 0 or 1, greyscale anti-
982 aliasing is turned on, and the gamma resource is set to the val‐
983 ue divided by 100. E.g., `150G' turns on greyscale and sets gam‐
984 ma to 1.5.
985 Ctrl-g [find-next()] Find the next match string in the DVI file; this
987 can be used instead of pressing the `Find' button in the search
988 window.
989 g [goto-page()] Moves to the page with the given number. If no
991 page number is given, xdvi jumps to the last page.
992 If the option/resource useTeXpages is active, the numbers corre‐
993 spond the the actual page numbers in the TeX file; otherwise,
994 absolute page numbers (starting from 1) are used. In the latter
995 case, the page numbers can be changed with the `P' keystroke,
996 below. Note that with the useTeXpages option it is possible
997 that the same page number occurs multiple times; in such a case,
998 xdvi will use the first page number that matches.
999 h Pops up a help window with a short explanation of the most im‐
1001 portant key bindings and concepts.
1002 k [set-keep-flag()] Normally when xdvi switches pages, it moves to
1004 the home position as well. The `k' keystroke toggles a `keep-
1005 position' flag which, when set, will keep the same position when
1006 moving between pages. Also `0k' and `1k' clear and set this
1007 flag, respectively. See also the -keep option.
1008 Ctrl-l [fullscreen(toggle)] Toggles fullscreen mode (see the descrip‐
1010 tion of the -fullscreen option for more information on this).
1011 This is even more flaky than using the command-line option:
1012 There is no universal standard how a window could change its own
1013 geometry or window decorations at run-time, so this will not
1014 work with most window managers or desktops. Generally, it's bet‐
1015 ter to use the window manager controls to change the size or
1016 decorations of the xdvi window.
1017 l [left()] Moves page left two thirds of a window-full.
1019 M [set-margins()] Sets the margins so that the point currently un‐
1021 der the mouse cursor defines the upper left-hand corner of the
1022 text in the page. Note that the command does not move the im‐
1023 age, but only determines the margins for the page switching com‐
1024 mands. For details on how the margins are used, see the -margins
1025 option.
1026 m [toggle-mark()] Toggles the mark for the current page in the
1028 page list. When a page is marked, it is displayed with a small
1029 star `*' next to the page number. The marked pages can then be
1030 printed or saved to a file. A page or several pages can also be
1031 marked by clicking or dragging Mouse-2 in the page list.
1032 Ctrl-n [toggle-mark()forward-page()] Toggles the mark for the current
1034 page in the page list, and moves to the next page. This lets you
1035 quickly mark a series of subsequent pages.
1036 n [forward-page()] Moves to the next page (or to the nth next page
1038 if a number is given). Synonyms are `f', Return, and Line Feed.
1039 Ctrl-o [select-dvi-file()] Read a new dvi file. A file-selection widget
1041 is popped up for you to choose the DVI file from. If a prefix
1042 argument n is given, the n th file from the file history is
1043 opened instead.
1044 P [declare-page-number()] ``This is page number n.'' This can be
1046 used to make the `g' keystroke refer to a different page number
1047 than the physical page. (If you want to use `logical' or TeX
1048 page numbers instead of physical pages, consider using the op‐
1049 tion -useTeXpages instead.) The argument n should be given as
1050 prefix to this key.
1051 Ctrl-p [print()] Opens a popup window for printing the DVI file, or
1053 parts of it. See the section PRINT DIALOG for an explanation of
1054 the options available, and the resources to customize the de‐
1055 fault behaviour.
1056 p [back-page()] Moves to the previous page (or back n pages).
1058 Synonyms are `b', Ctrl-h and Backspace.
1059 q [quit()] Quits the program.
1061 Ctrl-r [forward-page(0)] Redisplays the current page.
1063 R [reread-dvi-file()] Forces the dvi file to be reread. This al‐
1065 lows you to preview many versions of the same file while running
1066 xdvi only once.
1067 r [right()] Moves page right two thirds of a window-full.
1069 Ctrl-s [save()] Opens a popup window for saving the DVI file, or parts
1071 of it. See the section SAVE DIALOG below for more information on
1072 this.
1073 S [set-density()] Sets the density factor to be used when shrink‐
1075 ing bitmaps. This should be a number between 0 and 100; higher
1076 numbers produce lighter characters. If greyscaling mode is in
1077 effect, this changes the value of gamma instead. The new value
1078 of gamma is the given number divided by 100; negative values are
1079 allowed.
1080 s [set-shrink-factor()] Changes the shrink factor to the given
1082 number. If no number is given, the smallest factor that makes
1083 the entire page fit in the window will be used. (Margins are
1084 ignored in this computation.)
1085 T [use-tex-pages()] Use logical TeX pages (the values of the
1087 \count0 register) instead of physical pages for the pagelist la‐
1088 bels and when jumping to a page in a document via goto-page().
1089 See also the -useTeXpages option.
1090 t [switch-magnifier-units()] Switches the units used for the mag‐
1092 nifier tick marks, and for reporting the distance between the
1093 mouse pointer and the ruler centre in ruler mode (see the sec‐
1094 tion MODES). The default value is specified by the X resource
1095 tickUnits (`mm' by default). The units toggle through the fol‐
1096 lowing values; except for `px', they all correspond to TeX's
1097 units: mm (millimeters) pt (TeX points), in (inches), sp (scaled
1098 points, the unit used internally by TeX) bp (big points or
1099 `Postscript points'), cc (cicero points), dd (didot points), pc
1100 (pica), and px (screen pixels).
1101 Ctrl-u [back-page()toggle-mark()] Moves to the previous page, and tog‐
1103 gles the mark for that page. This is the dual action to Ctrl-n.
1104 u [up()] Moves page up two thirds of a window-full. With a float
1106 argument to ``up'', moves up the corresponding fraction of a
1107 window-full.
1108 Ctrl-v [show-source-specials()] Show bounding boxes for every source
1110 special on the current page, and print the strings contained in
1111 these specials to stderr. With prefix 1, show every bounding box
1112 on the page. This is for debugging purposes mainly.
1113 V [set-gs-alpha()] This key toggles the anti-aliasing of Post‐
1115 Script<tm> specials when Ghostscript is used as renderer. In
1116 addition the key sequences `0V' and `1V' clear and set this
1117 flag, respectively. See also the -gsalpha option.
1118 v [set-ps()] This key toggles the rendering of PostScript<tm> spe‐
1120 cials between 3 states:
1121 - specials (like EPS graphics) are displayed;
1123 - specials are displayed along with their bounding box (if
1125 available);
1126 - only the bounding box is displayed.
1128 The states can also be selected directly by using `1v', `2v' and
1130 `0v' respectively. See also the -postscript option.
1131 Ctrl-x [source-what-special()] Display information about the source
1133 special next to the mouse cursor in the statusline. This is the
1134 same special that would be found by source-special() , but with‐
1135 out invoking the editor. For debugging purposes.
1136 x [set-expert-mode()] Toggles expert mode, in which the sta‐
1138 tusline, the scrollbars, the menu buttons, the toolbar (Motif
1139 only) and the page list are not shown. Typing `1x' toggles the
1140 display of the statusline at the bottom of the window. Typing
1141 `2x' toggles the scrollbars (if available). For Xaw, `3x' tog‐
1142 gles the menu buttons and the page list, for Motif, it toggles
1143 the page list. In Motif, the additional bindings `4x' toggle the
1144 toolbar, and `5x' the menu bar.
1145 Without a prefix argument, all of the mentioned GUI elements are
1146 either switched on (if they had been invisible before) or off.
1147 Toggling the scrollbars may behave erratically with the Xaw wid‐
1148 gets; e.g. the scrollbars may reappear after resizing the win‐
1149 dow, and at certain window sizes one of the scrollbars may fail
1150 to disappear.
1151 See also the option -expertmode (the numbers above correspond to
1152 the bits in the argument to -expertmode).
1153
1155 The mouse actions can be customized by setting the X resource mouse‐
1156 Translations. Since there are three different mouse modes (see the
1157 section MODES below), there is a special action mouse-modes which lists
1158 the actions for each of the three modes: mouse-modes("ACTIONS-FOR-
1159 MODE1", "ACTIONS-FOR-MODE2", "ACTIONS-FOR-MODE3"). If only one argu‐
1160 ment is specified, this action is used for all modes. The default
1161 bindings are as follows:
1162 xdvi.mouseTranslations: \
1164 Shift<Btn1Down>:mouse-modes("drag(+)")\n\
1165 Shift<Btn2Down>:mouse-modes("drag(|)")\n\
1166 Shift<Btn3Down>:mouse-modes("drag(-)")\n\
1167 Ctrl<Btn1Down>:mouse-modes("source-special()")\n\
1168 <Btn1Down>: mouse-modes("do-href()magnifier(*2)", "text-selection()", "ruler()")\n\
1169 <Btn2Down>: mouse-modes("do-href-newwindow()magnifier(*2)", "text-selection()", "ruler()")\n\
1170 <Btn3Down>: mouse-modes("magnifier(*3)")\n\
1171 <Btn4Down>: mouse-modes("wheel(-0.2)")\n\
1172 <Btn5Down>: mouse-modes("wheel(0.2)")\n\
1173 All of these actions are described in more detail below. Note the use
1175 of quote symbols around the action strings, which are neccessary to
1176 group them into one argument. The buttons 4 and 5 refer to wheel move‐
1177 ments (wheel up/down) on wheel mice.
1178 do-href()
1180 do-href-newwindow()
1182 Usually, if a binding specifies more then one action, all ac‐
1183 tions are executed in a sequence. The hyperlink bindings do-
1184 href() and do-href-newwindow() are special in that they are used
1185 as an alternative to other actions that might follow them if the
1186 mouse is currently located on a hyperlink. In this case, none
1187 of the other actions will be executed; otherwise, only the other
1188 actions are executed.
1189 The action do-href() jumps to the link target in the current xd‐
1190 vi window (eventually switching to another page), and do-href-
1191 newwindow() opens a new instance of xdvi for the link target.
1192 In both cases, the location of the target is indicated by a
1193 small arrow drawn in the same color as a visited link in the
1194 left corner of the window.
1195 magnifier(n x m)
1197 magnifier(*n)
1199 This action will pop up a ``magnifying glass'' which shows the
1200 unshrunk image of the region around the mouse pointer. The mag‐
1201 nifier disappears when the mouse button is released. Moving the
1202 mouse cursor while holding the button down will move the magni‐
1203 fier.
1204 Different mouse buttons produce different sized windows, as in‐
1205 dicated by the the argument of the magnifier() action. Its argu‐
1206 ment is either a string of the form widthxheight, as in the
1207 -mgsn command-line option, or one of the strings *1 through *5,
1208 referring to the value specified by the corresponding -mgsn op‐
1209 tion.
1210 drag(+)
1212 drag(|)
1214 drag(-)
1216 Drags the page with the mouse. This action should have one pa‐
1217 rameter, the character ``|'', ``-'', or ``+'', indicating verti‐
1218 cal dragging only, horizontal dragging only, or dragging in all
1219 directions.
1220 source-special()
1222 This action starts a ``reverse search'', opening the editor at
1223 the location in the TeX file corresponding to the pointer loca‐
1224 tion in the DVI file. See the section on SOURCE SPECIALS, be‐
1225 low, for more information on this.
1226 wheel()
1228 This action can be used to scroll the image with a wheel mouse,
1229 where it is usually bound to mouse button 4 (wheel up) or 5
1230 (wheel down). The action takes one parameter, giving the dis‐
1231 tance to scroll the image. If the parameter contains a decimal
1232 point, the distance is given in wheel units; otherwise, pixels.
1233 A negative value scrolls up, a positive value scrolls down.
1234 text-selection()
1236 This action allows you to mark a rectangular region of text in
1237 the DVI file. The text is put into the X selection buffer and
1238 can be pasted into other applictions (e.g. text editors). This
1239 works similar to the Plain text option in the Save dialog; see
1240 the discussion there for more information on encoding issues.
1241 ruler()
1243 This action creates a cross-shaped ruler. Moving the mouse and
1244 holding the button down drags the ruler and lets you measure
1245 distances on the page. See the section Ruler Mode for more in‐
1246 formation on this.
1247
1249 The following actions are not bound to a key by default, but are avail‐
1250 able for customization.
1251 quit-confirm()
1253 Pops up a confirmation window to quit xdvi. To bind it to the
1254 `q' key instead of the default `quit()' action, put the follow‐
1255 ing into your ~/.Xdefaults file:
1256 xdvi.mainTranslations: #override\
1258 <Key>q: quit-confirm()\n
1259 down-or-next()
1261 Similar to unpause-or-next(): Moves down two-thirds of a window-
1262 full, or to the next page if already at the bottom of the page.
1263 shrink-to-dpi()
1265 This action takes one (required) argument. It sets the shrink
1266 factor to an integer so as to approximate the use of fonts with
1267 the corresponding number of dots per inch. If xdvi is using
1268 fonts scaled for p dots per inch, and the argument to shrink-to-
1269 dpi is n, then the corresponding shrink factor is the ratio p/n,
1270 rounded to the nearest integer.
1271
1273 Key and mouse button assignments can be changed by setting the main‐
1274 Translations resource to a string of translations as defined in the
1275 documentation for the X toolkit. The actions should take the form of
1276 action names listed in the KEYSTROKES and MOUSE ACTIONS sections.
1277 An exception to this are the Motif keys osfPageUp (PgUp), osfPageDown
1279 (PgDown), osfBeginLine (Home) and osfEndLine (End) which are currently
1280 not customizable in the Motif version.
1281 Key actions will usually be without arguments; if they are passed an
1283 argument, it represents the optional number or `prefix argument' typed
1284 prior to the action.
1285 Some key actions may take special arguments, as follows: The argument
1287 of goto-page may be the letter `e', indicating the action of going to
1288 the end of the document. The argument of set-shrink-factor may be the
1289 letter `a', indicating that the shrink factor should be set to the
1290 smallest value such that the page will fit in the window, or one of the
1291 signs `+' or `-', indicating that the shrink factor should be increased
1292 or decreased, respectively. Finally, actions that would perform a tog‐
1293 gle, such as set-keep-flag, may receive an argument `t', indicating
1294 that the action should toggle regardless of the current prefix argu‐
1295 ment.
1296 Mouse actions should refer only to ButtonPress events (e.g.,
1298 <Btn1Down>:magnifier(*1)). The corresponding motion and release events
1299 will be handled internally. A key action may be bound to a mouse
1300 event, but not vice versa.
1301 Usually the string of translations should begin with ``#override'', in‐
1303 dicating that the default key and mouse button assignments should not
1304 be discarded.
1305 When keys or mouse buttons involving modifiers (such as Ctrl or Shift)
1307 are customized together with their non-modified equivalents, the modi‐
1308 fied keys should come first, for example:
1309 xdvi.mainTranslations: #override \
1311 Shift<Key>s: select-dvi-file()\n\
1312 Ctrl<Key>s: save()\n\
1313 <Key>s: find()\n
1314 Because xdvi needs to capture pointer motion events, and because the X
1317 Toolkit translations mechanism cannot accommodate both motion events
1318 and double-click events at the same time, it is not possible to specify
1319 double-click actions in xdvi customizations. For information on this
1320 and other aspects of translations, see the X Toolkit Intrinsics docu‐
1321 mentation.
1322 There is no command-line option to set the mainTranslations resource,
1324 since changing this resource on the command line would be cumbersome.
1325 To set the resource for testing purposes, use the -xrm command-line op‐
1326 tion provided by the X toolkit. For example, xdvi -xrm 'XDvi.main‐
1327 Translations: #override "z":quit()' ... or xdvi -xrm 'XDvi.mainTrans‐
1328 lations: #override <Key>z:quit()' ... will cause the key `z' to quit
1329 xdvi.
1330 Some resources are provided to allow customization of the geometry of
1332 the Xaw command buttons. Again, they are not changeable via command-
1333 line options, other than via the -xrm option. All of these resources
1334 take integer values.
1335 buttonSideSpacing
1337 The number of pixels to be placed on either side of the buttons.
1338 The default value is 6.
1339 buttonTopSpacing
1341 The number of pixels between the top button and the top of the
1342 window. The default value is 50.
1343 buttonBetweenSpacing
1345 The number of pixels between the buttons. The default value is
1346 20.
1347 buttonBetweenExtra
1349 The number of pixels of additional space to be inserted if the
1350 buttonTranslations resource string contains an extra newline
1351 character. The default value is 50.
1352 buttonBorderWidth
1354 The border width of the button windows. The default value is 1.
1355
1357 The scrollable page list on the right of the main window allows you to
1358 jump directly to a page in the DVI file.
1359 Mouse-1
1361 Jumps to the page the mouse is located on.
1362 Mouse-2
1364 [toggle-mark()] Toggle the mark of the current page. The marks
1365 are used by the `Print' and `Save to file' dialogs to select on‐
1366 ly marked pages from the DVI file.
1367 When the mouse pointer is inside the page list, the mouse wheel switch‐
1369 es to the next or previous page.
1370
1372 The scrollbars (if present) behave in the standard way: pushing Button
1373 2 in a scrollbar moves the top or left edge of the scrollbar to that
1374 point and optionally drags it; pushing Button 1 moves the image up or
1375 right by an amount equal to the distance from the button press to the
1376 upper left-hand corner of the window; pushing Button 3 moves the image
1377 down or left by the same amount.
1378 The scrollbars can be removed via the -expertmode flag/keystroke (which
1380 see).
1381
1383 By default, the mouse buttons 1 to 5 will pop up a ``magnifying glass''
1384 that shows an unshrunken image of the page (i.e. an image at the reso‐
1385 lution determined by the option/X resource pixels or mfmode) at varying
1386 sizes. When the magnifier is moved, small ruler-like tick marks are
1387 displayed at the edges of the magnifier (unless the X resource de‐
1388 layRulers is set to false, in which case the tick marks will always be
1389 displayed). The unit of the marks is determined by the X resource
1390 tickUnits (mm by default). This unit can be changed at runtime via the
1391 action switch-magnifier-units(), by default bound to the keystroke `t'
1392 (see the description of that key, and of switch-magnifier-units() for
1393 more details on the units available).
1394 The length of the tick marks can be changed via the X resource tick‐
1395 Length (4 by default). A zero or negative value suppresses the tick
1396 marks.
1397
1399 Xdvi keeps a history of viewed pages, and you can move through the his‐
1400 tory and delete items using the keys [ (pagehistory-back()), ] (page‐
1401 history-forward()), Ctr-[ (pagehistory-delete-backward()) and Ctr-]
1402 (pagehistory-delete-forward()).
1403 When one of the history commands is used, the page history is displayed
1405 in the status line at the bottom of the window, with the current list
1406 item marked by square brackets `[', `]' and a left and right context of
1407 at most 10 items. File boundaries are marked by `#'.
1408 The size of the history can be customized with the X resource pageHis‐
1410 torySize (the default size is 1000 items). If the size is set to 0, the
1411 history commands are disabled.
1412
1414 The actions do-href() and do-href-newwindow() (by default bound to
1415 Mouse-1 and Mouse-2 if the pointer is currently located on a hyperlink)
1416 can be used to open the link target in the same window (do-href()) or
1417 in a new window (do-href-newwindow()).
1418 If the link target is not a file on the local disk, xdvi tries to
1420 launch a web browser (as specified by the -browser command line option,
1421 the BROWSER environment variable or the wwwBrowser X resource, in this
1422 order) to retrieve the document. See the description of the BROWSER en‐
1423 vironment variable, below, for an example setting.
1424 If the file is a local file, xdvi tries to determine if it is a DVI
1426 file. If it is, xdvi will try to display the file; otherwise it will
1427 try to determine the MIME type of the file, and from that an applica‐
1428 tion suitable for opening the file. This is done by parsing the files
1429 specified by the environment variable EXTENSIONMAPS for a mapping of
1430 filename extensions to MIME types, and the files determined by the en‐
1431 vironment variable MAILCAPS for a mapping of MIME types to application
1432 programs. See the descriptions of these variables in the section ENVI‐
1433 RONMENT, below, for a more detailed description and the default values
1434 of these variables. If no suitable files are found, a set of built-in
1435 default MIME types and applications is used.
1436 Xdvi currently uses no heuristics apart from the filename suffix to de‐
1438 termine the mime type of a file. If a filename has no suffix, the value
1439 of the resource noMimeSuffix is used (by default application/x-un‐
1440 known). If the suffix doesn't match any of the suffixes in mime.types,
1441 the value of the resource unknownMimeSuffix is used (by default appli‐
1442 cation/x-unknown). If the mailcap entries do not list a viewer for a
1443 given mime type, xdvi will show a warning popup. If you want to avoid
1444 this warning, and for example want to always use the netscape browser
1445 for unknown MIME types, you could add the following line to your
1446 ~/.mailcap file:
1447 application/xdvi-unknown; \
1449 netscape -raise -remote 'openURL(%s,new-window)'
1450
1453 The keystroke Ctrl-f or the menu entry File > Find ... (or the `Binoc‐
1454 ulars' symbol in the toolbar, for Motif) opens a dialog window to
1455 search for a text string or a regular expression in the DVI file. The
1456 keystroke Ctrl-g jumps to the next match (like pressing the `Find' but‐
1457 ton in the search window).
1458 By default, the matches are highlighted in inverted color. If the dis‐
1460 play isn't running in TrueColor, or if the X resource matchHighlightIn‐
1461 verted is set to false or the command-line option -nomatchinverted is
1462 used, xdvi will instead draw a rectangle in highlight color (see the
1463 -hl option) around the match.
1464 If a match crosses a page boundary, only the part on the first page is
1466 highlighted. Xdvi will scan up to 2 adjacent pages to match strings
1467 crossing page boundaries; but note that header or footer lines, or in‐
1468 tervening float pages will be treated as parts of the scanned text.
1469 Such text will usually cause multi-page matching to fail.
1470 This emphasizes the fact that searching in the formatted text (the DVI
1472 output) works differently from searching in the source text: Searching
1473 in the DVI file makes it easier to skip formatting instructions, and
1474 makes it possible to search for e.g. hyphenation and equation numbers;
1475 but sometimes the formatting results can also get in the way, e.g. in
1476 the case of footnotes. In these cases it's better to search in the TeX
1477 source instead. The use of source specials will make switching between
1478 the xdvi display and the editor with the TeX source easier; see the
1479 section SOURCE SPECIALS below for more information on this.
1480 The text extracted from the DVI file is in encoded in UTF-8 (you can
1482 view that text by saving the file in UTF-8 format via the File > Save
1483 as ... menu item). If xdvi has been compiled with locale, nl_langin‐
1484 fo() and iconv support, the search term is converted from the character
1485 set specified by the current locale into UTF-8. (See the output of lo‐
1486 cale -a for a list of locale settings available on your system). If
1487 nl_langinfo() is not available, but iconv is, you can specify the input
1488 encoding for iconv via the X resource textEncoding (see the output of
1489 iconv -l for a list of valid encodings). If iconv support is not avail‐
1490 able, only the encodings ISO-8859-1 and UTF-8 are supported (these
1491 names are case-insensitive).
1492 Ideographic characters from CJKV fonts are treated specially: All white
1494 space (spaces and newlines) before and after such characters is ignored
1495 in the search string and in the DVI file.
1496 To match a newline character, use \n in the search string; to match the
1498 string \n, use \\n.
1499 If the checkbox Regular Expression is activated, the string is treated
1501 as a regular expression in extended POSIX syntax, with the following
1502 properties:
1503 - a? matches a zero or one times.
1505 - a* matches a zero or more times.
1507 - a+ matches a one or more times. Note that * and + are greedy, i.e.
1509 they match the longest possible substring.
1510 - The pattern . matches any character except for newline. To also
1512 match a newline, use `(.|\n)'.
1513 - a{n} matches a exactly n times.
1515 - a{n,m} matches a at least n and no more than m times.
1517 - a|b matches a or b. Brackets can be used for grouping, e.g.:
1519 (a|b)|c.
1520 - The string matched by the nth group can be referenced by \n, e.g.
1522 \1 refers to the first match.
1523 - The characters ^ and $ match the beginning and the end of a line,
1525 respectively.
1526 - [abc] matches any of the letters a, b, c, and [a-z] matches all
1528 characters from a to z.
1529 - Each item in a regular expression can also be one of the following
1531 POSIX character classes:
1532 [[:alnum:]] [[:alpha:]] [[:blank:]] [[:cntrl:]] [[:digit:]]
1533 [[:graph:]] [[:lower:]] [[:print:]] [[:space:]] [[:upper:]]
1534 These can be negated by inserting a ^ symbol after the first brack‐
1537 et: [^[:alpha:]]
1538 For more details on POSIX regular expressions, see e.g. the IEEE
1540 Std 1003.1 standard definition available online from:
1541 http://www.opengroup.org/onlinepubs/007904975/basedefs/xbd_chap09.html
1543 - As a non-standard extension, the following Perl-like abbreviations
1545 can be used instead of the POSIX classes:
1546 Symbol Meaning POSIX Class
1548 \w an alphanumeric character [[:alnum:]]
1550 \W a non-alphanumeric character [^[:alnum:]]
1551 \d a digit character [[:digit:]]
1552 \D a non-digit character [^[:digit:]]
1553 \s a whitespace character [[:space:]]
1554 \S a non-whitespace character [^[:space:]]
1555 - The following characters are special symbols; they need to be es‐
1558 caped with \ in order to match them literally: ( ) [ ] . * ? + ^ $
1559 \.
1560 - Matches of length zero are silently skipped.
1562 The dialog also provides checkboxes to:
1564 - search backwards;
1566 - match in a case-sensitive manner (the default is to ignore case,
1568 i.e. a search string Test will match both the strings test and TEST
1569 in the DVI file);
1570 - ignore line breaks and hyphens: This removes all hyphens at the
1572 ends of lines and the following newline characters, and replaces
1573 all remaining newline characters by white spaces. So hyphenated
1574 words will appear as one word to the search, and a search for two
1575 words with a space in between will also match the words if they are
1576 separated by a linebreak.
1577 Note that the hyphen removal may cause unwanted side effects for
1578 compound words containing hyphens that are wrapped after the hy‐
1579 phen, and that replacing the newlines affects the interpretation of
1580 regular expressions as follows: The . pattern will also match new‐
1581 lines, and ^ and $ won't match begin and end of lines any more.
1582 (Since currently there is no option for turning off the greediness
1583 of * and +, turing on this option will usually result in matches
1584 that are longer than desired.)
1585 The current checkbox settings are saved in the ~/.xdvirc file.
1587
1589 The print dialog window allows you to print all pages, marked pages
1590 (click or drag Mouse-2 in the page list to mark them), or a range of
1591 pages. Note that the page numbers always refer to physical pages, so if
1592 you're using the option `use TeX pages', you may want to disable it to
1593 make it easier to determine the correct page numbers (or avoid this
1594 problem altogether by marking the pages to be printed).
1595 The value of the Printer text filed is passed to dvips via the -o!
1597 mechanism, as a single argument after the `!'. Any arguments listed in
1598 the Dvips options field are segmented at whitespaces and passed as sep‐
1599 arate arguments to dvips. If you e.g. want to print the file 2-up, you
1600 should enter the following string into the Printer field:
1601 psnup -2 -q | lpr -Plp
1603 There are several resources for customizing the behaviour and the de‐
1606 fault entries of the print dialog:
1607 dvipsPrinterString
1609 dvipsOptionsString
1611 These can be used to provide default entries for the Printer and
1612 the Dvips options text fields, respectively. If no paper size is
1613 specified in the DVI file (via e.g. \usepackage[dvips]{geometry}
1614 - this is the preferred method), the input field is initialized
1615 with the current value of the command line option/X resource pa‐
1616 per. E.g., the option -paper a4r is translated into the dvips
1617 options -t a4 -t landscape. Note that no check is performed
1618 whether dvips actually understands these options (it will ignore
1619 them if it can't); currently not all options used by xdvi are
1620 also covered by dvips.
1621 dvipsHangTime
1623 dvipsFailHangTime
1625 These specify the time (in milliseconds) that the printing
1626 progress window will stay open after the dvips process has ter‐
1627 minated. The value of dvipsHangTime is used if the process ter‐
1628 minates successfully; dvipsFailHangTime is used if it terminates
1629 with an error. The default values are 1.5 and 5 seconds, respec‐
1630 tively. If both values are negative, the window will stay open
1631 until it is closed by the user.
1632
1634 This dialog allows you to save all or selected/marked pages in the cur‐
1635 rent DVI file. You can save in one of the following formats:
1636 - Postscript (uses dvips to convert the DVI file to a Postscript
1638 file, just like when printing to a Postscript file).
1639 - PDF (first uses dvips to convert the DVI file to a Postscript file,
1641 then uses ps2pdf to convert the Postscript file to PDF).
1642 - Plain text in ISO-8859-1 or UTF-8 encoding. The latter will pre‐
1644 serve more of the special LaTeX characters e.g. from mathematical
1645 mode. Note however that e.g. only few of LaTeX's mathematical sym‐
1646 bols can be rendered correctly as text; so this funcionality works
1647 best for plain text documents. If a character cannot be displayed
1648 in the selected charset, it is replaced by `\' followed by the
1649 hexadecimal character code. If a character is not recognized at
1650 all, it is replaced by `?'.
1651 The programs for Postscript and PDF conversion can be customized via
1653 the command line options or X resources -dvipspath/.dvipsPath and
1654 -ps2pdfpath/.ps2pdfPath, respectively; see the explanation of these op‐
1655 tions above for more details.
1656
1658 The keystroke Ctrl-m [switch-mode()] switches between three different
1659 mouse bindings, which can also be activated via the Modes menu (in Mo‐
1660 tif, this is a submenu of the Options menu called Mouse Mode). The de‐
1661 fault mode at startup can be customized via the X resource mouseMode or
1662 the command-line option -mousemode. The default startup mode is Magni‐
1663 fier Mode.
1664 Note: The modes are implemented by changing the magnifier() action.
1666 Switching the mode will not work if Mouse-1 has been customized to an
1667 action sequence that does not contain the magnifier() action.
1668 Magnifier Mode
1670 In this mode, the mouse buttons 1 to 5 pop up a ``magnifying
1671 glass'' that shows an unshrunken image of the page (i.e. an im‐
1672 age at the resolution determined by the option/X resource pixels
1673 or mfmode) at varying sizes. When the magnifier is moved, small
1674 ruler-like tick marks are displayed at the edges of the magnifi‐
1675 er (unless the X resource delayRulers is set to false, in which
1676 case the tick marks are always displayed). The unit of the
1677 marks is determined by the X resource tickUnits (mm by default).
1678 This unit can be changed at runtime via the action switch-magni‐
1679 fier-units(), by default bound to the keystroke `t' (see the de‐
1680 scription of that key, and of switch-magnifier-units() for more
1681 details on the units available).
1682 The length of the tick marks can be changed via the X resource
1683 tickLength (4 by default). A zero or negative value suppresses
1684 the tick marks.
1685 Text Selection Mode
1687 This mode allows you to select a rectangular region of text in
1688 the DVI file by holding down Mouse-1 and moving the mouse. The
1689 text is put into the X primary selection so that it can be past‐
1690 ed into other X applications with Mouse-2 as usual.
1691 If xdvi has been compiled with locale, nl_langinfo() and iconv
1692 support, the selected text is converted into the character set
1693 of the current locale (see the output of locale -a for a list of
1694 locale settings available on your system). If nl_langinfo() is
1695 not available, but iconv is, you can specify the input encoding
1696 for iconv via the X resource textEncoding (see the output of
1697 iconv -l for a list of valid encodings). If iconv support is not
1698 available, only the encodings ISO-8859-1 and UTF-8 are supported
1699 (these names are case-insensitive).
1700 Note that UTF-8 is the only encoding that can render all charac‐
1701 ters (e.g. mathematical symbols) of a DVI file. If ISO-8859-1 is
1702 active, characters that cannot be displayed are replaced by `\'
1703 followed by the hexadecimal character code. For other encod‐
1704 ings, such characters may trigger iconv error messages. If a
1705 character is not recognized at all, it is replaced by `?'.
1706 To extract larger portions of text, you can alternatively save
1707 selected pages or the entire file in text format via the File >
1708 Save as ... menu.
1709 Ruler Mode
1711 This mode provides a simple way of measuring distances on the
1712 page.
1713 When this mode is activated, the mouse cursor changes into a
1714 thin cross, and a larger, cross-shaped ruler is drawn in the
1715 highlight color at the mouse location. The ruler doesn't have
1716 units attached to it; instead, the current distance between the
1717 ruler and the mouse cursor is continuously printed to the sta‐
1718 tusline.
1719 When activating Ruler Mode, the ruler is at first attached to
1720 the mouse and can be moved around. It can then be positioned at
1721 a fixed place by clicking Mouse-1. After that, the mouse cursor
1722 can be moved to measure the horizontal (dx), vertical (dy) and
1723 direct (shortest) (dr) distance between the ruler center point
1724 and the mouse.
1725 Clicking Mouse-1 again will move the ruler to the current mouse
1726 position, and holding down Mouse-1 will drag the ruler around.
1727 In Ruler Mode, the following special keybindings extend or re‐
1728 place the default bindings:
1729 o [ruler-snap-origin()] Snap the ruler back to the origin
1731 coordinate (0,0).
1732 t [overrides switch-magnifier-units()] Toggle between vari‐
1734 ous ruler units, which can be specified by the X resource
1735 tickUnits (`mm' by default).
1736 P [overrides declare-page-number()] Print the distances
1738 shown in the statusline to standard output.
1739
1741 The Motif toolbar can also be customized. The XPM file used for the
1742 toolbar icons can be specified via the resource toolbarPixmapFile,
1743 which should contain a filename that can be found in one of XFILE‐
1744 SEARCHPATH or XDVIINPUTS (see the section FILE SEARCHING below for more
1745 information on these variables). Xdvi will try to split this pixmap
1746 horizontally into n pieces, where each piece is as wide as the pixmap
1747 is high and is treated as an image for toolbar button n. This means
1748 that each icon should be a square, and that the entire pixmap should
1749 have width n x h if h is the height of the pixmap.
1750 The resource toolbarTranslations can be used to map icons/buttons to
1752 specific actions. The resource should contain a string separated by
1753 newline characters, similar to the resources mainTranslations and menu‐
1754 Translations. Every line must contain either a spacer definition, or
1755 an icon definition:
1756 A spacer definition is a string SPACER(n), where n is the number of
1758 pixels inserted as separator to the following button.
1759 An icon definition is a colon-separated list containing the following
1761 elements:
1762 - the index of an icon in the pixmap file (starting from zero);
1764 - a long tooltip string, displayed in the status area;
1766 - a short tooltip string, displayed as popup;
1768 - a sequence of actions to be performed when the corresponding tool‐
1770 bar button is pushed.
1771 To illustrate this, the default value of toolbarTranslations looks as
1773 follows:
1774 xdvi.toolbarTranslations: \
1776 SPACER(5)\n\
1777 0:Open a new document (Key\\: Ctrl-f):\
1778 Open file:select-dvi-file()\n\
1779 SPACER(10)\n\
1780 1:Reread this document (Key\\: R):\
1781 Reread file:reread-dvi-file()\n\
1782 SPACER(10)\n\
1783 2:Go to the first page of this document (Key\\: 1g):\
1784 Go to first page:goto-page(1)\n\
1785 3:Go to the previous page of this document (Key\\: p):\
1786 Go to previous page:back-page(1)\n\
1787 4:Go to the next page of this document (Key\\: n):\
1788 Go to next page:forward-page(1)\n\
1789 5:Go to the last page of this document (Key\\: g):\
1790 Go to last page:goto-page()\n\
1791 SPACER(10)\n\
1792 6:Enlarge the display (Key\\: Ctrl-+):Zoom in:\
1793 set-shrink-factor(+)\n\
1794 7:Shrink the display (Key\\: Ctrl--):Zoom out:\
1795 set-shrink-factor(-)\n\
1796 SPACER(10)\n\
1797 8:Jump back to the previous hyperlink (Key\\: B):\
1798 Back hyperlink:htex-back()\n\
1799 SPACER(10)\n\
1800 10:Print this document:Print:print()\n\
1801 SPACER(10)\n\
1802 11:Toggle marks for odd pages (Key\\: 1m):\
1803 Toggle odd:toggle-mark(1)\n\
1804 12:Toggle marks for even pages (Key\\: 2m):\
1805 Toggle even:toggle-mark(2)\n\
1806 13:Toggle mark for current page (Key\\: 2m):\
1807 Toggle current:toggle-mark()\n\
1808 14:Unmark all pages (Key\\: 0m):\
1809 Unmark all:toggle-mark(0)\n\
1810 SPACER(10)\n\
1811 18:Display fonts darker (Key\\: Alt-Ctrl-+):\
1812 Fonts darker:change-density(5)\n\
1813 19:Display fonts lighter (Key\\: Alt-Ctrl--):\
1814 Fonts lighter:change-density(-5)\n
1815 When the mouse remains over a toolbar button for a certain period, a
1818 `tooltip' window is shown, describing what the button does using the
1819 short tooltip string from the above resource. At the same time, the
1820 long tooltip string is displayed in the statusline. The appearance and
1821 behaviour of these tooltips can be customized via the following re‐
1822 sources:
1823 tipShell.background
1825 Background color of the tooltip window.
1826 tipShell.fontSet
1828 Font used for the tooltip.
1829 tipShell.waitPeriod
1831 The time (in milliseconds) the mouse pointer needs to be over
1832 the button before the tooltip is shown. Set it to a negative
1833 value to suppress the tooltips altogether.
1834
1837 The greyscale anti-aliasing feature in xdvi will not work at its best
1838 if the display does not have enough colors available. This can happen
1839 if other applications are using most of the colormap (even if they are
1840 iconified). If this occurs, then xdvi will print an error message and
1841 turn on the -copy option. This will result in overstrike characters
1842 appearing wrong; it may also result in poor display quality if the num‐
1843 ber of available colors is very small.
1844 Typically this problem occurs on displays that allocate eight bits of
1846 video memory per pixel. To see how many bits per pixel your display
1847 uses, type xwininfo in an xterm window, and then click the mouse on the
1848 root window when asked. The ``Depth:'' entry will tell you how many
1849 bits are allocated per pixel.
1850 Displays using at least 15 bits per pixel are typically TrueColor visu‐
1852 als, which do not have this problem, since their colormap is permanent‐
1853 ly allocated and available to all applications. (The visual class is
1854 also displayed by xwininfo.) For more information on visual classes
1855 see the documentation for the X Window System.
1856 To alleviate this problem, therefore, one may (a) run with more bits
1858 per pixel (this may require adding more video memory or replacing the
1859 video card), (b) shut down other applications that may be using much of
1860 the colormap and then restart xdvi, or (c) run xdvi with the -install
1861 option.
1862 One application which is often the cause of this problem is Netscape.
1864 In this case there are two more alternatives to remedying the situa‐
1865 tion. One can run ``netscape -install'' to cause Netscape to install a
1866 private colormap. This can cause colors to change in bizarre ways when
1867 the mouse is moved to a different window. Or, one can run ``netscape
1868 -ncols 220'' to limit Netscape to a smaller number of colors. A small‐
1869 er number will ensure that other applications have more colors avail‐
1870 able, but will degrade the color quality in the Netscape window.
1871
1874 Xdvi can display Encapsulated PostScript (EPS) files included in the
1875 dvi file. Such files are first searched for in the directory where the
1876 dvi file is, and then using normal Kpathsea rules. There is an excep‐
1877 tion to this, however: if the file name begins with a backtick (`),
1878 then the remaining characters in the file name give a shell command
1879 (often zcat) which is executed; its standard output is then sent to be
1880 interpreted as PostScript. Since the execution of arbitrary shell com‐
1881 mands with the user's permissions is a huge security risk, evaluation
1882 of these backtick commands is disabled by default. It needs to be acti‐
1883 vated via the -allowshell command-line option. NOTE: You should never
1884 use this option when viewing documents that you didn't compile your‐
1885 self. The backtick specials are not needed for uncompressing gzipped
1886 Postscript files, since xdvi can do that on the fly if the filename
1887 ends with .eps.gz or .eps.Z (and if the first bytes of the file indi‐
1888 cate that the file is indeed compressed). This is both safer and more
1889 flexible than the backtick approach, since the default file searching
1890 rules will apply to such filenames too.
1891
1893 Using T1Lib, a library written by Rainer Menzner (see ftp://sun‐
1894 site.unc.edu/pub/Linux/libs/graphics/), xdvi can render Postscript<tm>
1895 Type1 fonts directly, without the route via TeX pixel (pk) fonts. The
1896 advantage of this is that only one size of each font needs to be stored
1897 on disk. Unless the -not1lib option is used, xdvi will try to render
1898 every font using T1Lib. Only as a fallback it will invoke an external
1899 program (like mktexpk, which in turn may invoke utilities like ps2pk or
1900 gsftopk) to generate a pixel font from the Type1 source. The direct
1901 rendering of the Computer Modern fonts should work out-of-the box,
1902 whereas other Type1 fonts such as the 35 `standard' Postscript<tm>
1903 fonts resident in printers may need to be made accessible for use with
1904 xdvi, unless your system administrator or TeX distribution has already
1905 done so (which is the case e.g. for current teTeX systems). The xdvik
1906 distribution comes with a utility called t1mapper to make these fonts
1907 available for xdvi; see the manual page for t1mapper(1) for usage de‐
1908 tails.
1909
1911 Any of the specials used by xdvi may be preceded by the characters
1912 ``xdvi:''. Doing so does not change the behavior of the special under
1913 xdvi, but it tells other dvi drivers (such as e.g. dvips) to ignore the
1914 special.
1915
1917 Some TeX implementations or macro packages provide the facility to au‐
1918 tomatically include so-called `source specials' into a DVI file. These
1919 contain the line number, eventually a column number, and the filename
1920 of the .tex source. This makes it possible to jump from a .dvi file to
1921 the corresponding place in the .tex source and vice versa (also called
1922 `inverse search' - jumping from the DVI file to the TeX file is also
1923 known as `reverse search', and jumping from the TeX file to the DVI
1924 file as `forward search').
1925 To be usable with xdvi, source specials in the dvi file must have one
1927 of the following formats:
1928 src:line[ ]filename
1930 src:line:col[ ]filename
1931 src:line
1932 src:line:col
1933 src::col
1934 If filename or line are omitted, the most recent values are used. The
1936 first source special on each page must be in one of the first two
1937 forms, since defaults are not inherited across pages.
1938 You will need a TeX implementation that provides an appropriate switch
1940 (e.g. -src) or a macro package (such as srcltx.sty or srctex.sty,
1941 available from CTAN:macros/latex/contrib/supported/srcltx/) to insert
1942 such source specials into the DVI file.
1943 For reverse search, the combination Ctrl-Mouse 1 will make xdvi open an
1945 editor (the value of the -editor command line option) with the file and
1946 the line number of the .tex source. See the description of the -editor
1947 option for more information and example settings.
1948 For forward search, xdvi has a -sourceposition option that makes xdvi
1950 jump to the page in the DVI file corresponding to the given line (or
1951 the closest line having a source special) of the specified file and
1952 highlight the found region. See the description of the -sourceposition
1953 option for more details.
1954 More information on setting up various editors for use with source spe‐
1956 cials can be found at:
1957 http://xdvi.sourceforge.net/inverse-search.html
1959
1962 xdvi accepts specials to set the paper size for the document. These
1963 specials should be of the form
1964 papersize=[*]width,height
1966 where width and height give the width and height of the paper, respec‐
1969 tively. Each of these should appear in the form of a decimal number
1970 followed by any of the two-letter abbreviations for units accepted by
1971 TeX (pt, pc, in, bp, cm, mm, dd, cc, or sp). If an asterisk (*) ap‐
1972 pears just before the width, then the measurements refer to the docu‐
1973 ment dimensions (e.g., pt as opposed to truept). This allows a macro
1974 package to vary the page size according to elements of the document;
1975 e.g.,
1976 \special{xdvi: papersize=*\number\wd\mybox sp,
1978 \number\ht\mybox sp}
1979 Except for the asterisk, this format is compatible with dvips.
1982 The last papersize special on a page determines the size of that page.
1984 If there is no such special on a given page, the most recent papersize
1985 is used, or, if there are no papersize specials on any preceding page,
1986 then the value of the paper resource (or -paper option on the command
1987 line) is used. Thus the paper size may vary for different pages of the
1988 dvi file.
1989 If the paper resource (or -paper command-line option) begins with a
1991 plus sign (`+'), then all papersize specials in the dvi file are ig‐
1992 nored.
1993
1995 The color specials supported by xdvi are the same as those supported by
1996 dvips, except that the literal PostScript color specification (as in
1997 the AggiePattern example in the dvips documentation) is not supported.
1998 There are also some restrictions due to the way xdvi's drawing rou‐
1999 tines are implemented; e.g. the \colorbox and \fcolorbox macros don't
2000 work with xdvi. See the section LIMITATIONS below for more information
2001 on these restrictions. Xdvi supports the same list of named colors as
2002 with dvips, namely:
2003 Apricot, Aquamarine, Bittersweet, Black, Blue, BlueGreen, BlueViolet,
2005 BrickRed, Brown, BurntOrange, CadetBlue, CarnationPink, Cerulean, Corn‐
2006 flowerBlue, Cyan, Dandelion, DarkOrchid, Emerald, ForestGreen, Fuchsia,
2007 Goldenrod, Gray, Green, GreenYellow, JungleGreen, Lavender, LimeGreen,
2008 Magenta, Mahogany, Maroon, Melon, MidnightBlue, Mulberry, NavyBlue,
2009 OliveGreen, Orange, OrangeRed, Orchid, Peach, Periwinkle, PineGreen,
2010 Plum, ProcessBlue, Purple, RawSienna, Red, RedOrange, RedViolet, Rho‐
2011 damine, RoyalBlue, RoyalPurple, RubineRed, Salmon, SeaGreen, Sepia,
2012 SkyBlue, SpringGreen, Tan, TealBlue, Thistle, Turquoise, Violet, Viole‐
2013 tRed, White, WildStrawberry, Yellow, YellowGreen, YellowOrange.
2014 Note that these names are case sensitive.
2016 The documentation of the LaTeX color package provides more details on
2018 how to use such specials with LaTeX; see the dvips documentation for a
2019 detailed description of the syntax and semantics of the color specials.
2020
2022 When xdvi receives a SIGUSR1 signal, it rereads the dvi file.
2023
2025 Xdvik uses the same environment variables and algorithms for searching
2026 for font files as TeX and friends. See the documentation for the
2027 Kpathsea library, kpathsea.dvi, for a detailed description of these.
2028 In addition, xdvik accepts the following variables:
2030 DISPLAY
2032 Specifies which graphics display terminal to use.
2033 KPATHSEA_DEBUG
2035 Trace Kpathsea lookups; set it to -1 (= all bits on) for com‐
2036 plete tracing.
2037 EXTENSIONMAPS
2039 A list of files to be searched for mime types entries (as for
2040 Acrobat Reader). Earlier entries in one of these files override
2041 later ones. If this variable is not set, the following default
2042 path is used:
2043 $HOME/.mime.types:/etc/mime.types:\
2045 /usr/etc/mime.types:/usr/local/etc/mimetypes
2046 MAILCAPS
2050 A list of files to be searched for mailcap entries, as defined
2051 by RFC 1343. See this RFC or the mailcap(4) manual page for a
2052 detailed description of the mailcap file format. Currently, on‐
2053 ly the following mailcap features are supported:
2054 test=command
2056 The entry is only used if command can be executed via the
2057 system() call and if the system() call returns with value
2058 0 (success). The command string may contain the format
2059 string %s, which will be replaced by the file name.
2060 needsterminal
2062 If this flag is used, the command will be executed in a
2063 new xterm window by prepending ``xterm -e '' to the com‐
2064 mand string.
2065 All other fields in the mailcap entry are ignored by xdvi. Ear‐
2067 lier entries in one of these files override later ones. If the
2068 variable is not defined, the following default path is used:
2069 $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:\
2071 /usr/local/etc/mailcap
2072 For security reasons, some special characters (i.e.: ( ) ` \ ;)
2074 are escaped in the argument before passing it to system().
2075 BROWSER
2077 Determines the web browser used to open external links (i.e.,
2078 all URLs that don't start with the `file:' scheme and are not
2079 relative links in the local DVI file), and to open links for
2080 which no viewer has been specified in the mailcap files. The
2081 value of this variable is a colon-separated list of commands.
2082 Xdvi will try each of them in sequence until one succeeds (i.e.
2083 doesn't immediately return with status 0). This allows you to
2084 specify your favourite browser at the beginning, and fallback
2085 browsers at the end. Every occurrence of %s in the string is re‐
2086 placed by the target URL; every occurrence of %% is replaced by
2087 a single %. If no %s is present, the URL string is added as an
2088 extra argument.
2089 An example setting is:
2090 netscape -raise -remote 'openURL(%s,new-window)':xterm -e lynx
2092 %s:xterm -e wget %s:lynx %s:wget %s
2093 See
2095 http://www.catb.org/~esr/BROWSER/
2097 for more details on the BROWSER environment variable.
2099 TMPDIR The directory to use for storing temporary files created when
2101 uncompressing PostScript files.
2102 XEDITOR
2104 Determines the editor command used for source special `reverse
2105 search', if neither the -editor command-line option nor the .ed‐
2106 itor resource are specified. See the description of the -ed‐
2107 itor command line option for details on the format.
2108 VISUAL Determines an editor to be opened in an xterm window if neither
2110 of -editor, .editor, or XEDITOR is specified.
2111 EDITOR Determines an editor to be opened in an xterm window if neither
2113 of -editor, .editor, XEDITOR or VISUAL is specified.
2114 WWWBROWSER
2116 Obsolete; use BROWSER instead.
2117
2119 xdvi accepts many but not all types of PostScript specials accepted by
2120 dvips. For example, it accepts most specials generated by epsf and ps‐
2121 fig. It does not, however, support bop-hook or eop-hook, nor does it
2122 allow PostScript commands to affect the rendering of things that are
2123 not PostScript (for example, the ``NEAT'' and rotated ``A'' examples in
2124 the dvips manual). These restrictions are due to the design of xdvi;
2125 in all likelihood they will always remain.
2126 LaTeX2e rotation specials are currently not supported.
2128 MetaPost files containing included text are not supported.
2130 Xdvi's color handling doesn't support the \colorbox and \fcolorbox
2132 macros; this is not likely to change in the near future. This also
2133 means that e.g. colored tables (as created by the colortbl package)
2134 may render incorrectly: Text in colors different from the default fore‐
2135 ground color may not be displayed. When the page is redrawn (e.g. after
2136 using the magnifier), the background color of the cells may overdraw
2137 the text.
2138
2140 $HOME/.xdvirc
2141 A file that holds all settings that the user changed via the
2142 keys, the `Options' and the Xaw `Modes' menu and the dialogs, as
2143 X resources. These resources override the settings in
2144 $HOME/.Xdefaults. This file is ignored if the -q option is used
2145 or the noInitFile X resource is set.
2146 xdvi.cfg
2148 A configuration file for the T1 font setup which needs to be
2149 supplied in the directory determined by the XDVIINPUTS environ‐
2150 ment variable. Please see the file http://xdvi.source‐
2151 forge.net/README.t1fonts if that file is missing.
2152
2154 X(1), dvips(1), mktexpk(1), ps2pk(1), gsftopk(1), t1mapper(1), mail‐
2155 cap(4), the Kpathsea documentation, and the Xdvik home page at
2156 http://xdvi.sourceforge.net/.
2157
2159 Eric Cooper, CMU, did a version for direct output to a QVSS. Modified
2160 for X by Bob Scheifler, MIT Laboratory for Computer Science. Modified
2161 for X11 by Mark Eichin, MIT SIPB. Additional enhancements by many oth‐
2162 ers.
2163 The current maintainer of the original xdvi is Paul Vojta, U.C. Berke‐
2165 ley.
2166 Code for the xdvik variant has been contributed by many people, whose
2168 names are scattered across the source files. Xdvik is hosted on
2169 CTAN:dviware/xdvik and on SourceForge; for the most up-to-date informa‐
2170 tion, please visit:
2171 http://xdvi.sourceforge.net
2173 Please report all bugs to the SourceForge bug tracker:
2175 http://sourceforge.net/tracker/?func=add&group_id=23164&atid=377580
2177Xdvik 22.84.14: XDVI(1)