make epist compile with the new code base

[chaz/openbox] / util / epist / epistrc.5.in

diff --git a/util/epist/epistrc.5.in b/util/epist/epistrc.5.in
index b578c9f5e618d9d4e5442963e362877a074c7659..06615768ec7d9dc0da7320fc00725e39f3f17e7c 100644 (file)
--- a/util/epist/epistrc.5.in
+++ b/util/epist/epistrc.5.in
@@ -1,4 +1,4 @@
-.TH epistrc 5 "August 16, 2002"
+.TH epistrc 5 "August 24, 2002"
 .SH NAME
 epistrc \- Configuration file for Epist
 .SH SYNOPSIS
@@ -6,7 +6,11 @@ epistrc \- Configuration file for Epist
 .br
 .B @pkgdatadir@/epistrc
 .SH DESCRIPTION
-\fIepist\fR(1) grabs its configuration and bindings from the epistrc file.
+\fIepist\fR(1) grabs its configuration and bindings from the epistrc file. All
+options shown will work with any window manager that supports the NetWM/EWMH
+specification, with the exception of those marked with the
+.B [Openbox specific]
+tag.
 .SH SYNTAX
 The epistrc file contains 2 sections:
 .SS Options
@@ -18,7 +22,7 @@ options {
 .br
 }
 .PP
-The option name is a string of characters, and the option value can be either a string in double quotes or a number.
+The option name is a string of characters, and the option value can be either a string in double quotes, a number, or a boolen value (the words True or False without quotes around them).
 .SS Bindings
 Bindings are specified in this format:
 .PP
@@ -58,11 +62,23 @@ Control-Mod1-x {
 .br
 }
 .SH OPTIONS
-.SS chainTimeout
+.SS stackedCycling (boolean, default=off)
+When this option is set to True, any window cycling actions, such as nextWindow,
+prevWindow, nextWindowOfClass, etc., will cause the windows to focus, but they will
+not be raised until the modifiers are released. When the modifier is released,
+the focused (and now raised) window will be moved to the top of the stacking order,
+so if you execute nextWindow and release the modifiers multiple times, focus will
+cycle between two windows.
+.SS stackedCyclingRaise (boolean, default=off)
+This option modifies the window raise behavior when stackedCycling is turned on.
+When true, windows will be raised immediatly on focus, rather than when the
+keys are released. This may be desirable if you frequently have windows that are
+obscured by other windows.
+.SS chainTimeout (number, default=3500)
 Specifies the period of time after which a started key chain will
 be timed out. It takes a number argument specifying the number of
 milliseconds to wait. It defaults to 4000.
-.SS workspaceColumns
+.SS workspaceColumns (number, default=0, disabled)
 Specifies the number of columns of your workspace layout if you are using
 your workspaces in a 2-dimensional manner. This option must exist if one of
 the prevWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
@@ -159,5 +175,19 @@ Disables all keybindings except for the binding which runs this action, for
 the current screen. Enables keybindings when run again. This command cannot be
 part of a chain.
 
+.SS toggleDecorations
+.B [Openbox specific]
+.br
+Toggles whether or not the window decorations are shown on the currently
+focused window. (Decorations include the titlebar, borders, and bottom handle.)
+.SS showRootMenu
+.B [Openbox specific]
+.br
+Opens the root menu under the mouse pointer.
+.SS showWorkspaceMenu
+.B [Openbox specific]
+.br
+Opens the workspace menu under the mouse pointer.
+
 .SH SEE ALSO
 \fIepist\fR(1) \fIopenbox\fR(1)