home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / gap / msgmkr10.zip / MSGMKR.DOC < prev    next >
Text File  |  1994-07-23  |  12KB  |  297 lines
  1. Message Maker Version 1.0 - For GAP Version 6.x BBS Systems
  2. Copyright (c) 1994, Anthony Summy - The Main Shop
  3.  
  4.  
  5. WARRANTY - (aint there)
  6. ~~~~~~~~~~~~~~~~~~~~~~~
  7. The Main Shop, and Anthony Summy, (herein known as AUTHOR), disclaim all
  8. warrenties of any kind as to the usability or fitness of this product for any
  9. specific or particular purpose.  AUTHOR can not and shall not be liable for
  10. any incidental, consequential, indirect or direct damages due to the use of
  11. this product, including but not limited to loss of data, equipment, or any
  12. other reason, even if the AUTHOR or representative of AUTHOR has been advised
  13. or has received prior knowledge of the possibility of such damage.  The user
  14. of this product assumes ALL risk as to the quality and performance of this
  15. product.  <so there...>
  16.  
  17.  
  18. LICENSE - (legal stuff)
  19. ~~~~~~~~~~~~~~~~~~~~~~~
  20. Message Maker is SHAREWARE!  As such, license is hereby granted for use of
  21. this product for a REASONABLE amount of time from your FIRST execution of the
  22. program in any form.  A REASONABLE amount of time can not be definitively
  23. limited by AUTHOR, due to the nature of the product, and therefore it is left
  24. up to the user of the product to define a length of time which you deem as
  25. REASONABLE.  It is assumed by this license agreement that the user of the
  26. product will either immediately have a basis for determining usefullness, or
  27. will remove the product from your personal computer.  If usefullness is
  28. determined, you are required by fedral law to register the product with the
  29. AUTHOR.
  30.  
  31.  
  32. REGISTRATION - (send me money)
  33. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34. You may register the product by sending the enclosed REGISTER.DOC along with a
  35. check or money order for $20.00 to the address on the form.
  36.  
  37. This product is NOT fully functional when not registered!  However, the only
  38. functions disabled prior to registration are the ability to disable or alter
  39. taglines, and the ability to attach a file to the imported message.  The
  40. '-TAG:',  '-AF:' and '-NT' parameters outlined below are simply ignored.
  41.  
  42. I regret having to do this, but in my past experience with shareware, products
  43. released as shareware with all features fully functional do not get
  44. registrations.  I therefore decided to offer, as an incentive, a more capable
  45. product once it has been registered.
  46.  
  47.  
  48. TECHNICAL SUPPORT - (only a phone call away)
  49. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50. Comments and suggestions about Message Maker For GAP are welcome and
  51. encouraged.  Please call The Main Shop BBS at the number below.  I can also be
  52. reach through any of several national and international networks, including
  53. RIME (in the MainMail/GapDoors channel), Intelec (in the MainMail Support
  54. forum), HCSNet and others.  I also monitor the support forum on The Crow's
  55. Nest BBS, home of GAP Development Company.
  56.  
  57. The Main Shop
  58. P.O. Box 4284
  59. Orange, CA  92613
  60. (714) 288-1411 - Voice
  61. (714) 288-1320 - Data
  62.  
  63. Now, on with the show.....
  64.  
  65.  
  66. WHAT IS MESSAGE MAKER
  67. ~~~~~~~~~~~~~~~~~~~~~
  68. The purpose of this product is to import an ordinary TEXT file as a
  69. message into a GAP BBS system.  Message Maker uses a config file or
  70. command line parameters (or both) and an ascii text file to do so.
  71. Command line parameters consist of the name the message is to be sent
  72. to, the name of the ascii text file to import, and many others
  73. outlined later in this manual.
  74.  
  75.  
  76. HOW TO INSTALL MESSAGE MAKER
  77. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  78. Installation is very simple.  Place the EXE in your path.  That's it!  Message
  79. Maker uses your GAPCNF environment variable to find GAPBBS.CNF & DOOR.SYS if
  80. needed, (or you can specify the path to your default directory on the command
  81. line), and then reads those files to access the GAP user file, forum file, and
  82. any necessary message base(s).
  83.  
  84.  
  85. MULTI-NODE
  86. ~~~~~~~~~~
  87. MOST IMPORTANT OF ALL!!!  There are TWO versions of Message Maker For GAP, a
  88. single node version, and a multi node version.  If you are using the single
  89. node version of GAP, then you MUST use the single node version of Message
  90. Maker.  If you are using the multi node version of GAP, then you MUST use the
  91. multi node version of Message Maker.  DO NOT MIX VERSIONS!  Doing so could
  92. PERMINANTLY DAMAGE YOUR GAP USER FILE!    ---- Just dont do it! ----
  93.  
  94. The Multi user version is named : MSGMKRM.EXE
  95. The Single user version is named: MSGMKRS.EXE
  96.  
  97. When using the multi node version, you can use Message Maker while any number
  98. of nodes are active.  There are absolutely no restrictions regarding file
  99. sharing and multi user file locking.  Message Maker uses the same database
  100. routines as GAP, so as far as the other nodes of GAP know, Message Maker is
  101. simple an additional node.
  102.  
  103.  
  104. COMMAND LINE SWITCHES AND PARAMETERS
  105. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  106. NOTE: You may substitute a forward slash '/'  for a dash '-' used in the
  107.       examples below. '/' and '-' are interchangable, but ONE of them MUST be
  108.       used.
  109.  
  110.  
  111. -A:<#>
  112.  
  113. Area (forum) number, to import into (default = 0 <main board>)
  114.  
  115.  
  116. -AF:<filename>         REGISTERED VERSION ONLY!
  117.  
  118. Path and file name of an ATTACHED file.  Message Maker will attach this file
  119. specified as <filename> to the imported message.  This parameter is ignored if
  120. the product is not registered.
  121.  
  122.  
  123. -CFG:<filename>      (required, or '-M:' with '-D' or '-T'. see notes)
  124.  
  125. If specified, Message Maker will use <filename> to read command line
  126. parameters from.  <filename> should be a straight ascii text file,
  127. with each parameter on a single line.  ANY command line parameter
  128. except '-CFG:' can be placed into the config file.  If a parameter is
  129. specified both in the config file, and on the command line, the
  130. command line takes precedence.
  131.  
  132.  
  133. -D
  134.  
  135. Tells Message Maker to read DOOR.SYS for the name of the user to send the
  136. message to.
  137.  
  138.  
  139. -F:<first last>
  140.  
  141. User name whom this message is to be FROM (default = "SYSOP")
  142.  
  143.  
  144. -G:<gap default dir path>  (required or GAPCNF environment variable)
  145.  
  146. Path to your GAP default directory (where GAPBBS.CNF is) (default = read the
  147. GAPCNF environment variable).  NOTE: This parameter is required if the GAPCNF
  148. environment variable is not present.
  149.  
  150.  
  151. -M:   (required - see notes)
  152.  
  153. Full path and name of the ascii text file to import as a message.  If the text
  154. file is in the current directory, then you need not specify the path, only the
  155. file name.
  156.  
  157.  
  158. -NT                 REGISTERED VERSION ONLY!
  159.  
  160. 'No Tagline'.  When specified, there will not be any tagline appended to the
  161. message.  This parameter is ignored if the product is not registered.
  162.  
  163.  
  164. -P
  165.  
  166. Make message PUBLIC.  (default = PRIVATE)
  167.  
  168.  
  169. -S:<message subject>  (limit 25 characters)
  170.  
  171. Alternate message subject. (default = "Important Message")
  172.  
  173.  
  174. -T:<first last>
  175.  
  176. Name of the receiver of the message ie: -T:FRANK HAGAN (default = "SYSOP")
  177.  
  178.  
  179. -TAG:<alternate tagline>  (limit 50 chars)   REGISTERED VERSION ONLY!
  180.  
  181. When specified, this text will be placed after the '■ MsgMkr vX.XX ■' portion
  182. of the tagline.  This parameter is ignored if the product is not registered.
  183.  
  184.  
  185. -V
  186.  
  187. Verbose.  Display message as it is being imported.  (Message Maker displays
  188. the message header information at all times)
  189.  
  190.  
  191.  
  192. NOTES - MINIMUM COMMAND LINE PARAMETERS
  193. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  194. You must specify at the very least, either on the command line or within the
  195. config file, a message file to import, and a TO: name or a FROM: name.
  196.  
  197. -M:<message file>    <required>
  198. -T:<first last> or -D or -F:<first last>   <at least one is required>
  199.  
  200. Default for both TO: and FROM: is "SYSOP" and a message cannot be both
  201. TO and FROM the SYSOP.  An alternate of at least one of these is
  202. required.  TO: can be specified with either '-T:' or '-D', and FROM:
  203. can be specified with '-F:'
  204.  
  205. If a config file is used, then the only required command line parameter is
  206. '-CFG:'.  If any parameter(s) is (are) specified BOTH on the command line AND
  207. in the config file, the COMMAND LINE will override the config file.
  208.  
  209.  
  210.  
  211. ERROR CONDITIONS
  212. ~~~~~~~~~~~~~~~~
  213. Should an error occur, Message Maker exits with an error level.  The error
  214. levels and their descriptions are below:
  215.  
  216. 1 - Command line parameters '-D' and '-T:' used simultainiously.
  217.     Must use only one or the other.
  218. 3 - No message text file specified.  Use '-M:' command line parameter.
  219. 4 - No path to GAP default directory specified.
  220.     Use 'GAPCNF' environment variable or '-G:' command line parameter.
  221. 5 - GAPBBS.CNF not found, or path incorrect.
  222. 6 - FORUM.DAT not found, or path incorrect.
  223. 7 - Memory allocation error.
  224.     Out of memory during allocation or corrupted heap space.
  225. 8 - Error opening MESSNO.DAT, not found or path incorrect.
  226. 9 - Error while obtaining lock on MESSNO.DAT.
  227. 10 - DOS error while opening message text file.
  228. 11 - ISAM error occured.  Process aborted.
  229. 12 - Error while attempting to open DOOR.SYS.
  230. 13 - Invalid user name in DOOR.SYS.
  231. 14 - Invalid name in CFG file.
  232. 15 - Message cannot be FROM and TO Sysop. Use '-F:' or '-T:' for alternate.
  233.  
  234.  
  235.  
  236. ACKNOWLEDGEMENTS
  237. ~~~~~~~~~~~~~~~~
  238. Message Maker is written in Borland C/C++ 3.1 and is highly optimized for
  239. speed.  Every effort has been made to make Message Maker safe and fast, and we
  240. think you'll find that it meets or surpasses all expectations.
  241.  
  242. The following libraries and aftermarket utilities were used in the production
  243. of Message Maker For GAP:
  244.  
  245. - C-TREE Ver 4.3 (c) Copyright 1988, Faircom Corporation
  246. - BUFIO Ver 2.0 (c) Copyright 1988-1994 by Mark Turner,
  247.             and (c) Copyright 1994 by Anthony Summy - The Main Shop
  248. - MAINLIB Ver 6.4 (c) Copyright 1991-1994 by Anthony Summy
  249.  
  250. Some routines (c) Copyright 1988-1994, The GAP Development Company
  251.  
  252.  
  253. OTHER PRODUCTS
  254. ~~~~~~~~~~~~~~
  255. The Main Shop is author of a host of utilities and products.  Here is a list
  256. of the most popular ones:
  257.  
  258. The MainMail System
  259.    GAP'S QWK mail door.  The MainMail System operates as a door on your GAP
  260.    bbs system, and allows your users easy and fast access to QWK packets.  Up
  261.    to 20 compression methods, and 20 file transfer protocols, up to 64
  262.    networks, and unlimited forums, Pre-scanned packets and much MUCH more.
  263.    Look for MM3DEMO.ZIP for a full featured trial.  Registration is only
  264.    $35.00.
  265.  
  266. QXL
  267.    QWK Translation Utility.  Translates a QWK reply (REP) packet from one hub
  268.    ID to another quickly and transperently.  Usefull if you are a network node
  269.    in a QWK based network, obtaining mail from a thrid party source such as a
  270.    sattelite, and uploading to a normal QWK hub.  Written using the same fast
  271.    I/O routines used in Message Maker.  Registration is $10.00 and it's well
  272.    worth it!  Look for QXL10.ZIP for the full package.
  273.  
  274. MAINPACK
  275.    Selectively packs your GAP ISAM files.  Using a config file, MainPack
  276.    checks the size of your GAP message base against a pre-determined maximum,
  277.    and calls GAPPACK if the message file is larger.  Allows you to monitor
  278.    your GAP message bases without having to pack them all, each day.  Creates
  279.    a log of it's activities so you can easily determine any needed
  280.    adjustments.  Registration is FREE.  Look for MPACK32.ZIP for the full
  281.    package.
  282.  
  283. PURGEM
  284.    Purge your MEMBER file based on 'last date joined'.  Most of us have users
  285.    who join a forum, only to find that they are not interested in it.  This
  286.    creates a MEMBER record that will never again be used.  PurgeM detects
  287.    these records, and removes them from your MEMBER file.  This keeps your
  288.    MEMBER file trim and fast.  Registration is FREE.  Look for PURGEM.ZIP for
  289.    the complete package.
  290.  
  291. If you have any questions on any of the above products, please give me a call
  292. and I will be happy to help in any way I can.  Thank you for trying Message
  293. Maker.
  294.  
  295. Tony Summy - Author
  296. 07/23/94
  297.