Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 04:06:03 +00:00
Code Issues Releases Activity

added README.cvs-version

Browse Source 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@148 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Jason Tan 2005-08-22 07:43:01 +00:00
parent 5d836a0660
commit 137e03c900
4 changed files with 94 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
README
View File

@ -10,14 +10,14 @@ SYNOPSIS
conky [options]
DESCRIPTION
Conky is a system monitor for X originally based on the torsmo code.
Since it's original conception, Conky has changed a fair bit from it's
Conky is a system monitor for X originally based on the torsmo code.
Since its original conception, Conky has changed a fair bit from its
predecessor. Conky can display just about anything, either on your
root desktop or in it's own window. Conky has many built-in objects,
as well as the ability to execute programs and scripts, then display
root desktop or in its own window. Conky has many built-in objects,
as well as the ability to execute programs and scripts, then display
the output from stdout.
We are always looking for help, and anyone interested in becoming a
We are always looking for help, and anyone interested in becoming a
developer is welcome. Please use the facilities at SourceForge to make
bug reports, feature requests, and submit patches.
@ -26,9 +26,9 @@ DESCRIPTION
COMPILING
First, make sure you have the X development libraries installed, this
should be a package along the lines of "libx11-dev or xorg-x11-dev".
Gentoo users, Conky is in Gentoo's Portage. Simply use "emerge conky"
Gentoo users, Conky is in Gentoos Portage. Simply use "emerge conky"
for installation. There is also usually an up-to-date ebuild within
Conky's package or in CVS.
Conkys package or in CVS.
To compile and run Conky with all optional components:
@ -36,21 +36,21 @@ COMPILING
./configure --prefix=/usr --mandir=/usr/share/man
--infodir=/usr/share/info --datadir=/usr/ share --sysconfdir=/etc
--localstatedir=/var/lib --enable-double-buffer --enable-own-window
--localstatedir=/var/lib --enable-double-buffer --enable-own-window
--enable-proc-uptime --enable-mpd --enable-xft --enable-seti
make
./conky
Conky doesn't probably compile with other compilers than gcc and icc.
It doesn't compile with C89 compiler and not even with pure C99. It
uses few things that might not exist: strdup(), strcasecmp(), strn-
casecmp(), optarg variable with getopt() and long long (not in C89).
Crashes in file system statistics stuff when compiled with icc, I don't
Conky doesnt probably compile with other compilers than gcc and icc.
It doesnt compile with C89 compiler and not even with pure C99. It
uses few things that might not exist: strdup(), strcasecmp(), strn
casecmp(), optarg variable with getopt() and long long (not in C89).
Crashes in file system statistics stuff when compiled with icc, I dont
know exactly why.
You can disable 'drawing to own window' feature in case you don't need
You can disable drawing to own window feature in case you dont need
it by passing --disable-own-window to configure -script.
@ -61,11 +61,11 @@ YOU SHOULD KNOW
rest of Conky.
If you do use them, please do not complain about memory or CPU usage,
unless you think something is going seriously wrong (mem leak, et
unless you think something is going seriously wrong (mem leak, et
cetera).
OPTIONS
Command line options override configurations defined in configuration
Command line options override configurations defined in configuration
file.
-V Prints version and exits
@ -96,7 +96,7 @@ OPTIONS
-t TEXT
Text to render, remember single quotes, like -t ' $uptime '
Text to render, remember single quotes, like -t $uptime
-u SECONDS
@ -116,12 +116,12 @@ OPTIONS
CONFIGURATION SETTINGS
Default configuration file is $HOME/.conkyrc (can be changed from
Default configuration file is $HOME/.conkyrc (can be changed from
conky.c among other things). See conkyrc.sample. You might want to copy
it to $HOME/.conkyrc and then start modifying it.
alignment
Aligned position on screen, may be top_left, top_right, bot-
Aligned position on screen, may be top_left, top_right, bot
tom_left, bottom_right, or none
@ -151,7 +151,7 @@ CONFIGURATION SETTINGS
default_shade_color
Default shading color and border's shading color
Default shading color and borders shading color
default_outline_color
@ -159,8 +159,8 @@ CONFIGURATION SETTINGS
double_buffer
Use the Xdbe extension? (eliminates flicker) It is highly recom-
mended to use own window with this one so double buffer won't be
Use the Xdbe extension? (eliminates flicker) It is highly recom
mended to use own window with this one so double buffer wont be
so big.
@ -274,11 +274,11 @@ CONFIGURATION SETTINGS
VARIABLES
Colors are parsed using XParsecolor(), there might be a list of them:
Colors are parsed using XParsecolor(), there might be a list of them:
/usr/X11R6/lib/X11/rgb.txt. Also, http://sedition.com/perl/rgb.html
[http://sedition.com/perl/rgb.html] Color can be also in #rrggbb format
(hex). Note that when displaying bytes, power is 1024 and not 1000 so
1M really means 1024*1024 bytes and not 1000*1000.
Color can be also in #rrggbb format (hex). Note that when displaying
bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
and not 1000*1000.
addr (interface)
IP address for an interface
@ -336,7 +336,7 @@ VARIABLES
cpubar (height),(width)
Bar that shows CPU usage, height is bar's height in pixels
Bar that shows CPU usage, height is bars height in pixels
cpugraph (height),(width) (gradient colour 1) (gradient colour 2)
@ -360,8 +360,8 @@ VARIABLES
exec shell command
Executes a shell command and displays the output in conky. warn-
ing: this takes a lot more resources than other variables. I'd
Executes a shell command and displays the output in conky. warn
ing: this takes a lot more resources than other variables. Id
recommend coding wanted behaviour in C and posting a patch.
@ -376,7 +376,7 @@ VARIABLES
execi interval, shell command
Same as exec but with specific interval. Interval can't be less
Same as exec but with specific interval. Interval cant be less
than update_interval in configuration.
@ -416,15 +416,15 @@ VARIABLES
i2c (dev), type, n
I2C sensor from sysfs (Linux 2.6). dev may be omitted if you
have only one I2C device. type is either in (or vol) meaning
I2C sensor from sysfs (Linux 2.6). dev may be omitted if you
have only one I2C device. type is either in (or vol) meaning
voltage, fan meaning fan or temp/tempf (first in C, second in F)
meaning temperature. n is number of the sensor. See
/sys/bus/i2c/devices/ on your local computer.
if_running (process)
if PROCESS is running, display everything if_running and the
if PROCESS is running, display everything if_running and the
matching $endif
@ -522,7 +522,7 @@ VARIABLES
mpd_bar (height),(width)
Bar of mpd's progress
Bar of mpds progress
mpd_bitrate
@ -538,19 +538,19 @@ VARIABLES
mpd_vol
MPD's volume
MPDs volume
mpd_elapsed
Song's elapsed time
Songs elapsed time
mpd_length
Song's length
Songs length
mpd_percent
Percent of song's progress
Percent of songs progress
new_mails
@ -610,26 +610,26 @@ VARIABLES
tail logfile, lines interval> Displays last N lines of supplied text
text file. If interval is not supplied, Conky assumes 2x Conky's
text file. If interval is not supplied, Conky assumes 2x Conkys
interval. Max of 30 lines. Max of 30 lines can be displayed.
time (format)
Local time, see man strftime to get more information about for-
Local time, see man strftime to get more information about for
mat
totaldown net
Total download, overflows at 4 GB on Linux with 32-bit arch and
there doesn't seem to be a way to know how many times it has
there doesnt seem to be a way to know how many times it has
already done that before conky has started.
top type, num
This takes arguments in the form:top (name) (number) Basically,
processes are ranked from highest to lowest in terms of cpu
usage, which is what (num) represents. The types are: "name",
"pid", "cpu", and mem". There can be a max of 10 processes
usage, which is what (num) represents. The types are: "name",
"pid", "cpu", and mem". There can be a max of 10 processes
listed.
@ -683,7 +683,7 @@ VARIABLES
EXAMPLES
conky -t '${time %D %H:%m}' -o -u 30
conky -t${time %D %H:%m}-o -u 30
Start Conky in its own window with date and clock as text and 30
sec update interval.
@ -694,25 +694,24 @@ FILES
~/.conkyrc default configuration file
BUGS
Drawing to root or some other desktop window directly doesn't work with
all window managers. Especially doesn't work well with Gnome and it has
been reported that it doesn't work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree
useful to find the window to draw to. You can also use -o argument
Drawing to root or some other desktop window directly doesnt work with
all window managers. Especially doesnt work well with Gnome and it has
been reported that it doesnt work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree
useful to find the window to draw to. You can also use -o argument
which makes Conky to create its own window.
SEE ALSO
http://conky.sourceforge.net [http://conky.sourceforge.net]
http://conky.sourceforge.net
http://www.sourceforge.net/projects/conky [http://www.source-
forge.net/projects/conky]
http://www.sourceforge.net/projects/conky
#conky on irc.freenode.net
AUTHORS
The Conky dev team. What's up now??!
The Conky dev team. Whats up now??!

29
README.cvs-version Normal file
View File

@ -0,0 +1,29 @@
THESE INSTRUCTIONS ARE ONLY IF "sh autogen.sh" DOESN'T WORK!!!
First, read the README. This contains instructions specific to building conky
fresh from a CVS checkout:
* As the README says, you need to have the X development libraries installed.
This should be a package along the lines of libx11-dev or xorg-x11-dev .
* Conky requires three "auto-tools", with at least the specific version numbers.
Make sure these are installed:
aclocal-1.9
automake-1.9
autoconf-2.59
* In the directory where you checked out conky from CVS,
run "aclocal", "automake", and then "autoconf".
Make sure you run those commands with the latest versions...
it is very possible that older versions are installed, and
plain "automake" really means automake-1.4, not what we want,
but "automake-1.9" instead.
Use the "--version" option to check the program version, i.e.
"autoconf --version".
* After that, it's the familiar
./configure
make
make install
You might have to do the last two steps as root.

BIN
doc/conky.1.gz
View File

Binary file not shown.

22
doc/docs.html
View File

@ -1,4 +1,4 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>conky</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id257346"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>conky &#8212; a system monitor for X originally based on the torsmo code, but more kickass.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">conky</tt> [<i class="replaceable"><tt>options</tt></i>]</p></div></div><div class="refsect1" lang="en"><a name="id222072"></a><h2>Description</h2><p>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>conky</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2447920"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>conky &#8212; a system monitor for X originally based on the torsmo code, but more kickass.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">conky</tt> [<i class="replaceable"><tt>options</tt></i>]</p></div></div><div class="refsect1" lang="en"><a name="id2476569"></a><h2>Description</h2><p>
Conky is a system monitor for X originally based on the torsmo code.
Since it's original conception, Conky has changed a fair bit from it's predecessor.
Conky can display just about anything, either on your root desktop or in it's own window.
@ -9,7 +9,7 @@
Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
</p><p>
Thanks for your interest in Conky.
</p></div><div class="refsect1" lang="en"><a name="id222093"></a><h2>Compiling</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2476596"></a><h2>Compiling</h2><p>
First, make sure you have the X development libraries installed, this should be a package along the lines
of "libx11-dev or xorg-x11-dev". Gentoo users, Conky is in Gentoo's Portage. Simply use "emerge conky" for installation.
There is also usually an up-to-date ebuild within Conky's package or in CVS.
@ -38,19 +38,19 @@
--disable-own-window to configure -script.
</p><p>
</p></div><div class="refsect1" lang="en"><a name="id239613"></a><h2>You Should Know</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2447477"></a><h2>You Should Know</h2><p>
Conky is generally very good on resources. However, certain objects in
Conky are harder on resources then others. In particular, the $tail,
$top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
</p><p>
If you do use them, please do not complain about memory or CPU usage,
unless you think something is going seriously wrong (mem leak, et cetera).
</p></div><div class="refsect1" lang="en"><a name="id239630"></a><h2>Options</h2><p>Command line options override configurations defined in configuration file.</p><div class="variablelist"><dl><dt><span class="term"><span><b class="command"><tt class="option">-V</tt></b></span></span></dt><dd>
</p></div><div class="refsect1" lang="en"><a name="id2447496"></a><h2>Options</h2><p>Command line options override configurations defined in configuration file.</p><div class="variablelist"><dl><dt><span class="term"><span><b class="command"><tt class="option">-V</tt></b></span></span></dt><dd>
Prints version and exits
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-a </tt></b></span><tt class="option">ALIGNMENT</tt></span></dt><dd>
Text alignment on screen, {top,bottom}_{left,right} or none
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-b</tt></b></span></span></dt><dd>
Use double buffering (eliminates flicker)
Use double buffering (eliminates "flicker")
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-c </tt></b></span><tt class="option">FILE</tt></span></dt><dd>
Config file to load instead of $HOME/.conkyrc
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-d</tt></b></span></span></dt><dd>
@ -71,7 +71,7 @@
X position
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-y </tt></b></span><tt class="option">Y_COORDINATE</tt></span></dt><dd>
Y position
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id221342"></a><h2>Configuration Settings</h2><p>
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2448119"></a><h2>Configuration Settings</h2><p>
Default configuration file is $HOME/.conkyrc (can be changed from
conky.c among other things). See conkyrc.sample. You might want to copy
it to $HOME/.conkyrc and then start modifying it.
@ -149,7 +149,7 @@
Use Xft (anti-aliased font and stuff)
<p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">text</tt></b></span></span></dt><dd>
After this begins text to be formatted on screen
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id265106"></a><h2>Variables</h2><p>
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2517432"></a><h2>Variables</h2><p>
Colors are parsed using XParsecolor(), there might be a list of them:
/usr/X11R6/lib/X11/rgb.txt. Also, <a href="http://sedition.com/perl/rgb.html" target="_top">
http://sedition.com/perl/rgb.html</a>
@ -586,8 +586,8 @@
<tt class="option">(pixels)</tt>
</span></dt><dd>
Change verticle offset by N pixels. Negative values will cause text to overlap. See also $offset.
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id269077"></a><h2>Examples</h2><div class="variablelist"><dl><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-t '${time %D %H:%m}' -o -u 30</tt></span></dt><dd>Start Conky in its own window with date and clock as text and 30 sec update interval.</dd><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-a top_left -x 5 -y 500 -d</tt></span></dt><dd>Start Conky to background at coordinates (5, 500).</dd></dl></div></div><div class="refsect1" lang="en"><a name="id269116"></a><h2>Files</h2><tt class="filename">~/.conkyrc</tt> default configuration file
</div><div class="refsect1" lang="en"><a name="id269129"></a><h2>Bugs</h2><p>
<p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2521506"></a><h2>Examples</h2><div class="variablelist"><dl><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-t '${time %D %H:%m}' -o -u 30</tt></span></dt><dd>Start Conky in its own window with date and clock as text and 30 sec update interval.</dd><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-a top_left -x 5 -y 500 -d</tt></span></dt><dd>Start Conky to background at coordinates (5, 500).</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2521547"></a><h2>Files</h2><tt class="filename">~/.conkyrc</tt> default configuration file
</div><div class="refsect1" lang="en"><a name="id2521560"></a><h2>Bugs</h2><p>
Drawing to root or some other desktop window directly doesn't work with
all window managers. Especially doesn't work well with Gnome and it has
been reported that it doesn't work with KDE either. Nautilus can be
@ -596,10 +596,10 @@
to set some specific window id. You might find xwininfo -tree useful to
find the window to draw to. You can also use -o argument which makes
Conky to create its own window.
</p></div><div class="refsect1" lang="en"><a name="id269143"></a><h2>See Also</h2><p><a href="http://conky.sourceforge.net" target="_top">
</p></div><div class="refsect1" lang="en"><a name="id2521579"></a><h2>See Also</h2><p><a href="http://conky.sourceforge.net" target="_top">
http://conky.sourceforge.net</a></p><p><a href="http://www.sourceforge.net/projects/conky" target="_top">
http://www.sourceforge.net/projects/conky</a></p><p>
#conky on irc.freenode.net
</p></div><div class="refsect1" lang="en"><a name="id269168"></a><h2>Authors</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2521605"></a><h2>Authors</h2><p>
The Conky dev team. What's up now??!
</p></div></div></body></html>