/usr/share/doc/kildclient/html/ch12s01.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 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>12.1. Creating and Editing Hooks</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="chap_hooks.xhtml" title="Chapter 12. Hooks"/><link rel="next" href="sec_hook_cmdline.xhtml" title="12.2. Defining Hooks in the Command Line"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">12.1. Creating and Editing Hooks</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="chap_hooks.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 12. Hooks</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="sec_hook_cmdline.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm2243"><div class="titlepage"><div><div><h2 class="title" style="clear: both">12.1. Creating and Editing Hooks</h2></div></div></div><p>The easiest way to create and alter hooks 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>Hook are defined in the <span class="guilabel">Hooks</span> section
inside the <span class="guilabel">Automation</span> section. When you open that
section, you'll see a list of the defined hooks and some buttons
like this:</p><div class="figure" id="idm2251"><div class="figure-title">Figure 12.1. The graphical Hook editor</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_hooks.png" alt="The graphical Hook editor."/></div></div></div><br class="figure-break"/><p>In the top there is a combo box for you to select one of the
five events described above. When an event is selected the hooks
defined for that event will be listed, and all operations will be done
on hooks of that event.</p><p>The main part of the window is the list of defined hooks. 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
hook is enabled or not. Hooks 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 hook. This helps you identify the hook's purpose and is
useful when editing a hook via the command line (as described in
<a class="xref" href="sec_hook_cmdline.xhtml#sec_edit_hook_cmdline" title="12.2.1. Editing Hooks">Section 12.2.1, “Editing Hooks”</a>). Assigning a name to a
hook is optional.</p></li><li class="listitem"><p><span class="guilabel">Action</span> defines what is done
when the hook is run..</p></li></ul></div><section class="sect2" id="sec_add_hook_gui"><div class="titlepage"><div><div><h3 class="title">12.1.1. Adding Hooks</h3></div></div></div><p>To add a new hook, select the desired event from the Combo Box
and press the <span class="guilabel">Add</span> button. This will open a window
for you to edit the new hook's parameters:</p><div class="figure" id="idm2277"><div class="figure-title">Figure 12.2. The window to edit hooks</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_hook_edit.png" alt="The window to edit hooks."/></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
hook will be added. If you change your mind, press
<span class="guilabel">Cancel</span> and the hook will not be added.</p><p>To see some things hooks can do, read <a class="xref" href="sec_hook_cmdline.xhtml" title="12.2. Defining Hooks in the Command Line">Section 12.2, “Defining Hooks in the Command Line”</a>. If you want to try the hooks
described there, you can create them from the World Editor.</p></section><section class="sect2" id="idm2291"><div class="titlepage"><div><div><h3 class="title">12.1.2. Editing Hooks</h3></div></div></div><p>To edit a hook, select the event from the combo box, then select
the hook to edit in the list 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 hook (see <a class="xref" href="ch12s01.xhtml#sec_add_hook_gui" title="12.1.1. Adding Hooks">Section 12.1.1, “Adding Hooks”</a>) will be opened, filled with the hook'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 hook will remain as it was before.</p><p>Another shorter way to edit a hook is to double click its line
in the list.</p><p>It is also possible to change the value of enabled setting
directly from the hook list. Make sure that the hook you want to
change is selected, and click in the check button. The state will be
toggled.</p><p>To delete a hook, 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 hook. 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 hook again. See <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a>. To delete several hooks 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 hooks
is how to reorder them. Hooks as run from the first one to the last,
so in a few cases the order might matter. To move a hook 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="chap_hooks.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_hooks.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="sec_hook_cmdline.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Chapter 12. Hooks </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; "> 12.2. Defining Hooks in the Command Line</td></tr></table></div></footer></body></html>
|