awesomerc.1.txt

   1 awesomerc(1)
   2 ===========
   3
   4 NAME
   5 ----
   6
   7 awesomerc - Configuration file for the 'awesome window manager'
   8
   9 SYNOPSIS
  10 --------
  11
  12 *awesome* reads *$HOME/.awesomerc* by default. You can choose another configuration
  13 file with: awesome -c configuration
  14
  15 UICB FUNCTIONS
  16 --------------
  17
  18 In awesome, a lot of *functions* are available. These functions are called uicb (User Interface Call Backs). Each function can be bound to a key shortcut or a mouse button.
  19
  20 General
  21 ~~~~~~~
  22 *quit*::
  23     This function quits awesome.
  24 *statusbar_toggle*::
  25     Hide or show statusbar.
  26 *statusbar_set_position* top, bottom, left, right::
  27     Set the position of the statusbar.
  28 *spawn* client::
  29     Execute an external program.
  30 *exec* program::
  31     Replace awesome with another window manager (or itself; i.e. reload config).
  32 *widget_tell* widget-identifier data::
  33     Feed information to your widgets.
  34
  35 Client
  36 ~~~~~~
  37 *client_kill*::
  38     Closes the focused client.
  39 *client_moveresize* x y width height::
  40     Dynamically move and resize floating windows.
  41     Coordinates can be relative or absolute. Relative values must begin with + or -.
  42     E.g: to move a window 10 pixels up: "+0 \+10 +0 +0" To move a window
  43     in the upper left corner and increase its width by 10px: "0 0 \+0 +10"
  44 *client_settrans* float::
  45     Set client transparency, number can be a relative or absolute floating number in percentage.
  46 *client_swapnext*::
  47     Swap window placement with the next displayed window.
  48 *client_swapprev*::
  49     Swap window placement with the previous displayed window.
  50 *client_focusnext*::
  51     Focus next window.
  52 *client_focusprev*::
  53     Focus previous window.
  54 *client_togglemax*::
  55     Set window fullscreen. Calling this function another time will reset the window to its previous state.
  56 *client_togglehorizontalmax*::
  57     Set window's horizontal size to display width. Calling another time will reset the window to its previous state.
  58 *client_toggleverticalmax*::
  59     Set window's vertical size to display height. Calling another time will reset the window to its previous state.
  60 *client_togglefloating*::
  61     Set window floating or tiled.
  62 *client_zoom*::
  63     Set window as master window.
  64 *client_movetoscreen* relative or absolute integer::
  65     Move focused window to the nth screen, or next (+1) or previous (-1). If no screen_number is set, move to the next screen.
  66 *client_tag* tag number::
  67     Tag focused window with this tag.
  68 *client_toggletag*::
  69     Add or remove tag to focused window.
  70 *client_movemouse*::
  71     Move client window with mouse.
  72 *client_resizemouse*::
  73     Resize client window with mouse.
  74
  75 Tag
  76 ~~~
  77 *tag_setlayout* relative or absolute integer::
  78     Set layout number; or just switch to the next layout for current tag.
  79 *tag_toggleview* tag::
  80     Add windows tagged with tag number to current display.
  81 *tag_view* tag number::
  82     View windows tagged with tag number.
  83 *tag_viewnext*::
  84     Show windows tagged with next tag in list.
  85 *tag_viewperv*::
  86     Show windows tagged with previous tag in list.
  87 *tag_viewprev_selected*::
  88     Switch back to the previously displayed set of tags.
  89 *tag_setmwfact* relative or absolute float::
  90     Set master width factor.
  91 *tag_setncol* relative or absolute integer::
  92     Set number of columns for non-master windows.
  93 *tag_setnmaster* relative or absolute integer::
  94     Set number of master windows.
  95
  96 Screen
  97 ~~~~~~
  98 *screen_focus* relative or absolute integer::
  99     Select Screen and focus first window and move mouse.
 100 *setborder* relative or absolute integer::
 101     Set default border size in pixels for new clients.
 102
 103 FILES
 104 -----
 105 For an example of an awesomerc file, see the file provided with the sources
 106
 107 EXAMPLES
 108 --------
 109
 110 The general format of the awesomerc with some examples:
 111
 112 ....................
 113 screen 0    # particular settings for screen 0
 114 {           #
 115   general   #
 116   { }       # border=2 focus_move_pointer=true font="fixed-10" ...
 117             #
 118   colors    #
 119   { }       # focus_bg="#000000" focus_border= ...
 120             #
 121   statusbar #
 122   { }       # position="top" taglist tl {}  textbox tb {} ...
 123             # hint: tl is a identifier (you can freely choose)
 124             # usage: awesome-client <<< "0 widget_tell tl some_data"
 125             #
 126   tags      #
 127   { }       # tag identifier { layout="tile" wmfact=0.70 nmaster=2 }
 128             #
 129   layouts   #
 130   { }       # layout max { symbol="[ ]" } (or tile, max, dwindle, floating, ...)
 131 }           #
 132             #
 133 rules       #
 134 { }         # rule { name="gimp" float=true tags="3" }
 135             #
 136 mouse       #
 137 { }         # tag { button="1" command="tag_view" }
 138             #
 139 keys        #
 140 { }         # key { modkey={"Mod4"} key="j" command="client_focusnext" }
 141 ....................
 142
 143
 144 SEE ALSO
 145 --------
 146 awesome(1) awesome-client(1)
 147
 148
 149 AUTHORS
 150 -------
 151 This man page was written by Julien Danjou <julien@danjou.info> and Marco Candrian <mac@calmar.ws>.
 152
 153 WWW
 154 ---
 155 http://awesome.naquadah.org