View Source: xdvi.real(1) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages
XDVI
!!!XDVI
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
KEYSTROKES
MOUSE ACTIONS
UNBOUND ACTIONS
CUSTOMIZATION
SIGNALS
GREYSCALING AND COLORMAPS
ENVIRONMENT
HANDLING OF POSTSCRIPT FIGURES
SOURCE SPECIALS
ENVIRONMENT
LIMITATIONS
FILES
SEE ALSO
AUTHORS
----
!!NAME


xdvi - DVI Previewer for the X Window System
!!SYNOPSIS


__xdvi__ [[__+__[[''page'']] [[__-s__
''shrink''] [[__-S__ ''density''] [[__-nogrey__]
[[__-gamma__ ''g''] [[__-install__]
[[__-noinstall__] [[__-p__ ''pixels'']
[[__-margins__ ''dimen''] [[__-sidemargin__
''dimen''] [[__-topmargin__ ''dimen'']
[[__-offsets__ ''dimen''] [[__-xoffset__
''dimen''] [[__-yoffset__ ''dimen''] [[__-paper__
''papertype''] [[__-altfont__ ''font'']
[[__-nomakepk__] __-mfmode__
''mode-def''[[__:__''dpi''] [[__-editor__
''command''] [[__-sourceposition__
''line''[[__:__''col''][[ ]''filename'']
[[__-l__] [[__-rv__] [[__-expert__]
[[__-__[[__no__]__statusline__]
[[__-shrinkbutton__''n shrink''] [[__-mgs__[[''n'']
''size''] [[__-warnspecials__] [[__-hush__]
[[__-hushchars__] [[__-hushchecksums__]
[[__-hushspecials__] [[__-hushstdout__] [[__-safer__]
[[__-fg__ ''color''] [[__-bg__ ''color'']
[[__-hl__ ''color''] [[__-bd__ ''color'']
[[__-cr__ ''color''] [[__-bw__ ''width'']
[[__-grid1__ ''color''] [[__-grid2__ ''color'']
[[__-grid3__ ''color''] [[__-bw__ ''width'']
[[__-display__ ''host:display''] [[__-geometry__
''geometry''] [[__-icongeometry__ ''geometry'']
[[__-iconic__] [[__-font__ ''font''] [[__-keep__]
[[__-copy__] [[__-thorough__] [[__-wheelunit__
''pixels''] [[__-nopostscript__] [[__-noscan__]
[[__-allowshell__] [[__-noghostscript__]
[[__-nogssafer__] [[__-gsalpha__] [[__-interpreter__
''path''] [[__-gspalette__ ''palette'']
[[__-not1lib__] [[__-underlink__] [[__-browser__
''WWWbrowser''] [[__-base__ ''base URL'']
[[__-debug__ ''bitmask''] [[__-version__]
[[''dvi_file'']
!!DESCRIPTION


__xdvi__ is a program which runs under the X window
system. It is used to preview ''dvi'' files, such as are
produced by tex(1).


This program has the capability of showing the file shrunken
by various (integer) factors, and also has a ``magnifying
glass'' which allows one to see a small part of the unshrunk
image momentarily. Other new features are: it can display
Postscript


Before displaying any page or part thereof, it checks to see
if the ''dvi'' file has changed since the last time it
was displayed. If this is the case, then __xdvi__ will
reinitial- ize itself for the new ''dvi'' file. For this
reason, expos- ing parts of the __xdvi__ window while TEX
is running should be avoided. This feature allows you to
preview many ver- sions of the same file while running
__xdvi__ only once.


In addition to using keystrokes to move within the file,
__xdvi__ provides buttons on the right side of the
window, which are synonymous with various sequences of
keystrokes.


__xdvi__ can show !PostScript
__xdvi__.


For performance reasons, __xdvi__ does not render
!PostScript specials in the magnifying glass.


If ''dvi_file'' is not specified, a file-selection widget
is popped up for you to choose the ''dvi''
file.
!!OPTIONS


In addition to specifying the ''dvi'' file (with or
without the __.dvi__ extension), __xdvi__ supports the
following command line options. If the option begins with a
`__+__' instead of a `__-__', the option is restored
to its default value. By default, these options can be set
via the resource names given in parentheses in the
description of each option.


__+__''page''


Specifies the first page to show. If __+__ is given
without a number, the last page is assumed; the first page
is the default.


__-allowshell__


(__.allowShell__) This option enables the shell escape in
!PostScript specials. (For security reasons, shell escapes
are disabled by default.) This op- tion should be rarely
used; in particular it should not be used just to uncompress
files: that function is done automatically if the file name
ends in __.Z__, __.gz__, or __.bz2__. Shell escapes
are always turned off if the __-safer__ option is
used.


__-altfont__ ''font''


(__.altFont__) Declares a default font to use when the
font in the ''dvi'' file cannot be found. This is use-
ful, for example, with !PostScript
''


__-background__ ''color''


(__.background__) Determines the color of the back-
ground. Same as __-bg__.


__-base__ ''base URL''


(__.urlBase__) Sets the base URL value that external
links given in the ''dvi'' file are assumed relative to -
normally this should be the URL of the document itself
(?).


__-bd__ ''color''


(__.borderColor__) Determines the color of the window
border.


__-bg__ ''color''


(__.background__) Determines the color of the back-
ground.


__-bordercolor__ ''color''


Same as __-bd__.


__-borderwidth__ ''width''


(__.borderWidth__) Specifies the width of the border of
the window. Same as __-bw__.


__-browser__ ''WWWbrowser''


(__.wwwBrowser__) Defines the World Wide Web browser to
be used to handle external URL's, for example mosa- ic. If
neither the command-line option nor the X resource are set,
uses the environment variable WWWBROWSER.


__-bw__ ''width''


(__.borderWidth__) Specifies the width of the border of
the window.


__-copy__


(__.copy__) Always use the ''copy'' operation when
writing characters to the display. This option may be nec-
essary for correct operation on a color display, but
overstrike characters will be incorrect. If greyscale
anti-aliasing is in use, the __-copy__ opera- tion will
disable the use of colorplanes and make overstrikes come out
incorrectly. See also __-thor- ough__.


__-cr__ ''color''


(__.cursorColor__) Determines the color of the cursor.
The default is the color of the page border.


__-debug__ ''bitmask''


(__.debugLevel__) If nonzero, prints additional infor-
mation on standard output. The number is taken as a set of
independent bits. The meaning of each bit follows.
1=bitmaps; 2=dvi translation; 4=pk read- ing; 8=batch
operation; 16=events; 32=file opening; 64=!PostScript
communication; 128=Kpathsea stat(2) calls; 256=Kpathsea hash
table lookups; 512=Kpath- sea path definitions;
1024=Kpathsea path expansion; 2048=Kpathsea searches. To
trace everything having to do with file searching and
opening, use 4000. Some of these debugging options are
actually pro- vided by Kpathsea. See the Debugging section
in the Kpathsea manual.


__-density__ ''density''


(__.densityPercent__) Determines the density used when
shrinking bitmaps for fonts. A higher value pro- duces a
lighter font. The default value is 40. If greyscaling is in
use, this argument does not ap- ply; use __-gamma__
instead. See also the `__S__' keystroke. Same as
__-S__.


__-display__
''host''__:__''display''


Specifies the host and screen to be used for dis- playing
the ''dvi'' file. By default this is obtained from the
environment variable
__DISPLAY.__


__-editor__ ''editor''


(__.editor__) Specifies the editor that will be invoked
when the ''source-special()'' action is triggered (by
default via CTRL-Mouse 1). The argument to this option is a
format string in which occurrences of ``__%f__'' are
replaced by the file name, occurrences of ``__%l__'' are
replaced by the line number within the file, and optional
occurrences of ``__%c__'' are replaced by the column
number within the line. If no ``__%f__'' or ``__%l__''
occurs in the string, a warning is given and the missing
designators are appended.


If neither the option nor the X resource ''.editor'' is
specified, the following environment variables are checked
to determine the editor command: __XEDITOR__,
__VISUAL__, and __EDITOR__ (in this sequence). If the
string is found as the value of the
__VISUAL__ or __EDI-
TOR__ environment variables, then ``''xterm
-e'' '' is prepended to the string; if the editor is
specified by other means, then it must be in the form of a
shell command to pop up an X window with an editor in it. If
none of these variables is set, the com- mand ``''xterm -e
vi %s +%d'''' is used and a warning message is
given.


A new instance of the editor is started each time this
command is used; therefore it is preferrable to use an
editor that can be invoked in `client' mode to load new
files into the same instance. Ex- ample settings
are:


''emacsclient --no-wait +%l %f'' (older
Emacsen),


''gnuclient -q +%l %f'' (XEmacs and newer
Emacsen)


''nc +%l %f'' (nedit)


Note that those strings need to be enclosed into quotes when
using them on the command-line to pro- tect them from the
shell; when using them as argu- ment for the ''.editor''
resource in an X resource file, no quotes should be
used.


__NOTE ON SECURITY:__ The argument of this option isn't
executed as a shell command, but via ''exec()'' to pre-
vent evil tricks with the contents of source spe- cials.
Execution of the ''-editor'' command is dis- abled when
the ''-safer'' option is used.


__-expert__


(__.expert__) Prevent the buttons from appearing. See
also the `__x__' keystroke.


__-fg__ ''color''


(__.foreground__) Determines the color of the text
(foreground).


__-foreground__ ''color''


Same as __-fg__.


__-font__ ''font''


(__*font__) Sets the font for use in the
buttons.


__-gamma__ ''gamma''


(__.gamma__) Controls the interpolation of colors in the
greyscale anti-aliasing color palette. Default value is 1.0.
For 0 __gamma''
''gamma''
''-density__. See also the `__S__'
keystroke


__-grid1__ ''color''


(__.grid1Color__) Determines the color of level 1 grid
(default as foreground)


__-grid2__ ''color''


(__.grid2Color__) Determines the color of level 2 grid
(default as foreground)


__-grid3__ ''color''


(__.grid3Color__) Determines the color of level 3 grid
(default as foreground)


__-geometry__ ''geometry''


(__*geometry__) Specifies the initial geometry of the
window.


__-gspalette__ ''palette''


(__.palette__) Specifies the palette to be used when
using Ghostscript for rendering !PostScript spe- cials.
Possible values are __Color__, __Greyscale__, and
__Monochrome__. The default is __Color__.


__-gsalpha__


(__.gsAlpha__) Causes __Ghostscript__ to be called
with the __x11alpha__ driver instead of the __x11__
driver. The __x11alpha__ driver enables anti-aliasing in
!PostScript figures, for a nicer appearance. It is available
on newer versions of __Ghostscript__. This option can
also be toggled with the `__V__' keystroke.


__-sourceposition__ ''line''[[__:__''col''][[
]''filename''


This option makes xdvi start in `client mode' to perform a
`forward search'. The main dvi file ''dvi_file'' is
specified on the command line as usual. `Forward search'
means that xdvi will try to open the page in ''dvi_file''
corresponding to the ''line'' (op- tionally also the
''column'') and ''filename'' of the .tex source, and
highlight the place found by drawing a rectangle in
''highlight'' colour (see the ''-hl'' option) around
the corresponding text. (This only works when the
''dvi_file'' has been prepared with source special
information; see the section SOURCE SPE- CIALS for more
information on this.)


`Client mode' means that if there is already anoth- er
instance of xdvi running on this X display and displaying
the same ''dvi_file'', a new instance start- ed with the
''-sourceposition'' option will only notify that running
instance to perform the forward search, and exit after that.
This way, other pro- grams such such as text editors may
invoke xdvi in `client mode' to jump to a specific place in
the .dvi file corresponding to the current cursor posi- tion
in the .tex file.


The argument for ''filename'' should be a string with the
same extension as the file name used for the source specials
in the ''dvi'' file. The space before ''filename'' is
only needed if the filename starts with a digit. When the
space is used, the argument needs to be encosed in quotes to
prevent the shell from misinterpreting the space as argument
separa- tor.


__-hl__ ''color''


(__.highlight__) Determines the color of the page bor-
der. The default is the foreground color.


__-hush__


(__.Hush__) Causes __xdvi__ to suppress all
suppressible warnings.


__-hushchars__


(__.hushLostChars__) Causes __xdvi__ to suppress
warnings about references to characters which are not de-
fined in the font.


__-hushchecksums__


(__.hushChecksums__) Causes __xdvi__ to suppress
warnings about checksum mismatches between the ''dvi''
file and the font file.


__-hushspecials__


(__.hushSpecials__) Causes __xdvi__ to suppress
warnings about __special__ strings that it cannot
process.


__-hushstdout__


(__.hushStdout__) Causes __xdvi__ to suppress all
status informations it would normally print to stdout if the
statusline is disabled.


__-icongeometry__ ''geometry''


(__.iconGeometry__) Specifies the initial position for
the icon.


__-iconic__


(__.iconic__) Causes the __xdvi__ window to start in
the iconic state. The default is to start with the window
open.


__-install__


(__.install__) If __xdvi__ is running under a
__!PseudoColor__ visual, then (by default) it will check
for __True- Color__ visuals with more bits per pixel, and
switch to such a visual if one exists. If no such visual
exists, it will use the current visual and col- ormap. If
__-install__ is selected, however, it will still use a
__!TrueColor__ visual with a greater depth, if one is
available; otherwise, it will install its own colormap on
the current visual. If the current visual is not
__!PseudoColor__, then __xdvi__ will not switch the
visual or colormap, regardless of its options. The default
value of the __install__ resource is the special value,
__maybe__. There is no __+install__ option. See also
__-noinstall__, and the GREYSCALING AND COLORMAPS
section.


__-interpreter__ ''filename''


(__.interpreter__) Use ''filename'' as the Ghostscript
in- terpreter. By default it uses __gs__.


__-keep__


(__.keepPosition__) Sets a flag to indicate that
__xdvi__ should not move to the home position when moving
to a new page. See also the `__k__'
keystroke.


__-l__


(__.listFonts__) Causes the names of the fonts used to be
listed.


__-margins__ ''dimen''


(__.Margin__) Specifies the size of both the top margin
and side margin. This determines the ``home'' po- sition of
the page within the window as follows. If the entire page
fits in the window, then the margin settings are ignored.
If, even after remov- ing the margins from the left, right,
top, and bot- tom, the page still cannot fit in the window,
then the page is put in the window such that the top and
left margins are hidden, and presumably the upper left-hand
corner of the text on the page will be in the upper
left-hand corner of the window. Other- wise, the text is
centered in the window. The di- mension should be a decimal
number optionally fol- lowed by any of the two-letter
abbreviations for units accepted by TEX (__pt__,
__pc__, __in__, __bp__, __cm__, __mm__,
__dd__, __cc__, or __sp__). By default, the unit
will be __cm__ (cen- timeters)__.__ See also
__-sidemargin__, __-topmargin__, and the keystroke
`__M__.'


__-mfmode__ ''mode-def''


(__.mfMode__) Specifies a ''mode-def'' string, which
can be used in searching for fonts (see ENVIRONMENT, be-
low). Generally, when changing the ''mode-def'', it is
also necessary to change the font size to the ap- propriate
value for that mode. This is done by adding a colon and the
value in dots per inch; for example, __-mfmode
ljfour:600__. This method overrides any value given by the
__pixelsPerInch__ resource or the __-p__ command-line
argument. The metafont mode is also passed to
__metafont__ during automatic creation of fonts. By
default, it is __unspecified__.


__-mgs__ ''size''


Same as __-mgs1__.


__-mgs__[[''n''] ''size''


(__.magnifierSize__[[''n'']) Specifies the size of the
win- dow to be used for the ``magnifying glass'' for Button
''n''. The size may be given as an integer (in- dicating
that the magnifying glass is to be square), or it may be
given in the form ''width''x- ''height''. See the
MOUSE ACTIONS section. Defaults are 200x150, 400x250,
700x500, 1000x800, and 1200x1200.


__-noghostscript__


(__.ghostscript__) Inhibits the use of Ghostscript for
displaying !PostScript
__-noghostscript__ corresponds to __ghostscript:off__;
__+noghostscript__ to
__ghostscript:on__.)


__-nogrey__


(__.grey__) Turns off the use of greyscale anti-alias-
ing when printing shrunken bitmaps. (For this op- tion, the
logic of the corresponding resource is reversed:
__-nogrey__ corresponds to __grey:off__;
__+nogrey__ to __grey:on__.) See also the `__G__'
keystroke.


__-nogssafer__


(__.gsSafer__) Normally, if Ghostscript is used to ren-
der !PostScript specials, the Ghostscript inter- preter is
run with the option __-dSAFER__. The __-nogssafer__
option runs Ghostscript without __-dSAFER__. The
__-dSAFER__ option in Ghostscript disables !PostScript
operators such as __deletefile__, to prevent possibly
malicious !PostScript programs from having any effect. If the
__-safer__ option is specified, then this option has no
effect; in that case Ghostscript is always run with
__-dSAFER__. (For the __-nogssafer__ option, the logic
of the corresponding resource is reversed: __-nogssafer__
corresponds to __gsSafer:off__; __+nogssafer__ to
__gsSafer:on__.)


__-noinstall__


(__.install__) Inhibit the default behavior of switch-
ing to a __!TrueColor__ visual if one is available with
more bits per pixel than the current visual. This option
corresponds to a resource of __install:off__. There is no
__+noinstall__ option. See also __-install__, and the
GREYSCALING AND COLORMAPS section.


__-nomakepk__


(__.makePk__) Turns off automatic generation of font
files that cannot be found by other means. (For this option,
the logic of the corresponding re- source is reversed:
__-nomakepk__ corresponds to __makePk:off__;
__+nomakepk__ to __makePK:on__.)


__-nopostscript__


(__.postscript__) Turns off rendering of
!PostScript
__v__' keystroke. (For this option, the log- ic
of the corresponding resource is reversed: __-no-
postscript__ corresponds to __postscript:off__;
__+postscript__ to __postscript:on__.)


__-noscan__


(__.prescan__) Normally, when !PostScript
__xdvi__ will do a preliminary scan of the
''dvi'' file, in order to send any necessary header files
before sending the !PostScript code that requires them. This
option turns off such prescanning. (It will be automatically
be turned back on if __xdvi__ de- tects any specials that
require headers.) (For the __-noscan__ option, the logic
of the corresponding re- source is reversed: __-noscan__
corresponds to __pres- can:off__; __+noscan__ to
__prescan:on__.)


__-offsets__ ''dimen''


(__.Offset__) Specifies the size of both the horizontal
and vertical offsets of the output on the page. By decree of
the Stanford TEX Project, the default TEX page origin is
always 1 inch over and down from the top-left page corner,
even when non-American paper sizes are used. Therefore, the
default offsets are 1.0 inch. The argument ''dimen''
should be a decimal number optionally followed by any of the
two-letter abbreviations for units accepted by TEX
(__pt__, __pc__, __in__, __bp__, __cm__,
__mm__, __dd__, __cc__, or __sp__). By default,
the unit will be __cm__ (centimeters)__.__ See also
__-xoffset__ and __-yoffset__.


__-p__ ''pixels''


(__.pixelsPerInch__) Defines the size of the fonts to
use, in pixels per inch. The default value is 600. This
option is provided only for backwards compati- bility; the
preferred way of setting the font size is by setting the
Metafont mode at the same time; see the __-mfmode__
option.


__-paper__ ''papertype''


(__.paper__) Specifies the size of the printed page. This
may be of the form ''width''__x__''height''
optionally followed by a unit, where ''width'' and
''height'' are dec- imal numbers giving the width and
height of the pa- per, respectively, and the unit is any of
the two-letter abbreviations for units accepted by TEX
(__pt__, __pc__, __in__, __bp__, __cm__,
__mm__, __dd__, __cc__, or __sp__). By de-
fault, the unit will be __cm__ (centimeters)__.__
There are also synonyms which may be used: __us__
(8.5x11in), __usr__ (11x8.5in), __legal__ (8.5x14in),
__foolscap__ (13.5x17in), as well as the ISO sizes
__a1__-__a7__, __b1__-__b7__,
__c1__-__c7__, __a1r__-__a7r__
(__a1__-__a7__ rotated), etc. The default size is 21 x
29.7 cm (A4 size).


__-rv__


(__.reverseVideo__) Causes the page to be displayed with
white characters on a black background, in- stead of vice
versa.


__-s__ ''shrink''


(__.shrinkFactor__) Defines the initial shrink factor.
The default value is 8. If ''shrink'' is given as 0, then
the initial shrink factor is computed so that the page fits
within the window (as if the `s' keystroke were given
without a number).


__-S__ ''density''


(__.densityPercent__) Same as __-density__,
''q.v.''


__-safer__


(__.safer__) This option turns on all available securi-
ty options; it is designed for use when __xdvi__ is
called by a browser that obtains a ''dvi'' or TEX file
from another site. This option turns off evaluta- tion of
source specials (see SOURCE SPECIALS for details).
Furthermore, it selects __+nogssafer__ and
__+allowshell__.


__-shrinkbutton__''n shrink''


(__.shrinkButton__''n'') Specifies that the ''n''th
button changing shrink factors shall change to shrink fac-
tor ''factor''. This is useful, e.g., when using 600 dpi
fonts, since in that case shrinking by a factor of 4 is
still not enough. Here ''n'' may be a number from 1 to 3
(in the default button layout, the ``Full Size'' button is
unaffected by these op- tions). If the buttons are
customized, higher val- ues of ''n'' (up to 9) may be
used.


__-sidemargin__ ''dimen''


(__.sideMargin__) Specifies the side margin (see __-mar-
gins__).


__-statusline__, __-nostatusline__


(__.statusline__) Display/do not display the statusline
at the bottom of the window. This can also be tog- gled with
the `__1x__' keystroke. If displaying the statusline is
disabled, the messages that would normally be printed to the
statusline will be printed to ''stdout''. To suppress
printing these mes- sages as well, use the
__-hushstdout__ option.


__-thorough__


(__.thorough__) __xdvi__ will usually try to ensure
that overstrike characters (''e.g.'', __notin__) are
printed correctly. On monochrome displays, this is always
possible with one logical operation, either ''and'' or
''or''. On color displays, however, this may take two
operations, one to set the appropriate bits and one to clear
other bits. If this is the case, then by default __xdvi__
will instead use the ''copy'' operation, which does not
handle overstriking correctly. The __-thorough__ option
chooses the slower but more cor- rect choice. See also
__-copy__.


__-topmargin__ ''dimen''


(__.topMargin__) Specifies the top and bottom margins
(see __-margins__).


__-not1lib__


(__.not1lib__) This will disable the use of T1Lib to
display !PostScript
__


__-underlink__


(__.underLink__) Underline links. Default is
true.


__-version__


Print information on the version of
__xdvi__.


__-warnspecials__


(__.warnSpecials__) Causes __xdvi__ to issue warnings
about __special__ strings that it cannot
process.


__-wheelunit__ ''pixels''


(__.wheelUnit__) Sets the number of pixels that a mo-
tion of a wheel mouse will move the image up or down. If set
to zero, the wheel mouse functionali- ty is disabled. The
default value is 80.


__-xoffset__ ''dimen''


(__.xOffset__) Specifies the size of the horizontal
offset of the output on the page. See
__-offsets__.


__-yoffset__ ''dimen''


(__.yOffset__) Specifies the size of the vertical off-
set of the output on the page. See
__-offsets__.
!!KEYSTROKES


__xdvi__ recognizes the following keystrokes when typed
in its window. Each may optionally be preceded by a
(positive or negative) number, whose interpretation will
depend on the particular keystroke. Also, the ``Help'',
``Home'', ``Prior'' and ``Next'' keys are synonyms for
`__?__', `__^__', `__b__', and `__f__' keys,
respectively.


The key assignments given here are those that __xdvi__
assigns by default. They can be changed--see CUSTOMIZATION,
be- low. The names appearing in brackets at the beginning of
each of the following keystroke definitions is the name
assigned to the action associated with that key, for use
when customizing. Users who do not customize their
keystrokes may ignore these labels.


__q__


[[__quit()__] Quits the program. Control-C and con- trol-D
will do this, too.


__n__


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


__Space__


[[__down-or-next()__] Moves down two-thirds of a win-
dow-full, or to the next page if already at the bottom of
the page.


__p__


[[__back-page()__] Moves to the previous page (or back
''n'' pages). Synonyms are `__b__' and
control-H.


Delete


[[__up-or-previous()__] Moves up two-thirds of a win-
dow-full, or to the bottom of the previous page if already
at the top of the page. The !BackSpace key will also do
this.


__g__


[[__goto-page()__] Moves to the page with the given num-
ber. Initially, the first page is assumed to be page number
1, but this can be changed with the `__P__' keystroke,
below. If no page number is given, then it goes to the last
page.


__P__


[[__declare-page-number()__] ``This is page number
''n''.'' This can be used to make the `__g__'
keystroke refer to actual page numbers instead of absolute
page num- bers.


__Control-L__


[[__forward-page(0)__] Redisplays the current
page.


__^__


[[__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.


__Up arrow__


[[__up(0.015)__] Scrolls page up.


__Down arrow__


[[__down(0.015)__] Scrolls page down.


__u__


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


__d__


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


__Left arrow__


[[__left(0.015)__] Scrolls page left.


__Right arrow__


[[__right(0.015)__] Scrolls page right.


__l__


[[__left()__] Moves page left two thirds of a win-
dow-full.


__r__


[[__right()__] Moves page right two thirds of a win-
dow-full.


__c__


[[__center()__] Moves the page so that the point cur-
rently beneath the cursor is moved to the middle of the
window. It also (gasp!) warps the cursor to the same
place.


__M__


[[__set-margins()__] Sets the margins so that the point
currently under the cursor is the upper left-hand corner of
the text in the page. Note that this command itself does not
move the image at all. For details on how the margins are
used, see the __-mar- gins__ option.


__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.)


__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; nega- tive values are allowed.


__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.


__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__ op-
tion.


__x__


[[__set-expert-mode()__] Toggles expert mode (in which the
buttons do not appear). Typing `__1x__' toggles the
display of the statusline at the bottom of the window. See
also the options __-expert__ and __-__[[__no__]sta-
tusline.


__Control-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.


__Control-x__


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


__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.


__D__


[[__toggle-grid-mode()__] This key toggles the use of grid
over the document. If no number is given, the grid mode
toggles. By prepending number, 3 grid levels can be set. The
grid in each level is drawn in the colour specified. See
also the __-grid1, -grid2,__ and __-grid3__
options.


__v__


[[__set-ps()__] This key toggles the rendering of
!PostScript
__0v__' and `__1v__' clear
and set this flag, respectively. See also the
__-nopostscript__ option.


__Control-F__


[[__select-dvi-file()__] Read a new ''dvi'' file. A
file-se- lection widget is popped up for you to choose the
dvi file from.


__V__


[[__set-gs-alpha()__] This key toggles the anti-aliasing
of !PostScript__Ghostscript__ is
used as renderer. In addition the key sequences `__0V__'
and `__1V__' clear and set this flag, respectively. See
also the __-gsalpha__ option.


__?__


[[__help()__] Pops up a help window with a short expla-
nation of the most important key bindings and con- cepts.
The help texts and menu entries are fully configurable via
the following X resources (the de- faults strings are given
in parentheses, or as '''' if they contain a
longer text):


__helpTopicsButtonLabel__ ''(Topic)''


__helpQuitButtonLabel__ ''(Close)''


__helpIntro__ ''''


__helpGeneralMenulabel__ ''(General)''


__helpGeneral__ ''''


__helpHypertexMenulabel__ ''(HyperTeX
commands)''


__helpHypertex__ ''''


__helpOthercommandsMenulabel__ ''(Other
Commands)''


__helpOthercommands__ ''''


__helpPagemotionMenulabel__ ''(Page
Motion)''


__helpPagemotion__ ''''


__helpSourcespecialsMenulabel__ ''(Source
Specials)''


__helpSourcespecials__ ''''.
!!MOUSE ACTIONS


If the shrink factor is set to any number other than one,
then clicking mouse button 3 will pop up a ``magnifying
glass'' which shows the unshrunk image in the vicinity of
the mouse click. This subwindow disappears when the mouse
button is released. Different mouse buttons produce dif-
ferent sized windows, as indicated by the __-mgs__
option. Moving the cursor while holding the button down will
move the magnifying glass. To access this feature via cus-
tomization, use the __magnifier__ action. Its argument is
ei- ther a string of the form ''width''x''height'', as
in the __-mgs__''n'' command-line option, or one of
the strings __*1__ through __*5__, referring to the
value specified by the corresponding __-mgs__''n''
option.


Holding down the ''CTRL'' key and clicking on mouse
button 1 starts a ``reverse search'' (action
__source-special()__; see the section on SOURCE SPECIALS
for details).


If the cursor is on a hypertext link (underlined by de-
fault), then that link overrides the magnifying glass for
Buttons 1 and 2. If Button 1 is clicked over a link, then
__xdvi__ jumps to the target in the current window. If
Button 2 is clicked over a link, then __xdvi__ opens a
new window on the target.


More precisely, for internal links, Button 1 jumps in the
same window to the link, while Button 2 starts up a new
__xdvi__ on the link. For external links to ''dvi''
files, Button 1 changes the current __xdvi__ to be
reading that file, while Button 2 starts a new __xdvi__
on that file. For other file types, __mime.types__ and
__mailcap__ are parsed to determine the viewer; finally,
if no suitable __mailcap__ entry was found, if the
__WWWBROWSER__ environment variable is
set, or __-browser__ was specified on the command line,
it is started up on the file.


The scrollbars (if present) behave in the standard way:
pushing Button 2 in a scrollbar moves the top or left edge
of the scrollbar to that point and optionally drags it;
pushing Button 1 moves the image up or right by an amount
equal to the distance from the button press to the upper
left-hand corner of the window; pushing Button 3 moves the
image down or left by the same amount.


The image can also be dragged around, by holding down the
shift key and a mouse button. Shift-button 1 will allow
vertical dragging only; Shift-button 3, horizontal drag-
ging; and Shift-button 2 allows dragging in either direc-
tion. 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 direc- tions.


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 im- age. If the parameter contains a decimal point, the
dis- tance is given in wheel units; otherwise,
pixels.
!!UNBOUND ACTIONS


The following actions have not been assigned any keystroke,
but are available if customization is used.


__shrink-to-dpi()__


This action takes one (required) argument. It sets the
shrink factor to an integer so as to approxi- mate 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 in-
teger.
!!CUSTOMIZATION


Key and mouse button assignments can be changed by setting
the __mainTranslations__ resource to a string of
translations as defined in the documentation for the X
toolkit. The actions should take the form of action names as
given in the KEYSTROKES and MOUSE ACTIONS
sections.


Key actions will usually be without arguments, or they may
give an argument to replace an optional number typed imme-
diately prior to the action. The keys __0__-__9__ and
hyphen can- not be reassigned, since they are used for
inputting num- bers.


Some key actions may take special arguments, as follows. The
argument of __goto-page__ may be the letter `__e__',
indicat- ing the action of going to the end of the document.
The argument of __set-shrink-factor__ may be the letter
`__a__', indi- cating that the shrink factor should be
set to the small- est value such that the page will fit in
the window. Fi- nally, actions that would perform a toggle,
such as __set-keep-flag__, may be the letter `__t__',
indicating that the action should toggle regardless of what
number may have been typed recently.


Mouse actions should refer only to __!ButtonPress__ events
(e.g., ____). The
corresponding mo- tion and release events will then 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-mod- ified
equivalents, the modified keys should come first, for
example:


__Ctrl
__


Because __xdvi__ needs to capture pointer motion events,
and because the X Toolkit translations mechanism cannot
accom- modate both motion events and double-click events at
the same time, it is not possible to specify double-click
ac- tions in __xdvi__ customizations. For information on
this and other aspects of translations, see the X Toolkit
Intrin- sics documentation.


There is no command-line option to set the __mainTransla-
tions__ resource, since changing this resource on the com-
mand line would be cumbersome. To set the resource for
testing purposes, use the __-xrm__ command-line option
provid- ed by the X toolkit. For example, __xdvi -xrm
'XDvi.main- Translations: #override
__ or __xdvi -xrm 'XD- vi.mainTranslations: #override
__ will cause the key `__z__'
to quit __xdvi__.


Support of wheel mice is controlled by the __wheelTransla-
tions__ resource. Generally the only action routine called
by this resource should be __wheel__. The default value
is
``____''.
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 in- cluded.


The button labels and actions may also be customized, in a
similar manner. In this case the resource __buttonTransla-
tions__ should consist of a string describing the button
la- bels and the associated actions. The string consists of
substrings, separated by the newline character (`__n__'),
each describing one button. Each substring consists of a
string (to be used as the button's label), a colon, and a
sequence of actions to be performed when the button is
pushed. Unlike the situation with key actions, an action
associated to a button should provide an argument (if ap-
plicable).


The label string may contain a colon if it is escaped by a
backslash (`__\__'). It also may contain some special se-
quences tied to the __-shrinkbutton__''n''
command-line options. If the characters `__$#__' occur,
then they are replaced by the argument of the corresponding
__-shrinkbutton__ com- mand-line option (if present). If
no corresponding __-shrinkbutton__ option was given, then
the value is taken from the list of actions, which is
expected to contain at least one __set-shrink-factor__ or
__shrink-to-dpi__ action. Likewise, the character
sequence `__$%__' will be replaced by the percentage
corresponding to the shrink factor, deter- mined as above.
In order for the __-shrinkbutton__ option to affect a
given button, the label string must contain one of the
character sequences `__$#__', `__$%__', or
'__$___'. This last string flags a button to be affected
by a __-shrinkbutton__ option, without making any numbers
appear in the label text (the `__$___' will not appear in
the label text).


Some resources are provided to allow customization of the
geometry of the 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 most buttons. The de- fault
value is 20.


__buttonBetweenExtra__


The number of pixels of additional space to be in- serted if
the __buttonTranslations__ resource string contains an
extra newline character. The default value is
50.


__buttonBorderWidth__


The border width of the button windows. The de- fault value
is 1.
!!SIGNALS


When __xdvi__ receives a __SIGUSR1__
signal, it rereads the ''dvi'' file.
!!GREYSCALING AND COLORMAPS


The greyscale anti-aliasing feature in __xdvi__ will not
work at its best if the display does not have enough colors
available. This can happen if other applications are us- ing
most of the colormap (even if they are iconified). If this
occurs, then __xdvi__ will print an error message and
turn on the __-copy__ option. This will result in
overstrike characters appearing wrong; it may also result in
poor display quality if the number of available colors is
very small.


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__ op- tion.


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 -in- stall__'' 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.
!!ENVIRONMENT


Please see the __kpathsea__ documentation.
!!HANDLING OF POSTSCRIPT FIGURES


__xdvi__ can display !PostScript files included in the
''dvi'' file. Such files are first searched for in the
directory where the ''dvi'' file is, and then using
normal __Kpathsea__ rules. There is an exception to this,
however: if the file name begins with a backtick (__`__),
then the remaining characters in the file name give a shell
command (often __zcat__) which is executed; its standard
output is then sent to be interpreted as !PostScript. Note
that there is some potential for security problems here; see
the __-allowshell__ command-line option. It is better to
use compressed files directly (see below).


If a file name is given (as opposed to a shell command), if
that file name ends in ``__.Z__'' or ``__.gz__'', and
if the first two bytes of the file indicate that it was com-
pressed with compress(1) or gzip(1),
respectively, then the file is first uncompressed with
__uncompress -c__ or __gun- zip -c__, respectively.
This is preferred over using a backtick to call the command
directly, since you do not have to specify
__-allowshell__ and since it allows for path
searching.
!!SOURCE SPECIALS


Some TEX implementations or macro packages provide the fa-
cility to automatically include so-called `source spe-
cials' into a .dvi file. These contain the line number,
eventually a column number, and the filename of the .tex
source. This makes it possible to jump from a .dvi file to
the corresponding place in the .tex source and back (also
called `reverse search' and `forward search').


To be usable with __xdvi__, source specials in the
''dvi'' file must have one of the following
formats:


__    src:__''line''[[ ]''filename
''__    src:__''line''__:__''col''[[ ]''filename
''__    src:__''line
''__    src:__''line''__:__''col
''__    src::__''col
''


If ''filename'' or ''line'' are omitted, the most
recent values are used. The first source special on each
page must be in one of the first two forms, since defaults
are not in- herited across pages.


You will need a TEX implementation or a macro package (such
as ''srcltx.sty'' or ''srctex.sty'' , available from
CTAN) to insert such source specials into the dvi
file.


For reverse search, you can use the combination
''CTRL-Mouse 1'' to 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'' op- tion for more information and
examples.)


For forward search, __xdvi__ has a ''-sourceposition''
option that makes __xdvi__ jump jump to the page in the
.dvi file corre- sponding to the line number and the file
name and high- light the line found. See the description of
the ''-source- position'' for more details.


The evaluation of source specials is disabled when the
__-safer__ option is used.
!!ENVIRONMENT


__xdvik__ uses the same environment variables and
algorithms for finding font files as TEX and friends. See
the docu- mentation for the __Kpathsea__ library for
details (repeating it here is too cumbersome). In addition,
__xdvik__ accepts the following variables:


__DISPLAY__


Specifies which graphics display terminal to
use.


__KPATHSEA_DEBUG__


Trace __Kpathsea__ lookups; set it to __-1__ for
complete tracing.


__MIMELIBDIR__


Directory containing the __mime.types__ file, if
__~/.mime-types__ does not exist.


__MAILCAPDIR__


Directory containing the __.mailcap__ file, if
__~/.mail- cap__ does not exist.


__WWWBROWSER__


The browser used to open URL's, if neither the
__-browser__ option nor the __.wwwBrowser__ resource
are set. For more information on hyper-TEX support, see the
`Hypertext' node in the __dvipsk__ manual.


__TMPDIR__


The directory to use for storing temporary files created
when uncompressing !PostScript files.


__XEDITOR__


Determines the editor command used for source spe- cial
`reverse search', if neither the ''-editor'' com-
mand-line option nor the ''.editor'' resource are
specified. See the description of the ''-editor'' command
line option for details on the format.


__VISUAL__


Determines an editor to be opened in an xterm win- dow if
neither of ''-editor'', ''.editor'', or ''XEDITOR''
is specified.


__EDITOR__


Determines an editor to be opened in an xterm win- dow if
neither of ''-editor'', ''.editor'', ''XEDITOR'' or
''VI- SUAL'' is specified.
!!LIMITATIONS


__xdvi__ accepts many but not all types of !PostScript
specials accepted by __dvips__. For example, it accepts
most specials generated by __epsf__ and __psfig__. It
does not, however, sup- port __bop-hook__ or
__eop-hook__, nor does it allow !PostScript commands to
affect the rendering of things that are not !PostScript (for
example, the ``NEAT'' and rotated ``A'' examples in the
__dvips__ manual). These restrictions are due to the
design of __xdvi__; in all likelihood they will always
remain.


LaTEX2e color and rotation specials are not currently sup-
ported.


__!MetaPost__ files containing included text are not
supported.
!!FILES


__xdvi.cfg__ needs to be supplied in the directory named
by the __XDVIINPUTS kpathsea__ variable. Please see the
file __README.t1fonts__ in the source distribution if
__xdvi.cfg__ is missing. __xdvik__ also relies on the
whole __kpathsea__ infras- tructure. Please see the
kpathsea documentation for fur- ther
information.
!!SEE ALSO


X(1), dvips(1), __Kpathsea__
documentation
!!AUTHORS


Eric Cooper, CMU, did a version for direct output to a QVSS.
Modified for X by Bob Scheifler, MIT Laboratory for Computer
Science. Modified for X11 by Mark Eichin, MIT SIPB.
+Additional enhancements by many others. The cur- rent
maintainer of the original __xdvi__ is Paul Vojta, U.C.
Berkeley; the maintainer of the __xdvik__ variant is the
xdvik project at sourceforge, please see __http://source-
forge.net/projects/xdvi/__
----
One page links to xdvi.real(1):
Man1x
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
Last edited on Tuesday, June 4, 2002 12:23:01 am by "perry"
Edit PageHistory Diff Info LikePages