projects / monky / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
added README.cvs-version
[monky] / doc / docs.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>conky</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2447920"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>conky &#8212; a system monitor for X originally based on the torsmo code, but more kickass.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">conky</tt>  [<i class="replaceable"><tt>options</tt></i>]</p></div></div><div class="refsect1" lang="en"><a name="id2476569"></a><h2>Description</h2><p>
2     Conky is a system monitor for X originally based on the torsmo code. 
3     Since it's original conception, Conky has changed a fair bit from it's predecessor.  
4     Conky can display just about anything, either on your root desktop or in it's own window.  
5     Conky has many built-in objects, as well as the ability to execute programs and scripts, 
6     then display the output from stdout.
7                 </p><p>
8                 We are always looking for help, and anyone interested in becoming a developer is welcome.  
9                 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
10                 </p><p>
11                 Thanks for your interest in Conky.
12                 </p></div><div class="refsect1" lang="en"><a name="id2476596"></a><h2>Compiling</h2><p>
13                 First, make sure you have the X development libraries installed, this should be a package along the lines 
14                 of "libx11-dev or xorg-x11-dev". Gentoo users, Conky is in Gentoo's Portage.  Simply use "emerge conky" for installation.
15                 There is also usually an up-to-date ebuild within Conky's package or in CVS.
16                 </p><p>
17                 To compile and run Conky with all optional components:
18                 </p><div class="variablelist"><dl><dt><span class="term">
19                                         <span><b class="command"><tt class="option">sh autogen.sh</tt></b></span> <tt class="option"># Only required if building from CVS</tt>
20                                 </span></dt><dd></dd><dt><span class="term">
21                                 <span><b class="command"><tt class="option">./configure </tt></b></span><tt class="option">
22 --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
23 --datadir=/usr/ share --sysconfdir=/etc --localstatedir=/var/lib 
24 --enable-double-buffer --enable-own-window --enable-proc-uptime 
25 --enable-mpd --enable-xft --enable-seti</tt>
26                                 </span></dt><dd></dd><dt><span class="term">
27                                         <span><b class="command"><tt class="option">make</tt></b></span>
28                                 </span></dt><dd></dd><dt><span class="term">
29                                         <span><b class="command"><tt class="option">./conky</tt></b></span>     
30                                 </span></dt><dd></dd></dl></div><p>
31                         Conky doesn't probably compile with other compilers than gcc and icc. 
32                         It doesn't compile with C89 compiler and not even with pure C99.
33                         It uses few     things that might not exist: strdup(), strcasecmp(), strncasecmp(), 
34                         optarg variable with getopt() and long long (not in C89). Crashes in file system
35                         statistics stuff when compiled with icc, I don't know exactly why.
36                 </p><p>
37                         You can disable 'drawing to own window' feature in case you don't need it       by passing 
38                         --disable-own-window to configure -script.
39                 </p><p>
40                         
41                 </p></div><div class="refsect1" lang="en"><a name="id2447477"></a><h2>You Should Know</h2><p>
42                 Conky is generally very good on resources.  However, certain objects in
43                 Conky are harder on resources then others.  In particular, the $tail,
44                 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
45                 </p><p>
46                 If you do use them, please do not complain about memory or CPU usage, 
47                 unless you think something is going seriously wrong (mem leak, et cetera).
48                 </p></div><div class="refsect1" lang="en"><a name="id2447496"></a><h2>Options</h2><p>Command line options override configurations defined in configuration file.</p><div class="variablelist"><dl><dt><span class="term"><span><b class="command"><tt class="option">-V</tt></b></span></span></dt><dd>
49     Prints version and exits
50     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-a </tt></b></span><tt class="option">ALIGNMENT</tt></span></dt><dd>
51       Text alignment on screen, {top,bottom}_{left,right} or none
52     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-b</tt></b></span></span></dt><dd>
53       Use double buffering (eliminates "flicker")
54     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-c </tt></b></span><tt class="option">FILE</tt></span></dt><dd>
55       Config file to load instead of $HOME/.conkyrc
56     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-d</tt></b></span></span></dt><dd>
57       Daemonize, fork to background
58     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-f </tt></b></span><tt class="option">FONT</tt></span></dt><dd>
59       Font to use
60     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-h</tt></b></span></span></dt><dd>
61       Prints command line help and exits
62     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-o</tt></b></span></span></dt><dd>
63       Create own window to draw
64     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-t </tt></b></span><tt class="option">TEXT</tt></span></dt><dd>
65       Text to render, remember single quotes, like -t ' $uptime '
66     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-u </tt></b></span><tt class="option">SECONDS</tt></span></dt><dd>
67       Update interval
68     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-w </tt></b></span><tt class="option">WIN_ID</tt></span></dt><dd>
69       Window id to draw
70     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-x </tt></b></span><tt class="option">X_COORDINATE</tt></span></dt><dd>
71       X position
72     <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">-y </tt></b></span><tt class="option">Y_COORDINATE</tt></span></dt><dd>
73       Y position
74     <p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2448119"></a><h2>Configuration Settings</h2><p>
75                 Default configuration file is $HOME/.conkyrc (can be changed from
76                 conky.c among other things). See conkyrc.sample. You might want to copy
77                 it to $HOME/.conkyrc and then start modifying it.
78                 </p><div class="variablelist"><dl><dt><span class="term"><span><b class="command"><tt class="option">alignment</tt></b></span></span></dt><dd>
79                 Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
80         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">background</tt></b></span></span></dt><dd>
81                 Boolean value, if true, Conky will be forked to background when started
82         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">on_bottom</tt></b></span></span></dt><dd>
83                 Set conky on the bottom of all other applications
84         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">border_margin</tt></b></span></span></dt><dd>
85                 Border margin in pixels
86         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">border_width</tt></b></span></span></dt><dd>
87                 Border width in pixels
88         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">cpu_avg_samples</tt></b></span></span></dt><dd>
89                 The number of samples to average for CPU monitoring
90         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">default_color</tt></b></span></span></dt><dd>
91                 Default color and border color
92         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">default_shade_color</tt></b></span></span></dt><dd>
93                 Default shading color and border's shading color
94         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">default_outline_color</tt></b></span></span></dt><dd>
95                 Default outline color
96         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">double_buffer</tt></b></span></span></dt><dd>
97                 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
98         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">draw_borders</tt></b></span></span></dt><dd>
99                 Draw borders around text?
100         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">draw_shades</tt></b></span></span></dt><dd>
101                 Draw shades?
102         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">draw_outline</tt></b></span></span></dt><dd>
103                 Draw outlines?
104         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">font</tt></b></span></span></dt><dd>
105                 Font name in X, xfontsel can be used to get a nice font
106         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">gap_x</tt></b></span></span></dt><dd>
107                 Gap between right or left border of screen, same as passing -x at command line
108         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">gap_y</tt></b></span></span></dt><dd>
109                 Gap between top or bottom border of screen, same as passing -y at command line
110         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">no_buffers</tt></b></span></span></dt><dd>
111                 Substract (file system) buffers from used memory?
112         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mail_spool</tt></b></span></span></dt><dd>
113                 Mail spool for mail checking
114         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">minimum_size</tt></b></span></span></dt><dd>
115                 Minimum size of window
116         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mldonkey_hostname</tt></b></span></span></dt><dd>
117                 Hostname for mldonkey stuff, defaults to localhost
118         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mldonkey_port</tt></b></span></span></dt><dd>
119                 Mldonkey port, 4001 default
120         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mldonkey_login</tt></b></span></span></dt><dd>
121                 Mldonkey login, default none
122         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mldonkey_password</tt></b></span></span></dt><dd>
123                 Mldonkey password, default none
124         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mpd_host</tt></b></span></span></dt><dd>
125                 Host of MPD server
126         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mpd_post</tt></b></span></span></dt><dd>
127                 Port of MPD server
128         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">mpd_password</tt></b></span></span></dt><dd>
129                 MPD server password
130         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">net_avg_samples</tt></b></span></span></dt><dd>
131                 The number of samples to average for net data
132         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">override_utf8_locale</tt></b></span></span></dt><dd>
133                 Force UTF8? requires XFT
134         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">own_window</tt></b></span></span></dt><dd>
135                 Boolean, create own window to draw?
136         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">pad_percents</tt></b></span></span></dt><dd>
137                 Pad percentages to this many decimals (0 = no padding)
138         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">stippled_borders</tt></b></span></span></dt><dd>
139                 Border stippling (dashing) in pixels
140         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">total_run_times</tt></b></span></span></dt><dd>
141                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
142         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">update_interval</tt></b></span></span></dt><dd>
143                 Update interval in seconds
144         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">uppercase</tt></b></span></span></dt><dd>
145                 Boolean value, if true, text is rendered in upper case
146         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">use_spacer</tt></b></span></span></dt><dd>
147                 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
148         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">use_xft</tt></b></span></span></dt><dd>
149                 Use Xft (anti-aliased font and stuff)
150         <p></p></dd><dt><span class="term"><span><b class="command"><tt class="option">text</tt></b></span></span></dt><dd>
151                 After this begins text to be formatted on screen
152         <p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2517432"></a><h2>Variables</h2><p>
153                 Colors are parsed using XParsecolor(), there might be a list of them:
154                 /usr/X11R6/lib/X11/rgb.txt. Also, <a href="http://sedition.com/perl/rgb.html" target="_top">
155                                                                                                                                                          http://sedition.com/perl/rgb.html</a>
156                 Color can be also in #rrggbb format (hex).
157                 
158                 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
159                 means 1024*1024 bytes and not 1000*1000.
160                 </p><div class="variablelist"><dl><dt><span class="term">
161                 <span><b class="command"><tt class="option">addr</tt></b></span>
162         <tt class="option">(interface)</tt>
163         </span></dt><dd>
164                 IP address for an interface
165         <p></p></dd><dt><span class="term">
166                 <span><b class="command"><tt class="option">acpiacadapter</tt></b></span>
167         </span></dt><dd>
168                 ACPI ac adapter state.
169         <p></p></dd><dt><span class="term">
170                 <span><b class="command"><tt class="option">acpifan</tt></b></span>
171         </span></dt><dd>
172                 ACPI fan state
173         <p></p></dd><dt><span class="term">
174                 <span><b class="command"><tt class="option">acpitemp</tt></b></span>
175         </span></dt><dd>
176                 ACPI temperature in C.
177                 <p></p></dd><dt><span class="term">
178                 <span><b class="command"><tt class="option">acpitempf</tt></b></span>
179         </span></dt><dd>
180                 ACPI temperature in F.
181                 <p></p></dd><dt><span class="term">
182                 <span><b class="command"><tt class="option">adt746xcpu</tt></b></span>
183         </span></dt><dd>
184                 CPU temperature from therm_adt746x
185         <p></p></dd><dt><span class="term">
186                 <span><b class="command"><tt class="option">adt746xfan</tt></b></span>
187         </span></dt><dd>
188                 Fan speed from therm_adt746x
189         <p></p></dd><dt><span class="term">
190                 <span><b class="command"><tt class="option">alignr</tt></b></span>
191         <tt class="option">(num)</tt>
192         </span></dt><dd>
193                 Right-justify text, with space of N
194         <p></p></dd><dt><span class="term">
195                 <span><b class="command"><tt class="option">alignc</tt></b></span>
196         <tt class="option">(num)</tt>
197         </span></dt><dd>
198                 Align text to centre
199         <p></p></dd><dt><span class="term">
200                 <span><b class="command"><tt class="option">battery</tt></b></span>
201         <tt class="option">(num)</tt>
202         </span></dt><dd>
203                 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
204         <p></p></dd><dt><span class="term">
205                 <span><b class="command"><tt class="option">buffers</tt></b></span>
206         </span></dt><dd>
207                 Amount of memory buffered
208         <p></p></dd><dt><span class="term">
209                 <span><b class="command"><tt class="option">cached</tt></b></span>
210         </span></dt><dd>
211                 Amount of memory cached
212         <p></p></dd><dt><span class="term">
213                 <span><b class="command"><tt class="option">color</tt></b></span>
214         <tt class="option">(color)</tt>
215         </span></dt><dd>
216                 Change drawing color to color
217         <p></p></dd><dt><span class="term">
218                 <span><b class="command"><tt class="option">cpu</tt></b></span>
219         </span></dt><dd>
220                 CPU usage in percents
221         <p></p></dd><dt><span class="term">
222                 <span><b class="command"><tt class="option">cpubar</tt></b></span>
223         <tt class="option">(height),(width)</tt>
224         </span></dt><dd>
225                 Bar that shows CPU usage, height is bar's height in pixels
226         <p></p></dd><dt><span class="term">
227                 <span><b class="command"><tt class="option">cpugraph</tt></b></span>
228         <tt class="option">(height),(width) (gradient colour 1) (gradient colour 2)</tt>
229         </span></dt><dd>
230                 CPU usage graph, with optional colours in hex, minus the #.
231         <p></p></dd><dt><span class="term">
232                 <span><b class="command"><tt class="option">downspeed</tt></b></span>
233         <tt class="option">net</tt>
234         </span></dt><dd>
235                 Download speed in kilobytes
236         <p></p></dd><dt><span class="term">
237                 <span><b class="command"><tt class="option">downspeedf</tt></b></span>
238         <tt class="option">net</tt>
239         </span></dt><dd>
240                 Download speed in kilobytes with one decimal
241         <p></p></dd><dt><span class="term">
242                 <span><b class="command"><tt class="option">downspeedgraph</tt></b></span>
243                 <tt class="option">net, (height),(width) (gradient colour 1) (gradient colour 2)</tt>
244         </span></dt><dd>
245                 Download speed graph, colours defined in hex, minus the #.
246         <p></p></dd><dt><span class="term">
247                 <span><b class="command"><tt class="option">else</tt></b></span>
248         </span></dt><dd>
249                 Text to show if any of the above are not true
250         <p></p></dd><dt><span class="term">
251                 <span><b class="command"><tt class="option">exec</tt></b></span>
252         <tt class="option">shell command</tt>
253         </span></dt><dd>
254                 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
255         <p></p></dd><dt><span class="term">
256                 <span><b class="command"><tt class="option">execbar</tt></b></span>
257         <tt class="option">shell command</tt>
258         </span></dt><dd>
259                 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.
260         <p></p></dd><dt><span class="term">
261                 <span><b class="command"><tt class="option">execgraph</tt></b></span>
262         <tt class="option">shell command</tt>
263         </span></dt><dd>
264                 Same as execbar, but graphs values
265         <p></p></dd><dt><span class="term">
266                 <span><b class="command"><tt class="option">execi</tt></b></span>
267         <tt class="option">interval, shell command</tt>
268         </span></dt><dd>
269                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration.
270         <p></p></dd><dt><span class="term">
271                 <span><b class="command"><tt class="option">font</tt></b></span>
272         <tt class="option">font</tt>
273         </span></dt><dd>
274                 Specify a different font. Only applies to one line.
275         <p></p></dd><dt><span class="term">
276                         <span><b class="command"><tt class="option">freq</tt></b></span>
277                 </span></dt><dd>
278                         Returns CPU frequency in MHz
279                         <p></p></dd><dt><span class="term">
280                         <span><b class="command"><tt class="option">freq_g</tt></b></span>
281                 </span></dt><dd>
282                         Returns CPU frequency in GHz
283                         <p></p></dd><dt><span class="term">
284                 <span><b class="command"><tt class="option">fs_bar</tt></b></span>
285         <tt class="option">(height),(width) fs</tt>
286         </span></dt><dd>
287                 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.
288         <p></p></dd><dt><span class="term">
289                 <span><b class="command"><tt class="option">fs_free</tt></b></span>
290         <tt class="option">(fs)</tt>
291         </span></dt><dd>
292                 Free space on a file system available for users.
293         <p></p></dd><dt><span class="term">
294                 <span><b class="command"><tt class="option">fs_free_perc</tt></b></span>
295         <tt class="option">(fs)</tt>
296         </span></dt><dd>
297                 Free percentage of space on a file system available for users.
298         <p></p></dd><dt><span class="term">
299                 <span><b class="command"><tt class="option">fs_size</tt></b></span>
300         <tt class="option">(fs)</tt>
301         </span></dt><dd>
302                 File system size
303         <p></p></dd><dt><span class="term">
304                 <span><b class="command"><tt class="option">fs_used</tt></b></span>
305         <tt class="option">(fs)</tt>
306         </span></dt><dd>
307                 File system used space
308         <p></p></dd><dt><span class="term">
309                 <span><b class="command"><tt class="option">hr</tt></b></span>
310         <tt class="option">(height)</tt>
311         </span></dt><dd>
312                 Horizontal line, height is the height in pixels
313         <p></p></dd><dt><span class="term">
314                 <span><b class="command"><tt class="option">i2c</tt></b></span>
315         <tt class="option">(dev), type, n</tt>
316         </span></dt><dd>
317                 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.
318         <p></p></dd><dt><span class="term">
319                 <span><b class="command"><tt class="option">if_running</tt></b></span>
320         <tt class="option">(process)</tt>
321         </span></dt><dd>
322                 if PROCESS is running, display everything if_running and the matching $endif
323         <p></p></dd><dt><span class="term">
324                 <span><b class="command"><tt class="option">if_existing</tt></b></span>
325         <tt class="option">(file)</tt>
326         </span></dt><dd>
327                 if FILE exists, display everything between if_existing and the matching $endif
328         <p></p></dd><dt><span class="term">
329                 <span><b class="command"><tt class="option">if_mounted</tt></b></span>
330         <tt class="option">(mountpoint)</tt>
331         </span></dt><dd>
332                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
333         <p></p></dd><dt><span class="term">
334                 <span><b class="command"><tt class="option">kernel</tt></b></span>
335         </span></dt><dd>
336                 Kernel version
337         <p></p></dd><dt><span class="term">
338                 <span><b class="command"><tt class="option">linkstatus</tt></b></span>
339         <tt class="option">(interface)</tt>
340         </span></dt><dd>
341                 Get the link status for wireless connections
342         <p></p></dd><dt><span class="term">
343                 <span><b class="command"><tt class="option">loadavg</tt></b></span>
344         </span></dt><dd>
345                 (1,2,3)&gt; System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
346         <p></p></dd><dt><span class="term">
347                 <span><b class="command"><tt class="option">machine</tt></b></span>
348         </span></dt><dd>
349                 Machine, i686 for example
350         <p></p></dd><dt><span class="term">
351                 <span><b class="command"><tt class="option">mails</tt></b></span>
352         </span></dt><dd>
353                 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.
354         <p></p></dd><dt><span class="term">
355                 <span><b class="command"><tt class="option">mem</tt></b></span>
356         </span></dt><dd>
357                 Amount of memory in use
358         <p></p></dd><dt><span class="term">
359                 <span><b class="command"><tt class="option">membar</tt></b></span>
360         <tt class="option">(height),(width)</tt>
361         </span></dt><dd>
362                 Bar that shows amount of memory in use
363         <p></p></dd><dt><span class="term">
364                 <span><b class="command"><tt class="option">memmax</tt></b></span>
365         </span></dt><dd>
366                 Total amount of memory
367         <p></p></dd><dt><span class="term">
368                 <span><b class="command"><tt class="option">memperc</tt></b></span>
369         </span></dt><dd>
370                 Percentage of memory in use
371         <p></p></dd><dt><span class="term">
372                 <span><b class="command"><tt class="option">ml_upload_counter</tt></b></span>
373         </span></dt><dd>
374                 total session upload in mb
375         <p></p></dd><dt><span class="term">
376                 <span><b class="command"><tt class="option">ml_download_counter</tt></b></span>
377         </span></dt><dd>
378                 total session download in mb
379         <p></p></dd><dt><span class="term">
380                 <span><b class="command"><tt class="option">ml_nshared_files</tt></b></span>
381         </span></dt><dd>
382                 number of shared files
383         <p></p></dd><dt><span class="term">
384                 <span><b class="command"><tt class="option">ml_shared_counter</tt></b></span>
385         </span></dt><dd>
386                 total session shared in mb, buggy in some mldonkey versions
387         <p></p></dd><dt><span class="term">
388                 <span><b class="command"><tt class="option">ml_tcp_upload_rate</tt></b></span>
389         </span></dt><dd>
390                 tcp upload rate in kb/s
391         <p></p></dd><dt><span class="term">
392                 <span><b class="command"><tt class="option">ml_tcp_download_rate</tt></b></span>
393         </span></dt><dd>
394                 tcp download rate in kb/s
395         <p></p></dd><dt><span class="term">
396                 <span><b class="command"><tt class="option">ml_udp_upload_rate</tt></b></span>
397         </span></dt><dd>
398                 udp upload rate in kb/s
399         <p></p></dd><dt><span class="term">
400                 <span><b class="command"><tt class="option">ml_udp_download_rate</tt></b></span>
401         </span></dt><dd>
402                 udp download rate in kb/s
403         <p></p></dd><dt><span class="term">
404                 <span><b class="command"><tt class="option">ml_ndownloaded_files</tt></b></span>
405         </span></dt><dd>
406                 number of completed files
407         <p></p></dd><dt><span class="term">
408                 <span><b class="command"><tt class="option">ml_ndownloading_files</tt></b></span>
409         </span></dt><dd>
410                 number of downloading files
411         <p></p></dd><dt><span class="term">
412                 <span><b class="command"><tt class="option">mpd_artist</tt></b></span>
413         </span></dt><dd>
414                 Artist in current MPD song must be enabled at compile
415         <p></p></dd><dt><span class="term">
416                 <span><b class="command"><tt class="option">mpd_album</tt></b></span>
417         </span></dt><dd>
418                 Album in current MPD song
419         <p></p></dd><dt><span class="term">
420                 <span><b class="command"><tt class="option">mpd_bar</tt></b></span>
421         <tt class="option">(height),(width)</tt>
422         </span></dt><dd>
423                 Bar of mpd's progress
424         <p></p></dd><dt><span class="term">
425                 <span><b class="command"><tt class="option">mpd_bitrate</tt></b></span>
426         </span></dt><dd>
427                 Bitrate of current song
428         <p></p></dd><dt><span class="term">
429                 <span><b class="command"><tt class="option">mpd_status</tt></b></span>
430         </span></dt><dd>
431                 Playing, stopped, et cetera.
432         <p></p></dd><dt><span class="term">
433                 <span><b class="command"><tt class="option">mpd_title</tt></b></span>
434         </span></dt><dd>
435                 Title of current MPD song
436         <p></p></dd><dt><span class="term">
437                 <span><b class="command"><tt class="option">mpd_vol</tt></b></span>
438         </span></dt><dd>
439                 MPD's volume
440         <p></p></dd><dt><span class="term">
441                 <span><b class="command"><tt class="option">mpd_elapsed</tt></b></span>
442         </span></dt><dd>
443                 Song's elapsed time
444         <p></p></dd><dt><span class="term">
445                 <span><b class="command"><tt class="option">mpd_length</tt></b></span>
446         </span></dt><dd>
447                 Song's length
448         <p></p></dd><dt><span class="term">
449                 <span><b class="command"><tt class="option">mpd_percent</tt></b></span>
450         </span></dt><dd>
451                 Percent of song's progress
452         <p></p></dd><dt><span class="term">
453                 <span><b class="command"><tt class="option">new_mails</tt></b></span>
454         </span></dt><dd>
455                 Unread mail count in mail spool.
456         <p></p></dd><dt><span class="term">
457                 <span><b class="command"><tt class="option">nodename</tt></b></span>
458         </span></dt><dd>
459                 Hostname
460         <p></p></dd><dt><span class="term">
461                 <span><b class="command"><tt class="option">outlinecolor</tt></b></span>
462         <tt class="option">(color)</tt>
463         </span></dt><dd>
464                 Change outline color
465         <p></p></dd><dt><span class="term">
466                 <span><b class="command"><tt class="option">pre_exec</tt></b></span>
467         <tt class="option">shell command</tt>
468         </span></dt><dd>
469                 Executes a shell command one time before conky displays anything and puts output as text.
470         <p></p></dd><dt><span class="term">
471                 <span><b class="command"><tt class="option">processes</tt></b></span>
472         </span></dt><dd>
473                 Total processes (sleeping and running)
474         <p></p></dd><dt><span class="term">
475                 <span><b class="command"><tt class="option">running_processes</tt></b></span>
476         </span></dt><dd>
477                 Running processes (not sleeping), requires Linux 2.6
478         <p></p></dd><dt><span class="term">
479                 <span><b class="command"><tt class="option">shadecolor</tt></b></span>
480         <tt class="option">(color)</tt>
481         </span></dt><dd>
482                 Change shading color
483         <p></p></dd><dt><span class="term">
484                 <span><b class="command"><tt class="option">stippled_hr</tt></b></span>
485         <tt class="option">(space)</tt>
486         </span></dt><dd>
487                 Stippled (dashed) horizontal line
488         <p></p></dd><dt><span class="term">
489                 <span><b class="command"><tt class="option">swapbar</tt></b></span>
490         <tt class="option">(height),(width)</tt>
491         </span></dt><dd>
492                 Bar that shows amount of swap in use
493         <p></p></dd><dt><span class="term">
494                 <span><b class="command"><tt class="option">swap</tt></b></span>
495         </span></dt><dd>
496                 Amount of swap in use
497         <p></p></dd><dt><span class="term">
498                 <span><b class="command"><tt class="option">swapmax</tt></b></span>
499         </span></dt><dd>
500                 Total amount of swap
501         <p></p></dd><dt><span class="term">
502                 <span><b class="command"><tt class="option">swapperc</tt></b></span>
503         </span></dt><dd>
504                 Percentage of swap in use
505         <p></p></dd><dt><span class="term">
506                 <span><b class="command"><tt class="option">sysname</tt></b></span>
507         </span></dt><dd>
508                 System name, Linux for example
509         <p></p></dd><dt><span class="term">
510                 <span><b class="command"><tt class="option">offset</tt></b></span>
511                 <tt class="option">(pixels)</tt>
512         </span></dt><dd>
513                 Move text over by N pixels.  See also $voffset.
514                 <p></p></dd><dt><span class="term">
515                 <span><b class="command"><tt class="option">tail</tt></b></span>
516         </span></dt><dd>
517                 logfile, lines interval&gt; Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines. Max of 30 lines can be displayed.
518         <p></p></dd><dt><span class="term">
519                 <span><b class="command"><tt class="option">time</tt></b></span>
520         <tt class="option">(format)</tt>
521         </span></dt><dd>
522                 Local time, see man strftime to get more information about format
523         <p></p></dd><dt><span class="term">
524                 <span><b class="command"><tt class="option">totaldown</tt></b></span>
525         <tt class="option">net</tt>
526         </span></dt><dd>
527                 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
528         <p></p></dd><dt><span class="term">
529                 <span><b class="command"><tt class="option">top</tt></b></span>
530         <tt class="option">type, num</tt>
531         </span></dt><dd>
532                 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.
533         <p></p></dd><dt><span class="term">
534                 <span><b class="command"><tt class="option">top_mem</tt></b></span>
535         <tt class="option">type, num</tt>
536         </span></dt><dd>
537                 Same as top, except sorted by mem usage instead of cpu
538         <p></p></dd><dt><span class="term">
539                 <span><b class="command"><tt class="option">totalup</tt></b></span>
540         <tt class="option">net</tt>
541         </span></dt><dd>
542                 Total upload, this one too, may overflow
543         <p></p></dd><dt><span class="term">
544                 <span><b class="command"><tt class="option">updates</tt></b></span>
545         <tt class="option">Number of updates</tt>
546         </span></dt><dd>
547                 for debugging
548         <p></p></dd><dt><span class="term">
549                 <span><b class="command"><tt class="option">upspeed</tt></b></span>
550         <tt class="option">net</tt>
551         </span></dt><dd>
552                 Upload speed in kilobytes
553         <p></p></dd><dt><span class="term">
554                 <span><b class="command"><tt class="option">upspeedf</tt></b></span>
555         <tt class="option">net</tt>
556         </span></dt><dd>
557                 Upload speed in kilobytes with one decimal
558         <p></p></dd><dt><span class="term">
559                 <span><b class="command"><tt class="option">upspeedgraph</tt></b></span>
560                 <tt class="option">net, (height),(width) (gradient colour 1) (gradient colour 2)</tt>
561         </span></dt><dd>
562                 Upload speed graph, colours defined in hex, minus the #.
563         <p></p></dd><dt><span class="term">
564                 <span><b class="command"><tt class="option">uptime</tt></b></span>
565         </span></dt><dd>
566                 Uptime
567         <p></p></dd><dt><span class="term">
568                 <span><b class="command"><tt class="option">uptime_short</tt></b></span>
569         </span></dt><dd>
570                 Uptime in a shorter format
571         <p></p></dd><dt><span class="term">
572                 <span><b class="command"><tt class="option">seti_prog</tt></b></span>
573         </span></dt><dd>
574                 Seti@home current progress
575         <p></p></dd><dt><span class="term">
576                 <span><b class="command"><tt class="option">seti_progbar</tt></b></span>
577         <tt class="option">(height),(width)</tt>
578         </span></dt><dd>
579                 Seti@home current progress bar
580         <p></p></dd><dt><span class="term">
581                 <span><b class="command"><tt class="option">seti_credit</tt></b></span>
582         </span></dt><dd>
583                 Seti@home total user credit
584         <p></p></dd><dt><span class="term">
585                 <span><b class="command"><tt class="option">voffset</tt></b></span>
586                 <tt class="option">(pixels)</tt>
587         </span></dt><dd>
588                 Change verticle offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
589                 <p></p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2521506"></a><h2>Examples</h2><div class="variablelist"><dl><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-t '${time %D %H:%m}' -o -u 30</tt></span></dt><dd>Start Conky in its own window with date and clock as text and 30 sec update interval.</dd><dt><span class="term"><tt class="varname">conky </tt><tt class="option">-a top_left -x 5 -y 500 -d</tt></span></dt><dd>Start Conky to background at coordinates (5, 500).</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2521547"></a><h2>Files</h2><tt class="filename">~/.conkyrc</tt> default configuration file
590         </div><div class="refsect1" lang="en"><a name="id2521560"></a><h2>Bugs</h2><p>  
591                 Drawing to root or some other desktop window directly doesn't work with 
592                 all window managers. Especially doesn't work well with Gnome and it has 
593                 been reported that it doesn't work with KDE either. Nautilus can be 
594                 disabled from drawing to desktop with program gconf-editor. Uncheck 
595                 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky 
596                 to set some specific window id. You might find xwininfo -tree useful to 
597                 find the window to draw to. You can also use -o argument which makes
598                 Conky to create its own window.
599                 </p></div><div class="refsect1" lang="en"><a name="id2521579"></a><h2>See Also</h2><p><a href="http://conky.sourceforge.net" target="_top">
600     http://conky.sourceforge.net</a></p><p><a href="http://www.sourceforge.net/projects/conky" target="_top">
601     http://www.sourceforge.net/projects/conky</a></p><p>
602                         #conky on irc.freenode.net
603                 </p></div><div class="refsect1" lang="en"><a name="id2521605"></a><h2>Authors</h2><p>
604                         The Conky dev team. What's up now??!
605                 </p></div></div></body></html>
Unnamed repository; edit this file to name it for gitweb.