[sawfish] Docstring improvement for 'scroll-viewport-steps'.



commit bc6813997cec57f625ff2baf293016fb2ac74bd2
Author: Teika kazura <teika lavabit com>
Date:   Sat Oct 24 14:02:48 2009 +0900

    Docstring improvement for 'scroll-viewport-steps'.

 ChangeLog                   |    4 ++++
 OPTIONS                     |    5 ++++-
 lisp/sawfish/wm/viewport.jl |    5 ++++-
 man/sawfish.texi            |   14 ++++++++++----
 4 files changed, 22 insertions(+), 6 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 9c52b6c..62b30a1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2009-10-22  Teika kazura <teika lavabit com>
 	* OPTIONS
+	* man/sawfish.texi
+	* lisp/sawfish/wm/viewport.jl: Docstring improvement for 'scroll-viewport-steps'
+
+	* OPTIONS
 	* lisp/sawfish/wm/ext/apps-menu.jl
 	* man/sawfish.texi: Doc improvements on applications menu.
 
diff --git a/OPTIONS b/OPTIONS
index 8105f95..d58753c 100644
--- a/OPTIONS
+++ b/OPTIONS
@@ -218,7 +218,10 @@
 ;;    "How to act when passing the first or last viewport stop, wrap-around or dynamic")
 
 ;;  (define-special-variable scroll-viewport-steps 1
-;;    "Number of steps in which to scroll between viewports (less steps = faster scrolling)."
+;;    "When you go to another viewport, the bigger this value,
+;;  the more smoothly the screen is scrolled.
+;;  It is the number of steps for scrolling. The value 1 means no scroll, and
+;;  the change is instantaneous.")
 
 ;; workspace options
 
diff --git a/lisp/sawfish/wm/viewport.jl b/lisp/sawfish/wm/viewport.jl
index c9f8297..8bc4361 100644
--- a/lisp/sawfish/wm/viewport.jl
+++ b/lisp/sawfish/wm/viewport.jl
@@ -71,7 +71,10 @@
     :group (workspace viewport))
 
   (defcustom scroll-viewport-steps 1
-    "Number of steps for viewport scrolling."
+    "When you go to another viewport, the bigger this value,
+the more smoothly the screen is scrolled.
+It is the number of steps for scrolling. The value 1 means no scroll, and
+the change is instantaneous."
     :group (workspace viewport)
     :type number
     :range (1 . 50))
diff --git a/man/sawfish.texi b/man/sawfish.texi
index 6191908..4842793 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -4107,10 +4107,16 @@ each step in the motion.
 @end defun
 
 @defvr Customizable scroll-viewport-steps
-Number of steps in which to divide a viewport change for
- code{set-viewport}   Each step requires a redisplay.  Defaults to 1,
-which causes an instantaneous change to the new viewport.  The
-customization limit is 50.
+When you go to another viewport, the bigger this value, the more
+smoothly the screen is scrolled. It is the number of steps for
+scrolling. 
+
+The default value 1 means no scroll, and the change is
+instantaneous. The upper limit for customization is 50.
+
+This variable is used for @code{set-viewport}. All interactive commands
+defined by Sawfish call this function, so this variable is important
+for user.
 @end defvr
 
 @node Windows and Viewports,  , Switching Viewports, Viewports



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]