1FvwmWharf(1)                     Fvwm Modules                     FvwmWharf(1)
2
3
4

NAME

6       FvwmWharf - the AfterStep application "dock" module ported to Fvwm.
7

SYNOPSIS

9       FvwmWharf is spawned by Fvwm, so no command line invocation will work.
10
11

DESCRIPTION

13       The  FvwmWharf  module  is  a free-floating application loader that can
14       execute programs, "Swallow" running programs, and contain "Folders"  of
15       more  applications,  among  other things.  The user can press the first
16       button at any time to trigger invocation of one of these functions,  or
17       the  user  can  press  button two in order to cause the entire Wharf to
18       withdraw to the nearest corner in an iconified state.   FvwmWharf  only
19       works when fvwm is used as the window manager.
20
21

COPYRIGHTS

23       The  FvwmWharf  module  is copyright 1995 and 1996 by a variety of con‐
24       tributors.  They are,  in  alphabetical  order,  Beat  Christen,  Frank
25       Fejes, Alfredo Kenji Kojima, Dan Weeks, and Bo Yang
26
27       The  GoodStuff  program, and the concept for interfacing this module to
28       the Window Manager, are all original work by Robert Nation
29
30       No guarantees or warranties or anything are provided or implied in  any
31       way  whatsoever.  Use  this program at your own risk. Permission to use
32       this program for any purpose is given, as long as the copyright is kept
33       intact.
34
35
36

INITIALIZATION

38       During  initialization,  FvwmWharf  gets config info from fvwm's module
39       configuration database (see fvwm(1), section MODULE COMMANDS) to obtain
40       a description of button panel geometry, color, icons, and actions.
41
42       If  the  FvwmWharf  executable  is  linked  to  another  name, ie ln -s
43       FvwmWharf Pier, then another module called Pier can be started, with  a
44       completely  different  configuration than FvwmWharf, simply by changing
45       the keywords FvwmWharf... to Pier.... This way multiple button-bars can
46       be used.
47
48

INVOCATION

50       FvwmWharf should be invoked in the same way as other fvwm modules.
51
52

CONFIGURATION OPTIONS

