GNOME.org
 

[sawfish] Minor doc. News improvements. Minor typo fix.

commit 0bc4289b4a3b5f84be700dbce43fab2028398540
Author: Teika kazura <teika lavabit com>
Date:   Tue Apr 6 14:09:03 2010 +0900

    Minor doc. News improvements. Minor typo fix.

 lisp/sawfish/wm/autoload.jl   |    2 +-
 lisp/sawfish/wm/commands.jl   |    6 +++-
 lisp/sawfish/wm/util/gtkrc.jl |    3 +-
 man/news.texi                 |   51 +++++++++++++++++++--------------------
 man/sawfish.texi              |   53 ++++++++++++++++++++++++----------------
 5 files changed, 64 insertions(+), 51 deletions(-)
---
diff --git a/lisp/sawfish/wm/autoload.jl b/lisp/sawfish/wm/autoload.jl
index 4923eea..216d3ba 100644
--- a/lisp/sawfish/wm/autoload.jl
+++ b/lisp/sawfish/wm/autoload.jl
@@ -101,7 +101,7 @@
 (autoload-command 'move-cursor-southwest-fine 'sawfish.wm.commands.move-cursor)
 (autoload-command 'move-cursor-southeast-fine 'sawfish.wm.commands.move-cursor)
 (autoload-command 'move-cursor-center 'sawfish.wm.commands.move-cursor)
-(autoload-command 'move-window-center 'sawfish.wm.comands.move-resize)
+(autoload-command 'move-window-center 'sawfish.wm.commands.move-resize)
 (autoload-command 'move-window-interactively 'sawfish.wm.commands.move-resize)
 (autoload-command 'resize-window-interactively 'sawfish.wm.commands.move-resize)
 (autoload-command 'move-selected-window 'sawfish.wm.commands.move-resize)
diff --git a/lisp/sawfish/wm/commands.jl b/lisp/sawfish/wm/commands.jl
index db4e420..09ac4ca 100644
--- a/lisp/sawfish/wm/commands.jl
+++ b/lisp/sawfish/wm/commands.jl
@@ -363,12 +363,14 @@ command called NAME (optionally whose arguments have custom-type TYPE)."
 ;;; some default commands
 
   (define (run-shell-command command)
-    "Execute the given shell command."
+    "Execute a shell command. This is a wrapper command for the
+`system' function."
     (system (format nil "%s &" command)))
 
   (define-command 'run-shell-command run-shell-command
     #:spec "sCommand:"
-    #:type `(and (labelled ,(_ "Command:") string)))
+    #:type `(and (labelled ,(_ "Command:") string))
+    #:doc "Execute the given shell command.")
 
   (define (command-sequence commands)
     "Invoke the list of commands, one by one."
diff --git a/lisp/sawfish/wm/util/gtkrc.jl b/lisp/sawfish/wm/util/gtkrc.jl
index 2c4a777..014777d 100644
--- a/lisp/sawfish/wm/util/gtkrc.jl
+++ b/lisp/sawfish/wm/util/gtkrc.jl
@@ -78,7 +78,8 @@
       (call-with-server-ungrabbed
        (lambda ()
 	 (unless (zerop (call-process process nil gtkrc-style-program))
-	   (error "Can't start gtkrc-style-program"))))
+	   (error "Can't start gtkrc-style-program: `%s'."
+		  gtkrc-style-program))))
       (setq output (make-string-input-stream
 		    (get-output-stream-string output)))
       (setq gtkrc-style nil)
diff --git a/man/news.texi b/man/news.texi
index ab313dc..e024f94 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -13,29 +13,12 @@ they occurred between. For more detailed information see the
 
 @itemize @bullet
 
- item The 1.6.3 release has some improvements.
- itemize @minus
- item Customizable lisp directory [Teika kazura]
-
-User can add lisp directories to be read with the environmental
-variable @code{SAWFISH_USER_LISP_DIR}. Its value is directories
-separated by colon, like @code{PATH}, and prepended to
- code{load-path}  If not set, @file{~/.sawfish/lisp} is assumed.
-
-User can override system lisp files. For example, if there is
- file{~/.sawfish/lisp/sawfish/wm/windows.jl}, then it is read as
- code{sawfish wm windows}, instead of the installed one. In fact, it
-was possible for some lisp files, but now it's guaranteed for all
-files.  Of course, you can define new modules, too.
-
- end itemize
 @item Bugfixes
 @itemize @minus
 @item In tabbed-windows the left/right end is no longer outside the
 window, if that is too small [Fuchur]
 
- item Unsupported option @code{ignore-window-input-hint} is deleted @*
-It has been invalid for long. [Teika kazura]
+ item Unsupported option @code{ignore-window-input-hint} is deleted which has been invalid for long. [Teika kazura]
 
 @item Honor the user option @code{maximize-raises} in @code{maximize-window-fullscreen} and
 @code{maximize-window-fullxinerama}, too, not just in maximize-window
@@ -43,27 +26,28 @@ It has been invalid for long. [Teika kazura]
 
 @item More robustness in applications menu [Teika Kazura]
 
-It broke for 'R', and whitespace handling didn't follow the specification.
-Phony constants are removed, too.
+Before it broke for 'R' (statistics software), and whitespace handling
+didn't follow the specification. Phony constants are removed, too.
 @end itemize
 
 @item New Features
 @itemize @minus
 
- item Tabbed-Windowing-System [Fuchur]
+ item Tabbed windowing system improvements [Fuchur]
 @itemize +
 @item Support for transient tab-frames
 
- item new frame classes:
+ item New frame classes:
 @itemize x
 @item tab-s (side tab)
 @item tab-ls (side tab, left/bottom end)
 @item tab-rs (side tab, right/top end)
 @end itemize
 
