Files transferred over shell protocol

"FI"les transferred over "SH"ell protocol is a protocol to use SSH or RSH to transfer files between computers and manage remote files.

The advantage of FISH is that all it requires on the server-side is an SSH or RSH implementation, Unix shell and a set of standard Unix utilities like ls, cat or dd. Optionally, there can be a special FISH server program (called "start_fish_server") on the server, which executes FISH commands instead of Unix shell and thus speeds up operations.

The protocol was designed by Pavel Machek in 1998 for Midnight Commander.

Protocol messages

Client sends text requests of the following form:

#FISH_COMMAND arguments... equivalent shell commands, which may be multi-line

Fish commands are all defined, shell equivalents may vary.Fish commands always have priority: the server is expected to execute a fish command if it understands it. If it does not, however, it can try and execute a shell command.When there is no special server program, Unix shell ignores the fish command as a comment and executes the equivalent shell command(s).

Server replies are multi-line, but always end with

### xyz

line. ### is a prefix to mark this line, xyz is the return code.Return codes are superset to those used in ftp.The codes 000 and 001 are special, their meaning depends on presence of server output before the end line.

ession initiation

The client initiates SSH or RSH connection with echo FISH:;/bin/sh as the command executed on remote machine. This should make it possible for the server to distinguish FISH connections from normal RSH or SSH.

The first two commands sent to the server are FISH and VER to negotiate FISH protocol, its version and extensions.

#FISH echo; start_fish_server; echo '### 200'

#VER 0.0.2 <...> echo '### 000'

The server may reply to VER command with a lines like VER 0.0.0 <...> ### 200which indicates supported version of the FISH protocol and supported extensions.

Implementations

*Midnight Commander
*Lftp
*fish:// KDE kioslave (with konqueror)

See also

* SSHFS

External links

* [http://cvs.savannah.gnu.org/viewcvs/mc/mc/vfs/README.fish?view=markup README.fish from Midnight Commander]
* [http://www.garni.ch/fish/ kio_fish page]
* [http://docs.kde.org/development/en/kdebase-runtime/kioslave/fish.html KDE documentation]
* [http://www.linux.org/lessons/short/fish/index.html Tutorial for the kioslave]