mirror of
https://github.com/Llewellynvdm/conky.git
synced 2025-01-23 15:18:35 +00:00
fixed up some stuff in the docs
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@240 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
parent
e0f010f9c0
commit
cf39637f72
2
AUTHORS
2
AUTHORS
@ -48,7 +48,7 @@ Jason Mitchell <jason.mitchell03 at saintleo dot edu>
|
||||
|
||||
Jason Tan <jtan325 at users dot sourceforge dot net>
|
||||
developer
|
||||
debian package maintainer
|
||||
debian package maintainer
|
||||
|
||||
Joe Myre - <joemyre at users dot sourceforge dot net>
|
||||
developer
|
||||
|
269
README
269
README
@ -4,31 +4,37 @@ 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. Yeah.
|
||||
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.
|
||||
|
||||
Thanks for your interest in Conky.
|
||||
|
||||
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.
|
||||
For users compiling from source, 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 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.
|
||||
|
||||
Debian,etc. users -- Conky will be in Debians repositories soon (by
|
||||
mid-September, hopefully), and then Ubuntu shortly thereafter. Until
|
||||
then, "dpkg -i" the .deb package to install.
|
||||
|
||||
To compile and run Conky with all optional components:
|
||||
|
||||
@ -36,23 +42,23 @@ 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
|
||||
|
||||
make install # Optional
|
||||
|
||||
./conky
|
||||
src/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 probably doesnt compile with compilers other than gcc and icc.
|
||||
It doesnt compile with C89 compiler and not even with pure C99. It
|
||||
uses a 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,21 +69,21 @@ 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
|
||||
cetera).
|
||||
unless you think somethings seriously wrong (mem leak, etc.).
|
||||
|
||||
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
|
||||
conky". Saves you the trouble of having to stop and then restart.
|
||||
An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
|
||||
conky". Saves you the trouble of having to kill 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
|
||||
there'll be a better solution in Conky 2.x...
|
||||
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
|
||||
Command line options override configurations defined in configuration
|
||||
file.
|
||||
|
||||
-V Prints version and exits
|
||||
-v | -V
|
||||
Prints version and exits
|
||||
|
||||
|
||||
-a ALIGNMENT
|
||||
@ -105,7 +111,7 @@ OPTIONS
|
||||
|
||||
|
||||
-t TEXT
|
||||
Text to render, remember single quotes, like -t ' $uptime '
|
||||
Text to render, remember single quotes, like -t $uptime
|
||||
|
||||
|
||||
-u SECONDS
|
||||
@ -125,17 +131,21 @@ OPTIONS
|
||||
|
||||
|
||||
CONFIGURATION SETTINGS
|
||||
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.
|
||||
Default configuration file is $HOME/.conkyrc (can be changed from
|
||||
conky.c among other things). See conkyrc.sample. If installing from
|
||||
Debian package, this should be in /usr/share/doc/conky/examples ("gun
|
||||
zip conkyrc.sample.gz" to get conkyrc.sample).
|
||||
|
||||
You might want to copy it to $HOME/.conkyrc and then start modifying
|
||||
it. Other configs can be found at http://conky.sf.net
|
||||
|
||||
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
|
||||
|
||||
|
||||
background
|
||||
Boolean value, if true, Conky will be forked to background when
|
||||
Boolean value, if true, Conky will be forked to background when
|
||||
started
|
||||
|
||||
|
||||
@ -160,7 +170,7 @@ CONFIGURATION SETTINGS
|
||||
|
||||
|
||||
default_shade_color
|
||||
Default shading color and border's shading color
|
||||
Default shading color and borders shading color
|
||||
|
||||
|
||||
default_outline_color
|
||||
@ -168,8 +178,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.
|
||||
|
||||
|
||||
@ -188,11 +198,11 @@ CONFIGURATION SETTINGS
|
||||
font Font name in X, xfontsel can be used to get a nice font
|
||||
|
||||
|
||||
gap_x Gap between right or left border of screen, same as passing -x
|
||||
gap_x Gap between right or left border of screen, same as passing -x
|
||||
at command line
|
||||
|
||||
|
||||
gap_y Gap between top or bottom border of screen, same as passing -y
|
||||
gap_y Gap between top or bottom border of screen, same as passing -y
|
||||
at command line
|
||||
|
||||
|
||||
@ -257,8 +267,8 @@ 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
|
||||
If own_window_transparent no, set a specified background colour
|
||||
(defaults to black). Takes either a hex value (#ffffff) or a
|
||||
valid RGB name (see /usr/lib/X11/rgb.txt)
|
||||
|
||||
|
||||
@ -271,7 +281,7 @@ CONFIGURATION SETTINGS
|
||||
|
||||
|
||||
total_run_times
|
||||
Total number of times for Conky to update before quitting. Zero
|
||||
Total number of times for Conky to update before quitting. Zero
|
||||
makes Conky run forever
|
||||
|
||||
|
||||
@ -293,15 +303,15 @@ CONFIGURATION SETTINGS
|
||||
Use Xft (anti-aliased font and stuff)
|
||||
|
||||
|
||||
text After this begins text to be formatted on screen
|
||||
TEXT After this begins text to be formatted on screen
|
||||
|
||||
|
||||
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.
|
||||
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.
|
||||
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
|
||||
@ -340,7 +350,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).
|
||||
|
||||
|
||||
@ -356,27 +366,27 @@ VARIABLES
|
||||
|
||||
|
||||
cpu (cpuN)
|
||||
CPU usage in percents. For SMP machines, the CPU number can be
|
||||
CPU usage in percents. For SMP machines, the CPU number can be
|
||||
provided as an argument. cpu0 is the total usage, and >=cpu1 are
|
||||
individual CPUs. See $cpu for more info on SMP.
|
||||
|
||||
|
||||
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 usage graph, with optional colours in hex, minus the #. See
|
||||
$cpu for more info on SMP.
|
||||
|
||||
|
||||
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
|
||||
Disk IO graph, colours defined in hex, minus the #. If scale is
|
||||
non-zero, it becomes the scale for the graph.
|
||||
|
||||
|
||||
@ -388,9 +398,9 @@ 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
|
||||
Download speed graph, colours defined in hex, minus the #. If
|
||||
scale is non-zero, it becomes the scale for the graph.
|
||||
|
||||
|
||||
@ -398,14 +408,14 @@ 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.
|
||||
|
||||
|
||||
execbar command
|
||||
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
|
||||
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.
|
||||
|
||||
|
||||
@ -414,7 +424,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. See also $texeci
|
||||
|
||||
|
||||
@ -437,19 +447,19 @@ VARIABLES
|
||||
|
||||
|
||||
freq_dyn
|
||||
Returns CPU frequency in MHz, but is calculated by counting to
|
||||
clock cycles to complete an instruction. Only available for
|
||||
Returns CPU frequency in MHz, but is calculated by counting to
|
||||
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
|
||||
Returns CPU frequency in GHz, but is calculated by counting to
|
||||
clock cycles to complete an instruction. Only available for
|
||||
x86/amd64.
|
||||
|
||||
|
||||
fs_bar (height),(width) fs
|
||||
Bar that shows how much space is used on a file system. height
|
||||
Bar that shows how much space is used on a file system. height
|
||||
is the height in pixels. fs is any file on that file system.
|
||||
|
||||
|
||||
@ -470,8 +480,8 @@ 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
|
||||
Displays first N lines of supplied text text file. If interval
|
||||
is not supplied, Conky assumes 2x Conkys interval. Max of 30
|
||||
lines can be displayed, or until the text buffer is filled.
|
||||
|
||||
|
||||
@ -480,90 +490,90 @@ 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
|
||||
meaning temperature. n is number of the sensor. See
|
||||
/sys/bus/i2c/devices/ on your local computer.
|
||||
|
||||
|
||||
i8k_ac_status
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
whether ac power is on, as listed in /proc/i8k (translated to
|
||||
human-readable). Beware that this is by default not enabled by
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
whether ac power is on, as listed in /proc/i8k (translated to
|
||||
human-readable). Beware that this is by default not enabled by
|
||||
i8k itself.
|
||||
|
||||
|
||||
i8k_bios
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the bios version as listed in /proc/i8k.
|
||||
|
||||
|
||||
i8k_buttons_status
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the volume buttons status as listed in /proc/i8k.
|
||||
|
||||
|
||||
i8k_cpu_temp
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the cpu temperature in celsius, as reported by /proc/i8k.
|
||||
|
||||
|
||||
i8k_cpu_tempf
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the cpu temperature in farenheit, as reported by /proc/i8k.
|
||||
|
||||
|
||||
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
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
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
|
||||
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
|
||||
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
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
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.
|
||||
|
||||
|
||||
i8k_right_fan_status
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the right fan status as listed in /proc/i8k (translated to
|
||||
human-readable). Beware, some laptops i8k reports these fans in
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the right fan status as listed in /proc/i8k (translated to
|
||||
human-readable). Beware, some laptops i8k reports these fans in
|
||||
reverse order.
|
||||
|
||||
|
||||
i8k_serial
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
your laptop serial number as listed in /proc/i8k.
|
||||
|
||||
|
||||
i8k_version
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
If running the i8k kernel driver for Inspiron laptops, displays
|
||||
the version formatting of /proc/i8k.
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
if_existing (file)
|
||||
if FILE exists, display everything between if_existing and the
|
||||
if FILE exists, display everything between if_existing and the
|
||||
matching $endif
|
||||
|
||||
|
||||
if_mounted (mountpoint)
|
||||
if MOUNTPOINT is mounted, display everything between if_mounted
|
||||
if MOUNTPOINT is mounted, display everything between if_mounted
|
||||
and the matching $endif
|
||||
|
||||
|
||||
@ -583,8 +593,8 @@ VARIABLES
|
||||
Machine, i686 for example
|
||||
|
||||
|
||||
mails Mail count in mail spool. You can use program like fetchmail to
|
||||
get mails from some server using your favourite protocol. See
|
||||
mails Mail count in mail spool. You can use program like fetchmail to
|
||||
get mails from some server using your favourite protocol. See
|
||||
also new_mails.
|
||||
|
||||
|
||||
@ -651,7 +661,7 @@ VARIABLES
|
||||
|
||||
|
||||
mpd_bar (height),(width)
|
||||
Bar of mpd's progress
|
||||
Bar of mpds progress
|
||||
|
||||
|
||||
mpd_bitrate
|
||||
@ -667,19 +677,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
|
||||
@ -735,12 +745,12 @@ VARIABLES
|
||||
|
||||
|
||||
texeci interval command
|
||||
Runs a command at an interval inside a thread and displays the
|
||||
output. Same as $execi, except the command is run inside a
|
||||
thread. Use this if you have a slow script to keep Conky updat-
|
||||
ing. You should make the interval slightly longer then the time
|
||||
it takes your script to execute. For example, if you have a
|
||||
script that take 5 seconds to execute, you should make the
|
||||
Runs a command at an interval inside a thread and displays the
|
||||
output. Same as $execi, except the command is run inside a
|
||||
thread. Use this if you have a slow script to keep Conky updat
|
||||
ing. You should make the interval slightly longer then the time
|
||||
it takes your script to execute. For example, if you have a
|
||||
script that take 5 seconds to execute, you should make the
|
||||
interval at least 6 seconds. See also $execi.
|
||||
|
||||
|
||||
@ -750,26 +760,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
|
||||
Total download, overflows at 4 GB on Linux with 32-bit arch and
|
||||
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
|
||||
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
|
||||
listed.
|
||||
|
||||
|
||||
@ -793,9 +803,9 @@ VARIABLES
|
||||
Upload speed in kilobytes with one decimal
|
||||
|
||||
|
||||
upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
|
||||
upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
|
||||
2) (scale)
|
||||
Upload speed graph, colours defined in hex, minus the #. If
|
||||
Upload speed graph, colours defined in hex, minus the #. If
|
||||
scale is non-zero, it becomes the scale for the graph.
|
||||
|
||||
|
||||
@ -819,12 +829,12 @@ VARIABLES
|
||||
|
||||
|
||||
voffset (pixels)
|
||||
Change verticle offset by N pixels. Negative values will cause
|
||||
Change verticle offset by N pixels. Negative values will cause
|
||||
text to overlap. See also $offset.
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -835,25 +845,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!
|
||||
|
||||
|
||||
|
||||
|
15
TODO
15
TODO
@ -10,17 +10,4 @@ after 1.3.0 only maintenance releases will follow, no new features for the 1.x s
|
||||
|
||||
2.0.0 - hopefully by christmas at the latest
|
||||
* rewrite core of Conky in C++
|
||||
* implement new features like a cairo backend, network transparency, and whatever else
|
||||
|
||||
|
||||
######################################
|
||||
# POSSIBLE FEATURES TO ADD #
|
||||
######################################
|
||||
|
||||
[jtan325]
|
||||
|
||||
- math computation. for example, a user wants to know the total memory used by the top two memory-hogging processes, the user could do math operations, something like ${top mem 1} [+] ${top mem 2}, where "[" and "]" are special symbols (obviously this would be a bad choice of special symbol delimiter, but it's just for example) to denote a mathematical operation to perform and print the result.
|
||||
|
||||
- stock quotes. not sure if this is something within conky's intended realm, but yeah, it'd basically query some free quote websites and the user would provide the stock symbol(s) or something. i know konfabulator! has a stock quotes widget...
|
||||
|
||||
- more customizable placement of information. users may not want everything in one big box, but rather, spread along the bottom/top of the screen. this would be pretty hard to code right, for varying levels of flexibility.
|
||||
* implement new features like a cairo backend, network transparency, and whatever else
|
@ -1,6 +1,6 @@
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><command><option>-V</option></command></term>
|
||||
<term><command><option>-v | -V</option></command></term>
|
||||
<listitem>
|
||||
Prints version and exits
|
||||
<para></para></listitem>
|
||||
|
@ -279,7 +279,7 @@
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command><option>text</option></command></term>
|
||||
<term><command><option>TEXT</option></command></term>
|
||||
<listitem>
|
||||
After this begins text to be formatted on screen
|
||||
<para></para></listitem>
|
||||
|
43
doc/docs.xml
43
doc/docs.xml
@ -57,11 +57,18 @@
|
||||
<refsect1>
|
||||
<title>Compiling</title>
|
||||
<para>
|
||||
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.
|
||||
For users compiling from source, make sure you have the X development libraries installed.
|
||||
This should be a package along the lines of "libx11-dev or xorg-x11-dev".
|
||||
</para>
|
||||
<para>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then
|
||||
Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install.
|
||||
</para>
|
||||
<para>
|
||||
To compile and run Conky with all optional components:
|
||||
</para>
|
||||
<variablelist>
|
||||
@ -73,10 +80,10 @@
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command><option>./configure </option></command><option>
|
||||
--prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
|
||||
--datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib
|
||||
--enable-double-buffer --enable-own-window --enable-proc-uptime
|
||||
--enable-mpd --enable-xft --enable-seti</option>
|
||||
--prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
|
||||
--datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib
|
||||
--enable-double-buffer --enable-own-window --enable-proc-uptime
|
||||
--enable-mpd --enable-xft --enable-seti</option>
|
||||
</term>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@ -91,14 +98,14 @@
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command><option>./conky</option></command>
|
||||
<command><option>src/conky</option></command>
|
||||
</term>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>
|
||||
Conky doesn't probably compile with other compilers than gcc and icc.
|
||||
Conky probably doesn't compile with compilers other 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(), strncasecmp(),
|
||||
It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(),
|
||||
optarg variable with getopt() and long long (not in C89). Crashes in file system
|
||||
statistics stuff when compiled with icc, I don't know exactly why.
|
||||
</para>
|
||||
@ -122,15 +129,15 @@
|
||||
</para>
|
||||
<para>
|
||||
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).
|
||||
unless you think something's seriously wrong (mem leak, etc.).
|
||||
</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.
|
||||
An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
|
||||
Saves you the trouble of having to kill 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...
|
||||
mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
@ -148,8 +155,12 @@
|
||||
|
||||
<para>
|
||||
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.
|
||||
conky.c among other things). See conkyrc.sample. If installing from Debian package,
|
||||
this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
|
||||
</para>
|
||||
<para>
|
||||
You might want to copy it to $HOME/.conkyrc and then start modifying it.
|
||||
Other configs can be found at http://conky.sf.net
|
||||
</para>
|
||||
|
||||
&config_settings;
|
||||
@ -161,7 +172,7 @@
|
||||
<para>
|
||||
Colors are parsed using XParsecolor(), there might be a list of them:
|
||||
/usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
|
||||
http://sedition.com/perl/rgb.html</ulink>
|
||||
http://sedition.com/perl/rgb.html</ulink>.
|
||||
Color can be also in #rrggbb format (hex).
|
||||
|
||||
Note that when displaying bytes, power is 1024 and not 1000 so 1M really
|
||||
|
Loading…
x
Reference in New Issue
Block a user