ftp.barnyard.co.uk/2015.02.ftp.barnyard.co.uk.tar/ftp.barnyard.co.uk/cpm/walnut-creek-CDROM/ENTERPRS/CPM/UTILS/F/R95-40.ZIP/R95.TXT

Text File | 1992-01-25 | 22KB | 546 lines

R95


Binary to Data Text Conversion Utility


Version 4.0

(PC and PC Compatibles)



Greg Jones -- WD5IVD





SHAREWARE Distributed by:

Texas Packet Radio Society, Inc.
P.O. Box 50238
Denton, Texas    76206-0238







NOTE:
This software is provided as shareware to non-commercial amateur radio
users.  Commercial inquiries should be made to Greg Jones at the TPRS
address.


copyright 1992 Greg Jones



TABLE OF CONTENTS
======================================================================

     * R95 License
     * Warranty
     * Shareware
     * Bug Reports / Correspondence
     * Introduction
     * Radix 95 version 4.0
          R95 In-Line Commands
          R95 Menu & Example Usage
     * Radix 95 Functions
          Encode
          Decode
          Split
          Combine
          Bundle
          Unbundle
     * Potential Problems
     * Split Size Recommendation
     * Registration Information








R95 License
======================================================================

All version of R95, including version 4.0, are not public domain
software packages, nor are they free software.  R95 is copyright 1992
Greg Jones and is distributed by the Texas Packet Radio Society, Inc.

Copies of R95 may be freely copied and distributed under the following
conditions:

  * R95.ZIP must be copied in unmodified form, complete with
    the file containing the documentation.

  * R95 may not be distributed with any other product.

  * Operators of electronic bulletin board system (Sysops)
    may post R95 for downloading by their users only if the
    above conditions are met.

  * Distributors or public domain or user supported software
    may distribute copies of R95 subject to the above
    conditions only after obtaining written permission from
    Greg Jones.  Such permission is typically granted;
    please write for details.

Non-amateur inquires should be made to Greg Jones at the TPRS address.



Warranty
======================================================================

Texas Packet Radio Society makes no warranty of any kind, express or
implied, including without limitation, any warranties and/or fitness
for a particular purpose of this software.  Texas Packet Radio Society
shall not be liable for any damages, whether direct, indirect, special
or consequential arising from a failure of this software to operate in
the manner desired by the user.  Texas Packet Radio Society shall not
be liable for any damage to data or property that may be caused
directly or indirectly by using the software.

IN NO EVENT WILL TEXAS PACKET RADIO SOCIETY BE LIABLE FOR ANY
INCIDENTAL OR CONSEQUENTIAL DAMAGE ARISING OUT OF USE OR INABILITY TO
USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.



Shareware
======================================================================

R95 is distributed by the Texas Packet Radio Society as SHAREWARE to
the amateur radio community.  Commercial interest should contact Greg
Jones at the TPRS address.

If you like R95, please send $15 to Texas Packet Radio Society.  In
return you will receive the printed manual containing:

    Printed R95 Manual (Full Version)

    R95 source in Pascal

    Radix 95 - Binary to Text Data Conversion for Packet Radio Paper

    TPRS General Information


All money goes toward supporting research projects in the Texas Packet
Radio Society.




Bug Reports / Correspondence
======================================================================

Please send bug reports and correspondence to:

     Texas Packet Radio Society
     ATTN: R95
     P.O. Box 50238
     Denton, Texas
     76206-0238




Introduction
======================================================================

Why R95?  There are several reasons:

* The transfer of binary files across the amateur network is
  not guaranteed.  Although many binary transfer methods
  exist today on packet radio, only ASCII data is guaranteed
  to arrive in the same form as it originated.  Eventually
  the amateur network will support transparent binary
  transfer, but currently if you wish to send a file
  anywhere in the world using packet radio, R95 might be
  your best bet.

* Packet operators understand how their TNC works in
  converse mode, so why not make it possible to transfer
  binary file using the converse mode.

* R95 generates less overhead than most common conversion
  programs (18% - 20%) overhead.  This is due to the
  variable length encoding scheme that R95 employs.

