This file is indexed.

/usr/share/doc/libuclmmbase1-dev/uclmmbase-debug.html is in libuclmmbase1-dev 1.2.16.0-1ubuntu1.

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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Debug</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="UCL Common Library Reference"
HREF="book1.html"><LINK
REL="UP"
TITLE="Overview"
HREF="uclmmbase.html"><LINK
REL="PREVIOUS"
TITLE="RTP"
HREF="uclmmbase-rtp.html"><LINK
REL="NEXT"
TITLE="Memory"
HREF="uclmmbase-memory.html"><STYLE
TYPE="text/css"
>.synopsis, .classsynopsis {
    background: #eeeeee;
    border: solid 1px #aaaaaa;
    padding: 0.5em;
}
.programlisting {
    background: #eeeeff;
    border: solid 1px #aaaaff;
    padding: 0.5em;
}
.variablelist {
    padding: 4px;
    margin-left: 3em;
}
.navigation {
    background: #ffeeee;
    border: solid 1px #ffaaaa;
    margin-top: 0.5em;
    margin-bottom: 0.5em;
}
.navigation a {
    color: #770000;
}
.navigation a:visited {
    color: #550000;
}
.navigation .title {
    font-size: 200%;
}</STYLE
></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><TABLE
WIDTH="100%"
CLASS="navigation"
SUMMARY="Navigation header"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
><A
ACCESSKEY="p"
HREF="uclmmbase-rtp.html"
><IMG
SRC="left.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Prev"></A
></TD
><TD
><A
ACCESSKEY="u"
HREF="uclmmbase.html"
><IMG
SRC="up.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Up"></A
></TD
><TD
><A
ACCESSKEY="h"
HREF="book1.html"
><IMG
SRC="home.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Home"></A
></TD
><TH
WIDTH="100%"
align="center"
>UCL Common Library Reference</TH
><TD
><A
ACCESSKEY="n"
HREF="uclmmbase-memory.html"
><IMG
SRC="right.png"
WIDTH="24"
HEIGHT="24"
BORDER="0"
ALT="Next"></A
></TD
></TR
></TABLE
><H1
><A
NAME="UCLMMBASE-DEBUG"
></A
>Debug</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2247"
></A
><H2
>Name</H2
>Debug&nbsp;--&nbsp;Functions for outputing diagnostics.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="UCLMMBASE-DEBUG.SYNOPSIS"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>#include &lt;debug.h&gt;

