.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH ADVI 1 "October 07, 2005"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
.B advi
\-\- a DVI previewer and presenter
with some eye candy effects for presentation.

.SH VERSION
Active\-DVI version 1.10.1
.SH SYNOPSIS
.B advi
.RI [ options ] " dvifile " ...
.SH DESCRIPTION
The 
.B advi
program is a viewer for DVI files that also recognizes a new class of
special's targeted to presentations via laptop computers: various
visual effects can easily be incorporated to the presentation, via a
companion
.I advi.sty
LaTeX package.
If the input 
.I dvifile 
is a DVI file that has been compressed with 
.BR gzip (1)
or
.BR bzip2 (1)
it will be automatically decompressed.

.P
.B advi
is also a full-fledged graphical presenter that provides a wealth of
effects via
.B embedded
applications. Embedded applications are arbitrary Unix programs that
are launched on demand during the presentation; an embedded
application may display its material on a devoted area of the slide,
leading for example to live and/or interactive demos during the
presentation.

.SH 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
.BR gpic (1)
specials

\- Display of inlined Postscript using 
.BR gs (1)

\- 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 to other pages or slides

\- Active areas (execute an action when the mouse is over)

\- Background colors and images

\- Alpha blending for images

\- Bubbles, active anchors, annotations

\- Init files to set up options

\- Safety policy for embedded application

\- Scratching (interactive drawing and writing on slides during presentation)

\- Floating table of contents (either as hyperlinks on a regular LaTeX
table of contents or as small images set up on a page)

\- Transitions (slide animations when changing pages)

\- Text movements

\- Integrated ``Laser pointer'' feature to point to the slide

