1 .TH epistrc 5 "August 16, 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.
11 The epistrc file contains 2 sections:
13 All of the options for epist are contained inside a clause such as this:
17 <option name> <option value>;
21 The option name is a string of characters, and the option value can be either a string in double quotes or a number.
23 Bindings are specified in this format:
25 <key> <action> <optional parameter>;
27 Bindings with chains are specified in this format:
31 <key> <action> <optional parameter>;
35 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.
37 Comments can be added by prefixing the commented line with a "#".
39 You may nest as many chains as you want. Some examples of bindings are:
43 Mod1-Shift-Tab prevWindow;
45 Mod1-F1 changeWorkspace 1;
47 Mod1-F2 changeWorkspace 2;
49 Control-F1 execute "xterm";
62 Specifies the period of time after which a started key chain will
63 be timed out. It takes a number argument specifying the number of
64 milliseconds to wait. It defaults to 4000.
66 Specifies the number of columns of your workspace layout if you are using
67 your workspaces in a 2-dimensional manner. This option must exist if one of
68 the prevWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
69 nextWorkspaceRow commands are used.
72 Runs a shell command. Takes a single string argument, in ""s.
74 Iconifies the currently focused window.
76 Raises the currently focused window to the top of the stacking order.
78 Lowers the currently focused window to the bottom of the stacking order.
80 Closes the currently focused window.
82 Shades and Unshades the currently focused window.
84 Sends the window to all workspaces, or moves it from all workspaces to the
90 Move the window in the specified direction. Takes a single numerical parameter,
91 which is the amount to move the window.
93 .SS resizeWindowHeight
94 Resizes the window. Takes a single numerical parameter, which is the
95 amount to resize the window by. A positive number enlarges the window, a
96 negative value shrinks the window.
97 .SS toggleMaximizeFull
98 Maximizes and Unmaxizes the currently focused window.
99 .SS toggleMaximizeVertical
100 Maximizes and Unmaxizes the currently focused window vertically.
101 .SS toggleMaximizeHorizontal
102 Maximizes and Unmaxizes the currently focused window horizontally.
104 Sends the currently focused window to another workspace. This takes a single
105 numberical parameter, which is the workspace to send the window to. Workspace
109 Cycles focus to the next/previous window on the workspace. This can take a
110 single numerical parameter specifying how many windows to cycle through. If
111 none is specified, a value of 1 is assumed.
112 .SS nextWindowOnAllWorkspaces
113 .SS prevWindowOnAllWorkspaces
114 Cycles focus to the next/previous window on all workspaces, switching between
115 workspaces as neccessary. This can take a single numerical parameter specifying
116 how many windows to cycle through. If none is specified, a value of 1 is
118 .SS nextWindowOnAllScreens
119 .SS prevWindowOnAllScreens
120 Cycles focus to the next/previous window on all screens (in a multi-head setup).
121 This can take a single numerical parameter specifying how many windows to cycle
122 through. If none is specified, a value of 1 is assumed.
123 .SS nextWindowOfClass
124 .SS prevWindowOfClass
125 Cycles focus to the next/previous window of a certain class on the current
126 workspace. This can take a single string parameter, in ""s, specifying the
127 class of the window to cycle to. If the parameter is omitted, the class of the
128 currently focused window is used. This can take a single numerical parameter
129 specifying how many windows to cycle through. If none is specified, a value of
131 .SS nextWindowOfClassOnAllWorkspaces
132 .SS prevWindowOfClassOnAllWorkspaces
133 Cycles focus to the next/previous window of a certain class on all workspaces.
134 This can take a single string parameter, in ""s, specifying the class of the
135 window to cycle to. If the parameter is omitted, the class of the currently
136 focused window is used. This can take a single numerical parameter specifying
137 how many windows to cycle through. If none is specified, a value of 1 is
140 Changes to a specific workspace. This takes a single numerical paramter,
141 specifying the number of the workspace to switch to. Workspace numbers begin at
145 Switches to the next/previous workspace. This can take a single numerical
146 parameter specifying how many workspaces to cycle through. If none is specified,
147 a value of 1 is assumed.
150 Cycles focus to the next/previous screen (in a multi-head setup).
151 .SS prevWorkspaceColumn
152 .SS nextWorkspaceColumn
155 Used to navigate the workspaces in a 2-dimensional manner. If these commands are
156 used, the workspaceColumns action must be specified. See OPTIONS.
158 Disables all keybindings except for the binding which runs this action, for
159 the current screen. Enables keybindings when run again. This command cannot be
163 \fIepist\fR(1) \fIopenbox\fR(1)