home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / kmp11.zip / kmp.doc < prev    next >
Text File  |  1994-02-25  |  12KB  |  288 lines

  1.                         KeyMaster Pro, release 1.1
  2.                      Copyright (C) John McCalla, 1993
  3.  
  4.                                USER'S MANUAL
  5.  
  6. -----------------------
  7. Table of Contents
  8. -----------------------
  9.  
  10. 1. Introduction
  11. 2. Installing KMP
  12. 3. Using KMP (Features)
  13.     3.1 Creating an Entry
  14.     3.2 Deleting an Entry
  15.     3.3 Changing an Entry
  16.     3.4 Saving your Profile
  17.     3.5 Valid hot key combinations
  18.     3.6 Command line switches
  19.     3.7 WPS Objects
  20. 4. How to contact the author
  21. 5. Future Plans
  22.  
  23.  
  24. ---------------
  25. 1. Introduction
  26. ---------------
  27.  
  28.     KeyMaster Pro (KMP) is a simple yet very useful "hot keying" utility.
  29.     In plain english, KMP allows you to launch your favorite applications
  30.     and utilities using a key combination, from anywhere in the system
  31.     (except for full-screen sessions).  The key combinations supported are
  32.     almost all sequences of the type <ctrl><shift><key> where key is any
  33.     key (or almost see section 3.5).
  34.  
  35.     KMP will start all types of sessions under OS/2 2.X except for seamless
  36.     WIN-OS/2 sessions.  Once a session is open, hitting its key combination
  37.     will automatically cause PM to switch to the open application.
  38.  
  39.  
  40. -----------------
  41. 2. Installing KMP
  42. -----------------
  43.  
  44.     Installation is very simple.  First unzip all the files included in
  45.     kmp11.zip.  The zip file should include the following:
  46.  
  47.  
  48.     Length  Method   Size  Ratio   Date    Time   CRC-32     Name ("^" ==> case
  49.     ------  ------   ----  -----   ----    ----   ------     ----   conversion)
  50.        507  Deflate    293  42%  02-25-94  13:46  f8aa1933  ^whatsnew.txt
  51.      44601  Deflate  18311  59%  02-25-94  14:09  d8755a2a  ^kmp.exe
  52.      12109  Deflate   4284  65%  02-25-94  13:40  a41a0648  ^kmp.doc
  53.       7940  Deflate   3165  60%  02-25-94  14:09  7156b3a6  ^kmphook.dll
  54.       2457  Deflate    654  73%  02-23-94  15:31  afce92f9  ^kmp.dat
  55.     ------          ------  ---                              -------
  56.      67614           26707  61%                              5
  57.  
  58.  
  59.     Place KMP.EXE in your PMAPPS directory, or any directory included in
  60.     your path.  KMP.DOC (this file) must be in the SAME directory if you
  61.     want this help file to be accessible directly from KMP.  KMPHOOK.DLL
  62.     can be either in the same directory as KMP or in a directory pointer
  63.     to by the libpath variable.  A good place is \os2\dll.  The KMP.DAT
  64.     file must be in the same directory as KMP.EXE.
  65.  
  66.     That's it! KMP is now ready to run.  You will still need to setup
  67.     your applications and utilities from within KMP (see Section 3).  Note
  68.     that a default setup is provided (KMP.DAT).  You may edit this text
  69.     file directly, or use KMP's facilities for creating, editing, and
  70.     deleting entries.
  71.  
  72.  
  73. ------------
  74. 3. Using KMP
  75. ------------
  76.  
  77.     This section describes in some detail the various features of KMP and
  78.     explains how to use them.
  79.  
  80.     To start an application, or to switch to an open application, you may
  81.     proceed in two ways.
  82.  
  83.     First, you may use its hot key combination.  NOTE: in release 1.x,
  84.     this must be a combination of the control key, shift key, and a
  85.     capital letter from A to Z.  All must be held down at the same
  86.     time.  The recommended method is to press, and hold the CTRL and
  87.     SHIFT keys, and then press the letter needed, releasing all three
  88.     keys afterwards.  The same way you would reboot your computer.
  89.  
  90.     KMP can also be used as a pop-up menu launcher.  By pressing
  91.     <CTRL><SHIFT>K, you cause KMP to pop-up.  You may then start an
  92.     application you wish by double-clicking on its title in the list box.
  93.  
  94.  
  95. 3.1 Creating an Entry
  96. ---------------------
  97.  
  98.     To create a new entry in KMP, select "New Entry..." from the "File"
  99.     submenu.  A dialog pops-up.  Enter the information requested. The
  100.     meaning of each field is described below:
  101.  
  102.         FIELD                       DESCRIPTION
  103.         ------------------------------------------------------------------
  104.  
  105.         "Program Title"             The title of the application.  This
  106.                                     title is used for display in the list
  107.                                     box, and KMP attempts to give the newly
  108.                                     opened application that title.
  109.  
  110.         "Path and Filename"         The COMPLETE path and filename of the
  111.                                     application must be entered here.
  112.  
  113.         "Working Directory"         This is OPTIONAL.  If used, KMP will
  114.                                     start the application in that
  115.                                     directory.
  116.  
  117.         "Parameters"                This is OPTIONAL.  If used, KMP will
  118.                                     pass these parameters to the
  119.                                     application, only if it is opening the
  120.                                     application.
  121.  
  122.         "Switch List Text"          The text that will appear in the List
  123.                                     Window once the application is open.
  124.                                     If the title changes during the
  125.                                     time the application is active, you may
  126.                                     enter a partial name which does not
  127.                                     change (see also "Switch List Length").
  128.  
  129.         "Switch List Length"        This is the length of the "Switch List
  130.                                     Text".  Use this if you need partial
  131.                                     names to avoid loosing a window when
  132.                                     part of its title changes.  For example
  133.                                     to make an entry for EPM, you would
  134.                                     need to set the "Switch List Text"
  135.                                     to "EPM", with a "Switch List Length"
  136.                                     of 3. This way, when you switch to a
  137.                                     different document within EPM, KMP will
  138.                                     still be able to track the proper
  139.                                     window. NOTE: if not used, this field
  140.                                     defaults to (10) ten. Therefore, if you
  141.                                     have windows which have the same title
  142.                                     up to the tenth character, use this
  143.                                     field to set the length to more than
  144.                                     ten.
  145.  
  146.         "Hot Key"                   The hot key used to open or switch to
  147.                                     the application.  NOTE: IN RELEASE 1.x
  148.                                     ONLY, CAPITAL LETTERS FROM A TO Z MUST
  149.                                     BE USED, NO OTHER CHARACTERS ARE VALID.
  150.  
  151.         "Program Type"              Select the type of application this is.
  152.                                     If you try to open a WPS object, using
  153.                                     anything else than the proper setting,
  154.                                     KMP will flag an error.
  155.  
  156.     -----------------------------------------------------------------------
  157.  
  158.     For those who wish to create a large amount of entries at once,
  159.     the KMP.DAT file may be edited directly.  NOTE: when editing KMP.DAT,
  160.     KMP must NOT be open at the time, or the changes might be overwritten.
  161.  
  162.  
  163. 3.2 Deleting an Entry
  164. ---------------------
  165.  
  166.     To delete an entry, select "Delete Entry..." from the "Edit" submenu.
  167.     Answer "Yes" to the confirmation dialog.
  168.  
  169.     For those who wish to delete a large amount of entries at once, the
  170.     KMP.DAT file may be edited directly.  NOTE: when editing KMP.DAT,
  171.     KMP must NOT be open at the time, or the changes might be overwritten.
  172.  
  173.  
  174. 3.3 Changing an Entry
  175. ---------------------
  176.  
  177.     To change an entry, select "Change Entry..." from the "Edit"
  178.     submenu.  The same dialog that was used to create an new entry appears.
  179.     Edit any of the fields and press "Ok".  For a description of the
  180.     fields, see section 3.1.
  181.  
  182.     NOTE: As a shortcut, select the entry you wish to edit, and the press
  183.     "Mouse Button 2" over the list box.
  184.  
  185.  
  186. 3.4 Saving Your Profile
  187. -----------------------
  188.  
  189.     In version 1.x, the profile (KMP.DAT) is automatically saved after each
  190.     operation involving it.  The "Save" item in the "File" submenu is
  191.     redundant.
  192.  
  193. 3.5 Valid hot key combinations
  194. -----------------------------
  195.  
  196.     In version 1.x, only capital letters from A to Z are permitted.  All
  197.     other symbols will cause KMP to display the message to the effect that
  198.     this key is not defined.
  199.  
  200.     The Letter "K" is reserved for KMP.  Press <CTRL><SHIFT>K at any time,
  201.     and KMP will pop-up.
  202.  
  203.  
  204. 3.6 Command line switches
  205. -------------------------
  206.  
  207.     To start KMP minimized, use a "/MIN" or "-MIN" switch when starting
  208.     KMP.  NOTE: from ver 1.1 on, there is no /MIN option.  The initial
  209.     position and size of the main window is determined according to the
  210.     position it had when last closed.  Its behaviour is identical to that
  211.     of WPS folders.
  212.  
  213.         It is recommended to run KMP in the background, and minimized.
  214.     If not, KMP will flash into the foreground right before starting an
  215.     application.  This is not a bug, but a requirement (of PM).
  216.  
  217.  
  218. 3.7 WPS Objects
  219. ---------------
  220.  
  221.     WPS objects, such as folders, printers, etc... may be opened and switched
  222.     to using KMP as any other type of session.  To do this, use the
  223.     "Program Title", "Switch List Text" for the object's name and "Hot Key"
  224.     to the key which will switch to that object.  Make sure the program
  225.     type is set to "WPS object". The "path and filename" field must contain
  226.     the object's ID.  These are usually of the form "<WP_xxx>".  If the
  227.     object is a folder, you may also specify its path and name.  To do this,
  228.     open the settings notebook of the folder, switch to thew "file" page.
  229.     Now, copy the path field to the KMP "path and filename" field, enter a
  230.     separator ("\"), and then copy the name field of the folder to the KMP
  231.     field.
  232.  
  233.  
  234. ----------------------------
  235. 4. How to contact the author
  236. ----------------------------
  237.  
  238.     The author wishes to hear from you, the users.  Any comments, positive
  239.     or negative are encouraged; as well as recommendations and bug reports.
  240.  
  241.     e-mail addresses:
  242.  
  243.         on internet: jmccalla@draco.ee.mcgill.ca          (September - May)
  244.                      john_mccalla@f1.n240.z1.fidonet.org  (June - August)
  245.  
  246.         on fidonet:   John McCalla @ 1:2400               (June - August)
  247.  
  248.     Postal address:
  249.  
  250.         John McCalla,
  251.         2069 de Maisonneuve West, Apt 8,
  252.         Montreal, PQ,
  253.         Canada, H3H 1K9.
  254.  
  255.  
  256. ---------------
  257. 5. Future Plans
  258. ---------------
  259.  
  260.     Depending on user response the following things might be added to KMP:
  261.  
  262.         1. An interface using containers (like the folders on the WPS).
  263.         2. More control over how an application is started.
  264.         3. A settings notebooks to allow extensive customization.
  265.         4. More combinations of hot keys.
  266.         5. Add the ability the open Win-OS/2 sessions.
  267.         6. Anything else you can think of...
  268.  
  269.  
  270.     *** COMING SOON FROM THE SAME AUTHOR ***
  271.  
  272.         DC - Development Center
  273.             This will be released in the 1st quarter of 1994.  This is
  274.             a developer's tool. It's purpose is to provide a graphical
  275.             interface for MAKEing and testing applications.  It will
  276.             include advanced features permitting it to "become" part of
  277.             EPM.  This program will also be classified as freeware.
  278.  
  279.         MDPM - McCalla Desktop for PM
  280.             This will be released in the second quarter of 1994.  This is
  281.             the application everyone with less than 12 MEG of memory as
  282.             been waiting for.  MDPM is a shell replacement for WPS.  Using
  283.             it over WPS will save about 4 MEG of RAM.  It will be a subset
  284.             of WPS, with a few advanced features not included in WPS.  The
  285.             general look and feel will be something like the WPS; this is
  286.             not going to be something like "progman.exe".  MDPM will be
  287.             released as Shareware.
  288.