libgraphite2-doc 1.3.11-2 / usr / share / doc / libgraphite2-doc / html / Log_8h.html

This file is indexed.

/usr/share/doc/libgraphite2-doc/html/Log_8h.html is in libgraphite2-doc 1.3.11-2.

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
<!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>Graphiteng: Log.h 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">Graphiteng
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f8f859fb3bd89768df0930a211be597b.html">graphite2</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Log.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="Types_8h_source.html">graphite2/Types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="Font_8h_source.html">graphite2/Font.h</a>&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div>
<p><a href="Log_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:aaa8fbca84fe1747170d78750625dd8ec"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ec">GrLogMask</a> { <br />
&#160;&#160;<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8eca297b17dbfb7082d6851c3320001df7ef">GRLOG_NONE</a> = 0x0, 
<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ecaf5a1ca38905fb3b12e833aa5219985e3">GRLOG_FACE</a> = 0x01, 
<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ecaa639789ccd928f660cca0c207e0cbfb1">GRLOG_SEGMENT</a> = 0x02, 
<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8eca18f5e5a447fc2784cfe619d6f8faa5fa">GRLOG_PASS</a> = 0x04, 
<br />
&#160;&#160;<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ecad5e7b3ca9d4e594e40bd33242def6f9d">GRLOG_CACHE</a> = 0x08, 
<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8eca40e84465c821b671a1e288a0d4915c79">GRLOG_OPCODE</a> = 0x80, 
<a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8eca9c90186b600e081af86ff07afeebb5fe">GRLOG_ALL</a> = 0xFF
<br />
 }<tr class="memdesc:aaa8fbca84fe1747170d78750625dd8ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">deprecated mechanism that doesn't do anything now.  <a href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ec">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aaa8fbca84fe1747170d78750625dd8ec"><td class="memSeparator" colspan="2">&#160;</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:ac72492b3e57d6ba4ca14e320adbaa10c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Log_8h.html#ac72492b3e57d6ba4ca14e320adbaa10c">gr_start_logging</a> (<a class="el" href="Font_8h.html#a593edf9536bcbacd75254dcf11162ce5">gr_face</a> *face, const char *log_path)</td></tr>
