[sawfish] doc:

From: Christopher Bratusek <chrisb src gnome org>
To: commits-list gnome org
Cc:
Subject: [sawfish] doc:
Date: Tue, 14 Sep 2010 16:47:31 +0000 (UTC)
commit 297e44d3a8ce81fd48703fcca45f48e8a1318583
Author: Teika kazura <teika lavabit com>
Date:   Sat Sep 11 21:11:22 2010 +0900

    doc:
    
    * Typo fixes for x-draw-text.
    * Session management command line options are listed in "sawfish.1".
    * News.
    * Added history on lisp/sawfish/gtk/stock.jl
    * OPTIONS: minor change.
    * Misc.
    * CONTRIBUTING: update on bug reporting instruction.

 CONTRIBUTING                         |   62 ++++++++++++++---------
 OPTIONS                              |   18 ++++---
 lisp/sawfish/gtk/stock.jl            |    6 ++-
 lisp/sawfish/wm.jl                   |    6 +-
 lisp/sawfish/wm/commands.jl          |   12 +++--
 lisp/sawfish/wm/commands/describe.jl |    5 +-
 lisp/sawfish/wm/customize.jl         |    6 ++
 lisp/sawfish/wm/frames.jl            |    2 +
 lisp/sawfish/wm/util/nokogiri.jl     |    4 +-
 lisp/sawfish/wm/windows.jl           |    2 +
 man/news.texi                        |   90 ++++++++++++++++++---------------
 man/sawfish.1                        |    3 +
 man/sawfish.texi                     |   39 ++++++++-------
 src/functions.c                      |   11 +++-
 src/x.c                              |    6 ++-
 themes/mxflat/README                 |   19 +++-----
 16 files changed, 175 insertions(+), 116 deletions(-)
---
diff --git a/CONTRIBUTING b/CONTRIBUTING
index b6bd350..e3b72b7 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,31 +1,32 @@
 BUGS
 ****
 
-If you think you have found a bug, first check for newer versions of sawfish 
-and/or librep/rep-gtk and update, if it still happens with the latest versions: 
+If you think you have found a bug,
 
