home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 531.lha / TurboText_Utils / FindDoc / FindDoc.doc < prev    next >
Encoding:
Text File  |  1991-07-04  |  2.5 KB  |  71 lines
  1. FindDoc © May 1991 By Talin. Freely re-distributable.
  2.  
  3. An autodoc/include reference utility for TurboText users.
  4.  
  5.     FindDoc is a set of C programs and ARexx macros which allow you to
  6. quickly locate any AutoDoc function entry or structure name. You can place
  7. the cursor on the name to be looked up, or alternatively have a string
  8. requester ask for the name of the entry, and it will open a TurboText
  9. window containing the definition of that entry.
  10.     The program consists of the following parts:
  11.  
  12.     ParseAuto - a C program which parses the autodoc files
  13.     ParseInc - a C program which parses the include files
  14.     FindDoc - a C program which is a resident ARexx host. It maintains
  15.         an index and accepts requests from ARexx to locate entries in the
  16.         index.
  17.     FindAutoDoc.ttx - an ARexx program to be launched from TurboText,
  18.         which will request the name of the entry to be looked up.
  19.     FindAutoDocWord.ttx - similar to above, but uses the word under the
  20.         cursor as the entry to look up.
  21.  
  22.     Note that I gave not included the source to the C programs simply
  23. because they will only compile in my environment (they make use of my
  24. extensive personal function libraries).
  25.  
  26. To install FindDoc:
  27.     1. Copy the two rexx program to your REXX: directory.
  28.     2. Copy FindDoc to somewhere in your path (somewhere that can be called by
  29.         arexx)
  30.     3. execute the command:
  31.         ParseAuto <directory where your autodocs are> S:AutoDocs.index
  32.     4. execute the command:
  33.         ParseInc <directory where your includes are> S:Includes.index
  34.     5. Edit your TTX_Startup.dfn file to attach the two ARexx programs to
  35.         the function key of your choice.
  36.     6. Try it out! Edit any of your C source files, put the cursor on the
  37.         name of an Amiga ROM function, and hit the function key that executes
  38.         "FindAutoDocWord.ttx".
  39.  
  40. Program usage:
  41.  
  42.     ParseAuto <directory to scan> <index file to build>
  43.  
  44.         For example:
  45.  
  46.             ParseAuto dh0:docs S:AutoDoc.index
  47.  
  48.  
  49.     ParseInc <directory to scan> <index file to build>
  50.  
  51.         For example:
  52.  
  53.             ParseAuto dh0:include S:Includes.index
  54.  
  55.  
  56.     FindDoc <index file> <index file> ...
  57.  
  58.         Example:
  59.  
  60.             Run >NIL: <NIL: FindDoc S:AutoDoc.index S:Include.index
  61.  
  62.         Note that you don't have to run this program as the ARexx scripts
  63.             will call it if not already running.
  64.         To terminate the FindDoc server, either send it a control-C, or
  65.             send "quit" to it's rexx port.
  66.         The only other ARexx command it responds to is "find <entryname>". It
  67.             will return a string containing the file to look in and the
  68.             line number. If multiple entries are found, then the result
  69.             strings will be concatenated.
  70.             The entry name can be quoted.
  71.