modules/FvwmAnimate/FvwmAnimate.1.in

   1 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   2 .TH FvwmAnimate 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   3 .UC
   4 .SH NAME
   5 \fBFvwmAnimate\fP \- the fvwm animate module
   6 .SH SYNOPSIS
   7 Module FvwmAnimate [ModuleAlias]
   8
   9 \fBFvwmAnimate\fP can only be invoked by fvwm.
  10 Command line invocation of the FvwmAnimate module will not work.
  11
  12 From within the .fvwm2rc file, \fBFvwmAnimate\fP is spawned as follows:
  13 .nf
  14 .sp
  15 Module FvwmAnimate
  16 .sp
  17 .fi
  18 or from within an fvwm pop-up menu:
  19 .nf
  20 .sp
  21 DestroyMenu Module-Popup
  22 AddToMenu   Module-Popup "Modules" Title
  23 + "Fvwm Animate Icons" Module FvwmAnimate ModuleAlias
  24 .sp
  25 .fi
  26
  27 .SH DESCRIPTION
  28 The \fBFvwmAnimate\fP module animates iconification and de-iconification
  29 or on command.
  30 There are currently 6 different animation effects.
  31
  32 .SH INVOCATION
  33 \fBFvwmAnimate\fP must be invoked by the \fBfvwm\fP window manager.
  34 When invoked with the \fIOptionalName\fP argument, the \fIModuleAlias\fP
  35 is used to find configuration commands, configuration files,
  36 and name the internally generated menus and forms instead of "FvwmAnimate".
  37 During startup, FvwmAnimate defines menus and forms for configuring and
  38 controlling FvwmAnimate.  The default menu name is "MenuFvwmAnimate"
  39 and the form name is "FormFvwmAnimate".
  40 If the optional name is used, the menu would be "Menu<ModuleAlias>"
  41 and the form would be "Form<ModuleAlias>".
  42 .sp
  43 Assuming you already had a builtin menu called "Module-Popup",
  44 you could use FvwmAnimate by configuring it like this:
  45 .nf
  46 .sp
  47 AddToFunc "StartFunction" "I" Module FvwmAnimate
  48 AddToMenu "Module-Popup" "Control Animation" Popup MenuFvwmAnimate
  49 .sp
  50 .fi
  51
  52 .SH CONFIGURATION OPTIONS
  53 Since the pop up menu "MenuFvwmAnimate" allows complete control of
  54 the \fBFvwmAnimate\fP module, you don't really have to know what any
  55 of the configuration commands are.  This section describes them anyway.
  56
  57 \fBFvwmAnimate\fP gets configuration info from \fBfvwm\fP's module configuration
  58 database (see
  59 .IR fvwm (1),
  60 section
  61 .BR "MODULE COMMANDS" ).
  62 In addition, \fBFvwmAnimate\fP reads the file $HOME/.FvwmAnimate,
  63 and accepts commands from fvwm and its modules as it runs.
  64
  65 If \fIModuleAlias\fP is used to  start FvwmAnimate, the optional name
  66 is used in all commands,  messages, menus and forms generated by  FvwmAnimate
  67 and
  68 in the configuration file name.   Unlike other fvwm modules, there is
  69 little reason to use the optional name.
  70
  71 .IP "*FvwmAnimate: Color \fBcolor\fP"
  72 Tells \fBFvwmAnimate\fP what color to draw with.
  73 The color is "XOR'ed" (exclusive ORed) onto the background.
  74 Depending on the display type you are using,  the effect this
  75 causes will vary.  Especially on 8-bit displays, it helps if the background
  76 is a solid color.  You have to experiment with this to see how it works.
  77
  78 The default color is not really a color and can be entered as "Black^White",
  79 or more simply "None".  This is the same as the default XOR mask used
  80 by fvwm for move and resize frames.
  81
  82 Other colors can be specified using standard X color notation.  Ie. color
  83 names like "LightBlue", or RGB values like "#FFFFFF".
  84
  85 .IP "*FvwmAnimate: Pixmap \fBpixmap\fP"
  86 Tells \fBFvwmAnimate\fP to use \fBpixmap\fP to draw with. This can be useful
  87 if \fB*FvwmAnimate: Color\fP gives poor results.
  88
  89 .IP "*FvwmAnimate: Delay \fBmsecs\fP"
  90 Tells \fBFvwmAnimate\fP how many milliseconds to sleep
  91 between frames of animation.
  92
  93 .IP "*FvwmAnimate: Iterations \fBiterations\fP"
  94 Tells \fBFvwmAnimate\fP how many steps to break the animation into.
  95
  96 .IP "*FvwmAnimate: Twist \fBtwist\fP"
  97 Tells \fBFvwmAnimate\fP how many revolutions to twist the iconification frame.
  98
  99 .IP "*FvwmAnimate: Width \fBwidth\fP"
 100 Tells \fBFvwmAnimate\fP how wide a line to draw with.
 101 The default width of 0 (zero) is a fast line of Width 1.
 102
 103 .IP "*FvwmAnimate: Effect \fBmode\fP"
 104 Tells \fBFvwmAnimate\fP which animation effect to use.
 105 Currently the effects are:
 106 \fIFrame\fP,
 107 \fILines\fP,
 108 \fIFlip\fP,
 109 \fITurn\fP,
 110 \fIZoom3D\fP,
 111 \fITwist\fP
 112 \fIRandom\fP,
 113 and
 114 \fINone\fP.
 115 \fINone\fP is normally set in the configuration file, in-case FvwmAnimate
 116 is started automatically, but an individual user doesn't want it running.
 117
 118 .IP "*FvwmAnimate: Stop"
 119 Tells \fBFvwmAnimate\fP to stop.
 120
 121 .IP "*FvwmAnimate: Save"
 122 Tells \fBFvwmAnimate\fP to save the current configuration in a file
 123 named ".FvwmAnimate" in the users home directory.  This same file is
 124 read automatically by FvwmAnimate during startup.
 125
 126 .SH COMMANDS
 127 \fBFvwmAnimate\fP can be asked to produce an animation thru the "SendToModule"
 128 command.  The format of the command is:
 129 .nf
 130 .sp
 131 .in +.5i
 132 SendToModule FvwmAnimate animate sx sy sw sh dx dy dw dh
 133 .in -.5i
 134 .sp
 135 .fi
 136 The second word must match the name \fBFvwmAnimate\fP is started with.
 137 The 8 fields after
 138 .I animate
 139 must be numbers.  The first 4 are for the source
 140 (or starting) location of the animation.  The last 4 are for the
 141 destination of the animation.
 142 The 2 pairs of 4 numbers, represent rectangles.
 143 The first 2 numbers are the x and y location of the upper
 144 right corner.  The next 2 numbers are the width and height.
 145 One or more spaces can separate the fields in the command.
 146
 147 Modules can use the "SendToModule" command to animate "NoIcon" windows,
 148 or you can think up your own ways to have all kinds of fun with this
 149 command.
 150
 151 Additional available commands are:
 152 .IR pause ", " play ", "
 153 .IR push ", " pop " and " reset .
 154 These may be space separated.
 155
 156 .I pause
 157 causes a module to not temporarily produce any animations.
 158 .I play
 159 causes a module to produce an animation again.
 160 .I push
 161 stores the current playing state for a future and
 162 .I pop
 163 restores it.
 164 .I reset
 165 removes all stored states and sets playing on.
 166
 167 Suppose, we don't want to wait for all 40 xterms to be animated:
 168 .nf
 169 .sp
 170 .in +.5i
 171 SendToModule FvwmAnimate pause
 172 All (XTerm) Iconify on
 173 .in -.5i
 174 .sp
 175 .fi
 176 And if we don't want to damage the current playing state, then:
 177 .nf
 178 .sp
 179 .in +.5i
 180 SendToModule FvwmAnimate push pause
 181 All (XTerm) Iconify on
 182 SendToModule FvwmAnimate pop
 183 .in -.5i
 184 .sp
 185 .fi
 186
 187 .SH ORIGIN
 188 \fBFvwmAnimate\fP is based on the \fBAnimate\fP module from Afterstep 1.5pre6.
 189 Porting to \fBfvwm\fP and lots of other changes were done by
 190 \fIDan Espen\fP <despen@telcordia.com>.
 191 Below are the original author and acknowledgments.
 192
 193 .SH AUTHOR
 194 \fIAlfredo Kengi Kojima\fP <kojima@inf.ufrgs.br>
 195
 196 .SH ACKNOWLEDGMENTS
 197 These people have contributed to \fBFvwmAnimate\fP:
 198
 199 .IP "\fIKaj Groner\fP <kajg@mindspring.com>"
 200 Twisty iconification, configuration file parsing, man page.
 201
 202 .IP "\fIFrank Scheelen\fP <scheelen@worldonline.nl>"