util/epist/epistrc.5.in

   1 .TH epistrc 5 "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, \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.
  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 .SS moveWindowDown
  76 .SS moveWindowLeft
  77 .SS moveWindowRight
  78 Move the window in the specified direction. Takes a single numerical parameter,
  79 which is the amount to move the window.
  80 .SS resizeWindowWidth
  81 .SS resizeWindowHeight
  82 Resizes the window. Takes a single numerical parameter, which is the
  83 amount to resize the window by. A positive number enlarges the window, a
  84 negative value shrinks the window.
  85 .SS toggleMaximizeFull
  86 Maximizes and Unmaxizes the currently focused window.
  87 .SS toggleMaximizeVertical
  88 Maximizes and Unmaxizes the currently focused window vertically.
  89 .SS toggleMaximizeHorizontal
  90 Maximizes and Unmaxizes the currently focused window horizontally.
  91 .SS sendToWorkspace
  92 Sends the currently focused window to another workspace. This takes a single
  93 numberical parameter, which is the workspace to send the window to. Workspace
  94 numbers begin at 1.
  95 .SS nextWindow
  96 .SS prevWindow
  97 Cycles focus to the next/previous window on the workspace. This can take a
  98 single numerical parameter specifying how many windows to cycle through. If
  99 none is specified, a value of 1 is assumed.
 100 .SS nextWindowOnAllWorkspaces
 101 .SS prevWindowOnAllWorkspaces
 102 Cycles focus to the next/previous window on all workspaces, switching between
 103 workspaces as neccessary. This can take a single numerical parameter specifying
 104 how many windows to cycle through. If none is specified, a value of 1 is
 105 assumed.
 106 .SS nextWindowOnAllScreens
 107 .SS prevWindowOnAllScreens
 108 Cycles focus to the next/previous window on all screens (in a multi-head setup).
 109 This can take a single numerical parameter specifying how many windows to cycle
 110 through. If none is specified, a value of 1 is assumed.
 111 .SS nextWindowOfClass
 112 .SS prevWindowOfClass
 113 Cycles focus to the next/previous window of a certain class on the current
 114 workspace. This can take a single string parameter, in ""s, specifying the
 115 class of the window to cycle to. If the parameter is omitted, the class of the
 116 currently focused window is used. This can take a single numerical parameter
 117 specifying how many windows to cycle through. If none is specified, a value of
 118 1 is assumed.
 119 .SS nextWindowOfClassOnAllWorkspaces
 120 .SS prevWindowOfClassOnAllWorkspaces
 121 Cycles focus to the next/previous window of a certain class on all workspaces.
 122 This can take a single string parameter, in ""s, specifying the class of the
 123 window to cycle to. If the parameter is omitted, the class of the currently
 124 focused window is used. This can take a single numerical parameter specifying
 125 how many windows to cycle through. If none is specified, a value of 1 is
 126 assumed.
 127 .SS changeWorkspace
 128 Changes to a specific workspace. This takes a single numerical paramter,
 129 specifying the number of the workspace to switch to. Workspace numbers begin at
 130 1.
 131 .SS nextWorkspace
 132 .SS prevWorkspace
 133 Switches to the next/previous workspace. This can take a single numerical
 134 parameter specifying how many workspaces to cycle through. If none is specified,
 135 a value of 1 is assumed.
 136 .SS nextScreen
 137 .SS prevScreen
 138 Cycles focus to the next/previous screen (in a multi-head setup).
 139
 140 .SH SEE ALSO
 141 \fIepist\fR(1) \fIopenbox\fR(1)