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