⟦f7aa59ff0⟧

TextFile

XMODEM DOCUMENTATION

ABSTRACT

Xmodem is a self-contained subsystem for transferring data to and from an
R1000 via the Xmodem protocol. This subsystem permits the transfer of binary
files as well as text-only files.

XMODEM SETUP

This procedure assumes that:

    1) The R1000 is connected to a remote host via a Bridge network
    2) The remote host is a Macintosh running a suitable communications
       program such as RedRyder.
       
Of course, Xmodem can support any remote host capable of handling the 
necessary protocol. For example, if the R1000 is directly connected to 
the remote host, no special setup is needed to establish communications
for Xmodem. Similarly, text only transfers are specific to the Macintosh
for documents produced with programs such as MacWrite or Word; all other
remote hosts can ignore this class of transfer.

Since Xmodem must be able to send all 8-bit patterns, the path through the
Bridge network from an R1000 to a remote host must be established to allow
this. Therefore, TELENET ports cannot be used to send data from an R1000
(at Rational, this means that you must establish a port connection such as
Native_1 rather then just Native). Similarly, you must disable the use of
the attention character (at Rational, this is ^]) which enables Bridge
command mode. Once you have established a non-TELENET connection, enter 
the following commands at the Bridge prompt:

    ...> set ecmchar = disabled
    ...> set breakaction = escdtm
    ...> resume
    
This establishes a clear channel. To return to Bridge command mode, you must
send a BREAK. To restore normal Bridge channel parameters, type the following
commands at the Bridge prompt:

    ...> set ecma = ^]
    ...> set bra = ignore
    ...> set bra = inband
    ...> resume
    
The remaining discussion assumes that your search list defines a path to the
procedure Xmodem. Consult your system manager or the Rational Environment
Reference Manual if you need help doing this.

If you intend to do a lot of transfers via Xmodem, you might consider
creating a session dedicated for transfers to a remote host. In your login
procedure, test for this session and invoke the Xmodem procedure in that
case. Thus, when you login under this session, Xmodem will take over 
automatically.

Xmodem is capable of tranferring any binary file (such as Macintosh
applications or MacWrite, Word, MacDraw, MacPaint, etc documents). In 
addition, Xmodem can transfer any text file (such as text only documents 
produced by MacWrite and Word). The difference between these two classes
of transfers is important. If you are transferring files to be processed
later by a Macintosh application, you should use binary transfers. For
example, if you are using the R1000 as a file server, you might catalog
MacDraw documents on the R1000, which can then be downloaded to a Macintosh
for editing, and then uploaded later. If you are transferring programs or
documents which must be processed by tools on the Rational Environment, you
should use text-only transfers. For example, you might download an Ada 
program from the R1000 to a Macintosh in order to incorporate it into
a slide produced by MacDraw or to be transferred to another remote host
via RedRyder. Similarly, you might edit programs or documents on the
Macintosh, and then wish to upload them to the R1000 to be processed
by the Ada object editor or the text object editor.

Word will easily read and write any text only documents. To prepare a Word
document for text-only transfer, click on the button labeled "Text Only" in
the Save As... dialog.

MacWrite is a little less forgiving. To prepare a MacWrite document for
text-only transfer, click on the button labeled "Text Only" in the Save As...
dialog. MacWrite will then bring up another dialog, asking where you want to
place carriage returns. Click on the button marked "Line Breaks" to signify 
that you want a carriage return placed after every line. When editing 
a text-only document for the first time, MacWrite will bring up a similar 
dialog. This time, you must click on the button labeled "Paragraphs" 
to signify that you want a carriage return to represent a paragraph break.
If you do otherwise, you will notice that your document contains lines
that with word wrap in places where you probably don't want them.

At the remote host, you must set up your communications program for
Xmodem tranfers. For example, in RedRyder, select the command
"XMODEM and Kermit Preferences..." in the File menu. This command
brings up a dialog box, which should be set as:

    Timeout after 5 seconds
    Attempt CRC error checking for XMODEM receive
    Recognize and convert MacBinary format files
    Sent TEXT files using MacBinary format
    Received non-MacBinary format text file creator: MACA
    
