help=>$self->loc("Enable debugging. Either a level can be provided or the option can be repeated multiple times. Maximum level is 4."),
default=>0,
);
$self->add_option(
spec=>'generate-pod',
hidden=>1,
);
$self->add_option(
spec=>'autoclose|K=i',
arg_desc=>'seconds',
help=>$self->loc('Number of seconds to wait before closing finished terminal windows.'),
);
$self->add_option(
spec=>'autoquit|q',
help=>$self->loc('Enable automatically quiting after the last client window has closed (overriding the config file). See also L<--no-autoquit>'),
);
$self->add_option(
spec=>'no-autoquit|Q',
help=>$self->loc('Disable automatically quiting after the last client window has closed (overriding the config file). See also L<--autoquit>'),
);
$self->add_option(
spec=>'evaluate|e=s',
arg_desc=>'[user@]<host>[:port]',
help=>$self->loc('Display and evaluate the terminal and connection arguments to display any potential errors. The <hostname> is required to aid the evaluation.'),
);
$self->add_option(
spec=>'config-file|C=s',
arg_desc=>'filename',
help=>$self->loc('Use supplied file as additional configuration file (see also L</"FILES">).'),
);
$self->add_option(
spec=>'cluster-file|c=s',
arg_desc=>'filename',
help=>$self->loc('Use supplied file as additional cluster file (see also L</"FILES">).'),
);
$self->add_option(
spec=>'tag-file|r=s',
arg_desc=>'filename',
help=>$self->loc('Use supplied file as additional tag file (see also L</"FILES">)'),
);
$self->add_option(
spec=>'font|f=s',
arg_desc=>'font',
help=>$self->loc('Specify the font to use in the terminal windows. Use standard X font notation such as "5x8".'),
);
$self->add_option(
spec=>'list|L',
help=>$self->loc('List available cluster tags.'),
);
$self->add_option(
spec=>'output-config|u',
help=>$self->loc('Output the current configuration in the same format used by the F<$HOME/.clusterssh/config> file.'),
);
$self->add_option(
spec=>'port|p=i',
arg_desc=>'port',
help=>$self->loc('Specify an alternate port for connections.'),
);
$self->add_option(
spec=>'show-history|s',
help=>$self->loc('IN BETA: Show history within console window. This code is still being worked upon, but may help some users.'),
);
$self->add_option(
spec=>'tile|g',
help=>$self->loc('Enable window tiling (overriding the config file). See also --no-tile.'),
);
$self->add_option(
spec=>'no-tile|G',
help=>$self->loc('Disable window tiling (overriding the config file). See also --tile.'),
);
$self->add_option(
spec=>'term-args|t=s',
help=>$self->loc('Specify arguments to be passed to terminals being used.'),
);
$self->add_option(
spec=>'title|T=s',
arg_desc=>'title',
help=>$self->loc('Specify the initial part of the title used in the console and client windows.'),
);
$self->add_option(
spec=>'unique-servers|m',
help=>$self->loc('Connect to each host only once.'),
);
$self->add_option(
spec=>'use-all-a-records|A',
help=>$self->loc('If a hostname resolves to multiple IP addresses, toggle whether or not to connect to all of them, or just the first one (see also config file entry).'),
);
$self->add_option(
spec=>'username|l=s',
arg_desc=>'username',
help=>$self->loc('Specify the default username to use for connections (if different from the currently logged in user). B<NOTE:> will be overridden by <user>@<host>.'),
help=>$self->loc('Specify arguments to be passed to ssh when making the connection. B<NOTE:> options for ssh should normally be put into the ssh configuration file; see C<ssh_config> and F<$HOME/.ssh/config> for more details.'),
output$self->loc(q{The command opens an administration console and an xterm to all specified hosts. Any text typed into the administration console is replicated to all windows. All windows may also be typed into directly.
output$self->loc('Please also see "KNOWN BUGS".');
output'=over';
output'=item *';
output$self->loc(q{The dotted line on any sub-menu is a tear-off, i.e. click on it and the sub-menu is turned into its own window.});
output'=item *';
output$self->loc(q{Unchecking a hostname on the Hosts sub-menu will unplug the host from the cluster control window, so any text typed into the console is not sent to that host. Re-selecting it will plug it back in.});
output'=item *';
output$self->loc(q{If your window manager menu bars are obscured by terminal windows see the C<screen_reserve_XXXXX> options in the [_1] file (see [_2]).},'F<$HOME/.clusterssh/config>','L</"FILES">');
output'=item *';
output$self->loc(q{If the terminals overlap too much see the C<terminal_reserve_XXXXX> options in the [_1] file (see [_2]).},'F<$HOME/.clusterssh/config>','L</"FILES">');
output'=item *';
output$self->loc(q{When using cssh on a large number of systems to connect back to a single system (e.g. you issue a command to the cluster to scp a file from a given location) and when these connections require authentication (i.e. you are going to authenticate with a password), the sshd daemon at that location may refuse connects after the number specified by MaxStartups in sshd_config is exceeded. (If this value is not set, it defaults to 10.) This is expected behavior; sshd uses this mechanism to prevent DoS attacks from unauthenticated sources. Please tune sshd_config and reload the SSH daemon, or consider using the [_1] mechanism for authentication if you encounter this problem.},'F<~/.ssh/authorized_keys>');
output'=item *';
output$self->loc(q{If client windows fail to open, try running:
output$self->loc('The following arguments are supported:');
output'=over';
output'=item [user@]<hostname>[:port] ...';
output$self->loc('Open an xterm to the given hostname and connect to the administration console. An optional port number can be used if sshd is not listening on the standard port (i.e., not listening on port 22) and ssh_config cannot be used.');
output$self->loc(q{Retile all the client windows.});
output'=back';
output'=head1 '.$self->loc('EXAMPLES');
output'=over';
output'=item ',$self->loc(q{Open up a session to 3 servers});
outputq{S<$ cssh server1 server2 server3>};
output'=item ',$self->loc(q{Open up a session to a cluster of servers identified by the tag 'farm1' and give the controlling window a specific title, where the cluster is defined in one of the default configuration files});
outputq{S<$ cssh -T 'Web Farm Cluster 1' farm1>};
output'=item ',$self->loc(q{Connect to different servers using different login names. NOTE: this can also be achieved by setting up appropriate options in the F<.ssh/config> file. Do not close cssh when the last terminal exits.});
output$self->loc(q{These files contain a list of tags to server names mappings. When any name is used on the command line it is checked to see if it is a tag. If it is a tag, then the tag is replaced with the list of servers. The format is as follows:});
output$self->loc(q{All comments (marked by a #) and blank lines are ignored. Tags may be nested, but be aware of using recursive tags as they are not checked for.});
output$self->loc(q{Extra cluster files may also be specified either as an option on the command line (see [_1]) or in the user's [_2] file (see [_3] configuration option).},'C<cluster-file>','F<$HOME/.clusterssh/config>','C<extra_cluster_file>');
output$self->loc('B<NOTE:> the last tag read overwrites any pre-existing tag of that name.');
output$self->loc('B<NOTE:> there is a special cluster tag called [_1] - any tags or hosts included within this tag will be automatically opened if no other tags are specified on the command line.','C<default>');
output$self->loc(q{Very similar to [_1] files but the definition is reversed. The format is:},'F<clusters>');
output'S<< <host> <tag> [...] >>';
output$self->loc(q{This allows one host to be specified as a member of a number of tags. This format can be clearer than using [_1] files.},'F<clusters>');
output$self->loc(q{Extra tag files may be specified either as an option (see [_1]) or within the user's [_2] file (see [_3] configuration option).},'C<tag-file>','F<$HOME/.clusterssh/config>','C<extra_tag_file>');
output$self->loc('B<NOTE:> All tags are added together');
output$self->loc(q{This file contains configuration overrides - the defaults are as marked. Default options are overwritten first by the global file, and then by the user file.});
output$self->loc('B<NOTE:> values for entries do not need to be quoted unless it is required for passing arguments, e.g.');
output$self->loc('Close terminal window after this many seconds. If set to 0 will instead wait on input from the user in each window before closing. See also [_1] and [_2]','L<--autoclose>','--no-autoclose');
output'=item auto_quit = yes';
output$self->loc('Automatically quit after the last client window closes. Set to anything other than "yes" to disable. See also [_1] and [_2]','L<--autoquit>','L<--no-autoquit>');
output'=item clusters = <blank>';
output$self->loc('Define a number of cluster tags in addition to (or to replace) tags defined in the [_1] file. The format is:','F<clusters>');
output(q{C<< clusters = <tag1> <tag2> <tag3> >>
C<<<tag1>=host1host2host3>>
C<<<tag2>=user@host4user@host5host6>>
C<<<tag3>=<tag1><tag2>>>});
output$self->loc('As with the [_1] file, be sure not to create recursively nested tags.','F<clusters>');
output'=item comms = ssh';
output$self->loc('Sets the default communication method (initially taken from the name of the program, but can be overridden here).');
output'=item console_position = <null>';
output$self->loc(q{Set the initial position of the console - if empty then let the window manager decide. Format is '+<x>+<y>', i.e. '+0+0' is top left hand corner of the screen, '+0-70' is bottom left hand side of screen (more or less).});
output'=item external_cluster_command = <null>';
output$self->loc(q{Define the full path to an external command that can be used to resolve tags to host names. This command can be written in any language. The script must accept a list of tags to resolve and output a list of hosts on a single line. Any tags that cannot be resolved should be returned unchanged.
output$self->loc(q{Define an extra cluster file in the format of [_1]. Multiple files can be specified, separated by commas. Both ~ and $HOME are acceptable as a reference to the user's home directory, e.g.},'F</etc/clusters>');
B<NOTE:>Any"generic"changetothemethod(e.g.,specifyingthesshporttouse)shouldbedoneinthemedium's own config file (see [_1] and [_2]).},'C<ssh_config>','F<$HOME/.ssh/config>');
output'=item screen_reserve_top = 0';
output'=item screen_reserve_bottom = 60';
output'=item screen_reserve_left = 0';
output'=item screen_reserve_right = 0';
output$self->loc(q{Number of pixels from the screen's side to reserve when calculating screen geometry for tiling. Setting this to something like 50 will help keep cssh from positioning windows over your window manager's menu bar if it draws one at that side of the screen.});
output'=item rsh = /path/to/rsh';
output'=item ssh = /path/to/ssh';
output$self->loc(q{Depending on the value of comms, set the path of the communication binary.});
output'=item terminal = /path/to/xterm';
output$self->loc(q{Path to the X-Windows terminal used for the client.});
output'=item terminal_args = <blank>';
output$self->loc(q{Arguments to use when opening terminal windows. Otherwise takes defaults from [_1] or [_2] file.},'F<$HOME/.Xdefaults>','F<$HOME/.Xresources>');
output'=item terminal_font = 6x13';
output$self->loc(q{Font to use in the terminal windows. Use standard X font notation.});
output'=item terminal_reserve_top = 5';
output'=item terminal_reserve_bottom = 0';
output'=item terminal_reserve_left = 5';
output'=item terminal_reserve_right = 0';
output$self->loc(q{Number of pixels from the terminal's side to reserve when calculating screen geometry for tiling. Setting these will help keep cssh from positioning windows over your scroll and title bars or otherwise overlapping the windows too much.});
output'=item terminal_colorize = 1';
output$self->loc(q{If set to 1 (the default), then "-bg" and "-fg" arguments will be added to the terminal invocation command-line. The terminal will be colored in a pseudo-random way based on the host name; while the color of a terminal is not easily predicted, it will always be the same color for a given host name. After a while, you will recognize hosts by their characteristic terminal color.});
output'=item terminal_bg_style = dark';
output$self->loc(q{If set to [_1], the terminal background will be set to black and the foreground to the pseudo-random color. If set to [_2], then the foreground will be black and the background the pseudo-random color. If terminal_colorize is [_3], then this option has no effect.},'C<dark>','C<light>','C<zero>');
output'=item terminal_size = 80x24';
output$self->loc(q{Initial size of terminals to use. NOTE: the number of lines (24) will be decreased when resizing terminals for tiling, not the number of characters (80).});
output'=item terminal_title_opt = -T';
output$self->loc(q{Option used with [_1] to set the title of the window},'C<terminal>');
output$self->loc(q{Option required by the terminal to allow XSendEvents to be received});
output'=item title = cssh';
output$self->loc(q{Title of windows to use for both the console and terminals.});
output'=item unmap_on_redraw = no';
output$self->loc(q{Tell Tk to use the UnmapWindow request before redrawing terminal windows. This defaults to "no" as it causes some problems with the FVWM window manager. If you are experiencing problems with redraws, you can set it to "yes" to allow the window to be unmapped before it is repositioned.});
output'=item use_all_a_records = no';
output$self->loc(q{If a hostname resolves to multiple IP addresses, set to [_1] to connect to all of them, not just the first one found.},'C<yes>');
output'=item use_hotkeys = yes';
output$self->loc(q{Setting to anything other than [_1] will disable all hotkeys.},'C<yes>');
output'=item user = $LOGNAME';
output$self->loc(q{Sets the default user for running commands on clients.});
output'=item window_tiling = yes';
output$self->loc(q{Perform window tiling (set to [_1] to disable)},'C<no>');
output'=item window_tiling_direction = right';
output$self->loc(q{Direction to tile windows, where [_1] means starting top left and moving right and then down, and anything else means starting bottom right and moving left and then up},'C<right>');
output'=back';
output$self->loc(q{B<NOTE:> The key shortcut modifiers must be in the form [_1], [_2] or [_3], e.g. with the first letter capitalised and the rest lower case. Keys may also be disabled individually by setting to the word [_4].},'C<Control>','C<Alt>','C<Shift>','C<null>');
outputq{=item F<$HOME/.csshrc_send_menu>};
output$self->loc(q{This (optional) file contains items to populate the send menu. The default entry could be written as:});
output'<send_menu>
<menutitle="Use Macros">
<toggle/>
<accelerator>ALT-p</accelerator>
</menu>
<menutitle="Remote Hostname">
<command>%s</command>
<accelerator>ALT-n</accelerator>
</menu>
<menutitle="Local Hostname">
<command>%s</command>
<accelerator>ALT-l</accelerator>
</menu>
<menutitle="Username">
<command>%u</command>
<accelerator>ALT-u</accelerator>
</menu>
<menutitle="Test Text">
<command>echo"ClusterSSHVersion:%v%n</command>
</menu>
</send_menu>';
output$self->loc(q{Submenus can also be specified as follows:});
output'<send_menu>
<menutitle="Default Entries">
<detach>yes</detach>
<menutitle="Hostname">
<command>%s</command>
<accelerator>ALT-n</accelerator>
</menu>
</menu>
</send_menu>';
output$self->loc(q{B<Caveats:>});
output'=over';
output'=item ',$self->loc(q{There is currently no strict format checking of this file.});
output'=item ',$self->loc(q{The format of the file may change in the future});
output'=item ',$self->loc(q{If the file exists, the default entry (Hostname) is not added});
output'=back';
output$self->loc(q{The following replacement macros are available (note: these can be changed in the configuration file):});
output'=over';
output'=item %s';
output$self->loc(q{Hostname part of the specific connection string to each client, minus any username or port});
output'=item %u';
output$self->loc(q{Username part of the connection string to each client});
output'=item %h';
output$self->loc(q{Hostname of server where cssh is being run from});
output'=item %n';
output$self->loc(q{C<RETURN> code});
output'=back';
output$self->loc(q{B<NOTE:> requires [_1] to be installed},'L<XML::Simple>');
output'=back';
output'=head1 ',$self->loc('KNOWN BUGS');
output$self->loc(q{If you have any ideas about how to fix the below bugs, please get in touch and/or provide a patch.});
output'=over';
output'=item *';
output$self->loc(q{Swapping virtual desktops can cause a redraw of all the terminal windows. This is due to a lack of distinction within Tk between switching desktops and minimising/maximising windows. Until Tk can tell the difference between the two events, there is no fix (apart from rewriting everything directly in X).});
output'=back';
output'=head1 ',$self->loc('REPORTING BUGS');
output'=over';
output'=item *';
output$self->loc(q{If you have issues running cssh, first try:
output$self->loc(q{Test the terminal window works with the options provided});
output'=item 2';
output$self->loc(q{Test ssh works to a host with the configured arguments});
output'=back';
output$self->loc(q{Configuration options to watch for in ssh are});
output'=over';
output'=item ',$self->loc(q{SSH doesn't understand [_1] - remove the option from the [_2] file},'C<-o ConnectTimeout=10>','F<$HOME/.clusterssh/config>');
output'=item ',$self->loc(q{OpenSSH-3.8 using untrusted ssh tunnels - use [_1] instead of [_2] or use [_3] in [_4] (if you change the default ssh options from [_5] to [_6])},'C<-Y>','C<-X>','C<ForwardX11Trusted yes>','F<$HOME/.ssh/ssh_config>','C<-x>','C<-X>');
output'=back';
output'=item *';
output$self->loc(q{If you require support, please run the following commands and post it on the web site in the support/problems forum:});
output$self->loc(q{Using the debug option (--debug) will turn on debugging output. Repeat the option to increase the amount of debug. However, if possible please only use this option with one host at a time, e.g. [_1] due to the amount of output produced (in both main and child windows).},'C<< cssh --debug <host> >>');
output$self->loc('A web site for comments, requests, bug reports and bug fixes/patches is available at: [_1]','L<http://clusterssh.sourceforge.net/>');
