[sawfish] sawfish.texi: doc for grow, pack, shrink and yank.

[Christopher Bratusek <chrisb src gnome org>]

commit c56ce53ff2170d47b7b58001b06003959230a0c1
Author: Christopher Roy Bratusek <chris nanolx org>
Date:   Sat Oct 17 14:30:58 2009 +0200

    sawfish.texi: doc for grow, pack, shrink and yank.

 ChangeLog                             |   25 ++++++
 lisp/sawfish/wm/commands/grow-pack.jl |    2 +-
 man/sawfish.texi                      |  139 ++++++++++++++++++++++++++++++++-
 3 files changed, 161 insertions(+), 5 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 8cd164a..56c83f7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,6 +7,31 @@
 
 	* lisp/sawfish/wm/menus.jl: updated "Reload Appsmenu" entry to call new `update-apps-menu' instead of `update-saw-menu'
 
+	* man/sawfish.texi: added docs for several functions and variables:
+				- grow-window-up
+				- grow-window-down
+				- grow-window-left
+				- grow-window-right
+				- shrink-window-up
+				- shrink-window-down
+				- shrink-window-left
+				- shrink-window-right
+				- pack-window-up
+				- pack-window-down
+				- pack-window-left
+				- pack-window-right
+				- yank-window-up
+				- yank-window-down
+				- yank-window-left
+				- yank-window-right
+				- grow-is-maximize
+				- pack-warp-pointer
+				- grow-pack-bump-obscured
+				- grow-pack-bump-other-depth
+				- grow-pack-bump-ignored
+				- shrink-window-minimum-size
+				- yank-window-minimum-visible
+
 2009-10-16  Teika kazura <teika lavabit com>
 	* lisp/sawfish/wm/user.jl
 	* lisp/sawfish/wm/ext/apps-menu.jl: User can prepend their own apps-menu to the auto generated one. Cleanups, mostly in variables.
diff --git a/lisp/sawfish/wm/commands/grow-pack.jl b/lisp/sawfish/wm/commands/grow-pack.jl
index 8a6b64f..5bca887 100644
--- a/lisp/sawfish/wm/commands/grow-pack.jl
+++ b/lisp/sawfish/wm/commands/grow-pack.jl
@@ -65,7 +65,7 @@
     :type (choice always maybe never)
     :group (move gpsy))
 
