1FvwmWindowMenu(1)                Fvwm Modules                FvwmWindowMenu(1)
2
3
4

NAME

6       FvwmWindowMenu - open configurable fvwm menu listing current windows
7

SYNOPSIS

9       FvwmWindowMenu should be spawned by fvwm(1) for normal functionality.
10
11       Run this module from your StartFunction:
12
13           AddToFunc StartFunction
14           + I Module FvwmWindowMenu
15

DESCRIPTION

17       A substitute for fvwm builtin WindowList, but written in Perl and easy
18       to customize. Unlike FvwmIconMan or FvwmWinList the module does not
19       draw its own window, but instead creates an fvwm menu and asks fvwm to
20       pop it up.
21
22       By defining a set of regular expressions, windows may be sorted into
23       sections based on a regexp matching the window name, class or resource
24       and included in the menu.
25
26       Similarly, another set of regular expressions can be used to exclude
27       items from the menu.
28
29       Any windows not matching an instance of the include or exclude list
30       will be placed in the last section of the menu.
31

USAGE

33       Run the module, supposedly from StartFunction in .fvwm2rc:
34
35           Module FvwmWindowMenu
36
37       To actually invoke the menu add something like:
38
39           Key Menu A N SendToModule FvwmWindowMenu \
40               Post Root c c SelectOnRelease Menu
41
42       or:
43
44           Mouse 2 A N SendToModule FvwmWindowMenu Popup
45
46       The additional parameters are any valid Menu command parameters without
47       a menu name, see fvwm.
48
49       Recognized actions are Post (or its alias Menu) and Popup, they create
50       fvwm menus and invoke them using the corresponding commands Menu and
51       Popup. If the module was started with "-g" switch, it additionally
52       supports PostBar (not implemented yet).
53
54       Set module options for windows to include (Show) or exclude (DontShow).
55       The syntax is:
56
57           *FvwmWindowMenu: ShowName pattern
58           *FvwmWindowMenu: ShowClass pattern
59           *FvwmWindowMenu: ShowResource pattern
60           *FvwmWindowMenu: DontShowName pattern
61           *FvwmWindowMenu: DontShowClass pattern
62           *FvwmWindowMenu: DontShowResource pattern
63
64       Pattern is a perl regular expression that will be evaluated in m//
65       context. See perlre(1).
66
67       For example:
68
69           *FvwmWindowMenu: ShowResource ^gvim
70           *FvwmWindowMenu: ShowName Galeon|Navigator|mozilla-bin|Firefox
71
72       will define two sections containing respectively browsers, and GVim. A
73       third section will contain all other windows.
74
75       To only include matching windows, add:
76
77           *FvwmWindowMenu: DontShowName .*
78
79       Similarly:
80
81           *FvwmWindowMenu: DontShowName ^Fvwm
82           *FvwmWindowMenu: DontShowClass Gkrellm
83
84       will cause the menu to ignore windows with name beginning with Fvwm or
85       class gkrellm.
86
87       Other options:
88
89       *FvwmWindowMenu: OnlyIconified {on|off}
90           show only iconified windows
91
92       *FvwmWindowMenu: AllDesks {on|off}
93           show windows from all desks
94
95       *FvwmWindowMenu: AllPages {on|off}
96           show windows from all pages
97
98       *FvwmWindowMenu: MaxLen 32
99           max length in chars of entry
100
101       *FvwmWindowMenu: MenuName MyMenu
102           name of menu to popup
103
104       *FvwmWindowMenu: MenuStyle MyMenuStyle
105           name of MenuStyle to apply
106
107       *FvwmWindowMenu: Debug {0,1,2,3}
108           level of debug info output, 0 means no debug
109
110       *FvwmWindowMenu: Function MyWindowListFunc
111           function to invoke on menu entries; defaults to WindowListFunc
112
113       *FvwmWindowMenu: ItemFormat formatstring
114           how to format menu entries; substitutions are made as follows:
115
116           %n, %i, %c, %r
117               the window name, icon name, class or resource
118
119           %x, %y
120               the window x or y coordinates w.r.t. the page the window is on.
121
122           %X, %Y
123               the window x or y coordinates w.r.t. the desk the window is on.
124
125           %d  the window desk number
126
127           %m  the window's mini-icon
128
129           %M  the window's mini-icon only for iconified windows, otherwise
130               empty
131
132           %t  a tab
133
134           %%  a literal %
135
136           The format string must be quoted. The default string is
137           "%m%n%t%t(+%x+%y) - Desk %d".
138

MORE EXAMPLES

140       Fancy binding of the window menu to the right windows key on some
141       keyboards. Hold this button while navigating using cursor keys, then
142       release it.
143
144           CopyMenuStyle * WindowMenu
145           MenuStyle WindowMenu SelectOnRelease Super_R
146           *FvwmWindowMenu: MenuStyle WindowMenu
147
148           AddToFunc StartFunction I Module FvwmWindowMenu
149
150           Key Super_R A A SendToModule FvwmWindowMenu Post Root c c WarpTitle
151

AUTHORS

153       Richard Lister <ric+lister@cns.georgetown.edu>.
154
155       Scott Smedley <ss@aao.gov.au>.
156
157       Mikhael Goikhman <migo@homemail.com>.
158
159
160
1612.5.28 (from cvs)                 2009-03-22                 FvwmWindowMenu(1)