diff options
| author | delano <delano@solutious.com> | 2011-04-30 20:48:02 -0400 |
|---|---|---|
| committer | delano <delano@solutious.com> | 2011-04-30 20:48:02 -0400 |
| commit | 07a9b7935d094c9d9b1aca258802f565196c8d17 (patch) | |
| tree | 0c2d6d20bd7306ad95c6e6cbf4c7a11cadb518be | |
| parent | 29485b8ccf7c6a9b9afa9d2d7f41b8ec0875be0f (diff) | |
| download | net-ssh-gateway-07a9b7935d094c9d9b1aca258802f565196c8d17.tar.gz | |
Added note to README
| -rw-r--r-- | README.rdoc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/README.rdoc b/README.rdoc index ddedbf3..755c4c4 100644 --- a/README.rdoc +++ b/README.rdoc @@ -4,7 +4,7 @@ == DESCRIPTION: -Net::SSH::Gateway is a library for programmatically tunneling connections to servers via a single "gateway" host. It is useful for establishing Net::SSH connections to servers behind firewalls, but can also be used to forward ports and establish connections of other types, like HTTP, to servers with restricted access. +Net::SSH::Gateway is a library for programmatically tunnelling connections to servers via a single "gateway" host. It is useful for establishing Net::SSH connections to servers behind firewalls, but can also be used to forward ports and establish connections of other types, like HTTP, to servers with restricted access. == FEATURES: @@ -28,7 +28,11 @@ In a nutshell: end gateway.shutdown! - + + # As of 1.1.0, you can also specify the wait time for the + # gateway thread with the :loop_wait option. + gateway = Net::SSH::Gateway.new('host', 'user', :loop_wait => 0.001) + See Net::SSH::Gateway for more documentation. == REQUIREMENTS: |