home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / BONE$.ZIP / BONE$.DOC < prev    next >
Encoding:
Text File  |  1993-03-23  |  14.8 KB  |  446 lines
  1. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  2.                               B e a r   B o n e $
  3.            "The IND$FILE Compatible External File Transfer Protocol"
  4.        Copyright (c) 1993  Computer Vectors, Inc.  All rights reserved.
  5.                           TECHNICAL REFERENCE MANUAL
  6. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  7.  
  8.  
  9. Computer Vectors, Inc.
  10. 74-5599 Luhia St., Suite E-7
  11. Kailua-Kona, Hawaii 96740
  12.  
  13. Marketing.............1-800-262-RCOM
  14. Executive.............1-808-329-6645
  15. Tech Support..........1-808-329-5426
  16. Bulletin Board........1-808-329-5142
  17. FAX...................1-808-329-6523
  18.  
  19.  
  20. ******************************************************************************
  21.  
  22.  
  23. INTRODUCTION
  24. =-=-=-=-=-=-
  25.  
  26. BEAR BONE$ is a IND$FILE external protocol designed to work with most any PC
  27. based asynchronous communications package. It allows the user to transfer text
  28. and binary files to and from IBM hosts that support IND$FILE.
  29.  
  30.  
  31. REQUIREMENTS
  32. =-=-=-=-=-=-
  33.  
  34. You will need a asynchronous communications package such as PROCOMM Plus,
  35. PROCOMM for Windows, Q-MODEM, MTEZ, etc..  It must support the use of external
  36. protocols OR have the ability to shell-out to DOS while on-line.  It must
  37. also emulate one of the following terminals: VT100, 3101, FTTERM, or ANSI.
  38.  
  39. NOTE FOR WINDOWS USERS:
  40.  
  41.     Two options: BDR=<number> and BST=ABC (explained near the end of the
  42.     "BEAR BONE$ PARAMETERS" section) must be set to use BEAR BONE$ with a
  43.     true Windows communications product.  These options deal with the way
  44.     Windows resets the communications port when opening a "DOS BOX".
  45.  
  46. Among others, BEAR BONE$ is compatible with the following protocol converters:
  47.  
  48.     IBM 3708
  49.     IBM 3174 w/AEA
  50.     IBM 7171
  51.     IBM 9370
  52.   
  53.     DATALYNX 3174
  54.     INTERLYNX
  55.     
  56.     HYDRA II
  57.     HYDRA SNA
  58.     HYDRA 3000
  59.  
  60. Please call if you have a protocol converter that is not on the list.
  61.  
  62.  
  63. DETERMINING THE IND$FILE VERSION
  64. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  65.  
  66. Before you attempt a transfer, it is important to find out what version of
  67. IND$FILE is running on the host.  Please follow the steps below:
  68.  
  69. 1)  Dial or connect to the host using your terminal emulation software;
  70. 2)  Log on to your account;
  71. 3)  Get to the "Ready" state by issuing a "Clear-Screen" command or
  72.     "Control-C";
  73. 4)  Type "IND$FILE ?",  followed by the <Enter> key;
  74. 5)  If version 1.1.1 is running, a message similar to the following will
  75.     appear on your screen:
  76.         IBM File Transfer Program:     Version 1.1.1
  77.         PTF: 0000000  Date: 05/14/88   Size: lrecl (19768) x 3
  78.     In this case, you should specify the following options in your
  79.     parameter file (more on parameter files in the next section):
  80.         SEN=IND$FILE PTP
  81.         REC=IND$FILE GTP
  82.     otherwise;
  83. 6)  If version 1 is running, you will receive a message such as:
  84.         CaaaTRANS16   Incorrect request code: file transfer canceled$
  85.     The following options need be in your parameter file:
  86.         SEN=IND$FILE PUT
  87.         REC=IND$FILE GET
  88.     Also, check with your system operator to see if non-display fields are
  89.     available.  If they are not, you will get "time-out" errors when you try
  90.     to transfer.  Contact CVI's tech support at 1-808-329-5426 if you need
  91.     further assistance or advice on this issue.
  92.  
  93.  
  94. INVOKING BEAR BONE$
  95. =-=-=-=-=-=-=-=-=-=
  96.  
  97. Before invoking BEAR BONE$, be sure that you are in the "READY" state on the
  98. host.  This is normally done by hitting the "Clear" key or Control-C.  The
  99. structure of a BEAR BONE$ command line looks like the following:
  100.  
  101.     BONE$ <Param-file> PUT|GET <PC-file> <MF-file> <MF-options>
  102.  
  103. <Param-file> is the name of a file containing multiple lines of BEAR BONE$
  104. options (see BEAR BONE$ OPTIONS below).  Here is a sample parameter file
  105. (Note that comment lines start with a semicolon, and empty lines are
  106. permitted):
  107.  
  108.     ;***********************************
  109.     ;*** VM IND$FILE on a 3174 w/AEA ***
  110.     ;***********************************
  111.  
  112.     ; send and receive commands
  113.     SEN=IND$FILE PTP
  114.     REC=IND$FILE GTP
  115.  
  116.     ; err-check method, type-ahead buffer length, etc..
  117.     ERR=AUTO
  118.     BUF=2000
  119.     BLK=1000
  120.     DLY=7
  121.  
  122.     ; terminal type and key sequences
  123.     TRM=FTTERM               
  124.     ENT=^M                   
  125.     RHT=^[C                  
  126.     RST=^R                   
  127.     PF1=^[1                  
  128.     PF2=^[2                
  129.     PRE=^[>^[o
  130.     PST=^[<<^[p
  131.     
  132.     ; communication port options
  133.     PRT=1
  134.     ADR=0
  135.     IRQ=0
  136.  
  137. Unless a path is specified for the parameter file, BEAR BONE$ will first try
  138. and open a perameter file from the same path where the BEAR BONE$ executable is
  139. located.  If it can't find it, BEAR BONE$ will try and open it from your
  140. current path.  This means the user is able to conveniently place all of his/her
  141. parameter files in one directory.
  142.  
  143. Next on the command line, you need to specify either a PUT to send a file to
  144. the host, or a GET to download a file from the host.  You may abbreviate these
  145. to P and G.  Also, SEND and RECEIVE are valid and will perform the same
  146. functions as PUT and GET.
  147.  
  148. <PC-file> is the name of the file on the PC.  If you are doing a PUT, data is
  149. read from this file and transmitted to the host.  If you are doing a GET,
  150. this file is created and host data is written to it.
  151.  
  152. <MF-file> is a proper file name, or data set name on your mainframe.
  153. <MF-options> are file format and translation options that are available
  154. on your mainframe IND$FILE program (see MAINFRAME OPTIONS below).
  155.  
  156.  
  157. EXTERNAL PROTOCOL SETUP FOR PROCOMM-Plus
  158. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  159.  
  160. From PROCOMM's terminal mode, hit ALT-S to bring up the setup menu, then select
  161. PROTOCOL OPTIONS.  Next, select EXTERNAL PROTOCOL OPTIONS.  Here is a sample
  162. setup for BEAR BONE$:
  163.  
  164.     EXTERNAL PROTOCOL 1
  165.     A- Name ................  BONE$
  166.     B- Type ................  PROGRAM
  167.     C- Upload command ......  BONE$ VM PUT
  168.     H- Download command ....  BONE$ VM GET
  169.  
  170.  
  171. EXTERNAL PROTOCOL SETUP FOR QMODEM
  172. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  173.  
  174. Type ALT-N from QMODEM's terminal mode.  Next, select the PROTOCOLS pull down
  175. menu.  Here is a sample setup:
  176.  
  177.     Select Character    $
  178.     Protocol            BONE$
  179.     Upload BAT          BONE$ VM PUT
  180.     Download BAT        BONE$ VM GET
  181.     Filename Prompt     Y
  182.  
  183.  
  184. FILE TRANSFER IN PROGRESS
  185. =-=-=-=-=-=-=-=-=-=-=-=-=
  186.  
  187. BEAR BONE$ is somewhat unique, in that you can actually "see" the transfer
  188. taking place, frame by frame.  Progress is displayed on the 25th line in the
  189. following format:
  190.  
  191.     Frames: 4   Bytes sent: 1923 of 5409, 48%   Retries: 0
  192.  
  193. To cancel the transfer at any time, you may press any key.
  194.     
  195. Upon completion, BEAR BONE$ will notify the user by emitting several high
  196. pitch beeps along with a "file transfer complete" message.  If the transfer
  197. was not successful, BEAR BONE$ will emit alternating low pitch beeps and
  198. an error message.
  199.  
  200.  
  201. BEAR BONE$ OPTIONS
  202. =-=-=-=-=-=-=-=-=-
  203.     
  204.         
  205. SEN=<string>
  206.  
  207.     This is the string that BEAR BONE$ will send to the mainframe to invoke
  208.     an upload.  You would normally use IND$FILE PTP if your mainframe is
  209.     running version 1.1.1 of IND$FILE, or IND$FILE PUT if your mainframe
  210.     is running version 1 of IND$FILE.
  211.  
  212.     **************************************************************************
  213.     
  214.     Note: <string> may be any combination of the following definitions:
  215.  
  216.         Normal displayable ASCII characters:
  217.             IND$FILE PTP
  218.  
  219.         ASCII DIGITS surrounded by parenthesis and separated with spaces:
  220.             (123 12 32 42)
  221.  
  222.         HEXADECIMAL DIGITS surrounded by less-than/greater-than symbols and
  223.         separated with spaces:
  224.             <0F 1B C4 12>
  225.             
  226.         ASCII CONTROL CHARACTERS may be defined by using the carat (^)
  227.         followed by an ASCII character in the range of 64-95 (DECIMAL) or
  228.         40-5F (HEXADECIMAL):
  229.             ^C^M
  230.             
  231.         The following examples are all identical:
  232.             ^[J1
  233.             <1B>J1
  234.             (27)J1
  235.             ^[<4A 32>
  236.             (27 74 49)
  237.  
  238.     ***************************************************************************
  239.         
  240. REC=<string>
  241.  
  242.     BEAR BONE$ will send this string to the mainframe to initiate a download.
  243.     You should use either IND$FILE GTP (v1.1.1) or IND$FILE GET (v1).
  244.  
  245. ERR=AUTO|CHECKSUM|CRC
  246.  
  247.     This option is only available for uploads.
  248.  
  249.     ERR=AUTO will cause BEAR BONE$ to determine the type of error checking
  250.     that is performed on the mainframe automatically.  This is a typically
  251.     used options, but is not recommended for use with the CICS IND$FILE.
  252.         
  253.     ERR=CHECKSUM forces BEAR BONE$ to use a one byte checksum error detection.
  254.     Use this option only if your mainframe is running version 1 of IND$FILE,
  255.     or running a CICS version.
  256.  
  257.     ERR=CRC tells BEAR BONE$ to use an advanced 6 byte CRC (Cyclical
  258.     Redundancy Check).  Version 1.1.1 supports this feature.
  259.  
  260. BUF=<number from 20 to 2000>
  261.  
  262.     Specifies the size of your protocol converter's type-ahead buffer.  When
  263.     sending a file, BEAR BONE$ will never be more than <number> characters
  264.     ahead of echoed back characters.  Generally, the lower the number, the
  265.     slower the transfer will be.  On the other hand, if BUF is set too high,
  266.     your protocol converter may disconnect, or lock up on you during your
  267.     transfer.  Experiment to get the best results.
  268.  
  269. BLK=<number from 200 to 1915>
  270.  
  271.     Sets the block size of the data for uploads only. As with the BUF
  272.     parameter, a small block size will slow the transfer down.  Use this 
  273.     option only if you are having problems with file uploads.
  274.  
  275. DLY=<number from 0 to 50>
  276.  
  277.     BEAR BONE$ will pause this many ticks (1/18th second intervals) between
  278.     blocks, to make the transfer more reliable.
  279.  
  280. TRM=ANSI|FTTERM|VT100
  281.  
  282.     This tells BEAR BONE$ what type of terminal to emulate during the
  283.     transfer.  The transfer will not work if this option is set incorrectly.
  284.     It should match  the terminal type that your communications software is
  285.     emulating.
  286.  
  287.     If you are logged on as a IBM 3101 terminal, you should specify
  288.     FTTERM for this option.  The two are interchangeable.
  289.  
  290. *******************************************************************************
  291.  
  292. Note:
  293.  
  294.     The following key definitions should coincide with the terminal type and
  295.     key mapping that your communications package uses.
  296.  
  297. *******************************************************************************
  298.  
  299. ENT=<string>
  300.  
  301.     The key sequence your mainframe expects for the ENTER key.
  302.  
  303. RHT=<string>
  304.  
  305.     The key sequence your mainframe expects for the RIGHT ARROW key.
  306.  
  307. RST=<string>
  308.  
  309.     The key sequence your mainframe expects for the RESET key.
  310.  
  311. PF1=<string>
  312.  
  313.     The key sequence your mainframe expects for the PF1 key.
  314.     
  315. PF2=<string>
  316.  
  317.     The key sequence your mainframe expects for the PF2 key.
  318.  
  319.  
  320. PRE=<string>
  321.  
  322.     The preamble string.  BEAR BONE$ will send it to the protocol converter
  323.     before initiating a transfer.  Use this to set up XON-XOFF flow control,
  324.     or other protocol converter dependent options that the manufacturer
  325.     recommends.  Ask your systems operator or call CVI for more information.
  326.     
  327. PST=<string>
  328.  
  329.     The postamble string and BEAR BONE$ will send it when the transfer is
  330.     complete to "undo" the preamble.
  331.     
  332. PRT=<number from 1 to 8>
  333.  
  334.     Specifies the communications port number on the PC.
  335.  
  336. ADR=<number>
  337.  
  338.     The address of the communications port in hexadecimal (i.e., 03F8).
  339.     If you specify 0 for the port address, BEAR BONE$ will attempt to
  340.     auto-detect it.
  341.  
  342. IRQ=<number from 0 to 15>
  343.  
  344.     Specifies the port's IRQ.  Use 0 to have BEAR BONE$ auto-detect it.
  345.  
  346. BDR=<number>
  347.  
  348.     Causes the port's baud rate to be set when opened.  By default,
  349.     BEAR BONE$ leaves the baud rate alone.  Valid options are 1200, 2400,
  350.     4800, 9600, and 19200.   This option (and the BTS option) should only
  351.     be used if you are using BEAR BONE$ in conjunction with a Windows
  352.     product (such as PROCOMM for Windows).
  353.  
  354. BTS=ABC
  355.  
  356.     Where "A" is the number of DATA BITS (7 or 8), "B" is the PARITY 
  357.     (N=None, O=Odd, E=Even, M=Mark, and S=Space), and "C" is the number of
  358.     STOP BITS (1 or 2).
  359.  
  360.     Example:
  361.         BTS=8N1
  362.             or
  363.         BTS=7E1
  364.  
  365.  
  366. MAINFRAME OPTIONS
  367. =-=-=-=-=-=-=-=-=
  368.  
  369. *******************************************************************************
  370.  
  371. Note:
  372.  
  373.     Please refer to your mainframe IND$FILE manual for detailed descriptions
  374.     of the following options.
  375.  
  376. *******************************************************************************
  377.         
  378. CICS:
  379.  
  380.     SEND Options                RECEIVE Options
  381.     -------------------------------------------
  382.     ASCII|BINARY                APPEND
  383.     CRLF|NOCRLF                 ASCII|BINARY
  384.     P(xxx)                      CRLF|NOCRLF
  385.                                 P(xxx)
  386.  
  387.     ASCII CRLF is the default data type.
  388.     
  389. IWS:
  390.  
  391.     SEND Options                RECEIVE Options
  392.     -------------------------------------------
  393.     ASCII|BINARY                ASCII|BINARY
  394.     BLANK                       BLANK
  395.     CRLF|NOCRLF                 CRLF|NOCRLF
  396.     NOREPLACE|REPLACE           REPLACE|APPEND
  397.     P(xxx)                      P(xxx)
  398.     FILE=HTF|FILE=TS            FILE=HTF|FILE=TS
  399.  
  400.     if FILE=HTF:                if FILE=HTF:
  401.         FOR=usid1...usid8           FROM=usid
  402.         PRIVATE|PUBLIC              DELETE|KEEP
  403.         TYPE=EDIT|TYPE=PRINT
  404.  
  405.     if FILE=TS:                 if FILE=TS:
  406.         QNAME=CFTRxxxx              QNAME=CFTRxxxx
  407.         PROGRAM=CFTRxxxx            PROGRAM=CFTRxxxx
  408.  
  409.     ASCII is the default data type.
  410.     BINARY is used for binary files.
  411.     Options available depends on the level of VSE/SP.
  412.  
  413. MVS/TSO:
  414.  
  415.     SEND Options                RECEIVE Options
  416.     -------------------------------------------
  417.     APPEND                      APPEND
  418.     ASCII                       ASCII
  419.     BLKSIZE(n)                  CRLF
  420.     LRECL(n)                    P(xxx)
  421.     P(xxx)
  422.     RECFM(F|V|U)
  423.     SPACE(n1,n2)AVBLOCK(n)
  424.     SPACE(n1,n2)CYLINDERS
  425.     SPACE(n1,n2)TRACKS
  426.  
  427.     BINARY is the default data type.
  428.     ASCII and CRLF are commonly used for text files.
  429.     ASCII and CRLF are the only valid options for members of a partitioned
  430.         data set.
  431.     80 characters is default length for a fixed length records.
  432.  
  433. VM/SP:
  434.  
  435.     SEND Options                RECEIVE Options
  436.     -------------------------------------------
  437.     APPEND                      APPEND
  438.     ASCII                       ASCII
  439.     CRLF                        CRLF
  440.     LRECL                       P(xxx)
  441.     P(xxx)                      
  442.     RECFM V|F
  443.  
  444.     BINARY is the default data type.
  445.     ASCII and CRLF are commonly used for text files.
  446.