home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / misc_utils / funclib / funclib.doc < prev    next >
Text File  |  1990-10-28  |  2KB  |  53 lines
  1. FuncLib
  2. -------
  3.  
  4.   This program can be used to add or remove ARexx function libraries. ARexx
  5. functions libraries are shared libraries that are written to be called from
  6. ARexx macros. Once a function library is added, its functions can be called
  7. from an ARexx macro (with passed arguments) just like any other ARexx command.
  8.   For example, the library "rx_file.library" is an ARexx function library.
  9. (Actually, this is a rexx front-end to the dissidents requester.library).
  10. By using FuncLib, you can add the rx_file.library once, and then call any of
  11. its functions from an ARexx macro. Unlike with controlling programs, your
  12. script does not have to use the ADDRESS command to find some ARexx port.
  13.   In order to use FuncLib, you have to know 2 things about a library:
  14.  
  15. 1). That it is indeed setup to be an ARexx function library
  16. 2). The library vector offset for the Rexx Query function within the library
  17.  
  18.   All dissidents function libraries use -30 as the vector offset. This could
  19. very well be different for other programmer's libraries. Consult the documen-
  20. tation that you received with the library.
  21.  
  22.   FuncLib can only be used from the CLI (or within a startup script). The
  23. ARexx server must be running first (ie you must have run the RexxMast program
  24. once). The arguments are as follows:
  25.  
  26. FuncLib <libname> <pri> <vector offset for Query func> <version> [REM][ADD]
  27.   libname = the name of the function library to add/remove
  28.   pri     = the desired priority (-100 to 100)
  29.   vector  = the offset for the Query function (ie -30)
  30.   version = the version number of the library'
  31.   REM     = remove the library
  32.   ADD     = add the library (default)
  33.  
  34. For the libname, you must specify the .library extension (ie rx_file.library).
  35. The ADD keyword is optional, and the default is to add the specified library.
  36. Later, if you wish to remove the library, issue the FuncLib program again
  37. with the REM keyword.
  38.   This program is very useful from without a startup sequence since you can
  39. start ARexx with the RexxMast program, and then add all of the desired function
  40. libraries with the FuncLib program. Then, you're ready to run ARexx macros that
  41. use those function libraries.
  42.   For example, to add the rx_file.library (assuming that both the requester
  43. and rx_file libraries are in your LIBS: drawer),
  44.  
  45. FuncLib rx_file.library 0 -30 0
  46.  
  47.   To remove it:
  48.  
  49. FuncLib rx_file.library 0 -30 0 REM
  50.  
  51.   This program needs the rexxapp.library (which should be copied to your LIBS
  52. drawer).
  53.