Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 12:10:03 +00:00
Code Issues Releases Activity

small doc changes

Browse Source 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@222 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2005-08-27 21:15:33 +00:00
parent 1a8fe3f513
commit 09f2394410
4 changed files with 74 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
README
View File

@ -4,20 +4,20 @@ conky(1) conky(1)
NAME
conky - a system monitor for X originally based on the torsmo code, but
more kickass.
more kickass. It just keeps on given'er.
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,7 +36,7 @@ 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
@ -45,14 +45,14 @@ COMPILING
./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.
@ -63,7 +63,7 @@ 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).
Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
@ -101,7 +101,7 @@ OPTIONS
-t TEXT
Text to render, remember single quotes, like -t $uptime
Text to render, remember single quotes, like -t ' $uptime '
-u SECONDS
@ -121,12 +121,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
@ -156,7 +156,7 @@ CONFIGURATION SETTINGS
default_shade_color
Default shading color and borders shading color
Default shading color and border's shading color
default_outline_color
@ -164,8 +164,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.
@ -254,7 +254,7 @@ CONFIGURATION SETTINGS
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
(defaults to black). Takes either a hex value (#ffffff) or a
valid RGB name (see /usr/lib/X11/rgb.txt)
@ -295,9 +295,9 @@ CONFIGURATION SETTINGS
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
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
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).
@ -358,10 +358,10 @@ VARIABLES
cpubar (cpu number) (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 (cpu number) (height),(width) (gradient colour 1) (gradient
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.
@ -370,7 +370,7 @@ VARIABLES
diskio Displays current disk IO.
diskiograph (height),(width) (gradient colour 1) (gradient colour 2)
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.
@ -384,7 +384,7 @@ VARIABLES
Download speed in kilobytes with one decimal
downspeedgraph net, (height),(width) (gradient colour 1) (gradient
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.
@ -394,8 +394,8 @@ VARIABLES
exec 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.
@ -410,7 +410,7 @@ VARIABLES
execi interval 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.
@ -434,13 +434,13 @@ VARIABLES
freq_dyn
Returns CPU frequency in MHz, but is calculated by counting to
clock cycles to complete an instruction. Only available for
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
clock cycles to complete an instruction. Only available for
x86/amd64.
@ -467,7 +467,7 @@ VARIABLES
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
is not supplied, Conky assumes 2x Conky's interval. Max of 30
lines can be displayed, or until the text buffer is filled.
@ -476,8 +476,8 @@ 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.
@ -512,21 +512,21 @@ VARIABLES
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
the left fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
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
the left fan status as listed in /proc/i8k (translated to human-
readable). Beware, some laptops i8k reports these fans in
reverse order.
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
the right fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
@ -647,7 +647,7 @@ VARIABLES
mpd_bar (height),(width)
Bar of mpds progress
Bar of mpd's progress
mpd_bitrate
@ -663,19 +663,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
@ -736,26 +736,26 @@ VARIABLES
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
not supplied, Conky assumes 2x Conky's 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
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
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.
@ -779,7 +779,7 @@ VARIABLES
Upload speed in kilobytes with one decimal
upspeedgraph net, (height),(width) (gradient colour 1) (gradient colour
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.
@ -810,7 +810,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.
@ -821,24 +821,25 @@ 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??!

6
doc/Makefile.am
View File

@ -5,6 +5,8 @@ man_MANS = conky.1
clean-am: clean-generic mostlyclean-am
rm -f docs.mxml
rm -f conky.1
rm -f variables.html
rm -f config_settings.html
conky.1: command_options.xml config_settings.xml docs.xml variables.xml
${db2x_xsltproc_cmd} -s man ${srcdir}/docs.xml -o docs.mxml
@ -12,8 +14,8 @@ conky.1: command_options.xml config_settings.xml docs.xml variables.xml
${xsltproc_cmd} http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl ${srcdir}/docs.xml > docs.html
man ./conky.1 | col -b > README
mv README ${top_srcdir}
xsltproc variables.xsl variables.xml > variables.html
xsltproc config_settings.xsl config_settings.xml > config_settings.html
xsltproc ${srcdir}/variables.xsl ${srcdir}/variables.xml > variables.html
xsltproc ${srcdir}/config_settings.xsl ${srcdir}/config_settings.xml > config_settings.html
DOCS = conky.1 docs.html variables.html config_settings.html
endif

2
doc/docs.xml
View File

@ -26,7 +26,7 @@
<refnamediv>
<refname>conky</refname>
<refpurpose>a system monitor for X originally based on the torsmo code, but more kickass.</refpurpose>
<refpurpose>a system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er.</refpurpose>
</refnamediv>
<refsynopsisdiv>

4
doc/variables.xml
View File

@ -193,7 +193,7 @@
<varlistentry>
<term>
<command><option>downspeedgraph</option></command>
<option>net, (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
<option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
</term>
<listitem>
Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
@ -1024,7 +1024,7 @@
<varlistentry>
<term>
<command><option>upspeedgraph</option></command>
<option>net, (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
<option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
</term>
<listitem>
Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.