#define             <A
HREF="uclmmbase-debug.html#UNUSED:CAPS"
>UNUSED</A
>                              (x)
#define             <A
HREF="uclmmbase-debug.html#DEBUG-MSG"
>debug_msg</A
>
<GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                <A
HREF="uclmmbase-debug.html#DEBUG-DUMP"
>debug_dump</A
>                          (<CODE
CLASS="PARAMETER"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="TYPE"
>void</SPAN
></GTKDOCLINK
> *lp</CODE
>,
                                                         <CODE
CLASS="PARAMETER"
>long <GTKDOCLINK
HREF="LEN"
><SPAN
CLASS="TYPE"
>len</SPAN
></GTKDOCLINK
> Param2</CODE
>);
<GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                <A
HREF="uclmmbase-debug.html#DEBUG-SET-CORE-DIR"
>debug_set_core_dir</A
>                  (<CODE
CLASS="PARAMETER"
>const <GTKDOCLINK
HREF="CHAR"
><SPAN
CLASS="TYPE"
>char</SPAN
></GTKDOCLINK
> *argv0</CODE
>);</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="UCLMMBASE-DEBUG.DESCRIPTION"
></A
><H2
>Description</H2
><P
>These functions relate to outputing diagnostic messages and
information.</P
><P
>Use of these functions requires DEBUG to be defined at compilation
time.  On Unix systems, the <TT
CLASS="FILENAME"
>configure</TT
> script has
a command-line option <CODE
CLASS="OPTION"
>--enable-debug</CODE
>.  On Win32 a
debug configuration exists.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="UCLMMBASE-DEBUG.DETAILS"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="UNUSED:CAPS"
></A
><H3
>UNUSED()</H3
><PRE
CLASS="PROGRAMLISTING"
>#define UNUSED(x) (x=x)</PRE
><P
>Available for use to prevent compiler warnings when a function
argument is not used.  Sometimes this is unavoidable because function
has to conform to an interface.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2285"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>x</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>unused function argument that generates compiler warning.</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-MSG"
></A
><H3
>debug_msg</H3
><PRE
CLASS="PROGRAMLISTING"
>#define debug_msg _dprintf("[pid/%d +%d %s] ", getpid(), __LINE__, __FILE__), _dprintf</PRE
><P
>When DEBUG is defined this will write a formatted message to the
platform defined error stream.  The format of the message has the same
semantics as standard C library call <CODE
CLASS="FUNCTION"
><GTKDOCLINK
HREF="PRINTF"
><CODE
CLASS="FUNCTION"
>printf()</CODE
></GTKDOCLINK
></CODE
>.  The error
message displayed is prepended by the process id, the file and the
line number, where <A
HREF="uclmmbase-debug.html#DEBUG-MSG"
><CODE
CLASS="FUNCTION"
>debug_msg()</CODE
></A
> was called.
On Unix the message is rendered on the standard error stream.  On
Win32 a debug message is created using the Win32 API function
<CODE
CLASS="FUNCTION"
><GTKDOCLINK
HREF="OUTPUTDEBUGSTRING"
><CODE
CLASS="FUNCTION"
>OutputDebugString()</CODE
></GTKDOCLINK
></CODE
>.</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-DUMP"
></A
><H3
>debug_dump ()</H3
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                debug_dump                          (<CODE
CLASS="PARAMETER"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="TYPE"
>void</SPAN
></GTKDOCLINK
> *lp</CODE
>,
                                                         <CODE
CLASS="PARAMETER"
>long <GTKDOCLINK
HREF="LEN"
><SPAN
CLASS="TYPE"
>len</SPAN
></GTKDOCLINK
> Param2</CODE
>);</PRE
><P
>Writes a dump of a memory region to stdout.  The dump contains a
hexadecimal and an ascii representation of the memory region.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2319"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>lp</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>pointer to memory region.</P
></TD
></TR
></TBODY
></TABLE
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="DEBUG-SET-CORE-DIR"
></A
><H3
>debug_set_core_dir ()</H3
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="VOID"
><SPAN
CLASS="RETURNVALUE"
>void</SPAN
></GTKDOCLINK
>                debug_set_core_dir                  (<CODE
CLASS="PARAMETER"
>const <GTKDOCLINK
HREF="CHAR"
><SPAN
CLASS="TYPE"
>char</SPAN
></GTKDOCLINK
> *argv0</CODE
>);</PRE
><P
>Creates a directory with the application name and makes it the
current working directory.  </P
><P
>This function exists because some unix variants use the name 'core'
for core dump files.  When an application uses multiple processes,
this can be problematic if the failure of one process leads to the
failure of another because the dependent process 'core' file will
overwrite the core of the failing process.</P
><P
></P
><TABLE
CLASS="variablelist"
BORDER="0"
CELLSPACING="0"
CELLPADDING="4"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><A
NAME="AEN2337"><SPAN
STYLE="white-space: nowrap"
><CODE
CLASS="PARAMETER"
>argv0</CODE
> :</SPAN
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>the application path (usually argv[0] in <GTKDOCLINK
HREF="MAIN"
><CODE
CLASS="FUNCTION"
>main()</CODE
></GTKDOCLINK
>).</P
></TD
></TR
></TBODY
></TABLE
></DIV
></DIV
><TABLE
CLASS="navigation"
WIDTH="100%"
SUMMARY="Navigation footer"
CELLPADDING="2"
CELLSPACING="2"
><TR
VALIGN="middle"
><TD
ALIGN="left"
><A
ACCESSKEY="p"
HREF="uclmmbase-rtp.html"
><B
>&lt;&lt;&lt;&nbsp;RTP</B
></A
></TD
><TD
ALIGN="right"
><A
ACCESSKEY="n"
HREF="uclmmbase-memory.html"
><B
>Memory&nbsp;&gt;&gt;&gt;</B
></A
></TD
></TR
></TABLE
></BODY
></HTML
>