The key bindings listed here are those that xdvi assigns by default. The names appearing in brackets at the beginning of the descriptions are the names of the actions associated with the keys; these can be used to customize the key bindings, as explained in more detail in the section CUSTOMIZATION below. If only a lowercase binding is listed, both upper- and lowercase keys will work for that binding.

ESC key

[discard-number()] The escape key discards the numerical prefix for all actions (useful when you mistyped a number).

Delete key

[up-or-previous()] Moves down two-thirds of a window-full, or to the top of the previous page if already at the bottom of the page. With a float argument, moves down the corresponding fraction of a window-full. By default, the Space key is bound to the action unpause-or-next() which does a similar thing; see there. The `keep' flag is ignored by these actions.

Space key

[unpause-or-next()] Moves down two-thirds of a window-full, or to the next page if already at the bottom of the page. When the option -pause special-string is used and the display is currenlty paused, this key will instead display the next portion of the page until the next special-string or the end of the page is encountered. See the description of the -pause option for details.

Ctrl-Home (Xaw), Ctrl-osfBeginLine (Motif)

[goto-page(1)] Moves to the first page of the document.

Ctrl-End (Xaw), Ctrl-osfEndLine (Motif)

[goto-page()] Moves to the last page of the document.

Home (Xaw), osfBeginLine (Motif)

[home-or-top()] Move to the ``home'' position of the page, or to the top of the page if the keep flag is set (in this case, the page doesn't scroll horizontally).

End (Xaw), osfEndLine (Motif)

[end-or-bottom()] Move to the ``end'' position of the page (the lower right-hand corner), or to the bottom of the page if the keep flag is set (in this case, the page doesn't scroll horizontally).

Down arrow

[down(0.015)] Scrolls page down.

Up arrow

[up(0.015)] Scrolls page up.

Right arrow

[right(0.015)] Scrolls page right.

Left arrow

[left(0.015)] Scrolls page left.

Alt-Ctrl-+

[change-density(25)] Increase the darkness of the fonts in the DVI window by adding to the gamma value (see also the `S' keystroke).

Alt-Ctrl--

