manpages/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. Any layout can be applied dynamically, optimizing the
  19 environment for the application in use and the task currently being performed.
  20
  21 In a tiled layout, windows are managed in a master and stacking area. The master
  22 area contains the windows which currently need the most attention, whereas the
  23 stacking area contains all other windows. In a floating layout windows can be
  24 resized and moved freely. Dialog windows are always managed as floating,
  25 regardless of the layout currently applied. The spiral and dwindle layouts are
  26 special cases of the tiled layout where the stacking area is arranged in a
  27 spiral for the former or as a rectangular fractal for the later.
  28
  29 Windows are grouped by tags in awesome. Each window can be tagged with one or
  30 more 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 current layout, the title of the visible windows, 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 *-a*, *--no-argb*::
  46     Don't use ARGB visuals.
  47
  48 DEFAULT MOUSE BINDINGS
  49 -----------------------
  50 Navigation
  51 ~~~~~~~~~~
  52
  53 *Button1* on tag name::
  54     View tag.
  55 *Button4*, *Button5* on tag name::
  56     Switch to previous or next tag.
  57 *Button4*, *Button5* on root window::
  58     Switch to previous or next tag.
  59 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  60     Switch to previous or next layout.
  61
  62 Layout modification
  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 Window manager control
  78 ~~~~~~~~~~~~~~~~~~~~~~
  79 *Mod4 + Control + r*::
  80     Restart *awesome*.
  81 *Mod4 + Shift + q*::
  82     Quit *awesome*.
  83 *Mod4 + r*::
  84     Run prompt.
  85 *Mod4 + x*::
  86     Run Lua code prompt.
  87 *Mod4 + Return*::
  88     Spawn terminal emulator.
  89 *Mod4 + w*::
  90     Open main menu.
  91
  92 Clients
  93 ~~~~~~~
  94 *Mod4 + m*::
  95     Maximize client.
  96 *Mod4 + n*::
  97     Minimize client.
  98 *Mod4 + Control + n*::
  99     Restore client.
 100 *Mod4 + f*::
 101     Set client fullscreen.
 102 *Mod4 + Shift + c*::
 103     Kill focused client.
 104 *Mod4 + t*::
 105     Set client on-top.
 106
 107 Navigation
 108 ~~~~~~~~~~
 109 *Mod4 + j*::
 110     Focus next client.
 111 *Mod4 + k*::
 112     Focus previous client.
 113 *Mod4 + u*::
 114     Focus first urgent client.
 115 *Mod4 + Left*::
 116     View previous tag.
 117 *Mod4 + Right*::
 118     View next tag.
 119 *Mod4 + 1-9*::
 120     Switch to tag 1-9.
 121 *Mod4 + Control + j*::
 122     Focus next screen.
 123 *Mod4 + Control + k*::
 124     Focus previous screen.
 125 *Mod4 + Escape*::
 126     Focus previously selected tag set.
 127
 128 Layout modification
 129 ~~~~~~~~~~~~~~~~~~~
 130 *Mod4 + Shift + j*::
 131     Switch client with next client.
 132 *Mod4 + Shift + k*::
 133     Switch client with previous client.
 134 *Mod4 + o*::
 135     Send client to next screen.
 136 *Mod4 + h*::
 137     Decrease master width factor by 5%.
 138 *Mod4 + l*::
 139     Increase master width factor by 5%.
 140 *Mod4 + Shift + h*::
 141     Increase number of master windows by 1.
 142 *Mod4 + Shift + l*::
 143     Decrease number of master windows by 1.
 144 *Mod4 + Control + h*::
 145     Increase number of columns for non-master windows by 1.
 146 *Mod4 + Control + l*::
 147     Decrease number of columns for non-master windows by 1.
 148 *Mod4 + space*::
 149     Switch to next layout.
 150 *Mod4 + Shift + space*::
 151     Switch to previous layout.
 152 *Mod4 + Control + space*::
 153     Toggle client floating status.
 154 *Mod4 + Control + Return*::
 155     Swap focused client with master.
 156 *Mod4 + Control + 1-9*::
 157     Toggle tag view.
 158 *Mod4 + Shift + 1-9*::
 159     Tag client with tag.
 160 *Mod4 + Shift + Control + 1-9*::
 161     Toggle tag on client.
 162
 163 CUSTOMIZATION
 164 -------------
 165 *awesome* is customized by creating a custom '$XDG_CONFIG_HOME/awesome/rc.lua' file.
 166
 167 SIGNALS
 168 -------
 169 *awesome* can be restarted by sending it a SIGHUP.
 170
 171 SEE ALSO
 172 --------
 173 *awesomerc*(5) *awesome-client*(1)
 174
 175 BUGS
 176 ----
 177 Of course there's no bug in *awesome*. But there may be unexpected behaviors.
 178
 179 AUTHORS
 180 -------
 181 Julien Danjou <julien@danjou.info> and others.
 182
 183 WWW
 184 ---
 185 http://awesome.naquadah.org