.\" Automatically generated by Pod::Man 4.10 (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 "Lintian::CollScript 3"
.TH Lintian::CollScript 3 "2020-02-26" "Lintian v2.55.0~bpo10+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::CollScript \- Collection script handle
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Lintian::CollScript;
\&
\& my $cs = Lintian::CollScript\->new ("$ENV{\*(AqLINTIAN_ROOT\*(Aq}/collection/index.desc");
\& my $name = $cs\->name;
\& foreach my $needs ($cs\->needs_info) {
\&    print "$name needs $needs\en";
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Instances of this class represents the data in the collection \*(L".desc\*(R"
files.  It allows access to the common meta data of the collection
(such as Needs-Info).
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.IP "new (\s-1FILE\s0)" 4
.IX Item "new (FILE)"
Parse \s-1FILE\s0 as a collection desc file.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.IP "name" 4
.IX Item "name"
Returns the \*(L"name\*(R" of the collection script.  This is the value in the
Collector-Script field in the file.
.IP "type" 4
.IX Item "type"
Returns the value stored in the \*(L"Type\*(R" field of the file.  For the
purpose of testing if the collection applies to a given package type,
the \*(L"is_type\*(R" method can be used instead.
.IP "script_path" 4
.IX Item "script_path"
Returns the absolute path to the collection script.
.IP "interface" 4
.IX Item "interface"
The call interface for this collection script.
.RS 4
.IP "exec" 4
.IX Item "exec"
The collection is run by invoking the script denoted by script_path
with the proper arguments.
.Sp
This is the default value.
.IP "perl-coll" 4
.IX Item "perl-coll"
The collection is implemented in Perl in such a way that it can be
loaded into perl and run via the \*(L"collect (\s-1PKG, TASK, DIR\s0)\*(R" method.
.Sp
Collections that have the \*(L"perl-coll\*(R" can also be run as if they had
the \*(L"exec\*(R" interface (see above).
.RE
.RS 4
.RE
.IP "needs_info ([\s-1COND\s0])" 4
.IX Item "needs_info ([COND])"
Returns a list of all items listed in the Needs-Info field.  Neither
the list nor its contents should be modified.
.Sp
\&\s-1COND\s0 is optional and used to determine what conditions are true.  If
omitted, all \*(L"extra\*(R" dependencies are returned.  Otherwise, only the
dependencies required by \s-1COND\s0 are included.  \s-1COND\s0 is a hashref and
with the following key/values:
.RS 4
.IP "type" 4
.IX Item "type"
The value is a package type that determines which package type is
being unpacked.  This is used to determine if the condition for
\&\*(L"<dep> [<type>]\*(R" relations are true or not.
.RE
.RS 4
.RE
.IP "is_type (\s-1TYPE\s0)" 4
.IX Item "is_type (TYPE)"
Returns a truth value if this collection can be applied to a \s-1TYPE\s0 package.
.IP "collect (\s-1PKG, TASK, DIR\s0)" 4
.IX Item "collect (PKG, TASK, DIR)"
.SH "AUTHOR"
.IX Header "AUTHOR"
Originally written by Niels Thykier <niels@thykier.net> for Lintian.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlintian\fR\|(1), \fBLintian::Profile\fR\|(3), \fBLintian::Tag::Info\fR\|(3)