Documentation for the new graph options

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
marco candrian 2008-01-25 21:38:59 +01:00 committed by Julien Danjou
parent 6f1e1e1abe
commit 03743e1f0b
1 changed files with 80 additions and 74 deletions

View File

@ -248,14 +248,6 @@ progressbar
~~~~~~~~~~~ ~~~~~~~~~~~
This widget shows one or more progress-bars. This widget shows one or more progress-bars.
*mouse*::
Set mouse bindings.
*width*::
Set width.
*height*::
Set height (i.e. 0.9 = 90%)
*padding_left*::
Empty space on the left.
*bar*:: *bar*::
Draws a bar; Options: fg, bg, bordercolor. Draws a bar; Options: fg, bg, bordercolor.
*fg*:: *fg*::
@ -264,6 +256,14 @@ This widget shows one or more progress-bars.
Background color. Background color.
*bordercolor*:: *bordercolor*::
Border color. Border color.
*mouse*::
Set mouse bindings.
*width*::
Set width.
*height*::
Set height (i.e. 0.9 = 90%)
*padding_left*::
Empty space on the left.
*x*:: *x*::
Horizontal offset (auto-alignment if not set). Horizontal offset (auto-alignment if not set).
*y*:: *y*::
@ -273,10 +273,16 @@ graph
~~~~~ ~~~~~
This widget shows a graph. This widget shows a graph.
*data*::
Defines a data-stream section; Options: max, scale, fg and style.
*max*::
This value prints a full graph (default = 100)
*scale*:: *scale*::
Re-scales when input > max (see below). Re-scales when input > max (see below).
*max*:: *fg*::
This value prints a full graph. Foreground color.
*style*::
bottom (fills to bottom with fg), top, or line.
*mouse*:: *mouse*::
Set mouse bindings. Set mouse bindings.
*width*:: *width*::
@ -285,8 +291,6 @@ This widget shows a graph.
Set height (i.e. 0.9 = 90%) Set height (i.e. 0.9 = 90%)
*padding_left*:: *padding_left*::
Empty space on the left. Empty space on the left.
*fg*::
Foreground color.
*bg*:: *bg*::
Background color. Background color.
*bordercolor*:: *bordercolor*::
@ -329,22 +333,22 @@ screen <integer> [MULTI]
general general
{ {
allow_lower_floats = <boolean> allow_lower_floats = <boolean>
border = <integer> border = <integer>
focus_move_pointer = <boolean> focus_move_pointer = <boolean>
font = <font> font = <font>
new_become_master = <boolean> new_become_master = <boolean>
new_get_focus = <boolean> new_get_focus = <boolean>
resize_hints = <boolean> resize_hints = <boolean>
sloppy_focus = <boolean> sloppy_focus = <boolean>
snap = <integer> snap = <integer>
} }
tags tags
{ {
tag <identifier> [MULTI] tag <identifier> [MULTI]
{ {
layout = <{dwindle,floating,max, layout = <{dwindle,floating,max,
spiral,tile,tileleft,tilebottom,tiletop}> spiral,tile,tileleft,tilebottom,tiletop}>
mwfact = <float> mwfact = <float>
nmaster = <integer> nmaster = <integer>
} }
} }
@ -356,22 +360,22 @@ screen <integer> [MULTI]
} }
colors colors
{ {
tab_border = <color> tab_border = <color>
normal_fg = <color> normal_fg = <color>
normal_bg = <color> normal_bg = <color>
normal_border = <color> normal_border = <color>
focus_fg = <color> focus_fg = <color>
focus_bg = <color> focus_bg = <color>
focus_border = <color> focus_border = <color>
urgent_fg = <color> urgent_fg = <color>
urgent_bg = <color> urgent_bg = <color>
} }
padding padding
{ {
top = <integer> top = <integer>
bottom = <integer> bottom = <integer>
left = <integer> left = <integer>
right = <integer> right = <integer>
} }
statusbar <identifier> [MULTI] statusbar <identifier> [MULTI]
{ {
@ -383,7 +387,7 @@ screen <integer> [MULTI]
{ {
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
@ -392,8 +396,8 @@ screen <integer> [MULTI]
{ {
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
@ -401,8 +405,8 @@ screen <integer> [MULTI]
{ {
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
@ -414,8 +418,8 @@ screen <integer> [MULTI]
align = <{center,left,right}> align = <{center,left,right}>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
@ -431,23 +435,23 @@ screen <integer> [MULTI]
align = <{center,left,right}> align = <{center,left,right}>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
} }
} }
textbox <identifier> [MULTI] textbox <identifier> [MULTI]
{ {
text = <string> text = <string>
bg = <color> bg = <color>
fg = <color> fg = <color>
font = <font> font = <font>
width = <integer> width = <integer>
align = <{center,left,right}> align = <{center,left,right}>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
@ -457,84 +461,86 @@ screen <integer> [MULTI]
resize = <boolean> resize = <boolean>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
progressbar <identifier> [MULTI] progressbar <identifier> [MULTI]
{ {
bar { fg = <color> bg = <color> bordercolor = <color> } [MULTI] bar { fg = <color> bg = <color> bordercolor = <color> } [MULTI]
gap = <integer> gap = <integer>
width = <integer> width = <integer>
height = <float> height = <float>
padding_left = <integer> padding_left = <integer>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
graph <identifier> [MULTI] graph <identifier> [MULTI]
{ {
scale = <boolean> data [MULTI]
max = <float> {
scale = <boolean> max = <float> fg = <color>
style = <{bottom, top, line}>
}
width = <integer> width = <integer>
height = <float> height = <float>
padding_left = <integer> padding_left = <integer>
fg = <color>
bg = <color> bg = <color>
bordercolor = <color> bordercolor = <color>
x = <integer> y = <integer> x = <integer> y = <integer>
mouse [MULTI] mouse [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
} }
} }
rules rules
{ {
rule [MULTI] rule [MULTI]
{ {
name = <regex> name = <regex>
xproperty_name = <string> xproperty_name = <string>
xproperty_value = <regex> xproperty_value = <regex>
float = <{auto,true,false}> float = <{auto,true,false}>
tags = <regex> tags = <regex>
screen = <integer> screen = <integer>
icon = <image> icon = <image>
not_master = <boolean> not_master = <boolean>
} }
} }
keys keys
{ {
key [MULTI] key [MULTI]
{ {
key = <key> modkey = {<mod>, ...} key = <key> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
keylist [MULTI] keylist [MULTI]
{ {
keylist = {<key>, ...} keylist = {<key>, ...}
modkey = {<mod>, ...} modkey = {<mod>, ...}
command = <uicb-cmd> command = <uicb-cmd>
arglist = {<uicb-arg>, ...} arglist = {<uicb-arg>, ...}
} }
} }
mouse mouse
{ {
client [MULTI] client [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
root [MULTI] root [MULTI]
{ {
button = <integer> modkey = {<mod>, ...} button = <integer> modkey = {<mod>, ...}
command = <uicb-cmd> arg = <uicb-arg> command = <uicb-cmd> arg = <uicb-arg>
} }
} }
.............................................. ..............................................