rename draw_get_context() to draw_context_new()
[awesome.git] / awesome.1.txt
blobbfc951b9d2e16beee29b4385b4a7b640422d49aa
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. The spiral and dwindle layout are special cases
26 of the tiled layout where the stacking area is arranged in a spiral for the
27 former or as a rectangular fractal for the later.
29 Windows are grouped by tags. Each window can be tagged with one or multiple
30 tags. Selecting certain tags displays all windows with these tags.
32 awesome contains a small status bar which displays all available tags, the layout,
33 the title of the focused window, and a status text. A
34 floating window is indicated with an empty circle and a maximized
35 floating window is indicated with a circle square before the windows
36 title. The selected tags are indicated with a different color. The tags of
37 the focused window are indicated with a filled square in the top left
38 corner. The tags which are applied to one or more windows are indicated
39 with an empty square in the top left corner.
40 awesome can draw a small border around windows to indicate the focus state.
42 OPTIONS
43 -------
44 -v | --version::
45     prints version information to standard output, then exits.
46 -c::
47     use an alternate configuration file instead of $HOME/.awesomerc.
49 DEFAULTS MOUSE BINDINGS
50 -----------------------
51 *Button1* on tag name::
52     View tag.
53 *Mod4 + Button1* on tag name::
54     Tag current client with this tag.
55 *Button3* on tag name::
56     Add this tag to current view.
57 *Mod4 + Button3* on tag name::
58     Toggle this tag for client.
59 *Button4*, *Button5* on tag name::
60     Switch to previous or next tag.
61 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
62     Switch to previous or next layout.
63 *Button4*, *Button5* on root window::
64     Switch to previous or next tag.
65 *Mod4 + Button1* on client window::
66     Move window.
67 *Mod4 + Button2* on client window::
68     Zoom window.
69 *Mod4 + Button3* on client window::
70     Resize window.
72 DEFAULTS KEY BINDINGS
73 ---------------------
74 *Mod4 + Return*::
75     Spawn xterm.
76 *Mod4 + space*::
77     Switch to next layout.
78 *Mod4 \+ Shift \+ space*::
79     Switch to previous layout.
80 *Mod4 + b*::
81     Toggle statusbar.
82 *Mod4 + j*::
83     Focus next client.
84 *Mod4 + k*::
85     Focus previous client.
86 *Mod4 \+ Shift \+ j*::
87     Switch client with next client.
88 *Mod4 \+ Shift \+ k*::
89     Switch client with previous client.
90 *Mod4 \+ Control \+ j*::
91     Focus next screen.
92 *Mod4 \+ Control \+ k*::
93     Focus previous screen.
94 *Mod4 + h*::
95     Decrease master width factor by 5%.
96 *Mod4 + l*::
97     Increase master width factor by 5%.
98 *Mod4 \+ Shift \+ h*::
99     Increase number of master windows by 1.
100 *Mod4 \+ Shift \+ l*::
101     Decrease number of master windows by 1.
102 *Mod4 \+ Control \+ h*::
103     Increase number of column for non-master windows by 1.
104 *Mod4 \+ Control \+ l*::
105     Decrease number of column for non-master windows by 1.
106 *Mod4 + Escape*::
107     View previously selected tag.
108 *Mod4 + Left*::
109     View previous tag.
110 *Mod4 + Right*::
111     View next tag.
112 *Mod4 + m*::
113     Set client maximized.
114 *Mod4 \+ Control \+ Return*::
115     Zoom client.
116 *Mod4 \+ Control \+ space*::
117     Set client floating.
118 *Mod4 \+ Shift \+ c*::
119     Kill client.
120 *Mod4 \+ Shift \+ q*::
121     Quit awesome.
122 *Mod4 \+ Control \+ r*::
123     Restart awesome.
124 *Mod4 + 0-9*::
125     Switch to tag 1-9, 0 for all.
126 *Mod4 \+ Control \+ 0-9*::
127     Toggle tag view.
128 *Mod4 \+ Shift \+ 0-9*::
129     Tag client with tag.
130 *Mod4 \+ Shift \+ Control \+ 0-9*::
131     Toggle tag on client.
133 CUSTOMIZATION
134 -------------
135 awesome is customized by creating a custom $HOME/.awesomerc file.
137 SEE ALSO
138 --------
139 awesomerc(1) dmenu(1) dzen2(1)
141 BUGS
142 ----
143 Of course there's no bug in awesome. But there may be unexpected behaviours.
145 Java applications which use the XToolkit/XAWT backend may draw grey windows
146 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
147 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
148 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
149 can set the following environment variable (to use the older Motif
150 backend instead): AWT_TOOLKIT=MToolkit
152 AUTHORS
153 -------
154 Julien Danjou <julien@danjou.info>
158 http://awesome.naquadah.org