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