home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / vpjam123.zip / JamAPI.Doc < prev    next >
Text File  |  1997-09-03  |  4KB  |  94 lines
  1.               VPJAM - a JAM API for Virtual Pascal, Version 1.2
  2.                  for Virtual Pascal for OS/2, Version 1.10
  3.      Copyright (C) 1996-97 Dusk To Dawn Computing. All Rights Reserved
  4.  
  5. 1. Introduction: (What is JAM?)
  6. ~~~~~~~~~~~~~~~~
  7.    JAM is a format for message systems, primarily FidoNet-style BBS systems.
  8. It was created in 1993 by Joaquim Homrighausen, Andrew Milner, Mats Birch,
  9. and Mats Wallin to be a new standard for FidoNet message bases, and as a way
  10. to replace the older Hudson message base.  It was first implemented in
  11. Milner's BBS software, RemoteAccess.  It is an advanced message architecture,
  12. supporting multiple file attachments, nearly unlimited message size (Up to 2
  13. gigabytes per message), password protection, complete reply tracking,
  14. programmer-defined message subfields for any purpose necessary, and quite a
  15. bit more than can be described in this paragraph.  :)
  16.  
  17. 2. Disclaimer:
  18. ~~~~~~~~~~~~~~
  19.    VPJAM is guaranteed only to take up disk space.  Though this unit has been
  20. thoroughly tested on my machine, I have no way of knowing what your setup is;
  21. and as always, if it breaks, you have the pieces.
  22.  
  23. 3. About this implementation:
  24. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25.    VPJAM, my version of the JAM API, was created so that I could write my BBS
  26. software, Aspect/2.  I wanted to support JAM and SquishMail bases, but didn't
  27. have a JAM API for OS/2, and especially one for Virtual Pascal...It took me
  28. quite a while to find the original JAM API for DOS, which thankfully included
  29. a Turbo Pascal version.  I used the TP version as a template for my own
  30. version (although many things are implemented in a more Pascal-like manner in
  31. my version), while I had to implement a few things on my own (Like the Unix
  32. time conversion routines).
  33.  
  34. 4. Installation
  35. ~~~~~~~~~~~~~~~
  36.    Basically, run the installation program, pick the directories you want the
  37. various components to be installed into, and let it go. You should then be
  38. able to use the library.
  39.  
  40. 5. Files included:
  41. ~~~~~~~~~~~~~~~~~~
  42.  
  43. Unit files:
  44.    JAM.LIB/VPI       Declarations and record definitions
  45.    JAMMB.LIB/VPI     The actual message base object class
  46.    JAMINFO.LIB/VPI   Utility functions for included sample message viewer
  47.  
  48.    D2DCRC.LIB/VPI    Dusk To Dawn Computing's CRC32 unit
  49.    UNIXTIME.LIB/VPI  Dusk To Dawn Computing's tDateTime <-> tUnixTime unit
  50.  
  51. Source files:
  52.    JAM.INT           Interface for declarations and record definitions
  53.    JAMMB.INT         Public interface for message base object
  54.    JAMINFO.PAS       Source for utility functions used in sample viewer
  55.    JAMUTILP.PAS      Source for sample JAM message base viewer
  56.  
  57.    D2DCRC.INT        Public interface for CRC32 unit
  58.    UNIXTIME.INT      Public interface for UnixTime unit
  59.  
  60. Resource files:
  61.    JAM.H             C-style header file for JAM.RC
  62.    JAM.RC            RC.EXE source file for VPJAM's resources
  63.  
  64. Executables:
  65.    JAMUTILP.EXE      Sample JAM message base viewer/reader
  66.  
  67. 6. Using VPJAM
  68. ~~~~~~~~~~~~~~
  69. The only usage documentation included directly in this release is the sample
  70. message base viewer, the interfaces for the units, and the source for the
  71. JAMInfo unit. It's pretty much self-documenting code, so that shouldn't be too
  72. much of a problem, but if you have questions or problems in implementation,
  73. feel free to send me email about it.
  74.  
  75. 1.23 Update: There is an ongoing project to completely document VPJAM in HTML
  76. format. The documentation is available at the URL:
  77.  
  78.      http://DuskNet.dyn.ml.org/Pascal/VPJAM/
  79.  
  80. In a future release, the HTML documentation may be included in the base
  81. package, once it is complete and ready.
  82.  
  83. 7. Contacting me
  84. ~~~~~~~~~~~~~~~~
  85. I have two email addresses; the first, an account on the Grand Rapids Free-Net,
  86. is deek@grfn.org. The second is on my BBS, (located at DuskNet.dyn.ml.org if
  87. you would like to telnet there) and that is sysop@DuskNet.dyn.ml.org. I can
  88. also be found from time to time on the EFnet IRC network, using the nickname
  89. Deek, and in the channels #OS/2 and #OS2Prog.
  90.  
  91. If you have suggestions or have a bug to report, *please* email them to me!
  92. That way I can keep an archive of what suggestions I've looked at/worked
  93. on/added in, and I can also keep track of who suggested what.
  94.