/usr/share/doc/libxkbcommon-dev/group__include-path.html is in libxkbcommon-dev 0.7.1-2~deb9u1.
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 | <!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>libxkbcommon: Include Paths</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" />
<link href="doxygen-extra.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">libxkbcommon
 <span id="projectnumber">0.7.1</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Include Paths</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga75363558fde874b0e2161218e903d779"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#ga75363558fde874b0e2161218e903d779">xkb_context::xkb_context_include_path_append</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, const char *path)</td></tr>
<tr class="separator:ga75363558fde874b0e2161218e903d779"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a527a8a799fed9ad0b09d306ceab691"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#ga6a527a8a799fed9ad0b09d306ceab691">xkb_context::xkb_context_include_path_append_default</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:ga6a527a8a799fed9ad0b09d306ceab691"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb44086e732181e9adabd72c14f54dbd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#gaeb44086e732181e9adabd72c14f54dbd">xkb_context::xkb_context_include_path_reset_defaults</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:gaeb44086e732181e9adabd72c14f54dbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab77ea9cab1ab3cd9e2fc33576d096d70"><td class="memItemLeft" align="right" valign="top"><a id="gab77ea9cab1ab3cd9e2fc33576d096d70"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#gab77ea9cab1ab3cd9e2fc33576d096d70">xkb_context::xkb_context_include_path_clear</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:gab77ea9cab1ab3cd9e2fc33576d096d70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13667d420e59c62a6439b4955b36f24b"><td class="memItemLeft" align="right" valign="top"><a id="ga13667d420e59c62a6439b4955b36f24b"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#ga13667d420e59c62a6439b4955b36f24b">xkb_context::xkb_context_num_include_paths</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:ga13667d420e59c62a6439b4955b36f24b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga256a1bcc4175aa98ffed9f3c121a60f7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__include-path.html#ga256a1bcc4175aa98ffed9f3c121a60f7">xkb_context::xkb_context_include_path_get</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, unsigned int index)</td></tr>
<tr class="separator:ga256a1bcc4175aa98ffed9f3c121a60f7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Manipulating the include paths in a context. </p>
<p>The include paths are the file-system paths that are searched when an include statement is encountered during keymap compilation.</p>
<p>The default include paths are:</p><ul>
<li>The system XKB root, defined at library configuration time. If * the <code>XKB_CONFIG_ROOT</code> environment is defined, it is used instead.</li>
<li>The path <code>$HOME/.xkb</code>, where $HOME is the value of the environment variable <code>HOME</code>. </li>
</ul>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga75363558fde874b0e2161218e903d779"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75363558fde874b0e2161218e903d779">◆ </a></span>xkb_context_include_path_append()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xkb_context_include_path_append </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Append a new entry to the context's include path. </p>
<dl class="section return"><dt>Returns</dt><dd>1 on success, or 0 if the include path could not be added or is inaccessible. </dd></dl>
</div>
</div>
<a id="ga6a527a8a799fed9ad0b09d306ceab691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a527a8a799fed9ad0b09d306ceab691">◆ </a></span>xkb_context_include_path_append_default()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xkb_context_include_path_append_default </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Append the default include paths to the context's include path. </p>
<dl class="section return"><dt>Returns</dt><dd>1 on success, or 0 if the primary include path could not be added. </dd></dl>
</div>
</div>
<a id="gaeb44086e732181e9adabd72c14f54dbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb44086e732181e9adabd72c14f54dbd">◆ </a></span>xkb_context_include_path_reset_defaults()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xkb_context_include_path_reset_defaults </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the context's include path to the default. </p>
<p>Removes all entries from the context's include path, and inserts the default paths.</p>
<dl class="section return"><dt>Returns</dt><dd>1 on success, or 0 if the primary include path could not be added. </dd></dl>
</div>
</div>
<a id="ga256a1bcc4175aa98ffed9f3c121a60f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga256a1bcc4175aa98ffed9f3c121a60f7">◆ </a></span>xkb_context_include_path_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xkb_context_include_path_get </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a specific include path from the context's include path. </p>
<dl class="section return"><dt>Returns</dt><dd>The include path at the specified index. If the index is invalid, returns NULL. </dd></dl>
</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>
|