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