/usr/share/doc/kildclient/html/ch11s01.xhtml is in kildclient-doc 3.2.0-2.
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 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>11.1. Creating and Editing Timers</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="ch11.xhtml" title="Chapter 11. Timers"/><link rel="next" href="sec_timer_cmdline.xhtml" title="11.2. Defining Timers in the Command Line"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">11.1. Creating and Editing Timers</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="ch11.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 11. Timers</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="sec_timer_cmdline.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2027"><div class="titlepage"><div><div><h2 class="title" style="clear: both">11.1. Creating and Editing Timers</h2></div></div></div><p>The easiest way to create and alter timers is from the World
Editor, the place where all settings of a World are altered (see <a class="xref" href="chap_world_editor.xhtml" title="Chapter 4. Editing a World">Chapter 4, <em>Editing a World</em></a>).</p><p>Timer are defined in the <span class="guilabel">Timers</span> section
inside the <span class="guilabel">Automation</span> section. When you open that
section, you'll see a list of the defined timers and some buttons
like this:</p><div class="figure" id="idm2035"><div class="figure-title">Figure 11.1. The graphical Timer editor</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_timers.png" alt="The graphical Timer editor."/></div></div></div><br class="figure-break"/><p>The main part of the window is the list of defined timers. The
columns are as follows:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="guilabel">Enabled</span> specifies whether the
timer is enabled or not. Timers that are not enabled are not active
and will not be run, but they remain in the list so that they can
later be enabled again.</p></li><li class="listitem"><p><span class="guilabel">Name</span> is a name that is assigned
to a timer. This helps you identify the timer's purpose and is
useful when editing a timer via the command line (as described in
<a class="xref" href="sec_timer_cmdline.xhtml#sec_edit_timer_cmdline" title="11.2.1. Editing Timers">Section 11.2.1, “Editing Timers”</a>). Assigning a name to a
timer is optional.</p></li><li class="listitem"><p><span class="guilabel">Interval</span> is the interval
between timer activations, as described above. Fractions of seconds
are allowed: an interval of 0.5 means a timer that fires each
half-second.</p></li><li class="listitem"><p><span class="guilabel">Count</span> is the repeat count, as
described above.</p></li><li class="listitem"><p><span class="guilabel">Action</span> is the action that is
run when the timer fires.</p></li><li class="listitem"><p><span class="guilabel">Temp</span> indicates whether the
timer is <span class="emphasis"><em>temporary</em></span> or not. Temporary timers are
deleted automatically when their repeat count reaches
0.</p></li><li class="listitem"><p><span class="guilabel">Plugin</span>: if this is non-empty,
it means that the timer belongs to a plugin (and the name of the
plugin is displayed). However, by default plugin timers are not
displayed. See <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a> for information on
how to display plugin timers here.</p></li></ul></div><section class="sect2" id="sec_add_timer_gui"><div class="titlepage"><div><div><h3 class="title">11.1.1. Adding Timers</h3></div></div></div><p>To add a new timer, press the <span class="guilabel">Add</span> button.
This will open a window for you to edit the new timer's parameters:</p><div class="figure" id="idm2074"><div class="figure-title">Figure 11.2. The window to edit timers</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_timer_edit.png" alt="The window to edit timers."/></div></div></div><br class="figure-break"/><p>What can be set represents the columns described above.</p><p>When you are finished, press <span class="guilabel">OK</span> and the
timer will be added. If you change your mind, press
<span class="guilabel">Cancel</span> and the timer will not be added.</p><p>To see some things timers can do, read <a class="xref" href="sec_timer_cmdline.xhtml" title="11.2. Defining Timers in the Command Line">Section 11.2, “Defining Timers in the Command Line”</a>. If you want to try the timers described
there, you can create them from the World Editor.</p></section><section class="sect2" id="idm2088"><div class="titlepage"><div><div><h3 class="title">11.1.2. Editing Timers</h3></div></div></div><p>To edit a timer, select it by clicking its line in the list
(the line will be highlighted), and press the
<span class="guilabel">Edit</span> button. A window like the one used for
adding timer (see <a class="xref" href="ch11s01.xhtml#sec_add_timer_gui" title="11.1.1. Adding Timers">Section 11.1.1, “Adding Timers”</a>) will be
opened, filled with the timer's parameters. Change what you want,
and press the <span class="guilabel">OK</span> to commit the changes. If,
however, you change you mind, press <span class="guilabel">Cancel</span> and
the changes will be not be made, the timer will remain as it was
before.</p><p>Another shorter way to edit a timer is to double click its
line in the list.</p><p>It is also possible to change the value of the binary options
(those represented by a check box) directly from the timer list.
Make sure that the timer you want to change is selected, and click
in the check button. The state will be toggled.</p><p>To delete a timer, select it and press the
<span class="guilabel">Delete</span> button. You will be asked for
confirmation, and can cancel the operation, but once deleted, you
cannot recover the timer. If you want, you can disable this
confirmation dialog, but if you do so and click the
<span class="guilabel">Delete</span> button, the only way to undo your action
will be creating the timer again. See <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a>. To delete several timers at once, select
them all and press <span class="guilabel">Delete</span>.</p><p>The final thing that needs to be explained with regard to
timers is how to reorder them. Timers as tried from the first one
to the last, so in a few cases the order might matter. To move a
timer up or down in the list, select it and press the corresponding
button.</p></section></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="ch11.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="ch11.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="sec_timer_cmdline.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Chapter 11. Timers </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> 11.2. Defining Timers in the Command Line</td></tr></table></div></footer></body></html>
|