README.markdown in i2cssh-1.12.0 vs README.markdown in i2cssh-1.13.0
- old
+ new
@@ -7,27 +7,30 @@
## Installing
$ gem install i2cssh
## Usage
- Usage: i2cssh [options] [(username@host [username@host] | username@cluster)]
+ Usage: i2cssh [options] [(username@host [username@host] | username@cluster)]
+ -c, --clusters clus1,clus2 Comma-separated list of clusters specified in ~/.i2csshrc
+ -m, --machines a,b,c Comma-separated list of hosts
+ -f, --file FILE Cluster file (one hostname per line)
+ -t, --tab-split Split servers/clusters into tabs (group arguments)
+ -T, --tab-split-nogroup Split servers/clusters into tabs (don't group arguments)
-A, --forward-agent Enable SSH agent forwarding
-l, --login LOGIN SSH login name
-e, --environment KEY=VAL Send environment vars (comma-separated list, need to start with LC_)
+ -r, --rank Send LC_RANK with the host number as environment variable
-F, --fullscreen Make the window fullscreen
-C, --columns COLUMNS Number of columns (rows will be calculated)
-R, --rows ROWS Number of rows (columns will be calculated)
-b, --broadcast Start with broadcast input (DANGEROUS!)
-nb, --nobroadcast Disable broadcast
-p, --profile PROFILE Name of the iTerm2 profile (default: Default)
-2, --iterm2 Use iTerm2 instead of iTerm
-i, --itermname NAME Name of the application to use (default: iTerm)
- -f, --file FILE Cluster file (one hostname per line)
- -c, --cluster CLUSTERNAME Name of the cluster specified in ~/.i2csshrc
- -r, --rank Send LC_RANK with the host number as environment variable
- -m, --machines a,b,c Comma-separated list of hosts
-s, --sleep SLEEP Number of seconds to sleep between creating SSH sessions
+ -d, --direction DIRECTION Direction that new sessions are created (default: column)
-X, --extra EXTRA_PARAM Additional ssh parameters (e.g. -Xi=myidentity.pem)
i2cssh will assume you want to connect to a cluster when only one host is given.
For `-c` and `-m` options, the format `username@cluster` or `username@host` can be used.
@@ -35,10 +38,14 @@
The following commands are exactly the same, however, they might serve different purposes:
$ i2cssh -m user1@host1,user2@host2
$ i2cssh user1@host1 user2@host2
+You can combine these options and use them multiple times:
+
+ $ i2cssh -m user1@host1,user2@host2 -m user3@host3 user4@host4 user5@host5
+
Using the `-l` option will override all usernames:
$ i2cssh -l foo user1@host1 user2@host2
This will connect to both `host1` and `host2` as the user `foo`
@@ -55,11 +62,11 @@
[optional parameters]
hosts:
- host1
- host2
-Optional parameters can be used globablly or per cluster and include:
+Optional parameters can be used globally or per cluster and include:
broadcast: (true/false) # Enable/disable broadcast on start
login: <username> # Use this username for login
profile: <iTerm2 profile> # Use this iTerm profile
rank: (true/false) # Enable sending LC_RANK as an environment variable
@@ -131,20 +138,30 @@
### -f, --file
Will read nodes from a file. These will be added to any hosts specified on the command line or in the config
-### -c, --cluster
+### -c, --clusters clus1,clus2
-Connect to a cluster that is specified in the config
+Connect to one or more clusters that are specified in the config
### -r, --rank
Send a LC_RANK environment variable different for each host (from 0 to n)
### -m, --machines a,b,c
Connect to the machines a, b and c
+
+### -t, --tab-split
+
+Split servers/clusters into tabs, grouping arguments.
+Tabs are created as follows: hosts after a -m option are put in one tab, each cluster is always in its own tab, all the arguments are in one tab.
+
+### -T, --tab-split-nogroup
+
+Split servers/clusters into tabs, *not* grouping arguments.
+Tabs are created as follows: hosts after a -m option are put in one tab, each cluster is always in its own tab, each argument is in its own tab.
### -s, --sleep SLEEP
Wait SLEEP seconds between starting each ssh session. This will take decimals as well (0.5 for half a second)