runtime/doc/kioslave/fish/index.docbook

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