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 or a number.
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";
66 Specifies the period of time after which a started key chain will
67 be timed out. It takes a number argument specifying the number of
68 milliseconds to wait. It defaults to 4000.
70 Specifies the number of columns of your workspace layout if you are using
71 your workspaces in a 2-dimensional manner. This option must exist if one of
72 the prevWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
73 nextWorkspaceRow commands are used.
76 Runs a shell command. Takes a single string argument, in ""s.
78 Iconifies the currently focused window.
80 Raises the currently focused window to the top of the stacking order.
82 Lowers the currently focused window to the bottom of the stacking order.
84 Closes the currently focused window.
86 Shades and Unshades the currently focused window.
88 Sends the window to all workspaces, or moves it from all workspaces to the
94 Move the window in the specified direction. Takes a single numerical parameter,
95 which is the amount to move the window.
97 .SS resizeWindowHeight
98 Resizes the window. Takes a single numerical parameter, which is the
99 amount to resize the window by. A positive number enlarges the window, a
100 negative value shrinks the window.
101 .SS toggleMaximizeFull
102 Maximizes and Unmaxizes the currently focused window.
103 .SS toggleMaximizeVertical
104 Maximizes and Unmaxizes the currently focused window vertically.
105 .SS toggleMaximizeHorizontal
106 Maximizes and Unmaxizes the currently focused window horizontally.
108 Sends the currently focused window to another workspace. This takes a single
109 numberical parameter, which is the workspace to send the window to. Workspace
113 Cycles focus to the next/previous window on the workspace. This can take a
114 single numerical parameter specifying how many windows to cycle through. If
115 none is specified, a value of 1 is assumed.
116 .SS nextWindowOnAllWorkspaces
117 .SS prevWindowOnAllWorkspaces
118 Cycles focus to the next/previous window on all workspaces, switching between
119 workspaces as neccessary. This can take a single numerical parameter specifying
120 how many windows to cycle through. If none is specified, a value of 1 is
122 .SS nextWindowOnAllScreens
123 .SS prevWindowOnAllScreens
124 Cycles focus to the next/previous window on all screens (in a multi-head setup).
125 This can take a single numerical parameter specifying how many windows to cycle
126 through. If none is specified, a value of 1 is assumed.
127 .SS nextWindowOfClass
128 .SS prevWindowOfClass
129 Cycles focus to the next/previous window of a certain class on the current
130 workspace. This can take a single string parameter, in ""s, specifying the
131 class of the window to cycle to. If the parameter is omitted, the class of the
132 currently focused window is used. This can take a single numerical parameter
133 specifying how many windows to cycle through. If none is specified, a value of
135 .SS nextWindowOfClassOnAllWorkspaces
136 .SS prevWindowOfClassOnAllWorkspaces
137 Cycles focus to the next/previous window of a certain class on all workspaces.
138 This can take a single string parameter, in ""s, specifying the class of the
139 window to cycle to. If the parameter is omitted, the class of the currently
140 focused window is used. This can take a single numerical parameter specifying
141 how many windows to cycle through. If none is specified, a value of 1 is
144 Changes to a specific workspace. This takes a single numerical paramter,
145 specifying the number of the workspace to switch to. Workspace numbers begin at
149 Switches to the next/previous workspace. This can take a single numerical
150 parameter specifying how many workspaces to cycle through. If none is specified,
151 a value of 1 is assumed.
154 Cycles focus to the next/previous screen (in a multi-head setup).
155 .SS prevWorkspaceColumn
156 .SS nextWorkspaceColumn
159 Used to navigate the workspaces in a 2-dimensional manner. If these commands are
160 used, the workspaceColumns action must be specified. See OPTIONS.
162 Disables all keybindings except for the binding which runs this action, for
163 the current screen. Enables keybindings when run again. This command cannot be
167 .B [Openbox specific]
169 Opens the root menu under the mouse pointer.
170 .SS showWorkspaceMenu
171 .B [Openbox specific]
173 Opens the workspace menu under the mouse pointer.
176 \fIepist\fR(1) \fIopenbox\fR(1)