remove ggdb3 flag
[awesome.git] / awesome.1.txt
blob49f6838ab62bb4b7857f5371a582db867078fb4e
1 awesome(1)
2 ==========
4 NAME
5 ----
7 awesome - awesome window manager
9 SYNOPSIS
10 --------
12 awesome [-v | --version] [-c configuration file]
14 DESCRIPTION
15 -----------
17 +awesome+ is a window manager for X. It manages windows in different layouts, like
18 floating or tiled. Either layout can be applied dynamically, optimizing the
19 environment for the application in use and the task performed.
21 In tiled layout windows are managed in a master and stacking area. The master
22 area contains windows which currently need most attention, whereas the
23 stacking area contains all other windows. In floating layout windows can be
24 resized and moved freely. Dialog windows are always managed floating,
25 regardless of the layout applied.
27 Windows are grouped by tags. Each window can be tagged with one or multiple
28 tags. Selecting certain tags displays all windows with these tags.
30 awesome contains a small status bar which displays all available tags, the layout,
31 the title of the focused window, and a status text. A
32 floating window is indicated with an empty circle and a maximized
33 floating window is indicated with a circle square before the windows
34 title. The selected tags are indicated with a different color. The tags of
35 the focused window are indicated with a filled square in the top left
36 corner. The tags which are applied to one or more windows are indicated
37 with an empty square in the top left corner.
38 awesome can draw a small border around windows to indicate the focus state.
40 OPTIONS
41 -------
42 -v | --version::
43     prints version information to standard output, then exits.
44 -c::
45     use an alternate configuration file instead of $HOME/.awesomerc.
47 DEFAULTS MOUSE BINDINGS
48 -----------------------
49 *Button1* on tag name::
50     View tag.
51 *Mod4 + Button1* on tag name::
52     Tag current client with this tag.
53 *Button3* on tag name::
54     Add this tag to current view.
55 *Mod4 + Button3* on tag name::
56     Toggle this tag for client.
57 *Button4*, *Button5* on tag name::
58     Switch to previous or next tag.
59 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
60     Switch to previous or next layout.
61 *Button4*, *Button5* on root window::
62     Switch to previous or next tag.
63 *Mod4 + Button1* on client window::
64     Move window.
65 *Mod4 + Button2* on client window::
66     Zoom window.
67 *Mod4 + Button3* on client window::
68     Resize window.
70 DEFAULTS KEY BINDINGS
71 ---------------------
72 *Mod4 + Return*::
73     Spawn xterm.
74 *Mod4 + space*::
75     Switch to next layout.
76 *Mod4 \+ Shift \+ space*::
77     Switch to previous layout.
78 *Mod4 + b*::
79     Toggle statusbar.
80 *Mod4 + j*::
81     Focus next client.
82 *Mod4 + k*::
83     Focus previous client.
84 *Mod4 \+ Shift \+ j*::
85     Switch client with next client.
86 *Mod4 \+ Shift \+ k*::
87     Switch client with previous client.
88 *Mod4 \+ Control \+ j*::
89     Focus next screen.
90 *Mod4 \+ Control \+ k*::
91     Focus previous screen.
92 *Mod4 + h*::
93     Decrease master width factor by 5%.
94 *Mod4 + l*::
95     Increase master width factor by 5%.
96 *Mod4 \+ Shift \+ h*::
97     Increase number of master windows by 1.
98 *Mod4 \+ Shift \+ l*::
99     Decrease number of master windows by 1.
100 *Mod4 \+ Control \+ h*::
101     Increase number of column for non-master windows by 1.
102 *Mod4 \+ Control \+ l*::
103     Decrease number of column for non-master windows by 1.
104 *Mod4 + Escape*::
105     View previously selected tag.
106 *Mod4 + Left*::
107     View previous tag.
108 *Mod4 + Right*::
109     View next tag.
110 *Mod4 + m*::
111     Set client maximized.
112 *Mod4 \+ Control \+ Return*::
113     Zoom client.
114 *Mod4 \+ Control \+ space*::
115     Set client floating.
116 *Mod4 \+ Shift \+ c*::
117     Kill client.
118 *Mod4 \+ Shift \+ q*::
119     Quit awesome.
120 *Mod4 \+ Control \+ r*::
121     Restart awesome.
122 *Mod4 + 0-9*::
123     Switch to tag 1-9, 0 for all.
124 *Mod4 \+ Control \+ 0-9*::
125     Toggle tag view.
126 *Mod4 \+ Shift \+ 0-9*::
127     Tag client with tag.
128 *Mod4 \+ Shift \+ Control \+ 0-9*::
129     Toggle tag on client.
131 CUSTOMIZATION
132 -------------
133 awesome is customized by creating a custom $HOME/.awesomerc file.
135 SEE ALSO
136 --------
137 awesomerc(1) dmenu(1) dzen2(1)
139 BUGS
140 ----
141 Of course there's no bug in awesome. But there may be unexpected behaviours.
143 Java applications which use the XToolkit/XAWT backend may draw grey windows
144 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
145 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
146 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
147 can set the following environment variable (to use the older Motif
148 backend instead): AWT_TOOLKIT=MToolkit
150 AUTHORS
151 -------
152 Julien Danjou <julien@danjou.info>
156 http://awesome.naquadah.org