-Report Bugs in the GNOME BugZilla (http://bugzilla.gnome.org), we 
-prefer this over the mailing-list, because it's easier to find older
-reports in the BugZilla Database than in the Mailinglist-Archives
+1. Check if it'll be a new report.
+First check for newer versions of sawfish and librep/rep-gtk.  If it
+still happens with the latest versions, search for similar bugs by web
+searching / in GNOME Bugzilla (http://bugzilla.gnome.org).
 
-As product choose: Other -> Sawfish
+All open bugs in Bugzilla are found at:
+https://bugzilla.gnome.org/buglist.cgi?bug_status=__open__&product=Sawfish&order=Bug+Number
 
-Then choose the version you're using: 
-	- pre-1.3.x (obsolete)
-	- 1.3.x 
-	- 1.5.x
+For search from a browser (like firefox "smart keyword"), use this URL:
+https://bugzilla.gnome.org/buglist.cgi?bug_status=__open__&product=Sawfish&order=Bug+Number&content=%s
 
-At last choose the sawfish component you want to report the bug for:
-	- config tool
-	- general
-	- theme editor (obsolete)
-	- window-manager
+If it already has been reported, simply reply to the existing report,
+rather than opening a new one.
+
+2. Ok, it's a new bug.
+Please report it to our Mailing list
+(http://sawfish.wikia.com/wiki/Mailing_list). It will be viewed by
+much more people than to report it in Bugzilla. Bugzilla submission
+howto is explained later.
 
 When reporting bugs try to include as much relevant information as
 possible:
 
- - Most importantly: a reliable method for triggering the bug. (Once
-   the bug can be reproduced it's often straightforward to fix.)
+ - Most importantly: a reliable method for triggering the bug.
 
  - If you hear beeping sounds while the problem manifests itself it may
    mean that sawfish's Lisp interpreter is printing error messages to
@@ -33,8 +34,10 @@ possible:
    ~/.gnomerc-errors). Include any such messages in your bug report.
 
  - If sawfish crashes it will try to print information describing the
-   position at which it did so, look for any `backtrace' messages in
-   the error output and include them
+   position at which it did so. Please start Sawfish again with the
+   command line option "--interp"; it'll take a little bit to start,
+   but more information is printed at crash. Look for any "backtrace"
+   messages in the error output and include them.
 
  - The operating system type and version (including distribution details)
 
@@ -43,13 +46,25 @@ possible:
    from, and what are their version numbers?
 
  - Any other information you feel may be relevant. E.g. the values of
-   customization options that you feel may affect the problem
+   customization options that you feel may affect the problem.
 
 Also please make sure to not report bugs multiple times, first check if
-there's already a report for your issue. If it already has been reported,
-simply reply to the existing report, rather than opening a new one.
+there's already a report for your issue.
 
-The full bug-database is here: http://bugzilla.gnome.org/buglist.cgi?product=sawfish
+To report a bug to the Bugzilla
+-------------------------------
+Go to https://bugzilla.gnome.org/enter_bug.cgi
+
+As product choose: Other -> Sawfish
+
+Then choose the version you're using, for example, pre-1.3.x (obsolete),
+1.5.x, and so on.
+
+At last choose the sawfish component you want to report the bug for:
+	- config tool
+	- general
+	- window-manager
+	- theme editor (This item is obsolete)
 
 DEVELOPMENT
 ***********
@@ -230,4 +245,3 @@ Apologies if I've missed any names, mail me if you should be listed.
 
 Thanks also to the numerous people who have contributed bug reports and
 feature suggestions, too many to list individually.
-
diff --git a/OPTIONS b/OPTIONS
index d3f4f14..814b164 100644
--- a/OPTIONS
+++ b/OPTIONS
@@ -3,14 +3,17 @@
 ;; OPTIONS
 ;; =======
 
-;; This file lists all of sawfish's low-level configuration options,
-;; including both those that can be set through the UI can those that
-;; can't. For most options it also shows their default value, or how
-;; that value is initially computed.
+;; This file lists all of sawfish's low-level configuration options.
+;; Some of them can be set from the configurator GUI, the rest not.
+;; For most options it also shows their default value, or how that
+;; value is initially computed.
 
-;; To use this file, either copy it to ~/.sawfishrc and uncomment and
+;; It is recommended to try first the configurator, which can be invoked
+;; by middle-clicking the root window (= background).
+
+;; To use this file, either copy it to ~/.sawfish/rc and uncomment and
 ;; change the lines containing the options you want to modify, or just
-;; use it as a reference when editing your own .sawfishrc
+;; use it as a reference when editing your own .sawfish/rc
 
 ;; Note that some of the pages of options start with a commented out
 ;; "require" statement. If you change any of those options you'll also
@@ -53,7 +56,8 @@
 ;;    "Show variable names of each customization option.")
 
 ;;  (defvar-setq customize-command-classes '(default)
-;;    "Also include commands of these classes the key bindings panel.)
+;;    "In configurator \"binding\" section, also include commands of these
+;;  classes. Possible keys are default, advanced, viewport, and deprecated.")
 
 ;; focus options
 
diff --git a/lisp/sawfish/gtk/stock.jl b/lisp/sawfish/gtk/stock.jl
index a7a44e3..b46832a 100644
--- a/lisp/sawfish/gtk/stock.jl
+++ b/lisp/sawfish/gtk/stock.jl
@@ -1,4 +1,4 @@
-;; nokogiri-no-gnome.jl -- workaround lack of GNOME widgets -*- lisp -*-
+;; stock.jl -- gtk stock and so on -*- lisp -*-
 ;;
 ;; Copyright (C) 2000 John Harper <john dcs warwick ac uk>
 ;;
@@ -18,6 +18,10 @@
 ;; along with sawfish; see the file COPYING.  If not, write to
 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
+;; This file was delete once by mistake, in the commit dbe8c2235, and
+;; it had been called "lisp/sawfish/gtk/stock.jl.gtk".
+;; Re-added in the commit ce7e6c.
+
 (define-structure sawfish.gtk.stock
 
     (export stock-button
diff --git a/lisp/sawfish/wm.jl b/lisp/sawfish/wm.jl
index 03fc9ad..6ee7f7e 100644
--- a/lisp/sawfish/wm.jl
+++ b/lisp/sawfish/wm.jl
@@ -1,4 +1,4 @@
-;; sawfish.wm bootstrap
+;; Initiates lisp part of Sawfish.
 ;;
 ;; Copyright (C) 1999 John Harper <john dcs warwick ac uk>
 ;;
@@ -64,7 +64,7 @@
 (defmacro i18n-define args (cons 'define args))
 (export-bindings '(i18n-defvar i18n-define))
 
-;; import libraries that may be needed by autoload files
+;; import libraries needed by autoload
 (require 'sawfish.wm.commands)
 (require 'sawfish.wm.custom)
 (require 'sawfish.wm.focus)
@@ -114,7 +114,7 @@
 		   sawfish.wm.state.ignored))
 
 ;; Bindings in these modules are exported by sawfish.wm on behalf of
-;; them.
+;; them. User scripts have to import only sawfish.wm for core functions.
 (export-bindings (parse-interface
 		  '(compound-interface
 		    (structure-interface sawfish.wm.colors)
diff --git a/lisp/sawfish/wm/commands.jl b/lisp/sawfish/wm/commands.jl
index 0d28f01..85ffef2 100644
--- a/lisp/sawfish/wm/commands.jl
+++ b/lisp/sawfish/wm/commands.jl
@@ -379,10 +379,14 @@ command for the `system' function."
   (define-command 'command-sequence command-sequence
     #:type `(and (quoted (list command ,(_ "Command")))))
 
-  (define-command 'quit quit)
-  (define-command 'restart restart)
-  (define-command 'destroy-window destroy-window #:spec "%W")
-  (define-command 'kill-client x-kill-client #:spec "%W")
+  (define-command 'quit quit
+    #:doc "Quit sawfish.")
+  (define-command 'restart restart
+    #:doc "Restart sawfish.")
+  (define-command 'destroy-window destroy-window #:spec "%W"
+    #:doc "Destroy a window.")
+  (define-command 'kill-client x-kill-client #:spec "%W"
+    #:doc "Kill the client that created the specified window.")
   (define-command 'no-operation nop)
 
   (define (call-command-with-output-to-screen command)
diff --git a/lisp/sawfish/wm/commands/describe.jl b/lisp/sawfish/wm/commands/describe.jl
index 3acb927..d24eb1b 100644
--- a/lisp/sawfish/wm/commands/describe.jl
+++ b/lisp/sawfish/wm/commands/describe.jl
@@ -31,7 +31,7 @@
   (define-structure-alias describe sawfish.wm.commands.describe)
 
   (define (describe-symbol fun)
-    "Display the documentation of a specified symbol."
+    "Print the documentation of a specified symbol to the standard output ."
     (describe-value (symbol-value fun t) fun)
     (format standard-output "\n%s\n"
 	    (or (documentation fun nil (symbol-value fun t)) "Undocumented.")))
@@ -40,7 +40,8 @@
   (define-command 'describe-symbol describe-symbol
     #:spec "SSymbol:" #:class 'advanced)
   (define-command-to-screen 'describe-symbol-to-screen describe-symbol
-    #:spec "SSymbol:" #:class 'advanced)
+    #:spec "SSymbol:" #:class 'advanced
+    #:doc "Enter a name of var/func, and prints its doc.")
 
   (define (apropos-output symbols)
     (let ((separator (make-string 72 ?-)))
diff --git a/lisp/sawfish/wm/customize.jl b/lisp/sawfish/wm/customize.jl
index 39fd74d..0d591d6 100644
--- a/lisp/sawfish/wm/customize.jl
+++ b/lisp/sawfish/wm/customize.jl
@@ -42,7 +42,10 @@
   (defvar customize-redirect ">/dev/null 2>&1 </dev/null"
     "Redirect the configurator's input & output.")
 
+  ;; Stores the content of ~/.sawfish/custom, both for
+  ;; parsing and writing.
   (define customize-user-forms nil)
+
   (define customize-user-file-read nil)
   (define customize-user-file-dirty nil)
 
@@ -61,7 +64,10 @@
 
 ;;; setting variables
 
+  ;; Currently only called from `customize-set' below.
   (define (customize-read-user-file)
+    "Read the file which saves user customization. A configurator
+instance can read it only once."
     (unless customize-user-file-read
       (let ((filename
 	     (cond ((file-exists-p custom-user-file) custom-user-file)
diff --git a/lisp/sawfish/wm/frames.jl b/lisp/sawfish/wm/frames.jl
index d7ac3b7..be4ff3e 100644
--- a/lisp/sawfish/wm/frames.jl
+++ b/lisp/sawfish/wm/frames.jl
@@ -21,6 +21,8 @@
 (define-structure sawfish.wm.frames
 
     (compound-interface
+     ;; Subrs are stored in sawfish.wm.frames.subrs, but
+     ;; this module re-exports them for convenience.
      (structure-interface sawfish.wm.frames.subrs)
      (export after-setting-frame-option
 	     define-frame-type-mapper
diff --git a/lisp/sawfish/wm/util/nokogiri.jl b/lisp/sawfish/wm/util/nokogiri.jl
index 7e2e744..3fd11a8 100644
--- a/lisp/sawfish/wm/util/nokogiri.jl
+++ b/lisp/sawfish/wm/util/nokogiri.jl
@@ -40,7 +40,9 @@
     "Show variable names of each customization option.")
 
   (defvar customize-command-classes '(default)
-    "Also include commands of these classes the key bindings panel.")
+    "In configurator \"binding\" section, also include commands of
+these classes. Possible keys are default, advanced, viewport, and
+deprecated.")
 
 ;;; interfaces
 
diff --git a/lisp/sawfish/wm/windows.jl b/lisp/sawfish/wm/windows.jl
index 46a8a9a..c3c172b 100644
--- a/lisp/sawfish/wm/windows.jl
+++ b/lisp/sawfish/wm/windows.jl
@@ -21,6 +21,8 @@
 (define-structure sawfish.wm.windows
 
     (compound-interface
+     ;; Subrs are stored in sawfish.wm.windows.subrs, but
+     ;; this module re-exports them for convenience.
      (structure-interface sawfish.wm.windows.subrs)
      (export get-window-by-name
 	     get-window-by-name-re
diff --git a/man/news.texi b/man/news.texi
index a86c15a..82b1767 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -7,7 +7,7 @@
 This lists the user-visible changes made to Sawfish, and which releases
 they occurred between. For more detailed information see the
 @file{ChangeLog} file in the Sawfish source tree, or git log.
-(See Wiki page for how to access git repository.)
+(See Wiki page on how to access git repository.)
 
 @heading 1.7.0 "Frozen Flame"
 
@@ -23,27 +23,33 @@ they occurred between. For more detailed information see the
 @item Notes
 @itemize @minus
 
+ item When you report a crash, please add the backtrace, by
+invoking Sawfish with the command line option ``---interp''.
+
+Read the file @file{CONTRIBUTING} for more.
+
 @item Prompt API change [Jeremy Hankins]
 
 If you have code which utilizes prompt, it is affected. When you
 call the function @code{prompt}, pass helper functions directly
 as the function's arguments. They used to be set as global variables.
 
-The change is straightforward, so you should be able to easily update
-your code. See @code{sawfish.wm.util.prompt} for details.
+The change is straightforward, so it be easy to update your code. See
+ code{sawfish wm util prompt} for details.
 
 @item Mouse-button support state
 
-Sawfish is claimed to support mouse-buttons 1 - 9, but it is known
-that drag of buttons 6 - 8 may not work. The button 9 doesn't work at
-all, so we withdraw it.
+Sawfish claimed to support mouse-buttons 1 - 9, but it is known that
+drag of buttons 6 - 8 may not work. The button 9 doesn't work at all,
+so we withdraw it.
 
 @item Functions @code{maybe-raise-window} and @code{maybe-lower-window} are
 now obsolete. [Teika Kazura]
 
 Replace them with @code{raise-window*} and @code{lower-window*} defined
 in @code{sawfish.wm.util.stacking}. Only difference is that the obsolete
-version supports a nautilus feature which was dropped long ago.
+version supports a feature of Nautilus (GNOME file manager) which was
+dropped long ago.
 @end itemize
 
 @item Build and Installation
@@ -89,7 +95,7 @@ Function @code{x-atom-name} now accepts all 32 bits. Previously only
 It used to cause ``Bad argument'' error, most notably on Java
 applications.
 
- item De-obsoletion of two variables [Teika Kazura]
+ item Resurrection of two variables [Teika Kazura]
 
 User options @code{workspace-boundary-mode} and
 @code{workspace-send-boundary-mode} couldn't be set from the
@@ -103,10 +109,10 @@ were sorted [A-Z][a-z] (first all upper- then all loser-case entries).
 Also the function for detecting the language has been improved. It
 now better follows the freedesktop.org specification.
 
- item Edge-flip now still works after resolution-change. [Christopher Bratusek]
+ item Edge-flip and infinite-desktop now works after screen resolution change. [Christopher Bratusek]
 
 @item Sawfish now starts up correctly when receiving a session-id or
-session-prefix from GNOME-Session [Christopher Bratusek]
+session-prefix from GNOME-Session [Clinton Ebadi, Christopher Bratusek]
 
 @item Draft animator bugfix. [Christopher Bratusek]
 
@@ -114,11 +120,13 @@ The ``draft'' animator had two issues, on one hand the drawn numbers were
 always black (therefore possibly invisible), on the other hand those
 numbers weren't erased from the screen (unless you used a
 desktop-shell which on it's own refreshes the screen regularly). Both
-issues have been fixed by introducing the @code{x-draw-text} function.
+have been fixed by introducing the @code{x-draw-text} function, which
+is described below.
 
 @item Command @code{xterm} fix [Teika kazura] *
-It didn't run if the optional ``command'' argument was unset by the
-configurator, i.e. if it was an empty string.
+It couldn't be invoked as a key binging if the optional ``command''
+argument was unset by the configurator, i.e. if it was an empty
+string.
 @end itemize
 
 @item New Features
@@ -134,25 +142,34 @@ parts. (@pxref{Frame Part Definition})
 
 @item @code{x-draw-text} function [Christopher Bratusek]
 
-This function is a replacement for @code{x-draw-string} currently
-only used in the draft-animator (to fix it's bugs). Generally, if
-you use a @code{display-message} like message, rely on @code{x-draw-string},
-but if you want to draw on the screen directly use @code{x-draw-text}.
+It is similar to @code{x-draw-string}. Generally, if you use a
+ code{display-message} like message, rely on @code{x-draw-string}, but
+if you want to draw on the screen directly use @code{x-draw-text}
+(@pxref{X Drawing}.)
+
+ item Desktop environment integrations [Christopher Bratusek]
 
- item XFCE integration module [Christopher Bratusek]
+The new support of XFCE integration is just like the GNOME/KDE4 ones:
+it sets @code{xterm-program} and @code{browser-program} (unless already
+set by user), and adds XFCE logout/help/customization menu-entries to
+the Sawfish root-menu.
 
-The XFCE integration module behaves just like the GNOME/KDE4 ones:
-it sets xterm-program/browser-program unless already set by user and
-it adds XFCE logout/help/customization menu-entries to the root-menu
+Improvements are: All menu-entries for GNOME/KDE4 do now have
+accelerators. Entries for invoking @code{gnome-control-center} or KDE
+ code{systemsettings} have been added. The KDE4 detection has been
+improved.
+
+A new variable @code{desktop-environment} tells which desktop
+environment (gnome, kde, xfce or none) is running.
 
 @item Apps-Menu improvements [Matthew Love]
 
-Our freedesktop.org menu-implementation does now honor the OnlyShowIn
-and NotShowIn fields. This is done via @code{desktop-environment} set
-in sawfish.wm.integration.* on startup.
+The applications menu now honors the OnlyShowIn and NotShowIn
+fields.
 
-Furthermore the variable @code{apps-menu-ignore-no-display} is replaced
-by the variable @code{apps-menu-show-all}. The latter is more flexible:
+Furthermore the user option @code{apps-menu-ignore-no-display} is
+replaced by a new variable @code{apps-menu-show-all}. The latter is
+more flexible:
 
 if @code{apps-menu-show-all} is set to 'nil, then: fields @code{Hidden},
 @code{NoDisplay}, @code{NotShowIn} and	@code{OnlyShowIn} are respected
@@ -180,9 +197,9 @@ if @code{apps-menu-show-all} is set to 't, then: fields @code{Hidden},
 @itemize @minus
 @item More error and backtrace printing [Teika Kazura]
 
-Due to librep >= 0.91.0, the backtrace is printed by default on error.
-It is printed for sawfish-client, too, but it's sent to Sawfish's
-standard error, not to sawfish-client's, sorry.
+Due to librep >= 0.91.0, the backtrace is printed by default when an
+error is signaled. It is printed for sawfish-client, too, but it's
+sent to Sawfish's standard error, not to sawfish-client's, sorry.
 
 Previously when you connected to Sawfish as a server asynchronously,
 then the error was not printed. Now it is printed to Sawfish's
@@ -195,22 +212,13 @@ printed to standard error.
 
 @item Root-Menu improvements [Christopher Bratusek]
 
-All menu-entries do now have accelerators and the labels for the
-sawfish-help menu-entries have been improved.
-
- item GNOME/KDE4 integration updates [Christopher Bratusek]
-
-All extra menu-entries for GNOME/KDE4 do now have accelerators. Entries
-for invoking @code{gnome-control-center} or @code{systemsettings} have been
-added. The way KDE4 is detected has been improved. Besides a new variable
- code{desktop-environment} has been introduced, which might be checked to
-determine which one (gnome, kde, xfce or none) is running.
+All menu-entries do now have accelerators. Labels for the sawfish-help
+menu-entries have been improved.
 
 @item Configurator invocation without running Sawfish [Teika Kazura]
 
 If you run the configurator but the Sawfish window manager is absent,
-then an alert window is displayed before abortion. The appearance is
-poor, though.
+then an alert window is displayed before abortion.
 
 @item Pointer warping in window cycling [Teika Kazura]
 
diff --git a/man/sawfish.1 b/man/sawfish.1
index f28915d..351f8f8 100644
--- a/man/sawfish.1
+++ b/man/sawfish.1
@@ -48,6 +48,9 @@ Overrides the default custom file \fI~/.sawfish/custom\fR.
 Overrides the default window history file \fI~/.sawfish/window-history\fR.
 .IP "\fB\-\-no-rc" 10
 Do not load the rc file.
+.SS Session Management Options
+.IP "\fB\-\-sm-client-id\fP \fBID\fP" 10
+.IP "\fB\-\-sm-prefix\fP \fBPREFIX\fP" 10
 .SS Debugging Option
 .IP "\fB\-\-sync" 10
 Read src/display.c. Don't use it unless you're sure.
diff --git a/man/sawfish.texi b/man/sawfish.texi
index c7ba16e..c1e25c3 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -6551,7 +6551,11 @@ the @code{PATH} environmental variable. Example:
 
 @defun quit
 @defunx restart
-Quits and restart Sawfish.
+Quits and restart Sawfish. 
+
+Restart does exec (3), replacing the current process. All command line
+arguments are used again, except that session management related ones
+are updated.
 @end defun
 
 @defun exit-type
@@ -6631,7 +6635,7 @@ Sawfish.  For example: @code{":0"}, or @code{"foo:0.0"}.
 
 @defvar saved-command-line-args
 Holds a list of all of the command line arguments (including the
-executable name).
+executable name), except options related to session mangement.
 @end defvar
 
 @defun call-with-error-handler thunk
@@ -6684,7 +6688,7 @@ Return @var{x} clamped between @var{lower} and @var{upper}.  If
 than @var{upper} return @var{upper}.  Otherwise return @var{x}.
 @end defun
 
- defun clamp* x y lower upper
+ defun clamp* x w lower upper
 Return the interval (@var{x}, @var{x}+ var{w}) clamped between
 @var{lower} and @var{upper}.  If @var{x} is less than @var{lower},
 return @var{lower}.  If @var{x}+ var{w} is larger than @var{upper},
@@ -7533,21 +7537,6 @@ and dimensions @code{(@var{width}, @var{height})} in @var{window}
 using the graphics context @var{gc}.
 @end defun
 
- defun x-draw-string window gc (x . y) string &optional font
-Draw the specified string at @code{(@var{x}, @var{y})} in @var{window}
-using the graphics context @var{gc}.  If @var{font} is specified use
-that font. If you need to write on the root-window directly, use
- code{x-draw-text}, if you need a message like @code{display-message}
-use this function instead.
- end defun
-
- defun x-draw-string window gc (x . y) string
-Draw the specified string at @code{(@var{x}, @var{y})} in @var{window}
-using the graphics context @var{gc}. If you need to write a message like
- code{display-message} use @code{x-draw-string}, if you need to write on
-the root-window directly, use this function instead.
- end defun
-
 @defun x-fill-arc window gc (x . y) (width . height) (angle1 . angle2)
 Draw a single filled circular or elliptical arc in @var{window} using
 the graphics context @var{gc}.  The center of the circle or ellipse is
@@ -7602,6 +7591,20 @@ Swap the fore and back buffers of the window associated with
 function quietly does nothing.
 @end defun
 
+Two functions to draw strings are there. If you need to write a
+message like @code{display-message} use @code{x-draw-string}. If you
+need to write on the root-window directly, use @code{x-draw-text}.
+
+ defun x-draw-string window gc (x . y) string &optional font
+Draw the specified string at @code{(@var{x}, @var{y})} in @var{window}
+using the graphics context @var{gc}.  If @var{font} is specified use
+that font. See also @code{x-draw-text}.
+ end defun
+
+ defun x-draw-text window gc (x . y) string
+Draw the specified string at @code{(@var{x}, @var{y})} in @var{window}
+using the graphics context @var{gc}. See also @code{x-draw-string}.
+ end defun
 
 @node Available X Symbols,  , X Drawing, Low-level X Interface
 @section Available X Symbols
diff --git a/src/functions.c b/src/functions.c
index 9c0817c..3f8646a 100644
--- a/src/functions.c
+++ b/src/functions.c
@@ -192,7 +192,14 @@ lower WINDOW to the bottom of the stacking order.
 }
 
 DEFUN("x-kill-client", Fx_kill_client, Sx_kill_client,
-      (repv win), rep_Subr1)
+      (repv win), rep_Subr1) /*
+::doc:sawfish.wm.windows.subrs#x-kill-client::
+x-kill-client WINDOW
+
+Kill the client that created WINDOW. 
+
+WINDOW may be a window object or a numeric window id.
+::end:: */
 {
     Window w = x_win_from_arg (win);
     if (w == 0)
@@ -205,7 +212,7 @@ DEFUN_INT("destroy-window", Fdestroy_window, Sdestroy_window, (repv win), rep_Su
 ::doc:sawfish.wm.windows.subrs#destroy-window::
 destroy-window WINDOW
 
-Destroy WINDOW with out giving the owning application any warning.
+Destroy WINDOW without giving the owning application any warning.
 
 WINDOW may be a window object or a numeric window id.
 ::end:: */
diff --git a/src/x.c b/src/x.c
index 3d82a1d..b11a642 100644
--- a/src/x.c
+++ b/src/x.c
@@ -1015,6 +1015,8 @@ x-draw-string WINDOW GC (X . Y) STRING [FONT]
 
 Draws the specified string at the specified location in the optional
 specified font in the window associated with WINDOW.
+
+Read info for comparison to x-draw-text.
 ::end:: */
 {
     Drawable id = drawable_from_arg (window);
@@ -1046,7 +1048,9 @@ DEFUN ("x-draw-text", Fx_draw_text, Sx_draw_text,
 x-draw-text WINDOW GC (X . Y) STRING
 
 Draws the specified string at the specified location in the window
-* associated with WINDOW.
+associated with WINDOW.
+
+Read info for comparison to x-draw-string.
 ::end:: */
 {
     Drawable id = drawable_from_arg (window);
diff --git a/themes/mxflat/README b/themes/mxflat/README
index 2d984d3..6c046fd 100644
--- a/themes/mxflat/README
+++ b/themes/mxflat/README
@@ -1,12 +1,13 @@
 mxflat (v0.7.4) sawfish theme
 
-the mxflat theme was made to match the gtk[1|2]-flat-engine.
-it is probably the most customizable sawfish theme out there
+The mxflat theme was made to match the gtk[1|2]-flat-engine.
+It is probably the most customizable sawfish theme out there
 but it also works very well if you do not adjust anything.
-remember: if there is something special to know about an option,
+
+Remember: if there is something special to know about an option,
 there is probably a tooltip helping you out.
 
-please send us your button icon sets if you've made any!
+Please send us your button icon sets if you've made any!
 
 ### upgrading  ###
 
@@ -21,15 +22,9 @@ all negative position values to positive ones in sawfish-config or the
 custom file. furthermore some config variable names have changes,
 so it might happen you have to readjust some options.
 
-### installation ###
-
-copy the 'mxflat' directory that you have extracted from the mxflat-*.tar.gz
-to you sawfish theme directory (~/.sawfish/themes or /usr/share/sawfish/themes).
-check the file-permissions, then start "sawfish-config" and
-choose "mxflat" as your default frame style.
+### Customization ###
 
-hint: it is recommended to use "sawfish-config" and 
-not the gnome control-center to configure this theme.
+Use the configurator. There're many options.
 
 ### copyright ###
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]