Category : C Source Code
Archive   : V_RB_SB.ZIP
Filename : VRBSB.DOC

RRRRBBBB((((1111)))) XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((OO



NNNNAAAAMMMMEEEE
rb - X/YMODEM batch file receive

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
rrbb [ --11bbqquuvv ]

rrbb [ --11bbccqquuvv ] _f_i_l_e

[[--]][[vv]]rrbbCCOOMMMMAANNDD

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
RRbb uses the XMODEM and YMODEM error correcting protocols to
receive files over a serial port from a variety of programs
running under PC-DOS, CP/M, *nix, and other operating
systems.

The first form of rrbb (Receive Batch) receives files with
YMODEM batch protocol. Rb accepts either standard 128 byte
sectors or 1024 byte sectors (YAM kk option). The user
should determine experimentally the conditions under which
use of 1k blocks actually improves throughput without
causing problems.

Normally, the file contents are converted to Unix
conventions by stripping carriage returns and all characters
beginning with Control Z (CP/M end of file). If the raw
pathname ends in ".A", ".ARC", ".CCC", ".CL", ".CMD",
".COM", ".CRL", ".DAT", ".DIR", ".EXE", ".O", ".OBJ",
".OVL", ".PAG", ".REL", ".SAV", ".SUB", ".SWP", ".SYS",
".TAR", ".UTL", ".a", ".o", ".tar", or if the first packet
contains data that suggest a binary file (parity bits or
characters in the range 000 to 006 before the first ^Z), or
if the file mode is transmitted and the 0100000 (most
significant) bit is set, that file will be received in
binary mode anyway. Otherwise, if the raw pathname ends in
.MSG, or .TXT, an existing file will be appended to rather
than replaced.

If extended file information (file length, etc.) is
received, the file length controls the number of bytes
written to the output dataset, and the modify time and file
mode (iff non zero) are set accordingly.

If no extended file information is received, slashes in the
pathname are changed to underscore, and any trailing period
in the pathname is eliminated. Normally, each file name is
converted to lower case unless it contains one or more lower
case letters.

If rb is invoked with stdout and stderr to different
datasets, Verbose is set to 2, causing frame by frame
progress reports to stderr. This may be disabled with the qq



Page 1 (printed 1/27/86)






RRRRBBBB((((1111)))) XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((OO



option.

The second form of rrbb receives a single _f_i_l_e with XMODEM
protocol. The user must supply the file name to both
sending and receiving programs.

In the third form, rrbb is invoked as rrbbCCOOMMMMAANNDD (with an
optional leading - as generated by login(1)). For each
received file, rb will pipe the file to ``COMMAND filename''
where filename is the name of the transmitted file with the
file contents as standard input.

The file transfer is completed when COMMAND exits with 0
status. A non zero exit status terminates the transfer.

A typical use for this form is _r_b_r_m_a_i_l which calls rmail(1)
to post mail to the user specified by the transmitted file
name. For example, sending the file "caf" from a PC-DOS
system to _r_b_r_m_a_i_l on a Unix system would result in the
contents of the DOS file "caf" being mailed to user "caf".

On some Unix systems, the login directory must contain a
link to COMMAND as login sets SHELL=rsh which disallows
absolute pathnames. If invoked with a leading ``v'' rb will
report progress to LOGFILE. The following entry works for
Unix 3.0:
rbrmail::5:1::/bin:/usr/local/rbrmail
If the SHELL environment variable includes _r_s_h or _r_k_s_h

(restricted shell), rb will not accept absolute pathnames or
references to a parent directory, will not modify an
existing file, and removes any files received in error.


The meanings of the available options are:

11 Use file descriptor 1 for ioctls and reads (Unix only).
By default, file descriptor 0 is used. This option
allows rrbb to be used with the _c_u ~$ command.
bb Transfer all files in binary (tell it like it is) mode.
This option disables file append.
cc Request 16 bit CRC (single file transfers default to 8
bit checksum).
qq Quiet suppresses verbosity.
vv _V_e_r_b_o_s_e causes a list of file names to be appended to
/tmp/rblog . More v's generate more output.
uu Retain upper case letters in file names
unconditionally.

EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS






Page 2 (printed 1/27/86)






RRRRBBBB((((1111)))) XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((OO



( Unix command)
$ _r_b
rb: ready C
(Pro-YAM command)
<_A_L_T-_2>
YAM Command: _s_b *._h *._c

SSSSEEEEEEEE AAAALLLLSSSSOOOO
YMODEM.DOC, IMP(CP/M), cu(1), Professional-YAM manual,
sb(omen), usq(omen), undos(omen)

Compile time options required for various operating systems
are described in the rbsb.c source file.

BBBBUUUUGGGGSSSS
Pathnames are restricted to 127 characters. In XMODEM
single file mode, the pathname given on the command line is
still processed as described above. The CR/LF to NL
translation merely deletes CR's; undos(omen) performs a more
intelligent translation.

VVVVMMMMSSSS VVVVEEEERRRRSSSSIIIIOOOONNNN
Some of the #includes with file names enclosed with angle
brackets <> may need to have the angle brackets changed to
"", or vice versa.

The VMS version does not set binary mode according to the
incoming file type. Non binary file processing consists of
stripping all characters beginning with CPMEOF (^Z).

The VMS version does not set the file time.

VMS sometimes loses incoming characters, resulting in
retries and degradation of throughput.

The VMS C standard i/o package and RMS sometimes interact to
modify file contents unexpectedly.

The VMS version does not support invocation as rrbbCCOOMMMMAANNDD ..
















Page 3 (printed 1/27/86)






SSSSBBBB((((1111)))) XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((OO



NNNNAAAAMMMMEEEE
sb - X/YMODEM Batch file Send

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
ssbb [ --11ddffkkqquuvv ] _f_i_l_e ...
ssbb --XX [ --11kkqquuvv ] _f_i_l_e

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
SSbb uses the XMODEM and YMODEM error correcting protocols to
send files over a serial port to a variety of programs
running under PC-DOS, CP/M, *nix, and other operating
systems.

The first form of ssbb sends one or more files with YMODEM
batch protocol. Normally, only the file name part of the
pathname is transmitted. On Unix systems, additional
information about the file is transmitted. If the receiving
program uses this information, the transmitted file length
controls the exact number of bytes written to the output
dataset, and the modify time and file mode are set
accordingly.

The second form of ssbb uses the --XX flag to send a single _f_i_l_e
with XMODEM protocol. The user must supply the file name to
both sending and receiving programs.

If sb is invoked with stdout and stderr to different
datasets, Verbose is set to 2, causing frame by frame
progress reports to stderr. This may be disabled with the qq
option.

Iff sb is invoked with $SHELL set and iff that variable
contains the string _r_s_h or _r_k_s_h (restricted shell), sb
operates in restricted mode. Restricted mode restricts
pathnames to the current directory and PUBDIR
(conventionally, /usr/spool/uucppublic) and/or
subdirectories thereof.

Unix ssbb supports YMODEM-g with "cbreak" tty mode, XON/XOFF
flow control, and the interrupt character set to CAN.
YMODEM-g (Pro-YAM gg option) increases throughput over error
free channels (direct connection, X.PC, etc.) by not
acknowledging each transmitted sector.

The meanings of the available options are:

11 Use file descriptor 1 for ioctls and reads (Unix only).
By default, file descriptor 0 is used. This option
allows ssbb to be used with the _c_u ^$ command.
XX (XMODEM protocol) Send a single file without the
filename packet.
dd Change all instances of "." to "/" in the transmitted



Page 1 (printed 1/27/86)






SSSSBBBB((((1111)))) XXXXEEEENNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((OO



pathname. Thus, C.omenB0000 (which is unacceptable to
MSDOS or CP/M) is transmitted as C/omenB0000. If the
resultant filename has more than 8 characters in the
stem, a "." in inserted to allow a total of eleven.
ff Send Full pathnname. Normally directory prefices are
stripped from the transmitted filename.
kk Send files using 1024 byte blocks rather than the
default 128 byte blocks. 1024 byte packets speed file
transfers at high bit rates.
qq Quiet suppresses verbosity.
uu Unlink the file after successful transmission.
vv _V_e_r_b_o_s_e causes a list of file names to be appended to
/tmp/sblog . More v's generate more output.

EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
(Unix command)
$ _s_b -_k *._c
(Pro-YAM command)
<_F_3>
(8-bit YAM Commands)
^_E
>>>c: _r_t

SSSSEEEEEEEE AAAALLLLSSSSOOOO
rb(omen), YMODEM.DOC, Professional-YAM manual, IMP(CP/M),
cu(1), sq(omen), todos(omen), tocpm(omen), tomac(omen)

Compile time options required for various operating systems
are described in the rbsb.c source file.

BBBBUUUUGGGGSSSS
On VMS, some of the #includes with file names enclosed with
angle brackets <> may need to have the angle brackets
removed, or vice versa.

The VMS version does not transmit the file date.

The VMS version does not recognize YMODEM-g.

The VMS version calculates the file length by reading the
file and counting the bytes.

When VMS is lightly loaded, the response time may be too
quick for MODEM7 unless the MODEM7 qq modifier is used.

The VMS C standard i/o package and RMS sometimes interact to
modify file contents unexpectedly.








Page 2 (printed 1/27/86)