doc/commands/FakeKeypress.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: FakeKeypress.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='FakeKeypress'>
  12 <title>FakeKeypress</title>
  13
  14 <cmdsynopsis>
  15         <command>FakeKeypress</command
  16         ><arg choice='plain' rep='repeat'
  17                 ><optional
  18                         ><arg choice='plain'
  19                                 ><replaceable>command</replaceable
  20                         ></arg
  21                         ><arg choice='plain'
  22                                 ><replaceable>value</replaceable
  23                         ></arg
  24                 ></optional
  25         ></arg>
  26 </cmdsynopsis>
  27
  28 <para>This command is mainly intended for debugging fvwm and no
  29 guarantees are made that it works for you.
  30 <emphasis remap='B'>FakeKeypress</emphasis>
  31 can simulate key press and release events and pass them
  32 to fvwm or applications.  The parameters are a list of
  33 commands which consist of pairs of command tokens and values.
  34 The
  35 <fvwmopt cmd="FakeKeypress" opt="press"/> and
  36 <fvwmopt cmd="FakeKeypress" opt="release"/>
  37 commands are followed by a key name.
  38 The key name is a standard X11 key name as defined in
  39 <filename>/usr/include/X11/keysymdef.h</filename>,
  40 (without the
  41 <emphasis remap='I'>XK_</emphasis>
  42 prefix), or the keysym database
  43 <filename>/usr/X11R6/lib/X11/XKeysymDB</filename>.
  44 The
  45 <fvwmopt cmd="FakeKeypress" opt="wait"/>,
  46 <fvwmopt cmd="FakeKeypress" opt="modifiers"/> and
  47 <fvwmopt cmd="FakeKeypress" opt="depth"/>
  48 commands are the same as those used by
  49 <fvwmref cmd="FakeClick"/>.</para>
  50
  51 <para>Save all GVim sessions with: "Esc:w\n"</para>
  52
  53 <programlisting>
  54 <fvwmref cmd="All"/> (gvim) FakeKeypress press Escape \
  55                         press colon \
  56                         press w \
  57                         press Return
  58 </programlisting>
  59
  60 <para>Save &amp; exit all GVim sessions with: "Esc:wq\n"</para>
  61
  62 <programlisting>
  63 <fvwmref cmd="All"/> (gvim) FakeKeypress press Escape \
  64                         press colon \
  65                         press w \
  66                         press q \
  67                         press Return
  68 </programlisting>
  69
  70 <para>Send A to a specific window:</para>
  71
  72 <programlisting>
  73 <fvwmref cmd="WindowId"/> 0x3800002 FakeKeypress press A
  74 </programlisting>
  75
  76 <para>Note: all command names can be abbreviated with their first letter.</para>
  77
  78
  79 </section>