home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / FAP100.ZIP / FAP.DOC < prev    next >
Text File  |  1992-08-15  |  10KB  |  252 lines
  1. ─ File Announcer for Points v1.00 ──────────── Copyright Steve Mulligan 1992 ─
  2.  
  3.    Special Thanks go to Peter Beeftink for writing the really important parts
  4. of FAP that I didn't know how to do.  He told me to learn Pascal so I did and
  5. this program is the result.  Steve Mathieson for his great beta testing and
  6. constant support.  Paul Venne for opening up an echo area for us called
  7. BETA305.  This was where all the beta testing was done and it really helped
  8. a lot.  Jeff Galbraith for making a great program called MAKEMSG.  It is
  9. distributed in this archive because FAP needs it to announce files in it's
  10. message bases.
  11.  
  12. ─ Introduction ─
  13.  
  14.    File Announcer for Points (also called FAP) is a program that will scan
  15. any specified directory for new files and post the new files in a Squish or
  16. MSG style message base.  It will also convert RSP files to messages for you.
  17. I made FAP because I like to F'REQ files a lot. Sometimes too much.  Anyhow,
  18. I get all these files in and forget that I F'REQ'ed them and when I go look in
  19. my NetFile directory, I've got a ton of files.  After a long time, I wished I
  20. had a program that would announce these files for me when they arrived.  So...
  21. I saddled up my trusty Turbo Pascal book and gathered up my beta testers and
  22. here you go.  FAP.  A program that announced new files for you in a Squish or
  23. MSG style message base.
  24.  
  25. ─ Setting up FAP ─
  26.  
  27.    To install FAP, just copy all the files to your mailer directory (if you
  28. have one).  Files in this archive should be:
  29.  
  30.      FAP.EXE                 - Executable program you run
  31.      FAP.DOC                 - Your reading it
  32.      FAP.CFG                 - Sample config file
  33.      MAKEMSG.EXE             - Text file to message converter
  34.      MAKEMSG.DOC             - Documentation to MAKEMSG
  35.      
  36.    After all the files are in the right spot, edit the text file FAP.CFG and
  37. change the options as necessary.  See the next section on how to set up the
  38. configuration file.
  39.  
  40. ─ FAP and the Config File ─
  41.  
  42.    Here is a list of all the config verbs that FAP understands.  All commands
  43. and parameters are not case sensitive.  They can have spaces anywhere.  If a
  44. line starts with a ; then it will be treated as a comment and skipped.
  45.  
  46. NetFile
  47.  
  48. The NetFile option tells FAP where to look for new files.  You can enter up
  49. to 8 of these.  Duplicates will be ignored.  This should point to the
  50. directory that your mailer puts new files into.
  51.  
  52. eg : NetFile d:\modem\bbs\file
  53.  
  54. FileExclude
  55.  
  56. The FileExclude verb tells FAP where to find the list of files to exclude from
  57. new file scanning.  This file holds the full path and file name of any file
  58. that has been scanned by FAP.  If a file is found in a directory and is in the
  59. FileExclude file, it is not announced.  This stops files from being announced
  60. more than once.  The default is EXCLUDE.DAT.
  61.  
  62. eg : FileExclude EXCLUDE.DAT
  63.  
  64. Area
  65.  
  66. The Area verb tells the FAP where to put the file announcements.  It should
  67. point to a Squish or .MSG style base.  NOTE: This message base must already
  68. exist or it will not work.  THIS MUST BE INCLUDED.  THERE IS NO DEFAULT!
  69.  
  70. eg : Area d:\msgs\cvpfiles
  71.  
  72. NumberAnnounce
  73.  
  74. The NumberAnnounce verb tells you how many files announcements will go in each
  75. message.  The default is 3.  If there are more than the number specified, it
  76. will be broken into multiple messages.  You cannot have more than 32 files per
  77. message.  Any number greater will be reset to 32.  The larger the number, the
  78. less FAP has to shell to DOS to run MAKEMSG so FAP will run a lot faster if
  79. you get many files in one transfer.
  80.  
  81. eg : NumberAnnounce 3
  82.  
  83. AreaType
  84.  
  85. The AreaType verbs tell FAP what message area to support.  Right now, FAP
  86. supports Squish and MSG bases.  Put the word Squish after AreaType to use
  87. Squish style bases.  Put the word MSG after the AreaType to use MSG type
  88. bases.  Squish is the default
  89.  
  90. eg : AreaType Squish
  91.            or
  92.      AreaType MSG
  93.  
  94. AddressFrom
  95.  
  96. The AddressFrom verb is to define the address the message is from.  This MUST
  97. be included if there is no AddressTo verb.
  98.  
  99. eg : AddressFrom 1:163/305.30
  100.  
  101. AddressTo
  102.  
  103. The AddressTo verb is to define the address the message is from.  This MUST
  104. be included if there is no AddressFrom verb.
  105.  
  106. eg : AddressTo 1:163/305.30
  107.  
  108. FAPTempFile
  109.  
  110. The FAPTempFile verb points to the temp file.  The default is NEWFILE.FAP. The 
  111. temp file simply stores the text that will go into the file announcement
  112. message.  If a file by the name given already exists, it will be erased.
  113.  
  114. eg : FAPTempFile NEWFILE.FAP
  115.  
  116. MAKEMSGTempFile
  117.  
  118. The MAKEMSGTempFile verb points to the temp file that FAP makes for MAKEMSG.
  119. The default is MSGMK.CFG.  If this file already exists, it will be erased.
  120.  
  121. eg : MAKEMSGTempFile MSGMK.CFG
  122.  
  123. From
  124.  
  125. The From verb is what appears on the From line of the message.  FAP and then
  126. the version is the default.  If you want the right version number displayed,
  127. do not include a from line.
  128.  
  129. eg : From FAP v1.00
  130.  
  131. To
  132.  
  133. The To verb is what appears on the To line of the message.  All is the
  134. default.
  135.  
  136. eg : To All
  137.  
  138. Subject
  139.  
  140. The Subject verb is what appears on the Subject line of the message.
  141. "New Files" is the default.  (without the surrounding quotes).
  142.  
  143. eg : Subject New Files
  144.  
  145. OriginLine
  146.  
  147. The OriginLine verb tells FAP what to put on the Origin Line of your message.
  148. DO NOT PUT YOUR ADDRESS HERE.  It will be added to the end of the Origin Line
  149. by FAP. The default is :
  150.  
  151.         'Point System Using FAP ' + Version + ' * (' + FromAddress + ')'
  152.  
  153. eg : OriginLine Carp Valley Point * Carp, Ontario
  154.  
  155. AutoUpdate
  156.  
  157. The AutoUpdate verb tells FAP that the EXCLUDE.DAT file will be automatically
  158. updated.  This means if there is a file in a directory listed in the
  159. EXCLUDE.DAT file and it is later deleted, it will also be removed from the
  160. EXCLUDE.DAT next time FAP runs.  AutoUpdate can be Yes or No.  The default
  161. is Yes.
  162.  
  163. eg: AutoUpdate Yes
  164.  
  165. TICAnnounce
  166.  
  167. The TICAnnounce verb tells FAP if it should read into TIC files and announce
  168. the files that appear in them.  Valid options are Yes and No.  The default is
  169. Yes.  This is useful if you get files from a file distribution net because
  170. files you get from there often come with TIC files accompanying them.  This
  171. will allow files to have descriptions and other important information added
  172. to the file announcement.
  173.  
  174. eg : TICAnnounce Yes
  175.  
  176. RSPAnnounce
  177.  
  178. The RSPAnnounce verb tells FAP if it should convert files with the RSP
  179. extension into a message.  Valid options are Yes and No.  The default is Yes. 
  180. Sometimes when you file request a file from a BBS but you get the password
  181. wrong or the file cannot be found, they BBS will return a RSP file.  FAP will
  182. post this file to you message base.
  183.  
  184. eg : RSPAnnounce Yes
  185.  
  186. ─ Running FAP ─
  187.  
  188.    Once you have done all the above, you can run FAP.  It takes one command
  189. line argument; the config file name.  You can rename FAP.CFG to any file and
  190. then type FAP <configname> or just keep the name and run fap without any
  191. command line options.
  192.  
  193.    FAP will display a title screen and proceed to scan your directories using
  194. some calls to DOS.  It will then put a list of all files that did not appear
  195. in the ExcludeFile file in a file called TempFile you define.  FAP then shells
  196. to DOS and runs MAKEMSG and your Squish or .MSG base gets a new message in it.
  197. If a file did not appear in the ExcludeFile file, it will be added so that
  198. when FAP runs again, you will not get the same files announced over and over.
  199.  
  200.    If you continue to use FAP, I would LOVE to hear from you.  I just want to
  201. know if you like the program or you think I should stop development.  If you
  202. wish to make a comment (PLEASE) NetMail Steve Mulligan 1:163/305.30
  203.  
  204.    NOTE: MAKEMSG is distributed also in this archive.  It is in no way at all
  205. related to me.  I did not make it.  Jeff Galbraith did.  I use it because I
  206. do not yet know how to convert text files to Squish or .MSG bases.  If you
  207. have any code you could give me, please forward it to me.
  208.  
  209. ─ Beta Testers Wanted ─
  210.  
  211.    If you are in the 163 or 243 net or you don't mind polling long distance
  212. you are eligible to be a beta testers.  Simply NetMail Steve Mulligan at
  213. 1:163/305.30.  I will reply to you and tell you how to get the latest beta
  214. versions of software I make.
  215.  
  216. ─ On the Drawing Board ─
  217.  
  218.    This is a list of all the features my Beta Testers and I want to have added
  219. to FAP.  I'll get around to it in a while.  PLEASE ADD TO LIST AND FORWARD TO
  220. STEVE MULLIGAN 1:163/305.30.  If you want to become a Beta Tester, NetMail me
  221. and I'll send you beta releases.
  222.  
  223. 1.01ß   · Allow user to config appearance of file announcements.
  224.  
  225. 1.02ß   · Command line usage.
  226.  
  227. 1.10    · Next public release.
  228.  
  229. THE FOLLOWING VERSIONS ARE EXPECTED AFTER SEPT 1st.  NOT BEFORE.
  230.  
  231. 1.11ß   · Support FLE files.  All I have to do is get the format of
  232.           these files!  Any idea's?
  233.  
  234. 1.12ß   · Get rid of excess units and global variables.
  235.  
  236. 1.13ß   · Get rid of MAKEMSG.  Drop MSG support.
  237.  
  238. 1.20    · Another public release.  Should be smaller and faster!
  239.  
  240. 1.21ß   · Add MSG support.
  241.  
  242. 1.22ß   · Look into Hudson message bases and MAYBE use them.
  243.  
  244. 1.30    · Probably the last release.  Alas.
  245.  
  246. ?.??    · My file FDN.  This way, I can release updates & patches
  247.           to my users really fast.
  248.  
  249. If you have any additions to this list or any bugs, please let me know!
  250.  
  251. Steve Mulligan 1:163/305.30@fidonet.org
  252.