/usr/share/doc/liblzma-doc/html/structlzma__filter.html is in liblzma-doc 5.1.1alpha+20120614-2ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>XZ Utils: lzma_filter Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.1.0alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">lzma_filter Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Filter options.
<a href="structlzma__filter.html#details">More...</a></p>
<p><code>#include <filter.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aef1d9709759f39e61db77547b2326929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter.html#aef1d9709759f39e61db77547b2326929">id</a></td></tr>
<tr class="memdesc:aef1d9709759f39e61db77547b2326929"><td class="mdescLeft"> </td><td class="mdescRight">Filter ID. <a href="#aef1d9709759f39e61db77547b2326929">More...</a><br/></td></tr>
<tr class="separator:aef1d9709759f39e61db77547b2326929"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10dfbaa1601793657d12320bef933ee6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter.html#a10dfbaa1601793657d12320bef933ee6">options</a></td></tr>
<tr class="memdesc:a10dfbaa1601793657d12320bef933ee6"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to filter-specific options structure. <a href="#a10dfbaa1601793657d12320bef933ee6">More...</a><br/></td></tr>
<tr class="separator:a10dfbaa1601793657d12320bef933ee6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Filter options. </p>
<p>This structure is used to pass Filter ID and a pointer filter's options to liblzma. A few functions work with a single <a class="el" href="structlzma__filter.html" title="Filter options. ">lzma_filter</a> structure, while most functions expect a filter chain.</p>
<p>A filter chain is indicated with an array of <a class="el" href="structlzma__filter.html" title="Filter options. ">lzma_filter</a> structures. The array is terminated with .id = LZMA_VLI_UNKNOWN. Thus, the filter array must have LZMA_FILTERS_MAX + 1 elements (that is, five) to be able to hold any arbitrary filter chain. This is important when using <a class="el" href="block_8h.html#a71ddd0bec506092018e407ed6f027f53" title="Decode Block Header. ">lzma_block_header_decode()</a> from <a class="el" href="block_8h.html" title=".xz Block handling ">block.h</a>, because too small array would make liblzma write past the end of the filters array. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="aef1d9709759f39e61db77547b2326929"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> lzma_filter::id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter ID. </p>
<p>Use constants whose name begin with `LZMA_FILTER_' to specify different filters. In an array of <a class="el" href="structlzma__filter.html" title="Filter options. ">lzma_filter</a> structures, use LZMA_VLI_UNKNOWN to indicate end of filters.</p>
<dl class="section note"><dt>Note</dt><dd>This is not an enum, because on some systems enums cannot be 64-bit. </dd></dl>
<p>Referenced by <a class="el" href="coder_8h.html#a8884012fc28d467d3429070f270f7171">coder_add_filter()</a>, <a class="el" href="coder_8c.html#a15b6ce144220e53107c642b3baefe9bc">is_format_lzma()</a>, <a class="el" href="easy__preset_8h.html#ae2fd3feb0515d5f984c473a7b815b02b">lzma_easy_preset()</a>, <a class="el" href="filter__encoder_8c.html#adcde5a9917d1ca033f6c1cc35c9be4fc">lzma_filters_update()</a>, <a class="el" href="lzmainfo_8c.html#a76cfa2b4fc44ede3c371981dd4e66e11">lzmainfo()</a>, <a class="el" href="message_8h.html#abb05c48d97be5905fe89b7b83b757c05">message_filters_to_str()</a>, and <a class="el" href="list_8c.html#ae8bf55be793e1ad58bc179ac19168c90">parse_block_header()</a>.</p>
</div>
</div>
<a class="anchor" id="a10dfbaa1601793657d12320bef933ee6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* lzma_filter::options</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to filter-specific options structure. </p>
<p>If the filter doesn't need options, set this to NULL. If id is set to LZMA_VLI_UNKNOWN, options is ignored, and thus doesn't need be initialized. </p>
<p>Referenced by <a class="el" href="coder_8h.html#a8884012fc28d467d3429070f270f7171">coder_add_filter()</a>, <a class="el" href="coder_8h.html#aeacfa6d5e4a572118644c263e6bd6242">coder_set_preset()</a>, <a class="el" href="coder_8c.html#a15b6ce144220e53107c642b3baefe9bc">is_format_lzma()</a>, <a class="el" href="easy__preset_8h.html#ae2fd3feb0515d5f984c473a7b815b02b">lzma_easy_preset()</a>, <a class="el" href="lzmainfo_8c.html#a76cfa2b4fc44ede3c371981dd4e66e11">lzmainfo()</a>, and <a class="el" href="message_8h.html#abb05c48d97be5905fe89b7b83b757c05">message_filters_to_str()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>liblzma/api/lzma/<a class="el" href="filter_8h.html">filter.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 12 2014 15:12:38 for XZ Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|