/usr/share/doc/kildclient/html/ch08s01.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 54 55 56 57 58 59 60 61 62 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>8.1. Creating and Editing Triggers</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_triggers.xhtml" title="Chapter 8. Triggers"/><link rel="next" href="ch08s02.xhtml" title="8.2. Basic Triggers"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">8.1. Creating and Editing Triggers</th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="chap_triggers.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Chapter 8. Triggers</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="ch08s02.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="idm996"><div class="titlepage"><div><div><h2 class="title" style="clear: both">8.1. Creating and Editing Triggers</h2></div></div></div><p>The easiest way to create and alter triggers 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>Trigger are defined in the <span class="guilabel">Triggers</span> section
inside the <span class="guilabel">Automation</span> section. When you open that
section, you'll see a list of the defined triggers and some buttons
like this:</p><div class="figure" id="idm1004"><div class="figure-title">Figure 8.1. The graphical Trigger editor</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_triggers.png" alt="The graphical Trigger editor."/></div></div></div><br class="figure-break"/><p>The main part of the window is the list of defined triggers. 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
trigger is enabled or not. Triggers that are not enabled are not
active and will not be tried when a line is received, 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 trigger. This helps you identify the trigger's purpose and is
useful when editing a trigger via the command line (as described in
<a class="xref" href="sec_trigger_cmdline.xhtml#sec_edit_trigger_cmdline" title="8.6.1. Editing Triggers">Section 8.6.1, “Editing Triggers”</a>). Assigning a name to a
trigger is optional.</p></li><li class="listitem"><p><span class="guilabel">Pattern</span> and
<span class="guilabel">Action</span> are the parameters for the trigger, and
they define the trigger's action, as described
above.</p></li><li class="listitem"><p><span class="guilabel">I Case</span> (for "Ignore Case"), if
set, means the case is not considered while matching the pattern,
that is, a case-insensitive match is done.</p></li><li class="listitem"><p><span class="guilabel">Gag</span> defines if the line that
matches the trigger will be printed. If this is active, the line is
gaged (omitted) from the main screen.</p></li><li class="listitem"><p><span class="guilabel">Gag Log</span> defines if the line
that matches the trigger will be written to the log file. If this is
active, the line is gaged (omitted) from the log file, if logging is
enabled (see <a class="xref" href="chap_logging.xhtml" title="Chapter 14. Logging the Output">Chapter 14, <em>Logging the Output</em></a>).</p></li><li class="listitem"><p><span class="guilabel">Keep Exec</span> defines what happens
when the trigger is matched. By default, if a trigger matches
further matching of that line against other triggers is stopped. If,
however, this option is active and the trigger matches, the line
continues being tried against other triggers.</p></li><li class="listitem"><p><span class="guilabel">Rewriter</span> defines if the trigger
is a <span class="emphasis"><em>rewriter</em></span> trigger, a special kind of
trigger described in <a class="xref" href="sec_trigger_other.xhtml#sec_trigger_rewriter" title="8.5.1. Rewriter Triggers">Section 8.5.1, “Rewriter Triggers”</a>.</p></li><li class="listitem"><p><span class="guilabel">Plugin</span>: if this is non-empty,
it means that the trigger belongs to a plugin (and the name of the
plugin is displayed). However, by default plugin triggers 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 triggers here.</p></li></ul></div><section class="sect2" id="sec_add_trigger_gui"><div class="titlepage"><div><div><h3 class="title">8.1.1. Adding Triggers</h3></div></div></div><p>To add a new trigger, press the <span class="guilabel">Add</span> button.
This will open a window for you to edit the new trigger's parameters:</p><div class="figure" id="idm1052"><div class="figure-title">Figure 8.2. The window to edit triggers</div><div class="figure-contents"><div class="mediaobject"><img src="images/we_trigger_edit.png" alt="The window to edit triggers."/></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
trigger will be added. If you change your mind, press
<span class="guilabel">Cancel</span> and the trigger will not be added.</p><p>The next sections will describe some things that can be done
with triggers.</p></section><section class="sect2" id="idm1065"><div class="titlepage"><div><div><h3 class="title">8.1.2. Editing Triggers</h3></div></div></div><p>To edit a trigger, 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 trigger (see <a class="xref" href="ch08s01.xhtml#sec_add_trigger_gui" title="8.1.1. Adding Triggers">Section 8.1.1, “Adding Triggers”</a>) will be
opened, filled with the trigger'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 trigger will remain as it was
before.</p><p>Another shorter way to edit a trigger is to double click its
line in the list.</p><p>It is also possible to change the value of the boolean options
(those represented by a check box) directly from the trigger list.
Make sure that the trigger you want to change is selected, and click
in the check button. The state will be toggled.</p><p>To delete a trigger, 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 trigger. If you want, you can disable this
confirmation dialog (see <a class="xref" href="sec_we_advanced.xhtml" title="4.7. Advanced">Section 4.7, “Advanced”</a>), 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 trigger again. To delete several triggers 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
triggers is how to reorder them. Triggers as tried from the first one
to the last, so in a few cases the order might matter. To move a
trigger 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_triggers.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="chap_triggers.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="ch08s02.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">Chapter 8. Triggers </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; "> 8.2. Basic Triggers</td></tr></table></div></footer></body></html>
|