| 1 |
torben |
19 |
<?xml version="1.0" ?> |
| 2 |
|
|
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ |
| 3 |
|
|
<!ENTITY wxcputhrottle "<application>wxCpuThrottle 0.1</application>"> |
| 4 |
|
|
<!ENTITY kappname "&wxcputhrottle;"><!-- Do *not* replace kappname--> |
| 5 |
|
|
<!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc --> |
| 6 |
|
|
<!ENTITY % addindex "IGNORE"> |
| 7 |
|
|
<!ENTITY % English "INCLUDE"><!-- change language only here --> |
| 8 |
|
|
|
| 9 |
|
|
|
| 10 |
|
|
<!-- Do not define any other entities; instead, use the entities |
| 11 |
|
|
from kde-genent.entities and $LANG/user.entities. --> |
| 12 |
|
|
]> |
| 13 |
|
|
<!-- kdoctemplate v0.8 October 1 1999 |
| 14 |
|
|
Minor update to "Credits and Licenses" section on August 24, 2000 |
| 15 |
|
|
Removed "Revision history" section on 22 January 2001 |
| 16 |
|
|
Changed to Installation/Help menu entities 18 October 2001 |
| 17 |
|
|
Other minor cleanup and changes 18 October 2001 --> |
| 18 |
|
|
|
| 19 |
|
|
|
| 20 |
|
|
<!-- |
| 21 |
|
|
This template was designed by: David Rugge davidrugge@mindspring.com |
| 22 |
|
|
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr |
| 23 |
|
|
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de |
| 24 |
|
|
of the KDE DocBook team. |
| 25 |
|
|
|
| 26 |
|
|
You may freely use this template for writing any sort of KDE documentation. |
| 27 |
|
|
If you have any changes or improvements, please let us know. |
| 28 |
|
|
|
| 29 |
|
|
Remember: |
| 30 |
|
|
- in XML, the case of the <tags> and attributes is relevant ; |
| 31 |
|
|
- also, quote all attributes. |
| 32 |
|
|
|
| 33 |
|
|
Please don't forget to remove all these comments in your final documentation, |
| 34 |
|
|
thanks ;-). |
| 35 |
|
|
--> |
| 36 |
|
|
|
| 37 |
|
|
<!-- ................................................................ --> |
| 38 |
|
|
|
| 39 |
|
|
<!-- The language must NOT be changed here. --> |
| 40 |
|
|
|
| 41 |
|
|
<book lang="&language;"> |
| 42 |
|
|
|
| 43 |
|
|
<!-- This header contains all of the meta-information for the document such |
| 44 |
|
|
as Authors, publish date, the abstract, and Keywords --> |
| 45 |
|
|
|
| 46 |
|
|
<bookinfo> |
| 47 |
|
|
<title>The &wxcputhrottle; Handbook</title> |
| 48 |
|
|
|
| 49 |
|
|
<authorgroup> |
| 50 |
|
|
<author> |
| 51 |
|
|
<firstname></firstname> |
| 52 |
|
|
<othername></othername> |
| 53 |
|
|
<surname>Torben Nielsen</surname> |
| 54 |
|
|
<affiliation> |
| 55 |
|
|
<address><email>torben@t-hoerup.dk</email></address> |
| 56 |
|
|
</affiliation> |
| 57 |
|
|
</author> |
| 58 |
|
|
</authorgroup> |
| 59 |
|
|
|
| 60 |
|
|
<!-- TRANS:ROLES_OF_TRANSLATORS --> |
| 61 |
|
|
|
| 62 |
|
|
<copyright> |
| 63 |
|
|
<year>1999</year> |
| 64 |
|
|
<year>2007</year> |
| 65 |
|
|
<holder>Torben Nielsen</holder> |
| 66 |
|
|
</copyright> |
| 67 |
|
|
<!-- Translators: put here the copyright notice of the translation --> |
| 68 |
|
|
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook |
| 69 |
|
|
and in the FDL itself on how to use it. --> |
| 70 |
|
|
<legalnotice>&FDLNotice;</legalnotice> |
| 71 |
|
|
|
| 72 |
|
|
<!-- Date and version information of the documentation |
| 73 |
|
|
Don't forget to include this last date and this last revision number, we |
| 74 |
|
|
need them for translation coordination ! |
| 75 |
|
|
Please respect the format of the date (YYYY-MM-DD) and of the version |
| 76 |
|
|
(V.MM.LL), it could be used by automation scripts. |
| 77 |
|
|
Do NOT change these in the translation. --> |
| 78 |
|
|
|
| 79 |
|
|
<date>2001-10-18</date> |
| 80 |
|
|
<releaseinfo>0.1</releaseinfo> |
| 81 |
|
|
|
| 82 |
|
|
<!-- Abstract about this handbook --> |
| 83 |
|
|
|
| 84 |
|
|
<abstract> |
| 85 |
|
|
<para> |
| 86 |
|
|
&wxcputhrottle; is an application specially designed to do nothing you would |
| 87 |
|
|
ever want. |
| 88 |
|
|
</para> |
| 89 |
|
|
</abstract> |
| 90 |
|
|
|
| 91 |
|
|
<!-- This is a set of Keywords for indexing by search engines. |
| 92 |
|
|
Please at least include KDE, the KDE package it is in, the name |
| 93 |
|
|
of your application, and a few relevant keywords. --> |
| 94 |
|
|
|
| 95 |
|
|
<keywordset> |
| 96 |
|
|
<keyword>KDE</keyword> |
| 97 |
|
|
<keyword>wxCpuThrottle</keyword> |
| 98 |
|
|
<keyword>nothing</keyword> |
| 99 |
|
|
<keyword>nothing else</keyword> |
| 100 |
|
|
</keywordset> |
| 101 |
|
|
|
| 102 |
|
|
</bookinfo> |
| 103 |
|
|
|
| 104 |
|
|
<!-- The contents of the documentation begin here. Label |
| 105 |
|
|
each chapter so with the id attribute. This is necessary for two reasons: it |
| 106 |
|
|
allows you to easily reference the chapter from other chapters of your |
| 107 |
|
|
document, and if there is no ID, the name of the generated HTML files will vary |
| 108 |
|
|
from time to time making it hard to manage for maintainers and for the CVS |
| 109 |
|
|
system. Any chapter labelled (OPTIONAL) may be left out at the author's |
| 110 |
|
|
discretion. Other chapters should not be left out in order to maintain a |
| 111 |
|
|
consistent documentation style across all KDE apps. --> |
| 112 |
|
|
|
| 113 |
|
|
<chapter id="introduction"> |
| 114 |
|
|
<title>Introduction</title> |
| 115 |
|
|
|
| 116 |
|
|
<!-- The introduction chapter contains a brief introduction for the |
| 117 |
|
|
application that explains what it does and where to report |
| 118 |
|
|
problems. Basically a long version of the abstract. Don't include a |
| 119 |
|
|
revision history. (see installation appendix comment) --> |
| 120 |
|
|
|
| 121 |
|
|
<para> |
| 122 |
|
|
&wxcputhrottle; is a program that lets you do absolutely nothing. Please report |
| 123 |
|
|
any problems or feature requests to the &kde; mailing lists. |
| 124 |
|
|
</para> |
| 125 |
|
|
</chapter> |
| 126 |
|
|
|
| 127 |
|
|
<chapter id="using-wxcputhrottle"> |
| 128 |
|
|
<title>Using &wxcputhrottle;</title> |
| 129 |
|
|
|
| 130 |
|
|
<!-- This chapter should tell the user how to use your app. You should use as |
| 131 |
|
|
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document |
| 132 |
|
|
your application. --> |
| 133 |
|
|
|
| 134 |
|
|
<para> |
| 135 |
|
|
|
| 136 |
|
|
<!-- Note that all graphics should be in .png format. Use no gifs because of |
| 137 |
|
|
patent issues. --> |
| 138 |
|
|
|
| 139 |
|
|
<screenshot> |
| 140 |
|
|
<screeninfo>Here's a screenshot of &wxcputhrottle;</screeninfo> |
| 141 |
|
|
<mediaobject> |
| 142 |
|
|
<imageobject> |
| 143 |
|
|
<imagedata fileref="screenshot.png" format="PNG"/> |
| 144 |
|
|
</imageobject> |
| 145 |
|
|
<imageobject> |
| 146 |
|
|
<imagedata fileref="screenshot.eps" format="EPS"/> |
| 147 |
|
|
</imageobject> |
| 148 |
|
|
<textobject> |
| 149 |
|
|
<phrase>Screenshot</phrase> |
| 150 |
|
|
</textobject> |
| 151 |
|
|
</mediaobject> |
| 152 |
|
|
</screenshot> |
| 153 |
|
|
</para> |
| 154 |
|
|
|
| 155 |
|
|
|
| 156 |
|
|
<sect1 id="wxcputhrottle-features"> |
| 157 |
|
|
<title>More &wxcputhrottle; features</title> |
| 158 |
|
|
|
| 159 |
|
|
<para>It slices! It dices! and it comes with a free toaster!</para> |
| 160 |
|
|
<para> |
| 161 |
|
|
The Squiggle Tool <guiicon><inlinemediaobject> |
| 162 |
|
|
<imageobject> |
| 163 |
|
|
<imagedata fileref="squiggle.png" format="PNG"/> |
| 164 |
|
|
</imageobject> |
| 165 |
|
|
<imageobject> |
| 166 |
|
|
<imagedata fileref="squiggle.eps" format="EPS"/> |
| 167 |
|
|
</imageobject> |
| 168 |
|
|
<textobject> |
| 169 |
|
|
<phrase>Squiggle</phrase> |
| 170 |
|
|
</textobject> |
| 171 |
|
|
</inlinemediaobject></guiicon> is used to draw squiggly lines all over |
| 172 |
|
|
the &wxcputhrottle; main window. It's not a bug, it's a feature! |
| 173 |
|
|
</para> |
| 174 |
|
|
|
| 175 |
|
|
</sect1> |
| 176 |
|
|
</chapter> |
| 177 |
|
|
|
| 178 |
|
|
<chapter id="commands"> |
| 179 |
|
|
<title>Command Reference</title> |
| 180 |
|
|
|
| 181 |
|
|
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the |
| 182 |
|
|
application windows and their menubar and toolbar commands for easy reference. |
| 183 |
|
|
Also include any keys that have a special function but have no equivalent in the |
| 184 |
|
|
menus or toolbars. This may not be necessary for small apps or apps with no tool |
| 185 |
|
|
or menu bars. --> |
| 186 |
|
|
|
| 187 |
|
|
<sect1 id="wxcputhrottle-mainwindow"> |
| 188 |
|
|
<title>The main &wxcputhrottle; window</title> |
| 189 |
|
|
|
| 190 |
|
|
<sect2> |
| 191 |
|
|
<title>The File Menu</title> |
| 192 |
|
|
<para> |
| 193 |
|
|
<variablelist> |
| 194 |
|
|
<varlistentry> |
| 195 |
|
|
<term><menuchoice> |
| 196 |
|
|
<shortcut> |
| 197 |
|
|
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> |
| 198 |
|
|
</shortcut> |
| 199 |
|
|
<guimenu>File</guimenu> |
| 200 |
|
|
<guimenuitem>New</guimenuitem> |
| 201 |
|
|
</menuchoice></term> |
| 202 |
|
|
<listitem><para><action>Creates a new document</action></para></listitem> |
| 203 |
|
|
</varlistentry> |
| 204 |
|
|
<varlistentry> |
| 205 |
|
|
<term><menuchoice> |
| 206 |
|
|
<shortcut> |
| 207 |
|
|
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> |
| 208 |
|
|
</shortcut> |
| 209 |
|
|
<guimenu>File</guimenu> |
| 210 |
|
|
<guimenuitem>Save</guimenuitem> |
| 211 |
|
|
</menuchoice></term> |
| 212 |
|
|
<listitem><para><action>Saves the document</action></para></listitem> |
| 213 |
|
|
</varlistentry> |
| 214 |
|
|
<varlistentry> |
| 215 |
|
|
<term><menuchoice> |
| 216 |
|
|
<shortcut> |
| 217 |
|
|
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> |
| 218 |
|
|
</shortcut> |
| 219 |
|
|
<guimenu>File</guimenu> |
| 220 |
|
|
<guimenuitem>Quit</guimenuitem> |
| 221 |
|
|
</menuchoice></term> |
| 222 |
|
|
<listitem><para><action>Quits</action> &wxcputhrottle;</para></listitem> |
| 223 |
|
|
</varlistentry> |
| 224 |
|
|
</variablelist> |
| 225 |
|
|
</para> |
| 226 |
|
|
|
| 227 |
|
|
</sect2> |
| 228 |
|
|
|
| 229 |
|
|
<sect2> |
| 230 |
|
|
<title>The <guimenu>Help</guimenu> Menu</title> |
| 231 |
|
|
|
| 232 |
|
|
<!-- Assuming you have a standard help menu (help, what's this, about --> |
| 233 |
|
|
<!-- &wxcputhrottle;, about KDE) then the documentation is already written. --> |
| 234 |
|
|
<!-- The following entity is valid anywhere that a variablelist is --> |
| 235 |
|
|
<!-- valid. --> |
| 236 |
|
|
|
| 237 |
|
|
&help.menu.documentation; |
| 238 |
|
|
|
| 239 |
|
|
</sect2> |
| 240 |
|
|
|
| 241 |
|
|
</sect1> |
| 242 |
|
|
</chapter> |
| 243 |
|
|
|
| 244 |
|
|
<chapter id="developers"> |
| 245 |
|
|
<title>Developer's Guide to &wxcputhrottle;</title> |
| 246 |
|
|
|
| 247 |
|
|
<!-- (OPTIONAL) A Programming/Scripting reference chapter should be |
| 248 |
|
|
used for apps that use plugins or that provide their own scripting hooks |
| 249 |
|
|
and/or development libraries. --> |
| 250 |
|
|
|
| 251 |
|
|
<para> |
| 252 |
|
|
Programming &wxcputhrottle; plugins is a joy to behold. Just read through the next |
| 253 |
|
|
66 pages of API's to learn how! |
| 254 |
|
|
</para> |
| 255 |
|
|
|
| 256 |
|
|
<!-- Use refentries to describe APIs. Refentries are fairly complicated and you |
| 257 |
|
|
should consult the docbook reference for further details. The example below was |
| 258 |
|
|
taken from that reference and shortened a bit for readability. --> |
| 259 |
|
|
|
| 260 |
|
|
<refentry id="re-1007-unmanagechildren-1"> |
| 261 |
|
|
<refmeta> |
| 262 |
|
|
<refentrytitle>XtUnmanageChildren</refentrytitle> |
| 263 |
|
|
<refmiscinfo>Xt - Geometry Management</refmiscinfo> |
| 264 |
|
|
</refmeta> |
| 265 |
|
|
<refnamediv> |
| 266 |
|
|
<refname>XtUnmanageChildren |
| 267 |
|
|
</refname> |
| 268 |
|
|
<refpurpose>remove a list of children from a parent widget's managed |
| 269 |
|
|
list. |
| 270 |
|
|
<indexterm id="ix-1007-unmanagechildren-1"><primary>widgets</primary><secondary>removing</secondary></indexterm> |
| 271 |
|
|
<indexterm id="ix-1007-unmanagechildren-2"><primary>XtUnmanageChildren</primary></indexterm> |
| 272 |
|
|
</refpurpose> |
| 273 |
|
|
|
| 274 |
|
|
</refnamediv> |
| 275 |
|
|
<refsynopsisdiv> |
| 276 |
|
|
<refsynopsisdivinfo> |
| 277 |
|
|
<date>4 March 1996</date> |
| 278 |
|
|
</refsynopsisdivinfo> |
| 279 |
|
|
<synopsis> |
| 280 |
|
|
void XtUnmanageChildren(<replaceable class="parameter">children</replaceable>, <replaceable class="parameter">num_children</replaceable>) |
| 281 |
|
|
WidgetList <replaceable class="parameter">children</replaceable>; |
| 282 |
|
|
Cardinal <replaceable class="parameter">num_children</replaceable>; |
| 283 |
|
|
</synopsis> |
| 284 |
|
|
|
| 285 |
|
|
<refsect2 id="r2-1007-unmanagechildren-1"> |
| 286 |
|
|
<title>Inputs</title> |
| 287 |
|
|
<variablelist> |
| 288 |
|
|
<varlistentry> |
| 289 |
|
|
<term><replaceable class="parameter">children</replaceable> |
| 290 |
|
|
</term> |
| 291 |
|
|
<listitem> |
| 292 |
|
|
<para>Specifies an array of child widgets. Each child must be of |
| 293 |
|
|
class RectObj or any subclass thereof. |
| 294 |
|
|
</para> |
| 295 |
|
|
</listitem> |
| 296 |
|
|
</varlistentry> |
| 297 |
|
|
<varlistentry> |
| 298 |
|
|
<term><replaceable class="parameter">num_children</replaceable> |
| 299 |
|
|
</term> |
| 300 |
|
|
<listitem> |
| 301 |
|
|
<para>Specifies the number of elements in <replaceable class="parameter">children</replaceable>. |
| 302 |
|
|
</para> |
| 303 |
|
|
</listitem> |
| 304 |
|
|
</varlistentry> |
| 305 |
|
|
</variablelist> |
| 306 |
|
|
</refsect2></refsynopsisdiv> |
| 307 |
|
|
|
| 308 |
|
|
<refsect1 id="r1-1007-unmanagechildren-1"> |
| 309 |
|
|
<title>Description |
| 310 |
|
|
</title> |
| 311 |
|
|
<para><function>XtUnmanageChildren()</function> unmaps the specified widgets |
| 312 |
|
|
and removes them from their parent's geometry management. |
| 313 |
|
|
The widgets will disappear from the screen, and (depending |
| 314 |
|
|
on its parent) may no longer have screen space allocated for |
| 315 |
|
|
them. |
| 316 |
|
|
</para> |
| 317 |
|
|
<para>Each of the widgets in the <replaceable class="parameter">children</replaceable> array must have |
| 318 |
|
|
the same parent. |
| 319 |
|
|
</para> |
| 320 |
|
|
<para>See the “Algorithm” section below for full details of the |
| 321 |
|
|
widget unmanagement procedure. |
| 322 |
|
|
</para> |
| 323 |
|
|
</refsect1> |
| 324 |
|
|
|
| 325 |
|
|
<refsect1 id="r1-1007-unmanagechildren-2"> |
| 326 |
|
|
<title>Usage</title> |
| 327 |
|
|
<para>Unmanaging widgets is the usual method for temporarily |
| 328 |
|
|
making them invisible. They can be re-managed with |
| 329 |
|
|
<function>XtManageChildren()</function>. |
| 330 |
|
|
</para> |
| 331 |
|
|
<para>You can unmap a widget, but leave it under geometry |
| 332 |
|
|
management by calling <function>XtUnmapWidget()</function>. You can |
| 333 |
|
|
destroy a widget's window without destroying the widget by |
| 334 |
|
|
calling <function>XtUnrealizeWidget()</function>. You can destroy a |
| 335 |
|
|
widget completely with <function>XtDestroyWidget()</function>. |
| 336 |
|
|
</para> |
| 337 |
|
|
<para>If you are only going to unmanage a single widget, it is |
| 338 |
|
|
more convenient to call <function>XtUnmanageChild()</function>. It is |
| 339 |
|
|
often more convenient to call <function>XtUnmanageChild()</function> |
| 340 |
|
|
several times than it is to declare and initialize an array |
| 341 |
|
|
of widgets to pass to <function>XtUnmanageChildren()</function>. Calling |
| 342 |
|
|
<function>XtUnmanageChildren()</function> is more efficient, however, |
| 343 |
|
|
because it only calls the parent's <function>change_managed()</function> |
| 344 |
|
|
method once. |
| 345 |
|
|
</para> |
| 346 |
|
|
</refsect1> |
| 347 |
|
|
|
| 348 |
|
|
<refsect1 id="r1-1007-unmanagechildren-3"> |
| 349 |
|
|
<title>Algorithm |
| 350 |
|
|
</title> |
| 351 |
|
|
<para><function>XtUnmanageChildren()</function> performs the following: |
| 352 |
|
|
</para> |
| 353 |
|
|
<variablelist> |
| 354 |
|
|
<varlistentry> |
| 355 |
|
|
<term>- |
| 356 |
|
|
</term> |
| 357 |
|
|
<listitem> |
| 358 |
|
|
<para>Ignores the child if it already is unmanaged or is being |
| 359 |
|
|
destroyed. |
| 360 |
|
|
</para> |
| 361 |
|
|
</listitem> |
| 362 |
|
|
</varlistentry> |
| 363 |
|
|
<varlistentry> |
| 364 |
|
|
<term>- |
| 365 |
|
|
</term> |
| 366 |
|
|
<listitem> |
| 367 |
|
|
<para>Otherwise, if the child is realized, it makes it nonvisible |
| 368 |
|
|
by unmapping it. |
| 369 |
|
|
</para> |
| 370 |
|
|
</listitem> |
| 371 |
|
|
</varlistentry> |
| 372 |
|
|
</variablelist> |
| 373 |
|
|
<para> |
| 374 |
|
|
</para> |
| 375 |
|
|
</refsect1> |
| 376 |
|
|
|
| 377 |
|
|
<refsect1 id="r1-1007-unmanagechildren-4"> |
| 378 |
|
|
<title>Structures</title> |
| 379 |
|
|
<para>The <type>WidgetList</type> type is simply an array of widgets: |
| 380 |
|
|
</para> |
| 381 |
|
|
<screen id="sc-1007-unmanagechildren-1">typedef Widget *WidgetList; |
| 382 |
|
|
</screen> |
| 383 |
|
|
</refsect1> |
| 384 |
|
|
</refentry> |
| 385 |
|
|
|
| 386 |
|
|
</chapter> |
| 387 |
|
|
|
| 388 |
|
|
<chapter id="faq"> |
| 389 |
|
|
<title>Questions and Answers</title> |
| 390 |
|
|
|
| 391 |
|
|
<!-- (OPTIONAL but recommended) This chapter should include all of the silly |
| 392 |
|
|
(and not-so-silly) newbie questions that fill up your mailbox. This chapter |
| 393 |
|
|
should be reserved for BRIEF questions and answers! If one question uses more |
| 394 |
|
|
than a page or so then it should probably be part of the |
| 395 |
|
|
"Using this Application" chapter instead. You should use links to |
| 396 |
|
|
cross-reference questions to the parts of your documentation that answer them. |
| 397 |
|
|
This is also a great place to provide pointers to other FAQ's if your users |
| 398 |
|
|
must do some complicated configuration on other programs in order for your |
| 399 |
|
|
application work. --> |
| 400 |
|
|
|
| 401 |
|
|
&reporting.bugs; |
| 402 |
|
|
&updating.documentation; |
| 403 |
|
|
|
| 404 |
|
|
<qandaset id="faqlist"> |
| 405 |
|
|
<qandaentry> |
| 406 |
|
|
<question> |
| 407 |
|
|
<para>My Mouse doesn't work. How do I quit &wxcputhrottle;?</para> |
| 408 |
|
|
</question> |
| 409 |
|
|
<answer> |
| 410 |
|
|
<para>You silly goose! Check out the <link linkend="commands">Commands |
| 411 |
|
|
Section</link> for the answer.</para> |
| 412 |
|
|
</answer> |
| 413 |
|
|
</qandaentry> |
| 414 |
|
|
<qandaentry> |
| 415 |
|
|
<question> |
| 416 |
|
|
<para>Why can't I twiddle my documents?</para> |
| 417 |
|
|
</question> |
| 418 |
|
|
<answer> |
| 419 |
|
|
<para>You can only twiddle your documents if you have the foobar.lib |
| 420 |
|
|
installed.</para> |
| 421 |
|
|
</answer> |
| 422 |
|
|
</qandaentry> |
| 423 |
|
|
</qandaset> |
| 424 |
|
|
</chapter> |
| 425 |
|
|
|
| 426 |
|
|
<chapter id="credits"> |
| 427 |
|
|
|
| 428 |
|
|
<!-- Include credits for the programmers, documentation writers, and |
| 429 |
|
|
contributors here. The license for your software should then be included below |
| 430 |
|
|
the credits with a reference to the appropriate license file included in the KDE |
| 431 |
|
|
distribution. --> |
| 432 |
|
|
|
| 433 |
|
|
<title>Credits and License</title> |
| 434 |
|
|
|
| 435 |
|
|
<para> |
| 436 |
|
|
&wxcputhrottle; |
| 437 |
|
|
</para> |
| 438 |
|
|
<para> |
| 439 |
|
|
Program copyright 2007 Torben Nielsen <email>torben@t-hoerup.dk</email> |
| 440 |
|
|
</para> |
| 441 |
|
|
<para> |
| 442 |
|
|
Contributors: |
| 443 |
|
|
<itemizedlist> |
| 444 |
|
|
<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para> |
| 445 |
|
|
</listitem> |
| 446 |
|
|
<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para> |
| 447 |
|
|
</listitem> |
| 448 |
|
|
</itemizedlist> |
| 449 |
|
|
</para> |
| 450 |
|
|
|
| 451 |
|
|
<para> |
| 452 |
|
|
Documentation copyright 2007 Torben Nielsen <email>torben@t-hoerup.dk</email> |
| 453 |
|
|
</para> |
| 454 |
|
|
|
| 455 |
|
|
<!-- TRANS:CREDIT_FOR_TRANSLATORS --> |
| 456 |
|
|
|
| 457 |
|
|
&underFDL; <!-- FDL: do not remove --> |
| 458 |
|
|
|
| 459 |
|
|
<!-- Determine which license your application is licensed under, |
| 460 |
|
|
and delete all the remaining licenses below: |
| 461 |
|
|
|
| 462 |
|
|
(NOTE: All documentation are licensed under the FDL, |
| 463 |
|
|
regardless of what license the application uses) --> |
| 464 |
|
|
|
| 465 |
|
|
&underGPL; <!-- GPL License --> |
| 466 |
|
|
&underBSDLicense; <!-- BSD License --> |
| 467 |
|
|
&underArtisticLicense; <!-- BSD Artistic License --> |
| 468 |
|
|
&underX11License; <!-- X11 License --> |
| 469 |
|
|
|
| 470 |
|
|
</chapter> |
| 471 |
|
|
|
| 472 |
|
|
<appendix id="installation"> |
| 473 |
|
|
<title>Installation</title> |
| 474 |
|
|
|
| 475 |
|
|
<sect1 id="getting-wxcputhrottle"> |
| 476 |
|
|
<title>How to obtain &wxcputhrottle;</title> |
| 477 |
|
|
|
| 478 |
|
|
<!-- This first entity contains boiler plate for applications that are |
| 479 |
|
|
part of KDE CVS. You should remove it if you are releasing your |
| 480 |
|
|
application --> |
| 481 |
|
|
|
| 482 |
|
|
&install.intro.documentation; |
| 483 |
|
|
|
| 484 |
|
|
</sect1> |
| 485 |
|
|
|
| 486 |
|
|
<sect1 id="requirements"> |
| 487 |
|
|
<title>Requirements</title> |
| 488 |
|
|
|
| 489 |
|
|
<!-- |
| 490 |
|
|
List any special requirements for your application here. This should include: |
| 491 |
|
|
.Libraries or other software that is not included in kdesupport, |
| 492 |
|
|
kdelibs, or kdebase. |
| 493 |
|
|
.Hardware requirements like amount of RAM, disk space, graphics card |
| 494 |
|
|
capabilities, screen resolution, special expansion cards, etc. |
| 495 |
|
|
.Operating systems the app will run on. If your app is designed only for a |
| 496 |
|
|
specific OS, (you wrote a graphical LILO configurator for example) put this |
| 497 |
|
|
information here. |
| 498 |
|
|
--> |
| 499 |
|
|
|
| 500 |
|
|
<para> |
| 501 |
|
|
In order to successfully use &wxcputhrottle;, you need &kde; 1.1. Foobar.lib is |
| 502 |
|
|
required in order to support the advanced &wxcputhrottle; features. &wxcputhrottle; uses |
| 503 |
|
|
about 5 megs of memory to run, but this may vary depending on your |
| 504 |
|
|
platform and configuration. |
| 505 |
|
|
</para> |
| 506 |
|
|
|
| 507 |
|
|
<para> |
| 508 |
|
|
All required libraries as well as &wxcputhrottle; itself can be found |
| 509 |
|
|
on <ulink url="ftp://ftp.wxcputhrottle.org">The &wxcputhrottle; home page</ulink>. |
| 510 |
|
|
</para> |
| 511 |
|
|
|
| 512 |
|
|
<!-- For a list of updates, you may refer to the application web site |
| 513 |
|
|
or the ChangeLog file, or ... --> |
| 514 |
|
|
<para> |
| 515 |
|
|
You can find a list of changes at <ulink |
| 516 |
|
|
url="http://apps.kde.org/wxcputhrottle">http://apps.kde.org/wxcputhrottle</ulink>. |
| 517 |
|
|
</para> |
| 518 |
|
|
</sect1> |
| 519 |
|
|
|
| 520 |
|
|
<sect1 id="compilation"> |
| 521 |
|
|
<title>Compilation and Installation</title> |
| 522 |
|
|
|
| 523 |
|
|
<!-- This entity contains the boilerplate text for standard --> |
| 524 |
|
|
<!-- compilation instructions. If your application requires any --> |
| 525 |
|
|
<!-- special handling, remove it, and replace with your own text. --> |
| 526 |
|
|
|
| 527 |
|
|
&install.compile.documentation; |
| 528 |
|
|
|
| 529 |
|
|
</sect1> |
| 530 |
|
|
|
| 531 |
|
|
<sect1 id="configuration"> |
| 532 |
|
|
<title>Configuration</title> |
| 533 |
|
|
|
| 534 |
|
|
<para>Don't forget to tell your system to start the <filename>dtd</filename> |
| 535 |
|
|
dicer-toaster daemon first, or &wxcputhrottle; won't work !</para> |
| 536 |
|
|
|
| 537 |
|
|
</sect1> |
| 538 |
|
|
|
| 539 |
|
|
</appendix> |
| 540 |
|
|
|
| 541 |
|
|
&documentation.index; |
| 542 |
|
|
</book> |
| 543 |
|
|
|
| 544 |
|
|
<!-- |
| 545 |
|
|
Local Variables: |
| 546 |
|
|
mode: sgml |
| 547 |
|
|
sgml-minimize-attributes:nil |
| 548 |
|
|
sgml-general-insert-case:lower |
| 549 |
|
|
sgml-indent-step:0 |
| 550 |
|
|
sgml-indent-data:nil |
| 551 |
|
|
End: |
| 552 |
|
|
|
| 553 |
|
|
vim:tabstop=2:shiftwidth=2:expandtab |
| 554 |
|
|
--> |
Parent Directory
| 
Revision Log