[change-density(-25)] Decrease the darkness of the fonts in the DVI window by subtracting from the gamma value (see also the `S' keystroke).

Ctrl-+

[set-shrink-factor(+)] Increase the shrink factor (see also the `s' keystroke).

Ctrl--

[set-shrink-factor(-)] Decrease the shrink factor (see also the `s' keystroke).

Ctr-[

[pagehistory-delete-backward()] Delete the current item in the page history and move to the history item before the deleted one. With a prefix argument n, delete n previous history items. See PAGE HISTORY for details.

[

[pagehistory-back()] Move back in the page history (see PAGE HISTORY for details). With a prefix argument n, move back n history items.

Ctr-]

[pagehistory-delete-forward()] Delete the current item in the page history and move to the history item after the deleted one. With a prefix argument n, delete n next history items. See PAGE HISTORY for details.

]

[pagehistory-forward()] Move forward in the page history (see PAGE HISTORY for details). With a prefix argument n, move forward n history items.

^

[home()] Move to the ``home'' position of the page. This is normally the upper left-hand corner of the page, depending on the margins as described in the -margins option, above.

?

[help()] Same as the h key (which see).

B

[htex-back()] This key jumps back to the previous hyperlink anchor. See the section HYPERLINKS for more information on navigating the links.

b

[back-page()] Moves to the previous page (or back n pages). Synonyms are `p' and Ctrl-h.

C

[set-color()] This key toggles the use of color specials. The key sequences `0C' and `1C' turn interpretation of color specials off and on, respectively. See also the -nocolor option.

c

[center()] Moves the page so that the point currently beneath the mouse cursor is moved to the middle of the window, and warps the mouse cursor to the same place.

d

[down()] Moves page down two thirds of a window-full. With a float argument to ``down'', moves down the corresponding fraction of a window-full.

Ctrl-f

[find()] Pop up a window to search for a string in the DVI file. See the section STRING SEARCH, below, for more details.

f

[forward-page()] Moves to the next page (or to the nth next page if a number is given). Synonyms are `n', Return, and Line Feed.

G

[set-greyscaling()] This key toggles the use of greyscale anti-aliasing for displaying shrunken bitmaps. In addition, the key sequences `0G' and `1G' clear and set this flag, respectively. See also the -nogrey option.

If given a numeric argument that is not 0 or 1, greyscale anti-aliasing is turned on, and the gamma resource is set to the value divided by 100. E.g., `150G' turns on greyscale and sets gamma to 1.5.

Ctrl-g

[find-next()] Find the next match string in the DVI file; this can be used instead of pressing the `Find' button in the search window.

g

[goto-page()] Moves to the page with the given number. If no page number is given, xdvi jumps to the last page. If the option/resource useTeXpages is active, the numbers correspond the the actual page numbers in the TeX file; otherwise, absolute page numbers (starting from 1) are used. In the latter case, the page numbers can be changed with the `P' keystroke, below. Note that with the useTeXpages option it is possible that the same page number occurs multiple times; in such a case, xdvi will use the first page number that matches.

h

Pops up a help window with a short explanation of the most important key bindings and concepts.

k

[set-keep-flag()] Normally when xdvi switches pages, it moves to the home position as well. The `k' keystroke toggles a `keep-position' flag which, when set, will keep the same position when moving between pages. Also `0k' and `1k' clear and set this flag, respectively. See also the -keep option.

Ctrl-l

[fullscreen(toggle)] Toggles fullscreen mode (see the description of the -fullscreen option for more information on this). This is even more flaky than using the command-line option: There is no universal standard how a window could change its own geometry or window decorations at run-time, so this will not work with most window managers or desktops. Generally, it's better to use the window manager controls to change the size or decorations of the xdvi window.

l

[left()] Moves page left two thirds of a window-full.

M

[set-margins()] Sets the margins so that the point currently under the mouse cursor defines the upper left-hand corner of the text in the page. Note that the command does not move the image, but only determines the margins for the page switching commands. For details on how the margins are used, see the -margins option.

m

[toggle-mark()] Toggles the mark for the current page in the page list. When a page is marked, it is displayed with a small star `*' next to the page number. The marked pages can then be printed or saved to a file. A page or several pages can also be marked by clicking or dragging Mouse-2 in the page list.

Ctrl-n

[toggle-mark()forward-page()] Toggles the mark for the current page in the page list, and moves to the next page. This lets you quickly mark a series of subsequent pages.

n

[forward-page()] Moves to the next page (or to the nth next page if a number is given). Synonyms are `f', Return, and Line Feed.

Ctrl-o

[select-dvi-file()] Read a new dvi file. A file-selection widget is popped up for you to choose the DVI file from. If a prefix argument n is given, the n th file from the file history is opened instead.

P

[declare-page-number()] ``This is page number n.'' This can be used to make the `g' keystroke refer to a different page number than the physical page. (If you want to use `logical' or TeX page numbers instead of physical pages, consider using the option -useTeXpages instead.) The argument n should be given as prefix to this key.

Ctrl-p

[print()] Opens a popup window for printing the DVI file, or parts of it. See the section PRINT DIALOG for an explanation of the options available, and the resources to customize the default behaviour.

p

[back-page()] Moves to the previous page (or back n pages). Synonyms are `b' and Ctrl-h.

q

[quit()] Quits the program.

Ctrl-r

[forward-page(0)] Redisplays the current page.

R

[reread-dvi-file()] Forces the dvi file to be reread. This allows you to preview many versions of the same file while running xdvi only once.

r

[right()] Moves page right two thirds of a window-full.

Ctrl-s

[save()] Opens a popup window for saving the DVI file, or parts of it. See the section SAVE DIALOG below for more information on this.

S

[set-density()] Sets the density factor to be used when shrinking bitmaps. This should be a number between 0 and 100; higher numbers produce lighter characters. If greyscaling mode is in effect, this changes the value of gamma instead. The new value of gamma is the given number divided by 100; negative values are allowed.

s

[set-shrink-factor()] Changes the shrink factor to the given number. If no number is given, the smallest factor that makes the entire page fit in the window will be used. (Margins are ignored in this computation.)

T

[use-tex-pages()] Use logical TeX pages (the values of the \count0 register) instead of physical pages for the pagelist labels and when jumping to a page in a document via goto-page(). See also the -useTeXpages option.

t

[switch-magnifier-units()] Switches the units used for the magnifier tick marks, and for reporting the distance between the mouse pointer and the ruler centre in ruler mode (see the section MODES). The default value is specified by the X resource tickUnits (`mm' by default). The units toggle through the following values; except for `px', they all correspond to TeX's units: mm (millimeters) pt (TeX points), in (inches), sp (scaled points, the unit used internally by TeX) bp (big points or `Postscript points'), cc (cicero points), dd (didot points), pc (pica), and px (screen pixels).

Ctrl-u

[back-page()toggle-mark()] Moves to the previous page, and toggles the mark for that page. This is the dual action to Ctrl-n.

u

[up()] Moves page up two thirds of a window-full. With a float argument to ``up'', moves up the corresponding fraction of a window-full.

Ctrl-v

[show-source-specials()] Show bounding boxes for every source special on the current page, and print the strings contained in these specials to stderr. With prefix 1, show every bounding box on the page. This is for debugging purposes mainly.

V

[set-gs-alpha()] This key toggles the anti-aliasing of PostScript<tm> specials when Ghostscript is used as renderer. In addition the key sequences `0V' and `1V' clear and set this flag, respectively. See also the -gsalpha option.

v

[set-ps()] This key toggles the rendering of PostScript<tm> specials between 3 states:

- specials (like EPS graphics) are displayed;

- specials are displayed along with their bounding box (if available);

- only the bounding box is displayed.

The states can also be selected directly by using `1v', `2v' and `0v' respectively. See also the -postscript option.

Ctrl-x

[source-what-special()] Display information about the source special next to the mouse cursor in the statusline. This is the same special that would be found by source-special() , but without invoking the editor. For debugging purposes.

x

[set-expert-mode()] Toggles expert mode, in which the statusline, the scrollbars, the menu buttons, the toolbar (Motif only) and the page list are not shown. Typing `1x' toggles the display of the statusline at the bottom of the window. Typing `2x' toggles the scrollbars (if available). For Xaw, `3x' toggles the menu buttons and the page list, for Motif, it toggles the page list. In Motif, the additional bindings `4x' toggle the toolbar, and `5x' the menu bar. Without a prefix argument, all of the mentioned GUI elements are either switched on (if they had been invisible before) or off. Toggling the scrollbars may behave erratically with the Xaw widgets; e.g. the scrollbars may reappear after resizing the window, and at certain window sizes one of the scrollbars may fail to disappear. See also the option -expertmode (the numbers above correspond to the bits in the argument to -expertmode).

Mouse-1

[do-href()magnifier(*1)]

Mouse-2

[do-href-newwindow()magnifier(*2)] Usually, if a binding specifies more then one action, all actions are executed in a sequence. The hyperlink bindings do-href() and do-href-newwindow() are special in that they are used as an alternative to other actions that might follow them if the mouse is currently located on a hyperlink. In this case, none of the other actions will be executed. Otherwise, only the other actions are executed. The action do-href() jumps to the link target in the current xdvi window (eventually switching to another page), and do-href-newwindow() opens a new instance of xdvi for the link target. In both cases, the location of the target is indicated by a small arrow drawn in the same color as a visited link in the left corner of the window.

Mouse-3

[magnifier(*3)] The actions magnifier(n) will pop up a ``magnifying glass'' which shows the unshrunk image of the region around the mouse pointer. The magnifier disappears when the mouse button is released. Moving the mouse cursor while holding the button down will move the magnifier. In `Ruler Mode', the first button moves or sets a ruler cross instead; see the section MODES, below, for details. Different mouse buttons produce different sized windows, as indicated by the the argument of the magnifier() action. Its argument is either a string of the form widthxheight, as in the -mgsn command-line option, or one of the strings *1 through *5, referring to the value specified by the corresponding -mgsn option. Note that in order to assign magnifier actions to the buttons 4 or 5, you need to use the resource wheelTranslations (more about this resource below), e.g.:

xdvi.wheelTranslations: <Btn4Down>: magnifier(*4)\n\ <Btn5Down>:magnifier(*5)\n

Shift-Mouse-1

[drag(+)]

Shift-Mouse-2

[drag(|)]

Shift-Mouse-3

[drag(-)] Drags the page with the mouse. Shift-Mouse 1 allows dragging in all directions, Shift-Mouse 2 allows vertical dragging only, and Shift-Mouse 3 allows horizontal dragging only. To access these actions via customization, use the drag action. This action should have one parameter, the character ``|'', ``-'', or ``+'', indicating vertical dragging, horizontal dragging, or dragging in both directions.

Ctrl-Mouse-1

[source-special()] Holding down the Ctrl key and clicking mouse button 1 starts a ``reverse search'', opening the editor at the location in the TeX file corresponding to the pointer location in the DVI file. See the section on SOURCE SPECIALS, below, for more information on this.

quit-confirm()

Pops up a confirmation window to quit xdvi. To bind it to the `q' key instead of the default `quit()' action, put the following into your ~/.Xdefaults file:

xdvi.mainTranslations: #override\ <Key>q: quit-confirm()\n

down-or-next()

Similar to unpause-or-next(): Moves down two-thirds of a window-full, or to the next page if already at the bottom of the page.

shrink-to-dpi()

This action takes one (required) argument. It sets the shrink factor to an integer so as to approximate the use of fonts with the corresponding number of dots per inch. If xdvi is using fonts scaled for p dots per inch, and the argument to shrink-to-dpi is n, then the corresponding shrink factor is the ratio p/n, rounded to the nearest integer.

An exception to this are the Motif keys osfPageUp (PgUp), osfPageDown (PgDown), osfBeginLine (Home) and osfEndLine (End) which are currently not customizable in the Motif version.

Key actions will usually be without arguments; if they are passed an argument, it represents the optional number or `prefix argument' typed prior to the action.

Some key actions may take special arguments, as follows: The argument of goto-page may be the letter `e', indicating the action of going to the end of the document. The argument of set-shrink-factor may be the letter `a', indicating that the shrink factor should be set to the smallest value such that the page will fit in the window, or one of the signs `+' or `-', indicating that the shrink factor should be increased or decreased, respectively. Finally, actions that would perform a toggle, such as set-keep-flag, may receive an argument `t', indicating that the action should toggle regardless of the current prefix argument.

Mouse actions should refer only to ButtonPress events (e.g., <Btn1Down>:magnifier(*1)). The corresponding motion and release events will be handled internally. A key action may be bound to a mouse event, but not vice versa.

Usually the string of translations should begin with ``#override'', indicating that the default key and mouse button assignments should not be discarded.

When keys or mouse buttons involving modifiers (such as Ctrl or Shift) are customized together with their non-modified equivalents, the modified keys should come first, for example:

xdvi.mainTranslations: #override \
Ctrl<Btn1Down>: magnifier(*3)\n\
Shift<Btn1Down>: magnifier(*2)\n\
<Btn1Down>: magnifier(*1)\n

Note: The additional `Modes' for Mouse-1 (Ruler Mode, Text Mode - see the section MODES) only work if Mouse-1 has the magnifier() action bound to it.

Because xdvi needs to capture pointer motion events, and because the X Toolkit translations mechanism cannot accommodate both motion events and double-click events at the same time, it is not possible to specify double-click actions in xdvi customizations. For information on this and other aspects of translations, see the X Toolkit Intrinsics documentation.

There is no command-line option to set the mainTranslations resource, since changing this resource on the command line would be cumbersome. To set the resource for testing purposes, use the -xrm command-line option provided by the X toolkit. For example, xdvi -xrm 'XDvi.mainTranslations: #override "z":quit()' ... or xdvi -xrm 'XDvi.mainTranslations: #override <Key>z:quit()' ... will cause the key `z' to quit xdvi.

Support of wheel mice is controlled by the wheelTranslations resource. Generally the only action routine called by this resource should be wheel. The default value is ``<Btn4Down>:wheel(-1.)\n<Btn5Down>:wheel(1.)''. Because this resource is implemented differently from the others, it should not begin with ``#override''; when specifying a value for this resource, all wheel actions should be included.

Some resources are provided to allow customization of the geometry of the Xaw command buttons. Again, they are not changeable via command-line options, other than via the -xrm option. All of these resources take integer values.

buttonSideSpacing

The number of pixels to be placed on either side of the buttons. The default value is 6.

buttonTopSpacing

The number of pixels between the top button and the top of the window. The default value is 50.

buttonBetweenSpacing

The number of pixels between the buttons. The default value is 20.

buttonBetweenExtra

The number of pixels of additional space to be inserted if the buttonTranslations resource string contains an extra newline character. The default value is 50.

buttonBorderWidth

The border width of the button windows. The default value is 1.

Mouse-1

Jumps to the page the mouse is located on.

Mouse-2

[toggle-mark()] Toggle the mark of the current page. The marks are used by the `Print' and `Save to file' dialogs to select only marked pages from the DVI file.

When the mouse pointer is inside the page list, the mouse wheel switches to the next or previous page.

The scrollbars can be removed via the -expertmode flag/keystroke (which see).

Wheel mice are supported: motion of the wheel on such a mouse moves the image up or down by the number of pixels indicated by the -wheelunit option. To access this option via customization, use the wheel action. This action takes one parameter, giving the distance to scroll the image. If the parameter contains a decimal point, the distance is given in wheel units; otherwise, pixels.

When one of the history commands is used, the page history is displayed in the status line at the bottom of the window, with the current list item marked by square brackets `[', `]' and a left and right context of at most 10 items. File boundaries are marked by `#'.