54       *FvwmWharfAnimate
55              If  specified,  the  opening and closing of Folders will be ani‐
56              mated, rather than simply drawn in one frame.
57
58
59       *FvwmWharfAnimateMain
60              Designates that full-length Wharf windows will be animated.
61
62
63       *FvwmWharfBgColor color
64              If *FvwmWharfTextureType 0  is  specified,  FvwmWharf's  buttons
65              will be filled with color.
66
67
68       *FvwmWharfColorset colorset
69              Tells  the module to use colorset colorset for the background of
70              all buttons.  This option disables the options 'BgColor',  'Tex‐
71              tureType'  and  'TextureColor'  if  specified after these and is
72              disabled by them if used before any of them  in  the  configura‐
73              tion.   Please refer to the man page of the FvwmTheme module for
74              details about colorsets.
75
76
77       *FvwmWharfColumns columns
78              Specifies the number of columns of buttons  to  be  created.  If
79              unspecified,  the  number  of  columns will be set to 1.  If the
80              columns are set to a number greater than 1 then  there  will  be
81              that number of columns with enough rows to satisfy the requested
82              number of buttons.
83
84
85       *FvwmWharfForceSize
86              If specified, will  force  pixmaps  larger  than  64x64  to  the
87              default size.  Pixmaps smaller than 64x64 are not supported.
88
89
90       *FvwmWharfFullPush
91              If  specified,  the  entire  FvwmWharf button background will be
92              moved down and to the right when pushed.  Especially useful with
93              *FvwmWharfNoBorder textures.
94
95
96       *FvwmWharfGeometry geometry
97              Specifies the FvwmWharf window location and/or size. If the size
98              is not specified, FvwmWharf will auto-size itself in  a  reason‐
99              able  manner.   The  geometry  is a standard X11 window geometry
100              specification.  This option is pre-set in the Nextstep(tm) style
101              section  for  a consistent look and feel with NEXTSTEP(tm). Sec‐
102              ondary FvwmWharf invocations from links may have their own geom‐
103              etry.
104
105
106       *FvwmWharfMaxColors number
107              Specifies  the  maximum  number  of  colors to use on a gradient
108              fill.
109
110
111       *FvwmWharfNoBorder
112              Denotes that beveled borders should  not  be  drawn  around  the
113              FvwmWharf  button.   Useful with textures that include their own
114              bevels.
115
116
117       *FvwmWharfPixmap pixmap
118              Sets the pixmap file to be used as FvwmWharf's  button.   To  be
119              used with *FvwmWharfTextureType 128.
120
121
122       *FvwmWharfTextureColor from to
123              When used with a *FvwmWharfTextureType of 1 to 5, designates the
124              ends of the gradient range to be used on FvwmWharf's buttons.
125
126
127       *FvwmWharfTextureType  type
128              Specifies the type of gradient fill to be  used  on  FvwmWharf's
129              buttons.  Valid values are:
130              0 - No texture - use FvwmWharfBgColor to set the desired color
131              1 - Gradient from upper-left to lower right
132              2 - Horizontal one way gradient from top to bottom
133              3 - Horizontal cylindrical gradient from top/bottom to center
134              4 - Vertical one way gradient from left to right
135              5 - Vertical cylindrical gradient from left/right to center
136              128 - User specified pixmap
137              The default is the builtin FvwmWharf texture pixmap.
138
139
140       *FvwmWharf label icon command
141              Specifies  a  window manager built-in command or folder to acti‐
142              vate (folders will be discussed below), as described in the Fvwm
143              man page, which should be executed when a button is pressed. The
144              label field is an internal item that is still  around  from  the
145              GoodStuff  module.  The icon field specifies an X11 bitmap file,
146              XPM color icon file, or a comma-delimited set  of  pixmaps  con‐
147              taining  the  icon(s)  to  display on the button. FvwmWharf will
148              search through the path specified in the ImagePath configuration
149              item to find the icon file.
150
151              NOTE: Icons must have one transparent pixel or the definition of
152              a transparent color in order to be valid.
153
154              If command is an fvwm Exec command, then the button will  appear
155              pushed in until the mouse button is released.
156
157              A single extension to the fvwm built-in command set is provided.
158              A command of the form:
159
160              *FvwmWharf junk clock.xpm Swallow "Clock" asclock -shape -12
161
162              will cause FvwmWharf to spawn an asclock  process,  and  capture
163              the  first window whose name or resource is "Clock", and display
164              it in the  button-bar.  This  is  handy  for  applications  like
165              xclock, xbiff, xload, asclock, and asmail.
166
167              Modules can be swallowed by specifying the word Module:
168
169              *FvwmWharf pager nil Swallow "Desktop" Module FvwmPager 0 0
170
171              NOTE:  if  you use xclock for this application, you will want to
172              specify xclock -padding 0.
173
174              Swallow option tries to force an application to be 48 by 48 pix‐
175              els.  A special option MaxSwallow can be used to leave an appli‐
176              cation at its own size (but less  then  64x64).   MaxSwallow  is
177              invoked  the  same way Swallow is. If you want an application to
178              fill all the button place, you should start  it  with  a  proper
179              geometry  flag, like "xload -g 64x64" or, if you want to leave a
180              3d-look: "xload -g 60x60".
181
182              Note, not all applications are good for swallowing,  some  can't
183              be  resized  at  all,  some can't be resized exactly to 48x48 or
184              64x64, you are responsible for choosing suitable applications to
185              be swallowed.
186
187              To  create folder "slide-outs" in FvwmWharf the following format
188              must be used:
189
190              *FvwmWharf files Folders.xpm Folder
191              *FvwmWharf xftp 3DRings.xpm   Exec xftp
192              *FvwmWharf xdir FolderDeposit.xpm Exec xdir
193              *FvwmWharf moxfm FilingCabinet.xpm Exec moxfm
194              *FvwmWharf ~Folders
195
196              The first line of this set tells FvwmWharf that this button def‐
197              inition will be a folder.  All of the button definitions between
198              the Folder and the line with the definition of *FvwmWharf ~Fold‐
199              ers  will  appear  on the "files" folder when it is exposed.  To
200              expose the "files" folder simply click on the  FvwmWharf  button
201              with  the  Folders.xpm  icon  showing.  A button bar will appear
202              perpendicular to your FvwmWharf bar and toward the center of the
203              screen.   On  this smaller bar will be the three icons that were
204              configured between the Folder and ~Folder parts of the FvwmWharf
205              configuration.   As  many folder buttons may be configured as is
206              room on your screen.  The only items that may not be  configured
207              within folders are Swallowed applications and more folders.
208
209

DRAG AND DROP

211       FvwmWharf  supports the OffiX Drag and Drop standard.  In order to have
212       Drag and Drop enabled on a particular button, the following syntax must
213       be adhered to:
214
215       *FvwmWharf nil nil DropExec "program" program %s
216       *FvwmWharf program iconname Exec "program" program
217
218
219       The  button  will  call program when pushed.  If a file is dragged onto
220       into it, program will be called with %s being replaced by  the  dropped
221       filename.
222
223

AUTHORS

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
231
232
2333rd Berkeley Distribution    09 May 2010 (2.5.30)                 FvwmWharf(1)
Impressum