awesome.1.txt

   1 awesome(1)
   2 ==========
   3
   4 NAME
   5 ----
   6
   7 awesome - awesome window manager
   8
   9 SYNOPSIS
  10 --------
  11
  12 awesome [ -v | --version ] [ -h | --help ] [ -k | --check ] [ -s | --sync ] [ --config | -c configuration file ]
  13
  14 DESCRIPTION
  15 -----------
  16
  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.
  20
  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.
  28
  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.
  31
  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.
  41
  42 OPTIONS
  43 -------
  44 -v | --version::
  45     Prints version information to standard output, then exits.
  46 -h | --help::
  47     Prints help information, then exits.
  48 --config | -c::
  49     Use an alternate configuration file instead of $HOME/.awesomerc.
  50 --check | -k::
  51     Check configuration file syntax.
  52 --sync | -s::
  53     Enable X11 synchronization mode. All X11 calls will be synchronized,
  54     so you can break on exit to retrieve a backtrace of X errors.
  55
  56 DEFAULTS MOUSE BINDINGS
  57 -----------------------
  58 *Button1* on tag name::
  59     View tag.
  60 *Mod4 + Button1* on tag name::
  61     Tag current client with this tag.
  62 *Button3* on tag name::
  63     Add this tag to current view.
  64 *Mod4 + Button3* on tag name::
  65     Toggle this tag for client.
  66 *Button4*, *Button5* on tag name::
  67     Switch to previous or next tag.
  68 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  69     Switch to previous or next layout.
  70 *Button4*, *Button5* on root window::
  71     Switch to previous or next tag.
  72 *Mod4 + Button1* on client window::
  73     Move window.
  74 *Mod4 + Button2* on client window::
  75     Zoom window.
  76 *Mod4 + Button3* on client window::
  77     Resize window.
  78
  79 DEFAULTS KEY BINDINGS
  80 ---------------------
  81 *Mod4 + F1*::
  82     Spawn awesome-menu to read manual pages.
  83 *Mod4 + F2*::
  84     Spawn awesome-menu to execute a program.
  85 *Mod4 + F3*::
  86     Spawn awesome-menu to ssh to an host.
  87 *Mod4 + Return*::
  88     Spawn terminal emulator.
  89 *Mod4 + space*::
  90     Switch to next layout.
  91 *Mod4 \+ Shift \+ space*::
  92     Switch to previous layout.
  93 *Mod4 + b*::
  94     Toggle statusbar.
  95 *Mod4 + j*::
  96     Focus next client.
  97 *Mod4 + k*::
  98     Focus previous client.
  99 *Mod4 \+ Shift \+ j*::
 100     Switch client with next client.
 101 *Mod4 \+ Shift \+ k*::
 102     Switch client with previous client.
 103 *Mod4 \+ Control \+ j*::
 104     Focus next screen.
 105 *Mod4 \+ Control \+ k*::
 106     Focus previous screen.
 107 *Mod4 + h*::
 108     Decrease master width factor by 5%.
 109 *Mod4 + l*::
 110     Increase master width factor by 5%.
 111 *Mod4 \+ Shift \+ h*::
 112     Increase number of master windows by 1.
 113 *Mod4 \+ Shift \+ l*::
 114     Decrease number of master windows by 1.
 115 *Mod4 \+ Control \+ h*::
 116     Increase number of column for non-master windows by 1.
 117 *Mod4 \+ Control \+ l*::
 118     Decrease number of column for non-master windows by 1.
 119 *Mod4 + Escape*::
 120     View previously selected tag.
 121 *Mod4 + Left*::
 122     View previous tag.
 123 *Mod4 + Right*::
 124     View next tag.
 125 *Mod4 + m*::
 126     Set client maximized.
 127 *Mod4 \+ Control \+ Return*::
 128     Zoom client.
 129 *Mod4 \+ Control \+ space*::
 130     Set client floating.
 131 *Mod4 \+ Shift \+ c*::
 132     Kill client.
 133 *Mod4 \+ Shift \+ q*::
 134     Quit awesome.
 135 *Mod4 \+ Control \+ r*::
 136     Restart awesome.
 137 *Mod4 + 0-9*::
 138     Switch to tag 1-9, 0 for all.
 139 *Mod4 \+ Control \+ 0-9*::
 140     Toggle tag view.
 141 *Mod4 \+ Shift \+ 0-9*::
 142     Tag client with tag.
 143 *Mod4 \+ Shift \+ Control \+ 0-9*::
 144     Toggle tag on client.
 145
 146 CUSTOMIZATION
 147 -------------
 148 awesome is customized by creating a custom $HOME/.awesomerc file.
 149
 150 SEE ALSO
 151 --------
 152 awesomerc(5) awesome-menu(1) awesome-client(1) awesome-message(1)
 153
 154 BUGS
 155 ----
 156 Of course there's no bug in awesome. But there may be unexpected behaviours.
 157
 158 Java applications which use the XToolkit/XAWT backend may draw grey windows
 159 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
 160 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
 161 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
 162 can set the following environment variable (to use the older Motif
 163 backend instead): AWT_TOOLKIT=MToolkit
 164
 165 AUTHORS
 166 -------
 167 Julien Danjou <julien@danjou.info>
 168
 169 WWW
 170 ---
 171 http://awesome.naquadah.org