Penguin
Annotated edit history of xdvi.bin(1) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 XDVI
2 !!!XDVI
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 KEYSTROKES
8 MOUSE ACTIONS
9 UNBOUND ACTIONS
10 CUSTOMIZATION
11 SIGNALS
12 GREYSCALING AND COLORMAPS
13 ENVIRONMENT
14 HANDLING OF POSTSCRIPT FIGURES
15 SOURCE SPECIALS
16 ENVIRONMENT
17 LIMITATIONS
18 FILES
19 SEE ALSO
20 AUTHORS
21 ----
22 !!NAME
23
24
25 xdvi - DVI Previewer for the X Window System
26 !!SYNOPSIS
27
28
29 __xdvi__ [[__+__[[''page'']] [[__-s__
30 ''shrink''] [[__-S__ ''density''] [[__-nogrey__]
31 [[__-gamma__ ''g''] [[__-install__]
32 [[__-noinstall__] [[__-p__ ''pixels'']
33 [[__-margins__ ''dimen''] [[__-sidemargin__
34 ''dimen''] [[__-topmargin__ ''dimen'']
35 [[__-offsets__ ''dimen''] [[__-xoffset__
36 ''dimen''] [[__-yoffset__ ''dimen''] [[__-paper__
37 ''papertype''] [[__-altfont__ ''font'']
38 [[__-nomakepk__] __-mfmode__
39 ''mode-def''[[__:__''dpi''] [[__-editor__
40 ''command''] [[__-sourceposition__
41 ''line''[[__:__''col''][[ ]''filename'']
42 [[__-l__] [[__-rv__] [[__-expert__]
43 [[__-__[[__no__]__statusline__]
44 [[__-shrinkbutton__''n shrink''] [[__-mgs__[[''n'']
45 ''size''] [[__-warnspecials__] [[__-hush__]
46 [[__-hushchars__] [[__-hushchecksums__]
47 [[__-hushspecials__] [[__-hushstdout__] [[__-safer__]
48 [[__-fg__ ''color''] [[__-bg__ ''color'']
49 [[__-hl__ ''color''] [[__-bd__ ''color'']
50 [[__-cr__ ''color''] [[__-bw__ ''width'']
51 [[__-grid1__ ''color''] [[__-grid2__ ''color'']
52 [[__-grid3__ ''color''] [[__-bw__ ''width'']
53 [[__-display__ ''host:display''] [[__-geometry__
54 ''geometry''] [[__-icongeometry__ ''geometry'']
55 [[__-iconic__] [[__-font__ ''font''] [[__-keep__]
56 [[__-copy__] [[__-thorough__] [[__-wheelunit__
57 ''pixels''] [[__-nopostscript__] [[__-noscan__]
58 [[__-allowshell__] [[__-noghostscript__]
59 [[__-nogssafer__] [[__-gsalpha__] [[__-interpreter__
60 ''path''] [[__-gspalette__ ''palette'']
61 [[__-not1lib__] [[__-underlink__] [[__-browser__
62 ''WWWbrowser''] [[__-base__ ''base URL'']
63 [[__-debug__ ''bitmask''] [[__-version__]
64 [[''dvi_file'']
65 !!DESCRIPTION
66
67
68 __xdvi__ is a program which runs under the X window
69 system. It is used to preview ''dvi'' files, such as are
70 produced by tex(1).
71
72
73 This program has the capability of showing the file shrunken
74 by various (integer) factors, and also has a ``magnifying
75 glass'' which allows one to see a small part of the unshrunk
76 image momentarily. Other new features are: it can display
77 Postscript
78
79
80 Before displaying any page or part thereof, it checks to see
81 if the ''dvi'' file has changed since the last time it
82 was displayed. If this is the case, then __xdvi__ will
83 reinitial- ize itself for the new ''dvi'' file. For this
84 reason, expos- ing parts of the __xdvi__ window while TEX
85 is running should be avoided. This feature allows you to
86 preview many ver- sions of the same file while running
87 __xdvi__ only once.
88
89
90 In addition to using keystrokes to move within the file,
91 __xdvi__ provides buttons on the right side of the
92 window, which are synonymous with various sequences of
93 keystrokes.
94
95
3 perry 96 __xdvi__ can show !PostScript
1 perry 97 __xdvi__.
98
99
100 For performance reasons, __xdvi__ does not render
3 perry 101 !PostScript specials in the magnifying glass.
1 perry 102
103
104 If ''dvi_file'' is not specified, a file-selection widget
105 is popped up for you to choose the ''dvi''
106 file.
107 !!OPTIONS
108
109
110 In addition to specifying the ''dvi'' file (with or
111 without the __.dvi__ extension), __xdvi__ supports the
112 following command line options. If the option begins with a
113 `__+__' instead of a `__-__', the option is restored
114 to its default value. By default, these options can be set
115 via the resource names given in parentheses in the
116 description of each option.
117
118
119 __+__''page''
120
121
122 Specifies the first page to show. If __+__ is given
123 without a number, the last page is assumed; the first page
124 is the default.
125
126
127 __-allowshell__
128
129
130 (__.allowShell__) This option enables the shell escape in
3 perry 131 !PostScript specials. (For security reasons, shell escapes
1 perry 132 are disabled by default.) This op- tion should be rarely
133 used; in particular it should not be used just to uncompress
134 files: that function is done automatically if the file name
135 ends in __.Z__, __.gz__, or __.bz2__. Shell escapes
136 are always turned off if the __-safer__ option is
137 used.
138
139
140 __-altfont__ ''font''
141
142
143 (__.altFont__) Declares a default font to use when the
144 font in the ''dvi'' file cannot be found. This is use-
3 perry 145 ful, for example, with !PostScript
1 perry 146 ''
147
148
149 __-background__ ''color''
150
151
152 (__.background__) Determines the color of the back-
153 ground. Same as __-bg__.
154
155
156 __-base__ ''base URL''
157
158
159 (__.urlBase__) Sets the base URL value that external
160 links given in the ''dvi'' file are assumed relative to -
161 normally this should be the URL of the document itself
162 (?).
163
164
165 __-bd__ ''color''
166
167
168 (__.borderColor__) Determines the color of the window
169 border.
170
171
172 __-bg__ ''color''
173
174
175 (__.background__) Determines the color of the back-
176 ground.
177
178
179 __-bordercolor__ ''color''
180
181
182 Same as __-bd__.
183
184
185 __-borderwidth__ ''width''
186
187
188 (__.borderWidth__) Specifies the width of the border of
189 the window. Same as __-bw__.
190
191
192 __-browser__ ''WWWbrowser''
193
194
195 (__.wwwBrowser__) Defines the World Wide Web browser to
196 be used to handle external URL's, for example mosa- ic. If
197 neither the command-line option nor the X resource are set,
198 uses the environment variable WWWBROWSER.
199
200
201 __-bw__ ''width''
202
203
204 (__.borderWidth__) Specifies the width of the border of
205 the window.
206
207
208 __-copy__
209
210
211 (__.copy__) Always use the ''copy'' operation when
212 writing characters to the display. This option may be nec-
213 essary for correct operation on a color display, but
214 overstrike characters will be incorrect. If greyscale
215 anti-aliasing is in use, the __-copy__ opera- tion will
216 disable the use of colorplanes and make overstrikes come out
217 incorrectly. See also __-thor- ough__.
218
219
220 __-cr__ ''color''
221
222
223 (__.cursorColor__) Determines the color of the cursor.
224 The default is the color of the page border.
225
226
227 __-debug__ ''bitmask''
228
229
230 (__.debugLevel__) If nonzero, prints additional infor-
231 mation on standard output. The number is taken as a set of
232 independent bits. The meaning of each bit follows.
233 1=bitmaps; 2=dvi translation; 4=pk read- ing; 8=batch
3 perry 234 operation; 16=events; 32=file opening; 64=!PostScript
1 perry 235 communication; 128=Kpathsea stat(2) calls; 256=Kpathsea hash
236 table lookups; 512=Kpath- sea path definitions;
237 1024=Kpathsea path expansion; 2048=Kpathsea searches. To
238 trace everything having to do with file searching and
239 opening, use 4000. Some of these debugging options are
240 actually pro- vided by Kpathsea. See the Debugging section
241 in the Kpathsea manual.
242
243
244 __-density__ ''density''
245
246
247 (__.densityPercent__) Determines the density used when
248 shrinking bitmaps for fonts. A higher value pro- duces a
249 lighter font. The default value is 40. If greyscaling is in
250 use, this argument does not ap- ply; use __-gamma__
251 instead. See also the `__S__' keystroke. Same as
252 __-S__.
253
254
255 __-display__
256 ''host''__:__''display''
257
258
259 Specifies the host and screen to be used for dis- playing
260 the ''dvi'' file. By default this is obtained from the
261 environment variable
262 __DISPLAY.__
263
264
265 __-editor__ ''editor''
266
267
268 (__.editor__) Specifies the editor that will be invoked
269 when the ''source-special()'' action is triggered (by
270 default via CTRL-Mouse 1). The argument to this option is a
271 format string in which occurrences of ``__%f__'' are
272 replaced by the file name, occurrences of ``__%l__'' are
273 replaced by the line number within the file, and optional
274 occurrences of ``__%c__'' are replaced by the column
275 number within the line. If no ``__%f__'' or ``__%l__''
276 occurs in the string, a warning is given and the missing
277 designators are appended.
278
279
280 If neither the option nor the X resource ''.editor'' is
281 specified, the following environment variables are checked
282 to determine the editor command: __XEDITOR__,
283 __VISUAL__, and __EDITOR__ (in this sequence). If the
284 string is found as the value of the
285 __VISUAL__ or __EDI-
286 TOR__ environment variables, then ``''xterm
287 -e'' '' is prepended to the string; if the editor is
288 specified by other means, then it must be in the form of a
289 shell command to pop up an X window with an editor in it. If
290 none of these variables is set, the com- mand ``''xterm -e
291 vi %s +%d'''' is used and a warning message is
292 given.
293
294
295 A new instance of the editor is started each time this
296 command is used; therefore it is preferrable to use an
297 editor that can be invoked in `client' mode to load new
298 files into the same instance. Ex- ample settings
299 are:
300
301
302 ''emacsclient --no-wait +%l %f'' (older
303 Emacsen),
304
305
306 ''gnuclient -q +%l %f'' (XEmacs and newer
307 Emacsen)
308
309
310 ''nc +%l %f'' (nedit)
311
312
313 Note that those strings need to be enclosed into quotes when
314 using them on the command-line to pro- tect them from the
315 shell; when using them as argu- ment for the ''.editor''
316 resource in an X resource file, no quotes should be
317 used.
318
319
320 __NOTE ON SECURITY:__ The argument of this option isn't
321 executed as a shell command, but via ''exec()'' to pre-
322 vent evil tricks with the contents of source spe- cials.
323 Execution of the ''-editor'' command is dis- abled when
324 the ''-safer'' option is used.
325
326
327 __-expert__
328
329
330 (__.expert__) Prevent the buttons from appearing. See
331 also the `__x__' keystroke.
332
333
334 __-fg__ ''color''
335
336
337 (__.foreground__) Determines the color of the text
338 (foreground).
339
340
341 __-foreground__ ''color''
342
343
344 Same as __-fg__.
345
346
347 __-font__ ''font''
348
349
350 (__*font__) Sets the font for use in the
351 buttons.
352
353
354 __-gamma__ ''gamma''
355
356
357 (__.gamma__) Controls the interpolation of colors in the
358 greyscale anti-aliasing color palette. Default value is 1.0.
359 For 0 __gamma''
360 ''gamma''
361 ''-density__. See also the `__S__'
362 keystroke
363
364
365 __-grid1__ ''color''
366
367
368 (__.grid1Color__) Determines the color of level 1 grid
369 (default as foreground)
370
371
372 __-grid2__ ''color''
373
374
375 (__.grid2Color__) Determines the color of level 2 grid
376 (default as foreground)
377
378
379 __-grid3__ ''color''
380
381
382 (__.grid3Color__) Determines the color of level 3 grid
383 (default as foreground)
384
385
386 __-geometry__ ''geometry''
387
388
389 (__*geometry__) Specifies the initial geometry of the
390 window.
391
392
393 __-gspalette__ ''palette''
394
395
396 (__.palette__) Specifies the palette to be used when
3 perry 397 using Ghostscript for rendering !PostScript spe- cials.
1 perry 398 Possible values are __Color__, __Greyscale__, and
399 __Monochrome__. The default is __Color__.
400
401
402 __-gsalpha__
403
404
405 (__.gsAlpha__) Causes __Ghostscript__ to be called
406 with the __x11alpha__ driver instead of the __x11__
407 driver. The __x11alpha__ driver enables anti-aliasing in
3 perry 408 !PostScript figures, for a nicer appearance. It is available
1 perry 409 on newer versions of __Ghostscript__. This option can
410 also be toggled with the `__V__' keystroke.
411
412
413 __-sourceposition__ ''line''[[__:__''col''][[
414 ]''filename''
415
416
417 This option makes xdvi start in `client mode' to perform a
418 `forward search'. The main dvi file ''dvi_file'' is
419 specified on the command line as usual. `Forward search'
420 means that xdvi will try to open the page in ''dvi_file''
421 corresponding to the ''line'' (op- tionally also the
422 ''column'') and ''filename'' of the .tex source, and
423 highlight the place found by drawing a rectangle in
424 ''highlight'' colour (see the ''-hl'' option) around
425 the corresponding text. (This only works when the
426 ''dvi_file'' has been prepared with source special
427 information; see the section SOURCE SPE- CIALS for more
428 information on this.)
429
430
431 `Client mode' means that if there is already anoth- er
432 instance of xdvi running on this X display and displaying
433 the same ''dvi_file'', a new instance start- ed with the
434 ''-sourceposition'' option will only notify that running
435 instance to perform the forward search, and exit after that.
436 This way, other pro- grams such such as text editors may
437 invoke xdvi in `client mode' to jump to a specific place in
438 the .dvi file corresponding to the current cursor posi- tion
439 in the .tex file.
440
441
442 The argument for ''filename'' should be a string with the
443 same extension as the file name used for the source specials
444 in the ''dvi'' file. The space before ''filename'' is
445 only needed if the filename starts with a digit. When the
446 space is used, the argument needs to be encosed in quotes to
447 prevent the shell from misinterpreting the space as argument
448 separa- tor.
449
450
451 __-hl__ ''color''
452
453
454 (__.highlight__) Determines the color of the page bor-
455 der. The default is the foreground color.
456
457
458 __-hush__
459
460
461 (__.Hush__) Causes __xdvi__ to suppress all
462 suppressible warnings.
463
464
465 __-hushchars__
466
467
468 (__.hushLostChars__) Causes __xdvi__ to suppress
469 warnings about references to characters which are not de-
470 fined in the font.
471
472
473 __-hushchecksums__
474
475
476 (__.hushChecksums__) Causes __xdvi__ to suppress
477 warnings about checksum mismatches between the ''dvi''
478 file and the font file.
479
480
481 __-hushspecials__
482
483
484 (__.hushSpecials__) Causes __xdvi__ to suppress
485 warnings about __special__ strings that it cannot
486 process.
487
488
489 __-hushstdout__
490
491
492 (__.hushStdout__) Causes __xdvi__ to suppress all
493 status informations it would normally print to stdout if the
494 statusline is disabled.
495
496
497 __-icongeometry__ ''geometry''
498
499
500 (__.iconGeometry__) Specifies the initial position for
501 the icon.
502
503
504 __-iconic__
505
506
507 (__.iconic__) Causes the __xdvi__ window to start in
508 the iconic state. The default is to start with the window
509 open.
510
511
512 __-install__
513
514
515 (__.install__) If __xdvi__ is running under a
3 perry 516 __!PseudoColor__ visual, then (by default) it will check
1 perry 517 for __True- Color__ visuals with more bits per pixel, and
518 switch to such a visual if one exists. If no such visual
519 exists, it will use the current visual and col- ormap. If
520 __-install__ is selected, however, it will still use a
3 perry 521 __!TrueColor__ visual with a greater depth, if one is
1 perry 522 available; otherwise, it will install its own colormap on
523 the current visual. If the current visual is not
3 perry 524 __!PseudoColor__, then __xdvi__ will not switch the
1 perry 525 visual or colormap, regardless of its options. The default
526 value of the __install__ resource is the special value,
527 __maybe__. There is no __+install__ option. See also
528 __-noinstall__, and the GREYSCALING AND COLORMAPS
529 section.
530
531
532 __-interpreter__ ''filename''
533
534
535 (__.interpreter__) Use ''filename'' as the Ghostscript
536 in- terpreter. By default it uses __gs__.
537
538
539 __-keep__
540
541
542 (__.keepPosition__) Sets a flag to indicate that
543 __xdvi__ should not move to the home position when moving
544 to a new page. See also the `__k__'
545 keystroke.
546
547
548 __-l__
549
550
551 (__.listFonts__) Causes the names of the fonts used to be
552 listed.
553
554
555 __-margins__ ''dimen''
556
557
558 (__.Margin__) Specifies the size of both the top margin
559 and side margin. This determines the ``home'' po- sition of
560 the page within the window as follows. If the entire page
561 fits in the window, then the margin settings are ignored.
562 If, even after remov- ing the margins from the left, right,
563 top, and bot- tom, the page still cannot fit in the window,
564 then the page is put in the window such that the top and
565 left margins are hidden, and presumably the upper left-hand
566 corner of the text on the page will be in the upper
567 left-hand corner of the window. Other- wise, the text is
568 centered in the window. The di- mension should be a decimal
569 number optionally fol- lowed by any of the two-letter
570 abbreviations for units accepted by TEX (__pt__,
571 __pc__, __in__, __bp__, __cm__, __mm__,
572 __dd__, __cc__, or __sp__). By default, the unit
573 will be __cm__ (cen- timeters)__.__ See also
574 __-sidemargin__, __-topmargin__, and the keystroke
575 `__M__.'
576
577
578 __-mfmode__ ''mode-def''
579
580
581 (__.mfMode__) Specifies a ''mode-def'' string, which
582 can be used in searching for fonts (see ENVIRONMENT, be-
583 low). Generally, when changing the ''mode-def'', it is
584 also necessary to change the font size to the ap- propriate
585 value for that mode. This is done by adding a colon and the
586 value in dots per inch; for example, __-mfmode
587 ljfour:600__. This method overrides any value given by the
588 __pixelsPerInch__ resource or the __-p__ command-line
589 argument. The metafont mode is also passed to
590 __metafont__ during automatic creation of fonts. By
591 default, it is __unspecified__.
592
593
594 __-mgs__ ''size''
595
596
597 Same as __-mgs1__.
598
599
600 __-mgs__[[''n''] ''size''
601
602
603 (__.magnifierSize__[[''n'']) Specifies the size of the
604 win- dow to be used for the ``magnifying glass'' for Button
605 ''n''. The size may be given as an integer (in- dicating
606 that the magnifying glass is to be square), or it may be
607 given in the form ''width''x- ''height''. See the
608 MOUSE ACTIONS section. Defaults are 200x150, 400x250,
609 700x500, 1000x800, and 1200x1200.
610
611
612 __-noghostscript__
613
614
615 (__.ghostscript__) Inhibits the use of Ghostscript for
3 perry 616 displaying !PostScript
1 perry 617 __-noghostscript__ corresponds to __ghostscript:off__;
618 __+noghostscript__ to
619 __ghostscript:on__.)
620
621
622 __-nogrey__
623
624
625 (__.grey__) Turns off the use of greyscale anti-alias-
626 ing when printing shrunken bitmaps. (For this op- tion, the
627 logic of the corresponding resource is reversed:
628 __-nogrey__ corresponds to __grey:off__;
629 __+nogrey__ to __grey:on__.) See also the `__G__'
630 keystroke.
631
632
633 __-nogssafer__
634
635
636 (__.gsSafer__) Normally, if Ghostscript is used to ren-
3 perry 637 der !PostScript specials, the Ghostscript inter- preter is
1 perry 638 run with the option __-dSAFER__. The __-nogssafer__
639 option runs Ghostscript without __-dSAFER__. The
3 perry 640 __-dSAFER__ option in Ghostscript disables !PostScript
1 perry 641 operators such as __deletefile__, to prevent possibly
3 perry 642 malicious !PostScript programs from having any effect. If the
1 perry 643 __-safer__ option is specified, then this option has no
644 effect; in that case Ghostscript is always run with
645 __-dSAFER__. (For the __-nogssafer__ option, the logic
646 of the corresponding resource is reversed: __-nogssafer__
647 corresponds to __gsSafer:off__; __+nogssafer__ to
648 __gsSafer:on__.)
649
650
651 __-noinstall__
652
653
654 (__.install__) Inhibit the default behavior of switch-
3 perry 655 ing to a __!TrueColor__ visual if one is available with
1 perry 656 more bits per pixel than the current visual. This option
657 corresponds to a resource of __install:off__. There is no
658 __+noinstall__ option. See also __-install__, and the
659 GREYSCALING AND COLORMAPS section.
660
661
662 __-nomakepk__
663
664
665 (__.makePk__) Turns off automatic generation of font
666 files that cannot be found by other means. (For this option,
667 the logic of the corresponding re- source is reversed:
668 __-nomakepk__ corresponds to __makePk:off__;
669 __+nomakepk__ to __makePK:on__.)
670
671
672 __-nopostscript__
673
674
675 (__.postscript__) Turns off rendering of
3 perry 676 !PostScript
1 perry 677 __v__' keystroke. (For this option, the log- ic
678 of the corresponding resource is reversed: __-no-
679 postscript__ corresponds to __postscript:off__;
680 __+postscript__ to __postscript:on__.)
681
682
683 __-noscan__
684
685
3 perry 686 (__.prescan__) Normally, when !PostScript
1 perry 687 __xdvi__ will do a preliminary scan of the
688 ''dvi'' file, in order to send any necessary header files
3 perry 689 before sending the !PostScript code that requires them. This
1 perry 690 option turns off such prescanning. (It will be automatically
691 be turned back on if __xdvi__ de- tects any specials that
692 require headers.) (For the __-noscan__ option, the logic
693 of the corresponding re- source is reversed: __-noscan__
694 corresponds to __pres- can:off__; __+noscan__ to
695 __prescan:on__.)
696
697
698 __-offsets__ ''dimen''
699
700
701 (__.Offset__) Specifies the size of both the horizontal
702 and vertical offsets of the output on the page. By decree of
703 the Stanford TEX Project, the default TEX page origin is
704 always 1 inch over and down from the top-left page corner,
705 even when non-American paper sizes are used. Therefore, the
706 default offsets are 1.0 inch. The argument ''dimen''
707 should be a decimal number optionally followed by any of the
708 two-letter abbreviations for units accepted by TEX
709 (__pt__, __pc__, __in__, __bp__, __cm__,
710 __mm__, __dd__, __cc__, or __sp__). By default,
711 the unit will be __cm__ (centimeters)__.__ See also
712 __-xoffset__ and __-yoffset__.
713
714
715 __-p__ ''pixels''
716
717
718 (__.pixelsPerInch__) Defines the size of the fonts to
719 use, in pixels per inch. The default value is 600. This
720 option is provided only for backwards compati- bility; the
721 preferred way of setting the font size is by setting the
722 Metafont mode at the same time; see the __-mfmode__
723 option.
724
725
726 __-paper__ ''papertype''
727
728
729 (__.paper__) Specifies the size of the printed page. This
730 may be of the form ''width''__x__''height''
731 optionally followed by a unit, where ''width'' and
732 ''height'' are dec- imal numbers giving the width and
733 height of the pa- per, respectively, and the unit is any of
734 the two-letter abbreviations for units accepted by TEX
735 (__pt__, __pc__, __in__, __bp__, __cm__,
736 __mm__, __dd__, __cc__, or __sp__). By de-
737 fault, the unit will be __cm__ (centimeters)__.__
738 There are also synonyms which may be used: __us__
739 (8.5x11in), __usr__ (11x8.5in), __legal__ (8.5x14in),
740 __foolscap__ (13.5x17in), as well as the ISO sizes
741 __a1__-__a7__, __b1__-__b7__,
742 __c1__-__c7__, __a1r__-__a7r__
743 (__a1__-__a7__ rotated), etc. The default size is 21 x
744 29.7 cm (A4 size).
745
746
747 __-rv__
748
749
750 (__.reverseVideo__) Causes the page to be displayed with
751 white characters on a black background, in- stead of vice
752 versa.
753
754
755 __-s__ ''shrink''
756
757
758 (__.shrinkFactor__) Defines the initial shrink factor.
759 The default value is 8. If ''shrink'' is given as 0, then
760 the initial shrink factor is computed so that the page fits
761 within the window (as if the `s' keystroke were given
762 without a number).
763
764
765 __-S__ ''density''
766
767
768 (__.densityPercent__) Same as __-density__,
769 ''q.v.''
770
771
772 __-safer__
773
774
775 (__.safer__) This option turns on all available securi-
776 ty options; it is designed for use when __xdvi__ is
777 called by a browser that obtains a ''dvi'' or TEX file
778 from another site. This option turns off evaluta- tion of
779 source specials (see SOURCE SPECIALS for details).
780 Furthermore, it selects __+nogssafer__ and
781 __+allowshell__.
782
783
784 __-shrinkbutton__''n shrink''
785
786
787 (__.shrinkButton__''n'') Specifies that the ''n''th
788 button changing shrink factors shall change to shrink fac-
789 tor ''factor''. This is useful, e.g., when using 600 dpi
790 fonts, since in that case shrinking by a factor of 4 is
791 still not enough. Here ''n'' may be a number from 1 to 3
792 (in the default button layout, the ``Full Size'' button is
793 unaffected by these op- tions). If the buttons are
794 customized, higher val- ues of ''n'' (up to 9) may be
795 used.
796
797
798 __-sidemargin__ ''dimen''
799
800
801 (__.sideMargin__) Specifies the side margin (see __-mar-
802 gins__).
803
804
805 __-statusline__, __-nostatusline__
806
807
808 (__.statusline__) Display/do not display the statusline
809 at the bottom of the window. This can also be tog- gled with
810 the `__1x__' keystroke. If displaying the statusline is
811 disabled, the messages that would normally be printed to the
812 statusline will be printed to ''stdout''. To suppress
813 printing these mes- sages as well, use the
814 __-hushstdout__ option.
815
816
817 __-thorough__
818
819
820 (__.thorough__) __xdvi__ will usually try to ensure
821 that overstrike characters (''e.g.'', __notin__) are
822 printed correctly. On monochrome displays, this is always
823 possible with one logical operation, either ''and'' or
824 ''or''. On color displays, however, this may take two
825 operations, one to set the appropriate bits and one to clear
826 other bits. If this is the case, then by default __xdvi__
827 will instead use the ''copy'' operation, which does not
828 handle overstriking correctly. The __-thorough__ option
829 chooses the slower but more cor- rect choice. See also
830 __-copy__.
831
832
833 __-topmargin__ ''dimen''
834
835
836 (__.topMargin__) Specifies the top and bottom margins
837 (see __-margins__).
838
839
840 __-not1lib__
841
842
843 (__.not1lib__) This will disable the use of T1Lib to
3 perry 844 display !PostScript
1 perry 845 __
846
847
848 __-underlink__
849
850
851 (__.underLink__) Underline links. Default is
852 true.
853
854
855 __-version__
856
857
858 Print information on the version of
859 __xdvi__.
860
861
862 __-warnspecials__
863
864
865 (__.warnSpecials__) Causes __xdvi__ to issue warnings
866 about __special__ strings that it cannot
867 process.
868
869
870 __-wheelunit__ ''pixels''
871
872
873 (__.wheelUnit__) Sets the number of pixels that a mo-
874 tion of a wheel mouse will move the image up or down. If set
875 to zero, the wheel mouse functionali- ty is disabled. The
876 default value is 80.
877
878
879 __-xoffset__ ''dimen''
880
881
882 (__.xOffset__) Specifies the size of the horizontal
883 offset of the output on the page. See
884 __-offsets__.
885
886
887 __-yoffset__ ''dimen''
888
889
890 (__.yOffset__) Specifies the size of the vertical off-
891 set of the output on the page. See
892 __-offsets__.
893 !!KEYSTROKES
894
895
896 __xdvi__ recognizes the following keystrokes when typed
897 in its window. Each may optionally be preceded by a
898 (positive or negative) number, whose interpretation will
899 depend on the particular keystroke. Also, the ``Help'',
900 ``Home'', ``Prior'' and ``Next'' keys are synonyms for
901 `__?__', `__^__', `__b__', and `__f__' keys,
902 respectively.
903
904
905 The key assignments given here are those that __xdvi__
906 assigns by default. They can be changed--see CUSTOMIZATION,
907 be- low. The names appearing in brackets at the beginning of
908 each of the following keystroke definitions is the name
909 assigned to the action associated with that key, for use
910 when customizing. Users who do not customize their
911 keystrokes may ignore these labels.
912
913
914 __q__
915
916
917 [[__quit()__] Quits the program. Control-C and con- trol-D
918 will do this, too.
919
920
921 __n__
922
923
924 [[__forward-page()__] Moves to the next page (or to the
925 ''n''th next page if a number is given). Synonyms are
926 `__f__', Return, and Line Feed.
927
928
929 __Space__
930
931
932 [[__down-or-next()__] Moves down two-thirds of a win-
933 dow-full, or to the next page if already at the bottom of
934 the page.
935
936
937 __p__
938
939
940 [[__back-page()__] Moves to the previous page (or back
941 ''n'' pages). Synonyms are `__b__' and
942 control-H.
943
944
945 Delete
946
947
948 [[__up-or-previous()__] Moves up two-thirds of a win-
949 dow-full, or to the bottom of the previous page if already
3 perry 950 at the top of the page. The !BackSpace key will also do
1 perry 951 this.
952
953
954 __g__
955
956
957 [[__goto-page()__] Moves to the page with the given num-
958 ber. Initially, the first page is assumed to be page number
959 1, but this can be changed with the `__P__' keystroke,
960 below. If no page number is given, then it goes to the last
961 page.
962
963
964 __P__
965
966
967 [[__declare-page-number()__] ``This is page number
968 ''n''.'' This can be used to make the `__g__'
969 keystroke refer to actual page numbers instead of absolute
970 page num- bers.
971
972
973 __Control-L__
974
975
976 [[__forward-page(0)__] Redisplays the current
977 page.
978
979
980 __^__
981
982
983 [[__home()__] Move to the ``home'' position of the page.
984 This is normally the upper left-hand corner of the page,
985 depending on the margins as described in the __-margins__
986 option, above.
987
988
989 __Up arrow__
990
991
992 [[__up(0.015)__] Scrolls page up.
993
994
995 __Down arrow__
996
997
998 [[__down(0.015)__] Scrolls page down.
999
1000
1001 __u__
1002
1003
1004 [[__up()__] Moves page up two thirds of a window-full.
1005 With a float argument to ``up'', moves up the cor-
1006 responding fraction of a window-full.
1007
1008
1009 __d__
1010
1011
1012 [[__down()__] Moves page down two thirds of a win-
1013 dow-full. With a float argument to ``down, moves down the
1014 corresponding fraction of a window-full.
1015
1016
1017 __Left arrow__
1018
1019
1020 [[__left(0.015)__] Scrolls page left.
1021
1022
1023 __Right arrow__
1024
1025
1026 [[__right(0.015)__] Scrolls page right.
1027
1028
1029 __l__
1030
1031
1032 [[__left()__] Moves page left two thirds of a win-
1033 dow-full.
1034
1035
1036 __r__
1037
1038
1039 [[__right()__] Moves page right two thirds of a win-
1040 dow-full.
1041
1042
1043 __c__
1044
1045
1046 [[__center()__] Moves the page so that the point cur-
1047 rently beneath the cursor is moved to the middle of the
1048 window. It also (gasp!) warps the cursor to the same
1049 place.
1050
1051
1052 __M__
1053
1054
1055 [[__set-margins()__] Sets the margins so that the point
1056 currently under the cursor is the upper left-hand corner of
1057 the text in the page. Note that this command itself does not
1058 move the image at all. For details on how the margins are
1059 used, see the __-mar- gins__ option.
1060
1061
1062 __s__
1063
1064
1065 [[__set-shrink-factor()__] Changes the shrink factor to
1066 the given number. If no number is given, the smallest factor
1067 that makes the entire page fit in the window will be used.
1068 (Margins are ignored in this computation.)
1069
1070
1071 __S__
1072
1073
1074 [[__set-density()__] Sets the density factor to be used
1075 when shrinking bitmaps. This should be a number between 0
1076 and 100; higher numbers produce lighter characters. If
1077 greyscaling mode is in effect, this changes the value of
1078 gamma instead. The new value of gamma is the given number
1079 divided by 100; nega- tive values are allowed.
1080
1081
1082 __R__
1083
1084
1085 [[__reread-dvi-file()__] Forces the ''dvi'' file to be
1086 reread. This allows you to preview many versions of the same
1087 file while running __xdvi__ only once.
1088
1089
1090 __k__
1091
1092
1093 [[__set-keep-flag()__] Normally when __xdvi__ switches
1094 pages, it moves to the home position as well. The `__k__'
1095 keystroke toggles a `keep-position' flag which, when set,
1096 will keep the same position when moving between pages. Also
1097 `__0k__' and `__1k__' clear and set this flag,
1098 respectively. See also the __-keep__ op-
1099 tion.
1100
1101
1102 __x__
1103
1104
1105 [[__set-expert-mode()__] Toggles expert mode (in which the
1106 buttons do not appear). Typing `__1x__' toggles the
1107 display of the statusline at the bottom of the window. See
1108 also the options __-expert__ and __-__[[__no__]sta-
1109 tusline.
1110
1111
1112 __Control-v__
1113
1114
1115 [[__show-source-specials()__] Show bounding boxes for
1116 every source special on the current page, and print the
1117 strings contained in these specials to stderr. With prefix
1118 1, show every bounding box on the page. This is for
1119 debugging purposes mainly.
1120
1121
1122 __Control-x__
1123
1124
1125 [[__source-what-special()__] Display information about the
1126 source special next to the cursor in the sta- tusline. This
1127 is the same special that would be found by
1128 ''source-special() ,'' but without invoking the editor.
1129 For debugging purposes.
1130
1131
1132 __G__
1133
1134
1135 [[__set-greyscaling()__] This key toggles the use of
1136 greyscale anti-aliasing for displaying shrunken bitmaps. In
1137 addition, the key sequences `__0G__' and `__1G__'
1138 clear and set this flag, respectively. See also the
1139 __-nogrey__ option.
1140
1141
1142 If given a numeric argument that is not 0 or 1, greyscale
1143 anti-aliasing is turned on, and the gamma resource is set to
1144 the value divided by 100. E.g., `__150G__' turns on
1145 greyscale and sets gamma to 1.5.
1146
1147
1148 __D__
1149
1150
1151 [[__toggle-grid-mode()__] This key toggles the use of grid
1152 over the document. If no number is given, the grid mode
1153 toggles. By prepending number, 3 grid levels can be set. The
1154 grid in each level is drawn in the colour specified. See
1155 also the __-grid1, -grid2,__ and __-grid3__
1156 options.
1157
1158
1159 __v__
1160
1161
1162 [[__set-ps()__] This key toggles the rendering of
3 perry 1163 !PostScript
1 perry 1164 __0v__' and `__1v__' clear
1165 and set this flag, respectively. See also the
1166 __-nopostscript__ option.
1167
1168
1169 __Control-F__
1170
1171
1172 [[__select-dvi-file()__] Read a new ''dvi'' file. A
1173 file-se- lection widget is popped up for you to choose the
1174 dvi file from.
1175
1176
1177 __V__
1178
1179
1180 [[__set-gs-alpha()__] This key toggles the anti-aliasing
3 perry 1181 of !PostScript__Ghostscript__ is
1 perry 1182 used as renderer. In addition the key sequences `__0V__'
1183 and `__1V__' clear and set this flag, respectively. See
1184 also the __-gsalpha__ option.
1185
1186
1187 __?__
1188
1189
1190 [[__help()__] Pops up a help window with a short expla-
1191 nation of the most important key bindings and con- cepts.
1192 The help texts and menu entries are fully configurable via
1193 the following X resources (the de- faults strings are given
1194 in parentheses, or as '''' if they contain a
1195 longer text):
1196
1197
1198 __helpTopicsButtonLabel__ ''(Topic)''
1199
1200
1201 __helpQuitButtonLabel__ ''(Close)''
1202
1203
1204 __helpIntro__ ''''
1205
1206
1207 __helpGeneralMenulabel__ ''(General)''
1208
1209
1210 __helpGeneral__ ''''
1211
1212
1213 __helpHypertexMenulabel__ ''(HyperTeX
1214 commands)''
1215
1216
1217 __helpHypertex__ ''''
1218
1219
1220 __helpOthercommandsMenulabel__ ''(Other
1221 Commands)''
1222
1223
1224 __helpOthercommands__ ''''
1225
1226
1227 __helpPagemotionMenulabel__ ''(Page
1228 Motion)''
1229
1230
1231 __helpPagemotion__ ''''
1232
1233
1234 __helpSourcespecialsMenulabel__ ''(Source
1235 Specials)''
1236
1237
1238 __helpSourcespecials__ ''''.
1239 !!MOUSE ACTIONS
1240
1241
1242 If the shrink factor is set to any number other than one,
1243 then clicking mouse button 3 will pop up a ``magnifying
1244 glass'' which shows the unshrunk image in the vicinity of
1245 the mouse click. This subwindow disappears when the mouse
1246 button is released. Different mouse buttons produce dif-
1247 ferent sized windows, as indicated by the __-mgs__
1248 option. Moving the cursor while holding the button down will
1249 move the magnifying glass. To access this feature via cus-
1250 tomization, use the __magnifier__ action. Its argument is
1251 ei- ther a string of the form ''width''x''height'', as
1252 in the __-mgs__''n'' command-line option, or one of
1253 the strings __*1__ through __*5__, referring to the
1254 value specified by the corresponding __-mgs__''n''
1255 option.
1256
1257
1258 Holding down the ''CTRL'' key and clicking on mouse
1259 button 1 starts a ``reverse search'' (action
1260 __source-special()__; see the section on SOURCE SPECIALS
1261 for details).
1262
1263
1264 If the cursor is on a hypertext link (underlined by de-
1265 fault), then that link overrides the magnifying glass for
1266 Buttons 1 and 2. If Button 1 is clicked over a link, then
1267 __xdvi__ jumps to the target in the current window. If
1268 Button 2 is clicked over a link, then __xdvi__ opens a
1269 new window on the target.
1270
1271
1272 More precisely, for internal links, Button 1 jumps in the
1273 same window to the link, while Button 2 starts up a new
1274 __xdvi__ on the link. For external links to ''dvi''
1275 files, Button 1 changes the current __xdvi__ to be
1276 reading that file, while Button 2 starts a new __xdvi__
1277 on that file. For other file types, __mime.types__ and
1278 __mailcap__ are parsed to determine the viewer; finally,
1279 if no suitable __mailcap__ entry was found, if the
1280 __WWWBROWSER__ environment variable is
1281 set, or __-browser__ was specified on the command line,
1282 it is started up on the file.
1283
1284
1285 The scrollbars (if present) behave in the standard way:
1286 pushing Button 2 in a scrollbar moves the top or left edge
1287 of the scrollbar to that point and optionally drags it;
1288 pushing Button 1 moves the image up or right by an amount
1289 equal to the distance from the button press to the upper
1290 left-hand corner of the window; pushing Button 3 moves the
1291 image down or left by the same amount.
1292
1293
1294 The image can also be dragged around, by holding down the
1295 shift key and a mouse button. Shift-button 1 will allow
1296 vertical dragging only; Shift-button 3, horizontal drag-
1297 ging; and Shift-button 2 allows dragging in either direc-
1298 tion. To access these actions via customization, use the
1299 __drag__ action. This action should have one parameter,
1300 the character ``__|__'', ``__-__'', or ``__+__'',
1301 indicating vertical dragging, horizontal dragging, or
1302 dragging in both direc- tions.
1303
1304
1305 Wheel mice are supported: motion of the wheel on such a
1306 mouse moves the image up or down by the number of pixels
1307 indicated by the __-wheelunit__ option. To access this
1308 option via customization, use the __wheel__ action. This
1309 action takes one parameter, giving the distance to scroll
1310 the im- age. If the parameter contains a decimal point, the
1311 dis- tance is given in wheel units; otherwise,
1312 pixels.
1313 !!UNBOUND ACTIONS
1314
1315
1316 The following actions have not been assigned any keystroke,
1317 but are available if customization is used.
1318
1319
1320 __shrink-to-dpi()__
1321
1322
1323 This action takes one (required) argument. It sets the
1324 shrink factor to an integer so as to approxi- mate the use
1325 of fonts with the corresponding number of dots per inch. If
1326 __xdvi__ is using fonts scaled for ''p'' dots per
1327 inch, and the argument to __shrink-to-dpi__ is ''n'',
1328 then the corresponding shrink factor is the ratio
1329 ''p''/''n'', rounded to the nearest in-
1330 teger.
1331 !!CUSTOMIZATION
1332
1333
1334 Key and mouse button assignments can be changed by setting
1335 the __mainTranslations__ resource to a string of
1336 translations as defined in the documentation for the X
1337 toolkit. The actions should take the form of action names as
1338 given in the KEYSTROKES and MOUSE ACTIONS
1339 sections.
1340
1341
1342 Key actions will usually be without arguments, or they may
1343 give an argument to replace an optional number typed imme-
1344 diately prior to the action. The keys __0__-__9__ and
1345 hyphen can- not be reassigned, since they are used for
1346 inputting num- bers.
1347
1348
1349 Some key actions may take special arguments, as follows. The
1350 argument of __goto-page__ may be the letter `__e__',
1351 indicat- ing the action of going to the end of the document.
1352 The argument of __set-shrink-factor__ may be the letter
1353 `__a__', indi- cating that the shrink factor should be
1354 set to the small- est value such that the page will fit in
1355 the window. Fi- nally, actions that would perform a toggle,
1356 such as __set-keep-flag__, may be the letter `__t__',
1357 indicating that the action should toggle regardless of what
1358 number may have been typed recently.
1359
1360
3 perry 1361 Mouse actions should refer only to __!ButtonPress__ events
1 perry 1362 (e.g., ____). The
1363 corresponding mo- tion and release events will then be
1364 handled internally. A key action may be bound to a mouse
1365 event, but not vice versa.
1366
1367
1368 Usually the string of translations should begin with
1369 ``__#override__'', indicating that the default key and
1370 mouse button assignments should not be
1371 discarded.
1372
1373
1374 When keys or mouse buttons involving modifiers (such as Ctrl
1375 or Shift) are customized together with their non-mod- ified
1376 equivalents, the modified keys should come first, for
1377 example:
1378
1379
1380 __Ctrl
1381 __
1382
1383
1384 Because __xdvi__ needs to capture pointer motion events,
1385 and because the X Toolkit translations mechanism cannot
1386 accom- modate both motion events and double-click events at
1387 the same time, it is not possible to specify double-click
1388 ac- tions in __xdvi__ customizations. For information on
1389 this and other aspects of translations, see the X Toolkit
1390 Intrin- sics documentation.
1391
1392
1393 There is no command-line option to set the __mainTransla-
1394 tions__ resource, since changing this resource on the com-
1395 mand line would be cumbersome. To set the resource for
1396 testing purposes, use the __-xrm__ command-line option
1397 provid- ed by the X toolkit. For example, __xdvi -xrm
1398 'XDvi.main- Translations: #override
1399 __ or __xdvi -xrm 'XD- vi.mainTranslations: #override
1400 __ will cause the key `__z__'
1401 to quit __xdvi__.
1402
1403
1404 Support of wheel mice is controlled by the __wheelTransla-
1405 tions__ resource. Generally the only action routine called
1406 by this resource should be __wheel__. The default value
1407 is
1408 ``____''.
1409 Because this resource is implemented differently from the
1410 others, it should not begin with ``#override__'';__ when
1411 specifying a value for this resource, all wheel actions
1412 should be in- cluded.
1413
1414
1415 The button labels and actions may also be customized, in a
1416 similar manner. In this case the resource __buttonTransla-
1417 tions__ should consist of a string describing the button
1418 la- bels and the associated actions. The string consists of
1419 substrings, separated by the newline character (`__n__'),
1420 each describing one button. Each substring consists of a
1421 string (to be used as the button's label), a colon, and a
1422 sequence of actions to be performed when the button is
1423 pushed. Unlike the situation with key actions, an action
1424 associated to a button should provide an argument (if ap-
1425 plicable).
1426
1427
1428 The label string may contain a colon if it is escaped by a
1429 backslash (`__\__'). It also may contain some special se-
1430 quences tied to the __-shrinkbutton__''n''
1431 command-line options. If the characters `__$#__' occur,
1432 then they are replaced by the argument of the corresponding
1433 __-shrinkbutton__ com- mand-line option (if present). If
1434 no corresponding __-shrinkbutton__ option was given, then
1435 the value is taken from the list of actions, which is
1436 expected to contain at least one __set-shrink-factor__ or
1437 __shrink-to-dpi__ action. Likewise, the character
1438 sequence `__$%__' will be replaced by the percentage
1439 corresponding to the shrink factor, deter- mined as above.
1440 In order for the __-shrinkbutton__ option to affect a
1441 given button, the label string must contain one of the
1442 character sequences `__$#__', `__$%__', or
1443 '__$___'. This last string flags a button to be affected
1444 by a __-shrinkbutton__ option, without making any numbers
1445 appear in the label text (the `__$___' will not appear in
1446 the label text).
1447
1448
1449 Some resources are provided to allow customization of the
1450 geometry of the command buttons. Again, they are not
1451 changeable via command-line options, other than via the
1452 __-xrm__ option. All of these resources take integer
1453 values.
1454
1455
1456 __buttonSideSpacing__
1457
1458
1459 The number of pixels to be placed on either side of the
1460 buttons. The default value is 6.
1461
1462
1463 __buttonTopSpacing__
1464
1465
1466 The number of pixels between the top button and the top of
1467 the window. The default value is 50.
1468
1469
1470 __buttonBetweenSpacing__
1471
1472
1473 The number of pixels between most buttons. The de- fault
1474 value is 20.
1475
1476
1477 __buttonBetweenExtra__
1478
1479
1480 The number of pixels of additional space to be in- serted if
1481 the __buttonTranslations__ resource string contains an
1482 extra newline character. The default value is
1483 50.
1484
1485
1486 __buttonBorderWidth__
1487
1488
1489 The border width of the button windows. The de- fault value
1490 is 1.
1491 !!SIGNALS
1492
1493
1494 When __xdvi__ receives a __SIGUSR1__
1495 signal, it rereads the ''dvi'' file.
1496 !!GREYSCALING AND COLORMAPS
1497
1498
1499 The greyscale anti-aliasing feature in __xdvi__ will not
1500 work at its best if the display does not have enough colors
1501 available. This can happen if other applications are us- ing
1502 most of the colormap (even if they are iconified). If this
1503 occurs, then __xdvi__ will print an error message and
1504 turn on the __-copy__ option. This will result in
1505 overstrike characters appearing wrong; it may also result in
1506 poor display quality if the number of available colors is
1507 very small.
1508
1509
1510 Typically this problem occurs on displays that allocate
1511 eight bits of video memory per pixel. To see how many bits
1512 per pixel your display uses, type __xwininfo__ in an
1513 __xterm__ window, and then click the mouse on the root
1514 window when asked. The ``Depth:'' entry will tell you how
1515 many bits are allocated per pixel.
1516
1517
1518 Displays using at least 15 bits per pixel are typically
3 perry 1519 __!TrueColor__ visuals, which do not have this problem,
1 perry 1520 since their colormap is permanently allocated and available
1521 to all applications. (The visual class is also displayed by
1522 __xwininfo__.) For more information on visual classes see
1523 the documentation for the X Window System.
1524
1525
1526 To alleviate this problem, therefore, one may (a) run with
1527 more bits per pixel (this may require adding more video
1528 memory or replacing the video card), (b) shut down other
1529 applications that may be using much of the colormap and then
1530 restart __xdvi__, or (c) run __xdvi__ with the
1531 __-install__ op- tion.
1532
1533
1534 One application which is often the cause of this problem is
1535 __Netscape__. In this case there are two more
1536 alternatives to remedying the situation. One can run
1537 ``__netscape -in- stall__'' to cause __Netscape__ to
1538 install a private colormap. This can cause colors to change
1539 in bizarre ways when the mouse is moved to a different
1540 window. Or, one can run ``__netscape -ncols 220__'' to
1541 limit __Netscape__ to a smaller number of colors. A
1542 smaller number will ensure that other applications have more
1543 colors available, but will degrade the color quality in the
1544 __Netscape__ window.
1545 !!ENVIRONMENT
1546
1547
1548 Please see the __kpathsea__ documentation.
1549 !!HANDLING OF POSTSCRIPT FIGURES
1550
1551
3 perry 1552 __xdvi__ can display !PostScript files included in the
1 perry 1553 ''dvi'' file. Such files are first searched for in the
1554 directory where the ''dvi'' file is, and then using
1555 normal __Kpathsea__ rules. There is an exception to this,
1556 however: if the file name begins with a backtick (__`__),
1557 then the remaining characters in the file name give a shell
1558 command (often __zcat__) which is executed; its standard
3 perry 1559 output is then sent to be interpreted as !PostScript. Note
1 perry 1560 that there is some potential for security problems here; see
1561 the __-allowshell__ command-line option. It is better to
1562 use compressed files directly (see below).
1563
1564
1565 If a file name is given (as opposed to a shell command), if
1566 that file name ends in ``__.Z__'' or ``__.gz__'', and
1567 if the first two bytes of the file indicate that it was com-
1568 pressed with compress(1) or gzip(1),
1569 respectively, then the file is first uncompressed with
1570 __uncompress -c__ or __gun- zip -c__, respectively.
1571 This is preferred over using a backtick to call the command
1572 directly, since you do not have to specify
1573 __-allowshell__ and since it allows for path
1574 searching.
1575 !!SOURCE SPECIALS
1576
1577
1578 Some TEX implementations or macro packages provide the fa-
1579 cility to automatically include so-called `source spe-
1580 cials' into a .dvi file. These contain the line number,
1581 eventually a column number, and the filename of the .tex
1582 source. This makes it possible to jump from a .dvi file to
1583 the corresponding place in the .tex source and back (also
1584 called `reverse search' and `forward search').
1585
1586
1587 To be usable with __xdvi__, source specials in the
1588 ''dvi'' file must have one of the following
1589 formats:
1590
1591
1592 __ src:__''line''[[ ]''filename
1593 ''__ src:__''line''__:__''col''[[ ]''filename
1594 ''__ src:__''line
1595 ''__ src:__''line''__:__''col
1596 ''__ src::__''col
1597 ''
1598
1599
1600 If ''filename'' or ''line'' are omitted, the most
1601 recent values are used. The first source special on each
1602 page must be in one of the first two forms, since defaults
1603 are not in- herited across pages.
1604
1605
1606 You will need a TEX implementation or a macro package (such
1607 as ''srcltx.sty'' or ''srctex.sty'' , available from
1608 CTAN) to insert such source specials into the dvi
1609 file.
1610
1611
1612 For reverse search, you can use the combination
1613 ''CTRL-Mouse 1'' to make xdvi open an editor (the value
1614 of the ''-editor'' command line option) with the file and
1615 the line number of the .tex source. (See the description of
1616 the ''-editor'' op- tion for more information and
1617 examples.)
1618
1619
1620 For forward search, __xdvi__ has a ''-sourceposition''
1621 option that makes __xdvi__ jump jump to the page in the
1622 .dvi file corre- sponding to the line number and the file
1623 name and high- light the line found. See the description of
1624 the ''-source- position'' for more details.
1625
1626
1627 The evaluation of source specials is disabled when the
1628 __-safer__ option is used.
1629 !!ENVIRONMENT
1630
1631
1632 __xdvik__ uses the same environment variables and
1633 algorithms for finding font files as TEX and friends. See
1634 the docu- mentation for the __Kpathsea__ library for
1635 details (repeating it here is too cumbersome). In addition,
1636 __xdvik__ accepts the following variables:
1637
1638
1639 __DISPLAY__
1640
1641
1642 Specifies which graphics display terminal to
1643 use.
1644
1645
1646 __KPATHSEA_DEBUG__
1647
1648
1649 Trace __Kpathsea__ lookups; set it to __-1__ for
1650 complete tracing.
1651
1652
1653 __MIMELIBDIR__
1654
1655
1656 Directory containing the __mime.types__ file, if
1657 __~/.mime-types__ does not exist.
1658
1659
1660 __MAILCAPDIR__
1661
1662
1663 Directory containing the __.mailcap__ file, if
1664 __~/.mail- cap__ does not exist.
1665
1666
1667 __WWWBROWSER__
1668
1669
1670 The browser used to open URL's, if neither the
1671 __-browser__ option nor the __.wwwBrowser__ resource
1672 are set. For more information on hyper-TEX support, see the
1673 `Hypertext' node in the __dvipsk__ manual.
1674
1675
1676 __TMPDIR__
1677
1678
1679 The directory to use for storing temporary files created
3 perry 1680 when uncompressing !PostScript files.
1 perry 1681
1682
1683 __XEDITOR__
1684
1685
1686 Determines the editor command used for source spe- cial
1687 `reverse search', if neither the ''-editor'' com-
1688 mand-line option nor the ''.editor'' resource are
1689 specified. See the description of the ''-editor'' command
1690 line option for details on the format.
1691
1692
1693 __VISUAL__
1694
1695
1696 Determines an editor to be opened in an xterm win- dow if
1697 neither of ''-editor'', ''.editor'', or ''XEDITOR''
1698 is specified.
1699
1700
1701 __EDITOR__
1702
1703
1704 Determines an editor to be opened in an xterm win- dow if
1705 neither of ''-editor'', ''.editor'', ''XEDITOR'' or
1706 ''VI- SUAL'' is specified.
1707 !!LIMITATIONS
1708
1709
3 perry 1710 __xdvi__ accepts many but not all types of !PostScript
1 perry 1711 specials accepted by __dvips__. For example, it accepts
1712 most specials generated by __epsf__ and __psfig__. It
1713 does not, however, sup- port __bop-hook__ or
3 perry 1714 __eop-hook__, nor does it allow !PostScript commands to
1715 affect the rendering of things that are not !PostScript (for
1 perry 1716 example, the ``NEAT'' and rotated ``A'' examples in the
1717 __dvips__ manual). These restrictions are due to the
1718 design of __xdvi__; in all likelihood they will always
1719 remain.
1720
1721
1722 LaTEX2e color and rotation specials are not currently sup-
1723 ported.
1724
1725
3 perry 1726 __!MetaPost__ files containing included text are not
1 perry 1727 supported.
1728 !!FILES
1729
1730
1731 __xdvi.cfg__ needs to be supplied in the directory named
1732 by the __XDVIINPUTS kpathsea__ variable. Please see the
1733 file __README.t1fonts__ in the source distribution if
1734 __xdvi.cfg__ is missing. __xdvik__ also relies on the
1735 whole __kpathsea__ infras- tructure. Please see the
1736 kpathsea documentation for fur- ther
1737 information.
1738 !!SEE ALSO
1739
1740
4 perry 1741 X(1), dvips(1), __Kpathsea__
1 perry 1742 documentation
1743 !!AUTHORS
1744
1745
1746 Eric Cooper, CMU, did a version for direct output to a QVSS.
1747 Modified for X by Bob Scheifler, MIT Laboratory for Computer
1748 Science. Modified for X11 by Mark Eichin, MIT SIPB.
1749 +Additional enhancements by many others. The cur- rent
1750 maintainer of the original __xdvi__ is Paul Vojta, U.C.
1751 Berkeley; the maintainer of the __xdvik__ variant is the
1752 xdvik project at sourceforge, please see __http://source-
1753 forge.net/projects/xdvi/__
1754 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.