Changeset 197 for trunk/tssh

Timestamp:

Jan 25, 2018, 10:12:53 PM (7 years ago)

Author:

g7moreau

Message:

• Add some doc !

File:

• trunk/tssh/tssh (modified) (3 diffs)

trunk/tssh/tssh

@@ -18 +18 @@
 
 SYNOPSIS
-   $0 [-w number] [-f] [-v] <host1> <host2> <clusterssh class>... <hostM>- <hostN>+
+   $0 [-w number] [-f] [-v] [-c remote_cmd] <host1> <host2> <clusterssh class>... <hostM>- <hostN>+
 
 OPTIONS
-   -w  windows to open (integer, default 16)
-   -f  fast, no nmap scan to eliminate sleeping computer
-   -v  verbose
-   -h  help
+   -w             windows to open (integer, default 16)
+   -f             fast, no nmap scan to eliminate sleeping computer
+   -v             verbose
+   -c remote_cmd  launch the remote command on hosts and exit
+   -h             help
+
+DESCRIPTION
+   tssh can be use to launch terminal on many computer in parallel with tmux
+   multiplexer and ssh.
+   The tmux windows is splitted automatically.
+   If you need more computers on the same windows, you can zoom in and out
+   under gnome terminal with Ctrl- or Ctrl+.
+   This must be done before launching tssh.
+   
+   On the command line, you can put host, login@host, clusterssh class.
+   A host or a class can be remove from the list with a dash append
+   and force to be in this one with a plus append.
+   Example with the cluster ssh config below:
+   
+    tssh all team- node005 laptop04+
+
+   Is equivalent to:
+ 
+    tssh srv-mail srv-dns srv-imap srv-web srv-proxy \\
+      node001 node002 node003 node004 \\
+      node101 node102 node103 node104 \\
+      node005 laptop04
+
+   The control command for tmux is Ctrl^b.
+   You can switch from broadcast to a local machine with Ctrl^b Ctrl^b
+   and move between machine with Ctrl^b ArrowKey.
 
 DEPENDS
@@ -33 +60 @@
    wamerican (or wfrench...) is used to choose a random word in the file /usr/share/dict/words
    for each new tmux session.
+
    ncurses-bin is required for the tput command
    to automatically split your terminal into several small panels.
@@ -41 +69 @@
    It takes 10 lines and 40 columns for each windows by default.
    If tput is not installed, the default is 16 windows...
+
+CONFIGURATION
+   The clusterssh config file ~/.csshrc is a key values file.
+   The "clusters" is mandatory for clusterssh (not tssh) and define the other keys.
+   Values could be computer list or other key...
+   
+    clusters = all server s1 s2 s3 node n1 n2 team switch
+    all = server node team
+    server = s1 s2
+    node = n1 n2
+    s1 = srv-mail srv-dns srv-imap
+    s2 = srv-web srv-proxy
+    n1 = node001 node002 node003 node004
+    n2 = node101 node102 node103 node104
+    team = pc01 pc06 laptop04 laptop05 laptop09
+    switch = root@switch01 root@switch05 root@switch17
+
+   The tssh config file (~/.tsshrc) can be use change the default parameters.
+   
+    #export split_number=16
+    export dyn_domain='mycompagny.local'
+    #export fast='yes'
+    #export verbose='yes'
 
 AUTHOR