home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / bbs_opus / msgcopy1.arj / MSGCOPY.DOC < prev    next >
Encoding:
Text File  |  1991-07-21  |  6.8 KB  |  162 lines
  1.                                MSGCOPY v1.0
  2.  
  3.                                By Frank Cox
  4.                              FidoNet 1:140/53
  5.  
  6.  
  7.      This program is truly public  domain.  You can  give it away, you  can
  8. sell it, you can hack  it, you can do  whatever your little heart  desires.
  9. Also, this program  is not  guaranteed to do  anything other  than take  up
  10. space on your disk.   I have tested  it here and it  works for me but  that
  11. doesn't necessarily mean that  it will work  for you.  Use  it at your  own
  12. risk.
  13.  
  14. SO WHAT DOES IT DO?
  15. -------------------
  16.  
  17.      MSGCOPY copies any unreceived messages that are to a user on the board
  18. into the destination area and marks them as received in the origin area  so
  19. that the message won't be  moved twice.  It will  add a "* NOTE:  Reply  to
  20. this message is area #." where # is the area the message originated from to
  21. the top of the body of the message text.
  22.  
  23.      Why do you want to  do this?  The users  of my system like it  because
  24. they don't necessarily have to call in every single day and they won't miss
  25. messages addressed to  them that  come through  even the  most active  echo
  26. areas.   I have  a read-only  message area  on my  system called  "Echomail
  27. Replies to Local Users".   MSGCOPY slams all unreceived echomail  addressed
  28. to  local  users   into  this   area.     I  have   O_RENUM  (the   message
  29. renumber/deleter program by Steve Antonoff) set to delete messages in  this
  30. area that are either received or older than 45 days.  In this manner,  even
  31. if a  user goes  away for  a few  weeks vacation  or whatever,  all of  the
  32. echomail addressed to him is still waiting on his return.
  33.  
  34.      An additional benefit is that  your mail waiting announcement  program
  35. doesn't have to read  through all of  the echo message  areas when you  use
  36. MSGCOPY - just your local message areas and the reply area.
  37.  
  38.      MSGCOPY will optionally  read a text  file containing  names of  users
  39. whose messages you do  not want to  copy.  For  example, other sysops  will
  40. likely receive their  echo mail on  their own  system - if  they call  your
  41. system, the don't want to have to re-read the same messages again.  MSGCOPY
  42. will ignore messages addressed  to users whose  names are specified in  the
  43. text file.
  44.  
  45. HOW DO YOU USE IT?
  46. ------------------
  47.  
  48.      This is the command line you use with MSGCOPY:
  49.  
  50.  MSGCOPY [-uUSER.DAT] [-sSYSMSG.DAT] [-eEXCLUDE.LST] [target] [area] [area]
  51.  
  52. Explanation:
  53.  
  54.      [-uUSER.DAT] is the path and name of the USER.DAT file
  55.           example   -uC:\OPUS\MISC\USER.DAT
  56.  
  57.      [-sSYSMSG.DAT] is the path and name of the SYSMSG.DAT file
  58.           example   -sC:\OPUS\SYSMSG.DAT
  59.  
  60.      [-eEXCLUDE.LST] is a list of names to exclude from the search
  61.           example   -eC:\OPUS\MISC\EXCLUDE.LST
  62.  
  63.      [target] is the number of the reply holding area
  64.  
  65.      [area] is a list of the areas to be scanned
  66.  
  67.      If -s  or -u  options  are not  specified,  the current  directory  is
  68. scanned for USER.DAT and/or SYSMSG.DAT.  If no exclusion list is  specified
  69. with the -e option, all names in the USER.DAT file will be included in  the
  70. search.
  71.  
  72.      You can specify as many [area]'s as you can fit onto the command line.
  73.  
  74.      The Exclude.Lst file is  a text file  containing names of users  whose
  75. echo mail you do not want to copy  into the target message area.  It  might
  76. look like this:
  77.  
  78.           Jules Verne
  79.           Jonathan Swift
  80.           Edgar Poe
  81.           Charles Dickens
  82.           Thomas Hardy
  83.           Walter Scott
  84.  
  85.      If this exclusion list was  specified, then MSGCOPY would ignore  echo
  86. mail messages addressed to any of these gentlemen.
  87.  
  88.      It should also  be noted that  MSGCOPY is designed  to work with  echo
  89. mail messages, not  local messages.   Due to  the method used  to read  the
  90. messages, if you use  it to copy  messages from a  local message area,  the
  91. "* NOTE:  Reply to  this message in  area #" line will  be inserted in  the
  92. wrong place, one character too far into the body of the message.
  93.  
  94. EXAMPLES:
  95. ---------
  96.  
  97.      MSGCOPY -EC:\Opusstuf\Exclude.Lst 2 4 5 6 7 8 10 25
  98.  
  99.      This command  line will  read  an exclusion  list in  the  C:\Opusstuf
  100. directory, read  USER.DAT  and SYSMSG.DAT  in  the current  directory,  put
  101. messages into area 2, and read through messages in areas 4, 5, 6, 7, 8,  10
  102. and 25.
  103.  
  104.      MSGCOPY -SE:\Stuff\Sysmsg.Dat -uE:\Stuff\User.Dat 2 4 5 6 7 8 10 25
  105.  
  106.      This command line would read  USER.DAT and SYSMSG.DAT in the  E:\Stuff
  107. directory, would not use an exclusion  list, put messages into area 2,  and
  108. read through messages in areas 4, 5, 6, 7, 8, 10 and 25.
  109.  
  110.      Errorlevels returned:
  111.  
  112.           0 - No fatal errors encountered
  113.           1 - USER.DAT file not found
  114.           2 - SYSMSG.DAT file not found
  115.           3 - Target Message area not found
  116.  
  117.      Note that the error handling in this program is not exhaustive for two
  118. reasons - the additional code would slow the program down a bit, and I  was
  119. too lazy to write the additional code anyway.   In other words, if you  run
  120. out of disk space, specify a file that  does exist but is in an  unexpected
  121. format (such as  specifying a  USER.DAT file  that is  really a  SYSMSG.DAT
  122. file), or  similar stuff,  you may  still  get a  return errorlevel  of  0.
  123. However, in these kinds of situations, you should receive an error  message
  124. of some sort on the screen.
  125.  
  126. ACKNOWLEDGMENTS
  127. ---------------
  128.  
  129.      MSGCOPY is an implementation  of an idea  for Opus 1.03 originally  by
  130. Derrick Cedars which was developed further for both Opus 1.03 and Opus 1.10
  131. by Simon Giles.   Actually,  after seeing  the initial  program written  by
  132. Derrick, I  sort of  bugged Simon  until  he wrote  a version  that  worked
  133. better.  However, alas, Simon is no longer  in the nodelist.  This made  it
  134. too difficult for me to bug him for yet another update of his program  when
  135. Opus 1.70 was released.  So I had to dust off the compiler and write a  new
  136. version myself.
  137.  
  138.      This implementation of  MSGCOPY was written  completely from  scratch.
  139. Simon's implementation was written in  another language which I don't  know
  140. too much about.  So I just started again.
  141.  
  142.      I would  like  to  thank Bob  Swift  (1:140/24)  for  deciphering  the
  143. structure of the Opus 1.70 SYSMSG.DAT  file.  I would never have  succeeded
  144. in getting this program to work the way it does without him!
  145.  
  146.      Thanks also to Roger Franz  (1:100/380) for testing a version of  this
  147. program prior to the release of Opus 1.70.
  148.  
  149. COMMENTS, SUGGESTIONS, BUGS??
  150. -----------------------------
  151.  
  152.      Comments or questions can be directed to the author via netmail at the
  153. above noted FidoNet address, or the  old-fashioned way (pen on paper).   My
  154. postal address is
  155.  
  156.                     Frank Cox
  157.                     P. O. Box 2694
  158.                     Kindersley, Saskatchewan
  159.                     Canada  S0L 1S0
  160.  
  161.      Enjoy!
  162.