NAME

       FvwmWinList - the FVWM window list module

SYNOPSIS

       FvwmWinList is spawned by fvwm, so no command line invocation will work.

DESCRIPTION

       The FvwmWinList module provides a widow list made up of buttons, each corresponding to a window that FVWM
       is managing.  Clicking on the buttons with any of the three mouse buttons will either do a default action
       or  can  be  user  configured.   Like  the other modules, FvwmWinList only works when fvwm is used as the
       window manager.

COPYRIGHTS

       The FvwmWinList module is the original work of Mike Finger.

       Copyright 1994, Mike Finger. The author makes no guarantees or warranties of any kind about  the  use  of
       this module.  Use this modules at your own risk.  You may freely use this module or any portion of it for
       any purpose as long as the copyright is kept intact.

INITIALIZATION

       During initialization, FvwmWinList will scan the same configuration file that FVWM used during startup to
       find the options that pertain to it.  These options are discussed in a later section.

INVOCATION

       FvwmWinList  can  be  invoked by fvwm during initialization by inserting the line 'Module FvwmWinList' in
       the .fvwmrc file.

       FvwmWinList can also be bound to a keystroke, mouse button, or menu option to be invoked later,  in  this
       case using 'Transient' as an argument will cause FvwmWinList to resemble the built in window list.

       FvwmWinList  must  reside  in  a  directory  that is listed in the ModulePath option of FVWM for it to be
       executed by FVWM.

CONFIGURATION OPTIONS

       The following options can be placed in the .fvwmrc file

       *FvwmWinListGeometry {+-}<X>x{+-}<Y>
              Specifies the location and gravity of the FvwmWinList window.  At the current time,  size  is  not
              supported  and FvwmWinList will resize itself as buttons are added.  If the NoAnchor option is not
              specified then the windows gravity corner will be anchored,  and  the  window  will  grow  in  the
              opposite  direction.  (i.e. If the geometry is specified -5-5, that is SoutEastGravity.  This will
              cause the window to draw up and to the left as windows are added)

       *FvwmWinListFont font
              Specifies the font to be used for labeling the buttons.

       *FvwmWinListFore color
              Specifies the color to use for the button names.

       *FvwmWinListBack color
              Specifies the color for the buttons.

       *FvwmWinListUseSkipList
              Tells FvwmWinList to not show the windows  that  are  listed  on  a  WindowListSkip  line  if  the
              configuration file.

       *FvwmWinListNoAnchor
              By  default,  FvwmWinList  will  anchor the gravity corner so the window will grow in the opposite
              direction.  This undoes that option.

       *FvwmWinListUseIconNames
              Tells FvwmWinList to use the icon name of the window instead of the full  window  name.   This  is
              useful to keep the width of the window small.

       *FvwmWinListAction action response[,reponse...]
              Tells  FvwmWinList  to  do  response  when  action  is done.  The currently supported actions are:
              Click1, Click2, Click3.  The  currently  supported  responses  are  any  fvwm  built-in  commands,
              including modules and functions.

SAMPLE CONFIGURATION

       The following are excepts from a .fvwmrc file which describe FvwmWinList initialization commands:

       ########
       # Pop up the window list in tranient mode on button 3 press & hold

       Mouse 3   R   A   Module "FvwmWinList" FvwmWinList Transient

       ########################## Window-Lister ###############################
       *FvwmWinListBack DarkOliveGreen
       *FvwmWinListFore PaleGoldenRod
       *FvwmWinListFont -*-new century schoolbook-bold-r-*-*-*-120-*-*-*-*-*-*
       *FvwmWinListAction Click1 Iconify -1,Raise
       *FvwmWinListAction Click2 Iconify
       *FvwmWinListAction Click3 Module "FvwmIdent" FvwmIdent
       *FvwmWinListUseSkipList
       *FvwmWinListUseIconNames
       *FvwmWinListGeometry -50-85
       # I like it achored
       #*FvwmWinListNoAnchor

AUTHOR

       Mike Finger (mfinger@mermaid.micro.umn.edu)
                   (Mike_Finger@atk.com)
                   (doodman on IRC, check the #linux channel)