home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / RBTCH220.ZIP / DOCS.ZIP / RBATCH.DOC < prev    next >
Text File  |  1993-04-09  |  59KB  |  1,417 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                       ------------------------------------
  22.                         RBatch - RBBS-PC Batch Uploading
  23.                                HS/Link, & BiModem
  24.                                     Interface
  25.                       ------------------------------------
  26.  
  27.  
  28.  
  29.  
  30.                                RBatch Version 2.20
  31.                                  April 10, 1993
  32.                          (C) by Dan Shore - 1991,92,93
  33.                               By: Dan Shore - SYSOP
  34.                                 THE SHORELINE BBS
  35.                                  (301-946-2771)
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                                 TABLE OF CONTENTS
  46.                                 -----------------
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.      A. INTRODUCTION
  56.           1.  What is RBatch ....................................  3
  57.           2.  What it does ......................................  3
  58.  
  59.      B. INTERFACING RBATCH WITH RBBS-PC
  60.           1.  The RBatch Configuration File .....................  4
  61.           2.  Line-by-line analysis of the configuration file ...  5
  62.           3.  Additional notes on the configuration file ........ 12
  63.           4.  The RBBS-PC Proto.Def Setup ....................... 13
  64.           5.  Batch Files used in Proto.Def ..................... 14
  65.           6.  The RBatch Command Line ........................... 15
  66.           7.  SysOp Designed Batch Files ........................ 15
  67.           8.  Batch File Passed Parameters ...................... 16
  68.           9.  Calling other testers from the batch files ........ 16
  69.           10. Batch File Examples ............................... 16
  70.           11. Colorized Batch Files ............................. 17
  71.           12. Alternate Batch File Names ........................ 19
  72.           13. Flexibility in RBatch File Processing ............. 19
  73.  
  74.      C. MISCELLANEOUS INFORMATION
  75.           1.  Use of Recovery with Protocols and RBatch ......... 19
  76.           2.  User Time-Outs and Dropped Carriers ............... 19
  77.           3.  RBatch Error Logging .............................. 20
  78.           4.  What Do The Included Merges Do .................... 21
  79.           5.  Why Is RBatch An External Program ................. 21
  80.           6.  Companion Program For RBatch ...................... 21
  81.           7.  Warranty And Disclaimer ........................... 22
  82.           8.  Registration ...................................... 22
  83.           9.  Acknowledgments ................................... 22
  84.           10. Last Minute Notes ................................. 23
  85.           11. Support ........................................... 23
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.                                   - 2 -
  104.  
  105. A.                             INTRODUCTION:
  106.  
  107. A-1.     What is RBatch?
  108.          ---------------
  109.  
  110. RBatch is an upload interface utility for RBBS-PC Bulletin Board Systems.
  111. RBatch enables RBBS-PC (versions 12.x-17.4) to receive and process BATCH
  112. uploads.  It is an EXTERNAL program (NO code modification is necessary)
  113. that is called by RBBS after file transfers. It reads a standard, "true"
  114. DSZ log file (XFER-?.DEF) generated by most of today's better file transfer
  115. protocols, and reports the uploaded information to RBBS's system files
  116. in ways that make the SysOp's job much easier and less time-consuming.
  117. RBatch is fossil-aware, but does NOT require a fossil to run.
  118.  
  119. RBatch also is the interface for the new and extremely popular protocol,
  120. HSLINK, by Sam Smith--and the BiModem bi-directional protocol.
  121.  
  122.  
  123. A-2.     What it does?
  124.          -------------
  125. RBatch is called after file transfers are completed, and will:
  126.  
  127.      - check each file uploaded to see if it is a DUPLICATE of
  128.         a file already on the BBS.   This is accomplished by RBatch
  129.         checking the FFS (FIDX.DEF & FIDXT.DEF) and/or the SysOp 
  130.         designated directories that are listed in the RBatch 
  131.         configuration file.
  132.  
  133.      - check uploaded file INTEGRITY with SysOp designed batch files.
  134.         Files may be scanned for viruses, unwanted uploads, files too
  135.         old, etc.  Comments and logos may be stripped or added in these
  136.         BATCH FILES.
  137.  
  138.      - ask the user for an upload CATEGORY (if security level allows),
  139.         and a DESCRIPTION of the file.  Or, optionally, process
  140.         FILE_ID.DIZ, DESC.SDI or .DOZ files AUTOMATICALLY and post 
  141.         the file descriptions in them to the FMS.  No TYPING!
  142.         (See WHATISA.DOZ for details on RBatch's new and revolutionary
  143.         .DOZ File Descriptions Process).
  144.  
  145.      - post all necessary information to the FMS directory, USERS,
  146.         & CALLERS files.
  147.  
  148.      - Award time credits for the upload based on the user's security level.
  149.  
  150.      - Works for regurlar uploads as well as Personal Uploads
  151.  
  152.  
  153.   ***********************************************************************
  154.   * NOTE:  RBatch is responsible for the logging and processing of ALL  *
  155.   *        uploaded files, while RBBS is responsible for ALL downloaded *
  156.   *        files.                                                       *
  157.   ***********************************************************************
  158.  
  159.  
  160.  
  161.  
  162.                                   - 3 -
  163.  
  164. B.                      INTERFACING RBATCH WITH RBBS:
  165.  
  166. Three things are crucial to the proper "marriage" between RBatch and
  167. RBBS-PC:
  168.  
  169.         1.  The RBatch configuration file.  (Which you must create.)
  170.         2.  The RBBS PROTO.DEF file. (Which you must modify.)
  171.         3.  The Batch Files that are in the Proto.Def.  Example are
  172.             included, just change them to match your system.
  173.  
  174. B-1.     The RBatch configuration file:
  175.          ------------------------------
  176.  
  177. Here is the layout and description of each line in the RBatch
  178. configuration file.  (Note that the configuration file CANNOT
  179. have comments like those in the example below!):
  180.  
  181. D:\Uploads;YES                          <-- 1  Path to upload directory;Pause Prompt
  182. No;C:\Rbbs\Dorinfo[NODE].Def            <-- 2  Create;Path to DORINFOx.DEF
  183. ZIP;LZH;ARJ;ZOO;EXE                     <-- 3  Archive types to check for
  184. 5,50;10,100;15,150;20,200               <-- 4  Security level,credit parameters
  185. C:\Rbbs\Master.Dir;NONE;YES             <-- 5  FMS;2nd place to write;Strip periods from Filenames
  186. BLANK                                   <-- 6  Path to NON-FMS dirs
  187. C:\Rbbs\Messages                        <-- 7  Path to RBBS MSG file
  188. C:\Rbbs\Users                           <-- 8  Path to RBBS USERS file
  189. C:\Rbbs\Caller[NODE]                    <-- 9  Path to RBBS CALLERS file
  190. C:\Rbbs\Dir.Cat                         <-- 10 Path to RBBS directory categories
  191. C:\Rbbs\Xfer-[NODE].Def                 <-- 11 Path to DSZ transfer log
  192. SECRET NAME                             <-- 12 SYSOP'S secret name
  193. 5;C:\Rbbs\Upcat.Hlp                     <-- 13 SEC for cat.;Hlp file for upcat
  194. FMS                                     <-- 14 Using FMS or .DIR
  195. UNC                                     <-- 15 Default category code
  196. ZIP                                     <-- 16 Extension to convert to
  197. YES;YES                       ###       <-- 17 Save files on timeouts/errors?;Delete partial uploads?
  198. NO                                      <-- 18 Using FOSSIL?
  199. 46                                      <-- 19 # characters in first description line
  200. 5;YES;YES                     ###       <-- 20 # of ext. description lines;BamaWho Support;Post SysOp for Bama Who
  201. YES;C:\Fidx.Def;C:\Lidx.def;200         <-- 21 Use FFS system?;location of FIDX;location of LIDX;Sec Level for Overwrite
  202. C:\Rbbs\Dupelist.Lst                    <-- 22 Additional DIRs to look for dupes
  203. DV                                      <-- 23 Environment running
  204. THE SHORELINE BBS                       <-- 24 BBS Name
  205. 00000000000000000000                    <-- 25 Registration # (or all 0's)
  206. YES;D:\WORK;F:\TC\ARC.LST;DOZ           <-- 26 Use Desc. Files;Work Dir.;Archive list;DOZ Priority
  207. YES;10;F:\PRIVATE\PRIV.DIR;YES          <-- 27 Use Personal;Sec. Level;Path/Name of personal file;Post username who upld.
  208. YES;10;F:\DAN\                          <-- 28 Use Dist. Lists;Security to use Dist. List;Path to lists
  209. YES;5;20;1;31                           <-- 29 Use Ext. Desc;# of lines;Sec Level for sec Uploading;start pos;length
  210. 100;BATCH.BAT;BATCH1.BAT                <-- 30 Sec Level to bypass batch files;batch file names
  211.  
  212.            < ### = Denotes New Parameters for RBatch 2.20 >
  213.  
  214. This is the heart of the RBatch process.  This text file tells RBatch
  215. the name and location of all the files that it needs or uses on your
  216. system.  It sets security levels, upload credits, paths, duplication
  217. checking methods, designates batch files to call scanning programs and
  218. archive checkers, and much more.
  219.  
  220. This file may be created with your favorite editor, like QEdit or QDos
  221. editor, and may be named anything you wish, or stored anywhere on the
  222. system.  All you need to do is tell RBatch the name and location of
  223. its configuration file on the RBatch command line.  THERE IS NO
  224. DEFAULT FILENAME THAT RBATCH LOOKS FOR.
  225.  
  226.                                   - 4 -
  227.  
  228.  
  229.  
  230. B-2.    Line-by-line analysis of the RBatch configuration file:
  231.         -------------------------------------------------------
  232.  
  233. 1.  Path to Upload Directory;Pause Prompt
  234.  
  235.       - This is the full path to your Upload Directory.
  236.         (Path/Dir - NO TRAILING BACKSLASH)
  237.  
  238.       - 20 Second Pause Prompt - enter YES after semi-colon.  If you
  239.         just have your path to the Upload Directory and NO SEMI-COLON
  240.         then the feature is DISABLED.  The pause prompt stays for 20
  241.         seconds or until user hit ENTER Key.
  242.  
  243.         Pause prompt looks like this:   Press [ENTER] to continue: . . .
  244.         Dots will go back and forth until user hits enter or 20 Secs. passes
  245.         ### (This is a new feature for 1.80)
  246.  
  247. 2.  Shall RBatch create a DORINFOx.DEF;Path/name of the DORINFOx.DEF file:
  248.  
  249.         First parameter MUST be either YES or NO.  If you are
  250.         running RBBS-17.4, you would specify "NO." (RBBS v.17.4
  251.         is the first version to create its own DORINFOx.DEF file
  252.         for DOORING protocols) for the first parameter, and the
  253.         location of the DORINFOx.DEF file for the second parameter.
  254.         All earlier versions of RBBS prior to 17.4 specify "YES"
  255.         and RBatch will create a "working" copy of the DEF file in
  256.         this specified location.  (Note semicolon...)
  257.  
  258.         If you examine this file when RBatch creates it,
  259.         you will notice that it does not have the "normal"
  260. ====    DORINFO information in it.  Do not be concerned, I only   ====
  261.         write the information I need to run RBatch.
  262.  
  263.             NO  = RBatch DOES NOT create ; path to RBBS's (17.4) own file
  264.             YES = RBatch DOES create ; where you want us to put it
  265.  
  266. 3.  Extensions to check for duplicates -- or NONE:
  267.  
  268.         This parameter allows the SysOp to specify which
  269.         extensions to check when RBatch checks for duplicates
  270.         of uploaded files.  If SysOp only wants the uploaded file
  271.         checked just input the word NONE here instead.
  272.  
  273.             ARC;ZIP;LZH;ZOO
  274.             NOTE: ALL THE EXTENSIONS MUST BE SEPARATED BY A SEMI-COLON!!!
  275.             MAXIMUM NUMBER OF EXTENSIONS = 15
  276.  
  277. 4.  Security Level,Time CREDIT percentage given for UPLOADS (###):
  278.  
  279.  
  280.         Time credits may now be assigned by security level(s).
  281.         The format for the Time Credit line in the configuration file is:
  282.  
  283.         SECURITY LEVEL1,PERCENTAGE1;SECURITY LEVEL2,PERCENTAGE2
  284.  
  285.  
  286.  
  287.  
  288.  
  289.                                   - 5 -
  290.  
  291.         Here is an example:    5,125;10,150;15,175;25,200
  292.  
  293.             Users with security levels LESS THAN OR EQUAL TO 5 
  294.               would get 125%,
  295.             Users with security levels between 6 and 10 would get 150%,
  296.             Users with security levels between 11 and 15 would get 175%,
  297.             Users with security levels between 16 and 25 would get 200%.
  298.         ~(Note the way commas and semicolons are used on this line.)
  299.  
  300.  
  301.         You must have the HIGHEST value security level at the minimum
  302.         if just using one time credit percentage.  In other words, if
  303.         the highest security level of a user on your BBS is 100, and you
  304.         want ALL your users to have 100% time credits, then your
  305.         configuration line would be:
  306.  
  307.                        100,100
  308.  
  309.         Remember that RBatch checks to see if the user's security
  310.         level is LESS THAN OR EQUAL TO the security level(s) on this
  311.         line and then uses the associated percentage.
  312.  
  313.         Note also, that if you use multiple security levels, this line
  314.         should read (left to right) from lowest security level to the
  315.         highest, just like the examples.
  316.  
  317.         Currently you may define up to twenty security levels.
  318.  
  319.         The amount of time credit received (based on the percentage) is
  320.         calculated as shown in these examples:
  321.  
  322.             Ex. # 1  -  File upload time = 5:00 Minutes
  323.                         Time Credit%    = 150% (7:30 Minutes)
  324.                         5:00 + 7:30      = 12:30 of Time Credits
  325.             Ex. # 2  -  File Upload Time = 5:00 Minutes
  326.                         Time Credit%     = 50% (2:30 Minutes)
  327.                         5:00 + 2:30      = 7:30 of Time Credits
  328.             Ex. # 3  -  File Upload Time = 5:00 Minutes
  329.                         Time Credit%     = 0%
  330.                         5:00 + 0         = 5:00 of Time Credits
  331.  
  332.         The User always gets the time back it took to upload the file,
  333.         plus the percentage that you assign in the configuration file.
  334.  
  335.  
  336. 5.  Path/Name primary FMS/.DIR;Path/Name secondary FMS/.DIR;Remove period
  337.  
  338.         This is the text directory where the uploaded filenames and their
  339.         descriptions are WRITTEN.  If you wish to post this information
  340.         to more than one file, list the path/name of the second file AFTER
  341.         the Semi-Colon.  If you do not wish to post to more than one file,
  342.         then you must enter "NONE" as the second parameter.  The last
  343.         parameter will post the filenames without the period.  RBatch will
  344.         pad with spaces and line up the extensions.  DO NOT USE ANY
  345.         PARAMETER PAST THE SECONDARY FILENAME IF YOU WANT PERIODS!
  346.  
  347. 6.  Path to the .DIRs - Enter the word "BLANK" if using FMS:
  348.  
  349.         This is the path to where your .DIR's are.  An example of
  350.         this is:
  351.  
  352.                         C:\FILES\
  353.  
  354.  
  355.                                   - 6 -
  356.  
  357.  
  358.  
  359. 7.  Path/Name to MESSAGES File: (Self Explanatory)
  360.  
  361. 8.  Path/Name to USERS File:    (Self Explanatory)
  362.  
  363. 9.  Path/Name to CALLERS File:  (Self Explanatory)
  364.  
  365. 10. Path/Name to DIR.CAT File:  (Self Explanatory)
  366.  
  367.  
  368. 11. Path/Name to XFER-?.DEF File:
  369.  
  370.         Protocols ALWAYS write the Xfer-?.Def file in the CURRENT directory
  371.         when the protocol is invoked.  Make sure that you have your
  372.         SET DSZLOG=XFER-?.DEF (? = Node #) in your AUTOEXEC.BAT or your
  373.         DESQVIEW startup window batch file.  Do not use a path in
  374.         your SET DSZLOG statement.
  375.  
  376.         For example, if you are in the RBBS directory when you execute
  377.         DSZ, the XFER-?.DEF file will reside in the  RBBS Directory.
  378.         If you change to your upload directory when you invoke DSZ,
  379.         the XFER-?.DEF file will reside in your upload directory.
  380.         Note that RBatch will DELETE the XFER-?.DEF file, when there
  381.         are just uploads.
  382.  
  383.         If you are doing bidirectional transfers, the XFER will have
  384.         to be located in the current directory as the user when doing
  385.         a transfer (the Main RBBS directory or the Node Directory).
  386.         RBatch will not delete the XFER due to RBBS needing to "see"
  387.         the XFER file to report a successful transfer.
  388.  
  389. 12. SysOp's secret name :
  390.  
  391.         Enter "BLANK" if you do not wish the USERS file to be updated
  392.         with file count information for SysOp file transfers.
  393.  
  394.         Also if you wish to be notified of a personal upload you MUST
  395.         use your Secret Name, otherwise RBatch does not know who you
  396.         are and cannot set the personal upload flag.
  397.  
  398. 13. Min Security Level to Categorize;Path/Name of UPCAT.HLP File:
  399.  
  400.         The First Parameter is the MINIMUM security level a user must have
  401.         in order to categorize a file that he/she uploaded.  If their level
  402.         is LOWER than this value, the uploaded file will have the default
  403.         category code for FMS (line #15), and in the .DIR system, will be
  404.         posted to the file listed on line #5 in this configuration file.
  405.         The Second Parameter is the path/filename of the UPCAT.HLP file.
  406.  
  407.             < A useful feature for SYSOPS is that you do not have
  408.               to use the SAME UPCAT.HLP file you specify in RBBS's
  409.               CONFIG parameter #!  The file you specify here may
  410.               display entirely different categories, or you may
  411.               create a special one for local/SYSOP only uploads! >
  412.  
  413.  
  414.  
  415.  
  416.                                   - 7 -
  417.  
  418. ###     ----------------> New in RBatch 1.75 <----------------      ###
  419.  
  420.         RBatch now supports colorized UPCAT.HLP files for users that
  421.         have color chosen as their graphics type.  The program will look
  422.  
  423.  
  424.         for the following:
  425.  
  426.         Non-Color Graphics Choice         Color Graphics Choice
  427.         -------------------------         ---------------------
  428.  
  429.             UPCAT.HLP                         UPCATC.HLP
  430.  
  431.     You will note that the program looks for the filename with a "C"
  432.     appended to the filename.  If the "C" file does not exist then
  433.     the non-color file is used.  Also, remember that you can call
  434.     RBatch's UPCAT.HLP file whatever you wish, as long as it is specified
  435.     in the configuration file.
  436.  
  437. 14. Are you using FMS or .DIR?
  438.  
  439.             Enter:  FMS or DIR
  440.  
  441. 15. Default Category or Path/Name of SysOp-only uploads file (.DIR):
  442.  
  443.     This is the category given to uploads:
  444.             1. that are saved by the SysOp after a user times out
  445.                (falls asleep, too busy getting a beer, etc.) during or
  446.                after the upload WITHOUT entering the category.
  447.             2. if a user drops carrier during the upload process.
  448.             3. where the user does not have a high enough security level
  449.                to categorize uploads.
  450.  
  451.     If the SysOp is using the .DIR file system, then this entry will be
  452.     the path/name of the file that the SysOp wants the personal (/) uploads
  453.     posted to.  This file is only for the .DIR file system and not the FMS.
  454.  
  455. 16. Compression type all files are converted to:
  456.  
  457.     Enter "NONE" if you perform no conversions in your Batch File
  458.  
  459.     If you have batch files (PHASE?.BAT, CARCZIP.BAT, etc.) which convert
  460.     all uploaded files to a common format, enter the extension converted
  461.     TO here, otherwise, enter "NONE."
  462.  
  463. 17. Save files on User Timed Out or Dropped Carrier Uploads?;Delete Partial Files?
  464.             Enter:  YES or NO
  465.     ==== See section below on "User Time-Outs and Dropped Carriers"    ====
  466.  
  467.     If you just have YES on this line and nothing else, then RBatch will not
  468.     delete partial file uploads (uploads with "E" or "L" in the DSZLOG file).
  469.     If you wish to delete partial files, have this line entered as "YES;YES"
  470.     or "NO;YES".
  471.  
  472. 18. Use Fossil Driver?
  473.  
  474.             Enter:  YES or NO
  475.  
  476.         RBatch has support for the fossil drivers X00 or BNU.
  477.         Enter either "YES" or "NO" on this line in the configuration file.
  478.  
  479.         (We also support 16550AFN UARTS.)
  480.  
  481.                                       - 8 -
  482.  
  483. ==== If you run with a special type of COM Port setup (non-standard ====
  484.         IRQ's, etc.) you will be required to utilize a FOSSIL driver,
  485.         or RBatch will not function properly!
  486.  
  487. 19. Size of first FMS/.DIR File Description Line:
  488.  
  489.             Enter:  a number from 40 to 46
  490.  
  491. 20. Number of Lines for Extended Descriptions;Use BAMA support;Show SysOp on BamaWho
  492.                                                                ^          ^
  493.             Enter:  # of lines;YES or NO;YES or NO          ** New in 2.20 **
  494.  
  495.      Place the value of the maximum number of lines you will allow in
  496.      your FMS/.DIR's for extended FMS descriptions as the FIRST parameter
  497.      on this line.  As a second parameter, enter either "YES" or "NO"
  498.      --"YES if you use the BAMA WHO mod for posting the name of the
  499.      uploader to the FMS, "NO" to disable this feature.
  500.      To suppres "Uploaded by SysOp", enter "NO" as the third parameter.  If
  501.      you want this statement posted, then enter "YES as the third param.
  502.  
  503. 21. Use FFS System;Path/Name of Fidx.Def file;Path/Name of Lidx.Def;Sec Level
  504.                                                      ^                 ^
  505.     YES or NO - for using FFS System.                |                 |
  506.                                                ###   New in  RBatch 2.00 ###
  507.  
  508.     It is assumed that if the SysOp uses the TAB file of the FFS system,
  509.     that the filename is the same as the FIDX.DEF file, except that it
  510.     has a "T" in it & resides in the same directory as FIDX.  The security
  511.     level is who can overwrite an existing file if RBatch detects a
  512.     duplicate file.  RBatch will prompt the user to overwrite the existing
  513.     file and if user says "Y", RBatch copies the upload to the same directory
  514.     as the duplicate file and then deletes the file from the upload directory.
  515.  
  516. 22. Path/Name of file listing Directories to check for duplicate Uploads:
  517.  
  518.     This is a FILE that contains PATHS to file directories
  519.     to be checked for duplicate files in ADDITION to the ones that the
  520.     FFS already indexes. Here is an example of a listing:
  521.   
  522.     Do not enter each of these paths in the configuration file!!
  523.     The filename you specify on the configuration line contains
  524.     these paths.
  525.  
  526.                     c:\temp\
  527.                     c:\testing\
  528.                     d:\other\
  529.  
  530. ==== (One directory per line, and each line MUST END WITH A BACKSLASH!) ====
  531.  
  532.     If you specify "NO" for using a FFS system in line #22, then this
  533.     list of directories is what is used by RBatch to check for duplicate
  534.     uploads.   ***   MAXIMUM NUMBER OF DIRECTORIES SUPPORTED = 80 ***
  535.  
  536. 23. Environment Running under (choose one):
  537.  
  538.             Enter:  DOS - Running RBBS-PC\RBatch in DOS
  539.                     DV  - Running RBBS-PC\RBatch in DV
  540.                     NET - Running RBBS-PC\Rbatch in a Network Environment
  541.                             that REQUIRES running DOS's SHARE.EXE
  542.  
  543.                                   - 9 -
  544.  
  545. 24. BBS Name to appear on Registered Versions:
  546.  
  547.             Enter:  50 characters Maximum
  548.  
  549. 25. Registration Number:
  550.  
  551.             Enter:  20 Alpha-Numeric Registration Code
  552.  
  553.             (Input all "0"s if unregistered)
  554.  
  555. 26. Process .DIZ/.SDI/.DOZ files?;Work Directory;File with archive commands;DOZ Priority
  556.                  1                      2                 3                  4
  557.  
  558.             Enter:  1. YES or NO - This tells RBatch to process FILE_ID.DIZ,
  559.                                    DESC.SDI, or .DOZ files.
  560.                     2. Path to the work directory we will use to decompress
  561.                        the DIZ, DOZ*, or SDI file into.  NOTE: This directory
  562.                        must actually exist in order to process these files!
  563.                        RBatch creates, then deletes, NODE# directories under
  564.                        this specified directory.
  565.                     3. The THIRD parameter is the filename that contains
  566.                        a list of archive extensions and their associated
  567.                        command lines for DEcompressing (unZIPping, unARCing,
  568.                        etc.) for the decompressors that you wish to support.
  569. ## - New 2.00 -     4. DOZ files take priority over .DIZ/.SDI files if the
  570.                        word DOZ is the last parameter.  If no parameter is
  571.                        used .DIZ/.SDI files take precedence for file
  572.                        descriptions.
  573.  
  574.            Ex.:     ARC.LST (or whatever name you choose) is a text file
  575.                     like this:
  576.  
  577.                      ARJ;C:\RBBS\ARJ E
  578.                      ZIP;C:\PKZIP\PKUNZIP -O
  579.                         ^          ^
  580.                         1          2
  581.  
  582.            The FIRST part is the extension to process
  583.            The SECOND parameter is the path/command line
  584.            to use for that particular extension.
  585.  
  586. ==== NOTE: If a file is uploaded and its extension does not match an
  587.            entry in this file, the upload will not be checked for an
  588.            embedded description file (FILE_ID.DIZ or DESC.SDI).
  589.  
  590. *    For more information on .DOZ files, see the
  591.      WHATISA.DOZ file included in this archive.
  592.  
  593.      SysOp's now have the ability for the .DOZ file to OVERRIDE the
  594.      .DIZ/.SDI files.  If you wish to OVERRIDE, put ";DOZ" as the last
  595.      parameter on this line.  If you do not add anything to the end
  596.      of this line, the program will read a .DIZ/.SDI file before it
  597.      reads a .DOZ file for the file description.
  598.  
  599.      Here is an example of .DIZ/.SDI having priority:
  600.  
  601.              YES;D:\WORK;F:\TC\ARC.LST
  602.  
  603.  
  604.  
  605.                                   - 10 -
  606.  
  607. 27.  Allow Personal Files;Sec Level;Path/Filename of Personal File;Upld UserName
  608.  
  609.       --- This is new in RBatch version 2.00 ---
  610.  
  611.      This consists of 4 parts (each seperated by a SEMI-COLON) :
  612.  
  613.      a. Allow Personal Uploads - YES or NO
  614.      b. Security Level ( Greater than or equal to) to use Personal Uploads
  615.      c. Path/Filename of the Personal Upload File (Priv.Def)
  616.         [This is the same directory as where your personal files are]
  617.      d. YES if you wish to have the Username of the person uploading the file
  618.         as part of the file description.
  619.  
  620.      IF YOU DO NOT WANT THE USERNAME AS PART OF THE DESCRIPTION, DO NOT
  621.      ADD ANYTHING AFTER THE PATH/FILENAME OF THE PERSONAL FILE!!
  622.  
  623. 28.  Allow Dist. Lists;Security Level to use List;Path to Distribution Lists
  624.  
  625.       --- This is new in RBatch version 2.00 ---
  626.  
  627.      This consists of 3 parts (each seperated by a SEMI-COLON) :
  628.  
  629.      a. Allow distribution lists for Personal Uploads - YES or NO
  630.      b. Security Level to be allowed to use distribution lists.  This
  631.         security level must be equal to or greater than the .cfg level
  632.         in order to use the distribution list feature.
  633.      c. Path to directory that contains the distribution lists
  634.         [ NOTE:  THIS MUST END WITH A TRAILING BACKSLASH !! ]
  635.         Also, all distribution list MUST end with a .LST, as
  636.         per RBBS rules.
  637.  
  638.  
  639. 29.  Ext Descriptions;# of lines;Sec Level for Sec Level Pers Uploads;Start Pos.;Length
  640.  
  641.       --- This is new in RBatch version 2.00 ---
  642.  
  643.      This consists of 5 parts (each seperated by a SEMI-COLON) :
  644.  
  645.      a. Allow extended descriptions in persoal uploads - YES or NO
  646.      b. Number of extended description lines allowed
  647.      c. Security Level (greater than or equal to this) for a user to
  648.         be able to post a personal upload to a security level
  649.      d. Starting point in user record for identifying field
  650.      e. Length of identifying field from starting point in user record
  651.  
  652.      Note:  The most common way to use the Identifying field is to
  653.             start at 1 and have 31 characters (The persons Name).
  654.             Check your RBBS configuration file to see what you have
  655.             set up as your identifying field.  The default for RBBS
  656.             is the username (start = 1, length = 31).
  657.  
  658.  
  659. 30.  Sec Level;Batch file;Batch file;Batch file
  660.  
  661.       --- This is new in RBatch version 2.00 ---
  662.  
  663.      This consists of 1 to 4 parts  (each seperated by a SEMI-COLON) :
  664.  
  665.                                   - 11 -
  666.  
  667.      - Part 1 is mandatory while parts 2-4 are optional -
  668.                  ^^^^^^^^^                     ^^^^^^^^
  669.      a. Security Level (greater than or equal to) to bypass the batch
  670.         files to check uploads.
  671.      b. Name of the first batch file to check uploads
  672.      c. Name of the second batch file to check uploads
  673.      d. Name of the third batch file to check uploads
  674.  
  675.      If no batch files are named, the program defaults to using
  676.      PHASE1.BAT, PHASE2.BAT & PHASE3.BAT IF THEY EXIST.  Note that
  677.      the batch file(s) MUST RESIDE in the SAME directory as the
  678.      RBatch.CFG file.
  679.  
  680. ***> One important point to remember is that RBatch looks for the batch
  681.      file in the SAME DIRECTORY as the Configuration File.
  682.  
  683.              Here are some examples of LINE #30:
  684.              -----------------------------------
  685.  
  686.      YES;C:\RBBS\WORK;C:\RBBS\ARC.LST     - Currently the last line in config.
  687.      100;LOCAL.BAT;LOCAL1.BAT;LOCAL2.BAT  - New line is entered with the
  688.                                             names of the batch files to use.
  689.  
  690.      In this example LOCAL.BAT is called first, LOCAL1.BAT is called next,
  691.      and LOCAL2.BAT is called last.
  692.  
  693.              Here is another example:
  694.              ------------------------
  695.      YES;C:\RBBS\WORK;C:\RBBS\ARC.LST - Currently the last line in config.
  696.      100;LOCAL.BAT;LOCAL1.BAT         - New line is entered with the names of
  697.                                         the batch files to use.
  698.  
  699.      In this example LOCAL.BAT is called first, then LOCAL1.BAT, then
  700.      PHASE3.BAT is called last.
  701.  
  702.             And yet another:
  703.             ---------------
  704.      YES;C:\RBBS\WORK;C:\RBBS\ARC.LST - Currently the last line in config.
  705.      100;LOCAL.BAT                    - New line is entered with the name of
  706.                                         the batch file to use.
  707.  
  708.      In this example LOCAL.BAT is called first, then PHASE2.BAT is called next,
  709.      then PHASE3.BAT is called last.
  710.  
  711.  
  712.             Duh!:
  713.             -----
  714.      YES;C:\RBBS\WORK;C:\RBBS\ARC.LST - Currently the last line in config.
  715.      100;                             - No additional line is entered in
  716.                                         this configuration file example.
  717.                                         NOT EVEN A BLANK LINE!!!!
  718.  
  719.      In this example PHASE1.BAT is called first, then PHASE2.BAT is called
  720.      next, then PHASE3.BAT is called last.
  721.  
  722.         Note from the examples, that you may specify from one to
  723.         three new batch files for RBatch to use.  When using more
  724.         than one batch filename you MUST separate each name with a
  725.         SEMI-COLON!
  726.  
  727.         RBatch will only execute the Batch Files THAT IS CAN FIND.
  728.  
  729.                                   - 12 -
  730.  
  731.  
  732.  
  733.  
  734. B-3.    Additional notes for the RBatch Configuration file:
  735.         --------------------------------------------------
  736.      As of v.1.70, the variable [NODE] may be placed into the
  737.      configuration file anywhere you use a path/filename option.
  738.      When [NODE] is found, RBatch will substitute the node number
  739.      from the RBatch Command line in place of [NODE].  This new
  740.      feature should allow the SysOp, if they wish, to be able to
  741.      use ONE configuration file for all their nodes on the Main
  742.      board and one for each Sub-Board.
  743.  
  744.             Here is an example usage:
  745.             -------------------------
  746.           .
  747.           NO;c:\rbbs\node[node]\dorinfo[NODE].def
  748.           .
  749.           .
  750.           c:\rbbs\node[node]\callers[NODE]
  751.           .
  752.           .
  753.           c:\rbbs\xfer\xfer-[NODE].def
  754.           .
  755.           .
  756.                 (NOTE:  [NODE] is not case sensitive)
  757.  
  758.  
  759. ==== Once again I must stress that all the NAMES used in the above
  760.      configuration example are optional and SYSOP-configurable.
  761.      The only names that RBatch REQUIRES be used are PHASE.BAT,
  762.      PHASE2.BAT and PHASE3.BAT, and THEN only IF you do not
  763.      specify alternate BAT file names for configuration line #27.
  764.  
  765. ==== Also, make sure that all the lines in the configuration file end with
  766.      a carriage return.  THERE SHOULD BE NO SPACES AFTER THE LAST ENTRY
  767.      ON EACH LINE.  IF YOU HAVE SPACES, YOU WILL GET ERRORS AND RBATCH
  768.      WILL NOT RUN.
  769.  
  770.  
  771.  
  772. ==== A Note about Sub-Boards:
  773.  
  774.      In your RBatch configuration file, you should point to the MAIN
  775.      MESSAGE BASE.  If your Sub-Board uses aliases the user's REAL NAME
  776.      will be in the Main Message base and when RBatch goes to find the
  777.      user name in the Users file, it will find a match.  You should still
  778.      specify the Main Message Base even if you do not use aliases, due to
  779.      RBBS reading the Main Message base first upon return from the protocol,
  780.      hence time credits have to be written here in order for users to get
  781.      credit.
  782.  
  783. ==== Additional Feature of RBatch
  784.  
  785.      A file has been included in this archive called ADDIN.DOC and describes
  786.      how you can have RBatch add a file to each file uploaded.  Those of you
  787.      that take the time to read this documentation now know about this
  788.      additional feature if you want to use it!
  789.  
  790.                                   - 13 -
  791.  
  792. B-4.    The RBBS-PC PROTO.DEF Setup:
  793.         ----------------------------
  794.  
  795. Equally important to proper operation of RBatch is the structure
  796. of the RBBS PROTO.DEF protocol handling file.  This file designates
  797. the way RBBS loads the external protocols, and what information passes
  798. between the two (the system and the protocol) during a file transfer.
  799. Included in this archive are examples of PROTO.DEF setups.  Please
  800. refer to these files for assistance in setting up DSZ, HS/Link &
  801. BiModem.  Also, if you are not familiar with the structure of the
  802. RBBS PROTO.DEF file, we suggest you familiarize yourself with that
  803. section of the RBBS DOCuments.
  804.  
  805. Files included here are for EXAMPLE purposes only and all param-
  806. eters and criteria (security levels, paths, etc.) that are unique to
  807. your system need to be changed to match your BBS setup.
  808.  
  809. Note in the Proto.Def example, that XModem and 1K-Xmodem are shelled
  810. to and do not use RBatch.  This was done to show you that all protocols
  811. do not have to use RBatch.  If you wish all protocols to use RBatch for
  812. processing, just change the XModem entries to match the Xmodem sample
  813. entries in the Proto.def and refer to the batch files that are included
  814. in the BATCH.ZIP file.
  815.  
  816. There is also an example of how to use Xmodem and 1K-Xmodem (DSZ) with
  817. RBatch.  Thanks to Don Silva for assisting in the proper commands needed
  818. to use RBatch and XModem.
  819.  
  820. Remember for RBBS to recognize an entry in the Proto.Def it has to be
  821. able to "find" the batch file or program.  If you have your Proto.Def
  822. in a directory called C:\RBBS\XFER and all your batch files and protocols
  823. are also there, then your entries in the Proto.Def should have paths.
  824. Here is an example:
  825.  
  826. ....."C:\RBBS\XFER\BATCHDN.BAT [PORT#] [BAUD] [PROTO] [NODE]",".....
  827.  
  828. Note that this example only shows the "download side" of the Proto.Def
  829. entry, but I hope you get the idea.
  830.  
  831.  
  832. The only major REQUIREMENT for RBatch is that it requires DOORING to
  833. the protocol.  DO NOT SHELL!!!  This is an easy modification--requiring
  834. typing one letter in each line of your PROTO.DEF file.  (Change the "S"
  835. to a "D.")
  836.  
  837. If you wish to shell to your protocols, RBBS & RBatch has been tested
  838. and works with SHROOM
  839.  
  840.  
  841. B-5.    Batch Files used in PROTO.DEF:
  842.         -----------------------------
  843.  
  844. Also included in this archive are examples of the batch files that are
  845. used in our PROTO.DEF examples.
  846.  
  847. The file BATCH.ZIP contains:
  848.  
  849. BATCHUP.BAT   BATCHUPY.BAT   BATCHUPG.BAT   BATCHUPX.BAT   B1UPX.BAT
  850. BATCHDN.BAT   BATCHDNY.BAT   BATCHDNG.BAT   BATCHDNX.BAT   B1DNX.BAT
  851.  
  852.  (Zmodem)      (YModem)       (Ymodem-G)      (Xmodem)     (1K-Xmodem)
  853.  
  854.                                   - 14 -
  855.  
  856. The file HSLNKBAT.ZIP contains the two batch files:
  857.  
  858.      HS1UP.BAT     HS1DN.BAT
  859.      (These are for use with HS/Link)
  860.  
  861. The file BIMODEM.ZIP contains the:
  862.  
  863.      - A sample PROTO.DEF setup for Bimodem/RBatch.
  864.      - Sample BAT files used in PROTO.DEF (BI1UPA.BAT & BI1DNA.BAT).
  865.      - An example of an RBatch/BiModem configuration file.
  866.  
  867. (Again, note that these are examples and are to be used only as guidelines
  868. and should be modified to match your BBS setup.)
  869.  
  870.  
  871. SPECIAL NOTE on BATCHUPx.BAT:
  872.  
  873. For uploads with the DSZ protocols, these sample batch files first
  874. change to the upload drive & directory and then invoke the DSZ protocol.
  875. I have done it this way to show how SysOps who do not have a registered
  876. version of DSZ can designate an "Upload Directory."   With a registered
  877. version of DSZ, you may specify the path on the DSZ command line.
  878.  
  879. Check the DSZ documentation (sort of like suicide, huh?) for the proper
  880. command line for registered versions.
  881.  
  882.  
  883. B-6.    The RBatch COMMAND line:
  884.         -----------------------
  885.  
  886. The RBatch command line syntax is as follows:
  887.  
  888.    RBatch <Path/Config Filename> <Port #> <Proto Letter> <Node #> <Special>
  889.  
  890.            The config filename may have a path to it and the
  891.            other parameters can be passed from your PROTO.DEF
  892.            command lines with:
  893.  
  894.            <Port #>       = [PORT#]   NOTE: Use [PORT#]-not [PORT]!
  895.            <Proto Letter> = [PROTO]
  896.            <Node #>       = [NODE]
  897.            <SPECIAL>      = If RBatch is processing an upload using PCZ
  898.                             OR ZSX Protocol this is MANDATORY.  Do not include
  899.                             on command line if not using PCZ or ZSX.
  900.  
  901.         If your proto.def looked like this:
  902.           "C:\RBBS\XFER\BATCHDN.BAT [PORT#] [BAUD] [PROTO] [NODE] PCZ"
  903.           "C:\RBBS\XFER\BATCHDN.BAT [PORT#] [BAUD] [PROTO] [NODE] ZSX"
  904.  
  905.         Your RBatch command line would look like this:
  906.            RBatch Rbatch.cfg %1 %3 %4 %5
  907.  
  908. B-7.  SysOp Designed Batch Files (Phase1.Bat, Phase2.Bat, Phase3.Bat,
  909.                                   Phase1c.Bat, Phase2c.Bat, Phase3c.Bat,
  910.                                   or whatever name(s) you specify on line
  911.                                   #30 of the configuration file):
  912.       --------------------------------------------------------------------
  913.  
  914. These are the BATCH files (called in numerical order--PHASE1.BAT,
  915. PHASE2.BAT, PHASE3.BAT) that the SysOp creates or customizes for
  916.  
  917.                                   - 15 -
  918.  
  919. testing each uploaded file.  The ONLY REQUIREMENT we have is that
  920. if your batch file locates an error (corrupted ZIP, virus, unacceptable
  921. date range, etc.), it MUST delete the uploaded file!
  922.  
  923. Why?  It's simple.
  924.  
  925. If, upon return from the batch file, RBatch finds the uploaded file,
  926. it assumes the file tested OK during the batch file test (remember,
  927. RBatch itself tests nothing but the EXISTENCE of the file), and IF
  928. the file is still there, RBatch proceeds to get a description and
  929. category, then posts it to the FMS/.DIR, CALLERS, and USERS files.
  930.  
  931.  
  932. B-8.    PHASE?.BAT passed parameters:
  933.         -----------------------------
  934.  
  935. In the batch file command line, we send five parameters along with
  936. the batch filename:
  937.  
  938. %1 The first is the path & name of the uploaded file.
  939. %2 The second is the extension of the file (No Period)
  940. %3 The third is the node number.
  941. %4 The fourth is the filename with no period or extension.
  942. %5 The fifth parameter is the path to the upload directory.
  943.    (No trailing backslash)
  944.  
  945.  
  946. B-9.    Calling other testers from PHASE?.BAT:
  947.         -------------------------------------
  948.  
  949. If your system is already set up with an upload tester like ZIPLAB,
  950. RBatch will work right along with it, letting ZIPLAB handle all the
  951. upload testing.  Or, you could use the old RBBS standard upload
  952. testers. For example, PHASE1.BAT might read:
  953.  
  954.           @ECHO OFF
  955.           CLS
  956.           if %2 == ZIP GOTO ZIP
  957.           if %2 == ARJ GOTO ARJ
  958.           :ZIP
  959.              tzip.bat %1 %2 %3 %4 %5
  960.           :ARJ
  961.              tarj.bat %1 %2 %3 %4 %5
  962.  
  963. As you see, RBatch lets you use your existing batch files for checking
  964. uploads from RBBS, or you can create some new ones.
  965.  
  966.  
  967. B-10.   Examples of PHASE?.BAT:
  968.         ----------------------
  969.  
  970. Example--PHASE1.BAT:
  971.  
  972. @echo off
  973. cls
  974. if %2 == ARJ goto :ARJ
  975. if %2 == ZIP goto :ZIP
  976.  
  977.  
  978.  
  979.  
  980.                                   - 16 -
  981.  
  982. goto :END
  983. :ZIP
  984. echo  "Checking File Integrity"  > COM1
  985. pkunzip -t %1 > NUL
  986. if errorlevel 1 goto :DEL
  987. goto :END
  988. :ARJ
  989. echo  "Checking File Integrity"  > COM1
  990. arj t %1 > NUL
  991. if errorlevel 1 goto :DEL
  992. goto :END
  993. :DEL
  994. del %1 > NUL
  995. echo          The file %4.%2 failed the Integrity          > COM1
  996. echo          Test and has been deleted from this BBS...   > COM1
  997. :END
  998. seterror 0
  999.  
  1000.  
  1001. B-11.   Colorized (ANSI/High Ascii) BAT files:
  1002.         --------------------------------------
  1003.  
  1004. If the user has graphics turned on, then RBatch will call the batch
  1005. files PHASE1C.BAT, PHASE2C.BAT & PHASE3C.BAT so you can use colorized or
  1006. graphic batch files.  If the "C" version batch files do not exist,
  1007. then the normal ones (without the "C") are used.
  1008.  
  1009. Example--PHASE1C.BAT:
  1010.  
  1011. @echo off
  1012. if %2 == ARJ GOTO :ARJ
  1013. if %2 == ZIP GOTO :ZIP
  1014. if %2 == GIF GOTO :GIF
  1015. GOTO :END
  1016. :ZIP
  1017. if not exist %1 GOTO :END
  1018. echo @[2J                                                             > gate1
  1019. echo @[1;37m                                                          > gate1
  1020. echo.                                                                 > gate1
  1021. echo.                                                                 > gate1
  1022. echo       IMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM; > gate1
  1023. echo       :            Checking ZIP Integrity of Upload            : > gate1
  1024. echo       HMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM< > gate1
  1025. echo.                                                                 > gate1
  1026. echo.                                                                 > gate1
  1027. pkunzip -t %1 > NUL
  1028. if errorlevel 1 GOTO :DEL
  1029. GOTO :END
  1030. :ARJ
  1031. if not exist %1 GOTO :END
  1032. echo @[1;36m                                                          > gate1
  1033. echo.                                                                 > gate1
  1034. echo.                                                                 > gate1
  1035. echo       IMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM; > gate1
  1036. echo       :            Checking ARJ Integrity of Upload            : > gate1
  1037. echo       HMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM< > gate1
  1038. echo.                                                                 > gate1
  1039.  
  1040.  
  1041.  
  1042.                                   - 17 -
  1043.  
  1044. echo.                                                                 > gate1
  1045. arj t %1 > NUL
  1046. if errorlevel 1 GOTO :DEL
  1047. GOTO :END
  1048. :DEL
  1049. del %1 > NUL
  1050. :GIF
  1051. echo @[2J                                                             > gate1
  1052. echo @[1;33m                                                          > gate1
  1053. echo.                                                                 > gate1
  1054. echo.                                                                 > gate1
  1055. echo.                                                                 > gate1
  1056. echo.                                                                 > gate1
  1057. echo.                                                                 > gate1
  1058. echo.                                                                 > gate1
  1059. echo.                                                                 > gate1
  1060. echo       IMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM; > gate1
  1061. echo       :                        ****                            : > gate1
  1062. echo       :          The Policies of this BBS state that           : > gate1
  1063. echo       :              GIF's are UNWANTED FILES!                 : > gate1
  1064. echo       :       THE UPLOADED .GIF FILE HAS BEEN DELETED!!!!      : > gate1
  1065. echo       :                        ****                            : > gate1
  1066. echo       :            You agreed to these Policies when           : > gate1
  1067. echo       :              you first logged onto this BBS            : > gate1
  1068. echo       :                    as a New User                       : > gate1
  1069. echo       HMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM< > gate1
  1070. echo @[0m                                                             > gate1
  1071. del %1 > NUL
  1072. :END
  1073. seterror 0
  1074.  
  1075. This example will show to the user that the batch file is checking file
  1076. integrity by echoing out the gate#.  The line "echo." is for echoing a
  1077. blank line (thanks to Fred Busteed for this command).  Note that the
  1078. gate# is from using GATEWAY as your replacement for DOS's CTTY command.
  1079. If you decide to use GATEWAY, be sure to make the appropriate change
  1080. in your RBBS configuration file.  You can also use gate%node% if you set
  1081. the node in your autoexec.bat or your DV startup bat (SET NODE=1).
  1082.  
  1083.   ----------------------------------------------------------------
  1084.   There are more examples included in the file called EXAMPLES.BAT
  1085.   ----------------------------------------------------------------
  1086.  
  1087. B-12.   Alternate Batch filenames:
  1088.         --------------------------
  1089.  
  1090. If you wish to use batch files with names other than PHASE?.BAT, then
  1091. specify on line #30 of the configuration file, the name(s) of the other
  1092. batch files to use.  You may, for example, choose a different filename
  1093. to call for LOCAL uploads, or for SYSOP FMS postings.
  1094.  
  1095. Special Batch Files - A special batch file/upload checking system designed
  1096. -------------------   by Fred "Buzz" Busteed, is included in this archive.
  1097.                       The NEW-PHZ.ARJ contains the batch file and all the
  1098.  **********>>>>>>>    necessary files to create a PHASE1C.BAT file that is
  1099.                       specific for your system.  This is quite a batch file
  1100.                       and should be checked out!!!  Many thanks to Buzz for
  1101.                       contributing this to the RBatch System.
  1102.  
  1103.  
  1104.                                   - 18 -
  1105.  
  1106. B-13.   Flexibility in RBatch file processing:
  1107.         --------------------------------------
  1108.  
  1109. These batch files and their parameters will help RBBS SysOps process
  1110. many different types of compressed files.  Personally, I prefer the
  1111. ZIP format, but in order to allow the flexibility all RBBS SysOps have
  1112. learned to love, I feel that you should have the ability to accept
  1113. all types of files, convert to whatever format you prefer, and still
  1114. be able to check the file for the protection of your system and your
  1115. users.
  1116.  
  1117.  
  1118. C.                   MISCELLANEOUS INFORMATION:
  1119.  
  1120.  
  1121. C-1.    Use of "Recovery" with Protocols & RBatch:
  1122.         ------------------------------------------
  1123.  
  1124. Most of the protocols that work with RBatch, support file recovery.
  1125. There are two things to consider with recovery, however.  One concerns
  1126. your BBS and the other concerns how RBatch treats the file.  With
  1127. recovery, you take the chance of introducing a virus into your system
  1128. unless you have proper file checking procedures.  With RBatch, file
  1129. recovery presents a different kind of problem.  If you allow recovery
  1130. on your system, and a user uploads a file, and your system already HAS
  1131. that file, the protocol will report a good upload in its XFER-?.DEF!
  1132. RBatch, being very loyal, and trusting his little buddy, XFER, will
  1133. process the file as if it were being uploaded for the first time.
  1134. This means that you will get this file posted twice in your FMS or
  1135. .DIR, but you will only have one copy of the file.  It is up to
  1136. the SysOp to decide if he/she wants recovery or not.
  1137.  
  1138. C-2.    User Time-Outs and Dropped Carriers:
  1139.         ------------------------------------
  1140.  
  1141. The program also contains a "time-out" feature that will go into
  1142. effect in no keyboard input is received within three minutes.  The
  1143. timer starts each time a user is prompted for a category code and
  1144. file description.  When a user reaches a time-out, the uploaded file
  1145. RBatch is currently working on is either saved or deleted per the
  1146. configuration setup (Line #17).  Subsequent uploads that have not
  1147. been processed are also either saved or deleted as per line 17.
  1148. (NOTE:  Files saved in this manner are posted to the FMS or .DIR
  1149. with the default category code for FMS or go in the designated
  1150. upload directory for .DIR)
  1151.  
  1152.      - All files that are uploaded are logged to the CALLERS file,
  1153.        and are also posted to the FMS/.DIR if the SysOp is saving
  1154.        files (Line #17 of the configuration file).
  1155.  
  1156.      - Entries in the CALLERS file will end with a ### if a
  1157.        time-out has occured
  1158.  
  1159.      - Uploaded files processed after a timeout, are not
  1160.        credited to the user, but all downloads are.  This
  1161.        is due to RBBS handling the downloads.
  1162.  
  1163. The program also monitors carrier, and a dropped carrier is
  1164. treated the same way as a timeout (see above).
  1165.  
  1166.  
  1167.                                   - 19 -
  1168.  
  1169.  
  1170.  
  1171.  
  1172. C-3.    RBatch Error Logging:
  1173.         ---------------------
  1174.  
  1175. When RBatch detects an error, it will write to its own error log. This
  1176. file which is called RBATERR.LOG, will reside in the current directory
  1177. where RBatch is executed from.  The format for this file is as follows:
  1178.  
  1179.    <Error Message> <Node #> <Date> <Time> <File>
  1180.  
  1181. Here is an example:
  1182.  
  1183.    Cannot find XFER-?.DEF 1 01-05-92 22:34:01 c:\rbbs\xfer-1.def
  1184.  
  1185. This translates into.......RBatch could not find the XFER-?.DEF file
  1186. in the location you specified in your configuration file.  This
  1187. error occurred on Node 1 on 1/5/92 at 10:34pm.
  1188.  
  1189. Also note that the error for not finding the XFER?.DEF will be posted
  1190. in the RBATERR.LOG when a user aborts an upload,  since on an aborted
  1191. upload, the XFER-?.DEF file never gets created, hence never found by
  1192. RBatch.  One way to get around this is to put in your UPLOAD batch
  1193. file that is called from the Proto.Def statements like:
  1194.  
  1195.     cd\uploads
  1196.     c:\rbbs\dsz port %1 speed %2 rz -m
  1197.     if not exist c:\uploads\xfer-1.def goto :END      <-- Use this
  1198.     c:\rbbs\rbatch c:\rbbs\rbatch.cfg %1 %3 %4
  1199.     :END
  1200.  
  1201. With this example the batch file checks for the exitance of the
  1202. XFER-1.DEF file and if it is there, runs RBatch, otherwise it
  1203. just exits the batch file and returns to the BBS.
  1204.  
  1205.  ###  Note also that the %# parameters and the pathnames are only
  1206.       FOR AN EXAMPLE and should be changed to match your setup.
  1207.  
  1208.  ###  DO NOT DO THIS for a Bi-Directional Protocol on the
  1209.       download side, only on the upload side due to bi-directional
  1210.       transfer being initiated by a download on the BBS.
  1211.  
  1212.  
  1213. C-4.    What do the included Merges do?
  1214.         -------------------------------
  1215.  
  1216. NOTE:  You do not need to use the merges to be able to run RBatch!
  1217.        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1218.  
  1219. Included in this archive are two merges inside the filename
  1220. MRG1230.ZIP, one for RBBS-PC 17.3C & one for v.17.4.  These merges
  1221. will allow RBBS-PC to check a stacked list of filenames that a user
  1222. enters after the "Upload what file(s)" prompt.  Each filename will
  1223. then be checked to see if the file already exists, and if there are
  1224. any duplicates, a list of filenames will be shown to the user and
  1225. the upload process aborted.  These merges are in Bled 2.2 format.
  1226. A batch file is also included to aid in the bled process.
  1227.  
  1228.  
  1229.  
  1230.                                   - 20 -
  1231.  
  1232. C-5.    Why is RBatch an external program?
  1233.         ----------------------------------
  1234.  
  1235. The main reason for designing RBatch as an external interface
  1236. instead of relying on internal merges was simple:  not all
  1237. individuals care to recompile RBBS code (only the REAL hard core!),
  1238. and merges for ALL versions of RBBS (12 through 17.4) would have
  1239. had to be written.  Also, PROPER execution of batch uploading inside
  1240. RBBS would require a major rewrite of the code, and considering the
  1241. number of versions out there, this alternative is unacceptable.
  1242. With an external interface like RBatch, everyone can offer batch
  1243. and Bi-Directional transfers now.
  1244.  
  1245.  
  1246. C-6.    Companion Program for RBatch:
  1247.         -----------------------------
  1248.  
  1249. Tom Hansen of Church Chatters BBS has written a companion program for
  1250. use by the users of your BBS to aid them with Batch Uploading, called
  1251. TAG200B.ZIP (Check for future updates also, with more features and
  1252. enhancements!)
  1253.  
  1254. This program is designed to simplify the BATCH uploading process for
  1255. your users.  Your users can tag files for uploading and prepare their
  1256. batch uploading sessions in a few simple key strokes.  It supports
  1257. bidirectional protocols and the popular DSZ protocols and allows for
  1258. a user configurable protocol if one of their favorite protocols is not
  1259. an available option.   This program will assist you in training and
  1260. encouraging your users to utilize your BATCH uploading capabilities.
  1261.  
  1262.  
  1263. C-7.    Warranty & Disclaimer:
  1264.         ----------------------
  1265.  
  1266. THIS PRODUCT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
  1267. INCLUDING ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
  1268. PURPOSE.  THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THE
  1269. PROGRAM IS ASSUMED BY YOU.  FURTHERMORE, I THE AUTHOR DO NOT WARRANT,
  1270. GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF OR THE
  1271. RESULTS OF THE USE OF THE PROGRAM, OR THAT THE PROGRAM WILL RUN WITHOUT
  1272. ERROR, AND YOU RELY ON THE PROGRAM AND RESULTS SOLELY AT YOUR OWN RISK.
  1273. I THE AUTHOR CANNOT ACCEPT RESPONSIBILITY FOR SYSTEM DAMAGE, LOSS OF
  1274. PROFIT, OR ANY OTHER SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  1275. RESULTING FROM THE USE OR INABILITY TO USE THIS PRODUCT.
  1276.  
  1277.  
  1278.  
  1279. As always, with any new program, you should have backup copies of your
  1280. MESSAGES, USERS, FMS or .DIR, and CALLERS files when first installing and
  1281. using RBatch, since it uses these in its operation.
  1282.  
  1283. This program is ZIPPED with Authenticity Verification.  If you do not
  1284. see the registration number of "# MMJ131  THE SHORELINE BBS, there is
  1285. a possibility that it is not an official version or the BBS you
  1286. received it from re-zipped the file and stripped off the -AV.
  1287. You can always call my BBS and download the official version.
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.                                   - 21 -
  1294.  
  1295. C-8.    Registration:
  1296.         -------------
  1297.  
  1298. The program is not "Crippled" in any way, and what you get with a
  1299. registered version is your BBS name on the opening screen.  You will
  1300. also get "Visiting RBBS SysOp" access to my BBS which entitles you
  1301. to 60 Minutes/day, and unlimited file downloading.
  1302.  
  1303. I have chosen not to "cripple" the program because I don't believe in
  1304. "crippleware".  I hope that when you use the program you find that it
  1305. is an excellent addition to your BBS, hopefully then registering it.
  1306.  
  1307. Registration lets me know that the program I worked very hard on is
  1308. appreciated.  It will also encourage me to write other useful
  1309. programs/enhancements for RBBS SysOps in the future.
  1310.  
  1311. Once you register RBatch, it is registered for any new version that may
  1312. come out in the future.
  1313.  
  1314.  
  1315. You can get your registered version one of two ways:
  1316. ----------------------------------------------------
  1317.  
  1318. First, for $20.00, mail in the registration form with all the questions
  1319. filled in.  You then call my BBS and get your registration number in a
  1320. private message to you along with a file in the personal files section.
  1321.  
  1322. Second, for $25.00, you can send me the registration form with all the
  1323. questions filled in along with the size of the diskette you wish to
  1324. receive (5 1/4 or 3 1/2).  I will then mail you the latest version of
  1325. the program along with your registration number.
  1326.  
  1327.  
  1328. C-9.    Acknowledgments:
  1329.         -----------------
  1330.  
  1331.  
  1332. I would like to thank a few individuals for their support and ideas
  1333. without whom this program would not have been possible.
  1334.  
  1335. First of all, to my wife Linda, my son David, and my daughter Linnea
  1336. for time and again putting up with me parking myself in front of my
  1337. computer for hours on end to work on the program.  (Hey David, we
  1338. probably would have gotten a lot farther in Super Mario Brothers 3
  1339. if I hadn't been working on this program!!! <G>)
  1340.  
  1341. Second, to my Beta Testers--Tom Hansen, Walter Ames, David Brodmann,
  1342. Gregg Snyder, Gary Slemp (for helping out with the tedious task
  1343. of writing this documentation), Don Silva, Tate Biersack & Mercurio Franco.
  1344. Their ideas and testing of the program for any sort of bug possible, made
  1345. it a far superior product than it would have ever been.
  1346.  
  1347. Third, to all the people who work on RBBS, and make it the best BBS software
  1348. available.  And last, Borland International Inc., and Data-Comp Information
  1349. Systems, for their great software.
  1350.  
  1351.                                   - 22 -
  1352.  
  1353.  
  1354. C-10.   Last Minute Notes:
  1355.         ------------------
  1356.  
  1357. Included in RBatch is a file called MSGFILE.00 - This file has the prompts
  1358. that are shown to the user as the program executes.  You can change these
  1359. prompts if you wish, but you MUST follow these guidelines:
  1360.  
  1361. 1.  Each line MUST start with a NUMBER, followed by an EQUAL sign, followed
  1362.     with text.
  1363.  
  1364.      Example:    23=Text
  1365.  
  1366. 2.  Comments are allowed in this file as long as the FIRST CHARACTER on the
  1367.     line start with a "#" sign (do not use quotes).
  1368.  
  1369. 3.  The file MSGFILE.00 MUST RESIDE IN THE SAME DIRECTORY AS YOUR
  1370.     RBATCH CONFIGURATION FILE or RBatch will not work.
  1371.  
  1372. 4.  Be careful what you make changes to as you could exceed the size of
  1373.     the screen display if you make some MAJOR changes.  Test locally
  1374.     before putting online to make sure.
  1375.  
  1376.  
  1377. C-11.   Support:
  1378.         --------
  1379.  
  1380. If you do encounter any problems with the program, or have suggestions
  1381. on improvements, you can call my BBS 24 hrs a day, and leave a message
  1382. for me, or leave a message on the RIME Network in the RBBS conference,
  1383. or in the RBBS-PC or RBBSSYS conference on the RBBS-NET Network (Another
  1384. SysOp friend of mine carries the RBBS-NET and will alert me if there are
  1385. messages for me).  I will consider the enhancements and of course try to
  1386. fix any problems encountered with the program.
  1387.  
  1388. Note that I support both Registered and Non-Registered users of the
  1389. program.  Support is a NUMBER ONE priority for me and my programs,
  1390. and I think you will be impressed with the support that I give.  You
  1391. are welcome to call me voice if you have any problems between 7-10:00pm
  1392. weekdays and between 9am-10pm on the weekends.
  1393.  
  1394.  
  1395. My BBS name & number:
  1396.  
  1397.                               Dan Shore
  1398.                           "THE SHORELINE BBS"
  1399.                      Located in Silver Spring, MD
  1400.                        12/24/9600/14.4 (V.32bis)
  1401.                              301-946-2771
  1402.  
  1403.                           Proud Member of the
  1404.                     - DGS Systems Group (Wonder) -
  1405.  
  1406.                          RBBS-PC  Beta Test Site
  1407.  
  1408.                         Proudly Running RBBS-PC
  1409.                   "The Best BBS Software in the World"
  1410.  
  1411.                     Member of the RIME & FIDO Network
  1412.                         RelayNet ID = SHORELINE
  1413.                          FIDO Net#  = 1:109/458
  1414.  
  1415.                                   - 23 -
  1416.  
  1417.