doc/commands/Silent.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: Silent.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Silent'>
  12 <title>Silent</title>
  13
  14 <cmdsynopsis>
  15         <command>Silent</command
  16         ><arg choice='plain'
  17                 ><replaceable>command</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>A number of commands require a window to operate on.  If
  22 no window was selected when such a function is invoked the user is
  23 asked to select a window.  Sometimes this behavior is unwanted,
  24 for example if the function was called by a module and the window
  25 that was selected at first does not exist anymore.  You can
  26 prevent this by putting
  27 <emphasis remap='B'>Silent</emphasis>
  28 in front of the fvwm
  29 <replaceable>command</replaceable>.
  30 If a function that needs a window is called with
  31 <emphasis remap='B'>Silent</emphasis>
  32 without a window selected, it simply returns without doing
  33 anything. If
  34 <emphasis remap='B'>Silent</emphasis>
  35 is used on a user defined function it affects all function and sub
  36 function calls until the original function exits.</para>
  37
  38 <para>Another usage of
  39 <emphasis remap='B'>Silent</emphasis>
  40 is with binding commands
  41 <fvwmref cmd="Key"/>, <emphasis remap='B'>PointerKey</emphasis> and <emphasis remap='B'>Mouse</emphasis>,
  42 this disables error messages.</para>
  43
  44 <para><emphasis remap='B'>Silent</emphasis>
  45 also disables the error message for non-existent commands.  Note:
  46 This command is treated as a prefix to its
  47 <replaceable>command</replaceable>.
  48 Expansion of the command line is done as if
  49 <emphasis remap='B'>Silent</emphasis>
  50 was not there.</para>
  51
  52 <para>Examples:</para>
  53
  54 <programlisting>
  55 Silent <fvwmref cmd="Move"/> 0 0
  56 Silent User_defined_function
  57 # do not complain on keyboards without "Help" key
  58 Silent <fvwmref cmd="Key"/> Help R A <fvwmref cmd="Popup"/> HelpMenu
  59 </programlisting>
  60
  61
  62 </section>