.\" -*- 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::Config 3pm" .TH App::ClusterSSH::Config 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" .SH DESCRIPTION .IX Header "DESCRIPTION" Object representing application configuration .SH METHODS .IX Header "METHODS" .ie n .IP "$host=ClusterSSH::Config\->new ({ })" 4 .el .IP "\f(CW$host\fR=ClusterSSH::Config\->new ({ })" 4 .IX Item "$host=ClusterSSH::Config->new ({ })" Create a new configuration object. .ie n .IP $config\->parse_config_file(''); 4 .el .IP \f(CW$config\fR\->parse_config_file(''); 4 .IX Item "$config->parse_config_file('');" Read in configuration from given filename .ie n .IP $config\->\fBvalidate_args()\fR; 4 .el .IP \f(CW$config\fR\->\fBvalidate_args()\fR; 4 .IX Item "$config->validate_args();" Validate and apply all configuration loaded at this point .ie n .IP "$path = $config\->search_dirs('', @seaarch_directories);" 4 .el .IP "\f(CW$path\fR = \f(CW$config\fR\->search_dirs('', \f(CW@seaarch_directories\fR);" 4 .IX Item "$path = $config->search_dirs('', @seaarch_directories);" Search the given directories for the name given. Return undef if not found. .ie n .IP "$path = $config\->find_binary('');" 4 .el .IP "\f(CW$path\fR = \f(CW$config\fR\->find_binary('');" 4 .IX Item "$path = $config->find_binary('');" Locate the binary and return the full path. Doesn't just search \&\f(CW$PATH\fR in case the environment isn't set up correctly .ie n .IP $config\->load_configs(@extra); 4 .el .IP \f(CW$config\fR\->load_configs(@extra); 4 .IX Item "$config->load_configs(@extra);" Load up configuration from known locations (warn if .csshrc file found) and load in option files as necessary. .ie n .IP $config\->\fBwrite_user_config_file()\fR; 4 .el .IP \f(CW$config\fR\->\fBwrite_user_config_file()\fR; 4 .IX Item "$config->write_user_config_file();" Write out default \f(CW$HOME\fR/.clusterssh/config file (before option config files are loaded). .ie n .IP $config\->\fBdump()\fR 4 .el .IP \f(CW$config\fR\->\fBdump()\fR 4 .IX Item "$config->dump()" Write currently defined configuration to STDOUT