GNOME.org
 

[sawfish: 4/6] News & doc.

commit 5fafc9680ede203311468e976491394c9589dd7e
Author: Teika kazura <teika lavabit com>
Date:   Sat Sep 25 14:13:37 2010 +0900

    News & doc.
    
    * Deleted unnecessary items
      - Export of non-existent symbol is not illegal in librep.
      - Most of items in "Removed features" do not involve users much, so
        merged elsewhere and made concise.
      - Deleted item `infinite desktop'.
        The code had been designed wrongly before the commit 0b2f5 on 21 Sep.
        It can't be disabled from wm.ext.infinite-desktop, and automatically
        enabled when the module is loaded.
        So the commit is not wrong, but not so much meaningful at this point
        yet. It is better to delete this news item which only contains
        barely useful information.
    * Many rewritements.
    * Updates in `sawfish-config.1'.

 man/news.texi        |  237 +++++++++++++++++++++-----------------------------
 man/sawfish-config.1 |   18 +---
 2 files changed, 103 insertions(+), 152 deletions(-)
---
diff --git a/man/news.texi b/man/news.texi
index 0474b85..7fb9f1c 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -30,7 +30,7 @@ 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
+If you have a 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.
 
@@ -63,8 +63,8 @@ See the item ``Keyboard layout switching support'' below.
 @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 startup. Sawfish now waits until
-initialization is complete to maximize windows, preventing this
+the gnome-panel, or a trayer) on startup. Sawfish now defers
+maximization until the initialization is complete, preventing this
 problem.
 
 @item Viewport initialization bugfix [Jeremy Hankins]
@@ -81,17 +81,23 @@ and mouse-bindings got messed-up.
 
 Now, this can be prevented by passing a new commandline-option
 @code{--5-buttons} at Sawfish invocation. It is assumed that modifiers
-are common among keyboard groups.
+are common among keyboard groups. 
 
-By doing so, you won't be able to bind Sawfish commands to mouse
-buttons 6 - 8. This may be fixed in future, but not now because
-the current code for buttons 6 - 8 is hackish.
+More precisely, what's supported is switching by @code{ISO_Next_Group}
+or so, bound to some key, for example ctrl + alt. It appears as
+``option'' in X keyboard configuration, like
+``grp:ctrl_alt_toggle''. If you use some utility to switch the layout
+and it confuses Sawfish key bindings, please restart Sawfish.
+
+With that commandline option, you won't be able to bind Sawfish
+commands to mouse buttons 6 - 8. This may be fixed in future, but not
+now.
 
 @item Atom handling fix on 32-bit architecture (Java fix). [Teika Kazura]
 
 Function @code{x-atom-name} now accepts all 32 bits. Previously only
