/usr/share/doc/lintian/api.html/Lintian/Collect/Binary.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 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><title>Lintian::Collect::Binary</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::Collect::Binary - Lintian interface to binary package data collection</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>
<pre> my ($name, $type, $dir) = ('foobar', 'binary', '/path/to/lab-entry');
my $collect = Lintian::Collect->new ($name, $type, $dir);
if ($collect->native) {
print "Package is native\n";
}</pre>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>Lintian::Collect::Binary provides an interface to package data for binary packages. It implements data collection methods specific to binary packages.</p>
<p>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.</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_(PACKAGE)"
>new (PACKAGE)</a></dt>
<dd>
<p>Creates a new Lintian::Collect::Binary object. Currently, PACKAGE is ignored. Normally, this method should not be called directly, only via the <a href="../../Lintian/Collect.html" class="podlinkpod"
>Lintian::Collect</a> constructor.</p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="INSTANCE_METHODS"
>INSTANCE METHODS</a></h1>
<p>In addition to the instance methods listed below, all instance methods documented in the <a href="../../Lintian/Collect.html" class="podlinkpod"
>Lintian::Collect</a> and the <a href="../../Lintian/Collect/Package.html" class="podlinkpod"
>Lintian::Collect::Package</a> modules are also available.</p>
<dl>
<dt><a name="native"
>native</a></dt>
<dd>
<p>Returns true if the binary package is native and false otherwise. Nativeness will be judged by its version number.</p>
<p>If the version number is absent, this will return false (as native packages are a lot rarer than non-native ones).</p>
<p>Needs-Info requirements for using <i>native</i>: <a href="../../Lintian/Collect.html#field_(%5BFIELD%5B%2C_DEFAULT%5D%5D)" class="podlinkpod"
>Same as field</a></p>
<dt><a name="changelog"
>changelog</a></dt>
<dd>
<p>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 <em>changelog</em>.</p>
<p>Needs-Info requirements for using <i>changelog</i>: changelog-file</p>
<dt><a name="control_([FILE])"
>control ([FILE])</a></dt>
<dd>
<p><b>This method is deprecated</b>. Consider using <a href="#control_index_resolved_path(PATH)" class="podlinkpod"
>"control_index_resolved_path(PATH)"</a> instead, which returns <a href="../../Lintian/Path.html" class="podlinkpod"
>Lintian::Path</a> objects.</p>
<p>Returns the path to FILE in the control.tar.gz. FILE must be either a <a href="../../Lintian/Path.html" class="podlinkpod"
>Lintian::Path</a> 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.</p>
<p>It is not permitted for FILE to be <code>undef</code>. If the "root" dir is desired either invoke this method without any arguments at all, pass it the correct <a href="../../Lintian/Path.html" class="podlinkpod"
>Lintian::Path</a> or the empty string.</p>
<p>To get a list of entries in the control.tar.gz or the file meta data of the entries (as <a href="../../Lintian/Path.html" class="podlinkpod"
>path objects</a>), see <a href="#sorted_control_index" class="podlinkpod"
>"sorted_control_index"</a> and <a href="#control_index_(FILE)" class="podlinkpod"
>"control_index (FILE)"</a>.</p>
<p>The caveats of <a href="../../Lintian/Collect/Package.html#unpacked_(%5BFILE%5D)" class="podlinkpod"
>unpacked</a> 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.</p>
<p>Needs-Info requirements for using <i>control</i>: bin-pkg-control</p>
<dt><a name="control_index_(FILE)"
>control_index (FILE)</a></dt>
<dd>
<p>Returns a <a href="../../Lintian/Path.html" class="podlinkpod"
>path object</a> to FILE in the control.tar.gz. FILE must be relative to the root of the control.tar.gz and must be without leading slash (or "./"). If FILE is not in the control.tar.gz, it returns <code>undef</code>.</p>
<p>To get a list of entries in the control.tar.gz, see <a href="#sorted_control_index" class="podlinkpod"
>"sorted_control_index"</a>. To actually access the underlying file (e.g. the contents), use <a href="#control_(%5BFILE%5D)" class="podlinkpod"
>"control ([FILE])"</a>.</p>
<p>Note that the "root directory" (denoted by the empty string) will always be present, even if the underlying tarball omits it.</p>
<p>Needs-Info requirements for using <i>control_index</i>: bin-pkg-control</p>
<dt><a name="sorted_control_index"
>sorted_control_index</a></dt>
<dd>
<p>Returns a sorted array of file names listed in the control.tar.gz. The names will not have a leading slash (or "./") and can be passed to <a href="#control_(%5BFILE%5D)" class="podlinkpod"
>"control ([FILE])"</a> or <a href="#control_index_(FILE)" class="podlinkpod"
>"control_index (FILE)"</a> as is.</p>
<p>The array will not contain the entry for the "root" of the control.tar.gz.</p>
<p>Needs-Info requirements for using <i>sorted_control_index</i>: <a href="#control_index_(FILE)" class="podlinkpod"
>Same as control_index</a></p>
<dt><a name="control_index_resolved_path(PATH)"
>control_index_resolved_path(PATH)</a></dt>
<dd>
<p>Resolve PATH (relative to the root of the package) and return the <a href="../../Lintian/Path.html" class="podlinkpod"
>entry</a> denoting the resolved path.</p>
<p>The resolution is done using <a href="../../Lintian/Path.html#resolve_path(%5BPATH%5D)" class="podlinkpod"
>resolve_path</a>.</p>
<p>Needs-Info requirements for using <i>control_index_resolved_path</i>: <a href="#control_index_(FILE)" class="podlinkpod"
>Same as control_index</a></p>
<dt><a name="strings_(FILE)"
>strings (FILE)</a></dt>
<dd>
<p>Returns an open handle, which will read the data from coll/strings for FILE. If coll/strings did not collect any strings about FILE, this returns an open read handle with no content.</p>
<p>Caller is responsible for closing the handle either way.</p>
<p>Needs-Info requirements for using <i>strings</i>: strings</p>
<dt><a name="scripts"
>scripts</a></dt>
<dd>
<p>Returns a hashref mapping a FILE to its script/interpreter information (if FILE is a script). If FILE is not a script, it is not in the hash (and callers should use exists to test membership to ensure this invariant holds).</p>
<p>The value for a given FILE consists of a table with the following keys (and associated value):</p>
<dl>
<dt><a name="calls_env"
>calls_env</a></dt>
<dd>
<p>Returns a truth value if the script uses env (/usr/bin/env or /bin/env) in the "#!". Otherwise it is <code>undef</code>.</p>
<dt><a name="interpreter"
>interpreter</a></dt>
<dd>
<p>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 "#!".</p>
<p>NB: Some template files have "#!" lines like "#!@PERL@" or "#!perl". In this case, this value will be @PERL@ or perl (respectively).</p>
<dt><a name="name"
>name</a></dt>
<dd>
<p>Return the file name of the script. This will be identical to key to look up this table.</p>
</dd>
</dl>
<p>Needs-Info requirements for using <i>scripts</i>: scripts</p>
<dt><a name="objdump_info"
>objdump_info</a></dt>
<dd>
<p>Returns a hashref mapping a FILE to the data collected by objdump-info or <code>undef</code> if no data is available for that FILE. Data is generally only collected for ELF files.</p>
<p>Needs-Info requirements for using <i>objdump_info</i>: objdump-info</p>
<dt><a name="hardening_info"
>hardening_info</a></dt>
<dd>
<p>Returns a hashref mapping a FILE to its hardening issues.</p>
<p>NB: This is generally only useful for checks/binaries to emit the hardening-no-* tags.</p>
<p>Needs-Info requirements for using <i>hardening_info</i>: hardening-info</p>
<dt><a name="java_info"
>java_info</a></dt>
<dd>
<p>Returns a hashref containing information about JAR files found in binary packages, in the form <i>file name</i> -> <i>info</i>, where <i>info</i> is a hash containing the following keys:</p>
<dl>
<dt><a name="manifest"
>manifest</a></dt>
<dd>
<p>A hash containing the contents of the JAR file manifest. For instance, to find the classpath of <i>$file</i>, you could use:</p>
<pre> if (exists $info->java_info->{$file}{'manifest'}) {
my $cp = $info->java_info->{$file}{'manifest'}{'Class-Path'};
# ...
}</pre>
<p>NB: 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.</p>
<dt><a name="files"
>files</a></dt>
<dd>
<p>A table of the files in the JAR. Each key is a file name and its value is its "Major class version" for Java or "-" if it is not a class file.</p>
<dt><a name="error"
>error</a></dt>
<dd>
<p>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.</p>
</dd>
</dl>
<p>Needs-Info requirements for using <i>java_info</i>: java-info</p>
<dt><a name="relation_(FIELD)"
>relation (FIELD)</a></dt>
<dd>
<p>Returns a <a href="../../Lintian/Relation.html" class="podlinkpod"
>Lintian::Relation</a> object for the specified FIELD, which should be one of the possible relationship fields of a Debian package or one of the following special values:</p>
<dl>
<dt><a name="all"
>all</a></dt>
<dd>
<p>The concatenation of Pre-Depends, Depends, Recommends, and Suggests.</p>
<dt><a name="strong"
>strong</a></dt>
<dd>
<p>The concatenation of Pre-Depends and Depends.</p>
<dt><a name="weak"
>weak</a></dt>
<dd>
<p>The concatenation of Recommends and Suggests.</p>
</dd>
</dl>
<p>If FIELD isn't present in the package, the returned Lintian::Relation object will be empty (always satisfied and implies nothing).</p>
<p>Needs-Info requirements for using <i>relation</i>: <a href="../../Lintian/Collect.html#field_(%5BFIELD%5B%2C_DEFAULT%5D%5D)" class="podlinkpod"
>Same as field</a></p>
<dt><a name="is_pkg_class_([TYPE])"
>is_pkg_class ([TYPE])</a></dt>
<dd>
<p>Returns a truth value if the package is the given TYPE of special package. TYPE can be one of "transitional", "debug" or "any-meta". If omitted it defaults to "any-meta". The semantics for these values are:</p>
<dl>
<dt><a name="transitional"
>transitional</a></dt>
<dd>
<p>The package is (probably) a transitional package (e.g. it is probably empty, just depend on stuff will eventually disappear.)</p>
<p>Guessed from package description.</p>
<dt><a name="any-meta"
>any-meta</a></dt>
<dd>
<p>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 "tasks" (i.e. tasksel "tasks").</p>
<p>A transitional package will also match this.</p>
<p>Guessed from package description, section or package name.</p>
<dt><a name="debug"
>debug</a></dt>
<dd>
<p>The package is (probably) a package containing debug symbols.</p>
<p>Guessed from the package name.</p>
</dd>
</dl>
<p>Needs-Info requirements for using <i>is_pkg_class</i>: <a href="../../Lintian/Collect.html#field_(%5BFIELD%5B%2C_DEFAULT%5D%5D)" class="podlinkpod"
>Same as field</a></p>
<dt><a name="is_conffile_(FILE)"
>is_conffile (FILE)</a></dt>
<dd>
<p>Returns a truth value if FILE is listed in the conffiles control file. If the control file is not present or FILE is not listed in it, it returns <code>undef</code>.</p>
<p>Note that FILE 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).</p>
<p>Needs-Info requirements for using <i>is_conffile</i>: <a href="#control_index_resolved_path(PATH)" class="podlinkpod"
>Same as control_index_resolved_path</a></p>
</dd>
</dl>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Originally written by Frank Lichtenheld <djpig@debian.org> 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), <a href="../../Lintian/Collect.html" class="podlinkpod"
>Lintian::Collect</a>, <a href="../../Lintian/Relation.html" class="podlinkpod"
>Lintian::Relation</a></p>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
|