-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds the fvwm3 manual pages back to the website due to demand. The majority of the output is created directly by asciidoctor with a shell script that I've submitted to the fvwm3 source that slightly modifies it to better fit on the website. This is the current manual pages as of the 1.1.0 release.
- Loading branch information
1 parent
9ae3281
commit e51e32f
Showing
31 changed files
with
31,892 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,268 @@ | ||
| --- | ||
| title: FvwmAnimate manual page | ||
| showtitle: 1 | ||
| permalink: /Man/FvwmAnimate/index.html | ||
| --- | ||
| <div id="markdown-toc"> | ||
| <ul class="sectlevel1"> | ||
| <li><a href="#_name">NAME</a></li> | ||
| <li><a href="#_synopsis">SYNOPSIS</a></li> | ||
| <li><a href="#_description">DESCRIPTION</a></li> | ||
| <li><a href="#_invocation">INVOCATION</a></li> | ||
| <li><a href="#_configuration_options">CONFIGURATION OPTIONS</a></li> | ||
| <li><a href="#_commands">COMMANDS</a></li> | ||
| <li><a href="#_origin">ORIGIN</a></li> | ||
| <li><a href="#_author">AUTHOR</a></li> | ||
| <li><a href="#_acknowledgments">ACKNOWLEDGMENTS</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_name">NAME</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p>FvwmAnimate - the fvwm animate module</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_synopsis">SYNOPSIS</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p>Module FvwmAnimate [ModuleAlias]</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p><strong>FvwmAnimate</strong> can only be invoked by fvwm. Command line invocation of | ||
| the FvwmAnimate module will not work.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>From within the .fvwm2rc file, <strong>FvwmAnimate</strong> is spawned as follows:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>Module FvwmAnimate</pre> | ||
| </div> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>or from within an fvwm pop-up menu:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>DestroyMenu Module-Popup | ||
| AddToMenu Module-Popup "Modules" Title | ||
| + "Fvwm Animate Icons" Module FvwmAnimate ModuleAlias</pre> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_description">DESCRIPTION</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p>The <strong>FvwmAnimate</strong> module animates iconification and de-iconification or | ||
| on command. There are currently 6 different animation effects.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_invocation">INVOCATION</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p><strong>FvwmAnimate</strong> must be invoked by the <strong>fvwm</strong> window manager. When invoked | ||
| with the <em>OptionalName</em> argument, the <em>ModuleAlias</em> is used to find | ||
| configuration commands, configuration 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<ModuleAlias>" and the form would be "Form<ModuleAlias>".</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>Assuming you already had a builtin menu called "Module-Popup", you could | ||
| use FvwmAnimate by configuring it like this:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>AddToFunc "StartFunction" "I" Module FvwmAnimate | ||
| AddToMenu "Module-Popup" "Control Animation" Popup MenuFvwmAnimate</pre> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_configuration_options">CONFIGURATION OPTIONS</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p>Since the pop up menu "MenuFvwmAnimate" allows complete control of the | ||
| <strong>FvwmAnimate</strong> module, you don’t really have to know what any of the | ||
| configuration commands are. This section describes them anyway.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p><strong>FvwmAnimate</strong> gets configuration info from <strong>fvwm</strong>'s module configuration | ||
| database (see <em>fvwm</em>(1), section <strong>MODULE COMMANDS</strong>). In addition, | ||
| <strong>FvwmAnimate</strong> reads the file $HOME/.FvwmAnimate, and accepts commands | ||
| from fvwm and its modules as it runs.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>If <em>ModuleAlias</em> 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 fvwm modules, there is | ||
| little reason to use the optional name.</p> | ||
| </div> | ||
| <div class="dlist"> | ||
| <dl> | ||
| <dt class="hdlist1">*FvwmAnimate: Color color</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> 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.</p> | ||
| <div class="paragraph"> | ||
| <p>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.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>Other colors can be specified using standard X color notation. Ie. color | ||
| names like "LightBlue", or RGB values like "#FFFFFF".</p> | ||
| </div> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Pixmap pixmap</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> to use <strong>pixmap</strong> to draw with. This can be useful | ||
| if <strong>*FvwmAnimate: Color</strong> gives poor results.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Delay msecs</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> how many milliseconds to sleep between frames of | ||
| animation.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Iterations iterations</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> how many steps to break the animation into.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Twist twist</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> how many revolutions to twist the iconification | ||
| frame.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Width width</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> how wide a line to draw with. The default width of | ||
| 0 (zero) is a fast line of Width 1.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Effect mode</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> which animation effect to use. Currently the | ||
| effects are: <em>Frame</em>, <em>Lines</em>, <em>Flip</em>, <em>Turn</em>, <em>Zoom3D</em>, <em>Twist</em> | ||
| <em>Random</em>, and <em>None</em>. <em>None</em> is normally set in the configuration | ||
| file, in-case FvwmAnimate is started automatically, but an individual | ||
| user doesn’t want it running.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Stop</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> to stop.</p> | ||
| </dd> | ||
| <dt class="hdlist1">*FvwmAnimate: Save</dt> | ||
| <dd> | ||
| <p>Tells <strong>FvwmAnimate</strong> 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.</p> | ||
| </dd> | ||
| </dl> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_commands">COMMANDS</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p><strong>FvwmAnimate</strong> can be asked to produce an animation thru the | ||
| "SendToModule" command. The format of the command is:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>SendToModule FvwmAnimate animate sx sy sw sh dx dy dw dh</pre> | ||
| </div> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>The second word must match the name <strong>FvwmAnimate</strong> is started with. The 8 | ||
| fields after <em>animate</em> 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.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>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.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>Additional available commands are: <em>pause</em>, <em>play</em>, <em>push</em>, <em>pop</em> and | ||
| <em>reset</em>. These may be space separated.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p><em>pause</em> causes a module to not temporarily produce any animations. | ||
| <em>play</em> causes a module to produce an animation again. <em>push</em> stores the | ||
| current playing state for a future and <em>pop</em> restores it. <em>reset</em> | ||
| removes all stored states and sets playing on.</p> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>Suppose, we don’t want to wait for all 40 xterms to be animated:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>SendToModule FvwmAnimate pause | ||
| All (XTerm) Iconify on</pre> | ||
| </div> | ||
| </div> | ||
| <div class="paragraph"> | ||
| <p>And if we don’t want to damage the current playing state, then:</p> | ||
| </div> | ||
| <div class="literalblock highlight"> | ||
| <div class="content"> | ||
| <pre>SendToModule FvwmAnimate push pause | ||
| All (XTerm) Iconify on | ||
| SendToModule FvwmAnimate pop</pre> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_origin">ORIGIN</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p><strong>FvwmAnimate</strong> is based on the <strong>Animate</strong> module from Afterstep 1.5pre6. | ||
| Porting to <strong>fvwm</strong> and lots of other changes were done by <em>Dan Espen</em> | ||
| <<a href="mailto:despen@telcordia.com">despen@telcordia.com</a>>. Below are the original author and | ||
| acknowledgments.</p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_author">AUTHOR</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p><em>Alfredo Kengi Kojima</em> <<a href="mailto:kojima@inf.ufrgs.br">kojima@inf.ufrgs.br</a>></p> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sect1"> | ||
| <h2 id="_acknowledgments">ACKNOWLEDGMENTS</h2> | ||
| <div class="sectionbody"> | ||
| <div class="paragraph"> | ||
| <p>These people have contributed to <strong>FvwmAnimate</strong>:</p> | ||
| </div> | ||
| <div class="dlist"> | ||
| <dl> | ||
| <dt class="hdlist1">Kaj Groner <<a href="mailto:kajg@mindspring.com">kajg@mindspring.com</a>></dt> | ||
| <dd> | ||
| <p>Twisty iconification, configuration file parsing, man page.</p> | ||
| </dd> | ||
| <dt class="hdlist1">Frank Scheelen <<a href="mailto:scheelen@worldonline.nl">scheelen@worldonline.nl</a>></dt> | ||
| </dl> | ||
| </div> | ||
| </div> | ||
| </div> |
Oops, something went wrong.