Fresh Fish 8/FreshFishVol8-CD1.bin/new/util/cdity/cliphistory/cliphistory.man

Text File | 1994-10-31 | 41KB | 1,023 lines

   This file describes ClipHistory, version 2.2, a program that adds
a history to the clipboard.

Introduction
************

   This is a program that I thought about writing for a long time (a
year or so! :) before I actually implemented it. I first got the idea
when I had used the history feature of PowerSnap (by Nico François)
a little while. I soon realised that it was a very convenient feature.

   The problem is that other programs uses the clipboard as well. The
history PowerSnap maintains only applies to the text that
PowerSnap writes to the clipboard, not the ones e.g. my editor
writes. And I thought that it would indeed be useful to have them in a
history too.

   One problem with such a history is that it easily can eat up a lot
of memory, since cuts and copies in an editor can be rather large at
times. To remedy this problem, there are several filtering options,
that limits the amount of memory ClipHistory may use. But more about
this later on in this document.

   One interesting detail: ClipHistory is a completely system friendly
program, in that it doesn't patch any functions at all (unless you
really want it to! :). It only uses well documented features of the
operating system. This does have a minor drawback: ClipHistory can
miss clips, if several clips are written in a very short time. But this
shouldn't be any problem, I think.. :)

Legal information
*****************

       ClipHistory is freeware, i.e. copyrighted, freely distributable
software. Feel free to use and copy this program, as long as the
following restrictions are fulfilled:

   *  All files are copied without any alterations. If any extra files
     are added, it must be obvious that they don't belong to the
     original distribution, and that they don't need to be included in
     any redistribution.

     Exception: So called "BBS ads" may not be added.

   *  The copying is done on a non-commercial basis. A small fee to
     cover media costs etc. may be charged.

   *  The copier isn't claiming the copyright of this program.

   Any exeptions from the above requires a written permission from the
author.

No warranty
===========

   THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
OF THE PROGRAMS IS WITH YOU. SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU
ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAMS
(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
THE PROGRAMS TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

System requirements
*******************

       ClipHistory have very modest system requirements. It needs OS
2.04 or better, although OS 3.0 or better will make ClipHistory
operate slightly better.

   If you have ReqTools (by Nico François) installed, then
ClipHistory will use ReqTools for its requesters (you can disable
this if you like). Otherwise the "normal" system requesters will be
used.

Installation
************

       ClipHistory is easy to install. Simply copy the program (and
its icon) to WBStartup, or whereever you find convenient. If you have
OS 2.1 or better, you might want to copy a catalog file as well, to make
ClipHistory operate in another language than english.

   The easiest way is to let the Installer do it (if you have it that
is!  :). If not, copy the file cliphistory.catalog as found in the
Catalogs/<language> drawer to Locale:Catalogs/<language> (or to the
drawer Catalogs/<language> in the same drawer as you placed
ClipHistory). In either case, <language> should be one of the
languages you have select in the Locale preferences editor.

   If there is no catalog file for your language, please try to fill in
the file Empty.ct in the Catalogs drawer and send it to me. I will
then include the catalog in the next release of ClipHistory. It would
be nice if you could translate the Installer script as well.

Usage
*****

   To use ClipHistory, you first make sure that the tooltypes are set
up properly. Then start it. You can also start if from a shell, but then
you must remember to Run it (and to write suitable arguments). To
make it permanently installed, simply drop it into WBStartup, or
enter a suitable line in your S:User-Startup file.

       ClipHistory installs itself as a commodity, so you can use the
Commodities Exchange program to show the interface, disable/enable
it, or remove it completely. Starting ClipHistory a second time (for
the same clipboard unit (option CLIPUNIT)) will cause the first copy
to show the interface. Pressing the hotkey will also open the interface
(option CX_POPKEY). See Options for more information.

   The user interface of ClipHistory is very simple; it contains of a
window with a list gadget. This list contains all the remembered clips.
There is also a menu strip attached (see Menus).

   The text showed in the list is either the text - if it is a text
clip - or the type of the IFF clip (everything on the clipboard should
be in IFF format), followed by its size (in bytes). If you have OS 3.0
or higher, the non-text clips will be shown in bold.

   To select an item in the list, you either click once on it with the
mouse, or you use the cursur Up/Down keys (optionally with the
Shift/Alt/Ctrl qualifiers) to highlight the requested item.

   To copy an item to the clipboard, you double-click on the item, or
press Return when the proper item is selected. Unless the STICKY
option (see Options) have been used, the window will close.

   Esc closes the window.

Menus
*****

   The window ClipHistory opens have the following menus:

Project
    About...
          Shows some information about the program and the history.

    Hide
          Close the window, but don't quit.

    Quit
          Close the window and quit.

Edit
    Open clipboard...
          This will open a file requester, allowing you to select a
          file that will be written to the clipboard. If it is an IFF
          file, it will be copied as it is, otherwise it will be
          written as an IFF FTXT file.

    Save clipboard as...
          This will open a file requester, allowint you to select a
          filename to which the current clipboard contents will be
          written.

    Show clipboard...
          This will write the currently clipboard contents to a
          temprary file, and start the SHOWCLIP program to show this
          file (see Options for more information),

    Clear clipboard
          Simply clear the clipboard, by writing a special (and small)
          IFF EMTY file to it.

History
    Delete item...
          This will delete the currently selected item. You can also
          press Del to do this.

    Delete all items...
          This will delete all clips in the list. You can also press
          Shift-Del to do this.

    Save item as...
          This allows you to save the currently selected item to a file
          of your choice.

    Show item...
          This will write the