The size of the history can be customized with the X resource pageHistorySize (the default size is 1000 items). If the size is set to 0, the history commands are disabled.

If the link target is not a file on the local disk, xdvi tries to launch a web browser (as specified by the -browser command line option, the BROWSER environment variable or the wwwBrowser X resource, in this order) to retrieve the document. See the description of the BROWSER environment variable, below, for an example setting.

If the file is a local file, xdvi tries to determine if it is a DVI file. If it is, xdvi will try to display the file; otherwise it will try to determine the MIME type of the file, and from that an application suitable for opening the file. This is done by parsing the files specified by the environment variable EXTENSIONMAPS for a mapping of filename extensions to MIME types, and the files determined by the environment variable MAILCAPS for a mapping of MIME types to application programs. See the descriptions of these variables in the section ENVIRONMENT, below, for a more detailed description and the default values of these variables. If no suitable files are found, a set of built-in default MIME types and applications is used.

Xdvi currently uses no heuristics apart from the filename suffix to determine the mime type of a file. If a filename has no suffix, the value of the resource noMimeSuffix is used (by default application/x-unknown). If the suffix doesn't match any of the suffixes in mime.types, the value of the resource unknownMimeSuffix is used (by default application/x-unknown). If the mailcap entries do not list a viewer for a given mime type, xdvi will show a warning popup. If you want to avoid this warning, and for example want to always use the netscape browser for unknown MIME types, you could add the following line to your ~/.mailcap file:

