1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-17 18:45:10 +00:00

Update docs.

This commit is contained in:
Brenden Matthews 2009-04-09 20:18:19 -06:00
parent 506f6ecc3b
commit 77f818168b
3 changed files with 217 additions and 198 deletions

19
README
View File

@ -796,22 +796,23 @@ conky(1) conky(1)
execbar command execbar command
Same as exec, except if the first value return is a value be Same as exec, except if the first value return is a value be
tween 0-100, it will use that number for a bar. The size for the tween 0-100, it will use that number for a bar. The size for
bar is currently fixed, but that may change in the future. bars can be controlled via the default_bar_size config setting.
execgauge command execgauge command
Same as exec, except if the first value return is a value be Same as exec, except if the first value returned is a value be
tween 0-100, it will use that number for a gauge. The size for 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 gauges can be controlled via the default_gauge_size config set
future conky release. ting.
execgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi execgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi
ent colour 2) (scale) command ent colour 2) (scale) command
Same as execbar, but graphs values. Uses a logaritmic scale when Same as execbar, but graphs values. Uses a logaritmic scale when
the log option is given (to see small numbers). Values still the log option is given (to see small numbers). Values still
have to be between 0 and 100. have to be between 0 and 100. The size for graphs can be con
trolled via the default_graph_size config setting.
execi interval command execi interval command
@ -824,7 +825,11 @@ conky(1) conky(1)
execigraph interval command execigraph interval command
Same as execgraph, but takes an interval arg graphs values Same as execgraph, but takes an interval arg and graphs values.
execigauge interval command
Same as execgauge, but takes an interval arg and gauges values.
execp command execp command

View File

@ -696,15 +696,15 @@ Executes a shell command and displays the output in conky. warning: this takes a
.TP .TP
\fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> \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. 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 bars can be controlled via the default_bar_size config setting.
.TP .TP
\fB\*(T<\fBexecgauge\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> \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. Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting.
.TP .TP
\fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T> \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. 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. The size for graphs can be controlled via the default_graph_size config setting.
.TP .TP
\fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
@ -716,7 +716,11 @@ Same as execbar, except with an interval
.TP .TP
\fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
Same as execgraph, but takes an interval arg graphs values Same as execgraph, but takes an interval arg and graphs values.
.TP
\fB\*(T<\fBexecigauge\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
Same as execgauge, but takes an interval arg and gauges values.
.TP .TP
\fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>

View File

@ -611,7 +611,7 @@
<option>command</option> <option>command</option>
</term> </term>
<listitem> <listitem>
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. 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 bars can be controlled via the default_bar_size config setting.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -621,7 +621,7 @@
<option>command</option> <option>command</option>
</term> </term>
<listitem> <listitem>
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. Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -631,7 +631,7 @@
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option> <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
</term> </term>
<listitem> <listitem>
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. 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. The size for graphs can be controlled via the default_graph_size config setting.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -661,7 +661,17 @@
<option>interval command</option> <option>interval command</option>
</term> </term>
<listitem> <listitem>
Same as execgraph, but takes an interval arg graphs values Same as execgraph, but takes an interval arg and graphs values.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>execigauge</option></command>
<option>interval command</option>
</term>
<listitem>
Same as execgauge, but takes an interval arg and gauges values.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>