modules/FvwmRearrange/FvwmRearrange.1.in

   1 .\" t
   2 .\" @(#)@PACKAGE@-@VERSION@ @RELDATELONG@
   3 .de EX          \"Begin example
   4 .ne 5
   5 .if n .sp 1
   6 .if t .sp .5
   7 .nf
   8 .in +.5i
   9 ..
  10 .de EE
  11 .fi
  12 .in -.5i
  13 .if n .sp 1
  14 .if t .sp .5
  15 ..
  16 .TH FvwmRearrange 1 "@RELDATELONG@ (@VERSION@)" Fvwm "Fvwm Modules"
  17 .UC
  18 .SH NAME
  19 FvwmRearrange \- rearrange fvwm windows
  20 .SH SYNOPSIS
  21 FvwmRearrange is spawned by fvwm, so no command line invocation will work.
  22
  23 .SH DESCRIPTION
  24 This module can be called to tile or cascade windows.
  25
  26 When tiling the module attempts to tile windows on the current screen
  27 subject to certain constraints.  Horizontal or vertical tiling is performed
  28 so that each window does not overlap another, and by default each window
  29 is resized to its nearest resize increment (note sometimes some space
  30 might appear between tiled windows -- this is why).
  31
  32 When cascading the module attempts to cascade windows on the current screen
  33 subject to certain constraints.  Layering is performed so consecutive
  34 windows will have their window titles visible underneath the previous.
  35
  36 .SH INVOCATION
  37 FvwmRearrange is best invoked from a menu, pop up or button.  There are a
  38 number of command line options which can be used to constrain the
  39 layering, these are described below.  As an example case, one could
  40 call FvwmRearrange with the following arguments:
  41 .EX
  42 FvwmRearrange -tile -h 10 10 90 90
  43 .EE
  44 or
  45 .EX
  46 FvwmRearrange -cascade \-resize 10 2 80 70
  47 .EE
  48
  49 The first invocation will horizontally tile windows with a bounding box
  50 which starts at 10 by 10 percent into and down the screen and ends at
  51 90 by 90 percent into and down the screen.
  52
  53 The second invocation will cascade windows starting 10 by 2 percent into and
  54 down the screen.  Windows will be constrained to 80 by 70 percent of
  55 the screen dimensions.  Since the \fIresize\fP is also specified,
  56 windows will be resized to the given constrained width and height.
  57
  58 FvwmRearrange can be called as FvwmTile or FvwmCascade. This is equivalent
  59 to providing the -tile or -cascade option. This form is obsolete and
  60 supplied for backwards compatibility only.
  61
  62 Command-line arguments passed to FvwmRearrange are described here.
  63 .IP \-a
  64 Causes \fIall\fP window types to be affected, even ones with the
  65 WindowListSkip style.
  66 .IP \-animate
  67 Attempt to do an animated move, this is ignored if \fI-resize\fP
  68 or \fI-maximize\fP are used.
  69 .IP \-cascade
  70 Cascade windows. This argument must be the first on the command line.
  71 This is the default.
  72 .IP \-desk
  73 Causes all windows on the desk to be cascaded/tiled instead of the
  74 current screen only.
  75 .IP \-flatx
  76 Inhibits border width increment. Only used when cascading.
  77 .IP \-flaty
  78 Inhibits border height increment. Only used when cascading.
  79 .IP \-h
  80 Tiles horizontally (default is to tile vertically). Used for tiling only.
  81 .IP "\-incx \fIarg\fP"
  82 Specifies a horizontal increment which is successively added to
  83 cascaded windows.  \fIarg\fP is a percentage of screen width, or pixel
  84 value if a \fIp\fP is suffixed.  Default is zero. Used only for cascading.
  85 .IP "\-incy \fIarg\fP"
  86 Specifies a vertical increment which is successively added to cascaded
  87 windows.  \fIarg\fP is a percentage of screen height, or pixel value
  88 if a \fIp\fP is suffixed.  Default is zero. Used only for cascading.
  89
  90 .IP \-m
  91 Causes maximized windows to also be affected (implied by \-a).
  92 .IP \-maximize
  93 When moving/resizing a window, put it also into maximized state.
  94 .IP "\-mn \fIarg\fP"
  95 Tiles up to \fIarg\fP windows in tile direction.  If more windows
  96 exist, a new direction row or column is created (in effect, a matrix
  97 is created). Used only when tiling windows.
  98 .IP \-noanimate
  99 Do not attempt to do an animated move.
 100 .IP \-nomaximize
 101 Do not put windows into maximized state.
 102 .IP \-noraise
 103 Inhibits window raising, leaving the depth ordering intact.
 104 .IP \-noresize
 105 Inhibits window resizing, leaving window sizes intact. This is the default
 106 when cascading windows.
 107 .IP \-nostretch
 108 If tiling: inhibits window growth to fit tile.  Windows are shrunk to fit the
 109 tile but not expanded.
 110
 111 If cascading: inhibits window expansion when using the \-resize option.  Windows
 112 will only shrink to fit the maximal width and height (if given).
 113 .IP \-r
 114 Reverses the window sequence.
 115 .IP \-resize
 116 Forces all windows to resize to the constrained width and height (if
 117 given). This is the default when tiling windows.
 118 .IP \-s
 119 Causes sticky windows to also be affected (implied by \-a).
 120 .IP \-sp
 121 Causes windows sticky across pages to also be affected (implied by \-a).
 122 .IP \-sd
 123 Causes windows sticky across desks to also be affected (implied by \-a).
 124 .IP \-t
 125 Causes transient windows to also be affected (implied by \-a).
 126 .IP \-tile
 127 Tile windows. This argument must be the first on the command line.
 128 .IP \-u
 129 Causes untitled windows to also be affected (implied by \-a).
 130
 131 Up to four numbers can be placed on the command line that are not
 132 switches.  The first pair specify an x and y offset to start the first
 133 window (default is 0, 0).
 134 The meaning of the second pair depends on operation mode:
 135
 136 When tiling windows it specifies an absolute coordinate reference
 137 denoting the lower right bounding box for tiling.
 138
 139 When cascading it specifies a maximal width and height for the layered
 140 windows. If an affected window exceeds either this width or height, it
 141 is resized to the maximal width or height.
 142
 143 If any number is suffixed with the letter p, then it is taken to be a
 144 pixel value, otherwise it is interpreted as a screen percentage.
 145 Specifying zero for any parameter is equivalent to not specifying it.
 146
 147 .SH BUGS
 148 It is probably not a good idea to delete windows while windows are
 149 being rearranged.
 150
 151 .SH AUTHORS
 152 Andrew Veliath (original FvwmTile and FvwmCascade modules)
 153 Dominik Vogt (merged FvwmTile and FvwmCascade to FvwmRearrange)