FvwmIconBox
- the FVWM iconbox module
SYNOPSIS
FvwmIconBox is spawned by fvwm, so no command line invoca-
tion will work.
DESCRIPTION
The FvwmIconBox module provides an icon manager. The user
can do operations, like iconify and deiconify, for each
icon shown in the module via mouse and keyboard.
FvwmIconBox reads the same .fvwmrc file as fvwm reads when
it starts up, and looks for lines similar to "*FvwmIcon-
BoxFore green".
COPYRIGHTS
The FvwmIconBox program is original work of Nobutaka
Suzuki.
Copyright 1994, Nobutaka Suzuki. No guarantees or war-
ranties or anything are provided or implied in any way
whatsoever. Use this program at your own risk. Permission
to use this program for any purpose is given, as long as
the copyright is kept intact.
INITIALIZATION
During initialization, FvwmIconBox will eventually search
a configuration file. The configuration file is the same
file that fvwm used during initialization.
If the FvwmIconBox executable is linked to another name,
ie ln -s FvwmIconBox MoreIconBox, then another module
called MoreIconBox can be started, with a completely dif-
ferent configuration than FvwmIconBox, simply by changing
the keyword FvwmIconBox to MoreIconBox. This way multiple
clutter-reduction programs can be used.
INVOCATION
FvwmIconBox can be invoked by binding the action 'Module
FvwmIconBox' to a menu or key-stroke in the .fvwmrc file.
Fvwm will search directory specified in the ModulePath
configuration option to attempt to locate FvwmIconBox.
CONFIGURATION OPTIONS
FvwmIconBox shows icons only if NoIcon is applied. Note
that the NoIcon attribute should be set after the Icon
reads the same .fvwmrc file as fvwm reads when it starts
up, and looks for lines as listed below:
*FvwmIconBoxFore color
Tells the module to use color instead of white for
the window foreground. This option affects only the
foreground color of background_bitmap specified in
*FvwmIconBoxPixmap option described below.
*FvwmIconBoxBack color
Tells the module to use color instead of black for
the window background.
*FvwmIconBoxIconFore color
Tells the module to use color instead of black for
non-selected icon text.
*FvwmIconBoxIconBack color
Tells the module to use color instead of white for
the non-selected icon background.
*FvwmIconBoxIconHiFore color
Tells the module to use color instead of black for
selected icon text.
*FvwmIconBoxIconHiBack color
Tells the module to use color instead of white for
the selected icon background.
*FvwmIconBoxPixmap pixmap
Tells the module to use pixmap for the window back-
ground_pixmap.
*FvwmIconBoxFont fontname
Tells the module to use fontname instead of fixed
for text.
*FvwmIconBoxSortIcons option
Tells the module to sort all icons in iconbox in
alphabetical order. option can be WindowName,
IconName, ResClass, and ResName. For example, spec-
ifying ResClass means that icons are sorted by
using their resource-class strings. If option is
ment.
*FvwmIconBoxPadding number
Specifies the number of pixels between icons. The
default value is 5.
*FvwmIconBoxSBWidth number
Specifies the width of horizontal and vertical
scrollbars. The default value is 9.
*FvwmIconBoxPlacement primary secondary
Specifies icon placement policy. primary and sec-
ondary can be Top, Bottom, Left and Right. The fol-
lowing eight combinations are available:
primary secondary
Left Top
Left Bottom
Right Top
Right Bottom
Top Left
Top Right
Bottom Left
Bottom Right
Top: Icons are placed from top to bottom.
Bottom: Icons are placed from bottom to top.
Left: Icons are placed from left to right.
Right: Icons are placed from right to left.
For example, when the placement is "Left Top",
icons are placed from left to right, and new rows
are added from top to bottom. The default vale is
"Left Bottom".
*FvwmIconBoxLines
Specifies the number of icons placed in a line. If
primary is Left or Right, this value specifies the
number of columns. If primary is Top or Bottom,
this value specifies the number of rows. For exam-
ple, seven icons are placed in a row if *FvwmIcon-
BoxLines is 7 and *FvwmIconBoxPlacement is "Left
Top". The default value is 6.
Specifies the undisplayed scroll bar . Direction
can be either Horizontal or Vertical.
*FvwmIconBoxGeometry <width>x<height>{+-}<X>{+-}<Y>
Specifies the location and/or size of FvwmIconBox.
width and height are measured in icons, not pixels.
The default value is 6x1+0+0.
*FvwmIconBoxMaxIconSize <width>x<height>
Specifies the maximum size of icon bitmap. A bitmap
larger than this size is clipped to this size. The
default value is 48x48. In particular, if the
height is 0, then icon bitmaps are not displayed
and only icon labels are drawn.
*FvwmIconBoxMouse Button Action Response[, Response]
Tells the module to do Response when Action is done
on button Button. Available Responsees are built-in
commands in Fvwm (e.g. Iconify, Delete, Focus) and
available Actions are Click and DoubleClick.
*FvwmIconBoxKey Key Response[, Response]
Tells the module to do Response when Key is
pressed. Available Responsees are, besides Fvwm
built-in commands, the following six FvwmIconBox
built-in commands: Next, Prev, Left, Right, Up, and
Down.
Next: Change the hilited-icon to the next.
Prev: Change the hilited-icon to the previous.
Left: Move the slider of the horizontal scrollbar
to left. Icons move to right accordingly.
Right: Move the slider of the horizontal scrollbar
to right. Icons move to left accordingly.
Up: Move the slider of the vertical scrollbar to
up. Icons move to down accordingly.
Down: Move the slider of the vertical scrollbar to
down. Icons move to up accordingly.
*FvwmIconBox windowname bitmap-file
Specifies the bitmap to be displayed in iconbox for
windowname. This option "overrides" bitmap files
name can contain "*" and "?" like Fvwm configura-
tion file. The bitmap-file is either the full
path name to a bitmap file, or a file in the Icon-
Path or PixmapPath. If bitmap-file is specified to
be "-", the icon for a window corresponding to win-
downame is not shown in the iconbox.
*FvwmIconBoxSetWMIconSize
Tells the module to set XA_WM_ICON_SIZE property of
the root window at the size which the module want
icon windows to have. If you show icon windows on
not the root window but the module, it would be
better to specify this option.
*FvwmIconBoxHilightFocusWin
Tells the module to hilight the icon of the window
which has the keyboard focus. The fore/back colors
of the hilighted icon are those specified in the
*FvwmIconBoxIconHiFore and *FvwmIconBoxIconHiBack
commands, respectively.
*FvwmIconBoxResolution resolution
If resolution is Desk, then the module shows only
the icons on the current desk. Currently, Desk is
the only value resolution can take :)
*FvwmIconBoxFrameWidth width1 width2
Specifies the frame-width of the module. Width1
corresponds to the width from the outer-border to
the scroll-bar, and, width2 corresponds to the
width from the scroll-bar to the internal-window
displaying icons. The default values are 8 and 6,
respectively.
SAMPLE CONFIGURATION
The following are excepts from a .fvwmrc file which
describe FvwmIconBox initialization commands:
############################################################
# Note that icons are shown in the module
# only if NoIcon attribute is applied.
Style "*" NoIcon
############################################################
*FvwmIconBoxIconBack #cfcfcf
*FvwmIconBoxIconHiFore black
*FvwmIconBoxIconHiBack LightSkyBlue
*FvwmIconBoxGeometry 5x1+0+0
*FvwmIconBoxMaxIconSize 64x38
*FvwmIconBoxFont -adobe-helvetica-medium-r-*-*-12-*-*-*-*-*-*-*
*FvwmIconBoxSortIcons IconName
#*FvwmIconBoxSortIcons ResClass
*FvwmIconBoxPadding 4
*FvwmIconBoxFrameWidth 9 7
*FvwmIconBoxLines 10
*FvwmIconBoxSBWidth 11
*FvwmIconBoxPlacement Left Top
*FvwmIconBoxPixmap fvwm.xpm
#*FvwmIconBoxHideSC Horizontal
*FvwmIconBoxSetWMIconSize
*FvwmIconBoxHilightFocusWin
#*FvwmIconBoxResolution Desk
#
# mouse bindings
#
*FvwmIconBoxMouse 1 Click RaiseLower
*FvwmIconBoxMouse 1 DoubleClick Iconify
*FvwmIconBoxMouse 2 Click Iconify -1, Focus
*FvwmIconBoxMouse 3 Click Module FvwmIdent
#
# Key bindings
#
*FvwmIconBoxKey r RaiseLower
*FvwmIconBoxKey space Iconify
*FvwmIconBoxKey d Close
#
# FvwmIconBox built-in functions
#
*FvwmIconBoxKey n Next
*FvwmIconBoxKey p Prev
*FvwmIconBoxKey h Left
*FvwmIconBoxKey j Down
*FvwmIconBoxKey k Up
*FvwmIconBoxKey l Right
#
# Icon file specifications
#
# Mostly, you don't have to specify icon files, as FvwmIconBox now
# reads icon files specified in Style commands.
#
*FvwmIconBox "Fvwm*" -
AUTHOR
Nobutaka Suzuki (nobuta-s@is.aist-nara.ac.jp).
Man(1) output converted with
man2html