doc/commands/MoveToPage.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!-- $Id: MoveToPage.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='MoveToPage'>
  12 <title>MoveToPage</title>
  13
  14 <cmdsynopsis>
  15         <command>MoveToPage</command
  16         ><group choice='plain'
  17                 ><arg choice='plain'
  18                         ><arg choice='opt'
  19                                 ><replaceable>options</replaceable
  20                         ></arg
  21                         ><arg choice='opt'
  22                                 ><arg choice='plain'
  23                                         ><replaceable>x</replaceable
  24                                         ><optional
  25                                                 ><group choice='plain'
  26                                                         ><arg choice='plain'
  27                                                                 >p</arg
  28                                                         ><arg choice='plain'
  29                                                                 >w</arg
  30                                                 ></group
  31                                         ></optional
  32                                 ></arg
  33                                 ><arg choice='plain'
  34                                         ><replaceable>y</replaceable
  35                                         ><optional
  36                                                 ><group choice='plain'
  37                                                         ><arg choice='plain'
  38                                                                 >p</arg
  39                                                         ><arg choice='plain'
  40                                                                 >w</arg
  41                                                 ></group
  42                                         ></optional
  43                                 ></arg
  44                         ></arg
  45                 ></arg
  46                 ><arg choice='opt'>prev</arg
  47         ></group>
  48 </cmdsynopsis>
  49
  50 <para>Moves the selected window to another page
  51 (<replaceable>x</replaceable>,<replaceable>y</replaceable>). The
  52 upper left page is (0,0), the upper right is (M,0), where M is one
  53 less than the current number of horizontal pages specified in the
  54 <fvwmref cmd="DesktopSize"/>
  55 command.  Similarly the lower left page is (0,N), and the lower
  56 right page is (M,N).  Negative page numbers refer to pages from
  57 the rightmost/lowest page.  If
  58 <fvwmopt cmd="MoveToPage" opt="x"/> and
  59 <fvwmopt cmd="MoveToPage" opt="y"/>
  60 are not given, the window is moved to the current page (a window
  61 that has the focus but is off-screen can be retrieved with this).
  62 Moving windows to a page relative to the current page can be
  63 achieved by adding a trailing
  64 '<fvwmopt cmd="MoveToPage" opt="p"/>'
  65 after any or both numerical arguments.  To move the window
  66 relative to its current location, add a trailing
  67 '<fvwmopt cmd="MoveToPage" opt="w"/>'.
  68 To move a window to the previous page use
  69 <fvwmopt cmd="MoveToPage" opt="prev"/>
  70 as the single argument.</para>
  71
  72 <para>Windows are usually not moved beyond desk boundaries.</para>
  73
  74 <para>Possible
  75 <replaceable>options</replaceable>
  76 are
  77 <fvwmopt cmd="MoveToPage" opt="wrapx"/> and
  78 <fvwmopt cmd="MoveToPage" opt="wrapy"/>
  79 to wrap around the x or y coordinate when the window is moved
  80 beyond the border of the desktop. For example, with
  81 <emphasis remap='I'>wrapx</emphasis>,
  82 when the window moves past the right edge of the desktop, it
  83 reappears on the left edge.  The options
  84 <fvwmopt cmd="MoveToPage" opt="nodesklimitx"/> and
  85 <fvwmopt cmd="MoveToPage" opt="nodesklimity"/>
  86 allow moving windows beyond the desk boundaries in x and y
  87 direction (disabling the
  88 <emphasis remap='I'>wrapx</emphasis> and <emphasis remap='I'>wrapy</emphasis>
  89 options).</para>
  90
  91 <para>Examples:</para>
  92
  93 <programlisting>
  94 # <fvwmref cmd="Move"/> window to page (2,3)
  95 MoveToPage 2 3
  96
  97 # <fvwmref cmd="Move"/> window to lowest and rightmost page
  98 MoveToPage -1 -1
  99
 100 # <fvwmref cmd="Move"/> window to last page visited
 101 MoveToPage prev
 102
 103 # <fvwmref cmd="Move"/> window two pages to the right and one
 104 # page up, wrap at desk boundaries
 105 MoveToPage wrapx wrapy +2p -1p
 106 </programlisting>
 107
 108 </section>