home *** CD-ROM | disk | FTP | other *** search
/ CD Shareware Magazine 1996 December / CD_shareware_12-96.iso / DOS / Comunic / PRP110.ZIP / PRP.DOC < prev    next >
Encoding:
Text File  |  1996-08-20  |  17.1 KB  |  445 lines
  1. ╔══════════════════════════════════════════════╗
  2. ║      ProBoard Request Processor v1.10        ║
  3. ║ Written by Tom Torfs (2:292/516@fidonet.org) ║
  4. ╚══════════════════════════════════════════════╝
  5.  
  6. This is freeware. You are encouraged to copy this program
  7. and give copies to your friends. You may not, however,
  8. change this program or its documentation in any way
  9. or distribute modified versions of the original archive.
  10.  
  11. *** OVERVIEW ***
  12.  
  13. ProBoard Request Processor is a simple program that quickly
  14. generates responses to file requests, even from cd-roms, by
  15. reading the ProBoard index files directly.
  16.  
  17. It is compatible with most popular mailers, including FrontDoor,
  18. MainDoor, McMail, BinkleyTerm, Xenia, Cantaloup and other mailers
  19. that support external file request processors either through a
  20. command line interface or through the SRIF interface.
  21.  
  22. PRP comes in both 16-bit DOS and 32-bit OS/2 versions.
  23.  
  24. Both normal file requests and update requests (only if a file
  25. is newer than a certain date) are supported. Separate request
  26. limits for secure and unsecure sessions, and unlimited requests
  27. from free areas are also supported.
  28.  
  29. If you are looking for bells and whistles, like timeslots,
  30. passwords for files, etc. this program is not for you.
  31. If you are looking for a simple, robust and most of all
  32. fast file request processor for your ProBoard-based BBS,
  33. this is what you've been waiting for.
  34.  
  35. *** INSTALLATION ***
  36.  
  37. First unpack the archive into a separate directory
  38. (recommended) or into your mailer's directory.
  39.  
  40. To upgrade from a previous version of PRP, simply unpack the
  41. archive into the PRP directory. Your configuration and template
  42. files will be left intact. However, to use some of the new
  43. features, changing the configuration file will be necessary.
  44.  
  45. A) FrontDoor/MainDoor
  46.  
  47. Set SRIF=NO in the configuration file.
  48.  
  49. Launch FDSETUP/MDSETUP and set the following information
  50. in Mailer/File requests/Request processor:
  51.  
  52. Program   C:\FD\PRP\PRP.EXE =R =T =X =A "=O"    (*)
  53. Enabled   Yes
  54. Swapping  No                                    (**)
  55.  
  56. (*) use the correct path, of course
  57. (**) set to Yes if you're really low on memory
  58.  
  59. This requires the registered version of FrontDoor. It works
  60. with the unregistered version of MainDoor, though.
  61.  
  62. MainDoor/2 setup is identical (except for using PRP2.EXE instead
  63. of PRP.EXE, of course).
  64.  
  65. B) McMail
  66.  
  67. Set SRIF=NO in the configuration file.
  68.  
  69. Set up the following command string:
  70.  
  71. ReqProcessor C:\MCMAIL\PRP\PRP.EXE =PFL =PXL =SU =PA "=RS"   (*)
  72.  
  73. (*) use the correct path, of course
  74.  
  75. I believe McMail supports SRIF as well, but I don't have any more
  76. details about that. Look in the documentation.
  77.  
  78. C) BinkleyTerm 2.60 XE or later
  79.  
  80. Set SRIF=YES in the configuration file.
  81.  
  82. Insert the following line in BINKLEY.CFG:
  83.  
  84. SRIF C:\BT\PRP\PRP.EXE $s              (*)
  85.  
  86. (*) Use the correct path, of course.
  87.  
  88. The $s will be replaced with the full path to the SRIF file.
  89.  
  90. Note: BinkleyTerm prior to version 2.60 XE does not support
  91. external request processors.
  92.  
  93. D) Xenia 1.98.04 or later
  94.  
  95. Set SRIF=YES in the configuration file.
  96.  
  97. Remove the line Request from the configuration file if that is
  98. present. Then add the following line:
  99.  
  100. ExtReq C:\XENIA\PRP\PRP.EXE            (*)
  101.  
  102. (*) Use the correct path, of course.
  103.  
  104. Xenia will append the full path to the SRIF file.
  105.  
  106. Note: SRIF does not function properly with Xenia prior to
  107. version 1.98.04
  108.  
  109. E) Cantaloup
  110.  
  111. Set SRIF=YES in the configuration file.
  112.  
  113. Create the file FREQPROC.CMD with the following contents:
  114.  
  115. @C:\CLOUP\PRP\PRP.EXE %6               (*)
  116.  
  117. (*) Use the correct path, of course.
  118.  
  119. Alternatively, you can also set up Cantaloup without using the
  120. SRIF interface. Cantaloup passes the following command line parameters
  121. to FREQPROC.CMD:
  122.  
  123. FREQPROC <baud> <task> <time> <originator> <secure> <srif> <req> <attach>
  124.  
  125. F) Others
  126.  
  127. Find out if your mailer supports external request processors, and whether
  128. it can call these using a command line interface or through the SRIF
  129. interface.
  130.  
  131. 1) Command line interface
  132.  
  133. Set SRIF=NO in the configuration file.
  134.  
  135. Set up the command line as follows (look in your mailer's manual
  136. for the required macros):
  137.  
  138. PRP.EXE <infile> <outfile> <SECURE|UNSECURE> <address> "<sysopname>"
  139.  
  140. (use PRP2.EXE for the OS/2 version)
  141.  
  142. If you provide me with the correct command line for another mailer,
  143. it will be added to this doc and I will give credit to you.
  144.  
  145. 2) SRIF interface
  146.  
  147. Set SRIF=YES in the configuration file.
  148.  
  149. Set up the mailer so that it will call PRP.EXE with the full path and
  150. filename of the SRIF-file as only parameter.
  151.  
  152. *** CONFIGURATION ***
  153.  
  154. The configuration file must be named PRP.CFG and must be in the
  155. same directory as PRP.EXE/PRP2.EXE. It is a text file configuration,
  156. and can contain the following keywords. Everything after a
  157. semicolon (;) is treated as a comment and ignored.
  158.  
  159. ADDRESS=<your main address>
  160. Your main address, in the form zone:net/node.point. Any omitted
  161. fields (e.g. point) are assumed to be zero.
  162. This address is used as the origin for the file request response
  163. messages.
  164.  
  165. MAGIC=<list with magic file names>
  166. Defines the path and filename of the file containing a list
  167. of magic filenames (same file as the alias file in FrontDoor).
  168. Each line contains a magic name, followed by at least one
  169. space and then the full path of the corresponding file name
  170. (wildcards supported).
  171. If this is omitted, no magic files will be available.
  172. *NOTE* When a magic file is requested, the file will be searched
  173. in the ProBoard filebase. If it is found, the description will be
  174. taken from there, and the download counters will be updated if
  175. that option is set. If it fails, no description will be provided
  176. and no download counters will be updated.
  177.  
  178. PBPATH=<path to ProBoard system directory>
  179. If you omit this, the environment variable PROBOARD will be read,
  180. and if that isn't set, C:\PB will be assumed.
  181.  
  182. LOGFILE=<logfile>
  183. Defines the path and filename of the logfile. Leave empty, or
  184. simply omit, to disable logging.
  185.  
  186. MAXFILES=<maximum number of files>
  187. Defines the maximum number of files a system may request per
  188. session. If you omit this or set it to zero, there is no
  189. limit.
  190.  
  191. MAXKB=<maximum number of kilobytes>
  192. Defines the maximum number of kilobytes a system may request
  193. per session. If you omit this or set it to zero, there is no
  194. limit.
  195.  
  196. MAXLEVEL=<maximum security level>
  197. Defines the maximum security level a file area may have in
  198. ProBoard for a system to be allowed to request from it. Set
  199. this to 32767 (or omit it) if you want no limit.
  200.  
  201. MAXFILES_SECURE=<maximum number of files>
  202. Same as MAXFILES but for secure sessions. If you omit this the
  203. setting from MAXFILES will be used.
  204.  
  205. MAXKB_SECURE=<maximum number of kilobytes>
  206. Same as MAXKB but for secure sessions. If you omit this the
  207. setting from MAXKB will be used.
  208.  
  209. MAXLEVEL_SECURE=<maximum security level>
  210. Same as MAXLEVEL but for secure sessions. If you omit this the
  211. setting from MAXLEVEL will be used.
  212.  
  213. FREEFILES=<YES|NO>
  214. If set to YES, request limits are ignored for file areas marked
  215. as 'free' in ProBoard. This is also the default behaviour.
  216. This only affects number of files & kb limits, security level
  217. limits are still respected even if the area is marked as free.
  218.  
  219. FREEMAGIC=<YES|NO>
  220. If set to YES, request limits are ignored for files requested
  221. using magic names. This is also the default behaviour.
  222.  
  223. COPYLOCAL=<path>
  224. If this option is present, files from CD-ROM areas will be copied
  225. to <path> before sending them. If this option is left out, the files
  226. won't be copied to a local drive. The <path> must be a valid
  227. directory, with or without trailing backslash. If the <path> is
  228. invalid, PRP will not function properly.
  229.  
  230. CHECKEXTENSION=<YES|NO>
  231. When set to NO, the default and also the behaviour of previous
  232. versions of PRP, the extension of files is ignored, and the first
  233. matching file will be sent. For example, if someone freqs TEST.ARJ
  234. and you have TEST.ZIP and TEST.LZH, TEST.ZIP will be sent.
  235. This option also implies that if somebody freqs for example
  236. TEST.*, he will only receive the first file, the others will be
  237. considered duplicates.
  238. If set to YES, the file extension is significant. So if someone
  239. freqs TEST.ARJ and you have TEST.ZIP and TEST.LZH, neither of them
  240. will be sent.
  241. This option also implies that if somebody freqs for example
  242. TEST.*, he will receive all matching files, like TEST.ZIP,
  243. TEST.ARJ, etc.
  244. *NOTE* There is one exception to this option. Extensions that end
  245. in two digits (most often some form of nodelist) will always
  246. be treated as if this option was set to YES. So if someone freqs
  247. NODEDIFF.Z96 and you have NODEDIFF.Z89 and NODEDIFF.Z82, neither
  248. of them will be sent, regardless of this setting.
  249.  
  250. SENDDUPENAME=<YES|NO>
  251. If set to NO, the default and also the behaviour of previous
  252. versions of PRP, of more files with the same file name, including
  253. extension, only the first will be sent.
  254. If set to YES, the other files will be sent. Depending on the
  255. remote sysop's software, the files will be renamed, skipped,
  256. or the first files will be overwritten.
  257. If the files are copied to a local disk first, they are renamed,
  258. for example TEST.ZIP becomes TEST.ZI1, TEST.ZI2, etc.
  259. Two files with the same file name are sent *only* if they have
  260. different file sizes.
  261.  
  262. SRIF=<YES|NO>
  263. Whether your mailer uses the SRIF interface (e.g. Binkley 2.60 XE,
  264. Xenia) or a command line interface (e.g. FrontDoor). For more
  265. information see the installation instructions. The default is NO.
  266.  
  267. UPDATECOUNTERS=<YES|NO>
  268. If set to YES, PRP will append the requested files to the download
  269. logfile, so that on the next PBUTIL FC the download counter for this
  270. file will be updated. The default is NO.
  271.  
  272. MAXFREQS=<n>
  273. The maximum number of separate file requests that can be processed
  274. at a time. The default is 256, as in the previous versions of PRP.
  275. In the DOS version, if you set this value too high you will get a
  276. "not enough memory" error. In the OS/2 32-bit version that should
  277. not be a problem.
  278.  
  279. MAXMATCHES=<n>
  280. The maximum number of matching files that can be processed at a time.
  281. The default is 256, as in the previous versions of PRP.
  282. In the DOS version, if you set this value too high you will get a
  283. "not enough memory" error. In the OS/2 32-bit version that should
  284. not be a problem.
  285.  
  286. MAXMAGICS=<n>
  287. The maximum number of magic filenames that can be processed. The
  288. default is 128, as in the previous versions of PRP.
  289. In the DOS version, if you set this value too high you will get a
  290. "not enough memory" error. In the OS/2 32-bit version that should
  291. not be a problem.
  292.  
  293. *** RESPONSE TEMPLATE ***
  294.  
  295. The response template file must be named PRP.TPL and must be in
  296. the same directory as PRP.EXE. If this file isn't found, no
  297. response will be generated.
  298.  
  299. The first character of each line can define when a line should
  300. be included in the response:
  301.  
  302. ;       comment, always ignored
  303. +       only if the request succeeded entirely
  304. *       only if the request succeeded at least partly
  305. -       only if the request didn't succeed entirely
  306. !       only if the request limits were exceeded
  307. ?       only if some of the requested files weren't found
  308. #       always include this line
  309.  
  310. All other characters will cause the line to be always included. The
  311. # character is useful if you want a line beginning with any of the
  312. above characters to be always included.
  313.  
  314. You can use the following macros in the response template (case
  315. sensitive):
  316.  
  317. @SYSOPNAME@     name of sysop of requesting system
  318. @SYSOPFIRST@    first name of sysop of requesting system
  319. @MAXFILES@      maximum number of files this system can request
  320.                 per session (UNLIMITED if 0)
  321. @MAXKB@         maximum number of kilobytes this system can request
  322.                 per session (UNLIMITED if 0)
  323. @SENTFILES@     names and descriptions of sent files (everything
  324.                 else on this line will be ignored)
  325. @OVERLIMIT@     names and descriptions of files which exceeded limits
  326.                 (everything else on this line will be ignored)
  327. @NOTFOUND@      names of files for which no match was found
  328.                 (everything else on this line will be ignored)
  329.  
  330. See the example SAMPLE.TPL for an example on how to use these.
  331.  
  332. *** FILES.BBS ***
  333.  
  334. When a match is found, the file size and date/time stamp are
  335. looked up. It ignores this info in the FILES.BBS if present, so
  336. that an incorrect FILES.BBS doesn't cause incorrect results (like
  337. an attempt to send a missing file you forgot to delete from
  338. FILES.BBS etc.). Only the description is read from the FILES.BBS,
  339. with all optional information like file size, date/time, download
  340. counters etc. stripped.
  341. This way I also avoid compatibility problems with the different
  342. date formats etc.
  343. Extended descriptions are supported. The first non-whitespace character
  344. on each extended description line must be a +, | or >.
  345.  
  346. When a file is requested using a magic name, the description is searched
  347. for in FILES.BBS in the same directory as the file. For normal files, the
  348. File Listing name from the ProBoard file area configuration is used.
  349.  
  350. *** ERRORLEVELS ***
  351.  
  352. 0 = all OK
  353. 1 = syntax error
  354. 2 = file error
  355. 3 = memory error
  356.  
  357. *** CONTACTING THE AUTHOR ***
  358.  
  359. Although this is a freeware program, I am willing to give (limited)
  360. support for it. You can write netmail to me at 2:292/516@fidonet.org
  361. or call my BBS at 32-15-24.62.32 and leave a message.
  362.  
  363. *** SOURCE CODE ***
  364.  
  365. Sorry, no source code for this one. If you want to write your own
  366. file request processor, you'll find enough information in the
  367. FrontDoor development kit (FDDEV) and in the file SRIF.DOC (inside
  368. the MaxF'Req archive) to do so without having to see my source.
  369.  
  370. *** HISTORY OF PRP ***
  371.  
  372. Version         Release date    Changes
  373.  
  374. 1.0             9 Apr 1996      Original version
  375.  
  376. 1.01            3 May 1996      * Added file sharing support for
  377.                                   multiline BBSes
  378.  
  379. 1.02            27 May 1996     * Unlimited requests from free
  380.                                   file areas & free magic names
  381.                                   (configurable)
  382.                                 * Logging now possible
  383.                                 * Added documentation for setup
  384.                                   with McMail mailer
  385.                                 * Miscellaneous small changes to
  386.                                   the documentation & code
  387.  
  388. 1.02a           3 June 1996     * OS/2 problem fixed
  389.  
  390. 1.03            2 August 1996   * 32-bit OS/2 version included
  391.                                 * Copy local for cd-rom drives
  392.                                 * Supports ^AINTL,^AFMPT and ^ATOPT
  393.                                   for correctly creating messages
  394.                                   to points and/or other zones
  395.                                 * A tearline is now added to the
  396.                                   response message
  397.                                 * Fixed bug in wildcard matching
  398.                                 
  399. 1.10            20 August 1996  * Now supports SRIF interface, used
  400.                                   by Binkley 2.60 XE, Xenia, McMail,
  401.                                   Cantaloup, ...
  402.                                 * Option to update download counters
  403.                                 * More selective dupe-checking
  404.                                 * Limits are no longer hardcoded and
  405.                                   can now be set in PRP.CFG
  406.                                 * Proper descriptions are now given
  407.                                   with magic names if they are in the
  408.                                   PB filebase, the listingfile needs
  409.                                   no longer be FILES.BBS in the same
  410.                                   directory as the magic file
  411.                                 * Fixed a small bug that caused
  412.                                   download counters >99 not to be
  413.                                   stripped off properly
  414.                                 * Fixed another small bug in wildcard
  415.                                   matching; should be all fixed now
  416.                                 * If PBPATH is not defined in PRP.CFG,
  417.                                   PRP now reads PROBOARD environment
  418.                                   variable instead of PB
  419.  
  420. *** CREDITS ***
  421.  
  422. Thanks to Jacques Theys for suggesting the file sharing compatibility
  423. and for providing the correct McMail setup string.
  424.  
  425. Thanks to Jurre Van Dijken for suggesting the download counter update
  426. option.
  427.  
  428. Some of the SRIF-mailer settings were taken from the documentation
  429. of MaxF'Req file request processor written by Wilfried Brinkmann.
  430.  
  431. The SRIF (Standard Request Information File) file format is Copyright
  432. (c) 1994,95 by Gordian Schuermann & Mirko Mucko.
  433.  
  434. *** DISCLAIMER ***
  435.  
  436. I EXCLUDE ANY AND ALL IMPLIED WARRANTIES, INCLUDING WARRANTIES OF
  437. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. I MAKE NO WARRANTY
  438. OR REPRESENTATION, EITHER EXPRESS OR IMPLIED, WITH RESPECT TO THIS SOFTWARE,
  439. ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR
  440. PURPOSE. I SHALL HAVE NO LIABILITY FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
  441. DAMAGES ARISING OUT OF OR RESULTING FROM THE USE OR MODIFICATION OF THIS
  442. SOFTWARE.
  443.  
  444. *** END OF DOCUMENT ***
  445.