[sawfish] Doc on infinite-desktop, in texi and docstrings.

[Christopher Bratusek <chrisb src gnome org>]

commit 88151c85e2bedf41d9b8347d9b36d32dd4e92f25
Author: Teika kazura <teika lavabit com>
Date:   Sat Dec 19 15:16:41 2009 +0900

    Doc on infinite-desktop, in texi and docstrings.

 OPTIONS                                 |    8 +++---
 lisp/sawfish/wm/ext/infinite-desktop.jl |   18 ++++++++--------
 man/sawfish.texi                        |   34 +++++++++++++++++++++++++++++-
 3 files changed, 45 insertions(+), 15 deletions(-)
---
diff --git a/OPTIONS b/OPTIONS
index 012079b..1c58e7f 100644
--- a/OPTIONS
+++ b/OPTIONS
@@ -658,14 +658,14 @@
 
 ;; (require 'sawfish.wm.ext.infinite-desktop)
 
-;; (define-special-variable infinite-desktop-p 1
-;;   "Simulate an infinite desktop (Conflicts edge-flipping).")
+;; (define-special-variable infinite-desktop-p t
+;;   "\"Infinite desktop\", or smooth viewport motion with mouse (Conflicts edge-flipping).")
 
 ;; (define-special-variable infinite-desktop.move-distance 64
-;;   "Amount to move the workspace.")
+;;   "Amount to move the viewport when the pointer hits the screen edge.")
 
 ;; (define-special-variable infinite-desktop.move-cursor-distance 32
-;;   "Amount to move the cursor after moving the workspace.")
+;;   "Amount to pull back the cursor after moving the viewport.")
 
 ;; poweroff options
 
diff --git a/lisp/sawfish/wm/ext/infinite-desktop.jl b/lisp/sawfish/wm/ext/infinite-desktop.jl
index ea3fcb6..8651e1d 100644
--- a/lisp/sawfish/wm/ext/infinite-desktop.jl
+++ b/lisp/sawfish/wm/ext/infinite-desktop.jl
@@ -1,4 +1,4 @@
-;; infinite-desktop.jl -- make the virtual desktop bigger than the physical
+;; infinite-desktop.jl -- Smooth viewport motion with mouse
 
 ;; Copyright (C) 2008 David T. McWherter <udmcwher mcs drexel edu>
 
@@ -47,26 +47,26 @@
   (defgroup infinite-desktop "Infinite Desktop"
     :group workspace)
 
-  (defcustom infinite-desktop-p 1
-    "Simulate an infinite desktop (Conflicts edge-flipping)."
+  (defcustom infinite-desktop-p t
+    "\"Infinite desktop\", or smooth viewport motion with mouse (Conflicts edge-flipping)."
     :group (workspace infinite-desktop)
     :after-set (lambda () (infinite-desktop.infinite-desktop))
     :type boolean)
 
   (defcustom infinite-desktop.move-distance 64
-    "Amount to move the workspace."
+    "Amount to move the viewport when the pointer hits the screen edge."
     :group (workspace infinite-desktop)
     :type number
     :range (1 . nil))
 
   (defcustom infinite-desktop.move-cursor-distance 32
-    "Amount to move the cursor after moving the workspace."
+    "Amount to pull back the cursor after moving the viewport."
     :group (workspace infinite-desktop)
     :type number
     :range (1 . nil))
 
   (define (infinite-desktop.move-right)
-    "Shifts the display `infinite-desktop.move-distance' pixels to the
+    "Shifts the viewport `infinite-desktop.move-distance' pixels to the
 right."
     (let ((dist infinite-desktop.move-distance)
           (cdist infinite-desktop.move-cursor-distance)
@@ -79,7 +79,7 @@ right."
       (move-cursor (- (min dist cdist)) 0)))
 
   (define (infinite-desktop.move-left)
-    "Shifts the display `infinite-desktop.move-distance' pixels to the
+    "Shifts the viewport `infinite-desktop.move-distance' pixels to the
 left."
     (let ((dist (- infinite-desktop.move-distance))
           (cdist (- infinite-desktop.move-cursor-distance))
@@ -92,7 +92,7 @@ left."
       (move-cursor (- (max dist cdist)) 0)))
 
   (define (infinite-desktop.move-top)
-    "Shifts the display `infinite-desktop.move-distance' pixels up."
+    "Shifts the viewport `infinite-desktop.move-distance' pixels up."
     (let ((dist (- infinite-desktop.move-distance))
           (cdist (- infinite-desktop.move-cursor-distance))
           (miny 0))
@@ -104,7 +104,7 @@ left."
       (move-cursor 0 (- (max dist cdist)))))
 
   (define (infinite-desktop.move-bottom)
-    "Shifts the display `infinite-desktop.move-distance' pixels down."
+    "Shifts the viewport `infinite-desktop.move-distance' pixels down."
     (let ((dist infinite-desktop.move-distance)
           (cdist infinite-desktop.move-cursor-distance)
           (maxy (* (screen-height) (1- (cdr viewport-dimensions)))))
diff --git a/man/sawfish.texi b/man/sawfish.texi
index cfdff2b..406637c 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -4054,6 +4054,7 @@ dimensions directly.
 @menu
 * Viewport Functions::
 * Dynamic Viewport::       Automatic resizing of workspace.
+* Smooth Viewport::        Nice feature but not always compatible
 * Windows and Viewports::
 @end menu
 
@@ -4146,7 +4147,7 @@ defined by Sawfish call this function, so this variable is important
 for the user.
 @end defvr
 
- node Dynamic Viewport, Windows and Viewports, Viewport Functions, Viewports
+ node Dynamic Viewport, Smooth Viewport, Viewport Functions, Viewports
 @section Dynamic Viewport
 
 ``Dynamic viewport'' is enabled by setting
@@ -4193,7 +4194,36 @@ those who are not using dynamic viewports do not need to worry about
 Under dynamic viewport, @code{viewport-dimensions} is the current size
 of the current workspace, and does not have the meaning as a user option.
 
- node Windows and Viewports,  , Dynamic Viewport, Viewports
+ node Smooth Viewport, Windows and Viewports, Dynamic Viewport, Viewports
+ section Smooth Viewport
+ cindex Smooth Viewport
+ cindex Infinite Desktop
+
+``Infinite desktop'' is an intuitive, nice feature. Just move the
+mouse, for example to right, very far. As the pointer hits the screen
+edge, the viewport moves as if it is dragged by mouse motion. Viewport
+moves around by any amount, not limited to by a step of the physical
+screen size.
+
+To enable infinite desktop, put the following in your
+ file{~/.sawfish/rc}:
+
+ lisp
+(require 'sawfish.wm.ext.infinite-desktop)
+ end lisp
+
+Options can be set from the configurator, under @code{Workspace}
+section.
+
+Infinite desktop behavior differs noticeably from the usual viewport
+which lies on grid cells. For example, it does not make sense to ask
+in which viewport a window lies. The design is not complete yet, and
+may change in future. There may be some bugs.
+
+It is called ``infinite desktop'' by historical reason, but in fact
+you can limit the entire desktop size as you like.
+
+ node Windows and Viewports,  , Smooth Viewport, Viewports
 @section Windows and Viewports
 
 @defun window-viewport window