util/epist/epistrc.5.in

   1 .TH epistrc 5 "August 24, 2002"
   2 .SH NAME
   3 epistrc \- Configuration file for Epist
   4 .SH SYNOPSIS
   5 .B $HOME/.openbox/epistrc
   6 .br
   7 .B @pkgdatadir@/epistrc
   8 .SH DESCRIPTION
   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
  12 .B [Openbox specific]
  13 tag.
  14 .SH SYNTAX
  15 The epistrc file contains 2 sections:
  16 .SS Options
  17 All of the options for epist are contained inside a clause such as this:
  18 .PP
  19 options {
  20 .br
  21         <option name> <option value>;
  22 .br
  23 }
  24 .PP
  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).
  26 .SS Bindings
  27 Bindings are specified in this format:
  28 .PP
  29 <key> <action> <optional parameter>;
  30 .PP
  31 Bindings with chains are specified in this format:
  32 .PP
  33 <root key> {
  34 .br
  35         <key> <action> <optional parameter>;
  36 .br
  37 }
  38 .PP
  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.
  40 .PP
  41 Comments can be added by prefixing the commented line with a "#".
  42 .PP
  43 You may nest as many chains as you want. Some examples of bindings are:
  44 .PP
  45 Mod1-Tab nextWindow;
  46 .br
  47 Mod1-Shift-Tab prevWindow;
  48 .br
  49 Mod1-F1 changeWorkspace 1;
  50 .br
  51 Mod1-F2 changeWorkspace 2;
  52 .br
  53 Control-F1 execute "xterm";
  54 .br
  55 Control-Mod1-x {
  56 .br
  57         i iconify;
  58 .br
  59         r raise;
  60 .br
  61         Mod1-x { l lower; }
  62 .br
  63 }
  64 .SH OPTIONS
  65 .SS stackedCycling (boolean, default=off)
  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 stackedCyclingRaise (boolean, default=off)
  73 This option modifies the window raise behavior when stackedCycling is turned on.
  74 When true, windows will be raised immediatly on focus, rather than when the
  75 keys are released. This may be desirable if you frequently have windows that are
  76 obscured by other windows.
  77 .SS chainTimeout (number, default=3500)
  78 Specifies the period of time after which a started key chain will
  79 be timed out. It takes a number argument specifying the number of
  80 milliseconds to wait. It defaults to 4000.
  81 .SS workspaceColumns (number, default=0, disabled)
  82 Specifies the number of columns of your workspace layout if you are using
  83 your workspaces in a 2-dimensional manner. This option must exist if one of
  84 the prevWorkspaceColumn, prevWorkspaceRow, nextWorkspaceColumn,
  85 nextWorkspaceRow commands are used.
  86 .SH COMMANDS
  87 .SS execute
  88 Runs a shell command. Takes a single string argument, in ""s.
  89 .SS iconify
  90 Iconifies the currently focused window.
  91 .SS raise
  92 Raises the currently focused window to the top of the stacking order.
  93 .SS lower
  94 Lowers the currently focused window to the bottom of the stacking order.
  95 .SS close
  96 Closes the currently focused window.
  97 .SS toggleShade
  98 Shades and Unshades the currently focused window.
  99 .SS toggleOmnipresent
 100 Sends the window to all workspaces, or moves it from all workspaces to the
 101 current one.
 102 .SS moveWindowUp
 103 .SS moveWindowDown
 104 .SS moveWindowLeft
 105 .SS moveWindowRight
 106 Move the window in the specified direction. Takes a single numerical parameter,
 107 which is the amount to move the window.
 108 .SS resizeWindowWidth
 109 .SS resizeWindowHeight
 110 Resizes the window. Takes a single numerical parameter, which is the
 111 amount to resize the window by. A positive number enlarges the window, a
 112 negative value shrinks the window.
 113 .SS toggleMaximizeFull
 114 Maximizes and Unmaxizes the currently focused window.
 115 .SS toggleMaximizeVertical
 116 Maximizes and Unmaxizes the currently focused window vertically.
 117 .SS toggleMaximizeHorizontal
 118 Maximizes and Unmaxizes the currently focused window horizontally.
 119 .SS sendToWorkspace
 120 Sends the currently focused window to another workspace. This takes a single
 121 numberical parameter, which is the workspace to send the window to. Workspace
 122 numbers begin at 1.
 123 .SS nextWindow
 124 .SS prevWindow
 125 Cycles focus to the next/previous window on the workspace. This can take a
 126 single numerical parameter specifying how many windows to cycle through. If
 127 none is specified, a value of 1 is assumed.
 128 .SS nextWindowOnAllWorkspaces
 129 .SS prevWindowOnAllWorkspaces
 130 Cycles focus to the next/previous window on all workspaces, switching between
 131 workspaces as neccessary. This can take a single numerical parameter specifying
 132 how many windows to cycle through. If none is specified, a value of 1 is
 133 assumed.
 134 .SS nextWindowOnAllScreens
 135 .SS prevWindowOnAllScreens
 136 Cycles focus to the next/previous window on all screens (in a multi-head setup).
 137 This can take a single numerical parameter specifying how many windows to cycle
 138 through. If none is specified, a value of 1 is assumed.
 139 .SS nextWindowOfClass
 140 .SS prevWindowOfClass
 141 Cycles focus to the next/previous window of a certain class on the current
 142 workspace. This can take a single string parameter, in ""s, specifying the
 143 class of the window to cycle to. If the parameter is omitted, the class of the
 144 currently focused window is used. This can take a single numerical parameter
 145 specifying how many windows to cycle through. If none is specified, a value of
 146 1 is assumed.
 147 .SS nextWindowOfClassOnAllWorkspaces
 148 .SS prevWindowOfClassOnAllWorkspaces
 149 Cycles focus to the next/previous window of a certain class on all workspaces.
 150 This can take a single string parameter, in ""s, specifying the class of the
 151 window to cycle to. If the parameter is omitted, the class of the currently
 152 focused window is used. This can take a single numerical parameter specifying
 153 how many windows to cycle through. If none is specified, a value of 1 is
 154 assumed.
 155 .SS changeWorkspace
 156 Changes to a specific workspace. This takes a single numerical paramter,
 157 specifying the number of the workspace to switch to. Workspace numbers begin at
 158 1.
 159 .SS nextWorkspace
 160 .SS prevWorkspace
 161 Switches to the next/previous workspace. This can take a single numerical
 162 parameter specifying how many workspaces to cycle through. If none is specified,
 163 a value of 1 is assumed.
 164 .SS nextScreen
 165 .SS prevScreen
 166 Cycles focus to the next/previous screen (in a multi-head setup).
 167 .SS prevWorkspaceColumn
 168 .SS nextWorkspaceColumn
 169 .SS prevWorkspaceRow
 170 .SS nextWorkspaceRow
 171 Used to navigate the workspaces in a 2-dimensional manner. If these commands are
 172 used, the workspaceColumns action must be specified. See OPTIONS.
 173 .SS toggleGrabs
 174 Disables all keybindings except for the binding which runs this action, for
 175 the current screen. Enables keybindings when run again. This command cannot be
 176 part of a chain.
 177
 178 .SS toggleDecorations
 179 .B [Openbox specific]
 180 .br
 181 Toggles whether or not the window decorations are shown on the currently
 182 focused window. (Decorations include the titlebar, borders, and bottom handle.)
 183 .SS showRootMenu
 184 .B [Openbox specific]
 185 .br
 186 Opens the root menu under the mouse pointer.
 187 .SS showWorkspaceMenu
 188 .B [Openbox specific]
 189 .br
 190 Opens the workspace menu under the mouse pointer.
 191
 192 .SH SEE ALSO
 193 \fIepist\fR(1) \fIopenbox\fR(1)