-  (defcustom grow-pack-bump-obscured ()
+  (defcustom grow-pack-bump-obscured nil
     "Whether to bump into fully obscured windows."
     :type boolean
     :group (move gpsy))
diff --git a/man/sawfish.texi b/man/sawfish.texi
index decbf94..ff2e3d3 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -3,10 +3,10 @@
 @settitle sawfish Programming Manual
 @footnotestyle end
 
- set EDITION 0.14
- set VERSION 1.5.0
- set UPDATED 02 Apr 2009
- set UPDATE-MONTH Apr 2009
+ set EDITION 0.15
+ set VERSION 1.6.0
+ set UPDATED 17 Oct 2009
+ set UPDATE-MONTH Oct 2009
 
 @ifinfo
 @dircategory Programming
@@ -1766,6 +1766,137 @@ Double the size of @var{window}
 Halve the size of @var{window}
 @end deffn
 
+Sawfish supports increasing a windows size until it bumps into another
+window, this is called @code{grow}. @code{shrink} achieves the opposite,
+it decreases a windows size, until it does no longer overlap any other window.
+
+ deffn Command grow-window-up window #!optional arg
+Grows @var{window} upwards until it "bumps into" another window.
+If the top edge was beyond the screen edge, it is brought back in.
+With a universal prefix @var{arg}, maximize upwards instead. With a numeric
+prefix @var{arg}, grow upwards by that many increments specified by
+window or pixels instead.
+ end deffn
+
+ deffn Command grow-window-down window #!optional arg
+Grows @var{window} downwards until it "bumps into" another window.
+See @code{grow-window-up}.
+ end deffn
+
+ deffn Command grow-window-left window #!optional arg
+Grows @var{window} left until it "bumps into" another window.
+See @code{grow-window-up}.
+ end deffn
+
+ deffn Command grow-window-right window #!optional arg
+Grows @var{window} right until it "bumps into" another window.
+See @code{grow-window-up}.
+ end deffn
+
+ deffn Command shrink-window-up window
+Shrinks @var{window} by moving the lower edge upwards until it
+intersects with one window less than before.
+ end deffn
+
+ deffn Command shrink-window-down window
+Shrinks @var{window} by moving the upper edge downwards until it
+intersects with one window less than before.
+ end deffn
+
+ deffn Command shrink-window-left window
+Shrinks @var{window} by moving the right edge to the left until it
+intersects with one window less than before.
+ end deffn
+
+ deffn Command shrink-window-right window
+Shrinks @var{window} by moving the left edge to the right until it
+intersects with one window less than before.
+ end deffn
+
+in addition to @code{grow} and @code{shrink} sawfish also has @code{pack} and @code{yank},
+the difference is that while @code{grow} and @code{shrink} resize the window,
+ code{pack} and @code{yank} move it.
+
+ deffn Command pack-window-up window #! optional arg
+Moves @var{window} upwards until it "bumps into" another window.
+If the top edge was beyond the screen edge, it is moved back in.
+With a universal prefix @var{arg}, move upwards maximally instead.
+With a numeric prefix @var{arg}, move upwards by that many pixels instead.
+ end deffn
+
+ deffn Command pack-window-down #!optional arg
+Moves @var{window} downwards until it "bumps into" another window.
+See @code{pack-window-up}.
+ end deffn
+
+ deffn Command pack-window-left window #!optional arg
+Moves @var{window} left until it "bumps into" another window.
+See @code{pack-window-up}.
+ end deffn
+
+ deffn Command pack-window-right window #!optional arg
+Moves @var{window} right until it "bumps into" another window.
+See @code{pack-window-up}.
+ end deffn
+
+ deffn Command yank-window-up window
+Yanks @var{window} upwards until it inserts with one window less than
+before.
+ end deffn
+
+ deffn Command yank-window-down window
+Yanks @var{window} downwards until it inserts with one window less than
+before.
+ end deffn
+
+ deffn Command yank-window-left window
+Yanks @var{window} left until it inserts with one window less than
+before.
+ end deffn
+
+ deffn Command yank-window-right window
+Yanks @var{window} right until it inserts with one window less than
+before.
+ end deffn
+
+grow, pack, shrink and yank behavior can be customized through the
+following variables:
+
+ defvar grow-is-maximize
+Whether growing is considered to be maximization.
+The default value is @code{t}.
+ end defvar
+
+ defvar pack-warp-pointer
+Whether and how to move the pointer, either @code{allways} @code{maybe}
+or @code{never}. The default value is @code{maybe}.
+ end defvar
+
+ defvar grow-pack-bump-obscured
+Whether to bump into fully obscured windows.
+The default value is @code{nil}.
+ end defvar
+
+ defvar grow-pack-bump-other-depth
+Whether to bump into windows on a different depth, either @code{allways}
+ code{maybe} or @code{never}. The default value is @code{always}.
+ end defvar
+
+ defvar grow-pack-bump-ignored
+Whether to bump into ignored windows.
+The default value is @code{t}.
+ end defvar
+
+ defvar shrink-window-minimum-size
+The minimum height or width to which a window may be shrunk.
+The default value is @code{10}.
+ end defvar
+
+ defvar yank-window-minimum-visible
+The minimum amount of window left visible, if yanked over the edge.
+The default value is @code{10}.
+ end defvar
+
 @deffn Command move-window-center windows
 Place @var{window} in the middle of the screen
 (frame-size is respected while calculating position)