1FvwmIconBox(1) Fvwm Modules FvwmIconBox(1)
2
6 FvwmIconBox - the fvwm icon box module
7
9 FvwmIconBox [name]
10 FvwmIconBox is spawned by fvwm, so no command line invocation will
12 work.
13
16 The FvwmIconBox module provides an icon manager. The user can do opera‐
17 tions, like iconify and de-iconify, for each icon shown in the module
18 via mouse and keyboard.
19
22 The FvwmIconBox program is original work of Nobutaka Suzuki.
23 Copyright 1994, Nobutaka Suzuki. No guarantees or warranties or any‐
25 thing are provided or implied in any way whatsoever. Use this program
26 at your own risk. Permission to use this program for any purpose is
27 given, as long as the copyright is kept intact.
28
32 During initialization, FvwmIconBox gets config info from fvwm's module
33 configuration database (see fvwm(1), section MODULE COMMANDS).
34 If the FvwmIconBox executable is linked to another name, i.e. ln -s
36 FvwmIconBox MoreIconBox, then another module called MoreIconBox can be
37 started, with a completely different configuration than FvwmIconBox,
38 simply by changing the keyword FvwmIconBox to MoreIconBox. This way
39 multiple clutter-reduction programs can be used.
40
43 FvwmIconBox can be invoked by binding the action 'Module FvwmIconBox'
44 to a menu or key-stroke in the .fvwm2rc file. Fvwm will search direc‐
45 tory specified in the ModulePath configuration option to attempt to
46 locate FvwmIconBox.
47
50 FvwmIconBox shows icons only if NoIcon is applied. Note that the NoIcon
51 attribute should be set after the Icon attribute specification. Other‐
52 wise the icon-box module might become nothing but an empty-box module.
53 The module reads the same .fvwm2rc file as fvwm reads when it starts
54 up, and looks for lines as listed below:
55 *FvwmIconBox: Fore color
58 Tells the module to use color instead of white for the window
59 foreground. This option affects only the foreground color of
60 background_bitmap specified in *FvwmIconBox: Pixmap option
61 described below.
62 *FvwmIconBox: Colorset colorset
65 Tells the module to use colorset (See FvwmTheme) in place of
66 Fore and Back.
67 *FvwmIconBox: IconColorset colorset
70 Tells the module to use colorset (See FvwmTheme) in place of
71 IconFore and IconBack.
72 *FvwmIconBox: IconHiColorset colorset
75 Tells the module to use colorset (See FvwmTheme) in place of
76 IconHiFore and IconHiBack.
77 *FvwmIconBox: Back color
80 Tells the module to use color instead of black for the window
81 background.
82 *FvwmIconBox: IconFore color
85 Tells the module to use color instead of black for non-selected
86 icon text.
87 *FvwmIconBox: IconBack color
90 Tells the module to use color instead of white for the non-
91 selected icon background.
92 *FvwmIconBox: IconHiFore color
95 Tells the module to use color instead of black for selected icon
96 text.
97 *FvwmIconBox: IconHiBack color
100 Tells the module to use color instead of white for the selected
101 icon background.
102 *FvwmIconBox: Pixmap pixmap
105 Tells the module to use pixmap for the window background_pixmap.
106 *FvwmIconBox: Font fontname
109 Tells the module to use fontname instead of fixed for text.
110 *FvwmIconBox: SortIcons option
113 Tells the module to sort all icons in the icon box in alphabeti‐
114 cal order. option can be WindowName, IconName, ResClass, and
115 ResName. For example, specifying ResClass means that icons are
116 sorted by using their resource-class strings. If option is
117 ResClass or ResName, an icon having no XA_WM_CLASS property is
118 considered to be the "smallest" element.
119 *FvwmIconBox: Padding number
122 Specifies the number of pixels between icons. The default value
123 is 5.
124 *FvwmIconBox: SBWidth number
127 Specifies the width of horizontal and vertical scrollbars. The
128 default value is 9.
129 *FvwmIconBox: Placement primary secondary
132 Specifies icon placement policy. primary and secondary can be
133 Top, Bottom, Left and Right. The following eight combinations
134 are available:
135 primary secondary
137 Left Top
139 Left Bottom
140 Right Top
141 Right Bottom
142 Top Left
143 Top Right
144 Bottom Left
145 Bottom Right
146 Top: Icons are placed from top to bottom.
148 Bottom: Icons are placed from bottom to top.
150 Left: Icons are placed from left to right.
152 Right: Icons are placed from right to left.
154 For example, when the placement is "Left Top", icons are placed
156 from left to right, and new rows are added from top to bottom.
157 The default vale is "Left Bottom".
158 *FvwmIconBox: UseSkipList
161 Tells FvwmIconBox to not show the windows that are listed on a
162 WindowListSkip line in the configuration file.
163 *FvwmIconBox: Lines
166 Specifies the number of icons placed in a line. If primary is
167 Left or Right, this value specifies the number of columns. If
168 primary is Top or Bottom, this value specifies the number of
169 rows. For example, seven icons are placed in a row if *FvwmIcon‐
170 Box: Lines is 7 and *FvwmIconBox: Placement is "Left Top". The
171 default value is 6.
172 *FvwmIconBox: HideSC direction
175 Specifies the un-displayed scroll bar . Direction can be either
176 Horizontal or Vertical.
177 *FvwmIconBox: Geometry <width>x<height>{+-}<X>{+-}<Y>
180 Specifies the location and/or size of FvwmIconBox. width and
181 height are measured in icons, not pixels. The default value is
182 6x1+0+0.
183 *FvwmIconBox: MaxIconSize <width>x<height>
186 Specifies the maximum size of icon bitmap. A bitmap larger than
187 this size is clipped to this size. The default value is 48x48.
188 In particular, if the height is 0, then icon bitmaps are not
189 displayed and only icon labels are drawn.
190 *FvwmIconBox: Mouse Button Action Response[, Response]
193 Tells the module to do Response when Action is done on button
194 Button. Available Responses are built-in commands in Fvwm (e.g.
195 Iconify, Delete, Focus) and available Actions are Click and Dou‐
196 bleClick.
197 *FvwmIconBox: Key Key Response[, Response]
200 Tells the module to do Response when Key is pressed. Available
201 Responses are, besides Fvwm built-in commands, the following six
202 FvwmIconBox built-in commands: Next, Prev, Left, Right, Up, and
203 Down.
204 Next: Change the hilighted icon to the next.
206 Prev: Change the hilighted icon to the previous.
208 Left: Move the slider of the horizontal scrollbar to left. Icons
210 move to right accordingly.
211 Right: Move the slider of the horizontal scrollbar to right.
213 Icons move to left accordingly.
214 Up: Move the slider of the vertical scrollbar to up. Icons move
216 to down accordingly.
217 Down: Move the slider of the vertical scrollbar to down. Icons
219 move to up accordingly.
220 *FvwmIconBox: windowname bitmap-file
223 Specifies the bitmap to be displayed in the icon box for window‐
224 name. This option "overrides" bitmap files specified in Style
225 command. Windowname can be window name, class name, or resource
226 name. Windowname can contain "*" and "?" like Fvwm configura‐
227 tion file. The bitmap-file is either the full path name to a
228 bitmap file, or a file in the ImagePath. If bitmap-file is spec‐
229 ified to be "-", the icon for a window corresponding to window‐
230 name is not shown in the icon box.
231 *FvwmIconBox: SetWMIconSize
234 Tells the module to set XA_WM_ICON_SIZE property of the root
235 window at the size which the module want icon windows to have.
236 If you show icon windows on not the root window but the module,
237 it would be better to specify this option.
238 *FvwmIconBox: HilightFocusWin
241 Tells the module to hilight the icon of the window which has the
242 keyboard focus. The fore/back colors of the hilighted icon are
243 those specified in the *FvwmIconBox: IconHiFore and *FvwmIcon‐
244 Box: IconHiBack commands, respectively.
245 *FvwmIconBox: Resolution resolution
248 If resolution is Desk, then the module shows only the icons on
249 the current desk. Currently, Desk is the only value resolution
250 can take :)
251 *FvwmIconBox: FrameWidth width1 width2
254 Specifies the frame-width of the module. Width1 corresponds to
255 the width from the outer-border to the scroll-bar, and, width2
256 corresponds to the width from the scroll-bar to the internal-
257 window displaying icons. The default values are 8 and 6, respec‐
258 tively.
259 *FvwmIconBox: NoIconAction action
262 Tells FvwmIconBox to do action is when a NoIcon style window is
263 iconified or de-iconified. Relevant coordinates are appended to
264 action so that the icon can be traced to an FvwmIconBox button.
265 An example action is "*FvwmIconBox: NoIconAction SendToModule
266 FvwmAnimate animate". A blank or null action turns this feature
267 off.
268 *FvwmIconBox: NoIconifiedParentheses
271 Tells FvwmIconBox to not enclose the title of an iconified win‐
272 dow within parantheses.
273 *FvwmIconBox: NormalTitleRelief num
276 Sets the width in pixels of the relief that is put around icon
277 titles for windows that are not iconified. The default if this
278 option is not specified is 2 pixels.
279 *FvwmIconBox: IconifiedTitleRelief num
282 Sets the width in pixels of the relief that is put around icon
283 titles for windows that are iconified. The default if this
284 option is not specified is 2 pixels.
285 *FvwmIconBox: NormalTitleInvertedRelief
288 This option makes the relief around titles of uniconified win‐
289 dows to appear pressed in. The default is a relief that makes
290 the label look raised from the background (unless a relief width
291 of 0 pixels is specified, see above).
292 *FvwmIconBox: IconifiedTitleInvertedRelief
295 This option makes the relief around titles of iconified windows
296 to appear pressed in.
297
300 The following are excepts from a .fvwm2rc file which describe FvwmIcon‐
301 Box initialization commands:
302 ############################################################
304 # Note that icons are shown in the module
305 # only if NoIcon attribute is applied.
306 Style "*" NoIcon
307 ############################################################
309 *FvwmIconBox: IconBack #cfcfcf
310 *FvwmIconBox: IconHiFore black
311 *FvwmIconBox: IconHiBack LightSkyBlue
312 *FvwmIconBox: Back #5f9ea0
313 #*FvwmIconBox: Fore blue
314 *FvwmIconBox: Geometry 5x1+0+0
315 *FvwmIconBox: MaxIconSize 64x38
316 *FvwmIconBox: Font -adobe-helvetica-medium-r-*-*-12-*-*-*-*-*-*-*
317 *FvwmIconBox: SortIcons IconName
318 #*FvwmIconBox: SortIcons ResClass
319 *FvwmIconBox: Padding 4
320 *FvwmIconBox: FrameWidth 9 7
321 *FvwmIconBox: Lines 10
322 *FvwmIconBox: SBWidth 11
323 *FvwmIconBox: Placement Left Top
324 *FvwmIconBox: Pixmap fvwm.xpm
325 #*FvwmIconBox: HideSC Horizontal
326 *FvwmIconBox: SetWMIconSize
327 *FvwmIconBox: HilightFocusWin
328 #*FvwmIconBox: Resolution Desk
329 *FvwmIconBox: NoIconAction SendToModule FvwmAnimate animate
331 #
333 # mouse bindings
334 #
335 *FvwmIconBox: Mouse 1 Click RaiseLower
336 *FvwmIconBox: Mouse 1 DoubleClick Iconify
337 *FvwmIconBox: Mouse 2 Click Iconify -1, Focus
338 *FvwmIconBox: Mouse 3 Click Module FvwmIdent
339 #
340 # Key bindings
341 #
342 *FvwmIconBox: Key r RaiseLower
343 *FvwmIconBox: Key space Iconify
344 *FvwmIconBox: Key d Close
345 #
346 # FvwmIconBox built-in functions
347 #
348 *FvwmIconBox: Key n Next
349 *FvwmIconBox: Key p Prev
350 *FvwmIconBox: Key h Left
351 *FvwmIconBox: Key j Down
352 *FvwmIconBox: Key k Up
353 *FvwmIconBox: Key l Right
354 #
355 # Icon file specifications
356 #
357 # Mostly, you don't have to specify icon files, as FvwmIconBox now
358 # reads icon files specified in Style commands.
359 #
360 *FvwmIconBox: "Fvwm*" -
361
365 Nobutaka Suzuki (nobuta-s@is.aist-nara.ac.jp).
3663rd Berkeley Distribution 24 November 2007 (2.5.24) FvwmIconBox(1)