/usr/share/gtk-doc/html/clutter/running-clutter.html is in libclutter-1.0-doc 1.24.2-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Part III. Running Clutter: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="index.html" title="Clutter Reference Manual">
<link rel="prev" href="building-clutter.html" title="Part II. Building Clutter">
<link rel="next" href="clutterbase.html" title="Part IV. Clutter Core Reference">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="building-clutter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutterbase.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="part">
<div class="titlepage"><div>
<div><h1 class="title">
<a name="running-clutter"></a>Part III. Running Clutter</h1></div>
<div><div class="author">
<h3 class="author">
<span class="firstname">Emmanuele</span> <span class="surname">Bassi</span>
</h3>
<div class="affiliation"><div class="address"><p><br>
<code class="email"><<a class="email" href="mailto:ebassilinux.intel.com">ebassi<em class="parameter"><code>linux.intel.com</code></em></a>></code><br>
</p></div></div>
</div></div>
</div></div>
<div class="partintro">
<div></div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="environment-variables"></a>Environment Variables</h2></div></div></div>
<p>
Clutter automatically checks environment variables during
its initialization. These environment variables are meant
as debug tools, overrides for default behaviours or to
address known hardware issues:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">CLUTTER_BACKEND</span></p></td>
<td>
<p>Changes the windowing system backend used by Clutter.
The allowed values for this environment variable depend on
the configuration options used when compiling Clutter. The
available values are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">x11, for the X11 backend</li>
<li class="listitem">wayland, for the Wayland backend</li>
<li class="listitem">win32, for the Windows backend</li>
<li class="listitem">osx, for the MacOS X backend</li>
<li class="listitem">gsk, for the GDK backend</li>
<li class="listitem">eglnative, for the EGL/KMS backend</li>
<li class="listitem">cex100, for the CEx100 backend</li>
</ul></div>
<p>All of the above options except for the <code class="varname">eglnative</code>
and <code class="varname">cex100</code> backends also have an input backend.</p>
</td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_INPUT_BACKEND</span></p></td>
<td>
<p>Changes the input backend used by Clutter.
The allowed values for this environment variable depend on
the configuration options used when compiling Clutter. The
available values are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">tslib</li>
<li class="listitem">evdev</li>
<li class="listitem">null</li>
</ul></div>
<p>This environment variable is only useful for setting the input
backend when using a windowing system backend that does not have an
input API, like the <code class="varname">eglnative</code> or the <code class="varname">cex100</code>
windowing system backends.</p>
</td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_SCALE</span></p></td>
<td><p>Forces the window scaling factor to that value
inside Clutter instead of relying on what backends detect.</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_TEXT_DIRECTION</span></p></td>
<td><p>Forces the text direction of every Pango layout
inside Clutter. Valid values are: ltr or rtl</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_SHOW_FPS</span></p></td>
<td><p>Prints out the frames per second achieved by Clutter.</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_DEFAULT_FPS</span></p></td>
<td><p>Sets the default framerate.</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_DISABLE_MIPMAPPED_TEXT</span></p></td>
<td><p>Disables mipmapping when rendering text.</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_FUZZY_PICK</span></p></td>
<td><p>Enables "fuzzy picking".</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_DEBUG</span></p></td>
<td><p>Enables debugging modes for Clutter; debugging modes are
used to print debugging messages on the console. Clutter must be
compiled with the --enable-debug configuration switch for these
messages to be printed out. Multiple debugging modes can be
enabled by separating them using a colon (":") or a comma
(",").</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_PAINT</span></p></td>
<td><p>Enables paint debugging modes for Clutter; the modes change
the way Clutter paints a scene and are useful for debugging the
behaviour of the paint cycle.</p></td>
</tr>
<tr>
<td><p><span class="term">CLUTTER_ENABLE_DIAGNOSTIC</span></p></td>
<td><p>When set to 1, enables diagnostic messages for run-time
deprecations, similarly to <code class="varname">G_ENABLE_DIAGNOSTIC</code> in
GLib.</p></td>
</tr>
</tbody>
</table></div>
<p>On the GLX backend there is also:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">CLUTTER_VBLANK</span></p></td>
<td><p>Selects the sync-to-vblank mode to be used.
Valid values are: none, dri or glx</p></td>
</tr></tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="command-line"></a>Command Line Arguments</h2></div></div></div>
<p>Similarly to the environment variables, Clutter also installs
command line switches that are parsed during initialization:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">--clutter-show-fps</span></p></td>
<td><p>Equivalent of CLUTTER_SHOW_FPS. Prints the
current rendering speed in frames per second.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-default-fps=FPS</span></p></td>
<td><p>Equivalent of CLUTTER_DEFAULT_FPS. Sets the
default framerate.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-text-direction=DIRECTION</span></p></td>
<td><p>Equivalent of CLUTTER_TEXT_DIRECTION. Sets the
direction for the text.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-disable-mipmapped-text</span></p></td>
<td><p>Equivalent of CLUTTER_DISABLE_MIPMAPPED_TEXT.
Disables mipmapping when rendering text.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-use-fuzzy-picking</span></p></td>
<td><p>Equivalent of CLUTTER_FUZZY_PICK. Enables
"fuzzy" picking.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-debug=FLAGS</span></p></td>
<td><p>Equivalent of CLUTTER_DEBUG. Sets FLAGS as the
Clutter debugging flags.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-no-debug=FLAGS</span></p></td>
<td><p>Unsets FLAGS from the Clutter debugging
flags.</p></td>
</tr>
<tr>
<td><p><span class="term">--cogl-debug=FLAGS</span></p></td>
<td><p>Equivalent of COGL_DEBUG. Sets FLAGS as the
Cogl debugging flags.</p></td>
</tr>
<tr>
<td><p><span class="term">--cogl-no-debug=FLAGS</span></p></td>
<td><p>Unsets FLAGS from the Cogl debugging
flags.</p></td>
</tr>
<tr>
<td><p><span class="term">--clutter-enable-accessibility</span></p></td>
<td><p>Enables accessibility support.</p></td>
</tr>
</tbody>
</table></div>
<p>The X11 backends also have the following command line
options:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">--display=DISPLAY</span></p></td>
<td><p>Sets the X11 display to use.</p></td>
</tr>
<tr>
<td><p><span class="term">--screen=SCREEN</span></p></td>
<td><p>Sets the X11 screen number to use.</p></td>
</tr>
<tr>
<td><p><span class="term">--synch</span></p></td>
<td><p>Make X11 calls synchronous.</p></td>
</tr>
</tbody>
</table></div>
</div>
<p>The GLX backend also has the following command line option:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">--vblank=METHOD</span></p></td>
<td><p>Equivalent of CLUTTER_VBLANK. Sets the sync-to-vblank
method to be used.</p></td>
</tr></tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="clutter-Debug-Flags"></a>Debug flags for Clutter</h2></div></div></div>
<p>The debugging flags can be used for the CLUTTER_DEBUG environment
variable and the --clutter-debug command line switch. Multiple flags can
be separated by a colon (:) or a comma (,).</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">actor</span></p></td>
<td><p>Generic actor-related notes</p></td>
</tr>
<tr>
<td><p><span class="term">animation</span></p></td>
<td><p><a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> notes</p></td>
</tr>
<tr>
<td><p><span class="term">backend</span></p></td>
<td><p>Backend-related notes, including initialization of
the backend features and GL context creation</p></td>
</tr>
<tr>
<td><p><span class="term">event</span></p></td>
<td><p>Event handling notes</p></td>
</tr>
<tr>
<td><p><span class="term">layout</span></p></td>
<td><p><a class="link" href="ClutterLayoutManager.html" title="ClutterLayoutManager"><span class="type">ClutterLayoutManager</span></a> notes</p></td>
</tr>
<tr>
<td><p><span class="term">misc</span></p></td>
<td><p>Miscellaneous notes</p></td>
</tr>
<tr>
<td><p><span class="term">scheduler</span></p></td>
<td><p>Notes related to timelines and the master
clock</p></td>
</tr>
<tr>
<td><p><span class="term">script</span></p></td>
<td><p>Notes related to <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a></p></td>
</tr>
</tbody>
</table></div>
<p>It is possible to get all the debugging notes using the
special "all" flag.</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="configuration-file"></a>Configuration File</h2></div></div></div>
<p>Clutter will look for files named <code class="filename">settings.ini</code>
located in the <code class="filename">/etc/clutter-1.0</code> and
<code class="filename">$XDG_CONFIG_HOME/clutter-1.0</code> directories. These files
must be valid key files (see <span class="type">GKeyFile</span> in the GLib documentation) and may
have three sections:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Environment</span></p></td>
<td><p>The keys in this section map the environment variables
honoured by Clutter.</p></td>
</tr>
<tr>
<td><p><span class="term">Debug</span></p></td>
<td><p>The keys in this section related to the debugging notes
that Clutter exposes when compiled with debugging support; similarly to
the environment variables and command line arguments related to the
debugging notes, Clutter must be compiled with support for these notes
in order to use them.</p></td>
</tr>
<tr>
<td><p><span class="term">Settings</span></p></td>
<td><p>The keys in this section strictly map to the <span class="type">GObject</span>
properties exposed by the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> type; if Clutter is running
on an X11 platform, the XSettings manager will take precedence over the
values specified in the <code class="filename">settings.ini</code>
file.</p></td>
</tr>
</tbody>
</table></div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="configuration-keys-environment"></a>Keys available for the Environment group</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">ShowFps</span></p></td>
<td><p>A boolean value, equivalent to setting
<code class="code">CLUTTER_SHOW_FPS</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">DisableMipmappedText</span></p></td>
<td><p>A boolean value, equivalent to setting
<code class="code">CLUTTER_DISABLE_MIPMAPPED_TEXT</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">UseFuzzyPicking</span></p></td>
<td><p>A boolean value, equivalent to setting
<code class="code">CLUTTER_FUZZY_PICK</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">EnableAccessibility</span></p></td>
<td><p>A boolean value, equivalent to setting
<code class="code">CLUTTER_ENABLE_ACCESSIBILITY</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">DefaultFps</span></p></td>
<td><p>An integer value, equivalent to setting
<code class="code">CLUTTER_DEFAULT_FPS</code>.</p></td>
</tr>
<tr>
<td><p><span class="term">TextDirection</span></p></td>
<td><p>A string value, equivalent to setting
<code class="code">CLUTTER_TEXT_DIRECTION</code>.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="configuration-keys-debug"></a>Keys available for the Debug group</h3></div></div></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Debug</span></p></td>
<td><p>A string containing the debugging flags, in the same
format that should be used with the <code class="code">CLUTTER_DEBUG</code>
environment variable.</p></td>
</tr>
<tr>
<td><p><span class="term">PaintDebug</span></p></td>
<td><p>A string containing the paint debugging flags, in the same
format that should be used with the <code class="code">CLUTTER_PAINT</code>
environment variable.</p></td>
</tr>
<tr>
<td><p><span class="term">PickDebug</span></p></td>
<td><p>A string containing the pick debugging flags, in the same
format that should be used with the <code class="code">CLUTTER_PICK</code>
environment variable.</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|