1= FvwmIconMan(1) 2 3:doctype: manpage 4:mantitle: FvwmIconMan 5:manname: FvwmIconMan 6:manmanual: Fvwm Modules 7:manvolnum: 1 8:page-layout: base 9 10== NAME 11 12FvwmIconMan - an fvwm icon manager 13 14== SYNOPSIS 15 16FvwmIconMan is spawned by fvwm, so no command line invocation will work. 17 18== DESCRIPTION 19 20FvwmIconMan is an icon manager modeled after the TWM icon manager. The 21user may have multiple icon managers, each of which armed with a list of 22window types which it manages. For example, the user may have one 23manager which lists only emacs windows, and another which lists 24everything else. You may also specify what resolution each icon manager 25uses, for example, one icon manager may manage windows on all desks, and 26another may manage only those on the current desk, page or screen. 27FvwmIconMan can display the miniature icons provided by fvwm for its 28managed windows. The managers may have a maximum number of columns (and 29so grows vertically), a maximum number of rows (and then grows 30horizontally), or stay at a fixed size, and adjust the size of the 31window buttons to fit (think win95's Taskbar). And when support is 32compiled in for the X Shape extension, then the manager windows may be 33shaped. 34 35You can specify actions to be run when mouse, or key events are 36received. For example, you could bind the first mouse button to iconify 37the selected window, and make bindings for the arrow keys to navigate 38the manager window without the mouse. 39 40FvwmIconMan can be set to display which window currently has the 41keyboard focus, and by binding the select event (see below) to the fvwm 42Focus function, you can emulate the TWM icon manager's behavior. 43 44== INITIALIZATION 45 46During initialization, FvwmIconMan searches though the fvwm 47configuration file for the options which are described below. It is 48highly recommended that you make FvwmIconMan be a sticky window. And if 49you want to make use of the followfocus option, and/or binding an action 50to Focus, then you should make FvwmIconMan clicktofocus. Also, when 51using the Shape option, it's recommended that the FvwmIconMan window not 52be decorated at all by fvwm. 53 54== INVOCATION 55 56FvwmIconMan can be invoked by inserting the line 'Module FvwmIconMan' in 57the .fvwm2rc file. If FvwmIconMan is to be spawned during fvwm's 58initialization, then this line should be placed in the StartFunction 59declarations, or it can be bound to a menu, mouse button, or keystroke 60to invoke it later. 61 62If you wish to run FvwmIconMan in a transient mode, such as with the 63built in window list, then pass "-Transient" as an argument. The 64invocation "Module FvwmIconMan -Transient" will do nicely. In this mode, 65FvwmIconMan will pop up one manager window directly under the cursor. 66When the mouse button is released, it will execute the appropriate 67action, and then exit. Things are somewhat complicated by the fact that 68you can specify that FvwmIconMan creates multiple manager windows, 69behavior which is unsuitable when running transiently. So, when running 70transiently, FvwmIconMan will only create one manager window. Use the 71manager id 'transient' to specify options for this manager window. 72 73FvwmIconMan may accept an alias name as an argument. For example, 74"Module FvwmIconMan FvwmIconMan-Variant2". 75 76== CONFIGURATION OPTIONS REFERENCE CHART 77 78FvwmIconMan has acquired quite a few options. I assume others share my 79dislike of paging though a long man page, so here is a terse reference 80chart describing the available options. They are described in more 81detail in the next section. 82 83.... 84Name Description Default 85 86NumManagers number of managers 1 87Action binds command to event Mouse 0 N sendcommand Iconify 88Background default background gray 89ButtonGeometry size of button in pixels 90Colorset default colorset 91DontShow list of windows to ignore 92DrawIcons use mini icons false 93FocusAndSelectButton flat grey black 94FocusAndSelectColorset 95FocusButton style for focused buttons up grey black 96FocusColorset 97FollowFocus show which win has focus false 98Font 8x13 99Foreground default text color white 100Format describes button label "%c: %i" 101IconName manager icon name FvwmIconMan 102IconAndSelectButton up black grey 103IconAndSelectColorset 104IconButton style for icon buttons up black grey 105IconColorset 106ManagerGeometry size of manager in buttons 0x1 107MaxButtonWidth max width of a button 108MaxButtonWidthByColumns 109NoIconAction animate iconification NOP 110PlainButton style for normal buttons up black grey 111PlainColorset 112ReliefThickness size of button relief 2 113Resolution window filters desk page 114Reverse normal, icon or none none 115SelectButton style for selected buttons flat black grey 116SelectColorset 117Shape use shape extension false 118Show list of windows to show 119ShowOnlyIcons only icons visible false 120ShowNoIcons icons are not displayed false 121ShowTransient transient windows visible false 122ShowOnlyFocused only focused visible false 123Sort keep managers sorted name 124SortWeight weight for sorting 125Tips Tool Tips mode none 126TipsDelays Tool Tips mapping delays 1000 300 127TipsFont Font for Tool Tips default fvwm font 128TipsColorset Tool Tips Colorset 0 129TipsFormat describes Tips label the Format value 130TipsBorderWidth Tool Tips border size 1 131TipsPlacement Tips placement vs button updown 132TipsJustification Tips Just vs button leftup 133TipsOffsets Tips placement Offsets 3 2 134Title manager title FvwmIconMan 135TitleButton style for title button raisededge black grey 136TitleColorset 137UseWinList honor WinListSkip? true 138.... 139 140== CONFIGURATION OPTIONS 141 142With the exception of the nummanagers option, all of the options may be 143defined on a per-manager basis. So, for example, the user may have his 144emacs manager with a red foreground, and his xterm manager with a blue 145one. A configuration line may therefore have one of two forms: 146 147*FvwmIconMan: OptionName OptionValue:: 148 To specify that the _OptionName_ takes the value _OptionValue_ for all 149 managers. 150*FvwmIconMan: ManagerId OptionName OptionValue:: 151 To specify that the option _OptionName_ takes the value _OptionValue_ 152 for manager _ManagerId_. _ManagerId_ may either be a positive integer, 153 or the string "transient". An integer id refers to managers which 154 FvwmIconMan creates when running normally, and an id of "transient" 155 refers to the single manager which FvwmIconMan creates when running 156 transiently. 157 158The old syntax, that uses an asterisk instead of white spaces before 159_ManagerId_ and _OptionName_, is supported too, but it is obsolete now. 160 161The following options may be specified: 162 163*FvwmIconMan: NumManagers num:: 164 _num_ is a positive integer specifying the total number of icon 165 managers. Since FvwmIconMan would like to know how many managers there 166 are before handling any manager specific options, this should come 167 first. The default is 1. 168*FvwmIconMan: [id] Action type binding:: 169 Binds an FvwmIconMan command to an event. _Type_ may be one of the 170 values: Key, Mouse, or Select. Actions are described in the following 171 section ACTIONS. 172*FvwmIconMan: [id] Background background:: 173 Specifies the default background color. 174*FvwmIconMan: [id] ButtonGeometry geometry:: 175 Specifies the initial geometry of an individual button in pixels. If 176 the specified height is 0, then the button height is determined from 177 the font size. X and Y coordinates are ignored. 178*FvwmIconMan: [id] Colorset colorset:: 179 The default colorset used. Overrides background and foreground. 180*FvwmIconMan: [id] DrawIcons value:: 181 If your version of fvwm is capable of using mini icons, then this 182 option determines if FvwmIconMan displays the mini icons. Otherwise, 183 it generates an error message. "true" means that mini icons are shown 184 for iconified windows, "false" that mini icons are never shown, and 185 "always" that mini icons are shown for all windows. 186*FvwmIconMan: [id] FocusAndSelectButton style [forecolor backcolor]:: 187 Same as the plainbutton option, but specifies the look of buttons 188 which are both selected, and have the keyboard focus. 189*FvwmIconMan: [id] FocusAndSelectColorset colorset:: 190 Works like focusandselectbutton but uses colorsets instead. The style 191 setting can still only be applied with focusandselectbutton. 192*FvwmIconMan: [id] FocusButton style [forecolor backcolor]:: 193 Same as the plainbutton option, but specifies the look of buttons 194 whose windows have the keyboard focus. 195*FvwmIconMan: [id] FocusColorset colorset:: 196 Works like focusbutton but uses colorsets instead. The style setting 197 can still only be applied with focusbutton. 198*FvwmIconMan: [id] FollowFocus boolean:: 199 If _true_, then the button appearance reflects which window currently 200 has focus. Default is false. 201*FvwmIconMan: [id] Font font:: 202 Specifies the font to be used for labeling the buttons. The default is 203 8x13. 204*FvwmIconMan: [id] Foreground foreground:: 205 Specifies the default foreground color. 206*FvwmIconMan: [id] Format formatstring:: 207 A printf like format string which describes the string to be printed 208 in the manager window for each managed window. Possible flags are: %t, 209 %i, %c, and %r for the window's title, icon title, class, or resource 210 name, respectively. The default is "%c: %i". *Warning*: m4 reserves 211 the word _format_, so if you use m4, take appropriate action. 212*FvwmIconMan: [id] IconName iconstring:: 213 Specifies the window icon name for that manager window. _Iconstring_ 214 may either be a single word, or a string enclosed in quotes. The 215 default is "FvwmIconMan". 216*FvwmIconMan: [id] IconAndSelectButton style [forecolor backcolor]:: 217 Same as the plainbutton option, but specifies the look of buttons 218 whose windows are iconified and the button is selected. 219*FvwmIconMan: [id] IconButton style [forecolor backcolor]:: 220 Same as the plainbutton option, but specifies the look of buttons 221 whose windows are iconified. 222*FvwmIconMan: [id] IconAndSelectColorset colorset:: 223 Works like IconAndSelectButton but uses colorsets instead. The style 224 setting can still only be applied with iconbutton. 225*FvwmIconMan: [id] IconColorset colorset:: 226 Works like iconbutton but uses colorsets instead. The style setting 227 can still only be applied with iconbutton. 228*FvwmIconMan: [id] ManagerGeometry geometry:: 229 Specifies the initial geometry of the manager, in units of buttons. If 230 _height_ is 0, then the manager will use _width_ columns, and will 231 grow vertically once it has more than _width_ windows. Likewise, if 232 _width_ is 0, it will use _height_ rows, and grow horizontally. If 233 both are nonzero, then the manager window will be exactly that size, 234 and stay that way. As columns are created, the buttons will narrow to 235 accommodate. If the geometry is specified with a negative y 236 coordinate, then the window manager will grow upwards. Otherwise, it 237 will grow downwards. 238*FvwmIconMan: [id] MaxButtonWidth width:: 239 Defines a maximum for the width of a button (in pixels). By default 240 there is no maximum. A value of 0 resets the default. The maximum is 241 only used with a non growing manager (the ManagerGeometry option 242 specifies non zero width and height). 243*FvwmIconMan: [id] MaxButtonWidthByColumns col:: 244 This is another way to set the button width. col is the number of 245 columns of icons. The button width is determined by dividing the total 246 width of FvwmIconMan by the number of columns. For example if the 247 width of FvwmIconMan manager is 1024, MaxButtonWidthByColumns is 4 248 then MaxButtonWidth is 256. This is useful when you do not know, at 249 config time, the width of the manager, for example, for a swallowed 250 FvwmIconMan. 251*FvwmIconMan: [id] NoIconAction action:: 252 Tells FvwmIconMan to do _action_ when a NoIcon style window is 253 iconified or de-iconified. Relevant coordinates are appended to 254 _action_ so that the icon can be traced to an FvwmIconMan button. An 255 example action is "*FvwwmIconMan: NoIconAction SendToModule 256 FvwmAnimate animate". A blank or null action turns this feature off. 257*FvwmIconMan: [id] PlainButton style [forecolor backcolor]:: 258 Specifies how normal buttons look. _style_ may be one of _flat_, _up_, 259 _down_, _raisededge_, or _sunkedge_, and describes how the button is 260 drawn. The color options are both optional, and if not set, then the 261 default colors are used. If on a monochrome screen, then the _style_ 262 option is ignored, but must still be set. 263*FvwmIconMan: [id] PlainColorset colorset:: 264 Works like plainbutton but uses colorsets instead. The style setting 265 can still only be applied with plainbutton. 266*FvwmIconMan: [id] ReliefThickness num:: 267 _num_ is an integer specifying the number of pixels thick that the 268 relief at the edge of non-flat buttons should be. Setting this to 0 269 will produce flat buttons, as if the values for 270 _FocusAndSelectButton_, _FocusButton_, _IconAndSelectButton_, 271 _IconButton_, _PlainButton_, _SelectButton_, and _TitleButton_ were 272 all set to _flat_. If _num_ is negative, the button will be inverted 273 as if you had used _Reverse_ for all classes. 274*FvwmIconMan: [id] Resolution [_filter(s)_]:: 275 Specifies a list of _filters_, separated by spaces, that configure which 276 windows are displayed. If no filters are given, then all windows of the 277 appropriate type are shown (see the show and dontshow options below). 278 Each _filter_ then limits the windows that are displayed and may take 279 one of the following values: desk, page, screen, !desk, !page, !screen, 280 or invert. _desk_ only shows windows on the current desk, and _page_ 281 only shows windows on the current page. _!desk_ and _!page_ only show 282 windows not on the current desk or page respectively. _invert_ reverses 283 the filter displaying the windows that did not match. 284+ 285Notes: _page_ and _desk_ are independent. If the only filter is _page_, 286then you will see windows on the current page on all desks. To only see 287windows on the current page and desk (the default) you need both filters, 288'desk page'. You can only have one of desk/!desk, page/!page, or 289screen/!screen, the last one issued take precedence. The invert filter 290reverses the whole filter so 'invert desk page' is not the same as 291'!desk !page'. Sticky windows are visible on all pages and desks, so 292they match all page and desk filters, but won't match the inverted filter. 293+ 294The filters can take additional parameters to state which desk, page, 295or screen to show (or not show). _[!]desk [n]_ can take the desk number, 296which will only show windows (not) on the stated desk. _[!]page [x] [y]_ 297can take the horizontal, _x_, and vertical, _y_, page numbers, which will 298only show windows (not) on the stated page. 299+ 300_[!]screen [S]_ shows windows (not) on monitor _S_, which can be: 301+ 302> _NAME_: The "NAME" of the specific RandR monitor. 303+ 304> _c_: The current RandR monitor (containing the pointer) 305+ 306> _p_: The primary RandR monitor 307+ 308> _g_: The global monitor 309+ 310Since all windows are on the global monitor, _screen g_ effectively does 311nothing. _c_ is the current monitor at the time resolution is issued, and 312once set will not change. This filter is best used with a RandR _NAME_. 313+ 314This configuration line is respected when FvwmIconMan is running as 315well, the resolution is changed dynamically when sent to fvwm. 316 317*FvwmIconMan: [id] Reverse class:: 318 Causes certain classes of buttons to have their relief lines reversed 319 so that up and down styles are reversed. This has no affect on flat 320 buttons. The class can be icon, normal or none. The default is none. 321*FvwmIconMan: [id] SelectButton style [forecolor backcolor]:: 322 Same as the plainbutton option, but specifies the look of buttons when 323 the mouse is over them. 324*FvwmIconMan: [id] SelectColorset colorset:: 325 Works like selectbutton but uses colorsets instead. The style setting 326 can still only be applied with selectbutton. 327*FvwmIconMan: [id] Shape boolean:: 328 If _True_, then use make the window shaped. Probably only useful if 329 you have multiple columns or rows. If FvwmIconMan wasn't compiled to 330 support the Shape extension, this generates an error message. When 331 using shaped windows, it's recommended that a fvwm style is made for 332 FvwmIconMan that has no borders. Otherwise, fvwm will get confused. 333*FvwmIconMan: [id] Sort value:: 334 If _name_, then the manager list is sorted by name. If _namewithcase_, 335 then it is sorted by name sensitive to case. If _id_, then the manager 336 list is sorted by the window id, which never changes after the window 337 is created. If _weighted_, then the manager list is sorted by weight 338 (see the description of _sortweight_ below). Or it can be set to 339 _none_, which results in no sorting. Default is _name_. 340*FvwmIconMan: [id] SortWeight weight pattern-list:: 341 Assigns the specified _weight_ to windows that match _pattern-list_. 342 The list is made up of patterns of the form _type=pattern_, where type 343 is one of _class_, _resource_, _title_, or _icon_, and pattern is an 344 expression of the same format used in the fvwm style command 345 (minimalistic shell pattern matching). Multiple sort weights can be 346 given. Each window is matched against the list of sort weights, in 347 order, and is given the weight from the first match. Lower-weighted 348 windows are placed first in the manager list. For example: 349+ 350.... 351 *FvwmIconMan: Sort weighted 352 *FvwmIconMan: SortWeight 1 class=XTerm title=special* 353 *FvwmIconMan: SortWeight 10 class=XTerm 354 *FvwmIconMan: SortWeight 5 355.... 356+ 357In this example, xterm windows whose titles start with "special" (weight 3581) are listed first, followed by everything but other xterms (weight 5), 359and the other xterms (weight 10) are listed last. If no default weight 360(empty pattern list) is given, the default weight is 0. Only relevant if 361the sort type is set to _weighted_. 362 363*FvwmIconMan: [id] Title title-string:: 364 Specifies the window title string for that manager window. 365 _Titlestring_ may either be a single word, or a string enclosed in 366 quotes. The default is "FvwmIconMan". This will be drawn in the title 367 bar of the manager window, if any, and in the title button, which is 368 the button drawn when the manager is empty. 369*FvwmIconMan: [id] TitleButton style [forecolor backcolor]:: 370 Same as the plainbutton option, but specifies the look of the title 371 button (the button drawn when the manager is empty). The manager's 372 title is drawn in the title button. 373*FvwmIconMan: [id] UseWinList boolean:: 374 If _true_, then honor the WinListSkip style flag. Otherwise, all 375 windows are subject to possible management according to the show and 376 dontshow lists. 377 378The two following options control which windows get handled by which 379managers. A manager can get two lists, one of windows to show, and one 380of windows to ignore. If only the _show_ list is given, then that 381manager will show only the windows in the list. If only the _DontShow_ 382list is given, then the manager will show all windows except those in 383the list. If both lists are given, then a window will be shown if it is 384not in the _DontShow_ list, and in the _Show_ list. And finally, if 385neither list is given, then the manager will handle all windows. Each 386list is made up of patterns of the form _type=pattern_, where type is 387one of _class_, _resource_, _title_, or _icon_, and pattern is an 388expression of the same format used in the fvwm style command 389(minimalistic shell pattern matching). Quotes around the pattern will be 390taken as part of the expression. If a window could be handled by more 391than one manager, then the manager with the lowest id gets it. 392 393*FvwmIconMan: [id] Show pattern list:: 394 If a window matches one of the patterns in the list, then it may be 395 handled by this manager. 396*FvwmIconMan: [id] DontShow pattern list:: 397 If a window matches one of the patterns in the list, then it may not 398 be handled by this manager. 399*FvwmIconMan: [id] ShowTransient boolean:: 400 Show transient windows in the list (default false). 401*FvwmIconMan: [id] ShowOnlyIcons boolean:: 402 Only iconified windows are shown if _boolean_ is true. 403*FvwmIconMan: [id] ShowNoIcons boolean:: 404 Only windows that are not iconified are shown if _boolean_ is true. 405*FvwmIconMan: [id] ShowOnlyFocused boolean:: 406 Only window with the focus is shown if _boolean_ is true. 407 408The following two options control tips. 409 410*FvwmIconMan: [id] Tips value:: 411 where _value_ can be always, needed or false. Default is false, no 412 tips are displayed. With always, tips are enabled. With needed, a tip 413 is displayed only if either the button string is truncated or the tip 414 string is not equal to the button string. This configuration line is 415 respected when FvwmIconMan is running as well. 416*FvwmIconMan: [id] TipsDelays delay [mappeddelay]:: 417 where _delay_ and _mappeddelay_ are time out values in milliseconds. 418 If no _mappeddelay_ is given _delay_ is assumed. Default is 1000 300. 419 When the cursor is on a button, FvwmIconMan wait _delay_ milliseconds 420 before displaying the tip. In the case where a tip is already mapped 421 and the cursor goes to another button, FvwmIconMan waits _mappeddelay_ 422 milliseconds before displaying the new tip. 423*FvwmIconMan: [id] TipsFont fontname:: 424 Specifies the font to be used for tips. Default is the default fvwm 425 font. 426*FvwmIconMan: [id] TipsColorset colorset:: 427 Specifies the colors for tips window. Default is colorset 0. 428*FvwmIconMan: [id] TipsFormat formatstring:: 429 Similar to the Format option but for the tips window. The default is 430 the format string from the Format option. 431*FvwmIconMan: [id] TipsBorderWidth pixels:: 432 Specifies the border width (in pixels) of the tips window. Default is 433 1. 434*FvwmIconMan: [id] TipsPlacement value:: 435 where _value_ can be up, down, right, left, updown or leftright. This 436 value specifies the position of the tips window relative to its 437 button. Default is updown where buttons on the top half of the screen 438 get tips below the button, otherwise the tips are above the button. 439*FvwmIconMan: [id] TipsJustification value:: 440 where _value_ can be leftup, rightdown or center. Specifies the 441 justification (direction) of the tips window relative to its button 442 after the tips window has been placed. Default is leftup which means 443 that if a tip is placed above or below its button, then the left 444 border of the tip and of the button are aligned. If the tip is placed 445 on the left or on the right of its button, leftup aligns the top 446 borders. rightdown and center work like leftup but in different 447 directions. The alignment is adjusted by the TipsOffset option. See 448 next option. 449*FvwmIconMan: [id] TipsOffsets placementoffset justoffset:: 450 where _placementoffset_ and _justoffset_ are offsets in pixels for the 451 TipsPlacement and TipsJustification configuration option. Default is 3 452 2. 453 454== ACTIONS 455 456Actions are commands which may be bound to an event of the type: a key 457press, a mouse click, or the mouse entering a window manager button - 458denoted by the action types _Key_, _Mouse_, and _Select_. 459 460Normally, actions bound to a mouse click are executed when the button is 461pressed. In transient mode, the action is executed when the button is 462released, since it is assumed that FvwmIconMan was bound to some mouse 463event. A tip/warning: FvwmIconMan still keeps track of the mouse button 464and any modifier keys in this case, so if you bind FvwmIconMan to say, 465meta-button3, then it would be wise to ensure that the action you want 466to execute will be executed when the meta-button3 event occurs (which 467would be the button release, assuming you kept your finger on the meta 468key). 469 470The syntax for actions are: 471 472Key actions: Key Keysym Modifiers FunctionList:: 473 _Keysym_ and _Modifiers_ are exactly the same as for the fvwm _Key_ 474 command. 475Mouse actions: Mouse Button Modifiers FunctionList:: 476 _Button_ and _Modifiers_ are exactly the same as for the fvwm _Mouse_ 477 command. 478Select actions: Select FunctionList:: 479 480A _FunctionList_ is a sequence of commands separated by commas. They are 481executed in left to right order, in one shared context - which currently 482only contains a pointer to the "current" button. If a button is selected 483(typically by the mouse pointer sitting on it) when the action is 484executed, then the current button is initialized to that button. 485Otherwise, it points to nothing. 486 487Most of the available commands then modify this "current" button, either 488by moving it around, making it become the selected button, or sending 489commands to fvwm acting on the window represented by that button. Note 490that while this current button is initialized to be the selected button, 491the selected button does not implicitly follow it around. This way, the 492user can send commands to various windows, without changing which button 493is selected. 494 495Commands take five types of arguments: _Integer_, _Manager_, _Window_, 496_Button_, and _String_. A _String_ is a string specified exactly as for 497fvwm - either in quotes or as a single word not in quotes. Again, you 498may bind a sequence of commands to an event, by listing them separated 499by commas. 500 501_Window_ and _Button_ types look exactly the same in the .fvwm2rc file, 502but are interpreted as either specifying a managed window, or a 503FvwmIconMan button representing a window. They can either be an integer 504(which is interpreted module N where N is the number of buttons - so 0 505is the first and -1 is the last), or one of the strings: _Select_, 506_Focus_, _Up_, _Down_, _Right_, _Left_, _Next_, _Prev_. _Select_ and 507_Focus_ refer to the currently selected or focused button or window. 508_Up_, _Down_, _Right_, and _Left_ refer to the button or window above, 509below, to the right of, or to the left of the current button in the 510manager window, allowing navigation around the manager window. _Next_ 511and _Prev_ designates the window, button, or manager after or before the 512current button, allowing navigation of the one dimensional list of 513windows which is drawn in the manager window. If the manager is sorted, 514_Next_ and _Prev_ move through the windows in the sorted order. 515 516The _Manager_ type can either be an integer, _Next_, or _Prev_. The 517meaning is analogous to that of the _Button_ type, but in terms of the 518integral index of the managers, restricted to managers which are 519nonempty. 520 521The following functions are currently defined: 522 523bif Button Integer/String:: 524 A relative branch instruction. If _Button_ is _Select_ or _Focus_, 525 then take the branch if there is a selected button or a focused 526 button. If _Button_ is an integer, then branch if nonzero. If it is 527 one of _Up_, _Down_, _Right_, _Left_, _Next_, _Prev_, then the branch 528 is taken when the current button can move in that direction. If the 529 branch is taken, then _Integer_ commands are skipped. No backwards 530 branches are allowed. 531bifn Button Integer/String:: 532 The complement of bif. The branch is taken if _Button_ evaluates to 533 false, by the criteria listed for bif. 534gotobutton Button:: 535 Sets current button to _Button_. If _Button_ is an integer, then the 536 current button is set to _Button_ modulo the number of buttons, in the 537 whichever manager contains the selected button, if any. 538gotomanager Manager:: 539 Sets button to button 0 of _Manager_. This will only go to a visible, 540 nonempty manager. So an integral argument is taken modulo the number 541 of such managers. 542jmp Integer/String:: 543 Executes a relative jump of _Integer_ instructions. Backwards jumps 544 are not allowed. The jump is computed relative to the instruction 545 following the jmp. 546label String:: 547 Provides a label that previous instructions can jump to. It will not 548 be visible to subsequent jump instructions, and the same label can be 549 used multiple times in the same instruction list (though it would be 550 perverse to do so.) 551print String:: 552 Prints _String_ to the console. Useful for debugging actions. 553printdebug:: 554 Prints defined actions to the console. Should only be used by 555 developers. To enable this command, set CONFIG and FUNCTIONS variables 556 to '1' in the modules/FvwmIconMan/debug.h and recompile this module. 557quit:: 558 Quits FvwmIconMan. 559refresh:: 560 Causes all manager windows to redraw themselves. 561ret:: 562 Stop executing the entire action. 563searchback String:: 564 Sets button to button before the current one whose printed string in 565 the manager window matches specified _String_, which may contain 566 wildcards. 567searchforward String:: 568 Sets button to button after the current one whose printed string in 569 the manager window matches specified _String_, which may contain 570 wildcards. 571select:: 572 Selects the current button, if any. If a select action has been 573 specified, it will then be run. Therefore, it is considered unwise to 574 set the select button in the select action. 575sendcommand Command:: 576 Sends the fvwm command _Command_ to the window represented by the 577 current button, if any. 578warp:: 579 Warps cursor to current button, if any. 580 581*Examples:* gotobutton select, gotobutton Down, select 582 583Selects the button below the currently selected button. Since the 584current button is already initialized to the selected button, this may 585be shortened to "gotobutton Down, select". 586 587gotobutton Up, select 588 589Selects the button above the currently selected button. 590 591gotobutton 0, select 592 593Selects the first button of the current manager. If there is no current 594manager, which is the case when no button is selected, then this does 595nothing. 596 597gotobutton -1, select 598 599Selects the last button of the current manager. 600 601gotobutton focus, select 602 603Selects the button corresponding to the focused window. 604 605gotobutton focus, Iconify 606 607Sends the fvwm command Iconify to the focused window. Note that this 608does not change the selected button. 609 610bif Next 3, gotobutton 0, select, ret, gotobutton Next, select 611 612If a button is selected, and it's the last button, go to button 0. If 613it's not the last button, go to the next button. Otherwise, do nothing. 614Basically, this action cycles through all buttons in the current 615manager. 616 617bif select 7, bif focus 3, gotomanager 0, select, ret, gotobutton focus, 618\ select, ret, gotobutton down, select 619 620This is good for sending to FvwmIconMan with a SendToModule command. If 621there is a selected button, it moves down. Otherwise, if there is a 622focused button, it is selected. Otherwise, button 0 of manager 0 gets 623selected. 624 625bif select Select, bif focus Focus, gotomanager 0, select, ret, label 626Focus, \ gotobutton focus, select, ret, label Select, gotobutton down, 627select 628 629Same as previous, but using the label instruction. 630 631In addition to being bound to keys and mice, actions can be sent from 632fvwm to FvwmIconMan via the SendToModule command. Don't quote the 633command when using SendToModule. Also, due to a bug in the current 634version of fvwm, don't quote FvwmIconMan either. 635 636== SAMPLE CONFIGURATIONS 637 638This first example is of a the simplest invocation of FvwmIconMan, which 639only has one manager, and handles all windows: 640 641.... 642############################################################## 643# Load any modules which should be started during 644# fvwm initialization 645ModulePath /usr/lib/X11/fvwm:/usr/bin/X11 646Module FvwmIconMan 647 648# Make FvwmIconMan title-bar-less, sticky, and give it an icon 649Style "Fvwm*" Icon toolbox.xpm,NoTitle,NoHandles,Sticky 650Style "FvwmIconMan" HandleWidth 5, Handles, BorderWidth 5 651 652 653############################################################## 654############################################################## 655#Definitions used by the modules 656 657*FvwmIconMan: NumManagers 1 658*FvwmIconMan: Resolution global 659*FvwmIconMan: Background slategrey 660*FvwmIconMan: Foreground white 661*FvwmIconMan: Font 7x13 662*FvwmIconMan: ButtonGeometry 100x0 663*FvwmIconMan: ManagerGeometry 1x0-0+0 664.... 665 666This example is the Reader's Digest version of my personal 667configuration. It has two managers, one for emacs and one for everything 668else, minus things with no icon title. Only windows on the current page 669are displayed. The use of the _drawicons_ and _shape_ options requires 670that fvwm and FvwmIconMan are compiled with the correct options. Note 671how the geometry and show options are specified per manager, and the 672others are common to all: 673 674.... 675Style "FvwmIconMan" NoTitle, Sticky, WindowListSkip, BorderWidth 0 676Style "FvwmIconMan" HandleWidth 0 677 678 679Key F8 A N SendToModule FvwmIconMan bif select Select, bif focus Focus, \ 680 gotomanager 0, select, sendcommand WarpToWindow, ret, label Focus, \ 681 gotobutton focus, select, sendcommand WarpToWindow, ret, label Select, \ 682 gotobutton prev, select, sendcommand WarpToWindow 683Key F9 A N SendToModule FvwmIconMan bif select Select, bif focus Focus, \ 684 gotomanager 0, select, sendcommand WarpToWindow, ret, label Focus, \ 685 gotobutton focus, select, sendcommand WarpToWindow, ret, label Select, \ 686 gotobutton next, select, sendcommand WarpToWindow 687 688*FvwmIconMan: NumManagers 2 689*FvwmIconMan: Resolution page 690*FvwmIconMan: Background steelblue 691*FvwmIconMan: Foreground white 692*FvwmIconMan: Font 7x13 693*FvwmIconMan: UseWinList true 694*FvwmIconMan: DrawIcons true 695*FvwmIconMan: Shape true 696*FvwmIconMan: FollowFocus true 697*FvwmIconMan: Sort name 698*FvwmIconMan: PlainButton up white steelblue 699*FvwmIconMan: SelectButton down white steelblue 700*FvwmIconMan: FocusButton up white brown 701*FvwmIconMan: FocusAndSelectButton down white brown 702*FvwmIconMan: TitleButton raisededge white steelblue 703*FvwmIconMan: NoIconAction "SendToModule FvwmAnimate animate" 704 705*FvwmIconMan: 1 Title "Emacs windows" 706*FvwmIconMan: 1 IconName "FvwmIconMan: Emacs" 707*FvwmIconMan: 1 Format "%i" 708*FvwmIconMan: 1 Show resource=emacs resource=gemacs 709*FvwmIconMan: 1 ManagerGeometry 1x0-400+0 710*FvwmIconMan: 1 ButtonGeometry 200x0 711 712*FvwmIconMan: 2 Title "All windows" 713*FvwmIconMan: 2 IconName "FvwmIconMan: all" 714*FvwmIconMan: 2 Format "%c: %i" 715*FvwmIconMan: 2 DontShow icon=Untitled 716*FvwmIconMan: 2 ManagerGeometry 2x4-0+0 717*FvwmIconMan: 2 ButtonGeometry 200x0 718 719*FvwmIconMan: transient Geometry 194x100 720*FvwmIconMan: transient DontShow icon=Untitled 721*FvwmIconMan: transient Action Mouse 0 A sendcommand select select Iconify 722 723*FvwmIconMan: Action Mouse 1 N sendcommand Iconify 724*FvwmIconMan: Action Mouse 2 N sendcommand WarpToWindow 725*FvwmIconMan: Action Mouse 3 N sendcommand "Module FvwmIdent FvwmIdent" 726*FvwmIconMan: Action Key Left N gotobutton Left, select 727*FvwmIconMan: Action Key Right N gotobutton Right, select 728*FvwmIconMan: Action Key Up N gotobutton Up, select 729*FvwmIconMan: Action Key Down N gotobutton Down, select 730*FvwmIconMan: Action Key q N quit 731.... 732 733== UNFINISHED BUSINESS 734 735There is one bug that I know of. A honest to goodness solution to this 736would be appreciated. When an icon manager is set to grow upwards or 737leftwards, on some machines it may wander occasionally. 738 739It doesn't handle windows without resource names as gracefully as it 740should. 741 742== AUTHOR 743 744Brady Montz (bradym@cs.arizona.edu). 745 746== THANKS 747 748.... 749Thanks to: 750 David Berson <berson@cs.pitt.edu>, 751 Gren Klanderman <greg@alphatech.com>, 752 David Goldberg <dsg@mitre.org>, 753 Pete Forman <gsez020@compo.bedford.waii.com>, 754 Neil Moore <amethyst@maxwell.ml.org>, 755 Josh M. Osborne <stripes@va.pubnix.com, 756 Adam Rice <wysiwyg@glympton.airtime.co.uk>, 757 Chris Siebenmann <cks@hawkwind.utcs.toronto.edu>, 758 Bjorn Victor <victor@delial.docs.uu.se>. 759 760for contributing either code or truly keen ideas. 761.... 762