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 Navigation
  49 ~~~~~~~~~~
  50
  51 *Button1* on tag name::
  52     View tag.
  53 *Button4*, *Button5* on tag name::
  54     Switch to previous or next tag.
  55 *Button4*, *Button5* on root window::
  56     Switch to previous or next tag.
  57 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  58     Switch to previous or next layout.
  59
  60 Layout modification
  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 Window manager control
  76 ~~~~~~~~~~~~~~~~~~~~~~
  77 *Mod4 \+ Control \+ r*::
  78     Restart *awesome*.
  79 *Mod4 \+ Shift \+ q*::
  80     Quit *awesome*.
  81 *Mod4 \+ F1*::
  82     Run prompt.
  83 *Mod4 \+ F4*::
  84     Run Lua code prompt.
  85 *Mod4 \+ Return*::
  86     Spawn terminal emulator.
  87
  88 Clients
  89 ~~~~~~~
  90 *Mod4 \+ Control \+ i*::
  91     Print the client class and instance.
  92 *Mod4 \+ Shift \+ r*::
  93     Redraw the focused window.
  94 *Mod4 \+ m*::
  95     Maximize client.
  96 *Mod4 \+ f*::
  97     Set client fullscreen.
  98 *Mod4 \+ Shift \+ c*::
  99     Kill focused client.
 100 *Mod4 \+ t*::
 101     Mark a client.
 102
 103 Navigation
 104 ~~~~~~~~~~
 105 *Mod4 \+ j*::
 106     Focus next client.
 107 *Mod4 \+ k*::
 108     Focus previous client.
 109 *Mod4 \+ u*::
 110     Focus first urgent client.
 111 *Mod4 \+ Left*::
 112     View previous tag.
 113 *Mod4 \+ Right*::
 114     View next tag.
 115 *Mod4 \+ 1-9*::
 116     Switch to tag 1-9.
 117 *Mod4 \+ Control \+ j*::
 118     Focus next screen.
 119 *Mod4 \+ Control \+ k*::
 120     Focus previous screen.
 121 *Mod4 \+ Escape*::
 122     Focus previously selected tag set.
 123
 124 Layout modification
 125 ~~~~~~~~~~~~~~~~~~~
 126 *Mod4 \+ Shift \+ j*::
 127     Switch client with next client.
 128 *Mod4 \+ Shift \+ k*::
 129     Switch client with previous client.
 130 *Mod4 \+ h*::
 131     Decrease master width factor by 5%.
 132 *Mod4 \+ l*::
 133     Increase master width factor by 5%.
 134 *Mod4 \+ Shift \+ h*::
 135     Increase number of master windows by 1.
 136 *Mod4 \+ Shift \+ l*::
 137     Decrease number of master windows by 1.
 138 *Mod4 \+ Control \+ h*::
 139     Increase number of columns for non-master windows by 1.
 140 *Mod4 \+ Control \+ l*::
 141     Decrease number of columns for non-master windows by 1.
 142 *Mod4 \+ space*::
 143     Switch to next layout.
 144 *Mod4 \+ Shift \+ space*::
 145     Switch to previous layout.
 146 *Mod4 \+ Control \+ space*::
 147     Toggle client floating status.
 148 *Mod4 \+ Control \+ Return*::
 149     Swap focused client with master.
 150 *Mod4 \+ Control \+ 1-9*::
 151     Toggle tag view.
 152 *Mod4 \+ Shift \+ 1-9*::
 153     Tag client with tag.
 154 *Mod4 \+ Shift \+ Control \+ 1-9*::
 155     Toggle tag on client.
 156 *Mod4 \+ Shift \+ F1-9*::
 157     Tag marked clients with tag.
 158
 159 CUSTOMIZATION
 160 -------------
 161 *awesome* is customized by creating a custom '$XDG_CONFIG_HOME/awesome/rc.lua' file.
 162
 163 SIGNALS
 164 -------
 165 *awesome* can be restarted by sending it a SIGHUP.
 166
 167 SEE ALSO
 168 --------
 169 *awesomerc*(5) *awesome-client*(1)
 170
 171 BUGS
 172 ----
 173 Of course there's no bug in *awesome*. But there may be unexpected behaviors.
 174
 175 Java applications which use the XToolkit/XAWT backend may draw gray windows
 176 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
 177 JDK 1.6 versions because it assumes a reparenting window manager. As a workaround
 178 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend), or you
 179 can set the following environment variable (to use the older Motif
 180 backend instead): AWT_TOOLKIT=MToolkit
 181
 182 AUTHORS
 183 -------
 184 Julien Danjou <julien@danjou.info> and others.
 185
 186 WWW
 187 ---
 188 http://awesome.naquadah.org