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