doc/commands/Resize.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: Resize.xml,v 1.3 2007/06/16 12:38:46 griph Exp $ -->
  10
  11 <section id='Resize'>
  12 <title>Resize</title>
  13
  14 <cmdsynopsis>
  15         <command>Resize</command
  16         ><group choice='plain'
  17         /><optional
  18                 ><arg choice='opt'>frame</arg
  19                 ><arg choice='opt'
  20                         >direction <replaceable>dir</replaceable
  21                         ><arg choice='opt'>warptoborder</arg
  22                 ></arg
  23                 ><arg choice='opt'>fixeddirection</arg
  24                 ><arg choice='plain'
  25                         ><optional>w</optional
  26                         ><replaceable>width</replaceable
  27                         ><optional
  28                                 ><group choice='plain'
  29                                         ><arg choice='plain'>p</arg
  30                                         ><arg choice='plain'>c</arg
  31                                 ></group
  32                         ></optional
  33                 ></arg
  34                 ><arg choice='plain'
  35                         ><optional>w</optional
  36                         ><replaceable>height</replaceable
  37                         ><optional
  38                                 ><group choice='plain'
  39                                         ><arg choice='plain'>p</arg
  40                                         ><arg choice='plain'>c</arg
  41                                 ></group
  42                         ></optional
  43                 ></arg
  44         ></optional>
  45 </cmdsynopsis>
  46
  47
  48 <para>Allows for resizing a window.  If called from somewhere in a window
  49 or its border, then that window is resized.  If called from the
  50 root window then the user is allowed to select the target window.</para>
  51
  52 <para>The operation can be aborted with <keysym>Escape</keysym> or by pressing
  53 any mouse button (except button 1 which confirms it).</para>
  54
  55 <para>If the optional arguments
  56 <replaceable>width</replaceable> and <replaceable>height</replaceable>
  57 are provided, then the window is resized so that its dimensions
  58 are
  59 <replaceable>width</replaceable> by <replaceable>height</replaceable>.
  60 The units of
  61 <replaceable>width</replaceable> and <replaceable>height</replaceable>
  62 are percent-of-screen, unless a letter
  63 '<fvwmopt cmd="Resize" opt="p"/>'
  64 is appended to one or both coordinates, in which case the location
  65 is specified in pixels.  With a
  66 '<fvwmopt cmd="Resize" opt="c"/>'
  67 suffix the unit defined by the client application (hence the c) is
  68 used.  So you can say</para>
  69
  70 <programlisting>Resize 80c 24c</programlisting>
  71
  72 <para>to make a terminal window just big enough for 80x24
  73 characters.</para>
  74
  75 <para>If the
  76 <replaceable>width</replaceable> or <replaceable>height</replaceable>
  77 is prefixed with the letter
  78 '<fvwmopt cmd="Resize" opt="w"/>'
  79 the size is not taken as an absolute value but added to the
  80 current size of the window.  Example:</para>
  81
  82 <programlisting>
  83 # Enlarge window by one line
  84 Resize keep w+1c
  85 </programlisting>
  86
  87 <para>Both,
  88 <replaceable>width</replaceable> and <replaceable>height</replaceable>
  89 can be negative.  In this case the new size is the screen size
  90 minus the given value.  If either value is "<fvwmopt cmd="Resize" opt="keep"/>", the
  91 corresponding dimension of the window is left untouched.  The new
  92 size is the size of the client window, thus</para>
  93
  94 <programlisting>Resize 100 100</programlisting>
  95
  96 <para>may make the window bigger than the screen.  To base the new size
  97 on the size of the whole fvwm window, add the
  98 <fvwmopt cmd="Resize" opt="frame"/>
  99 option after the command.  The options
 100 <emphasis remap='I'>fixeddirection</emphasis>,
 101 <emphasis remap='I'>direction</emphasis> and
 102 <emphasis remap='I'>warptoborder</emphasis>
 103 are only used in interactive move operations.  With
 104 <fvwmopt cmd="Resize" opt="fixeddirection"/>
 105 the same border is moved even if the pointer moves past the
 106 opposite border.  The
 107 <fvwmopt cmd="Resize" opt="direction"/>
 108 option must be followed by a direction name such as "NorthWest",
 109 "South" or "East" (you get the idea).  Resizing is started
 110 immediately, even if the pointer is not on a border.  The
 111 <fvwmopt cmd="Resize" opt="warptoborder"/>
 112 option changes the behaviour of the
 113 <emphasis remap='I'>direction</emphasis>
 114 option so that the pointer is automatically warped to the border
 115 in the given direction before starting to resize.  Also, if
 116 resizing is started by clicking on the window border, the pointer
 117 is warped to the outer edge of the border.</para>
 118
 119 <programlisting>
 120 <fvwmref cmd="AddToFunc"/> ResizeSE I Resize <fvwmref cmd="Direction"/> SE
 121 <fvwmref cmd="Mouse"/> 3 A M ResizeSE
 122 </programlisting>
 123
 124
 125 <cmdsynopsis>
 126         <command>Resize</command
 127                 ><arg choice='opt'
 128                         ><group choice='plain'
 129                                 ><arg choice='plain'>bottomright</arg
 130                                 ><arg choice='plain'>br</arg
 131                         ></group
 132                         ><arg choice='plain'
 133                                 ><replaceable>x</replaceable
 134                         ></arg
 135                         ><arg choice='plain'
 136                                 ><replaceable>y</replaceable
 137                         ></arg
 138                 ></arg>
 139 </cmdsynopsis>
 140
 141 <para>An alternate syntax is used if the keyword
 142 <fvwmopt cmd="Resize" opt="bottomright"/> or in short
 143 <fvwmopt cmd="Resize" opt="br"/>
 144 follows the command name.  In this case, the arguments
 145 <replaceable>x</replaceable> and <replaceable>y</replaceable>
 146 specify the desired position of the bottom right corner of the
 147 window.  They are interpreted exactly like the
 148 <replaceable>x</replaceable> and <replaceable>y</replaceable>
 149 arguments of the
 150 <fvwmref cmd="Move"/>
 151 command.  Actually, any of the options accepted by the
 152 <fvwmref cmd="Move"/>
 153 command can be used.</para>
 154
 155 </section>