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']
  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
  44 DEFAULT MOUSE BINDINGS
  45 -----------------------
  46
  47 Navigation.
  48 ~~~~~~~~~~~
  49
  50 *Button1* on tag name::
  51     View tag.
  52 *Button4*, *Button5* on tag name::
  53     Switch to previous or next tag.
  54 *Button4*, *Button5* on root window::
  55     Switch to previous or next tag.
  56 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  57     Switch to previous or next layout.
  58
  59 Layout modification.
  60 ~~~~~~~~~~~~~~~~~~~~
  61
  62 *Mod4 \+ Button1* on tag name::
  63     Tag current client with this tag only.
  64 *Mod4 \+ Button3* on tag name::
  65     Toggle this tag for client.
  66 *Button3* on tag name::
  67     Add this tag to current view.
  68 *Mod4 \+ Button1* on client window::
  69     Move window.
  70 *Mod4 \+ Button3* on client window::
  71     Resize window.
  72
  73 DEFAULT KEY BINDINGS
  74 ---------------------
  75
  76 Birth and annihilation
  77 ~~~~~~~~~~~~~~~~~~~~~~
  78
  79 *Mod4 \+ Return*::
  80     Spawn terminal emulator.
  81 *Mod4 \+ F1*::
  82     Run prompt.
  83 *Mod4 \+ F4*::
  84     Run lua code prompt.
  85 *Mod4 \+ Shift \+ c*::
  86     Kill client.
  87 *Mod4 \+ Control \+ r*::
  88     Restart *awesome*.
  89 *Mod4 \+ Shift \+ q*::
  90     Quit *awesome*.
  91
  92 Navigation
  93 ~~~~~~~~~~
  94
  95 *Mod4 \+ j*::
  96     Focus next client.
  97 *Mod4 \+ k*::
  98     Focus previous client.
  99 *Mod4 \+ u*::
 100     Focus first urgent client.
 101 *Mod4 \+ Left*::
 102     View previous tag.
 103 *Mod4 \+ Right*::
 104     View next tag.
 105 *Mod4 \+ 1-9*::
 106     Switch to tag 1-9.
 107 *Mod4 \+ y*::
 108     Go to next client in a tabbed display.
 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 \+ Control \+ y*::
 134     Move next client to a tabbed display in current client.
 135 *Mod4 \+ Shift \+ y*::
 136     Move client out of a tabbed display.
 137 *Mod4 \+ space*::
 138     Switch to next layout.
 139 *Mod4 \+ Shift \+ space*::
 140     Switch to previous layout.
 141 *Mod4 \+ Control \+ space*::
 142     Toggle client floating status.
 143 *Mod4 \+ Control \+ Return*::
 144     Swap focused client with master.
 145 *Mod4 \+ Control \+ 1-9*::
 146     Toggle tag view.
 147 *Mod4 \+ Shift \+ 1-9*::
 148     Tag client with tag.
 149 *Mod4 \+ Shift \+ Control \+ 1-9*::
 150     Toggle tag on client.
 151
 152 Misc
 153 ~~~~
 154 *Mod4 \+ Shift \+ i*::
 155     Print the client class and instance.
 156
 157 *Mod4 \+ Shift \+ r*::
 158     Redraw the focused window.
 159
 160 CUSTOMIZATION
 161 -------------
 162 *awesome* is customized by creating a custom '$XDG_CONFIG_HOME/awesome/rc.lua' file.
 163
 164 SIGNALS
 165 -------
 166 *awesome* can be restarted by sending it a SIGHUP.
 167
 168 SEE ALSO
 169 --------
 170 *awesomerc*(5) *awesome-client*(1)
 171
 172 BUGS
 173 ----
 174 Of course there's no bug in *awesome*. But there may be unexpected behaviors.
 175
 176 Java applications which use the XToolkit/XAWT backend may draw gray windows
 177 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
 178 JDK 1.6 versions because it assumes a reparenting window manager. As a workaround
 179 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend), or you
 180 can set the following environment variable (to use the older Motif
 181 backend instead): AWT_TOOLKIT=MToolkit
 182
 183 AUTHORS
 184 -------
 185 Julien Danjou <julien@danjou.info> and others.
 186
 187 WWW
 188 ---
 189 http://awesome.naquadah.org