.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::ClusterSSH::Base 3pm"
.TH App::ClusterSSH::Base 3pm 2024-07-12 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use base qw/ App::ClusterSSH::Base /;
\&
\&    # in object new method
\&    sub new {
\&        ( $class, $arg_ref ) = @_;
\&        my $self = $class\->SUPER::new($arg_ref);
\&        return $self;
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Base object to provide some utility functions on objects \- should not be 
used directly
.SH METHODS
.IX Header "METHODS"
These extra methods are provided on the object
.ie n .IP "$obj = App::ClusterSSH::Base\->new({ arg => val, });" 4
.el .IP "\f(CW$obj\fR = App::ClusterSSH::Base\->new({ arg => val, });" 4
.IX Item "$obj = App::ClusterSSH::Base->new({ arg => val, });"
Creates object.  In higher debug levels the args are printed out.
.ie n .IP $obj\->id 4
.el .IP \f(CW$obj\fR\->id 4
.IX Item "$obj->id"
Return the unique id of the object for use in subclasses, such as
.Sp
.Vb 1
\&    $info_for{ $self\->id } = $info
.Ve
.ie n .IP $obj\->\fBdebug_level()\fR; 4
.el .IP \f(CW$obj\fR\->\fBdebug_level()\fR; 4
.IX Item "$obj->debug_level();"
Returns current debug level
.ie n .IP "$obj\->set_debug_level( n )" 4
.el .IP "\f(CW$obj\fR\->set_debug_level( n )" 4
.IX Item "$obj->set_debug_level( n )"
Set debug level to 'n' for all child objects.
.ie n .IP "$obj\->debug($level, @text)" 4
.el .IP "\f(CW$obj\fR\->debug($level, \f(CW@text\fR)" 4
.IX Item "$obj->debug($level, @text)"
Output \f(CW@text\fR on STDOUT if \f(CW$level\fR is the same or lower that debug_level
.ie n .IP $obj\->set_lang 4
.el .IP \f(CW$obj\fR\->set_lang 4
.IX Item "$obj->set_lang"
Set the Locale::Maketext language.  Defaults to 'en'.  Expects the 
App::ClusterSSH/L10N/{lang}.pm module to exist and contain all relevant 
translations, else defaults to English.
.ie n .IP "$obj\->loc('text to translate [_1]')" 4
.el .IP "\f(CW$obj\fR\->loc('text to translate [_1]')" 4
.IX Item "$obj->loc('text to translate [_1]')"
Using the App::ClusterSSH/L10N/{lang}.pm module convert the  given text to 
appropriate language.  See App::ClusterSSH::L10N for more details.  Essentially 
a wrapper to maketext in Locale::Maketext
.ie n .IP $obj\->stdout_output(@); 4
.el .IP \f(CW$obj\fR\->stdout_output(@); 4
.IX Item "$obj->stdout_output(@);"
Output text on STDOUT.
.ie n .IP $obj\->parent; 4
.el .IP \f(CW$obj\fR\->parent; 4
.IX Item "$obj->parent;"
Returned the object that is the parent of this one, if it was set when the 
object was created
.ie n .IP %obj\->options; 4
.el .IP \f(CW%obj\fR\->options; 4
.IX Item "%obj->options;"
Accessor to configured options, if it is set up by this point
.ie n .IP $obj\->exit; 4
.el .IP \f(CW$obj\fR\->exit; 4
.IX Item "$obj->exit;"
Stub to allow program to exit neatly from wherever in the code
.ie n .IP "$config = $obj\->config;" 4
.el .IP "\f(CW$config\fR = \f(CW$obj\fR\->config;" 4
.IX Item "$config = $obj->config;"
Returns whatever configuration object has been set up.  Croaks if set_config
hasnt been called
.ie n .IP $obj\->set_config($config); 4
.el .IP \f(CW$obj\fR\->set_config($config); 4
.IX Item "$obj->set_config($config);"
Set the config to the given value \- croaks if has already been called
.ie n .IP "$sort = $obj\->sort" 4
.el .IP "\f(CW$sort\fR = \f(CW$obj\fR\->sort" 4
.IX Item "$sort = $obj->sort"
Code reference used to sort lists; if configured (and installed) use
Sort;:Naturally, else use perl sort
.ie n .IP "%results = $obj\->load_file( filename => '/path/to/file', type => '(cluster|config}' )" 4
.el .IP "\f(CW%results\fR = \f(CW$obj\fR\->load_file( filename => '/path/to/file', type => '(cluster|config}' )" 4
.IX Item "%results = $obj->load_file( filename => '/path/to/file', type => '(cluster|config}' )"
Load in the specified file and return a hash, parsing the file depending on
wther it is a config file (key = value) or cluster file (key value)