doc/commands/All.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: All.xml,v 1.3 2007/06/16 12:38:45 griph Exp $ -->
   3 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   4   "../docbook-xml/docbookx.dtd"
   5 [
   6 <!ENTITY % myents SYSTEM "../fvwm.ent" >
   7 %myents;
   8 ]>
   9
  10
  11 <section id='All'>
  12 <title>All</title>
  13
  14 <cmdsynopsis>
  15         <command>All</command
  16         ><arg choice='opt'
  17                 ><replaceable>options</replaceable
  18         ></arg
  19         ><arg choice='opt'
  20                 >(<replaceable>conditions</replaceable
  21         >)</arg
  22         ><arg choice='plain'
  23                 ><replaceable>command</replaceable
  24         ></arg>
  25 </cmdsynopsis>
  26
  27 <para>Execute
  28 <replaceable>command</replaceable>
  29 on all windows meeting the conditions.  It returns 1 if any window
  30 matches the condition and 0 otherwise. The execution starts at the top of the
  31 window ring and continues towards the bottom. The
  32 <replaceable>options</replaceable>
  33 can be any combination of
  34 <emphasis remap='I'>Reverse</emphasis> and <emphasis remap='I'>UseStack</emphasis>.
  35 If the option
  36 <fvwmopt cmd="All" opt="Reverse"/>
  37 is given the execution order is reversed. The option
  38 <fvwmopt cmd="All" opt="UseStack"/>
  39 makes All use the stacking order instead of the window ring when walking
  40 through windows.
  41 See the <fvwmref sect="conditionals" opt="conditions" name="Conditions"/> section for a list of conditions.</para>
  42
  43 <para>This command implies the conditions
  44 <emphasis remap='I'>CirculateHit</emphasis>, <emphasis remap='I'>CirculateHitIcon</emphasis> and <emphasis remap='I'>CirculateHitShaded</emphasis>.
  45 They can be turned off by specifying
  46 <emphasis remap='I'>!CirculateHit</emphasis>
  47 etc. explicitly.</para>
  48 </section>