Notice that
.B advi
needs the 
.BR kpsewhich (1)
tool in order to find and
recompile PK fonts.  (This program is part of the `kpathsea' library
provided by many TeX distributions.)

.SH OPTIONS
Options are :
.TP
.B \-\-debug
General debug
.TP
.B \-\-debug_pages
Debug page motion
.TP
.B \-\-ignore_background
Ignore background for antialiasing
.TP
.B \-\-showps
Print a copy of Postscript sent to 
.BR gs (1)
to stdout
.TP
.B \-\-verbose\-image\-access
Change the cursor while loading images
.TP
.B \-\-version
Print the current Active\-DVI version, sub\-version and release date
.TP
.B \-A
Set Postscript antialiasing (default is unset)
.TP
.B \-ask
 Ask mode: launching an external application requires confirmation
(this is the default)
.TP
.B \-bbox
Show the bounding box
.TP
.B \-bgcolor STRING
Set default background color (Named or RGB)
.TP
.B \-browser STRING
Command to call the browser (default netscape\-communicator)
.TP
.B \-cache\-dir STRING
Set the cache directory (default 
.IR /tmp )
.TP
.B \-click\-turn
Turn pages with mouse clicks (see the doc)
.TP
.B \-crop
Crop the window to the best size (default)
.TP
.B \-disable\-image\-anti\-aliasing
Disable EPS inclusion anti\-aliasing
.TP
.B \-edit
Start in edit mode
.TP
.B \-exec
Exec mode: allow all external applications to be executed
.TP
.B \-fg
Draw in the foreground
.TP
.B \-fgcolor STRING
Set default foreground color (Named or RGB)
.TP
.B \-film\-viewer STRING
Command to display film files (default 
.BR mplayer (1))
.TP
.B \-fullwidth
Adjust size to width
.TP
.B \-g GEOM
Same as \-geometry GEOM
.TP
.B \-gamma FLOAT (>0)
Gamma correction of glyphs (default 1.000000)
.TP
.B \-geometry GEOM
Sets the (maximum) geometry GEOM
.TP
.B \-hmargin DIMEN
Horizontal margin (default: 1cm)
.TP
.B \-html STRING
Make
.B advi
start at HTML reference of name STRING
.TP
.B \-image\-viewer STRING
Command to display image files (default xv)
.TP
.B \-inherit\-background
Background options are inherited from previous page
.TP
.B \-n
Echoes commands, but does not execute them.
.TP
.B \-noautoresize
Prevents scaling from resizing the window (done if geometry is provided)
.TP
.B \-noautoscale
Prevents resizing the window from scaling (done if geometry is provided)
.TP
.B \-nocrop
Disable cropping
.TP
.B \-nogs
Turn off display of inlined Postscript
.TP
.B \-nomargins
Suppress horizontal and vertical margins
.TP
.B \-nopauses
Switch pauses off
.TP
.B \-nowatch
Don't display a watch when busy
.TP
.B \-options\-file STRING
Load this file when parsing this option to set up options
(to override the options of the default 
.I ~/.advirc 
or
.I ~/.advi/advirc 
init file)
.TP
.B \-page INT
Make
.B advi
start at page INT
.TP
.B \-page\-number
Ask
.B advi
to write the current page number in a file (default is no)
.TP
.B \-page\-number\-file STRING
Set the name of the file where
.B advi
could write the current page number
(default is file 'advi\_page\_number' in the cache directory)
.TP
.B \-pager STRING
Command to call the pager (default xterm \-e less)
.TP
.B \-passive
Cancel all Active\-DVI effects
.TP
.B \-pdf\-viewer STRING
Command to view PDF files (default 
.BR xpdf (1))
.TP
.B \-ps\-viewer STRING
Command to view PS files (default 
.BR gv (1))
.TP
.B \-pstricks
Show moveto
.TP
.B \-resolution REAL
DPI resolution of the screen (min. 72.27)))
.TP
.B \-rv
Reverse video is simulated by swapping the foreground and background colors
.TP
.B \-safer
 Safer mode: external applications are never launched. This is the default on
 the Debian version of advi.
.TP
.B \-scalestep REAL
Scale step for '<' and '>' (default sqrt (sqrt (sqrt 2.0)))
.TP
.B \-scratch\-font STRING
Set the font used when scratching slides (default times bold)
.TP
.B \-scratch\-font\-color STRING
Set the color of the font used when scratching slides (default red)
.TP
.B \-scratch\-line\-color INT
Set the color of the pen used when scratching slides (default red)
.TP
.B \-scratch\-line\-width INT
Set the width of the pen used when scratching slides (default 2)
.TP
.B \-thumbnail\-scale INT
Set the number of thumbname per line and column to INT
.TP
.B \-thumbnails
Create thumbnails for your slides and write them into cachedir
.TP
.B \-thumbnails\-size STRING
Fix thumbnails size (default 24x32)
.TP
.B \-v
Print the current Active\-DVI version
.TP
.B \-vmargin DIMEN
Vertical margin (default: 1cm)
.TP
.B \-w STRING
A/a enable/disable all warnings
.TP
.B \-watch FLOAT
Delay before the watch cursor appears (default 0.500000s)
.TP
.B \-help
Display this list of options
.TP
.B \-\-help
Display this list of options

.P
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):

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

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.

.SH KEYSTROKES

Advi recognizes the following keystrokes when typed in its window.
Some of them may optionally be preceded by a number, called ARG below,
whose interpretation is keystroke dependent. If ARG is unset, its
value is 1.

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

.RS 2
.TP 8
.B ?
Quick info and key bindings help.

.TP
.B q
Quits the program.

.TP
.B ^X\-^C (Control\-X Control\-C)
Quits the program.

.TP
.B ^X\-^F (Control\-X Control\-F)
Turn to full screen mode.

.TP
.B ^F (Control\-F)
Toggle to switch from full screen to normal mode and converse.

.TP
.B ^<button> (Control + left mouse button)
Allow moving the page into the window (useful in full screen mode).

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

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

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

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

.TP
.B <space>
Move to the next pause if any, or do as return otherwise.

.TP
.B <backspace>
Move ARG pages backward according to the history.
The history stack is popped, accordingly.

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

.TP
.B 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.

.TP
.B ,
Move to the first page.

.TP
.B .
Move to the last page.

.TP
.B c
Center the page in the window and resets the default resolution.

.TP
.B <
Scale the resolution by 1/scalestep (default 1/sqrt (sqrt (sqrt 2.0))).

.TP
.B >
Scale the resolution by  scalestep (default sqrt (sqrt (sqrt 2.0))).

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

.TP
.B 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.

.TP
.B r
Redraw the current page.

.TP
.B R
Reload the file and redraw the current page.

.TP
.B C
Erase the image cache.

.TP
.B T
Process thumbnails (graphical table of contents for the show).

.TP
.B t
Display thumbnails if processed or floating table of contents, or do
nothing.

.TP
.B ^X\-l (Control\-X l)
Toggle on or off the laser pointer.

.TP
.B s
Turn on the write scratching mode (to interactively write on the
slide). When in scratching mode press
.B ? 
to get help.

.TP
.B S
Turn on the draw scratching mode (to interactively draw on the
slide). When in scratching mode press
.B ? 
to get help.

.TP
.B ^X\-^S (Control\-X Control\-S)
Save an image of the current state of the slide. The default image file
name is shot
.B <n>
where
.B <n>
is the next available integer number such that no previously saved
slide image is overwritten. The default image format is PNG which
is the extension of the image file.

.RE

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 it cannot fit in the
window.)

.SH EYE CANDY MACROS

Using the LaTeX style
.I advi.sty
provided with the package, you can
embed some Active\-DVI specials into your TeX documents.
.B Advi
interprets those specials to provide some eye candy features for your
presentation. For the casual user, the 
.I advi\-slides.sty
package gives
a truly simple way to write a show for
.B advi
(see in the examples directory or the documentation inside the
.I advi\-slides.sty
file for more information).

.TP
.B \eadviwait
Active\-DVI stops rendering at the point of the document and wait a user key
stroke.

.TP
.B \eadviwait{sec}
Delay the rendering at the point of the document for sec seconds.

.TP
.B \eadvirecord[play]{this}{material}
Define an "advi tag" named ``this'' to refer to the text enclosed in the
following brackets. The tag can be used to change the color of the text
later.

.TP
.B \eadvirecord{this}{material}
Same as \eadvirecord[play]{this}{material}, but does not render the
text at this point. You can display the text later, using the \eadviplay macro.

.TP
.B \eadviplay{this}
Display the texts associated with the tag ``this''.

.TP
.B \eadviplay[col]{this}
Display the texts associated with the tag ``this'', using the color ``col''.

.RE
The directory examples contains a lot of presentations.
Please look also at
.I test/demo*.{tex|dvi} 
and 
.I test/macros.{tex|dvi} 
for
a rather comprehensive demonstration of Active\-DVI capabilities.

.SH COPYRIGHT
This program is distributed under the GNU LGPL.
.SH SEE ALSO
.BR latex (1),
.BR kpsewhich (1),
the user's manual (http://caml.inria.fr/advi/manual.dvi),
and the advi FAQ (http://caml.inria.fr/advi/faq.html).

.SH AUTHORS
Jun Furuse <Jun.Furuse@inria.fr>
Pierre Weis <Pierre.Weis@inria.fr>
Didier Remy <Didier.Remy@inria.fr> inlined Postscript, hyperlinks
Roberto Di Cosmo <dicosmo@pauillac.inria.fr>
Xavier Leroy <Xavier.Leroy@inria.fr> 
.BR gpic (1)
specials
Didier Le Botlan <Didier.Le_Botlan@inria.fr>
Alan Schmitt <Alan.Schmitt@inria.fr>
Alexandre Miquel  <Alexandre.Miquel@inria.fr>
.P
The original version of this manual page was written by Sven LUTHER
<luther@debian.org>, for the Debian GNU/Linux system port of 
.B advi
version 1.2.  This page has then been enhanced and updated for later
versions of Active\-DVI, and finally rewritten for version 1.6 by
Pierre Weis.