[sawfish] Doc, including news improvements.

[Christopher Bratusek <chrisb src gnome org>]

commit 49b4b4bb558d70bd9a98dc54835a23618d930a14
Author: Teika kazura <teika lavabit com>
Date:   Sat Aug 21 08:03:30 2010 +0900

    Doc, including news improvements.

 README.IMPORTANT            |   16 ----------
 lisp/sawfish/wm.jl          |    8 ++++-
 lisp/sawfish/wm/commands.jl |    2 +-
 lisp/sawfish/wm/frames.jl   |    2 +-
 man/news.texi               |   65 ++++++++++++++++++++++++------------------
 man/sawfish.texi            |   11 ++++--
 6 files changed, 53 insertions(+), 51 deletions(-)
---
diff --git a/README.IMPORTANT b/README.IMPORTANT
index 719cf15..39ac40f 100644
--- a/README.IMPORTANT
+++ b/README.IMPORTANT
@@ -3,20 +3,6 @@ lists only important changes.
 
 In Sawfish 1.6.0 there are the following major changes:
 
-9 mouse button support
-**********************
-
-Support for 6 - 9 mouse buttons is now optional. X.Org/XFree86 headers
-only define up to 5 buttons, and we use a working but somewhat hackish
-workaround for getting buttons 6 - 9 which is suspected to cause some
-problems with modifiers. Support for them is enabled by default. If
-you want to disable it, add the following flag to configure:
-
---without-nine-mousebuttons
-
-If you drop it, then you can't use mouse button 8 to, for example,
-drag windows.
-
 sawfish-ui is now sawfish-config
 ********************************
 
@@ -97,5 +83,3 @@ but: the old ui is -of course- still available, use:
 
 sawfish-config --flatten [in a terminal]
 (defvar-setq customize-program "sawfish-config --flatten") [in your config-file]
-
-- Christopher Bratusek <zanghar freenet de>
diff --git a/lisp/sawfish/wm.jl b/lisp/sawfish/wm.jl
index 81c2def..03fc9ad 100644
--- a/lisp/sawfish/wm.jl
+++ b/lisp/sawfish/wm.jl
@@ -152,10 +152,16 @@
 (let ((session-id     (get-command-line-option "--sm-client-id" t))
       (session-prefix (get-command-line-option "--sm-prefix" t)))
 
-  ;; now connect with the session manager; gsm requires that apps don't
+  ;; Now connect with the session manager; gsm requires that apps don't
   ;; connect until they're ready to handle the later priority levels
+
+  ;; NB: Even if you want to defer sm-init after sawfish.wm.user,
+  ;; initialization of related command line arguments has to be done
+  ;; here. Read also the comment below.
   (when (and (not batch-mode) (getenv "SESSION_MANAGER"))
     (sm-init session-id session-prefix)))
 
 ;; do user-level initialization
+;; This swallows all command line arguments, including those starting
+;; with "--".
 (load "sawfish/wm/user")
diff --git a/lisp/sawfish/wm/commands.jl b/lisp/sawfish/wm/commands.jl
index 7822825..0d28f01 100644
--- a/lisp/sawfish/wm/commands.jl
+++ b/lisp/sawfish/wm/commands.jl
@@ -239,7 +239,7 @@ command called NAME (optionally whose arguments have custom-type TYPE)."
 
 ;;; switching on spec codes
 
