FvwmIconBox(1)

🎀 FvwmIconBox(1) · General Commands Manual 🎀

Okay bestie, this is the manual for FvwmIconBox, the FVWM iconbox module 💖 Let's get into it ✨

✨ NAME ✨

FvwmIconBox - the FVWM iconbox module 🦋

💅 SYNOPSIS 💅

FvwmIconBox is spawned by fvwm, so no command line invocation will work. Don't bother typing it in a terminal, it literally won't work 💀

📖 DESCRIPTION 📖

Main character energy: the FvwmIconBox module is an icon manager 👑 You can do operations like iconify and deiconify on each icon shown in the module, using your mouse and keyboard 🖱️⌨️

FvwmIconBox reads the same .fvwmrc file that fvwm reads when it starts up, and looks for lines like *FvwmIconBoxFore green 🌈

📜 COPYRIGHTS 📜

The FvwmIconBox program is original work of Nobutaka Suzuki 🫶

Copyright 1994, Nobutaka Suzuki. Ngl, no guarantees, warranties, or anything else are provided or implied in any way whatsoever. Use this program at your own risk 😭 You're allowed to use it for any purpose, as long as the copyright stays intact.

🌸 INITIALIZATION 🌸

During initialization, FvwmIconBox will eventually search a configuration file. It's the same file fvwm used during initialization 🧚

Here's the iconic part: if the FvwmIconBox executable is linked to another name, like ln -s FvwmIconBox MoreIconBox, then another module called MoreIconBox can be started with a completely different configuration than FvwmIconBox. You just change 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 the directory specified in the ModulePath configuration option to try to locate FvwmIconBox 🔍

🎀 CONFIGURATION OPTIONS 🎀

FvwmIconBox reads the same .fvwmrc file that fvwm reads when it starts up, and looks for the lines listed below 💜

• *FvwmIconBoxFore color — Tells the module to use color instead of white for the window foreground. This only affects the foreground color of the background_bitmap set by the *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 the iconbox in alphabetical order 🔤
• *FvwmIconBoxPadding number — Sets how many pixels go between icons. The default is 5 ✨
• *FvwmIconBoxPlacement primary secondary — Sets the icon placement policy. primary and secondary can be Top, Bottom, Left, and Right. These 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, with the placement "Left Top", icons go from left to right, and new rows get added from top to bottom 🧁 The default value is "Left Bottom".

• *FvwmIconBoxLines — Sets how many icons get placed in a line. If primary is Left or Right, this is the number of columns. If primary is Top or Bottom, this is the number of rows. For example, seven icons go in a row if *FvwmIconBoxLines is 7 and *FvwmIconBoxPlacement is "Left Top". The default is 6.
• *FvwmIconBoxHideSC direction — Picks which scroll bar stays hidden. direction can be either Horizontal or Vertical.
• *FvwmIconBoxGeometry <width>x<height>{+-}<X>{+-}<Y> — Sets the location and/or size of FvwmIconBox. width and height are measured in icons, not pixels 📐 The default is 6x1+0+0.
• *FvwmIconBoxMaxIconSize <width>x<height> — Sets the maximum size of an icon bitmap. Anything bigger than this gets clipped down to this size. The default is 48x48.
• *FvwmIconBoxMouse Button Action Response[, Response] — Tells the module to run Response when Action happens on mouse button Button. Available Responses are the built-in Fvwm commands (e.g. Iconify, Delete, Focus), and the available Actions are Click and DoubleClick 🖱️
• *FvwmIconBoxKey Key Response[, Response] — Tells the module to run Response when Key is pressed. Available Responses are the Fvwm built-in commands plus the following six FvwmIconBox built-in commands: Next, Prev, Left, Right, Up, and Down ⌨️
  • Next: Changes the hilited icon to the next one.
  • Prev: Changes the hilited icon to the previous one.
  • Left: Moves the slider of the horizontal scrollbar to the left. Icons move to the right accordingly.
  • Right: Moves the slider of the horizontal scrollbar to the right. Icons move to the left accordingly.
  • Up: Moves the slider of the vertical scrollbar up. Icons move down accordingly.
  • Down: Moves the slider of the vertical scrollbar down. Icons move up accordingly.
• *FvwmIconBox windowname bitmap-file — Sets the bitmap displayed in the iconbox for windowname. windowname can be a window name, class name, or resource name, and it can contain * and ? like the Fvwm configuration file does. 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 set to -, the icon for a window matching windowname is not shown in the iconbox 🙈

🧚 SAMPLE CONFIGURATION 🧚

Here are some excerpts from a .fvwmrc file that show the 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) 🌟

---

That's the whole manual, bestie! 🫶 It's from the 3rd Berkeley Distribution, dated Jun 24 1994, and it's FvwmIconBox(1) all the way down 💅🩷