util/epist/epistrc.5.in

   1 .TH epistrc 4 "August 16, 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.
  10 .SH SYNTAX
  11 The epistrc file contains 2 sections:
  12 .SS options
  13 All of the options for epist are contained inside a clause such as this:
  14 .br
  15 options {
  16 .br
  17         blef 5;
  18 .br
  19 }
  20 .SS bindings
  21 Bindings are specified in this format:
  22 .br
  23 <key> <action> <optional parameter>;
  24 .PP
  25 Bindings with chains are specified in this format:
  26 .br
  27 <root key> {
  28 .br
  29         <key> <action> <optional parameter>;
  30 .br
  31 }
  32 .PP
  33 The <key> is made up of a list of modifiers and a single key. The possible modifiers are: \fIControl\fR, \fIShift\fR, \fRMod1\fI (usually the Alt key), \fRMod2\fI, \fRMod3\fI, \fRMod4\fI (usually the "windows" key), and \fRMod5\fI. You may also specify a <key> without any modifiers.
  34 .PP
  35 You may also nest as many chains as you want. Some examples of bindings are:
  36 .br
  37 Mod1-Tab nextWindow;
  38 .br
  39 Mod1-Shift-Tab prevWindow;
  40 .br
  41 Mod1-F1 changeWorkspace 1;
  42 .br
  43 Mod1-F2 changeWorkspace 2;
  44 .br
  45 Control-F1 execute "xterm";
  46 .br
  47 Control-Mod1-x {
  48 .br
  49         i iconify;
  50 .br
  51         r raise;
  52 .br
  53         l lower;
  54 .br
  55 }
  56 .SH COMMANDS
  57 .SS execute
  58 Runs a shell command. Takes a single string argument, in ""s.
  59 .SS iconify
  60 Iconifies the currently focused window.
  61 .SS raise
  62 Raises the currently focused window to the top of the stacking order.
  63 .SS lower
  64 Lowers the currently focused window to the bottom of the stacking order.
  65 .SS close
  66 Closes the currently focused window.
  67 .SS toggleshade
  68 Shades and Unshades the currently focused window.
  69 .SS toggleomnipresent
  70 Sends the window to all workspaces, or moves it from all workspaces to the
  71 current one.
  72 .SS moveWindowUp
  73 Move the window up. Takes a single numerical parameter, which is the amount to
  74 move the window.
  75 .SS moveWindowDown
  76 Move the window down. Takes a single numerical parameter, which is the amount to
  77 move the window.
  78 .SS moveWindowLeft
  79 Move the window left. Takes a single numerical parameter, which is the amount to
  80 move the window.
  81 .SS moveWindowRight
  82 Move the window right. Takes a single numerical parameter, which is the amount
  83 to move the window.
  84 .SS resizeWindowWidth
  85 Resizes the window's width. Takes a single numerical parameter, which is the
  86 amount to resize the window by. A positive number enlarges the window, a
  87 negative value shrinks the window.
  88 .SS resizeWindowHeight
  89 Resizes the window's height. Takes a single numerical parameter, which is the
  90 amount to resize the window by. A positive number enlarges the window, a
  91 negative value shrinks the window.
  92 .SS toggleMaximizeFull
  93 Maximizes and Unmaxizes the currently focused window.
  94 .SS toggleMaximizeVertical
  95 Maximizes and Unmaxizes the currently focused window vertically.
  96 .SS toggleMaximizeHorizontal
  97 Maximizes and Unmaxizes the currently focused window horizontally.
  98 .SS sendToWorkspace
  99 Sends the currently focused window to another workspace. This takes a single
 100 numberical parameter, which is the workspace to send the window to. Workspace
 101 numbers begin at 1.
 102 .SS nextWindow
 103 Cycles focus to the next window on the workspace.
 104 .SS prevWindow
 105 Cycles focus to the previous window on the workspace.
 106 .SS nextWindowOnAllWorkspaces
 107 Cycles focus to the next window on all workspaces, switching between workspaces
 108 as neccessary.
 109 .SS prevWindowOnAllWorkspaces
 110 Cycles focus to the previous window on all workspaces, switching between
 111 workspaces as neccessary.
 112 .SS nextWindowOnAllScreens
 113 Cycles focus to the next window on all screens (in a multi-head setup).
 114 .SS prevWindowOnAllScreens
 115 Cycles focus to the previous window on all screens (in a multi-head setup).
 116 .SS nextWindowOfClass
 117 Cycles focus to the next window of a certain class on the current workspace.
 118 This can take a single string parameter, in ""s, specifying the class of the
 119 window to cycle to. If the parameter is omitted, the class of the currently
 120 focused window is used.
 121 .SS prevWindowOfClass
 122 Cycles focus to the previous window of a certain class on the current workspace.
 123 This can take a single string parameter, in ""s, specifying the class of the
 124 window to cycle to. If the parameter is omitted, the class of the currently
 125 focused window is used.
 126 .SS nextWindowOfClassOnAllWorkspaces
 127 Cycles focus to the next window of a certain class on all workspaces. This can
 128 take a single string parameter, in ""s, specifying the class of the window to
 129 cycle to. If the parameter is omitted, the class of the currently focused
 130 window is used.
 131 .SS prevWindowOfClassOnAllWorkspaces
 132 Cycles focus to the previous window of a certain class on all workspaces. This
 133 can take a single string parameter, in ""s, specifying the class of the window
 134 to cycle to. If the parameter is omitted, the class of the currently focused
 135 window is used.
 136 .SS changeWorkspace
 137 Changes to a specific workspace. This takes a single numerical paramter,
 138 specifying the number of the workspace to switch to. Workspace numbers begin at
 139 1.
 140 .SS nextWorkspace
 141 Switches to the next workspace.
 142 .SS prevWorkspace
 143 Switches to the previous workspace.
 144 .SS nextScreen
 145 Cycles focus to the next screen (in a multi-head setup).
 146 .SS prevScreen
 147 Cycles focus to the previous screen (in a multi-head setup).
 148
 149 .SH SEE ALSO
 150 \fIepist\fR(1) \fIopenbox\fR(1)