modules/FvwmWharf/FvwmWharf.1.in

   1 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   2 .TH FvwmWharf 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   3 .UC
   4 .SH NAME
   5 FvwmWharf \- the AfterStep application "dock" module ported to
   6 Fvwm.
   7 .SH SYNOPSIS
   8 FvwmWharf is spawned by Fvwm, so no command line invocation will work.
   9
  10 .SH DESCRIPTION
  11 The FvwmWharf module is a free-floating application loader that can
  12 execute programs, "Swallow" running programs, and contain "Folders" of
  13 more applications, among other things.  The user can press the first
  14 button at any time to trigger invocation of one of these functions, or
  15 the user can press button two in order to cause the entire Wharf
  16 to withdraw to the nearest corner in an iconified state.  FvwmWharf only
  17 works when fvwm is used as the window manager.
  18
  19 .SH COPYRIGHTS
  20 The FvwmWharf module is copyright 1995 and 1996 by a variety of contributors.
  21 They are, in alphabetical order, Beat Christen, Frank Fejes, Alfredo
  22 Kenji Kojima, Dan Weeks, and Bo Yang
  23
  24 The GoodStuff program, and the concept for
  25 interfacing this module to the Window Manager, are all original work
  26 by Robert Nation
  27
  28 No guarantees or warranties or anything
  29 are provided or implied in any way whatsoever. Use this program at your
  30 own risk. Permission to use this program for any purpose is given,
  31 as long as the copyright is kept intact.
  32
  33
  34 .SH INITIALIZATION
  35 During initialization, \fIFvwmWharf\fP gets config info from \fBfvwm\fP's
  36 module configuration database (see
  37 .IR fvwm (1),
  38 section
  39 .BR "MODULE COMMANDS" )
  40 to obtain a description of button panel geometry, color, icons, and
  41 actions.
  42
  43 If the FvwmWharf executable is linked to another name, ie ln -s
  44 FvwmWharf Pier, then another module called Pier can be
  45 started, with a completely different configuration than FvwmWharf,
  46 simply by changing the keywords FvwmWharf... to Pier.... This way multiple
  47 button-bars can be used.
  48
  49 .SH INVOCATION
  50 FvwmWharf should be invoked in the same way as other
  51 fvwm modules.
  52
  53 .SH CONFIGURATION OPTIONS
  54 .IP "*FvwmWharfAnimate"
  55 If specified, the opening and closing of Folders will be animated,
  56 rather than simply drawn in one frame.
  57
  58 .IP "*FvwmWharfAnimateMain"
  59 Designates that full-length Wharf windows will be animated.
  60
  61 .IP "*FvwmWharfBgColor \fIcolor\fP"
  62 If \fI*FvwmWharfTextureType 0\fP is specified, \fIFvwmWharf\fP's buttons
  63 will be filled with \fIcolor\fP.
  64
  65 .IP "*FvwmWharfColorset \fIcolorset\fP"
  66 Tells the module to use colorset \fIcolorset\fP for the background
  67 of all buttons.  This option disables the options 'BgColor', 'TextureType'
  68 and 'TextureColor' if specified after these and is
  69 disabled by them if used before any of them in the configuration.
  70 Please refer to the man page of the FvwmTheme module for details
  71 about colorsets.
  72
  73 .IP "*FvwmWharfColumns \fIcolumns\fP"
  74 Specifies the number of columns of buttons to be created. If unspecified,
  75 the number of columns will be set to 1.
  76 If the columns are set to a number greater than 1 then there will be
  77 that number
  78 of columns with enough rows to satisfy the requested number of buttons.
  79
  80 .IP "*FvwmWharfForceSize"
  81 If specified, will force pixmaps larger than 64x64 to the default
  82 size.  Pixmaps smaller than 64x64 are not supported.
  83
  84 .IP "*FvwmWharfFullPush"
  85 If specified, the entire FvwmWharf button background will be moved down
  86 and to the right when pushed.  Especially useful with *FvwmWharfNoBorder
  87 textures.
  88
  89 .IP "*FvwmWharfGeometry \fIgeometry\fP"
  90 Specifies the FvwmWharf window location and/or size. If the size is
  91 not specified, FvwmWharf will auto-size itself in a reasonable manner.
  92 The geometry is a standard X11 window geometry specification.  This option is
  93 pre-set in the Nextstep(tm) style section for a consistent look and
  94 feel with NEXTSTEP(tm). Secondary FvwmWharf invocations from links
  95 may have their own geometry.
  96
  97 .IP "*FvwmWharfMaxColors \fInumber\fP"
  98 Specifies the maximum \fInumber\fP of colors to use on a gradient
  99 fill.
 100
 101 .IP "*FvwmWharfNoBorder"
 102 Denotes that beveled borders should not be drawn around the FvwmWharf button.
 103 Useful with textures that include their own bevels.
 104
 105 .IP "*FvwmWharfPixmap \fIpixmap\fP"
 106 Sets the pixmap file to be used as \fIFvwmWharf\fP's button.  To be used
 107 with \fI*FvwmWharfTextureType 128\fP.
 108
 109 .IP "*FvwmWharfTextureColor \fIfrom\fP \fIto\fP"
 110 When used with a \fI*FvwmWharfTextureType\fP of 1 to 5, designates the
 111 ends of the gradient range to be used on \fIFvwmWharf\fP's buttons.
 112
 113 .IP "*FvwmWharfTextureType  \fItype\fP"
 114 Specifies the type of gradient fill to be used on
 115 \fIFvwmWharf\fP's buttons.  Valid values are:
 116 .nf
 117 0 - No texture - use \fIFvwmWharfBgColor\fP to set the desired color
 118 1 - Gradient from upper-left to lower right
 119 2 - Horizontal one way gradient from top to bottom
 120 3 - Horizontal cylindrical gradient from top/bottom to center
 121 4 - Vertical one way gradient from left to right
 122 5 - Vertical cylindrical gradient from left/right to center
 123 128 - User specified pixmap
 124 .fi
 125 The default is the builtin \fIFvwmWharf\fP texture pixmap.
 126
 127 .IP "*FvwmWharf \fIlabel icon command\fP"
 128 Specifies a window manager built-in command or folder to activate
 129 (folders will be discussed below), as described in the Fvwm
 130 man page, which should be executed when a button is pressed. The label
 131 field is an internal item that is still around from the GoodStuff module.
 132 The icon field
 133 specifies an X11 bitmap file, XPM color icon file, or a comma-delimited
 134 set of pixmaps containing the
 135 icon(s) to display on the button. FvwmWharf will search through the path
 136 specified in the ImagePath configuration item to
 137 find the icon file.
 138
 139 NOTE: Icons must have one transparent pixel or the definition of
 140 a transparent color in order to be valid.
 141
 142 If \fIcommand\fP is an fvwm Exec command, then the button will
 143 appear pushed in until the mouse button is released.
 144
 145 A single extension to the fvwm built-in command set is provided.
 146 A command of the form:
 147 .nf
 148 .sp
 149 *FvwmWharf junk clock.xpm Swallow "Clock" asclock -shape -12
 150 .sp
 151 .fi
 152 will cause FvwmWharf to spawn an asclock process, and capture
 153 the first window whose name or resource is "Clock", and display it in
 154 the button-bar. This is handy for applications like xclock, xbiff,
 155 xload, asclock, and asmail.
 156
 157 Modules can be swallowed by specifying the word Module:
 158 .nf
 159 .sp
 160 *FvwmWharf pager nil Swallow "Desktop" Module FvwmPager 0 0
 161 .sp
 162 .fi
 163 NOTE: if you use xclock for this application, you will want
 164 to specify xclock -padding 0.
 165
 166 .I Swallow
 167 option tries to force an application to be 48 by 48 pixels.
 168 A special option
 169 .I MaxSwallow
 170 can be used to leave an application at its own size (but less then 64x64).
 171 MaxSwallow is invoked the same way Swallow is. If you want an application
 172 to fill all the button place, you should start it with a proper geometry flag,
 173 like "xload -g 64x64" or, if you want to leave a 3d-look: "xload -g 60x60".
 174
 175 Note, not all applications are good for swallowing, some can't be
 176 resized at all, some can't be resized exactly to 48x48 or 64x64,
 177 you are responsible for choosing suitable applications to be swallowed.
 178
 179 To create folder "slide-outs" in
 180 .B FvwmWharf
 181 the following format must be used:
 182 .nf
 183 .sp
 184 *FvwmWharf files Folders.xpm Folder
 185 *FvwmWharf xftp 3DRings.xpm     Exec xftp
 186 *FvwmWharf xdir FolderDeposit.xpm Exec xdir
 187 *FvwmWharf moxfm FilingCabinet.xpm Exec moxfm
 188 *FvwmWharf ~Folders
 189 .sp
 190 .fi
 191 The first line of this set tells FvwmWharf that this button definition
 192 will be a folder.  All of the button definitions between the
 193 .I Folder
 194 and the line with the definition of
 195 .I *FvwmWharf ~Folders
 196 will appear on the "files" folder when it is exposed.  To expose the "files"
 197 folder simply click on the FvwmWharf button with the Folders.xpm icon
 198 showing.  A button bar will appear perpendicular to your FvwmWharf bar
 199 and toward the center of the screen.  On this smaller bar will be the
 200 three icons that were configured between the
 201 .I Folder
 202 and
 203 .I ~Folder
 204 parts of the FvwmWharf configuration.  As many folder buttons may be configured as
 205 is room on your screen.  The only items that may not be configured within
 206 folders are Swallowed applications and more folders.
 207
 208 .SH DRAG AND DROP
 209 \fIFvwmWharf\fP supports the OffiX Drag and Drop standard.  In order to
 210 have Drag and Drop enabled on a particular button, the following syntax
 211 must be adhered to:
 212 .nf
 213 .sp
 214 *FvwmWharf nil nil DropExec "\fIprogram\fP" \fIprogram\fP %s
 215 *FvwmWharf \fIprogram\fP \fIiconname\fP Exec "\fIprogram\fP" \fIprogram\fP
 216 .sp
 217 .fi
 218
 219 The button will call \fIprogram\fP when pushed.  If a file is dragged
 220 onto into it, \fIprogram\fP will be called with %s being replaced by
 221 the dropped filename.
 222
 223 .SH AUTHORS
 224 .nf
 225 Beat Christen (bchriste@iiic.ethz.ch)
 226 Frank Fejes (frank@ssax.com)
 227 Alfredo Kengi Kojima (kojima@inf.ufrgs.br)
 228 Dan Weeks (dan@mango.sfasu.edu)
 229 Bo Yang (eric@coeus.ucsd.edu)
 230 .fi