0xV3NOMx
Linux ip-172-26-7-228 5.4.0-1103-aws #111~18.04.1-Ubuntu SMP Tue May 23 20:04:10 UTC 2023 x86_64



Your IP : 18.218.27.145


Current Path : /usr/share/doc/lintian/api.html/Lintian/
Upload File :
Current File : //usr/share/doc/lintian/api.html/Lintian/CollScript.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::CollScript</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="blkmagw" type="text/css" href="../_blkmagw.css" media="all" >
<link rel="alternate stylesheet" title="blkcynw" type="text/css" href="../_blkcynw.css" media="all" >
<link rel="alternate stylesheet" title="whtprpk" type="text/css" href="../_whtprpk.css" media="all" >
<link rel="alternate stylesheet" title="whtnavk" type="text/css" href="../_whtnavk.css" media="all" >
<link rel="alternate stylesheet" title="grygrnk" type="text/css" href="../_grygrnk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="blkgrng" type="text/css" href="../_blkgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >
<link rel="alternate stylesheet" title="blkbluw" type="text/css" href="../_blkbluw.css" media="all" >
<link rel="alternate stylesheet" title="whtpurk" type="text/css" href="../_whtpurk.css" media="all" >
<link rel="alternate stylesheet" title="whtgrng" type="text/css" href="../_whtgrng.css" media="all" >
<link rel="alternate stylesheet" title="grygrnw" type="text/css" href="../_grygrnw.css" media="all" >

<script type="text/javascript" src="../_podly.js"></script>

</head>
<body class='pod'>

<!-- start doc -->
<p class="backlinktop"><b><a name="___top" href="../index.html" accesskey="1" title="All Documents">&lt;&lt;</a></b></p>

<div class='indexgroup'>
<ul   class='indexList indexList1'>
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
  <li class='indexItem indexItem1'><a href='#CLASS_METHODS'>CLASS METHODS</a>
  <li class='indexItem indexItem1'><a href='#INSTANCE_METHODS'>INSTANCE METHODS</a>
  <li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
  <li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>

<p>Lintian::CollScript - Collection script handle</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre> use Lintian::CollScript;

 my $cs = Lintian::CollScript-&#62;new (&#34;$ENV{&#39;LINTIAN_ROOT&#39;}/collection/index.desc&#34;);
 my $name = $cs-&#62;name;
 foreach my $needs ($cs-&#62;needs_info) {
    print &#34;$name needs $needs\n&#34;;
 }</pre>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>Instances of this class represents the data in the collection &#34;.desc&#34; files. It allows access to the common meta data of the collection (such as Needs-Info).</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="CLASS_METHODS"
>CLASS METHODS</a></h1>

<dl>
<dt><a name="new_(FILE)"
>new (FILE)</a></dt>

<dd>
<p>Parse FILE as a collection desc file.</p>
</dd>
</dl>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTANCE_METHODS"
>INSTANCE METHODS</a></h1>

<dl>
<dt><a name="name"
>name</a></dt>

<dd>
<p>Returns the &#34;name&#34; of the collection script. This is the value in the Collector-Script field in the file.</p>

<dt><a name="type"
>type</a></dt>

<dd>
<p>Returns the value stored in the &#34;Type&#34; field of the file. For the purpose of testing if the collection applies to a given package type, the <a href="#is_type" class="podlinkpod"
>&#34;is_type&#34;</a> method can be used instead.</p>

<dt><a name="version"
>version</a></dt>

<dd>
<p>Returns the value of the &#34;Version&#34; field of the file. This should be an integer describing the version of the collector script.</p>

<dt><a name="auto_remove"
>auto_remove</a></dt>

<dd>
<p>Returns a truth value if the collection has the &#34;auto-remove&#34; flag.</p>

<dt><a name="script_path"
>script_path</a></dt>

<dd>
<p>Returns the absolute path to the collection script.</p>

<dt><a name="interface"
>interface</a></dt>

<dd>
<p>The call interface for this collection script.</p>

<dl>
<dt><a name="exec"
>exec</a></dt>

<dd>
<p>The collection is run by invoking the script denoted by script_path with the proper arguments.</p>

<p>This is the default value.</p>

<dt><a name="perl-coll"
>perl-coll</a></dt>

<dd>
<p>The collection is implemented in Perl in such a way that it can be loaded into perl and run via the <a href="#collect_(PKG%2C_TASK%2C_DIR)" class="podlinkpod"
>&#34;collect (PKG, TASK, DIR)&#34;</a> method.</p>

<p>Collections that have the &#34;perl-coll&#34; can also be run as if they had the &#34;exec&#34; interface (see above).</p>
</dd>
</dl>

<dt><a name="needs_info_([COND])"
>needs_info ([COND])</a></dt>

<dd>
<p>Returns a list of all items listed in the Needs-Info field. Neither the list nor its contents should be modified.</p>

<p>COND is optional and used to determine what conditions are true. If omitted, all &#34;extra&#34; dependencies are returned. Otherwise, only the dependencies required by COND are included. COND is a hashref and with the following key/values:</p>

<dl>
<dt><a name="type"
>type</a></dt>

<dd>
<p>The value is a package type that determines which package type is being unpacked. This is used to determine if the condition for &#34;&#60;dep&#62; [&#60;type&#62;]&#34; relations are true or not.</p>
</dd>
</dl>

<dt><a name="is_type_(TYPE)"
>is_type (TYPE)</a></dt>

<dd>
<p>Returns a truth value if this collection can be applied to a TYPE package.</p>

<dt><a name="collect_(PKG,_TASK,_DIR)"
>collect (PKG, TASK, DIR)</a></dt>
</dl>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>

<p>Originally written by Niels Thykier &#60;niels@thykier.net&#62; for Lintian.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>

<p>lintian(1), Lintian::Profile(3), Lintian::Tag::Info(3)</p>
<p class="backlinkbottom"><b><a name="___bottom" href="../index.html" title="All Documents">&lt;&lt;</a></b></p>

<!-- end doc -->

</body></html>