aboutsummaryrefslogtreecommitdiff
path: root/vendor/rsync_command/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/rsync_command/README.md')
-rw-r--r--vendor/rsync_command/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/vendor/rsync_command/README.md b/vendor/rsync_command/README.md
new file mode 100644
index 0000000..4b53a5c
--- /dev/null
+++ b/vendor/rsync_command/README.md
@@ -0,0 +1,25 @@
+RsyncCommand
+==================================
+
+The gem rsync_command provides a library wrapper around the rsync command line program, with additional support for parallel execution of rsync and configuration of OpenSSH options in the format understood by Capistrano (and Net::SSH).
+
+Installation
+------------------------------------
+
+ gem install rsync_command
+
+Usage
+------------------------------------
+
+ rsync = RsyncCommand.new(:logger => logger, :ssh => {:auth_methods => 'publickey'}, :flags => '-a')
+ source = '/source/path'
+ servers = ['red', 'green', 'blue']
+
+ rsync.asynchronously(servers) do |server|
+ dest = {:user => 'root', :host => server, :path => '/dest/path'}
+ rsync.exec(source, dest)
+ end
+
+ if rsync.failed?
+ puts rsync.failures.join
+ end \ No newline at end of file