All other settings should be disabled.

COMMANDS

Upon invoking Xmodem, this procedure will force a logoff. After
communication has been established with the remote host, Xmodem will
display the message:

    Xmodem Transfer Subsystem, V1.0
    Xmodem>
    
Once Xmodem has taken over the port, it can be controlled via a simple
command line interface. The commands available at this prompt are:

    sx  <file>       -- send a file from the R1000 via Xmodem
    st  <file>       -- send a text file from the R1000 via Xmodem
    rx  <file>       -- receive a file onto the R1000 via Xmodem
    rt  <file>       -- receive a text file onto the R1000 via Xmodem
    cd  <dir>        -- connect to another directory
    vd [<wildname>]  -- display selected objects
    ty  <file>       -- type a file to the screen
    ex               -- exit Xmodem and release terminal
    ?                -- help

Commands must begin in column 1 and typed in lowercase. Commands that take 
an argument must have a blank in column 3. An ANSI terminal is expected.  
BS or DEL will delete the character at the end of the line; 
CAN (^X) or NAK (^U) will erase the entire line. CR commits the command.

USING XMODEM                                                            

The following section provides examples of using Xmodem commands.

To send the MacDraw document Picture from the Macintosh to the R1000
as the binary file Data_Flow_Diagram:

    1) Enter the command:
    
          Xmodem> rx Data_Flow_Diagram 
          
       Note: fully qualified path names may be used here, such as
       !.users.jsb.data_flow_diagram
          
    2) Select the command Send File - XMODEM... in the file menu
    
    3) Enter the name Picture in the file dialog and commit the dialog
    
    4) Transfer will proceed automatically 
    
    5) Enter three ^D at the remote host to close the R1000 file
    
To send the binary file Data_Flow_Diagram from the R1000 to the remote host, to
be saved in the document Temporary:

    1) Enter the command:
    
           Xmodem> sx Data_Flow_Diagram
            
    2) Select the command Receive File - XMODEM... in the File menu
    
    3) Enter the name Temporary in the file dialog and commit the dialog.
    
    4) Transfer will proceed automatically
    
To send the text only document Foo_Bar from the remote host to the
R1000 to be saved in the file Document:

    1) Enter the command:
        
           Xmodem> rt Document
           
    2) Select the command Send File - XMODEM... in the file menu
    
    3) Enter the name Foo_Bar in the file dialog and commit the dialog
    
    4) Transfer will proceed automatically
    
    5) Enter three ^D at the remote host to close the R1000 file
    
To send the body of the procedure Login from the R1000 to the remote host
as a text file, to be saved in the document Login_Body:

    1) Enter the command:
    
           Xmodem> st !.users.jsb.login'body
           
    2) Select the command Send File - XMODEM... in the file menu
    
    3) Enter the name Login_Body in the file dialog and commit the dialog
    
    4) Transfer will proceed automatically
    
To set your R1000 context to the directory !.users.egb.components:

    1) Enter the command:
    
           Xmodem> cd !.users.egb.components
           
    2) Xmodem will acknowledge connection to this new directory
    
To display the R1000 file User_Guide as text on the remote host:

    1) Enter the command:
    
           Xmodem> ty User_Guide
           
    2) The document will be listed on the remote host. Note: beware of
       using this command for binary files - it may produce unexpected and
       undesirable behavior in the remote host. This command may be
       used to display Ada units on the R1000 as well as text files.
       
To list the contents of the current context:

    1) Enter the command:
    
           Xmodem> vd
           
    2) Xmodem will respond with a directory listing. Note: any wildcard
       defined in the Rational Environment Reference Manual, Workspace
       Management, may be used.
       
To display a list of all Xmodem commands:

    1) Enter the command:
    
           Xmodem> ?
           
    2) Xmodem will respond with a list of commands and their meaning
DataMuseum.dk

Rational R1000/400 Tapes

⟦f7aa59ff0⟧ TextFile

Derivation

TextFile
