FZDSXFER.DOC
======== ===

                         FreeZe Dried Software Protocols
                         ------ ----- -------- ---------

                           Program and Documentation 
           Copyright 1991-1992 Sean Price and Aaron Hopkins of FzDS
                              All Rights Reserved.

            Summary of commands for FreeZe Dried Software Protocols,
                              Beta-Test version .34

    This program is in its development and testing stages.  We will be adding 
more protocols and increasing the efficiency and thoroughput of this program. 
After it is perfected, it will become an internal part of the FreeZe Dried 
Terminal and possibly UNet and UBBS/III.  If you find a problem with it, 
please report it to the authors.  If you don't, the problem may reoccur in 
later versions of this and other programs which use it.  By releasing this 
Beta-test version, we are asking you the user to test it out for us in all 
possible situations and let us know if it doesn't meet your standards so we 
may improve it.

DISCLAIMER:  This program has been thoroughly tested and it is hoped that it 
             contains no errors.  But, the authors will accept no 
             responsibility for any damages caused by this program.  There 
             are no warranties, whether written or implied regarding the use 
             of this program.  You use it at your own risk!


How To Reach Us:
--- -- ----- --

Any problems, comments, or suggestions regarding FZDSXFER.TTP may be sent to 
the authors in the following ways:

a) Leave a post or feedback to the sysops on:
     Sanctuary From The Law BBS (619) 377-3611  300-19.2k HST  8/N/1
     The main support board for all FreeZe Dried Software Products
b) E-Mail S.PRICE19 on GEnie
c) Send mail to:
                        Aaron Hopkins
                        RE: FreeZe Dried Protocols
                        1213 Walnut Avenue
                        Manhattan Beach, CA  90266

If you have specifications (Book Reference, Text File, etc.) on Z-Modem, Puma,
Lynx, Super 8K, K9XModem, etc. protocols, or feel that you can help in any 
way with this project, please drop us a note.  We plan on addressing any 
shortcomings in this program, along with adding every conceivable protocol 
possible.  If you would like to see a certain protocol which we haven't 
listed, let us know.


Rules For Use:
----- --- ---

By now I'm sure you've read the standard shareware plea a thousand times, so 
I will not bother to repeat it again for your enjoyment.  If you like this 
program and use it regularly, all we ask is that you send in a $10 donation 
to the above address.  We can't force you to, as this works on the honor 
system.  (It is not necessary for registered users of FzDSTerm or UBBS to 
send in this donation; you have already done your part, enjoy!)

If you have FzP installed in a BBS system as an external protocol, we ask 
that you mention "FreeZe Dried Dried Software Protocols" somewhere in an 
"information about this BBS" type of bulletin along with the above address, 
for further information.  We also would hope that you make an archived copy 
of this documentation and the program available to your ST users, so they may 
use it also.

This software may be distributed freely as long at it includes this 
documentation, and is not "sold" to anyone except to pay for the price of the 
media and shipping prices.  Upload this everywhere!


Command Line Structure:
------- ---- ---------

FreeZe Dried Software Protocols currently supports Xmodem CRC, Xmodem 1K,
Ymodem Batch, Ymodem-G Batch, and Fmodem Batch.  The commands are passed by 
way of a command line when executed by being typed at a .TTP dialog or passed 
by a shell.  The following deals with the structure of the parameters being 
passed on the command line:

FzDS Protocols defaults to receive mode.  All commands must be seperated by 
a space.  FzP accepts wild cards as filenames for batch modes.  If a wildcard 
is used in a single file mode, FzDS Protocols will use the first matching 
file.  Filenames can include a path.


Format:  (Options in brackets are optional.)
-X/-K/-Y/-G/-F {-S -C -D -Ix -Ox} {x:\path\} {{x:\path\}file.ext ...}
^-Must have one  ^-Switches are optional. They can be in any order,
  and only one     or not included at all.  "x"s are parameters.
  command.

A path without a filename will reset the default receive/send path in FzP. 
Anywhere in the program where a filename exists without a path, this default 
path will be added to it.  When receiving a file using a batch protocol, the 
file will be put in this path.

At least one filename must be included for ALL sends.  If sending using Batch 
protocols, more than one file may be included.

X-Modem is the only protocol that requires a filename for a receive. 
Filenames will be ignored when receiving using batch protocols.


Commands:
--------

-X filename.ext
   Send using Xmodem CRC/Receive using Xmodem CRC or Xmodem 1K (Automatically
   detects block size to use.)
   Example:-X -S D:\SCUM\TEST.LZH 
           Sends D:\SCUM\TEST.LZH using Xmodem CRC
 
-K filename.ext
   Send using Xmodem 1K (Not needed for Receive because -X automatically
   detects block size.)
   Example:-K -S TEST.LZH
           Sends TEST.LZH using Xmodem 1K

-Y {filename.ext ...}
   Send/Receive using Ymodem Batch
   Example:-Y -S TEST.LZH TEST2.LZH
           Sends TEST.LZH and TEST2.LZH using Ymodem Batch

   Example:-Y D:\SCUM\
           Receives using Ymodem Batch.  All received files will be put
           in the D:\SCUM\ directory.

   Example:-Y -S *.LZH
           Sends all files matching *.LZH using Ymodem Batch

-G {filename.ext ...}
   Send/Receive using Ymodem-G Batch
   Example:-G -S TEST.LZH TEST2.LZH
           Sends TEST.LZH and TEST2.LZH using Ymodem-G Batch

   Example:-G
           Receives using Ymodem-G Batch

   Example:-G -S *.LZH
           Sends all files matching *.LZH using Ymodem-G Batch

-F {filename.ext ...}
   Send/Receive using Fmodem Batch
   Example:-F -S TEST.LZH TEST2.LZH
           Sends TEST.LZH and TEST2.LZH using Fmodem Batch

   Example:-F
           Receives using Fmodem Batch

   Example:-F -S *.LZH
           Sends all files matching *.LZH using Fmodem Batch


Switches:
--------

-S 
   Send mode (upload).  Without this switch, FzP will default to receive 
   mode (download).

-C 
   Turn on Carrier Detect.  If the carrier detect drops during any portion 
   of a transmission, FzP will abort and exit.

-D 
   Delete incompletely transferred files while in receive mode.

-N 
   Overwrites a file if one currently exists with that name.  Otherwise, the 
   transfer is aborted.

-Ofilename.ext 
   Creates a text file with the given filename and stores the names of
   successfully transferred files in it.  Filename must be immediately after
   the -O.  (This is used to return a list of files back to the calling 
   program.)
   Example:-Y -OGOT.TXT
           Receives using Ymodem Batch and stores the filenames of all
           successfully received files in GOT.TXT

-Ifilename.ext 
   For batch modes only.  Protocol looks for text file with the given 
   filename, and attempts to send all files contained in it.  Filenames may 
   or may not include a path, and may use wildcards.  Only the first 100 
   matching files are sent.
   Example:-Y -ISEND.TXT
           Sends all files listed in SEND.TXT using Ymodem Batch. 