* R95 may also be used in many other applications besides
  amateur packet radio file transfer.  Many networks use
  conversion programs to convert their files for transfer,
  so R95 could be very useful.


As a final note, I hope that this is a useful utility for
the amateur packet community at large and computer users in
general.


73 - Greg Jones, WD5IVD



Radix 95 version 4.0
============================================================

R95 supports two modes:

1. If only 'R95' is typed from the DOS command prompt, then
   the user will be presented with the R95 user interface.
   This will be detailed below.

2. The user also has a choice of in-line options to use
   with R95.  For help with in-line commands, enter 'R95 h'.


R95 In-Line Commands:
----------------------------------------------------------------------
Encode    R95 E InputFileName [Replace Y/N] [OutputFilePath]
Decode    R95 D InputFileName [Replace Y/N] [OutputFilePath]
Split     R95 S InputFileName [K-Size]      [OutputFilePath]
Combine   R95 C InputFileName [Replace Y/N] [OutputFilePath]
Bundle    R95 B InputFileName [Replace Y/N] [OutputFilePath]
Unbundle  R95 U InputFileName [Replace Y/N] [OutputFilePath]

where InputFileName is the name of file to be processed
              (may include drive and/or path name), and
   OutPutFilePath is , ** OPTIONAL **, the drive and/or
                           path name for output file(s)

   -- DO NOT INCLUDE FILE NAME or \ at end.
   If omitted, current path will be used.

Note: DO NOT INCLUDE FILE NAME or a '\' on the output path.
----------------------------------------------------------------------

Radix 95 will ask any necessary questions concerning files.

Example:
  R95 E TEST.ZIP
    This would encode the file called TEST.ZIP.
    Called TEST.R95.

    If TEST.R95 exists, R95 will ask if you want to replace
    it or not.  To force TEST.R95 to be overwritten we could
    have issued:
        R95 E TEST.ZIP Y

    To have it written TEST.R95 at the root, enter:
        R95 E TEST.ZIP Y c:



R95 Menu & Example Usage
------------------------------------------------------------

By entering the command R95 from the DOS prompt, you should see the
main R95 screen displayed.

+====================================================================+
|             Radix 95 (version 4.0 for PC/PC Compatible)            |
|                                  by                                |
|                          Greg Jones - WD5IVD                       |
|                                                                    |
|                      SHAREWARE Distributed by :                    |
|Texas Packet Radio Society - P.O. Box 50238 - Denton, Texas - 76206 |
+====================================================================+
|Info  Encode  Decode  Split  Combine  Bundle  Unbundle  !-DOS  Quit |
+====================================================================+


Commands can be selected by :
    1. Select the command using arrow keys and then press ENTER
    2. Press the first character of the command
    3. Select the command using a mouse.
           R95 version 4.0 has mouse support.


If ENTER is pressed while 'Info' is highlighted, you would then see:

++================== Texas Packet Radio Society ====================++
||                                                                  ||
||                R95 (version 4.0 for PC and PC Compatibles)       ||
||                    Copyright 1992 Greg Jones (WD5IVD)            ||
||                                                                  ||
||                             SHAREWARE  $15.00                    ||
||                                                                  ||
+| Radix 95 is a Binary to Text Data Conversion algorithm. For more |+
|| info regarding Radix 95 refer to the ARRL 7th Annual Network     ||
+| Conference, 1988 'RADIX 95 - Binary to Text Data Conversion      |+
 | for Packet Radio' Greg Jones, WD5IVD and Gerald Knezek, KB5EWV   |
 |                                                                  |
 | This utility implements the R95 encode/decode scheme. The utility|
 | implements modified text file split and combine functions for    |
 | sectioning R95 files as recommended in the paper.                |
 |                                                                  |
 | R95 is distributed by TPRS (Texas Packet Radio Society) and is   |
 | SHAREWARE.  If you use this program send $15 to the TPRS address |
 | Registered users will receive a printed R95 user's manual, the   |
 | RADIX 95 conference paper, and source.                           |
 |                                                                  |
 |                                                                  |
 | Texas Packet Radio Society  P.O. Box 50238 Denton, Texas  76206  |
 |                                                                  |
 +===================== PgDn -or- Esc to Exit ======================+



