diff --git a/README b/README index 4adb1ad4..c6e5c35c 100644 --- a/README +++ b/README @@ -10,14 +10,14 @@ SYNOPSIS conky [options] DESCRIPTION - 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 + 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 its own window. Conky has many built-in objects, - as well as the ability to execute programs and scripts, then display + 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. - 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. @@ -26,9 +26,9 @@ DESCRIPTION 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 Gentoos Portage. Simply use "emerge conky" + Gentoo users, Conky is in Gentoo's Portage. Simply use "emerge conky" for installation. There is also usually an up-to-date ebuild within - Conkys package or in CVS. + Conky's package or in CVS. To compile and run Conky with all optional components: @@ -36,21 +36,21 @@ 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 ./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). - Crashes in file system statistics stuff when compiled with icc, I dont + 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 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 don't need it by passing --disable-own-window to configure -script. @@ -61,11 +61,11 @@ 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 + unless you think something is going seriously wrong (mem leak, et cetera). OPTIONS - Command line options override configurations defined in configuration + Command line options override configurations defined in configuration file. -V Prints version and exits @@ -82,7 +82,7 @@ OPTIONS Config file to load instead of $HOME/.conkyrc - -d Daemonize, fork to background + -d Daemonize Conky, aka fork to background -f FONT @@ -96,7 +96,7 @@ OPTIONS -t TEXT - Text to render, remember single quotes, like -t $uptime + Text to render, remember single quotes, like -t ' $uptime ' -u SECONDS @@ -116,12 +116,12 @@ OPTIONS CONFIGURATION SETTINGS - Default configuration file is $HOME/.conkyrc (can be changed from + 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. 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 @@ -151,7 +151,7 @@ CONFIGURATION SETTINGS default_shade_color - Default shading color and borders shading color + Default shading color and border's shading color default_outline_color @@ -159,8 +159,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 wont be + Use the Xdbe extension? (eliminates flicker) It is highly recom- + mended to use own window with this one so double buffer won't be so big. @@ -274,11 +274,11 @@ CONFIGURATION SETTINGS 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 - and not 1000*1000. + [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 @@ -336,7 +336,7 @@ VARIABLES cpubar (height),(width) - Bar that shows CPU usage, height is bars height in pixels + Bar that shows CPU usage, height is bar's height in pixels cpugraph (height),(width) (gradient colour 1) (gradient colour 2) @@ -360,8 +360,8 @@ VARIABLES exec shell command - Executes a shell command and displays the output in conky. warn - ing: this takes a lot more resources than other variables. Id + Executes a shell command and displays the output in conky. warn- + ing: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. @@ -376,7 +376,7 @@ VARIABLES execi interval, shell command - Same as exec but with specific interval. Interval cant be less + Same as exec but with specific interval. Interval can't be less than update_interval in configuration. @@ -416,15 +416,15 @@ 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 /sys/bus/i2c/devices/ on your local computer. 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 @@ -522,7 +522,7 @@ VARIABLES mpd_bar (height),(width) - Bar of mpds progress + Bar of mpd's progress mpd_bitrate @@ -538,19 +538,19 @@ VARIABLES mpd_vol - MPDs volume + MPD's volume mpd_elapsed - Songs elapsed time + Song's elapsed time mpd_length - Songs length + Song's length mpd_percent - Percent of songs progress + Percent of song's progress new_mails @@ -610,26 +610,26 @@ VARIABLES tail logfile, lines interval> Displays last N lines of supplied text - text file. If interval is not supplied, Conky assumes 2x Conkys + text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines. Max of 30 lines can be displayed. 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 + there doesn't 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 + usage, which is what (num) represents. The types are: "name", + "pid", "cpu", and mem". There can be a max of 10 processes listed. @@ -683,7 +683,7 @@ VARIABLES 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. @@ -694,25 +694,26 @@ FILES ~/.conkyrc default configuration file 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 + 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. SEE ALSO - http://conky.sourceforge.net + http://conky.sourceforge.net [http://conky.sourceforge.net] - http://www.sourceforge.net/projects/conky + http://www.sourceforge.net/projects/conky [http://www.source- + forge.net/projects/conky] #conky on irc.freenode.net AUTHORS - The Conky dev team. Whats up now??! + The Conky dev team. What's up now??! - 2005-08-18 conky(1) +Conky 2005-08-18 conky(1) diff --git a/doc/command_options.xml b/doc/command_options.xml index 45be433d..1632b854 100644 --- a/doc/command_options.xml +++ b/doc/command_options.xml @@ -30,7 +30,7 @@ - Daemonize, fork to background + Daemonize Conky, aka fork to background diff --git a/doc/conky.1.gz b/doc/conky.1.gz index eb65208b..32f2ed61 100644 Binary files a/doc/conky.1.gz and b/doc/conky.1.gz differ diff --git a/doc/docs.html b/doc/docs.html index 93792193..6b4d6d1a 100644 --- a/doc/docs.html +++ b/doc/docs.html @@ -1,4 +1,4 @@ -conky

Name

conky — a system monitor for X originally based on the torsmo code, but more kickass.

Synopsis

conky [options]

Description

+conky

Name

conky — a system monitor for X originally based on the torsmo code, but more kickass.

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 predecessor. Conky can display just about anything, either on your root desktop or in it's own window. @@ -9,7 +9,7 @@ Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.

Thanks for your interest in Conky. -

Compiling

+

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 conky" for installation. There is also usually an up-to-date ebuild within Conky's package or in CVS. @@ -25,6 +25,8 @@ --enable-mpd --enable-xft --enable-seti

make +
+ make install # Optional
./conky

@@ -38,14 +40,14 @@ --disable-own-window to configure -script.

-

You Should Know

+

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.

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). -

Options

Command line options override configurations defined in configuration file.

-V
+

Options

Command line options override configurations defined in configuration file.

-V
Prints version and exits

-a ALIGNMENT
Text alignment on screen, {top,bottom}_{left,right} or none @@ -54,7 +56,7 @@

-c FILE
Config file to load instead of $HOME/.conkyrc

-d
- Daemonize, fork to background + Daemonize Conky, aka fork to background

-f FONT
Font to use

-h
@@ -71,7 +73,7 @@ X position

-y Y_COORDINATE
Y position -

Configuration Settings

+

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. @@ -149,7 +151,7 @@ Use Xft (anti-aliased font and stuff)

text
After this begins text to be formatted on screen -

Variables

+

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 @@ -586,8 +588,8 @@ (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 sec update interval.
conky -a top_left -x 5 -y 500 -d
Start Conky to background at coordinates (5, 500).

Files

~/.conkyrc default configuration file -

Bugs

+

Examples

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.
conky -a top_left -x 5 -y 500 -d
Start Conky to background at coordinates (5, 500).

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 @@ -596,10 +598,10 @@ 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

+

See Also

http://conky.sourceforge.net

http://www.sourceforge.net/projects/conky

#conky on irc.freenode.net -

Authors

+

Authors

The Conky dev team. What's up now??!

diff --git a/doc/docs.xml b/doc/docs.xml index eea6a6e4..70b2f27c 100644 --- a/doc/docs.xml +++ b/doc/docs.xml @@ -8,8 +8,6 @@ ]> - - Conky
brenden1@users.sourceforge.net