Bugfix pod problems and wording

This commit is contained in:
Duncan Ferguson 2014-06-14 08:09:33 +01:00
parent e5c8272520
commit c7853ce73a

View file

@ -69,7 +69,7 @@ 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 ~/.ssh/authorized_keys mechanism for
daemon, or consider using the F<~/.ssh/authorized_keys> mechanism for
authentication if you encounter this problem.
=item *
@ -231,8 +231,8 @@ be used.
Open a series of xterms defined by <tag> in one of the supplementary
configuration files (see L</"FILES">).
Note: specifying a username on a cluster tag will override any usernames
defined in the cluster
B<Note:> specifying a username on a cluster tag will override any usernames
defined in the cluster.
=back
@ -330,15 +330,15 @@ Extra cluster files may also be specified either as an option on the
command line (see C<cluster-file>) or in the user's F<$HOME/.clusterssh/config>
file (see C<extra_cluster_file> configuration option).
NOTE: the last tag read overwrites any pre-existing tag of that name.
B<NOTE:> the last tag read overwrites any pre-existing tag of that name.
NOTE: there is a special cluster tag called C<default> - any tags or hosts
B<NOTE:> there is a special cluster tag called C<default> - any tags or hosts
included within this tag will be automatically opened if no other tags
are specified on the command line.
=item F</etc/tags>, F<$HOME/.clusterssh/tags>
Very similar to F<cluster> files but the definition is reversed. The
Very similar to F<clusters> files but the definition is reversed. The
format is:
S<< <host> <tag> [...] >>
@ -350,7 +350,7 @@ Extra tag files may be specified either as an option (see C<tag-file>) or within
the user's F<$HOME/.clusterssh/config> file (see C<extra_tag_file>
configuration option).
NOTE: All tags are added together
B<NOTE:> All tags are added together
=item F</etc/csshrc> & F<$HOME/.clusterssh/config>
@ -361,36 +361,35 @@ user file.
B<NOTE:> values for entries do not need to be quoted unless it is required
for passing arguments, e.g.
terminal_allow_send_events="-xrm '*.VT100.allowSendEvents:true'"
C<< terminal_allow_send_events="-xrm '*.VT100.allowSendEvents:true'" >>
should be written as
terminal_allow_send_events=-xrm '*.VT100.allowSendEvents:true'
C<< terminal_allow_send_events=-xrm '*.VT100.allowSendEvents:true' >>
=over
=item auto_close = 5
Close terminal window after this many seconds. If set to 0 will instead wait
on input from the user in each window before closing. Can be overridden
by C<-K> on the command line.
on input from the user in each window before closing. See also L<--autoclose> and L<--no-autoclose>
=item auto_quit = yes
Automatically quit after the last client window closes. Set to anything
other than "yes" to disable. Can be overridden by C<-Q> on the command line.
other than "yes" to disable. See also L<--autoquit> and L<--no-autoquit>
=item clusters = <blank>
Define a number of cluster tags in addition to (or to replace) tags defined
in the F</etc/clusters> file. The format is:
in the F<clusters> file. The format is:
clusters = <tag1> <tag2> <tag3>
<tag1> = host1 host2 host3
<tag2> = user@host4 user@host5 host6
<tag3> = <tag1> <tag2>
C<< clusters = <tag1> <tag2> <tag3> >>
C<< <tag1> = host1 host2 host3 >>
C<< <tag2> = user@host4 user@host5 host6 >>
C<< <tag3> = <tag1> <tag2> >>
As with the F</etc/clusters> file, be sure not to create recursively nested tags.
As with the F<clusters> file, be sure not to create recursively nested tags.
=item comms = ssh
@ -417,47 +416,38 @@ output ignored.
Define an extra cluster file in the format of F</etc/clusters>. Multiple
files can be specified, separated by commas. Both ~ and $HOME are acceptable
as a reference to the user's home directory, i.e.
as a reference to the user's home directory, e.g.
extra_cluster_file = ~/clusters, $HOME/clus
=item ignore_host_errors
THIS OPTION IS DEPRECATED. It has been left in so current systems continue
to function as expected.
C<< extra_cluster_file = ~/clusters, $HOME/clus >>
=item key_addhost = Control-Shift-plus
Default key sequence to open AddHost menu. See below notes on shortcuts.
Default key sequence to open AddHost menu. See L<KEY SHORTCUTS> for more information.
=item key_clientname = Alt-n
Default key sequence to send cssh client names to client. See below notes
on shortcuts.
Default key sequence to send cssh client names to client. See L<KEY SHORTCUTS> for more information.
=item key_localname = Alt-l
Default key sequence to send hostname of local server to client. See below
notes on shortcuts.
Default key sequence to send hostname of local server to client. See L<KEY SHORTCUTS> for more information.
=item key_paste = Control-v
Default key sequence to paste text into the console window. See below notes
on shortcuts.
Default key sequence to paste text into the console window. See L<KEY SHORTCUTS> for more information.
=item key_quit = Control-q
Default key sequence to quit the program (will terminate all open windows).
See below notes on shortcuts.
See L<KEY SHORTCUTS> for more information.
=item key_retilehosts = Alt-r
Default key sequence to retile host windows. See below notes on shortcuts.
Default key sequence to retile host windows. See L<KEY SHORTCUTS> for more information.
=item key_username = Alt-u
Default key sequence to send username to client. See below notes
on shortcuts.
Default key sequence to send username to client. See L<KEY SHORTCUTS> for more information.
=item macro_servername = %s
@ -474,9 +464,7 @@ pasting text into the main console.
=item macros_enabled = yes
Enable or disable macro replacement. Note: this affects pasting into the
main console, items on the 'Send' menu and key_clientname, key_localname,
key_servername and key_username.
Enable or disable macro replacement. Note: this affects all the C<macro_*> variables above.
=item max_addhost_menu_cluster_items = 6
@ -497,7 +485,7 @@ program start
=item mouse_paste = Button-2 (middle mouse button)
Default key sequence to paste text into the console window using the mouse.
See below notes on shortcuts.
See L<KEY SHORTCUTS> for more information.
=item rsh = rsh
@ -506,7 +494,7 @@ See below notes on shortcuts.
=item telnet = telnet
Set the path to the specific binary to use for the communication method, else
uses the first match found in $PATH
uses the first match found in C<$PATH >
=item rsh_args = <blank>
@ -542,14 +530,14 @@ at that side of the screen.
Depending on the value of comms, set the path of the communication binary.
=item terminal = /path/to/terminal
=item terminal = /path/to/xterm
Path to the X-Windows terminal used for the client.
=item terminal_args = <blank>
Arguments to use when opening terminal windows. Otherwise takes defaults
from F<$HOME/.Xdefaults> or $<$HOME/.Xresources> file.
from F<$HOME/.Xdefaults> or F<$HOME/.Xresources> file.
=item terminal_font = 6x13
@ -579,10 +567,10 @@ terminal color.
=item terminal_bg_style = dark
If set to dark, the terminal background will be set to black and
the foreground to the pseudo-random color. If set to light, then the
If set to C<dark>, the terminal background will be set to black and
the foreground to the pseudo-random color. If set to C<light>, then the
foreground will be black and the background the pseudo-random color. If
terminal_colorize is zero, then this option has no effect.
terminal_colorize is C<zero>, then this option has no effect.
=item terminal_size = 80x24
@ -633,9 +621,9 @@ left and then up
=back
B<NOTE:> The key shortcut modifiers must be in the form "Control", "Alt", or
"Shift", i.e. with the first letter capitalised and the rest lower case. Keys
may also be disabled individually by setting to the word "null".
B<NOTE:> The key shortcut modifiers must be in the form C<Control>, C<Alt> or
C<Shift>, e.g. with the first letter capitalised and the rest lower case. Keys
may also be disabled individually by setting to the word C<null>.
=item F<$HOME/.csshrc_send_menu>
@ -707,7 +695,7 @@ Hostname of server where cssh is being run from
=item %n
<RETURN> code
C<RETURN> code
=back
@ -744,15 +732,27 @@ C<< cssh -e [user@]<hostname>[:port] >>
This performs two tests to confirm cssh is able to work properly with the
settings provided within the F<$HOME/.clusterssh/config> file (or internal defaults).
1. Test the terminal window works with the options provided
=over
2. Test ssh works to a host with the configured arguments
=item 1
Test the terminal window works with the options provided
=item 2
Test ssh works to a host with the configured arguments
=back
Configuration options to watch for in ssh are
- Doesn't understand "-o ConnectTimeout=10" - remove the option in the F<$HOME/.clusterssh/config> file
=over
- OpenSSH-3.8 using untrusted ssh tunnels - use "-Y" instead of "-X" or use "ForwardX11Trusted yes' in ssh_config (if you change the default ssh options from -x to -X)
=item SSH doesn't understand C<-o ConnectTimeout=10> - remove the option from the F<$HOME/.clusterssh/config> file
=item OpenSSH-3.8 using untrusted ssh tunnels - use C<-Y> instead of C<-X> or use C<ForwardX11Trusted yes> in F<$HOME/.ssh/ssh_config> (if you change the default ssh options from C<-x> to C<-X>)
=back
=item *
@ -771,7 +771,7 @@ C<< cat /etc/csshrc $HOME/.clusterssh/config >>
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. C<< cssh --debug <host> >>
only use this option with one host at a time, e.g. C<< cssh --debug <host> >>
due to the amount of output produced (in both main and child windows).
=back