modules/FvwmDragWell/FvwmDragWell.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .TH FvwmDragWell 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
   4 .UC
   5 .SH NAME
   6 FvwmDragWell \- A XDND drag well
   7 .SH SYNOPSIS
   8 \fBFvwmDragWell\fP
   9
  10 FvwmDragWell is a Xdnd drag well.  The user sends the data and type to
  11 the drag well via a fvwm SendToModule command.  The drag well
  12 indicates that it received the information via a crude animation.  The
  13 user may then drag the information from the well to other applications
  14 that support the Xdnd standard.  The fvwm module FvwmWharf accepts
  15 drops of type "text/uri-list".
  16
  17 .SH INITIALIZATION
  18 During initialization, \fIFvwmDragWell\fP gets config info from
  19 \fBfvwm\fP's module configuration database (see
  20 .IR fvwm (1),
  21 section
  22 .BR "MODULE COMMANDS" ).
  23 If the FvwmDragWell executable is linked to another name, i.e. ln -s
  24 FvwmDragWell OtherDragWell, then another module called OtherDragWell
  25 can be started, with a completely different configuration than
  26 FvwmDragWell, simply by changing the keyword FvwmDragWell to
  27 OtherDragWell. This way multiple FvwmDragWell programs may be used.
  28
  29 .SH USE
  30 Data is sent to the module from fvwm using the SendToModule Command.
  31 The form of the send to module command is:
  32 .nf
  33 .sp
  34 SendToModule modulename dragtype type-string, dragdata data
  35 .sp
  36 .fi
  37 type-string is a quoted string that declares the type of
  38 "data" and how the data will be exported.  The "typestring" string is
  39 converted to an XAtom.  The user should use standard Mime type
  40 strings, all in lower case.  Note that the module does no data
  41 conversion.
  42
  43 There is one exception to the above format.  If the datatype string is
  44 omitted, the module assumes that the user is passing a file or
  45 directory path.  In this case, the string "file://$hostname/" is
  46 prepended to the data, and the data is exported as type
  47 "text/uri-list".
  48
  49 Examples:
  50 .nf
  51 .sp
  52 SendToModule FvwmDragWell dragdata /usr/local/libexec/fvwm/2.4.0
  53 .sp
  54 .fi
  55
  56 On hostname saturn, the drag well will convert the data to
  57 "file://saturn/usr/local/libexec/fvwm/2.4.0"
  58 and will export the data as type "text/uri-list".  The long form of
  59 this command would be
  60 .nf
  61 .sp
  62 SendToModule FvwmDragWell dragtype text/uri-list, \\
  63         dragdata file://saturn/usr/local/libexec/fvwm/2.3.8
  64 .sp
  65 .fi
  66
  67 .SH INVOCATION
  68 FvwmDragWell must be invoked from fvwm, so no command line invocation
  69 will work.
  70
  71
  72 .SH CONFIGURATION OPTIONS
  73 FvwmDragWell reads the same .fvwm2rc file as fvwm reads when it starts up,
  74 and looks for certain configuration options:
  75
  76
  77 .IP "*FvwmDragWell: Geometry \fIgeometry\fP"
  78 Completely or partially specifies the Fvwm window location and
  79 geometry, in standard X11 notation. The default size is 48x48.
  80
  81 .IP "*FvwmDragWell: DragWellGeometry \fIgeometry\fP"
  82 Specifies the geometry of the drag box in the FvwmDragWell window, in
  83 the standard X11 notation.  Default is 30x30+9+9
  84
  85
  86 .IP "*FvwmDragWell: Colorset  \fIcolorset\fP"
  87 The colorset is used for the background and shading of the drag well.
  88 See the man page of FvwmTheme for a description of colorsets.
  89
  90 .IP "*FvwmDragWell: Fore \fIColor\fP"
  91 The foreground color.  The default foreground color is grey60.
  92
  93 .IP "*FvwmDragWell: Back \fIColor\fP"
  94 The background color.  The default background color is black.
  95
  96 .IP "*FvwmDragWell: Shadow \fIColor\fP"
  97 The shadow color of the button relief. The default foreground relief
  98 color is grey20.
  99
 100 .IP "*FvwmDragWell: Hilite \fIColor\fP"
 101 The hilight color of the button relief. The default background relief
 102 color is grey90.
 103
 104 .SH BUGS
 105
 106 .SH CREDITS and COPYRIGHTS
 107 The concept for interfacing this module to the Window Manager by Robert Nation.
 108 No guarantees or warranties or anything are provided or implied in any way
 109 whatsoever.  Use this program at your own risk.  Permission to use this
 110 program for any purpose is given, as long as the copyright is kept intact.
 111