tomwalters@0: .TH XREVIEW 1 "12 May 1995"
tomwalters@0: .LP
tomwalters@0: .SH NAME
tomwalters@0: .LP
tomwalters@0: xreview \- display of AIM cartoons for X Window System
tomwalters@0: .SH SYNOPSIS
tomwalters@0: .LP
tomwalters@0: xreview [options] [filename]
tomwalters@0: .LP
tomwalters@0: .SH OVERVIEW
tomwalters@0: .LP
tomwalters@0: xreview is a program for displaying bitmap cartoons produced by the AIM
tomwalters@0: software. All frames of a cartoon or a subset of frames can be played.
tomwalters@0: The speed may be slowed and it is possible to step through
tomwalters@0: a cartoon frame-by-frame. It has been tested under X11R4 and above. 
tomwalters@0: .SS GENERATION OF BITMAP CARTOONS
tomwalters@0: .LP
tomwalters@0: Any AIM module that creates a sequence of pictures, or "frames", may be used
tomwalters@0: to generate a cartoon. The frames are saved as bitmaps; that is, a copy
tomwalters@0: of the screen memory for the frame.  The bitmaps are created using the option "bitmap". For example,
tomwalters@0: .RS 4
tomwalters@0:   gensai [options] -bitmap [options] waveform
tomwalters@0: .RE
tomwalters@0: .LP
tomwalters@0: This creates a file called "waveform.ctn", which can be used as input
tomwalters@0: to xreview.
tomwalters@0: .LP
tomwalters@0: xreview reads and plays the sequence of bitmaps. The bitmap option
tomwalters@0: is available for AIM modules genasa, genepn, gensai and genspl.
tomwalters@0: .LP
tomwalters@0: Because the bitmaps are an exact copy of the screen memory, it is impossible
tomwalters@0: to change either the size of the cartoon or any AIM display parameters 
tomwalters@0: within xreview. In addition, if the cartoons are generated on a mulitplane
tomwalters@0: screen (e.g. 8 bits deep) then the bitmaps are very big, even though only
tomwalters@0: two colours are used by the AIM display software.  The hidden option "mono_ctn=on" 
tomwalters@0: may be used to copy only a 1-bit plane from the screen to the bitmaps.
tomwalters@0: On some machines the incorrect plane may be copied, in which case the 
tomwalters@0: cartoon displayed by xreview looks completely different to the cartoon
tomwalters@0: as it was generated by the AIM software. If this occurs, then
tomwalters@0: the option "planemask_ctn" may be used to specify which plane is copied.
tomwalters@0: This is best done by trial-and-error.  The hidden option "colour_ctn=on" forces
tomwalters@0: all planes to be copied to the bitmaps.
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: .SS DISPLAY OF BITMAP CARTOONS
tomwalters@0: .LP
tomwalters@0: The basic xreview command is 
tomwalters@0: .LP
tomwalters@0: 	xreview [options] waveform.ctn
tomwalters@0: .LP
tomwalters@0: This loads the entire cartoon and displays the first frame.  
tomwalters@0: There are two control modes: 
tomwalters@0: .LP
tomwalters@0:  (a) keyboard and mouse-buttons within the Cartoon Window, 
tomwalters@0: .LP
tomwalters@0: .RS 1
tomwalters@0: or
tomwalters@0: .RE
tomwalters@0: .LP
tomwalters@0:  (b) a separate "Controls Window".
tomwalters@0: 
tomwalters@0: 
tomwalters@0: .SS KEYBOARD CONTROL (cursor in the Cartoon Window)
tomwalters@0: .LP
tomwalters@0: space/return: animate cartoon once (leaving the last 
tomwalters@0: .RS 35
tomwalters@0: frame displayed).
tomwalters@0: .RE
tomwalters@0: .LP
tomwalters@0: .RS 4
tomwalters@0: n:     move to and display next frame
tomwalters@0: .LP
tomwalters@0: p:     move to and display previous frame
tomwalters@0: .LP
tomwalters@0: q:     quit xreview.
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: 
tomwalters@0: .LP
tomwalters@0: left mouse button:    animate cartoon once (leaving the  
tomwalters@0: .RS 30
tomwalters@0: last frame displayed).
tomwalters@0: .RE
tomwalters@0: .LP
tomwalters@0: right mouse button:   quit xreview.
tomwalters@0: .LP
tomwalters@0: middle mouse button:  display Controls Window.
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: .SH CONTROLS WINDOW
tomwalters@0: .LP
tomwalters@0: 'Buttons' in the Controls Window set the start frame and end frame of the 
tomwalters@0: animation, the framestep in the animation (e.g., skip every 2nd frame) and
tomwalters@0: the speed of the animation; the number indicates the delay between
tomwalters@0: frames in ms.  The buttons in the bottom panel move to and display a single
tomwalters@0: frame:
tomwalters@0: .LP
tomwalters@0: <<       back 10 frames
tomwalters@0: .LP
tomwalters@0: <        previous frame
tomwalters@0: .LP
tomwalters@0: >        next frame
tomwalters@0: .LP
tomwalters@0: >>       forward 10 frames
tomwalters@0: .LP
tomwalters@0: first    first frame
tomwalters@0: .LP
tomwalters@0: middle   middle frame
tomwalters@0: .LP
tomwalters@0: last     last frame
tomwalters@0: .LP
tomwalters@0: The numbers in the bottom-right corner indicate the current frame and the
tomwalters@0: total number of frames.
tomwalters@0: .LP
tomwalters@0: Unlike AIM displays from gen??? instructions, the cartoons may be
tomwalters@0: moved, iconified, hidden, etc. in the normal way.  The gen???
tomwalters@0: instructions are from an earlier are when few graphical tools were
tomwalters@0: available.
tomwalters@0: 
tomwalters@0: .SH OPTIONS
tomwalters@0: .LP
tomwalters@0: There are a number of command-line options; special purpose
tomwalters@0: abbrievations are indicated in parentheses.  (The instructions are in
tomwalters@0: a slightly different form to the gen??? instructions.)
tomwalters@0: .LP
tomwalters@0: .SS   Control Window Options
tomwalters@0: .LP
tomwalters@0: .RS 5
tomwalters@0: -controls   automatically display controls window 
tomwalters@0: .RE
tomwalters@0: .RS 17
tomwalters@0: (-con)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -controls_x <int>  x-position of controls window 
tomwalters@0: .RE
tomwalters@0: .RS 24 
tomwalters@0: in pixels   (-cx)  
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -controls_y <int>  y-position of controls window 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: in pixels (-cy)    
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -controls_size <string>  size of controls window:  
tomwalters@0: .RE
tomwalters@0: .RS 30
tomwalters@0: (-csize)  
tomwalters@0: .RE
tomwalters@0: .RS 30
tomwalters@0: "tiny", "small" or "normal"
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: .SS   Cartoon Options
tomwalters@0: .LP  
tomwalters@0: .RS 5 
tomwalters@0: -image_x <int>  x-position of cartoon in pixels  (-ix)          
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -image_y <int>  y-position of cartoon in pixels  (-iy)          
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -speed   <int>  delay between frames in ms; default = 1 
tomwalters@0: .RE
tomwalters@0: .RS 21
tomwalters@0: (-speed)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -start   <int>  start frame of animation; 
tomwalters@0: .RE
tomwalters@0: .RS 21
tomwalters@0: default = first  (-start)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -stop    <int>  stop frame of animation; 
tomwalters@0: .RE
tomwalters@0: .RS 21
tomwalters@0: default = last    (-stop)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -skip    <int>  framestep in animation; 
tomwalters@0: .RE
tomwalters@0: .RS 21
tomwalters@0: default = 1        (-skip)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -frame   <int>  intial frame to display; 
tomwalters@0: .RE
tomwalters@0: .RS 21
tomwalters@0: default = first   (-frame)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -help   generate the help page   (-h)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -verbose  send some running information 
tomwalters@0: .RE
tomwalters@0: .RS 15
tomwalters@0: to stderr    (-v)
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: .LP
tomwalters@0: .SS   Cartoon Window Options
tomwalters@0: .LP  
tomwalters@0: .RS 5
tomwalters@0: -display <string>  X display server to use   -d
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -font <font>       font used in controls window 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: (default = Times) -f
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -point <int>       fontsize (default depends upon 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: size of controls window)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -title <string>    title of cartoon window 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: (and of its icon)
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -mono              assume monochrome (single-plane)   
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: cartoons; default
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -colour            assume colour (multi-plane) 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: cartoons
tomwalters@0: .LP
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: The following options should not be necessary if cartoons are generated and
tomwalters@0: displayed on the same CPU architecture and screen hardware.  They are of use,
tomwalters@0: however, if the CPU or screen differ.
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -rv                reverse-video the cartoon 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: window
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -planemask <int>   value of planemask for displaying 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: bitmaps; default = 1
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -lsb               assume bit and byte order of 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: cartoon is LSBFirst
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -msb               assume bit and byte order of 
tomwalters@0: .RE
tomwalters@0: .RS 24
tomwalters@0: cartoon is MSBFirst
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -dec               alias for '-lsb -rv'
tomwalters@0: .RE
tomwalters@0: .RS 5
tomwalters@0: -sun               alias for '-msb'
tomwalters@0: .RE
tomwalters@0: 
tomwalters@0: .SH SEE ALSO
tomwalters@0: .LP
tomwalters@0: review
tomwalters@0: 
tomwalters@0: .SH BUGS
tomwalters@0: .LP
tomwalters@0: None currently.
tomwalters@0: 
tomwalters@0: .SH COPYRIGHT
tomwalters@0: .LP
tomwalters@0: Copyright (c) Applied Psychology Unit, Medical Research Council, 1993-1995
tomwalters@0: .LP
tomwalters@0: Permission to use, copy, modify, and distribute this software without fee 
tomwalters@0: is hereby granted for research purposes, provided that this copyright 
tomwalters@0: notice appears in all copies and in all supporting documentation, and that 
tomwalters@0: the software is not redistributed for any fee (except for a nominal 
tomwalters@0: shipping charge). Anyone wanting to incorporate all or part of this 
tomwalters@0: software in a commercial product must obtain a license from the Medical 
tomwalters@0: Research Council.
tomwalters@0: .LP
tomwalters@0: The MRC makes no representations about the suitability of this 
tomwalters@0: software for any purpose.  It is provided "as is" without express or 
tomwalters@0: implied warranty.
tomwalters@0: .LP
tomwalters@0: THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING 
tomwalters@0: ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL 
tomwalters@0: THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES 
tomwalters@0: OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, 
tomwalters@0: WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 
tomwalters@0: ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 
tomwalters@0: SOFTWARE.
tomwalters@0: .LP
tomwalters@0: 
tomwalters@0: .SH AUTHOR
tomwalters@0: .LP
tomwalters@0: M. Akeroyd, MRC Applied Psychology Unit, Cambridge, UK.