plugins/README

   1
   2                                 libwmfun
   3
   4                     Copyright (C) 1999 Tobias Gloth
   5                           All Rights Reserved
   6
   7 ------------------------------------------------------------------------
   8
   9 This program is free software; you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation; either version 1, or (at your option)
  12 any later version.
  13
  14 This program is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 ------------------------------------------------------------------------
  20
  21 Welcome to libwmfun!
  22
  23 libwmfun is a library that provides function textures for WindowMaker.
  24 WindowMaker is a popular for the X Window System (for more information,
  25 visit www.windowmaker.org). Due to the implementation of function
  26 textures in WindowMaker, this library must be compiled as a shared
  27 library!
  28
  29 ------------------------------------------------------------------------
  30
  31 Usage: First make sure that your version of WindowMaker does support
  32 function textures. The package is of no use outside of WindowMaker!
  33
  34 Colors are specified in the same was as for WindowMaker in its
  35 configuration file, e.g. in a verbose mode ("blue", "red", ...) or as
  36 triplets of hexadecimal numbers ("rgb:10/20/7f" for a dark blue).
  37
  38 Textures supported so far:
  39
  40 bilinear <color1> <color2> <color3> <color4>
  41
  42   This texture provides a bilinear interpolation of the corner colors.
  43   <color1> is used for the upper left, <color2> for the upper right,
  44   <color3> for the lower left and (you dig it) <color4> for the lower
  45   right corner.
  46
  47 fade [--from <color1>] [--to <color2>]
  48
  49   Vertically fade from <color1> to <color2>. This effect is similar
  50   to vgradient, but the fading is a bit irregular and gives a marble
  51   like impression.
  52
  53 waves [--from <color1>] [--to <color2>] <layers> <frequency>
  54
  55   This effect randomly creates several sine layers and adds their
  56   values. Use the <layers> parameter to specify the number of layers.
  57   The sine layers have randomly chosen frequencies, whose range is
  58   specified in the second parameter. Lower frequencies yield smoother
  59   textures.
  60
  61 ------------------------------------------------------------------------
  62
  63 Examples:
  64
  65   MenuTextBack = (
  66     function, libwmfun.so, fade,
  67     "--from", "rgb:40/60/ff",
  68     "--to", "rgb:ff/ff/ff"
  69   );
  70
  71   IconBack = (
  72     function, libwmfun.so, bilinear,
  73     "rgb:ff/ff/40", "rgb:ff/60/20", "rgb:60/ff/20", "rgb:20/60/ff"
  74   );
  75
  76
  77 Also there is included a small demo style file in the same directory where you
  78 read this file. Its name is WMFun-demo.style. To test how it works, just type:
  79
  80 setstyle WMFun-demo.style
  81