wmcliphist/README

   1 Copying
   2 -------
   3
   4 This program is free software; you can redistribute it and/or modify it
   5 under the terms of the GNU General Public License as published by the
   6 Free Software Foundation; either version 2 of the License, or (at your
   7 option) any later version.
   8
   9
  10 What is it?
  11 -----------
  12
  13 In short, it is clipboard history dockable application for Window Maker
  14 (and maybe AfterStep with some little modifications - not tested).
  15 wmcliphist keeps history of clipboard operations and allows you to put
  16 previously copied items back to clipboard for pasting to other
  17 applications. I wrote wmcliphist because there was no such application
  18 suitable for usage in Window Maker and I was confused to run number of
  19 KDE daemons for Klipper (which was the inspiration).
  20
  21
  22 Features
  23 --------
  24
  25   * selectable number of items to keep
  26   * detachable (tear off) menu with clipboard history
  27   * possibility to lock item (locked items will not be overriden by new
  28     clipboard operations). To lock item press right mouse button on it.
  29   * saves history to file on exit (and loads it on start, of course :),
  30     periodicaly and/or on request
  31   * can handle binary data
  32   * configurable hotkey support (pop up menu at mouse cursor position)
  33   * regular expression driven actions (ignore/submenu/exec)
  34   * possibility to lock clipboard (new selections will not replace the
  35     current one and it could not be stored in history too)
  36
  37
  38 Instalation
  39 -----------
  40
  41 wmcliphist requires gtk+ and glib (fully tested only with 1.2.8 and
  42 1.2.10, but probably will work with any 1.2.x version) and foodock
  43 library for writing dockable applications based on gtk+ (included).
  44 Hopefuly you'll only need to run
  45
  46 make all install
  47
  48 to compile and install wmcliphist. Note that you have to be root to
  49 install program to /usr/local/bin (default). If it fails, check, that
  50 you have installed gtk+, gtk+-devel, glib and glib-devel packages, make
  51 and compiler (gcc). If it still fails, try to upgrade to up to date
  52 versions of libraries listed above (see www.gtk.org).
  53 wmcliphist was tested only on Linux (Red Hat Linux 7.2, kernel 2.4.9,
  54 gcc 2.96), but it should compile and run on other un*x systems too.
  55 After installing binary you can create your configuration file in
  56 ~/.wmcliphistrc (sample config file wmcliphistrc is included in
  57 distribution archive).
  58
  59 Upgrading
  60
  61 Please note, that upgrade from version 0.1 will delete your old history!
  62 If you are upgrading from version 0.2 to 0.3, move your ~/.wmcliphistrc
  63 to ~/.wmcliphist.data and create new ~/.wmcliphistrc with configuration
  64 (sample config file is included).
  65
  66
  67 Usage
  68 -----
  69
  70 wmcliphist accepts followinf options:
  71
  72 -h         show help
  73 -n <num>   set number of items to keep (default 10)
  74 -c color   set color for locked items (default is red)
  75 -s <size>  choose wmcliphist icon size:
  76            16 = tiny 16x16 px icon
  77            30 = icon suitable for 32px dock/slit
  78            40 = icon suitable for 48px dock/slit
  79            60 = icon suitable for 64px dock/slit (default)
  80 -i <num>   choose wmcliphist icon antialiasing:
  81            0 = for mid tones background (default)
  82            1 = for dark background
  83            2 = for light background
  84
  85 Example:
  86
  87 /usr/local/bin/wmcliphist -n 15 -c darkgreen
  88
  89 Some of theese options and many others can be set in ~/.wmcliphistrc too.
  90
  91 Left click on icon opens menu with history and right click opens
  92 application menu. Right click on history menu item will lock it.
  93 History menu can be opened at mouse cursor position with configurable
  94 hotkey too.
  95
  96
  97 ToDo
  98 ----
  99
 100   * Maybe some configuration GUI? Who knows...
 101   * Separated history queues
 102
 103
 104 Credits
 105 -------
 106
 107 Michal Krause <michal (at) krause (dot) cz>
 108 Daniel Richard G. <skunk (at) iskunk (dot) org> (icon set used from version 0.5)
 109 Michael Beattie (new exec action handling in 0.6)
 110 Vadim O. Ustiansky (some improvements in 0.7)
 111
 112
 113 Special thanx
 114 -------------
 115
 116 Alexey Vyskubov, <alexey@pepper.spb.ru>
 117 foodock library
 118
 119 <mdem@chat.ru>
 120 Downloader for X, from which I took inspiration for clipboard
 121 monitoring. BTW, it's great peace of software, try it.
 122
 123
 124 Download
 125 --------
 126
 127 http://linux.nawebu.cz/wmcliphist/
 128
 129
 130 Apology
 131 -------
 132
 133 I'd like to apologize to all English speaking people for mangling of
 134 their mother tongue :)