File: README

package info (click to toggle)
advi 1.6.0-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 17,416 kB
  • ctags: 2,825
  • sloc: ml: 12,261; sh: 1,500; ansic: 935; makefile: 738; perl: 57; tcl: 10
file content (229 lines) | stat: -rw-r--r-- 8,091 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
WARNING -- WARNING -- WARNING -- WARNING -- WARNING -- WARNING -- WARNING
=========================================================================

    advi -safer file.dvi

    Active-DVI ``plays'' the DVI files that is displays: during
    presentation advi can launch arbitrary commands that were
    incorporated into the LaTeX source of the DVI file to animate the
    presentation.
    Hence, when playing a DVI file from some untrusted source, you
    must use the -safer option that prevents the execution of
    embedded commands:

    advi -safer file.dvi

For instance, if you choose advi as your default application to view
DVI files, the safe entry for your .mailcap file is
 
    application/x-dvi; advi -safer %s

It is also recommended to check before visualisation the list of
embedded commands that a suspicious DVI file could execute by calling

    advi -n file.dvi


                 Presentation
                 ============


Active-DVI is a DVI previewer and presenter written in Objective Caml
(http://caml.inria.fr/ocaml/) with some eye candy effects for
presentation, support for interactive demonstrations, and embedding of
arbitrary applications within the presentation (hence the Active
adjective of the presenter :).

Active-DVI is largely based on Mldvi written by Alexandre Miquel
(http://pauillac.inria.fr/~miquel/).

Version: 1.0
available at http://pauillac.inria.fr/advi/

CURRENTLY SUPPORTED FEATURES:
=============================

+ Encapsulated Postscript File inclusion (using graphics package)
+ Effects for presentation (pause, delay, text color change) 
+ Embedded applications for interactive demonstration

+ Pictures visualization via gpic specials

+ Display of inlined Postscript using gs
+ Font antialiasing that takes background colors into account
+ Page display is interrupted on user input
+ Resizing the page adjusts the magnification
+ Start displaying at a given page or at a given link reference
+ The file is reloading on signal SIGUSR1
+ Hyperlinks
+ Active areas (execute an action when the mouse is over)
+ Background colors and images
+ Alpha blending for images

INVOCATION
==========

The invocation is

        advi [OPTIONS...] DVIFILE

where OPTIONS are:

  -safer                Safer mode: external applications are not launched
  -geometry GEOM        Sets the (maximum) geometry GEOM
  -g GEOM               Same as -geometry GEOM
  -crop                 Crop the window to the best size (default)
  -nocrop               Disable cropping
  -nomargins            Suppress horizontal and vertical margins
  -hmargin DIMEN        Horizontal margin  (default: 1cm)
  -vmargin DIMEN        Vertical margin    (default: 1cm)
  -A                    Set Postscript antialias
  -bg                   Draw in the background
  -fullwidth            Adjust size to width
  -html STRING          Make advi start at html reference of name STRING
  -nogs                 Turn off dipslay of inlined Postscript
  -nopauses             Swictch pauses off
  -page INT             Make advi start at page INT
  -pager STRING         Command to call the pager
  -safer                Safer mode: external applications are not launched
  -scalestep REAL       Scale step for '<' and '>' (default sqrt (sqrt (sqrt 2.0)))

Geometry GEOM is specified in pixels, using the standard format
for specifying geometries (i.e: "WIDTHxHEIGHT[+XOFFSET+YOFFSET]").

Dimensions (for options `-hmargin' and `-vmargin') are specified as
numbers optionally followed by two letters representing units.

When no units are given, dimensions are treated as numbers of pixels.

Currently supported units are the standard TeX units as specified in
the TeXbook (D. Knuth, Addison-Wesley, (C) 1986):

  `pt' (point), `pc' (pica), `in' (inch), `bp' (big point),
  `cm' (centimeter), `mm' (millimeter), `dd' (didot point),
  `cc' (cicero) and `sp' (scaled point).

Note that dimensions are specified w.r.t the original TeX document,
and do not correspond to what is actually shown on the screen, which
can be displayed at a different resolution than specified in the
original TeX source.


KEYSTROKES
==========

Advi recognizes the following keystrokes when typed in its window.
Each may optionally be preceded by a number, called ARG below, whose
interpretation is keystroke dependant. If ARG is unset, its value is
1, unless specified otherwise.

Advi maintains an history of previously visited pages organized as a stack. 
Additionnally, the history contains mark pages which are stronger than
unmarked pages.

q       Quits the program

return  If ARG is non zero, push the current page on the history stack,
        and move forward Arg physical pages.

n       Move ARG physical pages forward, leaving the history unchanged.

p       Move ARG physical pages backward, leaving the history unchanged.

tab     Push the current page on top of the history as a marked page,
        do no move.

space   Move to the next pause if any, or do as return otherwise.

backspace
        Move ARG pages backward according to the history.
        The history stack is poped, accordingly. 

escape
        Move ARG marked pages backward according to the history.
        Do nothing if the history does no contain any marked page.

g       If ARG is unset move to the last page.
        If ARG is the current page do nothing.
        Otherwise, push the current page on the history as a marked
        page, and move to the physical page ARG.

,       Move to the first page.
        
.       Move to the last page.
        
c       Center the page in the window, and resets the default resolution.
        
<       Scale the resolution by 1/1.414

>       Scale the resolution by 1.414

f       Load all the fonts used in the documents. By default, fonts
        are loaded only when needed.

r       Redraw the current page.

R       Reload the file and redraw the current page.

F       Does the same as `f', and precomputes the glyphs of all
        characters used in the document. This takes more time than
        loading the fonts, but the pages are drawn faster.

C       Erase the image cache.

A click on an hyperlink, push the current page on this history as marked
(unless the target page is the current page) and move to the target page.
If the target is visible, it highlights the target.

Moreover, the user can drag the currently displayed page in the window
in order to change its relative position. (This is useful when the
page is displayed at a resolution such that cannot fit in the
window.)


EYE CANDY MACROS
================

Using the LaTeX style advi.sty provided with the package, you can
embed some Active-DVI specials into your TeX documents. Advi
interprets those specials to provide some eye candy features for your
presentation.

\wait{sec}
	Delay the rendering at the point of the document for sec
        seconds. Wait forever (i.e. stops) if parameter sec is omitted.

\advirecord[play]{this}{material}
	Define an "advi tag" named ``this'' to refer to the text
        enclosed in the following brackets. The tag can be later on
        to play or replay the text. By default, [material] is not
        display, unless option [play] is set.

\adviplay[color]{this}
	Replay the material previously bound to {this}. If [color] is
        provided changes the drawing color to [color] before displaying.

Please look at doc/manula.dvi for more information.
Look in directory test for examples (try advi test/*.dvi).
Advanced examples are in directory examples.
(See examples/seminar/clock/tools.dvi, examples/prosper/LL/ll.dvi,
examples/prosper/Join/join.dvi.)

COPYRIGHT
=========

This program is distributed under the GNU LGPL. 
See the enclosed file COPYING.


AUTHOR
======

Alexandre Miquel  <Alexandre.Miquel@inria.fr>
Jun Furuse <Jun.Furuse@inria.fr>
Didier Remy <Didier.Remy@inria.fr> inlined Postcript, hyperlinks
Pierre Weis <Pierre.Weis@inria.fr>
Xavier Leroy <Xavier.Leroy@inria.fr> gpic specials
Roberto Di Cosmo <dicosmo@pauillac.inria.fr>
Didier Le Botlan <Didier.Le_Botlan@inria.fr>
Alan Schmitt <Alan.Schmitt@inria.fr>