summaryrefslogtreecommitdiffstats
path: root/doc/tdeioslave/fish/index.docbook
blob: c9231931988565a6e7b6e9377f5be7a8aaeb4007 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<article lang="&language;" id="fish">
<title>fish</title>

<articleinfo>
<authorgroup>
<author>&Joerg.Walter;</author>
<author>&Brad.Hards;</author>
<author>&tde-authors;</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<releaseinfo>&tde-release-version;</releaseinfo>
<date>Reviewed: &tde-release-date;</date>

<copyright>
<year>2005</year>
<holder>&Joerg.Walter;</holder>
<holder>&Brad.Hards;</holder>
</copyright>
<copyright>
<year>&tde-copyright-date;</year>
<holder>&tde-team;</holder>
</copyright>

<abstract>
<para>
This handbook describes the fish protocol.
</para>
</abstract>

<keywordset>
<keyword>TDE</keyword>
<keyword>fish</keyword>
<keyword>protocol</keyword>
</keywordset>

</articleinfo>

<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 command line tools.</para>

<para>You can use the fish tdeioslave like this:
<userinput>fish://<replaceable>hostname</replaceable></userinput> or <userinput>fish://<replaceable>username
</replaceable>@<replaceable>hostname</replaceable></userinput>.</para>

<note><para>You need to use double forward slashes.</para></note>

<para>You can omit the <replaceable>username</replaceable> (and the trailing
@ symbol) when using the same username on both computers.</para>

<para>You can add a password in the format:
<userinput>fish://<replaceable>username</replaceable>:<replaceable>password</replaceable>@<replaceable>
hostname</replaceable></userinput> but it is not necessary as you will be prompted for one if it is not
supplied.</para>

<para>When you are running the <acronym>SSH</acronym> daemon on a non-standard
port, you can specify that port using the normal &URL; syntax as shown below:
<userinput>fish://<replaceable>hostname</replaceable>:<replaceable>portnumber</replaceable></userinput>.</para>

<para>Fish should work with any roughly <acronym>POSIX</acronym> compatible
&UNIX; based remote computer. It uses the shell commands
<command>cat</command>, <command>chgrp</command>,
<command>chmod</command>, <command>chown</command>,
<command>cp</command>, <command>dd</command>,
<command>env</command>, <command>expr</command>,
<command>grep</command>, <command>ls</command>,
<command>mkdir</command>, <command>mv</command>,
<command>rm</command>, <command>rmdir</command>,
<command>sed</command>,
and <command>wc</command>. Fish starts
<command>/bin/sh</command> as its shell and expects it to be a
Bourne shell (or compatible, like <command>bash</command>).
If the <command>sed</command> and
<command>file</command> commands are available, as well as a
<filename>/etc/apache/magic</filename> file with &MIME; type
signatures, these will be used to guess &MIME; types.
</para>

<para>If <application>Perl</application> is available on the remote
machine, it will be used instead. Then only <command>env</command> and
<command>/bin/sh</command> are needed. Using
<application>Perl</application> has the additional benefit of being
faster.</para>

<para>Fish might even work on &Windows; machines, if tools like
<application>Cygwin</application> are installed. All the above
utilities must be in the system <envar>PATH</envar>, and the initial
shell must be able to process the command <command>echo
FISH:;/bin/sh</command> correctly.</para>

</article>