home *** CD-ROM | disk | FTP | other *** search
- *-----------------------------------------------------------------------------*
- B e a r B o n e $
- "The IND$FILE-Compatible External File Transfer Protocol"
- Copyright (c) 1993 Computer Vectors, Inc. All rights reserved.
- TECHNICAL REFERENCE MANUAL - VERSION 2.00b
- *-----------------------------------------------------------------------------*
-
-
-
- Computer Vectors, Inc.
- 74-5599 Luhia St., Suite E-7
- Kailua-Kona, Hawaii 96740
-
- Marketing.............1-808-329-6645
- Tech Support..........1-808-329-5426
- Bulletin Board........1-808-329-5142
- FAX...................1-808-329-6523
-
-
-
- *-----------------------------------------------------------------------------*
- INTRODUCTION
- *-----------------------------------------------------------------------------*
-
- BEAR BONE$ is an IND$FILE external protocol designed to work with most any PC-
- based asynchronous communications package. It allows the user to transfer text
- and binary files to and from IBM hosts that support IND$FILE.
-
-
-
- *-----------------------------------------------------------------------------*
- REQUIREMENTS
- *-----------------------------------------------------------------------------*
-
- You will need an asynchronous communications package such as PROCOMM Plus,
- PROCOMM for Windows, Q-MODEM, HYPERACCESS/5, etc.. It must support the use
- of external protocols OR have the ability to shell-out to DOS while on-line.
- It must also emulate one of the following terminals:
-
- VT100
- ANSI
- 3101
- FTTERM
- HYDRA/PCCR
- TV950 (Procomm 3270/950)
-
-
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- NOTE FOR WINDOWS USERS:
-
- Two options: BDR=<number> and BTS=ABC (explained near the end of the
- "BEAR BONE$ OPTIONS" section) must be set to use BEAR BONE$ with a
- "true" Windows communications product. These options deal with the way
- Windows resets the communications port when opening a "DOS BOX".
-
- Also, you should set the device contention to "never warn" under the
- 386 Enhanced options of the control panel.
-
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- Among others, BEAR BONE$ is compatible with the following protocol converters:
-
- DATALYNX 3174
- HYDRA II
- HYDRA SNA
- HYDRA 3000
- IBM 3708
- IBM 3174 w/AEA
- IBM 7171
- IBM 9370
- INTERLYNX
- TYMNET
-
- ...and has been tested to work with the following communications packages:
-
- CEDER ISLAND LINK
- COM-AND
- CROSSTALK MK. IV
- CROSSTALK FOR WINDOWS
- DYNACOMM ASYNCHRONOUS FOR WINDOWS
- FTTERM
- HYPERACCESS/5
- HYPERACCESS FOR WINDOWS
- MICROPHONE PRO FOR WINDOWS
- MIRROR III
- MIRROR FOR WINDOWS
- PERELINE
- PROCOMM PLUS
- PROCOMM PLUS FOR WINDOWS
- PROCOMM PLUS NETWORK VERSION
- QMODEM
- RCOM-2/PC
- RELAY
- REXXTERM
- UNICOM
- TELIX
-
- Please call 1-808-329-5426 if you have a protocol converter that is not on
- the list, or if you have any other compatibility questions.
-
-
-
- *-----------------------------------------------------------------------------*
- WHAT'S ON THE DISK
- *-----------------------------------------------------------------------------*
-
- ORDER .FRM BEAR BONE$ order form
- BONE$ .EXE The BEAR BONE$ executable program
- BONE$ .PRM Default parameter file
- BONE$ .DOC This document
- BONE$ .WAS Script file for PROCOMM Plus for Windows
- RECEIVE .BAT Sample batch file for downloading
- SEND .BAT Sample batch file for uploading
- GENERIC .111 Sample parameter file for a generic protocol converter using
- VT100 emulation - Modify this parameter file to suit your
- protocol converter
- 3174-31 .111 3174 using 3101 emulation
- 3174-FT .111 3174 using FTTERM emulation
- 3174-TV .111 3174 using TV950 emulation
- 3174-VT .111 3174 using VT100 emulation
- 3270-950.111 Generic protocol converter using PROCOMM 3270/950 emulation -
- Modify this file to suit your protocol converter
- 3708-31 .111 3708 using 3101 emulation
- 3708-31 .1 3708 using 3101 emulation and IND$FILE version 1
- 3708-FT .111 3708 using FTTERM emulation
- 3708-FT .1 3708 using FTTERM emulation and IND$FILE version 1
- 3708-TV .111 3708 using TV950 emulation
- 3708-VT .111 3708 using VT100 emulation
- 7171-31 .111 7171 using 3101 emulation
- 7171-TV .111 7171 using TV950 emulation
- 7171-VT .111 7171 using VT100 emulation
- HYII-HY .111 HYDRA-II using HYDRA/PCCR emulation
-
-
-
- *-----------------------------------------------------------------------------*
- DETERMINING THE IND$FILE VERSION
- *-----------------------------------------------------------------------------*
-
- Before you attempt a transfer, it is important to find out what version of
- IND$FILE is running on the host. Please follow the steps below:
-
- 1) Dial or connect to the host using your terminal emulation software.
-
- 2) Log on to your account.
-
- 3) Get to the "Ready" state by issuing a "Clear-Screen" command or
- <Control-C>.
-
- 4) Type "IND$FILE PTP <MF File Name>", followed by <Enter>.
- (Please see the MAINFRAME OPTIONS sections for examples of valid
- mainframe file names.)
-
- 5) IF VERSION 1.1.1 IS RUNNING,
-
- the screen will clear and "Caaa" will appear in the upper left hand
- corner. Press the <PF2> or <Clear> key several times to cancel the
- transfer. In this case, you should specify the following options in
- your parameter file (more on parameter files in the next section):
-
- SEN=IND$FILE PTP
- REC=IND$FILE GTP
-
- 6) IF VERSION 1 IS RUNNING, EITHER
-
- ... the screen will clear and the cursor will move to the bottom right
- hand corner of the screen. You are running version 1 but DO NOT have
- "non-display" fields available. You will either need to modify your
- protocol converter's TDF (terminal definition file) or get an upgrade
- to version 1.1.1 of IND$FILE.
-
- ... OR the screen will clear and you will get a "TRANS16 Incorrect
- request code: file transfer canceled$" or similar message. You are
- running version 1 of IND$FILE. Use the following options in your
- parameter file:
-
- SEN=IND$FILE PUT
- REC=IND$FILE GET
-
-
-
- *-----------------------------------------------------------------------------*
- INVOKING BEAR BONE$
- *-----------------------------------------------------------------------------*
-
- Before invoking BEAR BONE$, be sure that you are in the "READY" state on the
- host. This is normally done by hitting the <Clear> key or Control-C. If
- you'd like, you can include the code for the <Clear> key in the PRE=
- parameter.
-
- Now, call up BEAR BONE$ by invoking it as an external protocol (see one of
- the EXTERNAL PROTOCOL SETUP sections below), or if your communications
- package doesn't have this feature, shell out to DOS and type in your command
- line manually.
-
- The format of a BEAR BONE$ command line looks like the following:
-
- BONE$ <Param-file> PUT|GET <PC-file> <MF-file> <MF-options>
-
- <Param-file> is the name of a file containing multiple lines of BEAR BONE$
- options (see BEAR BONE$ OPTIONS below). Any line that does not have an
- EQUAL in the fourth position is considered to be a comment line and is
- discarded. Here is a sample parameter file:
-
- ******************************************************************
- *** VM IND$FILE 1.1.1 using FTTERM emulation on a 3174 w/AEA ***
- ******************************************************************
-
- SEND AND RECEIVE COMMANDS
- -------------------------
- sen=ind$file ptp
- rec=ind$file gtp
-
- ERR-CHECK METHOD, TYPE-AHEAD BUFFER LENGTH, ETC..
- -------------------------------------------------
- err=auto
- buf=2000
- blk=700
- dly=0
-
- TERMINAL TYPE AND KEY SEQUENCES
- -------------------------------
- trm=ftterm
- ent=^m
- rht=^[c
- rst=^r
- try=^[r
- can=^[2^m
- pre=^[>^[o
- pst=^[<<^[p^c
-
- COMMUNICATION PORT OPTIONS
- --------------------------
- prt=1
- adr=0
- irq=0
-
- Unless a path is specified for the parameter file, BEAR BONE$ will first try
- and open a parameter file from the same path where the BEAR BONE$ executable
- is located. If it can't find it, BEAR BONE$ will try and open it from your
- current path. This means that you are able to conveniently place all your
- parameter files in one directory. We suggest that you put BEAR BONE$ and
- its associated parameter files in the same directory as your communications
- software.
-
- You may omit the <Param-file> if you have a file named BONE$.PRM in either
- your current directory, or in the same directory as your BONE$.EXE.
-
- Next on the command line, you need to specify either a PUT to send a file to
- the host, or a GET to download a file from the host. You may abbreviate these
- to P and G. Also, SEND and RECEIVE are valid and will perform the same
- functions as PUT and GET.
-
- <PC-file> is the name of the file on the PC. If you are doing a PUT, data is
- read from this file and transmitted to the host. If you are doing a GET,
- this file is created and host data is written to it.
-
- <MF-file> is a proper file name, or data set name on your mainframe.
-
- <MF-options> are file format and translation options that are available
- on your mainframe IND$FILE program (see MAINFRAME OPTIONS below).
-
-
-
- *-----------------------------------------------------------------------------*
- BATCH TRANSFERS
- *-----------------------------------------------------------------------------*
-
- If you would like to do batch transfers, you may use a command line like
- this:
-
- BONE$ <Param-file> @<List-file>
-
- Each line of the <List-file> should contain one transaction. Here's an
- example:
-
- PUT C:\AUTOEXEC JUNK TEST A
- GET JUNK. JUNK TEST A
- PUT D:DATA.FIL JUNK DATA A
-
-
-
- *-----------------------------------------------------------------------------*
- EXTERNAL PROTOCOL SETUP FOR PROCOMM-PLUS v2.01
- *-----------------------------------------------------------------------------*
-
- From PROCOMM's terminal mode, hit ALT-S to bring up the setup menu, then select
- PROTOCOL OPTIONS. Next, select EXTERNAL PROTOCOL OPTIONS. Here is a sample
- setup for BEAR BONE$ using a parameter file named VM:
-
- EXTERNAL PROTOCOL 1
- A- Name ................ BONE$
- B- Type ................ PROGRAM
- C- Upload command ...... BONE$ VM PUT
- H- Download command .... BONE$ VM GET
-
-
-
- *-----------------------------------------------------------------------------*
- EXTERNAL PROTOCOL SETUP FOR QMODEM v4.31
- *-----------------------------------------------------------------------------*
-
- Type ALT-N from QMODEM's terminal mode. Next, select the PROTOCOLS pull-down
- menu. Here is a sample setup:
-
- Select Character $
- Protocol BONE$
- Upload BAT BONE$ VM PUT
- Download BAT BONE$ VM GET
- Filename Prompt Y
-
-
-
- *-----------------------------------------------------------------------------*
- BEAR BONE$ OPTIONS
- *-----------------------------------------------------------------------------*
-
-
- MAINFRAME STRINGS
- -----------------
-
- SEN=<string> (Default: SEN=IND$FILE PTP)
-
- This is the string that BEAR BONE$ will send to the mainframe to invoke
- an upload. You would normally use IND$FILE PTP if your mainframe is
- running version 1.1.1 of IND$FILE, or IND$FILE PUT if your mainframe
- is running version 1 of IND$FILE.
-
- REC=<string> (Default: REC=IND$FILE GTP)
-
- BEAR BONE$ will send this string to the mainframe to initiate a download.
- You should use either IND$FILE GTP (v1.1.1) or IND$FILE GET (v1).
-
- OPT=<string> (Default: NOT USED)
-
- Default mainframe options used if none specified on the command line.
-
- Example:
- OPT=(ASCII CRLF
-
-
- RELIABILITY OPTIONS
- -------------------
-
- ERR=AUTO|CHECKSUM|CRC (Default: ERR=AUTO)
-
- This option is only available for uploads.
-
- ERR=AUTO will cause BEAR BONE$ to determine the type of error checking
- that is performed on the mainframe. This is a typically used option,
- but is not recommended for use with the CICS IND$FILE.
-
- ERR=CHECKSUM forces BEAR BONE$ to use a one byte checksum error detection.
- Use this option only if your mainframe is running version 1 of IND$FILE,
- or running a CICS version.
-
- ERR=CRC tells BEAR BONE$ to use an advanced 6 byte CRC (Cyclical
- Redundancy Check). Version 1.1.1 supports this feature.
-
- BUF=<number from 20 to 2000> (Default: BUF=50)
-
- Specifies the size of your protocol converter's type-ahead buffer. When
- sending a file, BEAR BONE$ will never be more than <number> characters
- ahead of echoed back characters. Generally, the lower the number, the
- slower the transfer will be. On the other hand, if BUF is set too high,
- your protocol converter may disconnect, or lock up on you during your
- transfer. Experiment to get the best results.
-
- BLK=<number from 200 to 1914> (Default: BLK=1914)
-
- Sets the block size of the data for uploads only. As with the BUF
- parameter, a small block size will slow the transfer. Use this
- option only if you are having problems with file uploads.
-
- DLY=<number from 0 to 50> (Default: DLY=0)
-
- BEAR BONE$ will pause this many ticks (1/18th second intervals) between
- blocks, to make the transfer more reliable.
-
- CLK=A,B,C (Default: NOT USED)
-
- Tells BEAR BONE$ to use the mainframes XCLOCK to determine when the
- screen has been updated. "A" is the ROW NUMBER, "B" is the COLUMN
- NUMBER, and "C" is the character located at that position.
-
- Example:
- CLK=25,9,X
-
- TMO=A,B (Default: TMO=20,3)
-
- Sets the time-out limit and number of retries. If the communications
- port remains inactive for "A" seconds, BEAR BONE$ will request a
- screen refresh from the host. The valid range for "A" is 5 seconds
- to 150 seconds. The "B" parameter specifies the maximum number of
- times BEAR BONE$ will ask for a screen refresh for any given frame.
- The valid range for "B" is 1 to 10.
-
-
- TERMINAL TYPES AND KEY DEFINITIONS
- ----------------------------------
-
- TRM=VT100|ANSI|FTTERM|3101|TV950|HYDRA (Default: TRM=VT100)
-
- Tells BEAR BONE$ what type of terminal to emulate during the transfer.
- The transfer will not work if this option is set incorrectly. It should
- match the terminal type that your communications software is emulating.
-
- TV950 should be used if you are using PROCOMM's 3270/950 emulation.
- The key mappings are likely to be different, however, so please double
- check them using PROCOMM's PCKEYMAP utility.
-
-
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- NOTE:
-
- The following key definitions should coincide with the terminal type and
- key mapping that your communications package uses.
-
- An <extended string> may be any combination of the following definitions:
-
- Normal displayable ASCII characters:
- IND$FILE PTP
-
- ASCII DIGITS surrounded by parenthesis and separated with spaces:
- (123 12 32 42)
-
- HEXADECIMAL DIGITS surrounded by less-than/greater-than symbols and
- separated with spaces:
- <0F 1B C4 12>
-
- ASCII CONTROL CHARACTERS may be defined by using the carat (^)
- followed by an ASCII character in the range of 64-95 (DECIMAL) or
- 40-5F (HEXADECIMAL):
- ^C^M
-
- Special cases are ^, (, and <. They may be specified by using
- ^^, ((, and << respectively.
-
- The following examples are all equivalent:
- ^[J1
- <1B>J1
- (27)J1
- ^[<4A 32>
- (27 74 49)
-
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- ENT=<extended string> (Default: ENT=^M)
-
- The key sequence your mainframe expects for the <Enter> key.
-
- RHT=<extended string> (Default: RHT=^[[C)
-
- The key sequence your mainframe expects for the <Right Arrow> key. This
- key must be defined correctly for uploads to work.
-
- RST=<extended string> (Default: RST=^R)
-
- The key sequence your mainframe expects for the <Reset> key. BEAR BONE$
- sends this key when the protocol converter has locked up and sent us the
- bell character (hexadecimal 07).
-
- TRY=<extended string> (Default: TRY=^[r)
-
- The key sequence for your protocol converter's "REDISPLAY SCREEN" function.
- If your protocol converter does not have such a function, try using the
- <PF1> key definition.
-
- CAN=<extended string> (Default: CAN=^[2^C^C)
-
- BEAR BONE$ will send this sequence to cancel a file transfer. Usually
- this is defined as your <PF2> key followed by a couple of <Clear> keys.
-
- PRE=<extended string> (Default: NOT USED)
-
- The preamble string. BEAR BONE$ will send it to the protocol converter
- before initiating a transfer. Use this to set up XON/XOFF flow control,
- or other protocol converter dependent options that the manufacturer
- recommends. Ask your systems operator or call CVI for more information.
-
- If your protocol converter displays the status line on the 24th line
- instead of the 25th line, you MUST disable it before starting a transfer.
-
- MID=<extended string> (Default: NOT USED)
-
- The "midamble" string. BEAR BONE$ will send this between batch transfers
- to get the host back to a "Ready" state.
-
- PST=<extended string> (Default: NOT USED)
-
- The postamble string. BEAR BONE$ will send it when the transfer is
- complete to "undo" the preamble.
-
-
- PORT OPTIONS
- ------------
-
- PRT=<number from 1 to 8> (Default: PRT=1)
-
- Specifies the communications port number on the PC.
-
- ADR=<number> (Default: ADR=0)
-
- The address of the communications port in hexadecimal (i.e., 03F8).
- If you specify 0 for the port address, BEAR BONE$ will use the port
- defaults.
-
- IRQ=<number from 0 to 15> (Default: IRQ=0)
-
- Specifies the port's IRQ. Use 0 to have BEAR BONE$ use port's default
- IRQ.
-
- BDR=<number> (Default: NOT USED)
-
- Causes the port's baud rate to be set when opened. By default,
- BEAR BONE$ leaves the baud rate alone. Valid options are 1200, 2400,
- 4800, 9600, and 19200. This option (and the BTS option) must be
- specified if you are using BEAR BONE$ in conjunction with a Windows
- product (such as PROCOMM for Windows).
-
- BTS=ABC (Default: NOT USED)
-
- Where "A" is the number of DATA BITS (7 or 8), "B" is the PARITY
- (N=None, O=Odd, E=Even, M=Mark, and S=Space), and "C" is the number of
- STOP BITS (1 or 2).
-
- Example:
- BTS=8N1
- or
- BTS=7E1
-
- NET=INT14|NASI (Default: USE LOCAL COM PORT)
-
- Tells BEAR BONE$ to use either INT14 or NASI/NCSI calls to route data
- through your LAN's "modem pool". You must also be using a "network"
- communications package that supports one of these methods.
-
- If you specify NASI, BEAR BONE$ will use the first active virtual
- circuit. Because of this, you must have only one circuit open.
-
-
- MISCELLANEOUS OPTIONS
- ---------------------
-
- DEL=<number from 20 to 200> (Default: NOT USED)
-
- Tells BEAR BONE$ to delete two characters every X number of bytes.
- This is useful to strip carriage return/line feed pairs if you mainframe
- IND$FILE puts them in when it shouldn't.
-
- LOG=<filename> (Default: NOT USED)
-
- Will cause BEAR BONE$ to append the results of the transfer to the
- specified log file:
-
- SEN FAIL 04/12/93 08:19:49 0:03 1632 c:autoexec.bat
- REC -OK- 04/12/93 08:23:42 0:09 6285 pcodes.doc
- .
- .
- .
-
- PAU=<number from 0 to 99> (Defualt: 3)
-
- Forces BEAR BONE$ will pause this many seconds before exiting.
-
- RET=A,B (Default: RET=0,1)
-
- Sets the values that BEAR BONE$ will return on exit. "A" is the
- return code for a successful transfer, and "B" is the return code for
- a failed transfer.
-
- TRC=<filename> (Default: NOT USED)
-
- Causes BEAR BONE$ to record all data that is sent or received on the
- communications port. Use this option only for debugging, as it creates
- a VERY LARGE file.
-
- VID=COLOR|B&W (Default: COLOR)
-
- Tells BEAR BONE$ to write to the screen either in full color, or black
- and white. This option could be useful on laptop machines or machines
- with paper-white VGA monitors.
-
- WAT=YES|NO (Default: NO)
-
- Lets you watch the emulation screen as the transfer takes place.
-
-
-
- *-----------------------------------------------------------------------------*
- MAINFRAME OPTIONS
- *-----------------------------------------------------------------------------*
-
- This section gives a brief listing of the mainframe IND$FILE options. Please
- refer to your mainframe IND$FILE manual for detailed descriptions of the
- following options.
-
-
- CICS:
-
- SEND Options RECEIVE Options
- -------------------------------------------
- ASCII|BINARY APPEND
- CRLF|NOCRLF ASCII|BINARY
- P(xxx) CRLF|NOCRLF
- P(xxx)
-
- ASCII CRLF is the default data type.
-
- Example: BONE$ CICS.PRM PUT C:\AUTOEXEC.BAT JUNK (ASCII CRLF
-
- IWS:
-
- SEND Options RECEIVE Options
- -------------------------------------------
- ASCII|BINARY ASCII|BINARY
- BLANK BLANK
- CRLF|NOCRLF CRLF|NOCRLF
- NOREPLACE|REPLACE REPLACE|APPEND
- P(xxx) P(xxx)
- FILE=HTF|FILE=TS FILE=HTF|FILE=TS
-
- if FILE=HTF: if FILE=HTF:
- FOR=usid1...usid8 FROM=usid
- PRIVATE|PUBLIC DELETE|KEEP
- TYPE=EDIT|TYPE=PRINT
-
- if FILE=TS: if FILE=TS:
- QNAME=CFTRxxxx QNAME=CFTRxxxx
- PROGRAM=CFTRxxxx PROGRAM=CFTRxxxx
-
- ASCII is the default data type.
- BINARY is used for binary files.
- Options available depends on the level of VSE/SP.
-
- Example: BONE$ IWS.PRM PUT C:\COMMAND.COM JUNK (BINARY
-
- MVS/TSO:
-
- SEND Options RECEIVE Options
- -------------------------------------------
- APPEND APPEND
- ASCII ASCII
- CRLF CRLF
- BLKSIZE(n) P(xxx)
- LRECL(n)
- P(xxx)
- RECFM(F|V|U)
- SPACE(n1,n2)AVBLOCK(n)
- SPACE(n1,n2)CYLINDERS
- SPACE(n1,n2)TRACKS
-
- BINARY is the default data type.
- ASCII and CRLF are commonly used for text files.
- ASCII and CRLF are the only valid options for members of a partitioned
- data set.
- 80 characters is default length for a fixed length records.
-
- Example: BONE$ TSO.PRM PUT C:\CONFIG.SYS 'JUNK.TEST.A' ASCII CRLF
- (Note that a left-paren does not precede the option list.)
-
- VM/SP:
-
- SEND Options RECEIVE Options
- -------------------------------------------
- APPEND APPEND
- ASCII ASCII
- CRLF CRLF
- LRECL P(xxx)
- P(xxx)
- RECFM V|F
-
- BINARY is the default data type.
- ASCII and CRLF are commonly used for text files.
-
- Example: BONE$ VM.PRM PUT D:\README.DOC JUNK TEST A (ASCII CRLF
-