home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / echorep1.zip / ECHOREP.DOC < prev    next >
Text File  |  1994-06-15  |  12KB  |  266 lines
  1.    EchoRep v1.1 for Telegard 2.7 & TeleMail 1.51 or 1.64/Beta
  2.                   Copyright 1994, Sergey Polak
  3.  
  4.  
  5.                            DISCLAIMER
  6.  
  7.      This program and other files associated with it are NOT
  8. guaranteed to be bug free or virus free.  I am not responsible for
  9. damages of any kind, including profit losses and data losses, that
  10. relate directly or indirectly to these programs and files.
  11.  
  12.                    DISTRIBUTION OF THE PROGRAM
  13.  
  14.      You may NOT charge any fee for the distribution of the program
  15. itself, although you may charge for the media on which you
  16. distribute it.  You MUST include all of the files in the archive if
  17. you distribute the program.  Feel free to share the program with
  18. your friends and upload it to Electronic Bulletin Boards.
  19.  
  20.                       FILES IN THE ARCHIVE
  21.  
  22.      The following files should have been included in the archive:
  23.  
  24. ECHOREP.EXE         The program itself
  25. ECHOREP.DOC         The documentation (this file)
  26. ECHOREP.CFG         Sample configuration file
  27. SKIP.LST            Sample skip file listing
  28.  
  29. If any of the above files are not present, you do not have an
  30. authorized copy of the program!
  31.  
  32.                         WHAT IS ECHOREP?
  33.  
  34.      EchoRep is a handy dandy little utility for Telegard 2.7 and
  35. TeleMail 1.51 or 1.64/Beta that will process the TeleMail log file
  36. and create a report for you consisting of the following:
  37.  
  38.      - number of messages imported into each message base
  39.      - number of messages exported from each message base
  40.      - names of message bases with no inbound traffic
  41.      - names of message bases with no outbound traffic
  42.  
  43.                           REQUIREMENTS
  44.  
  45.      In order for EchoRep to run you must have:
  46.  
  47.      - DOS 3.3 or above
  48.      - Telegard 2.7
  49.      - TeleMail 1.51 or 1.64/Beta
  50.  
  51.                             FEATURES
  52.  
  53.      EchoRep can process only EchoMail bases, only NetMail bases,
  54.      only GroupMail bases or any combination of the above.
  55.  
  56.      EchoRep allows you to specify which message bases not to
  57.      process either by name or by number.
  58.  
  59.      EchoRep returns errorlevels to let you know how and why it
  60.      ended.
  61.  
  62.      Full support for DOS's output redirection, so you can send the
  63.      output of the program to a file, your serial port or your
  64.      parallel port.
  65.  
  66.      Ability to use a configuration file so that you don't have to
  67.      type all those command line parameters every time you run the
  68.      program.
  69.  
  70.  
  71.                        HOW TO USE ECHOREP
  72.  
  73.      Simply call the program in the following format:
  74.  
  75. ECHOREP [/S:path] [/L:filespec] [/X:filespec] [/N] [/G] [/E-]
  76.         [/F:mm/dd/yy] [/T:mm/dd/yy] [/P] [/M-] [/I-] [/O-] [/S]
  77.         [/R:filespec] [@cfgfile]
  78.  
  79. /S:path        This is the full PATH to your STATUS.DAT  It is
  80.                only required if STATUS.DAT is not in the current
  81.                directory or in your PATH.  ** DO NOT INCLUDE THE
  82.                FILENAME **
  83. /L:filespec    This is the full path and/or filename of your
  84.                TeleMail log file.  It is only required if the log
  85.                file is not in the current directory or in your
  86.                PATH, or you are not using the standard
  87.                TELEMAIL.LOG filename.  If you specify the
  88.                directory only, be sure to include the backslash \
  89.                at the end of the directory name.
  90. /X:filespec    This is the full PATH and NAME to your skip
  91.                listing.  A skip listing is a plain ASCII file
  92.                which contains filenames or numbers of message
  93.                bases that should be skipped during processing. 
  94.                See below for more information.
  95. /N             This flag ENABLES processing of NetMail bases.  By
  96.                default NetMail bases are not processed.
  97. /G             This flag ENABLES processing of GroupMail bases. 
  98.                By default GroupMail bases are not processed.
  99. /E-            This flag DISABLES processing of EchoMail bases. 
  100.                By default EchoMail bases are processed.
  101. /F:mm/dd/yy    Message traffic will be processed beginning with
  102.                this date.  Any traffic that occurred before this
  103.                date will be ignored.  If the date you enter is
  104.                invalid, it will be ignored.  If no message traffic
  105.                was logged after the date you specify, no report
  106.                will be made.
  107. /T:mm/dd/yy    Message traffic will be processed up to and
  108.                INCLUDING this date.  Any traffic that occurred
  109.                after this date will be ignored.  If the date you
  110.                enter is invalid or is before the FROM date (if
  111.                any), it will be ignored.
  112. /P             This flag tells EchoRep to erase your TeleMail log
  113.                file after it is done.  By default the log file
  114.                remains unchanged.
  115. /M-            This flag DISABLES generation of the main report. 
  116.                The main report lists all message bases by name and
  117.                shows the number of messages imported and exported
  118.                to/from each message base.
  119. /I-            This flag DISABLES generation of the "no inbound
  120.                mail" report.  This report lists the names of all
  121.                message bases that had no inbound message traffic
  122.                for the report period.
  123. /O-            This flag DISABLES generation of the "no outbound
  124.                mail" report.  This report lists the names of all
  125.                message bases that had no outbound message traffic
  126.                for the report period.
  127. /S             This flag tells EchoRep to strip the Telegard color
  128.                codes from message base names before writing the
  129.                report.
  130. /R:filespec    Here you can specify the path and/or name of the
  131.                file you wish the report to be written to.  By
  132.                default, the file is called ECHO.REP and is located
  133.                in the current directory.  If you wish to change
  134.                that, include this option.  If you want to specify
  135.                a directory only, be sure to include a backslash at
  136.                the end of the directory name (eg. C:\TEL\TFILES\). 
  137.                If the file already exists it will be appended.
  138. @cfgfile       This is the full path and name to the EchoRep
  139.                configuration file.
  140.  
  141. All parameters are OPTIONAL.  Case and order of the parameters are
  142. irrelevant.  All parameters must be separated by a space.  No
  143. spaces allowed inside of parameters.
  144.  
  145. NOTE:     For the purposes of maintaining the format of the report,
  146.           EchoRep will strip all MCI codes (with the exception of
  147.           color codes, unless otherwise instructed) from message
  148.           base descriptions.
  149.  
  150.                        CONFIGURATION FILE
  151.  
  152.      The configuration file is plain ASCII file with a set of
  153. commands and values for the commands.  You may use semicolons to
  154. indicate comments in the configuration file.  The following
  155. commands can be included in the configuration file:
  156.  
  157. StatusDir      The path to your STATUS.DAT
  158. TMLogDir       The path/name of your TeleMail log file.
  159. ReportDir      The path/name of the report file.
  160. SkipFile       The path and name of the skip file.
  161. DoNetMail      Enable/disable NetMail processing.
  162. DoEchoMail     Enable/disable EchoMail processing.
  163. DoGroupMail    Enable/disable GroupMail processing.
  164. PurgeLog       Enable/disable erasure of the TeleMail log file
  165.                upon program completion.
  166. DoMain         Enable/disable generation of main report.
  167. DoNoInbound    Enable/disable generation of "no inbound mail"
  168.                report.
  169. DoNoOutbound   Enable/disable generation of "no outbound mail"
  170.                report.
  171. StripColor     Enable/disable stripping of Telegard color codes
  172.                from message base filenames.
  173.  
  174.      Each command must be followed by the equal sign = and a value. 
  175. The values for boolean (enable/disable) commands can be either
  176. ON/OFF, YES/NO or TRUE/FALSE.
  177.  
  178.      The only EchoRep commands that are not allowed inside a
  179. configuration file are the date limiting commands.  Those must be
  180. included on the command line.
  181.  
  182.      Command line parameters can be used to override any setting in
  183. the configuration file.
  184.  
  185.                             SKIP FILE
  186.  
  187.      If you want to skip certain message bases during processing,
  188. you can create a plain ASCII file with the filenames or numbers of
  189. the message bases that should be skipped, and include the name of
  190. that file with the /X: switch on the EchoRep command line or in the
  191. configuration file.  If you use this feature, make sure that the
  192. name you use in the file is the filename of that message base, not
  193. the description.  If you choose to use the message base number
  194. rather than the filename, precede the number by the # sign. 
  195. Obviously this means that you can't specify that a message base be
  196. skipped if its filename begins with a # sign.  Case in filenames is
  197. ignored.
  198.  
  199. WARNING:  Message base numbers are dependent on the user in
  200.           Telegard.  EchoRep uses ABSOLUTE message base numbers. 
  201.           Consult your message base editor for the absolute number
  202.           of any message base.
  203.  
  204.  
  205.                            ERRORLEVELS
  206.  
  207. If you are going to use EchoRep in batch files you have an added
  208. convenience:  errorlevels.  The following is the summary of
  209. errorlelevs returned by the program:
  210.  
  211. 0 -  Everything is just fine.
  212. 1 -  Help was requested.
  213. 2 -  Can't find STATUS.DAT
  214. 3 -  Can't find the TeleMail log file.
  215. 4 -  Can't find skip listing:
  216.           The filename you specified with the /X: switch is
  217.           incorrect.
  218. 5 -  Can't find BOARDS.DAT
  219.           There is an error in your STATUS.DAT path settings.
  220. 6 -  Input/Output error
  221.           An error was encountered while reading from or writing to
  222.           the disk.
  223. 7 -  Nothing to do
  224.           You either specified a FROM date with the /F: switch, but
  225.           no message traffic was logged after that date, you
  226.           specified that ALL message bases are to be skipped from
  227.           the report or you disabled generation of all 3 report
  228.           types (main, no inbound and no outbound) or you disabled
  229.           processing of all 3 message base types (EchoMail, NetMail
  230.           and GroupMail).
  231. 8 -  Can't find configuration file.
  232.  
  233.                       CONTACTING THE AUTHOR
  234.  
  235.      This is *MANDATORY*  You absolutely HAVE to contact me in some
  236. way and let me know that you're using the program.  Please let me
  237. know that you are using the program.  If you have any suggestions,
  238. then do not hesitate to tell me.  If you want to send me a
  239. financial contribution, I will not refuse (who would!).
  240.  
  241. You can reach me at the following address:
  242.  
  243.                           Sergey Polak
  244.                          212 Spring St.
  245.                         Monroe, NY  10950
  246.  
  247. Or on the OFFICIAL EchoRep BBS:
  248.  
  249. Hometown's Glass Manazure 1:272/107 (914) 496-4115  300-14.4K
  250. (v32/v42) baud, send mail to Sergey Polak #2,
  251.  
  252. or via FidoNet at 1:272/94 or 1:272/107
  253.  
  254. or via InterNet at
  255.  
  256. wp931085@pacevm.dac.pace.edu or
  257. sergey_polak@f94.n272.z1.fidonet.org or
  258. sergey_polak@f107.n272.z1.fidonet.org
  259.  
  260. or via BitNet at WP931085@PACEVM
  261.  
  262. I can also be found on the FidoNet Telegard support echo
  263. (TG_SUPPORT).
  264.  
  265. I will try to keep the latest copy of this program on the Telegard
  266. File Distribution Network.