Added diskio_avg_samples patch (thanks Yeon-Hyeong)
[monky] / README
1 conky(1)                                                              conky(1)
2
3
4
5 \e[1mNAME\e[0m
6        conky - A system monitor for X originally based on the torsmo code, but
7        more kickass. It just keeps on given'er. Yeah.
8
9 \e[1mSYNOPSIS\e[0m
10        \e[1mconky \e[22m[\e[4moptions\e[24m]
11
12 \e[1mDESCRIPTION\e[0m
13        Conky is a system monitor for X originally based on torsmo.  Since  its
14        inception,  Conky has changed significantly from its predecessor, while
15        maintaining simplicity and  configurability.  Conky  can  display  just
16        about  anything,  either on your root desktop or in its own window. Not
17        only does Conky have many built-in objects, it can  also  display  just
18        about any piece of information by using scripts and other external pro‐
19        grams.
20
21        Conky has more than 250 built  in  objects,  including  support  for  a
22        plethora  of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
23        "top" like process stats, and network monitoring, just to name a  few),
24        built in IMAP and POP3 support, built in support for many popular music
25        players (MPD, XMMS2, BMPx, Audacious), and much much more.   Conky  can
26        display  this  info  either  as text, or using simple progress bars and
27        graph widgets, with different fonts and colours.
28
29        We are always looking for help, whether  its  reporting  bugs,  writing
30        patches,  or writing docs.  Please use the facilities at SourceForge to
31        make bug reports, feature requests, and  submit  patches,  or  stop  by
32        #conky on irc.freenode.net if you have questions or want to contribute.
33
34        Thanks for your interest in Conky.
35
36 \e[1mCOMPILING\e[0m
37        For  users compiling from source on a binary distro, make sure you have
38        the X development libraries installed. This should be a  package  along
39        the  lines  of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar
40        "-dev" format for the other libs required (depending on your  configure
41        options).
42
43        Conky  has  (for  some time) been available in the repositories of most
44        popular distributions.  Here are some installation instructions  for  a
45        few:
46
47        Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
48        admin/conky" for installation.  There is  also  usually  an  up-to-date
49        ebuild within Conky's package or in the git repo.
50
51        Debian,  etc. users -- Conky should be in your repositories, and can be
52        installed by doing "aptitude install conky".
53
54        Example to compile and run Conky with  all  optional  components  (note
55        that some configure options may differ for your system):
56
57        \e[1msh autogen.sh # Only required if building from the git repo\e[0m
58
59        \e[1m./configure       --prefix=/usr      --mandir=/usr/share/man      --in‐\e[0m
60        \e[1mfodir=/usr/share/info --datadir=/usr/share  --sysconfdir=/etc  --local‐\e[0m
61        \e[1mstatedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega‐\e[0m
62        \e[1mcy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis‐\e[0m
63        \e[1mable-portmon   --disable-network  --enable-debug  --disable-x11  --dis‐\e[0m
64        \e[1mable-double-buffer --disable-xdamage --disable-xft\e[0m
65
66        \e[1mmake\e[0m
67
68        \e[1mmake install # Optional\e[0m
69
70        \e[1msrc/conky\e[0m
71
72        Conky has been tested to be compatible with C99 C, however it  has  not
73        been tested with anything other than gcc, and is not guaranteed to work
74        with other compilers.
75
76 \e[1mYOU SHOULD KNOW\e[0m
77        Conky is generally very good on resources. That said, the more you  try
78        to make Conky do, the more resources it is going to consume.
79
80        An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
81        conky".  Saves you the trouble of having to kill and then restart.  You
82        can now also do the same with SIGHUP.
83
84 \e[1mOPTIONS\e[0m
85        Command  line  options override configurations defined in configuration
86        file.
87
88        \e[1m-v | -V | --version\e[0m
89               Prints version and exits
90
91
92        \e[1m-q | --quiet\e[0m
93               Run Conky in 'quiet mode' (ie. no output)
94
95
96        \e[1m-a | --alignment=ALIGNMENT\e[0m
97               Text alignment on  screen,  {top,bottom,middle}_{left,right,mid‐
98               dle} or none
99
100
101        \e[1m-b | --double-buffer\e[0m
102               Use double buffering (eliminates "flicker")
103
104
105        \e[1m-c | --config=FILE\e[0m
106               Config file to load instead of $HOME/.conkyrc
107
108
109        \e[1m-d | --daemonize\e[0m
110               Daemonize Conky, aka fork to background
111
112
113        \e[1m-f | --font=FONT\e[0m
114               Font to use
115
116
117        \e[1m-h | --help\e[0m
118               Prints command line help and exits
119
120
121        \e[1m-o | --own-window\e[0m
122               Create own window to draw
123
124
125        \e[1m-t | --text=TEXT\e[0m
126               Text to render, remember single quotes, like -t ' $uptime '
127
128
129        \e[1m-u | --interval=SECONDS\e[0m
130               Update interval
131
132
133        \e[1m-w | --window-id=WIN_ID\e[0m
134               Window id to draw
135
136
137        \e[1m-x X_COORDINATE\e[0m
138               X position
139
140
141        \e[1m-y Y_COORDINATE\e[0m
142               Y position
143
144
145        \e[1m-i COUNT\e[0m
146               Number of times to update Conky (and quit)
147
148
149 \e[1mCONFIGURATION SETTINGS\e[0m
150        Default    configuration    file    location   is   $HOME/.conkyrc   or
151        ${sysconfdir}/conky/conky.conf. On most systems,  sysconfdir  is  /etc,
152        and you can find the sample config file there (/etc/conky/conky.conf).
153
154        You  might  want  to copy it to $HOME/.conkyrc and then start modifying
155        it.  Other configs can be found at http://conky.sf.net/
156
157        \e[1malias  \e[22mUse this to create aliases of variables. The first  argument  is
158               the  new  name, the second the old name, and the other arguments
159               are passed on to the variable. Example: If you want to use  $al‐
160               pha  instead  of  ${beta gamma delta} then you have to write the
161               following: alias alpha beta gamma delta . PS: Instead of  creat‐
162               ing  an  alias  in the config you can also use environment vari‐
163               ables. Example: Start conky like this: alpha="beta gamma  delta"
164               conky
165
166
167        \e[1malignment\e[0m
168               Aligned position on screen, may be top_left, top_right, top_mid‐
169               dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
170               dle_right,  or  none  (also can be abreviated as tl, tr, tm, bl,
171               br, bm, ml, mr)
172
173
174        \e[1mbackground\e[0m
175               Boolean value, if true, Conky will be forked to background  when
176               started.
177
178
179        \e[1mborder_margin\e[0m
180               Border margin in pixels.
181
182
183        \e[1mborder_width\e[0m
184               Border width in pixels.
185
186
187        \e[1mcolorN \e[22mPredefine  a color for use inside TEXT segments. Substitute N by
188               a digit between 0 and 9, inclusively. When specifying the  color
189               value in hex, omit the leading hash (#).
190
191
192        \e[1mcpu_avg_samples\e[0m
193               The number of samples to average for CPU monitoring.
194
195
196        \e[1mdiskio_avg_samples\e[0m
197               The number of samples to average for disk I/O monitoring.
198
199
200        \e[1mtop_cpu_separate\e[0m
201               If true, cpu in top will show usage of one processor's power. If
202               false, cpu in top will show the usage of all  processors'  power
203               combined.
204
205
206        \e[1mdefault_bar_size\e[0m
207               Specify  a  default  width  and  height  for bars. Example: 'de‐
208               fault_bar_size 0 6'. This is particularly useful for execbar and
209               execibar as they do not take size arguments.
210
211
212        \e[1mdefault_graph_size\e[0m
213               Specify  a  default  width  and height for graphs. Example: 'de‐
214               fault_graph_size 0 25'. This is particularly  useful  for  exec‐
215               graph and execigraph as they do not take size arguments
216
217
218        \e[1mdefault_gauge_size\e[0m
219               Specify  a  default  width  and height for gauges. Example: 'de‐
220               fault_gauge_size 25 25'. This is particularly useful  for  exec‐
221               gauge and execigauge as they do not take size arguments
222
223
224        \e[1mdefault_color\e[0m
225               Default color and border color
226
227
228        \e[1mdefault_outline_color\e[0m
229               Default outline color
230
231
232        \e[1mdefault_shade_color\e[0m
233               Default shading color and border's shading color
234
235
236        \e[1mdouble_buffer\e[0m
237               Use the Xdbe extension? (eliminates flicker) It is highly recom‐
238               mended to use own window with this one so double buffer won't be
239               so big.
240
241
242        \e[1mdraw_borders\e[0m
243               Draw borders around text?
244
245
246        \e[1mdraw_graph_borders\e[0m
247               Draw borders around graphs?
248
249
250        \e[1mdraw_outline\e[0m
251               Draw outlines?
252
253
254        \e[1mdraw_shades\e[0m
255               Draw shades?
256
257
258        \e[1mfont   \e[22mFont name in X, xfontsel can be used to get a nice font
259
260
261        \e[1mgap_x  \e[22mGap,  in pixels, between right or left border of screen, same as
262               passing -x at command line, e.g. gap_x 10
263
264
265        \e[1mgap_y  \e[22mGap, in pixels, between top or bottom border of screen, same  as
266               passing -y at command line, e.g. gap_y 10.
267
268
269        \e[1mif_up_strictness\e[0m
270               How  strict  should if_up be when testing an interface for being
271               up? The value is one of up, link or address, to  check  for  the
272               interface being solely up, being up and having link or being up,
273               having link and an assigned IP address.
274
275
276        \e[1mimap   \e[22mDefault global IMAP server. Arguments are: "host user  pass  [-i
277               interval]  [-f folder] [-p port] [-e command] [-r retries]". De‐
278               fault port is 143, default folder is 'INBOX',  default  interval
279               is  5 minutes, and default number of retries before giving up is
280               5. If the password is supplied as '*', you will be  prompted  to
281               enter the password when Conky starts.
282
283
284        \e[1mmail_spool\e[0m
285               Mail spool for mail checking
286
287
288        \e[1mmax_port_monitor_connections\e[0m
289               Allow  each  port monitor to track at most this many connections
290               (if 0 or not set, default is 256)
291
292
293        \e[1mmax_specials\e[0m
294               Maximum number of special things, e.g. fonts,  offsets,  aligns,
295               etc. (default is 512)
296
297
298        \e[1mmax_user_text bytes\e[0m
299               Maximum size of user text buffer, i.e. layout below TEXT line in
300               config file (default is 16384 bytes)
301
302
303        \e[1mtext_buffer_size bytes\e[0m
304               Size of the standard text buffer (default is  256  bytes).  This
305               buffer  is used for intermediary text, such as individual lines,
306               output from $exec vars, and various other variables.  Increasing
307               the  size  of this buffer can drastically reduce Conky's perfor‐
308               mance, but will allow for more text display  per  variable.  The
309               size  of this buffer cannot be smaller than the default value of
310               256 bytes.
311
312
313        \e[1mmaximum_width pixels\e[0m
314               Maximum width of window
315
316
317        \e[1mminimum_size width (height)\e[0m
318               Minimum size of window
319
320
321        \e[1mmpd_host\e[0m
322               Host of MPD server
323
324
325        \e[1mmpd_port\e[0m
326               Port of MPD server
327
328
329        \e[1mmpd_password\e[0m
330               MPD server password
331
332
333        \e[1mmusic_player_interval\e[0m
334               Music player thread update interval (defaults to Conky's  update
335               interval)
336
337
338        \e[1mnet_avg_samples\e[0m
339               The number of samples to average for net data
340
341
342        \e[1mno_buffers\e[0m
343               Substract (file system) buffers from used memory?
344
345
346        \e[1moverride_utf8_locale\e[0m
347               Force UTF8? requires XFT
348
349
350        \e[1mown_window\e[0m
351               Boolean, create own window to draw?
352
353
354        \e[1mown_window_class\e[0m
355               Manually set the WM_CLASS name. Defaults to "Conky".
356
357
358        \e[1mown_window_colour colour\e[0m
359               If  own_window_transparent no, set a specified background colour
360               (defaults to black). Takes either a hex  value  (#ffffff)  or  a
361               valid RGB name (see /usr/lib/X11/rgb.txt)
362
363
364        \e[1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager\e[0m
365               If  own_window is yes, you may use these window manager hints to
366               affect the way Conky displays.  Notes: Use own_window_type desk‐
367               top  as another way to implement many of these hints implicitly.
368               If you use own_window_type override, window manager  hints  have
369               no meaning and are ignored.
370
371
372        \e[1mown_window_title\e[0m
373               Manually set the window name. Defaults to "<hostname> - conky".
374
375
376        \e[1mown_window_transparent\e[0m
377               Boolean, set pseudo-transparency?
378
379
380        \e[1mown_window_type\e[0m
381               if own_window is yes, you may specify type normal, desktop, dock
382               or override (default: normal).  Desktop windows are special win‐
383               dows that have no window decorations; are always visible on your
384               desktop; do not appear in your pager or taskbar; and are  sticky
385               across  all workspaces.  Override windows are not under the con‐
386               trol of the window manager. Hints are ignored. This type of win‐
387               dow can be useful for certain situations.
388
389
390        \e[1mout_to_console\e[0m
391               Print text to stdout.
392
393
394        \e[1mout_to_stderr\e[0m
395               Print text to stderr.
396
397
398        \e[1mout_to_x\e[0m
399               When  set  to  no, there will be no output in X (useful when you
400               also use things like out_to_console).  If you set it to no, make
401               sure  that  it's placed before all other X-related setting (take
402               the first line of your configfile to be sure). Default value  is
403               yes
404
405
406        \e[1moverwrite_file\e[0m
407               Overwrite the file given as argument.
408
409
410        \e[1mappend_file\e[0m
411               Append the file given as argument.
412
413
414        \e[1mpad_percents\e[0m
415               Pad percentages to this many decimals (0 = no padding)
416
417
418        \e[1mpop3   \e[22mDefault  global  POP3 server. Arguments are: "host user pass [-i
419               interval] [-p port] [-e command] [-r retries]". Default port  is
420               110,  default  interval  is 5 minutes, and default number of re‐
421               tries before giving up is 5. If the password is supplied as '*',
422               you will be prompted to enter the password when Conky starts.
423
424
425        \e[1mshort_units\e[0m
426               Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
427               fault is off.
428
429
430        \e[1mshow_graph_scale\e[0m
431               Shows the maximum value in scaled graphs.
432
433
434        \e[1mshow_graph_range\e[0m
435               Shows the time range covered by a graph.
436
437
438        \e[1mstippled_borders\e[0m
439               Border stippling (dashing) in pixels
440
441
442        \e[1mtemperature_unit\e[0m
443               Desired output unit of all  objects  displaying  a  temperature.
444               Parameters  are  either  "fahrenheit"  or "celsius". The default
445               unit is degree Celsius.
446
447
448        \e[1mtemplateN\e[0m
449               Define a template for later use inside TEXT segments. Substitute
450               N  by  a  digit  between 0 and 9, inclusively.  The value of the
451               variable is being inserted into the stuff below TEXT at the cor‐
452               responding position, but before some substitutions are applied:
453
454               '\n' -> newline
455               '\\' -> backslash
456               '\ ' -> space
457               '\N' -> template argument N
458
459
460        \e[1mtotal_run_times\e[0m
461               Total  number of times for Conky to update before quitting. Zero
462               makes Conky run forever
463
464
465        \e[1mupdate_interval\e[0m
466               Update interval in seconds
467
468
469        \e[1muppercase\e[0m
470               Boolean value, if true, text is rendered in upper case
471
472
473        \e[1muse_spacer\e[0m
474               Adds spaces around certain objects to stop them from moving oth‐
475               er things around. Arguments are left, right, and none (default).
476               The  old  true/false  values  are  deprecated  and  default   to
477               right/none  respectively.  Note  that this only helps if you are
478               using a mono font, such as Bitstream Vera Sans Mono.
479
480
481        \e[1muse_xft\e[0m
482               Use Xft (anti-aliased font and stuff)
483
484
485        \e[1mxftalpha\e[0m
486               Alpha of Xft font. Must be a value at or between 1 and 0.
487
488
489        \e[1mxftfont\e[0m
490               Xft font to use.
491
492
493        \e[1mTEXT   \e[22mAfter this begins text to be formatted on screen. Backslash  (\)
494               escapes  newlines  in  the  text section. This can be useful for
495               cleaning up config files where conky is used to  pipe  input  to
496               dzen2.
497
498
499 \e[1mVARIABLES\e[0m
500        Colors  are  parsed using XParsecolor(), there might be a list of them:
501        /usr/share/X11/rgb.txt.   Also,    ⟨http://sedition.com/perl/rgb.html⟩.
502        Color can be also in #rrggbb format (hex).
503
504        \e[1maddr interface\e[0m
505               IP  address  for  an interface, or "No Address" if no address is
506               assigned.
507
508
509        \e[1maddrs interface\e[0m
510               IP addresses for an interface (if one - works like addr).  Linux
511               only.
512
513
514        \e[1macpiacadapter\e[0m
515               ACPI ac adapter state.
516
517
518        \e[1macpifan\e[0m
519               ACPI fan state
520
521
522        \e[1macpitemp\e[0m
523               ACPI temperature in C.
524
525
526        \e[1madt746xcpu\e[0m
527               CPU temperature from therm_adt746x
528
529
530        \e[1madt746xfan\e[0m
531               Fan speed from therm_adt746x
532
533
534        \e[1malignr (num)\e[0m
535               Right-justify text, with space of N
536
537
538        \e[1malignc (num)\e[0m
539               Align text to centre
540
541
542        \e[1mapm_adapter\e[0m
543               Display APM AC adapter status (FreeBSD only)
544
545
546        \e[1mapm_battery_life\e[0m
547               Display APM battery life in percent (FreeBSD only)
548
549
550        \e[1mapm_battery_time\e[0m
551               Display  remaining  APM battery life in hh:mm:ss or "unknown" if
552               AC adapterstatus is on-line or charging (FreeBSD only)
553
554
555        \e[1maudacious_bar (height),(width)\e[0m
556               Progress bar
557
558
559        \e[1maudacious_bitrate\e[0m
560               Bitrate of current tune
561
562
563        \e[1maudacious_channels\e[0m
564               Number of audio channels of current tune
565
566
567        \e[1maudacious_filename\e[0m
568               Full path and filename of current tune
569
570
571        \e[1maudacious_frequency\e[0m
572               Sampling frequency of current tune
573
574
575        \e[1maudacious_length\e[0m
576               Total length of current tune as MM:SS
577
578
579        \e[1maudacious_length_seconds\e[0m
580               Total length of current tune in seconds
581
582
583        \e[1maudacious_playlist_position\e[0m
584               Playlist position of current tune
585
586
587        \e[1maudacious_playlist_length\e[0m
588               Number of tunes in playlist
589
590
591        \e[1maudacious_position\e[0m
592               Position of current tune (MM:SS)
593
594
595        \e[1maudacious_position_seconds\e[0m
596               Position of current tune in seconds
597
598
599        \e[1maudacious_status\e[0m
600               Player status (Playing/Paused/Stopped/Not running)
601
602
603        \e[1maudacious_title (max length)\e[0m
604               Title of current tune with optional maximum length specifier
605
606
607        \e[1maudacious_main_volume\e[0m
608               The current volume fetched from Audacious
609
610
611        \e[1mbattery (num)\e[0m
612               Battery status and remaining percentage capacity of ACPI or  APM
613               battery.  ACPI  battery number can be given as argument (default
614               is BAT0).
615
616
617        \e[1mbattery_short (num)\e[0m
618               Battery status and remaining percentage capacity of ACPI or  APM
619               battery.  ACPI  battery number can be given as argument (default
620               is BAT0).  This mode display a short status, which means that  C
621               is  displayed  instead of charging and D is displayed instead of
622               discharging.
623
624
625        \e[1mbattery_bar (height),(width) (num)\e[0m
626               Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
627               tery number can be given as argument (default is BAT0).
628
629
630        \e[1mbattery_percent (num)\e[0m
631               Battery percentage remaining for ACPI battery. ACPI battery num‐
632               ber can be given as argument (default is BAT0).
633
634
635        \e[1mbattery_time (num)\e[0m
636               Battery charge/discharge time remaining of  ACPI  battery.  ACPI
637               battery number can be given as argument (default is BAT0).
638
639
640        \e[1mbmpx_artist\e[0m
641               Artist in current BMPx track
642
643
644        \e[1mbmpx_album\e[0m
645               Album in current BMPx track
646
647
648        \e[1mbmpx_title\e[0m
649               Title of the current BMPx track
650
651
652        \e[1mbmpx_track\e[0m
653               Track number of the current BMPx track
654
655
656        \e[1mbmpx_bitrate\e[0m
657               Bitrate of the current BMPx track
658
659
660        \e[1mbmpx_uri\e[0m
661               URI of the current BMPx track
662
663
664        \e[1mbuffers\e[0m
665               Amount of memory buffered
666
667
668        \e[1mcached \e[22mAmount of memory cached
669
670
671        \e[1mcolor (color)\e[0m
672               Change drawing color to color
673
674
675        \e[1mcolorN \e[22mChange  drawing color to colorN configuration option, where N is
676               a digit between 0 and 9, inclusively.
677
678
679        \e[1mcombine var1 var2\e[0m
680               Places the lines of var2 to the  right  of  the  lines  of  var1
681               seperated  by  the chars that are put between var1 and var2. For
682               example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/memin‐
683               fo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1
684               and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐
685               ed to place more vars next to each other.
686
687
688        \e[1mconky_version\e[0m
689               Conky version
690
691
692        \e[1mconky_build_date\e[0m
693               Date Conky was built
694
695
696        \e[1mconky_build_arch\e[0m
697               CPU architecture Conky was built for
698
699
700        \e[1mcpu (cpuN)\e[0m
701               CPU  usage  in percents. For SMP machines, the CPU number can be
702               provided as an argument. ${cpu cpu0} is  the  total  usage,  and
703               ${cpu cpuX} (X >= 1) are individual CPUs.
704
705
706        \e[1mcpubar (cpuN) (height),(width)\e[0m
707               Bar  that shows CPU usage, height is bar's height in pixels. See
708               $cpu for more info on SMP.
709
710
711        \e[1mcpugauge (cpuN) (height),(width)\e[0m
712               Elliptical gauge that shows CPU  usage,  height  and  width  are
713               gauge's  vertical and horizontal axis respectively. See $cpu for
714               more info on SMP.
715
716
717        \e[1mcpugraph (cpuN) ("normal"|"log") (height),(width) (gradient  colour  1)\e[0m
718        \e[1m(gradient colour 2) (scale)\e[0m
719               CPU  usage graph, with optional colours in hex, minus the #. See
720               $cpu for more info on SMP. Uses  a  logarithmic  scale  (to  see
721               small numbers) when you use "log" instead of "normal".
722
723
724        \e[1mdiskio (device)\e[0m
725               Displays current disk IO. Device is optional, and takes the form
726               of sda for /dev/sda. Individual partitions are allowed.
727
728
729        \e[1mdiskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐\e[0m
730        \e[1mdient colour 2) (scale) (device)\e[0m
731               Disk  IO graph, colours defined in hex, minus the #. If scale is
732               non-zero, it becomes the scale for the graph. Uses a logarithmic
733               scale (to see small numbers) when you use "log" instead of "nor‐
734               mal".
735
736
737        \e[1mdiskio_read (device)\e[0m
738               Displays current disk IO for reads. Device as in diskio.
739
740
741        \e[1mdiskiograph_read ("normal"|"log") (height),(width) (gradient colour  1)\e[0m
742        \e[1m(gradient colour 2) (scale) (device)\e[0m
743               Disk IO graph for reads, colours defined in hex, minus the #. If
744               scale is non-zero, it becomes the scale for the graph. Device as
745               in  diskio. Uses a logarithmic scale (to see small numbers) when
746               you use "log" instead of "normal".
747
748
749        \e[1mdiskio_write (device)\e[0m
750               Displays current disk IO for writes. Device as in diskio.
751
752
753        \e[1mdiskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)\e[0m
754        \e[1m(gradient colour 2) (scale) (device)\e[0m
755               Disk  IO  graph for writes, colours defined in hex, minus the #.
756               If scale is non-zero, it becomes the scale for the graph. Device
757               as  in  diskio.  Uses a logarithmic scale (to see small numbers)
758               when you use "log" instead of "normal".
759
760
761        \e[1mdisk_protect device\e[0m
762               Disk  protection  status,  if  supported  (needs  kernel-patch).
763               Prints either "frozen" or "free " (note the padding).
764
765
766        \e[1mdownspeed net\e[0m
767               Download speed in KiB
768
769
770        \e[1mdownspeedf net\e[0m
771               Download speed in KiB with one decimal
772
773
774        \e[1mdownspeedgraph  ("normal"|"log")  (height),(width)  (gradient colour 1)\e[0m
775        \e[1m(gradient colour 2) (scale) (net)\e[0m
776               Download speed graph, colours defined in hex, minus  the  #.  If
777               scale  is  non-zero,  it becomes the scale for the graph. Uses a
778               logarithmic scale (to see small numbers) when you use "log"  in‐
779               stead of "normal".
780
781
782        \e[1melse   \e[22mText to show if any of the above are not true
783
784
785        \e[1mentropy_avail\e[0m
786               Current entropy available for crypto freaks
787
788
789        \e[1mentropy_bar (height),(width)\e[0m
790               Normalized bar of available entropy for crypto freaks
791
792
793        \e[1mentropy_poolsize\e[0m
794               Total size of system entropy pool for crypto freaks
795
796
797        \e[1meval string\e[0m
798               Evalutates given string according to the rules of TEXT interpre‐
799               tation, i.e. parsing any contained  text  object  specifications
800               into  their  output,  any occuring '$$' into a single '$' and so
801               on. The output is then being parsed again.
802
803
804        \e[1mexec command\e[0m
805               Executes a shell command and displays the output in conky. warn‐
806               ing:  this  takes a lot more resources than other variables. I'd
807               recommend coding wanted behaviour in C and posting a patch.
808
809
810        \e[1mexecbar command\e[0m
811               Same as exec, except if the first value return is  a  value  be‐
812               tween  0-100,  it  will  use that number for a bar. The size for
813               bars can be controlled via the default_bar_size config setting.
814
815
816        \e[1mexecgauge command\e[0m
817               Same as exec, except if the first value returned is a value  be‐
818               tween  0-100,  it will use that number for a gauge. The size for
819               gauges can be controlled via the default_gauge_size config  set‐
820               ting.
821
822
823        \e[1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐\e[0m
824        \e[1ment colour 2) (scale) command\e[0m
825               Same as execbar, but graphs values. Uses a logaritmic scale when
826               the  log  option  is  given (to see small numbers). Values still
827               have to be between 0 and 100. The size for graphs  can  be  con‐
828               trolled via the default_graph_size config setting.
829
830
831        \e[1mexeci interval command\e[0m
832               Same  as exec but with specific interval. Interval can't be less
833               than update_interval in configuration. See also $texeci
834
835
836        \e[1mexecibar interval command\e[0m
837               Same as execbar, except with an interval
838
839
840        \e[1mexecigraph interval command\e[0m
841               Same as execgraph, but takes an interval arg and graphs values.
842
843
844        \e[1mexecigauge interval command\e[0m
845               Same as execgauge, but takes an interval arg and gauges values.
846
847
848        \e[1mexecp command\e[0m
849               Executes a shell command and displays the output in conky. warn‐
850               ing:  this  takes a lot more resources than other variables. I'd
851               recommend coding wanted behaviour in C and posting a patch. This
852               differs  from $exec in that it parses the output of the command,
853               so you can insert things like ${color  red}hi!${color}  in  your
854               script  and  have  it correctly parsed by Conky.  Caveats: Conky
855               parses and evaluates the  output  of  $execp  every  time  Conky
856               loops, and then destroys all the objects. If you try to use any‐
857               thing like $execi within an $execp statement, it will  function‐
858               ally run at the same interval that the $execp statement runs, as
859               it is created and destroyed at every interval.
860
861
862        \e[1mexecpi interval command\e[0m
863               Same as execp but with specific interval. Interval can't be less
864               than update_interval in configuration. Note that the output from
865               the $execpi command is still parsed and evaluated at  every  in‐
866               terval.
867
868
869        \e[1mfont (font)\e[0m
870               Specify  a  different font. This new font will apply to the cur‐
871               rent line and everything following. You can use a $font with  no
872               arguments  to  change  back  to the default font (much like with
873               $color)
874
875
876        \e[1mfreq (n)\e[0m
877               Returns CPU #n's frequency in MHz. CPUs are counted from  1.  If
878               omitted, the parameter defaults to 1.
879
880
881        \e[1mfreq_g (n)\e[0m
882               Returns  CPU  #n's frequency in GHz. CPUs are counted from 1. If
883               omitted, the parameter defaults to 1.
884
885
886        \e[1mfs_bar (height),(width) fs\e[0m
887               Bar that shows how much space is used on a file  system.  height
888               is the height in pixels. fs is any file on that file system.
889
890
891        \e[1mfs_bar_free (height),(width) fs\e[0m
892               Bar  that  shows how much space is free on a file system. height
893               is the height in pixels. fs is any file on that file system.
894
895
896        \e[1mfs_free (fs)\e[0m
897               Free space on a file system available for users.
898
899
900        \e[1mfs_free_perc (fs)\e[0m
901               Free percentage of space on a file system available for users.
902
903
904        \e[1mfs_size (fs)\e[0m
905               File system size.
906
907
908        \e[1mfs_type (fs)\e[0m
909               File system type.
910
911
912        \e[1mfs_used (fs)\e[0m
913               File system used space.
914
915
916        \e[1mfs_used_perc (fs)\e[0m
917               Percent of file system used space.
918
919
920        \e[1mgoto x \e[22mThe next element will be printed at position 'x'.
921
922
923        \e[1mgw_iface\e[0m
924               Displays the default route's interface or "multiple"/"none"  ac‐
925               cordingly.
926
927
928        \e[1mgw_ip  \e[22mDisplays  the  default gateway's IP or "multiple"/"none" accord‐
929               ingly.
930
931
932        \e[1mhddtemp dev, (host,(port))\e[0m
933               Displays temperature of a selected hard disk drive  as  reported
934               by  the  hddtemp  daemon  running on host:port.  Default host is
935               127.0.0.1, default port is 7634.
936
937
938        \e[1mhead logfile lines (interval)\e[0m
939               Displays first N lines of supplied text text file.  If  interval
940               is  not  supplied,  Conky assumes 2x Conky's interval. Max of 30
941               lines can be displayed, or until the text buffer is filled.
942
943
944        \e[1mhr (height)\e[0m
945               Horizontal line, height is the height in pixels
946
947
948        \e[1mhwmon (dev) type n\e[0m
949               Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be  omit‐
950               ted  if you have only one hwmon device. Parameter type is either
951               'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
952               temperature.   Parameter   n   is  number  of  the  sensor.  See
953               /sys/class/hwmon/ on your local computer.
954
955
956        \e[1miconv_start codeset_from codeset_to\e[0m
957               Convert text from one codeset to another using GNU iconv.  Needs
958               to be stopped with iconv_stop.
959
960
961        \e[1miconv_stop\e[0m
962               Stop iconv codeset conversion.
963
964
965        \e[1mi2c (dev) type n\e[0m
966               I2C  sensor from sysfs (Linux 2.6). Parameter dev may be omitted
967               if you have only one I2C device. Parameter type is  either  'in'
968               or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
969               perature.  Parameter  n   is   number   of   the   sensor.   See
970               /sys/bus/i2c/devices/ on your local computer.
971
972
973        \e[1mi8k_ac_status\e[0m
974               If  running the i8k kernel driver for Inspiron laptops, displays
975               whether ac power is on, as listed in  /proc/i8k  (translated  to
976               human-readable).  Beware  that this is by default not enabled by
977               i8k itself.
978
979
980        \e[1mi8k_bios\e[0m
981               If running the i8k kernel driver for Inspiron laptops,  displays
982               the bios version as listed in /proc/i8k.
983
984
985        \e[1mi8k_buttons_status\e[0m
986               If  running the i8k kernel driver for Inspiron laptops, displays
987               the volume buttons status as listed in /proc/i8k.
988
989
990        \e[1mi8k_cpu_temp\e[0m
991               If running the i8k kernel driver for Inspiron laptops,  displays
992               the cpu temperature in Celsius, as reported by /proc/i8k.
993
994
995        \e[1mi8k_left_fan_rpm\e[0m
996               If  running the i8k kernel driver for Inspiron laptops, displays
997               the left fan's rate of rotation, in revolutions  per  minute  as
998               listed in /proc/i8k. Beware, some laptops i8k reports these fans
999               in reverse order.
1000
1001
1002        \e[1mi8k_left_fan_status\e[0m
1003               If running the i8k kernel driver for Inspiron laptops,  displays
1004               the left fan status as listed in /proc/i8k (translated to human-
1005               readable). Beware, some laptops i8k reports these  fans  in  re‐
1006               verse order.
1007
1008
1009        \e[1mi8k_right_fan_rpm\e[0m
1010               If  running the i8k kernel driver for Inspiron laptops, displays
1011               the right fan's rate of rotation, in revolutions per  minute  as
1012               listed in /proc/i8k. Beware, some laptops i8k reports these fans
1013               in reverse order.
1014
1015
1016        \e[1mi8k_right_fan_status\e[0m
1017               If running the i8k kernel driver for Inspiron laptops,  displays
1018               the  right  fan status as listed in /proc/i8k (translated to hu‐
1019               man-readable). Beware, some laptops i8k reports  these  fans  in
1020               reverse order.
1021
1022
1023        \e[1mi8k_serial\e[0m
1024               If  running the i8k kernel driver for Inspiron laptops, displays
1025               your laptop serial number as listed in /proc/i8k.
1026
1027
1028        \e[1mi8k_version\e[0m
1029               If running the i8k kernel driver for Inspiron laptops,  displays
1030               the version formatting of /proc/i8k.
1031
1032
1033        \e[1mibm_fan\e[0m
1034               If running the IBM ACPI, displays the fan speed.
1035
1036
1037        \e[1mibm_temps N\e[0m
1038               If  running the IBM ACPI, displays the temperatures from the IBM
1039               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1040               GPU.
1041
1042
1043        \e[1mibm_volume\e[0m
1044               If  running  the  IBM  ACPI,  displays the "master" volume, con‐
1045               trolled by the volume keys (0-14).
1046
1047
1048        \e[1mibm_brightness\e[0m
1049               If running the IBM ACPI, displays the brigtness of the laptops's
1050               LCD (0-7).
1051
1052
1053        \e[1mif_empty (var)\e[0m
1054               if  conky  variable  VAR  is  empty,  display everything between
1055               $if_empty and the matching $endif
1056
1057
1058        \e[1mif_existing file (string)\e[0m
1059               if FILE exists, display everything between if_existing  and  the
1060               matching  $endif.  The optional second paramater checks for FILE
1061               containing the specified string and  prints  everything  between
1062               $if_existing and the matching $endif.
1063
1064
1065        \e[1mif_gw  \e[22mif there is at least one default gateway, display everything be‐
1066               tween $if_gw and the matching $endif
1067
1068
1069        \e[1mif_match expression\e[0m
1070               Evaluates the given boolean expression, printing everything  be‐
1071               tween $if_match and the matching $endif depending on whether the
1072               evaluation returns true or not.  Valid expressions consist of  a
1073               left  side,  an  operator and a right side. Left and right sides
1074               are being parsed for contained text objects  before  evaluation.
1075               Recognised left and right side types are:
1076
1077               \e[1mdouble\e[22m: argument consists of only digits and a single dot.
1078               \e[1mlong\e[22m: argument consists of only digits.
1079               \e[1mstring\e[22m: argument is enclosed in quotation mark or the checks for
1080               double and long failed before.
1081
1082               Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1083
1084
1085        \e[1mif_mixer_mute (mixer)\e[0m
1086               If mixer exists, display everything between  $if_mixer_mute  and
1087               the matching $endif. If no mixer is specified, "Master" is used.
1088
1089
1090        \e[1mif_running (process)\e[0m
1091               if  PROCESS  is  running, display everything $if_running and the
1092               matching $endif. This uses the  ``pidof''  command,  so  the  -x
1093               switch is also supported.
1094
1095
1096        \e[1mif_mounted (mountpoint)\e[0m
1097               if MOUNTPOINT is mounted, display everything between $if_mounted
1098               and the matching $endif
1099
1100
1101        \e[1mif_smapi_bat_installed (INDEX)\e[0m
1102               when using smapi, if the battery with index INDEX is  installed,
1103               display   everything  between  $if_smapi_bat_installed  and  the
1104               matching $endif
1105
1106
1107        \e[1mif_up (interface)\e[0m
1108               if INTERFACE exists and is up, display everything between $if_up
1109               and the matching $endif
1110
1111
1112        \e[1mif_updatenr (updatenr)\e[0m
1113               If  it's the UPDATENR-th time that conky updates, display every‐
1114               thing between $if_updatenr and the matching $endif.  The counter
1115               resets   when  the  highest  UPDATENR  is  reached.   Example  :
1116               "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
1117               4}$endif"  shows  foo 25% of the time followed by bar 25% of the
1118               time followed by nothing the other half of the time.
1119
1120
1121        \e[1mimap_messages (args)\e[0m
1122               Displays the number of messages in your global IMAP inbox by de‐
1123               fault.  You  can  define  individual  IMAP inboxes seperately by
1124               passing arguments to this object. Arguments are: "host user pass
1125               [-i interval] [-p port] [-e command] [-r retries]". Default port
1126               is 143, default interval is 5 minutes, and default number of re‐
1127               tries before giving up is 5. If the password is supplied as '*',
1128               you will be prompted to enter the password when Conky starts.
1129
1130
1131        \e[1mimap_unseen (args)\e[0m
1132               Displays the number of unseen messages in your global IMAP inbox
1133               by default. You can define individual IMAP inboxes seperately by
1134               passing arguments to this object. Arguments are: "host user pass
1135               [-i interval] [-p port] [-e command] [-r retries]". Default port
1136               is 143, default interval is 5 minutes, and default number of re‐
1137               tries before giving up is 5. If the password is supplied as '*',
1138               you will be prompted to enter the password when Conky starts.
1139
1140
1141        \e[1mioscheduler disk\e[0m
1142               Prints the current ioscheduler used  for  the  given  disk  name
1143               (i.e. e.g. "hda" or "sdb")
1144
1145
1146        \e[1mkernel \e[22mKernel version
1147
1148
1149        \e[1mlaptop_mode\e[0m
1150               The value of /proc/sys/vm/laptop_mode
1151
1152
1153        \e[1mloadavg\e[0m
1154               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1155               5 minutes and 3 for past 15 minutes.
1156
1157
1158        \e[1mloadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐\e[0m
1159        \e[1ment colour 2) (scale)\e[0m
1160               Load1  average graph, similar to xload, with optional colours in
1161               hex, minus the #. Uses a logarithmic scale (to  see  small  num‐
1162               bers) when you use "log" instead of "normal".
1163
1164
1165        \e[1mlines textfile\e[0m
1166               Displays the number of lines in the given file
1167
1168
1169        \e[1mmachine\e[0m
1170               Machine, i686 for example
1171
1172
1173        \e[1mmails (mailbox) (interval)\e[0m
1174               Mail  count  in the specified mailbox or your mail spool if not.
1175               Both mbox and maildir type mailboxes are supported. You can  use
1176               a  program  like  fetchmail  to get mails from some server using
1177               your favourite protocol. See also new_mails.
1178
1179
1180        \e[1mnew_mails (mailbox) (interval)\e[0m
1181               Unread mail count in the specified mailbox or mail spool if not.
1182               Both mbox and maildir type mailboxes are supported.
1183
1184
1185        \e[1mseen_mails (maildir) (interval)\e[0m
1186               Number  of mails marked as seen in the specified mailbox or mail
1187               spool if not. Only maildir type mailboxes  are  supported,  mbox
1188               type will return -1.
1189
1190
1191        \e[1munseen_mails (maildir) (interval)\e[0m
1192               Number  of  new or unseen mails in the specified mailbox or mail
1193               spool if not. Only maildir type mailboxes  are  supported,  mbox
1194               type will return -1.
1195
1196
1197        \e[1mflagged_mails (maildir) (interval)\e[0m
1198               Number  of  mails  marked as flagged in the specified mailbox or
1199               mail spool if not. Only maildir type  mailboxes  are  supported,
1200               mbox type will return -1.
1201
1202
1203        \e[1munflagged_mails (maildir) (interval)\e[0m
1204               Number  of  mails not marked as flagged in the specified mailbox
1205               or mail spool if not. Only maildir type mailboxes are supported,
1206               mbox type will return -1.
1207
1208
1209        \e[1mforwarded_mails (maildir) (interval)\e[0m
1210               Number  of mails marked as forwarded in the specified mailbox or
1211               mail spool if not. Only maildir type  mailboxes  are  supported,
1212               mbox type will return -1.
1213
1214
1215        \e[1munforwarded_mails (maildir) (interval)\e[0m
1216               Number of mails not marked as forwarded in the specified mailbox
1217               or mail spool if not. Only maildir type mailboxes are supported,
1218               mbox type will return -1.
1219
1220
1221        \e[1mreplied_mails (maildir) (interval)\e[0m
1222               Number  of  mails  marked as replied in the specified mailbox or
1223               mail spool if not. Only maildir type  mailboxes  are  supported,
1224               mbox type will return -1.
1225
1226
1227        \e[1munreplied_mails (maildir) (interval)\e[0m
1228               Number  of  mails not marked as replied in the specified mailbox
1229               or mail spool if not. Only maildir type mailboxes are supported,
1230               mbox type will return -1.
1231
1232
1233        \e[1mdraft_mails (maildir) (interval)\e[0m
1234               Number of mails marked as draft in the specified mailbox or mail
1235               spool if not. Only maildir type mailboxes  are  supported,  mbox
1236               type will return -1.
1237
1238
1239        \e[1mtrashed_mails (maildir) (interval)\e[0m
1240               Number  of  mails  marked as trashed in the specified mailbox or
1241               mail spool if not. Only maildir type  mailboxes  are  supported,
1242               mbox type will return -1.
1243
1244
1245        \e[1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject\e[0m
1246        \e[1mwidth) mbox\e[0m
1247               Print a summary of recent messages in an  mbox  format  mailbox.
1248               mbox  parameter  is the filename of the mailbox (can be encapsu‐
1249               lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1250
1251
1252        \e[1mmem    \e[22mAmount of memory in use
1253
1254
1255        \e[1mmembar (height),(width)\e[0m
1256               Bar that shows amount of memory in use
1257
1258
1259        \e[1mmemgauge (height),(width)\e[0m
1260               Gauge that shows amount of memory in use (see cpugauge)
1261
1262
1263        \e[1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1)  (gradi‐\e[0m
1264        \e[1ment colour 2) (scale)\e[0m
1265               Memory  usage graph. Uses a logarithmic scale (to see small num‐
1266               bers) when you use "log" instead of "normal".
1267
1268
1269        \e[1mmemeasyfree\e[0m
1270               Amount of free memory including the memory that is  very  easily
1271               freed (buffers/cache)
1272
1273
1274        \e[1mmemfree\e[0m
1275               Amount of free memory
1276
1277
1278        \e[1mmemmax \e[22mTotal amount of memory
1279
1280
1281        \e[1mmemperc\e[0m
1282               Percentage of memory in use
1283
1284
1285        \e[1mmixer (device)\e[0m
1286               Prints  the  mixer value as reported by the OS. Default mixer is
1287               "vol", but you can specify one of the following  optional  argu‐
1288               ments:  "vol",  "bass",  "treble",  "synth",  "pcm",  "speaker",
1289               "line", "mic", "cd", "mix",  "pcm2",  "rec",  "igain",  "ogain",
1290               "line1",  "line2",  "line3",  "dig1",  "dig2",  "dig3",  "phin",
1291               "phout", "video", "radio", "monitor". Refer to the definition of
1292               SOUND_DEVICE_NAMES  in  <linux/soundcard.h>  (on Linux), <sound‐
1293               card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1294               tions available on your system.
1295
1296
1297        \e[1mmixerbar (device)\e[0m
1298               Displays  mixer  value  in a bar as reported by the OS. See docs
1299               for $mixer for details on arguments.
1300
1301
1302        \e[1mmixerr (device)\e[0m
1303               Prints the right channel mixer value as reported by the OS.  See
1304               docs for $mixer for details on arguments.
1305
1306
1307        \e[1mmixerrbar (device)\e[0m
1308               Displays  the  right channel mixer value in a bar as reported by
1309               the OS. See docs for $mixer for details on arguments.
1310
1311
1312        \e[1mmixerl (device)\e[0m
1313               Prints the left channel mixer value as reported by the  OS.  See
1314               docs for $mixer for details on arguments.
1315
1316
1317        \e[1mmixerlbar (device)\e[0m
1318               Displays  the  left  channel mixer value in a bar as reported by
1319               the OS. See docs for $mixer for details on arguments.
1320
1321
1322        \e[1mmoc_state\e[0m
1323               Current state of MOC; playing, stopped etc.
1324
1325
1326        \e[1mmoc_file\e[0m
1327               File name of the current MOC song
1328
1329
1330        \e[1mmoc_title\e[0m
1331               Title of the current MOC song
1332
1333
1334        \e[1mmoc_artist\e[0m
1335               Artist of the current MOC song
1336
1337
1338        \e[1mmoc_song\e[0m
1339               The current song name being played in MOC.
1340
1341
1342        \e[1mmoc_album\e[0m
1343               Album of the current MOC song
1344
1345
1346        \e[1mmoc_totaltime\e[0m
1347               Total length of the current MOC song
1348
1349
1350        \e[1mmoc_timeleft\e[0m
1351               Time left in the current MOC song
1352
1353
1354        \e[1mmoc_curtime\e[0m
1355               Current time of the current MOC song
1356
1357
1358        \e[1mmoc_bitrate\e[0m
1359               Bitrate in the current MOC song
1360
1361
1362        \e[1mmoc_rate\e[0m
1363               Rate of the current MOC song
1364
1365
1366        \e[1mmonitor\e[0m
1367               Number of the monitor on which conky is running
1368
1369
1370        \e[1mmonitor_number\e[0m
1371               Number of monitors
1372
1373
1374        \e[1mmpd_artist\e[0m
1375               Artist in current MPD song must be enabled at compile
1376
1377
1378        \e[1mmpd_album\e[0m
1379               Album in current MPD song
1380
1381
1382        \e[1mmpd_bar (height),(width)\e[0m
1383               Bar of mpd's progress
1384
1385
1386        \e[1mmpd_bitrate\e[0m
1387               Bitrate of current song
1388
1389
1390        \e[1mmpd_status\e[0m
1391               Playing, stopped, et cetera.
1392
1393
1394        \e[1mmpd_title (max length)\e[0m
1395               Title of current MPD song
1396
1397
1398        \e[1mmpd_vol\e[0m
1399               MPD's volume
1400
1401
1402        \e[1mmpd_elapsed\e[0m
1403               Song's elapsed time
1404
1405
1406        \e[1mmpd_length\e[0m
1407               Song's length
1408
1409
1410        \e[1mmpd_percent\e[0m
1411               Percent of song's progress
1412
1413
1414        \e[1mmpd_random\e[0m
1415               Random status (On/Off)
1416
1417
1418        \e[1mmpd_repeat\e[0m
1419               Repeat status (On/Off)
1420
1421
1422        \e[1mmpd_track\e[0m
1423               Prints the MPD track field
1424
1425
1426        \e[1mmpd_name\e[0m
1427               Prints the MPD name field
1428
1429
1430        \e[1mmpd_file\e[0m
1431               Prints the file name of the current MPD song
1432
1433
1434        \e[1mmpd_smart (max length)\e[0m
1435               Prints the song name in either the form "artist - title" or file
1436               name, depending on whats available
1437
1438
1439        \e[1mif_mpd_playing\e[0m
1440               if   mpd  is  playing  or  paused,  display  everything  between
1441               $if_mpd_playing and the matching $endif
1442
1443
1444        \e[1mnameserver (index)\e[0m
1445               Print a nameserver from /etc/resolv.conf. Index  starts  at  and
1446               defaults to 0.
1447
1448
1449        \e[1mnodename\e[0m
1450               Hostname
1451
1452
1453        \e[1mnvidia threshold temp ambient gpufreq memfreq imagequality\e[0m
1454               Nvidia  graficcard support for the XNVCtrl library.  Each option
1455               can be shortened to the least  significant  part.   Temperatures
1456               are printed as float, all other values as integer.
1457
1458               \e[1mthreshold\e[22m: the thresholdtemperature at which the gpu slows down
1459               \e[1mtemp\e[22m: gives the gpu current temperature
1460               \e[1mambient\e[22m: gives current air temperature near GPU case
1461               \e[1mgpufreq\e[22m: gives the current gpu frequency
1462               \e[1mmemfreq\e[22m: gives the current mem frequency
1463               \e[1mimagequality\e[22m: which imagequality should be choosen by OpenGL ap‐
1464               plications
1465
1466
1467        \e[1moutlinecolor (color)\e[0m
1468               Change outline color
1469
1470
1471        \e[1mpb_battery item\e[0m
1472               If running on Apple powerbook/ibook, display information on bat‐
1473               tery  status.  The item parameter specifies, what information to
1474               display. Exactly one item must be specified. Valid items are:
1475
1476               \e[1mstatus\e[22m: Display if battery is fully charged, charging, discharg‐
1477               ing or absent (running on AC)
1478               \e[1mpercent\e[22m:  Display  charge  of battery in percent, if charging or
1479               discharging. Nothing will be  displayed,  if  battery  is  fully
1480               charged or absent.
1481               \e[1mtime\e[22m: Display the time remaining until the battery will be fully
1482               charged or discharged at current rate. Nothing is displayed,  if
1483               battery  is  absent or if it's present but fully charged and not
1484               discharging.
1485
1486
1487        \e[1mplatform (dev) type n\e[0m
1488               Platform sensor from sysfs (Linux 2.6).  Parameter  dev  may  be
1489               omitted  if  you have only one platform device. Platform type is
1490               either 'in' or 'vol' meaning voltage; 'fan' meaning fan;  'temp'
1491               meaning  temperature.  Parameter  n is number of the sensor. See
1492               /sys/bus/platform/devices/ on your local computer.
1493
1494
1495        \e[1mpop3_unseen (args)\e[0m
1496               Displays the number of unseen messages in your global POP3 inbox
1497               by default. You can define individual POP3 inboxes seperately by
1498               passing arguments to this object. Arguments are: "host user pass
1499               [-i interval] [-p port] [-e command] [-r retries]". Default port
1500               is 110, default interval is 5 minutes, and default number of re‐
1501               tries before giving up is 5. If the password is supplied as '*',
1502               you will be prompted to enter the password when Conky starts.
1503
1504
1505        \e[1mpop3_used (args)\e[0m
1506               Displays the amount of space (in MiB, 2^20) used in your  global
1507               POP3  inbox  by  default. You can define individual POP3 inboxes
1508               seperately by passing arguments to this object.  Arguments  are:
1509               "host  user  pass  [-i  interval] [-p port] [-e command] [-r re‐
1510               tries]". Default port is 110, default interval is 5 minutes, and
1511               default number of retries before giving up is 5. If the password
1512               is supplied as '*', you will be prompted to enter  the  password
1513               when Conky starts.
1514
1515
1516        \e[1mpre_exec shell command\e[0m
1517               Executes a shell command one time before conky displays anything
1518               and puts output as text.
1519
1520
1521        \e[1mprocesses\e[0m
1522               Total processes (sleeping and running)
1523
1524
1525        \e[1mrunning_processes\e[0m
1526               Running processes (not sleeping), requires Linux 2.6
1527
1528
1529        \e[1mscroll length (step) text\e[0m
1530               Scroll 'text' by 'step' characters showing  'length'  number  of
1531               characters  at  the  same  time. The text may also contain vari‐
1532               ables. 'step' is optional and defaults to 1 if not set. If a var
1533               creates  output  on multiple lines then the lines are placed be‐
1534               hind each other separated with a '|'-sign. Do NOT use vars  that
1535               change  colors or otherwise affect the design inside a scrolling
1536               text. If you want spaces  between  the  start  and  the  end  of
1537               'text',  place them at the end of 'text' not at the front ("foo‐
1538               bar" and " foobar" can both generate "barfoo" but "foobar " will
1539               keep the spaces like this "bar foo").
1540
1541
1542        \e[1mshadecolor (color)\e[0m
1543               Change shading color
1544
1545
1546        \e[1msmapi (ARGS)\e[0m
1547               when  using  smapi,  display  contents of the /sys/devices/plat‐
1548               form/smapi directory. ARGS are either '(FILENAME)' or 'bat  (IN‐
1549               DEX)  (FILENAME)'  to  display the corresponding files' content.
1550               This is a very raw method of accessing the  smapi  values.  When
1551               available, better use one of the smapi_* variables instead.
1552
1553
1554        \e[1msmapi_bat_bar (INDEX),(height),(width)\e[0m
1555               when  using smapi, display the remaining capacity of the battery
1556               with index INDEX as a bar.
1557
1558
1559        \e[1msmapi_bat_perc (INDEX)\e[0m
1560               when using smapi, display the remaining capacity in  percent  of
1561               the  battery  with  index INDEX. This is a separate variable be‐
1562               cause it supports the 'use_spacer' configuration option.
1563
1564
1565        \e[1msmapi_bat_power INDEX\e[0m
1566               when using smapi, display the current power of the battery  with
1567               index  INDEX  in  watt.  This is a separate variable because the
1568               original read out value is being converted from mW. The sign  of
1569               the  output  reflects  charging (positive) or discharging (nega‐
1570               tive) state.
1571
1572
1573        \e[1msmapi_bat_temp INDEX\e[0m
1574               when using smapi, display the current temperature of the battery
1575               with  index INDEX in degree Celsius. This is a separate variable
1576               because the original read out value is being converted from mil‐
1577               li degree Celsius.
1578
1579
1580        \e[1mstippled_hr (space)\e[0m
1581               Stippled (dashed) horizontal line
1582
1583
1584        \e[1mswapbar (height),(width)\e[0m
1585               Bar that shows amount of swap in use
1586
1587
1588        \e[1mswap   \e[22mAmount of swap in use
1589
1590
1591        \e[1mswapmax\e[0m
1592               Total amount of swap
1593
1594
1595        \e[1mswapperc\e[0m
1596               Percentage of swap in use
1597
1598
1599        \e[1msysname\e[0m
1600               System name, Linux for example
1601
1602
1603        \e[1mtcp_portmon port_begin port_end item (index) \e[4m\e[22m(ip4\e[24m \e[4monly\e[24m \e[4mat\e[24m \e[4mpresent)\e[0m
1604               TCP port monitor for specified local ports. Port numbers must be
1605               in the range 1 to 65535. Valid items are:
1606
1607               \e[1mcount \e[22m- total number of connections in the range
1608               \e[1mrip \e[22m- remote ip address
1609               \e[1mrhost \e[22m- remote host name
1610               \e[1mrport \e[22m- remote port number
1611               \e[1mrservice \e[22m- remote service name from /etc/services
1612               \e[1mlip \e[22m- local ip address
1613               \e[1mlhost \e[22m- local host name
1614               \e[1mlport \e[22m- local port number
1615               \e[1mlservice \e[22m- local service name from /etc/services
1616
1617               The connection index provides you with access to each connection
1618               in the port monitor. The monitor will return information for in‐
1619               dex values from 0 to n-1 connections. Values higher than n-1 are
1620               simply  ignored. For the "count" item, the connection index must
1621               be omitted. It is required for all other items.
1622
1623               Examples:
1624               \e[1m${tcp_portmon 6881 6999 count} \e[22m- displays the number of  connec‐
1625               tions in the bittorrent port range
1626               \e[1m${tcp_portmon  22 22 rip 0} \e[22m- displays the remote host ip of the
1627               first sshd connection
1628               \e[1m${tcp_portmon 22 22 rip 9} \e[22m- displays the remote host ip of  the
1629               tenth sshd connection
1630               \e[1m${tcp_portmon 1 1024 rhost 0} \e[22m- displays the remote host name of
1631               the first connection on a privileged port
1632               \e[1m${tcp_portmon 1 1024 rport 4} \e[22m- displays the remote host port of
1633               the fifth connection on a privileged port
1634               \e[1m${tcp_portmon  1 65535 lservice 14} \e[22m- displays the local service
1635               name of the fifteenth connection in the range of all ports
1636
1637               Note that port monitor variables which share the same port range
1638               actually refer to the same monitor, so many references to a sin‐
1639               gle port range for different items and different indexes all use
1640               the  same monitor internally. In other words, the program avoids
1641               creating redundant monitors.
1642
1643        \e[1mtexeci interval command\e[0m
1644               Runs a command at an interval inside a thread and  displays  the
1645               output.  Same  as  $execi,  except  the  command is run inside a
1646               thread. Use this if you have a slow script to keep Conky  updat‐
1647               ing.  You should make the interval slightly longer then the time
1648               it takes your script to execute. For  example,  if  you  have  a
1649               script  that  take 5 seconds to execute, you should make the in‐
1650               terval at least 6 seconds. See also $execi.
1651
1652
1653        \e[1moffset (pixels)\e[0m
1654               Move text over by N pixels. See also $voffset.
1655
1656
1657        \e[1mrss url delay_in_minutes action (num_par (spaces_in_front))\e[0m
1658               Download and parse RSS feeds. Action may be one of  the  follow‐
1659               ing:  feed_title, item_title (with num par), item_desc (with num
1660               par) and item_titles (when using this action and spaces_in_front
1661               is given conky places that many spaces in front of each item).
1662
1663
1664        \e[1mtab (width, (start))\e[0m
1665               Puts a tab of the specified width, starting from column 'start'.
1666               The unit is pixels for both arguments.
1667
1668
1669        \e[1mtail logfile lines (interval)\e[0m
1670               Displays last N lines of supplied text text file. If interval is
1671               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1672               can be displayed, or until the text buffer is filled.
1673
1674
1675        \e[1mtemplateN (arg1) (arg2) (arg3 ...)\e[0m
1676               Evaluate the content of  the  templateN  configuration  variable
1677               (where N is a value between 0 and 9, inclusively), applying sub‐
1678               stitutions as described in the documentation of the  correspond‐
1679               ing  configuration variable.  The number of arguments is option‐
1680               al, but must match the highest referred index in  the  template.
1681               You  can  use the same special sequences in each argument as the
1682               ones valid for a template definition, e.g. to allow an  argument
1683               to  contain  a  whitespace.  Also simple nesting of templates is
1684               possible this way.
1685
1686               Here are some examples of template definitions:
1687
1688               template0 $\1\2
1689               template1 \1: ${fs_used \2} / ${fs_size \2}
1690               template2 \1 \2
1691
1692               The following list shows sample usage of the  templates  defined
1693               above, with the equivalent syntax when not using any template at
1694               all:
1695
1696               using template                            same without template
1697               ─────────────────────────────────────────────────────────────────────────────────
1698               ${template0 node name}                    $nodename
1699               ${template1 root /}                       root:   ${fs_free   /}   /
1700                                                         ${fs_size /}
1701               ${template1 ${template2\ disk\ root} /}   disk root: ${fs_free /} / ${fs_size /}
1702
1703
1704        \e[1mtime (format)\e[0m
1705               Local  time, see man strftime to get more information about for‐
1706               mat
1707
1708
1709        \e[1mutime (format)\e[0m
1710               Display time in UTC (universal coordinate time).
1711
1712
1713        \e[1mtztime (timezone) (format)\e[0m
1714               Local time for specified timezone, see man strftime to get  more
1715               information  about format. The timezone argument is specified in
1716               similar fashion as TZ environment variable. For hints,  look  in
1717               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1718
1719
1720        \e[1mtotaldown net\e[0m
1721               Total  download, overflows at 4 GB on Linux with 32-bit arch and
1722               there doesn't seem to be a way to know how many times it has al‐
1723               ready done that before conky has started.
1724
1725
1726        \e[1mtop type, num\e[0m
1727               This  takes arguments in the form:top (name) (number) Basically,
1728               processes are ranked from highest to lowest in terms of cpu  us‐
1729               age,  which  is  what  (num)  represents. The types are: "name",
1730               "pid", "cpu", "mem", "mem_res", "mem_vsize", and  "time".  There
1731               can be a max of 10 processes listed.
1732
1733
1734        \e[1mtop_mem type, num\e[0m
1735               Same as top, except sorted by mem usage instead of cpu
1736
1737
1738        \e[1mtop_time type, num\e[0m
1739               Same  as top, except sorted by total CPU time instead of current
1740               CPU usage
1741
1742
1743        \e[1mtotalup net\e[0m
1744               Total upload, this one too, may overflow
1745
1746
1747        \e[1mupdates Number of updates\e[0m
1748               for debugging
1749
1750
1751        \e[1mupspeed net\e[0m
1752               Upload speed in KiB
1753
1754
1755        \e[1mupspeedf net\e[0m
1756               Upload speed in KiB with one decimal
1757
1758
1759        \e[1mupspeedgraph  ("normal"|"log")  (height),(width)  (gradient  colour  1)\e[0m
1760        \e[1m(gradient colour 2) (scale) (net)\e[0m
1761               Upload  speed  graph,  colours  defined  in hex, minus the #. If
1762               scale is non-zero, it becomes the scale for the  graph.  Uses  a
1763               logarithmic  scale (to see small numbers) when you use "log" in‐
1764               stead of "normal".
1765
1766
1767        \e[1muptime \e[22mUptime
1768
1769
1770        \e[1muptime_short\e[0m
1771               Uptime in a shorter format
1772
1773
1774        \e[1muser_number\e[0m
1775               Number of users logged in
1776
1777
1778        \e[1muser_names\e[0m
1779               Lists the names of the users logged in
1780
1781
1782        \e[1muser_terms\e[0m
1783               Lists the consoles in use
1784
1785
1786        \e[1muser_times\e[0m
1787               Lists how long users have been logged in for
1788
1789
1790        \e[1mvoffset (pixels)\e[0m
1791               Change vertical offset by N pixels. Negative values  will  cause
1792               text to overlap. See also $offset.
1793
1794
1795        \e[1mvoltage_mv (n)\e[0m
1796               Returns  CPU  #n's  voltage  in  mV. CPUs are counted from 1. If
1797               omitted, the parameter defaults to 1.
1798
1799
1800        \e[1mvoltage_v (n)\e[0m
1801               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
1802               ted, the parameter defaults to 1.
1803
1804
1805        \e[1mwireless_essid net\e[0m
1806               Wireless access point ESSID (Linux only)
1807
1808
1809        \e[1mwireless_mode net\e[0m
1810               Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1811
1812
1813        \e[1mwireless_bitrate net\e[0m
1814               Wireless bitrate (ie 11 Mb/s) (Linux only)
1815
1816
1817        \e[1mwireless_ap net\e[0m
1818               Wireless access point MAC address (Linux only)
1819
1820
1821        \e[1mwireless_link_qual net\e[0m
1822               Wireless link quality (Linux only)
1823
1824
1825        \e[1mwireless_link_qual_max net\e[0m
1826               Wireless link quality maximum value (Linux only)
1827
1828
1829        \e[1mwireless_link_qual_perc net\e[0m
1830               Wireless link quality in percents (Linux only)
1831
1832
1833        \e[1mwireless_link_bar (height), (width) net\e[0m
1834               Wireless link quality bar (Linux only)
1835
1836
1837        \e[1mwords textfile\e[0m
1838               Displays the number of words in the given file
1839
1840
1841        \e[1mxmms2_artist\e[0m
1842               Artist in current XMMS2 song
1843
1844
1845        \e[1mxmms2_album\e[0m
1846               Album in current XMMS2 song
1847
1848
1849        \e[1mxmms2_title\e[0m
1850               Title in current XMMS2 song
1851
1852
1853        \e[1mxmms2_genre\e[0m
1854               Genre in current XMMS2 song
1855
1856
1857        \e[1mxmms2_comment\e[0m
1858               Comment in current XMMS2 song
1859
1860
1861        \e[1mxmms2_url\e[0m
1862               Full path to current song
1863
1864
1865        \e[1mxmms2_tracknr\e[0m
1866               Track number in current XMMS2 song
1867
1868
1869        \e[1mxmms2_bitrate\e[0m
1870               Bitrate of current song
1871
1872
1873        \e[1mxmms2_id\e[0m
1874               XMMS2 id of current song
1875
1876
1877        \e[1mxmms2_duration\e[0m
1878               Duration of current song
1879
1880
1881        \e[1mxmms2_elapsed\e[0m
1882               Song's elapsed time
1883
1884
1885        \e[1mxmms2_size\e[0m
1886               Size of current song
1887
1888
1889        \e[1mxmms2_percent\e[0m
1890               Percent of song's progress
1891
1892
1893        \e[1mxmms2_date\e[0m
1894               Returns song's date.
1895
1896
1897        \e[1mxmms2_playlist\e[0m
1898               Returns the XMMS2 playlist.
1899
1900
1901        \e[1mxmms2_timesplayed\e[0m
1902               Number of times a song was played (presumably).
1903
1904
1905        \e[1mxmms2_status\e[0m
1906               XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1907
1908
1909        \e[1mxmms2_bar (height),(width)\e[0m
1910               Bar of XMMS2's progress
1911
1912
1913        \e[1mxmms2_smart\e[0m
1914               Prints the song name in either the form "artist - title" or file
1915               name, depending on whats available
1916
1917
1918        \e[1mif_xmms2_connected\e[0m
1919               Display everything between $if_xmms2_connected and the  matching
1920               $endif if xmms2 is running.
1921
1922
1923        \e[1meve api_userid api_key character_id\e[0m
1924               Fetches  your  currently  training skill from the Eve Online API
1925               servers  (http://www.eve-online.com/)  and  displays  the  skill
1926               along with the remaining training time.
1927
1928
1929        \e[1mendif  \e[22mEnds an $if block.
1930
1931
1932 \e[1mEXAMPLES\e[0m
1933        conky \e[1m-t '${time %D %H:%M}' -o -u 30\e[0m
1934               Start Conky in its own window with date and clock as text and 30
1935               sec update interval.
1936
1937        conky \e[1m-a top_left -x 5 -y 500 -d\e[0m
1938               Start Conky to background at coordinates (5, 500).
1939
1940 \e[1mFILES\e[0m
1941        \e[4m~/.conkyrc\e[24m default configuration file
1942
1943 \e[1mBUGS\e[0m
1944        Drawing to root or some other desktop window directly doesn't work with
1945        all window managers. Especially doesn't work well with Gnome and it has
1946        been reported that it doesn't work with KDE  either.  Nautilus  can  be
1947        disabled  from  drawing  to  desktop with program gconf-editor. Uncheck
1948        show_desktop in /apps/nautilus/preferences/.  There  is  -w  switch  in
1949        Conky  to  set  some  specific window id. You might find xwininfo -tree
1950        useful to find the window to draw to. You  can  also  use  -o  argument
1951        which makes Conky to create its own window. If you do try running Conky
1952        in its own window, be sure to read up on the  own_window_type  settings
1953        and experiment.
1954
1955 \e[1mSEE ALSO\e[0m
1956        ⟨http://conky.sourceforge.net/⟩
1957
1958        ⟨http://www.sourceforge.net/projects/conky⟩
1959
1960        #conky on irc.freenode.net
1961
1962 \e[1mCOPYING\e[0m
1963        Copyright  (c)  2005-2009 Brenden Matthews, Philip Kovacs, et. al.  Any
1964        original torsmo code is licensed under the BSD license (see LICENSE.BSD
1965        for a copy).  All code written since the fork of torsmo is licensed un‐
1966        der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1967        ly  (such  as  in  portmon  code, timed thread code, and audacious code
1968        which are LGPL, and prss which is an MIT-style license).
1969
1970 \e[1mAUTHORS\e[0m
1971        The Conky dev team (see AUTHORS for a full list of contributors).
1972
1973
1974
1975                                   2009-05-01                          conky(1)