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
  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 + r*::
  82     Run prompt.
  83 *Mod4 + x*::
  84     Run Lua code prompt.
  85 *Mod4 + Return*::
  86     Spawn terminal emulator.
  87 *Mod4 + w*::
  88     Open main menu.
  89
  90 Clients
  91 ~~~~~~~
  92 *Mod4 + Shift + r*::
  93     Redraw the focused window.
  94 *Mod4 + m*::
  95     Maximize client.
  96 *Mod4 + n*::
  97     Minimize client.
  98 *Mod4 + f*::
  99     Set client fullscreen.
 100 *Mod4 + Shift + c*::
 101     Kill focused client.
 102 *Mod4 + t*::
 103     Mark a client.
 104
 105 Navigation
 106 ~~~~~~~~~~
 107 *Mod4 + j*::
 108     Focus next client.
 109 *Mod4 + k*::
 110     Focus previous client.
 111 *Mod4 + u*::
 112     Focus first urgent client.
 113 *Mod4 + Left*::
 114     View previous tag.
 115 *Mod4 + Right*::
 116     View next tag.
 117 *Mod4 + 1-9*::
 118     Switch to tag 1-9.
 119 *Mod4 + Control + j*::
 120     Focus next screen.
 121 *Mod4 + Control + k*::
 122     Focus previous screen.
 123 *Mod4 + Escape*::
 124     Focus previously selected tag set.
 125
 126 Layout modification
 127 ~~~~~~~~~~~~~~~~~~~
 128 *Mod4 + Shift + j*::
 129     Switch client with next client.
 130 *Mod4 + Shift + k*::
 131     Switch client with previous client.
 132 *Mod4 + o*::
 133     Send client to next screen.
 134 *Mod4 + h*::
 135     Decrease master width factor by 5%.
 136 *Mod4 + l*::
 137     Increase master width factor by 5%.
 138 *Mod4 + Shift + h*::
 139     Increase number of master windows by 1.
 140 *Mod4 + Shift + l*::
 141     Decrease number of master windows by 1.
 142 *Mod4 + Control + h*::
 143     Increase number of columns for non-master windows by 1.
 144 *Mod4 + Control + l*::
 145     Decrease number of columns for non-master windows by 1.
 146 *Mod4 + space*::
 147     Switch to next layout.
 148 *Mod4 + Shift + space*::
 149     Switch to previous layout.
 150 *Mod4 + Control + space*::
 151     Toggle client floating status.
 152 *Mod4 + Control + Return*::
 153     Swap focused client with master.
 154 *Mod4 + Control + 1-9*::
 155     Toggle tag view.
 156 *Mod4 + Shift + 1-9*::
 157     Tag client with tag.
 158 *Mod4 + Shift + Control + 1-9*::
 159     Toggle tag on client.
 160 *Mod4 + Shift + F1-9*::
 161     Tag marked clients with tag.
 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