<tr class="memdesc:ac72492b3e57d6ba4ca14e320adbaa10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start logging all segment creation and updates on the provided face.  <a href="#ac72492b3e57d6ba4ca14e320adbaa10c">More...</a><br /></td></tr>
<tr class="separator:ac72492b3e57d6ba4ca14e320adbaa10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4471cbf188e5cb08036fadf5d4331b6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Log_8h.html#a4471cbf188e5cb08036fadf5d4331b6f">gr_stop_logging</a> (<a class="el" href="Font_8h.html#a593edf9536bcbacd75254dcf11162ce5">gr_face</a> *face)</td></tr>
<tr class="memdesc:a4471cbf188e5cb08036fadf5d4331b6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop logging on the given face.  <a href="#a4471cbf188e5cb08036fadf5d4331b6f">More...</a><br /></td></tr>
<tr class="separator:a4471cbf188e5cb08036fadf5d4331b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ee7efcf30484f607f431371bc4dd5de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Log_8h.html#a1ee7efcf30484f607f431371bc4dd5de">graphite_start_logging</a> (FILE *logFile, <a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ec">GrLogMask</a> mask)</td></tr>
<tr class="memdesc:a1ee7efcf30484f607f431371bc4dd5de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start logging to a FILE object.  <a href="#a1ee7efcf30484f607f431371bc4dd5de">More...</a><br /></td></tr>
<tr class="separator:a1ee7efcf30484f607f431371bc4dd5de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70353c8e2e4ca56ddb6b8b3e8d210377"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Log_8h.html#a70353c8e2e4ca56ddb6b8b3e8d210377">graphite_stop_logging</a> ()</td></tr>
<tr class="memdesc:a70353c8e2e4ca56ddb6b8b3e8d210377"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop logging to a FILE object.  <a href="#a70353c8e2e4ca56ddb6b8b3e8d210377">More...</a><br /></td></tr>
<tr class="separator:a70353c8e2e4ca56ddb6b8b3e8d210377"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aaa8fbca84fe1747170d78750625dd8ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa8fbca84fe1747170d78750625dd8ec">&#9670;&nbsp;</a></span>GrLogMask</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ec">GrLogMask</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>deprecated mechanism that doesn't do anything now. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8eca297b17dbfb7082d6851c3320001df7ef"></a>GRLOG_NONE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8ecaf5a1ca38905fb3b12e833aa5219985e3"></a>GRLOG_FACE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8ecaa639789ccd928f660cca0c207e0cbfb1"></a>GRLOG_SEGMENT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8eca18f5e5a447fc2784cfe619d6f8faa5fa"></a>GRLOG_PASS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8ecad5e7b3ca9d4e594e40bd33242def6f9d"></a>GRLOG_CACHE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8eca40e84465c821b671a1e288a0d4915c79"></a>GRLOG_OPCODE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aaa8fbca84fe1747170d78750625dd8eca9c90186b600e081af86ff07afeebb5fe"></a>GRLOG_ALL&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac72492b3e57d6ba4ca14e320adbaa10c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac72492b3e57d6ba4ca14e320adbaa10c">&#9670;&nbsp;</a></span>gr_start_logging()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> bool gr_start_logging </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="Font_8h.html#a593edf9536bcbacd75254dcf11162ce5">gr_face</a> *&#160;</td>
          <td class="paramname"><em>face</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>log_path</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start logging all segment creation and updates on the provided face. </p>
<p>This is logged to a JSON file, see "Segment JSON Schema.txt" for a precise definition of the file</p>
<dl class="section return"><dt>Returns</dt><dd>true if the file was successfully created and logging is correctly initialised. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">face</td><td>the gr_face whose segments you want to log to the given file </td></tr>
    <tr><td class="paramname">log_path</td><td>a utf8 encoded file name and path to log to. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a4471cbf188e5cb08036fadf5d4331b6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4471cbf188e5cb08036fadf5d4331b6f">&#9670;&nbsp;</a></span>gr_stop_logging()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> void gr_stop_logging </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="Font_8h.html#a593edf9536bcbacd75254dcf11162ce5">gr_face</a> *&#160;</td>
          <td class="paramname"><em>face</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stop logging on the given face. </p>
<p>This will close the log file created by gr_start_logging.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">face</td><td>the gr_face whose segments you want to stop logging </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a1ee7efcf30484f607f431371bc4dd5de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ee7efcf30484f607f431371bc4dd5de">&#9670;&nbsp;</a></span>graphite_start_logging()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> bool graphite_start_logging </td>
          <td>(</td>
          <td class="paramtype">FILE *&#160;</td>
          <td class="paramname"><em>logFile</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="Log_8h.html#aaa8fbca84fe1747170d78750625dd8ec">GrLogMask</a>&#160;</td>
          <td class="paramname"><em>mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start logging to a FILE object. </p>
<p>This function is deprecated as of 1.2.0, use the _face versions instead.</p>
<dl class="section return"><dt>Returns</dt><dd>True on success </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">logfile</td><td>FILE reference to output logging to </td></tr>
    <tr><td class="paramname">mask</td><td>What aspects of logging to report (ignored) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a70353c8e2e4ca56ddb6b8b3e8d210377"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70353c8e2e4ca56ddb6b8b3e8d210377">&#9670;&nbsp;</a></span>graphite_stop_logging()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="Types_8h.html#ab23e4d8c7c3feff76f3b8ac9e9c71354">GR2_API</a> void graphite_stop_logging </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stop logging to a FILE object. </p>
<p>This function is deprecated as of 1.2.0, use the _face versions instead. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 11 2018 12:22:48 for Graphiteng by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.