modules/FvwmIconBox/FvwmIconBox.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmIconBox 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5 .SH NAME
   6 FvwmIconBox \- the fvwm icon box module
   7 .SH SYNOPSIS
   8 \fBFvwmIconBox\fP [\fIname\fP]
   9
  10 FvwmIconBox is spawned by fvwm, so no command line invocation will work.
  11
  12 .SH DESCRIPTION
  13 The FvwmIconBox module provides an icon manager. The user can do
  14 operations, like iconify and de-iconify, for each icon shown in the
  15 module via mouse and keyboard.
  16
  17 .SH COPYRIGHTS
  18 The FvwmIconBox program is original work of Nobutaka Suzuki.
  19
  20 Copyright 1994, Nobutaka Suzuki. No guarantees or warranties or anything
  21 are provided or implied in any way whatsoever. Use this program at your
  22 own risk. Permission to use this program for any purpose is given,
  23 as long as the copyright is kept intact.
  24
  25
  26 .SH INITIALIZATION
  27 During initialization, \fIFvwmIconBox\fP gets config info from \fBfvwm\fP's
  28 module configuration database (see
  29 .IR fvwm (1),
  30 section
  31 .BR "MODULE COMMANDS" ).
  32
  33 If the FvwmIconBox executable is linked to another name, i.e. ln -s
  34 FvwmIconBox MoreIconBox, then another module called MoreIconBox can be
  35 started, with a completely different configuration than FvwmIconBox,
  36 simply by changing the keyword  FvwmIconBox to MoreIconBox. This way
  37 multiple clutter-reduction programs can be used.
  38
  39 .SH INVOCATION
  40 FvwmIconBox can be invoked by binding the action 'Module
  41 FvwmIconBox' to a menu or key-stroke in the .fvwm2rc file.
  42 Fvwm will search directory specified in the ModulePath configuration
  43 option to attempt to locate FvwmIconBox.
  44
  45 .SH CONFIGURATION OPTIONS
  46 FvwmIconBox shows icons only if NoIcon is applied. Note that the
  47 NoIcon attribute should be set after the Icon attribute specification.
  48 Otherwise the icon-box module might become nothing but an empty-box
  49 module. The module reads the same .fvwm2rc file as fvwm reads when it
  50 starts up, and looks for lines as listed below:
  51
  52 .IP "*FvwmIconBox: Fore \fIcolor\fP"
  53 Tells the module to use \fIcolor\fP instead of white for the window
  54 foreground. This option affects only the foreground color of
  55 background_bitmap specified in *FvwmIconBox: Pixmap option described
  56 below.
  57
  58 .IP "*FvwmIconBox: Colorset \fIcolorset\fP"
  59 Tells the module to use colorset (See FvwmTheme) in place of Fore and
  60 Back.
  61
  62 .IP "*FvwmIconBox: IconColorset \fIcolorset\fP"
  63 Tells the module to use colorset (See FvwmTheme) in place of IconFore
  64 and IconBack.
  65
  66 .IP "*FvwmIconBox: IconHiColorset \fIcolorset\fP"
  67 Tells the module to use colorset (See FvwmTheme) in place of IconHiFore
  68 and IconHiBack.
  69
  70 .IP "*FvwmIconBox: Back \fIcolor\fP"
  71 Tells the module to use \fIcolor\fP instead of black for the window
  72 background.
  73
  74 .IP "*FvwmIconBox: IconFore \fIcolor\fP"
  75 Tells the module to use \fIcolor\fP instead of black for non-selected
  76 icon text.
  77
  78 .IP "*FvwmIconBox: IconBack \fIcolor\fP"
  79 Tells the module to use \fIcolor\fP instead of white for the
  80 non-selected icon background.
  81
  82 .IP "*FvwmIconBox: IconHiFore \fIcolor\fP"
  83 Tells the module to use \fIcolor\fP instead of black for selected icon
  84 text.
  85
  86 .IP "*FvwmIconBox: IconHiBack \fIcolor\fP"
  87 Tells the module to use \fIcolor\fP instead of white for the selected
  88 icon background.
  89
  90 .IP "*FvwmIconBox: Pixmap \fIpixmap\fP"
  91 Tells the module to use \fIpixmap\fP for the window background_pixmap.
  92
  93 .IP "*FvwmIconBox: Font \fIfontname\fP"
  94 Tells the module to use \fIfontname\fP instead of fixed for text.
  95
  96 .IP "*FvwmIconBox: SortIcons \fIoption\fP"
  97 Tells the module to sort all icons in the icon box in alphabetical order.
  98 \fIoption\fP can be \fIWindowName\fP, \fIIconName\fP, \fIResClass\fP,
  99 and \fIResName\fP. For example, specifying \fIResClass\fP means that
 100 icons are sorted by using their resource-class strings. If
 101 \fIoption\fP is \fIResClass\fP or \fIResName\fP, an icon having no
 102 XA_WM_CLASS property is considered to be the "smallest" element.
 103
 104 .IP "*FvwmIconBox: Padding \fInumber\fP"
 105 Specifies the number of pixels between icons. The default value is 5.
 106
 107 .IP "*FvwmIconBox: SBWidth \fInumber\fP"
 108 Specifies the width of horizontal and vertical scrollbars. The default
 109 value is 9.
 110
 111 .IP "*FvwmIconBox: Placement \fIprimary\fP \fIsecondary\fP"
 112 Specifies icon placement policy. \fIprimary\fP and \fIsecondary\fP can
 113 be \fITop\fP, \fIBottom\fP, \fILeft\fP and \fIRight\fP. The following
 114 eight combinations are available:
 115 .nf
 116 .sp
 117 \fIprimary\fP      \fIsecondary\fP
 118
 119  Left         Top
 120  Left         Bottom
 121  Right        Top
 122  Right        Bottom
 123  Top          Left
 124  Top          Right
 125  Bottom       Left
 126  Bottom       Right
 127 .sp
 128 .fi
 129 .B "\fITop\fP:"
 130 Icons are placed from top to bottom.
 131
 132 .B "\fIBottom\fP:"
 133 Icons are placed from bottom to top.
 134
 135 .B "\fILeft\fP:"
 136 Icons are placed from left to right.
 137
 138 .B "\fIRight\fP:"
 139 Icons are placed from right to left.
 140
 141 For example, when the placement is "Left Top", icons are placed from
 142 left to right, and new rows are added from top to bottom. The default
 143 vale is "Left Bottom".
 144
 145 .IP "*FvwmIconBox: UseSkipList"
 146 Tells FvwmIconBox to not show the windows that are listed on a WindowListSkip
 147 line in the configuration file.
 148
 149 .IP "*FvwmIconBox: Lines"
 150 Specifies the number of icons placed in a line. If \fIprimary\fP is
 151 Left or Right, this value specifies the number of columns.
 152 If \fIprimary\fP is Top or Bottom, this value specifies the number of
 153 rows. For example, seven icons are placed in a row if
 154 *FvwmIconBox: Lines is 7 and *FvwmIconBox: Placement is "Left Top".
 155 The default value is 6.
 156
 157 .IP "*FvwmIconBox: HideSC \fIdirection\fP"
 158 Specifies the un-displayed scroll bar . \fIDirection\fP can be
 159 either \fIHorizontal\fP or \fIVertical\fP.
 160
 161 .IP "*FvwmIconBox: Geometry \fI<width>x<height>{+-}<X>{+-}<Y>\fP"
 162 Specifies the location and/or size of FvwmIconBox.
 163 \fIwidth\fP and \fIheight\fP are measured in icons, not pixels.
 164 The default value is 6x1+0+0.
 165
 166 .IP "*FvwmIconBox: MaxIconSize \fI<width>x<height>\fP"
 167 Specifies the maximum size of icon bitmap. A bitmap larger than
 168 this size is clipped to this size. The default value is 48x48. In
 169 particular, if the height is 0, then icon bitmaps are not displayed and
 170 only icon labels are drawn.
 171
 172 .IP "*FvwmIconBox: Mouse \fIButton\fP \fIAction\fP \fIResponse[, Response]\fP"
 173 Tells the module to do \fIResponse\fP when \fIAction\fP is done on
 174 button \fIButton\fP. Available \fIResponse\fPs are built-in commands
 175 in Fvwm (e.g. Iconify, Delete, Focus) and available \fIAction\fPs
 176 are Click and DoubleClick.
 177
 178 .IP "*FvwmIconBox: Key \fIKey\fP \fIResponse[, Response]\fP"
 179 Tells the module to do \fIResponse\fP when \fIKey\fP is pressed.
 180 Available \fIResponse\fPs are, besides Fvwm built-in commands, the
 181 following six FvwmIconBox built-in commands: \fINext\fP, \fIPrev\fP,
 182 \fILeft\fP, \fIRight\fP, \fIUp\fP, and \fIDown\fP.
 183
 184 .B "\fINext\fP:"
 185 Change the hilighted icon to the next.
 186
 187 .B "\fIPrev\fP:"
 188 Change the hilighted icon to the previous.
 189
 190 .B "\fILeft\fP:"
 191 Move the slider of the horizontal scrollbar to left. Icons move
 192 to right accordingly.
 193
 194 .B "\fIRight\fP:"
 195 Move the slider of the horizontal scrollbar to right. Icons move
 196 to left accordingly.
 197
 198 .B "\fIUp\fP:"
 199 Move the slider of the vertical scrollbar to up. Icons move to
 200 down accordingly.
 201
 202 .B "\fIDown\fP:"
 203 Move the slider of the vertical scrollbar to down. Icons move to
 204 up accordingly.
 205
 206 .IP "*FvwmIconBox: \fIwindowname\fP \fIbitmap-file\fP"
 207 Specifies the bitmap to be displayed in the icon box for \fIwindowname\fP.
 208 This option "overrides" bitmap files specified in Style command.
 209 \fIWindowname\fP can be window name, class name, or resource name.
 210 \fIWindowname\fP  can contain "*" and "?" like Fvwm configuration
 211 file. The \fIbitmap-file\fP is either  the full  path name to a bitmap
 212 file, or a file in the ImagePath. If \fIbitmap-file\fP is
 213 specified to be "-", the icon for a window corresponding to
 214 \fIwindowname\fP is not shown in the icon box.
 215
 216 .IP "*FvwmIconBox: SetWMIconSize"
 217 Tells the module to set XA_WM_ICON_SIZE property of the root window
 218 at the size which the module want icon windows to have. If you show
 219 icon windows on not the root window but the module, it would be
 220 better to specify this option.
 221
 222 .IP "*FvwmIconBox: HilightFocusWin"
 223 Tells the module to hilight the icon of the window which has the
 224 keyboard focus. The fore/back colors of the hilighted icon are those
 225 specified in the *FvwmIconBox: IconHiFore and *FvwmIconBox: IconHiBack
 226 commands, respectively.
 227
 228 .IP "*FvwmIconBox: Resolution \fIresolution\fP"
 229 If \fIresolution\fP is Desk, then the module shows only the icons on
 230 the current desk.  Currently, Desk is the only value \fIresolution\fP
 231 can take :)
 232
 233 .IP "*FvwmIconBox: FrameWidth \fIwidth1\fP \fIwidth2\fP"
 234 Specifies the frame-width of the module. \fIWidth1\fP corresponds to
 235 the width from the outer-border to the scroll-bar, and,  \fIwidth2\fP
 236 corresponds to the width from the scroll-bar to the internal-window
 237 displaying icons. The default values are 8 and 6, respectively.
 238
 239 .IP "*FvwmIconBox: NoIconAction \fIaction\fP"
 240 Tells FvwmIconBox to do \fIaction\fP is when a NoIcon style window is
 241 iconified or de-iconified. Relevant coordinates are appended to \fIaction\fP so
 242 that the icon can be traced to an FvwmIconBox button. An example action
 243 is "*FvwmIconBox: NoIconAction SendToModule FvwmAnimate animate". A blank or null
 244 action turns this feature off.
 245
 246 .IP "*FvwmIconBox: NoIconifiedParentheses"
 247 Tells FvwmIconBox to not enclose the title of an iconified window within
 248 parantheses.
 249
 250 .IP "*FvwmIconBox: NormalTitleRelief \fInum\fP"
 251 Sets the width in pixels of the relief that is put around icon titles for
 252 windows that are not iconified. The default if this option is not specified is
 253 2 pixels.
 254
 255 .IP "*FvwmIconBox: IconifiedTitleRelief \fInum\fP"
 256 Sets the width in pixels of the relief that is put around icon titles for
 257 windows that are iconified. The default if this option is not specified is
 258 2 pixels.
 259
 260 .IP "*FvwmIconBox: NormalTitleInvertedRelief"
 261 This option makes the relief around titles of uniconified windows to appear
 262 pressed in. The default is a relief that makes the label look raised from
 263 the background (unless a relief width of 0 pixels is specified, see above).
 264
 265 .IP "*FvwmIconBox: IconifiedTitleInvertedRelief"
 266 This option makes the relief around titles of iconified windows to appear
 267 pressed in.
 268
 269 .SH SAMPLE CONFIGURATION
 270 The following are excepts from a .fvwm2rc file which describe
 271 FvwmIconBox initialization commands:
 272 .nf
 273 .sp
 274 ############################################################
 275 # Note that icons are shown in the module
 276 #    only if NoIcon attribute is applied.
 277 Style   "*"     NoIcon
 278
 279 ############################################################
 280 *FvwmIconBox: IconBack    #cfcfcf
 281 *FvwmIconBox: IconHiFore  black
 282 *FvwmIconBox: IconHiBack  LightSkyBlue
 283 *FvwmIconBox: Back        #5f9ea0
 284 #*FvwmIconBox: Fore       blue
 285 *FvwmIconBox: Geometry    5x1+0+0
 286 *FvwmIconBox: MaxIconSize 64x38
 287 *FvwmIconBox: Font        -adobe-helvetica-medium-r-*-*-12-*-*-*-*-*-*-*
 288 *FvwmIconBox: SortIcons   IconName
 289 #*FvwmIconBox: SortIcons  ResClass
 290 *FvwmIconBox: Padding     4
 291 *FvwmIconBox: FrameWidth  9 7
 292 *FvwmIconBox: Lines       10
 293 *FvwmIconBox: SBWidth     11
 294 *FvwmIconBox: Placement   Left Top
 295 *FvwmIconBox: Pixmap      fvwm.xpm
 296 #*FvwmIconBox: HideSC     Horizontal
 297 *FvwmIconBox: SetWMIconSize
 298 *FvwmIconBox: HilightFocusWin
 299 #*FvwmIconBox: Resolution Desk
 300
 301 *FvwmIconBox: NoIconAction SendToModule FvwmAnimate animate
 302
 303 #
 304 # mouse bindings
 305 #
 306 *FvwmIconBox: Mouse       1       Click           RaiseLower
 307 *FvwmIconBox: Mouse       1       DoubleClick     Iconify
 308 *FvwmIconBox: Mouse       2       Click           Iconify -1, Focus
 309 *FvwmIconBox: Mouse       3       Click           Module FvwmIdent
 310 #
 311 # Key bindings
 312 #
 313 *FvwmIconBox: Key         r       RaiseLower
 314 *FvwmIconBox: Key         space   Iconify
 315 *FvwmIconBox: Key         d       Close
 316 #
 317 # FvwmIconBox built-in functions
 318 #
 319 *FvwmIconBox: Key         n       Next
 320 *FvwmIconBox: Key         p       Prev
 321 *FvwmIconBox: Key         h       Left
 322 *FvwmIconBox: Key         j       Down
 323 *FvwmIconBox: Key         k       Up
 324 *FvwmIconBox: Key         l       Right
 325 #
 326 # Icon file specifications
 327 #
 328 # Mostly, you don't have to specify icon files, as FvwmIconBox now
 329 # reads icon files specified in Style commands.
 330 #
 331 *FvwmIconBox:  "Fvwm*"  -
 332 .sp
 333 .fi
 334
 335 .SH AUTHOR
 336 Nobutaka Suzuki (nobuta-s@is.aist-nara.ac.jp).
 337