application/xdvi-unknown; \
    netscape -raise -remote 'openURL(%s,new-window)'

By default, the matches are highlighted in inverted color. If the display isn't running in TrueColor, or if the X resouce matchHighlightInverted is set to false or the command-line option -nomatchinverted is used, xdvi will instead draw a rectangle in highlight color (see the -hl option) around the match.

If a match crosses a page boundary, only the part on the first page is highlighted. Xdvi will scan up to 2 adjacent pages to match strings crossing page boundaries; but note that header or footer lines, or intervening float pages will be treated as parts of the scanned text. Such text will usually cause multi-page matching to fail.

This emphasizes the fact that searching in the formatted text (the DVI output) works differently from searching in the source text: Searching in the DVI file makes it easier to skip formatting instructions, and makes it possible to search for e.g. hyphenation and equation numbers; but sometimes the formatting results can also get in the way, e.g. in the case of footnotes. In these cases it's better to search in the TeX source instead. The use of source specials will make switching between the xdvi display and the editor with the TeX source easier; see the section SOURCE SPECIALS below for more information on this.

The text extracted from the DVI file is in encoded in UTF-8 (you can view that text by saving the file in UTF-8 format via the File > Save as ... menu item). If xdvi has been compiled with locale, nl_langinfo() and iconv support, the search term is converted from the character set specified by the current locale into UTF-8. (See the output of locale -a for a list of locale settings available on your system). If nl_langinfo() is not available, but iconv is, you can specify the input encoding for iconv via the X resource textEncoding (see the output of iconv -l for a list of valid encodings). If iconv support is not available, only the encodings ISO-8859-1 and UTF-8 are supported (these names are case-insensitive).

