[sawfish] man/sawfish.texi: Improvements.



commit 50ffe92ed385042fc9017d992577afd1e66d0d12
Author: chrisb <zanghar freenet de>
Date:   Mon Aug 31 17:25:48 2009 +0200

    man/sawfish.texi: Improvements.

 ChangeLog        |    5 +++
 man/news.texi    |    2 +-
 man/sawfish.texi |   72 +++++++++++++++++++++++++++++------------------------
 3 files changed, 45 insertions(+), 34 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 2e0cbb3..405728a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,6 +7,11 @@
 
 	* man/news.texi: Minor fixes in 1.5.0 section [Teika Kazura]
 
+	* man/sawfish.texi: Better description on font type.
+	                    Description on window snapping and cycle-among-groups[-backwards].
+			    Usage on environmental variables.
+			    -- [Teika Kazura]
+
 2009-08-30  Christopher Bratusek <zanghar freenet de>
 	* lisp/sawfish/gtk/widget.jl: Number widget can take optional initial value [Teika Kazura]
 
diff --git a/man/news.texi b/man/news.texi
index f77fe25..9bd9aac 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -126,7 +126,7 @@ they occurred between. For more detailed information see the
 
 @item Grow/Pack and Shrink/Yank options are in the same group now [Christopher Bratusek]
 
- item Doc updates [Christopher Bratusek, Jeremy Hankins]
+ item Doc updates [Christopher Bratusek, Jeremy Hankins, Teika Kazura]
 @end itemize
 @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
-string).
+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
-windows.
+ 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



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