awesome.1

   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 tiled and
   9 floating layouts. Either layout can be applied dynamically, optimizing the
  10 environment for the application in use and the task performed.
  11 .P
  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.
  17 .P
  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.
  20 .P
  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.
  29 .P
  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 .SS Status bar
  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 Button4 or Button5 (mouse wheel)
  49 use mouse wheel on tags to switch them, on layout to switch them or in title bar to
  50 cycle between clients.
  51 .TP
  52 .B Modkey\-Button1
  53 click on a tag label applies that tag to the focused window.
  54 .TP
  55 .B Modkey\-Button3
  56 click on a tag label adds/removes that tag to/from the focused window.
  57 .SS Keyboard commands
  58 .TP
  59 There's no keyboard binding by default, please look at the example file.
  60 .SS Mouse commands
  61 .TP
  62 .B Modkey\-Button1
  63 Move current window while dragging (and make it floating if tiled).
  64 .TP
  65 .B Modkey\-Button2
  66 Zooms/cycles current window to/from master area (or tile it if floating).
  67 .TP
  68 .B Modkey\-Button3
  69 Resize current window while dragging (and make it floating if tiled).
  70 .SH CUSTOMIZATION
  71 awesome is customized by creating a custom $HOME/.awesomerc file.
  72 .SH SEE ALSO
  73 .BR dmenu (1)
  74 .BR dzen2 (1)
  75 .SH BUGS
  76 .P
  77 Of course there's no bug in awesome. There may be unexpected behaviours.
  78 .P
  79 Java applications which use the XToolkit/XAWT backend may draw grey windows
  80 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
  81 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
  82 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
  83 can set the following environment variable (to use the older Motif
  84 backend instead):
  85 .BR AWT_TOOLKIT=MToolkit .
  86 .P
  87 Recent GTK 2.10.9+ versions contain a broken
  88 .BR Save\-As
  89 file dialog implementation,
  90 which requests to reconfigure its window size in an endless loop. However, its
  91 window is still responsive during this state, so you can simply ignore the flicker
  92 until a new GTK version appears, which will fix this bug, approximately
  93 GTK 2.10.12+ versions.
  94 .SH AUTHORS
  95 Julien Danjou <julien@danjou.info>
  96 .SH WWW
  97 http://awesome.naquadah.org