epistrc(5)
NAME
epistrc - Configuration file for Epist
SYNOPSIS
$HOME/.openbox/epistrc /usr/share/openbox/epistrc
DESCRIPTION
epist(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 [Openbox specific]
tag.
SYNTAX
- The epistrc file contains 2 sections:
- Options
- All of the options for epist are contained inside a clause
such as this: - options {
<option name> <option value>;
- }
- 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). - Bindings
- Bindings are specified in this format:
- <key> <action> <optional parameter>;
- Bindings with chains are specified in this format:
- <root key> {
<key> <action> <optional parameter>;
- }
- The <key> is made up of a list of modifiers and a single
key. The possible modifiers are: Control, Shift, Mod1 (usually the Alt key), Mod2, Mod3, Mod4 (usually the "win dows" key), and Mod5. You may also specify a <key> without
any modifiers. - Comments can be added by prefixing the commented line with
a "#". - You may nest as many chains as you want. Some examples of
bindings are: - Mod1-Tab nextWindow;
Mod1-Shift-Tab prevWindow;
Mod1-F1 changeWorkspace 1;
Mod1-F2 changeWorkspace 2;
Control-F1 execute "xterm";
Control-Mod1-x {i iconify;
r raise;
Mod1-x { l lower; } - }
OPTIONS
- stackedCycling (boolean, default=off)
- When this option is set to True, any window cycling
actions, such as nextWindow, prevWindow, nextWindowOf
Class, 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 multi
ple times, focus will cycle between two windows. - 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. - chainTimeout (number, default=3500)
- Specifies the period of time after which a started key
chain will be timed out. It takes a number argument speci
fying the number of milliseconds to wait. It defaults to
4000. - workspaceColumns (number, default=0, disabled)
- Specifies the number of columns of your workspace layout
if you are using your workspaces in a 2-dimensional man
ner. This option must exist if one of the pre
vWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
nextWorkspaceRow commands are used.
COMMANDS
- execute
- Runs a shell command. Takes a single string argument, in
""s. - iconify
- Iconifies the currently focused window.
- raise
- Raises the currently focused window to the top of the
stacking order. - lower
- Lowers the currently focused window to the bottom of the
stacking order. - close
- Closes the currently focused window.
- toggleShade
- Shades and Unshades the currently focused window.
- toggleOmnipresent
- Sends the window to all workspaces, or moves it from all
workspaces to the current one. - moveWindowUp
moveWindowDown
moveWindowLeft
moveWindowRight - Move the window in the specified direction. Takes a single
numerical parameter, which is the amount to move the win
dow. - resizeWindowWidth
resizeWindowHeight - Resizes the window. Takes a single numerical parameter,
which is the amount to resize the window by. A positive
number enlarges the window, a negative value shrinks the
window. - toggleMaximizeFull
- Maximizes and Unmaxizes the currently focused window.
- toggleMaximizeVertical
- Maximizes and Unmaxizes the currently focused window ver
tically. - toggleMaximizeHorizontal
- Maximizes and Unmaxizes the currently focused window hori
zontally. - sendToWorkspace
- Sends the currently focused window to another workspace.
This takes a single numerical parameter, which is the
workspace to send the window to. Workspace numbers begin
at 1. - sendToNextWorkspace
sendToPrevWorkspace - Sends the currently focused window to the next/previous
workspace. Takes boolean parameter that when true switches
to that workspace as well. If none is specified a value of
false is assumed. - nextWindow
prevWindow - Cycles focus to the next/previous window on the workspace.
This can take a single numerical parameter specifying how
many windows to cycle through. If none is specified, a
value of 1 is assumed. - nextWindowOnAllWorkspaces prevWindowOnAllWorkspaces
- Cycles focus to the next/previous window on all
workspaces, switching between workspaces as neccessary.
This can take a single numerical parameter specifying how
many windows to cycle through. If none is specified, a
value of 1 is assumed. - nextWindowOnAllScreens
prevWindowOnAllScreens - Cycles focus to the next/previous window on all screens
(in a multi-head setup). This can take a single numerical
parameter specifying how many windows to cycle through. If
none is specified, a value of 1 is assumed. - nextWindowOfClass
prevWindowOfClass - Cycles focus to the next/previous window of a certain
class on the current workspace. This can take a single
string parameter, in ""s, specifying the class of the win
dow to cycle to. If the parameter is omitted, the class of
the currently focused window is used. This can take a sin
gle numerical parameter specifying how many windows to
cycle through. If none is specified, a value of 1 is
assumed. - nextWindowOfClassOnAllWorkspaces prevWindowOfClassOnAllWorkspaces
- Cycles focus to the next/previous window of a certain
class on all workspaces. This can take a single string
parameter, in ""s, specifying the class of the window to
cycle to. If the parameter is omitted, the class of the
currently focused window is used. This can take a single
numerical parameter specifying how many windows to cycle
through. If none is specified, a value of 1 is assumed. - changeWorkspace
- Changes to a specific workspace. This takes a single
numerical paramter, specifying the number of the workspace
to switch to. Workspace numbers begin at 1. - nextWorkspace
prevWorkspace - Switches to the next/previous workspace. This can take a
single numerical parameter specifying how many workspaces
to cycle through. If none is specified, a value of 1 is
assumed. - nextScreen
prevScreen - Cycles focus to the next/previous screen (in a multi-head
setup). - prevWorkspaceColumn
nextWorkspaceColumn
prevWorkspaceRow
nextWorkspaceRow - Used to navigate the workspaces in a 2-dimensional manner.
If these commands are used, the workspaceColumns action
must be specified. See OPTIONS. - 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. - toggleDecorations
- [Openbox specific]
Toggles whether or not the window decorations are shown on
the currently focused window. (Decorations include the
titlebar, borders, and bottom handle.) - showRootMenu
- [Openbox specific]
Opens the root menu under the mouse pointer. - showWorkspaceMenu
- [Openbox specific]
Opens the workspace menu under the mouse pointer.