Changeset 418

Timestamp:

Nov 24, 2019, 10:17:36 PM (5 years ago)

Author:

g7moreau

Message:

• Began doc in POD format

File:

• trunk/tssh/tssh (modified) (1 diff)

trunk/tssh/tssh

@@ -341 +341 @@
 # Clean temporary folder
 [ -d "/tmp/${base_path}" ] && rm -rf "/tmp/${base_path}"
+
+
+exit
+
+
+################################################################
+# Documentation in POD format (like Perl)
+################################################################
+
+=head1 NAME
+
+tssh - tmux cluster ssh
+
+=head1 SYNOPSIS
+
+ tssh [-w number] [-f] [-v] [-p] [-c remote_cmd] [-o ssh_option] <host1> <host2> <clusterssh class>... <hostM>- <hostN>+
+
+=head1 OPTIONS
+
+=over
+
+=item C<-w number>      windows to open (integer, default 16)
+
+=item C<-o ssh_option>  option to pass to ssh
+
+=item C<-f>             fast, no nmap scan to eliminate sleeping computer
+
+=item C<-v>             verbose
+
+=item C<-c remote_cmd>  launch the remote command on hosts and exit
+
+=item C<-p>             launch in parallel (only with option C<-c>) with command parallel or xargs
+
+=item  C<-h>             help
+
+=back
+
+=head1 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 C<host>, C<login@host>, C<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 C<tmux> is C<Ctrl^b>.
+You can switch from broadcast to a local machine with C<Ctrl^b Ctrl^b>
+and move between machine with C<Ctrl^b ArrowKey>.
+
+=head1 DEPENDS
+
+On Debian, you need the package
+
+ apt-get install tmux ncurses-bin wamerican nmap
+
+C<wamerican> (or C<wfrench>...) is used to choose a random word in the file F</usr/share/dict/words>
+for each new tmux session.
+
+C<ncurses-bin> is required for the C<tput> command
+to automatically split your terminal into several small panels.
+C<nmap> is only used for dynamic DNS domain and dynamic scan.
+This is not mandatory for general use.
+
+By default, C<tssh> use C<tput> to know the number of columns and lines of your terminal.
+It takes 10 lines and 40 columns for each windows by default.
+If C<tput> is not installed, the default is 16 windows...
+
+=head1 CONFIGURATION
+
+The clusterssh config file F<~/.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 C<tssh> config file (F<~/.tsshrc>) can be use change the default parameters.
+
+ #export split_number=16
+ export dyn_domain='mycompagny.local'
+ #export ssh_option=''
+ #export fast='yes'
+ #export verbose='yes'
+
+=head1 SEE ALSO
+
+cluster-ssh, cssh, xargs, parallel, tmux
+
+=head1 AUTHORS
+
+Written by Gabriel Moreau, Grenoble - France
+
+=head1 COPYRIGHT
+
+Copyright (C) 2014-2019, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
+Licence : GNU GPL version 2 or later