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

NAME

6       FvwmPager - the Fvwm Pager module
7

SYNOPSIS

9       FvwmPager  [  -transient  ] [ name ] [ first desk [ last desk ] ] Fvwm‐
10       Pager is spawned by fvwm, so no command line invocation will work.
11
12       All desks with desk numbers between first desk and last desk  are  dis‐
13       played.  If  last desk is omitted only the first desk is shown. If both
14       desk numbers are omitted, the current desk is used instead. If you  use
15       an  asterisk  '*' in place of first desk the pager will always show the
16       current desktop, even when you switch desks.
17
18       Example lines to put in your .fvwm2rc:
19
20
21       Module FvwmPager 0 3
22
23       or
24
25       Module FvwmPager *
26
27       or from within an fvwm pop-up menu:
28
29       AddToMenu Module-Popup Modules Title
30       + Audio        Module FvwmAudio
31       + Auto         Module FvwmAuto 200
32       + Buttons      Module FvwmButtons
33       + Console      Module FvwmConsole
34       + Ident        Module FvwmIdent
35       + Banner       Module FvwmBanner
36       + Pager        Module FvwmPager 0 3
37
38       or
39
40       + Pager        Module FvwmPager *
41
42
43       If the pager is started with the -transient option,  the  next  time  a
44       button is released the pager is closed. Note that this option does only
45       work if the window style of the pager window is 'sticky' (see the  fvwm
46       man page). You should use the 'StaysOnTop' style too.
47
48       Example:
49
50
51       Style FvwmPager Sticky, StaysOnTop
52       *FvwmPager: Rows       1
53       *FvwmPager: Columns    1
54       Mouse 3 R C Module FvwmPager -transient
55
56
57       With  this  in  your .fvwm2rc, if you press control and button 3 in the
58       root window the pager pops up under the mouse and  while  the  viewport
59       moves with the mouse.
60
61
62

DESCRIPTION

64       The  FvwmPager module shows a miniature view of the Fvwm desktops which
65       are specified in the command line. This is a useful reminder  of  where
66       your  active  windows  are.  Windows in the pager are shown in the same
67       color as their fvwm decorations.
68
69       The pager can be used to change your viewport into the current desktop,
70       to change desktops, or to move windows around.
71
72       Pressing  mouse button 1 in the pager will cause you viewport to change
73       to the selected page of the selected desk. If you click with  button  1
74       in  the desk-label area, you will switch desks but not pages within the
75       desk.
76
77       Dragging mouse button 2 on a miniature view of a window will cause that
78       window  to  be move to the location where you release the mouse button,
79       but your viewport will not change. If you drag the window  out  of  the
80       pager  and  onto  your  desktop,  a  full size image of the window will
81       appear for you to place. There is no way to pick up a full  size  image
82       of  the  window and move it into the pager, however. Since some mice do
83       not have button 2, I have made provisions to drag windows in the  pager
84       by using pressing modifier-1 (usually Alt) and dragging with button 3.
85
86       Clicking  mouse  button 3 on a location will cause the viewport to move
87       to the selected location and switch desks if necessary,  but  will  not
88       align the viewport to a page boundary. Dragging button 3 will cause the
89       viewport to move as you drag but  not  switch  desktops,  even  if  the
90       pointer moves to another desktop.
91
92       With  the *FvwmPager: SloppyFocus option the focus is transfered to the
93       window pointed at with the mouse when the pointer is inside the pager.
94
95       When iconified, the pager will work as a fully functional current  desk
96       only  pager.  Windows and viewports can be moved within the icon of the
97       pager. Users will want to make sure that they have no lines similar to
98
99       Icon "Fvwm Pager" whatever
100
101       in their .fvwm2rc files.
102
103
104

COPYRIGHTS

106       The FvwmPager program, and the concept for interfacing this  module  to
107       the Window Manager, are all original work by Robert Nation.
108
109       Copyright  1994, Robert Nation. No guarantees or warranties or anything
110       are provided or implied in any way whatsoever. Use this program at your
111       own  risk.  Permission to use this program for any purpose is given, as
112       long as the copyright is kept intact.
113
114
115

INITIALIZATION

