API tools faq
paste
edwinpaixao

conky

edwinpaixao
Sep 28th, 2016
45
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 99.23 KB | None | 0 0
raw download clone embed print report diff
  1. conky(1) conky(1)
  2.  
  3.  
  4.  
  5. NAME
  6. conky - A system monitor for X originally based on the torsmo code, but
  7. more kickass. It just keeps on given'er. Yeah.
  8.  
  9. SYNOPSIS
  10. conky [ options ]
  11.  
  12. DESCRIPTION
  13. Conky is a system monitor for X originally based on torsmo. Since its
  14. inception, Conky has changed significantly from its predecessor, while
  15. maintaining simplicity and configurability. Conky can display just
  16. about anything, either on your root desktop or in its own window. Not
  17. only does Conky have many built-in objects, it can also display just
  18. about any piece of information by using scripts and other external pro‐
  19. grams.
  20.  
  21. Conky has more than 250 built in objects, including support for a
  22. plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
  23. "top" like process stats, and network monitoring, just to name a few),
  24. built in IMAP and POP3 support, built in support for many popular music
  25. players (MPD, XMMS2, BMPx, Audacious), and much much more. Conky can
  26. display this info either as text, or using simple progress bars and
  27. graph widgets, with different fonts and colours.
  28.  
  29. We are always looking for help, whether its reporting bugs, writing
  30. patches, or writing docs. Please use the facilities at SourceForge to
  31. make bug reports, feature requests, and submit patches, or stop by
  32. #conky on irc.freenode.net if you have questions or want to contribute.
  33.  
  34. Thanks for your interest in Conky.
  35.  
  36. COMPILING
  37. For users compiling from source on a binary distro, make sure you have
  38. the X development libraries installed (Unless you provide configure
  39. with "--disable-x11"). This should be a package along the lines of
  40. "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" format
  41. for the other libs required (depending on your configure options). You
  42. should be able to see which extra packages you need to install by read‐
  43. ing errors that you get from './configure'. You can enable/disable
  44. stuff by giving options to configure, but be careful with disabling.
  45. For example: with --disable-math you won't get errors but logarithmic
  46. graphs will be normal graphs and gauges will miss their 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 all optional components (note
  59. that some configure options may differ for your system):
  60.  
  61. sh autogen.sh # Only required if building from the git repo
  62.  
  63. ./configure --prefix=/usr --mandir=/usr/share/man --in‐
  64. fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local‐
  65. statedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega‐
  66. cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis‐
  67. able-portmon --disable-network --enable-debug --disable-x11 --dis‐
  68. able-double-buffer --disable-xdamage --disable-xft
  69.  
  70. make
  71.  
  72. make install # Optional
  73.  
  74. src/conky
  75.  
  76. Conky has been tested to be compatible with C99 C, however it has not
  77. been tested with anything other than gcc, and is not guaranteed to work
  78. with other compilers.
  79.  
  80. YOU SHOULD KNOW
  81. Conky is generally very good on resources. That said, the more you try
  82. to make Conky do, the more resources it is going to consume.
  83.  
  84. An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
  85. conky". Saves you the trouble of having to kill and then restart. You
  86. can now also do the same with SIGHUP.
  87.  
  88. OPTIONS
  89. Command line options override configurations defined in configuration
  90. file.
  91.  
  92. -v | -V | --version
  93. Prints version and exits
  94.  
  95.  
  96. -q | --quiet
  97. Run Conky in 'quiet mode' (ie. no output)
  98.  
  99.  
  100. -D | --debug
  101. Increase debugging output, ie. -DD for more debugging
  102.  
  103.  
  104. -a | --alignment= ALIGNMENT
  105. Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
  106. dle} or none. Can also be abbreviated with first chars of posi‐
  107. tion, ie. tr for top_right.
  108.  
  109.  
  110. -b | --double-buffer
  111. Use double buffering (eliminates "flicker")
  112.  
  113.  
  114. -c | --config= FILE
  115. Config file to load instead of $HOME/.conkyrc
  116.  
  117.  
  118. -C | --print-config
  119. Print builtin default config to stdout. See also the section EX‐
  120. AMPLES for more information.
  121.  
  122.  
  123. -d | --daemonize
  124. Daemonize Conky, aka fork to background
  125.  
  126.  
  127. -f | --font= FONT
  128. Font to use
  129.  
  130.  
  131. -h | --help
  132. Prints command line help and exits
  133.  
  134.  
  135. -o | --own-window
  136. Create own window to draw
  137.  
  138.  
  139. -t | --text= TEXT
  140. Text to render, remember single quotes, like -t ' $uptime '
  141.  
  142.  
  143. -p | --pause= SECONDS
  144. Time to pause before actually starting Conky
  145.  
  146.  
  147. -u | --interval= SECONDS
  148. Update interval
  149.  
  150.  
  151. -w | --window-id= WIN_ID
  152. Window id to draw
  153.  
  154.  
  155. -X | --display= DISPLAY
  156. X11 display to use
  157.  
  158.  
  159. -x X_COORDINATE
  160. X position
  161.  
  162.  
  163. -y Y_COORDINATE
  164. Y position
  165.  
  166.  
  167. -i COUNT
  168. Number of times to update Conky (and quit)
  169.  
  170.  
  171. CONFIGURATION SETTINGS
  172. Default configuration file location is $HOME/.conkyrc or
  173. ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
  174. and you can find the sample config file there (/etc/conky/conky.conf).
  175.  
  176. You might want to copy it to $HOME/.conkyrc and then start modifying
  177. it. Other configs can be found at http://conky.sf.net/
  178.  
  179. TEXT After this begins text to be formatted on screen. Backslash (\)
  180. escapes newlines in the text section. This can be useful for
  181. cleaning up config files where conky is used to pipe input to
  182. dzen2.
  183.  
  184.  
  185. alignment
  186. Aligned position on screen, may be top_left, top_right, top_mid‐
  187. dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
  188. dle_middle, middle_right, or none (also can be abreviated as tl,
  189. tr, tm, bl, br, bm, ml, mm, mr). See also gap_x and gap_y.
  190.  
  191.  
  192. append_file
  193. Append the file given as argument.
  194.  
  195.  
  196. background
  197. Boolean value, if true, Conky will be forked to background when
  198. started.
  199.  
  200.  
  201. border_inner_margin
  202. Inner border margin in pixels (the margin between the border and
  203. text).
  204.  
  205.  
  206. border_outer_margin
  207. Outer border margin in pixels (the margin between the border and
  208. the edge of the window).
  209.  
  210.  
  211. border_width
  212. Border width in pixels.
  213.  
  214.  
  215. colorN Predefine a color for use inside TEXT segments. Substitute N by
  216. a digit between 0 and 9, inclusively. When specifying the color
  217. value in hex, omit the leading hash (#).
  218.  
  219.  
  220. cpu_avg_samples
  221. The number of samples to average for CPU monitoring.
  222.  
  223.  
  224. default_bar_size
  225. Specify a default width and height for bars. Example: 'de‐
  226. fault_bar_size 0 6'. This is particularly useful for execbar and
  227. execibar as they do not take size arguments.
  228.  
  229.  
  230. default_color
  231. Default color and border color
  232.  
  233.  
  234. default_gauge_size
  235. Specify a default width and height for gauges. Example: 'de‐
  236. fault_gauge_size 25 25'. This is particularly useful for exec‐
  237. gauge and execigauge as they do not take size arguments
  238.  
  239.  
  240. default_graph_size
  241. Specify a default width and height for graphs. Example: 'de‐
  242. fault_graph_size 0 25'. This is particularly useful for exec‐
  243. graph and execigraph as they do not take size arguments
  244.  
  245.  
  246. default_outline_color
  247. Default outline color
  248.  
  249.  
  250. default_shade_color
  251. Default shading color and border's shading color
  252.  
  253.  
  254. disable_auto_reload
  255. Enable to disable the inotify-based auto config reload feature.
  256.  
  257.  
  258. diskio_avg_samples
  259. The number of samples to average for disk I/O monitoring.
  260.  
  261.  
  262. display
  263. Specify an X display to connect to.
  264.  
  265.  
  266. double_buffer
  267. Use the Xdbe extension? (eliminates flicker) It is highly recom‐
  268. mended to use own window with this one so double buffer won't be
  269. so big.
  270.  
  271.  
  272. draw_borders
  273. Draw borders around text?
  274.  
  275.  
  276. draw_graph_borders
  277. Draw borders around graphs?
  278.  
  279.  
  280. draw_outline
  281. Draw outlines?
  282.  
  283.  
  284. draw_shades
  285. Draw shades?
  286.  
  287.  
  288. extra_newline
  289. Put an extra newline at the end when writing to stdout, useful
  290. for writing to awesome's wiboxes.
  291.  
  292.  
  293. font Font name in X, xfontsel can be used to get a nice font
  294.  
  295.  
  296. format_human_readable
  297. If enabled, values which are in bytes will be printed in human
  298. readable format (i.e., KiB, MiB, etc). If disabled, the number
  299. of bytes is printed instead.
  300.  
  301.  
  302. gap_x Gap, in pixels, between right or left border of screen, same as
  303. passing -x at command line, e.g. gap_x 10. For other position
  304. related stuff, see 'alignment'.
  305.  
  306.  
  307. gap_y Gap, in pixels, between top or bottom border of screen, same as
  308. passing -y at command line, e.g. gap_y 10. For other position
  309. related stuff, see 'alignment'.
  310.  
  311.  
  312. hddtemp_host
  313. Hostname to connect to for hddtemp objects. Defaults to
  314. "127.0.0.1".
  315.  
  316.  
  317. hddtemp_port
  318. Port to use for hddtemp connections. Defaults to 7634.
  319.  
  320.  
  321. if_up_strictness
  322. How strict should if_up be when testing an interface for being
  323. up? The value is one of up, link or address, to check for the
  324. interface being solely up, being up and having link or being up,
  325. having link and an assigned IP address.
  326.  
  327.  
  328. imap Default global IMAP server. Arguments are: "host user pass [-i
  329. interval (in seconds)] [-f 'folder'] [-p port] [-e 'command']
  330. [-r retries]". Default port is 143, default folder is 'INBOX',
  331. default interval is 5 minutes, and default number of retries be‐
  332. fore giving up is 5. If the password is supplied as '*', you
  333. will be prompted to enter the password when Conky starts.
  334.  
  335.  
  336. imlib_cache_flush_interval
  337. Interval (in seconds) to flush Imlib2 cache.
  338.  
  339.  
  340. imlib_cache_size
  341. Imlib2 image cache size, in bytes. Defaults to 4MiB. Increase
  342. this value if you use $image lots. Set to 0 to disable the image
  343. cache.
  344.  
  345.  
  346. lua_draw_hook_post function_name [function arguments]
  347. This function, if defined, will be called by Conky through each
  348. iteration after drawing to the window. Requires X support. Takes
  349. any number of optional arguments. Use this hook for drawing
  350. things on top of what Conky draws. Conky puts 'conky_' in front
  351. of function_name to prevent accidental calls to the wrong func‐
  352. tion unless you place 'conky_' in front of it yourself.
  353.  
  354.  
  355. lua_draw_hook_pre function_name [function arguments]
  356. This function, if defined, will be called by Conky through each
  357. iteration before drawing to the window. Requires X support.
  358. Takes any number of optional arguments. Use this hook for draw‐
  359. ing things on top of what Conky draws. Conky puts 'conky_' in
  360. front of function_name to prevent accidental calls to the wrong
  361. function unless you place 'conky_' in front of it yourself.
  362.  
  363.  
  364. lua_load
  365. Loads the Lua scripts separated by spaces.
  366.  
  367.  
  368. lua_shutdown_hook function_name [function arguments]
  369. This function, if defined, will be called by Conky at shutdown
  370. or when the configuration is reloaded. Use this hook to clean up
  371. after yourself, such as freeing memory which has been allocated
  372. by external libraries via Lua. Conky puts 'conky_' in front of
  373. function_name to prevent accidental calls to the wrong function
  374. unless you place 'conky_' in front of it yourself.
  375.  
  376.  
  377. lua_startup_hook function_name [function arguments]
  378. This function, if defined, will be called by Conky at startup or
  379. when the configuration is reloaded. Use this hook to initialize
  380. values, or for any run-once applications. Conky puts 'conky_' in
  381. front of function_name to prevent accidental calls to the wrong
  382. function unless you place 'conky_' in front of it yourself.
  383.  
  384.  
  385. mail_spool
  386. Mail spool for mail checking
  387.  
  388.  
  389. max_port_monitor_connections
  390. Allow each port monitor to track at most this many connections
  391. (if 0 or not set, default is 256)
  392.  
  393.  
  394. max_specials
  395. Maximum number of special things, e.g. fonts, offsets, aligns,
  396. etc. (default is 512)
  397.  
  398.  
  399. max_text_width width
  400. When a line in the output contains 'width' chars and the end
  401. isn't reached, the next char will start on a new line. If you
  402. want to make sure that lines don't get broken, set 'width' to 0
  403.  
  404.  
  405. max_user_text bytes
  406. Maximum size of user text buffer, i.e. layout below TEXT line in
  407. config file (default is 16384 bytes)
  408.  
  409.  
  410. maximum_width pixels
  411. Maximum width of window
  412.  
  413.  
  414. minimum_size width (height)
  415. Minimum size of window
  416.  
  417.  
  418. mpd_host
  419. Host of MPD server
  420.  
  421.  
  422. mpd_password
  423. MPD server password
  424.  
  425.  
  426. mpd_port
  427. Port of MPD server
  428.  
  429.  
  430. music_player_interval
  431. Music player thread update interval (defaults to Conky's update
  432. interval)
  433.  
  434.  
  435. net_avg_samples
  436. The number of samples to average for net data
  437.  
  438.  
  439. no_buffers
  440. Subtract (file system) buffers from used memory?
  441.  
  442.  
  443. nvidia_display
  444. The display that the nvidia variable will use (defaults to the
  445. value of the display variable)
  446.  
  447.  
  448. out_to_console
  449. Print text to stdout.
  450.  
  451.  
  452. out_to_ncurses
  453. Print text in the console, but use ncurses so that conky can
  454. print the text of a new update over the old text. (In the future
  455. this will provide more useful things)
  456.  
  457.  
  458. out_to_stderr
  459. Print text to stderr.
  460.  
  461.  
  462. out_to_x
  463. When set to no, there will be no output in X (useful when you
  464. also use things like out_to_console). If you set it to no, make
  465. sure that it's placed before all other X-related setting (take
  466. the first line of your configfile to be sure). Default value is
  467. yes
  468.  
  469.  
  470. override_utf8_locale
  471. Force UTF8? requires XFT
  472.  
  473.  
  474. overwrite_file
  475. Overwrite the file given as argument.
  476.  
  477.  
  478. own_window
  479. Boolean, create own window to draw?
  480.  
  481.  
  482. own_window_class
  483. Manually set the WM_CLASS name. Defaults to "Conky".
  484.  
  485.  
  486. own_window_colour colour
  487. If own_window_transparent no, set a specified background colour
  488. (defaults to black). Takes either a hex value (e.g. ffffff, note
  489. the lack of '#') or a valid RGB name (see /usr/lib/X11/rgb.txt)
  490.  
  491.  
  492. own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
  493. If own_window is yes, you may use these window manager hints to
  494. affect the way Conky displays. Notes: Use own_window_type desk‐
  495. top as another way to implement many of these hints implicitly.
  496. If you use own_window_type override, window manager hints have
  497. no meaning and are ignored.
  498.  
  499.  
  500. own_window_title
  501. Manually set the window name. Defaults to "<hostname> - conky".
  502.  
  503.  
  504. own_window_argb_visual
  505. Boolean, use ARGB visual? ARGB can be used for real transparen‐
  506. cy, note that a composite manager is required for real trans‐
  507. parency. This option will not work as desired (in most cases) in
  508. conjunction with 'own_window_type override'.
  509.  
  510.  
  511. own_window_argb_value
  512. When ARGB visuals are enabled, this use this to modify the alpha
  513. value used. Valid range is 0-255, where 0 is 0% opacity, and 255
  514. is 100% opacity.
  515.  
  516.  
  517. own_window_transparent
  518. Boolean, set transparency? If ARGB visual is enabled, sets back‐
  519. ground opacity to 0%.
  520.  
  521.  
  522. own_window_type
  523. if own_window is yes, you may specify type normal, desktop,
  524. dock, panel or override (default: normal). Desktop windows are
  525. special windows that have no window decorations; are always vis‐
  526. ible on your desktop; do not appear in your pager or taskbar;
  527. and are sticky across all workspaces. Panel windows reserve
  528. space along a desktop edge, just like panels and taskbars, pre‐
  529. venting maximized windows from overlapping them. The edge is
  530. chosen based on the alignment option. Override windows are not
  531. under the control of the window manager. Hints are ignored. This
  532. type of window can be useful for certain situations.
  533.  
  534.  
  535. pad_percents
  536. Pad percentages to this many decimals (0 = no padding)
  537.  
  538.  
  539. pop3 Default global POP3 server. Arguments are: "host user pass [-i
  540. interval (in seconds)] [-p port] [-e 'command'] [-r retries]".
  541. Default port is 110, default interval is 5 minutes, and default
  542. number of retries before giving up is 5. If the password is sup‐
  543. plied as '*', you will be prompted to enter the password when
  544. Conky starts.
  545.  
  546.  
  547. short_units
  548. Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
  549. fault is off.
  550.  
  551.  
  552. show_graph_range
  553. Shows the time range covered by a graph.
  554.  
  555.  
  556. show_graph_scale
  557. Shows the maximum value in scaled graphs.
  558.  
  559.  
  560. stippled_borders
  561. Border stippling (dashing) in pixels
  562.  
  563.  
  564. temperature_unit
  565. Desired output unit of all objects displaying a temperature. Pa‐
  566. rameters are either "fahrenheit" or "celsius". The default unit
  567. is degree Celsius.
  568.  
  569.  
  570. templateN
  571. Define a template for later use inside TEXT segments. Substitute
  572. N by a digit between 0 and 9, inclusively. The value of the
  573. variable is being inserted into the stuff below TEXT at the cor‐
  574. responding position, but before some substitutions are applied:
  575.  
  576. '\n' -> newline
  577. '\\' -> backslash
  578. '\ ' -> space
  579. '\N' -> template argument N
  580.  
  581.  
  582. text_buffer_size bytes
  583. Size of the standard text buffer (default is 256 bytes). This
  584. buffer is used for intermediary text, such as individual lines,
  585. output from $exec vars, and various other variables. Increasing
  586. the size of this buffer can drastically reduce Conky's perfor‐
  587. mance, but will allow for more text display per variable. The
  588. size of this buffer cannot be smaller than the default value of
  589. 256 bytes.
  590.  
  591.  
  592. times_in_seconds
  593. If true, variables that output times output a number that repre‐
  594. sents seconds. This doesn't affect $time, $tztime and $utime
  595.  
  596.  
  597. top_cpu_separate
  598. If true, cpu in top will show usage of one processor's power. If
  599. false, cpu in top will show the usage of all processors' power
  600. combined.
  601.  
  602.  
  603. top_name_width
  604. Width for $top name value (defaults to 15 characters).
  605.  
  606.  
  607. total_run_times
  608. Total number of times for Conky to update before quitting. Zero
  609. makes Conky run forever
  610.  
  611.  
  612. update_interval seconds
  613. Update interval
  614.  
  615.  
  616. update_interval_on_battery seconds
  617. Update interval when running on batterypower
  618.  
  619.  
  620. uppercase
  621. Boolean value, if true, text is rendered in upper case
  622.  
  623.  
  624. use_spacer
  625. Adds spaces around certain objects to stop them from moving oth‐
  626. er things around. Arguments are left, right, and none (default).
  627. The old true/false values are deprecated and default to
  628. right/none respectively. Note that this only helps if you are
  629. using a mono font, such as Bitstream Vera Sans Mono.
  630.  
  631.  
  632. use_xft
  633. Use Xft (anti-aliased font and stuff)
  634.  
  635.  
  636. xftalpha
  637. Alpha of Xft font. Must be a value at or between 1 and 0.
  638.  
  639.  
  640. xftfont
  641. Xft font to use.
  642.  
  643.  
  644. OBJECTS/VARIABLES
  645. Colours are parsed using XParsecolor(), there might be a list of them:
  646. /usr/share/X11/rgb.txt. Colour can be also in #rrggbb format (hex).
  647.  
  648. Some objects may create threads, and sometimes these threads will not
  649. be destroyed until Conky terminates. There is no way to destroy or
  650. clean up threads while Conky is running. For example, if you use an MPD
  651. variable, the MPD thread will keep running until Conky dies. Some
  652. threaded objects will use one of the parameters as a 'key', so that you
  653. only have 1 relevant thread running (for example, the $curl, $rss and
  654. $weather objects launch one thread per URI).
  655.  
  656. acpiacadapter (adapter)
  657. ACPI ac adapter state. On linux, the adapter option specifies
  658. the subfolder of /sys/class/power_supply containing the state
  659. information (tries "AC" and "ADP1" if there is no argument giv‐
  660. en). Non-linux systems ignore it.
  661.  
  662.  
  663. acpifan
  664. ACPI fan state
  665.  
  666.  
  667. acpitemp
  668. ACPI temperature in C.
  669.  
  670.  
  671. addr (interface)
  672. IP address for an interface, or "No Address" if no address is
  673. assigned.
  674.  
  675.  
  676. addrs (interface)
  677. IP addresses for an interface (if one - works like addr). Linux
  678. only.
  679.  
  680.  
  681. adt746xcpu
  682. CPU temperature from therm_adt746x
  683.  
  684.  
  685. adt746xfan
  686. Fan speed from therm_adt746x
  687.  
  688.  
  689. alignc (num)
  690. Align text to centre
  691.  
  692.  
  693. alignr (num)
  694. Right-justify text, with space of N
  695.  
  696.  
  697. apcupsd host port
  698. Sets up the connection to apcupsd daemon. Prints nothing, de‐
  699. faults to localhost:3551
  700.  
  701.  
  702. apcupsd_cable
  703. Prints the UPS connection type.
  704.  
  705.  
  706. apcupsd_charge
  707. Current battery capacity in percent.
  708.  
  709.  
  710. apcupsd_lastxfer
  711. Reason for last transfer from line to battery.
  712.  
  713.  
  714. apcupsd_linev
  715. Nominal input voltage.
  716.  
  717.  
  718. apcupsd_load
  719. Current load in percent.
  720.  
  721.  
  722. apcupsd_loadbar
  723. Bar showing current load.
  724.  
  725.  
  726. apcupsd_loadgauge (height),(width)
  727. Gauge that shows current load.
  728.  
  729.  
  730. apcupsd_loadgraph (height),(width) (gradient colour 1) (gradient colour
  731. 2) (scale) (-t) (-l)
  732. History graph of current load.
  733.  
  734.  
  735. apcupsd_model
  736. Prints the model of the UPS.
  737.  
  738.  
  739. apcupsd_name
  740. Prints the UPS user-defined name.
  741.  
  742.  
  743. apcupsd_status
  744. Prints current status (on-line, on-battery).
  745.  
  746.  
  747. apcupsd_temp
  748. Current internal temperature.
  749.  
  750.  
  751. apcupsd_timeleft
  752. Time left to run on battery.
  753.  
  754.  
  755. apcupsd_upsmode
  756. Prints the UPS mode (e.g. standalone).
  757.  
  758.  
  759. apm_adapter
  760. Display APM AC adapter status (FreeBSD only)
  761.  
  762.  
  763. apm_battery_life
  764. Display APM battery life in percent (FreeBSD only)
  765.  
  766.  
  767. apm_battery_time
  768. Display remaining APM battery life in hh:mm:ss or "unknown" if
  769. AC adapterstatus is on-line or charging (FreeBSD only)
  770.  
  771.  
  772. audacious_bar (height),(width)
  773. Progress bar
  774.  
  775.  
  776. audacious_bitrate
  777. Bitrate of current tune
  778.  
  779.  
  780. audacious_channels
  781. Number of audio channels of current tune
  782.  
  783.  
  784. audacious_filename
  785. Full path and filename of current tune
  786.  
  787.  
  788. audacious_frequency
  789. Sampling frequency of current tune
  790.  
  791.  
  792. audacious_length
  793. Total length of current tune as MM:SS
  794.  
  795.  
  796. audacious_length_seconds
  797. Total length of current tune in seconds
  798.  
  799.  
  800. audacious_main_volume
  801. The current volume fetched from Audacious
  802.  
  803.  
  804. audacious_playlist_length
  805. Number of tunes in playlist
  806.  
  807.  
  808. audacious_playlist_position
  809. Playlist position of current tune
  810.  
  811.  
  812. audacious_position
  813. Position of current tune (MM:SS)
  814.  
  815.  
  816. audacious_position_seconds
  817. Position of current tune in seconds
  818.  
  819.  
  820. audacious_status
  821. Player status (Playing/Paused/Stopped/Not running)
  822.  
  823.  
  824. audacious_title (max length)
  825. Title of current tune with optional maximum length specifier
  826.  
  827.  
  828. battery (num)
  829. Battery status and remaining percentage capacity of ACPI or APM
  830. battery. ACPI battery number can be given as argument (default
  831. is BAT0).
  832.  
  833.  
  834. battery_bar (height),(width) (num)
  835. Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
  836. tery number can be given as argument (default is BAT0).
  837.  
  838.  
  839. battery_percent (num)
  840. Battery percentage remaining for ACPI battery. ACPI battery
  841. number can be given as argument (default is BAT0).
  842.  
  843.  
  844. battery_short (num)
  845. Battery status and remaining percentage capacity of ACPI or APM
  846. battery. ACPI battery number can be given as argument (default
  847. is BAT0). This mode display a short status, which means that C
  848. is displayed instead of charging, D for discharging, F for full,
  849. N for not present, E for empty and U for unknown.
  850.  
  851.  
  852. battery_time (num)
  853. Battery charge/discharge time remaining of ACPI battery. ACPI
  854. battery number can be given as argument (default is BAT0).
  855.  
  856.  
  857. blink text_and_other_conky_vars
  858. Let 'text_and_other_conky_vars' blink on and off.
  859.  
  860.  
  861. bmpx_album
  862. Album in current BMPx track
  863.  
  864.  
  865. bmpx_artist
  866. Artist in current BMPx track
  867.  
  868.  
  869. bmpx_bitrate
  870. Bitrate of the current BMPx track
  871.  
  872.  
  873. bmpx_title
  874. Title of the current BMPx track
  875.  
  876.  
  877. bmpx_track
  878. Track number of the current BMPx track
  879.  
  880.  
  881. bmpx_uri
  882. URI of the current BMPx track
  883.  
  884.  
  885. buffers
  886. Amount of memory buffered
  887.  
  888.  
  889. cached Amount of memory cached
  890.  
  891.  
  892. cmdline_to_pid string
  893. PID of the first process that has string in it's commandline
  894.  
  895.  
  896. color (color)
  897. Change drawing color to 'color' which is a name of a color or a
  898. hexcode preceded with # (for example #0A1B2C ). If you use
  899. ncurses only the following colors are supported: red,green,yel‐
  900. low,blue,magenta,cyan,black,white.
  901.  
  902.  
  903. colorN Change drawing color to colorN configuration option, where N is
  904. a digit between 0 and 9, inclusively.
  905.  
  906.  
  907. combine var1 var2
  908. Places the lines of var2 to the right of the lines of var1 sepa‐
  909. rated by the chars that are put between var1 and var2. For exam‐
  910. ple: ${combine ${head /proc/cpuinfo 2} - ${head /proc/meminfo
  911. 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1
  912. and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐
  913. ed to place more vars next to each other.
  914.  
  915.  
  916. conky_build_arch
  917. CPU architecture Conky was built for
  918.  
  919.  
  920. conky_build_date
  921. Date Conky was built
  922.  
  923.  
  924. conky_version
  925. Conky version
  926.  
  927.  
  928. cpu (cpuN)
  929. CPU usage in percents. For SMP machines, the CPU number can be
  930. provided as an argument. ${cpu cpu0} is the total usage, and
  931. ${cpu cpuX} (X >= 1) are individual CPUs.
  932.  
  933.  
  934. cpubar (cpuN) (height),(width)
  935. Bar that shows CPU usage, height is bar's height in pixels. See
  936. $cpu for more info on SMP.
  937.  
  938.  
  939. cpugauge (cpuN) (height),(width)
  940. Elliptical gauge that shows CPU usage, height and width are
  941. gauge's vertical and horizontal axis respectively. See $cpu for
  942. more info on SMP.
  943.  
  944.  
  945. cpugraph (cpuN) (height),(width) (gradient colour 1) (gradient colour
  946. 2) (scale) (-t) (-l)
  947. CPU usage graph, with optional colours in hex, minus the #. See
  948. $cpu for more info on SMP. Uses a logarithmic scale (to see
  949. small numbers) when you use the -l switch. Takes the switch '-t'
  950. to use a temperature gradient, which makes the gradient values
  951. change depending on the amplitude of a particular graph value
  952. (try it and see).
  953.  
  954.  
  955. curl url (interval_in_minutes)
  956. Download data from URI using Curl at the specified interval. The
  957. interval may be a floating point value greater than 0, otherwise
  958. defaults to 15 minutes. Most useful when used in conjunction
  959. with Lua and the Lua API. This object is threaded, and once a
  960. thread is created it can't be explicitly destroyed. One thread
  961. will run for each URI specified. You can use any protocol that
  962. Curl supports.
  963.  
  964. desktop
  965. Number of the desktop on which conky is running or the message
  966. "Not running in X" if this is the case.
  967.  
  968.  
  969. desktop_name
  970. Name of the desktop on which conky is running or the message
  971. "Not running in X" if this is the case.
  972.  
  973.  
  974. desktop_number
  975. Number of desktops or the message "Not running in X" if this is
  976. the case.
  977.  
  978.  
  979. disk_protect device
  980. Disk protection status, if supported (needs kernel-patch).
  981. Prints either "frozen" or "free " (note the padding).
  982.  
  983.  
  984. diskio (device)
  985. Displays current disk IO. Device is optional, and takes the form
  986. of sda for /dev/sda. Individual partitions are allowed.
  987.  
  988.  
  989. diskio_read (device)
  990. Displays current disk IO for reads. Device as in diskio.
  991.  
  992.  
  993. diskio_write (device)
  994. Displays current disk IO for writes. Device as in diskio.
  995.  
  996.  
  997. diskiograph (device) (height),(width) (gradient colour 1) (gradient
  998. colour 2) (scale) (-t) (-l)
  999. Disk IO graph, colours defined in hex, minus the #. If scale is
  1000. non-zero, it becomes the scale for the graph. Uses a logarithmic
  1001. scale (to see small numbers) when you use -l switch. Takes the
  1002. switch '-t' to use a temperature gradient, which makes the gra‐
  1003. dient values change depending on the amplitude of a particular
  1004. graph value (try it and see).
  1005.  
  1006.  
  1007. diskiograph_read (device) (height),(width) (gradient colour 1) (gradi‐
  1008. ent colour 2) (scale) (-t) (-l)
  1009. Disk IO graph for reads, colours defined in hex, minus the #. If
  1010. scale is non-zero, it becomes the scale for the graph. Device as
  1011. in diskio. Uses a logarithmic scale (to see small numbers) when
  1012. you use -l switch. Takes the switch '-t' to use a temperature
  1013. gradient, which makes the gradient values change depending on
  1014. the amplitude of a particular graph value (try it and see).
  1015.  
  1016.  
  1017. diskiograph_write (device) (height),(width) (gradient colour 1) (gradi‐
  1018. ent colour 2) (scale) (-t) (-l)
  1019. Disk IO graph for writes, colours defined in hex, minus the #.
  1020. If scale is non-zero, it becomes the scale for the graph. Device
  1021. as in diskio. Uses a logarithmic scale (to see small numbers)
  1022. when you use -l switch. Takes the switch '-t' to use a tempera‐
  1023. ture gradient, which makes the gradient values change depending
  1024. on the amplitude of a particular graph value (try it and see).
  1025.  
  1026.  
  1027. downspeed (net)
  1028. Download speed in suitable IEC units
  1029.  
  1030.  
  1031. downspeedf (net)
  1032. Download speed in KiB with one decimal
  1033.  
  1034.  
  1035. downspeedgraph (netdev) (height),(width) (gradient colour 1) (gradient
  1036. colour 2) (scale) (-t) (-l)
  1037. Download speed graph, colours defined in hex, minus the #. If
  1038. scale is non-zero, it becomes the scale for the graph. Uses a
  1039. logarithmic scale (to see small numbers) when you use -l switch.
  1040. Takes the switch '-t' to use a temperature gradient, which makes
  1041. the gradient values change depending on the amplitude of a par‐
  1042. ticular graph value (try it and see).
  1043.  
  1044.  
  1045. draft_mails (maildir) (interval)
  1046. Number of mails marked as draft in the specified mailbox or mail
  1047. spool if not. Only maildir type mailboxes are supported, mbox
  1048. type will return -1.
  1049.  
  1050.  
  1051. else Text to show if any of the above are not true
  1052.  
  1053.  
  1054. endif Ends an $if block.
  1055.  
  1056.  
  1057. entropy_avail
  1058. Current entropy available for crypto freaks
  1059.  
  1060.  
  1061. entropy_bar (height),(width)
  1062. Normalized bar of available entropy for crypto freaks
  1063.  
  1064.  
  1065. entropy_perc
  1066. Percentage of entropy available in comparison to the poolsize
  1067.  
  1068.  
  1069. entropy_poolsize
  1070. Total size of system entropy pool for crypto freaks
  1071.  
  1072.  
  1073. eval string
  1074. Evaluates given string according to the rules of TEXT interpre‐
  1075. tation, i.e. parsing any contained text object specifications
  1076. into their output, any occuring '$$' into a single '$' and so
  1077. on. The output is then being parsed again.
  1078.  
  1079.  
  1080. eve api_userid api_key character_id
  1081. Fetches your currently training skill from the Eve Online API
  1082. servers (http://www.eve-online.com/) and displays the skill
  1083. along with the remaining training time.
  1084.  
  1085.  
  1086. exec command
  1087. Executes a shell command and displays the output in conky. warn‐
  1088. ing: this takes a lot more resources than other variables. I'd
  1089. recommend coding wanted behaviour in C and posting a patch.
  1090.  
  1091.  
  1092. execbar command
  1093. Same as exec, except if the first value return is a value be‐
  1094. tween 0-100, it will use that number for a bar. The size for
  1095. bars can be controlled via the default_bar_size config setting.
  1096.  
  1097.  
  1098. execgauge command
  1099. Same as exec, except if the first value returned is a value be‐
  1100. tween 0-100, it will use that number for a gauge. The size for
  1101. gauges can be controlled via the default_gauge_size config set‐
  1102. ting.
  1103.  
  1104.  
  1105. execgraph (-t) (-l) command
  1106. Same as execbar, but graphs values. Uses a logaritmic scale when
  1107. the log option (-l switch) is given (to see small numbers). Val‐
  1108. ues still have to be between 0 and 100. The size for graphs can
  1109. be controlled via the default_graph_size config setting. Takes
  1110. the switch '-t' to use a temperature gradient, which makes the
  1111. gradient values change depending on the amplitude of a particu‐
  1112. lar graph value (try it and see). If -t or -l is your first ar‐
  1113. gument, you may need to preceed it by a space (' ').
  1114.  
  1115.  
  1116. execi interval command
  1117. Same as exec but with specific interval. Interval can't be less
  1118. than update_interval in configuration. See also $texeci
  1119.  
  1120.  
  1121. execibar interval command
  1122. Same as execbar, except with an interval
  1123.  
  1124.  
  1125. execigauge interval command
  1126. Same as execgauge, but takes an interval arg and gauges values.
  1127.  
  1128.  
  1129. execigraph interval (-t) (-l) command
  1130. Same as execgraph, but takes an interval arg and graphs values.
  1131. If -t or -l is your first argument, you may need to preceed it
  1132. by a space (' ').
  1133.  
  1134.  
  1135. execp command
  1136. Executes a shell command and displays the output in conky. warn‐
  1137. ing: this takes a lot more resources than other variables. I'd
  1138. recommend coding wanted behaviour in C and posting a patch. This
  1139. differs from $exec in that it parses the output of the command,
  1140. so you can insert things like ${color red}hi!${color} in your
  1141. script and have it correctly parsed by Conky. Caveats: Conky
  1142. parses and evaluates the output of $execp every time Conky
  1143. loops, and then destroys all the objects. If you try to use any‐
  1144. thing like $execi within an $execp statement, it will function‐
  1145. ally run at the same interval that the $execp statement runs, as
  1146. it is created and destroyed at every interval.
  1147.  
  1148.  
  1149. execpi interval command
  1150. Same as execp but with specific interval. Interval can't be
  1151. less than update_interval in configuration. Note that the output
  1152. from the $execpi command is still parsed and evaluated at every
  1153. interval.
  1154.  
  1155.  
  1156. flagged_mails (maildir) (interval)
  1157. Number of mails marked as flagged in the specified mailbox or
  1158. mail spool if not. Only maildir type mailboxes are supported,
  1159. mbox type will return -1.
  1160.  
  1161.  
  1162. font (font)
  1163. Specify a different font. This new font will apply to the cur‐
  1164. rent line and everything following. You can use a $font with no
  1165. arguments to change back to the default font (much like with
  1166. $color)
  1167.  
  1168.  
  1169. format_time seconds format
  1170. Format time given in seconds. This var only works when the
  1171. times_in_seconds configuration setting is on. Format is a string
  1172. that should start and end with a "-char. The "-chars are not
  1173. part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
  1174. weeks,days,hours,minutes,seconds,(,) and \. If you leave out a
  1175. unit, it's value will be expressed in the highest unite lower
  1176. then the one left out. Text between ()-chars will not be visible
  1177. if a replaced unit in this text is 0. If seconds is a decimal
  1178. number then you can see the numbers behind the point by using \S
  1179. followed by a number that specifies the amount of digits behind
  1180. the point that you want to see (maximum 9). You can also place
  1181. a 'x' behind \S so you have all digits behind the point and no
  1182. trailing zero's. (also maximum 9)
  1183.  
  1184.  
  1185. forwarded_mails (maildir) (interval)
  1186. Number of mails marked as forwarded in the specified mailbox or
  1187. mail spool if not. Only maildir type mailboxes are supported,
  1188. mbox type will return -1.
  1189.  
  1190.  
  1191. freq (n)
  1192. Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
  1193. omitted, the parameter defaults to 1.
  1194.  
  1195.  
  1196. freq_g (n)
  1197. Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
  1198. omitted, the parameter defaults to 1.
  1199.  
  1200.  
  1201. fs_bar (height),(width) fs
  1202. Bar that shows how much space is used on a file system. height
  1203. is the height in pixels. fs is any file on that file system.
  1204.  
  1205.  
  1206. fs_bar_free (height),(width) fs
  1207. Bar that shows how much space is free on a file system. height
  1208. is the height in pixels. fs is any file on that file system.
  1209.  
  1210.  
  1211. fs_free (fs)
  1212. Free space on a file system available for users.
  1213.  
  1214.  
  1215. fs_free_perc (fs)
  1216. Free percentage of space on a file system available for users.
  1217.  
  1218.  
  1219. fs_size (fs)
  1220. File system size.
  1221.  
  1222.  
  1223. fs_type (fs)
  1224. File system type.
  1225.  
  1226.  
  1227. fs_used (fs)
  1228. File system used space.
  1229.  
  1230.  
  1231. fs_used_perc (fs)
  1232. Percent of file system used space.
  1233.  
  1234.  
  1235. goto x The next element will be printed at position 'x'.
  1236.  
  1237.  
  1238. gw_iface
  1239. Displays the default route's interface or "multiple"/"none" ac‐
  1240. cordingly.
  1241.  
  1242.  
  1243. gw_ip Displays the default gateway's IP or "multiple"/"none" accord‐
  1244. ingly.
  1245.  
  1246.  
  1247. hddtemp (dev)
  1248. Displays temperature of a selected hard disk drive as reported
  1249. by the hddtemp daemon. Use hddtemp_host and hddtemp_port to
  1250. specify a host and port for all hddtemp objects. If no dev pa‐
  1251. rameter is given, the first disk returned by the hddtemp daemon
  1252. is used.
  1253.  
  1254.  
  1255. head logfile lines (next_check)
  1256. Displays first N lines of supplied text file. The file is
  1257. checked every 'next_check' update. If next_check is not sup‐
  1258. plied, Conky defaults to 2. Max of 30 lines can be displayed, or
  1259. until the text buffer is filled.
  1260.  
  1261.  
  1262. hr (height)
  1263. Horizontal line, height is the height in pixels
  1264.  
  1265.  
  1266. hwmon (dev) type n (factor offset)
  1267. Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
  1268. ted if you have only one hwmon device. Parameter type is either
  1269. 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
  1270. temperature. Parameter n is number of the sensor. See
  1271. /sys/class/hwmon/ on your local computer. The optional arguments
  1272. 'factor' and 'offset' allow precalculation of the raw input,
  1273. which is being modified as follows: 'input = input * factor +
  1274. offset'. Note that they have to be given as decimal values (i.e.
  1275. contain at least one decimal place).
  1276.  
  1277.  
  1278. i2c (dev) type n (factor offset)
  1279. I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
  1280. if you have only one I2C device. Parameter type is either 'in'
  1281. or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
  1282. perature. Parameter n is number of the sensor. See
  1283. /sys/bus/i2c/devices/ on your local computer. The optional argu‐
  1284. ments 'factor' and 'offset' allow precalculation of the raw in‐
  1285. put, which is being modified as follows: 'input = input * factor
  1286. + offset'. Note that they have to be given as decimal values
  1287. (i.e. contain at least one decimal place).
  1288.  
  1289.  
  1290. i8k_ac_status
  1291. If running the i8k kernel driver for Inspiron laptops, displays
  1292. whether ac power is on, as listed in /proc/i8k (translated to
  1293. human-readable). Beware that this is by default not enabled by
  1294. i8k itself.
  1295.  
  1296.  
  1297. i8k_bios
  1298. If running the i8k kernel driver for Inspiron laptops, displays
  1299. the bios version as listed in /proc/i8k.
  1300.  
  1301.  
  1302. i8k_buttons_status
  1303. If running the i8k kernel driver for Inspiron laptops, displays
  1304. the volume buttons status as listed in /proc/i8k.
  1305.  
  1306.  
  1307. i8k_cpu_temp
  1308. If running the i8k kernel driver for Inspiron laptops, displays
  1309. the cpu temperature in Celsius, as reported by /proc/i8k.
  1310.  
  1311.  
  1312. i8k_left_fan_rpm
  1313. If running the i8k kernel driver for Inspiron laptops, displays
  1314. the left fan's rate of rotation, in revolutions per minute as
  1315. listed in /proc/i8k. Beware, some laptops i8k reports these fans
  1316. in reverse order.
  1317.  
  1318.  
  1319. i8k_left_fan_status
  1320. If running the i8k kernel driver for Inspiron laptops, displays
  1321. the left fan status as listed in /proc/i8k (translated to human-
  1322. readable). Beware, some laptops i8k reports these fans in re‐
  1323. verse order.
  1324.  
  1325.  
  1326. i8k_right_fan_rpm
  1327. If running the i8k kernel driver for Inspiron laptops, displays
  1328. the right fan's rate of rotation, in revolutions per minute as
  1329. listed in /proc/i8k. Beware, some laptops i8k reports these fans
  1330. in reverse order.
  1331.  
  1332.  
  1333. i8k_right_fan_status
  1334. If running the i8k kernel driver for Inspiron laptops, displays
  1335. the right fan status as listed in /proc/i8k (translated to hu‐
  1336. man-readable). Beware, some laptops i8k reports these fans in
  1337. reverse order.
  1338.  
  1339.  
  1340. i8k_serial
  1341. If running the i8k kernel driver for Inspiron laptops, displays
  1342. your laptop serial number as listed in /proc/i8k.
  1343.  
  1344.  
  1345. i8k_version
  1346. If running the i8k kernel driver for Inspiron laptops, displays
  1347. the version formatting of /proc/i8k.
  1348.  
  1349.  
  1350. ibm_brightness
  1351. If running the IBM ACPI, displays the brigtness of the laptops's
  1352. LCD (0-7).
  1353.  
  1354.  
  1355. ibm_fan
  1356. If running the IBM ACPI, displays the fan speed.
  1357.  
  1358.  
  1359. ibm_temps N
  1360. If running the IBM ACPI, displays the temperatures from the IBM
  1361. temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
  1362. GPU.
  1363.  
  1364.  
  1365. ibm_volume
  1366. If running the IBM ACPI, displays the "master" volume, con‐
  1367. trolled by the volume keys (0-14).
  1368.  
  1369.  
  1370. iconv_start codeset_from codeset_to
  1371. Convert text from one codeset to another using GNU iconv. Needs
  1372. to be stopped with iconv_stop.
  1373.  
  1374.  
  1375. iconv_stop
  1376. Stop iconv codeset conversion.
  1377.  
  1378.  
  1379. if_empty (var)
  1380. if conky variable VAR is empty, display everything between
  1381. $if_empty and the matching $endif
  1382.  
  1383.  
  1384. if_existing file (string)
  1385. if FILE exists, display everything between if_existing and the
  1386. matching $endif. The optional second parameter checks for FILE
  1387. containing the specified string and prints everything between
  1388. $if_existing and the matching $endif.
  1389.  
  1390.  
  1391. if_gw if there is at least one default gateway, display everything be‐
  1392. tween $if_gw and the matching $endif
  1393.  
  1394.  
  1395. if_match expression
  1396. Evaluates the given boolean expression, printing everything be‐
  1397. tween $if_match and the matching $endif depending on whether the
  1398. evaluation returns true or not. Valid expressions consist of a
  1399. left side, an operator and a right side. Left and right sides
  1400. are being parsed for contained text objects before evaluation.
  1401. Recognised left and right side types are:
  1402.  
  1403. doubleArgument consists of only digits and a single dot.
  1404. longArgument consists of only digits.
  1405. stringArgument is enclosed in quotation marks (")
  1406.  
  1407. Valid operands are: '>', '<', '>=', '<=', '==', '!='.
  1408.  
  1409.  
  1410. if_mixer_mute (mixer)
  1411. If mixer exists, display everything between $if_mixer_mute and
  1412. the matching $endif. If no mixer is specified, "Vol" is used.
  1413.  
  1414.  
  1415. if_mounted (mountpoint)
  1416. if MOUNTPOINT is mounted, display everything between $if_mounted
  1417. and the matching $endif
  1418.  
  1419.  
  1420. if_mpd_playing
  1421. if mpd is playing or paused, display everything between
  1422. $if_mpd_playing and the matching $endif
  1423.  
  1424.  
  1425. if_running (process)
  1426. if PROCESS is running, display everything $if_running and the
  1427. matching $endif. This uses the ``pidof'' command, so the -x
  1428. switch is also supported.
  1429.  
  1430.  
  1431. if_smapi_bat_installed (INDEX)
  1432. when using smapi, if the battery with index INDEX is installed,
  1433. display everything between $if_smapi_bat_installed and the
  1434. matching $endif
  1435.  
  1436.  
  1437. if_up (interface)
  1438. if INTERFACE exists and is up, display everything between $if_up
  1439. and the matching $endif
  1440.  
  1441.  
  1442. if_updatenr (updatenr)
  1443. If it's the UPDATENR-th time that conky updates, display every‐
  1444. thing between $if_updatenr and the matching $endif. The counter
  1445. resets when the highest UPDATENR is reached. Example : "{$if_up‐
  1446. datenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$en‐
  1447. dif" shows foo 25% of the time followed by bar 25% of the time
  1448. followed by nothing the other half of the time.
  1449.  
  1450.  
  1451. if_xmms2_connected
  1452. Display everything between $if_xmms2_connected and the matching
  1453. $endif if xmms2 is running.
  1454.  
  1455.  
  1456. image <path to image> (-p x,y) (-s WxH) (-n) (-f interval)
  1457. Renders an image from the path specified using Imlib2. Takes 4
  1458. optional arguments: a position, a size, a no-cache switch, and a
  1459. cache flush interval. Changing the x,y position will move the
  1460. position of the image, and changing the WxH will scale the im‐
  1461. age. If you specify the no-cache flag (-n), the image will not
  1462. be cached. Alternately, you can specify the -f int switch to
  1463. specify a cache flust interval for a particular image. Example:
  1464. ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200} will
  1465. render 'cheeseburger.jpg' at (20,20) scaled to 200x200 pixels.
  1466. Conky does not make any attempt to adjust the position (or any
  1467. other formatting) of images, they are just rendered as per the
  1468. arguments passed. The only reason $image is part of the TEXT
  1469. section, is to allow for runtime modifications, through $execp
  1470. $lua_parse, or some other method.
  1471.  
  1472.  
  1473. imap_messages (args)
  1474. Displays the number of messages in your global IMAP inbox by de‐
  1475. fault. You can define individual IMAP inboxes separately by
  1476. passing arguments to this object. Arguments are: "host user
  1477. pass [-i interval (in seconds)] [-f 'folder'] [-p port] [-e
  1478. 'command'] [-r retries]". Default port is 143, default folder is
  1479. 'INBOX', default interval is 5 minutes, and default number of
  1480. retries before giving up is 5. If the password is supplied as
  1481. '*', you will be prompted to enter the password when Conky
  1482. starts.
  1483.  
  1484.  
  1485. imap_unseen (args)
  1486. Displays the number of unseen messages in your global IMAP inbox
  1487. by default. You can define individual IMAP inboxes separately by
  1488. passing arguments to this object. Arguments are: "host user pass
  1489. [-i interval (in seconds)] [-f 'folder'] [-p port] [-e 'com‐
  1490. mand'] [-r retries]". Default port is 143, default folder is
  1491. 'INBOX', default interval is 5 minutes, and default number of
  1492. retries before giving up is 5. If the password is supplied as
  1493. '*', you will be prompted to enter the password when Conky
  1494. starts.
  1495.  
  1496.  
  1497. include path
  1498. Loads the configfile at path, places the configsettings behind
  1499. the configsettings in the orginal config and places the vars
  1500. where the includevar stood.
  1501.  
  1502. ioscheduler disk
  1503. Prints the current ioscheduler used for the given disk name
  1504. (i.e. e.g. "hda" or "sdb")
  1505.  
  1506.  
  1507. kernel Kernel version
  1508.  
  1509.  
  1510. laptop_mode
  1511. The value of /proc/sys/vm/laptop_mode
  1512.  
  1513.  
  1514. lines textfile
  1515. Displays the number of lines in the given file
  1516.  
  1517.  
  1518. loadavg (1|2|3)
  1519. System load average, 1 is for past 1 minute, 2 for past 5 min‐
  1520. utes and 3 for past 15 minutes. Without argument, prints all
  1521. three values separated by whitespace.
  1522.  
  1523.  
  1524. loadgraph (height),(width) (gradient colour 1) (gradient colour 2)
  1525. (scale) (-t) (-l)
  1526. Load1 average graph, similar to xload, with optional colours in
  1527. hex, minus the #. Uses a logarithmic scale (to see small num‐
  1528. bers) when you use the -l switch. Takes the switch '-t' to use
  1529. a temperature gradient, which makes the gradient values change
  1530. depending on the amplitude of a particular graph value (try it
  1531. and see).
  1532.  
  1533.  
  1534. lua function_name (function parameters)
  1535. Executes a Lua function with given parameters, then prints the
  1536. returned string. See also 'lua_load' on how to load scripts.
  1537. Conky puts 'conky_' in front of function_name to prevent acci‐
  1538. dental calls to the wrong function unless you put you place
  1539. 'conky_' in front of it yourself.
  1540.  
  1541.  
  1542. lua_bar (height, width) function_name (function parameters)
  1543. Executes a Lua function with given parameters and draws a bar.
  1544. Expects result value to be an integer between 0 and 100. See al‐
  1545. so 'lua_load' on how to load scripts. Conky puts 'conky_' in
  1546. front of function_name to prevent accidental calls to the wrong
  1547. function unless you put you place 'conky_' in front of it your‐
  1548. self.
  1549.  
  1550.  
  1551. lua_gauge (height, width) function_name (function parameters)
  1552. Executes a Lua function with given parameters and draws a gauge.
  1553. Expects result value to be an integer between 0 and 100. See al‐
  1554. so 'lua_load' on how to load scripts. Conky puts 'conky_' in
  1555. front of function_name to prevent accidental calls to the wrong
  1556. function unless you put you place 'conky_' in front of it your‐
  1557. self.
  1558.  
  1559.  
  1560. lua_graph function_name (height),(width) (gradient colour 1) (gradient
  1561. colour 2) (scale) (-t) (-l)
  1562. Executes a Lua function with and draws a graph. Expects result
  1563. value to be any number, and by default will scale to show the
  1564. full range. See also 'lua_load' on how to load scripts. Takes
  1565. the switch '-t' to use a temperature gradient, which makes the
  1566. gradient values change depending on the amplitude of a particu‐
  1567. lar graph value (try it and see). Conky puts 'conky_' in front
  1568. of function_name to prevent accidental calls to the wrong func‐
  1569. tion unless you put you place 'conky_' in front of it yourself.
  1570.  
  1571.  
  1572. lua_parse function_name (function parameters)
  1573. Executes a Lua function with given parameters as per $lua, then
  1574. parses and prints the result value as per the syntax for Conky's
  1575. TEXT section. See also 'lua_load' on how to load scripts. Conky
  1576. puts 'conky_' in front of function_name to prevent accidental
  1577. calls to the wrong function unless you put you place 'conky_' in
  1578. front of it yourself.
  1579.  
  1580.  
  1581. machine
  1582. Machine, i686 for example
  1583.  
  1584.  
  1585. mails (mailbox) (interval)
  1586. Mail count in the specified mailbox or your mail spool if not.
  1587. Both mbox and maildir type mailboxes are supported. You can use
  1588. a program like fetchmail to get mails from some server using
  1589. your favourite protocol. See also new_mails.
  1590.  
  1591.  
  1592. mboxscan (-n number of messages to print) (-fw from width) (-sw subject
  1593. width) mbox
  1594. Print a summary of recent messages in an mbox format mailbox.
  1595. mbox parameter is the filename of the mailbox (can be encapsu‐
  1596. lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
  1597.  
  1598.  
  1599. mem Amount of memory in use
  1600.  
  1601.  
  1602. membar (height),(width)
  1603. Bar that shows amount of memory in use
  1604.  
  1605.  
  1606. memeasyfree
  1607. Amount of free memory including the memory that is very easily
  1608. freed (buffers/cache)
  1609.  
  1610.  
  1611. memfree
  1612. Amount of free memory
  1613.  
  1614.  
  1615. memgauge (height),(width)
  1616. Gauge that shows amount of memory in use (see cpugauge)
  1617.  
  1618.  
  1619. memgraph (height),(width) (gradient colour 1) (gradient colour 2)
  1620. (scale) (-t) (-l)
  1621. Memory usage graph. Uses a logarithmic scale (to see small num‐
  1622. bers) when you use the -l switch. Takes the switch '-t' to use a
  1623. temperature gradient, which makes the gradient values change de‐
  1624. pending on the amplitude of a particular graph value (try it and
  1625. see).
  1626.  
  1627.  
  1628. memmax Total amount of memory
  1629.  
  1630.  
  1631. memperc
  1632. Percentage of memory in use
  1633.  
  1634.  
  1635. mixer (device)
  1636. Prints the mixer value as reported by the OS. On Linux, this
  1637. variable uses the OSS emulation, so you need the proper kernel
  1638. module loaded. Default mixer is "Vol", but you can specify one
  1639. of the available OSS controls: "Vol", "Bass", "Trebl", "Synth",
  1640. "Pcm", "Spkr", "Line", "Mic", "CD", "Mix", "Pcm2 ", "Rec",
  1641. "IGain", "OGain", "Line1", "Line2", "Line3", "Digital1", "Digi‐
  1642. tal2", "Digital3", "PhoneIn", "PhoneOut", "Video", "Radio" and
  1643. "Monitor".
  1644.  
  1645.  
  1646. mixerbar (device)
  1647. Displays mixer value in a bar as reported by the OS. See docs
  1648. for $mixer for details on arguments.
  1649.  
  1650.  
  1651. mixerl (device)
  1652. Prints the left channel mixer value as reported by the OS. See
  1653. docs for $mixer for details on arguments.
  1654.  
  1655.  
  1656. mixerlbar (device)
  1657. Displays the left channel mixer value in a bar as reported by
  1658. the OS. See docs for $mixer for details on arguments.
  1659.  
  1660.  
  1661. mixerr (device)
  1662. Prints the right channel mixer value as reported by the OS. See
  1663. docs for $mixer for details on arguments.
  1664.  
  1665.  
  1666. mixerrbar (device)
  1667. Displays the right channel mixer value in a bar as reported by
  1668. the OS. See docs for $mixer for details on arguments.
  1669.  
  1670.  
  1671. moc_album
  1672. Album of the current MOC song
  1673.  
  1674.  
  1675. moc_artist
  1676. Artist of the current MOC song
  1677.  
  1678.  
  1679. moc_bitrate
  1680. Bitrate in the current MOC song
  1681.  
  1682.  
  1683. moc_curtime
  1684. Current time of the current MOC song
  1685.  
  1686.  
  1687. moc_file
  1688. File name of the current MOC song
  1689.  
  1690.  
  1691. moc_rate
  1692. Rate of the current MOC song
  1693.  
  1694.  
  1695. moc_song
  1696. The current song name being played in MOC.
  1697.  
  1698.  
  1699. moc_state
  1700. Current state of MOC; playing, stopped etc.
  1701.  
  1702.  
  1703. moc_timeleft
  1704. Time left in the current MOC song
  1705.  
  1706.  
  1707. moc_title
  1708. Title of the current MOC song
  1709.  
  1710.  
  1711. moc_totaltime
  1712. Total length of the current MOC song
  1713.  
  1714.  
  1715. monitor
  1716. Number of the monitor on which conky is running or the message
  1717. "Not running in X" if this is the case.
  1718.  
  1719.  
  1720. monitor_number
  1721. Number of monitors or the message "Not running in X" if this is
  1722. the case.
  1723.  
  1724.  
  1725. mpd_album
  1726. Album in current MPD song
  1727.  
  1728.  
  1729. mpd_artist
  1730. Artist in current MPD song must be enabled at compile
  1731.  
  1732.  
  1733. mpd_bar (height),(width)
  1734. Bar of mpd's progress
  1735.  
  1736.  
  1737. mpd_bitrate
  1738. Bitrate of current song
  1739.  
  1740.  
  1741. mpd_date
  1742. Date of current song
  1743.  
  1744.  
  1745. mpd_elapsed
  1746. Song's elapsed time
  1747.  
  1748.  
  1749. mpd_file
  1750. Prints the file name of the current MPD song
  1751.  
  1752.  
  1753. mpd_length
  1754. Song's length
  1755.  
  1756.  
  1757. mpd_name
  1758. Prints the MPD name field
  1759.  
  1760.  
  1761. mpd_percent
  1762. Percent of song's progress
  1763.  
  1764.  
  1765. mpd_random
  1766. Random status (On/Off)
  1767.  
  1768.  
  1769. mpd_repeat
  1770. Repeat status (On/Off)
  1771.  
  1772.  
  1773. mpd_smart (max length)
  1774. Prints the song name in either the form "artist - title" or file
  1775. name, depending on whats available
  1776.  
  1777.  
  1778. mpd_status
  1779. Playing, stopped, et cetera.
  1780.  
  1781.  
  1782. mpd_title (max length)
  1783. Title of current MPD song
  1784.  
  1785.  
  1786. mpd_track
  1787. Prints the MPD track field
  1788.  
  1789.  
  1790. mpd_vol
  1791. MPD's volume
  1792.  
  1793.  
  1794. nameserver (index)
  1795. Print a nameserver from /etc/resolv.conf. Index starts at and
  1796. defaults to 0.
  1797.  
  1798.  
  1799. new_mails (mailbox) (interval)
  1800. Unread mail count in the specified mailbox or mail spool if not.
  1801. Both mbox and maildir type mailboxes are supported.
  1802.  
  1803.  
  1804. nodename
  1805. Hostname
  1806.  
  1807.  
  1808. nodename_short
  1809. Short hostname (same as 'hostname -s' shell command).
  1810.  
  1811.  
  1812. nvidia threshold temp ambient gpufreq memfreq imagequality
  1813. Nvidia graficcard support for the XNVCtrl library. Each option
  1814. can be shortened to the least significant part. Temperatures are
  1815. printed as float, all other values as integer.
  1816.  
  1817. threshold The thresholdtemperature at which the gpu slows down
  1818. temp Gives the gpu current temperature
  1819. ambient Gives current air temperature near GPU case
  1820. gpufreq Gives the current gpu frequency
  1821. memfreq Gives the current mem frequency
  1822. imagequality Which imagequality should be chosen by OpenGL ap‐
  1823. plications
  1824.  
  1825.  
  1826. offset (pixels)
  1827. Move text over by N pixels. See also $voffset.
  1828.  
  1829.  
  1830. outlinecolor (color)
  1831. Change outline color
  1832.  
  1833.  
  1834. pb_battery item
  1835. If running on Apple powerbook/ibook, display information on bat‐
  1836. tery status. The item parameter specifies, what information to
  1837. display. Exactly one item must be specified. Valid items are:
  1838.  
  1839. status Display if battery is fully charged, charging, discharg‐
  1840. ing or absent (running on AC)
  1841. percent Display charge of battery in percent, if charging or
  1842. discharging. Nothing will be displayed, if battery is fully
  1843. charged or absent.
  1844. time Display the time remaining until the battery will be fully
  1845. charged or discharged at current rate. Nothing is displayed, if
  1846. battery is absent or if it's present but fully charged and not
  1847. discharging.
  1848.  
  1849.  
  1850. pid_chroot pid
  1851. Directory used as rootdirectory by the process (this will be "/"
  1852. unless the process did a chroot syscall)
  1853.  
  1854.  
  1855. pid_cmdline pid
  1856. Command line this process was invoked with
  1857.  
  1858.  
  1859. pid_cwd pid
  1860. Current working directory of the process
  1861.  
  1862.  
  1863. pid_environ pid varname
  1864. Contents of a environment-var of the process
  1865.  
  1866.  
  1867. pid_environ_list pid
  1868. List of environment-vars that the process can see
  1869.  
  1870.  
  1871. pid_exe pid
  1872. Path to executed command that started the process
  1873.  
  1874.  
  1875. pid_nice pid
  1876. The nice value of the process
  1877.  
  1878.  
  1879. pid_openfiles pid
  1880. List of files that the process has open
  1881.  
  1882.  
  1883. pid_parent pid
  1884. The pid of the parent of the process
  1885.  
  1886.  
  1887. pid_priority pid
  1888. The priority of the process (see 'priority' in "man 5 proc")
  1889.  
  1890.  
  1891. pid_read pid
  1892. Total number of bytes read by the process
  1893.  
  1894.  
  1895. pid_state pid
  1896. State of the process
  1897.  
  1898.  
  1899. pid_state_short pid
  1900. One of the chars in "RSDZTW" representing the state of the
  1901. process where R is running, S is sleeping in an interruptible
  1902. wait, D is waiting in uninterruptible disk sleep, Z is zombie, T
  1903. is traced or stopped (on a signal), and W is paging
  1904.  
  1905.  
  1906. pid_stderr pid
  1907. Filedescriptor binded to the STDERR of the process
  1908.  
  1909.  
  1910. pid_stdin pid
  1911. Filedescriptor binded to the STDIN of the process
  1912.  
  1913.  
  1914. pid_stdout pid
  1915. Filedescriptor binded to the STDOUT of the process
  1916.  
  1917.  
  1918. pid_threads pid
  1919. Number of threads in process containing this thread
  1920.  
  1921.  
  1922. pid_thread_list pid
  1923. List with pid's from threads from this process
  1924.  
  1925.  
  1926. pid_time_kernelmode pid
  1927. Amount of time that the process has been scheduled in kernel
  1928. mode in seconds
  1929.  
  1930.  
  1931. pid_time_usermode pid
  1932. Amount of time that the process has been scheduled in user mode
  1933. in seconds
  1934.  
  1935.  
  1936. pid_time pid
  1937. Sum of $pid_time_kernelmode and $pid_time_usermode
  1938.  
  1939.  
  1940. pid_uid pid
  1941. The real uid of the process
  1942.  
  1943.  
  1944. pid_euid pid
  1945. The effective uid of the process
  1946.  
  1947.  
  1948. pid_suid pid
  1949. The saved set uid of the process
  1950.  
  1951.  
  1952. pid_fsuid pid
  1953. The file system uid of the process
  1954.  
  1955.  
  1956. pid_gid pid
  1957. The real gid of the process
  1958.  
  1959.  
  1960. pid_egid pid
  1961. The effective gid of the process
  1962.  
  1963.  
  1964. pid_sgid pid
  1965. The saved set gid of the process
  1966.  
  1967.  
  1968. pid_fsgid pid
  1969. The file system gid of the process
  1970.  
  1971.  
  1972. pid_vmpeak pid
  1973. Peak virtual memory size of the process
  1974.  
  1975.  
  1976. pid_vmsize pid
  1977. Virtual memory size of the process
  1978.  
  1979.  
  1980. pid_vmlck pid
  1981. Locked memory size of the process
  1982.  
  1983.  
  1984. pid_vmhwm pid
  1985. Peak resident set size ("high water mark") of the process
  1986.  
  1987.  
  1988. pid_vmrss pid
  1989. Resident set size of the process
  1990.  
  1991.  
  1992. pid_vmdata pid
  1993. Data segment size of the process
  1994.  
  1995.  
  1996. pid_vmstk pid
  1997. Stack segment size of the process
  1998.  
  1999.  
  2000. pid_vmexe pid
  2001. Text segment size of the process
  2002.  
  2003.  
  2004. pid_vmlib pid
  2005. Shared library code size of the process
  2006.  
  2007.  
  2008. pid_vmpte pid
  2009. Page table entries size of the process
  2010.  
  2011.  
  2012. pid_write pid
  2013. Total number of bytes written by the process
  2014.  
  2015.  
  2016. platform (dev) type n (factor offset)
  2017. Platform sensor from sysfs (Linux 2.6). Parameter dev may be
  2018. omitted if you have only one platform device. Platform type is
  2019. either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
  2020. meaning temperature. Parameter n is number of the sensor. See
  2021. /sys/bus/platform/devices/ on your local computer. The optional
  2022. arguments 'factor' and 'offset' allow precalculation of the raw
  2023. input, which is being modified as follows: 'input = input * fac‐
  2024. tor + offset'. Note that they have to be given as decimal values
  2025. (i.e. contain at least one decimal place).
  2026.  
  2027.  
  2028. pop3_unseen (args)
  2029. Displays the number of unseen messages in your global POP3 inbox
  2030. by default. You can define individual POP3 inboxes separately by
  2031. passing arguments to this object. Arguments are: "host user pass
  2032. [-i interval (in seconds)] [-p port] [-e 'command'] [-r re‐
  2033. tries]". Default port is 110, default interval is 5 minutes, and
  2034. default number of retries before giving up is 5. If the password
  2035. is supplied as '*', you will be prompted to enter the password
  2036. when Conky starts.
  2037.  
  2038.  
  2039. pop3_used (args)
  2040. Displays the amount of space (in MiB, 2^20) used in your global
  2041. POP3 inbox by default. You can define individual POP3 inboxes
  2042. separately by passing arguments to this object. Arguments are:
  2043. "host user pass [-i interval (in seconds)] [-p port] [-e 'com‐
  2044. mand'] [-r retries]". Default port is 110, default interval is 5
  2045. minutes, and default number of retries before giving up is 5. If
  2046. the password is supplied as '*', you will be prompted to enter
  2047. the password when Conky starts.
  2048.  
  2049.  
  2050. pre_exec shell command
  2051. Executes a shell command one time before conky displays anything
  2052. and puts output as text.
  2053.  
  2054.  
  2055. processes
  2056. Total processes (sleeping and running)
  2057.  
  2058.  
  2059. read_tcp (host) port
  2060. Connects to a tcp port on a host (default is localhost), reads
  2061. every char available at the moment and shows them.
  2062.  
  2063.  
  2064. replied_mails (maildir) (interval)
  2065. Number of mails marked as replied in the specified mailbox or
  2066. mail spool if not. Only maildir type mailboxes are supported,
  2067. mbox type will return -1.
  2068.  
  2069.  
  2070. rss uri interval_in_minutes action (num_par (spaces_in_front))
  2071. Download and parse RSS feeds. The interval may be a floating
  2072. point value greater than 0, otherwise defaults to 15 minutes.
  2073. Action may be one of the following: feed_title, item_title (with
  2074. num par), item_desc (with num par) and item_titles (when using
  2075. this action and spaces_in_front is given conky places that many
  2076. spaces in front of each item). This object is threaded, and once
  2077. a thread is created it can't be explicitly destroyed. One thread
  2078. will run for each URI specified. You can use any protocol that
  2079. Curl supports.
  2080.  
  2081. running_processes
  2082. Running processes (not sleeping), requires Linux 2.6
  2083.  
  2084.  
  2085. running_threads
  2086. Number of running (runnable) threads. Linux only.
  2087.  
  2088.  
  2089. scroll length (step) text
  2090. Scroll 'text' by 'step' characters showing 'length' number of
  2091. characters at the same time. The text may also contain vari‐
  2092. ables. 'step' is optional and defaults to 1 if not set. If a var
  2093. creates output on multiple lines then the lines are placed be‐
  2094. hind each other separated with a '|'-sign. If you change the
  2095. textcolor inside $scroll it will automatically have it's old
  2096. value back at the end of $scroll. The end and the start of text
  2097. will be separated by 'length' number of spaces.
  2098.  
  2099.  
  2100. seen_mails (maildir) (interval)
  2101. Number of mails marked as seen in the specified mailbox or mail
  2102. spool if not. Only maildir type mailboxes are supported, mbox
  2103. type will return -1.
  2104.  
  2105.  
  2106. shadecolor (color)
  2107. Change shading color
  2108.  
  2109.  
  2110. smapi (ARGS)
  2111. when using smapi, display contents of the /sys/devices/plat‐
  2112. form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
  2113. DEX) (FILENAME)' to display the corresponding files' content.
  2114. This is a very raw method of accessing the smapi values. When
  2115. available, better use one of the smapi_* variables instead.
  2116.  
  2117.  
  2118. smapi_bat_bar (INDEX),(height),(width)
  2119. when using smapi, display the remaining capacity of the battery
  2120. with index INDEX as a bar.
  2121.  
  2122.  
  2123. smapi_bat_perc (INDEX)
  2124. when using smapi, display the remaining capacity in percent of
  2125. the battery with index INDEX. This is a separate variable be‐
  2126. cause it supports the 'use_spacer' configuration option.
  2127.  
  2128.  
  2129. smapi_bat_power INDEX
  2130. when using smapi, display the current power of the battery with
  2131. index INDEX in watt. This is a separate variable because the
  2132. original read out value is being converted from mW. The sign of
  2133. the output reflects charging (positive) or discharging (nega‐
  2134. tive) state.
  2135.  
  2136.  
  2137. smapi_bat_temp INDEX
  2138. when using smapi, display the current temperature of the battery
  2139. with index INDEX in degree Celsius. This is a separate variable
  2140. because the original read out value is being converted from mil‐
  2141. li degree Celsius.
  2142.  
  2143.  
  2144. sony_fanspeed
  2145. Displays the Sony VAIO fanspeed information if sony-laptop ker‐
  2146. nel support is enabled. Linux only.
  2147.  
  2148.  
  2149. stippled_hr (space)
  2150. Stippled (dashed) horizontal line
  2151.  
  2152.  
  2153. swap Amount of swap in use
  2154.  
  2155.  
  2156. swapbar (height),(width)
  2157. Bar that shows amount of swap in use
  2158.  
  2159.  
  2160. swapfree
  2161. Amount of free swap
  2162.  
  2163.  
  2164. swapmax
  2165. Total amount of swap
  2166.  
  2167.  
  2168. swapperc
  2169. Percentage of swap in use
  2170.  
  2171.  
  2172. sysname
  2173. System name, Linux for example
  2174.  
  2175.  
  2176. tab (width, (start))
  2177. Puts a tab of the specified width, starting from column 'start'.
  2178. The unit is pixels for both arguments.
  2179.  
  2180.  
  2181. tail logfile lines (next_check)
  2182. Displays last N lines of supplied text file. The file is checked
  2183. every 'next_check' update. If next_check is not supplied, Conky
  2184. defaults to 2. Max of 30 lines can be displayed, or until the
  2185. text buffer is filled.
  2186.  
  2187.  
  2188. tcp_portmon port_begin port_end item (index)
  2189. TCP port (both IPv6 and IPv4) monitor for specified local ports.
  2190. Port numbers must be in the range 1 to 65535. Valid items are:
  2191.  
  2192. count Total number of connections in the range
  2193. rip Remote ip address
  2194. rhost Remote host name
  2195. rport Remote port number
  2196. rservice Remote service name from /etc/services
  2197. lip Local ip address
  2198. lhost Local host name
  2199. lport Local port number
  2200. lservice Local service name from /etc/services
  2201.  
  2202. The connection index provides you with access to each connection
  2203. in the port monitor. The monitor will return information for in‐
  2204. dex values from 0 to n-1 connections. Values higher than n-1 are
  2205. simply ignored. For the "count" item, the connection index must
  2206. be omitted. It is required for all other items.
  2207.  
  2208. Examples:
  2209.  
  2210. ${tcp_portmon 6881 6999 count} Displays the number of connec‐
  2211. tions in the bittorrent port range
  2212. ${tcp_portmon 22 22 rip 0} Displays the remote host ip of the
  2213. first sshd connection
  2214. ${tcp_portmon 22 22 rip 9} Displays the remote host ip of the
  2215. tenth sshd connection
  2216. ${tcp_portmon 1 1024 rhost 0} Displays the remote host name of
  2217. the first connection on a privileged port
  2218. ${tcp_portmon 1 1024 rport 4} Displays the remote host port of
  2219. the fifth connection on a privileged port
  2220. ${tcp_portmon 1 65535 lservice 14} Displays the local service
  2221. name of the fifteenth connection in the range of all ports
  2222.  
  2223. Note that port monitor variables which share the same port range
  2224. actually refer to the same monitor, so many references to a sin‐
  2225. gle port range for different items and different indexes all use
  2226. the same monitor internally. In other words, the program avoids
  2227. creating redundant monitors.
  2228.  
  2229. templateN (arg1) (arg2) (arg3 ...)
  2230. Evaluate the content of the templateN configuration variable
  2231. (where N is a value between 0 and 9, inclusively), applying sub‐
  2232. stitutions as described in the documentation of the correspond‐
  2233. ing configuration variable. The number of arguments is optional,
  2234. but must match the highest referred index in the template. You
  2235. can use the same special sequences in each argument as the ones
  2236. valid for a template definition, e.g. to allow an argument to
  2237. contain a whitespace. Also simple nesting of templates is possi‐
  2238. ble this way.
  2239.  
  2240. Here are some examples of template definitions:
  2241.  
  2242. template0 $\1\2
  2243. template1 \1: ${fs_used \2} / ${fs_size \2}
  2244. template2 \1 \2
  2245.  
  2246. The following list shows sample usage of the templates defined
  2247. above, with the equivalent syntax when not using any template at
  2248. all:
  2249.  
  2250. using template same without template
  2251. ────────────────────────────────────────────────────────
  2252. ${template0 node name} $nodename
  2253. ${template1 root /} root: ${fs_free /} /
  2254. ${fs_size /}
  2255. ${template1 ${template2\ disk root: ${fs_free /} /
  2256. disk\ root} /} ${fs_size /}
  2257.  
  2258. texeci interval command
  2259. Runs a command at an interval inside a thread and displays the
  2260. output. Same as $execi, except the command is run inside a
  2261. thread. Use this if you have a slow script to keep Conky updat‐
  2262. ing. You should make the interval slightly longer then the time
  2263. it takes your script to execute. For example, if you have a
  2264. script that take 5 seconds to execute, you should make the in‐
  2265. terval at least 6 seconds. See also $execi. This object will
  2266. clean up the thread when it is destroyed, so it can safely be
  2267. used in a nested fashion, though it may not produce the desired
  2268. behaviour if used this way.
  2269.  
  2270.  
  2271. threads
  2272. Total threads
  2273.  
  2274.  
  2275. time (format)
  2276. Local time, see man strftime to get more information about for‐
  2277. mat
  2278.  
  2279.  
  2280. to_bytes size
  2281. If 'size' is a number followed by a size-unit (kilo‐
  2282. byte,mb,GiB,...) then it converts the size to bytes and shows it
  2283. without unit, otherwise it just shows 'size'.
  2284.  
  2285.  
  2286. top type num
  2287. This takes arguments in the form:top (name) (number) Basically,
  2288. processes are ranked from highest to lowest in terms of cpu us‐
  2289. age, which is what (num) represents. The types are: "name",
  2290. "pid", "cpu", "mem", "mem_res", "mem_vsize", "time", "uid", "us‐
  2291. er", "io_perc", "io_read" and "io_write". There can be a max of
  2292. 10 processes listed.
  2293.  
  2294.  
  2295. top_io type num
  2296. Same as top, except sorted by the amount of I/O the process has
  2297. done during the update interval
  2298.  
  2299.  
  2300. top_mem type num
  2301. Same as top, except sorted by mem usage instead of cpu
  2302.  
  2303.  
  2304. top_time type num
  2305. Same as top, except sorted by total CPU time instead of current
  2306. CPU usage
  2307.  
  2308.  
  2309. totaldown (net)
  2310. Total download, overflows at 4 GB on Linux with 32-bit arch and
  2311. there doesn't seem to be a way to know how many times it has al‐
  2312. ready done that before conky has started.
  2313.  
  2314.  
  2315. totalup (net)
  2316. Total upload, this one too, may overflow
  2317.  
  2318.  
  2319. trashed_mails (maildir) (interval)
  2320. Number of mails marked as trashed in the specified mailbox or
  2321. mail spool if not. Only maildir type mailboxes are supported,
  2322. mbox type will return -1.
  2323.  
  2324.  
  2325. tztime (timezone (format))
  2326. Local time for specified timezone, see man strftime to get more
  2327. information about format. The timezone argument is specified in
  2328. similar fashion as TZ environment variable. For hints, look in
  2329. /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
  2330.  
  2331.  
  2332. gid_name gid
  2333. Name of group with this gid
  2334.  
  2335.  
  2336. uid_name uid
  2337. Username of user with this uid
  2338.  
  2339.  
  2340. unflagged_mails (maildir) (interval)
  2341. Number of mails not marked as flagged in the specified mailbox
  2342. or mail spool if not. Only maildir type mailboxes are supported,
  2343. mbox type will return -1.
  2344.  
  2345.  
  2346. unforwarded_mails (maildir) (interval)
  2347. Number of mails not marked as forwarded in the specified mailbox
  2348. or mail spool if not. Only maildir type mailboxes are supported,
  2349. mbox type will return -1.
  2350.  
  2351.  
  2352. unreplied_mails (maildir) (interval)
  2353. Number of mails not marked as replied in the specified mailbox
  2354. or mail spool if not. Only maildir type mailboxes are supported,
  2355. mbox type will return -1.
  2356.  
  2357.  
  2358. unseen_mails (maildir) (interval)
  2359. Number of new or unseen mails in the specified mailbox or mail
  2360. spool if not. Only maildir type mailboxes are supported, mbox
  2361. type will return -1.
  2362.  
  2363.  
  2364. updates Number of updates
  2365. for debugging
  2366.  
  2367.  
  2368. upspeed (net)
  2369. Upload speed in suitable IEC units
  2370.  
  2371.  
  2372. upspeedf (net)
  2373. Upload speed in KiB with one decimal
  2374.  
  2375.  
  2376. upspeedgraph (netdev) (height),(width) (gradient colour 1) (gradient
  2377. colour 2) (scale) (-t) (-l)
  2378. Upload speed graph, colours defined in hex, minus the #. If
  2379. scale is non-zero, it becomes the scale for the graph. Uses a
  2380. logarithmic scale (to see small numbers) when you use the -l
  2381. switch. Takes the switch '-t' to use a temperature gradient,
  2382. which makes the gradient values change depending on the ampli‐
  2383. tude of a particular graph value (try it and see).
  2384.  
  2385.  
  2386. uptime Uptime
  2387.  
  2388.  
  2389. uptime_short
  2390. Uptime in a shorter format
  2391.  
  2392.  
  2393. user_names
  2394. Lists the names of the users logged in
  2395.  
  2396.  
  2397. user_number
  2398. Number of users logged in
  2399.  
  2400.  
  2401. user_terms
  2402. Lists the consoles in use
  2403.  
  2404.  
  2405. user_times
  2406. Lists how long users have been logged in for
  2407.  
  2408.  
  2409. user_time console
  2410. Lists how long the user for the given console has been logged in
  2411. for
  2412.  
  2413.  
  2414. utime (format)
  2415. Display time in UTC (universal coordinate time).
  2416.  
  2417.  
  2418. voffset (pixels)
  2419. Change vertical offset by N pixels. Negative values will cause
  2420. text to overlap. See also $offset.
  2421.  
  2422.  
  2423. voltage_mv (n)
  2424. Returns CPU #n's voltage in mV. CPUs are counted from 1. If
  2425. omitted, the parameter defaults to 1.
  2426.  
  2427.  
  2428. voltage_v (n)
  2429. Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
  2430. ted, the parameter defaults to 1.
  2431.  
  2432.  
  2433. weather URI locID data_type (interval_in_minutes)
  2434. Download, parse and display METAR data.
  2435.  
  2436. For the 'URI', there are two possibilities:
  2437.  
  2438. http://weather.noaa.gov/pub/data/observations/metar/stations/
  2439. http://xoap.weather.com/weather/local/
  2440.  
  2441. The first one is free to use but the second requires you to reg‐
  2442. ister and obtain your partner ID and license key. These two must
  2443. be written, separated by a space, into a file called .xoaprc
  2444. which needs to be placed into your home directory.
  2445.  
  2446. 'locID' must be a valid location identifier for the required
  2447. uri. For the NOAA site this must be a valid ICAO (see for in‐
  2448. stance https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
  2449. weather.com site this must be a valid location ID (see for in‐
  2450. stance http://aspnetresources.com/tools/locid.aspx).
  2451.  
  2452. 'data_type' must be one of the following:
  2453.  
  2454. last_update The date and time stamp of the data. The result de‐
  2455. pends on the URI used. For the NOAA site it is date (yyyy/mm/dd)
  2456. and UTC time. For the weather.com one it is date ([m]m/[d]d/yy)
  2457. and Local Time of the station.
  2458. temperature
  2459.  
  2460. Air temperature (you can use the 'temperature_unit' config set‐
  2461. ting to change units)
  2462. cloud_cover
  2463.  
  2464. The highest cloud cover status
  2465. pressure
  2466.  
  2467. Air pressure in millibar
  2468. wind_speed
  2469.  
  2470. Wind speed in km/h
  2471. wind_dir
  2472.  
  2473. Wind direction
  2474. wind_dir_DEG
  2475.  
  2476. Compass wind direction
  2477. humidity
  2478.  
  2479. Relative humidity in %
  2480. weather
  2481.  
  2482. Any relevant weather event (rain, snow, etc.). This is not used
  2483. if you are querying the weather.com site since this data is ag‐
  2484. gregated into the cloud_cover one
  2485. icon
  2486.  
  2487. Weather icon (only for www.weather.com). Can be used together
  2488. with the icon kit provided upon registering to their service.
  2489.  
  2490. 'delay_in_minutes' (optional, default 30) cannot be less than 30
  2491. minutes.
  2492.  
  2493. This object is threaded, and once a thread is created it can't
  2494. be explicitly destroyed. One thread will run for each URI speci‐
  2495. fied.
  2496.  
  2497. Note that these variables are still EXPERIMENTAL and can be sub‐
  2498. ject to many future changes.
  2499.  
  2500. weather_forecast URI locID day data_type (interval_in_minutes)
  2501. Download, parse and display weather forecast data for a given
  2502. day (daytime only).
  2503.  
  2504. For the 'URI', for the time being only http://xoap.weath‐
  2505. er.com/weather/local/ is supported. See 'weather' above for de‐
  2506. tails of usage
  2507.  
  2508. 'locID', see 'weather' above.
  2509.  
  2510. 'day' is a number from 0 (today) to 4 (3 days after tomorrow).
  2511.  
  2512. 'data_type' must be one of the following:
  2513.  
  2514. day Day of the week
  2515. date Date, in the form MMM DD (ie. Jul 14)
  2516. low Minimun temperature (you can use the 'temperature_unit' con‐
  2517. fig setting to change units)
  2518. hi Maximum temperature (you can use the 'temperature_unit' con‐
  2519. fig setting to change units)
  2520. icon Weather icon. Can be used together with the icon kit pro‐
  2521. vided upon registering to the weather.com service
  2522. forecast Weather forecast (sunny, rainy, etc.)
  2523. wind_speed Wind speed in km/h
  2524. wind_dir Wind direction
  2525. wind_dir_DEG Compass wind direction
  2526. humidity Relative humidity in %
  2527. precipitation Probability of having a precipitation (in %)
  2528.  
  2529. 'delay_in_minutes' (optional, default 210) cannot be lower than
  2530. 210 min.
  2531.  
  2532. This object is threaded, and once a thread is created it can't
  2533. be explicitly destroyed. One thread will run for each URI speci‐
  2534. fied. You can use any protocol that Curl supports.
  2535.  
  2536. Note that these variables are still EXPERIMENTAL and can be sub‐
  2537. ject to many future changes.
  2538.  
  2539. wireless_ap (net)
  2540. Wireless access point MAC address (Linux only)
  2541.  
  2542.  
  2543. wireless_bitrate (net)
  2544. Wireless bitrate (ie 11 Mb/s) (Linux only)
  2545.  
  2546.  
  2547. wireless_essid (net)
  2548. Wireless access point ESSID (Linux only)
  2549.  
  2550.  
  2551. wireless_link_bar (height),(width) (net)
  2552. Wireless link quality bar (Linux only)
  2553.  
  2554.  
  2555. wireless_link_qual (net)
  2556. Wireless link quality (Linux only)
  2557.  
  2558.  
  2559. wireless_link_qual_max (net)
  2560. Wireless link quality maximum value (Linux only)
  2561.  
  2562.  
  2563. wireless_link_qual_perc (net)
  2564. Wireless link quality in percents (Linux only)
  2565.  
  2566.  
  2567. wireless_mode (net)
  2568. Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
  2569.  
  2570.  
  2571. words textfile
  2572. Displays the number of words in the given file
  2573.  
  2574.  
  2575. xmms2_album
  2576. Album in current XMMS2 song
  2577.  
  2578.  
  2579. xmms2_artist
  2580. Artist in current XMMS2 song
  2581.  
  2582.  
  2583. xmms2_bar (height),(width)
  2584. Bar of XMMS2's progress
  2585.  
  2586.  
  2587. xmms2_bitrate
  2588. Bitrate of current song
  2589.  
  2590.  
  2591. xmms2_comment
  2592. Comment in current XMMS2 song
  2593.  
  2594.  
  2595. xmms2_date
  2596. Returns song's date.
  2597.  
  2598.  
  2599. xmms2_duration
  2600. Duration of current song
  2601.  
  2602.  
  2603. xmms2_elapsed
  2604. Song's elapsed time
  2605.  
  2606.  
  2607. xmms2_genre
  2608. Genre in current XMMS2 song
  2609.  
  2610.  
  2611. xmms2_id
  2612. XMMS2 id of current song
  2613.  
  2614.  
  2615. xmms2_percent
  2616. Percent of song's progress
  2617.  
  2618.  
  2619. xmms2_playlist
  2620. Returns the XMMS2 playlist.
  2621.  
  2622.  
  2623. xmms2_size
  2624. Size of current song
  2625.  
  2626.  
  2627. xmms2_smart
  2628. Prints the song name in either the form "artist - title" or file
  2629. name, depending on whats available
  2630.  
  2631.  
  2632. xmms2_status
  2633. XMMS2 status (Playing, Paused, Stopped, or Disconnected)
  2634.  
  2635.  
  2636. xmms2_timesplayed
  2637. Number of times a song was played (presumably).
  2638.  
  2639.  
  2640. xmms2_title
  2641. Title in current XMMS2 song
  2642.  
  2643.  
  2644. xmms2_tracknr
  2645. Track number in current XMMS2 song
  2646.  
  2647.  
  2648. xmms2_url
  2649. Full path to current song
  2650.  
  2651.  
  2652. LUA API
  2653. Conky features a Lua Programming API, and also ships with Lua bindings
  2654. for some useful libraries. Conky defines certain global functions and
  2655. variables which can be accessed from Lua code running in Conky.
  2656.  
  2657. To use Lua Conky, you first need to make sure you have a version of
  2658. Conky with Lua support enabled (``conky -v'' will report this). Scripts
  2659. must first be loaded using the lua_load configuration option. You then
  2660. call functions in Lua via Conky's $lua, $lua_read, and Lua hooks.
  2661.  
  2662. Be careful when creating threaded objects through the Lua API. You
  2663. could wind up with a whole bunch of threads running if a thread is cre‐
  2664. ated with each iteration.
  2665.  
  2666. At this time, the Lua API should not be considered stable and may
  2667. change drastically from one release to another as it matures.
  2668.  
  2669. NOTE: In order to accommodate certain features in the cairo library's
  2670. API, Conky will export a few additional functions for the creation of
  2671. certain structures. These are documented below.
  2672.  
  2673. conky_parse(string) function
  2674. This function takes a string that is evaluated as per Conky's
  2675. TEXT section, and then returns a string with the result.
  2676.  
  2677. conky_set_update_interval(number) function
  2678. Sets Conky's update interval (in seconds) to 'number'.
  2679.  
  2680. conky_window table
  2681. This table contains some information about Conky's window. The
  2682. following table describes the values contained:
  2683.  
  2684. drawable Window's drawable (Xlib Drawable), requires Lua extras
  2685. enabled at compile time.
  2686. visual Window's visual (Xlib Visual), requires Lua extras en‐
  2687. abled at compile time.
  2688. display Window's display (Xlib Display), requires Lua extras en‐
  2689. abled at compile time.
  2690. width Window width (in pixels).
  2691. height Window height (in pixels).
  2692. border_inner_margin Window's inner border margin (in pixels).
  2693. border_outer_margin Window's outer border margin (in pixels).
  2694. border_width Window's border width (in pixels).
  2695. text_start_x The x component of the starting coordinate of text
  2696. drawing.
  2697. text_start_y The y component of the starting coordinate of text
  2698. drawing.
  2699. text_width The width of the text drawing region.
  2700. text_height The height of the text drawing region.
  2701.  
  2702. NOTE: This table is only defined when X support is enabled.
  2703.  
  2704. conky_info table
  2705. This table contains some information about Conky's internal da‐
  2706. ta. The following table describes the values contained:
  2707.  
  2708. update_interval Conky's update interval (in seconds).
  2709. uptime System uptime, in seconds.
  2710.  
  2711. conky_build_info string
  2712. A string containing the build info for this particular instance
  2713. of Conky, including the version, build date, and architecture.
  2714.  
  2715. conky_build_date string
  2716. A string containing the build date for this particular instance
  2717. of Conky.
  2718.  
  2719. conky_build_arch string
  2720. A string containing the build architecture for this particular
  2721. instance of Conky.
  2722.  
  2723. conky_version string
  2724. A string containing the version of the current instance of
  2725. Conky.
  2726.  
  2727. conky_config string
  2728. A string containing the path of the current Conky configuration
  2729. file.
  2730.  
  2731. cairo_text_extents_t:create() function
  2732. Call this function to return a new cairo_text_extents_t struc‐
  2733. ture. A creation function for this structure is not provided by
  2734. the cairo API. After calling this, you should use tolua.takeown‐
  2735. ership() on the return value to ensure ownership is passed prop‐
  2736. erly.
  2737.  
  2738. cairo_font_extents_t:create() function
  2739. Call this function to return a new cairo_font_extents_t struc‐
  2740. ture. A creation function for this structure is not provided by
  2741. the cairo API. After calling this, you should use tolua.takeown‐
  2742. ership() on the return value to ensure ownership is passed prop‐
  2743. erly.
  2744.  
  2745. cairo_matrix_t:create() function
  2746. Call this function to return a new cairo_matrix_t structure. A
  2747. creation function for this structure is not provided by the
  2748. cairo API. After calling this, you should use tolua.takeowner‐
  2749. ship() on the return value to ensure ownership is passed proper‐
  2750. ly.
  2751.  
  2752. EXAMPLES
  2753. conky -t '${time %D %H:%M}' -o -u 30
  2754. Start Conky in its own window with date and clock as text and 30
  2755. sec update interval.
  2756.  
  2757. conky -a top_left -x 5 -y 500 -d
  2758. Start Conky to background at coordinates (5, 500).
  2759.  
  2760. conky -C > ~/.conkyrc
  2761. Do not start Conky, but have it output the builtin default con‐
  2762. fig file to ~/.conkyrc for later customising.
  2763.  
  2764. FILES
  2765. ${sysconfdir}/conky/conky.conf
  2766. Default system-wide configuration file. The value of
  2767. ${sysconfdir} depends on the compile-time options (most likely
  2768. /etc).
  2769.  
  2770. ~/.conkyrc
  2771. Default personal configuration file.
  2772.  
  2773. BUGS
  2774. Drawing to root or some other desktop window directly doesn't work with
  2775. all window managers. Especially doesn't work well with Gnome and it has
  2776. been reported that it doesn't work with KDE either. Nautilus can be
  2777. disabled from drawing to desktop with program gconf-editor. Uncheck
  2778. show_desktop in /apps/nautilus/preferences/. There is -w switch in
  2779. Conky to set some specific window id. You might find xwininfo -tree
  2780. useful to find the window to draw to. You can also use -o argument
  2781. which makes Conky to create its own window. If you do try running Conky
  2782. in its own window, be sure to read up on the own_window_type settings
  2783. and experiment.
  2784.  
  2785. SEE ALSO
  2786. ⟨http://conky.sourceforge.net/⟩
  2787.  
  2788. ⟨http://www.sourceforge.net/projects/conky⟩
  2789.  
  2790. ⟨http://wiki.conky.be⟩
  2791.  
  2792. #conky on irc.freenode.net
  2793.  
  2794. COPYING
  2795. Copyright (c) 2005-2010 Brenden Matthews, Philip Kovacs, et. al. Any
  2796. original torsmo code is licensed under the BSD license (see LICENSE.BSD
  2797. for a copy). All code written since the fork of torsmo is licensed un‐
  2798. der the GPL (see LICENSE.GPL for a copy), except where noted different‐
  2799. ly (such as in portmon code, timed thread code, and audacious code
  2800. which are LGPL, and prss which is an MIT-style license).
  2801.  
  2802. AUTHORS
  2803. The Conky dev team (see AUTHORS for a full list of contributors).
  2804.  
  2805.  
  2806.  
  2807. 2012-05-03 conky(1)
Advertisement
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!