home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d3xx / d325 / farprint.lha / FarPrint / FarPrint.doc < prev    next >
Text File  |  1990-02-27  |  5KB  |  109 lines
  1.                           - FarPrint v1.5 -
  2.         Debugging functions for programs which don't have any
  3.                      links to their environment.
  4.  
  5.         IMPORTANT! FarPrint NEEDS the Arp.Library, read below!
  6.  
  7.                              BACKGROUND:
  8.                              -----------
  9. Your  compiler usually comes with a set of debugging functions, called
  10. the  debug.lib.   In this collection of routines you will find various
  11. functions  to communicate with a terminal connected to the serial port
  12. of  your  Amiga  at 9600 bps.  A fine idea, but - are you one of those
  13. lucky  guys who own two Amigas or an Amiga and a PC?  If not, FarPrint
  14. may  help  you.  The FarPrint package was created to support debugging
  15. the  fantasy  roleplaying  game  "Legend  of  Faerghail"  and has been
  16. successfully tested with various other projects.
  17.  
  18.                               FEATURES:
  19.                               ---------
  20. FarPrint  consists  of  two  major parts:  one harbour process open to
  21. receive  and  distribute  messages  and  requests  and  a  set  of 'C'
  22. functions  to  be  linked into any program wishing to communicate with
  23. the FarPrint main process.  While the standard debug.lib functions may
  24. even  be able to get a message through when the Amiga has already gone
  25. home  to  its  masters (Guru!), FarPrint requires the standard program
  26. environment  (exec, dos, intuition & graphics) to be intact to display
  27. messages.    The   interface   routines   use  the  functions  of  the
  28. exec.library only, so they are safe to call even from low-level tasks.
  29.  
  30. The  FarPrint  main  process  runs as an independent program, since it
  31. detaches  itself  from  the  CLI  process  it  has  been started from.
  32. Gadgets  are provided to scroll through the list of recorded messages.
  33. Menu  selections  can  be  used  to interrupt the activity of FarPrint
  34. (Pause/Continue),  save  the  list of recorded messages and to iconify
  35. the FarPrint window.
  36.  
  37. FarPrint  can  record  up to 128 messages, when the buffer is full the
  38. oldest messages get discarded to make room for the new messages.
  39.  
  40. Version  1.5  introduces a shared library as a replacement for the 'C'
  41. language communcation routine fragment.  Note that this library can be
  42. opened  from processes only or fireworks will be seen tonight (you may
  43. alternatively still use the FarCom.c package).  The text print routine
  44. can   be   called  from  interrupt  code  now  since  texts  are  sent
  45. asynchronously.   This  version  also introduces linker code & library
  46. glue routines for both Lattice & Manx.
  47.  
  48.                             REQUIREMENTS:
  49.                             -------------
  50. To  execute  successfully,  the  FarPrint  main  process  requires the
  51. arp.library.   Any  version  will  do, version 39.1 is best.  FarPrint
  52. uses  the  famous  file requester for message saving.  FarPrint is not
  53. limited to a special amount of memory.
  54.  
  55.                             INSTALLATION:
  56.                             -------------
  57. Put  arp.library and farprint.library into LIBS:, FarPrint into C:  or
  58. SYS:   and compile the supplied FarCom.c routines.  Lattice users will
  59. have  to assemble the assembly language part separately or may use the
  60. supplied  latticefarcom.lib  instead.  The resulting object files will
  61. have to be linked to your program code.
  62.  
  63.                                CREDITS:
  64.                                --------
  65. Credits  go  to ARP Programmers for the phantastic ARP 1.3 release, Ed
  66. Hoogerbeets,  Jimm Mackraz & Neil Katin for the library skeleton code,
  67. Leo Schwab for the basic Iconify routine, Justin V.  McCormick for the
  68. printf()-like  formatting  routine  and  to  Jürgen Haage whose R.C.T.
  69. (Requester  Construction  Tool)  was  employed to construct the gadget
  70. environment.  Thanks to all of you.
  71.  
  72.                    COPY FEE, AUTHORS REQUEST, ETC.:
  73.                    --------------------------------
  74. If you like FarPrint program and wish to contribute any money I urge you
  75. to send at least 5$ to...
  76.  
  77.                           Amnesty International
  78.                           P.O. Box 37137
  79.                           Washington D.C. 20013
  80.  
  81. I  suppose Amnesty International can make better use of the money than
  82. I can.
  83.  
  84. I don't care what happens to FarPrint, copy it, sell it, delete it, it
  85. is meant to be PUBLIC-DOMAIN.  But don't 'fleece' other users for it.
  86.  
  87.  
  88.            DEVELOPMENT HISTORY (most recent change first):
  89.            -----------------------------------------------
  90. V1.5    Gadget response now generally better, scrolling speeded up
  91.     slightly, new shared library introduced, texts are now sent
  92.     asynchronously to the harbour process (even interrupt code
  93.     is able to call these routines now!), support files for
  94.     both Lattice & Manx added.
  95.  
  96. V1.4    Added keyboard control (cursor up and down scroll the list),
  97.     got rid of the flashing of the list and took care of the
  98.     main window (if active, action is suspended). Pause/skip
  99.     function redefined (will ignore all incoming actions
  100.     now).
  101.  
  102. V1.3    First public release, easy and (hopefully) comfortable enough.
  103.  
  104. V1.2    Skipped.
  105.  
  106. V1.1    Skipped.
  107.  
  108. V1.0    Fortunately not published.
  109.