split battery off into battery and battery_time
[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_port_monitor_connections
224               Allow each port monitor to track at most this  many  connections
225               (if 0 or not set, default is 256)
226
227
228        max_specials
229               Maximum  number  of special things, e.g. fonts, offsets, aligns,
230               etc. (default is 512)
231
232
233        max_user_text bytes
234               Maximum size of user text buffer, i.e. layout below TEXT line in
235               config file (default is 16384 bytes)
236
237
238        maximum_width pixels
239               Maximum width of window
240
241
242        minimum_size width (height)
243               Minimum size of window
244
245
246        mpd_host
247               Host of MPD server
248
249
250        mpd_port
251               Port of MPD server
252
253
254        mpd_password
255               MPD server password
256
257
258        net_avg_samples
259               The number of samples to average for net data
260
261
262        no_buffers
263               Substract (file system) buffers from used memory?
264
265
266        override_utf8_locale
267               Force UTF8? requires XFT
268
269
270        own_window
271               Boolean, create own window to draw?
272
273
274        own_window_transparent
275               Boolean, set pseudo-transparency?
276
277
278        own_window_type
279               if  own_window  is  yes, you may specify type normal, desktop or
280               override (default: normal).  Desktop windows are special windows
281               that  have  no  window  decorations;  are always visible on your
282               desktop; do not appear in your pager or taskbar; and are  sticky
283               across  all workspaces.  Override windows are not under the con-
284               trol of the window manager. Hints are ignored. This type of win-
285               dow can be useful for certain situations.
286
287
288        own_window_colour colour
289               If  own_window_transparent no, set a specified background colour
290               (defaults to black). Takes either a hex  value  (#ffffff)  or  a
291               valid RGB name (see /usr/lib/X11/rgb.txt)
292
293
294        own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
295               If  own_window is yes, you may use these window manager hints to
296               affect the way Conky displays.  Notes: Use own_window_type desk-
297               top  as another way to implement many of these hints implicitly.
298               If you use own_window_type override, window manager  hints  have
299               no meaning and are ignored.
300
301
302        out_to_console
303               Print text to stdout.
304
305
306        pad_percents
307               Pad percentages to this many decimals (0 = no padding)
308
309
310        pop3   Default  global  POP3 server. Arguments are: "host user pass [-i
311               interval] [-p port] [-e command]". Default port is 110,  default
312               interval  is  5 minutes. If the password is supplied as '*', you
313               will be prompted to enter the password when Conky starts.
314
315
316        stippled_borders
317               Border stippling (dashing) in pixels
318
319
320        total_run_times
321               Total number of times for Conky to update before quitting.  Zero
322               makes Conky run forever
323
324
325        update_interval
326               Update interval in seconds
327
328
329        uppercase
330               Boolean value, if true, text is rendered in upper case
331
332
333        use_spacer
334               Adds spaces after certain objects to stop them from moving other
335               things around. Note that this only helps if you are using a mono
336               font, such as Bitstream Vera Sans Mono.
337
338
339        use_xft
340               Use Xft (anti-aliased font and stuff)
341
342
343        wm_class_name
344               Manually set the WM_CLASS name. Defaults to "conky".
345
346
347        xftalpha
348               Alpha of Xft font. Must be a value at or between 1 and 0.
349
350
351        xftfont
352               Xft font to use.
353
354
355        TEXT   After this begins text to be formatted on screen
356
357
358 VARIABLES
359        Colors  are  parsed using XParsecolor(), there might be a list of them:
360        /usr/X11R6/lib/X11/rgb.txt. Also,  <http://sedition.com/perl/rgb.html>.
361        Color  can  be also in #rrggbb format (hex).  Note that when displaying
362        bytes, power is 1024 and not 1000 so 1M really  means  1024*1024  bytes
363        and not 1000*1000.
364
365        addr interface
366               IP address for an interface
367
368
369        acpiacadapter
370               ACPI ac adapter state.
371
372
373        acpifan
374               ACPI fan state
375
376
377        acpitemp
378               ACPI temperature in C.
379
380
381        acpitempf
382               ACPI temperature in F.
383
384
385        adt746xcpu
386               CPU temperature from therm_adt746x
387
388
389        adt746xfan
390               Fan speed from therm_adt746x
391
392
393        alignr (num)
394               Right-justify text, with space of N
395
396
397        alignc (num)
398               Align text to centre
399
400
401        apm_adapter
402               Display APM AC adapter status (FreeBSD only)
403
404
405        apm_battery_life
406               Display APM battery life in percent (FreeBSD only)
407
408
409        apm_battery_time
410               Display  remaining  APM battery life in hh:mm:ss or "unknown" if
411               AC adapterstatus is on-line or charging (FreeBSD only)
412
413
414        audacious_bar (height),(width)
415               Progress bar
416
417
418        audacious_bitrate
419               Bitrate of current tune
420
421
422        audacious_channels
423               Number of audio channels of current tune
424
425
426        audacious_filename
427               Full path and filename of current tune
428
429
430        audacious_frequency
431               Sampling frequency of current tune
432
433
434        audacious_length
435               Total length of current tune as MM:SS
436
437
438        audacious_length_seconds
439               Total length of current tune in seconds
440
441
442        audacious_playlist_position
443               Playlist position of current tune
444
445
446        audacious_playlist_length
447               Number of tunes in playlist
448
449
450        audacious_position
451               Position of current tune (MM:SS)
452
453
454        audacious_position_seconds
455               Position of current tune in seconds
456
457
458        audacious_status
459               Player status (Playing/Paused/Stopped/Not running)
460
461
462        audacious_title (max length)
463               Title of current tune with optional maximum length specifier
464
465
466        battery (num)
467               Battery status and remaining percentage capacity of ACPI or  APM
468               battery.  ACPI  battery number can be given as argument (default
469               is BAT0).
470
471
472        battery_time (num)
473               Battery charge/discharge time remaining of  ACPI  battery.  ACPI
474               battery number can be given as argument (default is BAT0).
475
476
477        bmpx_artist
478               Artist in current BMPx track
479
480
481        bmpx_album
482               Album in current BMPx track
483
484
485        bmpx_title
486               Title of the current BMPx track
487
488
489        bmpx_track
490               Track number of the current BMPx track
491
492
493        bmpx_bitrate
494               Bitrate of the current BMPx track
495
496
497        bmpx_uri
498               URI of the current BMPx track
499
500
501        buffers
502               Amount of memory buffered
503
504
505        cached Amount of memory cached
506
507
508        color (color)
509               Change drawing color to color
510
511
512        cpu (cpuN)
513               CPU  usage  in percents. For SMP machines, the CPU number can be
514               provided as an argument. ${cpu 0} is the total usage, and  ${cpu
515               X} (X >= 1) are individual CPUs.
516
517
518        cpubar (cpu number) (height),(width)
519               Bar  that shows CPU usage, height is bar's height in pixels. See
520               $cpu for more info on SMP.
521
522
523        cpugraph (cpu number) (height),(width) (gradient  colour  1)  (gradient
524        colour 2)
525               CPU usage graph, with optional colours in hex, minus the #.  See
526               $cpu for more info on SMP.
527
528
529        diskio Displays current disk IO.
530
531
532        diskiograph  (height),(width)  (gradient  colour 1) (gradient colour 2)
533        (scale)
534               Disk  IO graph, colours defined in hex, minus the #. If scale is
535               non-zero, it becomes the scale for the graph.
536
537
538        downspeed net
539               Download speed in kilobytes
540
541
542        downspeedf net
543               Download speed in kilobytes with one decimal
544
545
546        downspeedgraph  net  (height),(width)  (gradient  colour  1)  (gradient
547        colour 2) (scale)
548               Download speed graph, colours defined in hex, minus  the  #.  If
549               scale is non-zero, it becomes the scale for the graph.
550
551
552        else   Text to show if any of the above are not true
553
554
555        entropy_avail
556               Current entropy available for crypto freaks
557
558
559        entropy_bar (height),(width)
560               Normalized bar of available entropy for crypto freaks
561
562
563        entropy_poolsize
564               Total size of system entropy pool for crypto freaks
565
566
567        exec command
568               Executes a shell command and displays the output in conky. warn-
569               ing: this takes a lot more resources than other  variables.  I'd
570               recommend coding wanted behaviour in C and posting a patch.
571
572
573        execbar command
574               Same  as  exec,  except if the first value return is a value be-
575               tween 0-100, it will use that number for a bar. The size for the
576               bar is currently fixed, but that may change in the future.
577
578
579        execgraph command
580               Same as execbar, but graphs values.
581
582
583        execi interval command
584               Same  as exec but with specific interval. Interval can't be less
585               than update_interval in configuration. See also $texeci
586
587
588        execibar interval command
589               Same as execbar, except with an interval
590
591
592        execigraph interval command
593               Same as execigraph, but takes an interval arg graphs values
594
595
596        font (font)
597               Specify a different font. This new font will apply to  the  cur-
598               rent  line and everything following. You can use a $font with no
599               arguments to change back to the default  font  (much  like  with
600               $color)
601
602
603        freq (n)
604               Returns  CPU  #n's frequency in MHz. CPUs are counted from 1. If
605               omitted, the parameter defaults to 1.
606
607
608        freq_g (n)
609               Returns CPU #n's frequency in GHz. CPUs are counted from  1.  If
610               omitted, the parameter defaults to 1.
611
612
613        freq_dyn
614               Returns  CPU  frequency in MHz, but is calculated by counting to
615               clock cycles to complete  an  instruction.  Only  available  for
616               x86/amd64.
617
618
619        freq_dyn_g
620               Returns  CPU  frequency in GHz, but is calculated by counting to
621               clock cycles to complete  an  instruction.  Only  available  for
622               x86/amd64.
623
624
625        fs_bar (height),(width) fs
626               Bar  that  shows how much space is used on a file system. height
627               is the height in pixels. fs is any file on that file system.
628
629
630        fs_free (fs)
631               Free space on a file system available for users.
632
633
634        fs_free_perc (fs)
635               Free percentage of space on a file system available for users.
636
637
638        fs_size (fs)
639               File system size
640
641
642        fs_used (fs)
643               File system used space
644
645
646        goto x The next element will be printed at position 'x'.
647
648
649        hddtemp dev, (host,(port))
650               Displays temperature of a selected hard disk drive  as  reported
651               by  the  hddtemp  daemon  running on host:port.  Default host is
652               127.0.0.1, default port is 7634.
653
654
655        head logfile lines (interval)
656               Displays first N lines of supplied text text file.  If  interval
657               is  not  supplied,  Conky assumes 2x Conky's interval. Max of 30
658               lines can be displayed, or until the text buffer is filled.
659
660
661        hr (height)
662               Horizontal line, height is the height in pixels
663
664
665        iconv_start codeset_from codeset_to
666               Convert text from one codeset to another using GNU iconv.  Needs
667               to be stopped with iconv_stop.
668
669
670        iconv_stop
671               Stop iconv codeset conversion.
672
673
674        i2c (dev) type n
675               I2C  sensor  from  sysfs  (Linux 2.6). dev may be omitted if you
676               have only one I2C device. type is either  in  (or  vol)  meaning
677               voltage, fan meaning fan or temp/tempf (first in C, second in F)
678               meaning  temperature.  n  is   number   of   the   sensor.   See
679               /sys/bus/i2c/devices/ on your local computer.
680
681
682        i8k_ac_status
683               If  running the i8k kernel driver for Inspiron laptops, displays
684               whether ac power is on, as listed in  /proc/i8k  (translated  to
685               human-readable).  Beware  that this is by default not enabled by
686               i8k itself.
687
688
689        i8k_bios
690               If running the i8k kernel driver for Inspiron laptops,  displays
691               the bios version as listed in /proc/i8k.
692
693
694        i8k_buttons_status
695               If  running the i8k kernel driver for Inspiron laptops, displays
696               the volume buttons status as listed in /proc/i8k.
697
698
699        i8k_cpu_temp
700               If running the i8k kernel driver for Inspiron laptops,  displays
701               the cpu temperature in Celsius, as reported by /proc/i8k.
702
703
704        i8k_cpu_tempf
705               If  running the i8k kernel driver for Inspiron laptops, displays
706               the cpu temperature in Fahrenheit, as reported by /proc/i8k.
707
708
709        i8k_left_fan_rpm
710               If running the i8k kernel driver for Inspiron laptops,  displays
711               the  left  fan's  rate of rotation, in revolutions per minute as
712               listed in /proc/i8k. Beware, some laptops i8k reports these fans
713               in reverse order.
714
715
716        i8k_left_fan_status
717               If  running the i8k kernel driver for Inspiron laptops, displays
718               the left fan status as listed in /proc/i8k (translated to human-
719               readable).  Beware,  some  laptops i8k reports these fans in re-
720               verse order.
721
722
723        i8k_right_fan_rpm
724               If running the i8k kernel driver for Inspiron laptops,  displays
725               the  right  fan's rate of rotation, in revolutions per minute as
726               listed in /proc/i8k. Beware, some laptops i8k reports these fans
727               in reverse order.
728
729
730        i8k_right_fan_status
731               If  running the i8k kernel driver for Inspiron laptops, displays
732               the right fan status as listed in /proc/i8k (translated  to  hu-
733               man-readable).  Beware,  some  laptops i8k reports these fans in
734               reverse order.
735
736
737        i8k_serial
738               If running the i8k kernel driver for Inspiron laptops,  displays
739               your laptop serial number as listed in /proc/i8k.
740
741
742        i8k_version
743               If  running the i8k kernel driver for Inspiron laptops, displays
744               the version formatting of /proc/i8k.
745
746
747        ibm_fan
748               If running the IBM ACPI, displays the fan speed.
749
750
751        ibm_temps N
752               If running the IBM ACPI, displays the temperatures from the  IBM
753               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
754               GPU.
755
756
757        ibm_volume
758               If running the IBM ACPI,  displays  the  "master"  volume,  con-
759               trolled by the volume keys (0-14).
760
761
762        ibm_brightness
763               If running the IBM ACPI, displays the brigtness of the laptops's
764               LCD (0-7).
765
766
767        if_running (process)
768               if PROCESS is running, display  everything  if_running  and  the
769               matching $endif
770
771
772        if_existing (file)
773               if  FILE  exists, display everything between if_existing and the
774               matching $endif
775
776
777        if_mounted (mountpoint)
778               if MOUNTPOINT is mounted, display everything between  if_mounted
779               and the matching $endif
780
781
782        imap_messages (args)
783               Displays the number of messages in your global IMAP inbox by de-
784               fault. You can define  individual  IMAP  inboxes  seperately  by
785               passing arguments to this object. Arguments are: "host user pass
786               [-i interval] [-p port] [-e command]". Default port is 143,  de-
787               fault interval is 5 minutes. If the password is supplied as '*',
788               you will be prompted to enter the password when Conky starts.
789
790
791        imap_unseen (args)
792               Displays the number of unseen messages in your global IMAP inbox
793               by default. You can define individual IMAP inboxes seperately by
794               passing arguments to this object. Arguments are: "host user pass
795               [-i  interval] [-p port] [-e command]". Default port is 143, de-
796               fault interval is 5 minutes. If the password is supplied as '*',
797               you will be prompted to enter the password when Conky starts.
798
799
800        kernel Kernel version
801
802
803        linkstatus interface
804               Get the link status for wireless connections
805
806
807        loadavg
808               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
809               5 minutes and 3 for past 15 minutes.
810
811
812        machine
813               Machine, i686 for example
814
815
816        mails  Mail count in mail spool. You can use program like fetchmail  to
817               get  mails  from  some server using your favourite protocol. See
818               also new_mails.
819
820
821        mem    Amount of memory in use
822
823
824        membar (height),(width)
825               Bar that shows amount of memory in use
826
827
828        memmax Total amount of memory
829
830
831        memperc
832               Percentage of memory in use
833
834
835        mpd_artist
836               Artist in current MPD song must be enabled at compile
837
838
839        mpd_album
840               Album in current MPD song
841
842
843        mpd_bar (height),(width)
844               Bar of mpd's progress
845
846
847        mpd_bitrate
848               Bitrate of current song
849
850
851        mpd_status
852               Playing, stopped, et cetera.
853
854
855        mpd_title
856               Title of current MPD song
857
858
859        mpd_vol
860               MPD's volume
861
862
863        mpd_elapsed
864               Song's elapsed time
865
866
867        mpd_length
868               Song's length
869
870
871        mpd_percent
872               Percent of song's progress
873
874
875        mpd_random
876               Random status (On/Off)
877
878
879        mpd_repeat
880               Repeat status (On/Off)
881
882
883        mpd_track
884               Prints the MPD track field
885
886
887        mpd_name
888               Prints the MPD name field
889
890
891        mpd_file
892               Prints the file name of the current MPD song
893
894
895        mpd_smart
896               Prints the song name in either the form "artist - title" or file
897               name, depending on whats available
898
899
900        new_mails
901               Unread mail count in mail spool.
902
903
904        nodename
905               Hostname
906
907
908        outlinecolor (color)
909               Change outline color
910
911
912        pb_battery item
913               If running on Apple powerbook/ibook, display information on bat-
914               tery status. The item parameter specifies, what  information  to
915               display. Exactly one item must be specified. Valid items are:
916
917               status: Display if battery is fully charged, charging, discharg-
918               ing or absent (running on AC)
919               percent: Display charge of battery in percent,  if  charging  or
920               discharging.  Nothing  will  be  displayed,  if battery is fully
921               charged or absent.
922               time: Display the time remaining until the battery will be fully
923               charged  or discharged at current rate. Nothing is displayed, if
924               battery is absent or if it's present but fully charged  and  not
925               discharging.
926
927
928        pop3_unseen (args)
929               Displays the number of unseen messages in your global POP3 inbox
930               by default. You can define individual POP3 inboxes seperately by
931               passing arguments to this object. Arguments are: "host user pass
932               [-i interval] [-p port] [-e command]". Default port is 110,  de-
933               fault interval is 5 minutes. If the password is supplied as '*',
934               you will be prompted to enter the password when Conky starts.
935
936
937        pop3_used (args)
938               Displays the amount of space (in MiB, 2^20) used in your  global
939               POP3  inbox  by  default. You can define individual POP3 inboxes
940               seperately by passing arguments to this object.  Arguments  are:
941               "host  user  pass [-i interval] [-p port] [-e command]". Default
942               port is 110, default interval is 5 minutes. If the  password  is
943               supplied as '*', you will be prompted to enter the password when
944               Conky starts.
945
946
947        pre_exec shell command
948               Executes a shell command one time before conky displays anything
949               and puts output as text.
950
951
952        processes
953               Total processes (sleeping and running)
954
955
956        running_processes
957               Running processes (not sleeping), requires Linux 2.6
958
959
960        shadecolor (color)
961               Change shading color
962
963
964        stippled_hr (space)
965               Stippled (dashed) horizontal line
966
967
968        swapbar (height),(width)
969               Bar that shows amount of swap in use
970
971
972        swap   Amount of swap in use
973
974
975        swapmax
976               Total amount of swap
977
978
979        swapperc
980               Percentage of swap in use
981
982
983        sysname
984               System name, Linux for example
985
986
987        tcp_portmon port_begin port_end item (index) (ip4 only at present)
988               TCP port monitor for specified local ports. Port numbers must be
989               in the range 1 to 65535. Valid items are:
990
991               count - total number of connections in the range
992               rip - remote ip address
993               rhost - remote host name
994               rport - remote port number
995               rservice - remote service name from /etc/services
996               lip - local ip address
997               lhost - local host name
998               lport - local port number
999               lservice - local service name from /etc/services
1000
1001               The connection index provides you with access to each connection
1002               in the port monitor. The monitor will return information for in-
1003               dex values from 0 to n-1 connections. Values higher than n-1 are
1004               simply  ignored. For the "count" item, the connection index must
1005               be omitted. It is required for all other items.
1006
1007               Examples:
1008               ${tcp_portmon 6881 6999 count} - displays the number of  connec-
1009               tions in the bittorrent port range
1010               ${tcp_portmon  22 22 rip 0} - displays the remote host ip of the
1011               first sshd connection
1012               ${tcp_portmon 22 22 rip 9} - displays the remote host ip of  the
1013               tenth sshd connection
1014               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1015               the first connection on a privileged port
1016               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1017               the fifth connection on a privileged port
1018               ${tcp_portmon  1 65535 lservice 14} - displays the local service
1019               name of the fifteenth connection in the range of all ports
1020
1021               Note that port monitor variables which share the same port range
1022               actually refer to the same monitor, so many references to a sin-
1023               gle port range for different items and different indexes all use
1024               the  same monitor internally. In other words, the program avoids
1025               creating redundant monitors.
1026
1027        texeci interval command
1028               Runs a command at an interval inside a thread and  displays  the
1029               output.  Same  as  $execi,  except  the  command is run inside a
1030               thread. Use this if you have a slow script to keep Conky  updat-
1031               ing.  You should make the interval slightly longer then the time
1032               it takes your script to execute. For  example,  if  you  have  a
1033               script  that  take 5 seconds to execute, you should make the in-
1034               terval at least 6 seconds. See also $execi.
1035
1036
1037        offset (pixels)
1038               Move text over by N pixels. See also $voffset.
1039
1040
1041        tab (width, (start))
1042               Puts a tab of the specified width, starting from column 'start'.
1043
1044
1045        tail logfile lines (interval)
1046               Displays last N lines of supplied text text file. If interval is
1047               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1048               can be displayed, or until the text buffer is filled.
1049
1050
1051        time (format)
1052               Local  time, see man strftime to get more information about for-
1053               mat
1054
1055
1056        utime (format)
1057               Display time in UTC (universal coordinate time).
1058
1059
1060        tztime (timezone) (format)
1061               Local time for specified timezone, see man strftime to get  more
1062               information  about format. The timezone argument is specified in
1063               similar fashion as TZ environment variable. For hints,  look  in
1064               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1065
1066
1067        totaldown net
1068               Total  download, overflows at 4 GB on Linux with 32-bit arch and
1069               there doesn't seem to be a way to know how many times it has al-
1070               ready done that before conky has started.
1071
1072
1073        top type, num
1074               This  takes arguments in the form:top (name) (number) Basically,
1075               processes are ranked from highest to lowest in terms of cpu  us-
1076               age,  which  is  what  (num)  represents. The types are: "name",
1077               "pid", "cpu", and "mem". There can be  a  max  of  10  processes
1078               listed.
1079
1080
1081        top_mem type, num
1082               Same as top, except sorted by mem usage instead of cpu
1083
1084
1085        totalup net
1086               Total upload, this one too, may overflow
1087
1088
1089        updates Number of updates
1090               for debugging
1091
1092
1093        upspeed net
1094               Upload speed in kilobytes
1095
1096
1097        upspeedf net
1098               Upload speed in kilobytes with one decimal
1099
1100
1101        upspeedgraph  net (height),(width) (gradient colour 1) (gradient colour
1102        2) (scale)
1103               Upload  speed  graph,  colours  defined  in hex, minus the #. If
1104               scale is non-zero, it becomes the scale for the graph.
1105
1106
1107        uptime Uptime
1108
1109
1110        uptime_short
1111               Uptime in a shorter format
1112
1113
1114        voffset (pixels)
1115               Change vertical offset by N pixels. Negative values  will  cause
1116               text to overlap. See also $offset.
1117
1118
1119        voltage_mv (n)
1120               Returns  CPU  #n's  voltage  in  mV. CPUs are counted from 1. If
1121               omitted, the parameter defaults to 1.
1122
1123
1124        voltage_v (n)
1125               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1126               ted, the parameter defaults to 1.
1127
1128
1129 EXAMPLES
1130        conky -t '${time %D %H:%m}' -o -u 30
1131               Start Conky in its own window with date and clock as text and 30
1132               sec update interval.
1133
1134        conky -a top_left -x 5 -y 500 -d
1135               Start Conky to background at coordinates (5, 500).
1136
1137 FILES
1138        ~/.conkyrc default configuration file
1139
1140 BUGS
1141        Drawing to root or some other desktop window directly doesn't work with
1142        all window managers. Especially doesn't work well with Gnome and it has
1143        been reported that it doesn't work with KDE  either.  Nautilus  can  be
1144        disabled  from  drawing  to  desktop with program gconf-editor. Uncheck
1145        show_desktop in /apps/nautilus/preferences/.  There  is  -w  switch  in
1146        Conky  to  set  some  specific window id. You might find xwininfo -tree
1147        useful to find the window to draw to. You  can  also  use  -o  argument
1148        which makes Conky to create its own window.
1149
1150 SEE ALSO
1151        <http://conky.sourceforge.net>
1152
1153        <http://www.sourceforge.net/projects/conky>
1154
1155        #conky on irc.freenode.net
1156
1157 AUTHORS
1158        The Conky dev team. What's up now!
1159
1160
1161
1162                                   2006-05-13                          conky(1)