doc/commands/IgnoreModifiers.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: IgnoreModifiers.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='IgnoreModifiers'>
  12 <title>IgnoreModifiers</title>
  13
  14 <cmdsynopsis>
  15         <command>IgnoreModifiers</command
  16         ><arg choice='opt'
  17                 ><replaceable>Modifiers</replaceable
  18         ></arg>
  19 </cmdsynopsis>
  20
  21 <para>Tells fvwm which modifiers to ignore when matching Mouse or Key
  22 bindings.
  23 <emphasis remap='B'>IgnoreModifiers</emphasis>
  24 affects the
  25 <fvwmref cmd="Style" opt="ClickToFocus"/>
  26 style too.  This command belongs into your
  27 <filename>config</filename>.
  28 If you issue it when your fvwm session is already up and running
  29 the results are unpredictable.  The should appear before any
  30 applications or modules are started in your
  31 <filename>config</filename>
  32 file (e.g. with the
  33 <fvwmref cmd="Exec"/>
  34 command).</para>
  35
  36 <para><replaceable>Modifiers</replaceable>
  37 has the same syntax as in the
  38 <fvwmref cmd="Mouse"/> or <fvwmref cmd="Key"/>
  39 bindings, with the addition of 'L' meaning the
  40 <keysym>caps lock</keysym>
  41 key.  The default is "L".
  42 <replaceable>Modifiers</replaceable>
  43 can be omitted, meaning no modifiers are ignored.  This command
  44 comes in handy if the
  45 <keysym>num-lock</keysym>
  46 and
  47 <keysym>scroll-lock</keysym>
  48 keys interfere with your shortcuts.  With XFree86 '2' usually is
  49 the
  50 <keysym>num-lock</keysym>
  51 modifier and '5' refers to the
  52 <keysym>scroll-lock</keysym>
  53 key. To turn all these pesky modifiers off you can use this
  54 command:</para>
  55
  56 <programlisting>
  57 IgnoreModifiers L25
  58 </programlisting>
  59
  60 <para>If the
  61 <replaceable>Modifiers</replaceable>
  62 argument is the string "<fvwmopt cmd="IgnoreModifiers" opt="default"/>", fvwm reverts back to the
  63 default value "L".</para>
  64
  65 <para><important>
  66 This command creates a lot of extra network traffic, depending on
  67 your CPU, network connection, the number of
  68 <fvwmref cmd="Key"/> or <fvwmref cmd="Mouse"/>
  69 commands in your configuration file and the number of modifiers
  70 you want to ignore.  If you do not have a lightning fast machine
  71 or very few bindings you should not ignore more than two
  72 modifiers. I.e. do not ignore
  73 <keysym>scroll-lock</keysym>
  74 if you have no problem with it.  In the
  75 <emphasis remap='I'>FAQ</emphasis>
  76 you can find a better solution of this problem.</important></para>
  77
  78 </section>