Document external_cluster_command

Add in some basic documentation for the new functionality
This commit is contained in:
Duncan Ferguson 2013-04-15 22:30:32 +01:00
parent ea811ba639
commit 824e4a0274

View file

@ -262,8 +262,8 @@ on standard port (e.g not listening on port 22) and ssh_config cannot be used.
=item <tag> ...
Open a series of xterms defined by <tag> within either /etc/clusters or
F<$HOME/.clusterssh/config> (see L</"FILES">).
Open a series of xterms defined by <tag> in one of the suplimentary
configuration files (see L</"FILES">).
Note: specifying a username on a cluster tag will override any usernames
defined in the cluster
@ -437,6 +437,16 @@ 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).
=item external_cluster_command = <null>
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.
A non-0 exit code will be counted as an error, a warning will be printed and
output ignored.
=item extra_cluster_file = <null>
Define an extra cluster file in the format of F</etc/clusters>. Multiple