.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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" '' . 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 .\" .\" 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 "App::Info::Lib::OSSPUUID 3pm" .TH App::Info::Lib::OSSPUUID 3pm "2020-01-23" "perl v5.30.0" "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" App::Info::Lib::OSSPUUID \- Information about the OSSP UUID library .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use App::Info::Lib::OSSPUUID; \& \& my $uuid = App::Info::Lib::OSSPUUID\->new; \& \& if ($uuid\->installed) { \& print "App name: ", $uuid\->name, "\en"; \& print "Version: ", $uuid\->version, "\en"; \& print "Bin dir: ", $uuid\->bin_dir, "\en"; \& } else { \& print "Expat is not installed. :\-(\en"; \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" App::Info::Lib::OSSPUUID supplies information about the \s-1OSSP UUID\s0 library installed on the local system. It implements all of the methods defined by App::Info::Lib. Methods that trigger events will trigger them only the first time they're called (See App::Info for documentation on handling events). To start over (after, say, someone has installed the \s-1OSSP UUID\s0 library) construct a new App::Info::Lib::OSSPUUID object to aggregate new meta data. .PP Some of the methods trigger the same events. This is due to cross-calling of shared subroutines. However, any one event should be triggered no more than once. For example, although the info event \*(L"Executing `uuid\-config \-\-version`\*(R" is documented for the methods \f(CW\*(C`name()\*(C'\fR \f(CW\*(C`version()\*(C'\fR, \f(CW\*(C`major_version()\*(C'\fR, \&\f(CW\*(C`minor_version()\*(C'\fR, and \f(CW\*(C`patch_version()\*(C'\fR, rest assured that it will only be triggered once, by whichever of those four methods is called first. .SH "INTERFACE" .IX Header "INTERFACE" .SS "Constructor" .IX Subsection "Constructor" \fInew\fR .IX Subsection "new" .PP .Vb 1 \& my $expat = App::Info::Lib::OSSPUUID\->new(@params); .Ve .PP Returns an App::Info::Lib::OSSPUUID object. See App::Info for a complete description of argument parameters. .PP When called, \f(CW\*(C`new()\*(C'\fR searches all of the paths returned by the \&\f(CW\*(C`search_lib_dirs()\*(C'\fR method for one of the files returned by the \&\f(CW\*(C`search_lib_names()\*(C'\fR method. If any of is found, then the \s-1OSSP UUID\s0 library is assumed to be installed. Otherwise, most of the object methods will return \&\f(CW\*(C`undef\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Looking for uuid-config .IP "confirm" 4 .IX Item "confirm" Path to uuid-config? .IP "unknown" 4 .IX Item "unknown" Path to uuid-config? .SS "Class Method" .IX Subsection "Class Method" \fIkey_name\fR .IX Subsection "key_name" .PP .Vb 1 \& my $key_name = App::Info::Lib::OSSPUUID\->key_name; .Ve .PP Returns the unique key name that describes this class. The value returned is the string \*(L"\s-1OSSP UUID\*(R".\s0 .SS "Object Methods" .IX Subsection "Object Methods" \fIinstalled\fR .IX Subsection "installed" .PP .Vb 1 \& print "UUID is ", ($uuid\->installed ? \*(Aq\*(Aq : \*(Aqnot \*(Aq), "installed.\en"; .Ve .PP Returns true if the \s-1OSSP UUID\s0 library is installed, and false if it is not. App::Info::Lib::OSSPUUID determines whether the library is installed based on the presence or absence on the file system of the \f(CW\*(C`uuid\-config\*(C'\fR application, searched for when \f(CW\*(C`new()\*(C'\fR constructed the object. If the \s-1OSSP UUID\s0 library does not appear to be installed, then most of the other object methods will return empty values. .PP \fIname\fR .IX Subsection "name" .PP .Vb 1 \& my $name = $uuid\->name; .Ve .PP Returns the name of the library. App::Info::Lib::OSSPUUID parses the name from the system call \f(CW\*(C`\`uuid\-config \-\-version\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-version` .IP "error" 4 .IX Item "error" Failed to find \s-1OSSP UUID\s0 version with `uuid\-config \-\-version` .Sp Unable to parse name from string .Sp Unable to parse version from string .Sp Failed to parse \s-1OSSP UUID\s0 version parts from string .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 version number .PP \fIversion\fR .IX Subsection "version" .PP .Vb 1 \& my $version = $uuid\->version; .Ve .PP Returns the \s-1OSSP UUID\s0 version number. App::Info::Lib::OSSPUUID parses the version number from the system call \f(CW\*(C`\`uuid\-config \-\-version\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-version` .IP "error" 4 .IX Item "error" Failed to find \s-1OSSP UUID\s0 version with `uuid\-config \-\-version` .Sp Unable to parse name from string .Sp Unable to parse version from string .Sp Failed to parse \s-1OSSP UUID\s0 version parts from string .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 version number .PP \fImajor version\fR .IX Subsection "major version" .PP .Vb 1 \& my $major_version = $uuid\->major_version; .Ve .PP Returns the \s-1OSSP UUID\s0 library major version number. App::Info::Lib::OSSPUUID parses the major version number from the system call \f(CW\*(C`\`uuid\-config \&\-\-version\`\*(C'\fR. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"1.3.0\*(R", then this method returns \*(L"1\*(R". .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-version` .IP "error" 4 .IX Item "error" Failed to find \s-1OSSP UUID\s0 version with `uuid\-config \-\-version` .Sp Unable to parse name from string .Sp Unable to parse version from string .Sp Failed to parse \s-1OSSP UUID\s0 version parts from string .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 major version number .PP \fIminor version\fR .IX Subsection "minor version" .PP .Vb 1 \& my $minor_version = $uuid\->minor_version; .Ve .PP Returns the \s-1OSSP UUID\s0 library minor version number. App::Info::Lib::OSSPUUID parses the minor version number from the system call \f(CW\*(C`\`uuid\-config \&\-\-version\`\*(C'\fR. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"1.3.0\*(R", then this method returns \*(L"3\*(R". .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-version` .IP "error" 4 .IX Item "error" Failed to find \s-1OSSP UUID\s0 version with `uuid\-config \-\-version` .Sp Unable to parse name from string .Sp Unable to parse version from string .Sp Failed to parse \s-1OSSP UUID\s0 version parts from string .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 minor version number .PP \fIpatch version\fR .IX Subsection "patch version" .PP .Vb 1 \& my $patch_version = $uuid\->patch_version; .Ve .PP Returns the \s-1OSSP UUID\s0 library patch version number. App::Info::Lib::OSSPUUID parses the patch version number from the system call \f(CW\*(C`\`uuid\-config \&\-\-version\`\*(C'\fR. For example, if \f(CW\*(C`version()\*(C'\fR returns \*(L"1.3.0\*(R", then this method returns \*(L"0\*(R". .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-version` .IP "error" 4 .IX Item "error" Failed to find \s-1OSSP UUID\s0 version with `uuid\-config \-\-version` .Sp Unable to parse name from string .Sp Unable to parse version from string .Sp Failed to parse \s-1OSSP UUID\s0 version parts from string .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 minor version number .PP \fIexecutable\fR .IX Subsection "executable" .PP .Vb 1 \& my $exe = $uuid\->executable; .Ve .PP Returns the full path to the \s-1OSSP UUID\s0 executable, which is named \fIuuid\fR. This method does not use the executable names returned by \&\f(CW\*(C`search_exe_names()\*(C'\fR; those executable names are used to search for \&\fIuuid-config\fR only (in \f(CW\*(C`new()\*(C'\fR). .PP When it called, \f(CW\*(C`executable()\*(C'\fR checks for an executable named \fIuuid\fR in the directory returned by \f(CW\*(C`bin_dir()\*(C'\fR. .PP Note that \f(CW\*(C`executable()\*(C'\fR is simply an alias for \f(CW\*(C`uuid()\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Looking for uuid executable .IP "confirm" 4 .IX Item "confirm" Path to uuid executable? .IP "unknown" 4 .IX Item "unknown" Path to uuid executable? .PP \fIbin_dir\fR .IX Subsection "bin_dir" .PP .Vb 1 \& my $bin_dir = $uuid\->bin_dir; .Ve .PP Returns the \s-1OSSP UUID\s0 binary directory path. App::Info::Lib::OSSPUUID gathers the path from the system call \f(CW\*(C`\`uuid\-config \-\-bindir\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-bindir` .IP "error" 4 .IX Item "error" Cannot find bin directory .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 bin directory .PP \fIinc_dir\fR .IX Subsection "inc_dir" .PP .Vb 1 \& my $inc_dir = $uuid\->inc_dir; .Ve .PP Returns the \s-1OSSP UUID\s0 include directory path. App::Info::Lib::OSSPUUID gathers the path from the system call \f(CW\*(C`\`uuid\-config \-\-includedir\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-includedir` .IP "error" 4 .IX Item "error" Cannot find include directory .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 include directory .PP \fIlib_dir\fR .IX Subsection "lib_dir" .PP .Vb 1 \& my $lib_dir = $uuid\->lib_dir; .Ve .PP Returns the \s-1OSSP UUID\s0 library directory path. App::Info::Lib::OSSPUUID gathers the path from the system call \f(CW\*(C`\`uuid\-config \-\-libdir\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-libdir` .IP "error" 4 .IX Item "error" Cannot find library directory .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 library directory .PP \fIso_lib_dir\fR .IX Subsection "so_lib_dir" .PP .Vb 1 \& my $so_lib_dir = $uuid\->so_lib_dir; .Ve .PP Returns the \s-1OSSP UUID\s0 shared object library directory path. This is actually just an alias for \f(CW\*(C`lib_dir()\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-libdir` .IP "error" 4 .IX Item "error" Cannot find library directory .IP "unknown" 4 .IX Item "unknown" Enter a valid \s-1OSSP UUID\s0 library directory .PP \fIcflags\fR .IX Subsection "cflags" .PP .Vb 1 \& my $configure = $uuid\->cflags; .Ve .PP Returns the C flags used when compiling the \s-1OSSP UUID\s0 library. App::Info::Lib::OSSPUUID gathers the configure data from the system call \&\f(CW\*(C`\`uuid\-config \-\-cflags\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-configure` .IP "error" 4 .IX Item "error" Cannot find configure information .IP "unknown" 4 .IX Item "unknown" Enter \s-1OSSP UUID\s0 configuration options .PP \fIldflags\fR .IX Subsection "ldflags" .PP .Vb 1 \& my $configure = $uuid\->ldflags; .Ve .PP Returns the \s-1LD\s0 flags used when compiling the \s-1OSSP UUID\s0 library. App::Info::Lib::OSSPUUID gathers the configure data from the system call \&\f(CW\*(C`\`uuid\-config \-\-ldflags\`\*(C'\fR. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Executing `uuid\-config \-\-configure` .IP "error" 4 .IX Item "error" Cannot find configure information .IP "unknown" 4 .IX Item "unknown" Enter \s-1OSSP UUID\s0 configuration options .PP \fIperl_module\fR .IX Subsection "perl_module" .PP .Vb 1 \& my $bool = $uuid\->perl_module; .Ve .PP Return true if \f(CW\*(C`OSSP::uuid\*(C'\fR is installed and can be loaded, and false if not. \&\f(CW\*(C`OSSP::uuid\*(C'\fR must be able to be loaded by the currently running instance of the Perl interpreter. .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Loading OSSP::uuid .PP \fIhome_url\fR .IX Subsection "home_url" .PP .Vb 1 \& my $home_url = $uuid\->home_url; .Ve .PP Returns the \s-1OSSP UUID\s0 home page \s-1URL.\s0 .PP \fIdownload_url\fR .IX Subsection "download_url" .PP .Vb 1 \& my $download_url = $uuid\->download_url; .Ve .PP Returns the \s-1OSSP UUID\s0 download \s-1URL.\s0 .PP \fIsearch_exe_names\fR .IX Subsection "search_exe_names" .PP .Vb 1 \& my @search_exe_names = $app\->search_exe_names; .Ve .PP Returns a list of possible names for \fIuuid-config\fR executable. By default, only \&\fIuuid-config\fR is returned (or \fIuuid\-config.exe\fR on Win32). .PP Note that this method is not used to search for the \s-1OSSP UUID\s0 server executable, only \fIuuid-config\fR. .PP \fIsearch_bin_dirs\fR .IX Subsection "search_bin_dirs" .PP .Vb 1 \& my @search_bin_dirs = $app\->search_bin_dirs; .Ve .PP Returns a list of possible directories in which to search an executable. Used by the \f(CW\*(C`new()\*(C'\fR constructor to find an executable to execute and collect application info. The found directory will also be returned by the \f(CW\*(C`bin_dir\*(C'\fR method. .PP The list of directories by default consists of the path as defined by \&\f(CW\*(C`File::Spec\->path\*(C'\fR, as well as the following directories: .IP "/usr/local/bin" 4 .IX Item "/usr/local/bin" .PD 0 .IP "/usr/local/sbin" 4 .IX Item "/usr/local/sbin" .IP "/usr/bin" 4 .IX Item "/usr/bin" .IP "/usr/sbin" 4 .IX Item "/usr/sbin" .IP "/bin" 4 .IX Item "/bin" .IP "C:\eProgram Files\euid\ebin" 4 .IX Item "C:Program Filesuidbin" .PD .SS "Other Executable Methods" .IX Subsection "Other Executable Methods" These methods function just like the \f(CW\*(C`executable()\*(C'\fR method, except that they return different executables. \s-1OSSP UUID\s0 comes with a fair number of them; we provide these methods to provide a path to a subset of them. Each method, when called, checks for an executable in the directory returned by \f(CW\*(C`bin_dir()\*(C'\fR. The name of the executable must be one of the names returned by the corresponding \f(CW\*(C`search_*_names\*(C'\fR method. .PP The available executable methods are: .IP "uuid" 4 .IX Item "uuid" .PD 0 .IP "uuid_config" 4 .IX Item "uuid_config" .PD .PP And the corresponding search names methods are: .IP "search_postgres_names" 4 .IX Item "search_postgres_names" .PD 0 .IP "search_createdb_names" 4 .IX Item "search_createdb_names" .PD .PP \&\fBEvents:\fR .IP "info" 4 .IX Item "info" Looking for executable .IP "confirm" 4 .IX Item "confirm" Path to executable? .IP "unknown" 4 .IX Item "unknown" Path to executable? .SH "SUPPORT" .IX Header "SUPPORT" This module is stored in an open GitHub repository . Feel free to fork and contribute! .PP Please file bug reports via GitHub Issues or by sending mail to bug\-App\-Info@rt.cpan.org . .SH "AUTHOR" .IX Header "AUTHOR" David E. Wheeler . .SH "SEE ALSO" .IX Header "SEE ALSO" App::Info documents the event handling interface. .PP App::Info::Lib is the App::Info::Lib::Expat parent class. .PP OSSP::uuid is the Perl interface to the \s-1OSSP UUID\s0 library. .PP is the \s-1OSSP UUID\s0 home page. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (c) 2002\-2011, David E. Wheeler. Some Rights Reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.