rename uicb_toggletag to uicb_client_toggletag
[awesome.git] / awesome.1
blob997cc59e7588d8b8c1099f18a6b0dcd96f0e6489
1 .TH AWESOME 1 awesome\-VERSION
2 .SH NAME
3 awesome \- awesome window manager
4 .SH SYNOPSIS
5 .B awesome
6 .RB [\ \-v\ |\ \-c\ <configfile>\ ]
7 .SH DESCRIPTION
8 awesome is a window manager for X. It manages windows in different layouts, like
9 floating or tiled. 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 windows which currently need 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 a status text. A
23 floating window is indicated with an empty circle and a maximized
24 floating window is indicated with a circle 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 can draw 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 .TP
36 .B \-c
37 use an alternate configuration file instead of $HOME/.awesomerc
38 .SH USAGE
39 .TP
40 Please read the default configuration file to see mouse and key actions.
41 .SH CUSTOMIZATION
42 awesome is customized by creating a custom $HOME/.awesomerc file.
43 .SH SEE ALSO
44 .BR dmenu (1)
45 .BR dzen2 (1)
46 .SH BUGS
48 Of course there's no bug in awesome. There may be unexpected behaviours.
50 Java applications which use the XToolkit/XAWT backend may draw grey windows
51 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
52 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
53 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
54 can set the following environment variable (to use the older Motif
55 backend instead):
56 .BR AWT_TOOLKIT=MToolkit .
58 Recent GTK 2.10.9+ versions contain a broken
59 .BR Save\-As
60 file dialog implementation,
61 which requests to reconfigure its window size in an endless loop. However, its
62 window is still responsive during this state, so you can simply ignore the flicker
63 until a new GTK version appears, which will fix this bug, approximately
64 GTK 2.10.12+ versions.
65 .SH AUTHORS
66 Julien Danjou <julien@danjou.info>
67 .SH WWW
68 http://awesome.naquadah.org