adding option 'x' and 'y' and general cleanup

' = ' looks (probably) better compared to no whitespace
I ordered items in a more human-like manner instead of an alpha order
This commit is contained in:
marco candrian 2008-01-05 13:24:15 +01:00 committed by Julien Danjou
parent 5770b56af0
commit f33ce43af0
1 changed files with 199 additions and 165 deletions

View File

@ -108,6 +108,10 @@ This widget shows the tag list.
*mouse*:: *mouse*::
Set mouse bindings. Set mouse bindings.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
layoutinfo layoutinfo
~~~~~~~~~~ ~~~~~~~~~~
@ -115,6 +119,10 @@ This widget shows a icon for the selected layout.
*mouse*:: *mouse*::
Set mouse bindings. Set mouse bindings.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
netwmicon netwmicon
~~~~~~~~~ ~~~~~~~~~
@ -122,6 +130,10 @@ This widget shows a icon for the focused window using NET_WM_ICON or icon file
*mouse*:: *mouse*::
Set mouse bindings. Set mouse bindings.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
focustitle focustitle
~~~~~~~~~~ ~~~~~~~~~~
@ -137,6 +149,10 @@ This widget shows the title of the focused window.
Foreground color. Foreground color.
*align*:: *align*::
Text alignement. Text alignement.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
tasklist tasklist
~~~~~~~~ ~~~~~~~~
@ -158,6 +174,10 @@ This widget shows a list of running windows.
Text alignement. Text alignement.
*show_icons*:: *show_icons*::
Show applications icons. Show applications icons.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
textbox textbox
~~~~~~~ ~~~~~~~
@ -177,6 +197,10 @@ This widget shows a text.
Text to change. Text to change.
*align*:: *align*::
Text alignement. Text alignement.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
iconbox iconbox
~~~~~~~ ~~~~~~~
@ -188,6 +212,10 @@ This widget shows an icon.
Image file. Image file.
*resize*:: *resize*::
Resize icon to fit into statusbar. Resize icon to fit into statusbar.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
progressbar progressbar
~~~~~~~~~~~ ~~~~~~~~~~~
@ -198,17 +226,21 @@ This widget shows one or more progress-bars.
*width*:: *width*::
Set width. Set width.
*bar*:: *bar*::
Draws a bar; Options: fg, bg, bcolor Draws a bar; Options: fg, bg, bcolor.
*fg*:: *fg*::
Foreground color. Foreground color.
*bg*:: *bg*::
Background color. Background color.
*bcolor*:: *bcolor*::
Border color. Border color.
*x*::
Horizontal offset (auto-alignment if not set).
*y*::
Vertical offset (auto-alignment if not set).
FILES FILES
----- -----
For an example of an awesomerc file, see the file provided with the sources For an example of an awesomerc file, see the file provided with the sources.
EXAMPLES EXAMPLES
-------- --------
@ -216,166 +248,174 @@ EXAMPLES
The general config and subconfig options for the awesomerc: The general config and subconfig options for the awesomerc:
.............................................. ..............................................
Note: when there are no whitespaces, quotes are optional. Note: when there are no whitespace, quotes are optional.
<boolean> -> "true" or "false"
<color> -> #ff9933 (hexadecimal color notation: #red green blue) <color> -> #ff9933 (hexadecimal color notation: #red green blue)
<float> -> 0.3, 0,8 (often values between 0 and 1 are useful) <float> -> 0.3, 0,8 (often values between 0 and 1 are useful)
<identifier> -> foobar (choose a free name/string) <font> -> Xft font: mono-10, fixed-12, sans-8, ...
<identifier> -> foobar (choose a name/string)
<image> -> "/home/awesome/pics/icon.png" (path to image) <image> -> "/home/awesome/pics/icon.png" (path to image)
<integer> -> 1, 10, -3 (positive numbers are required mostly) <integer> -> 1, 10, -3 (positive numbers are required mostly)
<key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev') <key> -> a, 1, F10 (see /usr/include/X11/keysymdef.h w/o XK_ or 'xev')
<mod> -> modifier list: {"Mod1"}, {"Mod4", "Control"}, ... <mod> -> "Mod1", "Mod4", "Control" (modifiers)
<uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
<uicb-arg> -> prog, 3 (argument to a uicb function, where required)
<string> -> "foo bar"
<font> -> Xft font: mono-10, fixed-12, sans-8, ...
<boolean> -> true or false
<regex> -> regular expression <regex> -> regular expression
<string> -> "foo bar"
<uicb-arg> -> prog, 3... (argument to a uicb function, where required)
<uicb-cmd> -> spawn, exec, client_tag... (see UICB FUNCTIONS above)
<{.., ...}> -> list of available options <{.., ...}> -> list of available options
[MULTI] means, you can use an item multiple times. [MULTI] means, you can use an item multiple times.
screen <integer> [MULTI] screen <integer> [MULTI]
{ {
colors
{
focus_bg=<color>
focus_border=<color>
focus_fg=<color>
normal_bg=<color>
normal_border=<color>
normal_fg=<color>
tab_border=<color>
urgent_bg=<color>
urgent_fg=<color>
}
general general
{ {
allow_lower_floats=<boolean> allow_lower_floats = <boolean>
sloppy_focus=<boolean> border = <integer>
new_become_master=<boolean> focus_move_pointer = <boolean>
border=<integer> font = <font>
focus_move_pointer=<boolean> new_become_master = <boolean>
font=<font> opacity_unfocused = <integer>
opacity_unfocused=<integer> resize_hints = <boolean>
resize_hints=<boolean> sloppy_focus = <boolean>
snap=<integer> snap = <integer>
}
layouts
{
layout <{dwindle,floating,max,
spiral,tile,tileleft}> { image=<image> } [MULTI]
}
padding
{
bottom=<integer>
left=<integer>
right=<integer>
top=<integer>
}
statusbar <identifier> [MULTI]
{
position=<{bottom,top,left,right}>
height=<integer>
width=<integer>
focustitle <identifier>
{
fg=<color>
bg=<color>
align=<{center,left,right}>
font=<font>
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
tasklist <identifier>
{
show_icons=<boolean>
focus_fg=<color>
focus_bg=<color>
fg=<color>
bg=<color>
align=<{center,left,right}>
font=<font>
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
iconbox <identifier> [MULTI]
{
image=<image>
resize=<boolean>
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
layoutinfo <identifier>
{
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
netwmicon <identifier>
{
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
progressbar <identifier> [MULTI]
{
bar { bcolor=<color> bg=<color> fg=<color> } [MULTI]
gap=<integer>
width=<integer>
height=<float>
lpadding=<integer>
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
taglist <identifier> [MULTI]
{
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
}
textbox <identifier> [MULTI]
{
bg=<color>
fg=<color>
font=<font>
mouse [MULTI]
{
button=<integer> modkey=<mod>
command=<uicb-cmd> arg=<uicb-arg>
}
text=<string>
width=<integer>
align=<{center,left,right}>
}
} }
tags tags
{ {
tag <identifier> [MULTI] tag <identifier> [MULTI]
{ {
layout=<{dwindle,floating,max, layout = <{dwindle,floating,max,
spiral,tile,tileleft}> spiral,tile,tileleft}>
mwfact=<float> mwfact = <float>
nmaster=<integer> nmaster = <integer>
}
}
layouts
{
layout <{dwindle,floating,max,
spiral,tile,tileleft}> { image = <image> } [MULTI]
}
colors
{
tab_border = <color>
normal_fg = <color>
normal_bg = <color>
normal_border = <color>
focus_fg = <color>
focus_bg = <color>
focus_border = <color>
urgent_fg = <color>
urgent_bg = <color>
}
padding
{
top = <integer>
bottom = <integer>
left = <integer>
right = <integer>
}
statusbar <identifier> [MULTI]
{
position = <{top,bottom,left,right}>
height = <integer>
width = <integer>
taglist <identifier> [MULTI]
{
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
layoutinfo <identifier>
{
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
netwmicon <identifier>
{
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
focustitle <identifier>
{
fg = <color>
bg = <color>
font = <font>
align = <{center,left,right}>
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
tasklist <identifier>
{
fg = <color>
bg = <color>
focus_fg = <color>
focus_bg = <color>
font = <font>
show_icons = <boolean>
align = <{center,left,right}>
x = <integer> y = <integer>
mouse [MULTI]
{
command = <uicb-cmd> arg = <uicb-arg>
button = <integer> modkey = {<mod>, ...}
}
}
textbox <identifier> [MULTI]
{
text = <string>
bg = <color>
fg = <color>
font = <font>
width = <integer>
align = <{center,left,right}>
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
iconbox <identifier> [MULTI]
{
image = <image>
resize = <boolean>
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
}
progressbar <identifier> [MULTI]
{
bar { bcolor = <color> bg = <color> fg = <color> } [MULTI]
gap = <integer>
width = <integer>
height = <float>
lpadding = <integer>
x = <integer> y = <integer>
mouse [MULTI]
{
button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg>
}
} }
} }
} }
@ -383,48 +423,42 @@ rules
{ {
rule [MULTI] rule [MULTI]
{ {
float=<boolean> name = <regex>
icon=<image> xproperty_name = <string>
name=<regex> xproperty_value = <regex>
screen=<integer> float = <boolean>
tags=<regex> tags = <regex>
not_master=<boolean> screen = <integer>
xproperty_name=<string> icon = <image>
xproperty_value=<regex> not_master = <boolean>
} }
} }
keys keys
{ {
key [MULTI] key [MULTI]
{ {
arg=<uicb-arg> key = <key> modkey = {<mod>, ...}
command=<uicb-cmd> command = <uicb-cmd> arg = <uicb-arg>
key=<key>
modkey=<mod>
} }
keylist [MULTI] keylist [MULTI]
{ {
arglist={<uicb-arg>, ...} keylist = {<key>, ...}
command=<uicb-cmd> modkey = {<mod>, ...}
keylist={<key>, ...} command = <uicb-cmd>
modkey=<mod> arglist = {<uicb-arg>, ...}
} }
} }
mouse mouse
{ {
client [MULTI] client [MULTI]
{ {
arg=<uicb-arg> button = <integer> modkey = {<mod>, ...}
button=<integer> command = <uicb-cmd> arg = <uicb-arg>
command=<uicb-cmd>
modkey=<mod>
} }
root [MULTI] root [MULTI]
{ {
arg=<uicb-arg> button = <integer> modkey = {<mod>, ...}
button=<integer> command = <uicb-cmd> arg = <uicb-arg>
command=<uicb-cmd>
modkey=<mod>
} }
} }
.............................................. ..............................................