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