runssh 0.1.0 → 0.1.1

data/README.rdoc

@@ -2,7 +2,10 @@
 A CLI utility to bookmark ssh connections with hierarchy and act upon
 these bookmarks. Currently only opens a shell.
 
-For usage run _runssh_ without arguments.
+=== Installation
+You must have ruby[http://www.ruby-lang.org/] and
+rubygems[http://rubygems.org/] installed and then run:
+	gem install runssh
 
 === Bash Completion
 For bash completion I added a simple <tt>runssh_comp.sh</tt> file which completes
@@ -21,6 +24,39 @@ the following to your .zshrc file:
 This works for me, but I'm only starting with zsh so I hope it will work for you
 as well.
 
+== Usage
+For usage run _runssh_ without arguments.
+
+=== Host Definition
+Host definition is a collection of attributes that help us define a host
+bookmark. As of version 0.1.0 only _hostname_ and <i>remote user</i> are supported,
+but more attributes (e.g, tunnel definition) will be added on later versions.
+
+=== Bookmarks
+The bookmarks consists of a host definition inside nested groups. These
+groups could hold other groups or host definitions. Here is an example
+of bookmarks:
+
+    customer1:
+        location1:
+            host1
+            host2
+        location2:
+            host3
+            host4
+            sublocation:
+                host5
+    customer2:
+        office:
+            host1
+            ...
+
+You can decide to arrange your bookmarks by customers and/or location
+and/or internal/external addresses etc. To access a host definition you
+specify the full path to that host. In the above example to access _host2_
+(e.g, print it's definition) run:
+    runssh print customer1 location1 host2
+
 == requirements:
 (versions are specified in the gem definition in the Rakefile)
 
@@ -33,6 +69,12 @@ Development:
 == License
 This program is distributed under the GPL v2 license.
 
+== History
+
+[0.1.0]	Initial release. Simple bookmarks (host and user),
+        only _shell_ operation supported.
+[0.1.1] Improved docs.
+
 == TODO
 * Create a _proper_ zsh completion script.
 * Add scp capabilities

data/lib/runsshlib/cli.rb

@@ -67,11 +67,14 @@ module RunSSHLib
 Usage: runssh [global_options] COMMAND [options] <path>
 
 A utility to bookmark multiple ssh connections in heirarchial order.
+For a better understanding of host definitions and bookmarks, Read
+the provided README.rdoc or go to http://github.com/babysnakes/runssh.
 
 COMMAND : One of the commands mentioned below. It's possible to
           type only part of the command as long as it's not ambiguous.
-<path>  : A space separated list of names (e.g, one two three)
-          For available completions append " ?" to the end of path.
+<path>  : A space-separated list of names (e.g, one two three) that
+          leads to a host definition. For available completions
+          append " ?" to the end of path.
 
 Available commands:
   * shell  : Open ssh shell on remote host
@@ -134,7 +137,9 @@ EOS
           banner <<-EOS
 Usage: runssh [global_options] add [options] <path>
 
-Add a new host definition at the supplied <path>. <path> must not exit!
+Add a new host definition at the supplied <path>. <path> must not exist!
+A host definition can have a hostname (required) and a remote user
+(optional).
 
 <path> : See main help for description of path.
 

data/lib/runsshlib.rb

@@ -37,7 +37,7 @@ module RunSSHLib
   module Version
     MAJOR = 0
     MINOR = 1
-    BUILD = 0
+    BUILD = 1
 
     STRING = [MAJOR, MINOR, BUILD].compact.join('.')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: runssh
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Haim Ashkenazi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +02:00
+date: 2010-10-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency