net-ssh.github.com/sftp/v2/api/files/README_rdoc.html at 5aeaa2d6dfb857c6de4d3f347aecaf5b70fefe47 · net-ssh/net-ssh.github.com · GitHub

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>File: README.rdoc</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;

    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }

  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )

  // ]]>
  </script>

</head>
<body>


  <div id="fileHeader">
    <h1>README.rdoc</h1>
    <table class="header-table">
    <tr class="top-aligned-row">
      <td><strong>Path:</strong></td>
      <td>README.rdoc
      </td>
    </tr>
    <tr class="top-aligned-row">
      <td><strong>Last Update:</strong></td>
      <td>Sat Mar 22 22:07:40 -0600 2008</td>
    </tr>
    </table>
  </div>
  <!-- banner header -->

  <div id="bodyContent">


  <div id="contextContent">

    <div id="description">
      <h1><a href="../classes/Net/SFTP.html">Net::SFTP</a></h1>
<ul>
<li><a href="https://net-ssh.github.io/sftp">net-ssh.github.io/sftp</a>

</li>
</ul>
<h2>DESCRIPTION:</h2>
<p>
<a href="../classes/Net/SFTP.html">Net::SFTP</a> is a pure-Ruby
implementation of the SFTP protocol (specifically, versions 1 through 6 of
the SFTP protocol). Note that this is the &quot;Secure File Transfer
Protocol&quot;, typically run over an SSH connection, and has nothing to do
with the FTP protocol.
</p>
<h2>FEATURES/PROBLEMS:</h2>
<ul>
<li>Transfer files or even entire directory trees to or from a remote host via
SFTP

</li>
<li>Completely supports all six protocol versions

</li>
<li>Asynchronous and synchronous operation

</li>
<li>Read and write files using an IO-like interface

</li>
</ul>
<h2>SYNOPSIS:</h2>
<p>
In a nutshell:
</p>
<pre>
  require 'net/sftp'

  Net::SFTP.start('host', 'username', :password =&gt; 'password') do |sftp|
    # upload a file or directory to the remote host
    sftp.upload!(&quot;/path/to/local&quot;, &quot;/path/to/remote&quot;)

    # download a file or directory from the remote host
    sftp.download!(&quot;/path/to/remote&quot;, &quot;/path/to/local&quot;)

    # grab data off the remote host directly to a buffer
    data = sftp.download!(&quot;/path/to/remote&quot;)

    # open and write to a pseudo-IO for a remote file
    sftp.file.open(&quot;/path/to/remote&quot;, &quot;w&quot;) do |f|
      f.puts &quot;Hello, world!\n&quot;
    end

    # open and read from a pseudo-IO for a remote file
    sftp.file.open(&quot;/path/to/remote&quot;, &quot;r&quot;) do |f|
      puts f.gets
    end

    # create a directory
    sftp.mkdir! &quot;/path/to/directory&quot;

    # list the entries in a directory
    sftp.dir.foreach(&quot;/path/to/directory&quot;) do |entry|
      puts entry.longname
    end
  end
</pre>
<p>
For the full documentation, start with <a
href="../classes/Net/SFTP/Session.html">Net::SFTP::Session</a>. Also see <a
href="../classes/Net/SFTP/Operations/Upload.html">Net::SFTP::Operations::Upload</a>,
<a
href="../classes/Net/SFTP/Operations/Download.html">Net::SFTP::Operations::Download</a>,
<a
href="../classes/Net/SFTP/Operations/FileFactory.html">Net::SFTP::Operations::FileFactory</a>,
<a
href="../classes/Net/SFTP/Operations/File.html">Net::SFTP::Operations::File</a>,
and <a
href="../classes/Net/SFTP/Operations/Dir.html">Net::SFTP::Operations::Dir</a>.
</p>
<h2>REQUIREMENTS:</h2>
<ul>
<li><a href="../classes/Net/SSH.html">Net::SSH</a> 2

</li>
</ul>
<p>
If you wish to run the tests, you&#8216;ll need:
</p>
<ul>
<li>Echoe (if you want to use the Rakefile)

</li>
<li>Mocha

</li>
</ul>
<h2>INSTALL:</h2>
<ul>
<li>gem install net-sftp (might need sudo privileges)

</li>
</ul>
<p>
Or, if you prefer to do it the hard way (sans Rubygems):
</p>
<ul>
<li>tar xzf net-ssh-*.tgz

</li>
<li>cd net-ssh-*

</li>
<li>ruby setup.rb config

</li>
<li>ruby setup.rb install (might need sudo privileges)

</li>
</ul>
<h2>LICENSE:</h2>
<p>
(The MIT License)
</p>
<p>
Copyright (c) 2008 Jamis Buck
</p>
<p>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
&#8216;Software&#8217;), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the
following conditions:
</p>
<p>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</p>
<p>
THE SOFTWARE IS PROVIDED &#8216;AS IS&#8217;, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
</p>

    </div>


   </div>


  </div>


    <!-- if includes -->

    <div id="section">


    <!-- if method_list -->


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>