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*] [*-c* | *--config* 'FILE'] [*-k* | *--check*]
  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 the 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* can contain small wiboxes which can display anything you want:
  33 all available tags, the layout, the title of the visible windows, a text, etc.
  34
  35 OPTIONS
  36 -------
  37 *-v*, *--version*::
  38     Print version information to standard output, then exit.
  39 *-h*, *--help*::
  40     Print help information, then exit.
  41 *-c*, *--config* 'FILE'::
  42     Use an alternate configuration file instead of '$XDG_CONFIG_HOME/awesome/rc.lua'.
  43 *-k*, *--check*::
  44     Check configuration file syntax.
  45
  46 DEFAULT MOUSE BINDINGS
  47 -----------------------
  48
  49 Navigation.
  50 ~~~~~~~~~~~
  51
  52 *Button1* on tag name::
  53     View tag.
  54 *Button4*, *Button5* on tag name::
  55     Switch to previous or next tag.
  56 *Button4*, *Button5* on root window::
  57     Switch to previous or next tag.
  58 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  59     Switch to previous or next layout.
  60
  61 Layout modification.
  62 ~~~~~~~~~~~~~~~~~~~~
  63
  64 *Mod4 \+ Button1* on tag name::
  65     Tag current client with this tag only.
  66 *Mod4 \+ Button3* on tag name::
  67     Toggle this tag for client.
  68 *Button3* on tag name::
  69     Add this tag to current view.
  70 *Mod4 \+ Button1* on client window::
  71     Move window.
  72 *Mod4 \+ Button3* on client window::
  73     Resize window.
  74
  75 DEFAULT KEY BINDINGS
  76 ---------------------
  77
  78 Birth and annihilation
  79 ~~~~~~~~~~~~~~~~~~~~~~
  80
  81 *Mod4 \+ Return*::
  82     Spawn terminal emulator.
  83 *Mod4 \+ F1*::
  84     Run prompt.
  85 *Mod4 \+ F4*::
  86     Run lua code prompt.
  87 *Mod4 \+ Shift \+ c*::
  88     Kill client.
  89 *Mod4 \+ Control \+ r*::
  90     Restart *awesome*.
  91 *Mod4 \+ Shift \+ q*::
  92     Quit *awesome*.
  93
  94 Navigation
  95 ~~~~~~~~~~
  96
  97 *Mod4 \+ j*::
  98     Focus next client.
  99 *Mod4 \+ k*::
 100     Focus previous client.
 101 *Mod4 \+ u*::
 102     Focus first urgent client.
 103 *Mod4 \+ Left*::
 104     View previous tag.
 105 *Mod4 \+ Right*::
 106     View next tag.
 107 *Mod4 \+ 1-9*::
 108     Switch to tag 1-9.
 109 *Mod4 \+ Control \+ j*::
 110     Focus next screen.
 111 *Mod4 \+ Control \+ k*::
 112     Focus previous screen.
 113
 114 Layout modification
 115 ~~~~~~~~~~~~~~~~~~~
 116
 117 *Mod4 \+ Shift \+ j*::
 118     Switch client with next client.
 119 *Mod4 \+ Shift \+ k*::
 120     Switch client with previous client.
 121 *Mod4 \+ h*::
 122     Decrease master width factor by 5%.
 123 *Mod4 \+ l*::
 124     Increase master width factor by 5%.
 125 *Mod4 \+ Shift \+ h*::
 126     Increase number of master windows by 1.
 127 *Mod4 \+ Shift \+ l*::
 128     Decrease number of master windows by 1.
 129 *Mod4 \+ Control \+ h*::
 130     Increase number of columns for non-master windows by 1.
 131 *Mod4 \+ Control \+ l*::
 132     Decrease number of columns for non-master windows by 1.
 133 *Mod4 \+ space*::
 134     Switch to next layout.
 135 *Mod4 \+ Shift \+ space*::
 136     Switch to previous layout.
 137 *Mod4 \+ Control \+ space*::
 138     Toggle client floating status.
 139 *Mod4 \+ Control \+ Return*::
 140     Swap focused client with master.
 141 *Mod4 \+ Control \+ 1-9*::
 142     Toggle tag view.
 143 *Mod4 \+ Shift \+ 1-9*::
 144     Tag client with tag.
 145 *Mod4 \+ Shift \+ Control \+ 1-9*::
 146     Toggle tag on client.
 147
 148 Misc
 149 ~~~~
 150 *Mod4 \+ Shift \+ i*::
 151     Print the client class and instance.
 152
 153 *Mod4 \+ Shift \+ r*::
 154     Redraw the focused window.
 155
 156 CUSTOMIZATION
 157 -------------
 158 *awesome* is customized by creating a custom '$XDG_CONFIG_HOME/awesome/rc.lua' file.
 159
 160 SIGNALS
 161 -------
 162 *awesome* can be restarted by sending it a SIGHUP.
 163
 164 SEE ALSO
 165 --------
 166 *awesomerc*(5) *awesome-client*(1)
 167
 168 BUGS
 169 ----
 170 Of course there's no bug in *awesome*. But there may be unexpected behaviors.
 171
 172 Java applications which use the XToolkit/XAWT backend may draw gray windows
 173 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
 174 JDK 1.6 versions because it assumes a reparenting window manager. As a workaround
 175 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend), or you
 176 can set the following environment variable (to use the older Motif
 177 backend instead): AWT_TOOLKIT=MToolkit
 178
 179 AUTHORS
 180 -------
 181 Julien Danjou <julien@danjou.info> and others.
 182
 183 WWW
 184 ---
 185 http://awesome.naquadah.org