To start an ENCODE, select ENCODE and then press ENTER.


+====================================================================+
|             Radix 95 (version 4.0 for PC/PC Compatible)            |
|                                  by                                |
|                          Greg Jones - WD5IVD                       |
|                                                                    |
|                      SHAREWARE Distributed by :                    |
|Texas Packet Radio Society - P.O. Box 50238 - Denton, Texas - 76206 |
+====================================================================+
|Info  Encode  Decode  Split  Combine  Bundle  Unbundle  !-DOS  Quit |
+====================================================================+

+========================== R95 - ENCODE ============================+
|                                                                    |
| STATUS : [ Encode : Enter File Name ]                              |
|                                                                    |
| Enter file name to ENCODE :                                        |
| [C:\GREG\R95\*.*                                               ]   |
|                                                                    |
+====================================================================+
| Enter file name with directory to      'Enter' to accept entry.    |
| ENCODE -or- enter directory and        'Esc' to exit to main menu. |
| wildcard pattern to display a          'Backspace' to edit entry.  |
| directory matching the wildcard pattern.                           |
+====================================================================+


The bottom half of the screen is partitioned into two halves.  The top
half is where R95 will ask for user input.  Since we selected the
ENCODE function, it is now asking the user to select a path or the
file name to be selected for encoding.


The bottom half is the help area.  R95 will display help and
information for each user input screen.  As the Encode help section
shows, the user could either enter the full path and name for the file
to be encoded or select a path and wildcard for the file find screen
to use.




If we press ENTER to accept 'C:\GREG\R95\*.*', R95 will then display
the file find window at the top of the screen.

+=+======================= C:\GREG\R95\*.* =========================++
| | ..\           scr1.pix       scr3.pix       scr5.pix            ||
| | r95.exe       scr2.pix       scr4.pix                           ||
|+==================================================================+|
|                                                                    |
|                      SHAREWARE Distributed by :                    |
|Texas Packet Radio Society - P.O. Box 50238 - Denton, Texas - 76206 |
+====================================================================+
|Info  Encode  Decode  Split  Combine  Bundle  Unbundle  !-DOS  Quit |
+====================================================================+

+========================== R95 - ENCODE ============================+
|                                                                    |
| STATUS : [ ENCODE : Directory Lookup ]                             |
|                                                                    |
|                                                                    |
|                                                                    |
|                                                                    |
+====================================================================+
| Use cursor to select file to ENCODE.     'Enter' to accept entry.  |
| Select '..\' to display parent directory 'Esc' to exit to main menu|
| Select DIR\ to display sub-directory.     Use cursor keys to move. |
| Enter filename to go directly to file.                             |
+====================================================================+


The file selection area provides a simple directory file interface for
the user to traverse the file structure and select files.  Use the
ARROW keys and press ENTER or use the mouse to select files.  For
large directories, type in the first few characters of the file name,
and the selection bar will move to the nearest matching file name.
Selecting the '..\' will move to the parent directory.  The interface
will not allow changing to a different drive, so the drive must be
specified during the file selection stage (see step above - i.e.
'Enter file name to ENCODE :' D:\*.*).



After a file is selected R95 will then ask for an output directory
path.

+========================== R95 - ENCODE ============================+
|                                                                    |
| STATUS : [ Encode : Enter Output Directory ]                       |
|                                                                    |
| Enter directory path to save ENCODE of "SCR2.PIX" to :             |
| [C:\GREG\R95                                                 ]     |
|                                                                    |
+====================================================================+
|  Enter directory path to save          'Enter' to accept entry.    |
|  ENCODE file to.                       'Esc' to exit to main menu. |
|                                        'Backspace' to edit entry.  |
|                                                                    |
+====================================================================+


This is only the output path, the file created will be the name with
the extension of 'R95'.

At this point R95 will encode the file.

+========================== R95 - ENCODE ============================+
|                                                                    |
| STATUS : [ Encoding        ]                                       |
|                                                                    |
| 0% ----------- 25% ----------- 50% ----------- 75% ---------- 100% |
| ###############################################                    |
|                                                                    |
+====================================================================+
|                                                                    |


