runtime/doc/kioslave/fish.docbook

   1 <article lang="&language;" id="fish">
   2 <title>fish</title>
   3 <articleinfo>
   4 <authorgroup>
   5 <author>&Joerg.Walter; &Joerg.Walter.mail;</author>
   6 <author>&Brad.Hards; &Brad.Hards.mail;</author>
   7 <!-- TRANS:ROLES_OF_TRANSLATORS -->
   8 </authorgroup>
   9
  10 <date>2005-02-29</date>
  11 <releaseinfo>1.1.2</releaseinfo>
  12
  13 </articleinfo>
  14
  15 <para>Allows you to access another computer's files using the SEcure Shell (<acronym>SSH</acronym>) protocol.  The remote computer needs to be running the <acronym>SSH</acronym> daemon, but the remainder of the protocol uses standard commandline tools as discussed below.</para>
  16
  17 <para>You can use the fish kioslave like this:
  18 <userinput>fish://<replaceable>hostname</replaceable></userinput> or <userinput>fish://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput>.</para>
  19
  20 <note><para>You need to use double forward slashes.</para></note>
  21
  22 <para>You can omit the <replaceable>username</replaceable> (and the trailing
  23 @ symbol) if you have the same username on both computers.</para>
  24
  25 <para>You can add a password in the format:
  26 <userinput>fish://<replaceable>username</replaceable>:<replaceable>password</replaceable>@<replaceable>hostname</replaceable></userinput>
  27 but it is not necessary as you will be prompted for one if it is not
  28 supplied.</para>
  29
  30 <para>If you are running the <acronym>SSH</acronym> daemon on a non-standard
  31 port, you can specify that port using the normal &URL; syntax as shown
  32 below:
  33 <userinput>fish://<replaceable>hostname</replaceable>:<replaceable>portnumber</replaceable></userinput>.</para>
  34
  35 <para>Fish should work with any roughly <acronym>POSIX</acronym> compatible
  36 &UNIX; based remote computer. It uses the shell commands
  37 <command>cat</command>, <command>chgrp</command>,
  38 <command>chmod</command>, <command>chown</command>,
  39 <command>cp</command>, <command>dd</command>,
  40 <command>env</command>, <command>expr</command>,
  41 <command>grep</command>, <command>ls</command>,
  42 <command>mkdir</command>, <command>mv</command>,
  43 <command>rm</command>, <command>rmdir</command>,
  44 <command>sed</command>,
  45 and <command>wc</command>. Fish starts
  46 <command>/bin/sh</command> as its shell and expects it to be a
  47 Bourne shell (or compatible, like <command>bash</command>).
  48 If the <command>sed</command> and
  49 <command>file</command> commands are available, as well as a
  50 <filename>/etc/apache/magic</filename> file with &MIME; type
  51 signatures, these will be used to guess &MIME; types.
  52 </para>
  53
  54 <para>If <application>Perl</application> is available on the remote
  55 machine, it will be used instead. Then only <command>env</command> and
  56 <command>/bin/sh</command> are needed. Using
  57 <application>Perl</application> has the additional benefit of being
  58 faster.</para>
  59
  60 <para>Fish may even work on &Windows; machines, if tools like
  61 <application>Cygwin</application> are installed.  All the above
  62 utilities must be in the system <envar>PATH</envar>, and the initial
  63 shell must be able to process the command <command>echo
  64 FISH:;/bin/sh</command> correctly.</para>
  65
  66 </article>