/usr/share/doc/liblzma-doc/html/options_8c.html is in liblzma-doc 5.2.2-1.3.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: xz/options.c File 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_53e01eec41348db90f08d9ee7e6793af.html">xz</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">options.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parser for filter-specific options.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="private_8h.html">private.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structname__id__map.html">name_id_map</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structoption__map.html">option_map</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae4d5251432e1a9e6803c0240cc492e18"><td class="memItemLeft" align="right" valign="top"><a id="ae4d5251432e1a9e6803c0240cc492e18"></a>enum  </td><td class="memItemRight" valign="bottom">{ <b>OPT_DIST</b>
}</td></tr>
<tr class="separator:ae4d5251432e1a9e6803c0240cc492e18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ff5f2dff38e7639981794c43dc9167b"><td class="memItemLeft" align="right" valign="top"><a id="a7ff5f2dff38e7639981794c43dc9167b"></a>enum  </td><td class="memItemRight" valign="bottom">{ <b>OPT_START_OFFSET</b>
}</td></tr>
<tr class="separator:a7ff5f2dff38e7639981794c43dc9167b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabfcbcb5ac86a1edac4035264bc7d2b8"><td class="memItemLeft" align="right" valign="top"><a id="aabfcbcb5ac86a1edac4035264bc7d2b8"></a>enum  </td><td class="memItemRight" valign="bottom">{ <br />
  <b>OPT_PRESET</b>,
<b>OPT_DICT</b>,
<b>OPT_LC</b>,
<b>OPT_LP</b>,
<br />
  <b>OPT_PB</b>,
<b>OPT_MODE</b>,
<b>OPT_NICE</b>,
<b>OPT_MF</b>,
<br />
  <b>OPT_DEPTH</b>
<br />
}</td></tr>
<tr class="separator:aabfcbcb5ac86a1edac4035264bc7d2b8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a329ca50e0955eb59fcda39617f76b202"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="options_8c.html#a329ca50e0955eb59fcda39617f76b202">parse_options</a> (const char *str, const <a class="el" href="structoption__map.html">option_map</a> *opts, void(*set)(void *filter_options, unsigned key, uint64_t value, const char *valuestr), void *filter_options)</td></tr>
<tr class="separator:a329ca50e0955eb59fcda39617f76b202"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3913d1fbeefd478d996e2c2a34a9c9c"><td class="memItemLeft" align="right" valign="top"><a id="ac3913d1fbeefd478d996e2c2a34a9c9c"></a>
static void </td><td class="memItemRight" valign="bottom"><b>set_delta</b> (void *options, unsigned key, uint64_t value, const char *valuestr <a class="el" href="memcmplen_8h.html#a157d11c2c46feafcc7a602313ff1a1e6">lzma_attribute</a>((__unused__)))</td></tr>
<tr class="separator:ac3913d1fbeefd478d996e2c2a34a9c9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb75b1d0565a4c9372b2ff3d7cbd6898"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlzma__options__delta.html">lzma_options_delta</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="options_8c.html#aeb75b1d0565a4c9372b2ff3d7cbd6898">options_delta</a> (const char *str)</td></tr>
<tr class="memdesc:aeb75b1d0565a4c9372b2ff3d7cbd6898"><td class="mdescLeft"> </td><td class="mdescRight">Parser for Delta options. <a href="#aeb75b1d0565a4c9372b2ff3d7cbd6898">More...</a><br /></td></tr>
<tr class="separator:aeb75b1d0565a4c9372b2ff3d7cbd6898"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6b8ba410f28688130095e704aad6172"><td class="memItemLeft" align="right" valign="top"><a id="af6b8ba410f28688130095e704aad6172"></a>
static void </td><td class="memItemRight" valign="bottom"><b>set_bcj</b> (void *options, unsigned key, uint64_t value, const char *valuestr <a class="el" href="memcmplen_8h.html#a157d11c2c46feafcc7a602313ff1a1e6">lzma_attribute</a>((__unused__)))</td></tr>
<tr class="separator:af6b8ba410f28688130095e704aad6172"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90111e8a8652cc28be7ca9763ed588d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlzma__options__bcj.html">lzma_options_bcj</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="options_8c.html#a90111e8a8652cc28be7ca9763ed588d5">options_bcj</a> (const char *str)</td></tr>
<tr class="memdesc:a90111e8a8652cc28be7ca9763ed588d5"><td class="mdescLeft"> </td><td class="mdescRight">Parser for BCJ options. <a href="#a90111e8a8652cc28be7ca9763ed588d5">More...</a><br /></td></tr>
<tr class="separator:a90111e8a8652cc28be7ca9763ed588d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1957d0c8f6ec2eb4950e67226425ee7c"><td class="memItemLeft" align="right" valign="top"><a id="a1957d0c8f6ec2eb4950e67226425ee7c"></a>
static void </td><td class="memItemRight" valign="bottom"><b>lzma_attribute</b> ((__noreturn__))</td></tr>
<tr class="separator:a1957d0c8f6ec2eb4950e67226425ee7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16b1232f2f40a8a9a96cc5985898a58d"><td class="memItemLeft" align="right" valign="top"><a id="a16b1232f2f40a8a9a96cc5985898a58d"></a>
static void </td><td class="memItemRight" valign="bottom"><b>set_lzma</b> (void *options, unsigned key, uint64_t value, const char *valuestr)</td></tr>
<tr class="separator:a16b1232f2f40a8a9a96cc5985898a58d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80e4a9dd89d3f2fab00c48c4feb75126"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="options_8c.html#a80e4a9dd89d3f2fab00c48c4feb75126">options_lzma</a> (const char *str)</td></tr>
<tr class="memdesc:a80e4a9dd89d3f2fab00c48c4feb75126"><td class="mdescLeft"> </td><td class="mdescRight">Parser for LZMA options. <a href="#a80e4a9dd89d3f2fab00c48c4feb75126">More...</a><br /></td></tr>
<tr class="separator:a80e4a9dd89d3f2fab00c48c4feb75126"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parser for filter-specific options. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a329ca50e0955eb59fcda39617f76b202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a329ca50e0955eb59fcda39617f76b202">◆ </a></span>parse_options()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void parse_options </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structoption__map.html">option_map</a> * </td>
<td class="paramname"><em>opts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *filter_options, unsigned key, uint64_t value, const char *valuestr) </td>
<td class="paramname"><em>set</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>filter_options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses option=value pairs that are separated with commas: opt=val,opt=val,opt=val</p>
<p>Each option is a string, that is converted to an integer using the index where the option string is in the array.</p>
<p>Value can be</p><ul>
<li>a string-id map mapping a list of possible string values to integers (opts[i].map != NULL, opts[i].min and opts[i].max are ignored);</li>
<li>a number with minimum and maximum value limit (opts[i].map == NULL && opts[i].min != UINT64_MAX);</li>
<li>a string that will be parsed by the filter-specific code (opts[i].map == NULL && opts[i].min == UINT64_MAX, opts[i].max ignored)</li>
</ul>
<p>When parsing both option and value succeed, a filter-specific function is called, which should update the given value to filter-specific options structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>String containing the options from the command line </td></tr>
<tr><td class="paramname">opts</td><td>Filter-specific option map </td></tr>
<tr><td class="paramname">set</td><td>Filter-specific function to update filter_options </td></tr>
<tr><td class="paramname">filter_options</td><td>Pointer to filter-specific options structure</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns only if no errors occur. </dd></dl>
<p class="reference">References <a class="el" href="message_8h.html#aff3f122bb031385c3969689f471800eb">message_fatal()</a>, and <a class="el" href="util_8c.html#a401dd8b99774c03e2dafe25f57d259e8">xstrdup()</a>.</p>
</div>
</div>
<a id="aeb75b1d0565a4c9372b2ff3d7cbd6898"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb75b1d0565a4c9372b2ff3d7cbd6898">◆ </a></span>options_delta()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlzma__options__delta.html">lzma_options_delta</a>* options_delta </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parser for Delta options. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated options structure. Doesn't return on error. </dd></dl>
</div>
</div>
<a id="a90111e8a8652cc28be7ca9763ed588d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90111e8a8652cc28be7ca9763ed588d5">◆ </a></span>options_bcj()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlzma__options__bcj.html">lzma_options_bcj</a>* options_bcj </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parser for BCJ options. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated options structure. Doesn't return on error. </dd></dl>
</div>
</div>
<a id="a80e4a9dd89d3f2fab00c48c4feb75126"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80e4a9dd89d3f2fab00c48c4feb75126">◆ </a></span>options_lzma()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a>* options_lzma </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parser for LZMA options. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated options structure. Doesn't return on error. </dd></dl>
<p class="reference">References <a class="el" href="lzma12_8h.html#acf740075f86fa61dc408d6d0dbf8fa80a7ab212446c3f6520f5c33ccfa4b3386a">LZMA_MF_BT2</a>, <a class="el" href="lzma12_8h.html#acf740075f86fa61dc408d6d0dbf8fa80a983ecc59bf3e07a7c43fea551ea11865">LZMA_MF_BT3</a>, <a class="el" href="lzma12_8h.html#acf740075f86fa61dc408d6d0dbf8fa80a468c32cdea9861d1ff98478364e6c547">LZMA_MF_BT4</a>, <a class="el" href="lzma12_8h.html#acf740075f86fa61dc408d6d0dbf8fa80a6eb38f634021a192cada8a978b5de93b">LZMA_MF_HC3</a>, <a class="el" href="lzma12_8h.html#acf740075f86fa61dc408d6d0dbf8fa80a0944620f4949289c2ebde613cae12b04">LZMA_MF_HC4</a>, <a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866ac8c0926a91b4f756e11121efd30648cc">LZMA_MODE_FAST</a>, and <a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866ad37225f30d5cd21fc8bb3eaba283bbf9">LZMA_MODE_NORMAL</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|