$VER: CapShift.doc 1.00 (19.8.93) © Alessandro Sala

                    CapShift version 1.00 19-Aug-1993
                   Copyright © 1993 By Alessandro Sala

             Requires AmigaOS v2.04 ( Kickstart v37 ) or later


                               ------------
                                Disclaimer
                               ------------

   This program is provided "as is" without warranty of any kind, either
expressed or implied, including, but not limited to, the implied warranty
of fitness for a particular purpose.  Though every care has been taken to
make this program system-friendly and bugs-free, the entire risk as to the
results, reliability and performance of this program is assumed by you.


                            ------------------
                             Copyright notice
                            ------------------

   This program is "FreeWare": it can be freely copied and distributed for
non-commercial purposes, provided that no file is added to or removed from the
distribution archive and no charge, beside a nominal fee, is requested.
   Nevertheless the program remains COPYRIGHT of the Author: you cannot
patch, reverse engineer or otherwise modify the program, the documentation and
every other file found in the distribution archive except where explicitly
allowed.
   Compressing in executable form is allowed for personal use but not
for distribution: LHARC'ing in an archival form is explicitly allowed for
distribution convenience.
   Furthermore you cannot embed the program in any other software without
the written permission of the author.

                     ------------------------------------
                     Contents of the distribution archive
                     ------------------------------------

    CapShift             : The main program
    CapShift.info        : Related '.info' file with pre-set tooltypes

    Doc
      Italiano.leggimi   : General information in italian language
      Italiano
        Italiano.doc     : Italian documentation in ASCII format
        Italiano.guide   : Italian documentation in AmigaGuide format

      English.readme     : General information in english language
      English
        English.doc      : English documentation in ASCII format
        English.guide    : English documentation in AmigaGuide format

    Install
      Italiano           : Italian installation script (see Italiano.leggimi)
      English            : English installation script (see English.readme)

    Catalogs
      CapShift.ct        : Empty translation file
      italiano
        CapShift.catalog : Italian language support file

    Various '.info' files

                               ---------------
                               1. Introduction
                               ---------------


                              What is CapShift ?
                              ------------------

   CapShift is a simple commodity and its main function is to modify the
behaviour of the 'shift' key: if you press 'shift' when the capslock key is on,
normally nothing happens; with CapShift the capslock state AND the shift state
are turned off until you release the 'shift' key, which is now acting as a
'capital-toggle' if you press an alphabetic key (A...Z) :

           capslock | shift | result
           ---------+-------+---------
              off   |  off  | lowercase
              off   |  on   | uppercase
              on    |  off  | uppercase
              on    |  on   | lowercase

   CapShift has also another feature you can turn on: the so-called
'capslock killing'. The capslock key is rarely used as a qualifier for the
'highmap' keys (f1-f10, esc, return, enter, tab, backspace, del, help, cursor
keys), nevertheless it IS a qualifier and, if it is on, some key combinations
(especially hotkeys) don't work as expected. With hotkeys, you can avoid this
problem if you put '-capslock' in every hotkey description, when this is
possible,  but this can be annoying. Besides, if the problem isn't with a hotkey
there is often no solution. Here comes CapShift: you can choose to turn off the
capslock qualifier when one of the 'highmap' keys is pressed: simply add the
'KILLHIGHCAPS' tooltype to the CapShift's icon, or use the same argument from
CLI. You can also turn on 'capslock killing' when one ore more of the 'control',
'alt' or 'amiga' qualifier is pressed and with the keypad's keys: simply add
the 'KILLQUALCAPS' tooltype to the CapShift's icon, or use the same argument
from CLI.


                                Installation
                                ------------

   To install CapShift, if you have the 'Installer' utility from Commodore (see
English.readme), you can simply double-click the 'English' icon found in the
'Install' drawer.
   Differently, you can simply copy CapShift in some drawer, typically
