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