-  ;; codes local to sawfish
+  ;; codes local to sawfish, i.e. "%X" case, where X is one of:
   (define (local-codes code prompt)
     (case code
       ((#\f)
diff --git a/lisp/sawfish/wm/frames.jl b/lisp/sawfish/wm/frames.jl
index a19fc35..d7ac3b7 100644
--- a/lisp/sawfish/wm/frames.jl
+++ b/lisp/sawfish/wm/frames.jl
@@ -132,7 +132,7 @@ that overrides settings set elsewhere.")
     "Frame definition used for unframed windows.")
 
   (defcustom default-frame-style nil
-    "Default frame style:"
+    "Theme"
     :type frame-style
     :widget-flags (expand-vertically)
     :group appearance
diff --git a/man/news.texi b/man/news.texi
index 51df0e3..6169485 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -45,17 +45,18 @@ See the item ``Keyboard layout switching support'' below.
 
 @item Bug Fixes
 @itemize @minus
- item Maximized windows overlapping avoided windows bugfix
+ item Maximized windows wrongly covering other windows on startup [Jeremy Hankins]
 
-Sometimes maximized windows would overlap avoided windows (e.g., the
-gnome-panel, or a trayer) on restart.  Sawfish now waits until
-initialization is complete to maximize windows, preventing this problem.
+Sometimes maximized windows would overlap ``avoided'' windows (e.g.,
+the gnome-panel, or a trayer) on startup. Sawfish now waits until
+initialization is complete to maximize windows, preventing this
+problem.
 
- item Viewport initialization bugfix
+ item Viewport initialization bugfix [Jeremy Hankins]
 
-Under certain circumstances windows could end up outside of the
-accessible viewport space when sawfish was restarted.  This has been
-fixed.
+Under certain circumstances viewport slots were wrongly shifted when
+sawfish was restarted, ending up with some windows outside of the
+virtual desktop. This has been fixed.
 
 @item Keyboard-layout switching support [Teika Kazura]
 
@@ -76,26 +77,32 @@ the current code for buttons 6 - 8 is hackish.
 Function @code{x-atom-name} now accepts all 32 bits. Previously only
 30 bits were treated, if the architecture was 32-bit.
 
- item The following two variables are no longer declared obsolete:@*
- code{workspace-boundary-mode} and @code{workspace-send-boundary-mode}.
+It used to cause ``Bad argument'' error, most notably on Java
+applications.
 
- item Apps-Menu bugfix [Matthew Love]
+ item De-obsoletion of two variables [Teika Kazura]
 
-correctly alphabetize menu-entries, previously they were sorted [A-Z][a-z]
-(first all upper- then all loser-case entries). Now it's done properly [aA-zZ].
+User options @code{workspace-boundary-mode} and
+ code{workspace-send-boundary-mode} couldn't be set from the
+configurator, but this is fixed.
 
- item Edge-Flip now still works after resolution-change. [Christopher Bratusek]
+ item Applications menu bugfix [Matthew Love]
+
+Correct alphabetic ordering of menu-entries is done. Previously they
+were sorted [A-Z][a-z] (first all upper- then all loser-case entries).
+
+ item Edge-flip now still works after resolution-change. [Christopher Bratusek]
 
 @item Sawfish now starts up correctly when receiving a session-id or
 session-prefix from GNOME-Session [Christopher Bratusek]
 
- item Draft Animator bugfix. [Christopher Bratusek]
+ item Draft animator bugfix. [Christopher Bratusek]
 
-The draft animator had two issues, on one hand the numbers drawn by it
-where 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.
+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.
 @end itemize
 
 @item New Features
@@ -421,11 +428,12 @@ viewport when displaying all workspaces.
 @item Removed requirements: LibAudioFile and ESounD
 @item Mouse buttons 6 - 9 support is now optional
 
-Support for 6 - 9 mouse buttons is now optional. X.Org/XFree86 headers
-only define up to 5 buttons, and we use a working but somewhat hackish
-workaround for getting buttons 6 - 9 which is suspected to cause some
-problems with modifiers. Support for them is enabled by default. If
-you want to disable it, add the following flag to configure:
+(This item is no longer valid from 1.7.0.)  Support for 6 - 9 mouse
+buttons is now optional. X.Org/XFree86 headers only define up to 5
+buttons, and we use a working but somewhat hackish workaround for
+getting buttons 6 - 9 which is suspected to cause some problems with
+modifiers. Support for them is enabled by default. If you want to
+disable it, add the following flag to configure:
 
 @code{--without-nine-mousebuttons}
 @c Well, ``code'' gives ugly (back)quote, but otherwise the first hyphen is dropped.
@@ -750,9 +758,10 @@ buttons or frames to their theme in charge. There are no user visible changes.
 
 @item Startup window placement improvement [Jeremy Hankins]
 
-At Sawfish startup including restart, maximized windows and
-position specified windows used to mess up viewport, appearing
-in wrong viewports. It's fixed now.
+(Later this item was found wrong. The true fix was done in 1.7.0.)  At
+Sawfish startup including restart, maximized windows and position
+specified windows used to mess up viewport, appearing in wrong
+viewports. It's fixed now.
 
 @item Renamed @code{after-add-window} to @code{maxmize-after-add-window} @*
 This function is only used in a hook [Teika Kazura]
diff --git a/man/sawfish.texi b/man/sawfish.texi
index d1ec54c..43b6405 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -4733,7 +4733,9 @@ otherwise.
 
 Sawfish provides an intuitive way, like flipping pages, to switch the
 workspace (or the viewport) by moving the mouse to the edge of the
-screen. This is called ``edge flipping''.
+screen. This is called ``edge flipping''. To use it, add
+ code{(require 'sawfish.wm.ext.edge-flip)} in your
+ file{~/.sawfish/rc} file, and use the configurator.
 
 @defvr Customizable edge-flip-enabled nil
 When true, select the next desktop when the pointer hits screen edge.
@@ -5520,9 +5522,10 @@ ancestor chain until it is handled.
 @chapter Commands
 @cindex Commands
 
-A @dfn{command} is a Sawfish lisp notion which can be called from key
-or mouse input. Unlike emacs, a command is not always a Lisp
-function. See following setions for more.
+ dfn{Command} is a Sawfish lisp notion. A command is what can be
+called from key or mouse input. Unlike emacs, a command is not always
+in one-to-one correspondence to a Lisp function. See following
+sections for more.
 
 @menu
 * Old-style Command Definition::  Emacs-Lisp style