home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / softos.zip / READ.ME < prev    next >
Text File  |  1994-01-17  |  21KB  |  522 lines

  1.  
  2.  
  3.  
  4.                           Softerm Modular Plus
  5.                   Communications and Terminal Emulation
  6.  
  7.  
  8.  
  9.                      READ.ME - Documentation Supplement
  10.                              August 9, 1993
  11.  
  12.      To obtain a hard copy of this document, you may want to type, 
  13.  
  14.           COPY READ.ME LPT1
  15.  
  16.      Or you can view it using the OS/2 system editor.
  17.  
  18.      Contents:
  19.  
  20.      I.   Install Procedure
  21.      II.   Changes to Softerm Modular
  22.           -  Close Appended Capture (new option)
  23.           -  Profile data base not created automatically
  24.           -  "If File Exists" now supports Zmodem (see also topic 8)
  25.           -  Auto-detect ZModem and CompuServe B+ protocols
  26.           -  Mark/Copy -> Transmit to host feature
  27.           -  Hot Spots on the monitor
  28.           -  Hide option when downloading
  29.           -  New Paste option
  30.  
  31.     III. Printing to a Network Printer
  32.  
  33.      IV. Nationality Profile Character Representations
  34.  
  35.       V. Softrans File Transfer Protocol Source Code
  36.  
  37.      VI. Zmodem File Transfer Protocol
  38.  
  39.     VII. CompuServe B+ File Transfer Protocol
  40.  
  41.  
  42.  
  43.       I.  Installing Softerm Modular Plus
  44.       Run Setup program to create Softerm Plus Group and Program Entries
  45.       or follow these steps:
  46.             1.  Create a new group entitled "Softerm Plus".
  47.             2.  Create a new program within that group giving the 
  48.                 OS/2 Presentation Manager the full path and program 
  49.                 name to SOFTERM.EXE. 
  50.           And that's it.  In the SOFTERM.MDB file, you can go in and
  51.           add or delete any dial sessions that you like.   Double click
  52.           on it with the mouse, and you are set.
  53.  
  54.       If you would like to create a Softerm Icon that Starts a specifyed
  55.       Session, for example an Icon that will start Softerm Plus and
  56.       connects to Compuserve;
  57.       Create a new program with in the Softerm Plus Group giving the
  58.       full path and program name followed by the Session Name and "/p";
  59.  
  60.         C:\SOFTERM\SOFTERM.EXE  "CompuServe"/p
  61.  
  62.       If the Session Profile is in a different Database file than the
  63.       default, (Last Database file opened), then add the database file
  64.       name to the command line arguments;
  65.  
  66.         C:\SOFTERM\SOFTERM.EXE  MYDATABS.MDB "CompuServe"/p
  67.  
  68.           
  69.      II.  Changes to Softerm Modular
  70.           --------------------------
  71.           Please make a note of the following changes in the manual:
  72.  
  73.           1.   Page RF.9 (Session Window: File Menu)
  74.                Please add the following information to Close Capture:
  75.  
  76.              a.  The cascading menu now appears similar to:
  77.  
  78.                  ┌────────────────────────┐
  79.                  │ Save Capture           │
  80.                  │ Discard Capture        │
  81.                  ├────────────────────────┤
  82.                  │ Close Appended Capture │
  83.                  └────────────────────────┘
  84.  
  85.              b.  Close Appended Capture
  86.                  If the Terminal Emulation printer definition option Append
  87.                  Disk Printer File On Close (p. PE.8) is enabled and
  88.                  printer data has been redirected to a disk file, use this
  89.                  option to permanently close the file.
  90.  
  91.                  Important:  A capture cannot be active when this option is
  92.                  used.
  93.  
  94.           2. Pages E.2 and E.3 (Appendix E: Startup Switches)
  95.              If the named profile data base does not exist, it will not be
  96.              created.
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.                 - 2 -
  104.  
  105.           3. Page RF.5 (Session Window: File Menu)
  106.              Please change the description of "If File Exists" to:
  107.              If a file with the name you have assigned already exists on
  108.              your PC, you can specify that you want to:
  109.              - Resume the transfer (if you are using Zmodem);
  110.              - Replace the existing file;
  111.              - Append the received data to the end of the existing file,
  112.                or;
  113.              - Stop the file transfer.
  114.  
  115.           4.  Auto-detect ZModem and CompuServe B+ Protocols.  
  116.               These download protocols will start receiving a file 
  117.               automatically when you are downloading.  You no longer
  118.               need to go in and start the download manually.
  119.               The program is set up so that you can enable/disable the 
  120.               autodownload session by changing it under the Settings
  121.               menu, selecting Terminal Emulation, and Auto Download.
  122.               Under the Dialog box for Auto Download, you can set your
  123.               default download path, and set your options for "If file
  124.               exists....".
  125.  
  126.           5.  Mark/Copy -> Transmit to host feature
  127.               Now you can mark a section of text using your mouse and
  128.               transmit it to the host.  If it is a single character, 
  129.               like 'x', double click on it.  That will send it.  If it
  130.               is a block of text, mark it off with the mouse, click on
  131.               the EDIT menu, and select transmit to host.  The block
  132.               will be received at the other end of the connection.  
  133.               This is defined under Settings, System Environment, and then
  134.               select Edit Action Options.  From there you can set up how
  135.               you want the transmission to be formatted, and where you 
  136.               want it to go.
  137.  
  138.           6.  Hot Spots on the monitor
  139.               If you are on a service that asks you to press (Enter) to
  140.               continue, all you have to do is double click on a blank
  141.               area of the screen.  That will send a carriage return to
  142.               the other end.  It will also send entire words, finding the
  143.               beginning and the end of the word.  By double clicking on
  144.               that word, it will transmit it to the host or to clipboard,
  145.               dependant upon how it is configured.  It can also  transmit
  146.               an entire page of text, by highlighting it with the mouse,
  147.               then clicking somewhere inside of that block, and it will
  148.               be transmitted.  Refer to item #5 for defining the settings
  149.               for this option.
  150.  
  151.           7.  Hide option when downloading
  152.               There is a button that you can select in the download 
  153.               screen that will minimize your session while you are 
  154.               downloading and maintain the download.
  155.  
  156.                 - 3 -
  157.           
  158.           8.  New Paste option
  159.               You can now cut & paste from outside files, using Shift-
  160.               Delete, Ctrl-Insert, and Shift-Insert keys.  As well as
  161.               the Edit menu.  This item is defined with the EDIT menu.
  162.               This will work *only* for TEXT.
  163.  
  164.     III.  Printing to a Network Printer
  165.           -----------------------------
  166.  
  167.           Softerm fully supports rerouting LPT1, LPT2 and LPT3 to network
  168.           printers, but does not monitor the status of the printers.
  169.           Serial printing is supported only on local ports unless the
  170.           vendor's network software supports such cases.
  171.  
  172.  
  173.      IV.  Nationality Profile Character Representations
  174.           ---------------------------------------------
  175.  
  176.           If you use the Nationality Profile to remap incoming or outgoing
  177.           characters, you may see character descriptions which appear
  178.           similar to:
  179.  
  180.                Character      Description         Hexadecimal
  181.                [VT]           NOTE:See READ.ME    0BH
  182.  
  183.           These characters cannot be displayed within the menu system.
  184.           Locate the Hexadecimal value in the following list to see how the
  185.           character is translated:
  186.  
  187.           Hex       Character      Description
  188.  
  189.           001H           ─         Single Line Horizontal
  190.           002H           │         Single Line Vertical
  191.           003H           ┌         Single Line Upper Left Corner
  192.           004H           ┐         Single Line Upper Right Corner
  193.           005H           └         Single Line Lower Left Corner
  194.           006H           ┘         Single Line Lower Right Corner
  195.           007H           ┼         Single Line Cross
  196.           008H           ├         Single Line Junction Left
  197.           009H           ┤         Single Line Junction Right
  198.           00AH           ┬         Single Line Junction Top
  199.           00BH           ┴         Single Line Junction Bottom
  200.           00CH           ═         Double Line Horizontal
  201.           00DH           ║         Double Line Vertical
  202.           00EH           ╔         Double Line Upper Left Corner
  203.           00FH           ╦         Double Line Upper Right Corner
  204.           010H           ╚         Double Line Lower Left Corner
  205.           011H           ╝         Double Line Lower Right Corner
  206.           012H           ╬         Double Line Cross
  207.           013H           ╠         Double Line Junction Left
  208.           014H           ╣         Double Line Junction Right
  209.           015H           ╦         Double Line Junction Top
  210.           016H           ╩         Double Line Junction Bottom
  211.           017H           ▒         Communications Error Character
  212.           018H                     Up Arrow
  213.           019H                     Down Arrow
  214.           01AH                     Right Arrow
  215.           01BH                     Left Arrow
  216.  
  217.                 - 4 -
  218.           01CH           █         Solid Block
  219.           01DH           ▄         Solid Block, Lower Half
  220.           01EH           ▀         Solid Block, Upper Half
  221.           01FH           ■         Solid Middle Block
  222.           087H           ╒         Single To Double Upper Left Corner
  223.           088H           ╕         Single To Double Upper Right Corner
  224.           089H           ╙         Single To Double Lower Left Corner
  225.           08AH           ╜         Single To Double Lower Right Corner
  226.           08BH           ╪         Single To Double Cross
  227.           08CH           ╞         Single To Double Junction Left
  228.           08DH           ╡         Single To Double Junction Right
  229.           08EH           ╤         Single To Double Junction Top
  230.           08FH           ╧         Single To Double Junction Bottom
  231.           093H           ▌         Solid Block, Left Half
  232.           094H           ▐         Solid Block, Right Half
  233.           095H           ≥         Greater Than Or Equal To
  234.           096H           ≤         Less Than Or Equal To
  235.           097H           ╓         Double To Single Upper Left Corner
  236.           098H           ╖         Double To Single Upper Right Corner
  237.           099H           ╙         Double To Single Lower Left Corner
  238.           09AH           ╜         Double To Single Lower Right Corner
  239.           09BH           ╫         Double To Single Cross
  240.           09CH           ╟         Double To Single Junction Left
  241.           09DH           ╢         Double To Single Junction Right
  242.           09EH           ╥         Double To Single Junction Top
  243.           09FH           ╨         Double To Single Junction Bottom
  244.  
  245.  
  246.        V. Softrans File Transfer Protocol Source Code
  247.           -------------------------------------------
  248.  
  249.           Softrans, a file transfer protocol developed by Softronics, Inc.,
  250.           was designed to provide reliable file transmission over a wide
  251.           variety of asynchronous communications connections, including
  252.           switched packet networks and front end communications processors.
  253.           Full binary file transparency automatically is provided by the
  254.           protocol with no requirement for an 8-bit wide data path;
  255.           standard 7-bit ASCII characters only are used within a data
  256.           buffer.  In addition, no control characters (00 hex thru 1F hex)
  257.           occur within any Softrans block; the only control character used
  258.           is carriage return (0D hex) which is the End of Message (EOM)
  259.           character.
  260.  
  261.           Contact Softronic's sales for the Fortran 77 source code that
  262.           can be uploaded to your host system and compiled with the
  263.           appropriate Fortran compiler.
  264.  
  265.           Source code avalible for:
  266.  
  267.                Source for Unix systems
  268.                Source for VAX systems
  269.                Source for Data General systems
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.                 - 5 -
  279.  
  280.      VI. Zmodem File Transfer Protocol
  281.          -----------------------------
  282.  
  283.           The Zmodem protocol has been added to Softerm.  Please add the
  284.           following information:
  285.  
  286.           Page PX.15 (Profiles: File Transfer)
  287.           ------------------------------------
  288.  
  289.           Zmodem Protocol Parameters
  290.  
  291.             Retries
  292.             Specify the maximum retry count for error conditions.  Possible
  293.             error conditions include timeouts and block check errors.  If
  294.             an error condition occurs during a file transfer operation and
  295.             the Retries count is exhausted, a Line Failure message will be
  296.             displayed on your screen.  This parameter accepts values from 0
  297.             to 255.
  298.  
  299.             Transmit Packet Size
  300.             This parameter determines the number of bytes contained by each
  301.             packet of data. Set it to the size supported by the host (if
  302.             you know what it is) or to Auto.
  303.  
  304.             If set to Auto, the packet size is determined by the speed of
  305.             the connection.  The faster the speed, the larger will be the
  306.             packet size.
  307.  
  308.           Page B.12 (Appendix B: File Transfer Protocols)
  309.           -----------------------------------------------
  310.  
  311.           Zmodem Protocol
  312.  
  313.           Note:  Zmodem was developed for the public domain by Omen
  314.           Technology under a Telenet contract.  The Zmodem protocol
  315.           descriptions and the Unix rz/sz program source code are public
  316.           domain.  No licensing, trademark, or copyright restrictions apply
  317.           to the use of the protocol, the Unix rz/sz source code and the
  318.           Zmodem name.
  319.  
  320.           The Zmodem file transfer protocol provides reliable file
  321.           transfers with complete end-to-end data integrity between
  322.           application programs.  Zmodem uses either a 16-bit or a 32-bit
  323.           Cyclical Redundancy Check to detect errors.
  324.  
  325.           Zmodem accommodates network and timesharing system delays by
  326.           continuously transmitting data unless the receiver interrupts the
  327.           sender to request retransmission of garbled data.
  328.  
  329.           Softerm's implementation of Zmodem supports all functions except
  330.           fallback to Ymodem transfer.
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.                 - 6 -
  340.  
  341.           File Transfer Initiation
  342.  
  343.           When the Zmodem receive program starts, it immediately sends an
  344.           initiation header to start Zmodem file transfers, or a challenge
  345.           header to verify the sending program.
  346.  
  347.           The sender may send an optional intitialization frame to define
  348.           the receiving program's Attention sequence, or to specify
  349.           complete control character escaping.
  350.  
  351.           The sender sends a header with Zmodem Conversion, Management, and
  352.           Transport options followed by a data subpacket containing the
  353.           file name, file length, modification date, and other information
  354.           identical to that used by Ymodem Batch.
  355.  
  356.                The Zmodem Header
  357.  
  358.                The header contains a "frame type", four bytes of
  359.                supervisory information, and its own CRC.  Data frames
  360.                consist of a header followed by 1 or more data subpackets.
  361.                In the absence of transmission errors, an entire file can be
  362.                sent in one data frame.
  363.  
  364.                Frame File Information
  365.                Zmodem sends the same file information with the ZFILE frame
  366.                data that Ymodem Batch sends in its block 0.
  367.  
  368.                Pathname
  369.                The path name (conventionally, the file name) is sent as a
  370.                null terminated ASCII string.
  371.  
  372.                Length
  373.                The file length and each of the succeeding fields are
  374.                optional.  The length field is stored as an ASCII-coded
  375.                octal string counting the number of data bytes in the file.
  376.  
  377.                     The Zmodem receiver uses the file length as an estimate
  378.                     only.
  379.  
  380.                     It may be used to display an estimate of the
  381.                     transmission time, and may be compared with the amount
  382.                     of free disk space.  The  actual length of the received
  383.                     file is determined by the data  transfer.  A file may
  384.                     grow after transmission commences, and all the data
  385.                     will be sent.
  386.  
  387.                Modification Date
  388.                The modification date is an octal number giving the time the
  389.                contents of the file were last changed measured in seconds
  390.                from Jan. 1, 1970 Universal Coordinated Time (GMT).  A date
  391.                of 0 implies the modification date is unknown and should be
  392.                left as the date the file is received.
  393.  
  394.                File Mode
  395.                Unless the file originated from a Unix system, the file mode
  396.                is set to 0.
  397.  
  398.  
  399.  
  400.                 - 7 -
  401.  
  402.           The receiver examines the file name, length, and date information
  403.           provided by the sender in the context of the specified transfer
  404.           options, the current state of its file system(s), and local
  405.           security requirements.
  406.  
  407.           If the receiver has a file with the same name and length, it may
  408.           respond with a CRC header, which requires the sender to perform a
  409.           32-bit CRC on the file and transmit the complement of the CRC in
  410.           a header.  The receiver uses this information to determine
  411.           whether to accept the file or skip it.
  412.  
  413.           Error Recovery
  414.  
  415.           Normally the receiver specifies the data transfer to start at the
  416.           beginning of the file, but may start the transfer further down in
  417.           the file.  This allows a file transfer interrupted by a loss of
  418.           carrier or system crash to be completed on the next connection
  419.           without requiring the entire file to be retransmitted.  If
  420.           downloading a file from a timesharing system that becomes
  421.           sluggish, the transfer can be interrupted and resumed later with
  422.           no loss of data.
  423.  
  424.           Normal Session Ending
  425.  
  426.           When the sender receives the acknowledging header, it sends two
  427.           characters, "OO" (Over and Out) and exits to the operating system
  428.           or application that invoked it.  The receiver waits briefly for
  429.           the "O" characters, then exits whether they were received or not.
  430.  
  431.           Session Cancel Sequence
  432.  
  433.           If the receiver is receiving data in streaming mode, the
  434.           Attention sequence is executed to interrupt data transmission
  435.           before the Cancel sequence is sent.  The Cancel sequence consists
  436.           of eight CAN characters and ten backspace characters.  Zmodem
  437.           only requires five Cancel characters, the other three are
  438.           "insurance".
  439.  
  440.           The trailing backspace characters attempt to erase the effects of
  441.           the CAN characters if they are received by a command interpreter.
  442.  
  443.           For complete information about the Zmodem protocol, please
  444.           contact:
  445.  
  446.                                    Chuck Forsberg
  447.                                 Omen Technology Inc.
  448.                              17505-V Sauvie Island Road
  449.                                Portland, Oregon 97231
  450.                                  Phone: 503-621-3406
  451.                                  Modem: 503-621-3746
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.                 - 8 -
  462.  
  463.     VII. Compuserv B+ Transfer Protocol
  464.          ------------------------------
  465.  
  466.           The CompuServe B+ protocol has been added to Softerm.  You may 
  467.           now select the CompuServe B+ protocol for transfering files.  
  468.           This protocol will now appear on the selection list of available 
  469.           protocols and may be selected the same way the XMODEM or ZMODEM 
  470.           protocols are selected.
  471.  
  472.           Please add the following information:
  473.  
  474.           Page PX.15 (Profiles: File Transfer)
  475.           ------------------------------------
  476.  
  477.           CompuServe B+ Protocol Parameters
  478.  
  479.             Retries
  480.             Specify the maximum retry count for error conditions.  Possible
  481.             error conditions include timeouts and block check errors.  If
  482.             an error condition occurs during a file transfer operation and
  483.             the Retries count is exhausted, a Line Failure message will be
  484.             displayed on your screen.  This parameter accepts values from 0
  485.             to 255.
  486.  
  487.             Receive Acknowledgment Timeout
  488.             This parameter sets the number of seconds before a transfer
  489.             operation will cancel when an acknowledgement for data
  490.             transmitted to the host is expected to be received.  Valid values
  491.             are from 0 to 65535.
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.                 - 9 -