FvwmAnimate(1.1)

NAME
FvwmAnimate - the Fvwm2 Animate module

SYNOPSIS
FvwmAnimate is spawned by fvwm2, so no command line invocation will work. From within the .fvwm2rc file, FvwmAnimate is spawned as follows:

Module FvwmAnimate

or from within an fvwm2 pop-up menu:

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

DESCRIPTION
The FvwmAnimate module animates iconification and deiconification. There are currenly 6 different animation effects.

INVOCATION
No command line invocation is possible. FvwmAnimate must be invoked by the fvwm2 window manager. When invoked with the OptionalName argument, the OptionalName is used to find configuration commands, configuraton files, and name the internally generated menus and forms instead of "FvwmAnimate". 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<OptionalName>" and the form would be "Form<OptionalName>".

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

AddToFunc "InitFunction" "I" Module FvwmAnimate
AddToFunc "RestartFunction" "I" Module FvwmAnimate
AddToMenu "Module-Popup" "Control Animation" Popup MenuFvwmAnimate

CONFIGURATION OPTIONS
Since the popup 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 reads the same .fvwm2rc file as fvwm2 reads when it starts up. In addition, FvwmAnimate reads the file $HOME/.FvwmAnimate, and accepts commands from fvwm2 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 configuration file name. Unlike other fvwm2 modules, there is little reason to use the optional name.

*FvwmAnimateColor color
    Tells FvwmAnimate what color to draw with. The color is "XOR'ed" (exclusive ORed) onto the background. Depending on the display type you are using, the effect this causes will vary. Especially on 8-bit displays, it helps if the background 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 fvwm2 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".

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

*FvwmAnimateIterations iterations
    Tells FvwmAnimate how many steps to break the animation into.

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

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

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

*FvwmAnimateStop
    Tells FvwmAnimate to stop.

*FvwmAnimateSave
    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.

ORIGIN
FvwmAnimate is based on the Animate module from Afterstep 1.5pre6. Porting to fvwm2 and lots of other changes were done by Dan Espen <dane@mk.bellcore.com>. Below are the original author and acknowledgments.

AUTHOR
Alfredo Kengi Kojima <kojima@inf.ufrgs.br>

ACKNOWLEDGMENTS
These people have contributed to FvwmAnimate:

Kaj Groner <kajg@mindspring.com>
    Twisty iconification, configuration file parsing, man page.

Frank Scheelen <scheelen@worldonline.nl>