117       During initialization, FvwmPager gets config info  from  fvwm's  module
118       configuration database (see fvwm(1), section MODULE COMMANDS).
119
120       To  use FvwmPager with several different configurations, you can invoke
121       FvwmPager with an optional parameter, which it will  use  as  its  name
122       instead  (e.g "Module FvwmPager OtherPager"). OtherPager will then read
123       only the lines in the configuration file starting  with  "*OtherPager",
124       and  not  the  lines  belonging  to  FvwmPager. This way multiple pager
125       instances may be used.
126
127       Note: the old way to use the FvwmPager with several different  configu‐
128       rations is to link the executable to another name, i.e.
129
130       ln -s FvwmPager OtherPager
131
132       This may work, but this method is not supported.
133
134

KEYBOARD FOCUS CONTROL

136       You  can direct the keyboard focus to any window on the current desktop
137       by clicking with button 2 on its image in the pager.  The  window  does
138       not need to be visible, but it does need to be on the current page.
139
140

INVOCATION

142       The invocation method was shown in the synopsis section
143
144

CONFIGURATION OPTIONS

146       *FvwmPager: Geometry geometry
147              Completely or partially specifies the pager windows location and
148              geometry, in standard X11 notation.  In  order  to  maintain  an
149              undistorted aspect ratio, you might want to leave out either the
150              width or height dimension of the geometry specification .
151
152
153       *FvwmPager: Rows rows
154              Tells fvwm how many rows of desks to use  when  laying  out  the
155              pager window.
156
157
158       *FvwmPager: Columns columns
159              Tells  fvwm how many columns of desks to use when laying out the
160              pager window.
161
162
163       *FvwmPager: IconGeometry geometry
164              Specifies a size (optional)  and  location  (optional)  for  the
165              pager's icon window. Since there is no easy way for FvwmPager to
166              determine the height of the icon's label, you will have to  make
167              an  allowance  for the icon  label height when using negative y-
168              coordinates in the icon location specification (used to  specify
169              a  location  relative  to  the  bottom instead of the top of the
170              screen).
171
172
173       *FvwmPager: StartIconic
174              Causes the pager to start iconified.
175
176
177       *FvwmPager: NoStartIconic
178              Causes the pager to start normally.  Useful  for  canceling  the
179              effect of the StartIconic option.
180
181
182       *FvwmPager: LabelsBelow
183              Causes  the  pager  to  draw desk labels below the corresponding
184              desk.
185
186
187       *FvwmPager: LabelsAbove
188              Causes the pager to draw desk  labels  above  the  corresponding
189              desk. Useful for canceling the effect of the LabelsBelow option.
190
191
192       *FvwmPager: ShapeLabels
193              Causes the pager to hide the labels of all but the current desk.
194              This turns off label hilighting.
195
196
197       *FvwmPager: NoShapeLabels
198              Causes the pager to show the labels of all visible desks. Useful
199              for canceling the effect of the ShapeLabels option.
200
201
202       *FvwmPager: Font font-name
203              Specified  a font to use to label the desktops.  If font_name is
204              "none" then no desktop labels will be displayed.
205
206
207       *FvwmPager: SmallFont font-name
208              Specified a font to use to label the window names in the  pager.
209              If  not  specified,  the  window  labels will be omitted. Window
210              labels seem to be fairly useless for desktop  scales  of  32  or
211              greater.   If  font_name  is "none" then no window names will be
212              displayed.
213
214
215       *FvwmPager: Fore color
216              Specifies the color to use to write the desktop labels,  and  to
217              draw the page-grid lines.
218
219
220       *FvwmPager: Back color
221              Specifies the background color for the window.
222
223
224       *FvwmPager: Hilight color
225              The active page and desk label will be highlighted by using this
226              background pattern instead of the normal background.
227
228
229       *FvwmPager: HilightPixmap pixmap
230              The active page will be highlighted  by  using  this  background
231              pattern instead of the normal background.
232
233
234       *FvwmPager: DeskHilight
235              Hilight  the  active page with the current hilight color/pixmap.
236              Useful for canceling the effect of the NoDeskHilight option.
237
238
239       *FvwmPager: NoDeskHilight
240              Don't hilight the active page.
241
242
243       *FvwmPager: WindowColors fore back hiFore hiBack
244              Change the normal/highlight colors  of  the  windows.  fore  and
245              hiFore  specify  the colors as used for the font inside the win‐
246              dows. back and hiBack are used to fill the windows with.
247
248
249       *FvwmPager: WindowLabelFormat format
250              This specifies a printf() like format for the labels in the mini
251              window.  Possible flags are: %t, %i, %c, and %r for the window's
252              title, icon, class, or resource name, respectively.  The default
253              is "%i".
254
255
256       *FvwmPager: Label desk label
257              Assigns the text label to desk desk (or the current desk if desk
258              is "*") in the pager window. Useful for assigning symbolic names
259              to desktops, i.e.
260
261              *FvwmPager: Label 1 Mail
262              *FvwmPager: Label 2 Maker
263              *FvwmPager: Label * Matlab
264
265
266              Note: There is currently a much better way to specify desk names
267              globally (and not just in FvwmPager) using DesktopName  command,
268              so you should not use this option anymore.
269
270
271       *FvwmPager: DeskColor desk color
272              Assigns  the  color  color  to desk desk (or the current desk if
273              desk is "*") in the pager window. This replaces  the  background
274              color  for  the particular desk.  This only works when the pager
275              is full sized. When Iconified, the pager uses the  color  speci‐
276              fied by *FvwmPager: Back.
277
278              TIP: Try using *FvwmPager: DeskColor in conjunction with FvwmCpp
279              (or FvwmM4) and FvwmBacker to assign identical  colors  to  your
280              various desktops and the pager representations.
281
282
283       *FvwmPager: Pixmap pixmap
284              Use pixmap as background for the pager.
285
286
287       *FvwmPager: DeskPixmap desk pixmap
288              Assigns  the  pixmap  color to desk desk (or the current desk if
289              desk is "*") in the pager window. This replaces  the  background
290              pixmap for the particular desk.
291
292              TIP:  Try using *FvwmPager: DeskPixmap in conjunction with Fvwm‐
293              Cpp (or FvwmM4) and FvwmBacker to assign  identical  pixmaps  to
294              your various desktops and the pager representations.
295
296
297       *FvwmPager: DeskTopScale number
298              If  the geometry is not specified, then a desktop reduction fac‐
299              tor is used to calculate the pager's size. Things in  the  pager
300              window are shown at 1/number of the actual size.
301
302
303       *FvwmPager: MiniIcons
304              Allow the pager to display a window's mini icon in the pager, if
305              it has one, instead of showing the window's name.
306
307
308       *FvwmPager: MoveThreshold pixels
309              Defines the distance the pointer has to be moved before a window
310              being dragged with button 2 is actually moved. The default value
311              is three pixels. If the pointer moved less that this amount  the
312              window  snaps  back  to its original position when the button is
313              released. If pixels is less than zero the default value is used.
314              The  value  set with the MoveThreshold command in fvwm is inher‐
315              ited by FvwmPager but can be overridden with this option.
316
317
318       *FvwmPager: SloppyFocus
319              If the SloppyFocus option is used, you do not need to click into
320              the  mini window in the pager to give the real window the focus.
321              Simply putting the pointer over the window inside the  pager  is
322              enough.
323
324              Note:  This  option  interferes slightly with the MouseFocus and
325              SloppyFocus styles of fvwm.  Sometimes, if you  click  into  the
326              pager  window  to  change  pages  or  desks  and  then  move the
327              pointer     to a place on the screen where a window of  the  new
328              page  will appear, this new window does not get the input focus.
329              This may happen if you drag the pointer over  one  of  the  mini
330              windows  in  the pager.  There is nothing that can be done about
331              this - except not using SloppyFocus in the pager.
332
333
334       *FvwmPager: SolidSeparators
335              By default the pages of the virtual  desktop  are  separated  by
336              dashed  lines in the pager window.  This option causes FvwmPager
337              to use solid lines instead.
338
339
340       *FvwmPager: NoSeparators
341              Turns off the lines separating the pages of the virtual desktop.
342
343
344       *FvwmPager: Balloons [type]
345              Show a balloon describing the window when the pointer  is  moved
346              into  a  window  in  the pager. The default format (the window's
347              icon name) can be changed using BalloonStringFormat. If type  is
348              Pager balloons are just shown for an un-iconified pager; if type
349              is Icon balloons are just shown for an iconified pager. If  type
350              is anything else (or null) balloons are always shown.
351
352
353       *FvwmPager: BalloonFore color
354              Specifies  the  color for text in the balloon window. If omitted
355              it defaults  to  the  foreground  color  for  the  window  being
356              described.
357
358
359       *FvwmPager: BalloonBack color
360              Specifies  the background color for the balloon window. If omit‐
361              ted it defaults to the background color  for  the  window  being
362              described.
363
364
365       *FvwmPager: BalloonFont font-name
366              Specifies a font to use for the balloon text. Defaults to fixed.
367
368
369       *FvwmPager: BalloonBorderWidth number
370              Sets the width of the balloon window's border. Defaults to 1.
371
372
373       *FvwmPager: BalloonBorderColor color
374              Sets  the  color  of  the  balloon  window's border. Defaults to
375              black.
376
377
378       *FvwmPager: BalloonYOffset number
379              The balloon window is positioned  to  be  horizontally  centered
380              against the pager window it is describing. The vertical position
381              may be set as an offset. Negative offsets of  -n  are  placed  n
382              pixels above the pager window, positive offsets of +n are placed
383              n pixels below. Offsets of -1 and 1 represent the balloon window
384              close to the original window without a gap. Offsets of 0 are not
385              permitted, as this would permit direct transit from pager window
386              to  balloon  window,  causing an event loop. Defaults to +3. The
387              offset will change sign automatically, as needed,  to  keep  the
388              balloon on the screen.
389
390
391       *FvwmPager: BalloonStringFormat format
392              The same as *FvwmPager: WindowLabelFormat, it just specifies the
393              string to display in the balloons. The default is "%i".
394
395
396       *FvwmPager: Colorset desk colorset
397              Tells the module to use colorset colorset for desk. If  you  use
398              an  asterisk  '*'  in place of desk, the colorset is used on all
399              desks. Please refer to the man page of the FvwmTheme module  for
400              details about colorsets.
401
402
403       *FvwmPager: BalloonColorset desk colorset
404              Tells  the module to use colorset colorset for balloons on desk.
405              If you use an asterisk '*' in place of  desk,  the  colorset  is
406              used on all desks. Please refer to the man page of the FvwmTheme
407              module for details about colorsets.
408
409
410       *FvwmPager: HilightColorset desk colorset
411              Tells the module to use  colorset  colorset  for  hilighting  on
412              desk.  If you use an asterisk '*' in place of desk, the colorset
413              is used on all desks. Please  refer  to  the  man  page  of  the
414              FvwmTheme module for details about colorsets.
415
416
417       *FvwmPager: WindowColorsets colorset activecolorset
418              Uses  colorsets  in  the  same  way as *FvwmPager: WindowColors.
419              Please refer to the man page of the FvwmTheme module for details
420              about  colorsets.  The shadow and hilight colors of the colorset
421              are only used for the window borders  if  the  *FvwmPager:  Win‐
422              dow3DBorders is specified too.
423
424
425       *FvwmPager: WindowBorderWidth n
426              Specifies the width of the border drawn around the mini windows.
427              This also sets the minimum size of the mini windows to (2 * n  +
428              1). The default is 1.
429
430
431       *FvwmPager: Window3DBorders
432              Specifies  that  the mini windows should have a 3d borders based
433              on the mini window background. This option only works if  *Fvwm‐
434              Pager: WindowColorsets is specified.
435
436
437       *FvwmPager: UseSkipList
438              Tells  FvwmPager to not show the windows that are using the Win‐
439              dowListSkip style.
440
441

AUTHOR

443       Robert Nation
444       DeskColor patch contributed by Alan Wild
445       MiniIcons & WindowColors patch contributed by Rob Whapham
446       Balloons patch by Ric Lister <ric@giccs.georgetown.edu>
447       fvwm-workers: Dominik, Olivier, Hippo and others.
448
449
450
4513rd Berkeley Distribution    09 May 2010 (2.5.30)                 FvwmPager(1)
Impressum