skippy/README

   1 Requirements and limitations
   2 ----------------------------
   3 Skippy depends on:
   4
   5     * An X11R6 server
   6     * Xft - the X Font library Imlib2
   7     * A NETWM or GNOME WM Specs compliant window-manager.
   8
   9 So far, it's been sucessfully tested using OpenBox-3.2, Fluxbox-0.9.9
  10 (thanks daelstorm!), XFWM4 (thanks SeeSchloss!), Metacity (thanks
  11 SmackleFunky!), WindowMaker (thanks SuperBFG7), IceWM (thanks Tomasz
  12 Torcz), PekWM (thanks Josh Chaney), Waimea (thanks Gad
  13 'make-up-your-mind' Kadosh) and KWin (no, BlackBox and ion aren't
  14 supported).
  15
  16 Note: if you want to use skippy with WindowMaker, make sure WindowMaker
  17 is compiled with gnome support.
  18
  19 Another note: If you use KDE, Skippy might have trouble grabbing the F11
  20 key. You can make it bind to a different key in the config file (see the
  21 skippyrc-default file that's in the tarball). Scroll_Lock is reported to
  22 work (thanks Dmitriy!).
  23
  24 Because of the way standard X11 works, Skippy has to raise all windows
  25 before it can take a snapshot. If there's something that obscures the
  26 window (like a window in a layer above it), Skippy won't be able to make
  27 a snapshot correctly.
  28
  29 Usage
  30 -----
  31 Skippy is pretty easy to use. Just compile (and optionally
  32 install) it, and press the hotkey (the default hotkey is F11). Then
  33 choose a window with either the keyboard (you can use up, down, left and
  34 right to navigate) or the mouse (just hover over a window) and activate
  35 it by pressing the left mouse button or the return or spacebar key.
  36
  37 There are also two or three modifiers you can use with the hotkey: hold
  38 Control and Skippy will update the snapshots of all the windows. Hold
  39 Mod1 (aka the alt key) and skippy will only show the windows of the
  40 currently focused window's window group (like, all of gimp's windows, or
  41 all of kopete's windows), and if Skippy is compiled with Xinerama
  42 support and you have several heads, hold shift while pressing the hotkey
  43 to make it show the windows on all heads.