home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMNETML / AFR100.ZIP / AFR.DOC < prev    next >
Encoding:
Text File  |  1993-03-11  |  7.5 KB  |  185 lines
  1. ─ AreaFixer v1.00 ─────────── Copyright 1993 Peter Beeftink & Steve Mulligan ─
  2.  
  3. NOTE : If you use AreaFixer and you NetMail me, Steve Mulligan, at
  4.        1:163/307.30 then I will send you a NetMail every time I
  5.        release a version of AreaFixer and I will tell you when and
  6.        where I have sent it.
  7.  
  8. ─ Introduction ─
  9.  
  10.   AreaFixer (from now on refered to as AFR) is a program that will scan your
  11. NetMail directory for AreaFix messages, extract needed AreaFix information
  12. and update the needed files that you specify.
  13.  
  14. ─ How To Install AFR ─
  15.  
  16.   AFR should be run right after your mail is unpacked.  If you have a batch
  17. file, put it right after your mail tosser runs.  It takes on command line
  18. that is optional.  It is the config file name.  If there is no command line,
  19. AFR.CFG is the assumed CFG file name.
  20.  
  21. ─ The Config File ─
  22.  
  23.   AFR is quite the powerfull little tool.  It is in the config file that you
  24. setup that AFR draws all it's power.  In the config file, lines that start
  25. with a ; will be ignored.
  26.  
  27. The following options tells AFR what names, addresses and subjects to look
  28. for in your NetMail message base to determine if a message is from AreaFix.
  29.  
  30. You can have up to 8 blocks of each.  The defaults for all of them except
  31. for Subject is blank.  The default for Subject is 'Re: AreaFix Change
  32. Requests'.  All fields are not case sensitive.
  33.  
  34. A 'block of information' as shown below, starting with the keyword 'To' and
  35. ending with the keyword 'Subject' must be entered in the SEQUENCE as shown
  36. below.  There MUST be a minimum of one block.  Parameters are not necessary
  37. but once a block is started, every keyword must be listed, with or without
  38. parameters.
  39.  
  40. eg:
  41. [beginning of a block (a)]
  42. To Joe User
  43. AddressTo 1:22222/33
  44. From Joe Sysop
  45. AddressFrom 1:444/55
  46. Subject Re: AreaFix Change Requests
  47. [end of a block (a)]
  48.  
  49. [beginning of block (b)]
  50. To Joe User
  51. AddressTo 1:66666/77
  52. From Someother Sysop
  53. AddressFrom 1:888/99
  54. Subject Re: AreaFix Change Requests
  55. [end of block (b)]
  56.  
  57. This would assume that all messages
  58.  
  59. a) Are to Joe User, have a destination address of 1:22222/33, are from Joe
  60.    Sysop, have an originating address of 1:444/55 and a subject of
  61.    Re: AreaFix Change Request
  62.  
  63. b) Are to Joe User, have a destination address of 1:66666/77, are from
  64.    Someother Sysop, have an originating address of 1:888/99 and a subject of
  65.    Re: AreaFix Change Request
  66.  
  67. and consider them AreaFix messages and process them as such.
  68.  
  69. The FileUpdate verb defines how and what files AFR should modify when there
  70. is a new message are found.  The format used is the file name you want
  71. updated, then the line you want added to the end of the file specified.  You
  72. can have up to eight of these.  You will want to put the AREATAG or path name
  73. to a message base in somewhere, you can do this using a # sign code.  Here is
  74. a list of the # sign codes:
  75.  
  76. ##     Place a # where the ## is.
  77. #1     Place the AreaTag where the #1 is.
  78. #2     Place the first eight letters of the AreaTag where the #2 is.  This
  79.        is usefull for filenames.
  80. #3     Place the origin address where the #3 is.
  81. #4     Place the destination address where the #4 is.
  82. #5xxx  Move to tabstop xxx.  xxx must be three digits. (leading zero's
  83.        are required).
  84. #6     Wild Card code.  When AFR searches to see if a certain line is in
  85.        a file already, it will search for an exact match except where these
  86.        are placed.
  87.  
  88. eg:
  89.  
  90. FileUpdate AREAS.BBS #5002$e:\msgs\#2 #5025#1 #5041#3
  91. FileUpdate GOLDAREA.CFG AREA #1 #5017"#6" #5048ME e:\msgs\#2
  92.  
  93. This will add a line to the end of AREAS.BBS and GOLDAREA.CFG containing the
  94. neccasarry information.  NOTE:  Because of the #6, you can also add a
  95. description between the quotes and AFR will not mind.
  96.  
  97. The AreaPath verb tells the AFR where to scan for AreaFix messages.  It should
  98. point to a Squish, MSG or QBBS style base.  NOTE: This message base must
  99. already exist or it will not work.  THIS MUST BE INCLUDED.  THERE IS NO
  100. DEFAULT!
  101.  
  102. AreaPath e:\msgs\netmail
  103.  
  104. The AreaType verbs tell AFR what message area to support.  Right now, AFR
  105. supports Squish, MSG and QBBS bases.  Put the word Squish after AreaType to
  106. use Squish style bases.  Put the word *.MSG after the AreaType to use MSG
  107. type bases.  Put the word QBBS to use QBBS style message bases.  Squish is the
  108. default.
  109.  
  110. AreaType Squish
  111.  
  112. The DelOld keyword tells AFR what to do with an AreaFix message when it reads
  113. it.  DelOld accepts one parameter which can one of the following.
  114.  
  115. Yes - This deletes AreaFix messages when it receives one.
  116. No  - Doesn't do anything to the AreaFix message
  117. Ask - Prompts you if it should delete the message.
  118.  
  119. I recommend a Yes setting.  That way, there is no chance AFR will add the same
  120. area twice.  AFR DOES scan your config files to make sure it doesn't add a
  121. duplicate areas but as a saftey precaution, deleting old AreaFix messages is
  122. wise.  The default is Yes.
  123.  
  124. DelOld Yes
  125.  
  126. The TimeOut verb tells AreaFixer how many seconds to wait for a reply to the
  127. DelOld command.  5 is the default.  It can range from 0 (to wait forever)
  128. to 255.
  129.  
  130. TimeOut 5
  131.  
  132. The TimeOutDel verb tells AreaFixer what to automatically answer when asked
  133. to delete a message and a TimeOut has occured.  This can be Yes or No.  The
  134. default is No.
  135.  
  136. TimeOutDel No
  137.  
  138. The StartFrom tells where AreaFixer should start scanning message bases
  139. from.  It can be First or LastRead.  If it is First, AreaFixer will scan
  140. all messages starting at the first one.  If LastRead, AreaFixer will scan
  141. all messages starting at the lastread message.  LastRead is the default.
  142.  
  143. StartFrom LastRead
  144.  
  145. ─ How AFR Works ─
  146.  
  147.   AFR starts out by scanning your NetMail area.  If it finds a message that
  148. matches the criteria you have set to be an AreaFix message, it extracts the
  149. information from the message about the areas you want to add/unlink from.
  150.  
  151.   If you are adding a message area, AFR scans each line of the files it needs
  152. to update for a match of what it will add.  This will make sure duplicates
  153. are not added.  NOTE: Spaces, and case sensitivity ignored.  Also, when you
  154. have a #6 in the FileUpdate string, it will treat it like a dos wild card.
  155. If no match is found, the area is added to the current file.
  156.  
  157.   If you are adding a message area, AFR scans each line of the files it needs
  158. to update to make sure it actually already exists.  This will make sure only
  159. the right areas are deleted NOTE: Spaces, and case sensitivity ignored.  Also,
  160. when you have a #6 in the FileUpdate string, it will treat it like a dos wild
  161. card.  If no match is found, the area is added to the current file.
  162.  
  163.   When all this is finished, AFR quits and there is no need for you to lift a
  164. finger editing all your files you normally edit when adding/unlinking an area.
  165.  
  166. ─ Beta Testers Wanted ─
  167.  
  168.   If you are in the 163 or 243 net or you don't mind polling long distance
  169. you are eligible to be a beta testers.  Simply NetMail Steve Mulligan at
  170. 1:163/307.30.  I will reply to you and tell you how to get the latest beta
  171. versions of software I make.
  172.  
  173. ─ On the Drawing Board ─
  174.  
  175.    This is a list of all the features my Beta Testers and I want to have added
  176. to AreaFixer.  I'll get around to it in a while.  PLEASE ADD TO LIST AND
  177. FORWARD TO STEVE MULLIGAN 1:163/307.30.  If you want to become a Beta Tester,
  178. NetMail me and I'll send you beta releases.
  179.  
  180. 1.10    · Bug fix release, anything else you suggest.  Aug 93
  181.  
  182. If you have any additions to this list or any bugs, please let me know!
  183.  
  184. Steve Mulligan 1:163/307.30@fidonet.org
  185.