.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "Lintian::Collect::Binary 3"
.TH Lintian::Collect::Binary 3 "2019-05-26" "Lintian v2.15.0~bpo9+1" "Debian Package Checker"
.\" 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"
Lintian::Collect::Binary \- Lintian interface to binary package data collection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    my ($name, $type, $dir) = (\*(Aqfoobar\*(Aq, \*(Aqbinary\*(Aq, \*(Aq/path/to/lab\-entry\*(Aq);
\&    my $collect = Lintian::Collect\->new ($name, $type, $dir);
\&    if ($collect\->native) {
\&        print "Package is native\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Lintian::Collect::Binary provides an interface to package data for binary
packages.  It implements data collection methods specific to binary
packages.
.PP
This module is in its infancy.  Most of Lintian still reads all data from
files in the laboratory whenever that data is needed and generates that
data via collect scripts.  The goal is to eventually access all data about
binary packages via this module so that the module can cache data where
appropriate and possibly retire collect scripts in favor of caching that
data in memory.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.IP "new (\s-1PACKAGE\s0)" 4
.IX Item "new (PACKAGE)"
Creates a new Lintian::Collect::Binary object.  Currently, \s-1PACKAGE\s0 is
ignored.  Normally, this method should not be called directly, only via
the Lintian::Collect constructor.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
In addition to the instance methods listed below, all instance methods
documented in the Lintian::Collect and the
Lintian::Collect::Package modules are also available.
.IP "native" 4
.IX Item "native"
Returns true if the binary package is native and false otherwise.
Nativeness will be judged by the source version number.
.Sp
If the version number is absent, this will return false (as
native packages are a lot rarer than non-native ones).
.Sp
Needs-Info requirements for using \fInative\fR: Same as field
.IP "changelog" 4
.IX Item "changelog"
Returns the changelog of the binary package as a Parse::DebianChangelog
object, or undef if the changelog doesn't exist.  The changelog-file
collection script must have been run to create the changelog file, which
this method expects to find in \fIchangelog\fR.
.Sp
Needs-Info requirements for using \fIchangelog\fR: changelog-file
.IP "control ([\s-1FILE\s0])" 4
.IX Item "control ([FILE])"
\&\fBThis method is deprecated\fR.  Consider using
\&\*(L"control_index_resolved_path(\s-1PATH\s0)\*(R" instead, which returns
Lintian::Path objects.
.Sp
Returns the path to \s-1FILE\s0 in the control.tar.gz.  \s-1FILE\s0 must be either a
Lintian::Path object (>= 2.5.13~) or a string denoting the
requested path.  In the latter case, the path must be relative to the
root of the control.tar.gz member and should be normalized.
.Sp
It is not permitted for \s-1FILE\s0 to be \f(CW\*(C`undef\*(C'\fR.  If the \*(L"root\*(R" dir is
desired either invoke this method without any arguments at all, pass
it the correct Lintian::Path or the empty string.
.Sp
To get a list of entries in the control.tar.gz or the file meta data
of the entries (as path objects), see
\&\*(L"sorted_control_index\*(R" and \*(L"control_index (\s-1FILE\s0)\*(R".
.Sp
The caveats of unpacked
also apply to this method.  However, as the control.tar.gz is not
known to contain symlinks, a simple file type check is usually enough.
.Sp
Needs-Info requirements for using \fIcontrol\fR: bin-pkg-control
.IP "control_index (\s-1FILE\s0)" 4
.IX Item "control_index (FILE)"
Returns a path object to \s-1FILE\s0 in the control.tar.gz.
\&\s-1FILE\s0 must be relative to the root of the control.tar.gz and must be
without leading slash (or \*(L"./\*(R").  If \s-1FILE\s0 is not in the
control.tar.gz, it returns \f(CW\*(C`undef\*(C'\fR.
.Sp
To get a list of entries in the control.tar.gz, see
\&\*(L"sorted_control_index\*(R".  To actually access the underlying file
(e.g. the contents), use \*(L"control ([\s-1FILE\s0])\*(R".
.Sp
Note that the \*(L"root directory\*(R" (denoted by the empty string) will
always be present, even if the underlying tarball omits it.
.Sp
Needs-Info requirements for using \fIcontrol_index\fR: bin-pkg-control
.IP "sorted_control_index" 4
.IX Item "sorted_control_index"
Returns a sorted array of file names listed in the control.tar.gz.
The names will not have a leading slash (or \*(L"./\*(R") and can be passed
to \*(L"control ([\s-1FILE\s0])\*(R" or \*(L"control_index (\s-1FILE\s0)\*(R" as is.
.Sp
The array will not contain the entry for the \*(L"root\*(R" of the
control.tar.gz.
.Sp
Needs-Info requirements for using \fIsorted_control_index\fR: Same as control_index
.IP "control_index_resolved_path(\s-1PATH\s0)" 4
.IX Item "control_index_resolved_path(PATH)"
Resolve \s-1PATH \s0(relative to the root of the package) and return the
entry denoting the resolved path.
.Sp
The resolution is done using
resolve_path.
.Sp
Needs-Info requirements for using \fIcontrol_index_resolved_path\fR: Same as control_index
.IP "strings (\s-1FILE\s0)" 4
.IX Item "strings (FILE)"
Returns an open handle, which will read the data from coll/strings for
\&\s-1FILE. \s0 If coll/strings did not collect any strings about \s-1FILE,\s0 this
returns an open read handle with no content.
.Sp
Caller is responsible for closing the handle either way.
.Sp
Needs-Info requirements for using \fIstrings\fR: strings
.IP "scripts" 4
.IX Item "scripts"
Returns a hashref mapping a \s-1FILE\s0 to its script/interpreter information
(if \s-1FILE\s0 is a script).  If \s-1FILE\s0 is not a script, it is not in the hash
(and callers should use exists to test membership to ensure this
invariant holds).
.Sp
The value for a given \s-1FILE\s0 consists of a table with the following keys
(and associated value):
.RS 4
.IP "calls_env" 4
.IX Item "calls_env"
Returns a truth value if the script uses env (/usr/bin/env or
/bin/env) in the \*(L"#!\*(R".  Otherwise it is \f(CW\*(C`undef\*(C'\fR.
.IP "interpreter" 4
.IX Item "interpreter"
This is the interpreter used.  If calls_env is true, this will be the
first argument to env.  Otherwise it will be the command listed after
the \*(L"#!\*(R".
.Sp
\&\s-1NB:\s0 Some template files have \*(L"#!\*(R" lines like \*(L"#!@PERL@\*(R" or \*(L"#!perl\*(R".
In this case, this value will be \f(CW@PERL\fR@ or perl (respectively).
.IP "name" 4
.IX Item "name"
Return the file name of the script.  This will be identical to key to
look up this table.
.RE
.RS 4
.Sp
Needs-Info requirements for using \fIscripts\fR: scripts
.RE
.IP "objdump_info" 4
.IX Item "objdump_info"
Returns a hashref mapping a \s-1FILE\s0 to the data collected by objdump-info
or \f(CW\*(C`undef\*(C'\fR if no data is available for that \s-1FILE. \s0 Data is generally
only collected for \s-1ELF\s0 files.
.Sp
Needs-Info requirements for using \fIobjdump_info\fR: objdump-info
.IP "hardening_info" 4
.IX Item "hardening_info"
Returns a hashref mapping a \s-1FILE\s0 to its hardening issues.
.Sp
\&\s-1NB:\s0 This is generally only useful for checks/binaries to emit the
hardening\-no\-* tags.
.Sp
Needs-Info requirements for using \fIhardening_info\fR: hardening-info
.IP "java_info" 4
.IX Item "java_info"
Returns a hashref containing information about \s-1JAR\s0 files found in
binary packages, in the form \fIfile name\fR \-> \fIinfo\fR, where \fIinfo\fR is
a hash containing the following keys:
.RS 4
.IP "manifest" 4
.IX Item "manifest"
A hash containing the contents of the \s-1JAR\s0 file manifest. For instance,
to find the classpath of \fI\f(CI$file\fI\fR, you could use:
.Sp
.Vb 4
\& if (exists $info\->java_info\->{$file}{\*(Aqmanifest\*(Aq}) {
\&     my $cp = $info\->java_info\->{$file}{\*(Aqmanifest\*(Aq}{\*(AqClass\-Path\*(Aq};
\&     # ...
\& }
.Ve
.Sp
\&\s-1NB:\s0 Not all jar files have a manifest.  For those without, this will
value will not be available.  Use exists (rather than defined) to
check for it.
.IP "files" 4
.IX Item "files"
A table of the files in the \s-1JAR. \s0 Each key is a file name and its value
is its \*(L"Major class version\*(R" for Java or \*(L"\-\*(R" if it is not a class file.
.IP "error" 4
.IX Item "error"
If it exists, this is an error that occurred during reading of the zip
file.  If it exists, it is unlikely that the other fields will be
present.
.RE
.RS 4
.Sp
Needs-Info requirements for using \fIjava_info\fR: java-info
.RE
.IP "relation (\s-1FIELD\s0)" 4
.IX Item "relation (FIELD)"
Returns a Lintian::Relation object for the specified \s-1FIELD,\s0 which should
be one of the possible relationship fields of a Debian package or one of
the following special values:
.RS 4
.IP "all" 4
.IX Item "all"
The concatenation of Pre-Depends, Depends, Recommends, and Suggests.
.IP "strong" 4
.IX Item "strong"
The concatenation of Pre-Depends and Depends.
.IP "weak" 4
.IX Item "weak"
The concatenation of Recommends and Suggests.
.RE
.RS 4
.Sp
If \s-1FIELD\s0 isn't present in the package, the returned Lintian::Relation
object will be empty (always satisfied and implies nothing).
.Sp
Needs-Info requirements for using \fIrelation\fR: Same as field
.RE
.IP "is_pkg_class ([\s-1TYPE\s0])" 4
.IX Item "is_pkg_class ([TYPE])"
Returns a truth value if the package is the given \s-1TYPE\s0 of special
package.  \s-1TYPE\s0 can be one of \*(L"transitional\*(R", \*(L"debug\*(R" or \*(L"any-meta\*(R".
If omitted it defaults to \*(L"any-meta\*(R".  The semantics for these values
are:
.RS 4
.IP "transitional" 4
.IX Item "transitional"
The package is (probably) a transitional package (e.g. it is probably
empty, just depend on stuff will eventually disappear.)
.Sp
Guessed from package description.
.IP "any-meta" 4
.IX Item "any-meta"
This package is (probably) some kind of meta or task package.  A meta
package is usually empty and just depend on stuff.  It will also
return a truth value for \*(L"tasks\*(R" (i.e. tasksel \*(L"tasks\*(R").
.Sp
A transitional package will also match this.
.Sp
Guessed from package description, section or package name.
.IP "debug" 4
.IX Item "debug"
The package is (probably) a package containing debug symbols.
.Sp
Guessed from the package name.
.IP "auto-generated" 4
.IX Item "auto-generated"
The package is (probably) a package generated automatically (e.g. a
dbgsym package)
.Sp
Guessed from the \*(L"Auto-Built-Package\*(R" field.
.RE
.RS 4
.Sp
Needs-Info requirements for using \fIis_pkg_class\fR: Same as field
.RE
.IP "is_conffile (\s-1FILE\s0)" 4
.IX Item "is_conffile (FILE)"
Returns a truth value if \s-1FILE\s0 is listed in the conffiles control file.
If the control file is not present or \s-1FILE\s0 is not listed in it, it
returns \f(CW\*(C`undef\*(C'\fR.
.Sp
Note that \s-1FILE\s0 should be the filename relative to the package root
(even though the control file uses absolute paths).  If the control
file does relative paths, they are assumed to be relative to the
package root as well (and used without warning).
.Sp
Needs-Info requirements for using \fIis_conffile\fR: Same as control_index_resolved_path
.SH "AUTHOR"
.IX Header "AUTHOR"
Originally written by Frank Lichtenheld <djpig@debian.org> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIlintian\fR\|(1), Lintian::Collect, Lintian::Relation