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 ]
   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 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.
  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 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.
  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 .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 There's no keyboard binding by default, please look at the example file.
  56 .SS Mouse commands
  57 .TP
  58 .B Mod1\-Button1
  59 Move current window while dragging (and make it floating if tiled).
  60 .TP
  61 .B Mod1\-Button2
  62 Zooms/cycles current window to/from master area (or tile it if floating).
  63 .TP
  64 .B Mod1\-Button3
  65 Resize current window while dragging (and make it floating if tiled).
  66 .SH CUSTOMIZATION
  67 awesome is customized by creating a custom ~/.awesomerc file.
  68 .SH SEE ALSO
  69 .BR dmenu (1)
  70 .SH BUGS
  71 The status bar may display
  72 .BR "EOF"
  73 when awesome has been started by an X session manager like
  74 .BR xdm (1),
  75 because those close standard output before executing awesome.
  76 .P
  77 Java applications which use the XToolkit/XAWT backend may draw grey windows
  78 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
  79 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
  80 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
  81 can set the following environment variable (to use the older Motif
  82 backend instead):
  83 .BR AWT_TOOLKIT=MToolkit .
  84 .P
  85 Recent GTK 2.10.9+ versions contain a broken
  86 .BR Save\-As
  87 file dialog implementation,
  88 which requests to reconfigure its window size in an endless loop. However, its
  89 window is still respondable during this state, so you can simply ignore the flicker
  90 until a new GTK version appears, which will fix this bug, approximately
  91 GTK 2.10.12+ versions.
  92 .SH AUTHORS
  93 Julien Danjou <julien@danjou.info>
  94 .SH WWW
  95 http://awesome.naquadah.org