doc/commands/GotoDesk.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: GotoDesk.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='GotoDesk'>
  12 <title>GotoDesk</title>
  13
  14 <cmdsynopsis>
  15         <command>GotoDesk</command
  16         ><group choice='opt'
  17                 ><arg choice='plain'>prev</arg
  18                 ><arg choice='plain'
  19                         ><arg choice='plain'
  20                                 ><replaceable>arg1</replaceable
  21                         ></arg
  22                         ><arg choice='opt'
  23                                 ><replaceable>arg2</replaceable
  24                         ></arg
  25                         ><arg choice='opt'
  26                                 ><replaceable>min</replaceable
  27                                 > <replaceable>max</replaceable
  28                         ></arg
  29                 ></arg
  30         ></group>
  31 </cmdsynopsis>
  32
  33 <para>
  34 Switches the current viewport to another desktop (workspace, room).
  35 </para>
  36
  37 <para>The command takes 1, 2, 3, or 4 arguments.  A single argument is
  38 interpreted as a relative desk number.  Two arguments are
  39 understood as a relative and an absolute desk number.  Three
  40 arguments specify a relative desk and the minimum and maximum of
  41 the allowable range. Four arguments specify the relative,
  42 absolute, minimum and maximum values.  (Desktop numbers can be
  43 negative).  If a literal
  44 <fvwmopt cmd="GotoDesk" opt="prev"/>
  45 is given as the single argument, the last visited desk number is
  46 used.</para>
  47
  48 <para>If
  49 <replaceable>arg1</replaceable>
  50 is non zero then the next desktop number is the current desktop
  51 number plus
  52 <replaceable>arg1</replaceable>.</para>
  53
  54 <para>If
  55 <replaceable>arg1</replaceable>
  56 is zero then the new desktop number is
  57 <replaceable>arg2</replaceable>.
  58 (If
  59 <replaceable>arg2</replaceable>
  60 is not present, then the command has no effect.)</para>
  61
  62 <para>If
  63 <replaceable>min</replaceable> and <replaceable>max</replaceable>
  64 are given, the new desktop number is no smaller than
  65 <replaceable>min</replaceable>
  66 and no bigger than
  67 <replaceable>max</replaceable>.
  68 Values out of this range are truncated (if you gave an absolute
  69 desk number) or wrapped around (if you gave a relative desk
  70 number).</para>
  71
  72 <para>The syntax is the same as for
  73 <fvwmref cmd="MoveToDesk"/>,
  74 which moves a window to a different desktop.</para>
  75
  76 <para>The number of active desktops is determined dynamically.  Only
  77 desktops which contain windows or are currently being displayed
  78 are active.  Desktop numbers must be between 2147483647 and
  79 -2147483648 (is that enough?).</para>
  80
  81 </section>