home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / comm / nmodem.zip / NMODEM.DOC < prev    next >
Text File  |  1991-01-13  |  13KB  |  302 lines
  1.                          NMODEM 1.62 DOCUMENTATION
  2.                          -------------------------
  3.  
  4.   NMODEM is a file transfer protocol written in Turbo Pascal 5.5 for
  5.   the "IBM" family of computers.
  6.  
  7.   This protocol sends data in 2048k blocks.  The last block will be the
  8.   size of the final bytes in the file, thus the original file size will
  9.   be retained. Each block has an overhead of 6 bytes.
  10.  
  11.   2048 was chosen for block size as it seems to be the optimum size for CPS
  12.   and minimal inpact on efficiency if an error should occur. It also happens
  13.   to be the normal size of a Hard Drive sector, 2 times a Floppy sector and
  14.   1/2 of a oversize Hard drive sector thus improving disk read/write
  15.   efficiency.
  16.  
  17.   NMODEM uses the 16-bit CRC error checking system for a very high reliability
  18.   of successful transfer in rough conditions with minimal transfer overhead.
  19.  
  20.                             LEGAL STUFF
  21.                             -----------
  22.  
  23.   NMODEM is (c)Copyright 1990,1991 by L.B. Neal. All Rights Reserved.
  24.  
  25.   Anyone may distribute the NMODEM cheapware version as long it is unmodified,
  26.   complete and any distribution fee is less than $5.00.
  27.  
  28.   -----------------------------------------------------------------------
  29.   NOTE: The registered version of NMODEM may NOT be distributed excepting
  30.         to SYSOPs of "NOT-for-Profit" BBS systems.  See Caution.TXT.
  31.   -----------------------------------------------------------------------
  32.  
  33.   NMODEM is distributed as "cheapware".  You may try this program to see
  34.   if it is of value to you before registering.  If you find the product
  35.   to be of value you MUST pay a the registration fee or stop using the
  36.   program.  SYSOPS of non-profit BBS's may use NMODEM without registration.
  37.  
  38.   If you paid a fee for NMODEM to anyone but L. B. Neal you did NOT register
  39.   NMODEM you paid for media and handling costs.
  40.  
  41.   Registration schedule is as follows:
  42.  
  43.    1. Register NMODEM but w/o disk                            $ 5.00
  44.  
  45.    2. Register NMODEM w/returned registered version -         $10.00
  46.       * Has DirectVideo/FIFO/MNP options enabled.
  47.       * Latest Version plus latest NMTERM program.
  48.       * Misc items that will also fit on disk.
  49.  
  50.    3. Update registered version by mail.                      $ 2.00
  51.  
  52.    4. Update registered source by mail.                       $ 5.00
  53.      
  54.    --------------------------------------------------------------------
  55.    NOTICE: Effective immediately registered users will be able to
  56.            download the latest registered version from PYSMATIC or
  57.            THE COMM CENTER for free!!
  58.      
  59.            I will need your user#, Password and which BBS you use
  60.            to set up access!
  61.    --------------------------------------------------------------------
  62.  
  63.    NOTE: Items 2,3 & 4 include media, handling, postage and Tax!
  64.  
  65.  
  66.   My mailing address is currently:
  67.  
  68.               L.B. Neal
  69.               415-112 N. Mary Ave #111
  70.               Sunnyvale, CA 94086
  71.  
  72.   If response is appropriate I will attempt a Two-Way version that will
  73.   transfer files in both directions at the same time.    
  74.  
  75.   --------------------------------------------------------------------------
  76.                 NMODEM is provided AS-IS without warranty!
  77.  
  78.   I am NOT and will NOT be responsible for the use or misuse of this program.
  79.  
  80.   It is my belief that this program will function essentially as described
  81.   in this document but I cannot test for every possible software/hardware
  82.   configuration.
  83.  
  84.   If you use this program then you have agreed to the previous statements.
  85.   --------------------------------------------------------------------------
  86.  
  87.   The source code for NMODEM is available for $50.  If you purchase the
  88.   source you will be required to sign a Non-Disclosure agreement and will
  89.   NOT be allowed to distribute any modified form of NMODEM or the source
  90.   code.  You will be able to utilize modified versions for your own use.
  91.   This provision is for the protection of myself and other users and is NOT
  92.   intended to prohibit individuals or organizations from adjusting the program
  93.   for specific needs.  Individuals or organizations wishing to incorporate
  94.   NMODEM into a communications program should contact me directly for very
  95.   nominal licensing fees.
  96.  
  97.   NOTE: Due to the low registration cost of NMODEM - Registration or
  98.         purchase of the source does NOT in anyway require any support for
  99.         the program by L.B. Neal. However, I will address problems reported
  100.         in a prompt manner.
  101.  
  102.  
  103.                             USAGE NOTES
  104.                             -----------
  105.  
  106.   1. NMODEM assumes the comport called for is already initialized.
  107.      Therefore using NMODEM directly from DOS will probably NOT work!
  108.  
  109.   2. A minimum of 64k of free memory is needed to sucessfully operate.
  110.  
  111.   3. COM1 thru COM4 are supported with 3 & 4 setup for the "unofficial"
  112.      standard as used by Everex and other manufactures.
  113.  
  114.   4. NMODEM will exit with a DOS error level of 1 if anything goes wrong.
  115.      Otherwise the value will be 0.
  116.  
  117.   5. Please report "in detail" any problems experienced in using the program.
  118.  
  119.   6. Call NMODEM w/o parameters ie C:\>NMODEM<cr> or such to see the needed
  120.      info for using.
  121.  
  122.      NMODEM needs:
  123.  
  124.        a. S for Send or R for Receive.
  125.  
  126.        b. port# (COM1 thru COM4)
  127.  
  128.        c. FileName to transfer.
  129.            optional drive and/or directory.
  130.  
  131.        d. If you add the /D behind the filename Directvideo will be used.
  132.           * [registered versions] 
  133.  
  134.        e. If you have a 16550 UART a /F behind the file name will enable
  135.           the UART FIFO Buffer.
  136.           * [registered versions]
  137.  
  138.        f. MNP is enabled with /M - NMODEM will NOT do CRC check!
  139.           *[registered versions]
  140.  
  141.        f. NMODEM.LOG is disabled with /L - NMODEM will NOT write to
  142.           nmodem.log.
  143.           *[registered versions]
  144.  
  145.  
  146.        Examples:
  147.  
  148.         "cheapware" version:
  149.  
  150.         NMODEM S2 Myfile.zip              { Send via COM2: myfile.zip }
  151.         NMODEM S1 c:\uploads\Myfile.zip   { Send via COM1: myfile.zip }
  152.         NMODEM R2 c:\download\Hisfile.zip { Recv via COM2: hisfile.zip }
  153.         NMODEM R1 Hisfile.zip             { Recv via COM1: hisfile.zip }
  154.  
  155.         Registered version:
  156.        
  157.         NMODEM S2 C:\UPLOADS\Myfile.zip /D   { Send via COM2: myfile.zip }
  158.         NMODEM S1 C:\UPLOADS\Myfile.zip /DF  { Send via COM1: myfile.zip }
  159.         NMODEM R2 C:\DOWNLOAD\Hisfile.zip /D { Recv via COM2: hisfile.zip }
  160.         NMODEM R1 C:\DOWNLOAD\Hisfile.zip /F { Recv via COM1: hisfile.zip }
  161.  
  162.  
  163.      NOTE: I have set up NMODEM to use the same basic parameter string as
  164.            JMODEM to make it easier to install.  If you have a JMODEM batch
  165.            file just rename it and change JMODEM to NMODEM inside the batch
  166.            file.
  167.  
  168.            Combined switches are just added behind a single '/'!
  169.  
  170.  
  171.   7. I have taken great care to try to make sure the CPS rate reported is
  172.      accurate (Unlike many other protocol drivers!).  Please advise if you
  173.      find my efforts in vain.  I recently performed stopwatch tests with
  174.      large file transfers and the indicated CPS did infact match the size
  175.      vs time.
  176.  
  177.      NOTE: The CPS calculation does NOT include receive file I/O time. It
  178.            does include resend times if necessary.  It is not unusual to see
  179.            a low CPS for the first block depending on the interface timing.
  180.            The receive IO is in the background and thus does NOT normally
  181.            effect the actual CPS.
  182.  
  183.   8. NMODEM will resend a block 6 times before aborting the effort.
  184.  
  185.   9. This program plays no tricks and assumes the calling program is nice
  186.      as well.  Tricky programs will probably cause NMODEM to fail. 
  187.  
  188.  10. The file Nmodem.err will be generated if a runtime error occurs!
  189.      NMODEM version and error # + error address will be give!  This
  190.      info will be what I need to address problems. Informative messages
  191.      will also go to NMODEM.LOG.
  192.  
  193.  11. NMODEM uses BIOS screenwrites for maximum compatability with DesqView
  194.      and other Multi-Tasking situations.  The registered version has an option
  195.      for enabling DirectVideo. IF you use the BIOS method I suggest you
  196.      investigate QCRT11.ZIP for much faster screenwrites!
  197.  
  198.  12. I have provided NMR.BAT and NMS.BAT as sample batch files which are setup
  199.      for parameters as passed by TELIX.
  200.  
  201.  12. If you attempt to receive an existing file NMODEM will abort!
  202.  
  203.  14. If NMODEM aborts during a receive operation the file will deleted.
  204.  
  205.  15. NMODEM has been tested with TELIX 3.12 and QMODEM 4.2 they seem to work
  206.      fine.  I also tested with GT-1550 and was unable to duplicate
  207.      problems reported by GT users.
  208.  
  209.  16. Remember TSR's can have strange side effects.  If NMODEM fails please
  210.      address any TSR's in your system as a possible cause of the problem.
  211.  
  212.  17. NMODEM has been tested with MS-DOS 4.01 (later version or w/patch),
  213.      OS/2, DR-DOS 5.0, PC-MOS 4.1, DOS-XM 6.2 and Concurrent DOS-386 3.0.
  214.  
  215.  18. NMODEM will NOT work below 1200 Baud!
  216.  
  217.  19. Computers which do NOT have DMA such as PCJr and some versions of the
  218.      TANDY 1000 will NOT work with NMODEM.
  219.  
  220.  20. Special thanks to Ted Chan, Dennis King, Ron Pierce and 
  221.      Dave Halliday for their help with BETA testing of NMODEM.
  222.  
  223.  21. I can be contacted at:
  224.  
  225.                               THE COMM CENTER
  226.                               (408)737-7245
  227.  
  228.                               PYSMATIC BBS
  229.                               (408)-992-0372
  230.  
  231.                               Both in Sunnyvale, CA
  232.  
  233.  
  234.                        TECHNICAL NOTES
  235.                        ---------------
  236.  
  237.  
  238.   1. NMODEM does NOT use assembly language to improve transfer speed.
  239.      Standard Turbo Pascal library routines are used for IO.
  240.  
  241.   2. The port intialization routines use some assembly.
  242.  
  243.   3. An interrupt driven receive buffer is utilized to allow high speed
  244.      transfer without dropping bytes. The buffer is NOT written in 
  245.      assembly language or inline.
  246.  
  247.   4. Output is directly via the port and a buffer is not used.
  248.  
  249.   5. The program is constructed to avoid Procedure and Function calls
  250.      in the transfer routines for efficiency.  All transfer variables are
  251.      global to avoid stack manipulation overhead.
  252.   
  253.   6. Great care has been taken to use only standard DOS and BIOS interface
  254.      calls to avoid wierd side effects in using NMODEM.  The program is
  255.      being used under FALCON BBS, WILDCAT! BBS, FEATHERNET BBS, TMODEM,
  256.      TELIX 3.12 and QMODEM 4.2 on XT, AT & 386 class machines of various
  257.      manufacture and working well.  Some users have experienced problems
  258.      with lockups, inability to synchup, etc.  At this point I must suspect
  259.      TSR type interference though it is possible I have overlooked a step in
  260.      the interrupt interface. This aspect is under constant review to attempt
  261.      to uncover any oversights on my part.
  262.  
  263.   7. As of version 1.20 the file lookahead scheme was removed since it was
  264.      faulty and did NOT work when an error was encountered.  I will try to
  265.      come up with a new scheme that will work.
  266.  
  267.   8. Version 1.30 fixes a bug introduced by me and considerable change in
  268.      the main Send and Receive procedures.
  269.  
  270.   9. Version 1.31 uses a new status screen scheme and improves on handling
  271.      of NMODEM.ERR and NMODEM.LOG files.
  272.  
  273.  10. Version 1.32 eliminates redundant ClearScreen.
  274.  
  275.  11. Version 1.40 changes the modem interface hopefully for the better!
  276.      NMODEM now uses Turbo Pascal 5.5, TPCRT from Turbo Power Software,
  277.      and SYST55C2 from Eagle Performance Software!  Each of these items
  278.      increase the speed of NMODEM!
  279.  
  280.  12. Version 1.41 introduces a 1 sec delay after setting up the UART to
  281.      allow slow UARTS to process the information.
  282.  
  283.  13. Version 1.50 introduces yet another major revision of the modem
  284.      interface to try to improve reliabilty with various modems.
  285.  
  286.  14. Version 1.60 eliminates the restiction on path names in the shareware
  287.      package.  I also optimized send and receive loops.  NMODEM will now
  288.      inform DOS of COM3: and COM4: while operating and restore the initial
  289.      status on exit.
  290.  
  291.  16. Version 1.61 introduces an option to disable the generation of the
  292.      Nmodem.log file.  This option works on registered versions only!
  293.  
  294.  17. Version 1.62 adds these features:
  295.  
  296.      A. Added statusline that shows the various options.
  297.  
  298.      B. Optimized the status screen.
  299.  
  300.      C. Cleared full status screen on exit.
  301.  
  302.