home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / open / jbat116.lzh / JBATCH.DOC < prev    next >
Text File  |  1988-10-30  |  20KB  |  451 lines
  1. JBatch v1.14  MiniNet's Driver for Richard B. Johnson's Jmodem Protocol
  2.  
  3. Protocols Supported: Jmodem - Batch or Single File
  4.  
  5. Copyright 11/01/1988 by Crater Rim Software. All Rights Reserved.
  6.  
  7. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  8.  
  9. JBatch Licensing Agreement
  10. --------------------------
  11.    This program is the sole property of Crater  Rim  Software.  For  the 
  12.    sake of clarity, all references and restrictions to the use of JBatch 
  13.    also  apply  to any and all of the associated support files (included 
  14.    with or created by) JBatch. 
  15.  
  16.    JBatch,  its overlays and all of its associated support files are not 
  17.    public  domain  software,  nor  are  they  free  software.  JBatch is 
  18.    copyright (c) 1988 by Crater Rim Software. All rights reserved. 
  19.  
  20.    Users are granted a limited license to use JBatch free of charge  BUT 
  21.    subject to the following limitations: 
  22.  
  23.      No user may modify JBatch in any way,  including but not limited 
  24.      to decompiling,  disassembling or otherwise reverse  engineering 
  25.      the program. 
  26.  
  27.      JBatch must be copied in unmodified form, complete with the file 
  28.      containing this license information. 
  29.  
  30.      Any and all JBatch documentation must be included with the copy.  
  31.      No  fee,  charge  or  other  compensation  may  be  accepted  or 
  32.      requested by any licensee. 
  33.  
  34.      JBatch  may  not  be  distributed  in conjunction with any other 
  35.      product without prior arrangements with Crater Rim Software. 
  36.  
  37.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  38.    ********* ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS *********
  39.    *********    (and is using)  THIS FILE!  NOTHING MORE...    *********  
  40.    *                                                                   *
  41.    * Operators  of electronic bulletin board systems (Sysops) may post *
  42.    * JBatch for downloading by their users  and  may  use  the  JBatch *
  43.    * module  only  as  long as the above conditions are met and Crater *
  44.    * Rim Software has been notified of your intent to use JBatch       *
  45.    *                                                                   *
  46.    ******** ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS **********
  47.    ********    (and is using)  THIS FILE!  NOTHING MORE...    **********  
  48.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  49.  
  50.    Those organizations who distribute public domain  or  user  supported 
  51.    software  on a pay per diskette basis may distribute copies of JBatch 
  52.    under the above conditions ONLY AFTER  OBTAINING  WRITTEN  PERMISSION 
  53.    from  Crater  Rim  Software.  Such  permission  usually  is  granted.  
  54.    Please write or call for details. 
  55.  
  56.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  57.  
  58.                    Software Discalaimer and Warranty
  59.  
  60.    Crater  Rim  Software  makes  no  warranty  of  any kind,  express or 
  61.    implied,   including   without   limitation,    any   warranties   of 
  62.    merchantability  and/or fitness for a particular purpose.  Crater Rim 
  63.    Software shall  not  be  liable  for  any  damages,  whether  direct, 
  64.    indirect,  special  or  consequential  arising from a failure of this 
  65.    program to operate in the manner desired  by  the  user.  Crater  Rim 
  66.    Software shall not be liable for any damage to data or property which 
  67.    may be caused directly or indirectly by use of the program.  
  68.  
  69.    IN  NO  EVENT  WILL  Crater  Rim  Software  BE  LIABLE TO YOU FOR ANY 
  70.    DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL 
  71.    OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO  USE 
  72.    THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.  
  73.  
  74. = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
  75.  
  76. JBatch v1.14  MiniNet's Protocol Driver for Jmodem Batch
  77.  
  78. Memory requirements:
  79.  
  80.    JBatch  requires  a  minimum  of  103K  (105,472  bytes)  to  perform 
  81.    transfers.  If you don't know how much memory you have available,  it 
  82.    can be checked easily as follows: 
  83.  
  84.    1)  Copy  DOS' CHKDSK.COM  to your comm directory.
  85.  
  86.    2)  Start up your comm program and execute the comm program's DOS shell
  87.        option.
  88.  
  89.    3)  Type  CHKDSK  at the DOS prompt
  90.  
  91.    4)  CHKDSK will display its results along with the "bytes free" figure.
  92.        The "bytes free" must be at least 105,472.
  93.  
  94.    5)  Enter "EXIT" at the DOS prompt.
  95.  
  96.    6)  Exit your comm program...
  97.  
  98. Command line parameters :
  99.  
  100.    M        Monitor  Carrier,  abort  if  not  present.  Including  this 
  101.             parameter allows you to use JBatch to transfer files between 
  102.             systems  via  null  modem  cable.  Default  is  ON  (Monitor 
  103.             Carrier).
  104.  
  105.    Dx       Direction of transfer. Where x = R (receive) or S (send)
  106.  
  107.    Fname    [d:\path\]Filename   to send/receive.
  108.  
  109.                                   or
  110.  
  111.             @C:[d:\path\]Filelist   of files to Batch send.
  112.  
  113.                                   or
  114.  
  115.             @C:[d:\path\]Filelist@C:d:\path   filelist of files 
  116.             (residing in the second d:\path  directry) to Batch send.
  117.  
  118.    Px       Comm Port to use. Where x = 1 or 2
  119.  
  120.    Sbaud    Modem Speed. Where baud = 300, 1200, 2400, 4800, 9600, 19200
  121.  
  122.    Y        Override Overwrite Flag
  123.  
  124.               JBatch allows you to specify if you  want  overwriting  of 
  125.               existing  files  to  be  performed.  By  including  the  Y 
  126.               parameter on  the  command  line,  the  default  overwrite 
  127.               setting   will   be  reversed  during  the  current  BATCH 
  128.               transfer. 
  129.  
  130.               In single file mode, the Jmodem  Protocol Module is  fully 
  131.               compatible   with  its  stand-alone  counterpart  used  on 
  132.               all/most BBS. Both systems must be using JBatch to  invoke 
  133.               the Jmodem Batch Mode. 
  134.  
  135.    B          Override Batch Mode Flag
  136.  
  137.               The default setting for JBatch is Batch Mode. By including 
  138.               the  B parameter on the command line,  JBatch will perform 
  139.               the transfer in Single File mode.  If the  B  is  omitted, 
  140.               JBatch defaults to batch mode. 
  141.  
  142.    Nx       Node Letter or Number. Where x = A to Z  or  0 to 9
  143.  
  144.    @        Modify logfile name/xferfile name/options flags...
  145.             Clone JBATCH.COM if changes are made 
  146.  
  147.             Note:  As is the case with Jmodem,  the  default  colors  of 
  148.                    JBatch  are  Black  text  on a White background.  The 
  149.                    colors cannot be changed. 
  150.  
  151.    The D, P and S parameters MUST be supplied...  if operating in single 
  152.    file mode, the  F and B  parameters must be supplied. The  Y, M and N 
  153.    parameters are optional...  and the  @  parameter  is  only  used  to 
  154.    review/modify the default settings (see modification mode below). 
  155.  
  156.    The  DR  and DS parameters are mutually exclusive (only one,  but not 
  157.    both) 
  158.  
  159.    Command Line parameters may be supplied as upper or lower  case,  and 
  160.    may be entered in any order.
  161.  
  162.  
  163. JB.LOG      -  JBatch will record transfer results to the logfile in the
  164.                following format:
  165.  
  166. +--- Transfer Direction
  167. |  +------- File Size (0 if transfer fails)
  168. |  |      +---------- Modem Speed
  169. |  |      |         +---------- CPS efficiency (0 if transfer fails)
  170. |  |      |         |        +--- Filename
  171. |  |      |         |        |                   +- Protocol
  172. |  |      |         |        |                   |      +-- If Batch Mode
  173. |  |      |         |        |                   |      |
  174. S  27648  1200 bps  108 cps  C:\DLS\JBATCH.ARC - Jmodem Batch
  175.  
  176.  
  177. XFER.TXT - If  (and only if) a Node character is specified,  JBatch will 
  178.            also create a Xfer Node File to show  success/failure  status 
  179.            messages.
  180.  
  181.            This file has the following format :
  182.  
  183.                 Filename
  184.                 Upload   or   Download
  185.                 Protocol      (Jmodem or JBatch)
  186.                 Success  or   Fail
  187.                 EOF           (^Z)
  188.  
  189.            Sample:
  190.  
  191.                 JBATCH.ARC
  192.                 Download
  193.                 JBatch
  194.                 Success
  195.                 ^Z
  196.  
  197.    The file will be created in the default directory if no drive/path is 
  198.    specified during the command  line  @  parameter  modification  mode. 
  199.    While  in  batch  mode,  only  the last file transfer results will be 
  200.    logged to this file.  However, JB.LOG will contain the results of all 
  201.    files transferred in the batch. 
  202.  
  203.  
  204. Command Line @ Parameter Modification Mode.
  205.  
  206.    Starting JBatch with the @ command line  parameter  will  put  JBatch 
  207.    into  its  default  modification mode.  JBatch will first display its 
  208.    current default settings and then prompt you for any changes you  may 
  209.    wish  to  make.  Note  that  entering  a  blank  line (simply hitting 
  210.    [Enter])  will  leave  the  current  setting  intact.  JBatch  allows 
  211.    modification  of  the logfile name,  the xfer file name (for BBS use) 
  212.    and certain operational flags. 
  213.  
  214.    L - Logfile Name:
  215.  
  216.        This  is  the  filename  JBatch uses to record the results of any 
  217.        tranfers it performs.  JBatch will accept upto 40  characters  so 
  218.        you  may include a full drive:\path\ along with the logfile name. 
  219.        Additionally,  you may use a question mark (?) as one  (and  only 
  220.        one)  of  the  logfile  name  characters.  If  a question mark is 
  221.        present,  JBatch will substitute the Node character in its place.  
  222.        If  no node character is specified,  JBatch will use the letter A 
  223.        as a Node character.  The letter A is  substituted  ONLY  if  the 
  224.        question  mark is encountered in the logfile name.  If you do not 
  225.        want JBatch to maintain a logfile, simply enter a backslash (\).. 
  226.        which will inform JBatch to  blank  out  the  logfile  name.  The 
  227.        default logfile name is JBatch.LOG 
  228.  
  229.    X - XferFile Name:
  230.  
  231.        This  is  the filename JBatch uses to record transfer results for 
  232.        use by BBS programs.  Its format and modification is identical to 
  233.        the Logfile Name. The default Xferfile name is XFER.TXT
  234.  
  235.    O - Overwrite:
  236.  
  237.        This flag setting tells JBatch whether or not  in  can  overwrite 
  238.        existing files during Batch mode transfers. If the Overwrite flag 
  239.        is  set  (YES),  JBatch  will  erase  any duplicate file prior to 
  240.        beginning the transfer of  the  new  same-filename  file...  thus 
  241.        eliminating the presence of any *.OLD files. The default is NO 
  242.  
  243.    S - Save Aborts:
  244.  
  245.        This  flag setting tells JBatch whether or not it should keep any 
  246.        partial files which were aborted during transfer. This flag holds 
  247.        for batch mode only.  When operating in batch mode,  JBatch sends 
  248.        both  the  filename  and  filesize to the receiving system.  Upon 
  249.        completion (or abort),  JBatch checks the size of the transported 
  250.        file  against the actual filesize sent with the filename.  If the 
  251.        the filesizes are not the same (the actual filesize is less  than 
  252.        the filesize sent with the filename) ... and the Save-Aborts flag 
  253.        is  off  (NO)...  JBatch will erase the partial file.  Understand 
  254.        that this process takes place only  on  the  receiving  end!  The 
  255.        default is YES 
  256.  
  257.    W - Write On 0:
  258.  
  259.        This flag setting tells JBatch whether or not  it  should  create 
  260.        the  XferFile when a transfer is not successfully completed.  The 
  261.        status of this flag is the last check that  JBatch  makes  before 
  262.        creating the XferFile. A node character and XferFile Name must be 
  263.        specified before the Write On 0 flag comes into play. The default 
  264.        is YES 
  265.  
  266.    [Enter] Quit:
  267.  
  268.        If you only wish to view the current default settings, simply hit 
  269.        [Enter]  to  exit  back  to  DOS.  If any changes have been made, 
  270.        JBatch will go into its cloning mode and ask if you want to clone 
  271.        JBatch to preserve the new changes.  Note that you MUST press the 
  272.        Y key in order to clone JBatch.  Hitting [Enter] here will simply 
  273.        return you to DOS without saving your changes within  the  JBatch 
  274.        program. 
  275.  
  276.  
  277. Program control keys:
  278.  
  279.        JBatch  will recognize either the [Esc] key or ^X (control X) key 
  280.        during transfers and will abort the current  transfer,  returning 
  281.        you  to  DOS.  I  have  modified  the  Jmodem  module (JM.COM) to 
  282.        eliminate as much as the delays as possible...  making the  batch 
  283.        mode cycling quite "brisk"! Note however that there is a delay if 
  284.        the transfer is aborted for any reason... this is due to the fact 
  285.        that the buffers have to be "drained" before recycling. 
  286.  
  287.  
  288. Batch transfers:
  289.  
  290.        JBatch  is  capable  of  sending  and receiving multiple files in 
  291.        batch mode.  Since this protocol driver was written for use  with 
  292.        my  MiniNet BBS package...  the sending of the file creation date 
  293.        (ala DSZ and Telink) tends to drive  me  up  the  wall,  creating 
  294.        quite  a  bit  of  confusion  in keeeping track of newly acquired 
  295.        files! 
  296.  
  297.        For  this  reason  the major difference between JBatch Batch mode 
  298.        and other Batch modes is that JBatch Batch only  sends  the  File 
  299.        Name and filesize and does not send the file creation date. 
  300.  
  301.        During Batch mode transfers, JBatch will display the last 3 files 
  302.        requested under the JBatch logo so that you may  have  a  running 
  303.        update  of  what's  happening.  The  present transfer progress is 
  304.        displayed in its own window alongside the JBatch logo. 
  305.  
  306.        Upon completion,  JBatch will  display  the  transfer  efficiency 
  307.        (CPS) alongside the filename.
  308.  
  309.    Receiving files in Batch mode:
  310.  
  311.        You do  not  have  to  supply  any  filename  during  batch  mode 
  312.        receives. You may of course, include a full drive:\path\ in place 
  313.        of a filename.  Use the F command line parameter to designate the 
  314.        path in the form:  fC:\FOO\BAR   (with or  without  the  trailing 
  315.        backslash) 
  316.  
  317.    Sending files in batch mode:
  318.    
  319.        You  may  use  any  valid  DOS  wildcard configuration with the F 
  320.        parameter. 
  321.  
  322.        Additionally,  you may specify a list of filenames for JBatch  to 
  323.        send.  The list filename is specified as @C:listfilename 
  324.  
  325.        You may of course, include a full drive:\path\ when using the @C: 
  326.        option. 
  327.  
  328.        The filenames in the list may contain a  full  drive:\path\  (the 
  329.        same  or  different)  for  each  filename  or  you  may supply an 
  330.        external path when using the  @C:filelist  option in either batch 
  331.        upload or download modes. The format is  @C:[path]filelist@C:path 
  332.  
  333.        JBatch is capable of reading  and  extracting  filenames  from  a 
  334.        standard  -  single  line  - BBS files listing.  If you use a BBS 
  335.        type files  listing,  and  call  JBatch  from  the  comm  or  BBS 
  336.        directory,  you  will  have  to add the full drive:\path\ to each 
  337.        filename in the list if the files to send do not  reside  in  the 
  338.        default  directory.  There are other ways of accessing files that 
  339.        reside in directories other than the default (default upload  and 
  340.        download  directories,  etc.),  but  I won't go into this area as 
  341.        most comm and BBS programs do this work for you (K9X does it  ALL 
  342.        for you... automatically!) 
  343.  
  344. Examples:
  345.  
  346.    1.  Use COM1, 1200 baud, Send file MYFILE.DOC in single file mode
  347.  
  348.         JBATCH p1 s1200 b dS fMYFILE.DOC
  349.  
  350.    2.  Use COM2,  19200 baud, Batch Receive files *.DOC, do not 
  351.        monitor carrier, override the default "do not overwrite". 
  352.  
  353.         JBATCH p2 s19200 Y dR m
  354.  
  355.    3.  Use COM1, 9600 baud, Batch Send files in MYLIST.LST which resides 
  356.        in  my  C:\BBS\ directory.  The files listed in MYLIST.LST reside 
  357.        in various  directories  on  different  drives.  Do  not  monitor 
  358.        carrier and record success results to Node A of my BBS. 
  359.  
  360.         JBATCH p1 s9600 dS f@C:C:\BBS\MYLIST.LST m nA
  361.  
  362.         C:\DLS\MYLIST.LST looks like this:
  363.  
  364.           ABC.ARC            (this one resides in the default directory)
  365.           D:\FOO\BAR\MYGAME.EXE
  366.           E:\LOTUS\123GRAPH.ARC
  367.  
  368.        XFER.TXT  (or  XFER-A.TXT if ?  specified in the default xferfile 
  369.        name) will reflect the results of the transfer.  Note  that  only 
  370.        the  last  filename  and  its transfer results will be present in 
  371.        XFER.TXT.  JB.LOG will however,  contain the results of all three 
  372.        files. 
  373.  
  374.    4.  Use COM1, 9600 baud, Batch Send files in MYLIST.LST which resides 
  375.        in  my  C:\BBS\ directory.  The files listed in MYLIST.LST reside 
  376.        in my C:\UPLOADS directory.  Record success results to Node A  of 
  377.        my BBS. 
  378.  
  379.         JBATCH p1 s9600 dS f@C:C:\BBS\MYLIST.LST@C:C:\UPLOADS nA
  380.  
  381.         C:\DLS\MYLIST.LST looks like this:
  382.  
  383.           ABC.ARC
  384.           MYGAME.EXE
  385.           123GRAPH.ARC
  386.  
  387.        XFER.TXT  (or  XFER-A.TXT if ?  specified in the default xferfile 
  388.        name) will reflect the results of the transfer.  Note  that  only 
  389.        the  last  filename  and  its transfer results will be present in 
  390.        XFER.TXT.  JB.LOG will however,  contain the results of all three 
  391.        files. 
  392.  
  393.    5.  Use  COM2,  19200  baud,  Batch Send only files containing an ARC 
  394.        extension and residing in my C:\DLS directory,  and don't monitor 
  395.        carrier. 
  396.  
  397.         JBATCH p2 s19200 dS fC:\DLS\*.ARC m
  398.  
  399.    6.  Use COM2,  19200 baud, Batch Mode Receive files and store them 
  400.        in my C:\DLS directory. 
  401.  
  402.         JBATCH p2 s19200 dR fC:\DLS
  403.  
  404.    7.  Use COM1,  2400 baud, Receive MYFILE.ARC in single file mode and
  405.        store it in my C:\DLS directory. 
  406.  
  407.         JBATCH p2 s2400 b dR fC:\DLS\MYFILE.ARC
  408.  
  409. There are 3 sample batch files included in JBATCH.ARC 
  410.  
  411.     SJ.BAT    - this batch file is set up for sending file(s) to
  412.                 another system
  413.  
  414.     RJ.BAT    - this batch file is set up to receive file(s) from 
  415.                 another system
  416.  
  417.     RSJ.BAT   - this batch file will handle transfers in either 
  418.                 direction
  419.  
  420. Executing  any  one  of  the  batch files without any parameters (or the 
  421. wrong parameter) will  display  a  short  message  showing  the  correct 
  422. calling   procedure   and  parameter  choices.   Since  RJS.BAT  handles 
  423. transfers in either Send or Receive mode,  it  naturally  requires  more 
  424. information in order to perform correctly. 
  425.  
  426. NOTE: If you are operating a MiniNet BBS v18.00 or above... or K9X v8.00 
  427.       or  above...  access  to JBatch is handled internally and does not 
  428.       require the use of the batch files. 
  429.  
  430.       If you are not... please read the enclosed PRODUCTS.TXT file...
  431.       It's worth a look! 
  432.  
  433.       For pure BBS'ing, K9X can't be beat!
  434.  
  435.  ------------------------------------------------------------------------------
  436.  
  437.     This  is  a  preliminary  release  of  JBatch.  All  suggestions are 
  438.     gratefully received and reviewed!  Sysops, Let me know... 
  439.  
  440.                     Sal Manaro  dba  Crater Rim Softare
  441.                  4028 41st Ave South   Seattle, Wa 98118
  442.  
  443.                      Courtesy of Underdog's MiniNet
  444.                    (206) 725-9233  or  (206) 723-6728
  445.                 1200/2400/9600   24hrs   600 megs OnLine
  446.                 Supporting  21  files transfer protocols
  447.  
  448.                               Enjoy,
  449.                                  Sal Manaro
  450.  
  451.