--- name: "FvwmIconBox1" section: "1" platform: "linux" package: "fvwm1" version: "1.24r-57+b1" release: "Debian 12 (Bookworm)" platforms: ["linux"] url: "https://new.carta.tech/FvwmIconBox1" --- # FvwmIconBox1(1) the FVWM iconbox module ## NAME FvwmIconBox - the FVWM iconbox module ## SYNOPSIS FvwmIconBox is spawned by fvwm, so no command line invocation 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 "\*FvwmIconBoxFore green". ## COPYRIGHTS The FvwmIconBox program is original work of Nobutaka Suzuki. Copyright 1994, Nobutaka Suzuki. No guarantees or warranties 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 different 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 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 background\_pixmap. - \*FvwmIconBoxFont *fontname* Tells the module to use *fontname* instead of fixed for text. - \*FvwmIconBoxSortIcons Tells the module to sort all icons in iconbox in alphabetical order. - \*FvwmIconBoxPadding *number* Specifies the number of pixels between icons. The default value is 5. - \*FvwmIconBoxPlacement *primary* *secondary* Specifies icon placement policy. *primary* and *secondary* can be *Top*, *Bottom*, *Left* and *Right*. The following 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 example, seven icons are placed in a row if \*FvwmIconBoxLines is 7 and \*FvwmIconBoxPlacement is "Left Top". The default value is 6. - \*FvwmIconBoxHideSC *direction* Specifies the undisplayed scroll bar . *Direction* can be either *Horizontal* or *Vertical*. - \*FvwmIconBoxGeometry *\x\{+-}\{+-}\* 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 *\x\* Specifies the maximum size of icon bitmap. A bitmap larger than this size is clipped to this size. The default value is 48x48. - \*FvwmIconBoxMouse *Button* *Action* *Response\[, Response\]* Tells the module to do *Responce* when *Action* is done on button *Button*. Available *Response*es are built-in commands in Fvwm (e.g. Iconify, Delete, Focus) and available *Action*s are Click and DoubleClick. - \*FvwmIconBoxKey *Key* *Response\[, Response\]* Tells the module to do *Response* when *Key* is pressed. Available *Responce*es 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*. *Windowname* can be window name, class name, or resource name. *Windowname* can contain "\*" and "?" like Fvwm configuration file. The *bitmap-file* is either the full path name to a bitmap file, or a file in the IconPath or PixmapPath. If *bitmap-file* is specefied to be "-", the icon for a window corresponding to *windowname* is not shown in the iconbox. ## SAMPLE CONFIGURATION The following are excepts from a .fvwmrc file which describe FvwmIconBox initialization commands: ``` ############################################################ # Make no icon to be shown in root window # by spcifying in your .fvwmrc # (1) "SuppressIcons" if PRUNE is defined in configure.h, or # (2) "Style "*" NoIcon" if PRUNE is defined. #SuppressIcons Style "*" NoIcon ############################################################ *FvwmIconBoxIconBack #cfcfcf *FvwmIconBoxIconHiFore black *FvwmIconBoxIconHiBack LightSkyBlue *FvwmIconBoxBack #5f9ea0 #*FvwmIconBoxFore blue *FvwmIconBoxGeometry 5x1+0+0 *FvwmIconBoxMaxIconSize 64x38 *FvwmIconBoxFont -adobe-helvetica-medium-r-*-*-12-*-*-*-*-*-*-* *FvwmIconBoxSortIcons *FvwmIconBoxPadding 4 *FvwmIconBoxLines 10 *FvwmIconBoxPlacement Left Top *FvwmIconBoxPixmap fvwm.xpm #*FvwmIconBoxHideSC Horizontal # # mouse bindings # *FvwmIconBoxMouse 1 Click RaiseLower *FvwmIconBoxMouse 1 DoubleClick Iconify *FvwmIconBoxMouse 2 Click Iconify -1, Focus *FvwmIconBoxMouse 3 Click Module "FvwmIdent" 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 spcifications # *FvwmIconBox "*" unknown1.xpm *FvwmIconBox "Fvwm*" - *FvwmIconBox "FvwmFileMgr" folder2.xpm *FvwmIconBox "rxvt" term.xpm *FvwmIconBox "xterm" xterm.xpm *FvwmIconBox "editres" editres.xpm *FvwmIconBox "xman" xman.xpm *FvwmIconBox "xbiff" mail1.xpm *FvwmIconBox "xmh" mail1.xpm *FvwmIconBox "xcalc" xcalc.xpm *FvwmIconBox "GoodStuff" toolbox.xpm ``` ## AUTHOR Nobutaka Suzuki (nobuta-s@is.aist-nara.ac.jp).