Ideographic characters from CJKV fonts are treated specially: All white space (spaces and newlines) before and after such characters is ignored in the search string and in the DVI file.

To match a newline character, use \n in the search string; to match the string \n, use \\n.

If the checkbox Regular Expression is activated, the string is treated as a regular expression in extended POSIX syntax, with the following properties:

-

a? matches a zero or one times.

-

a* matches a zero or more times.

-

a+ matches a one or more times. Note that * and + are greedy, i.e. they match the longest possible substring.

-

The pattern . matches any character except for newline. To also match a newline, use `(.|\n)'.

-

a{n} matches a exactly n times.

-

a{n,m} matches a at least n and no more than m times.

-

a|b matches a or b. Brackets can be used for grouping, e.g.: (a|b)|c.

-

The string matched by the nth group can be referenced by \n, e.g. \1 refers to the first match.

-

The characters ^ and $ match the beginning and the end of a line, respectively.

-

[abc] matches any of the letters a, b, c, and [a-z] matches all characters from a to z.

-

Each item in a regular expression can also be one of the following POSIX character classes:

[[:alnum:]] [[:alpha:]] [[:blank:]] [[:cntrl:]] [[:digit:]]
[[:graph:]] [[:lower:]] [[:print:]] [[:space:]] [[:upper:]]

These can be negated by inserting a ^ symbol after the first bracket: [^[:alpha:]]

For more details on POSIX regular expressions, see e.g. the IEEE Std 1003.1 standard definition available online from:

-
As a non-standard extension, the following Perl-like
abbreviations can be used instead of the POSIX classes:
Symbol   Meaning                       POSIX Class

    \w   an alphanumeric character     [[:alnum:]]
    \W   a non-alphanumeric character  [^[:alnum:]]
    \d   a digit character             [[:digit:]]
    \D   a non-digit character         [^[:digit:]]
    \s   a whitespace character        [[:space:]]
    \S   a non-whitespace character    [^[:space:]]
-
The following characters are special symbols; they need to be
escaped with \ in order to match them literally: ( ) [ ]
. * ? + ^ $ \.
-
Matches of length zero are silently skipped.

The dialog also provides checkboxes to:

-

search backwards;

-

match in a case-sensitive manner (the default is to ignore case, i.e. a search string Test will match both the strings test and TEST in the DVI file);

-

ignore line breaks and hyphens: This removes all hyphens at the ends of lines and the following newline characters, and replaces all remaining newline characters by white spaces. So hyphenated words will appear as one word to the search, and a search for two words with a space in between will also match the words if they are separated by a linebreak. Note that the hyphen removal may cause unwanted side effects for compound words containing hyphens that are wrapped after the hyphen, and that replacing the newlines affects the interpretation of regular expressions as follows: The . pattern will also match newlines, and ^ and $ won't match begin and end of lines any more. (Since currently there is no option for turning off the greediness of * and +, turing on this option will usually result in matches that are longer than desired.)

The current checkbox settings are saved in the ~/.xdvirc file.

The value of the Printer text filed is passed to dvips via the -o! mechanism, as a single argument after the `!'. Any arguments listed in the Dvips options field are segmeted at whitespaces and passed as separate arguments to dvips. If you e.g. want to print the file 2-up, you should enter the following string into the Printer field:

    psnup -2 -q | lpr -Plp

