.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "FusionInventory::Agent::Tools 3pm" .TH FusionInventory::Agent::Tools 3pm "2012-06-25" "perl v5.14.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 "NAME" FusionInventory::Agent::Tools \- OS\-independant generic functions .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides some OS-independant generic functions. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "getFormatedLocalTime($time)" .IX Subsection "getFormatedLocalTime($time)" Returns a formated date from given Unix timestamp. .SS "getFormatedGmTime($time)" .IX Subsection "getFormatedGmTime($time)" Returns a formated date from given Unix timestamp. .ie n .SS "getFormatedDate($year, $month, $day, $hour, $min, $sec)" .el .SS "getFormatedDate($year, \f(CW$month\fP, \f(CW$day\fP, \f(CW$hour\fP, \f(CW$min\fP, \f(CW$sec\fP)" .IX Subsection "getFormatedDate($year, $month, $day, $hour, $min, $sec)" Returns a formated date from given date elements. .SS "getCanonicalManufacturer($manufacturer)" .IX Subsection "getCanonicalManufacturer($manufacturer)" Returns a normalized manufacturer value for given one. .SS "getCanonicalSpeed($speed)" .IX Subsection "getCanonicalSpeed($speed)" Returns a normalized speed value (in Mhz) for given one. .SS "getCanonicalSize($size)" .IX Subsection "getCanonicalSize($size)" Returns a normalized size value (in Mb) for given one. .SS "getSanitizedString($string)" .IX Subsection "getSanitizedString($string)" Returns the input stripped from any control character, properly encoded in \&\s-1UTF\-8\s0. .ie n .SS "compareVersion($major, $minor, $min_major, $min_minor)" .el .SS "compareVersion($major, \f(CW$minor\fP, \f(CW$min_major\fP, \f(CW$min_minor\fP)" .IX Subsection "compareVersion($major, $minor, $min_major, $min_minor)" Returns true if software with given major and minor version meet minimal version requirements. .SS "getDirectoryHandle(%params)" .IX Subsection "getDirectoryHandle(%params)" Returns an open file handle on either a command output, or a file. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "directory the directory to use" 4 .IX Item "directory the directory to use" .PD .SS "getFileHandle(%params)" .IX Subsection "getFileHandle(%params)" Returns an open file handle on either a command output, a file, or a string. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "command the command to use" 4 .IX Item "command the command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .IP "string the string to use, as an alternative to the command" 4 .IX Item "string the string to use, as an alternative to the command" .PD .SS "getFirstLine(%params)" .IX Subsection "getFirstLine(%params)" Returns the first line of given command output or given file content, with end of line removed. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "command the exact command to use" 4 .IX Item "command the exact command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .PD .SS "getAllLines(%params)" .IX Subsection "getAllLines(%params)" Returns all the lines of given command output or given file content, with end of line removed. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "command the exact command to use" 4 .IX Item "command the exact command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .PD .SS "getFirstMatch(%params)" .IX Subsection "getFirstMatch(%params)" Returns the result of applying given pattern on the first matching line of given command output or given file content. .IP "pattern a regexp" 4 .IX Item "pattern a regexp" .PD 0 .IP "logger a logger object" 4 .IX Item "logger a logger object" .IP "command the exact command to use" 4 .IX Item "command the exact command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .PD .SS "getLastLine(%params)" .IX Subsection "getLastLine(%params)" Returns the last line of given command output or given file content. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "command the exact command to use" 4 .IX Item "command the exact command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .PD .SS "getLinesCount(%params)" .IX Subsection "getLinesCount(%params)" Returns the number of lines of given command output or given file content. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "command the exact command to use" 4 .IX Item "command the exact command to use" .IP "file the file to use, as an alternative to the command" 4 .IX Item "file the file to use, as an alternative to the command" .PD .SS "canRun($binary)" .IX Subsection "canRun($binary)" Returns true if given binary can be executed. .SS "canRead($file)" .IX Subsection "canRead($file)" Returns true if given file can be read. .SS "canLoad($module)" .IX Subsection "canLoad($module)" Returns true if given perl module can be loaded (and actually loads it). .SS "hex2char($value)" .IX Subsection "hex2char($value)" Returns the value converted to a character if it starts with hexadecimal prefix, the unconverted value otherwise. Eg. 0x41 \-> A, 41 \-> 41. .SS "hex2dec($value)" .IX Subsection "hex2dec($value)" Returns the value converted to a decimal if it starts with hexadecimal prefix, the unconverted value otherwise. Eg. 0x41 \-> 65, 41 \-> 41. .SS "dec2hex($value)" .IX Subsection "dec2hex($value)" Returns the value converted to an hexadecimal if it doesn't start with hexadecimal prefix, the unconverted value otherwise. Eg. 65 \-> 0x41, 0x41 \-> 0x41. .SS "any \s-1BLOCK\s0 \s-1LIST\s0" .IX Subsection "any BLOCK LIST" Returns a true value if any item in \s-1LIST\s0 meets the criterion given through \&\s-1BLOCK\s0. .SS "all \s-1BLOCK\s0 \s-1LIST\s0" .IX Subsection "all BLOCK LIST" Returns a true value if all items in \s-1LIST\s0 meet the criterion given through \&\s-1BLOCK\s0. .SS "none \s-1BLOCK\s0 \s-1LIST\s0" .IX Subsection "none BLOCK LIST" Returns a true value if no item in \s-1LIST\s0 meets the criterion given through \s-1BLOCK\s0. .SS "uniq \s-1BLOCK\s0 \s-1LIST\s0" .IX Subsection "uniq BLOCK LIST" Returns a new list by stripping duplicate values in \s-1LIST\s0. .SS "file2module($string)" .IX Subsection "file2module($string)" Converts a perl file name to a perl module name (Foo/Bar.pm \-> Foo::Bar) .SS "module2file($string)" .IX Subsection "module2file($string)" Converts a perl module name to a perl file name ( Foo::Bar \-> Foo/Bar.pm) .SS "runFunction(%params)" .IX Subsection "runFunction(%params)" Run a function whose name is computed at runtime and return its result. .IP "logger a logger object" 4 .IX Item "logger a logger object" .PD 0 .IP "module the function namespace" 4 .IX Item "module the function namespace" .IP "function the function name" 4 .IX Item "function the function name" .IP "timeout timeout for function execution" 4 .IX Item "timeout timeout for function execution" .IP "load enforce module loading first" 4 .IX Item "load enforce module loading first" .PD .SS "delay($second)" .IX Subsection "delay($second)" Wait for \f(CW$second\fR. It uses \fIsleep()\fR or \fIWin32::Sleep()\fR depending on the Operating System.