/usr/share/doc/lintian/api.html/Lintian/CollScript.html is in lintian 2.5.43.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | <!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"><<</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->new ("$ENV{'LINTIAN_ROOT'}/collection/index.desc");
my $name = $cs->name;
foreach my $needs ($cs->needs_info) {
print "$name needs $needs\n";
}</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 ".desc" 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 "name" 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 "Type" 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"
>"is_type"</a> method can be used instead.</p>
<dt><a name="version"
>version</a></dt>
<dd>
<p>Returns the value of the "Version" 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 "auto-remove" 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"
>"collect (PKG, TASK, DIR)"</a> method.</p>
<p>Collections that have the "perl-coll" can also be run as if they had the "exec" 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 "extra" 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 "<dep> [<type>]" 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 <niels@thykier.net> 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"><<</a></b></p>
<!-- end doc -->
</body></html>
|