1FvwmTaskBar(1) Fvwm Modules FvwmTaskBar(1)
2
6 FvwmTaskBar - the fvwm taskbar module
7
9 FvwmTaskBar [name]
10 FvwmTaskBar is spawned by fvwm, so no command line invocation will
12 work.
13
16 The FvwmTaskBar module provides a taskbar made up of buttons arranged
17 by rows, each corresponding to a window that fvwm is managing. Click‐
18 ing on first button gives focus to the corresponding top level window;
19 clicking on the middle button will hide a top level window; third mouse
20 button is reserved for a future extension (context menu). Like the
21 other modules, FvwmTaskBar only works when fvwm is used as the window
22 manager.
23 When started, the taskbar shows up as a single row of buttons filling
25 the full width of the screen, but during the work can be resized to
26 accommodate up to 8 rows. In addition, if the AutoStick option is used,
27 the taskbar will auto position itself at the top or bottom of the
28 screen, and can be dragged from one position to another with a normal
29 move operation.
30 The first button of the taskbar, labelled "Start" sends a "Popup Start‐
32 Menu" command to the fvwm, which can be used to pop-up a general-pur‐
33 pose menu when the button is pressed.
34 The FvwmTaskBar also displays at the right side a window showing the
36 current time and the built-in incoming mail indicator.
37
40 The FvwmTaskBar module is derived from Mike Finger's FvwmWinList.
41 Copyright 1994, Mike Finger. The author makes no guarantees or war‐
43 ranties of any kind about the use of this module. Use this module at
44 your own risk. You may freely use this module or any portion of it for
45 any purpose as long as the copyright is kept intact.
46
49 During initialization, FvwmTaskBar gets configuration information from
50 fvwm to find the options that pertain to it. These options are dis‐
51 cussed in a later section.
52
55 FvwmTaskBar can be invoked by fvwm during initialization by inserting
56 the line 'Module FvwmTaskBar' in the .fvwm2rc file.
57 FvwmTaskBar must reside in a directory that is listed in the ModulePath
59 option of fvwm for it to be executed by fvwm.
60
63 The following options can be placed in the .fvwm2rc file
64 *FvwmTaskBar: Geometry {+-}<X>{+-}<Y>
67 Specifies the location and gravity of the FvwmTaskBar window.
68 Currently, this option is scanned as a normal X geometry string.
69 You can include the width and the height in addition to the "x"
70 and "y" offset. However, only the "x" and "y" offset are used.
71 To avoid possible future compatibility problems, only code the
72 "x" and "y" offset.
73 The actual width of the taskbar is always the full width of the
75 screen and the height is controlled by the *FvwmTaskBar: Rows
76 option.
77 If the AutoStick option is specified, the taskbar automatically
79 "sticks" to the top or the bottom of the screen, whichever is
80 closest to the geometry specification.
81 To position the taskbar at the bottom of the screen, use a geom‐
83 etry of "+0-0".
84 *FvwmTaskBar: Rows r
87 Specifies the initial number in rows of the FvwmTaskBar window.
88 Default is 1 and the maximum is 8.
89 *FvwmTaskBar: Font font
92 Specifies the default font to be used for labeling the buttons,
93 when they are not depressed. If not specified, fixed font is
94 assumed.
95 *FvwmTaskBar: SelFont font
98 Specifies the font to be used for the depressed buttons. Note
99 that the Start button will always use this font even if is not
100 pressed. If this option is not specified, the default font is
101 used instead.
102 *FvwmTaskBar: StatusFont font
105 Specifies the font to be used for the clock and tip windows. If
106 this option is not specified, fixed font is used.
107 *FvwmTaskBar: Fore color
110 Specifies the color to use for the button names.
111 *FvwmTaskBar: Back color
114 Specifies the background color for the bar and buttons.
115 *FvwmTaskBar: Colorset colorset
118 Tells the module to use colorset colorset for the window back‐
119 ground and the foreground color of the buttons. Please refer to
120 the man page of the FvwmTheme module for details about col‐
121 orsets.
122 *FvwmTaskBar: IconFore color
125 Specifies the color to use for the button names which represent
126 iconified windows.
127 *FvwmTaskBar: IconBack color
130 Specifies the color to use for the buttons which represent
131 iconified windows.
132 *FvwmTaskBar: IconColorset colorset
135 Tells the module to use colorset colorset for the buttons of
136 iconified windows. Please refer to the man page of the
137 FvwmTheme module for details about colorsets.
138 *FvwmTaskBar: FocusFore color
141 Specifies the color to use for the button which represents the
142 window with the focus. If not specified the color specified by
143 *FvwmTaskBar: Fore or *FvwmTaskBar: Colorset is used.
144 *FvwmTaskBar: FocusBack color
147 Specifies the color to use for the button which represents the
148 window with the focus. If not specified the color specified by
149 *FvwmTaskBar: Back or *FvwmTaskBar: Colorset is used. Note that
150 the button which represents the window with the focus is also
151 highlighted. See "*FvwmTaskBar: NoBrightFocus".
152 *FvwmTaskBar: FocusColorset colorset
155 Tells the module to use colorset colorset for the button which
156 represents the window with the focus. Please refer to the man
157 page of the FvwmTheme module for details about colorsets.
158 *FvwmTaskBar: NoBrightFocus
161 By default the button which represents the window with the focus
162 is highlighted. This option disables this feature. Note: you
163 will want this option if you use a pixmap (via FvwmTheme) for
164 the background.
165 *FvwmTaskBar: TipsFore color
168 Specifies the color to be used for the text in the tips windows.
169 *FvwmTaskBar: TipsBack color
172 Specifies the background color for the tips windows.
173 *FvwmTaskBar: TipsColorset colorset
176 Tells the module to use colorset colorset for the tips windows.
177 Please refer to the man page of the FvwmTheme module for details
178 about colorsets.
179 *FvwmTaskBar: AutoStick
182 This option causes the taskbar to "stick" either to the top or
183 bottom of the screen, whichever is closest to the initial window
184 placement. Any further move operation is also subject to that
185 behavior.
186 *FvwmTaskBar: AutoFocus
189 This option causes the taskbar to raise a window if the cursor
190 stays on a button in taskbar and its tip is open.
191 *FvwmTaskBar: AutoHide [pixels]
194 This option causes the taskbar to disappear leaving a narrow
195 strip at the bottom of the screen, and reappear only when the
196 mouse is moved to that strip. This option automatically enables
197 AutoStick. The optional pixels parameter specifies thickness of
198 a strip (3 pixels by default).
199 *FvwmTaskBar: UseSkipList
202 Tells FvwmTaskBar to not show the windows that are listed on a
203 WindowListSkip line in the configuration file.
204 *FvwmTaskBar: DeskOnly
207 Tells FvwmTaskBar to show only windows that are on the current
208 desktop. When desktops are switched, the list of windows
209 changes accordingly.
210 *FvwmTaskBar: PageOnly
213 Tells FvwmTaskBar to show only windows that are on the same page
214 as the task bar. When a window enters or leaves the page, the
215 list of windows changes accordingly.
216 *FvwmTaskBar: ScreenOnly
219 Tells FvwmTaskBar to show only windows that are only on the same
220 Xinerama screen as the task bar. When a window enters or leaves
221 the screen, the list of windows changes accordingly.
222 *FvwmTaskBar: UseIconNames
225 Tells FvwmTaskBar to use the icon name of the window instead of
226 the full window name. This is useful to keep the width of the
227 buttons small.
228 *FvwmTaskBar: ShowTransients
231 Tells FvwmTaskBar to show the application transient windows
232 also. By default they are not shown.
233 *FvwmTaskBar: Action action response
236 Tells FvwmTaskBar to do response when action is done. The cur‐
237 rently supported actions are: Click1, Click2, Click3 and so on.
238 By default the module supports 5 mouse buttons, but it can be
239 compiled to support more. The currently supported responses are
240 any fvwm built-in commands, including modules and functions.
241 Warning: Use of the former syntax that allowed to use comma sep‐
242 arated lists of commands is strongly discouraged due to synchro‐
243 nization problems with fvwm. Please use complex fvwm functions
244 instead (defined with the AddToFunc command of fvwm).
245 In the response part, you can use a number of predefined vari‐
247 ables: $left, $right, $top and $bottom are substituted by the
248 left, right, top and bottom coordinates of the button pressed.
249 $-left, $-right, $-top and $-bottom are substituted likewise,
250 but the coordinates are calculated from the bottom or the right
251 edge of the screen instead (for a button that is 5 pixels away
252 from the right screen border, $-right will be 5). $width and
253 $height are replaced by the width or height of the button. All
254 this is done regardless of any quoting characters. To get a lit‐
255 eral '$' use the string '$$'.
256 *FvwmTaskBar: Button Title title, Icon icon, Action action
259 Tells FvwmTaskBar to put a shortcut minibutton in the taskbar
260 that does action when clicked. The icon can have a caption
261 denoted by title, an icon denoted by icon, or a combination of
262 the two. The icons will appear to the immediate right of the
263 start button, and will appear in the order that they are
264 declared in the .fvwm2rc file.
265 To invoke different commands for different mouse clicks, use
267 this syntax:
268 *FvwmTaskBar: Button Title title, Icon icon, \
271 Action (Mouse 1) action1, Action (Mouse 2) action2
272 *FvwmTaskBar: ButtonWidth width
276 Indicates the maximum width that window buttons should reach.
277 (the minimum is hard coded at 32).
278 *FvwmTaskBar: Pad width
281 Specifies the space (in pixels) between the window buttons. If
282 this option is not specified, the default space is 3.
283 *FvwmTaskBar: WindowButtonsLeftMargin margin
286 Specifies the space (in pixels) between the left side of the
287 left-most window button and the right side of the start button
288 or right-most shortcut minibutton. If this option is not speci‐
289 fied, the default margin is 4.
290 *FvwmTaskBar: WindowButtonsRightMargin margin
293 Specifies the space (in pixels) between the right side of the
294 right-most window button and the left side of the clock and tip
295 window. If this option is not specified, the default margin is
296 2.
297 *FvwmTaskBar: StartButtonRightMargin margin
300 Specifies the space (in pixels) between the right side of the
301 start button and the left side of the left-most shortcut
302 minibutton. If this option is not specified, the default margin
303 is 0.
304 *FvwmTaskBar: 3DFvwm
307 By default the buttons use a special (asymmetric) 3D look. This
308 option enables a more classical 3D look (Ie., a la fvwm).
309 *FvwmTaskBar: HighlightFocus
312 If the mouse pointer is over the taskbar, the window under the
313 current button is active. This behavior is like the TVTWM Icon
314 Manager or FvwmIconMan. Note: If you use this option combined
315 with FollowMouse focus style, you'll want the taskbar to be
316 ClickToFocus.
317 *FvwmTaskBar: ShowTips
320 Enables the tips windows (by default disabled).
321 *FvwmTaskBar: NoIconAction action
324 Tells FvwmTaskBar to do action is when a NoIcon style window is
325 iconified or de-iconified. Relevant coordinates are appended to
326 action so that the icon can be traced to an FvwmTaskBar button.
327 An example action is "*FvwmTaskBar: NoIconAction SendToModule
328 FvwmAnimate animate". A blank or null action turns this feature
329 off.
330 The following options deal more specifically with the status indicators
334 displayed at the right of the taskbar.
335 *FvwmTaskBar: ClockFormat format-string
338 This option specifies the time format for the digital clock. It
339 is a strftime(3) compatible format string. By default it is
340 "%R". There is a 24 character limit for string expansion. The
341 string depends of locale settings.
342 *FvwmTaskBar: DateFormat format-string
345 This option specifies the date and/or time format for clock tip.
346 It is a strftime(3) compatible format string. By default it is
347 "%A, %B %d, %Y". There is 40 characters limit for string expan‐
348 sion. The string depends of locale settings now.
349 *FvwmTaskBar: UpdateInterval seconds
352 Specifies how often the clock display should be refreshed, so
353 that times of the form HH:MM:SS can be used. By default 60 sec‐
354 onds.
355 *FvwmTaskBar: BellVolume volume
358 This sets the volume of the bell when mail is detected. It is a
359 value between 0 (no bell) and 100 (maximum volume). By default
360 it is set to 20.
361 *FvwmTaskBar: MailBox path
364 This option instructs the module to look for mail at the speci‐
365 fied place. It is a full pathname to the user's mailbox. By
366 default it is /var/spool/mail/$USER_LOGIN. A value of 'None'
367 instructs the module not to have a mail indicator.
368 *FvwmTaskBar: MailDir
371 By default format of the user's mailbox is mbox. If this option
372 is specified, the maildir format is used instead.
373 *FvwmTaskBar: MailCommand command
376 Specifies a fvwm command to be executed when double-clicking on
377 the mail icon.
378 *FvwmTaskBar: MailCheck seconds
381 Specifies the interval between checks for new mail. The default
382 is ten seconds. A value of zero or less switches mail checking
383 off.
384 Note, this value is only relable when greater than the UpdateIn‐
386 terval value. The mail check is done either on any redraw (like
387 a focus change) or every nearest factor of the UpdateInterval
388 value.
389 *FvwmTaskBar: IgnoreOldMail
392 If set, draw no bitmap if there is no new mail.
393 The following options deal with the Start button at the left of the
397 taskbar:
398 *FvwmTaskBar: StartCommand command
401 This option specifies a command to run when the start button is
402 pressed. Some strings are replaced in the command when it is
403 executed like for the other buttons. See Action for details.
404 If both, StartCommand and StartMenu have been defined, the com‐
405 mand is executed first and the menu is opened afterwards. The
406 StartCommand can be used to exactly place a menu atop a button.
407 *FvwmTaskBar: StartCommand Popup StartMenu rectangle \
410 $widthx$height+$left+$top 0 -100m
411 To invoke different commands for different mouse clicks, use
414 this syntax:
415 *FvwmTaskBar: StartCommand (Mouse 1) Popup Mouse1Menu
418 *FvwmTaskBar: StartCommand (Mouse 3) Popup Mouse3Menu
419 *FvwmTaskBar: StartName string
423 This option specifies the string displayed in the Start button.
424 ('Start' by default). If the string is omitted no string is dis‐
425 played.
426 *FvwmTaskBar: StartMenu string
429 This option specifies the pop up menu to invoke when the start
430 button is pressed. ('StartMenu' by default). The module send a
431 'Popup StartMenu' command to the fvwm window manager.
432 To invoke different menus for different mouse clicks, use this
434 syntax:
435 *FvwmTaskBar: StartMenu (Mouse 1) Mouse1Menu
438 *FvwmTaskBar: StartMenu (Mouse 3) Mouse3Menu
439 *FvwmTaskBar: StartIcon icon-name
443 This option specifies the name of the icon to display at the
444 left of the Start button.
445 *FvwmTaskBar: NoDefaultStartButton
448 This option removes the default start button if no start button
449 configuration options are given. It is useful to remove the
450 start button. Note that this is the default if you use the But‐
451 ton configuration option.
452
455 The following are excerpts from a .fvwm2rc file which describe Fvwm‐
456 TaskBar initialization commands:
457 #
460 # Start the taskbar on fvwm startup and restart
461 #
462 AddToFunc "StartFunction" "I" Module FvwmTaskBar
464 #
466 # For Click 1 action
467 #
468 AddToFunc DeiconifyRaiseAndFocus
470 + I Iconify off
471 + I Raise
472 + I Focus
473 #
475 # Set the style for the taskbar window, keep always on top of another
476 # windows
477 #
478 Style "FvwmTaskBar" NoTitle,BorderWidth 4, HandleWidth 4,Sticky,\
480 StaysOnTop,WindowListSkip,CirculateSkip
481 #------------------------------------ taskbar
483 *FvwmTaskBar: Back #c3c3c3
484 *FvwmTaskBar: Fore black
485 *FvwmTaskBar: TipsBack bisque
486 *FvwmTaskBar: TipsFore black
487 *FvwmTaskBar: Geometry +0-0
488 *FvwmTaskBar: Font -adobe-helvetica-medium-r-*-*-14-*-*-*-*-*-*-*
489 *FvwmTaskBar: SelFont -adobe-helvetica-bold-r-*-*-14-*-*-*-*-*-*-*
490 *FvwmTaskBar: StatusFont fixed
491 *FvwmTaskBar: Action Click1 DeiconifyRaiseAndFocus
493 *FvwmTaskBar: Action Click2 Iconify On
494 *FvwmTaskBar: Action Click3 Lower
495 *FvwmTaskBar: UseSkipList
497 *FvwmTaskBar: UseIconNames
498 *FvwmTaskBar: AutoStick
499 *FvwmTaskBar: ShowTips
500 *FvwmTaskBar: NoIconAction SendToModule FvwmAnimate animate
501 *FvwmTaskBar: ButtonWidth 180
503 *FvwmTaskBar: BellVolume 20
504 *FvwmTaskBar: MailBox /var/spool/mail/
505 *FvwmTaskBar: MailCommand Exec xterm -e mail
506 *FvwmTaskBar: ClockFormat %I:%M %p
507 *FvwmTaskBar: StartName Start
509 *FvwmTaskBar: StartMenu StartMenu
510 *FvwmTaskBar: StartIcon mini-exp.xpm
511 *FvwmTaskBar: Button Title Mozilla, Action exec exec /usr/local/mozilla/mozilla
513 *FvwmTaskBar: Button Icon mini.term.xpm, Action exec exec xterm
514 *FvwmTaskBar: Button Title Freeamp, Icon mini.cd.xpm, Action exec exec freeamp
515
520 There is a bug report that FvwmTaskBar doesn't work well with auto hide
521 turned on.
522
525 David Barth <barth@di.epfl.ch>
526
529 These people have contributed to FvwmTaskBar:
530 Danny Dulai <nirva@ishiboo.com>
533 fvwm workers <fvwm-workers@fvwm.org>
5353rd Berkeley Distribution 24 November 2007 (2.5.24) FvwmTaskBar(1)