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 or a number.
  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 chainTimeout
  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.
  69 .SS workspaceColumns
  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.
  74 .SH COMMANDS
  75 .SS execute
  76 Runs a shell command. Takes a single string argument, in ""s.
  77 .SS iconify
  78 Iconifies the currently focused window.
  79 .SS raise
  80 Raises the currently focused window to the top of the stacking order.
  81 .SS lower
  82 Lowers the currently focused window to the bottom of the stacking order.
  83 .SS close
  84 Closes the currently focused window.
  85 .SS toggleShade
  86 Shades and Unshades the currently focused window.
  87 .SS toggleOmnipresent
  88 Sends the window to all workspaces, or moves it from all workspaces to the
  89 current one.
  90 .SS moveWindowUp
  91 .SS moveWindowDown
  92 .SS moveWindowLeft
  93 .SS moveWindowRight
  94 Move the window in the specified direction. Takes a single numerical parameter,
  95 which is the amount to move the window.
  96 .SS resizeWindowWidth
  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.
 107 .SS sendToWorkspace
 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
 110 numbers begin at 1.
 111 .SS nextWindow
 112 .SS prevWindow
 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
 121 assumed.
 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
 134 1 is assumed.
 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
 142 assumed.
 143 .SS changeWorkspace
 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
 146 1.
 147 .SS nextWorkspace
 148 .SS prevWorkspace
 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.
 152 .SS nextScreen
 153 .SS prevScreen
 154 Cycles focus to the next/previous screen (in a multi-head setup).
 155 .SS prevWorkspaceColumn
 156 .SS nextWorkspaceColumn
 157 .SS prevWorkspaceRow
 158 .SS nextWorkspaceRow
 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.
 161 .SS toggleGrabs
 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
 164 part of a chain.
 165
 166 .SS toggleDecorations
 167 .B [Openbox specific]
 168 .br
 169 Toggles whether or not the window decorations are shown on the currently
 170 focused window. (Decorations include the titlebar, borders, and bottom handle.)
 171 .SS showRootMenu
 172 .B [Openbox specific]
 173 .br
 174 Opens the root menu under the mouse pointer.
 175 .SS showWorkspaceMenu
 176 .B [Openbox specific]
 177 .br
 178 Opens the workspace menu under the mouse pointer.
 179
 180 .SH SEE ALSO
 181 \fIepist\fR(1) \fIopenbox\fR(1)