$Id: README,v 1.26 2000/06/06 20:44:32 imil Exp $

FastHuitre / RapideAsperged v0.3
================================

FastHuitre / RapideAsperged is a client / server application for quick
file transfer.
It has been written from scratch and uses a brand new free protocol.

This software is in its VERY EARLY STAGES. Don't expect it to have no bugs, don't use it on a productive machine, I won't be responsible for the damages FastHuitre can cause to your computer, your family, your dog or your girlfriend !
You've been warned.

. PlatForms
  ---------

FastHuitre has been successfully compiled and used on :

. NetBSD
. FreeBSD
. Linux
. OpenBSD

. Install
  -------

Required: automake / autoconf

./configure && make && make install

Note: this is a userspace program, maybe you should perform a :

./configure --prefix=/home/you/ && make && make install

Note2: For people having non-ansi terms, fasthuitre can be compiled with the following switch :

./configure --prefix=/home/you/ --disable-ansi-colors && make && make install

RPM binaries: http://okki.lefute.com/ ( thanks to Okki <crow@planete.net> )

. Usage
  -----

. Server :
  ------

Create configuration file $(prefix)/etc/rad.conf or /etc/rad.conf with the following format :

[myhome] # volume's name
pass="password" # a nice password or "none"
mode="rw" # rw for read / write access, ro for read only
comment="Nice comment"
path="/path/to/shared/directory"

[myftp]
mode="ro" # we don't put the password line, the same as pass="none"
comment="Leech here"
path="/usr/local/ftp"

the password line may contain a plain text password ( hey ! where I've told you about security ;) ), the word "none", or not spec. which means "no password".

The default values are (if not specified) :
pass="none"
mode="ro"
comment="No comment"
path="/tmp"

Then launch RapideAsperged with the following command :

$ rad

Configuration file  can be loaded from another path with the -f </where/is/rad.conf> switch
It can be run as a daemon with the -d switch, logs are then located on /var/log/rad.log.
Be sure rad can write to this log directory.
Listen port can be specified via a -p <port> switch, default is 2121.

Note: server rereads conf file at each connection, so changes can be made "on the fly" ;)

. Client :
  ------

$ fh -n <host> -s
Lists the shared volumes on <host>

$ fh -n <host> -v volume:/some/where -l [-x password]
Performs a directory listing of /some/where on <host>'s shared volume

$ fh -n <host> -v volume -g tar.gz [-x password]
Retreives all files containing the string "tar.gz" on <host>'s shared volume 

$ fh -n <host> -v volume:/some/where -g *
Retreive recursively all files on /some/where

$ fh -n <host> -v volume:/some/where -u /home/you/good/arch
Uploads arch* to "volume:/some/where"

$ fh -n <host> -v volume:/some/where -u /home/you/good/stuff
Uploads recursively "/home/you/good/stuff" contents to "volume:/some/where"

If server has a password on a volume, add the -x password option.
Port can be specified via the -p <port> switch.
When adding the -o swith, client will retreive exact match.
-q enables "quiet mode". Mostly for frontends.

---

TODO :
----

. rad host automatic detection

---

That's all folks, much more to come ;)
Greets / Flames : imil@gcu-squad.org