Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-09-29 21:49:07 +00:00
Code Issues Releases Activity

updated docs for , mentioned that metar is gone. changed some of the packaging files to meet debian standards (thanks to pollux, thru mirrorbox), so that should be almost ready

Browse Source 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@235 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Jason Tan 2005-08-29 16:52:54 +00:00
parent 0159b41637
commit 93d9e8c7b1
7 changed files with 83 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
README
View File

@ -4,20 +4,20 @@ conky(1) conky(1)
NAME
conky - A system monitor for X originally based on the torsmo code, but
more kickass. It just keeps on given'er.
more kickass. It just keeps on givener. Yeah.
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 app-
admin/conky" for installation. There is also usually an up-to-date
ebuild within Conky's package or in CVS.
Gentoo users, Conky is in Gentoos Portage. Simply use "emerge
app-admin/conky" for installation. There is also usually an up-to-date
ebuild within Conkys package or in CVS.
To compile and run Conky with all optional components:
@ -36,7 +36,7 @@ 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
@ -45,14 +45,14 @@ COMPILING
./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.
@ -63,11 +63,15 @@ 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).
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
conky". Saves you the trouble of having to stop and then restart!
conky". Saves you the trouble of having to stop and then restart.
IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the
metar stuff. mdsplib was causing way too many problems. hopefully
therell be a better solution in Conky 2.x...
OPTIONS
Command line options override configurations defined in configuration
@ -101,7 +105,7 @@ OPTIONS
-t TEXT
Text to render, remember single quotes, like -t ' $uptime '
Text to render, remember single quotes, like -t $uptime
-u SECONDS
@ -121,12 +125,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
@ -156,7 +160,7 @@ CONFIGURATION SETTINGS
default_shade_color
Default shading color and border's shading color
Default shading color and borders shading color
default_outline_color
@ -164,8 +168,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.
@ -254,7 +258,7 @@ CONFIGURATION SETTINGS
own_window_colour colour
If own_window_transparent no, set a specified background colour
(defaults to black). Takes either a hex value (#ffffff) or a
(defaults to black). Takes either a hex value (#ffffff) or a
valid RGB name (see /usr/lib/X11/rgb.txt)
@ -295,11 +299,11 @@ CONFIGURATION SETTINGS
VARIABLES
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)
addr interface
IP address for an interface
@ -336,7 +340,7 @@ VARIABLES
battery (num)
Remaining capacity in ACPI or APM battery. ACPI battery number
Remaining capacity in ACPI or APM battery. ACPI battery number
can be given as argument (default is BAT0).
@ -358,10 +362,10 @@ VARIABLES
cpubar (cpu number) (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 (cpu number) (height),(width) (gradient colour 1) (gradient
cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
colour 2)
CPU usage graph, with optional colours in hex, minus the #. See
$cpu for more info on SMP.
@ -370,7 +374,7 @@ VARIABLES
diskio Displays current disk IO.
diskiograph (height),(width) (gradient colour 1) (gradient colour 2)
diskiograph (height),(width) (gradient colour 1) (gradient colour 2)
(scale)
Disk IO graph, colours defined in hex, minus the #. If scale is
non-zero, it becomes the scale for the graph.
@ -384,7 +388,7 @@ VARIABLES
Download speed in kilobytes with one decimal
downspeedgraph net (height),(width) (gradient colour 1) (gradient
downspeedgraph net (height),(width) (gradient colour 1) (gradient
colour 2) (scale)
Download speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph.
@ -394,8 +398,8 @@ VARIABLES
exec 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.
@ -410,7 +414,7 @@ VARIABLES
execi interval 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.
@ -434,13 +438,13 @@ VARIABLES
freq_dyn
Returns CPU frequency in MHz, but is calculated by counting to
clock cycles to complete an instruction. Only available for
clock cycles to complete an instruction. Only available for
x86/amd64.
freq_dyn_g
Returns CPU frequency in GHz, but is calculated by counting to
clock cycles to complete an instruction. Only available for
clock cycles to complete an instruction. Only available for
x86/amd64.
@ -467,7 +471,7 @@ VARIABLES
head logfile lines (interval)
Displays first N lines of supplied text text file. If interval
is not supplied, Conky assumes 2x Conky's interval. Max of 30
is not supplied, Conky assumes 2x Conkys interval. Max of 30
lines can be displayed, or until the text buffer is filled.
@ -476,8 +480,8 @@ 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.
@ -512,21 +516,21 @@ VARIABLES
i8k_left_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays
the left fan's rate of rotation, in revolutions per minute as
the left fans rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
i8k_left_fan_status
If running the i8k kernel driver for Inspiron laptops, displays
the left fan status as listed in /proc/i8k (translated to human-
readable). Beware, some laptops i8k reports these fans in
the left fan status as listed in /proc/i8k (translated to
human-readable). Beware, some laptops i8k reports these fans in
reverse order.
i8k_right_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays
the right fan's rate of rotation, in revolutions per minute as
the right fans rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
@ -647,7 +651,7 @@ VARIABLES
mpd_bar (height),(width)
Bar of mpd's progress
Bar of mpds progress
mpd_bitrate
@ -663,19 +667,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
@ -736,26 +740,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 interval. Max of 30 lines
not supplied, Conky assumes 2x Conkys interval. Max of 30 lines
can be displayed, or until the text buffer is filled.
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
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
listed.
@ -810,7 +814,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.
@ -821,25 +825,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!

5
debian/changelog vendored
View File

@ -1,7 +1,6 @@
conky (1.2.9) hoary; urgency=low
conky (1.3.0-1) unstable; urgency=low
* Initial Release.
* This is my first Debian Package, hopefully it works.
* Initial Release (Closes: #320978).
-- Jason Tan <jtan325@gmail.com> Wed, 24 Aug 2005 00:10:49 -0700

5
debian/control vendored
View File

@ -2,9 +2,8 @@ Source: conky
Section: utils
Priority: optional
Maintainer: Jason Tan <jtan325@gmail.com>
Build-Depends: debhelper (>= 4.0.0), xlibs-dev, libtool (>= 1.5.6), automake1.9, autoconf (>= 2.59)
Build-Conflicts: autoconf2.13, automake1.4
Standards-Version: 3.6.1
Build-Depends: debhelper (>= 4.0.0), libx11-dev
Standards-Version: 3.6.2
Package: conky
Architecture: any

1
debian/docs vendored
View File

@ -1,4 +1,3 @@
NEWS
README
TODO
doc/docs.html

7
debian/rules vendored
View File

@ -26,11 +26,6 @@ endif
configure: configure-stamp
configure-stamp:
dh_testdir
aclocal-1.9
libtoolize --force
autoheader
automake-1.9 -a
autoconf
./configure --host=$(DEB_HOST_GNU_TYPE) --build=$(DEB_BUILD_GNU_TYPE) --prefix=/usr --mandir=\$${prefix}/share/man --infodir=\$${prefix}/share/info --enable-double-buffer --enable-own-window --enable-proc-uptime --enable-mpd --enable-xft --enable-seti
touch configure-stamp
@ -49,7 +44,7 @@ clean:
dh_testdir
dh_testroot
rm -f build-stamp configure-stamp
rm -f config.cache config.status config.log
-$(MAKE) clean
dh_clean

6
doc/docs.xml
View File

@ -126,7 +126,11 @@
</para>
<para>
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
Saves you the trouble of having to stop and then restart!
Saves you the trouble of having to stop and then restart.
</para>
<para>
IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
mdsplib was causing way too many problems. hopefully there'll be a better solution in Conky 2.x...
</para>
</refsect1>

2
doc/variables.xml
View File

@ -2,7 +2,7 @@
<varlistentry>
<term>
<command><option>addr</option></command>
<option>(interface)</option>
<option>interface</option>
</term>
<listitem>
IP address for an interface