This file is indexed.

/usr/share/gtk-doc/html/pigment/pgm-running.html is in libpigment0.3-dev 0.3.17-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Running Pigment Applications</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Pigment 0.3 Reference Manual">
<link rel="up" href="pigment-overview.html" title="Part I. Pigment Overview">
<link rel="prev" href="pgm-compiling.html" title="Compiling Pigment Applications">
<link rel="next" href="pigment-core.html" title="Part II. Pigment Core Reference">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="preface" href="introduction.html" title="Introduction">
<link rel="part" href="pigment-overview.html" title="Part I. Pigment Overview">
<link rel="part" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="part" href="pigment-library.html" title="Part III. Pigment Library Reference">
<link rel="index" href="pigment-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="pgm-compiling.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pigment-overview.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Pigment 0.3
 Reference Manual</th>
<td><a accesskey="n" href="pigment-core.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="pgm-running"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Running Pigment Applications</span></h2>
<p>Running Pigment Applications — 
Run and debug your Pigment applications.
</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" lang="en">
<a name="id2690636"></a><h2>Running and debugging Pigment applications</h2>
<div class="refsect2" lang="en">
<a name="id2690643"></a><h3>Pigment environment variables</h3>
<p>
Pigment inspects a few environment variables.
</p>
<p><a name="PGM_PLUGIN_PATH"></a><b><code class="envar">PGM_PLUGIN_PATH</code></b>
This environment variable can be set to a colon-separated list of
paths.  Pigment will scan these paths for rendering plug-ins.  These
plug-ins will be loaded in addition to, and before the plug-ins found in
the system paths.
  </p>
<p><b><code class="envar">PGM_DEBUG</code></b>
If GStreamer has been configured
with <code class="option">--enable-gst-debug=yes</code>, this variable can be set
to a list of debug options, which causes Pigment to print out different
types of debugging information to stderr.
  
The variable takes a comma-separated list of "category_name:level"
pairs to set specific levels for the individual categories.  The level
value ranges from 0 (nothing) to 5 (LOG).
    </p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">1 - <code class="option">ERROR</code></span></p></td>
<td><p>
Logs all fatal errors.  These are errors that do not allow the core or
a plugin to perform the requested action.  The application can still
recover if programmed to handle the conditions that triggered the
error.
</p></td>
</tr>
<tr>
<td><p><span class="term">2 - <code class="option">WARNING</code></span></p></td>
<td><p>
Logs all warnings.  Typically these are non-fatal, but user-visible
problems are expected to happen.
</p></td>
</tr>
<tr>
<td><p><span class="term">3 - <code class="option">INFO</code></span></p></td>
<td><p>
Logs all informational messages.  These are typically used for events
in the system that only happen once, or are important and rare enough
to be logged at this level.
</p></td>
</tr>
<tr>
<td><p><span class="term">4 - <code class="option">DEBUG</code></span></p></td>
<td><p>
Logs all debug messages.  These are general debug messages for events
that happen only a limited number of times during an object's lifetime;
these include setup, teardown, change of parameters, ...
</p></td>
</tr>
<tr>
<td><p><span class="term">5 - <code class="option">LOG</code></span></p></td>
<td><p>
Logs all log messages.  These are messages for events
that happen repeatedly during an object's lifetime;
these include streaming and steady-state conditions.
</p></td>
</tr>
</tbody>
</table></div>
<p>

 The category_name can contain "<code class="option">*"</code> as a wildcard.
  
For example, setting <code class="envar">PGM_DEBUG</code> to
<code class="option">pgm_canvas:5,pgm_*:3</code>, will cause the
<code class="option">pgm_canvas</code> category to be logged at full
<code class="option">LOG</code> level, while all categories starting with
<code class="option">pgm_</code> will be logged at <code class="option">INFO</code> level.
  
To get all possible debug output, set
<code class="envar">PGM_DEBUG</code>
to <code class="option">*:5</code>
  </p>
<p><a name="PGM_IMAGE_THREAD_POOL_SIZE"></a><b><code class="envar">PGM_IMAGE_THREAD_POOL_SIZE</code></b>
This environment variable can be set to an integer in the range [1, 16]
defining the number of pre-allocated threads used by the image loader thread
pool. The default setting is 1.
  </p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2737477"></a><h3>OpenGL Viewport environment variables</h3>
<p>
Pigment OpenGL Viewport plugin inspects a few environment variables.
</p>
<p><a name="PGM_GL_VBLANK"></a><b><code class="envar">PGM_GL_VBLANK</code></b>
This environment variable can be set to override the plugin selection of the
best vertical synchronization method to use depending on the graphical driver.
Note that if the __GL_SYNC_TO_VBLANK environment variable used by the NVIDIA
proprietary driver is set, PGM_GL_VBLANK is simply ignored.
  </p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">0 - </span></p></td>
<td><p>
	    Disable all attempts to synchronize to the VBlank.
	  </p></td>
</tr>
<tr>
<td><p><span class="term">1 - </span></p></td>
<td><p>
	    Use the GLX_SGI_video_sync extension to synchronize to the VBlank.
	  </p></td>
</tr>
<tr>
<td><p><span class="term">2 - </span></p></td>
<td><p>
	    Use the GLX_SGI_swap_control extension to synchronize to the VBlank.
	  </p></td>
</tr>
</tbody>
</table></div>
<p><a name="PGM_GL_PROGRAMS"></a><b><code class="envar">PGM_GL_PROGRAMS</code></b>
This environment variable can be set to 0 in order to disable the use of all
ARB vertex and fragment programs. In this case, Pigment will behave as if
programs were not supported.
  </p>
<p><a name="PGM_GL_CSP_PROGRAM"></a><b><code class="envar">PGM_GL_CSP_PROGRAM</code></b>
This environment variable can be set to 0 in order to disable the use of a
fragment program to handle the color space conversion from I420 or YV12 YCbCr
formats to RGB. It removes the I420 and YV12 pixel formats from the list of
supported formats in the viewport.
  </p>
<p><a name="PGM_GL_FPS"></a><b><code class="envar">PGM_GL_FPS</code></b>
This environment variable can be set to an integer specifying the framerate
in which the rendering loop should run. Note that the vertical synchronization
will not work correctly when running Pigment with a custom framerate.
  </p>
<p><a name="PGM_GL_ARGB_VISUAL"></a><b><code class="envar">PGM_GL_ARGB_VISUAL</code></b>
This environment variable can be set to 1 to enable the search for an ARGB
visual when the plugin is used on Xlib/GLX. It means that if you are running
in a composited environment, you will be able to change the opacity of the
window.
  </p>
<p><a name="PGM_GL_INDIRECT_RENDERING"></a><b><code class="envar">PGM_GL_INDIRECT_RENDERING</code></b>
This environment variable can be set to 1 to explicitly request the creation
of a indirect rendered OpenGL context.
  </p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2737633"></a><h3>OpenGL ES Viewport environment variables</h3>
<p>
Pigment OpenGL ES Viewport plugin inspects a few environment variables.
</p>
<p><a name="PGM_GLES_SWAP_INTERVAL"></a><b><code class="envar">PGM_GLES_SWAP_INTERVAL</code></b>
This environment variable can be set to an integer specifying the minimum
number of vertical refresh periods (interval) that should occur for each buffer
swap. A value of 0 specifies that buffer swaps must not be synchronized.
  </p>
<p><a name="PGM_GLES_FPS"></a><b><code class="envar">PGM_GLES_FPS</code></b>
This environment variable can be set to an integer specifying the framerate
in which the rendering loop should run. Note that the vertical synchronization
will not work correctly when running Pigment with a custom framerate.
  </p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>