home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / libraries / rxgen / rxgen.readme < prev    next >
Text File  |  1991-02-18  |  4KB  |  93 lines
  1. /*
  2.  *===========================================================================
  3.  * \__________/ Copyright (c) 1990 Francois Rouaix and The Software Winery.
  4.  *  \o   o   /  All Rights Reserved. This program may not be distributed
  5.  *   \ o   o/   without the permission of the author:
  6.  *    \  o /         Francois Rouaix
  7.  *     \ o/          7 rue de la Ferme
  8.  *      ||           78150 Le Chesnay   FRANCE
  9.  *      ||      Contact The Software Winery at:
  10.  *      ||           BBS     : +33 (1) 39 55 84 59  (V23 Videotex)
  11.  *      ||           MAIL    : c/o Alain DIDIERJEAN 69 rue Dunois
  12.  *      ||                     75646 Paris cedex 13 FRANCE
  13.  *    <====>         INTERNET: rouaix@inria.inria.fr
  14.  *===========================================================================
  15.  */
  16.  
  17.  
  18.                     RXGEN README
  19.                     Version 1.0 (First released version)
  20.  
  21. Overview:
  22.     RXGEN is an ARexx library designed for the hacker.
  23.     This library allows you to call any function of (almost) any amiga
  24.     library from a Arexx program.
  25.     I would say it is essentially useful under 2.0 to test some of
  26.     the new "high-level" features of the system. It also works under 1.3.
  27.     You can use the library to write small programs, when you don't want
  28.     to use your C-compiler ! Eventually, your program will get bigger and
  29.     bigger, and you'll find out that either you don't need your C-compiler,
  30.     or that Arexx is slow (heheh).
  31.  
  32.  
  33. Distribution:
  34.     The rxgen distribution consists in the following files
  35.         libs/rxgen.library      the library itself
  36.         rxgen.readme            (this file)
  37.         rxgen.doc               autodoc file
  38.         rexx/FD2rxFD.rexx       filter from FD.FILES to specific format
  39.  
  40.         rexx/db.rexx            DisplayBeep example
  41.         rexx/wbfront.rexx       WBenchToFront example
  42.         rexx/alert.rexx         DisplayAlert example
  43.         rexx/port.rexx          MsgPort example
  44.  
  45.         rexx/fd.rexx            Scanner for FD.FILES
  46.         rexx/wbmaster.rexx      AppMenuItems under 2.0
  47.  
  48.     All the files of the distribution are Copyright (C) 1990 Francois Rouaix
  49.     and The Software Winery.
  50.     RXGEN is NOT Public Domain, but can be distributed freely, provided
  51.     all files are included, unmodified. Inclusion in a commercial product
  52.     requires previous written permission from the author.
  53.  
  54. Installation:
  55.     You will have to
  56.        -copy rxgen.library to your libs: directory (or any :libs directory
  57.         under 2.0)
  58.        -install the script FD2rxFD.rexx in your rexx: directory
  59.        -install rxgen.library in the list of arexx libraries with either
  60.         1> rxlib rxgen.library 0 -30 0
  61.         or the usual ARexx clause:
  62.         if ~show('L','rxgen.library') then call addlib('rxgen.library',0,-30,0)
  63.  
  64. Functionalities:
  65.     rxgen provides you with 3 functions,
  66.         GenOpenLib          generic open library
  67.         GenCloseLib         generic close library
  68.         GenACall            generic assembly call
  69.  
  70.     GenACall will need a definition of the function it will call.
  71.     Fortunately, part of this definition can be obtained automatically
  72.     from the FD.FILES (found on the Extras disk), through the
  73.     ARexx program FD2rxFD. More details in the autodocs.
  74.  
  75. In the distribution, you will find an autodoc file for these three functions.
  76. You're invited to check with the examples (the examples have to run, the doc
  77. doesn't). Examples are usually documented when needed (!).
  78.  
  79. Special offer:
  80.    -INCLUDED in the distribution is an example (wbmaster.rexx) using a
  81.     new 2.0 feature of the Workbench: AppMenuItems
  82.     Read the comments. Use with care.
  83.  
  84.    -INCLUDED in the distribution is an utility (fd.rexx) for scanning
  85.    the FD.FILES when looking for
  86.                     * either function OFFSET when function name is known
  87.                     * or function name when OFFSET is known
  88.  
  89. Bug reports, comments, suggestions: see my mail/e-mail address in the header
  90.  
  91.                                     Francois Rouaix
  92.  
  93.