home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / arexx / arexg10c.lha / ARexxGuide / Extras / ARx_Help.rexx.README < prev    next >
Encoding:
Text File  |  1993-10-16  |  2.3 KB  |  55 lines
  1. Short: Shell help-key macro for ARexxGuide
  2. Author: Robin Evans
  3.  
  4. DESCRIPTION
  5. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  6. This is a little ditty that might be of some limited utility with
  7. directory utilities or shells. The opening comment to the program
  8. offers a suggestion of how it might be used with WShell.
  9.  
  10. The script takes one argument, a word. It then attempts to find that
  11. word in the ARexxGuide cross-reference file. If it is sucessful, the
  12. node for the word will be shown.
  13.  
  14. REQUIRED FILES
  15. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16.    ARx_Help.rexx     Place in rexx: directory.
  17.    ARx_Guide.xref    An AmigaGuide cross-reference file. Place in
  18.                      directory with other ARexxGuide files.
  19.  
  20. OTHER REQUIREMENTS
  21. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22. The shareware file ARexxGuide is required. It can be found on Aminet in
  23. the util/rexx directory as file name ARexxGuide1_0A.lha.
  24.  
  25. AmigaGuide (available on Aminet) or Multiview is required to run ARexxGuide.
  26.  
  27. The freeware library rexxarplib.library is useful for this macro, but not
  28. necessary.
  29.  
  30. SETUP:
  31. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32. Two environmental variables must be set for this file:
  33.  
  34.    amigaguide/path         May include multiple directories, but one of
  35.                            them must be the full path to the directory
  36.                            where ARexxGuide files are located. Without
  37.                            this env: variable, the macro script will not
  38.                            be able to load ARx_Guide.xref. The current
  39.                            version of the script aborts if that happens.
  40.                            Previous versions didn't check. AmigaGuide
  41.                            would sometimes cause gurus since it was sent
  42.                            invalid information.
  43.  
  44.    arexxguide/agcmd        Must hold the command used to start whatever
  45.                            utility will be used to launch the ARexxGuide
  46.                            files. It can include a full path, if
  47.                            necessary. The current version of the script
  48.                            aborts if this variable is not set, but doesn't
  49.                            check for the existence of the command.
  50.  
  51. The macro ARx_Help.rexx should be moved to your REXX: directory. The file
  52. ARx_Guide.xref should be moved to the directory where the other files in
  53. the ARexxGuide archive are stored.
  54.  
  55.