doc/commands/EscapeFunc.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: EscapeFunc.xml,v 1.2 2007/06/09 09:46:41 griph Exp $ -->
  10
  11 <section id='EscapeFunc'>
  12 <title>EscapeFunc</title>
  13
  14 <cmdsynopsis>
  15         <command>EscapeFunc</command>
  16 </cmdsynopsis>
  17
  18 <para>By default the key sequence
  19 <keysym>Ctrl-Alt-Escape</keysym>
  20 allows for escaping from a
  21 <fvwmref cmd="Wait"/>
  22 pause and from a locked
  23 <fvwmref cmd="ModuleSynchronous"/>
  24 command.  The
  25 <emphasis remap='B'>EscapeFunc</emphasis>
  26 command used with the
  27 <fvwmref cmd="Key"/>
  28 command allows for configuring this key sequence.  An example:</para>
  29
  30 <programlisting>
  31 <fvwmref cmd="Key"/> Escape A MC -
  32 <fvwmref cmd="Key"/> Escape A  S EscapeFunc
  33 </programlisting>
  34
  35 <para>replaces the
  36 <keysym>Ctrl-Alt-Escape</keysym>
  37 key sequence with
  38 <keysym>Shift-Escape</keysym>
  39 for aborting a
  40 <fvwmref cmd="Wait"/>
  41 pause and
  42 <fvwmref cmd="ModuleSynchronous"/>
  43 command.
  44 <emphasis remap='B'>EscapeFunc</emphasis>
  45 used outside the
  46 <fvwmref cmd="Key"/>
  47 command does nothing.</para>
  48
  49 </section>