README.markdown in i2cssh-1.4.1 vs README.markdown in i2cssh-1.4.2

- old
+ new

@@ -21,39 +21,42 @@ -2, --iterm2 Use iTerm2 instead of iTerm -f, --file FILE Cluster file (one hostname per line) -c, --cluster CLUSTERNAME Name of the cluster specified in ~/.i2csshrc -m, --machines a,b,c Comma-separated list of hosts -For -c and -m options, the format username@cluster or username@host can be used. +For `-c` and `-m` options, the format `username@cluster` or `username@host` can be used. The following commands are exactly the same, however, they might serve different purposes: $ i2cssh -m user1@host1,user2@host2 $ i2cssh user1@host1 user2@host2 -Using the -l option will override all usernames: +Using the `-l` option will override all usernames: $ i2css -l foo user1@host1 user2@host2 -This will connect to both host1 and host2 as the user foo +This will connect to both `host1` and `host2` as the user `foo` ## i2csshrc -The i2csshrc file is a YAML formatted file that contains the following structure: +The `i2csshrc` file is a YAML formatted file that contains the following structure: --- - version: 2 # Mandatory. Current version is 2 - iterm2: false # Optional. Set to true if you use iTerm2.app instead of iTerm.app. - broadcast: false # Optional. Set to true if you want to enable broadcast for all clusters. - login: myusername # Optional. Always use this username. + version: 2 + [optional parameters] clusters: mycluster: - broadcast: false # Optional. Set to true if you want to enable broadcast for this cluster. - login: false # Optional. Set to true if you want a specific login for this cluster. + [optional parameters] hosts: - host1 - host2 - - ... + +Optional parameters can be used globablly 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 + iterm2: true # Use iTerm2.app instead of iTerm.app (only available globally) The following precedence is used: global options from config < cluster options from config < command line flags