doc/commands/EwmhNumberOfDesktops.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$ -->
  10
  11 <section id='EwmhNumberOfDesktops'>
  12 <title>EwmhNumberOfDesktops</title>
  13
  14 <cmdsynopsis>
  15         <command>EwmhNumberOfDesktops</command
  16         ><arg choice='plain'
  17                 ><replaceable>num</replaceable
  18         ></arg>
  19         <arg choice='opt'
  20                 ><replaceable>max</replaceable
  21         ></arg>
  22 </cmdsynopsis>
  23
  24 <para>This command is useful only for an ewmh compliant pager or taskbar
  25 (as kpager or kicker taskbar) and not for fvwm modules (
  26 <fvwmref mod="FvwmPager"/> or <fvwmref mod="FvwmIconMan"/>). It causes a
  27 compliant application to consider at least
  28 <replaceable>num</replaceable>
  29 desktops (desktop 0 to desktop
  30 <replaceable>num</replaceable>-1).
  31 The optional argument
  32 <replaceable>max</replaceable>
  33 causes a compliant application to never consider more than
  34 <replaceable>max</replaceable>
  35 desktops. If
  36 <replaceable>max</replaceable>
  37 is 0 (the default) there is no limitation.  The actual number of
  38 desktops is determined dynamically.  It is at least
  39 <replaceable>num</replaceable>,
  40 but it can be d if there is a window on desktop d-1 (or if the
  41 current desktop is desktop d-1) and d is less or equal to
  42 <replaceable>max</replaceable>
  43 or
  44 <replaceable>max</replaceable>
  45 is null.
  46 Moreover, a compliant pager can ask to change
  47 <replaceable>num</replaceable>
  48 itself.
  49 This is accepted by fvwm only if this number is
  50 less than or equal to
  51 <replaceable>max</replaceable>
  52 or if
  53 <replaceable>max</replaceable>
  54 is null.  Note that negative desktops are not supported by the
  55 ewmh specification.  The default is 4 0.</para>
  56
  57 </section>