1conky(1) conky(1)
2
3
4
6 conky - A system monitor for X
7
9 conky [ options ]
10
12 Conky is a system monitor for X originally based on torsmo. Since its
13 inception, Conky has changed significantly from its predecessor, while
14 maintaining simplicity and configurability. Conky can display just
15 about anything, either on your root desktop or in its own window. Not
16 only does Conky have many built-in objects, it can also display just
17 about any piece of information by using scripts and other external pro‐
18 grams.
19
20 Conky has more than 250 built in objects, including support for a
21 plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
22 "top" like process stats, and network monitoring, just to name a few),
23 built in IMAP and POP3 support, built in support for many popular music
24 players (MPD, XMMS2, Audacious), and much much more. Conky can display
25 this info either as text, or using simple progress bars and graph wid‐
26 gets, with different fonts and colours.
27
28 We are always looking for help, whether its reporting bugs, writing
29 patches, or writing docs. Please use the facilities on GitHub to make
30 bug reports, feature requests, and submit patches.
31
32 Thanks for your interest in Conky.
33
35 For users compiling from source on a binary distro, make sure you have
36 the X development libraries installed (Unless you configure your build
37 without X11). This should be a package along the lines of "libx11-dev"
38 or "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other
39 libs required (depending on your build options). You should be able to
40 see which extra packages you need to install by reading errors that you
41 get from running `cmake'. The easiest way to view the available build
42 options is to run `ccmake' or `cmake-gui' from the source tree, but be
43 careful when disabling certain features as you may lose desired func‐
44 tionality. E.g., with BUILD_MATH disabled you won't get errors but
45 logarithmic graphs will be normal graphs and gauges will miss their
46 line.
47
48 Conky has (for some time) been available in the repositories of most
49 popular distributions. Here are some installation instructions for a
50 few:
51
52 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge
53 app-admin/conky" for installation.
54
55 Debian, etc. users -- Conky should be in your repositories, and can be
56 installed by doing "aptitude install conky".
57
58 Example to compile and run Conky with default components (note that
59 some build options may differ for your system):
60
61 cmake -D CMAKE_INSTALL_PREFIX:string=/usr .
62
63 make
64
65 make install # Optional
66
67 src/conky
68
69 Conky has been tested to be compatible with C99 C and C++0x C++, howev‐
70 er it has not been tested with anything other than gcc, and is not
71 guaranteed to work with other compilers.
72
73 TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead of just
74 `cmake'.
75
77 Conky is generally very good on resources. That said, the more you try
78 to make Conky do, the more resources it is going to consume.
79
80 An easy way to force Conky to reload your ~/.config/conky/conky.conf:
81 "killall -SIGUSR1 conky". Saves you the trouble of having to kill and
82 then restart.
83
85 Command line options override configurations defined in configuration
86 file.
87
88 -a | --alignment= ALIGNMENT
89 Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
90 dle} or none. Can also be abbreviated with first chars of posi‐
91 tion, ie. tr for top_right. Only available with build flag
92 BUILD_X11 enabled.
93
94 -b | --double-buffer
95 Use double buffering (eliminates "flicker"). Only available
96 with build flag BUILD_X11 enabled.
97
98 -c | --config= FILE
99 Config file to load instead of ~/.config/conky/conky.conf.
100
101 -C | --print-config
102 Print builtin default config to stdout. See also the section
103 EXAMPLES for more information. Only available with build flag
104 BUILD_BUILTIN_CONFIG enabled.
105
106 -d | --daemonize
107 Daemonize Conky, aka fork to background.
108
109 -D | --debug
110 Increase debugging output, ie. -DD for more debugging.
111
112 -f | --font= FONT
113 Font to use. Only available with build flag BUILD_X11 enabled.
114
115 -h | --help
116 Prints command line help and exits.
117
118 -i COUNT
119 Number of times to update Conky (and quit).
120
121 -o | --own-window
122 Create own window to draw. Only available with build flag
123 BUILD_X11 enabled.
124
125 -p | --pause= SECONDS
126 Time to pause/wait before actually starting Conky.
127
128 -q | --quiet
129 Run Conky in 'quiet mode' (ie. no output).
130
131 -t | --text= TEXT
132 Text to render, remember single quotes, like -t ' $uptime '.
133
134 -u | --interval= SECONDS
135 Update interval.
136
137 -v | -V | --version
138 Prints version, build information and general info. Exits after
139 printing.
140
141 -w | --window-id= WIN_ID
142 Window id to draw. Only available with build flag BUILD_X11 en‐
143 abled.
144
145 -x X_COORDINATE
146 X position.
147
148 -X | --display= DISPLAY
149 X11 display to use. Only available with build flag BUILD_X11
150 enabled.
151
152 -y Y_COORDINATE
153 Y position.
154
156 This is a listing of global configuration options for Conky. These are
157 placed in the conky.config section of your configuration file, before
158 conky.text.
159
160 The default configuration file location is ~/.config/conky/conky.conf
161 or ${sysconfdir}/conky/conky.conf. On most systems, $sysconfdir is
162 /etc, and you can find the sample config file there in
163 /etc/conky/conky.conf.
164
165 You might want to copy the default config to ~/.config/conky/conky.conf
166 and then start modifying it. User configs can be found at
167 https://github.com/brndnmtthws/conky/wiki/Configs.
168
169 Optional arguments are generally denoted with paretheses (i.e., (op‐
170 tional)).
171
172 alignment
173 Aligned position on screen, may be top_left, top_right, top_mid‐
174 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
175 dle_middle, middle_right, or none (also can be abbreviated as
176 tl, tr, tm, bl, br, bm, ml, mm, mr). See also gap_x and gap_y.
177
178 append_file
179 Append the file given as argument.
180
181 background
182 Boolean value, if true, Conky will be forked to background when
183 started.
184
185 border_inner_margin
186 Inner border margin in pixels (the margin between the border and
187 text).
188
189 border_outer_margin
190 Outer border margin in pixels (the margin between the border and
191 the edge of the window).
192
193 border_width
194 Border width in pixels.
195
196 colorN Predefine a color for use inside conky.text segments. Substi‐
197 tute N by a digit between 0 and 9, inclusively. When specifying
198 the color value in hex, omit the leading hash (#).
199
200 console_bar_fill
201 A character to fill the console bars.
202
203 Default: #
204
205 console_bar_unfill
206 A character to unfill the console bars.
207
208 Default: .
209
210 console_graph_ticks
211 A comma-separated list of strings to use as the bars of a graph
212 output to console/shell. The first list item is used for the
213 minimum bar height and the last item is used for the maximum,
214 e.g. " ,_,=,#".
215
216 cpu_avg_samples
217 The number of samples to average for CPU monitoring.
218
219 default_bar_height
220 Specify a default height for bars.
221
222 Default: 6
223
224 default_bar_width
225 Specify a default width for bars. If not specified, the default
226 value is 0, which causes the bar to expand to fit the width of
227 your Conky window. If you set out_to_console = true, the de‐
228 fault value will be 10 for the text version of the bar.
229
230 default_color
231 Default color and border color.
232
233 default_gauge_height
234 Specify a default height for gauges.
235
236 Default: 25
237
238 default_gauge_width
239 Specify a default width for gauges.
240
241 Default: 40
242
243 default_graph_height
244 Specify a default height for graphs.
245
246 Default: 25
247
248 default_graph_width
249 Specify a default width for graphs. If not specified, the de‐
250 fault value is 0, which causes the graph to expand to fit the
251 width of your Conky window. If you set out_to_console = true,
252 the text version of the graph will actually have no width and
253 you will need to set a sensible default or set the height and
254 width of each graph individually.
255
256 default_outline_color
257 Default outline color.
258
259 default_shade_color
260 Default shading color and border’s shading color.
261
262 detect_battery
263 One or more batteries to check in order to use update_inter‐
264 val_on_battery (comma separated).
265
266 Default: BAT0
267
268 disable_auto_reload
269 Enable to disable the inotify-based auto config reload feature.
270
271 diskio_avg_samples
272 The number of samples to average for disk I/O monitoring.
273
274 display
275 Specify an X display to connect to.
276
277 double_buffer
278 Use the Xdbe extension? (eliminates flicker) It is highly rec‐
279 ommended to use own window with this one so double buffer won’t
280 be so big.
281
282 draw_blended
283 Boolean, blend when rendering drawn image? Some images blend
284 incorrectly breaking alpha with ARBG visuals. This provides a
285 possible work around by disabling blending.
286
287 Default: True
288
289 draw_borders
290 Draw borders around text.
291
292 draw_graph_borders
293 Draw borders around graphs.
294
295 draw_outline
296 Draw outlines.
297
298 draw_shades
299 Draw shades.
300
301 extra_newline
302 Put an extra newline at the end when writing to stdout, useful
303 for writing to awesome’s wiboxes.
304
305 font Font name in X, xfontsel can be used to get a nice font.
306
307 fontN Predefine a font to be used in conky.text segments. Substitute
308 N by a number between 0 and 9 inclusive. Use the same format as
309 a font variable.
310
311 forced_redraw
312 Boolean value, if true, Conky will redraw everything when you
313 switch the workspace. This may cause delays/flickering on some
314 WMs.
315
316 format_human_readable
317 If enabled, values which are in bytes will be printed in human
318 readable format (i.e., KiB, MiB, etc). If disabled, the number
319 of bytes is printed instead.
320
321 gap_x Gap, in pixels, between right or left border of screen, same as
322 passing -x at command line, e.g. gap_x 10. For other position
323 related stuff, see `alignment'.
324
325 gap_y Gap, in pixels, between top or bottom border of screen, same as
326 passing -y at command line, e.g. gap_y 10. For other position
327 related stuff, see `alignment'.
328
329 github_token
330 Specify API token for GitHub notifications.
331
332 Create an API token at https://github.com/settings/to‐
333 kens/new?scopes=notifications&description=conky.
334
335 hddtemp_host
336 Hostname to connect to for hddtemp objects.
337
338 Default: 127.0.0.1
339
340 hddtemp_port
341 Port to use for hddtemp connections.
342
343 Default: 7634
344
345 http_port
346 Port to listen to for HTTP connections. Default value is 10080,
347 but is blocked by Firefox and Chrome, so you really want to
348 change it.
349
350 Default: 10080
351
352 http_refresh
353 When this is set the page generated with out_to_http will auto‐
354 matically refresh each interval.
355
356 if_up_strictness
357 How strict should if_up be when testing an interface for being
358 up? The value is one of up, link or address, to check for the
359 interface being solely up, being up and having link or being up,
360 having link and an assigned IP address.
361
362 imap host user pass [`-i interval (in seconds)'] [“-f `folder'”] [`-p
363 port'] [“-e `command'”] [`-r retries']
364 Default global IMAP server. Default port is 143, default folder
365 is `INBOX', default interval is 5 minutes, and default number of
366 retries before giving up is 5. If the password is supplied as
367 ’*’, you will be prompted to enter the password when Conky
368 starts.
369
370 imlib_cache_flush_interval
371 Interval (in seconds) to flush Imlib2 cache.
372
373 imlib_cache_size
374 Imlib2 image cache size, in bytes. Increase this value if you
375 use $image lots. Set to 0 to disable the image cache.
376
377 Default: 4194304
378
379 lua_mouse_hook function_name
380 This function, if defined, will be called by Conky upon receiv‐
381 ing mouse events from X. Requires X support. A table contain‐
382 ing event information will be passed to this function as the
383 first argument. Use this hook for detecting mouse input and
384 acting on it. Conky puts `conky_' in front of function_name to
385 prevent accidental calls to the wrong function unless you place
386 `conky_' in front of it yourself.
387
388 lowercase
389 Boolean value, if true, text is rendered in lower case.
390
391 lua_draw_hook_post function_name [`function arguments']
392 This function, if defined, will be called by Conky through each
393 iteration after drawing to the window. Requires X support.
394 Takes any number of optional arguments. Use this hook for draw‐
395 ing things on top of what Conky draws. Conky puts `conky_' in
396 front of function_name to prevent accidental calls to the wrong
397 function unless you place `conky_' in front of it yourself.
398
399 lua_draw_hook_pre function_name [`function arguments']
400 This function, if defined, will be called by Conky through each
401 iteration before drawing to the window. Requires X support.
402 Takes any number of optional arguments. Use this hook for draw‐
403 ing things on top of what Conky draws. Conky puts `conky_' in
404 front of function_name to prevent accidental calls to the wrong
405 function unless you place `conky_' in front of it yourself.
406
407 lua_load
408 Loads the Lua scripts separated by spaces.
409
410 lua_shutdown_hook function_name [`function arguments']
411 This function, if defined, will be called by Conky at shutdown
412 or when the configuration is reloaded. Use this hook to clean
413 up after yourself, such as freeing memory which has been allo‐
414 cated by external libraries via Lua. Conky puts `conky_' in
415 front of function_name to prevent accidental calls to the wrong
416 function unless you place `conky_' in front of it yourself.
417
418 lua_startup_hook function_name [`function arguments']
419 This function, if defined, will be called by Conky at startup or
420 when the configuration is reloaded. Use this hook to initialize
421 values, or for any run-once applications. Conky puts `conky_'
422 in front of function_name to prevent accidental calls to the
423 wrong function unless you place `conky_' in front of it your‐
424 self.
425
426 mail_spool
427 Mail spool for mail checking.
428
429 max_port_monitor_connections
430 Allow each port monitor to track at most this many connections.
431
432 Default: 256
433
434 max_text_width seconds
435 When a line in the output contains `width' chars and the end
436 isn’t reached, the next char will start on a new line. If you
437 want to make sure that lines don’t get broken, set `width' to 0.
438
439 max_user_text seconds
440 Maximum size of user text buffer in bytes, i.e. text inside
441 conky.text section in config file.
442
443 Default: 16384
444
445 maximum_width seconds
446 Maximum width of window.
447
448 minimum_height seconds
449 Minimum height of the window.
450
451 minimum_width seconds
452 Minimum width of window.
453
454 mpd_host
455 Host of MPD server.
456
457 mpd_password
458 MPD server password.
459
460 mpd_port
461 Port of MPD server.
462
463 music_player_interval
464 Music player thread update interval.
465
466 Default: update interval
467
468 mysql_db
469 MySQL database to use.
470
471 Default: mysql
472
473 mysql_host
474 Host of MySQL server
475
476 Default: localhost
477
478 mysql_password
479 Password of the MySQL user. Place it between "-chars. When
480 this is not set there is no password used.
481
482 mysql_port
483 Port of MySQL server.
484
485 mysql_user
486 MySQL user name to use when connecting to the server. Defaults
487 to your username.
488
489 net_avg_samples
490 The number of samples to average for net data.
491
492 no_buffers
493 Subtract (file system) buffers from used memory.
494
495 nvidia_display
496 The display that the nvidia variable will used.
497
498 Default: $DISPLAY
499
500 out_to_console
501 Print text to stdout.
502
503 out_to_http
504 Let conky act as a small http-server serving its text.
505
506 out_to_ncurses
507 Print text in the console, but use ncurses so that conky can
508 print the text of a new update over the old text. (In the fu‐
509 ture this will provide more useful things).
510
511 out_to_stderr
512 Print text to stderr.
513
514 out_to_wayland
515 Open a Wayland window to display output.
516
517 out_to_x
518 When set to no, there will be no output in X (useful when you
519 also use things like out_to_console). If you set it to no, make
520 sure that it’s placed before all other X-related setting (take
521 the first line of your configfile to be sure).
522
523 Default: True
524
525 override_utf8_locale
526 Force UTF8. Requires XFT.
527
528 overwrite_file
529 Overwrite the file given as argument.
530
531 own_window
532 Boolean, create own window to draw.
533
534 own_window_argb_value
535 When ARGB visuals are enabled, this use this to modify the alpha
536 value used. Valid range is 0-255, where 0 is 0% opacity, and
537 255 is 100% opacity.
538
539 own_window_argb_visual
540 Boolean, use ARGB visual? ARGB can be used for real transparen‐
541 cy, note that a composite manager is required for real transpar‐
542 ency. This option will not work as desired (in most cases) in
543 conjunction with `own_window_type override'.
544
545 own_window_class
546 Manually set the WM_CLASS name.
547
548 Default: Conky
549
550 own_window_colour seconds
551 If own_window_transparent no, set a specified background colour.
552 Takes either a hex value (e.g. `#ffffff'), a shorthand hex value
553 (e.g. `#fff'), or a valid RGB nam (see /usr/lib/X11/rgb.txt).
554
555 Default: black
556
557 own_window_hints seconds
558 If own_window is yes, you may use these window manager hints to
559 affect the way Conky displays. Notes: Use own_window_type desk‐
560 top as another way to implement many of these hints implicitly.
561 If you use own_window_type override, window manager hints have
562 no meaning and are ignored.
563
564 own_window_title
565 Manually set the window name.
566
567 Default: conky ()
568
569 own_window_transparent
570 Boolean, set transparency? If ARGB visual is enabled, sets
571 background opacity to 0%.
572
573 own_window_type
574 if own_window is yes, you may specify type normal, desktop,
575 dock, panel, utility or override. Desktop windows are special
576 windows that have no window decorations; are always visible on
577 your desktop; do not appear in your pager or taskbar; and are
578 sticky across all workspaces. Utility windows are like desktop
579 windows, except they appear above everything else rather than
580 below. Panel windows reserve space along a desktop edge, just
581 like panels and taskbars, preventing maximized windows from
582 overlapping them. The edge is chosen based on the alignment op‐
583 tion. Override windows are not under the control of the window
584 manager. Hints are ignored. This type of window can be useful
585 for certain situations.
586
587 Default: normal
588
589 pad_percents
590 Pad percentages to this many decimals (0 = no padding).
591
592 pop3 host user pass [`-i interval (in seconds)'] [`-p port'] [“-e `com‐
593 mand'”] [`-r retries']
594 Default global POP3 server. Arguments are: `host user pass [-i
595 interval (in seconds)] [-p port] [-e `command'] [-r retries]".
596 Default port is 110, default interval is 5 minutes, and default
597 number of retries before giving up is 5. If the password is
598 supplied as ’*’, you will be prompted to enter the password when
599 Conky starts.
600
601 short_units
602 Shortens units to a single character (kiB->k, GiB->G, etc.).
603
604 show_graph_range
605 Shows the time range covered by a graph.
606
607 show_graph_scale
608 Shows the maximum value in scaled graphs.
609
610 graph_gradient_mode (rbg|hcl|hsv)
611 Changes the color space used for interpolation. Arguments are
612 hcl, hsv, and rgb (default).
613
614 Default: rgb
615
616 stippled_borders
617 Border stippling (dashing) in pixels.
618
619 store_graph_data_explicitly
620 Enable storing graph data explicitly by ID. This avoids resets
621 while using conditional colors. This option should be disabled
622 while using graphs indirectly e.g. via execpi or lua_parse.
623 Otherwise the graph stays emtpy. The default value is true.
624
625 Default: True
626
627 temperature_unit
628 Desired output unit of all objects displaying a temperature.
629 Parameters are either fahrenheit or celsius.
630
631 Default: celsius
632
633 templateN
634 Define a template for later use inside conky.text segments.
635 Substitute N by a digit between 0 and 9, inclusively. The value
636 of the variable is being inserted into the stuff inside
637 conky.text at the corresponding position, but before some sub‐
638 stitutions are applied:
639
640 • \\n -> newline
641
642 • \\ -> backslash
643
644 • \\ -> space
645
646 • \\N -> template argument N (starting from 1)
647
648 text_buffer_size seconds
649 Size of the standard text buffer (default is 256 bytes). This
650 buffer is used for intermediary text, such as individual lines,
651 output from $exec vars, and various other variables. Increasing
652 the size of this buffer can drastically reduce Conky’s perfor‐
653 mance, but will allow for more text display per variable. The
654 size of this buffer cannot be smaller than the default value of
655 256 bytes.
656
657 times_in_seconds
658 If true, variables that output times output a number that repre‐
659 sents seconds. This doesn’t affect $time, $tztime and $utime.
660
661 top_cpu_separate
662 If true, cpu in top will show usage of one processor’s power.
663 If false, cpu in top will show the usage of all processors’ pow‐
664 er combined.
665
666 top_name_verbose
667 If true, top name shows the full command line of each process,
668 including arguments (whenever possible). Otherwise, only the
669 basename is displayed. Default value is false.
670
671 top_name_width
672 Width for $top name value (defaults to 15 characters).
673
674 total_run_times
675 Total number of times for Conky to update before quitting. Zero
676 makes Conky run forever.
677
678 units_spacer
679 String to place between values and units.
680
681 update_interval seconds
682 Update interval.
683
684 update_interval_on_battery seconds
685 Update interval when running on battery power.
686
687 uppercase
688 Boolean value, if true, text is rendered in upper case.
689
690 use_spacer
691 Adds spaces around certain objects to stop them from moving oth‐
692 er things around. Arguments are left, right, and none (de‐
693 fault). The old true/false values are deprecated and default to
694 right/none respectively. Note that this only helps if you are
695 using a mono font, such as Bitstream Vera Sans Mono.
696
697 Default: none
698
699 use_xft
700 Use Xft (anti-aliased font and stuff).
701
702 xftalpha
703 Alpha of Xft font. Must be a value at or between 1 and 0.
704
705 xinerama_head
706 Specify a Xinerama head.
707
709 To configure what Conky displays, you must supply some variables in the
710 conky.text section of your configuration. In this secton you’ll find a
711 listing of the available variables. Some of them may require build op‐
712 tions to be enabled at compile time for them to work.
713
714 Colours are parsed using XParseColor(), there might be a list of them:
715 /usr/share/X11/rgb.txt. Colour can be also in #rrggbb format (hex).
716
717 Some objects may create threads, and sometimes these threads will not
718 be destroyed until Conky terminates. There is no way to destroy or
719 clean up threads while Conky is running. For example, if you use an
720 MPD variable, the MPD thread will keep running until Conky dies. Some
721 threaded objects will use one of the parameters as a key, so that you
722 only have 1 relevant thread running (for example, the $curl, and $rss
723 objects launch one thread per URI).
724
725 Optional arguments are generally denoted with paretheses (i.e., (op‐
726 tional)).
727
728 acpiacadapter (adapter)
729 ACPI AC adapter state. On linux, the adapter option specifies
730 the subfolder of /sys/class/power_supply containing the state
731 information (tries AC and ADP1 if there is no argument given).
732 Non-linux systems ignore it.
733
734 acpifan
735 ACPI fan state.
736
737 acpitemp
738 ACPI temperature in C.
739
740 addr (interface)
741 IP address for an interface, or “No Address” if no address is
742 assigned.
743
744 addrs (interface)
745 IP addresses for an interface (if one - works like addr). Linux
746 only.
747
748 adt746xcpu
749 CPU temperature from therm_adt746x.
750
751 adt746xfan
752 Fan speed from therm_adt746x.
753
754 alignc (num)
755 Align text to centre.
756
757 alignr (num)
758 Right-justify text, with space of N.
759
760 apcupsd host port
761 Sets up the connection to apcupsd daemon. Prints nothing.
762
763 Default: localhost:3551
764
765 apcupsd_cable
766 Prints the UPS connection type.
767
768 apcupsd_charge
769 Current battery capacity in percent.
770
771 apcupsd_lastxfer
772 Reason for last transfer from line to battery.
773
774 apcupsd_linev
775 Nominal input voltage.
776
777 apcupsd_load
778 Current load in percent.
779
780 apcupsd_loadbar
781 Bar showing current load.
782
783 apcupsd_loadgauge (height),(width)
784 Gauge that shows current load.
785
786 apcupsd_loadgraph (height),(width) (gradient colour 1) (gradient colour
787 2) (scale) (-t) (-l)
788 History graph of current load.
789
790 apcupsd_model
791 Prints the model of the UPS.
792
793 apcupsd_name
794 Prints the UPS user-defined name.
795
796 apcupsd_status
797 Prints current status (on-line, on-battery).
798
799 apcupsd_temp
800 Current internal temperature.
801
802 apcupsd_timeleft
803 Time left to run on battery.
804
805 apcupsd_upsmode
806 Prints the UPS mode (e.g. standalone).
807
808 apm_adapter
809 Display APM AC adapter status. FreeBSD, OpenBSD only.
810
811 apm_battery_life
812 Display APM battery life in percent. FreeBSD, OpenBSD only.
813
814 apm_battery_time
815 Display remaining APM battery life in hh:mm:ss or “unknown” if
816 AC adapterstatus is on-line or charging. FreeBSD, OpenBSD only.
817
818 audacious_bar (height),(width)
819 Progress bar.
820
821 audacious_bitrate
822 Bitrate of current tune.
823
824 audacious_channels
825 Number of audio channels of current tune.
826
827 audacious_filename
828 Full path and filename of current tune.
829
830 audacious_frequency
831 Sampling frequency of current tune.
832
833 audacious_length
834 Total length of current tune as MM:SS.
835
836 audacious_length_seconds
837 Total length of current tune in seconds.
838
839 audacious_main_volume
840 The current volume fetched from Audacious.
841
842 audacious_playlist_length
843 Number of tunes in playlist.
844
845 audacious_playlist_position
846 Playlist position of current tune.
847
848 audacious_position
849 Position of current tune (MM:SS).
850
851 audacious_position_seconds
852 Position of current tune in seconds.
853
854 audacious_status
855 Player status (Playing/Paused/Stopped/Not running).
856
857 audacious_title (max length)
858 Title of current tune with optional maximum length specifier.
859
860 battery (num)
861 Battery status and remaining percentage capacity of ACPI or APM
862 battery. ACPI battery number can be given as argument.
863
864 Default: BAT0
865
866 battery_bar (height),(width) (num)
867 Battery percentage remaining of ACPI battery in a bar. ACPI
868 battery number can be given as argument (use all to get the mean
869 percentage remaining for all batteries).
870
871 Default: BAT0
872
873 battery_percent (num)
874 Battery percentage remaining for ACPI battery. ACPI battery
875 number can be given as argument (use all to get the mean per‐
876 centage remaining for all batteries).
877
878 Default: BAT0
879
880 battery_power_draw (num)
881 Battery power draw in watts
882
883 Default: BAT0
884
885 battery_short (num)
886 Battery status and remaining percentage capacity of ACPI or APM
887 battery. ACPI battery number can be given as argument. This
888 mode display a short status, which means that C is displayed in‐
889 stead of charging, D for discharging, F for full, N for not
890 present, E for empty and U for unknown.
891
892 Default: BAT0
893
894 battery_status (num)
895 Battery status for ACPI battery. ACPI battery number can be
896 given as arguments.
897
898 Default: BAT0
899
900 battery_time (num)
901 Battery charge/discharge time remaining of ACPI battery. ACPI
902 battery number can be given as argument.
903
904 Default: BAT0
905
906 blink text_and_other_conky_vars
907 Let `text_and_other_conky_vars' blink on and off.
908
909 buffers
910 Amount of memory buffered.
911
912 cached Amount of memory cached.
913
914 cat file
915 Reads a file and displays the contents in conky. This is useful
916 if you have an independent process generating output that you
917 want to include in conky.
918
919 catp file
920 Reads a file and displays the contents in conky. This is useful
921 if you have an independent process generating output that you
922 want to include in conky. This differs from $cat in that it
923 parses the contents of the file, so you can insert things like
924 `${color red}hi!${color}` in your file and have it correctly
925 parsed by Conky.
926
927 cmdline_to_pid string
928 PID of the first process that has string in its commandline.
929
930 cmus_aaa
931 Print aaa status of cmus (all/artist/album).
932
933 cmus_album
934 Prints the album of the current cmus song.
935
936 cmus_artist
937 Prints the artist of the current cmus song.
938
939 cmus_curtime
940 Current time of the current cmus song.
941
942 cmus_date
943 Print the date of the current cmus song.
944
945 cmus_file
946 Print the file name of the current cmus song.
947
948 cmus_genre
949 Print the genre name of the current cmus song.
950
951 cmus_percent
952 Percent of song’s progress.
953
954 cmus_progress (height),(width)
955 cmus’ progress bar.
956
957 cmus_random
958 Random status of cmus (on/off).
959
960 cmus_repeat
961 Repeat status of cmus (song/all/off).
962
963 cmus_state
964 Current state of cmus (playing, paused, stopped etc).
965
966 cmus_timeleft
967 Time left of the current cmus song.
968
969 cmus_title
970 Prints the title of the current cmus song.
971
972 cmus_totaltime
973 Total length of the current cmus song.
974
975 cmus_track
976 Print track number of current cmus song.
977
978 color (color)
979 Change drawing color to color which is a name of a color or a
980 hexcode preceded with #, e.g. #0A1B2C. If you use ncurses only
981 the following colors are supported: red, green, yellow, blue,
982 magenta, cyan, black, and white.
983
984 colorN Change drawing color to colorN configuration option, where N is
985 a digit between 0 and 9, inclusively.
986
987 combine var1 var2
988 Places the lines of var2 to the right of the lines of var1 sepa‐
989 rated by the chars that are put between var1 and var2. For ex‐
990 ample: ${combine ${head /proc/cpuinfo 2} - ${head /proc/meminfo
991 1}} gives as output cpuinfo_line1 - meminfo_line1 on line 1 and
992 cpuinfo_line2 - on line 2. $combine vars can also be nested to
993 place more vars next to each other.
994
995 conky_build_arch
996 CPU architecture Conky was built for.
997
998 conky_build_date
999 Date Conky was built.
1000
1001 conky_version
1002 Conky version.
1003
1004 cpu (cpuN)
1005 CPU usage in percents. For SMP machines, the CPU number can be
1006 provided as an argument. ${cpu cpu0} is the total usage, and
1007 ${cpu cpuX} (X >= 1) are individual CPUs.
1008
1009 cpubar (cpuN) (height),(width)
1010 Bar that shows CPU usage, height is bar’s height in pixels. See
1011 $cpu for more info on SMP.
1012
1013 cpugauge (cpuN) (height),(width)
1014 Elliptical gauge that shows CPU usage, height and width are
1015 gauge’s vertical and horizontal axis respectively. See $cpu for
1016 more info on SMP.
1017
1018 cpugovernor (cpuN)
1019 The active CPU scaling governor, defaulting to the first core.
1020 See $cpu for more info on SMP. Linux only.
1021
1022 cpugraph (cpuN) (height),(width) (gradient colour 1) (gradient colour
1023 2) (scale) (-t) (-l)
1024 CPU usage graph, with optional colours in hex, minus the #. See
1025 $cpu for more info on SMP. Uses a logarithmic scale (to see
1026 small numbers) when you use the -l switch. Takes the switch
1027 `-t' to use a temperature gradient, which makes the gradient
1028 values change depending on the amplitude of a particular graph
1029 value (try it and see).
1030
1031 curl url (interval_in_minutes)
1032 Download data from URI using Curl at the specified interval.
1033 The interval may be a positive floating point value (0 is al‐
1034 lowed), otherwise defaults to 15 minutes. Most useful when used
1035 in conjunction with Lua and the Lua API. This object is thread‐
1036 ed, and once a thread is created it can’t be explicitly de‐
1037 stroyed. One thread will run for each URI specified. You can
1038 use any protocol that Curl supports.
1039
1040 desktop
1041 Number of the desktop on which conky is running or the message
1042 “Not running in X” if this is the case.
1043
1044 desktop_name
1045 Name of the desktop on which conky is running or the message
1046 “Not running in X” if this is the case.
1047
1048 desktop_number
1049 Number of desktops or the message “Not running in X” if this is
1050 the case.
1051
1052 disk_protect device
1053 Disk protection status, if supported (needs kernel-patch).
1054 Prints either “frozen” or “free” (note the padding).
1055
1056 diskio (device)
1057 Displays current disk IO. Device is optional, and takes the
1058 form of sda for /dev/sda. A block device label can be specified
1059 with label:foo and a block device partuuid can be specified with
1060 partuuid:40000000-01.
1061
1062 diskio_read (device)
1063 Displays current disk IO for reads. Device as in diskio.
1064
1065 diskio_write (device)
1066 Displays current disk IO for writes. Device as in diskio.
1067
1068 diskiograph (device) (height),(width) (gradient colour 1) (gradient
1069 colour 2) (scale) (-t) (-l)
1070 Disk IO graph, colours defined in hex, minus the #. If scale is
1071 non-zero, it becomes the scale for the graph. Uses a logarith‐
1072 mic scale (to see small numbers) when you use -l switch. Takes
1073 the switch `-t' to use a temperature gradient, which makes the
1074 gradient values change depending on the amplitude of a particu‐
1075 lar graph value (try it and see).
1076
1077 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi‐
1078 ent colour 2) (scale) (-t) (-l)
1079 Disk IO graph for reads, colours defined in hex, minus the #.
1080 If scale is non-zero, it becomes the scale for the graph. De‐
1081 vice as in diskio. Uses a logarithmic scale (to see small num‐
1082 bers) when you use -l switch. Takes the switch `-t' to use a
1083 temperature gradient, which makes the gradient values change de‐
1084 pending on the amplitude of a particular graph value (try it and
1085 see).
1086
1087 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi‐
1088 ent colour 2) (scale) (-t) (-l)
1089 Disk IO graph for writes, colours defined in hex, minus the #.
1090 If scale is non-zero, it becomes the scale for the graph. De‐
1091 vice as in diskio. Uses a logarithmic scale (to see small num‐
1092 bers) when you use -l switch. Takes the switch `-t' to use a
1093 temperature gradient, which makes the gradient values change de‐
1094 pending on the amplitude of a particular graph value (try it and
1095 see).
1096
1097 distribution
1098 The name of the distribution. It could be that some of the
1099 untested distributions will show up wrong or as “unknown”, if
1100 that’s the case post a bug on sourceforge, make sure it contains
1101 the name of your distribution, the contents of and if there is a
1102 file that only exists on your distribution, also add the path of
1103 that file in the bug. If there is no such file, please add an‐
1104 other way which we can use to identify your distribution.
1105
1106 downspeed (net)
1107 Download speed in suitable IEC units.
1108
1109 downspeedf (net)
1110 Download speed in KiB with one decimal.
1111
1112 downspeedgraph (netdev) (height),(width) (gradient colour 1) (gradient
1113 colour 2) (scale) (-t) (-l)
1114 Download speed graph, colours defined in hex, minus the #. If
1115 scale is non-zero, it becomes the scale for the graph. Uses a
1116 logarithmic scale (to see small numbers) when you use -l switch.
1117 Takes the switch `-t' to use a temperature gradient, which makes
1118 the gradient values change depending on the amplitude of a par‐
1119 ticular graph value (try it and see).
1120
1121 draft_mails (maildir) (interval)
1122 Number of mails marked as draft in the specified mailbox or mail
1123 spool if not. Only maildir type mailboxes are supported, mbox
1124 type will return -1.
1125
1126 else Text to show if any of the above are not true.
1127
1128 endif Ends an $if block.
1129
1130 entropy_avail
1131 Current entropy available for crypto freaks.
1132
1133 entropy_bar (height),(width)
1134 Normalized bar of available entropy for crypto freaks.
1135
1136 entropy_perc
1137 Percentage of entropy available in comparison to the poolsize.
1138
1139 entropy_poolsize
1140 Total size of system entropy pool for crypto freaks.
1141
1142 eval string
1143 Evaluates given string according to the rules of conky.text in‐
1144 terpretation, i.e. parsing any contained text object specifica‐
1145 tions into their output, any occurring `$′intoasingle′' and so
1146 on. The output is then being parsed again.
1147
1148 exec command
1149 Executes a shell command and displays the output in conky.
1150 Warning: this takes a lot more resources than other variables.
1151 I’d recommend coding wanted behaviour in C/C++ and posting a
1152 patch.
1153
1154 execbar (height),(width) command
1155 Same as exec, except if the first value returned is a value be‐
1156 tween 0-100, it will use that number to draw a horizontal bar.
1157 The height and width parameters are optional, and default to the
1158 default_bar_height and default_bar_width config settings, re‐
1159 spectively.
1160
1161 execgauge (height),(width) command
1162 Same as exec, except if the first value returned is a value be‐
1163 tween 0-100, it will use that number to draw a round gauge (much
1164 like a vehicle speedometer). The height and width parameters
1165 are optional, and default to the default_gauge_height and de‐
1166 fault_gauge_width config settings, respectively.
1167
1168 execgraph command (height),(width) (gradient color 1) (gradient color
1169 2) (scale) (-t) (-l)
1170 Draws a horizontally scrolling graph with values from 0-100
1171 plotted on the vertical axis. All parameters following the com‐
1172 mand are optional. Gradient colors can be specified as hexadec‐
1173 imal values with no 0x or # prefix. Use the -t switch to enable
1174 a temperature gradient, so that small values are “cold” with
1175 color 1 and large values are “hot” with color 2. Without the -t
1176 switch, the colors produce a horizontal gradient spanning the
1177 width of the graph. The scale parameter defines the maximum
1178 value of the graph. Use the -l switch to enable a logarithmic
1179 scale, which helps to see small values. The default size for
1180 graphs can be controlled via the default_graph_height and de‐
1181 fault_graph_width config settings.
1182
1183 If you need to execute a command with spaces, you have a couple
1184 options:
1185
1186 1. wrap your command in double-quotes, or
1187
1188 2. put your command into a separate file, such as
1189 ~/bin/myscript.sh, and use that as your execgraph command.
1190
1191 Remember to make your script executable!
1192
1193 In the following example, we set up execgraph to display seconds
1194 (0-59) on a graph that is 50px high and 200px wide, using a tem‐
1195 perature gradient with colors ranging from red for small values
1196 (FF0000) to yellow for large values (FFFF00). We set the scale
1197 to 60.
1198
1199 ${execgraph ~/seconds.sh 50,200 FF0000 FFFF00 60 -t}
1200
1201 execi interval command
1202 Same as exec, but with a specific interval in seconds. The in‐
1203 terval can’t be less than the update_interval in your configura‐
1204 tion. See also $texeci.
1205
1206 execibar interval (height),(width) command
1207 Same as execbar, but with an interval.
1208
1209 execigauge interval (height),(width) command
1210 Same as execgauge, but with an interval.
1211
1212 execigraph interval command (height),(width) (gradient color 1) (gradi‐
1213 ent color 2) (scale) (-t) (-l)
1214 Same as execgraph, but with an interval.
1215
1216 execp command
1217 Executes a shell command and displays the output in conky.
1218 Warning: this takes a lot more resources than other variables.
1219 I’d recommend coding wanted behaviour in C/C++ and posting a
1220 patch. This differs from $exec in that it parses the output of
1221 the command, so you can insert things like `${color
1222 red}hi!${color}` in your script and have it correctly parsed by
1223 Conky. Caveats: Conky parses and evaluates the output of $execp
1224 every time Conky loops, and then destroys all the objects. If
1225 you try to use anything like $execi within an $execp statement,
1226 it will functionally run at the same interval that the $execp
1227 statement runs, as it is created and destroyed at every inter‐
1228 val.
1229
1230 execpi interval command
1231 Same as execp, but with an interval. Note that the output from
1232 the $execpi command is still parsed and evaluated at every in‐
1233 terval.
1234
1235 flagged_mails (maildir) (interval)
1236 Number of mails marked as flagged in the specified mailbox or
1237 mail spool if not. Only maildir type mailboxes are supported,
1238 mbox type will return -1.
1239
1240 font (font)
1241 Specify a different font. This new font will apply to the cur‐
1242 rent line and everything following. You can use a $font with no
1243 arguments to change back to the default font (much like with
1244 $color).
1245
1246 fontN Change font to fontN configuration option, where N is a digit
1247 between 0 and 9, inclusively.
1248
1249 format_time seconds format
1250 Format time given in seconds. This var only works when the
1251 times_in_seconds configuration setting is on. Format is a
1252 string that should start and end with a double quote " charac‐
1253 ter. The quote characters are not part of the output, ,,,(,)
1254 and \ are replaced by weeks,days,hours,minutes,seconds,(,) and .
1255 If you leave out a unit, it’s value will be expressed in the
1256 highest unit lower than the one left out. Text between ()-chars
1257 will not be visible if a replaced unit in this text is 0. If
1258 seconds is a decimal number then you can see the numbers behind
1259 the point by using followed by a number that specifies the
1260 amount of digits behind the point that you want to see (maximum
1261 9). You can also place a `x' behind so you have all digits be‐
1262 hind the point and no trailing zero’s. (also maximum 9).
1263
1264 forwarded_mails (maildir) (interval)
1265 Number of mails marked as forwarded in the specified mailbox or
1266 mail spool if not. Only maildir type mailboxes are supported,
1267 mbox type will return -1.
1268
1269 free_bufcache
1270 Amount of memory cached or buffered, as reported by free. Linux
1271 only.
1272
1273 freq (n)
1274 Returns CPU #n’s frequency in MHz. CPUs are counted from 1.
1275
1276 Default: 1
1277
1278 freq2 (n)
1279 Returns CPU #n’s clock speed from assembly in MHz. CPUs are
1280 counted from 1.
1281
1282 Default: 1
1283
1284 freq_g (n)
1285 Returns CPU #n’s frequency in GHz. CPUs are counted from 1.
1286
1287 Default: 1
1288
1289 fs_bar (height),(width) fs
1290 Bar that shows how much space is used on a file system. height
1291 is the height in pixels. fs is any file on that file system.
1292
1293 fs_bar_free (height),(width) fs
1294 Bar that shows how much space is free on a file system. height
1295 is the height in pixels. fs is any file on that file system.
1296
1297 fs_free (fs)
1298 Free space on a file system available for users.
1299
1300 fs_free_perc (fs)
1301 Free percentage of space on a file system available for users.
1302
1303 fs_size (fs)
1304 File system size.
1305
1306 fs_type (fs)
1307 File system type.
1308
1309 fs_used (fs)
1310 File system used space.
1311
1312 fs_used_perc (fs)
1313 Percent of file system used space.
1314
1315 gid_name gid
1316 Name of group with this gid.
1317
1318 github_notifications
1319 Number of GitHub notifications.
1320
1321 goto x The next element will be printed at position `x'.
1322
1323 gw_iface
1324 Displays the default route’s interface or “multiple”/“none” ac‐
1325 cordingly.
1326
1327 gw_ip Displays the default gateway’s IP or “multiple”/“none” accord‐
1328 ingly.
1329
1330 hddtemp (dev)
1331 Displays temperature of a selected hard disk drive as reported
1332 by the hddtemp daemon. Use hddtemp_host and hddtemp_port to
1333 specify a host and port for all hddtemp objects. If no dev pa‐
1334 rameter is given, the first disk returned by the hddtemp daemon
1335 is used.
1336
1337 head logfile lines (next_check)
1338 Displays first N lines of supplied text file. The file is
1339 checked every `next_check' update. If next_check is not sup‐
1340 plied, Conky defaults to 2. Max of 30 lines can be displayed,
1341 or until the text buffer is filled.
1342
1343 hr (height)
1344 Horizontal line, height is the height in pixels.
1345
1346 hwmon (dev) type n (factor offset)
1347 Hwmon sensor from sysfs (Linux 2.6). Parameter dev can be: 1.
1348 Number. e.g 1 means hwmon1. 2. Module name. e.g. k10temp
1349 means the first hwmon device whose module name is `k10temp. 3.
1350 Omitted. Then the first hwmon device (hwmon0) will be used.
1351
1352 Parameter type is either in or vol meaning voltage; fan meaning
1353 fan; temp meaning temperature. Parameter n is number of the
1354 sensor. See /sys/class/hwmon/ on your local computer. The op‐
1355 tional arguments factor and offset allow precalculation of the
1356 raw input, which is being modified as follows: input = input *
1357 factor + offset. Note that they have to be given as decimal
1358 values (i.e. contain at least one decimal place).
1359
1360 i2c (dev) type n (factor offset)
1361 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
1362 if you have only one I2C device. Parameter type is either in or
1363 vol meaning voltage; fan meaning fan; temp meaning temperature.
1364 Parameter n is number of the sensor. See /sys/bus/i2c/devices/
1365 on your local computer. The optional arguments factor and off‐
1366 set allow precalculation of the raw input, which is being modi‐
1367 fied as follows: input = input * factor + offset. Note that
1368 they have to be given as decimal values (i.e. contain at least
1369 one decimal place).
1370
1371 i8k_ac_status
1372 If running the i8k kernel driver for Inspiron laptops, displays
1373 whether ac power is on, as listed in /proc/i8k (translated to
1374 human-readable). Beware that this is by default not enabled by
1375 i8k itself.
1376
1377 i8k_bios
1378 If running the i8k kernel driver for Inspiron laptops, displays
1379 the bios version as listed in /proc/i8k.
1380
1381 i8k_buttons_status
1382 If running the i8k kernel driver for Inspiron laptops, displays
1383 the volume buttons status as listed in /proc/i8k.
1384
1385 i8k_cpu_temp
1386 If running the i8k kernel driver for Inspiron laptops, displays
1387 the cpu temperature in Celsius, as reported by /proc/i8k.
1388
1389 i8k_left_fan_rpm
1390 If running the i8k kernel driver for Inspiron laptops, displays
1391 the left fan’s rate of rotation, in revolutions per minute as
1392 listed in /proc/i8k. Beware, some laptops i8k reports these
1393 fans in reverse order.
1394
1395 i8k_left_fan_status
1396 If running the i8k kernel driver for Inspiron laptops, displays
1397 the left fan status as listed in /proc/i8k (translated to human-
1398 readable). Beware, some laptops i8k reports these fans in re‐
1399 verse order.
1400
1401 i8k_right_fan_rpm
1402 If running the i8k kernel driver for Inspiron laptops, displays
1403 the right fan’s rate of rotation, in revolutions per minute as
1404 listed in /proc/i8k. Beware, some laptops i8k reports these
1405 fans in reverse order.
1406
1407 i8k_right_fan_status
1408 If running the i8k kernel driver for Inspiron laptops, displays
1409 the right fan status as listed in /proc/i8k (translated to hu‐
1410 man-readable). Beware, some laptops i8k reports these fans in
1411 reverse order.
1412
1413 i8k_serial
1414 If running the i8k kernel driver for Inspiron laptops, displays
1415 your laptop serial number as listed in /proc/i8k.
1416
1417 i8k_version
1418 If running the i8k kernel driver for Inspiron laptops, displays
1419 the version formatting of /proc/i8k.
1420
1421 ibm_brightness
1422 If running the IBM ACPI, displays the brigtness of the laptops’s
1423 LCD (0-7).
1424
1425 ibm_fan
1426 If running the IBM ACPI, displays the fan speed.
1427
1428 ibm_temps N
1429 If running the IBM ACPI, displays the temperatures from the IBM
1430 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1431 GPU.
1432
1433 ibm_thinklight
1434 If running the IBM ACPI, displays the status of your Think‐
1435 Light™. Value is either `on', `off' or `unknown'.
1436
1437 ibm_volume
1438 If running the IBM ACPI, displays the “master” volume, con‐
1439 trolled by the volume keys (0-14).
1440
1441 ical number file
1442 Shows title of event number `number' in the ical (RFC 5545) file
1443 `file'. The events are first ordered by starting time, events
1444 that started in the past are ignored. The events that are shown
1445 are the VEVENTS, the title that is shown is the SUMMARY and the
1446 starting time used for sorting is DTSTART.
1447
1448 iconv_start codeset_from codeset_to
1449 Convert text from one codeset to another using GNU iconv. Needs
1450 to be stopped with iconv_stop.
1451
1452 iconv_stop
1453 Stop iconv codeset conversion.
1454
1455 if_empty (var)
1456 if conky variable VAR is empty, display everything between
1457 $if_empty and the matching $endif.
1458
1459 if_existing file (string)
1460 if FILE exists, display everything between if_existing and the
1461 matching $endif. The optional second parameter checks for FILE
1462 containing the specified string and prints everything between
1463 $if_existing and the matching $endif.
1464
1465 if_gw if there is at least one default gateway, display everything be‐
1466 tween $if_gw and the matching $endif.
1467
1468 if_match expression
1469 Evaluates the given boolean expression, printing everything be‐
1470 tween $if_match and the matching $endif depending on whether the
1471 evaluation returns true or not. Valid expressions consist of a
1472 left side, an operator and a right side. Left and right sides
1473 are being parsed for contained text objects before evaluation.
1474
1475 Recognised left and right side types are:
1476
1477 • double: Argument consists of only digits and a single dot.
1478
1479 • long: Argument consists of only digits.
1480
1481 • string: Argument is enclosed in quotation marks (").
1482
1483 Valid operands are:
1484
1485 • < or >
1486
1487 • <= or >=
1488
1489 • == or !=
1490
1491 if_mixer_mute (mixer)
1492 If mixer exists, display everything between $if_mixer_mute and
1493 the matching $endif. If no mixer is specified, “Vol” is used.
1494
1495 if_mounted (mountpoint)
1496 if MOUNTPOINT is mounted, display everything between $if_mounted
1497 and the matching $endif.
1498
1499 if_mpd_playing
1500 if mpd is playing or paused, display everything between
1501 $if_mpd_playing and the matching $endif.
1502
1503 if_pa_sink_muted
1504 If Pulseaudio’s default sink is muted, display everything be‐
1505 tween $if_pa_sink_muted and the corresponding $else or $endif.
1506
1507 if_running (process)
1508 If PROCESS is running, display everything between $if_running
1509 and the corresponding $else or $endif. Note that PROCESS may be
1510 either a full command line with arguments (without the directory
1511 prefix), or simply the name of an executable. For example, ei‐
1512 ther of the following will be true if there is a running process
1513 with the command line /usr/bin/conky -u 5:
1514
1515 • ${if_running conky -u 5} or
1516
1517 • ${if_running conky}
1518
1519 It is important not to include trailing spaces. For example,
1520 ${if_running conky } will be false.
1521
1522 if_smapi_bat_installed (INDEX)
1523 when using smapi, if the battery with index INDEX is installed,
1524 display everything between $if_smapi_bat_installed and the
1525 matching $endif.
1526
1527 if_up (interface)
1528 if INTERFACE exists and is up, display everything between $if_up
1529 and the matching $endif.
1530
1531 if_updatenr (updatenr)
1532 If it’s the UPDATENR-th time that conky updates, display every‐
1533 thing between $if_updatenr and the matching $endif. The counter
1534 resets when the highest UPDATENR is reached.
1535
1536 Example: {$if_updatenr 1}foo$endif{$if_updatenr 2}bar$en‐
1537 dif{$if_updatenr 4}$endif shows foo 25% of the time followed by
1538 bar 25% of the time followed by nothing the other half of the
1539 time.
1540
1541 if_xmms2_connected
1542 Display everything between $if_xmms2_connected and the matching
1543 $endif if xmms2 is running.
1544
1545 iface (number)
1546 Display interface names starting from 1, eg ${iface 1}.
1547
1548 image (-p x,y) (-s WxH) (-n) (-f interval)
1549 Renders an image from the path specified using Imlib2. Takes 4
1550 optional arguments: a position, a size, a no-cache switch, and a
1551 cache flush interval. Changing the x,y position will move the
1552 position of the image, and changing the WxH will scale the im‐
1553 age. If you specify the no-cache flag (-n), the image will not
1554 be cached. Alternately, you can specify the -f int switch to
1555 specify a cache flush interval for a particular image. Example:
1556 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200} will
1557 render `cheeseburger.jpg' at (20,20) scaled to 200x200 pixels.
1558 Conky does not make any attempt to adjust the position (or any
1559 other formatting) of images, they are just rendered as per the
1560 arguments passed. The only reason $image is part of the
1561 conky.text section, is to allow for runtime modifications,
1562 through $execp $lua_parse, or some other method.
1563
1564 imap_messages (args)
1565 Displays the number of messages in your global IMAP inbox by de‐
1566 fault. You can define individual IMAP inboxes separately by
1567 passing arguments to this object. Arguments are: “host user
1568 pass [-i interval (in seconds)] [-f `folder'] [-p port] [-e
1569 `command'] [-r retries]”. Default port is 143, default folder
1570 is `INBOX', default interval is 5 minutes, and default number of
1571 retries before giving up is 5. If the password is supplied as
1572 ’*’, you will be prompted to enter the password when Conky
1573 starts.
1574
1575 imap_unseen (args)
1576 Displays the number of unseen messages in your global IMAP inbox
1577 by default. You can define individual IMAP inboxes separately
1578 by passing arguments to this object. Arguments are: “host user
1579 pass [-i interval (in seconds)] [-f `folder'] [-p port] [-e
1580 `command'] [-r retries]”. Default port is 143, default folder
1581 is `INBOX', default interval is 5 minutes, and default number of
1582 retries before giving up is 5. If the password is supplied as
1583 ’*’, you will be prompted to enter the password when Conky
1584 starts.
1585
1586 intel_backlight
1587 Display the brightness of your Intel backlight in percent.
1588
1589 ioscheduler disk
1590 Prints the current ioscheduler used for the given disk name
1591 (i.e. e.g. “hda” or “sdb”).
1592
1593 irc server(:port) #channel (max_msg_lines)
1594 Shows everything that’s being told in #channel on IRCserver
1595 `server'. TCP-port 6667 is used for the connection unless
1596 `port' is specified. Shows everything since the last time or
1597 the last `max_msg_lines' entries if specified.
1598
1599 journal lines (type)
1600 Displays last N lines of the systemd journal. The optional type
1601 can be `user' or `system' which will show only the user or sys‐
1602 tem journal respectively. By default, all journal lines visible
1603 to the user are shown. A maximum of 200 lines can be displayed,
1604 or until the text buffer is filled.
1605
1606 kernel Kernel version.
1607
1608 key_caps_lock
1609 An indicator for Capital Lock key.
1610
1611 key_num_lock
1612 An indicator for Number Lock key.
1613
1614 key_scroll_lock
1615 An indicator for Scrolling Lock key.
1616
1617 keyboard_layout
1618 Display keyboard layout.
1619
1620 laptop_mode
1621 The value of /proc/sys/vm/laptop_mode.
1622
1623 legacymem
1624 Amount of memory used, calculated the same way as in the free
1625 program.
1626
1627 lines textfile
1628 Displays the number of lines in the given file.
1629
1630 loadavg (1|2|3)
1631 System load average, 1 is for past 1 minute, 2 for past 5 min‐
1632 utes and 3 for past 15 minutes. Without argument, prints all
1633 three values separated by whitespace.
1634
1635 loadgraph (height),(width) (gradient colour 1) (gradient colour 2)
1636 (scale) (-t) (-l)
1637 Load1 average graph, similar to xload, with optional colours in
1638 hex, minus the #. Uses a logarithmic scale (to see small num‐
1639 bers) when you use the -l switch. Takes the switch `-t' to use
1640 a temperature gradient, which makes the gradient values change
1641 depending on the amplitude of a particular graph value (try it
1642 and see).
1643
1644 lowercase text
1645 Converts all letters into lowercase.
1646
1647 lua function_name (function parameters)
1648 Executes a Lua function with given parameters, then prints the
1649 returned string. See also `lua_load' on how to load scripts.
1650 Conky puts `conky_' in front of function_name to prevent acci‐
1651 dental calls to the wrong function unless you place `conky_' in
1652 front of it yourself.
1653
1654 lua_bar (height,width) function_name (function parameters)
1655 Executes a Lua function with given parameters and draws a bar.
1656 Expects result value to be an integer between 0 and 100. See
1657 also `lua_load' on how to load scripts. Conky puts `conky_' in
1658 front of function_name to prevent accidental calls to the wrong
1659 function unless you place `conky_' in front of it yourself.
1660
1661 lua_gauge (height,width) function_name (function parameters)
1662 Executes a Lua function with given parameters and draws a gauge.
1663 Expects result value to be an integer between 0 and 100. See
1664 also `lua_load' on how to load scripts. Conky puts `conky_' in
1665 front of function_name to prevent accidental calls to the wrong
1666 function unless you place `conky_' in front of it yourself.
1667
1668 lua_graph function_name (height),(width) (gradient colour 1) (gradient
1669 colour 2) (scale) (-t) (-l)
1670 Executes a Lua function with and draws a graph. Expects result
1671 value to be any number, and by default will scale to show the
1672 full range. See also `lua_load' on how to load scripts. Takes
1673 the switch `-t' to use a temperature gradient, which makes the
1674 gradient values change depending on the amplitude of a particu‐
1675 lar graph value (try it and see). Conky puts `conky_' in front
1676 of function_name to prevent accidental calls to the wrong func‐
1677 tion unless you put you place `conky_' in front of it yourself.
1678
1679 lua_parse function_name (function parameters)
1680 Executes a Lua function with given parameters as per $lua, then
1681 parses and prints the result value as per the syntax for the
1682 conky.text section. See also `lua_load' on how to load scripts.
1683 Conky puts `conky_' in front of function_name to prevent acci‐
1684 dental calls to the wrong function unless you place `conky_' in
1685 front of it yourself.
1686
1687 machine
1688 Machine, e.g. i686, x86_64.
1689
1690 mails (mailbox) (interval)
1691 Mail count in the specified mailbox or your mail spool if not.
1692 Both mbox and maildir type mailboxes are supported. You can use
1693 a program like fetchmail to get mails from some server using
1694 your favourite protocol. See also new_mails.
1695
1696 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1697 width) mbox
1698 Print a summary of recent messages in an mbox format mailbox.
1699 mbox parameter is the filename of the mailbox (can be encapsu‐
1700 lated using ’“’, ie. ${mboxscan -n 10”/home/brenden/some box”}
1701
1702 mem Amount of memory in use.
1703
1704 memactive
1705 Amount of active memory. FreeBSD only.
1706
1707 memavail
1708 Amount of available memory as recorded in /proc/meminfo. Linux
1709 3.14+ only.
1710
1711 membar (height),(width)
1712 Bar that shows amount of memory in use.
1713
1714 memdirty
1715 Amount of “dirty” memory. Linux only.
1716
1717 memeasyfree
1718 Amount of free memory including the memory that is very easily
1719 freed (buffers/cache).
1720
1721 memfree
1722 Amount of free memory.
1723
1724 memgauge (height),(width)
1725 Gauge that shows amount of memory in use (see cpugauge).
1726
1727 memgraph (height),(width) (gradient colour 1) (gradient colour 2)
1728 (scale) (-t) (-l)
1729 Memory usage graph. Uses a logarithmic scale (to see small num‐
1730 bers) when you use the -l switch. Takes the switch `-t' to use
1731 a temperature gradient, which makes the gradient values change
1732 depending on the amplitude of a particular graph value (try it
1733 and see).
1734
1735 meminactive
1736 Amount of inactive memory. FreeBSD only.
1737
1738 memlaundry
1739 Amount of memory in the laundry queue. FreeBSD only.
1740
1741 memmax Total amount of memory.
1742
1743 memperc
1744 Percentage of memory in use.
1745
1746 memwired
1747 Amount of wired memory. FreeBSD only.
1748
1749 memwithbuffers
1750 Amount of memory in use, including that used by system buffers
1751 and caches.
1752
1753 memwithbuffersbar (height),(width)
1754 Bar that shows amount of memory in use (including memory used by
1755 system buffers and caches).
1756
1757 memwithbuffersgraph (height),(width) (gradient colour 1) (gradient
1758 colour 2) (scale) (-t) (-l)
1759 Memory usage graph including memory used by system buffers and
1760 cache. Uses a logarithmic scale (to see small numbers) when you
1761 use the -l switch. Takes the switch `-t' to use a temperature
1762 gradient, which makes the gradient values change depending on
1763 the amplitude of a particular graph value (try it and see).
1764
1765 mixer (device)
1766 Prints the mixer value as reported by the OS. On Linux, this
1767 variable uses the OSS emulation, so you need the proper kernel
1768 module loaded. Default mixer is “Vol”, but you can specify one
1769 of the available OSS controls: “Vol”, “Bass”, “Trebl”, “Synth”,
1770 “Pcm”, “Spkr”, “Line”, “Mic”, “CD”, “Mix”, “Pcm2”, “Rec”,
1771 “IGain”, “OGain”, “Line1”, “Line2”, “Line3”, “Digital1”, “Digi‐
1772 tal2”, “Digital3”, “PhoneIn”, “PhoneOut”, “Video”, “Radio” and
1773 “Monitor”.
1774
1775 Default: Vol
1776
1777 mixerbar (device)
1778 Displays mixer value in a bar as reported by the OS. See docs
1779 for $mixer for details on arguments.
1780
1781 mixerl (device)
1782 Prints the left channel mixer value as reported by the OS. See
1783 docs for $mixer for details on arguments.
1784
1785 mixerlbar (device)
1786 Displays the left channel mixer value in a bar as reported by
1787 the OS. See docs for $mixer for details on arguments.
1788
1789 mixerr (device)
1790 Prints the right channel mixer value as reported by the OS. See
1791 docs for $mixer for details on arguments.
1792
1793 mixerrbar (device)
1794 Displays the right channel mixer value in a bar as reported by
1795 the OS. See docs for $mixer for details on arguments.
1796
1797 moc_album
1798 Album of the current MOC song.
1799
1800 moc_artist
1801 Artist of the current MOC song.
1802
1803 moc_bitrate
1804 Bitrate in the current MOC song.
1805
1806 moc_curtime
1807 Current time of the current MOC song.
1808
1809 moc_file
1810 File name of the current MOC song.
1811
1812 moc_rate
1813 Rate of the current MOC song.
1814
1815 moc_song
1816 The current song name being played in MOC.
1817
1818 moc_state
1819 Current state of MOC; playing, stopped etc.
1820
1821 moc_timeleft
1822 Time left in the current MOC song.
1823
1824 moc_title
1825 Title of the current MOC song.
1826
1827 moc_totaltime
1828 Total length of the current MOC song.
1829
1830 monitor
1831 Number of the monitor on which conky is running or the message
1832 “Not running in X” if this is the case.
1833
1834 monitor_number
1835 Number of monitors or the message “Not running in X” if this is
1836 the case.
1837
1838 mouse_speed
1839 Display mouse speed.
1840
1841 mpd_album
1842 Album in current MPD song.
1843
1844 mpd_albumartist
1845 Artist of the album of the current MPD song.
1846
1847 mpd_artist
1848 Artist in current MPD song must be enabled at compile.
1849
1850 mpd_bar (height),(width)
1851 Bar of mpd’s progress.
1852
1853 mpd_bitrate
1854 Bitrate of current song.
1855
1856 mpd_comment (max length)
1857 Comment of current MPD song.
1858
1859 mpd_date
1860 Date of current song.
1861
1862 mpd_elapsed
1863 Song’s elapsed time.
1864
1865 mpd_file
1866 Prints the file name of the current MPD song.
1867
1868 mpd_length
1869 Song’s length.
1870
1871 mpd_name
1872 Prints the MPD name field.
1873
1874 mpd_percent
1875 Percent of song’s progress.
1876
1877 mpd_random
1878 Random status (On/Off).
1879
1880 mpd_repeat
1881 Repeat status (On/Off).
1882
1883 mpd_smart (max length)
1884 Prints the song name in either the form “artist - title” or file
1885 name, depending on whats available.
1886
1887 mpd_status
1888 Playing, stopped, et cetera.
1889
1890 mpd_title (max length)
1891 Title of current MPD song.
1892
1893 mpd_track
1894 Prints the MPD track field.
1895
1896 mpd_vol
1897 MPD’s volume.
1898
1899 mysql query
1900 Shows the first field of the first row of the result of the
1901 query.
1902
1903 nameserver (index)
1904 Print a nameserver from /etc/resolv.conf.
1905
1906 new_mails (mailbox) (interval)
1907 Unread mail count in the specified mailbox or mail spool if not.
1908 Both mbox and maildir type mailboxes are supported.
1909
1910 no_update text
1911 Shows text and parses the vars in it, but doesn’t update them.
1912 Use this for things that do not change while conky is running,
1913 like $machine, $conky_version,... By not updating this you can
1914 save some resources.
1915
1916 nodename
1917 Hostname.
1918
1919 nodename_short
1920 Short hostname (same as `hostname -s' shell command).
1921
1922 nvidia argument (GPU_ID)
1923 Nvidia graphics card information via the XNVCtrl library.
1924
1925 Temperatures are printed as float, all other values as integers.
1926
1927 GPU_ID: Optional parameter to choose the GPU to be used as
1928 0,1,2,3,.. Default parameter is 0
1929
1930 Possible arguments:
1931
1932 Argument Alias Description
1933 ─────────────────────────────────────────────────────────────────────────────
1934 gputemp temp GPU temperature
1935 gputempthresh‐ threshold Temperature threshold where the GPU will re‐
1936 old duce its clock speed
1937 ambienttemp ambient Ambient temperature outside the graphics card
1938 gpufreqcur gpufreq Current GPU clock speed
1939 gpufreqmin Minimum GPU clock speed
1940 gpufreqmax Maximum GPU clock speed
1941 memfreqcur memfreq Current memory clock speed
1942 memfreqmin Minimum memory clock speed
1943 memfreqmax Maximum memory clock speed
1944 mtrfreqcur mtrfreq Current memory transfer rate clock speed
1945 mtrfreqmin Minimum memory transfer rate clock speed
1946 mtrfreqmax Maximum memory transfer rate clock speed
1947 perflevelcur perflevel Current performance level
1948 perflevelmin Lowest performance level
1949 perflevelmax Highest performance level
1950 perfmode Performance mode
1951 gpuutil GPU utilization %
1952 membwutil Memory bandwidth utilization %
1953 videoutil Video engine utilization %
1954 pcieutil PCIe bandwidth utilization %
1955 memused mem Amount of used memory
1956 memfree memavail Amount of free memory
1957 memmax memtotal Total amount of memory
1958 memutil memperc Memory utilization %
1959 fanspeed Fan speed
1960 fanlevel Fan level %
1961 imagequality Image quality
1962 modelname Model name of the GPU card
1963 driverversion Driver version
1964
1965 nvidiabar (height),(width) argument (GPU_ID)
1966 Same as nvidia, except it draws its output in a horizontal bar.
1967 The height and width parameters are optional, and default to the
1968 default_bar_height and default_bar_width config settings, re‐
1969 spectively.
1970
1971 GPU_ID: Optional parameter to choose the GPU to be used as
1972 0,1,2,3,.. Default parameter is 0
1973
1974 Note the following arguments are incompatible:
1975
1976 • gputempthreshold (threshold)
1977
1978 • gpufreqmin
1979
1980 • gpufreqmax
1981
1982 • memfreqmin
1983
1984 • memfreqmax
1985
1986 • mtrfreqmin
1987
1988 • mtrfreqmax
1989
1990 • perflevelmin
1991
1992 • perflevelmax
1993
1994 • perfmode
1995
1996 • memtotal (memmax)
1997
1998 • fanspeed
1999
2000 nvidiagauge (height),(width) argument (GPU_ID)
2001 Same as nvidiabar, except a round gauge (much like a vehicle
2002 speedometer). The height and width parameters are optional, and
2003 default to the default_gauge_height and default_gauge_width con‐
2004 fig settings, respectively.
2005
2006 GPU_ID: Optional parameter to choose the GPU to be used as
2007 0,1,2,3,.. Default parameter is 0
2008
2009 For possible arguments see nvidia and nvidiabar.
2010
2011 nvidiagraph argument (height),(width) (gradient color 1) (gradient col‐
2012 or 2) (scale) (-t) (-l) GPU_ID
2013 Same as nvidiabar, except a horizontally scrolling graph with
2014 values from 0-100 plotted on the vertical axis. The height and
2015 width parameters are optional, and default to the de‐
2016 fault_graph_height and default_graph_width config settings, re‐
2017 spectively.
2018
2019 GPU_ID: NOT optional. This parameter allows to choose the GPU
2020 to be used as 0,1,2,3,..
2021
2022 For possible arguments see nvidia and nvidiabar. To learn more
2023 about the -t -l and gradient color options, see execgraph.
2024
2025 offset (pixels)
2026 Move text over by N pixels. See also $voffset.
2027
2028 outlinecolor (color)
2029 Change outline color.
2030
2031 pa_card_active_profile
2032 Pulseaudio’s default card active profile.
2033
2034 pa_card_name
2035 Pulseaudio’s default card name.
2036
2037 pa_sink_active_port_description
2038 Pulseaudio’s default sink active port description.
2039
2040 pa_sink_active_port_name
2041 Pulseaudio’s default sink active port name.
2042
2043 pa_sink_description
2044 Pulseaudio’s default sink description.
2045
2046 pa_sink_volume
2047 Pulseaudio’s default sink volume percentage.
2048
2049 pa_sink_volumebar
2050 Pulseaudio’s default sink volume bar.
2051
2052 password (length)
2053 Generate random passwords.
2054
2055 pb_battery item
2056 If running on Apple powerbook/ibook, display information on bat‐
2057 tery status. The item parameter specifies, what information to
2058 display. Exactly one item must be specified. Valid items are:
2059
2060 Item Description
2061 ──────────────────────────────────────────────────────────────────────────
2062 sta‐ Display if battery is fully charged, charging, discharging or ab‐
2063 tus sent (running on AC)
2064 per‐ Display charge of battery in percent, if charging or discharging.
2065 cent Nothing will be displayed, if battery is fully charged or absent.
2066 time Display the time remaining until the battery will be fully charged
2067 or discharged at current rate. Nothing is displayed, if battery
2068 is absent or if it’s present but fully charged and not discharg‐
2069 ing.
2070
2071 pid_chroot pid
2072 Directory used as rootdirectory by the process (this will be “/”
2073 unless the process did a chroot syscall).
2074
2075 pid_cmdline pid
2076 Command line this process was invoked with.
2077
2078 pid_cwd pid
2079 Current working directory of the process.
2080
2081 pid_egid pid
2082 The effective gid of the process.
2083
2084 pid_environ pid varname
2085 Contents of a environment-var of the process.
2086
2087 pid_environ_list pid
2088 List of environment-vars that the process can see.
2089
2090 pid_euid pid
2091 The effective uid of the process.
2092
2093 pid_exe pid
2094 Path to executed command that started the process.
2095
2096 pid_fsgid pid
2097 The file system gid of the process.
2098
2099 pid_fsuid pid
2100 The file system uid of the process.
2101
2102 pid_gid pid
2103 The real gid of the process.
2104
2105 pid_nice pid
2106 The nice value of the process.
2107
2108 pid_openfiles pid
2109 List of files that the process has open.
2110
2111 pid_parent pid
2112 The pid of the parent of the process.
2113
2114 pid_priority pid
2115 The priority of the process (see `priority' in “man 5 proc”).
2116
2117 pid_read pid
2118 Total number of bytes read by the process.
2119
2120 pid_sgid pid
2121 The saved set gid of the process.
2122
2123 pid_state pid
2124 State of the process.
2125
2126 pid_state_short pid
2127 One of the chars in “RSDZTW” representing the state of the
2128 process where R is running, S is sleeping in an interruptible
2129 wait, D is waiting in uninterruptible disk sleep, Z is zombie, T
2130 is traced or stopped (on a signal), and W is paging.
2131
2132 pid_stderr pid
2133 Filedescriptor binded to the STDERR of the process.
2134
2135 pid_stdin pid
2136 Filedescriptor binded to the STDIN of the process.
2137
2138 pid_stdout pid
2139 Filedescriptor binded to the STDOUT of the process.
2140
2141 pid_suid pid
2142 The saved set uid of the process.
2143
2144 pid_thread_list pid
2145 List with pid’s from threads from this process.
2146
2147 pid_threads pid
2148 Number of threads in process containing this thread.
2149
2150 pid_time pid
2151 Sum of $pid_time_kernelmode and $pid_time_usermode.
2152
2153 pid_time_kernelmode pid
2154 Amount of time that the process has been scheduled in kernel
2155 mode in seconds.
2156
2157 pid_time_usermode pid
2158 Amount of time that the process has been scheduled in user mode
2159 in seconds.
2160
2161 pid_uid pid
2162 The real uid of the process.
2163
2164 pid_vmdata pid
2165 Data segment size of the process.
2166
2167 pid_vmexe pid
2168 Text segment size of the process.
2169
2170 pid_vmhwm pid
2171 Peak resident set size (“high water mark”) of the process.
2172
2173 pid_vmlck pid
2174 Locked memory size of the process.
2175
2176 pid_vmlib pid
2177 Shared library code size of the process.
2178
2179 pid_vmpeak pid
2180 Peak virtual memory size of the process.
2181
2182 pid_vmpte pid
2183 Page table entries size of the process.
2184
2185 pid_vmrss pid
2186 Resident set size of the process.
2187
2188 pid_vmsize pid
2189 Virtual memory size of the process.
2190
2191 pid_vmstk pid
2192 Stack segment size of the process.
2193
2194 pid_write pid
2195 Total number of bytes written by the process.
2196
2197 platform (dev) type n (factor offset)
2198 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
2199 omitted if you have only one platform device. Platform type is
2200 either in or vol meaning voltage; fan meaning fan; temp meaning
2201 temperature. Parameter n is number of the sensor. See
2202 /sys/bus/platform/devices/ on your local computer. The optional
2203 arguments factor and offset allow precalculation of the raw in‐
2204 put, which is being modified as follows: input = input * factor
2205 + offset. Note that they have to be given as decimal values
2206 (i.e. contain at least one decimal place).
2207
2208 pop3_unseen (args)
2209 Displays the number of unseen messages in your global POP3 inbox
2210 by default. You can define individual POP3 inboxes separately
2211 by passing arguments to this object. Arguments are: “host user
2212 pass [-i interval (in seconds)] [-p port] [-e `command'] [-r re‐
2213 tries]”. Default port is 110, default interval is 5 minutes,
2214 and default number of retries before giving up is 5. If the
2215 password is supplied as ’*’, you will be prompted to enter the
2216 password when Conky starts.
2217
2218 pop3_used (args)
2219 Displays the amount of space (in MiB, 2^20) used in your global
2220 POP3 inbox by default. You can define individual POP3 inboxes
2221 separately by passing arguments to this object. Arguments are:
2222 “host user pass [-i interval (in seconds)] [-p port] [-e `com‐
2223 mand'] [-r retries]”. Default port is 110, default interval is
2224 5 minutes, and default number of retries before giving up is 5.
2225 If the password is supplied as ’*’, you will be prompted to en‐
2226 ter the password when Conky starts.
2227
2228 processes
2229 Total processes (sleeping and running).
2230
2231 read_tcp (host) port
2232 Connects to a tcp port on a host (default is localhost), reads
2233 every char available at the moment and shows them.
2234
2235 read_udp (host) port
2236 Connects to a udp port on a host (default is localhost), reads
2237 every char available at the moment and shows them.
2238
2239 replied_mails (maildir) (interval)
2240 Number of mails marked as replied in the specified mailbox or
2241 mail spool if not. Only maildir type mailboxes are supported,
2242 mbox type will return -1.
2243
2244 rss uri interval_in_seconds action (num_par (spaces_in_front))
2245 Download and parse RSS feeds. The interval may be a (floating
2246 point) value greater than 0. Action may be one of the follow‐
2247 ing: feed_title, item_title (with num par), item_desc (with num
2248 par) and item_titles (when using this action and spaces_in_front
2249 is given conky places that many spaces in front of each item).
2250 This object is threaded, and once a thread is created it can’t
2251 be explicitly destroyed. One thread will run for each URI spec‐
2252 ified. You can use any protocol that Curl supports.
2253
2254 rstrip text
2255 Strips all trailing whitespace from input.
2256
2257 running_processes
2258 Running processes (not sleeping). Requires Linux 2.6.
2259
2260 running_threads
2261 Number of running (runnable) threads. Linux only.
2262
2263 scroll (direction) length (step) (interval) text
2264 Scroll `text' by `step' characters to the left or right (set
2265 `direction' to `left' or `right' or `wait') showing `length'
2266 number of characters at the same time. The text may also con‐
2267 tain variables. `step' is optional and defaults to 1 if not
2268 set. `direction' is optional and defaults to left if not set.
2269 When direction is `wait' then text will scroll left and wait for
2270 `interval' itertations at the beginning and end of the text. If
2271 a var creates output on multiple lines then the lines are placed
2272 behind each other separated with a `|'-sign. If you change the
2273 textcolor inside $scroll it will automatically have it’s old
2274 value back at the end of $scroll. The end and the start of text
2275 will be separated by `length' number of spaces unless direction
2276 is `wait'.
2277
2278 seen_mails (maildir) (interval)
2279 Number of mails marked as seen in the specified mailbox or mail
2280 spool if not. Only maildir type mailboxes are supported, mbox
2281 type will return -1.
2282
2283 shadecolor (color)
2284 Change shading color.
2285
2286 shmem Amount of shared memory. Linux only.
2287
2288 sip_status (switch)
2289 Prints info regarding System Integrity Protection (SIP) on mac‐
2290 OS. If no switch is provided, prints SIP status (enabled / dis‐
2291 abled), else, status of the specific SIP feature corresponding
2292 to the switch provided.
2293
2294 Below are shown the available switches:
2295
2296 SWITCH RESULT STATUS
2297 ──────────────────────────────────────
2298 0 apple internal YES/NO
2299 1 forbid untrusted YES/NO
2300 kexts
2301 2 forbid task-for-pid YES/NO
2302 3 restrict filesystem YES/NO
2303
2304 4 forbid kernel-de‐ YES/NO
2305 bugger
2306 5 restrict dtrace YES/NO
2307 6 restrict nvram YES/NO
2308 7 forbid device-con‐ YES/NO
2309 figuration
2310 8 forbid any-recov‐ YES/NO
2311 ery-os
2312 9 forbid user-ap‐ YES/NO
2313 proved-kexts
2314
2315 uses unsupported configuration?: If yes, prints “unsupported
2316 configuration, beware!” Else, prints “configuration is ok”.
2317
2318 USAGE:
2319
2320 $ conky -t '${sip_status}'
2321 # print SIP status
2322 $ conky -t '${sip_status 0}'
2323 # print allows apple-internal? Yes or No?
2324
2325 NOTES:
2326
2327 • Available for all macOS versions (even the ones prior El Capi‐
2328 tan where SIP was first introduced)
2329
2330 • If run on versions prior El Capitan SIP is unavailable, so all
2331 you will get is “unsupported”.
2332
2333 smapi (ARGS)
2334 When using smapi, display contents of the /sys/devices/plat‐
2335 form/smapi directory. ARGS are either (FILENAME) or bat (INDEX)
2336 (FILENAME) to display the corresponding files’ content. This is
2337 a very raw method of accessing the smapi values. When avail‐
2338 able, better use one of the smapi_* variables instead.
2339
2340 smapi_bat_bar (INDEX),(height),(width)
2341 when using smapi, display the remaining capacity of the battery
2342 with index INDEX as a bar.
2343
2344 smapi_bat_perc (INDEX)
2345 when using smapi, display the remaining capacity in percent of
2346 the battery with index INDEX. This is a separate variable be‐
2347 cause it supports the `use_spacer' configuration option.
2348
2349 smapi_bat_power INDEX
2350 when using smapi, display the current power of the battery with
2351 index INDEX in watt. This is a separate variable because the
2352 original read out value is being converted from mW. The sign of
2353 the output reflects charging (positive) or discharging (nega‐
2354 tive) state.
2355
2356 smapi_bat_temp INDEX
2357 when using smapi, display the current temperature of the battery
2358 with index INDEX in degree Celsius. This is a separate variable
2359 because the original read out value is being converted from mil‐
2360 li degree Celsius.
2361
2362 sony_fanspeed
2363 Displays the Sony VAIO fanspeed information if sony-laptop ker‐
2364 nel support is enabled. Linux only.
2365
2366 startcase text
2367 Capitalises the start of each word.
2368
2369 stippled_hr (space)
2370 Stippled (dashed) horizontal line.
2371
2372 stock symbol data
2373 Displays the data of a stock symbol. The following data is sup‐
2374 ported:
2375
2376 Name Description
2377 ─────────────────────────────────────────
2378 1ytp 1 yr Target Price
2379 200ma 200-day Moving Average
2380 50ma 50-day Moving Average
2381 52weekhigh
2382 52weeklow
2383 52weekrange
2384 adv Average Daily Volume
2385 ag Annualized Gain
2386
2387 ahcrt After Hours Change real‐
2388 time
2389 ask
2390 askrt ask realtime
2391 asksize
2392 bid
2393 bidrt bid realtime
2394 bidsize
2395 bookvalue
2396 c200ma Change From 200-day Moving
2397 Average
2398 c50ma Change From 50-day Moving
2399 Average
2400 c52whigh Change from 52-week high
2401 c52wlow Change From 52-week Low
2402 change
2403 changert change realtime
2404 cip change in percent
2405 commission
2406 cprt change percent realtime
2407 dayshigh
2408 dayslow
2409 dpd Dividend Pay Date
2410 dr day’s range
2411 drrt day’s range realtime
2412 ds dividend/share
2413 dvc Day’s Value Change
2414 dvcrt Day’s Value Change real‐
2415 time
2416 dy Dividend Yield
2417 ebitda
2418 edv Ex-Dividend Date
2419 ei error indication
2420 epsecy EPS Estimate Current Year
2421 epsenq EPS Estimate Next Quarter
2422 epseny EPS Estimate Next Year
2423 es earnings/share
2424 floatshares
2425 hg Holdings Gain
2426 hgp Holdings Gain Percent
2427 hgprt Holdings Gain Percent re‐
2428 altime
2429 hgrt Holdings Gain realtime
2430 hl high limit
2431 hv Holdings Value
2432 hvrt Holdings Value realtime
2433 ll low limit
2434 ltd Last Trade Date
2435 ltp last trade price
2436 lts Last Trade Size
2437 ltt Last Trade Time
2438 mc Market Capitalization
2439 mcrt Market Cap realtime
2440 moreinfo
2441 name
2442 notes
2443 obrt Order Book realtime
2444 open
2445 pb price/book
2446 pc previous close
2447 pc200ma Percent Change From
2448 200-day Moving Average
2449 pc50ma Percent Change From 50-day
2450 Moving Average
2451 pc52whigh percent change from
2452 52-week high
2453 pc52wlow Percent Change From
2454 52-week Low
2455 pegr PEG Ratio
2456 pepsecy Price/EPS Estimate Current
2457 Year
2458 pepseny Price/EPS Estimate Next
2459 Year
2460 per P/E Ratio
2461 perrt P/E Ratio realtime
2462 pricepaid
2463 ps price/sales
2464 se Stock Exchange
2465 sharesowned
2466 shortratio
2467 symbol
2468 tradedate
2469
2470 tradelinks
2471 tt Ticker Trend
2472 volume
2473
2474 swap Amount of swap in use.
2475
2476 swapbar (height),(width)
2477 Bar that shows amount of swap in use.
2478
2479 swapfree
2480 Amount of free swap.
2481
2482 swapmax
2483 Total amount of swap.
2484
2485 swapperc
2486 Percentage of swap in use.
2487
2488 sysctlbyname (name)
2489 Print sysctl value by name. FreeBSD only.
2490
2491 sysname
2492 System name, e.g. Linux.
2493
2494 tab (width, (start))
2495 Puts a tab of the specified width, starting from column `start'.
2496 The unit is pixels for both arguments.
2497
2498 tail logfile lines (next_check)
2499 Displays last N lines of supplied text file. The file is
2500 checked every `next_check' update. If next_check is not sup‐
2501 plied, Conky defaults to 2. Max of 30 lines can be displayed,
2502 or until the text buffer is filled.
2503
2504 tcp_ping host (port)
2505 Displays the number of microseconds it takes to get a reply on a
2506 ping to to tcp `port' on `host'. `port' is optional and has 80
2507 as default. This works on both open and closed ports, just make
2508 sure that the port is not behind a firewall or you will get
2509 `down' as answer. It’s best to test a closed port instead of an
2510 open port, you will get a quicker response.
2511
2512 tcp_portmon port_begin port_end item (index)
2513 TCP port (both IPv6 and IPv4) monitor for specified local ports.
2514 Port numbers must be in the range 1 to 65535. Valid items are:
2515
2516 Item Description
2517 ──────────────────────────────────────
2518 count Total number of connec‐
2519 tions in the range
2520 rip Remote ip address
2521 rhost Remote host name
2522 rport Remote port number
2523 rservice Remote service name from
2524 /etc/services
2525 lip Local ip address
2526 lhost Local host name
2527 lport Local port number
2528 lservice Local service name from
2529 /etc/services
2530
2531 The connection index provides you with access to each connection
2532 in the port monitor. The monitor will return information for
2533 index values from 0 to n-1 connections. Values higher than n-1
2534 are simply ignored. For the count item, the connection index
2535 must be omitted. It is required for all other items.
2536
2537 Examples:
2538
2539 Example Description
2540 ──────────────────────────────────────────────────────────────────────────
2541 ${tcp_portmon 6881 Displays the number of connections in the bittor‐
2542 6999 count} rent port range
2543 ${tcp_portmon 22 22 Displays the remote host ip of the first sshd
2544 rip 0} connection
2545 ${tcp_portmon 22 22 Displays the remote host ip of the tenth sshd
2546 rip 9} connection
2547 ${tcp_portmon 1 1024 Displays the remote host name of the first con‐
2548 rhost 0} nection on a privileged port
2549 ${tcp_portmon 1 1024 Displays the remote host port of the fifth con‐
2550 rport 4} nection on a privileged port
2551
2552
2553 ${tcp_portmon 1 65535 Displays the local service name of the fifteenth
2554 lservice 14} connection in the range of all ports
2555
2556 Note that port monitor variables which share the same port range
2557 actually refer to the same monitor, so many references to a sin‐
2558 gle port range for different items and different indexes all use
2559 the same monitor internally. In other words, the program avoids
2560 creating redundant monitors.
2561
2562 templateN (arg1) (arg2) (arg3 ...)
2563 Evaluate the content of the templateN configuration variable
2564 (where N is a value between 0 and 9, inclusively), applying sub‐
2565 stitutions as described in the documentation of the correspond‐
2566 ing configuration variable. The number of arguments is option‐
2567 al, but must match the highest referred index in the template.
2568 You can use the same special sequences in each argument as the
2569 ones valid for a template definition, e.g. to allow an argument
2570 to contain a whitespace. Also simple nesting of templates is
2571 possible this way.
2572
2573 Here are some examples of template definitions, note they are
2574 placed between [[ ... ]] instead of ...:
2575
2576 template0 = [[$12]]
2577 template1 = [[1: ${fs_used 2} / ${fs_size 2}]]
2578 template2 = [[1 2]]
2579
2580 The following list shows sample usage of the templates defined
2581 above, with the equivalent syntax when not using any template at
2582 all:
2583
2584 Using template Same without template
2585 ──────────────────────────────────────────────────────────────────────────
2586 ${template0 node name} $nodename
2587 ${template1 root /} root: ${fs_free /} / ${fs_size /}
2588 ${template1 ${template2 disk root} disk root: ${fs_free /} /
2589 /} ${fs_size /}
2590 ——————————————— ——————————————
2591
2592 texeci interval command
2593 Runs a command at an interval inside a thread and displays the
2594 output. Same as $execi, except the command is run inside a
2595 thread. Use this if you have a slow script to keep Conky updat‐
2596 ing. You should make the interval slightly longer than the time
2597 it takes your script to execute. For example, if you have a
2598 script that take 5 seconds to execute, you should make the in‐
2599 terval at least 6 seconds. See also $execi. This object will
2600 clean up the thread when it is destroyed, so it can safely be
2601 used in a nested fashion, though it may not produce the desired
2602 behaviour if used this way.
2603
2604 texecpi interval command
2605 Same as execpi, except the command is run inside a thread.
2606
2607 threads
2608 Total threads.
2609
2610 time (format)
2611 Local time, see “man strftime” to get more information about
2612 format.
2613
2614 to_bytes size
2615 If `size' is a number followed by a size-unit (kilo‐
2616 byte,mb,GiB,...) then it converts the size to bytes and shows
2617 it without unit, otherwise it just shows `size'.
2618
2619 top type num
2620 This takes arguments in the form:top (name) (number) Basically,
2621 processes are ranked from highest to lowest in terms of cpu us‐
2622 age, which is what (num) represents. The types are: “name”,
2623 “pid”, “cpu”, “mem”, “mem_res”, “mem_vsize”, “time”, “uid”, “us‐
2624 er”, “io_perc”, “io_read” and “io_write”. There can be a max of
2625 10 processes listed.
2626
2627 top_io type num
2628 Same as top, except sorted by the amount of I/O the process has
2629 done during the update interval.
2630
2631 top_mem type num
2632 Same as top, except sorted by mem usage instead of cpu.
2633
2634 top_time type num
2635 Same as top, except sorted by total CPU time instead of current
2636 CPU usage.
2637
2638 totaldown (net)
2639 Total download, overflows at 4 GB on Linux with 32-bit arch and
2640 there doesn’t seem to be a way to know how many times it has al‐
2641 ready done that before conky has started.
2642
2643 totalup (net)
2644 Total upload, this one too, may overflow.
2645
2646 trashed_mails (maildir) (interval)
2647 Number of mails marked as trashed in the specified mailbox or
2648 mail spool if not. Only maildir type mailboxes are supported,
2649 mbox type will return -1.
2650
2651 tztime (timezone (format))
2652 Local time for specified timezone, see man strftime to get more
2653 information about format. The timezone argument is specified in
2654 similar fashion as TZ environment variable. For hints, look in
2655 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
2656
2657 uid_name uid
2658 Username of user with this uid.
2659
2660 unflagged_mails (maildir) (interval)
2661 Number of mails not marked as flagged in the specified mailbox
2662 or mail spool if not. Only maildir type mailboxes are support‐
2663 ed, mbox type will return -1.
2664
2665 unforwarded_mails (maildir) (interval)
2666 Number of mails not marked as forwarded in the specified mailbox
2667 or mail spool if not. Only maildir type mailboxes are support‐
2668 ed, mbox type will return -1.
2669
2670 unreplied_mails (maildir) (interval)
2671 Number of mails not marked as replied in the specified mailbox
2672 or mail spool if not. Only maildir type mailboxes are support‐
2673 ed, mbox type will return -1.
2674
2675 unseen_mails (maildir) (interval)
2676 Number of new or unseen mails in the specified mailbox or mail
2677 spool if not. Only maildir type mailboxes are supported, mbox
2678 type will return -1.
2679
2680 updates Number of updates
2681 for debugging.
2682
2683 uppercase text
2684 Converts all letters into uppercase.
2685
2686 upspeed (net)
2687 Upload speed in suitable IEC units.
2688
2689 upspeedf (net)
2690 Upload speed in KiB with one decimal.
2691
2692 upspeedgraph (netdev) (height),(width) (gradient colour 1) (gradient
2693 colour 2) (scale) (-t) (-l)
2694 Upload speed graph, colours defined in hex, minus the #. If
2695 scale is non-zero, it becomes the scale for the graph. Uses a
2696 logarithmic scale (to see small numbers) when you use the -l
2697 switch. Takes the switch `-t' to use a temperature gradient,
2698 which makes the gradient values change depending on the ampli‐
2699 tude of a particular graph value (try it and see).
2700
2701 uptime Uptime.
2702
2703 uptime_short
2704 Uptime in a shorter format.
2705
2706 user_names
2707 Lists the names of the users logged in.
2708
2709 user_number
2710 Number of users logged in.
2711
2712 user_terms
2713 Lists the consoles in use.
2714
2715 user_time console
2716 Lists how long the user for the given console has been logged in
2717 for.
2718
2719 user_times
2720 Lists how long users have been logged in for.
2721
2722 utime (format)
2723 Display time in UTC (universal coordinate time).
2724
2725 v6addrs (-n) (-s) (interface)
2726 IPv6 addresses for an interface, followed by netmask if -n is
2727 specified and scope with -s. Scopes are Global(G), Host-lo‐
2728 cal(H), Link-local(L), Site-local(S), Compat(C) and Unspeci‐
2729 fied(/). Linux only.
2730
2731 version
2732 Git version number. DragonFly only.
2733
2734 voffset (pixels)
2735 Change vertical offset by N pixels. Negative values will cause
2736 text to overlap. See also $offset.
2737
2738 voltage_mv (n)
2739 Returns CPU #n’s voltage in mV. CPUs are counted from 1.
2740
2741 Default: 1
2742
2743 voltage_v (n)
2744 Returns CPU #n’s voltage in V. CPUs are counted from 1.
2745
2746 Default: 1
2747
2748 wireless_ap (net)
2749 Wireless access point MAC address. Linux only.
2750
2751 wireless_bitrate (net)
2752 Wireless bitrate (ie 11 Mb/s). Linux only.
2753
2754 wireless_channel (net)
2755 WLAN channel on which device `net' is listening.
2756
2757 wireless_essid (net)
2758 Wireless access point ESSID. Linux only.
2759
2760 wireless_freq (net)
2761 Frequency on which device `net' is listening.
2762
2763 wireless_link_bar (height),(width) (net)
2764 Wireless link quality bar. Linux only.
2765
2766 wireless_link_qual (net)
2767 Wireless link quality. Linux only.
2768
2769 wireless_link_qual_max (net)
2770 Wireless link quality maximum value. Linux only.
2771
2772 wireless_link_qual_perc (net)
2773 Wireless link quality in percents. Linux only.
2774
2775 wireless_mode (net)
2776 Wireless mode (Managed/Ad-Hoc/Master). Linux only.
2777
2778 words textfile
2779 Displays the number of words in the given file.
2780
2781 xmms2_album
2782 Album in current XMMS2 song.
2783
2784 xmms2_artist
2785 Artist in current XMMS2 song.
2786
2787 xmms2_bar (height),(width)
2788 Bar of XMMS2’s progress.
2789
2790 xmms2_bitrate
2791 Bitrate of current song.
2792
2793 xmms2_comment
2794 Comment in current XMMS2 song.
2795
2796 xmms2_date
2797 Returns song’s date.
2798
2799 xmms2_duration
2800 Duration of current song.
2801
2802 xmms2_elapsed
2803 Song’s elapsed time.
2804
2805 xmms2_genre
2806 Genre in current XMMS2 song.
2807
2808 xmms2_id
2809 XMMS2 id of current song.
2810
2811 xmms2_percent
2812 Percent of song’s progress.
2813
2814 xmms2_playlist
2815 Returns the XMMS2 playlist.
2816
2817 xmms2_size
2818 Size of current song.
2819
2820 xmms2_smart
2821 Prints the song name in either the form “artist - title” or file
2822 name, depending on whats available.
2823
2824 xmms2_status
2825 XMMS2 status (Playing, Paused, Stopped, or Disconnected).
2826
2827 xmms2_timesplayed
2828 Number of times a song was played (presumably).
2829
2830 xmms2_title
2831 Title in current XMMS2 song.
2832
2833 xmms2_tracknr
2834 Track number in current XMMS2 song.
2835
2836 xmms2_url
2837 Full path to current song.
2838
2840 Conky features a Lua Programming API, and also ships with Lua bindings
2841 for some useful libraries. Note that the bindings require tolua++,
2842 which currently only compiles against Lua 5.1.
2843
2844 To use Lua Conky, you first need to make sure you have a version of
2845 Conky with Lua support enabled (conky -v will report this). Conky de‐
2846 fines certain global functions and variables which can be accessed from
2847 Lua code running in Conky. Scripts must first be loaded using the
2848 lua_load configuration option. You then call functions in Lua via
2849 Conky’s $lua, $lua_read, and Lua hooks.
2850
2851 Be careful when creating threaded objects through the Lua API. You
2852 could wind up with a whole bunch of threads running if a thread is cre‐
2853 ated with each iteration.
2854
2855 NOTE: In order to accommodate certain features in the cairo library’s
2856 API, Conky will export a few additional functions for the creation of
2857 certain structures. These are documented below.
2858
2859 cairo_font_extents_t:create()
2860 Call this function to return a new cairo_font_extents_t struc‐
2861 ture. A creation function for this structure is not provided by
2862 the cairo API.
2863
2864 After calling this, you should use tolua.takeownership(cfe) on
2865 the return value to ensure ownership is passed properly.
2866
2867 cairo_font_extents_t:destroy(structure)
2868 Call this function to free memory allocated by cairo_font_ex‐
2869 tents_t:create.
2870
2871 You should call tolua.releaseownership(cfe) before calling this
2872 function to avoid double-frees, but only if you previously
2873 called tolua.takeownership(cfe)
2874
2875 cairo_matrix_t:create()
2876 Call this function to return a new cairo_matrix_t structure. A
2877 creation function for this structure is not provided by the
2878 cairo API.
2879
2880 After calling this, you should use tolua.takeownership(cm) on
2881 the return value to ensure ownership is passed properly.
2882
2883 cairo_matrix_t:destroy(structure)
2884 Call this function to free memory allocated by cairo_ma‐
2885 trix_t:create.
2886
2887 You should call tolua.releaseownership(cm) before calling this
2888 function to avoid double-frees, but only if you previously
2889 called tolua.takeownership(cm)
2890
2891 cairo_text_extents_t:create()
2892 Call this function to return a new cairo_text_extents_t struc‐
2893 ture. A creation function for this structure is not provided by
2894 the cairo API.
2895
2896 After calling this, you should use tolua.takeownership(cte) on
2897 the return value to ensure ownership is passed properly.
2898
2899 cairo_text_extents_t:destroy(structure)
2900 Call this function to free memory allocated by cairo_text_ex‐
2901 tents_t:create.
2902
2903 You should call tolua.releaseownership(cte) before calling this
2904 function to avoid double-frees, but only if you previously
2905 called tolua.takeownership(cte)
2906
2907 conky_build_arch
2908 A string containing the build architecture for this particular
2909 instance of Conky.
2910
2911 conky_build_date
2912 A string containing the build date for this particular instance
2913 of Conky.
2914
2915 conky_build_info
2916 A string containing the build info for this particular instance
2917 of Conky, including the version, build date, and architecture.
2918
2919 conky_config
2920 A string containing the path of the current Conky configuration
2921 file.
2922
2923 conky_info
2924 This table contains some information about Conky’s internal da‐
2925 ta. The following table describes the values contained:
2926
2927 Key Value
2928 ─────────────────────────────────────────────
2929 update_interval Conky’s update interval
2930 (in seconds).
2931
2932 conky_parse(string)
2933 This function takes a string that is evaluated as per Conky’s
2934 TEXT section, and then returns a string with the result.
2935
2936 conky_set_update_interval(number)
2937 Sets Conky’s update interval (in seconds) to `number'.
2938
2939 conky_version
2940 A string containing the version of the current instance of
2941 Conky.
2942
2943 conky_window
2944 This table contains some information about Conky’s window. The
2945 following table describes the values contained:
2946
2947 Key Value
2948 ──────────────────────────────────────────────────────────────────────────
2949 drawable Window’s drawable (Xlib Drawable), requires Lua extras
2950 enabled at compile time.
2951 visual Window’s visual (Xlib Visual), requires Lua extras en‐
2952 abled at compile time.
2953 display Window’s display (Xlib Display), requires Lua extras en‐
2954 abled at compile time.
2955 width Window width (in pixels).
2956 height Window height (in pixels).
2957 border_in‐ Window’s inner border margin (in pixels).
2958 ner_margin
2959 border_out‐ Window’s outer border margin (in pixels).
2960 er_margin
2961 border_width Window’s border width (in pixels).
2962 text_start_x The x component of the starting coordinate of text draw‐
2963 ing.
2964 text_start_y The y component of the starting coordinate of text draw‐
2965 ing.
2966 text_width The width of the text drawing region.
2967 text_height The height of the text drawing region.
2968
2969 NOTE: This table is only defined when X support is enabled.
2970
2971 RsvgRectangle:create()
2972 Call this method to return a new RsvgRectangle structure. A
2973 creation function for this structure is not provided by the Rsvg
2974 API.
2975
2976 After calling this, you should use tolua.takeownership(rect) on
2977 the return value to ensure ownership is passed properly.
2978
2979 RsvgRectangle:destroy()
2980 Call this method to free memory allocated by RsvgRectangle:cre‐
2981 ate.
2982
2983 You should call tolua.releaseownership(rect) before calling this
2984 function to avoid double-frees, but only if you previously
2985 called tolua.takeownership(rect)
2986
2987 RsvgRectangle:set(x, y, width, height)
2988 Sets the values of an existing RsvgRectangle.
2989
2990 RsvgRectangle:get()
2991 Gets the values of an existing RsvgRectangle.
2992
2993 RsvgDimensionData:create()
2994 Call this method to return a new RsvgDimensionData structure. A
2995 creation function for this structure is not provided by the Rsvg
2996 API.
2997
2998 After calling this, you should use tolua.takeownership(rect) on
2999 the return value to ensure ownership is passed properly.
3000
3001 RsvgDimensionData:destroy()
3002 Call this method to free memory allocated by RsvgDimensionDa‐
3003 ta:create.
3004
3005 You should call tolua.releaseownership(dd) before calling this
3006 function to avoid double-frees, but only if you previously
3007 called tolua.takeownership(dd)
3008
3009 RsvgDimensionData:set(x, y, width, height)
3010 Sets the values of an existing RsvgDimensionData.
3011
3012 RsvgDimensionData:get()
3013 Gets the values of an existing RsvgDimensionData.
3014
3016 conky -t '${time %D %H:%M}' -o -u 30
3017 Start Conky in its own window with date and clock as text and 30
3018 sec update interval.
3019
3020 conky -a top_left -x 5 -y 500 -d
3021 Start Conky to background at coordinates (5, 500).
3022
3023 conky -C > ~/.config/conky/conky.conf
3024 Do not start Conky, but have it output the builtin default con‐
3025 fig file to ~/.config/conky/conky.conf for later customising.
3026
3028 ${sysconfdir}/conky/conky.conf
3029 Default system-wide configuration file. The value of
3030 ${sysconfdir} depends on the compile-time options (most likely
3031 /etc).
3032
3033 ~/.config/conky/conky.conf
3034 Default personal configuration file.
3035
3037 Drawing to root or some other desktop window directly doesn't work with
3038 all window managers. Especially doesn't work well with Gnome and it
3039 has been reported that it doesn't work with KDE either. Nautilus can
3040 be disabled from drawing to desktop with program gconf-editor. Uncheck
3041 show_desktop in /apps/nautilus/preferences/. There is -w switch in
3042 Conky to set some specific window id. You might find xwininfo -tree
3043 useful to find the window to draw to. You can also use -o argument
3044 which makes Conky to create its own window. If you do try running
3045 Conky in its own window, be sure to read up on the own_window_type set‐
3046 tings and experiment.
3047
3049 https://github.com/brndnmtthws/conky
3050
3052 Copyright (c) 2005-2023 Brenden Matthews, Philip Kovacs, et. al. Any
3053 original torsmo code is licensed under the BSD license (see LICENSE.BSD
3054 for a copy). All code written since the fork of torsmo is licensed un‐
3055 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
3056 ly (such as in portmon and audacious code which are LGPL, and prss
3057 which is an MIT-style license).
3058
3060 The Conky dev team (see AUTHORS for a full list of contributors).
3061
3062
3063
3064 2023-07-03 conky(1)