Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-17 18:45:10 +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

89
README
View File

@ -4,16 +4,16 @@ conky(1) conky(1)
NAME NAME
conky - a system monitor for X originally based on the torsmo code, but conky - a system monitor for X originally based on the torsmo code, but
more kickass. more kickass. It just keeps on given'er.
SYNOPSIS SYNOPSIS
conky [options] conky [options]
DESCRIPTION DESCRIPTION
Conky is a system monitor for X originally based on the torsmo code. 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 Since it's original conception, Conky has changed a fair bit from it's
predecessor. Conky can display just about anything, either on your predecessor. Conky can display just about anything, either on your
root desktop or in its own window. Conky has many built-in objects, 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 as well as the ability to execute programs and scripts, then display
the output from stdout. the output from stdout.
@ -26,9 +26,9 @@ DESCRIPTION
COMPILING COMPILING
First, make sure you have the X development libraries installed, this 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". 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 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: To compile and run Conky with all optional components:
@ -45,14 +45,14 @@ COMPILING
./conky ./conky
Conky doesnt probably compile with other compilers than gcc and icc. Conky doesn't probably compile with other compilers than gcc and icc.
It doesnt compile with C89 compiler and not even with pure C99. It It doesn't compile with C89 compiler and not even with pure C99. It
uses few things that might not exist: strdup(), strcasecmp(), strn uses few things that might not exist: strdup(), strcasecmp(), strn-
casecmp(), optarg variable with getopt() and long long (not in C89). casecmp(), optarg variable with getopt() and long long (not in C89).
Crashes in file system statistics stuff when compiled with icc, I dont Crashes in file system statistics stuff when compiled with icc, I don't
know exactly why. 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. it by passing --disable-own-window to configure -script.
@ -101,7 +101,7 @@ OPTIONS
-t TEXT -t TEXT
Text to render, remember single quotes, like -t $uptime Text to render, remember single quotes, like -t ' $uptime '
-u SECONDS -u SECONDS
@ -126,7 +126,7 @@ CONFIGURATION SETTINGS
it to $HOME/.conkyrc and then start modifying it. it to $HOME/.conkyrc and then start modifying it.
alignment 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 tom_left, bottom_right, or none
@ -156,7 +156,7 @@ CONFIGURATION SETTINGS
default_shade_color default_shade_color
Default shading color and borders shading color Default shading color and border's shading color
default_outline_color default_outline_color
@ -164,8 +164,8 @@ CONFIGURATION SETTINGS
double_buffer double_buffer
Use the Xdbe extension? (eliminates flicker) It is highly recom Use the Xdbe extension? (eliminates flicker) It is highly recom-
mended to use own window with this one so double buffer wont be mended to use own window with this one so double buffer won't be
so big. so big.
@ -295,9 +295,9 @@ CONFIGURATION SETTINGS
VARIABLES 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 /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 [http://sedition.com/perl/rgb.html] Color can be also in #rrggbb format
bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes (hex). Note that when displaying bytes, power is 1024 and not 1000 so
and not 1000*1000. 1M really means 1024*1024 bytes and not 1000*1000.
addr (interface) addr (interface)
IP address for an interface IP address for an interface
@ -358,7 +358,7 @@ VARIABLES
cpubar (cpu number) (height),(width) 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
@ -384,7 +384,7 @@ VARIABLES
Download speed in kilobytes with one decimal 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) colour 2) (scale)
Download speed graph, colours defined in hex, minus the #. If Download speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. scale is non-zero, it becomes the scale for the graph.
@ -394,8 +394,8 @@ VARIABLES
exec command exec command
Executes a shell command and displays the output in conky. warn Executes a shell command and displays the output in conky. warn-
ing: this takes a lot more resources than other variables. Id ing: this takes a lot more resources than other variables. I'd
recommend coding wanted behaviour in C and posting a patch. recommend coding wanted behaviour in C and posting a patch.
@ -410,7 +410,7 @@ VARIABLES
execi interval command 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. than update_interval in configuration.
@ -467,7 +467,7 @@ VARIABLES
head logfile lines (interval) head logfile lines (interval)
Displays first N lines of supplied text text file. If 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. lines can be displayed, or until the text buffer is filled.
@ -512,21 +512,21 @@ VARIABLES
i8k_left_fan_rpm i8k_left_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays 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 listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
i8k_left_fan_status i8k_left_fan_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the left fan status as listed in /proc/i8k (translated to the left fan status as listed in /proc/i8k (translated to human-
human-readable). Beware, some laptops i8k reports these fans in readable). Beware, some laptops i8k reports these fans in
reverse order. reverse order.
i8k_right_fan_rpm i8k_right_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays 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 listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
@ -647,7 +647,7 @@ VARIABLES
mpd_bar (height),(width) mpd_bar (height),(width)
Bar of mpds progress Bar of mpd's progress
mpd_bitrate mpd_bitrate
@ -663,19 +663,19 @@ VARIABLES
mpd_vol mpd_vol
MPDs volume MPD's volume
mpd_elapsed mpd_elapsed
Songs elapsed time Song's elapsed time
mpd_length mpd_length
Songs length Song's length
mpd_percent mpd_percent
Percent of songs progress Percent of song's progress
new_mails new_mails
@ -736,18 +736,18 @@ VARIABLES
tail logfile lines (interval) tail logfile lines (interval)
Displays last N lines of supplied text text file. If interval is 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. can be displayed, or until the text buffer is filled.
time (format) 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 mat
totaldown net totaldown net
Total download, overflows at 4 GB on Linux with 32-bit arch and 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. already done that before conky has started.
@ -779,7 +779,7 @@ VARIABLES
Upload speed in kilobytes with one decimal 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) 2) (scale)
Upload speed graph, colours defined in hex, minus the #. If Upload speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. scale is non-zero, it becomes the scale for the graph.
@ -810,7 +810,7 @@ VARIABLES
EXAMPLES 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 Start Conky in its own window with date and clock as text and 30
sec update interval. sec update interval.
@ -821,9 +821,9 @@ FILES
~/.conkyrc default configuration file ~/.conkyrc default configuration file
BUGS BUGS
Drawing to root or some other desktop window directly doesnt work with Drawing to root or some other desktop window directly doesn't work with
all window managers. Especially doesnt work well with Gnome and it has all window managers. Especially doesn't work well with Gnome and it has
been reported that it doesnt work with KDE either. Nautilus can be been reported that it doesn't work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree Conky to set some specific window id. You might find xwininfo -tree
@ -831,14 +831,15 @@ BUGS
which makes Conky to create its own window. which makes Conky to create its own window.
SEE ALSO 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 #conky on irc.freenode.net
AUTHORS 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 clean-am: clean-generic mostlyclean-am
rm -f docs.mxml rm -f docs.mxml
rm -f conky.1 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 conky.1: command_options.xml config_settings.xml docs.xml variables.xml
${db2x_xsltproc_cmd} -s man ${srcdir}/docs.xml -o docs.mxml ${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 ${xsltproc_cmd} http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl ${srcdir}/docs.xml > docs.html
man ./conky.1 | col -b > README man ./conky.1 | col -b > README
mv README ${top_srcdir} mv README ${top_srcdir}
xsltproc variables.xsl variables.xml > variables.html xsltproc ${srcdir}/variables.xsl ${srcdir}/variables.xml > variables.html
xsltproc config_settings.xsl config_settings.xml > config_settings.html xsltproc ${srcdir}/config_settings.xsl ${srcdir}/config_settings.xml > config_settings.html
DOCS = conky.1 docs.html variables.html config_settings.html DOCS = conky.1 docs.html variables.html config_settings.html
endif endif

2
doc/docs.xml
View File

@ -26,7 +26,7 @@
<refnamediv> <refnamediv>
<refname>conky</refname> <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> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>

4
doc/variables.xml
View File

@ -193,7 +193,7 @@
<varlistentry> <varlistentry>
<term> <term>
<command><option>downspeedgraph</option></command> <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> </term>
<listitem> <listitem>
Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. 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> <varlistentry>
<term> <term>
<command><option>upspeedgraph</option></command> <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> </term>
<listitem> <listitem>
Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.