1 .\" Title: awesome
2 .\" Author:
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\" Date: 09/28/2009
5 .\" Manual:
6 .\" Source:
7 .\"
8 .TH "AWESOME" "1" "09/28/2009" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 awesome - awesome window manager
15 .SH "SYNOPSIS"
16 \fBawesome\fR [\fB\-v\fR | \fB\-\-version\fR] [\fB\-h\fR | \fB\-\-help\fR] [\fB\-c\fR | \fB\-\-config\fR \fIFILE\fR] [\fB\-k\fR | \fB\-\-check\fR]
17 .sp
18 .SH "DESCRIPTION"
19 \fBawesome\fR is a window manager for X\. It manages windows in different layouts, like floating or tiled\. Either layout can be applied dynamically, optimizing the environment for the application in use and the task performed\.
20 .sp
21 In tiled layout, windows are managed in a master and stacking area\. The master area contains the windows which currently need most attention, whereas the stacking area contains all other windows\. In floating layout windows can be resized and moved freely\. Dialog windows are always managed floating, regardless of the layout applied\. The spiral and dwindle layout are special cases of the tiled layout where the stacking area is arranged in a spiral for the former or as a rectangular fractal for the later\.
22 .sp
23 Windows are grouped by tags\. Each window can be tagged with one or multiple tags\. Selecting certain tags displays all windows with these tags\.
24 .sp
25 \fBawesome\fR can contain small wiboxes which can display anything you want: all available tags, the layout, the title of the visible windows, a text, etc\.
26 .sp
27 .SH "OPTIONS"
28 .PP
29 \fB\-v\fR, \fB\-\-version\fR
30 .RS 4
31 Print version information to standard output, then exit\.
32 .RE
33 .PP
34 \fB\-h\fR, \fB\-\-help\fR
35 .RS 4
36 Print help information, then exit\.
37 .RE
38 .PP
39 \fB\-c\fR, \fB\-\-config\fR \fIFILE\fR
40 .RS 4
41 Use an alternate configuration file instead of
42 \fI$XDG_CONFIG_HOME/awesome/rc\.lua\fR\.
43 .RE
44 .PP
45 \fB\-k\fR, \fB\-\-check\fR
46 .RS 4
47 Check configuration file syntax\.
48 .RE
49 .SH "DEFAULT MOUSE BINDINGS"
50 .SS "Navigation"
51 .PP
52 \fBButton1\fR on tag name
53 .RS 4
54 View tag\.
55 .RE
56 .PP
57 \fBButton4\fR, \fBButton5\fR on tag name
58 .RS 4
59 Switch to previous or next tag\.
60 .RE
61 .PP
62 \fBButton4\fR, \fBButton5\fR on root window
63 .RS 4
64 Switch to previous or next tag\.
65 .RE
66 .PP
67 \fBButton1\fR, \fBButton3\fR, \fBButton4\fR, \fBButton5\fR on layout symbol
68 .RS 4
69 Switch to previous or next layout\.
70 .RE
71 .SS "Layout modification"
72 .PP
73 \fBMod4 \e+ Button1\fR on tag name
74 .RS 4
75 Tag current client with this tag only\.
76 .RE
77 .PP
78 \fBMod4 \e+ Button3\fR on tag name
79 .RS 4
80 Toggle this tag for client\.
81 .RE
82 .PP
83 \fBButton3\fR on tag name
84 .RS 4
85 Add this tag to current view\.
86 .RE
87 .PP
88 \fBMod4 \e+ Button1\fR on client window
89 .RS 4
90 Move window\.
91 .RE
92 .PP
93 \fBMod4 \e+ Button3\fR on client window
94 .RS 4
95 Resize window\.
96 .RE
97 .SH "DEFAULT KEY BINDINGS"
98 .SS "Window manager control"
99 .PP
100 \fBMod4 \e+ Control \e+ r\fR
101 .RS 4
102 Restart
103 \fBawesome\fR\.
104 .RE
105 .PP
106 \fBMod4 \e+ Shift \e+ q\fR
107 .RS 4
108 Quit
109 \fBawesome\fR\.
110 .RE
111 .PP
112 \fBMod4 \e+ r\fR
113 .RS 4
114 Run prompt\.
115 .RE
116 .PP
117 \fBMod4 \e+ x\fR
118 .RS 4
119 Run Lua code prompt\.
120 .RE
121 .PP
122 \fBMod4 \e+ Return\fR
123 .RS 4
124 Spawn terminal emulator\.
125 .RE
126 .PP
127 \fBMod4 \e+ w\fR
128 .RS 4
129 Open main menu\.
130 .RE
131 .SS "Clients"
132 .PP
133 \fBMod4 \e+ Shift \e+ r\fR
134 .RS 4
135 Redraw the focused window\.
136 .RE
137 .PP
138 \fBMod4 \e+ m\fR
139 .RS 4
140 Maximize client\.
141 .RE
142 .PP
143 \fBMod4 \e+ f\fR
144 .RS 4
145 Set client fullscreen\.
146 .RE
147 .PP
148 \fBMod4 \e+ Shift \e+ c\fR
149 .RS 4
150 Kill focused client\.
151 .RE
152 .PP
153 \fBMod4 \e+ t\fR
154 .RS 4
155 Mark a client\.
156 .RE
157 .SS "Navigation"
158 .PP
159 \fBMod4 \e+ j\fR
160 .RS 4
161 Focus next client\.
162 .RE
163 .PP
164 \fBMod4 \e+ k\fR
165 .RS 4
166 Focus previous client\.
167 .RE
168 .PP
169 \fBMod4 \e+ u\fR
170 .RS 4
171 Focus first urgent client\.
172 .RE
173 .PP
174 \fBMod4 \e+ Left\fR
175 .RS 4
176 View previous tag\.
177 .RE
178 .PP
179 \fBMod4 \e+ Right\fR
180 .RS 4
181 View next tag\.
182 .RE
183 .PP
184 \fBMod4 \e+ 1\-9\fR
185 .RS 4
186 Switch to tag 1\-9\.
187 .RE
188 .PP
189 \fBMod4 \e+ Control \e+ j\fR
190 .RS 4
191 Focus next screen\.
192 .RE
193 .PP
194 \fBMod4 \e+ Control \e+ k\fR
195 .RS 4
196 Focus previous screen\.
197 .RE
198 .PP
199 \fBMod4 \e+ Escape\fR
200 .RS 4
201 Focus previously selected tag set\.
202 .RE
203 .SS "Layout modification"
204 .PP
205 \fBMod4 \e+ Shift \e+ j\fR
206 .RS 4
207 Switch client with next client\.
208 .RE
209 .PP
210 \fBMod4 \e+ Shift \e+ k\fR
211 .RS 4
212 Switch client with previous client\.
213 .RE
214 .PP
215 \fBMod4 \e+ o\fR
216 .RS 4
217 Send client to next screen\.
218 .RE
219 .PP
220 \fBMod4 \e+ h\fR
221 .RS 4
222 Decrease master width factor by 5%\.
223 .RE
224 .PP
225 \fBMod4 \e+ l\fR
226 .RS 4
227 Increase master width factor by 5%\.
228 .RE
229 .PP
230 \fBMod4 \e+ Shift \e+ h\fR
231 .RS 4
232 Increase number of master windows by 1\.
233 .RE
234 .PP
235 \fBMod4 \e+ Shift \e+ l\fR
236 .RS 4
237 Decrease number of master windows by 1\.
238 .RE
239 .PP
240 \fBMod4 \e+ Control \e+ h\fR
241 .RS 4
242 Increase number of columns for non\-master windows by 1\.
243 .RE
244 .PP
245 \fBMod4 \e+ Control \e+ l\fR
246 .RS 4
247 Decrease number of columns for non\-master windows by 1\.
248 .RE
249 .PP
250 \fBMod4 \e+ space\fR
251 .RS 4
252 Switch to next layout\.
253 .RE
254 .PP
255 \fBMod4 \e+ Shift \e+ space\fR
256 .RS 4
257 Switch to previous layout\.
258 .RE
259 .PP
260 \fBMod4 \e+ Control \e+ space\fR
261 .RS 4
262 Toggle client floating status\.
263 .RE
264 .PP
265 \fBMod4 \e+ Control \e+ Return\fR
266 .RS 4
267 Swap focused client with master\.
268 .RE
269 .PP
270 \fBMod4 \e+ Control \e+ 1\-9\fR
271 .RS 4
272 Toggle tag view\.
273 .RE
274 .PP
275 \fBMod4 \e+ Shift \e+ 1\-9\fR
276 .RS 4
277 Tag client with tag\.
278 .RE
279 .PP
280 \fBMod4 \e+ Shift \e+ Control \e+ 1\-9\fR
281 .RS 4
282 Toggle tag on client\.
283 .RE
284 .PP
285 \fBMod4 \e+ Shift \e+ F1\-9\fR
286 .RS 4
287 Tag marked clients with tag\.
288 .RE
289 .SH "CUSTOMIZATION"
290 \fBawesome\fR is customized by creating a custom \fI$XDG_CONFIG_HOME/awesome/rc\.lua\fR file\.
291 .sp
292 .SH "SIGNALS"
293 \fBawesome\fR can be restarted by sending it a SIGHUP\.
294 .sp
295 .SH "SEE ALSO"
296 \fBawesomerc\fR(5) \fBawesome\-client\fR(1)
297 .sp
298 .SH "BUGS"
299 Of course there\(cqs no bug in \fBawesome\fR\. But there may be unexpected behaviors\.
300 .sp
301 Java applications which use the XToolkit/XAWT backend may draw gray windows only\. The XToolkit/XAWT backend breaks ICCCM\-compliance in recent JDK 1\.5 and early JDK 1\.6 versions because it assumes a reparenting window manager\. As a workaround you can use JDK 1\.4 (which doesn\(cqt contain the XToolkit/XAWT backend), or you can set the following environment variable (to use the older Motif backend instead): AWT_TOOLKIT=MToolkit
302 .sp
303 .SH "AUTHORS"
304 Julien Danjou <\fIjulien@danjou\.info\fR\&[1]> and others\.
305 .sp
306 .SH "WWW"
307 \fIhttp://awesome\.naquadah\.org\fR
308 .sp
309 .SH "NOTES"
310 .IP " 1." 4
311 julien@danjou.info
312 .RS 4
313 \%mailto:julien@danjou.info
314 .RE
|
