doc/commands/Wait.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: Wait.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Wait'>
  12 <title>Wait</title>
  13
  14 <cmdsynopsis>
  15         <command>Wait</command
  16         ><arg choice='plain'
  17                 ><replaceable>window</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>This command is intended to be used in fvwm functions only.  It
  22 causes execution of a function to pause until a new window matching
  23 <replaceable>window</replaceable>
  24 appears.  This can be a window's name, class, or resource string.
  25 It may contain the wildcards '*' and '?', which are matched in the
  26 usual Unix filename manner.  This is particularly useful in the
  27 "InitFunction" if you are trying to start windows on specific desktops:</para>
  28
  29 <programlisting>
  30 <fvwmref cmd="AddToFunc"/> InitFunction
  31  + I <fvwmref cmd="Exec"/> exec xterm -geometry 80x64+0+0
  32  + I Wait xterm
  33  + I <fvwmref cmd="GotoDesk"/> 0 2
  34  + I <fvwmref cmd="Exec"/> exec xmh -font fixed -geometry \
  35        507x750+0+0
  36  + I Wait xmh
  37  + I <fvwmref cmd="GotoDesk"/> 0 0
  38 </programlisting>
  39
  40 <para>The above function starts an xterm on the current desk, waits for
  41 it to map itself, then switches to desk 2 and starts an xmh.
  42 After the xmh window appears control moves to desk 0.</para>
  43
  44 <para>Fvwm remains partially functional during a wait, but any input
  45 from the modules is queued up and processed only after the window
  46 appears or the command is aborted.  For example, windows can not
  47 be focused with <fvwmref mod="FvwmTaskBar"/> or
  48 <fvwmref mod="FvwmWinList"/> during a wait.</para>
  49
  50 <para>You can escape from a
  51 <emphasis remap='B'>Wait</emphasis>
  52 pause by pressing
  53 <keysym>Ctrl-Alt-Escape</keysym>
  54 (where
  55 <keysym>Alt</keysym>
  56 is the first modifier).  To redefine this key sequence see the
  57 <fvwmref cmd="EscapeFunc"/>
  58 command.</para>
  59
  60
  61 </section>