[sawfish] Minor docs.



commit ec04741401f46e5591b130de70d4179dbd56cc95
Author: Teika kazura <teika lavabit com>
Date:   Tue Feb 1 14:08:10 2011 +0900

    Minor docs.

 lisp/sawfish/wm/commands.jl       |    3 +++
 lisp/sawfish/wm/customize.jl      |    3 ++-
 lisp/sawfish/wm/ext/auto-raise.jl |    1 +
 lisp/sawfish/wm/windows.jl        |    3 +++
 man/sawfish.texi                  |   35 +++++++++++++++++++++++------------
 themes/mxflat/theme.jl            |   34 ----------------------------------
 6 files changed, 32 insertions(+), 47 deletions(-)
---
diff --git a/lisp/sawfish/wm/commands.jl b/lisp/sawfish/wm/commands.jl
index 40ef8b4..fd74adb 100644
--- a/lisp/sawfish/wm/commands.jl
+++ b/lisp/sawfish/wm/commands.jl
@@ -140,6 +140,9 @@ command called NAME (optionally whose arguments have custom-type TYPE)."
   (define (call-command name #!optional pfx-arg)
     "Call the command NAME; optionally with the prefix argument PFX-ARG."
 
+    ;; `name' is a lisp expression for commands with `type',
+    ;; among others.
+    
     ;; prefix
     (let ((this-command name))
       (unless pfx-arg (setq pfx-arg prefix-arg))
diff --git a/lisp/sawfish/wm/customize.jl b/lisp/sawfish/wm/customize.jl
index 0d591d6..6e17034 100644
--- a/lisp/sawfish/wm/customize.jl
+++ b/lisp/sawfish/wm/customize.jl
@@ -100,7 +100,8 @@ instance can read it only once."
 	  (unwind-protect
 	      (progn
 		(format file "\
-;; sawfish user customization -- do not edit by hand!
+;; Sawfish user customization -- do not edit by hand!
+;; Use the configurator instead.
 ;; sawfish version %s, written %s\n\n"
                         sawfish-version (current-time-string))
 		(mapc (lambda (f)
diff --git a/lisp/sawfish/wm/ext/auto-raise.jl b/lisp/sawfish/wm/ext/auto-raise.jl
index f6f82dd..7fd5a2e 100644
--- a/lisp/sawfish/wm/ext/auto-raise.jl
+++ b/lisp/sawfish/wm/ext/auto-raise.jl
@@ -45,6 +45,7 @@
     :depends raise-windows-on-focus
     :group (focus auto-raise))
 
+  ;; Used to suppress temporarily in some commands.
   (defvar disable-auto-raise nil)
 
   (define rw-timer nil)
diff --git a/lisp/sawfish/wm/windows.jl b/lisp/sawfish/wm/windows.jl
index 7073c55..453b735 100644
--- a/lisp/sawfish/wm/windows.jl
+++ b/lisp/sawfish/wm/windows.jl
@@ -317,6 +317,9 @@ specified by the user."
 ;;; resizing windows in accordance with their size hints
 
   (define (constrain-dimension-to-hints x dimension hints)
+    ;; User asks the value DIMENSION as a window dimension.
+    ;; X is either 'x or 'y.
+    ;; Return value is the DIMENSION constrained by HINTS.
     (let ((base (cdr (assq (if (eq dimension 'x)
 			       'base-width 'base-height) hints)))
 	  (minimum (cdr (assq (if (eq dimension 'x)
diff --git a/man/sawfish.texi b/man/sawfish.texi
index 58e42dd..6c50482 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -1926,14 +1926,17 @@ Move the top-left corner of the window frame of @var{window} to
 
 @defun resize-window-with-hints window cols rows @t{#!optional} hints
 @defunx resize-window-with-hints* window width height @t{#!optional} hints
-Resize the window associated with object @var{window} so that it has
-certain X and Y dimensions.  For the first function, the dimensions
-are @var{cols} columns and @var{rows} rows.   For the second function,
-the dimensions are @var{width} pixels and @var{height} pixels.
+Resize the window @var{window} respecting the hints (see below).
+For the first function, the dimensions are @var{cols} columns and
+ var{rows} rows.  For the second function, the dimensions are
+ var{width} pixels and @var{height} pixels.
 
 The @var{hints} parameters is either the size hints alist to use, or
 @code{nil} in which case the @code{window-size-hints} function is used
 to retrieve the window's hints.
+
+Hints can specify minimum or maximum value of each dimension, and
+also increase step, as far as these two functions are concerned.
 @end defun
 
 @defun window-size-hints window
@@ -3092,13 +3095,11 @@ customization variables to configure, or all classes if @var{group} is
 undefined.
 @end deffn
 
-There also exists the command, for example, @code{customize:appearance},
-i.e. for each top-level customization group, the command to customize
-only it and its subgroups.
+There also exists commands like @code{customize:appearance}, i.e. for
+each top-level customization group, the command to customize only it
+and its subgroups.
 
-The @file{sawfish-config} program can be used to invoke the GUI manually;
-if GNOME is being used, then the GNOME Control Center can also be used
-to customize certain classes.
+The @file{sawfish-config} program can be used to invoke the GUI manually.
 
 In order to provide these customization options however, an extra
 requirement is placed on the Lisp programmer. Instead of just using the
@@ -5721,7 +5722,10 @@ If it's lacking, that of the function @var{fun} will be looked up.
 Other arguments are mostly for internal use.
 
 @var{type} specifies arguments, too. These arguments are statically
-set in ``Bindings'' section of the configurator. (The doc is lacking.)
+set in ``Bindings'' section of the configurator. If @var{type} is set,
+then a lisp expression like @code{(command-name arg1 arg2...)} is bound
+to the key, in contrast to the usual case where command name is bound.
+(The precise doc is lacking.)
 
 @var{class} is a symbol which annotates the command, for example
 @code{advanced}. Users can choose which commands are shown in the
@@ -6426,6 +6430,10 @@ is @code{nil} then any string previously displayed is removed. Returns
 the numeric id of the window displaying the message, or @code{nil} if
 no message is displayed.
 
+The window is placed on top of X client windows, and basically at the
+center of the screen. The window remains until another call of this
+function, or the user clicks on it.
+
 @var{attributes} is an alist specifying how the string should be
 displayed; each element of the list is a cons cell @code{(@var{attr} .
 @var{value})} associating an attribute @var{attr} (a symbol) with it's
@@ -6462,8 +6470,11 @@ The head on which to center the message when a position is not specified or
 given as nil.  If not provided defaults to the head containing the window that
 has the input focus.
 @end table
- end defun
 
+Tip: Don't call this function during initialization. Instead, use
+ code{after-initialization-hook} to defer. Otherwise the message
+window is covered by X client windows.
+ end defun
 
 @node Rectangle Functions, Gradient Functions, Display Functions, Miscellaneous Functions
 @section Rectangle Functions
diff --git a/themes/mxflat/theme.jl b/themes/mxflat/theme.jl
index caa3170..c7daa41 100644
--- a/themes/mxflat/theme.jl
+++ b/themes/mxflat/theme.jl
@@ -2732,45 +2732,11 @@ string color."
 ;;; REGISTER THEME
 ;;  --------------
 ;;
-;; that is from the manual
-;; (http://sawmill.sourceforge.net/prog-manual.html)
-;;
-;; Frame Types
-;;
-;; * default
-;; The normal frame type. Includes all decorations, both borders and
-;; the title bar.
-;;
-;; * transient
-;; The frame for a transient window. This usually does not include a
-;; title bar, but does have all four borders.
-;;
-;; * shaped
-;; Shaped windows are normally decorated with only a title-bar, since
-;; their boundary is not rectangular it makes no sense to surround
-;; them with a rectangular border.
-;;
-;; * shaped-transient
-;; A combination of the shaped and transient types, normally just a
-;; very small title border with no text.
-;;
-;; * shaded
-;; A shaded window (normally just the title bar).
-;;
-;; * shaded-transient
-;; A shaded transient window.
-;;
-;; * unframed
-;; No frame at all, just the client window itself. The predefined
-;; nil-frame variable contains a null frame that may be used for this
-;; frame type.
-;;
 ;; "Normal" 'default
 ;; "Title-only" 'shaped
 ;; "Border-only" 'transient
 ;; "Top-border" 'shaped-transient
 ;; "None" 'unframed
-;;
 
 ;; return the window frame and decorations
 (define (get-frame w frame-type)



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