X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fdocs.xml;h=878b698677ecf3e6b14d56dda4848e1138bfdde7;hb=b951f0f45f60917eea7104e44d0f14c3e0d1f189;hp=17af17dcef91465e85fc04f2a92a32e2ea12ef28;hpb=7c37c3322a830e8eb9c61ab091522916e49014ef;p=monky diff --git a/doc/docs.xml b/doc/docs.xml index 17af17d..878b698 100644 --- a/doc/docs.xml +++ b/doc/docs.xml @@ -1,239 +1,337 @@ - - - - - - ]> - + + + + + +]> - -
- brenden1@users.sourceforge.net -
- - Brenden - Matthews - - 2005-09-24 - - - - conky - 1 - - - - conky - A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah. - - - - - 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 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. + +
+ brenden1@users.sourceforge.net +
+ + Brenden + Matthews + + 2010-10-05 + + + conky + 1 + + + conky + A system monitor for X originally based on the + torsmo code, but more kickass. It just keeps on given'er. + Yeah. + + + + conky + + options + + + + + Description + Conky is a system monitor for X originally based on + torsmo. Since its inception, Conky has changed + significantly from its predecessor, while maintaining + simplicity and configurability. Conky can display just + about anything, either on your root desktop or in its own + window. Not only does Conky have many built-in objects, it + can also display just about any piece of information by + using scripts and other external programs. - - 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. + Conky has more than 250 built in objects, including + support for a plethora of OS stats (uname, uptime, CPU + usage, mem usage, disk usage, "top" like process stats, and + network monitoring, just to name a few), built in IMAP and + POP3 support, built in support for many popular music + players (MPD, XMMS2, BMPx, Audacious), and much much more. + Conky can display this info either as text, or using simple + progress bars and graph widgets, with different fonts and + colours. - - Thanks for your interest in Conky. - - - + We are always looking for help, whether its reporting + bugs, writing patches, or writing docs. Please use the + facilities at SourceForge to make bug reports, feature + requests, and submit patches, or stop by #conky on + irc.freenode.net if you have questions or want to + contribute. + Thanks for your interest in Conky. + + Compiling - - 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". + For users compiling from source on a binary distro, + make sure you have the X development libraries installed + (Unless you provide configure with "--disable-x11"). This + should be a package along the lines of "libx11-dev" or + "xorg-x11-dev" for X11 libs, and similar "-dev" format for + the other libs required (depending on your configure + options). You should be able to see which extra packages + you need to install by reading errors that you get from + './configure'. You can enable/disable stuff by giving + options to configure, but be careful with disabling. For + example: with --disable-math you won't get errors but + logarithmic graphs will be normal graphs and gauges + will miss their line. - - 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. + Conky has (for some time) been available in the + repositories of most popular distributions. Here are some + installation instructions for a few: - - 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. + Gentoo users -- Conky is in Gentoo's Portage... + simply use "emerge app-admin/conky" for + installation. - - To compile and run Conky with all optional components: + Debian, etc. users -- Conky should be in your + repositories, and can be installed by doing "aptitude + install conky". + + Example to compile and run Conky with all optional + components (note that some configure options may differ for + your system): - + + + + - + + + + - + + + - + + + + - + + + - - 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 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. - - - You can disable 'drawing to own window' feature in case you don't need it by passing - --disable-own-window to configure -script. - - - + Conky has been tested to be compatible with C99 C, + however it has not been tested with anything other than + gcc, and is not guaranteed to work with other + compilers. + - - - - - 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 rest of Conky. + + You Should Know + Conky is generally very good on resources. That said, + the more you try to make Conky do, the more resources it is + going to consume. - - If you do use them, please do not complain about memory or CPU usage, - unless you think something's seriously wrong (mem leak, etc.). + An easy way to force Conky to reload your ~/.conkyrc: + "killall -SIGUSR1 conky". Saves you the trouble of having + to kill and then restart. You can now also do the same with + SIGHUP. - - An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky". - Saves you the trouble of having to kill and then restart. + + + Options + Command line options override configurations defined in + configuration file. - - 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... - - - - - Options - - Command line options override configurations defined in configuration file. - &command_options; - - - + Configuration Settings - - - 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 ("gunzip conkyrc.sample.gz" to get conkyrc.sample). + Default configuration file location is $HOME/.conkyrc or + ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is + /etc, and you can find the sample config file there + (/etc/conky/conky.conf). - - You might want to copy it to $HOME/.conkyrc and then start modifying it. - Other configs can be found at http://conky.sf.net + You might want to copy it to $HOME/.conkyrc and then + start modifying it. Other configs can be found at + http://conky.sf.net/ - &config_settings; - - Variables - + Objects/Variables + Colours are parsed using XParsecolor(), there might be a + list of them: /usr/share/X11/rgb.txt. + Colour can be also in + #rrggbb format (hex). + - 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. - - + Some objects may create threads, and sometimes these threads will + not be destroyed until Conky terminates. There is no way to + destroy or clean up threads while Conky is running. For example, + if you use an MPD variable, the MPD thread will keep running until + Conky dies. Some threaded objects will use one of the parameters + as a 'key', so that you only have 1 relevant thread running (for + example, the $curl, $rss and $weather objects launch one thread per + URI). + &variables; - + + Lua API + Conky features a Lua Programming API, and also ships with Lua + bindings for some useful libraries. Conky defines certain global + functions and variables which can be accessed from Lua code running + in Conky. + + To use Lua Conky, you first need to make sure you have a version of Conky + with Lua support enabled (``conky -v'' will report this). Scripts + must first be loaded using the lua_load configuration option. You + then call functions in Lua via Conky's $lua, $lua_read, and Lua + hooks. + + + Be careful when creating threaded objects through the Lua API. You + could wind up with a whole bunch of threads running if a thread is + created with each iteration. + + + At this time, the Lua API should not be considered stable and may + change drastically from one release to another as it matures. + + + NOTE: In order to accommodate certain features in the cairo + library's API, Conky will export a few additional functions for the + creation of certain structures. These are documented below. + + &lua; + Examples - - conky - Start Conky in its own window with date and clock as text and 30 sec update interval. + + conky + + + Start Conky in its own window with date + and clock as text and 30 sec update + interval. - - conky - Start Conky to background at coordinates (5, 500). + + conky + + + Start Conky to background at coordinates + (5, 500). + + + + conky + + + Do not start Conky, but have it output + the builtin default config file to ~/.conkyrc for + later customising. - - Files - ~/.conkyrc default configuration file + + + + + ${sysconfdir}/conky/conky.conf + + Default system-wide configuration file. + The value of ${sysconfdir} depends on the + compile-time options (most likely /etc). + + + + ~/.conkyrc + + Default personal 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 which makes - Conky to create its own window. - + 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 which makes Conky to create + its own window. If you do try running Conky in its own + window, be sure to read up on the own_window_type settings + and experiment. - - - See Also - - http://conky.sourceforge.net - - http://www.sourceforge.net/projects/conky + + See Also - #conky on irc.freenode.net + + http://conky.sourceforge.net/ - - - - Authors - The Conky dev team. What's up now! + + http://www.sourceforge.net/projects/conky - - + + + http://wiki.conky.be + + #conky on irc.freenode.net + + + Copying + Copyright (c) 2005-2010 Brenden Matthews, Philip + Kovacs, et. al. Any original torsmo code is licensed under + the BSD license (see LICENSE.BSD for a copy). All code + written since the fork of torsmo is licensed under the GPL + (see LICENSE.GPL for a copy), except where noted + differently (such as in portmon code, timed thread code, + and audacious code which are LGPL, and prss which is an + MIT-style license). + + + Authors + The Conky dev team (see AUTHORS for a full list of + contributors). +