Thanks for your interest in Conky.
COMPILING
- To compile and run Conky with all optional components (If you run Gen
- too, see the "Ebuild" Section below):
+ 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 Gentoos Portage. Simply use "emerge 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:
+
+ sh autogen.sh # Only required if building from CVS
./configure --prefix=/usr --mandir=/usr/share/man
- --infodir=/usr/share/info --datadir=/usr/ share --sysconfdir=/etc
+ --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-metar
- --enable-seti
+ --enable-proc-uptime --enable-mpd --enable-xft --enable-seti
make
+ make install # Optional
+
./conky
- 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).
+ 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 dont need
+ You can disable drawing to own window feature in case you dont need
it by passing --disable-own-window to configure -script.
- Conky is in Gentoos Portage. Simply use "emerge conky" to install
- conky. There is also usually an up-to-date ebuild within Conkys pack
- age or in CVS.
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,
- $top, $font, and $graph objects are quite costly in comparison to the
+ Conky is generally very good on resources. However, certain objects in
+ Conky are harder on resources then others. In particular, the $tail,
+ $top, $font, 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,
- unless you think something is going seriously wrong (mem leak, et
+ 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).
+ Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
+ conky". Saves you the trouble of having to stop and then restart!
+
OPTIONS
Command line options override configurations defined in configuration
file.
-a ALIGNMENT
- Text alignment on screen, {top,bottom}_{left,right}
+ Text alignment on screen, {top,bottom}_{left,right} or none
- -b Use double buffering (eliminates flicker)
+ -b Use double buffering (eliminates "flicker")
-c FILE
Config file to load instead of $HOME/.conkyrc
- -d Daemonize, fork to background
+ -d Daemonize Conky, aka fork to background
-f FONT
alignment
Aligned position on screen, may be top_left, top_right, bot
- tom_left, bottom_right
+ tom_left, bottom_right, or none
background
Mail spool for mail checking
- metar_station
- METAR station code for weather, see http://www.wrh.noaa.gov/ if
- you need to find your code.
-
+ maximum_width pixels
+ Maximum width of window
- metar_server
- Define a custom METAR ftp server
-
- metar_path
- Path on server to use
-
-
- minimum_size
+ minimum_size width (height)
Minimum size of window
Host of MPD server
- mpd_post
+ mpd_port
Port of MPD server
Boolean, create own window to draw?
+ own_window_transparent
+ Boolean, set pseudo-transparency?
+
+
+ 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
+ valid RGB name (see /usr/lib/X11/rgb.txt)
+
+
pad_percents
Pad percentages to this many decimals (0 = no padding)
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
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
- 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
+ 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)
acpitemp
- ACPI temperature.
+ ACPI temperature in C.
+
+
+ acpitempf
+ ACPI temperature in F.
adt746xcpu
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).
Change drawing color to color
- cpu CPU usage in percents
+ cpu (cpuN)
+ 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 (height)
+ cpubar (cpu number) (height),(width)
Bar that shows CPU usage, height is bars height in pixels
- cpugraph (height, width, gradient colour 1, gradient colour 2)
- CPU usage graph, with optional colours in hex, minus the #.
+ 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.
+
+
+ diskio Displays current disk IO.
+
+
+ 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.
downspeed net
Download speed in kilobytes with one decimal
- downspeedgraph net, (height, width, gradient colour 1, gradient colour
- 2)
- Download speed graph, colours defined in hex, minus the #.
+ 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.
else Text to show if any of the above are not true
- exec shell command
+ exec command
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 shell command
+ 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
the bar is currently fixed, but that may change in the future.
- execgraph shell command
- Same as execbar, but graphs values
+ execgraph command
+ Same as execbar, but graphs values.
- execi interval, shell command
+ execi interval command
Same as exec but with specific interval. Interval cant be less
than update_interval in configuration.
+ execibar interval command
+ Same as execbar, except with an interval
+
+
+ execigraph interval command
+ Same as execigraph, but takes an interval arg graphs values
+
+
font font
Specify a different font. Only applies to one line.
- fs_bar (height, fs)
+ freq Returns CPU frequency in MHz
+
+
+ freq_g Returns CPU frequency in GHz
+
+
+ freq_dyn
+ 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
+ x86/amd64.
+
+
+ fs_bar (height),(width) fs
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.
File system used space
+ head logfile lines (interval)
+ 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.
+
+
hr (height)
Horizontal line, height is the height in pixels
/sys/bus/i2c/devices/ on your local computer.
- if_running (process)
- if PROCESS is running, display everything if_running and the
- matching $endif
+ 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
+ i8k itself.
- if_existing (file)
- if FILE exists, display everything between if_existing and the
- matching $endif
+ i8k_bios
+ If running the i8k kernel driver for Inspiron laptops, displays
+ the bios version as listed in /proc/i8k.
- if_mounted (mountpoint)
- if MOUNTPOINT is mounted, display everything between if_mounted
- and the matching $endif
+ i8k_buttons_status
+ If running the i8k kernel driver for Inspiron laptops, displays
+ the volume buttons status as listed in /proc/i8k.
- kernel Kernel version
+ i8k_cpu_temp
+ If running the i8k kernel driver for Inspiron laptops, displays
+ the cpu temperature in celsius, as reported by /proc/i8k.
- linkstatus (interface)
- Get the link status for wireless connections
+ i8k_cpu_tempf
+ If running the i8k kernel driver for Inspiron laptops, displays
+ the cpu temperature in farenheit, as reported by /proc/i8k.
- loadavg
- (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
- 5 minutes and 3 for past 15 minutes.
+ i8k_left_fan_rpm
+ 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.
- machine
- Machine, i686 for example
+ 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
+ reverse order.
- 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.
+ i8k_right_fan_rpm
+ 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.
- mem Amount of memory in use
+ 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
+ reverse order.
- membar (height)
- Bar that shows amount of memory in use
+ i8k_serial
+ If running the i8k kernel driver for Inspiron laptops, displays
+ your laptop serial number as listed in /proc/i8k.
- memmax Total amount of memory
+ i8k_version
+ If running the i8k kernel driver for Inspiron laptops, displays
+ the version formatting of /proc/i8k.
- memperc
- Percentage of memory in use
+ if_running (process)
+ if PROCESS is running, display everything if_running and the
+ matching $endif
- metar_ob_time
- self-explanatory
+ if_existing (file)
+ if FILE exists, display everything between if_existing and the
+ matching $endif
- metar_temp
- self-explanatory
+ if_mounted (mountpoint)
+ if MOUNTPOINT is mounted, display everything between if_mounted
+ and the matching $endif
- metar_tempf
- temp in F
+ kernel Kernel version
- metar_windchill
- self-explanatory
+ linkstatus interface
+ Get the link status for wireless connections
- metar_dew_poin
- self-explanatory
+ loadavg
+ (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
+ 5 minutes and 3 for past 15 minutes.
- metar_rh
- self-explanatory
+ machine
+ Machine, i686 for example
- metar_windspeed
- self-explanatory
+ 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.
- metar_winddir
- self-explanatory
+ mem Amount of memory in use
- metar_swinddir
- self-explanatory
+ membar (height),(width)
+ Bar that shows amount of memory in use
- metar_cloud
- self-explanatory
+ memmax Total amount of memory
- metar_u2d_time
- self-explanatory
+ memperc
+ Percentage of memory in use
ml_upload_counter
Album in current MPD song
- mpd_bar height
+ mpd_bar (height),(width)
Bar of mpds progress
Stippled (dashed) horizontal line
- swapbar (height)
+ swapbar (height),(width)
Bar that shows amount of swap in use
System name, Linux for example
- offse pixels
- Move text over by N pixels
+ offset (pixels)
+ Move text over by N pixels. See also $voffset.
- tail logfile, lines interval> Displays last N lines of supplied text
- text file. If interval is not supplied, Conky assumes 2x Conkys
- interval. Max of 30 lines. Max of 30 lines can be displayed.
+ tail logfile lines (interval)
+ Displays last 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.
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 doesnt 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.
Upload speed in kilobytes with one decimal
- upspeedgraph net, (height, width, gradient colour 1, gradient colour 2)
- Upload speed graph, colours defined in hex, minus the #.
+ upspeedgraph net, (height),(width) (gradient colour 1) (gradient colour
+ 2) (scale)
+ Upload speed graph, colours defined in hex, minus the #. If
+ scale is non-zero, it becomes the scale for the graph.
uptime Uptime
Seti@home current progress
- seti_progbar (height)
+ seti_progbar (height),(width)
Seti@home current progress bar
Seti@home total user credit
+ voffset (pixels)
+ 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
Start Conky in its own window with date and clock as text and 30
BUGS
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
+ 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
- 2005-08-18 conky(1)
+ 2005-08-24 conky(1)
projects / monky / blobdiff