@@ -1,3 +1,4 @@ pkg doc coverage +ri .gitignore @@ -2,7 +2,14 @@ require 'net/ssh' require 'net/sftp/session' module Net - + + # Net::SFTP is a pure-Ruby module for programmatically interacting with a + # remote host via the SFTP protocol (that's SFTP as in "Secure File Transfer + # Protocol" produced by the Secure Shell Working Group, not "Secure FTP" + # and certainly not "Simple FTP"). + # + # See Net::SFTP#start for an introduction to the library. Also, see + # Net::SFTP::Session for further documentation. module SFTP # A convenience method for starting a standalone SFTP session. It will # start up an SSH session using the given arguments (see the documentation lib/net/sftp.rb @@ -109,7 +109,7 @@ module Net; module SFTP # Net::SFTP::Operations::Download for a full discussion of hos this method can be # used. # - # download = sftp.downnload("/remote/path", "/local/path") + # download = sftp.download("/remote/path", "/local/path") # download.wait def download(remote, local, options={}, &block) Operations::Download.new(self, local, remote, options, &block) lib/net/sftp/session.rb ebf5d5380cc533b69b308baa2e396e4a18abc900 Jamis Buck jamis jamis@37signals.com http://github.com/jamis/net-sftp/commit/8a162edac058f9410cf17245afcab31f0bb265ba 8a162edac058f9410cf17245afcab31f0bb265ba 2008-03-13T21:08:55-07:00 2008-03-13T21:08:55-07:00 more documentation, to make the ri docs more useful 07c0052dead3765c1f3397d0b90973c5e143cc43 Jamis Buck jamis jamis@37signals.com