doc/fvwm/execution.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3   "../docbook-xml/docbookx.dtd"
   4 [
   5 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   6 %myents;
   7 ]>
   8
   9 <!-- $Id: execution.xml,v 1.2 2007/06/07 20:09:52 griph Exp $ -->
  10
  11 <section id='command_execution'>
  12 <title>Command Execution</title>
  13
  14 <section id='module_and_function_commands'>
  15 <title>Module and Function Commands</title>
  16
  17 <para>If fvwm encounters a command that it doesn't recognize,
  18 it checks to see if the
  19 specified command should have been</para>
  20
  21 <programlisting>
  22 <fvwmref cmd="Function"/> (rest of command)
  23 </programlisting>
  24
  25 <para>or</para>
  26
  27 <programlisting>
  28 <fvwmref cmd="Module"/> (rest of command)
  29 </programlisting>
  30
  31 <para>This allows complex functions or modules to be invoked in a manner
  32 which is fairly transparent to the configuration file.</para>
  33
  34 <para>Example: the
  35 <filename>config</filename>
  36 file contains the line</para>
  37
  38 <programlisting>
  39 HelpMe
  40 </programlisting>
  41
  42 <para>Fvwm looks for an fvwm command called "HelpMe", and fails.
  43 Next it looks for a user-defined complex function called "HelpMe".
  44 If no such function exists, fvwm tries to execute a
  45 module called "HelpMe".</para>
  46
  47 </section>
  48
  49 <section id='delayed_execution_of_commands'>
  50 <title>Delayed Execution of Commands</title>
  51 <para>Note: There are many commands that affect look and feel of
  52 specific, some or all windows, like
  53 <fvwmref cmd="Style"/>, <fvwmref cmd="Mouse"/>, <fvwmref cmd="Colorset"/>, <fvwmref cmd="TitleStyle"/>
  54 and many others.  For performance reasons such changes are
  55 not applied immediately but only when fvwm is idle, i.e. no user
  56 interaction or module input is pending.  Specifically, new
  57 <fvwmref cmd="Style"/>
  58 options that are set in a function are not applied until after the
  59 function has completed.  This can sometimes lead to unwanted
  60 effects.</para>
  61
  62 <para>To force that all pending changes are applied immediately, use the
  63 <fvwmref cmd="UpdateStyles"/>, <fvwmref cmd="Refresh"/> or <fvwmref cmd="RefreshWindow"/>
  64 commands.</para>
  65
  66 </section>
  67
  68 </section>