[sawfish] Improved manuals (1). All options are now described.
- From: Christopher Bratusek <chrisb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [sawfish] Improved manuals (1). All options are now described.
- Date: Tue, 22 Jun 2010 14:54:49 +0000 (UTC)
commit 8bd30b6b4eb8783b4f8aae83d9c33863310336d1
Author: Teika kazura <teika lavabit com>
Date: Sun Jun 20 21:33:15 2010 +0900
Improved manuals (1). All options are now described.
man/news.texi | 4 +-
man/sawfish-config.1 | 70 +++++++++++++++++---------------
man/sawfish.1 | 107 +++++++++++++++++++++++++++----------------------
3 files changed, 99 insertions(+), 82 deletions(-)
---
diff --git a/man/news.texi b/man/news.texi
index 3936152..2452c6b 100644
--- a/man/news.texi
+++ b/man/news.texi
@@ -25,7 +25,9 @@ parts. (@pxref{Frame Part Definition})
@item Miscellaneous Changes
@itemize @minus
- item A new faq item on how to hide the mouse pointer.
+ item Doc improvements *
+A new faq item on how to hide the mouse pointer *
+Manuals (1) describe all options.
@end itemize
@end itemize
diff --git a/man/sawfish-config.1 b/man/sawfish-config.1
index ed66607..b528107 100644
--- a/man/sawfish-config.1
+++ b/man/sawfish-config.1
@@ -1,33 +1,37 @@
-.TH "sawfish-config" "1"
-.SH "NAME"
-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]
-.SH "DESCRIPTION"
-.PP
-This program can be used to invoke the GUI manually; if GNOME is being
-used, then the GNOME Control Center can also be used to customize
-certain classes.
-.SH "OPTIONS"
-.IP "\fB\-\-group\fP \fBGROUP-NAME\fP " 10
-Display only \fIGROUP-NAME\fR
-.IP "" 10
-\fIGROUP-NAME\fR should be one of these
-names Sawfish, Appearance, Bindings, Focus, Window Rules,
-Minimizing/Maximizing, Miscellaneous, Move/Resize, Placement, Sounds, 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.
-.IP "\fB\-\-socket-id\fP \fBWINDOW-ID\fP " 10
-This option allow the ui to be embedded in the gnome control
-center. This also disables the ok/cancel/etc buttons and enables
-a hacky protocol on stdin/stdout
-.SH "AUTHOR"
-.PP
-This manual page was written by Christian Marillat marillat debian org for
-the \fBDebian GNU/Linux\fP system (but may be used by others).
-.\" created by instant / docbook-to-man, Sat 02 Feb 2008, 23:15
+.TH "sawfish-config" "1"
+.SH "NAME"
+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]
+.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.
+.SH "OPTIONS"
+.IP "\fB\-\-group=\fIGROUP-NAME\fP " 10
+Display only \fIGROUP-NAME\fR.
+.IP "" 10
+\fIGROUP-NAME\fR should be one of these names: Sawfish, Appearance,
+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.
+.IP "\fB\-\-disable-nls\fP" 10
+Disable internationalization of messages.
+.IP "\fB\-\-help\fP" 10
+Prints help.
+.SH "AUTHOR"
+.PP
+This manual page was written by Christian Marillat marillat debian org for
+the \fBDebian GNU/Linux\fP system (but may be used by others).
+.\" created by instant / docbook-to-man, Sat 02 Feb 2008, 23:15
diff --git a/man/sawfish.1 b/man/sawfish.1
index 5ffee5e..ff5bf88 100644
--- a/man/sawfish.1
+++ b/man/sawfish.1
@@ -1,48 +1,59 @@
-.TH "sawfish" "1"
-.SH "NAME"
-sawfish \(em Sawfish window manager.
-.SH "SYNOPSIS"
-.PP
-\fBsawfish\fR [\fB\-\-display \fI[=DPY]\fR \fP] [\fB\-\-multihead \fP] [\fB\-\-visual \fI[=VISUAL]\fR \fP] [\fB\-\-depth \fI[=DEPTH]\fR \fP] [\fB\-\-disable-nls \fP] [\fBFILE \fP] [\fB\-\-batch \fP] [\fB\-\-interp \fP] [\fB-f, \-\-call \fIFUNCTION\fR \fP] [\fB-l, \-\-load \fIFILE\fR \fP] [\fB\-\-version \fP] [\fB\-\-no-rc \fP] [\fB-q, \-\-quit \fP]
-.SH "DESCRIPTION"
-.PP
-Sawfish is a lisp-extensible window manager for X11. Its aim is to
-allow all areas of window management (decoration, manipulation) to be
-customized as far as is possible, yet still remain as fast or faster
-than existing window managers.
-.SH "OPTIONS"
-.IP "\fB\-\-display=\fIDPY\fR\fP" 10
-Connect to X display \fIDPY\fR.
-.IP "\fB\-\-multihead\fP" 10
-Fork a copy of sawfish for each screen.
-.IP "\fB\-\-visual=\fIVISUAL\fR\fP" 10
-Preferred \fIVISUAL\fR type.
-.IP "\fB\-\-depth=\fIDEPTH\fR\fP" 10
-Preferred color \fIDEPTH\fR.
-.IP "\fB\-\-disable-nls\fP" 10
-Disable internationalization of messages.
-.IP "\fBFILE\fP " 10
-Load the Lisp file \fIFILE\fR (from the
-cwd if possible, implies \fI\-\-batch\fR mode).
-.IP "\fB\-\-batch\fP " 10
-Batch mode: process options and exit.
-.IP "\fB\-\-interp\fP " 10
-Interpreted mode: don't load compiled Lisp files.
-.IP "\fB-f, \-\-call\fP \fBFUNCTION\fP " 10
-Call Lisp function \fIFUNCTION\fR.
-.IP "\fB-l, \-\-load\fP \fBFILE\fP " 10
-Load the file of Lisp forms called \fIFUNCTION\fR.
-.IP "\fB\-\-version\fP" 10
-Print version details.
-.IP "\fB\-\-no-rc\fP" 10
-Don't load rc or site-init files.
-.IP "\fB-q, \-\-quit-\fP" 10
-Terminate the interpreter process.
-.SH "SEE ALSO"
-.PP
-Sawfish is documented fully by \fIJohn Harper\fP available via the \fBInfo\fP system.
-.SH "AUTHOR"
-.PP
-This manual page was written by Christian Marillat marillat debian org for
-the \fBDebian GNU/Linux\fP system (but may be used by others).
-.\" created by instant / docbook-to-man, Sat 02 Feb 2008, 23:15
+.TH "sawfish" "1"
+.SH "NAME"
+sawfish \(em Sawfish window manager.
+.SH "SYNOPSIS"
+.PP
+\fBsawfish\fR [\fB\-\-display \fI[=DPY]\fR \fP] [\fB\-\-multihead \fP] [\fB\-\-visual \fI[=VISUAL]\fR \fP] [\fB\-\-depth \fI[=DEPTH]\fR \fP] [\fB\-\-disable-nls \fP] [\fBFILE \fP] [\fB\-\-batch \fP] [\fB\-\-interp \fP] [\fB-f, \-\-call \fIFUNCTION\fR \fP] [\fB-l, \-\-load \fIFILE\fR \fP] [\fB\-\-version \fP] [\fB\-\-no-rc \fP] [\fB-q, \-\-quit \fP]
+.SH "DESCRIPTION"
+.PP
+Sawfish is a lisp-extensible window manager for X11. Its aim is to
+allow all areas of window management (decoration, manipulation) to be
+customized as far as is possible, yet still remain as fast or faster
+than existing window managers.
+.SH "OPTIONS"
+.IP "\fB\-\-disable-nls\fP" 10
+Disable internationalization of messages.
+.IP "\fBFILE\fP " 10
+Load the Lisp file \fIFILE\fR (from the
+cwd if possible, implies \fI\-\-batch\fR mode).
+.IP "\fB\-\-batch\fP " 10
+Batch mode: process options and exit.
+.IP "\fB\-\-interp\fP " 10
+Interpreted mode: don't load compiled Lisp files.
+.IP "\fB-f, \-\-call\fP \fBFUNCTION\fP" 10
+Call Lisp function \fIFUNCTION\fR.
+.IP "\fB-l, \-\-load\fP \fBFILE\fP" 10
+Load the file of Lisp forms called \fIFUNCTION\fR.
+.IP "\fB\-\-version\fP" 10
+Print version details.
+.IP "\fB\-\-no-rc\fP" 10
+Don't load rc or site-init files.
+.IP "\fB-q, \-\-quit\fP" 10
+Terminate the interpreter process.
+.SS Display Options
+.IP "\fB\-\-display=\fIDPY\fR\fP" 10
+Connect to X display \fIDPY\fR.
+.IP "\fB\-\-multihead\fP" 10
+Fork a copy of sawfish for each screen.
+.IP "\fB\-\-visual=\fIVISUAL\fR\fP" 10
+Preferred \fIVISUAL\fR type.
+.IP "\fB\-\-depth=\fIDEPTH\fR\fP" 10
+Preferred color \fIDEPTH\fR.
+.SS Customization Files Options
+.IP "\fB\-\-custom-file\fP \fBFILE\fP" 10
+Overrides the default custom file \fI~/.sawfish/custom\fR.
+.IP "\fB\-\-window-history-file\fP \fBFILE\fP" 10
+Overrides the default window history file \fI~/.sawfish/window-history\fR.
+.IP "\fB\-\-no-rc" 10
+Do not load the rc file.
+.SS Debugging Option
+.IP "\fB\-\-sync" 10
+Read src/display.c. Don't use it unless you're sure.
+.SH "SEE ALSO"
+.PP
+Sawfish is documented fully by \fIJohn Harper\fP available via the \fBInfo\fP system.
+.SH "AUTHOR"
+.PP
+This manual page was written by Christian Marillat marillat debian org for
+the \fBDebian GNU/Linux\fP system (but may be used by others).
+.\" created by instant / docbook-to-man, Sat 02 Feb 2008, 23:15
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]