/usr/share/doc/ddccontrol/html/apes02.html is in ddccontrol 0.4.2-11.
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 | <?xml version="1.0" encoding="utf-8" standalone="no"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
<meta http-equiv="Content-Type" content=
"text/html; charset=UTF-8" />
<title>Monitor database structure</title>
<meta name="generator" content=
"DocBook XSL Stylesheets V1.70.1" />
<link rel="start" href="index.html" title=
"DDCcontrol Documentation" />
<link rel="up" href="ape.html" title=
"Appendix E. Documents for developers" />
<link rel="prev" href="ape.html" title=
"Appendix E. Documents for developers" />
<link rel="next" href="apes03.html" title=
"Profile file structure" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Monitor database
structure</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href=
"ape.html">Prev</a> </td>
<th width="60%" align="center">Appendix E. Documents for
developers</th>
<td width="20%" align="right"> <a accesskey="n" href=
"apes03.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id=
"dbstruct"></a>Monitor database structure</h2>
</div>
</div>
</div>
<p>The monitor database is written in XML, it can be found in
the <code class="filename">db</code> directory of <code class=
"filename">ddccontrol-db</code> package.</p>
<p>This directory contains the following files:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"filename">options.xml</code></li>
<li style="list-style-type: disc"><code class=
"filename">monitor/<em class=
"replaceable"><code>%monitor_id%</code></em>.xml</code></li>
</ul>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="optionsxml"></a>Control
list</h3>
</div>
<div>
<h4 class="subtitle">XML file: <code class=
"filename">options.xml</code></h4>
</div>
</div>
</div>
<p><code class="sgmltag-element">control</code> elements
(e.g. <tt xmlns="" class=
"sgmltag-attvalue">“brightness”</tt>) are contained in
<code class="sgmltag-element">group</code> elements (e.g.
<tt xmlns="" class="sgmltag-attvalue">“color
settings”</tt>). <code class="sgmltag-element">group</code>
and <code class="sgmltag-element">subgroup</code> elements
allow the GUI to separate the controls in different branches
on the tree.</p>
<p><code class="sgmltag-element">options</code>
attributes:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">date</code>: indicates the release
date of the current database (YYYYMMDD format).</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">dbversion</code>: indicates which
version of database format is used (must be set to
3).</li>
</ul>
</div>
<p><code class="sgmltag-element">group</code> attributes:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">name</code>: full English group
name.</li>
</ul>
</div>
<p><code class="sgmltag-element">subgroup</code>
attributes:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">name</code>: full English subgroup
name.</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">pattern</code>: name of the
fullscreen pattern <code class=
"filename">gddccontrol</code> must display to help the
user to adjust subgroup's controls (optional). For
possible values, see <code class=
"filename">ddccontrol/src/gddccontrol/fspatterns.c</code>.</li>
</ul>
</div>
<p><code class="sgmltag-element">control</code>
attributes:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">id</code>: abbreviated control
name.</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">name</code>: full English control
name.</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">address</code>: DDC/CI address
(optional).</li>
<li style="list-style-type: disc">
<code class="sgmltag-attribute">type</code>: one of
these values:
<div class="itemizedlist">
<ul type="opencircle">
<li style="list-style-type: circle"><tt xmlns=""
class="sgmltag-attvalue">“value”</tt>: The
control accepts values in a continuous range (e.g.
brightness).</li>
<li style="list-style-type: circle"><tt xmlns=""
class="sgmltag-attvalue">“command”</tt>: An
action occurs when the value is set to something
greater than <tt xmlns="" class=
"sgmltag-attvalue">“0”</tt> (e.g. degauss). If
you don't define any <code class=
"sgmltag-element">value</code> element in a command
control, the default value <tt xmlns="" class=
"sgmltag-attvalue">“0x01”</tt> will be
used.</li>
<li style="list-style-type: circle"><tt xmlns=""
class="sgmltag-attvalue">“list”</tt>: The
control accepts a list of values (e.g. OSD
language).</li>
</ul>
</div>
</li>
<li style="list-style-type: disc">
<code class="sgmltag-attribute">refresh</code> (only
for list and command controls): Set whether other
controls must be refreshed after changing list value or
running the command associated with the control
(optional). Possible values:
<div class="itemizedlist">
<ul type="opencircle">
<li style="list-style-type: circle"><tt xmlns=""
class="sgmltag-attvalue">“none”</tt>: Do not
refresh anything. (default)</li>
<li style="list-style-type: circle"><tt xmlns=""
class="sgmltag-attvalue">“all”</tt>: Refresh
all controls.</li>
</ul>
</div>
</li>
</ul>
</div>
<p><code class="sgmltag-element">value</code> attributes:</p>
<div class="itemizedlist">
<ul type="bullet">
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">id</code>: abbreviated value
name.</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">name</code>: full English value name
(it is not needed if there is only one value for command
controls).</li>
<li style="list-style-type: disc"><code class=
"sgmltag-attribute">value</code>: DDC/CI control value
(optional).</li>
</ul>
</div>
<p>File format:</p>
<pre class="screen">
<?xml version="1.0"?>
<options date="%date%" dbversion="3">
<group name="%groupname%">
<subgroup name="%subgroupname%" pattern="%patternname%">
<control id="%control_id%" type="value" name="%control_name%" address="%hex_address%"/>
<!-- Command using the default 0x01 address -->
<control id="%control_id%" type="command" name="%control_name%" address="%hex_address%"/>
<control id="%control_id%" type="command" name="%control_name%" address="%hex_address%">
<value id="%value_id%" value="%hex_value%"/>
</control>
<control id="%control_id%" type="list" name="%control_name%" address="%hex_address%">
<value id="%value_id%" name="%value_name%" value="%hex_value%"/>
<value...>
</control>
<control ...>
</subgroup>
</group>
<group ...>
</options>
</pre>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="monitorxml"></a>Monitor
Profiles</h3>
</div>
<div>
<h4 class="subtitle">XML files: <code class=
"filename">monitor/<em class=
"replaceable"><code>%monitor_id%</code></em>.xml</code></h4>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id2565436"></a><code class=
"sgmltag-element">caps</code> element</h4>
</div>
</div>
</div>
<p>The caps attribute is optional. Its format is defined in
ACCESS.bus specifications.</p>
<p>To add controls to caps, use the <code class=
"sgmltag-attribute">add</code> attribute. To remove
controls from caps, use the <code class=
"sgmltag-attribute">remove</code> attribute.</p>
<p>Note remove is handled before add, so if you remove and
add a same control, it will finally be in caps.</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id2565501"></a><code class=
"sgmltag-element">controls</code> element</h4>
</div>
</div>
</div>
<p>List of controls supported by a monitor (optional if you
have an <code class="sgmltag-attribute">include</code>
element).</p>
<p><code class="sgmltag-element">control</code>
<code class="sgmltag-attribute">id</code> attributes are
defined in <code class="filename">options.xml</code>. If
<code class="sgmltag-element">control</code> <code class=
"sgmltag-attribute">type</code> is <tt xmlns="" class=
"sgmltag-attvalue">“list”</tt> or <tt xmlns="" class=
"sgmltag-attvalue">“command”</tt> without default
values, supported values must be defined.</p>
<p><code class="sgmltag-attribute">address</code> attribute
for <code class="sgmltag-element">control</code> elements
and <code class="sgmltag-attribute">value</code> attribute
for <code class="sgmltag-element">value</code> elements are
optional if they are defined in the general options
file.</p>
<p>The <code class="sgmltag-attribute">init</code>
attribute in <code class="sgmltag-element">monitor</code>
element define the type of the initialization: DDC/CI
standard (<tt xmlns="" class=
"sgmltag-attvalue">“standard”</tt>), or Samsung
(<tt xmlns="" class="sgmltag-attvalue">“samsung”</tt>).
This attribute is optional, as long as the monitor profile
includes another profile which defines this attribute.</p>
<p>You can set a <code class=
"sgmltag-attribute">delay</code> attribute in <code class=
"sgmltag-element">control</code> elements to set the time
in milliseconds to wait after changing the value of this
control. If you don't, a default value is used.</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id2565644"></a><code class=
"sgmltag-element">include</code> element</h4>
</div>
</div>
</div>
<p>Includes another monitor, manufacturer or standard
profile, specified by the <code class=
"sgmltag-attribute">file</code> attribute.</p>
</div>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>Monitor profile are read
sequentially. Control and init mode redifinitions are
ignored, so define specific controls and init mode before
including a generic profile. Caps are also treated
sequentially, so if a control is not in CAPS at the time it
is defined, it won't be supported by ddccontrol.
</div>
<p>File format:</p>
<pre class="screen">
<?xml version="1.0"?>
<monitor name="%full_monitor_name%" init="[standard|samsung]">
<caps add="%add_caps%" remove="%remove_caps%"/>
<controls>
<!--- value -->
<control id="%control_id%" address="%hex_address%" delay="%wait_time%"/>
<!--- command using a default 0x01 value-->
<control id="%control_id%" address="%hex_address%" delay="%wait_time%"/>
<!--- command -->
<control id="%control_id%" address="%hex_address%" delay="%wait_time%">
<value id="activate" value="%hex_value%"/>
</control>
<!--- list -->
<control id="%control_id%" address="%hex_address%" delay="%wait_time%">
<value id="%value_id%" value="%hex_value%"/>
<value...>
</control>
<control...>
</controls>
<!--- Including VESA generic profile is generally a good idea. -->
<include file="VESA"/>
</monitor>
</pre>
<p>If a monitor supports exactly the same controls as another
one, you can define it as shown:</p>
<pre class="screen">
<?xml version="1.0"?>
<monitor name="%full_monitor_name%">
<caps add="%add_caps%" remove="%remove_caps%"/>
<include file="%include_monitor_id%"/>
</monitor>
</pre>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href=
"ape.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href=
"ape.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href=
"apes03.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
Appendix E. Documents for developers </td>
<td width="20%" align="center"><a accesskey="h" href=
"index.html">Home</a></td>
<td width="40%" align="right" valign="top"> Profile file
structure</td>
</tr>
</table>
</div>
<hr xmlns="" />
<div xmlns="" align="left">
<a href="http://sourceforge.net"><img src=
"http://sourceforge.net/sflogo.php?group_id=117933&type=1"
width="88" height="31" border="0" alt=
"SourceForge.net Logo" /></a>
</div>
</body>
</html>
|