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? WHAT IS CONKY?
Conky is a system monitor for Linux that sits in the corner of your Conky is a system monitor for X originally based on the torsmo code.
desktop. Conky renders itself on the root window (on the desktop) or to Since it's original conception, Conky has changed a fair bit from
its own transparent window any special eyecandy. it's predecessor. Conky can display just about anything, either on
Conky can show lots of info about your system, including: 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 We are always looking for help, and anyone interested in becoming
* uptime a developer is welcome. Please use the facilities at SourceForge
* network interface information to make bug reports, feature requests, and submit patches.
* memory and swap usage
* hostname Thanks for your interest in Conky.
* machine, i686 for example
* system name, Linux for example
* temperatures from i2c-sensors
THINGS YOU SHOULD KNOW THINGS YOU SHOULD KNOW
Conky is generally very good on resources. However, certain objects in Conky is generally very good on resources. However, certain objects in
Conky are harder on resources then others. In particular, the $tail and Conky are harder on resources then others. In particular, the $tail,
$top objects are quite costly in comparison to the rest of Conky. $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, If you do use them, please do not complain about memory or CPU usage,
because you will simply be ignored. unless you think something is going seriously wrong (mem leak, et cetera).
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.
COMPILING COMPILING
To compile and run Conky with all optional components (If you run Gentoo, see the "Ebuild" Section below): 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 make
./conky ./conky
@ -48,6 +43,8 @@
EBUILD EBUILD
Conky is in Gentoo's Portage. Simply use "emerge conky" to install conky. 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 CONFIGURING
@ -159,12 +156,14 @@
cpubar (height) Bar that shows CPU usage, height is cpubar (height) Bar that shows CPU usage, height is
bar's height in pixels bar's height in pixels
cpugraph (height),(width) (gradient colour 1) (gradient colour 2) 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 downspeed net Download speed in kilobytes
downspeedf net Download speed in kilobytes with one downspeedf net Download speed in kilobytes with one
decimal decimal
downspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2) 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 exec shell command Executes a shell command and displays
the output in conky. warning: this the output in conky. warning: this
takes a lot more resources than other takes a lot more resources than other
@ -176,8 +175,9 @@
The size for the bar is currently fixed, The size for the bar is currently fixed,
but that may change in the future. but that may change in the future.
execgraph shell command Same as execbar, but graphs values execgraph shell command Same as execbar, but graphs values
execi interval, shell Same as exec but with specific interval. execi interval, shell command
command Interval can't be less than Same as exec but with specific interval.
Interval can't be less than
update_interval in configuration. update_interval in configuration.
fs_bar (height), (fs)Bar that shows how much space is used on fs_bar (height), (fs)Bar that shows how much space is used on
a file system. height is the height in a file system. height is the height in
@ -303,7 +303,8 @@
upspeedf net Upload speed in kilobytes with one upspeedf net Upload speed in kilobytes with one
decimal decimal
upspeedgraph net (height),(width) (gradient colour 1) (gradient colour 2) 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 Uptime
uptime_short Uptime in a shorter format 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 (args) {
if (sscanf(args, "%*s %d,%d %x %x", h, w, first_colour, last_colour) < 4) { 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) { 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; *w = 0;
*h = 25; *h = 25;
} }

View File

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

View File

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