modules/FvwmWinList/FvwmWinList.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmWinList 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5 .SH NAME
   6 FvwmWinList \- the fvwm window list module
   7 .SH SYNOPSIS
   8 \fBFvwmWinList\fP [\fIname\fP]
   9
  10 FvwmWinList is spawned by fvwm, so no command line invocation will work.
  11
  12 .SH DESCRIPTION
  13 The FvwmWinList module provides a window list made up of buttons, each
  14 corresponding to a window that fvwm is managing.  Clicking on the buttons
  15 with any of the three mouse buttons will either do a default action or
  16 can be user configured.  Like the other modules, FvwmWinList only works
  17 when fvwm is used as the window manager.
  18
  19 .SH COPYRIGHTS
  20 The FvwmWinList module is the original work of Mike Finger.
  21
  22 Copyright 1994, Mike Finger. The author makes no guarantees or warranties of
  23 any kind about the use of this module.  Use this modules at your own risk.
  24 You may freely use this module or any portion of it for any purpose as long
  25 as the copyright is kept intact.
  26
  27 .SH INITIALIZATION
  28 During initialization, \fIFvwmWinList\fP gets config info from \fBfvwm\fP's
  29 module configuration database (see
  30 .IR fvwm (1),
  31 section
  32 .BR "MODULE COMMANDS" ).
  33 Available options are discussed in a later section.
  34
  35 .SH INVOCATION
  36 FvwmWinList can be invoked by fvwm during initialization by inserting the
  37 line 'Module FvwmWinList' in the .fvwm2rc file.
  38
  39 FvwmWinList can also be bound to a keystroke, mouse button, or menu option to
  40 be invoked later, in this case using 'Transient' as an argument will cause
  41 FvwmWinList to resemble the built in window list.
  42
  43 .SH CONFIGURATION OPTIONS
  44 .IP "*FvwmWinList: Geometry \fI{+-}<X>{+-}<Y>\fP"
  45 Specifies the location and gravity of the FvwmWinList window.  At the current
  46 time, size is not supported and FvwmWinList will resize itself as buttons are
  47 added.  If the NoAnchor option is not specified then the windows gravity
  48 corner will be anchored, and the window will grow in the opposite direction.
  49 (i.e. If the geometry is specified -5-5, that is SoutEastGravity.  This will
  50 cause the window to draw up and to the left as windows are added)
  51
  52 .IP "*FvwmWinList: Font \fIfont\fP"
  53 Specifies the font to be used for labeling the buttons.
  54
  55 .IP "*FvwmWinList: Colorset \fIn\fP"
  56 Specifies the colorset to use for the buttons. See FvwmTheme. Defaults to 0.
  57
  58 .IP "*FvwmWinList: Fore \fIcolor\fP"
  59 Specifies the color to use for the button names. Cancels *FvwmWinList: Colorset.
  60
  61 .IP "*FvwmWinList: Back \fIcolor\fP"
  62 Specifies the color for the buttons. Cancels *FvwmWinList: Colorset.
  63
  64 .IP "*FvwmWinList: FocusColorset \fIn\fP"
  65 Specifies the colorset to use for the button for the window that
  66 has the input focus. Defaults to 1.
  67
  68 .IP "*FvwmWinList: FocusFore \fIcolor\fP"
  69 Specifies the color to use for the button names for the window that
  70 has the input focus. If omitted, the color from \fB*FvwmWinList: Fore\fP
  71 is used. Cancels *FvwmWinList: FocusColorset.
  72
  73 .IP "*FvwmWinList: FocusBack \fIcolor\fP"
  74 Specifies the color to use for the button for the window that
  75 has the input focus. If omitted, the color from \fB*FvwmWinList: Back\fP
  76 is used. Cancels *FvwmWinList: FocusColorset.
  77
  78 .IP "*FvwmWinList: IconColorset \fIn\fP"
  79 Specifies the colorset to use for buttons for windows that
  80 are iconified. Defaults to 0.
  81
  82 .IP "*FvwmWinList: IconFore \fIcolor\fP"
  83 Specifies the color to use for the button names for windows that
  84 are iconified. If omitted, the color from \fB*FvwmWinList: Fore\fP
  85 is used. Cancels *FvwmWinList: IconColorset.
  86
  87 .IP "*FvwmWinList: IconBack \fIcolor\fP"
  88 Specifies the color to use for the button for windows that
  89 are iconified. If omitted, the color from \fB*FvwmWinList: Back\fP
  90 is used. Cancels *FvwmWinList: IconColorset.
  91
  92 .IP "*FvwmWinList: DontDepressFocus"
  93 By default FvwmWinList will show the button for the window that has the
  94 input focus as pressed in. This option disables that feature.
  95
  96 .IP "*FvwmWinList: ButtonFrameWidth \fIwidth\fP"
  97 Specify the width of the 3D borders around the buttons in FvwmWinList.
  98
  99 .IP "*FvwmWinList: FollowWindowList"
 100 Specifies that FvwmWinList will keep its list in the same order as fvwm.
 101 This is the order displayed by the "WindowList NoDeskSort" fvwm command.
 102 This is not the default as it is more visually disturbing when the focus
 103 changes.
 104
 105 .IP "*FvwmWinList: UseSkipList"
 106 Tells FvwmWinList to not show the windows that are listed on a WindowListSkip
 107 line in the configuration file.
 108
 109 .IP "*FvwmWinList: ShowCurrentDesk"
 110 Specifies that only windows on the current desk are displayed.
 111
 112 .IP "*FvwmWinList: NoAnchor"
 113 By default, FvwmWinList will anchor the gravity corner so the window will grow
 114 in the opposite direction.  This undoes that option, i.e. the window will
 115 always grow down.  Do not use this option if a negative geometry was
 116 specified.
 117
 118 .IP "*FvwmWinList: UseIconNames"
 119 Tells FvwmWinList to use the icon name of the window instead of the full window
 120 name.  This is useful to keep the width of the window small.
 121
 122 .IP "*FvwmWinList: LeftJustify"
 123 By default, FvwmWinList will center the icon text in the icon.  This option
 124 causes it to be justified flush with the left edge of the icon. This option is
 125 turned on when MiniIcons are used.
 126
 127 .IP "*FvwmWinList: MinWidth \fIwidth\fP"
 128 .IP "*FvwmWinList: MaxWidth \fIwidth\fP"
 129 Specify the minimum and maximum widths that the buttons will shrink or grow
 130 to.  The buttons will normally size to fit the longest name, but certain
 131 applications produce icon titles that can easily fill the screen.  Setting
 132 these parameters constrains the size of the buttons to be between the two
 133 values.  Setting them identically will fix the size of the buttons.
 134 Setting Max < Min will have unpredictable results.
 135
 136 .IP "*FvwmWinList: TruncateLeft"
 137 If names get truncated because of the setting of \fBFvwmWinList: MaxWidth\fP,
 138 they will normally get truncated on the right, so only the start of the names
 139 are visible. Setting this resource will cause them to get truncated on the left,
 140 so that the end of names are visible. This is useful when the window title
 141 contains a directory and file name, for example.
 142
 143 .IP "*FvwmWinList: Action \fIaction response\fP"
 144 Tells FvwmWinList to do \fIresponse\fP when \fIaction\fP is done.  The
 145 currently supported \fIaction\fPs are: Click1, Click2, Click3 and so on.
 146 By default the module supports 3 mouse buttons, but it can be compiled
 147 to support more.  The currently
 148 supported \fIresponse\fPs are any fvwm built-in commands, including modules
 149 and functions.
 150 Warning: The use of the former syntax that allowed to use comma
 151 separated lists of commands is strongly discouraged due to synchronization
 152 problems with fvwm.  Please use complex fvwm functions instead (defined with
 153 the 'AddToFunc' command of fvwm).
 154
 155 .IP "*FvwmWinList: NoIconAction \fIaction\fP"
 156 Tells FvwmWinList to do \fIaction\fP is when a NoIcon style window is
 157 iconified or de-iconified. Relevant coordinates are appended to \fIaction\fP so
 158 that the icon can be traced to an FvwmWinList button. An example action
 159 is "*FvwmWinList: NoIconAction SendToModule FvwmAnimate animate". A blank or
 160 null action turns this feature off.
 161
 162 .SH SAMPLE CONFIGURATION
 163 The following are excepts from a .fvwm2rc file which describe FvwmWinList
 164 initialization commands:
 165
 166 .nf
 167 .sp
 168 ########
 169 # Pop up the window list in transient mode on button 3 press & hold
 170
 171 Mouse 3   R   A   Module FvwmWinList Transient
 172
 173 AddToFunc DeiconifyAndRaise
 174 + I Iconify off
 175 + I Raise
 176
 177 ########################## Window-Lister ###############################
 178 *FvwmWinList: Back DarkOliveGreen
 179 *FvwmWinList: Fore PaleGoldenRod
 180 *FvwmWinList: Font -*-new century schoolbook-bold-r-*-*-*-120-*-*-*-*-*-*
 181 *FvwmWinList: Action Click1 Function DeiconifyAndRaise
 182 *FvwmWinList: Action Click2 Iconify
 183 *FvwmWinList: Action Click3 Module FvwmIdent
 184 *FvwmWinList: UseSkipList
 185 *FvwmWinList: UseIconNames
 186 *FvwmWinList: Geometry -50-85
 187 *FvwmWinList: MinWidth 70
 188 *FvwmWinList: MaxWidth 120
 189 # I prefer the text centered
 190 #*FvwmWinList: LeftJustify
 191 # I like it anchored
 192 #*FvwmWinList: NoAnchor
 193 # A flat list in most recently focused order
 194 #*FvwmWinList: FollowWindowList
 195 #*FvwmWinList: BorderReliefWidth 0
 196 # pretend to be a taskbar
 197 *FvwmWinList: NoIconAction SendToModule FvwmAnimate animate
 198
 199 .sp
 200 .fi
 201
 202 .SH AUTHOR
 203 Mike Finger (mfinger@mermaid.micro.umn.edu)
 204             (Mike_Finger@atk.com)
 205             (doodman on IRC, check the #linux channel)
 206
 207 Various Patches by
 208    John Heidemann <johnh@ficus.CS.UCLA.EDU> and
 209    Jason L Tibbitts <tibbs@tcamc.uh.edu>.