There are several resources for customizing the behaviour and the default entries of the print dialog:

dvipsPrinterString

dvipsOptionsString

These can be used to provide default entries for the Printer and the Dvips options text fields, respectively. If no paper size is specified in the DVI file (via e.g. \usepackage[dvips]{geometry} - this is the preferred method), the input field is initialized with the current value of the command line option/X resource paper. E.g., the option -paper a4r is translated into the dvips options -t a4 -t landscape. Note that no check is performed whether dvips actually understands these options (it will ignore them if it can't); currently not all options used by xdvi are also covered by dvips.

dvipsHangTime

dvipsFailHangTime

These specify the time (in milliseconds) that the printing progress window will stay open after the dvips process has terminated. The value of dvipsHangTime is used if the process terminates successfully; dvipsFailHangTime is used if it terminates with an error. The default values are 1.5 and 5 seconds, respectively. If both values are negative, the window will stay open until it is closed by the user.

-

Postscript (uses dvips to convert the DVI file to a Postscript file, just like when printing to a Postscript file).

-

PDF (first uses dvips to convert the DVI file to a Postscript file, then uses ps2pdf to convert the Postscript file to PDF).

-

Plain text in ISO-8859-1 or UTF-8 encoding (the latter will preserve more of the special LaTeX characters e.g. from mathematical mode). If a character cannot be displayed in the selected charset, it is replaced by `\' followed by the hexadecimal character code. If a character is not recognized at all, it is replaced by `?'. If you think that xdvi should recognize a character but doesn't, please send a feature request to the address given in AUTHORS below. Likewise, if you observe spurious spaces or unwanted linebreaks in the output, please report this as a bug.

The programs for Postscript and PDF conversion can be customized via the command line options or X resources -dvipspath/.dvipsPath and -ps2pdfpath/.ps2pdfPath, respectively; see the explanation of these options above for more details.

Note: The modes are implemented by changing the magnifier() action. Switching the mode will not work if Mouse-1 has been customized to an action sequence that does not contain the magnifier() action.

Magnifier Mode

In this mode, the mouse buttons 1 to 5 pop up a ``magnifying glass'' that shows an unshrunken image of the page (i.e. an image at the resolution determined by the option/X resource pixels or mfmode) at varying sizes. When the magnifier is moved, small ruler-like tick marks are displayed at the edges of the magnifier (unless the X resource delayRulers is set to false, in which case the tick marks are always displayed). The unit of the marks is determined by the X resource tickUnits (mm by default). This unit can be changed at runtime via the action switch-magnifier-units(), by default bound to the keystroke `t' (see the description of that key, and of switch-magnifier-units() for more details on the units available). The length of the tick marks can be changed via the X resource tickLength (4 by default). A zero or negative value suppresses the tick marks.

Text Selection Mode

This mode allows you to select a rectangular region of text in the DVI file by holding down Mouse-1 and moving the mouse. The text is put into the X primary selection so that it can be pasted into other X applications with Mouse-2 as usual. If xdvi has been compiled with locale, nl_langinfo() and iconv support, the selected text is converted into the character set of the current locale (see the output of locale -a for a list of locale settings available on your system). If nl_langinfo() is not available, but iconv is, you can specify the input encoding for iconv via the X resource textEncoding (see the output of iconv -l for a list of valid encodings). If iconv support is not available, only the encodings ISO-8859-1 and UTF-8 are supported (these names are case-insensitive). Note that UTF-8 is the only encoding that can render all characters (e.g. mathematical symbols) of a DVI file. If ISO-8859-1 is active, characters that cannot be displayed are replaced by `\' followed by the hexadecimal character code. For other encodings, such characters may trigger iconv error messages. If a character is not recognized at all, it is replaced by `?'. To extract larger portions of text, you can alternatively save selected pages or the entire file in text format via the File > Save as ... menu.

Ruler Mode

This mode provides a simple way of measuring distances on the page. When this mode is activated, the mouse cursor changes into a thin cross, and a larger, cross-shaped ruler is drawn in the highlight color at the mouse location. The ruler doesn't have units attached to it; instead, the current distance between the ruler and the mouse cursor is continously printed to the statusline. When activating Ruler Mode, the ruler is at first attached to the mouse and can be moved around. It can then be positioned at a fixed place by clicking Mouse-1. After that, the mouse cursor can be moved to measure the horizontal (dx), vertical (dy) and direct (shortest) (dr) distance between the ruler center point and the mouse. Clicking Mouse-1 again will move the ruler to the current mouse position, and holding down Mouse-1 will drag the ruler around. In Ruler Mode, the following special keybindings extend or replace the default bindings:

o

[ruler-snap-origin()] Snap the ruler back to the origin coordinate (0,0).

t

[overrides switch-magnifier-units()] Toggle between various ruler units, which can be specified by the X resource tickUnits (`mm' by default).

P

[overrides declare-page-number()] Print the distances shown in the statusline to standard output.

The resource toolbarTranslations can be used to map icons/buttons to specific actions. The resource should contain a string separated by newline characters, similar to the resources mainTranslations and menuTranslations. Every line must contain either a spacer definition, or an icon definition:

A spacer definition is a string SPACER(n), where n is the number of pixels inserted as separator to the following button.

An icon definition is a colon-separated list containing the following elements:

- the index of an icon in the pixmap file (starting from zero);

- a long tooltip string, displayed in the status area;

- a short tooltip string, displayed as popup;

- a sequence of actions to be performed when the corresponding toolbar button is pushed.

To illustrate this, the default value of toolbarTranslations looks as follows:

xdvi.toolbarTranslations: \
   SPACER(5)\n\
   0:Open a new document   (Key\\: Ctrl-f):\
        Open file:select-dvi-file()\n\
   SPACER(10)\n\
   1:Reread this document   (Key\\: R):\
        Reread file:reread-dvi-file()\n\
   SPACER(10)\n\
   2:Go to the first page of this document   (Key\\: 1g):\
        Go to first page:goto-page(1)\n\
   3:Go to the previous page of this document   (Key\\: p):\
        Go to previous page:back-page(1)\n\
   4:Go to the next page of this document   (Key\\: n):\
        Go to next page:forward-page(1)\n\
   5:Go to the last page of this document   (Key\\: g):\
        Go to last page:goto-page()\n\
   SPACER(10)\n\
   6:Enlarge the display   (Key\\: Ctrl-+):Zoom in:\
        set-shrink-factor(+)\n\
   7:Shrink the display   (Key\\: Ctrl--):Zoom out:\
        set-shrink-factor(-)\n\
   SPACER(10)\n\
   8:Jump back to the previous hyperlink   (Key\\: B):\
        Back hyperlink:htex-back()\n\
   SPACER(10)\n\
   10:Print this document:Print:print()\n\
   SPACER(10)\n\
   11:Toggle marks for odd pages   (Key\\: 1m):\
        Toggle odd:toggle-mark(1)\n\
   12:Toggle marks for even pages   (Key\\: 2m):\
        Toggle even:toggle-mark(2)\n\
   13:Toggle mark for current page   (Key\\: 2m):\
        Toggle current:toggle-mark()\n\
   14:Unmark all pages   (Key\\: 0m):\
        Unmark all:toggle-mark(0)\n\
   SPACER(10)\n\
   18:Display fonts darker   (Key\\: Alt-Ctrl-+):\
        Fonts darker:change-density(5)\n\
   19:Display fonts lighter   (Key\\: Alt-Ctrl--):\
        Fonts lighter:change-density(-5)\n

When the mouse remains over a toolbar button for a certain period, a `tooltip' window is shown, describing what the button does using the short tooltip string from the above resource. At the same time, the long tooltip string is displayed in the statusline. The appearance and behaviour of these tooltips can be customized via the following resources:

tipShell.background

Background color of the tooltip window.

tipShell.fontSet

Font used for the tooltip.

tipShell.waitPeriod

The time (in milliseconds) the mouse pointer needs to be over the button before the tooltip is shown. Set it to a negative value to suppress the tooltips altogether.

Typically this problem occurs on displays that allocate eight bits of video memory per pixel. To see how many bits per pixel your display uses, type xwininfo in an xterm window, and then click the mouse on the root window when asked. The ``Depth:'' entry will tell you how many bits are allocated per pixel.

Displays using at least 15 bits per pixel are typically TrueColor visuals, which do not have this problem, since their colormap is permanently allocated and available to all applications. (The visual class is also displayed by xwininfo.) For more information on visual classes see the documentation for the X Window System.

To alleviate this problem, therefore, one may (a) run with more bits per pixel (this may require adding more video memory or replacing the video card), (b) shut down other applications that may be using much of the colormap and then restart xdvi, or (c) run xdvi with the -install option.

One application which is often the cause of this problem is Netscape. In this case there are two more alternatives to remedying the situation. One can run ``netscape -install'' to cause Netscape to install a private colormap. This can cause colors to change in bizarre ways when the mouse is moved to a different window. Or, one can run ``netscape -ncols 220'' to limit Netscape to a smaller number of colors. A smaller number will ensure that other applications have more colors available, but will degrade the color quality in the Netscape window.

    src:line[ ]filename
    src:line:col[ ]filename
    src:line
    src:line:col
    src::col

You will need a TeX implementation that provides an appropriate switch (e.g. -src) or a macro package (such as srcltx.sty or srctex.sty, available from CTAN:macros/latex/contrib/supported/srcltx/) to insert such source specials into the DVI file.

For reverse search, the combination Ctrl-Mouse 1 will make xdvi open an editor (the value of the -editor command line option) with the file and the line number of the .tex source. See the description of the -editor option for more information and example settings. For forward search, xdvi has a -sourceposition option that makes xdvi jump to the page in the DVI file corresponding to the given line (or the closest line having a source special) of the specified file and highlight the found region. See the description of the -sourceposition option for more details.

More information on setting up various editors for use with source specials can be found at: