1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-26 12:27:52 +00:00

Regenerate docs.

This commit is contained in:
Brenden Matthews 2009-03-17 23:26:56 -06:00
parent 3d56128925
commit c8e2437f1e
2 changed files with 215 additions and 186 deletions

19
README
View File

@ -677,6 +677,12 @@ conky(1) conky(1)
$cpu for more info on SMP.
1mcpugauge (cpu number) (height),(width)0m
Elliptical gauge that shows CPU usage, height and width are
gauge's vertical and horizontal axis respectively. See $cpu for
more info on SMP.
1mcpugraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi0m
1ment colour 2) (scale) (cpu number)0m
CPU usage graph, with optional colours in hex, minus the #. See
@ -769,6 +775,13 @@ conky(1) conky(1)
bar is currently fixed, but that may change in the future.
1mexecgauge command0m
Same as exec, except if the first value return is a value be
tween 0-100, it will use that number for a gauge. The size for
the gauge is currently fixed, but you may change that for the
future conky release.
1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi0m
1ment colour 2) (scale) command0m
Same as execbar, but graphs values. Uses a logaritmic scale when
@ -1198,6 +1211,10 @@ conky(1) conky(1)
Bar that shows amount of memory in use
1mmemgauge (height),(width)0m
Gauge that shows amount of memory in use (see cpugauge)
1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi0m
1ment colour 2) (scale)0m
Memory usage graph. Uses a logarithmic scale (to see small num
@ -1901,4 +1918,4 @@ conky(1) conky(1)
2008-12-07 conky(1)
2009-03-15 conky(1)

View File

@ -5,7 +5,7 @@
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH conky 1 2008-12-07 "" ""
.TH conky 1 2009-03-15 "" ""
.SH NAME
conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
.SH SYNOPSIS
@ -610,6 +610,10 @@ CPU usage in percents. For SMP machines, the CPU number can be provided as an ar
\fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
.TP
\fB\*(T<\fBcpugauge\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
.TP
\fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (cpu number)\fR\*(T>
CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
@ -678,6 +682,10 @@ Executes a shell command and displays the output in conky. warning: this takes a
\fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
.TP
\fB\*(T<\fBexecgauge\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
Same as exec, except if the first value return is a value between 0-100, it will use that number for a gauge. The size for the gauge is currently fixed, but you may change that for the future conky release.
.TP
\fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T>
Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100.
@ -1030,6 +1038,10 @@ Amount of memory in use
\fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
Bar that shows amount of memory in use
.TP
\fB\*(T<\fBmemgauge\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
Gauge that shows amount of memory in use (see cpugauge)
.TP
\fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".