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