home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / filutl / pcpck.lbr / -README.QQQ / PCPCK.DOC
Encoding:
Text File  |  1986-10-21  |  3.1 KB  |  78 lines
  1. To:    All PC Pursuit Users
  2. From:    Bob Freed
  3. Date:    October 17, 1986
  4. Subj:    Documentation for PCPCK.COM
  5.  
  6. PCPCK.COM is a simple program which checks a CP/M file to 
  7. determine if it contains the Telenet (PC Pursuit network) local 
  8. command escape sequence.  Such files cannot be uploaded to a 
  9. remote system with XMODEM (or YMODEM) file transfer protocol, 
  10. unless a special Telenet command is first issued to disable 
  11. recognition of the escape sequence.  Details of this problem and 
  12. its solution may be found in the previously-published messages, 
  13. PCP-WARN.MSG and PCP-FIX.MSG, which are included in this library.
  14.  
  15. To use this program, simply supply the unambiguous file name of 
  16. the (single) file to be checked.  For example:
  17.  
  18.     A>PCPCK B:TEST.LBR
  19.         File is ok!
  20.  
  21. Note that the specified file name should not contain wildcard 
  22. characters (? or *), although this is not treated as an error 
  23. (and will cause the first matching file on disk to be checked).  
  24. If no file name is supplied, a short help message is generated.
  25.  
  26. The above example illustrates the program's response if the 
  27. escape sequence is not detected.  This implies that the file 
  28. should be safe to upload.  (See note below, however.)
  29.  
  30. If the escape sequence is detected in the middle of a 128-byte 
  31. record, the program terminates immediately with the following 
  32. message (nnn is the decimal record no. containing the escape 
  33. sequence):
  34.  
  35.     File will fail in record # nnn!
  36.  
  37. If the (three-byte) escape sequence crosses a record boundary, it 
  38. is possible that the file will upload successfully using 128-byte 
  39. transmission blocks (XMODEM protocol) but will fail using 1024- 
  40. byte blocks (YMODEM protocol).  In this case, the program issues 
  41. the following message and continues checking the file:
  42.  
  43.     Warning: File will fail in record # nnn! (with 1K blocks)
  44.  
  45. If only the above such (warning) conditions are detected, the 
  46. following final message will appear:
  47.  
  48.     File is ok! (with 128-byte blocks)
  49.  
  50. In this case, the file is safe to upload using XMODEM protocol 
  51. but not YMODEM (1K) protocol.
  52.  
  53.                               NOTE
  54.  
  55.     It is possible that a file will pass the PCPCK
  56.     program's check and still not upload properly.  
  57.     This may happen if a part of the Telenet escape
  58.     sequence occurs at the beginning or end of a
  59.     record and is completed by the additional bytes 
  60.     which are inserted by the XMODEM protocol (record
  61.     no. or checksum/CRC bytes).  Determination of
  62.     such a (highly unlikely) condition is beyond the
  63.     scope of this simple program.
  64.  
  65. I originally wrote this program two months ago (at the time the 
  66. above-mentioned message files were generated).  I have not used 
  67. it since.  (Nor have I encountered an aborted file upload 
  68. situation since then, which illustrates just how rare an 
  69. occurrence that is.)  I am releasing it now at the request of 
  70. Gary Inman, sysop of the West Los Angeles RCP/M.  It is 
  71. completely public domain.  The source program uses Zilog 
  72. mnemonics but does not implement any Z80-specific instructions, 
  73. and it should be usable on any CP/M system.
  74.  
  75.                 Bob Freed
  76.                 Newton Centre, MA
  77.                 October 17, 1986
  78.