summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/ExtUtils::Installed.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/ExtUtils::Installed.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/ExtUtils::Installed.3perl')
-rw-r--r--upstream/debian-unstable/man3/ExtUtils::Installed.3perl195
1 files changed, 195 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/ExtUtils::Installed.3perl b/upstream/debian-unstable/man3/ExtUtils::Installed.3perl
new file mode 100644
index 00000000..2ac6f236
--- /dev/null
+++ b/upstream/debian-unstable/man3/ExtUtils::Installed.3perl
@@ -0,0 +1,195 @@
+.\" -*- 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 "ExtUtils::Installed 3perl"
+.TH ExtUtils::Installed 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" 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
+ExtUtils::Installed \- Inventory management of installed modules
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 9
+\& use ExtUtils::Installed;
+\& my ($inst) = ExtUtils::Installed\->new( skip_cwd => 1 );
+\& my (@modules) = $inst\->modules();
+\& my (@missing) = $inst\->validate("DBI");
+\& my $all_files = $inst\->files("DBI");
+\& my $files_below_usr_local = $inst\->files("DBI", "all", "/usr/local");
+\& my $all_dirs = $inst\->directories("DBI");
+\& my $dirs_below_usr_local = $inst\->directory_tree("DBI", "prog");
+\& my $packlist = $inst\->packlist("DBI");
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+ExtUtils::Installed provides a standard way to find out what core and module
+files have been installed. It uses the information stored in .packlist files
+created during installation to provide this information. In addition it
+provides facilities to classify the installed files and to extract directory
+information from the .packlist files.
+.SH USAGE
+.IX Header "USAGE"
+The \fBnew()\fR function searches for all the installed .packlists on the system, and
+stores their contents. The .packlists can be queried with the functions
+described below. Where it searches by default is determined by the settings found
+in \f(CW%Config::Config\fR, and what the value is of the PERL5LIB environment variable.
+.SH METHODS
+.IX Header "METHODS"
+Unless specified otherwise all method can be called as class methods, or as object
+methods. If called as class methods then the "default" object will be used, and if
+necessary created using the current processes \f(CW%Config\fR and \f(CW@INC\fR. See the
+\&'default' option to \fBnew()\fR for details.
+.IP \fBnew()\fR 4
+.IX Item "new()"
+This takes optional named parameters. Without parameters, this
+searches for all the installed .packlists on the system using
+information from \f(CW%Config::Config\fR and the default module search
+paths \f(CW@INC\fR. The packlists are read using the
+ExtUtils::Packlist module.
+.Sp
+If the named parameter \f(CW\*(C`skip_cwd\*(C'\fR is true, the current directory \f(CW\*(C`.\*(C'\fR will
+be stripped from \f(CW@INC\fR before searching for .packlists. This keeps
+ExtUtils::Installed from finding modules installed in other perls that
+happen to be located below the current directory.
+.Sp
+If the named parameter \f(CW\*(C`config_override\*(C'\fR is specified,
+it should be a reference to a hash which contains all information
+usually found in \f(CW%Config::Config\fR. For example, you can obtain
+the configuration information for a separate perl installation and
+pass that in.
+.Sp
+.Vb 3
+\& my $yoda_cfg = get_fake_config(\*(Aqyoda\*(Aq);
+\& my $yoda_inst =
+\& ExtUtils::Installed\->new(config_override=>$yoda_cfg);
+.Ve
+.Sp
+Similarly, the parameter \f(CW\*(C`inc_override\*(C'\fR may be a reference to an
+array which is used in place of the default module search paths
+from \f(CW@INC\fR.
+.Sp
+.Vb 3
+\& use Config;
+\& my @dirs = split(/\eQ$Config{path_sep}\eE/, $ENV{PERL5LIB});
+\& my $p5libs = ExtUtils::Installed\->new(inc_override=>\e@dirs);
+.Ve
+.Sp
+\&\fBNote\fR: You probably do not want to use these options alone, almost always
+you will want to set both together.
+.Sp
+The parameter \f(CW\*(C`extra_libs\*(C'\fR can be used to specify \fBadditional\fR paths to
+search for installed modules. For instance
+.Sp
+.Vb 2
+\& my $installed =
+\& ExtUtils::Installed\->new(extra_libs=>["/my/lib/path"]);
+.Ve
+.Sp
+This should only be necessary if \fI/my/lib/path\fR is not in PERL5LIB.
+.Sp
+Finally there is the 'default', and the related 'default_get' and 'default_set'
+options. These options control the "default" object which is provided by the
+class interface to the methods. Setting \f(CW\*(C`default_get\*(C'\fR to true tells the constructor
+to return the default object if it is defined. Setting \f(CW\*(C`default_set\*(C'\fR to true tells
+the constructor to make the default object the constructed object. Setting the
+\&\f(CW\*(C`default\*(C'\fR option is like setting both to true. This is used primarily internally
+and probably isn't interesting to any real user.
+.IP \fBmodules()\fR 4
+.IX Item "modules()"
+This returns a list of the names of all the installed modules. The perl 'core'
+is given the special name 'Perl'.
+.IP \fBfiles()\fR 4
+.IX Item "files()"
+This takes one mandatory parameter, the name of a module. It returns a list of
+all the filenames from the package. To obtain a list of core perl files, use
+the module name 'Perl'. Additional parameters are allowed. The first is one
+of the strings "prog", "doc" or "all", to select either just program files,
+just manual files or all files. The remaining parameters are a list of
+directories. The filenames returned will be restricted to those under the
+specified directories.
+.IP \fBdirectories()\fR 4
+.IX Item "directories()"
+This takes one mandatory parameter, the name of a module. It returns a list of
+all the directories from the package. Additional parameters are allowed. The
+first is one of the strings "prog", "doc" or "all", to select either just
+program directories, just manual directories or all directories. The remaining
+parameters are a list of directories. The directories returned will be
+restricted to those under the specified directories. This method returns only
+the leaf directories that contain files from the specified module.
+.IP \fBdirectory_tree()\fR 4
+.IX Item "directory_tree()"
+This is identical in operation to \fBdirectories()\fR, except that it includes all the
+intermediate directories back up to the specified directories.
+.IP \fBvalidate()\fR 4
+.IX Item "validate()"
+This takes one mandatory parameter, the name of a module. It checks that all
+the files listed in the modules .packlist actually exist, and returns a list of
+any missing files. If an optional second argument which evaluates to true is
+given any missing files will be removed from the .packlist
+.IP \fBpacklist()\fR 4
+.IX Item "packlist()"
+This returns the ExtUtils::Packlist object for the specified module.
+.IP \fBversion()\fR 4
+.IX Item "version()"
+This returns the version number for the specified module.
+.SH EXAMPLE
+.IX Header "EXAMPLE"
+See the example in ExtUtils::Packlist.
+.SH AUTHOR
+.IX Header "AUTHOR"
+Alan Burlison <Alan.Burlison@uk.sun.com>