doc/commands/Pick.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: Pick.xml,v 1.3 2007/06/16 12:38:46 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='Pick'>
  12 <title>Pick</title>
  13
  14 <cmdsynopsis>
  15         <command>Pick</command
  16         ><arg choice='opt'
  17                 >(<replaceable>conditions</replaceable
  18         >)</arg
  19         ><arg choice='plain'
  20                 ><replaceable>command</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para><emphasis remap='B'>Pick</emphasis>
  25 works like
  26 <fvwmref cmd="Function"/>
  27 if invoked in the context of a window.  If invoked in the root
  28 window, it first asks the user to pick a window and then executes
  29 the
  30 <replaceable>command</replaceable>
  31 in the context of that window.  This avoids annoying multiple
  32 selections with complex functions.  The command is executed only
  33 if the given
  34 <replaceable>conditions</replaceable>
  35 are met.  Returns -1 if no window was selected.
  36 See <fvwmref sect="conditionals" opt="conditions" name="Conditions"/> section for a list of conditions.</para>
  37
  38 <para>This command implies the conditions
  39 <emphasis remap='I'>CirculateHit</emphasis>, <emphasis remap='I'>CirculateHitIcon</emphasis> and <emphasis remap='I'>CirculateHitShaded</emphasis>.
  40 They can be turned off by specifying
  41 <emphasis remap='I'>!CirculateHit</emphasis>
  42 etc. explicitly.</para>
  43
  44 </section>