1 .TH epistrc 5 "August 24, 2002"
3 epistrc \- Configuration file for Epist
5 .B $HOME/.openbox/epistrc
7 .B @pkgdatadir@/epistrc
9 \fIepist\fR(1) grabs its configuration and bindings from the epistrc file. All
10 options shown will work with any window manager that supports the NetWM/EWMH
11 specification, with the exception of those marked with the
15 The epistrc file contains 2 sections:
17 All of the options for epist are contained inside a clause such as this:
21 <option name> <option value>;
25 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).
27 Bindings are specified in this format:
29 <key> <action> <optional parameter>;
31 Bindings with chains are specified in this format:
35 <key> <action> <optional parameter>;
39 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.
41 Comments can be added by prefixing the commented line with a "#".
43 You may nest as many chains as you want. Some examples of bindings are:
47 Mod1-Shift-Tab prevWindow;
49 Mod1-F1 changeWorkspace 1;
51 Mod1-F2 changeWorkspace 2;
53 Control-F1 execute "xterm";
65 .SS stackedCycling (boolean)
66 When this option is set to True, any window cycling actions, such as nextWindow,
67 prevWindow, nextWindowOfClass, etc., will cause the windows to focus, but they will
68 not be raised until the modifiers are released. When the modifier is released,
69 the focused (and now raised) window will be moved to the top of the stacking order,
70 so if you execute nextWindow and release the modifiers multiple times, focus will
71 cycle between two windows.
72 .SS chainTimeout (number)
73 Specifies the period of time after which a started key chain will
74 be timed out. It takes a number argument specifying the number of
75 milliseconds to wait. It defaults to 4000.
76 .SS workspaceColumns (number)
77 Specifies the number of columns of your workspace layout if you are using
78 your workspaces in a 2-dimensional manner. This option must exist if one of
79 the prevWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
80 nextWorkspaceRow commands are used.
83 Runs a shell command. Takes a single string argument, in ""s.
85 Iconifies the currently focused window.
87 Raises the currently focused window to the top of the stacking order.
89 Lowers the currently focused window to the bottom of the stacking order.
91 Closes the currently focused window.
93 Shades and Unshades the currently focused window.
95 Sends the window to all workspaces, or moves it from all workspaces to the
101 Move the window in the specified direction. Takes a single numerical parameter,
102 which is the amount to move the window.
103 .SS resizeWindowWidth
104 .SS resizeWindowHeight
105 Resizes the window. Takes a single numerical parameter, which is the
106 amount to resize the window by. A positive number enlarges the window, a
107 negative value shrinks the window.
108 .SS toggleMaximizeFull
109 Maximizes and Unmaxizes the currently focused window.
110 .SS toggleMaximizeVertical
111 Maximizes and Unmaxizes the currently focused window vertically.
112 .SS toggleMaximizeHorizontal
113 Maximizes and Unmaxizes the currently focused window horizontally.
115 Sends the currently focused window to another workspace. This takes a single
116 numberical parameter, which is the workspace to send the window to. Workspace
120 Cycles focus to the next/previous window on the workspace. This can take a
121 single numerical parameter specifying how many windows to cycle through. If
122 none is specified, a value of 1 is assumed.
123 .SS nextWindowOnAllWorkspaces
124 .SS prevWindowOnAllWorkspaces
125 Cycles focus to the next/previous window on all workspaces, switching between
126 workspaces as neccessary. This can take a single numerical parameter specifying
127 how many windows to cycle through. If none is specified, a value of 1 is
129 .SS nextWindowOnAllScreens
130 .SS prevWindowOnAllScreens
131 Cycles focus to the next/previous window on all screens (in a multi-head setup).
132 This can take a single numerical parameter specifying how many windows to cycle
133 through. If none is specified, a value of 1 is assumed.
134 .SS nextWindowOfClass
135 .SS prevWindowOfClass
136 Cycles focus to the next/previous window of a certain class on the current
137 workspace. This can take a single string parameter, in ""s, specifying the
138 class of the window to cycle to. If the parameter is omitted, the class of the
139 currently focused window is used. This can take a single numerical parameter
140 specifying how many windows to cycle through. If none is specified, a value of
142 .SS nextWindowOfClassOnAllWorkspaces
143 .SS prevWindowOfClassOnAllWorkspaces
144 Cycles focus to the next/previous window of a certain class on all workspaces.
145 This can take a single string parameter, in ""s, specifying the class of the
146 window to cycle to. If the parameter is omitted, the class of the currently
147 focused window is used. This can take a single numerical parameter specifying
148 how many windows to cycle through. If none is specified, a value of 1 is
151 Changes to a specific workspace. This takes a single numerical paramter,
152 specifying the number of the workspace to switch to. Workspace numbers begin at
156 Switches to the next/previous workspace. This can take a single numerical
157 parameter specifying how many workspaces to cycle through. If none is specified,
158 a value of 1 is assumed.
161 Cycles focus to the next/previous screen (in a multi-head setup).
162 .SS prevWorkspaceColumn
163 .SS nextWorkspaceColumn
166 Used to navigate the workspaces in a 2-dimensional manner. If these commands are
167 used, the workspaceColumns action must be specified. See OPTIONS.
169 Disables all keybindings except for the binding which runs this action, for
170 the current screen. Enables keybindings when run again. This command cannot be
173 .SS toggleDecorations
174 .B [Openbox specific]
176 Toggles whether or not the window decorations are shown on the currently
177 focused window. (Decorations include the titlebar, borders, and bottom handle.)
179 .B [Openbox specific]
181 Opens the root menu under the mouse pointer.
182 .SS showWorkspaceMenu
183 .B [Openbox specific]
185 Opens the workspace menu under the mouse pointer.
188 \fIepist\fR(1) \fIopenbox\fR(1)