home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d855 / keycall.lha / KeyCall / Keycall.doc < prev    next >
Text File  |  1993-03-28  |  12KB  |  311 lines
  1.  
  2.  
  3.  
  4.  
  5.                              Keycall 1.3
  6.                              ~~~~~~~~~~~
  7.  
  8. Version 1.3.2  06/02/93                                © Timespan Software
  9.  
  10.  
  11.  
  12. The purpose of this program is to provide hotkeys to run frequently used
  13. programs. In order to minimise conflict with other software attempting
  14. input from the keyboard, a choice of qualifier and all function keys are
  15. used. Using these key combinations allows Keycall to allocate up to ten
  16. user-definable hotkeys. The advantage of using hotkeys as opposed to other
  17. menu or docking programs etc. is that the keyboard is always available
  18. regardless of the screen you are currently working in.
  19.  
  20. This software will work on both 1.3 and 2.n machines. Please note that
  21. "Keycall 2" (currently under production) will run as a true WB2 commodity,
  22. allowing control from the CX Exchange program etc.
  23.  
  24. Keycall is shareware. It may be freely copied and distributed, as long as
  25. the original program remains intact. I would also request that this "doc"
  26. file is distributed along with Keycall. Should you find this program
  27. useful then a small donation to the author would be gratefully received.
  28.  
  29.  
  30.  
  31. Installation (2.0)
  32. ~~~~~~~~~~~~~~~~~~
  33. Drag the WB2_Icon to your disk using workbench, use the Icon/Rename menu
  34. option to change this icon's name to Keycall. To invoke Keycall at startup,
  35. you have the option of dragging the Keycall icon (the one that you have
  36. just renamed!) to your WB startup drawer, or you can move Keycall to your
  37. C: directory using the shell or SID etc., and add the "Run >Nil: Keycall"
  38. command to your User-Startup file.
  39.  
  40.  
  41. Installation (1.3)
  42. ~~~~~~~~~~~~~~~~~~
  43. Simply copy Keycall (less than 8k in size) to your disk using workbench to
  44. drag the Keycall icon to your desired drawer. Or if you intend to include
  45. Keycall as part of your startup-sequence (recommended) then copy the
  46. program to your C: directory and add the following line to your startup-
  47. sequence :
  48.  
  49.                 Run >Nil: Keycall
  50.  
  51.  
  52. Floppy Users
  53. ~~~~~~~~~~~~
  54. Keycall does not require the use of any disk libraries, however if you
  55. wish to retain identical command strings across a number of different
  56. workbench disks, Install Keycall as above, edit the command strings and
  57. then save a keylist file (see below) and copy to the various S:
  58. directories.
  59.  
  60.  
  61. Using Keycall
  62. ~~~~~~~~~~~~~
  63. From Workbench: click on the Keycall icon
  64.  
  65. From CLI      : enter "Run >Nil: Pathname/Keycall"
  66.  
  67. CLI Usage     : Keycall SHOW/s
  68.  
  69.  
  70. Keycall operates in two modes, control or background. Whilst the programs
  71. window is visible the control+function key combinations are ignored and
  72. program control/editing is possible. Using the Ctrl+Esc combination opens
  73. the program's control window.
  74.  
  75. Whilst running in the background (ie. Keycall's window is closed) then the
  76. appropriate command strings are executed when the qualifier+function key
  77. combinations are used. Please note that in order to quit the program, you
  78. need to select "Quit" from the menu on the control window.
  79.  
  80. As a default if Keycall can open the S:Keylist file, then the program will
  81. run in the background, The SHOW option causes Keycall to open it's control
  82. window when being first executed. 
  83.  
  84.  
  85. The basics of operating the program are :
  86.  
  87.   [1] Run the program
  88.   [2] Ensure the control window is open.
  89.   [3] Edit command strings for appropriate function keys.
  90.   [4] Select your qualifier. (ie Ctrl/Amiga/Alt/Shift keys)
  91.   [5] Save the keylist file.
  92.   [6] Test function key sequences.
  93.   
  94.   
  95. Once you have saved a keylist file, then all you need do is run the
  96. program and then use your <qualifier> + function keys as before.
  97.  
  98.  
  99. The Control Window
  100. ~~~~~~~~~~~~~~~~~~
  101. Run Keycall from either CLI or Workbench, until Keycall has saved a
  102. "Keylist" file in the S: directory, the control window will be displayed
  103. at startup with default strings shown for keys F1 and F2. These command
  104. strings start a shell and give a directory listing of DF0:. 
  105.  
  106.  
  107. The program's control window should now appear,  looking like this:
  108. (if not then use the Ctrl + Esc hotkey combination)
  109.  
  110.  ================================================================ 
  111. |                                                                |
  112. |  ------    -------------------------------------------------   |
  113. | |CYCLE |  |COMMAND                                          |  |
  114. |  ------    -------------------------------------------------   |
  115. |                                                                |
  116. |  ------    ------     -----------------------    -----         |
  117. | |CANCEL|  | SAVE |   | QUALIFIER = < key>    |  | USE |        |
  118. |  ------    ------     -----------------------    -----         |
  119. |                                                                |
  120.  ================================================================
  121.  
  122.  
  123.          Keys
  124.  
  125. Help       :
  126.              Brings up a small help window detailing the very basic
  127.              operation of Keycall. To continue click anywhere within
  128.              the window.
  129.  
  130. Tab        :
  131.              Keyboard alternative to select the CYCLE gadget.
  132.              
  133.              
  134.              Gadgets
  135.  
  136. CYCLE      :
  137.              Selects the next command string to view/edit. As it's name
  138.              suggests, it cycles through F1 - F10, and then back to F1
  139.              again.
  140.  
  141. COMMAND    :
  142.              This is a standard Amiga text gadget used for the input of
  143.              command strings. In order to edit/create commands you will
  144.              need to click in this gadget before typing.
  145.  
  146. CANCEL     :
  147.              Cancels the current edits, command strings remain as they
  148.              were when the control window last appeared. Keycall is
  149.              enabled and the control window closed. Using the close
  150.              gadget on Keycall's window is functionally equivalent.
  151.          
  152. SAVE       :
  153.              Permanently saves the current edits as S:Keylist and then
  154.              closes the control window and enables keycall.
  155.  
  156. USE        :
  157.              Keycall is enabled using the current edits and the control
  158.              window is closed.
  159.              
  160. QUALIFIER  :
  161.              Cycles through the various qualifier options available for
  162.              use with the function keys. In order to prevent conflict
  163.              with other programs attempting to use the function keys, you
  164.              can select your own qualifier key. Choices are : Control,
  165.              Left Alt,Right Alt,Any Alt,Left Amiga,Right Amiga,Shift,None.
  166.              
  167.  
  168.              Project Menu
  169.  
  170. New        :
  171.   <Amiga+N>  Clears the current command strings being edited.
  172.  
  173.  
  174. Save       :
  175.   <Amiga+S>  Functionally equivalent to the "SAVE" gadget
  176.           
  177.  
  178. Use        :
  179.      <None>  Functionally equivalent to the "USE" gadget
  180.           
  181.  
  182. Disable    :
  183.   <Amiga+D>  Closes the control window, but allows no execution of
  184.              command strings until the control window has been opened
  185.              again.
  186.           
  187.  
  188. About      :
  189.      <None>  Causes a small window to appear showing shareware details
  190.              etc. Click anywhere in this window to continue.
  191.  
  192.  
  193. Quit       :
  194.      <None>  Quits the program, this is the **ONLY** way to shut the
  195.              program down without resorting to using the shell.
  196.  
  197.  
  198.  
  199.              Edit Menu
  200.  
  201. Last Saved :
  202.      <None>  Reloads the previously saved command strings from the keylist
  203.              file in your S: directory, then updates the control window
  204.              display.
  205.  
  206.                              
  207. Background Mode
  208. ~~~~~~~~~~~~~~~
  209.              Keys
  210.  
  211. Ctrl+Esc   : Only used whilst the control window is closed, this is
  212.              Keycall's Hot Key. Using this key combination causes the
  213.              control window to appear.
  214.  
  215. Qual+Fn    : With Keycall's control window closed and commands enabled,
  216.              using the combination of the chosen qualifier key and any of
  217.              the function keys F1 - F10 causes Keycall to execute the
  218.              line(s) in the same way as typing the command into the Shell.
  219.              If any of the available command strings are empty then no
  220.              attempt is made to perform that function. 
  221.  
  222.  
  223. Command Strings
  224. ~~~~~~~~~~~~~~~
  225. What commands ?  Those programs you use most frequently, or if you know 
  226. your way around the shell well enough, then format/list/copy files etc.
  227. However it is recommended to allow some visual output for example :
  228.  
  229.           Run >Nil: List >"Con:20/20/440/180/ Listing of C:" C: NODATES
  230. Or :
  231.           Run >Nil: MyDir/Wordprocessor <argument1> <argument2>
  232.  
  233.  
  234. Note that further execution of command strings is suspended until the
  235. current execution is finished. Therefore ensure that the Run (or Runback
  236. etc.) command is used to ensure early completion. Keycall is quite happy
  237. to wait, however if your needs dictate.
  238.  
  239. Multiple commands can be entered in the COMMAND text gadget by use of the
  240. "\n" combination (as per c), as in the following example :
  241.  
  242.           CD DH1:Grafix\nRun >NIL: DPaint
  243.  
  244. In order to include a literal "\n" within the command string, simply type
  245. in "\\n" the first slash will be ignored. Obviously if you exceed the 255
  246. byte limit of the command string, then you will have to resort to using a
  247. script file and using Keycall to execute it.
  248.  
  249. Redirection to the NIL: Device may be required, dependant on your system
  250. set up, workbench 2 and 1.3.n + ARP seem happy enough without this, but
  251. a standard 1.3.2 workbench may crash if this redirection is omitted.
  252.  
  253.  
  254. Problems
  255. ~~~~~~~~
  256. Program does nothing :
  257.  
  258. [1]  Firstly Use the Ctrl+Esc combination if the control window does not
  259. appear see [2]. Assuming you are now looking at the control window check
  260. that you have specified pathnames correctly and that you have given valid
  261. arguments. I suggest typing the command(s) into a shell to test. The most
  262. common problem is mitsyping a command. Further check that you are using
  263. the correct qualifier key, as displayed on your QUALIFIER gadget.
  264.  
  265.  
  266. [2]  Run Keycall again, the control window should now appear. If not, then
  267. a command string has failed to return control to the program. Reboot and
  268. check for commands that do not finish. (Note that only one occurrence of
  269. Keycall will run at any one time. If you try to run the program a second
  270. time Keycall sends a hotkey type signal to the first program and shuts
  271. down.) Do remember that a program that expects CLI input could well be
  272. unaware that it is running in the background, and wait forever.
  273.  
  274. Amiga crashes :
  275.  
  276. [1]  Either you need to redirect your input/output, or your command causes
  277. system failure. As described above type your line in the shell to test.
  278.  
  279.  
  280. Programmers/Disk Compilers
  281. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  282. The KeyMenu program included on this disk allows the use of Keycall to 
  283. create a menu driven front end for your disks. Read the KeyMenu.doc file
  284. for more information.
  285.  
  286.  
  287. Disclaimer
  288. ~~~~~~~~~~
  289. Although every attempt has been made to ensure this program is bug free,
  290. no warranty is given or implied as to the suitability of this software.
  291. Please send bug reports or suggestions to the address shown below.
  292.  
  293.  
  294. Registration
  295. ~~~~~~~~~~~~
  296. Should you wish to become a registered user, then send a small donation
  297. to the author. Registered users will receive Keycall 2, the workbench 2
  298. version of this software, which should be available shortly. If you do not
  299. reside within the UK, please ensure that the costs of disk and postage is
  300. covered.
  301.  
  302. Whether registered or not, if any users require help regarding the use of
  303. Keycall, then drop me a line and I will do my best to help.
  304.  
  305.             
  306.                     Timespan Software
  307.                     49 Craydene Road,
  308.                     Erith,           
  309.                     Kent      DA8 2HA
  310.  
  311.