This is just one short example of how R95 is used.  The other R95
functions behave in a similar fashion.


Radix 95 Functions
======================================================================

ENCODE
------
  The Encode function is used to take a file and create a R95 encoded
format file.  R95 encoded files use the '.R95' file extension.  A
character count check is placed in the R95 ending line.


DECODE
------
  The Decode function is used to read in a R95 encoded file and covert
it back into the original file.  Decode will read the first 100 lines
to find the R95 header line.  If EOF or the header is not found, R95
will abort the operation.  This allows additional information to be
ignored that might have beeen captured during a download.  Decode will
check the character count contained at the end of the R95 file for
accuracy.


SPLIT
------
  The Split function is used to take a R95 file or an ordinary text
file and create n-K (K=1024 Bytes) length files.  This function is
used to create smaller file segments for transfer through multiple BBS
systems or networks.  The Split file uses a numbered extension
beginning with .001, which incremented for each file.  The numbered
extension is used during the Combine function.  The extension must
later match the number used in the R95 Split header.


COMBINE
-------
  The Combine function reads multiple Split files and recreates the
original R95 encoded file.  The numbered extension generated by the
Split function are used to decide file order when recombining.  The
extension must match the number in the R95 split header.


BUNDLE
------
  The Bundle function is used to read in multiple Split files and add
the necessary BBS information for BBS transfer.  The Bundle function
also generate one file with the extension of '.B95'.  This file can
then be sent at once to a BBS (with proper flow control) or submitted
to the BBS directly as a file locally.


UNBUNDLE
--------
  The Unbundle function is used to read a file that contains multiple
Split files and then extract each Split file to its own file with
correct name and extension.  This allows the user to capture multiple
Split files at once without having to open a file for each Split file.



POTENTIAL PROBLEMS
======================================================================

Potential problems when sending R95 files in converse mode on a TNC
center on flow control and the STREAMSW command.  If STREAMSW is set
to any printable ASCII character, R95 will have a problem.  Since R95
uses the full range of printable ASCII characters, chances are that it
will generate a printable STREAMSW character.  When this occurs, two
characters will be lost.  The first will be the STREAMSW character and
second one will be the channel designation.  Depending on your TNC,
this might generate the error that a bad channel number has been
specified.  The solution is to change the STREAMSW character to a non-
printable ASCII character.  Either TAB ($09) or NULL ($00) are good
choices.  You can always switch back after you have sent the R95 file.

The second problem is TNC buffer overflow.  Depending on how your
computer talks to the TNC, you might feed the data too fast for the
TNC to handle, thus losing whole lines of characters.  The solution is
to slow the information dump to the TNC from the computer, or set-up
correct flow control between the TNC and the computer.


SPLIT SIZE RECOMMENDATION
======================================================================

The reason that R95 includes the SPLIT function is to allow a large
R95 file to be broken into smaller data segments.  The important thing
to remember is that the packet network is still a fragile environment
in places and when you want to transfer R95 files, you should attempt
to be as 'low-impact' as possible.  This means using ZIP or ARC on the
file before you encode the file with R95.  This gets the file as small
as possible before encoding.  If you know exactly what path a file
will take to get from one place to another, then the split size is
your choice.  Otherwise, refer to the following table for suggested
file sizes based on various sending methods.  If you don't know the
path to be used, take the smallest size split.  A choice of 2 or 3K is
typically a safe choice.


  Forwarding System                       Split Size
  --------------------------------        ----------------
  HF Forwarding                           3K or smaller
  TexNet PMS (Packet Message System)      7K Max.
  Single Channel Networks 1200 baud       5-10K



Registration Information
======================================================================

If you like R95, please send $15 to the Texas Packet Radio Society to
help support ongoing TPRS projects.  Registered users will receive a
full printed version of the R95 Manual, R95 source in Pascal, a copy
of the original 'Radix 95 - Binary to Text Data Conversion for Packet
Radio' Paper, TPRS General Information, and a big thanks from all the
folks at TPRS.


Send your registration money to:

    Texas Packet Radio Society, Inc.
    P.O. Box 50238
    Denton, Texas  76206-0238