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