-30 bits were treated, if the architecture was 32-bit. 64-bit systems
-had not this bug.
+30 bits were treated if the architecture was 32-bit. 64-bit systems
+hasn't had this bug.
 
 It used to cause ``Bad argument'' error, most notably on Java
 applications. (In theory, an atom is set by X server, not a client.
@@ -112,12 +118,11 @@ session-prefix from GNOME-Session [Clinton Ebadi, Christopher Bratusek]
 
 @item Draft animator bugfix. [Christopher Bratusek]
 
-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
-have been fixed by introducing the @code{x-draw-text} function, which
-is described below.
+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. Both have been
+fixed. Internally, it's by the new @code{x-draw-text} function
+described below.
 
 @item Resurrection of two variables [Teika Kazura]
 
@@ -125,11 +130,6 @@ User options @code{workspace-boundary-mode} and
 @code{workspace-send-boundary-mode} couldn't be set from the
 configurator, but this is fixed.
 
- item Removed wrong export [Christopher Bratusek]
-
-The function @code{make-url-widget}, which has been removed in
-version 1.6.0 was still exported by it's former modules, it's fixed.
-
 @item Command @code{xterm} fix [Teika kazura] *
 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
@@ -148,42 +148,48 @@ the Sawfish 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.
+improved. See also the item ``Applications menu improvements'' below.
 
 A new variable @code{desktop-environment} tells which desktop
 environment is running (@pxref{External Applications}).
 
- item Apps-Menu improvements [Matthew Love]
+ item Applications menu improvements [Matthew Love]
 
-The applications menu now honors the OnlyShowIn and NotShowIn
-fields.
+Applications menu now looks more like that of GNOME / KDE / Xfce if
+one is running. (In fact, more improvements are planned. Sorry for
+shipping intermediate one.)
 
-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:
+The user option @code{apps-menu-ignore-no-display} is now gone.
+Instead, use a new variable @code{apps-menu-show-all}.
 
-if @code{apps-menu-show-all} is set to 'nil, then: fields @code{Hidden},
- code{NoDisplay}, @code{NotShowIn} and	@code{OnlyShowIn} are respected
-(a menu much like GNOMEs/KDEs is then generated by Sawfish).
+If @code{apps-menu-show-all} is @code{nil} (the default), the menu
+looks much like that of GNOME / KDE / Xfce, by hiding some
+applications. If it's @code{t}, then all installed applications are
+shown. An intermediate option, the symbol @code{maybe} is possible, as
+described below.
 
-if @code{apps-menu-show-all} is set to 'maybe, then: fields @code{Hidden}
-and @code{NoDisplay} are ignored, but fields @code{OnlyShowIn} and
- code{NotShowIn} are respected.
+Technically, fields @code{NotShowIn} and @code{OnlyShowIn} in files
+ file{/usr/share/applications/*.desktop} tell under which
+desktop environment that application wants to be shown. If
+ code{apps-menu-show-all} is @code{nil} or @code{maybe}, they are
+respected.
 
-if @code{apps-menu-show-all} is set to 't, then: fields @code{Hidden},
- code{NoDisplay}, @code{NotShowIn} and @code{OnlyShowIn} are ignored
-(Sawfish lists all existing menu-entries)
+Items with field @code{Hidden} or @code{NoDisplay} are usually not to
+be shown. They are respected if @code{apps-menu-show-all} is @code{nil}.
 
- item New window-matchers [Christopher Bratusek]
+The KDE specific directory is now searched, too for the menu generation.
+
+ item New window rules [Christopher Bratusek]
 
 @itemize
- item @code{fixed-size}: this window-matcher prevents the window from being
-resized by the @code{resize-window-interactively}, @code{halve-window-size}
-and @code{double-window-size} functions, maximize-* functions, still do. See
- code{never-maximize} window-matcher to prevent this, too.
+ item @code{fixed-size}: this disables resizing, or more precisely,
+functions @code{resize-window-interactively}, @code{halve-window-size}
+and @code{double-window-size}. (Maximization is still possible.  Use
+ code{never-maximize} to prevent maximization.)
 
- item @code{never-close}: this window-matcher prevents the windows brom being
-closed when calling the deletion-function interactively.
+ item @code{never-close}: this disables closing. Only interactive
+closing is prevented, and you can delete windows with
+ code{never-close} property from a lisp program.
 @end itemize
 
 @item Update of emacs major mode @file{sawfish.el} [Teika kazura]
@@ -211,64 +217,19 @@ See the item ``Keyboard-layout switching support'' above.
 @item @code{x-draw-text} function [Christopher Bratusek]
 
 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}
+ code{display-message} like message, call @code{x-draw-string}.
+If you want to draw on the screen directly use @code{x-draw-text}
 (@pxref{X Drawing}.)
 @end itemize
 
- item Removed Features
-
- itemize @minus
- item @code{old-window-menu} [Christopher Bratusek]
-
-The @code{old-window-menu} was replaced by @code{beos-window-menu}
-a long time ago in version 0.28.1. Now it is removed. If you still
-want to use it, download it from the wiki.
-
- item Capplets code [Christopher Bratusek]
-
-The capplets where used in very early GNOME 2.x to setup application-
-properties via GNOME-Control-Center. The capplets aren't used for years
-and already removed from Sawfish since version 1.5.0. Non-removed capplet
-fragments from SawfishConfig are removed now. Therefore the command-line
-option @code{--socket-id} for SawfishConfig is no longer available.
-
- item SawfishConfig Single-Level [Christopher Bratusek]
-
-The command-line option @code{--single-level} for SawfishConfig was broken,
-and therefore removed.
-
- item @code{3d-hack} [Christopher Bratusek]
-
-The @code{3d-hack} module provides two functions similar to @code{glxgears},
-rendered in 2d. Practically it's of no use, therefore it's gone now.
-If you still want to use it, download it from the wiki.
-
- item @code{test-widget} function [Christopher Bratusek]
-
-The @code{test-widget} function is heavily broken and crashes Sawfish
-very easily, using it for debugging is therefore impossible. So it is
-removed now.
-
- item @code{about-dialog} function [Christopher Bratusek]
-
-The custom @code{about-dialog} function has been replaced by
-gtk-about-dialog in version 1.6.0. Now the function is removed.
-
- item @code{stock-button} function [Christopher Bratusek]
-
-The @code{stock-button} function has been replaced by directly
-using gtk-button-new-from-stock.
- end itemize
-
- item Updated translations
- itemize @minus
- item British English (en_GB)
+ item Translation updates 
 
- item Spanish (es)
+Updated translations since 1.6.0 are Danish (da), British English
+(en_GB), German (de), Spanish (es), Slovenian (sl), and Swedish (sv).
 
- item Slovenian (sl)
- end itemize
+All translation files are now in UTF-8. Changed languages are Galician
+(gl), Italian (it), Romanian (ro), and Turkish (tr). The rest were
+alread UTF-8. [Teika Kazura]
 
 @item Miscellaneous Changes
 @itemize @minus
@@ -278,79 +239,77 @@ 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
-output. (In contrast, a client which connects synchronously receives
-the error message.) Practically, this means sawfish-pager's errors are
-printed to Sawfish's output.
-
 Phrase ``Sawfish error:'' is prepended to error messages which are
 printed to standard error.
 
+Sawfish-pager's errors are printed to Sawfish's output. More
+precisely, when you connected to Sawfish as a server asynchronously,
+then the error was not printed. But now it is printed, to Sawfish's
+output. (In contrast, a client which connects synchronously receives
+the error message.)
+
 @item Pointer warping in window cycling [Teika Kazura]
 
 In window cycling, some unnecessary pointer warping is avoided.
 Previously, the necessity of a warp was judged by the geometry before
 the raise was done. Now the updated one is used.
 
- item @code{sawfish.cfg.utils} module [Christopher Bratusek]
-
-Previously the functions @code{remove-newlines} and
- code{beautify-symbol-name} were defined in several modules. No
-there are only defined once in @code{sawfish.cfg.utils}
+ item Configurator changes (user visible parts) [Christopher Bratusek]
 
- item small Infinite-Desktop improvements [Christopoher Bratusek]
+Icon is now provided. (If it doesn't show up, first run @code{gtk-update-icon-cache}.)
 
- code{infinite-desktop} now exports @code{infinite-desktop-enable} function,
-so it can be enabled via sawfishrc, too. Besides the names of it's functions
-have been improved.
+If you run the configurator but the Sawfish window manager is not
+running, then an alert window is displayed before abortion. [Teika
+Kazura, Christopher Bratusek]
 
- item Small UI-changes in SawfishConfig [Christopher Bratusek]
-
- itemize @minus
- item set window-icon to @code{sawfish-config} (and added an icon);
-if the icon does not show up, then run @code{gtk-update-icon-cache
-/usr/share/icons/hicolor/} first, it will then work.
-
- item set the root-containers shadow-type to etched-in
-
- item use nicer stock-buttons with icons instead of plain buttons
-
- item change the boolean buttons in @code{Window Rules} to display
-Enable rather than Yes and No. This improves the thing a bit. A
-real solution (read: revised UI) will come with Sawfish 3.0.0.
- end itemize
+Two obsolete features are deleted. One is the command line option
+ code{--socket-id}, which was for ``capplets'', part of very early
+GNOME 2.x. The other is the command line option @code{--single-level}
+which has been broken.
 
 @item Doc improvements
 
 FAQ items, on how to hide the mouse-pointer, and on application execution  *
 Manuals (1) describe all options.
 
-Described functions @code{grab-keymap} and @code{ungrab-keymap}
+Newly described functions are: @code{grab-keymap} and @code{ungrab-keymap}
 (@pxref{Keymaps}), @code{x-raise-window} and @code{x-lower-window}
 (@pxref{Raising and Lowering Windows}), @code{frame-state-mutex}
 (@pxref{Frame Functions}).
 
 @item Root-Menu improvements [Christopher Bratusek]
 
-All menu-entries do now have accelerators. Labels for the sawfish-help
-menu-entries have been improved.
+All menu-entries do now have accelerators. Labels for the help have
+been improved.
+
+ c sawfish.gtk can be thought as configurator internals.
+ item Configurator internals [Christopher Bratusek]
 
- item Configurator invocation without running Sawfish [Teika Kazura]
+The module @code{widget-test} is deleted. It provided testing function
+of widgets in modules @code{sawfish.gtk.*}. But allegedly it is broken
+and crashed Sawfish.
 
-If you run the configurator but the Sawfish window manager is absent,
-then an alert window is displayed before abortion.
+ code{widget-dialog jl} was merged into @code{simple-dialog.jl}
+
+Previously the functions @code{remove-newlines} and
+ code{beautify-symbol-name} were defined in several modules, with the
+same contents. Now they are defined (only once) in a new module
+ code{sawfish cfg utils} 
 
- item Module @code{3d-hack} is not autoloaded anymore. [Teika Kazura]
+The @code{stock-button} function was defined in Sawfish, but now it's
+replaced by the gtk's stock button. Same for the @code{about-dialog}
+function, replaced by @code{gtk-about-dialog}.
 
- item widget-dialog.jl was merged into simple-dialog.jl [Christopher Bratusek]
+ file{/usr/bin/sawfish-config} is now minimal, moving most of the
+contents to @code{sawfish.cfg.shell} [Teika Kazura]
 
- item @code{sawfish-config} is now minimal, moving most of the contents to @code{sawfish.cfg.shell} [Teika Kazura]
+ item Module @code{3d-hack} is deleted. [Christopher Bratusek]
 
- item All translation files are now in UTF-8 [Teika Kazura]
+The @code{3d-hack} module was an animation demo, not a feature. It
+provided two functions similar to @code{glxgears}, rendered in 2d.
+If you want it, it can be downloaded from the Sawfish Wiki, from the
+page ``3d-hack''.
 
-Almost all were already UTF-8. The rest, Galician, Italian, Romanian,
-and Turkish are changed this time.
 @end itemize
 @end itemize
 
diff --git a/man/sawfish-config.1 b/man/sawfish-config.1
index b528107..51889f9 100644
--- a/man/sawfish-config.1
+++ b/man/sawfish-config.1
@@ -3,12 +3,11 @@
 sawfish-config \(em The Sawfish Configurator.
 .SH "SYNOPSIS"
 .PP
-\fBsawfish-config\fR [\fB \-\-group=\fIGROUP-NAME \fR\fP]  [\fB \-\-flatten \fP]  [\fB \-\-single-level \fP]  [\fB \-\-socket-id=\fIWINDOW-ID \fR\fP]
+\fBsawfish-config\fR [\fB \-\-group=\fIGROUP-NAME \fR\fP]  [\fB \-\-flatten \fP]
 .SH "DESCRIPTION"
 .PP
-This program can be used to invoke the Sawfish configurator manually;
-if GNOME is used, then the GNOME Control Center can also be used
-to customize certain classes.
+This program can be used to manually invoke the Sawfish configurator, but
+usually it's called from the window manager itself.
 .SH "OPTIONS"
 .IP "\fB\-\-group=\fIGROUP-NAME\fP 	" 10
 Display only \fIGROUP-NAME\fR.
@@ -17,15 +16,8 @@ Display only \fIGROUP-NAME\fR.
 Bindings, Focus, Minimizing/Maximizing, Miscellaneous, Move/Resize,
 Sounds, Window Rules, Workspaces
 .IP "\fB\-\-flatten\fP" 10
-display sub-groups inline instead of using a tree widget
-(good for control center). In normal `tree' item, don't put frame
-the widgets
-.IP "\fB\-\-single-level\fP" 10
-Don't display the tree widget. This option allows the configurator to
-be embedded in the gnome control center. This also disables the
-ok/cancel/etc buttons and enables a hacky protocol on stdin/stdout.
-.IP "\fB\-\-socket-id\fP=\fIsocket-ID\fP 	" 10
-Specifies the socket ID it connects to.
+display sub-groups inline instead of using a tree widget. In normal
+`tree' item, don't put frame the widgets
 .IP "\fB\-\-disable-nls\fP" 10
 Disable internationalization of messages.
 .IP "\fB\-\-help\fP" 10
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]