1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-09-29 13:39:10 +00:00

doc updates, mostly

git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@42 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2005-08-02 03:08:54 +00:00
parent 40064a978f
commit 17ef518559
4 changed files with 536 additions and 515 deletions

51
README
View File

@ -2,37 +2,32 @@
WHAT IS CONKY?
Conky is a system monitor for Linux that sits in the corner of your
desktop. Conky renders itself on the root window (on the desktop) or to
its own transparent window any special eyecandy.
Conky can show lots of info about your system, including:
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. Conky has many built-in
objects, as well as the ability to execute programs and scripts,
then display the output from stdout.
* kernel version
* uptime
* network interface information
* memory and swap usage
* hostname
* machine, i686 for example
* system name, Linux for example
* temperatures from i2c-sensors
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.
THINGS YOU SHOULD KNOW
Conky is generally very good on resources. However, certain objects in
Conky are harder on resources then others. In particular, the $tail and
$top objects are quite costly in comparison to the rest of Conky.
Conky are harder on resources then others. In particular, the $tail,
$top, and $graph objects are quite costly in comparison to the rest of Conky.
If you do use them, please do not complain about memory or CPU usage,
because you will simply be ignored.
With that out of the way, if you have a better way of doing something,
please submit a patch for Conky. I know I am certainly not the world's
best programmer, and I still have a lot to learn.
unless you think something is going seriously wrong (mem leak, et cetera).
COMPILING
To compile and run Conky with all optional components (If you run Gentoo, see the "Ebuild" Section below):
./configure --prefix=/usr --enable-xft --enable-mpd --enable-seti --enable-double-buffer --enable-own-window --enable-proc-uptime
./configure --prefix=/usr --enable-xft --enable-mpd --enable-seti --enable-double-buffer --enable-own-window --enable-proc-uptime --enable-metar --enable-mldonkey
make
./conky
@ -48,6 +43,8 @@
EBUILD
Conky is in Gentoo's Portage. Simply use "emerge conky" to install conky.
There is also usually an up-to-date ebuild within Conky's package or in
CVS.
CONFIGURING
@ -159,12 +156,14 @@
cpubar (height) Bar that shows CPU usage, height is
bar's height in pixels
cpugraph (height),(width) (gradient colour 1) (gradient colour 2)
CPU usage graph
CPU usage graph, with optional colours in hex,
minus the #.
downspeed net Download speed in kilobytes
downspeedf net Download speed in kilobytes with one
decimal
downspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2)
Download speed graph
Download speed graph, colours defined in
hex, minus the #.
exec shell command Executes a shell command and displays
the output in conky. warning: this
takes a lot more resources than other
@ -176,8 +175,9 @@
The size for the bar is currently fixed,
but that may change in the future.
execgraph shell command Same as execbar, but graphs values
execi interval, shell Same as exec but with specific interval.
command Interval can't be less than
execi interval, shell command
Same as exec but with specific interval.
Interval can't be less than
update_interval in configuration.
fs_bar (height), (fs)Bar that shows how much space is used on
a file system. height is the height in
@ -303,7 +303,8 @@
upspeedf net Upload speed in kilobytes with one
decimal
upspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2)
Upload speed graph
Upload speed graph, colours defined in
hex, minus the #.
uptime Uptime
uptime_short Uptime in a shorter format

10
conky.c
View File

