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] [-c configuration 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 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 contains a small status bar which displays all available tags, the layout,
  33 the title of the focused window, and a status text. A
  34 floating window is indicated with an empty circle and a maximized
  35 floating window is indicated with a circle square before the windows
  36 title. The selected tags are indicated with a different color. The tags of
  37 the focused window are indicated with a filled square in the top left
  38 corner. The tags which are applied to one or more windows are indicated
  39 with an empty square in the top left corner.
  40 awesome can draw a small border around windows to indicate the focus state.
  41
  42 OPTIONS
  43 -------
  44 -v | --version::
  45     prints version information to standard output, then exits.
  46 -h | --help::
  47     prints help information, then exits.
  48 -c::
  49     use an alternate configuration file instead of $HOME/.awesomerc.
  50 -k::
  51     check configuration file syntax.
  52
  53 DEFAULTS MOUSE BINDINGS
  54 -----------------------
  55 *Button1* on tag name::
  56     View tag.
  57 *Mod4 + Button1* on tag name::
  58     Tag current client with this tag.
  59 *Button3* on tag name::
  60     Add this tag to current view.
  61 *Mod4 + Button3* on tag name::
  62     Toggle this tag for client.
  63 *Button4*, *Button5* on tag name::
  64     Switch to previous or next tag.
  65 *Button1*, *Button3*, *Button4*, *Button5* on layout symbol::
  66     Switch to previous or next layout.
  67 *Button4*, *Button5* on root window::
  68     Switch to previous or next tag.
  69 *Mod4 + Button1* on client window::
  70     Move window.
  71 *Mod4 + Button2* on client window::
  72     Zoom window.
  73 *Mod4 + Button3* on client window::
  74     Resize window.
  75
  76 DEFAULTS KEY BINDINGS
  77 ---------------------
  78 *Mod4 + Return*::
  79     Spawn xterm.
  80 *Mod4 + space*::
  81     Switch to next layout.
  82 *Mod4 \+ Shift \+ space*::
  83     Switch to previous layout.
  84 *Mod4 + b*::
  85     Toggle statusbar.
  86 *Mod4 + j*::
  87     Focus next client.
  88 *Mod4 + k*::
  89     Focus previous client.
  90 *Mod4 \+ Shift \+ j*::
  91     Switch client with next client.
  92 *Mod4 \+ Shift \+ k*::
  93     Switch client with previous client.
  94 *Mod4 \+ Control \+ j*::
  95     Focus next screen.
  96 *Mod4 \+ Control \+ k*::
  97     Focus previous screen.
  98 *Mod4 + h*::
  99     Decrease master width factor by 5%.
 100 *Mod4 + l*::
 101     Increase master width factor by 5%.
 102 *Mod4 \+ Shift \+ h*::
 103     Increase number of master windows by 1.
 104 *Mod4 \+ Shift \+ l*::
 105     Decrease number of master windows by 1.
 106 *Mod4 \+ Control \+ h*::
 107     Increase number of column for non-master windows by 1.
 108 *Mod4 \+ Control \+ l*::
 109     Decrease number of column for non-master windows by 1.
 110 *Mod4 + Escape*::
 111     View previously selected tag.
 112 *Mod4 + Left*::
 113     View previous tag.
 114 *Mod4 + Right*::
 115     View next tag.
 116 *Mod4 + m*::
 117     Set client maximized.
 118 *Mod4 \+ Control \+ Return*::
 119     Zoom client.
 120 *Mod4 \+ Control \+ space*::
 121     Set client floating.
 122 *Mod4 \+ Shift \+ c*::
 123     Kill client.
 124 *Mod4 \+ Shift \+ q*::
 125     Quit awesome.
 126 *Mod4 \+ Control \+ r*::
 127     Restart awesome.
 128 *Mod4 + 0-9*::
 129     Switch to tag 1-9, 0 for all.
 130 *Mod4 \+ Control \+ 0-9*::
 131     Toggle tag view.
 132 *Mod4 \+ Shift \+ 0-9*::
 133     Tag client with tag.
 134 *Mod4 \+ Shift \+ Control \+ 0-9*::
 135     Toggle tag on client.
 136
 137 CUSTOMIZATION
 138 -------------
 139 awesome is customized by creating a custom $HOME/.awesomerc file.
 140
 141 SEE ALSO
 142 --------
 143 awesomerc(1) dmenu(1) dzen2(1)
 144
 145 BUGS
 146 ----
 147 Of course there's no bug in awesome. But there may be unexpected behaviours.
 148
 149 Java applications which use the XToolkit/XAWT backend may draw grey windows
 150 only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
 151 JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
 152 you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
 153 can set the following environment variable (to use the older Motif
 154 backend instead): AWT_TOOLKIT=MToolkit
 155
 156 AUTHORS
 157 -------
 158 Julien Danjou <julien@danjou.info>
 159
 160 WWW
 161 ---
 162 http://awesome.naquadah.org