your SYS:WBStartup drawer. If you have OS 2.1 or later and you want to
take advantage of localization, you must also copy the 'catalogs' drawer, found
in the CapShift distribution archive, into the same drawer as CapShift, or
you can copy the 'CapShift.catalog' file ( found in the 'catalogs/<language>/'
drawer ) into your 'LOCALE:catalogs/<language>/' drawer.
   If your language is not currently available, you can fill in the empty
translation file found in the catalogs drawer ( catalogs/CapShift.ct ) and
send it to me by E-Mail ( the address is at the end of this file ). I will
create a new '<your-language>/CapShift.catalog' file and E-Mail it to you as
soon as possible, and the next version of CapShift will support one more
language. You can also translate the documentation files and send them to me
for inclusion in the distribution of CapShift.


                         --------------------------
                         2. Configuration and usage
                         --------------------------

  To start CapShift simply double-click on its icon or type 'run CapShift' from
a CLI. To have it activated on every boot, place it in your SYS:WBStartup
drawer with the 'DONOTWAIT' tooltype, or insert 'run CapShift' in your
S:user-startup file.
  CapShift recognizes the following ToolTypes or CLI arguments:

          CX_PRIORITY=<pri>     : The priority of CapShift in the commodities
                                  network: CapShift should be the highest
                                  priority commodity installed in your system,
                                  so it can kill the capslock key before any
                                  other program can see it. However if you have
                                  some commodity needing the capslock key as a
                                  qualifier, give it a higher priority than
                                  CapShift.
                                  Default value = 20. Range = -128 to 127

          HOTKEY=<desc>         : By this hotkey combination you can activate
                                  and deactivate 'capslock killing' and
                                  'capital-toggle'. Note that this is
                                  different from activating and deactivating
                                  CapShift from the Commodities Exchange
                                  program (see below).
                                  Default value = control alt -capslock c

          KILLHIGHCAPS          : This turns the 'capslock killing' feature on
                                  when 'highmap' keys are pressed.

          KILLQUALCAPS          : This turns the 'capslock killing' feature on
                                  when one ore more of the 'control', 'alt' or
                                  'amiga' qualifier is pressed and with the
                                  keypad's keys.

          BREAK_WARN            : When CapShift terminates because of a
                                  ^C signal, it displays a requester
                                  informing you of the event only if BREAK_WARN
                                  is set.

   Once CapShift is active you can use the Commodities Exchange program to
control its activities. Note that if you disable CapShift via the Exchange
program you can re-enable it only with the same method. The same applies to the
hotkey combination. Besides, when you use the hotkey, CapShift simply doesn't
modify the capslock state anymore, but the commodity is still active and so
continues to steal the hotkey combination from the input stream.


                           -----------------------
                           3. Terminating CapShift
                           -----------------------

As a commodity, CapShift can be terminated in three ways:

  a) Run CapShift a second time.

  b) Use the Commodities Exchange program.

  c) Send CapShift a 'control-C' signal:

    c.1) If you started CapShift from workbench (or WBStartup drawer) use a
         task control utility such as TaskX by Steve Tibbet.

    c.2) If you started CapShift from a CLI (or user-startup) do the following:

          1) Open a CLI
          2) Issue the 'STATUS' command and note the process number of CapShift
          3) Issue 'BREAK <n> C' where <n> is the process number noted above


                         ----------------------------
                         4. Criticism and suggestions
                         ----------------------------

   I hope you will find CapShift useful, and if you have any criticism,
suggestions, bug report, ideas for enhancements in possible future versions,
you can write ( in Italian or English ) at the following address:

        Alessandro Sala
        Via A. Grandi, 16
        20014 Nerviano (MI)
        Italy

	If you have E-Mail capability you can also contact me at the following
Internet address (at least until the end of January 1994):

        tser1506@cdc835.cdc.polimi.it


                                                  Thank you

**********************************************************************************
                                    History
**********************************************************************************



------------
Version 1.00
------------

     First release.