@ -356,7 +356,15 @@ static const char *scan_graph(const char *args, int *w, int *h, unsigned int *fi
if (args) {
if (sscanf(args, "%*s %d,%d %x %x", h, w, first_colour, last_colour) < 4) {
if (sscanf(args, "%*s %x %x", first_colour, last_colour) < 2) {
sscanf(args, "%x %x", first_colour, last_colour);
if (sscanf(args, "%x %x", first_colour, last_colour) < 2) {
if (sscanf(args, "%d,%d", h, w) < 2) {
sscanf(args, "%*s %d,%d", h, w);
*first_colour = 0;
*last_colour = 0;
}
*first_colour = 0;
*last_colour = 0;
}
*w = 0;
*h = 25;
}

View File

@ -381,7 +381,7 @@ int get_mldonkey_status(mldonkey_config * config, mldonkey_info * info);
/* in linux.c */
extern int show_nice_processes;
//static int show_nice_processes;
/* in cairo.c */

View File

@ -1,6 +1,6 @@
# conky configuration
# set to yes if you want tormo to be forked in the background
# set to yes if you want Conky to be forked in the background
background no
# X font when Xft is disabled, you can pick one with program xfontsel
@ -8,12 +8,19 @@ background no
#font 6x10
#font 7x13
#font 8x13
font 9x15
#font 9x15
#font *mintsmild.se*
#font -*-*-*-*-*-*-34-*-*-*-*-*-*-*
# Use Xft?
use_xft no
use_xft yes
# Xft font when Xft is enabled
xftfont Bitstream Vera Sans Mono:size=8
# Text alpha when using Xft
xftalpha 0.8
# Print everything to stdout?
# out_to_console no
@ -25,12 +32,6 @@ use_xft no
# Print everything to console?
# out_to_console no
# Xft font when Xft is enabled
xftfont courier-12
# Text alpha when using Xft
xftalpha 0.8
# mail spool
mail_spool $MAIL
@ -92,11 +93,11 @@ uppercase no
# number of cpu samples to average
# set to 1 to disable averaging
cpu_avg_samples 4
cpu_avg_samples 2
# number of net samples to average
# set to 1 to disable averaging
net_avg_samples 4
net_avg_samples 2
# Force UTF8? note that UTF8 support required XFT
override_utf8_locale no
@ -111,6 +112,7 @@ use_spacer no
# mldonkey_password Mldonkey password, default none
# METAR station code for weather, get codes from weather.noaa.gov or google
# or http://www.maltalinks.com/weather/ (thanks Hopeless @ f.g.o)
metar_station CYBW
# METAR ftp server
@ -144,12 +146,14 @@ metar_station CYBW
# cpubar (height) Bar that shows CPU usage, height is
# bar's height in pixels
# cpugraph (height),(width) (gradient colour 1) (gradient colour 2)
# CPU usage graph
# CPU usage graph, with optional colours in hex,
# minus the #.
# downspeed net Download speed in kilobytes
# downspeedf net Download speed in kilobytes with one
# decimal
# downspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2)
# Download speed graph
# Download speed graph, colours defined in
# hex, minus the #.
# exec shell command Executes a shell command and displays
# the output in conky. warning: this
# takes a lot more resources than other
@ -161,8 +165,9 @@ metar_station CYBW
# The size for the bar is currently fixed,
# but that may change in the future.
# execgraph shell command Same as execbar, but graphs values
# execi interval, shell Same as exec but with specific interval.
# command Interval can't be less than
# execi interval, shell command
# Same as exec but with specific interval.
# Interval can't be less than
# update_interval in configuration.
# fs_bar (height), (fs)Bar that shows how much space is used on
# a file system. height is the height in
@ -217,7 +222,7 @@ metar_station CYBW
# metar_swinddir
# metar_cloud
# metar_u2d_time
#
# ml_upload_counter total session upload in mb
# ml_download_counter total session download in mb
# ml_nshared_files number of shared files
@ -288,7 +293,8 @@ metar_station CYBW
# upspeedf net Upload speed in kilobytes with one
# decimal
# upspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2)
# Upload speed graph
# Upload speed graph, colours defined in
# hex, minus the #.
# uptime Uptime
# uptime_short Uptime in a shorter format
#
@ -306,25 +312,31 @@ metar_station CYBW
TEXT
$nodename - $sysname $kernel on $machine
$stippled_hr
${color grey}Uptime$color $uptime
${color grey}RAM Usage:$color $mem/$memmax - $memperc% ${membar 6}
${color grey}Swap Usage:$color $swap/$swapmax - $swapperc% ${swapbar 6}
${color grey}CPU Usage:$color $cpu% ${cpubar 6}
${color grey}Processes:$color $processes ${color grey}Running:$color $running_processes
${color grey}Mails: ${color}$mails${color grey} New: ${color}$new_mails${color grey}
${color lightgrey}Uptime:$color $uptime ${color lightgrey}- Load:$color $loadavg
${color lightgrey}CPU Usage:${color #cc2222} $cpu% ${cpubar}
${color red}${cpugraph 0000ff 00ff00}
${color lightgrey}RAM Usage:$color $mem/$memmax - $memperc% ${membar}
${color lightgrey}Swap Usage:$color $swap/$swapmax - $swapperc% ${swapbar}
${color lightgrey}Processes:$color $processes ${color grey}Running:$color $running_processes
$color$stippled_hr
${color grey}Networking:
Up:$color ${upspeed eth0} k/s${color grey} - Down:$color ${downspeed eth0} k/s
${color grey}File systems:
/ $color${fs_free /}/${fs_size /} ${fs_bar 6 /}
${color grey}Temperatures:
CPU:$color ${i2c temp 1}°C${color grey} - MB:$color ${i2c temp 2}°C
${color grey}MPD:
$mpd_status ${alignc}$mpd_artist - $mpd_title from $mpd_album at $mpd_vol $mpd_bitrate
$mpd_bar
${color grey}Name PID CPU% MEM%
${color lightgrey} ${top name 1} ${top pid 1} ${top cpu 1} ${top mem 1}
${color lightgrey}Networking:
Down:${color #8844ee} ${downspeed eth0} k/s${color lightgrey} ${offset 80}Up:${color #22ccff} ${upspeed eth0} k/s
${color #0000ff}${downspeedgraph eth0 32,150 ff0000 0000ff} ${color #22ccff}${upspeedgraph eth0 32,150 0000ff ff0000}
${color lightgrey}File systems:
/ $color${fs_used /}/${fs_size /} ${fs_bar /}
${color lightgrey}Temperatures:
CPU:$color ${i2c temp 2}C${color grey} - MB:$color ${i2c temp 1}C
${color #88aadd}MPD: ${alignc}$mpd_artist - $mpd_title
${color #88aadd}$mpd_bar
${color #88aadd}${alignc}$mpd_status
${color}Name PID CPU% MEM%
${color #ddaa00} ${top name 1} ${top pid 1} ${top cpu 1} ${top mem 1}
${color lightgrey} ${top name 2} ${top pid 2} ${top cpu 2} ${top mem 2}
${color lightgrey} ${top name 3} ${top pid 3} ${top cpu 3} ${top mem 3}
${color lightgrey} ${top name 4} ${top pid 4} ${top cpu 4} ${top mem 4}
${color}Mem usage
${color #ddaa00} ${top_mem name 1} ${top_mem pid 1} ${top_mem cpu 1} ${top_mem mem 1}
${color lightgrey} ${top_mem name 2} ${top_mem pid 2} ${top_mem cpu 2} ${top_mem mem 2}
${color lightgrey} ${top_mem name 3} ${top_mem pid 3} ${top_mem cpu 3} ${top_mem mem 3}
${color}Current conditions: ${color lightgrey}${metar_temp}C $metar_cloud
${tail /var/log/Xorg.0.log 3 30}
${metar_temp}C $metar_cloud