add max_specials config item with default 512. really closes bug #1574523
[monky] / README
1 conky(1)                                                              conky(1)
2
3
4
5 NAME
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 SYNOPSIS
10        conky [options]
11
12 DESCRIPTION
13        Conky is a system monitor for X originally based on  the  torsmo  code.
14        Since  it's original conception, Conky has changed a fair bit from it's
15        predecessor.  Conky can display just about  anything,  either  on  your
16        root  desktop  or in it's own window.  Conky has many built-in objects,
17        as well as the ability to execute programs and  scripts,  then  display
18        the output from stdout.
19
20        We are always looking for help, and anyone interested in becoming a de-
21        veloper is welcome.  Please use the facilities at SourceForge  to  make
22        bug reports, feature requests, and submit patches.
23
24        Thanks for your interest in Conky.
25
26 COMPILING
27        For  users  compiling from source, make sure you have the X development
28        libraries installed.  This should be  a  package  along  the  lines  of
29        "libx11-dev or xorg-x11-dev".
30
31        Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
32        admin/conky" for installation.  There is  also  usually  an  up-to-date
33        ebuild within Conky's package or in Svn.
34
35        Debian,etc.  users  --  Conky will be in Debian's repositories soon (by
36        mid-September, hopefully), and then Ubuntu  shortly  thereafter.  Until
37        then, "dpkg -i" the .deb package to install.
38
39        Example  to  compile  and  run Conky with all optional components (note
40        that some configure options may differ for your system):
41
42        sh autogen.sh # Only required if building from Svn
43
44        ./configure      --prefix=/usr      --mandir=/usr/share/man       --in-
45        fodir=/usr/share/info  --datadir=/usr/share  --sysconfdir=/etc --local-
46        statedir=/var/lib --enable-xft --enable-own-window --enable-proc-uptime
47        --enable-audacious  --enable-bmpx  --enable-hddtemp  --enable-mpd --en-
48        able-xmms2  --enable-imlib2   --enable-portmon   --enable-debug   --en-
49        able-double-buffer --enable-xdamage --enable-x11
50
51        make
52
53        make install # Optional
54
55        src/conky
56
57        Conky probably doesn't compile with compilers other than gcc  and  icc.
58        It  doesn't  compile  with C89 compiler and not even with pure C99.  It
59        uses a few things that might not exist: strdup(),  strcasecmp(),  strn-
60        casecmp(),  optarg  variable  with getopt() and long long (not in C89).
61        Crashes in file system statistics stuff when compiled with icc, I don't
62        know exactly why.
63
64        You  can disable 'drawing to own window' feature in case you don't need
65        it by passing --disable-own-window to configure -script.
66
67
68 YOU SHOULD KNOW
69        Conky is generally very good on resources. However, certain objects  in
70        Conky  are  harder  on resources then others. In particular, the $tail,
71        $top, $font, and $graph objects are quite costly in comparison  to  the
72        rest of Conky.
73
74        If  you  do use them, please do not complain about memory or CPU usage,
75        unless you think something's seriously wrong (mem leak, etc.).
76
77        An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
78        conky".  Saves you the trouble of having to kill and then restart.
79
80        IMPORTANT:  For  previous Conky users, Conky 1.3 no longer supports the
81        metar stuff.  mdsplib was causing  way  too  many  problems.  Hopefully
82        there'll be a better solution in Conky 2.x...
83
84 OPTIONS
85        Command  line  options override configurations defined in configuration
86        file.
87
88        -v | -V
89               Prints version and exits
90
91
92        -a ALIGNMENT
93               Text alignment on screen, {top,bottom}_{left,right} or none
94
95
96        -b     Use double buffering (eliminates "flicker")
97
98
99        -c FILE
100               Config file to load instead of $HOME/.conkyrc
101
102
103        -d     Daemonize Conky, aka fork to background
104
105
106        -f FONT
107               Font to use
108
109
110        -h     Prints command line help and exits
111
112
113        -o     Create own window to draw
114
115
116        -t TEXT
117               Text to render, remember single quotes, like -t ' $uptime '
118
119
120        -u SECONDS
121               Update interval
122
123
124        -w WIN_ID
125               Window id to draw
126
127
128        -x X_COORDINATE
129               X position
130
131
132        -y Y_COORDINATE
133               Y position
134
135
136 CONFIGURATION SETTINGS
137        Default configuration file  is  $HOME/.conkyrc  (can  be  changed  from
138        conky.c among other things). See conkyrc.sample. If installing from De-
139        bian package, this should be in /usr/share/doc/conky/examples  ("gunzip
140        conkyrc.sample.gz" to get conkyrc.sample).
141
142        You  might  want  to copy it to $HOME/.conkyrc and then start modifying
143        it.  Other configs can be found at http://conky.sf.net
144
145        alignment
146               Aligned position on screen, may  be  top_left,  top_right,  bot-
147               tom_left, bottom_right, or none
148
149
150        background
151               Boolean  value, if true, Conky will be forked to background when
152               started
153
154
155        border_margin
156               Border margin in pixels
157
158
159        border_width
160               Border width in pixels
161
162
163        cpu_avg_samples
164               The number of samples to average for CPU monitoring
165
166
167        default_color
168               Default color and border color
169
170
171        default_outline_color
172               Default outline color
173
174
175        default_shade_color
176               Default shading color and border's shading color
177
178
179        double_buffer
180               Use the Xdbe extension? (eliminates flicker) It is highly recom-
181               mended to use own window with this one so double buffer won't be
182               so big.
183
184
185        draw_borders
186               Draw borders around text?
187
188
189        draw_graph_borders
190               Draw borders around graphs?
191
192
193        draw_outline
194               Draw outlines?
195
196
197        draw_shades
198               Draw shades?
199
200
201        font   Font name in X, xfontsel can be used to get a nice font
202
203
204        gap_x  Gap, in pixels, between right or left border of screen, same  as
205               passing -x at command line, e.g. gap_x 10
206
207
208        gap_y  Gap,  in pixels, between top or bottom border of screen, same as
209               passing -y at command line, e.g. gap_y 10.
210
211
212        imap   Default global IMAP server. Arguments are: "host user  pass  [-i
213               interval]  [-f  folder] [-p port] [-e command]". Default port is
214               143, default folder is 'INBOX', default interval is  5  minutes.
215               If  the password is supplied as '*', you will be prompted to en-
216               ter the password when Conky starts.
217
218
219        mail_spool
220               Mail spool for mail checking
221
222
223        max_specials
224               Maximum number of special things, e.g. fonts,  offsets,  aligns,
225               etc. (default is 512)
226
227
228        max_user_text bytes
229               Maximum size of user text buffer, i.e. layout below TEXT line in
230               config file (default is 16384 bytes)
231
232
233        maximum_width pixels
234               Maximum width of window
235
236
237        minimum_size width (height)
238               Minimum size of window
239
240
241        min_port_monitors
242               Allow for the creation of at least this number of port  monitors
243               (if 0 or not set, default is 16)
244
245
246        min_port_monitor_connections
247               Allow  each port monitor to track at least this many connections
248               (if 0 or not set, default is 256)
249
250
251        mpd_host
252               Host of MPD server
253
254
255        mpd_port
256               Port of MPD server
257
258
259        mpd_password
260               MPD server password
261
262
263        net_avg_samples
264               The number of samples to average for net data
265
266
267        no_buffers
268               Substract (file system) buffers from used memory?
269
270
271        override_utf8_locale
272               Force UTF8? requires XFT
273
274
275        own_window
276               Boolean, create own window to draw?
277
278
279        own_window_transparent
280               Boolean, set pseudo-transparency?
281
282
283        own_window_type
284               if own_window is yes, you may specify type  normal,  desktop  or
285               override (default: normal).  Desktop windows are special windows
286               that have no window decorations;  are  always  visible  on  your
287               desktop;  do not appear in your pager or taskbar; and are sticky
288               across all workspaces.  Override windows are not under the  con-
289               trol of the window manager. Hints are ignored. This type of win-
290               dow can be useful for certain situations.
291
292
293        own_window_colour colour
294               If own_window_transparent no, set a specified background  colour
295               (defaults  to  black).  Takes  either a hex value (#ffffff) or a
296               valid RGB name (see /usr/lib/X11/rgb.txt)
297
298
299        own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
300               If own_window is yes, you may use these window manager hints  to
301               affect the way Conky displays.  Notes: Use own_window_type desk-
302               top as another way to implement many of these hints  implicitly.
303               If  you  use own_window_type override, window manager hints have
304               no meaning and are ignored.
305
306
307        out_to_console
308               Print text to stdout.
309
310
311        pad_percents
312               Pad percentages to this many decimals (0 = no padding)
313
314
315        pop3   Default global POP3 server. Arguments are: "host user  pass  [-i
316               interval]  [-p port] [-e command]". Default port is 110, default
317               interval is 5 minutes. If the password is supplied as  '*',  you
318               will be prompted to enter the password when Conky starts.
319
320
321        stippled_borders
322               Border stippling (dashing) in pixels
323
324
325        total_run_times
326               Total  number of times for Conky to update before quitting. Zero
327               makes Conky run forever
328
329
330        update_interval
331               Update interval in seconds
332
333
334        uppercase
335               Boolean value, if true, text is rendered in upper case
336
337
338        use_spacer
339               Adds spaces after certain objects to stop them from moving other
340               things around. Note that this only helps if you are using a mono
341               font, such as Bitstream Vera Sans Mono.
342
343
344        use_xft
345               Use Xft (anti-aliased font and stuff)
346
347
348        wm_class_name
349               Manually set the WM_CLASS name. Defaults to "conky".
350
351
352        xftalpha
353               Alpha of Xft font. Must be a value at or between 1 and 0.
354
355
356        xftfont
357               Xft font to use.
358
359
360        TEXT   After this begins text to be formatted on screen
361
362
363 VARIABLES
364        Colors are parsed using XParsecolor(), there might be a list  of  them:
365        /usr/X11R6/lib/X11/rgb.txt.  Also, <http://sedition.com/perl/rgb.html>.
366        Color can be also in #rrggbb format (hex).  Note that  when  displaying
367        bytes,  power  is  1024 and not 1000 so 1M really means 1024*1024 bytes
368        and not 1000*1000.
369
370        addr interface
371               IP address for an interface
372
373
374        acpiacadapter
375               ACPI ac adapter state.
376
377
378        acpifan
379               ACPI fan state
380
381
382        acpitemp
383               ACPI temperature in C.
384
385
386        acpitempf
387               ACPI temperature in F.
388
389
390        adt746xcpu
391               CPU temperature from therm_adt746x
392
393
394        adt746xfan
395               Fan speed from therm_adt746x
396
397
398        alignr (num)
399               Right-justify text, with space of N
400
401
402        alignc (num)
403               Align text to centre
404
405
406        apm_adapter
407               Display APM AC adapter status (FreeBSD only)
408
409
410        apm_battery_life
411               Display APM battery life in percent (FreeBSD only)
412
413
414        apm_battery_time
415               Display remaining APM battery life in hh:mm:ss or  "unknown"  if
416               AC adapterstatus is on-line or charging (FreeBSD only)
417
418
419        audacious_bar (height),(width)
420               Progress bar
421
422
423        audacious_bitrate
424               Bitrate of current tune
425
426
427        audacious_channels
428               Number of audio channels of current tune
429
430
431        audacious_filename
432               Full path and filename of current tune
433
434
435        audacious_frequency
436               Sampling frequency of current tune
437
438
439        audacious_length
440               Total length of current tune as MM:SS
441
442
443        audacious_length_seconds
444               Total length of current tune in seconds
445
446
447        audacious_playlist_position
448               Playlist position of current tune
449
450
451        audacious_playlist_length
452               Number of tunes in playlist
453
454
455        audacious_position
456               Position of current tune (MM:SS)
457
458
459        audacious_position_seconds
460               Position of current tune in seconds
461
462
463        audacious_status
464               Player status (Playing/Paused/Stopped/Not running)
465
466
467        audacious_title
468               Title of current tune
469
470
471        battery (num)
472               Remaining  capacity  in ACPI or APM battery. ACPI battery number
473               can be given as argument (default is BAT0).
474
475
476        bmpx_artist
477               Artist in current BMPx track
478
479
480        bmpx_album
481               Album in current BMPx track
482
483
484        bmpx_title
485               Title of the current BMPx track
486
487
488        bmpx_track
489               Track number of the current BMPx track
490
491
492        bmpx_bitrate
493               Bitrate of the current BMPx track
494
495
496        bmpx_uri
497               URI of the current BMPx track
498
499
500        buffers
501               Amount of memory buffered
502
503
504        cached Amount of memory cached
505
506
507        color (color)
508               Change drawing color to color
509
510
511        cpu (cpuN)
512               CPU usage in percents. For SMP machines, the CPU number  can  be
513               provided  as an argument. ${cpu 0} is the total usage, and ${cpu
514               X} (X >= 1) are individual CPUs.
515
516
517        cpubar (cpu number) (height),(width)
518               Bar that shows CPU usage, height is bar's height in pixels.  See
519               $cpu for more info on SMP.
520
521
522        cpugraph  (cpu  number)  (height),(width) (gradient colour 1) (gradient
523        colour 2)
524               CPU  usage graph, with optional colours in hex, minus the #. See
525               $cpu for more info on SMP.
526
527
528        diskio Displays current disk IO.
529
530
531        diskiograph (height),(width) (gradient colour 1)  (gradient  colour  2)
532        (scale)
533               Disk IO graph, colours defined in hex, minus the #. If scale  is
534               non-zero, it becomes the scale for the graph.
535
536
537        downspeed net
538               Download speed in kilobytes
539
540
541        downspeedf net
542               Download speed in kilobytes with one decimal
543
544
545        downspeedgraph  net  (height),(width)  (gradient  colour  1)  (gradient
546        colour 2) (scale)
547               Download  speed  graph,  colours defined in hex, minus the #. If
548               scale is non-zero, it becomes the scale for the graph.
549
550
551        else   Text to show if any of the above are not true
552
553
554        exec command
555               Executes a shell command and displays the output in conky. warn-
556               ing:  this  takes a lot more resources than other variables. I'd
557               recommend coding wanted behaviour in C and posting a patch.
558
559
560        execbar command
561               Same as exec, except if the first value return is  a  value  be-
562               tween 0-100, it will use that number for a bar. The size for the
563               bar is currently fixed, but that may change in the future.
564
565
566        execgraph command
567               Same as execbar, but graphs values.
568
569
570        execi interval command
571               Same as exec but with specific interval. Interval can't be  less
572               than update_interval in configuration. See also $texeci
573
574
575        execibar interval command
576               Same as execbar, except with an interval
577
578
579        execigraph interval command
580               Same as execigraph, but takes an interval arg graphs values
581
582
583        font (font)
584               Specify  a  different font. This new font will apply to the cur-
585               rent line and everything following. You can use a $font with  no
586               arguments  to  change  back  to the default font (much like with
587               $color)
588
589
590        freq (n)
591               Returns CPU #n's frequency in MHz. CPUs are counted from  1.  If
592               omitted, the parameter defaults to 1.
593
594
595        freq_g (n)
596               Returns  CPU  #n's frequency in GHz. CPUs are counted from 1. If
597               omitted, the parameter defaults to 1.
598
599
600        freq_dyn
601               Returns CPU frequency in MHz, but is calculated by  counting  to
602               clock  cycles  to  complete  an  instruction. Only available for
603               x86/amd64.
604
605
606        freq_dyn_g
607               Returns CPU frequency in GHz, but is calculated by  counting  to
608               clock  cycles  to  complete  an  instruction. Only available for
609               x86/amd64.
610
611
612        fs_bar (height),(width) fs
613               Bar that shows how much space is used on a file  system.  height
614               is the height in pixels. fs is any file on that file system.
615
616
617        fs_free (fs)
618               Free space on a file system available for users.
619
620
621        fs_free_perc (fs)
622               Free percentage of space on a file system available for users.
623
624
625        fs_size (fs)
626               File system size
627
628
629        fs_used (fs)
630               File system used space
631
632
633        goto x The next element will be printed at position 'x'.
634
635
636        hddtemp dev, (host,(port))
637               Displays  temperature  of a selected hard disk drive as reported
638               by the hddtemp daemon running on  host:port.   Default  host  is
639               127.0.0.1, default port is 7634.
640
641
642        head logfile lines (interval)
643               Displays  first  N lines of supplied text text file. If interval
644               is not supplied, Conky assumes 2x Conky's interval.  Max  of  30
645               lines can be displayed, or until the text buffer is filled.
646
647
648        hr (height)
649               Horizontal line, height is the height in pixels
650
651
652        iconv_start codeset_from codeset_to
653               Convert  text from one codeset to another using GNU iconv. Needs
654               to be stopped with iconv_stop.
655
656
657        iconv_stop
658               Stop iconv codeset conversion.
659
660
661        i2c (dev) type n
662               I2C sensor from sysfs (Linux 2.6). dev may  be  omitted  if  you
663               have  only  one  I2C  device. type is either in (or vol) meaning
664               voltage, fan meaning fan or temp/tempf (first in C, second in F)
665               meaning   temperature.   n   is   number   of  the  sensor.  See
666               /sys/bus/i2c/devices/ on your local computer.
667
668
669        i8k_ac_status
670               If running the i8k kernel driver for Inspiron laptops,  displays
671               whether  ac  power  is on, as listed in /proc/i8k (translated to
672               human-readable). Beware that this is by default not  enabled  by
673               i8k itself.
674
675
676        i8k_bios
677               If  running the i8k kernel driver for Inspiron laptops, displays
678               the bios version as listed in /proc/i8k.
679
680
681        i8k_buttons_status
682               If running the i8k kernel driver for Inspiron laptops,  displays
683               the volume buttons status as listed in /proc/i8k.
684
685
686        i8k_cpu_temp
687               If  running the i8k kernel driver for Inspiron laptops, displays
688               the cpu temperature in Celsius, as reported by /proc/i8k.
689
690
691        i8k_cpu_tempf
692               If running the i8k kernel driver for Inspiron laptops,  displays
693               the cpu temperature in Fahrenheit, as reported by /proc/i8k.
694
695
696        i8k_left_fan_rpm
697               If  running the i8k kernel driver for Inspiron laptops, displays
698               the left fan's rate of rotation, in revolutions  per  minute  as
699               listed in /proc/i8k. Beware, some laptops i8k reports these fans
700               in reverse order.
701
702
703        i8k_left_fan_status
704               If running the i8k kernel driver for Inspiron laptops,  displays
705               the left fan status as listed in /proc/i8k (translated to human-
706               readable). Beware, some laptops i8k reports these  fans  in  re-
707               verse order.
708
709
710        i8k_right_fan_rpm
711               If  running the i8k kernel driver for Inspiron laptops, displays
712               the right fan's rate of rotation, in revolutions per  minute  as
713               listed in /proc/i8k. Beware, some laptops i8k reports these fans
714               in reverse order.
715
716
717        i8k_right_fan_status
718               If running the i8k kernel driver for Inspiron laptops,  displays
719               the  right  fan status as listed in /proc/i8k (translated to hu-
720               man-readable). Beware, some laptops i8k reports  these  fans  in
721               reverse order.
722
723
724        i8k_serial
725               If  running the i8k kernel driver for Inspiron laptops, displays
726               your laptop serial number as listed in /proc/i8k.
727
728
729        i8k_version
730               If running the i8k kernel driver for Inspiron laptops,  displays
731               the version formatting of /proc/i8k.
732
733
734        ibm_fan
735               If running the IBM ACPI, displays the fan speed.
736
737
738        ibm_temps N
739               If  running the IBM ACPI, displays the temperatures from the IBM
740               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
741               GPU.
742
743
744        ibm_volume
745               If  running  the  IBM  ACPI,  displays the "master" volume, con-
746               trolled by the volume keys (0-14).
747
748
749        ibm_brightness
750               If running the IBM ACPI, displays the brigtness of the laptops's
751               LCD (0-7).
752
753
754        if_running (process)
755               if  PROCESS  is  running,  display everything if_running and the
756               matching $endif
757
758
759        if_existing (file)
760               if FILE exists, display everything between if_existing  and  the
761               matching $endif
762
763
764        if_mounted (mountpoint)
765               if  MOUNTPOINT is mounted, display everything between if_mounted
766               and the matching $endif
767
768
769        imap_messages (args)
770               Displays the number of messages in your global IMAP inbox by de-
771               fault.  You  can  define  individual  IMAP inboxes seperately by
772               passing arguments to this object. Arguments are: "host user pass
773               [-i  interval] [-p port] [-e command]". Default port is 143, de-
774               fault interval is 5 minutes. If the password is supplied as '*',
775               you will be prompted to enter the password when Conky starts.
776
777
778        imap_unseen (args)
779               Displays the number of unseen messages in your global IMAP inbox
780               by default. You can define individual IMAP inboxes seperately by
781               passing arguments to this object. Arguments are: "host user pass
782               [-i interval] [-p port] [-e command]". Default port is 143,  de-
783               fault interval is 5 minutes. If the password is supplied as '*',
784               you will be prompted to enter the password when Conky starts.
785
786
787        kernel Kernel version
788
789
790        linkstatus interface
791               Get the link status for wireless connections
792
793
794        loadavg
795               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
796               5 minutes and 3 for past 15 minutes.
797
798
799        machine
800               Machine, i686 for example
801
802
803        mails  Mail  count in mail spool. You can use program like fetchmail to
804               get mails from some server using your  favourite  protocol.  See
805               also new_mails.
806
807
808        mem    Amount of memory in use
809
810
811        membar (height),(width)
812               Bar that shows amount of memory in use
813
814
815        memmax Total amount of memory
816
817
818        memperc
819               Percentage of memory in use
820
821
822        mpd_artist
823               Artist in current MPD song must be enabled at compile
824
825
826        mpd_album
827               Album in current MPD song
828
829
830        mpd_bar (height),(width)
831               Bar of mpd's progress
832
833
834        mpd_bitrate
835               Bitrate of current song
836
837
838        mpd_status
839               Playing, stopped, et cetera.
840
841
842        mpd_title
843               Title of current MPD song
844
845
846        mpd_vol
847               MPD's volume
848
849
850        mpd_elapsed
851               Song's elapsed time
852
853
854        mpd_length
855               Song's length
856
857
858        mpd_percent
859               Percent of song's progress
860
861
862        mpd_random
863               Random status (On/Off)
864
865
866        mpd_repeat
867               Repeat status (On/Off)
868
869
870        mpd_track
871               Prints the MPD track field
872
873
874        mpd_name
875               Prints the MPD name field
876
877
878        mpd_file
879               Prints the file name of the current MPD song
880
881
882        mpd_smart
883               Prints the song name in either the form "artist - title" or file
884               name, depending on whats available
885
886
887        new_mails
888               Unread mail count in mail spool.
889
890
891        nodename
892               Hostname
893
894
895        outlinecolor (color)
896               Change outline color
897
898
899        pb_battery item
900               If running on Apple powerbook/ibook, display information on bat-
901               tery  status.  The item parameter specifies, what information to
902               display. Exactly one item must be specified. Valid items are:
903
904               status: Display if battery is fully charged, charging, discharg-
905               ing or absent (running on AC)
906               percent:  Display  charge  of battery in percent, if charging or
907               discharging. Nothing will be  displayed,  if  battery  is  fully
908               charged or absent.
909               time: Display the time remaining until the battery will be fully
910               charged or discharged at current rate. Nothing is displayed,  if
911               battery  is  absent or if it's present but fully charged and not
912               discharging.
913
914
915        pop3_unseen (args)
916               Displays the number of unseen messages in your global POP3 inbox
917               by default. You can define individual POP3 inboxes seperately by
918               passing arguments to this object. Arguments are: "host user pass
919               [-i  interval] [-p port] [-e command]". Default port is 110, de-
920               fault interval is 5 minutes. If the password is supplied as '*',
921               you will be prompted to enter the password when Conky starts.
922
923
924        pop3_used (args)
925               Displays  the amount of space (in MiB, 2^20) used in your global
926               POP3 inbox by default. You can define  individual  POP3  inboxes
927               seperately  by  passing arguments to this object. Arguments are:
928               "host user pass [-i interval] [-p port] [-e  command]".  Default
929               port  is  110, default interval is 5 minutes. If the password is
930               supplied as '*', you will be prompted to enter the password when
931               Conky starts.
932
933
934        pre_exec shell command
935               Executes a shell command one time before conky displays anything
936               and puts output as text.
937
938
939        processes
940               Total processes (sleeping and running)
941
942
943        running_processes
944               Running processes (not sleeping), requires Linux 2.6
945
946
947        shadecolor (color)
948               Change shading color
949
950
951        stippled_hr (space)
952               Stippled (dashed) horizontal line
953
954
955        swapbar (height),(width)
956               Bar that shows amount of swap in use
957
958
959        swap   Amount of swap in use
960
961
962        swapmax
963               Total amount of swap
964
965
966        swapperc
967               Percentage of swap in use
968
969
970        sysname
971               System name, Linux for example
972
973
974        tcp_portmon port_begin port_end item (index) (ip4 only at present)
975               TCP port monitor for specified local ports. Port numbers must be
976               in the range 1 to 65535. Valid items are:
977
978               count - total number of connections in the range
979               rip - remote ip address
980               rhost - remote host name
981               rport - remote port number
982               rservice - remote service name from /etc/services
983               lip - local ip address
984               lhost - local host name
985               lport - local port number
986               lservice - local service name from /etc/services
987
988               The connection index provides you with access to each connection
989               in the port monitor. The monitor will return information for in-
990               dex values from 0 to n-1 connections. Values higher than n-1 are
991               simply ignored. For the "count" item, the connection index  must
992               be omitted. It is required for all other items.
993
994               Examples:
995               ${tcp_portmon  6881 6999 count} - displays the number of connec-
996               tions in the bittorrent port range
997               ${tcp_portmon 22 22 rip 0} - displays the remote host ip of  the
998               first sshd connection
999               ${tcp_portmon  22 22 rip 9} - displays the remote host ip of the
1000               tenth sshd connection
1001               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1002               the first connection on a privileged port
1003               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1004               the fifth connection on a privileged port
1005               ${tcp_portmon 1 65535 lservice 14} - displays the local  service
1006               name of the fifteenth connection in the range of all ports
1007
1008               Note that port monitor variables which share the same port range
1009               actually refer to the same monitor, so many references to a sin-
1010               gle port range for different items and different indexes all use
1011               the same monitor internally. In other words, the program  avoids
1012               creating redundant monitors.
1013
1014        texeci interval command
1015               Runs  a  command at an interval inside a thread and displays the
1016               output. Same as $execi, except  the  command  is  run  inside  a
1017               thread.  Use this if you have a slow script to keep Conky updat-
1018               ing. You should make the interval slightly longer then the  time
1019               it  takes  your  script  to  execute. For example, if you have a
1020               script that take 5 seconds to execute, you should make  the  in-
1021               terval at least 6 seconds. See also $execi.
1022
1023
1024        offset (pixels)
1025               Move text over by N pixels. See also $voffset.
1026
1027
1028        tab (width, (start))
1029               Puts a tab of the specified width, starting from column 'start'.
1030
1031
1032        tail logfile lines (interval)
1033               Displays last N lines of supplied text text file. If interval is
1034               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1035               can be displayed, or until the text buffer is filled.
1036
1037
1038        time (format)
1039               Local time, see man strftime to get more information about  for-
1040               mat
1041
1042
1043        utime (format)
1044               Display time in UTC (universal coordinate time).
1045
1046
1047        tztime (timezone) (format)
1048               Local  time for specified timezone, see man strftime to get more
1049               information about format. The timezone argument is specified  in
1050               similar  fashion  as TZ environment variable. For hints, look in
1051               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1052
1053
1054        totaldown net
1055               Total download, overflows at 4 GB on Linux with 32-bit arch  and
1056               there doesn't seem to be a way to know how many times it has al-
1057               ready done that before conky has started.
1058
1059
1060        top type, num
1061               This takes arguments in the form:top (name) (number)  Basically,
1062               processes  are ranked from highest to lowest in terms of cpu us-
1063               age, which is what (num)  represents.  The  types  are:  "name",
1064               "pid",  "cpu",  and  "mem".  There  can be a max of 10 processes
1065               listed.
1066
1067
1068        top_mem type, num
1069               Same as top, except sorted by mem usage instead of cpu
1070
1071
1072        totalup net
1073               Total upload, this one too, may overflow
1074
1075
1076        updates Number of updates
1077               for debugging
1078
1079
1080        upspeed net
1081               Upload speed in kilobytes
1082
1083
1084        upspeedf net
1085               Upload speed in kilobytes with one decimal
1086
1087
1088        upspeedgraph net (height),(width) (gradient colour 1) (gradient  colour
1089        2) (scale)
1090               Upload speed graph, colours defined in  hex,  minus  the  #.  If
1091               scale is non-zero, it becomes the scale for the graph.
1092
1093
1094        uptime Uptime
1095
1096
1097        uptime_short
1098               Uptime in a shorter format
1099
1100
1101        voffset (pixels)
1102               Change  vertical  offset by N pixels. Negative values will cause
1103               text to overlap. See also $offset.
1104
1105
1106        voltage_mv (n)
1107               Returns CPU #n's voltage in mV. CPUs  are  counted  from  1.  If
1108               omitted, the parameter defaults to 1.
1109
1110
1111        voltage_v (n)
1112               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1113               ted, the parameter defaults to 1.
1114
1115
1116 EXAMPLES
1117        conky -t '${time %D %H:%m}' -o -u 30
1118               Start Conky in its own window with date and clock as text and 30
1119               sec update interval.
1120
1121        conky -a top_left -x 5 -y 500 -d
1122               Start Conky to background at coordinates (5, 500).
1123
1124 FILES
1125        ~/.conkyrc default configuration file
1126
1127 BUGS
1128        Drawing to root or some other desktop window directly doesn't work with
1129        all window managers. Especially doesn't work well with Gnome and it has
1130        been  reported  that  it  doesn't work with KDE either. Nautilus can be
1131        disabled from drawing to desktop  with  program  gconf-editor.  Uncheck
1132        show_desktop  in  /apps/nautilus/preferences/.  There  is  -w switch in
1133        Conky to set some specific window id. You  might  find  xwininfo  -tree
1134        useful  to  find  the  window  to draw to. You can also use -o argument
1135        which makes Conky to create its own window.
1136
1137 SEE ALSO
1138        <http://conky.sourceforge.net>
1139
1140        <http://www.sourceforge.net/projects/conky>
1141
1142        #conky on irc.freenode.net
1143
1144 AUTHORS
1145        The Conky dev team. What's up now!
1146
1147
1148
1149                                   2006-05-13                          conky(1)