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 42ecb3b0ae1f87dffe558659dd608a242b8d4872..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,26 +6,30 @@ 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
+.SS Options
 All of the options for epist are contained inside a clause such as this:
-.br
+.PP
 options {
 .br
-       blef 5;
+       <option name> <option value>;
 .br
 }
 .PP
-.B NOTE: options is not yet supported by epist. This will exist in the next release.
-.SS bindings
+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:
-.br
+.PP
 <key> <action> <optional parameter>;
 .PP
 Bindings with chains are specified in this format:
-.br
+.PP
 <root key> {
 .br
        <key> <action> <optional parameter>;
@@ -34,8 +38,10 @@ Bindings with chains are specified in this format:
 .PP
 The <key> is made up of a list of modifiers and a single key. The possible modifiers are: \fIControl\fR, \fIShift\fR, \fIMod1\fR (usually the Alt key), \fIMod2\fR, \fIMod3\fR, \fIMod4\fR (usually the "windows" key), and \fIMod5\fR. You may also specify a <key> without any modifiers.
 .PP
-You may also nest as many chains as you want. Some examples of bindings are:
-.br
+Comments can be added by prefixing the commented line with a "#".
+.PP
+You may nest as many chains as you want. Some examples of bindings are:
+.PP
 Mod1-Tab nextWindow;
 .br
 Mod1-Shift-Tab prevWindow;
@@ -52,9 +58,31 @@ Control-Mod1-x {
 .br
        r raise;
 .br
-       l lower;
+       Mod1-x { l lower; }
 .br
 }
+.SH OPTIONS
+.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 (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,
+nextWorkspaceRow commands are used.
 .SH COMMANDS
 .SS execute
 Runs a shell command. Takes a single string argument, in ""s.
@@ -66,9 +94,9 @@ Raises the currently focused window to the top of the stacking order.
 Lowers the currently focused window to the bottom of the stacking order.
 .SS close
 Closes the currently focused window.
-.SS toggleshade
+.SS toggleShade
 Shades and Unshades the currently focused window.
-.SS toggleomnipresent
+.SS toggleOmnipresent
 Sends the window to all workspaces, or moves it from all workspaces to the
 current one.
 .SS moveWindowUp
@@ -136,6 +164,30 @@ a value of 1 is assumed.
 .SS nextScreen
 .SS prevScreen
 Cycles focus to the next/previous screen (in a multi-head setup).
+.SS prevWorkspaceColumn
+.SS nextWorkspaceColumn
+.SS prevWorkspaceRow
+.SS nextWorkspaceRow
+Used to navigate the workspaces in a 2-dimensional manner. If these commands are
+used, the workspaceColumns action must be specified. See OPTIONS.
+.SS toggleGrabs
+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)