bug fix: move/resize with tiled windows
[awesome.git] / awesome.1
blobf5b9bd6f123c90ced7f2b06127e30b6d00216526
1 .TH AWESOME 1 awesome\-VERSION
2 .SH NAME
3 awesome \- awesome window manager
4 .SH SYNOPSIS
5 .B awesome
6 .RB [ \-v ]
7 .SH DESCRIPTION
8 awesome is a dynamic window manager for X. It manages windows in tiled and
9 floating layouts. Either layout can be applied dynamically, optimizing the
10 environment for the application in use and the task performed.
12 In tiled layout windows are managed in a master and stacking area. The master
13 area contains the window which currently needs most attention, whereas the
14 stacking area contains all other windows. In floating layout windows can be
15 resized and moved freely. Dialog windows are always managed floating,
16 regardless of the layout applied.
18 Windows are grouped by tags. Each window can be tagged with one or multiple
19 tags. Selecting certain tags displays all windows with these tags.
21 awesome contains a small status bar which displays all available tags, the layout,
22 the title of the focused window, and the text read from standard input. A
23 floating window is indicated with an empty square and a maximized
24 floating window is indicated with a filled square before the windows
25 title.  The selected tags are indicated with a different color. The tags of
26 the focused window are indicated with a filled square in the top left
27 corner.  The tags which are applied to one or more windows are indicated
28 with an empty square in the top left corner.
30 awesome draws a small border around windows to indicate the focus state.
31 .SH OPTIONS
32 .TP
33 .B \-v
34 prints version information to standard output, then exits.
35 .SH USAGE
36 .SS Status bar
37 .TP
38 .B Standard input
39 is read and displayed in the status text area.
40 .TP
41 .B Button1
42 click on a tag label to display all windows with that tag, click on the layout
43 label toggles between tiled and floating layout.
44 .TP
45 .B Button3
46 click on a tag label adds/removes all windows with that tag to/from the view.
47 .TP
48 .B Mod1\-Button1
49 click on a tag label applies that tag to the focused window.
50 .TP
51 .B Mod1\-Button3
52 click on a tag label adds/removes that tag to/from the focused window.
53 .SS Keyboard commands
54 .TP
55 .B Mod1\-Shift\-Return
56 Start
57 .BR xterm.
58 .TP
59 .B Mod1\-Return
60 Zooms/cycles current window to/from master area (tiled layout only).
61 .TP
62 .B Mod1\-b
63 Shows/hides the status bar.
64 .TP
65 .B Mod1\-h
66 Decreases the master area width about 5% (tiled layout only).
67 .TP
68 .B Mod1\-j
69 Focus next window.
70 .TP
71 .B Mod1\-k
72 Focus previous window.
73 .TP
74 .B Mod1\-l
75 Increases the master area width about 5% (tiled layout only).
76 .TP
77 .B Mod1\-m
78 Toggles maximization of current window (floating layout only).
79 .TP
80 .B Mod1\-Shift\-[1..n]
81 Apply
82 .RB nth
83 tag to current window.
84 .TP
85 .B Mod1\-Shift\-0
86 Apply all tags to current window.
87 .TP
88 .B Mod1\-Control\-Shift\-[1..n]
89 Add/remove
90 .B nth
91 tag to/from current window.
92 .TP
93 .B Mod1\-Shift\-c
94 Close focused window.
95 .TP
96 .B Mod1\-space
97 Toggle between tiled and floating layout (affects all windows).
98 .TP
99 .B Mod1\-Shift\-space
100 Toggle focused window between tiled and floating state (tiled layout only).
102 .B Mod1\-[1..n]
103 View all windows with
104 .BR nth
105 tag.
107 .B Mod1\-0
108 View all windows with any tag.
110 .B Mod1\-Control\-[1..n]
111 Add/remove all windows with
112 .BR nth
113 tag to/from the view.
115 .B Mod1\-Shift\-q
116 Quit awesome.
117 .SS Mouse commands
119 .B Mod1\-Button1
120 Move current window while dragging (floating layout only).
122 .B Mod1\-Button2
123 Zooms/cycles current window to/from master area (tiled layout only).
125 .B Mod1\-Button3
126 Resize current window while dragging (floating layout only).
127 .SH CUSTOMIZATION
128 awesome is customized by creating a custom ~/.awesomerc
129 .SH SEE ALSO
130 .BR dmenu (1)
131 .SH BUGS
132 The status bar may display
133 .BR "EOF"
134 when awesome has been started by an X session manager like
135 .BR xdm (1),
136 because those close standard output before executing awesome.
138 Java applications which use the XToolkit/XAWT backend may draw grey windows
139 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
140 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
141 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
142 can set the following environment variable (to use the older Motif
143 backend instead):
144 .BR AWT_TOOLKIT=MToolkit .
146 Recent GTK 2.10.9+ versions contain a broken
147 .BR Save\-As
148 file dialog implementation,
149 which requests to reconfigure its window size in an endless loop. However, its
150 window is still respondable during this state, so you can simply ignore the flicker
151 until a new GTK version appears, which will fix this bug, approximately
152 GTK 2.10.12+ versions.