public
Description: Pure Ruby implementation of an SFTP (protocols 1-6) client
Homepage: http://rubyforge.org/projects/net-ssh
Clone URL: git://github.com/jamis/net-sftp.git
Search Repo:
jamis (author)
Thu Mar 13 14:22:01 -0700 2008
commit  0324f7f649c41c496aacef82b086742a8d360e10
tree    39555c9546a1dee5b47f2ef01ed8979ddad01c25
parent  24b25f0b5d79369cc54f2f6291b2f64b01180e0c
name age message
folder .gitignore Thu Mar 13 14:08:58 -0700 2008 ignore the rcov coverage directory [jamis]
folder History.txt Wed Mar 05 07:45:13 -0800 2008 go hoe [jamis]
folder Manifest.txt Thu Mar 13 14:22:01 -0700 2008 updated Manifest with new test files [jamis]
folder README.txt Wed Mar 05 07:45:13 -0800 2008 go hoe [jamis]
folder Rakefile Wed Mar 05 07:45:13 -0800 2008 go hoe [jamis]
folder lib/ Thu Mar 13 14:09:13 -0700 2008 Add tests on the synchronous versions of the SF... [jamis]
folder setup.rb Wed Mar 05 07:45:13 -0800 2008 go hoe [jamis]
folder test/ Thu Mar 13 14:09:13 -0700 2008 Add tests on the synchronous versions of the SF... [jamis]
README.txt
= Net::SFTP

* http://net-ssh.rubyforge.org/sftp

== DESCRIPTION:

Net::SFTP is a pure-Ruby implementation of the SFTP protocol (specifically, versions 1 through 6 of the SFTP protocol). 
Note that this is the "Secure File Transfer Protocol", typically run over an SSH connection, and has nothing to do with 
the FTP protocol.

== FEATURES/PROBLEMS:

* Transfer files or even entire directory trees to or from a remote host via SFTP
* Completely supports all six protocol versions
* Asynchronous and synchronous operation
* Read and write files using an IO-like interface

== SYNOPSIS:

  require 'net/sftp'

  Net::SFTP.start('host', 'username', 'password') do |sftp|
    sftp.download!("/path/to/remote", "/path/to/local")
  end

== REQUIREMENTS:

* Net::SSH 2

If you wish to run the tests, you'll need:

* Hoe
* Mocha

== INSTALL:

* sudo gem install net-sftp

Or, if you prefer to do it the hard way (sans Rubygems):

* tar xzf net-ssh-*.tgz
* cd net-ssh-*
* ruby setup.rb config
* sudo ruby setup.rb install

== LICENSE:

(The MIT License)

Copyright (c) 2008 Jamis Buck <jamis@37signals.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), 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:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', 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.