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

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

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

95
README
View File

@ -4,16 +4,16 @@ conky(1) conky(1)
NAME NAME
conky - A system monitor for X originally based on the torsmo code, but 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 SYNOPSIS
conky [options] conky [options]
DESCRIPTION DESCRIPTION
Conky is a system monitor for X originally based on the torsmo code. 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 Since its original conception, Conky has changed a fair bit from its
predecessor. Conky can display just about anything, either on your predecessor. Conky can display just about anything, either on your
root desktop or in it's own window. Conky has many built-in objects, 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 as well as the ability to execute programs and scripts, then display
the output from stdout. the output from stdout.
@ -26,9 +26,9 @@ DESCRIPTION
COMPILING COMPILING
First, make sure you have the X development libraries installed, this 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". 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- Gentoo users, Conky is in Gentoos Portage. Simply use "emerge
admin/conky" for installation. There is also usually an up-to-date app-admin/conky" for installation. There is also usually an up-to-date
ebuild within Conky's package or in CVS. ebuild within Conkys package or in CVS.
To compile and run Conky with all optional components: To compile and run Conky with all optional components:
@ -45,14 +45,14 @@ COMPILING
./conky ./conky
Conky doesn't probably compile with other compilers than gcc and icc. Conky doesnt probably compile with other compilers than gcc and icc.
It doesn't compile with C89 compiler and not even with pure C99. It It doesnt compile with C89 compiler and not even with pure C99. It
uses few things that might not exist: strdup(), strcasecmp(), strn- uses few things that might not exist: strdup(), strcasecmp(), strn
casecmp(), optarg variable with getopt() and long long (not in C89). casecmp(), optarg variable with getopt() and long long (not in C89).
Crashes in file system statistics stuff when compiled with icc, I don't Crashes in file system statistics stuff when compiled with icc, I dont
know exactly why. 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. it by passing --disable-own-window to configure -script.
@ -67,7 +67,11 @@ YOU SHOULD KNOW
cetera). cetera).
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 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 OPTIONS
Command line options override configurations defined in configuration Command line options override configurations defined in configuration
@ -101,7 +105,7 @@ OPTIONS
-t TEXT -t TEXT
Text to render, remember single quotes, like -t ' $uptime ' Text to render, remember single quotes, like -t $uptime
-u SECONDS -u SECONDS
@ -126,7 +130,7 @@ CONFIGURATION SETTINGS
it to $HOME/.conkyrc and then start modifying it. it to $HOME/.conkyrc and then start modifying it.
alignment 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 tom_left, bottom_right, or none
@ -156,7 +160,7 @@ CONFIGURATION SETTINGS
default_shade_color default_shade_color
Default shading color and border's shading color Default shading color and borders shading color
default_outline_color default_outline_color
@ -164,8 +168,8 @@ CONFIGURATION SETTINGS
double_buffer double_buffer
Use the Xdbe extension? (eliminates flicker) It is highly recom- Use the Xdbe extension? (eliminates flicker) It is highly recom
mended to use own window with this one so double buffer won't be mended to use own window with this one so double buffer wont be
so big. so big.
@ -295,11 +299,11 @@ CONFIGURATION SETTINGS
VARIABLES 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 /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 Color can be also in #rrggbb format (hex). Note that when displaying
(hex). Note that when displaying bytes, power is 1024 and not 1000 so bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
1M really means 1024*1024 bytes and not 1000*1000. and not 1000*1000.
addr (interface) addr interface
IP address for an interface IP address for an interface
@ -358,7 +362,7 @@ VARIABLES
cpubar (cpu number) (height),(width) 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
@ -394,8 +398,8 @@ VARIABLES
exec command exec command
Executes a shell command and displays the output in conky. warn- Executes a shell command and displays the output in conky. warn
ing: this takes a lot more resources than other variables. I'd ing: this takes a lot more resources than other variables. Id
recommend coding wanted behaviour in C and posting a patch. recommend coding wanted behaviour in C and posting a patch.
@ -410,7 +414,7 @@ VARIABLES
execi interval command 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. than update_interval in configuration.
@ -467,7 +471,7 @@ VARIABLES
head logfile lines (interval) head logfile lines (interval)
Displays first N lines of supplied text text file. If 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. lines can be displayed, or until the text buffer is filled.
@ -512,21 +516,21 @@ VARIABLES
i8k_left_fan_rpm i8k_left_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays 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 listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
i8k_left_fan_status i8k_left_fan_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the left fan status as listed in /proc/i8k (translated to human- the left fan status as listed in /proc/i8k (translated to
readable). Beware, some laptops i8k reports these fans in human-readable). Beware, some laptops i8k reports these fans in
reverse order. reverse order.
i8k_right_fan_rpm i8k_right_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays 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 listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
@ -647,7 +651,7 @@ VARIABLES
mpd_bar (height),(width) mpd_bar (height),(width)
Bar of mpd's progress Bar of mpds progress
mpd_bitrate mpd_bitrate
@ -663,19 +667,19 @@ VARIABLES
mpd_vol mpd_vol
MPD's volume MPDs volume
mpd_elapsed mpd_elapsed
Song's elapsed time Songs elapsed time
mpd_length mpd_length
Song's length Songs length
mpd_percent mpd_percent
Percent of song's progress Percent of songs progress
new_mails new_mails
@ -736,18 +740,18 @@ VARIABLES
tail logfile lines (interval) tail logfile lines (interval)
Displays last N lines of supplied text text file. If interval is 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. can be displayed, or until the text buffer is filled.
time (format) 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 mat
totaldown net totaldown net
Total download, overflows at 4 GB on Linux with 32-bit arch and 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. already done that before conky has started.
@ -810,7 +814,7 @@ VARIABLES
EXAMPLES 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 Start Conky in its own window with date and clock as text and 30
sec update interval. sec update interval.
@ -821,9 +825,9 @@ FILES
~/.conkyrc default configuration file ~/.conkyrc default configuration file
BUGS BUGS
Drawing to root or some other desktop window directly doesn't work with Drawing to root or some other desktop window directly doesnt work with
all window managers. Especially doesn't work well with Gnome and it has all window managers. Especially doesnt work well with Gnome and it has
been reported that it doesn't work with KDE either. Nautilus can be been reported that it doesnt work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree Conky to set some specific window id. You might find xwininfo -tree
@ -831,15 +835,14 @@ BUGS
which makes Conky to create its own window. which makes Conky to create its own window.
SEE ALSO SEE ALSO
http://conky.sourceforge.net [http://conky.sourceforge.net] http://conky.sourceforge.net
http://www.sourceforge.net/projects/conky [http://www.source- http://www.sourceforge.net/projects/conky
forge.net/projects/conky]
#conky on irc.freenode.net #conky on irc.freenode.net
AUTHORS 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. * Initial Release (Closes: #320978).
* This is my first Debian Package, hopefully it works.
-- Jason Tan <jtan325@gmail.com> Wed, 24 Aug 2005 00:10:49 -0700 -- 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 Section: utils
Priority: optional Priority: optional
Maintainer: Jason Tan <jtan325@gmail.com> Maintainer: Jason Tan <jtan325@gmail.com>
Build-Depends: debhelper (>= 4.0.0), xlibs-dev, libtool (>= 1.5.6), automake1.9, autoconf (>= 2.59) Build-Depends: debhelper (>= 4.0.0), libx11-dev
Build-Conflicts: autoconf2.13, automake1.4 Standards-Version: 3.6.2
Standards-Version: 3.6.1
Package: conky Package: conky
Architecture: any Architecture: any

1
debian/docs vendored
View File

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

7
debian/rules vendored
View File

@ -26,11 +26,6 @@ endif
configure: configure-stamp configure: configure-stamp
configure-stamp: configure-stamp:
dh_testdir 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 ./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 touch configure-stamp
@ -49,7 +44,7 @@ clean:
dh_testdir dh_testdir
dh_testroot dh_testroot
rm -f build-stamp configure-stamp rm -f build-stamp configure-stamp
rm -f config.cache config.status config.log
-$(MAKE) clean -$(MAKE) clean
dh_clean dh_clean

View File

@ -126,7 +126,11 @@
</para> </para>
<para> <para>
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky". 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> </para>
</refsect1> </refsect1>

View File

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