FvwmAnimate(1)                                     FvwmAnimate(1)



NAME
       FvwmAnimate - the Fvwm Animate module

SYNOPSIS
       FvwmAnimate is spawned by fvwm, so no command line invoca-
       tion will work.  From within the .fvwm2rc  file,  FvwmAni-
       mate is spawned as follows:

       Module FvwmAnimate

       or from within an fvwm pop-up menu:

       DestroyMenu Module-Popup
       AddToMenu   Module-Popup "Modules" Title
       + "Fvwm Animate Icons" Module FvwmAnimate OptionalName



DESCRIPTION
       The  FvwmAnimate  module  animates  iconification  and de-
       iconification or on command.  There are currently  6  dif-
       ferent animation effects.


INVOCATION
       No  command line invocation is possible.  FvwmAnimate must
       be invoked by the fvwm window manager.  When invoked  with
       the  OptionalName  argument,  the  OptionalName is used to
       find configuration commands, configuration files, and name
       the  internally generated menus and forms instead of "Fvw-
       mAnimate".  During startup, FvwmAnimate defines menus  and
       forms  for  configuring  and controlling FvwmAnimate.  The
       default menu name is "MenuFvwmAnimate" and the  form  name
       is  "FormFvwmAnimate".   If the optional name is used, the
       menu would be "Menu" and the form  would  be
       "Form".

       Assuming  you  already  had a builtin menu called "Module-
       Popup", you could use FvwmAnimate by configuring  it  like
       this:

       AddToFunc "StartFunction" "I" Module FvwmAnimate
       AddToMenu "Module-Popup" "Control Animation" Popup MenuFvwmAnimate



CONFIGURATION OPTIONS
       Since  the  pop  up menu "MenuFvwmAnimate" allows complete
       control of the FvwmAnimate module, you don't  really  have
       to  know what any of the configuration commands are.  This
       section describes them anyway.

       FvwmAnimate gets config info from fvwm's module configura-
       tion database (see fvwm2(1), section MODULE COMMANDS).  In
       addition, FvwmAnimate reads the  file  $HOME/.FvwmAnimate,
       and accepts commands from fvwm and its modules as it runs.

       If  OptionalName  is  used  to   start  FvwmAnimate,   the
       optional  name  is  used in all commands,  messages, menus
       and forms generated by  FvwmAnimate and in the  configura-
       tion file name.   Unlike other fvwm modules, there is lit-
       tle reason to use the optional name.


       *FvwmAnimate: Color color
              Tells FvwmAnimate what color  to  draw  with.   The
              color  is  "XOR'ed" (exclusive ORed) onto the back-
              ground.  Depending on  the  display  type  you  are
              using,   the  effect  this causes will vary.  Espe-
              cially on 8-bit displays, it  helps  if  the  back-
              ground  is  a  solid color.  You have to experiment
              with this to see how it works.

              The default color is not really a color and can  be
              entered  as  "Black^White",  or more simply "None".
              This is the same as the default XOR  mask  used  by
              fvwm for move and resize frames.

              Other  colors  can  be  specified  using standard X
              color notation.  Ie. color names like  "LightBlue",
              or RGB values like "#FFFFFF".


       *FvwmAnimate: Pixmap pixmap
              Tells  FvwmAnimate to use pixmap to draw with. This
              can be useful if  *FvwmAnimate:  Color  gives  poor
              results.


       *FvwmAnimate: Delay msecs
              Tells  FvwmAnimate  how  many milliseconds to sleep
              between frames of animation.


       *FvwmAnimate: Iterations iterations
              Tells FvwmAnimate how many steps to break the  ani-
              mation into.


       *FvwmAnimate: Twist twist
              Tells FvwmAnimate how many revolutions to twist the
              iconification frame.


       *FvwmAnimate: Width width
              Tells FvwmAnimate how wide a  line  to  draw  with.
              The  default  width  of  0 (zero) is a fast line of
              Width 1.


       *FvwmAnimate: Effect mode
              Tells FvwmAnimate which animation  effect  to  use.
              Currently  the  effects  are:  Frame,  Lines, Flip,
              Turn, Zoom3D, Twist Random, and None.  None is nor-
              mally  set  in the configuration file, in-case Fvw-
              mAnimate is started automatically, but an  individ-
              ual user doesn't want it running.


       *FvwmAnimate: Stop
              Tells FvwmAnimate to stop.


       *FvwmAnimate: Save
              Tells FvwmAnimate to save the current configuration
              in a file named ".FvwmAnimate" in  the  users  home
              directory.  This same file is read automatically by
              FvwmAnimate during startup.


COMMANDS
       FvwmAnimate can be asked to produce an animation thru  the
       "sendtomodule" command.  The format of the command is:

       sendtomodule FvwmAnimate animate sx sy sw sh dx dy dw dh

       The second word must match the name FvwmAnimate is started
       with.  The word "animate" must be in lower case.  The next
       8  fields must be numbers.  The first 4 are for the source
       (or starting) location of the animation.  The last  4  are
       for  the  destination  of the animation.  The 2 pairs of 4
       numbers, represent rectangles.  The first  2  numbers  are
       the  x and y location of the upper right corner.  The next
       2 numbers are the width and height.  One  or  more  spaces
       can separate the fields in the command.

       Modules  can  use  the  "sendtomodule"  command to animate
       "NoIcon" windows, or you can think up  your  own  ways  to
       have all kinds of fun with this command.


ORIGIN
       FvwmAnimate  is based on the Animate module from Afterstep
       1.5pre6.  Porting to fvwm and lots of other  changes  were
       done  by  Dan Espen .  Below are the
       original author and acknowledgments.


AUTHOR
       Alfredo Kengi Kojima 


ACKNOWLEDGMENTS
       These people have contributed to FvwmAnimate:


       Kaj Groner 
              Twisty iconification, configuration  file  parsing,
              man page.


       Frank Scheelen 



                           3 July 2001             FvwmAnimate(1)