- item tabgroups now support a set of new properties and actions:
-type, set-frame-style, fixed-position, iconify. In addition, new
-tabs gain those properties from their parent window.
+ item Tabgroups now support a set of new properties and actions:
+ code{type}, @code{set-frame-style}, @code{fixed-position},
+ code{iconify}  In addition, new tabs gain those properties from their
+parent window.
 @end itemize
 @item New command @code{display-window-position} [Teika kazura]
 
@@ -73,7 +57,7 @@ and size in a popup. Also available as a function, defined in
 
 @item New function @code{window-pid} [Teika kazura]
 
-It returns the process id of a window. (@pxref{Window Attributes}
+It returns the process ID of a window. (@pxref{Window Attributes}
 
 @item Window instance name is now accessible [Teika kazura]
 
@@ -81,6 +65,21 @@ Technically, the window class consists of ``instance'' and ``class'',
 but only the latter was returned previously by the function
 @code{window-class}. Now with the new optional argument, the instance
 is returned too. (@pxref{Window Attributes})
+
+ item Customizable lisp directory [Teika kazura]
+
+User can add lisp directories to be read with the environmental
+variable @code{SAWFISH_USER_LISP_DIR}. Its value is directories
+separated by colon, like @code{PATH}, and prepended to
+ code{load-path}  If not set, @file{~/.sawfish/lisp} is assumed.
+For example, if you define a module @code{sawfish.wm.super-hack}, then
+it can be read from @file{~/.sawfish/lisp/sawfish/wm/super-hack.jl}.
+
+User can override system lisp files, too. For example, if there is
+ file{~/.sawfish/lisp/sawfish/wm/windows.jl}, then it defines
+ code{sawfish wm windows}, instead of the installed one. (But this can
+easily break your Sawfish startup.) In fact, it was possible for some
+lisp files, but now it's guaranteed for all files.
 @end itemize
 
 @item Other Changes
diff --git a/man/sawfish.texi b/man/sawfish.texi
index a2e8473..3fdcf4f 100644
--- a/man/sawfish.texi
+++ b/man/sawfish.texi
@@ -711,7 +711,7 @@ Windows with special properties:
 
 Many attributes are described in the related sections.
 
-First, basic attributes, like name, class, id, etc.
+First, basic attributes, like name, class, ID, etc.
 @defun window-name window
 Return the name associated with @var{window}.
 @end defun
@@ -793,7 +793,7 @@ Return true if @var{window} includes @var{atom} in its
 @end defun
 
 @defun window-pid window
-Returns the window process id, or nil if not available.
+Returns the window process ID, or nil if not available.
 @end defun
 
 @noindent
@@ -849,7 +849,7 @@ Returns the value of the last @var{function} invocation.  If any
 Functions to get specific windows.
 
 @defun get-window-by-id xid
-Return a window object with id @var{xid}, or @code{nil}.
+Return a window object with ID @var{xid}, or @code{nil}.
 @end defun
 
 @defun get-window-by-name name
@@ -5426,9 +5426,9 @@ ancestor chain until it is handled.
 @chapter Commands
 @cindex Commands
 
-A @dfn{command} is a Lisp function which may be called interactively,
-that is, as a result of being bound to an input event.  To support
-this, we mark them with metadata that the runtime system can query.
+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.
 
 @menu
 * Old-style Command Definition::  Emacs-Lisp style
@@ -5655,23 +5655,27 @@ command.
 
 Sawfish defines several commands by default.
 
- defun run-shell-command
-The command prompts the user for a string, and executes that string as
-under @code{system}.
- end defun
+ deffn Command: run-shell-command
+Executes a shell command. This is a wrapper for @code{system}
+function, so in lisp code, use it instead. (@pxref{Shell Commands, ,
+,librep}.)
+ end deffn
 
- defun quit
- defunx restart
- defunx destroy-window
- defunx kill-client
- defunx no-operation
+ deffn Command: quit
+ deffnx Command: restart
+Quits and restarts Sawfish. @xref{Sawfish Invocation Functions}.
+ end deffn
 
-Calls the function of the same name.  @code{destroy-window} and
- code{kill-client} both take @code{%W} as argument.
+ deffn Command: destroy-window
+ deffnx Command: kill-client
+Command @code{destroy-window} calls the function of the same name, and
+command @code{kill-client} calls the function @code{x-kill-client}.
+Both take @code{%W} as argument. @xref{Destroying Windows}.
+ end deffn
 
-(Strictly speaking, @code{kill-client} calls @code{x-kill-client},
-and @code{no-operation} calls @code{nop}.)
- end defun
+ deffn Command: no-operation
+Does nothing.
+ end deffn
 
 @node Keymaps, Event Loop, Commands, Top
 @chapter Keymaps
@@ -6442,6 +6446,11 @@ the @code{PATH} environmental variable. Example:
 @code{~/.sawfish/lisp-test:~/.sawfish/lisp}.
 @end defvar
 
+ defun quit
+ defunx restart
+Quits and restart Sawfish.
+ end defun
+
 @defun exit-type
 If Sawfish is shutting down, this function returns one of the strings
 @code{"user-quit"}, @code{"user-restart"} or @code{"session-quit"}.
@@ -6590,7 +6599,9 @@ order of elements is not preserved.
 @chapter External Applications
 @cindex External applications
 
-There're some functions and variables for invocation of external applications.
+There're some functions and variables for invocation of external
+applications. They're defined in @code{sawfish.wm.commands.launcher}
+module.
 
 @defvr {Customizable} xterm-program
 The program launched by the @code{xterm} function. Interpreted by shell.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]