home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / upchek_b.lzh / Upchek.cfg < prev    next >
Text File  |  1993-08-26  |  8KB  |  184 lines
  1. %
  2. %                         Upchek.cfg (beta)
  3. %                         August 25, 1993
  4. %                         Kim Bergman
  5. % 
  6. %   Upchek.cmd will look for this file, Upchek.cfg, in the directory that
  7. %   Upchek.cmd executes from.  Copy Upchek.cfg to that directory, usually
  8. %   your Max directory.
  9. %
  10. %   Lines that begin with the % character are comments and will be ignored
  11. %   by Upchek.cmd.
  12. %
  13. %   The format of this config file is fairly standard and should be 
  14. %   familiar to most Maximus sysops.  Each of the Option Lines
  15. %   (non-commented lines) below sets an option within Upchek.  Each Option
  16. %   Line is of the format:
  17. %
  18. %     <keyword> <option>
  19. %
  20. %   where <keyword> is some  more or less intuitive, single word
  21. %   description of what the option does and <option> is a single word that
  22. %   defines the option.  You must not edit the keyword itself, just the
  23. %   option.
  24. %
  25. %
  26. %   Keywords and options are case insensitive.  There must be at least one
  27. %   space between the keyword and option and several spaces is OK.  Spaces
  28. %   before the keyword and spaces and other characters after the option
  29. %   word are ignored.
  30. %
  31. %
  32. %   BADACT toggles the action Upchek takes when it finds a bad upload.
  33. %   Valid values for badact are Move, Delete and Rename.  A bad upload is
  34. %   one that:
  35. %
  36. %       1. is/contains a corrupted archive
  37. %       2. the virus scanner thinks contains a virus
  38. %       3. causes the scanner to crash
  39. %       4. has an extension that appears in the list of bad extensions you
  40. %          define below.
  41. %
  42. %   If you use Move then Upchek will move the bad file from the home 
  43. %   directory (the % directory it was uploaded to) to a directory defined
  44. %   by BADPATH.  If you use Delete the file is deleted.  If you use  
  45. %   Rename then the file is renamed by prefixing the name with "bad" and
  46. %   leaving it in the upload directory.  Uncomment one of the following
  47. %   lines.
  48. %
  49. Badact    Rename
  50. % Badact    Move
  51. % Badact    Delete
  52. %
  53. %
  54. %   LISTSCAND allows you to toggle additional information lines in the log
  55. %   file generated by Upchek.  It can have one of 2 values: True or False.
  56. %   If True then all non-archive files inside an archive are listed in the
  57. %   log.  If False, only the name of the file given to Upchek for
  58. %   processing shows in the log file.  Uncomment one of the following 2
  59. %   lines.
  60. %
  61. Listscand    True
  62. % Listscand     False
  63. %
  64. %
  65. %   WORKDIR is the pathname of a temporary work directory that Upchek will
  66. %   create, use and delete as necessary.  Use an odd name for this
  67. %   directory, something neither you nor other programs are likely to use. 
  68. %   Don't copy files to this directory unless you want them to disappear
  69. %   quickly.  On multi-line systems Virchek will append the node number to
  70. %   the directory name when it creates the temporary directory.  Uncomment
  71. %   the line below and edit the path to whatever suits your directory
  72. %   structure.  Your Max directory is a good directory for the work
  73. %   directory to be created in because you will not likely delete it in the
  74. %   future.  You do not need to create the work directory yourself,
  75. %   Upchek.cmd will create and delete it as required.
  76. %
  77. Workdir     e:\max\scn$$
  78. %
  79. %
  80. %   TEMPFIL1 and TEMPFIL2 are paths + filenames of 2 temporary work files 
  81. %   that Upchek.cmd creates, uses and deletes as necessary.  Use any
  82. %   directory and filenames that suit your directory structure.  Of course
  83. %   the directory shouldn't be one that you might need to delete later.  Do
  84. %   not use the temporary work directory designated by WORKDIR (above)
  85. %   either.  You must define both TEMPFIL1 AND TEMPFIL2.
  86. %
  87. Tempfil1   e:\max\tmp$$
  88. Tempfil2    e:\max\tmp$$$
  89. %
  90. %
  91. %   LOGFILE is the path + filename of a text file to which Upchek.cmd will
  92. %   write its sysop report.  Since Upchek appends reports to this file
  93. %   rather than overwriting it you could probably use your Maximus log
  94. %   file.  I haven't tried that yet but it should work.
  95. %
  96. %
  97. Logfile e:\max\upldlog.txt
  98. %
  99. %
  100. %   OPTSFILE is the path + filename to a text file that contains parameters
  101. %   (options) read by OS2SCAN when it runs.  Consult the OS2SCAN docs for
  102. %   information on what can and should go into this file.  The parameters
  103. %   in the supplied Scanopts.txt cause OS2SCAN to run with no pauses
  104. %   which is important if you are going to use Upchek.cmd with Maximus.
  105. %
  106. Optsfile e:\max\scanopts.txt
  107. %
  108. %
  109. %   BADPATH is the incomplete path (without a drive letter) to the
  110. %   directory that you want Upchek to move bad uploads to.  For speed,
  111. %   OS/2's MOVE command is used rather than COPY followed by DEL.
  112. %   There is one drawback to MOVE which is that a file cannot be moved from
  113. %   one drive to another.  You can MOVE only to a different directory on
  114. %   the same drive.  This restriction is reflected in MOVE's syntax and
  115. %   therefore in badpath's syntax too.  The path assigned to badpath must
  116. %   not begin with a drive letter because the drive is understood to be the
  117. %   same drive that the bad file is on.  The path must start with a "\" but
  118. %   should not end with a "\" character.
  119. %
  120. Badpath \max\file\baduplds
  121. %
  122. %
  123. %   FULLBADPATH is the complete path to the directory that you want Upcheck
  124. %   to move bad uploads to.  This path must end with a "\" character.  You
  125. %   must create this directory yourself since Upchek will not create it for
  126. %   you.  The keywords BADPATH and FULLBADPATH may seem repetitious but
  127. %   it's required.
  128. %
  129. Fullbadpath   e:\max\file\baduplds\
  130. %
  131. %
  132. %   DOORFILE is the path + filename of the drop file (door file) that
  133. %   Upchek reads.  The default is e:\max\chekdoor.sys. If you want to use a
  134. %   different path + filename for the drop file then you must edit the
  135. %   supplied Cdoor.mec appropriately.  Upchek does not require the drop
  136. %   file when used in local mode, it is required only when Upcheck.cmd is
  137. %   invoked by Maximus.  Non-sysops can leave the following line commented. 
  138. %
  139. Doorfile     e:\max\chekdoor.sys
  140. %
  141. %
  142. %   MAXDIR is usually the pathname to your Max directory, i.e.  the
  143. %   directory in which Maxp.exe resides.  Upchek.cmd sets the current
  144. %   directory to this directory just before it exits.  If you prefer to
  145. %   have Upchek.cmd exit to some other current directory then define
  146. %   Maxdir accordingly.
  147. %
  148. Maxdir     E:\Max
  149. %
  150. %   DISCOURAGE allows you to define aspects of the message callers
  151. %   receive when they upload a restricted file (one with a bad extension). 
  152. %   If DISCOURAGE is True then the caller will receive a message
  153. %   explaining:
  154. %
  155. %       1. which types of files should not be uploaded to your system
  156. %       2. that they have upoaded is one of those types.
  157. %
  158. %   If DISCOURAGE False then callers will receive no message concerning
  159. %   restricted files.  The discourage setting has no effect upon whether or
  160. %   not your system screens files based on file extensions.
  161. %
  162. Discourage   True
  163. % Discourage   False
  164. %
  165. %
  166. %   RESTRICTED is a list of restricted file extensions.  The list is a
  167. %   string of extensions seperated by commas as in the list below, no
  168. %   periods, case insensitive.  If you do not want to restrict any file
  169. %   types files then leave this line commented.  Uploads that are
  170. %   restricted will be either deleted or moved depending on the option
  171. %   you select for BADACT.
  172. %
  173. Restricted Gif,voc,Fli,piC
  174. %
  175. %
  176. %   The Badact, Discourage and Restricted options provide flexibility in 
  177. %   what you do with restricted files and what you say to callers when they
  178. %   upload one.  If you do not allow certain file types to be uploaded and
  179. %   want to say so to callers who upload those types then you should use
  180. %   a RESTRICTED list, DISCOURAGE True and either BADACT Move or BADACT
  181. %   Delete.  If you accept all file types but want to be warned when
  182. %   certain types are uploaded then use a RESTRICTED list and DISCOURAGE
  183. %   False.
  184.