[patch] Doc patches

Hi. Let me submit doc patches.

* utf8.patch.bz2:
CONTRIBUTING: Encoding is changed to utf-8 from latin-1
(This is bzip-ed to prevent my mailer from assuming weird encoding.)

* news.patch:
man/news.texi: Minor fixes.

* man.patch
man/sawfish.texi: Improvements.
  Better description on font type. Description on window snapping, and
cycle-among-groups[-backwards]. Usage on environmental variables.

* keys.patch
src/keys.h: Small comment added.

Other patches contain git logs.

And I've got a question. Look at this:
diff --git a/lisp/sawfish/wm/commands/move-resize.jl b/lisp/sawfish/wm/commands/move-resize.jl
index b1af5cc..e25c95a 100644
--- a/lisp/sawfish/wm/commands/move-resize.jl
+++ b/lisp/sawfish/wm/commands/move-resize.jl
@@ -542,11 +542,11 @@
 ;;; Entry points
   (define (move-window-interactively w)
-    "Move the window interactively using the mouse."
+    "Move the window interactively, with mouse or keyboard."
     (do-move-resize w 'move))
   (define (resize-window-interactively w)
-    "Resize the window interactively using the mouse."
+    "Resize the window interactively, with mouse or keyboard."
     (do-move-resize w 'resize))
   (define (move-selected-window)
Docstring change should accompany po files patches, right? But is
it possible to let translators note it? 

Anyway, it won't hurt, so I'll prepare po patches. (I'm not good at
sed, but it's possible ;-)

Thanks a lot,
Teika (Teika kazura)

Attachment: utf.patch.bz2
Description: Binary data

commit 5d804abc3eb76e5ac2fda335fe9c645becd74260
Author: Teika kazura <teika lavabit com>
Date:   Tue Jul 21 17:56:23 2009 +0900

    Renamed hooked function `after-add-window' -> `maximize-after-add-window'.
    This makes self-descriptive, so that when you evaluate `after-add-window-hook', you see what's hooked in.

diff --git a/lisp/sawfish/wm/state/maximize.jl b/lisp/sawfish/wm/state/maximize.jl
index 437376c..d7511c5 100644
--- a/lisp/sawfish/wm/state/maximize.jl
+++ b/lisp/sawfish/wm/state/maximize.jl
@@ -552,7 +552,7 @@ unmaximized."
 ;;; initialisation
   ;; Hook to maximize, following matcher's order.
-  (define (after-add-window w)
+  (define (maximize-after-add-window w)
     (let ((vert (window-get w 'queued-vertical-maximize))
 	  (horiz (window-get w 'queued-horizontal-maximize))
 	  (full (window-get w 'queued-fullscreen-maximize)))
@@ -569,7 +569,7 @@ unmaximized."
 				   (vert 'vertical)
 				   (horiz 'horizontal)))))))
-  (add-hook 'after-add-window-hook after-add-window)
+  (add-hook 'after-add-window-hook maximize-after-add-window)
   ;; before exiting, return all windows to their unmaximized
   ;; geometries. But _don't_ change any of the properties (either
diff --git a/man/news.texi b/man/news.texi
index f3ced8a..1603b9b 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -132,6 +132,8 @@ they occurred between. For more detailed information see the
 @heading 1.5.0
+The new release is Sawfish-1.5.0. We don't release 1.4 series for historical reason.
 @itemize @bullet
 @item The 1.5.0 release has new features and bugfixes
@@ -189,9 +191,9 @@ To use the old style, put @code{(define-special-variable customize-program "sawf
 @item Fixup the last incomplete AC_DEFINE [Christopher Bratusek]
- item Fixed a speed-issue with microGUI [Christopher Bratusek]
+ item Fixed a speed-issue with ``microGUI'' theme [Christopher Bratusek]
- item Make properly use of WM_NAME in Elberg-tabbed [Christopher Bratusek]
+ item Make properly use of WM_NAME in ``Elberg-tabbed'' theme [Christopher Bratusek]
 @end itemize
 @item New features:
@@ -203,15 +205,15 @@ To use the old style, put @code{(define-special-variable customize-program "sawf
 @item Tabbed Windowing Support [Yann Hodique, Scott Scriven, Nathan Froyd, Christopher Bratusek]
+ item Tabbed Windowing Support: Raise Tabs on hover [Christopher Bratusek]
 @item Improved KDE3 Integration [Timo Korvola]
 @item Replaced hardcoded focus logic by focus-revert function [Timo Korvola]
- item Tabbed Windowing Support: Raise Tabs on hover [Christopher Bratusek]
 @item Warp cursor to cycled windows, if warp-cursor is enabled [Christopher Bratusek]
- item Warp cursor to unmaximied windows, if warp-cursor is enabled [Fernando Carmona Varo]
+ item Warp cursor to unmaximized windows, if warp-cursor is enabled [Fernando Carmona Varo]
 @item 3 New Window-Animators: cross, elliptical and draft [Christopher Bratusek, Teika Kazura[draft fixups]]
@@ -227,7 +229,7 @@ To use the old style, put @code{(define-special-variable customize-program "sawf
 @item Interactive placement-mode now also for transients [Christopher Bratusek]
- item Improved prompt.jl (allows changing font, fg and bg color) [Sergey I. Sharybi]
+ item Improved prompt.jl (allows changing font, fg and bg color) [Sergey I. Sharybin]
 @item Expose fixed-position, never-iconify, never-maximize in the Window-Matcher UI [Christopher Bratusek]
 @end itemize
diff --git a/man/sawfish.texi b/man/sawfish.texi
index bb7bcf6..b9c1b70 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -232,33 +232,32 @@ The color used for text where no other color is defined.
 @chapter Fonts
 @cindex Fonts
-As with the color type, the font type allows X11 fonts to be
-manipulated by Lisp code.
+Lisp font object allows manipulation of correspondig X11 fonts.
 @defun fontp arg
 Returns @code{t} if @var{arg} is a font object.
 @end defun
-Sawfish supports two types of fonts: X11 core fonts (fontsets and
-fontstructs) and Xft fonts.  Calling code must look up fonts by
-giving both a name and a type: an @code{xlfd} argument indicates the
-core fonts, and @code{Xft} indicates Xft fonts.  These types are
-always literal strings.
+Sawfish supports three ``types'' of fonts: X11 old core fonts (fontsets
+and fontstructs), Xft fonts, and if supported, Pango fonts. In lisp,
+type is represented by a string, @code{"xlfd"}, @code{"Xft"}, or
+ code{"Pango"}.
 @defun font-type-exists-p type
-Returns true if fonts with the type described by the string @var{type}
-can be loaded, false otherwise.
+Returns true if fonts of @var{type} are available, false otherwise.
 @end defun
 @defun get-font-typed type name
-Return a font object representing the X11 font specified by the string
- var{name}   Argument @var{type} indicates the type of font to look
-for; it must be one of the strings @code{xlfd} for a X11 core fonts
-(based on fontsets or a fontstructs), or @code{Xft} for an Xft font.
+Returns a font object which represents an X11 font. It's specified by
+the string @var{name}, and string @var{type}. Signals an error if the
+specified font is not available.
-Signals an error if @var{type} is not one of the literal strings
-listed above.  Also signals an error if no font named @var{name}
-can be found within the requested type.
+``Safe'' examples are:
+ lisp
+(get-font-typed "xlfd" "fixed")
+(get-font-typed "Xft" "Sans")
+(get-font-typed "Pango" "Sans")
+ end lisp
 @end defun
 @defun get-font name
@@ -273,13 +272,13 @@ Several functions allow the attributes associated with a font object to
 be found.
 @defun font-name font
-Returns the name of the X11 font represented by object @var{font} (a
+Returns the name, in string, of the X11 font represented by object
+ var{font} 
 @end defun
 @defun font-type font
-Returns a string indicating the font's class.  This is @code{xlfd}
-for X11 core fonts, or @code{Xft} for Xft fonts.
+Returns the font's type. It is one of @code{"xlfd"}, @code{"Xft"}, and
+ code{"Pango"}.
 @end defun
 @defun font-height font
@@ -1204,7 +1203,6 @@ responsible for checking whether an entered window wants input events.
 The desktop never receives @code{pointer-in} or @code{pointer-out};
 only normal windows do.
- item
 @item enter-root
 @itemx leave-root
 The pointer has entered or exited the desktop (which is the
@@ -1783,13 +1781,14 @@ screen.
 When non-nil, the window size is shown in the center of the screen.
 @end defvar
- defvar move-snap-edges
-When non-nil, the window position is ``snapped'' to edges of other
-windows within close proximity.
- end defvar
+When you move a window and it comes close to another, sawfish adjusts
+its position so that its edge fits to the other, or ``snaps''. (It may
+be dubbed as ``interactive tiling''.) Snapping also takes place agaisnt
+screen boundary.
 @defvar move-snap-epsilon
-The distance in pixels before snapping together two edges.
+The distance in pixels before snapping together two edges. The bigger
+the value, the more adhesive windows get.
 @end defvar
 Windows have a ``gravity'' property, which affect how they are placed
@@ -2520,10 +2519,13 @@ Cycle through all cycleable windows.
 @defun cycle-group
 @defunx cycle-group-backwards
-Cycle through all windows in this group.
+Cycle through all windows inside the same group. This is somewhat
+comparable to the @key{Control-TAB} behavior of Windows OS.
+ end defun
-This is somewhat comparable to the @key{Control-TAB} behavior of
+ defun cycle-among-groups
+ defunx cycle-among-groups-backwards
+Cycle through windows at the top of each group.
 @end defun
 @defun cycle-prefix
@@ -5824,17 +5826,20 @@ executable name).
 @defvar sawfish-directory
 The home directory for Sawfish files.  For example:
- code{"/usr/share/sawfish"}.
+ code{"/usr/share/sawfish"}. You can override it with the environment
+variable @code{SAWFISHDIR}.
 @end defvar
 @defvar sawfish-exec-directory
 The directory for architechture-specific Sawfish executables.  For
-example: @code{"/usr/lib/sawfish/1.3/i386-pc-linux-gnu"}.
+example: @code{"/usr/lib/sawfish/1.3/i386-pc-linux-gnu"}. You can
+override it with the environment variable @code{SAWFISHEXECDIR}.
 @end defvar
 @defvar sawfish-lisp-lib-directory
 The top-level directory for Sawfish lisp files.  For example:
- code{"/usr/share/sawfish/1.3/lisp"}.
+ code{"/usr/share/sawfish/1.3/lisp"}. You can override it with the
+environment variable @code{SAWFISHLISPDIR}.
 @end defvar
 @defvar sawfish-locale-directory
@@ -5845,7 +5850,8 @@ part of the Sawfish distribution.  For example:
 @defvar sawfish-site-lisp-directory
 The top-level directory for site-specific Sawfish lisp files.  For
-example: @code{"/usr/share/sawfish/site-lisp"}.
+example: @code{"/usr/share/sawfish/site-lisp"}. You can override it
+with the environment variable @code{SAWFISHSITELISPDIR}.
 @end defvar
 @defvar sawfish-version
diff --git a/src/keys.h b/src/keys.h
index 6d4f401..c6b0395 100644
--- a/src/keys.h
+++ b/src/keys.h
@@ -60,7 +60,7 @@ enum {
        all predefined wm key bindings to a different modifier */
     EV_MOD_WM     = 0x04000000,
-    /* Matches any of the modifiers */
+    /* Matches any of the modifiers, including no modifier */
     EV_MOD_ANY    = 0x00400000,
     /* a KeyRelease event */

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