From 3c1c74f541ff699732465870ee1058bed7e53593 Mon Sep 17 00:00:00 2001 From: lasers Date: Mon, 31 Dec 2018 04:05:44 -0600 Subject: [PATCH] doc: tidy --wrap 79 -xml -i --indent-spaces 4 --- doc/command_options.xml | 55 +- doc/config_settings.xml | 426 ++++----- doc/conky-howto.xml | 290 +++--- doc/docs.xml | 547 +++++------ doc/lua.xml | 116 +-- doc/variables.xml | 2018 ++++++++++++++++++--------------------- 6 files changed, 1625 insertions(+), 1827 deletions(-) diff --git a/doc/command_options.xml b/doc/command_options.xml index 6c4721e0..f648d0aa 100644 --- a/doc/command_options.xml +++ b/doc/command_options.xml @@ -7,9 +7,9 @@ Text alignment on screen, - {top,bottom,middle}_{left,right,middle} or none. Can also - be abbreviated with first chars of position, ie. tr for - top_right. Only available with build flag BUILD_X11 enabled. + {top,bottom,middle}_{left,right,middle} or none. Can also be + abbreviated with first chars of position, ie. tr for top_right. Only + available with build flag BUILD_X11 enabled. @@ -18,7 +18,8 @@ - Use double buffering (eliminates "flicker"). Only available with build flag BUILD_X11 enabled. + Use double buffering (eliminates "flicker"). Only available + with build flag BUILD_X11 enabled. @@ -28,7 +29,8 @@ - Config file to load instead of $HOME/.config/conky/conky.conf + Config file to load instead of + $HOME/.config/conky/conky.conf @@ -37,8 +39,9 @@ - Print builtin default config to stdout. See also - the section EXAMPLES for more information. Only available with build flag BUILD_BUILTIN_CONFIG enabled. + Print builtin default config to stdout. See also the section + EXAMPLES for more information. Only available with build flag + BUILD_BUILTIN_CONFIG enabled. @@ -47,7 +50,7 @@ - Daemonize Conky, aka fork to background. + Daemonize Conky, aka fork to background. @@ -56,8 +59,7 @@ - Increase debugging output, ie. -DD for more - debugging. + Increase debugging output, ie. -DD for more debugging. @@ -67,7 +69,8 @@ - Font to use. Only available with build flag BUILD_X11 enabled. + Font to use. Only available with build flag BUILD_X11 + enabled. @@ -76,7 +79,7 @@ - Prints command line help and exits. + Prints command line help and exits. @@ -86,7 +89,7 @@ - Number of times to update Conky (and quit). + Number of times to update Conky (and quit). @@ -95,7 +98,8 @@ - Create own window to draw. Only available with build flag BUILD_X11 enabled. + Create own window to draw. Only available with build flag + BUILD_X11 enabled. @@ -114,7 +118,7 @@ - Run Conky in 'quiet mode' (ie. no output). + Run Conky in 'quiet mode' (ie. no output). @@ -124,8 +128,7 @@ - Text to render, remember single quotes, like -t ' - $uptime ' + Text to render, remember single quotes, like -t ' $uptime ' @@ -135,7 +138,7 @@ - Update interval. + Update interval. @@ -144,8 +147,8 @@ - Prints version, build information and general info. - Exits after printing. + Prints version, build information and general info. Exits + after printing. @@ -155,7 +158,8 @@ - Window id to draw. Only available with build flag BUILD_X11 enabled. + Window id to draw. Only available with build flag BUILD_X11 + enabled. @@ -165,7 +169,7 @@ - X position + X position @@ -175,7 +179,7 @@ - X position + X position @@ -185,7 +189,8 @@ - X11 display to use. Only available with build flag BUILD_X11 enabled. + X11 display to use. Only available with build flag BUILD_X11 + enabled. @@ -195,7 +200,7 @@ - Y position + Y position diff --git a/doc/config_settings.xml b/doc/config_settings.xml index 59ec4c47..fcf6e2cc 100644 --- a/doc/config_settings.xml +++ b/doc/config_settings.xml @@ -5,11 +5,10 @@ - Aligned position on screen, may be top_left, - top_right, top_middle, bottom_left, bottom_right, - bottom_middle, middle_left, middle_middle, middle_right, or - none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, - mm, mr). See also gap_x and gap_y. + Aligned position on screen, may be top_left, top_right, + top_middle, bottom_left, bottom_right, bottom_middle, middle_left, + middle_middle, middle_right, or none (also can be abreviated as tl, + tr, tm, bl, br, bm, ml, mm, mr). See also gap_x and gap_y. @@ -27,8 +26,8 @@ - Boolean value, if true, Conky will be forked to - background when started. + Boolean value, if true, Conky will be forked to background + when started. @@ -37,8 +36,8 @@ - Inner border margin in pixels (the margin between - the border and text). + Inner border margin in pixels (the margin between the border + and text). @@ -47,8 +46,8 @@ - Outer border margin in pixels (the margin between - the border and the edge of the window). + Outer border margin in pixels (the margin between the border + and the edge of the window). @@ -67,9 +66,8 @@ Predefine a color for use inside conky.text segments. - Substitute N by a digit between 0 and 9, inclusively. When - specifying the color value in hex, omit the leading hash - (#). + Substitute N by a digit between 0 and 9, inclusively. When specifying + the color value in hex, omit the leading hash (#). @@ -96,9 +94,10 @@ - A comma-separated list of strings to use as the bars of a graph output - to console/shell. The first list item is used for the minimum bar height and the - last item is used for the maximum. Example: " ,_,=,#". + A comma-separated list of strings to use as the bars of a + graph output to console/shell. The first list item is used for the + minimum bar height and the last item is used for the maximum. Example: + " ,_,=,#". @@ -107,8 +106,7 @@ - The number of samples to average for CPU - monitoring. + The number of samples to average for CPU monitoring. @@ -117,8 +115,8 @@ - Specify a default height for bars. If not specified, - the default value is 6. + Specify a default height for bars. If not specified, the + default value is 6. @@ -127,11 +125,10 @@ - Specify a default width for bars. If not specified, - the default value is 0, which causes the bar to expand to - fit the width of your Conky window. If you set - out_to_console = true, the default value will be 10 - for the text version of the bar. + Specify a default width for bars. If not specified, the + default value is 0, which causes the bar to expand to fit the width of + your Conky window. If you set out_to_console = true, the default value + will be 10 for the text version of the bar. @@ -149,8 +146,8 @@ - Specify a default height for gauges. If not specified, - the default value is 25. + Specify a default height for gauges. If not specified, the + default value is 25. @@ -159,8 +156,8 @@ - Specify a default width for gauges. If not specified, - the default value is 40. + Specify a default width for gauges. If not specified, the + default value is 40. @@ -169,8 +166,8 @@ - Specify a default height for graphs. If not specified, - the default value is 25. + Specify a default height for graphs. If not specified, the + default value is 25. @@ -179,12 +176,11 @@ - Specify a default width for graphs. If not specified, - the default value is 0, which causes the graph to expand to - fit the width of your Conky window. If you set - out_to_console = true, the text version of the graph will - actually have no width and you will need to set a - sensible default or set the height and width of each graph + Specify a default width for graphs. If not specified, the + default value is 0, which causes the graph to expand to fit the width + of your Conky window. If you set out_to_console = true, the text + version of the graph will actually have no width and you will need to + set a sensible default or set the height and width of each graph individually. @@ -212,7 +208,8 @@ - Enable to disable the inotify-based auto config reload feature. + Enable to disable the inotify-based auto config reload + feature. @@ -221,8 +218,7 @@ - The number of samples to average for disk I/O - monitoring. + The number of samples to average for disk I/O monitoring. @@ -233,8 +229,8 @@ Specify an X display to connect to. - - + + @@ -242,16 +238,16 @@ Specify a Xinerama head. - + - Use the Xdbe extension? (eliminates flicker) It - is highly recommended to use own window with this one so - double buffer won't be so big. + Use the Xdbe extension? (eliminates flicker) It is highly + recommended to use own window with this one so double buffer won't be + so big. @@ -260,10 +256,9 @@ - Boolean, blend when rendering drawn image? - Some images blend incorrectly breaking alpha with ARBG visuals. This - provides a possible work around by disabling blending. Defaults to - true. + Boolean, blend when rendering drawn image? Some images blend + incorrectly breaking alpha with ARBG visuals. This provides a possible + work around by disabling blending. Defaults to true. @@ -308,8 +303,8 @@ - Put an extra newline at the end when writing to - stdout, useful for writing to awesome's wiboxes. + Put an extra newline at the end when writing to stdout, + useful for writing to awesome's wiboxes. @@ -318,8 +313,7 @@ - Font name in X, xfontsel can be used to get a - nice font + Font name in X, xfontsel can be used to get a nice font @@ -333,16 +327,15 @@ format as a font variable. - - If enabled, values which are in bytes will be - printed in human readable format (i.e., KiB, MiB, etc). If - disabled, the number of bytes is printed instead. + If enabled, values which are in bytes will be printed in + human readable format (i.e., KiB, MiB, etc). If disabled, the number + of bytes is printed instead. @@ -351,9 +344,9 @@ - Gap, in pixels, between right or left border of - screen, same as passing -x at command line, e.g. gap_x 10. - For other position related stuff, see 'alignment'. + Gap, in pixels, between right or left border of screen, same + as passing -x at command line, e.g. gap_x 10. For other position + related stuff, see 'alignment'. @@ -362,9 +355,9 @@ - Gap, in pixels, between top or bottom border of - screen, same as passing -y at command line, e.g. gap_y 10. - For other position related stuff, see 'alignment'. + Gap, in pixels, between top or bottom border of screen, same + as passing -y at command line, e.g. gap_y 10. For other position + related stuff, see 'alignment'. @@ -376,8 +369,7 @@ Specify API token for GitHub notifications. - https://github.com/settings/tokens/new?scopes=notifications&description=conky - + https://github.com/settings/tokens/new?scopes=notifications&description=conky @@ -387,8 +379,8 @@ - Hostname to connect to for hddtemp objects. Defaults - to "127.0.0.1". + Hostname to connect to for hddtemp objects. Defaults to + "127.0.0.1". @@ -397,8 +389,7 @@ - Port to use for hddtemp connections. Defaults to - 7634. + Port to use for hddtemp connections. Defaults to 7634. @@ -407,9 +398,8 @@ - When this is set the page generated with - out_to_http will automatically refresh each interval. Default - value is no. + When this is set the page generated with out_to_http will + automatically refresh each interval. Default value is no. @@ -418,11 +408,10 @@ - How strict should if_up be when testing an - interface for being up? The value is one of up, link or - address, to check for the interface being solely up, being - up and having link or being up, having link and an assigned - IP address. + How strict should if_up be when testing an interface for + being up? The value is one of up, link or address, to check for the + interface being solely up, being up and having link or being up, + having link and an assigned IP address. @@ -431,13 +420,12 @@ - Default global IMAP server. Arguments are: "host - user pass [-i interval (in seconds)] [-f 'folder'] [-p port] - [-e 'command'] [-r retries]". Default port is 143, default - folder is 'INBOX', default interval is 5 minutes, and - default number of retries before giving up is 5. If the - password is supplied as '*', you will be prompted to enter - the password when Conky starts. + Default global IMAP server. Arguments are: "host user pass + [-i interval (in seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r + retries]". Default port is 143, default folder is 'INBOX', default + interval is 5 minutes, and default number of retries before giving up + is 5. If the password is supplied as '*', you will be prompted to + enter the password when Conky starts. @@ -455,11 +443,10 @@ - - Imlib2 image cache size, in bytes. Defaults to - 4MiB. Increase this value if you use $image lots. Set - to 0 to disable the image cache. - + Imlib2 image cache size, in bytes. Defaults to 4MiB. + Increase this value if you use $image lots. Set to 0 to disable the + image cache. + @@ -468,16 +455,13 @@ - - This function, if defined, will be called by - Conky through each iteration after drawing to the - window. Requires X support. Takes any number of - optional arguments. Use this hook for drawing things on - top of what Conky draws. Conky puts 'conky_' in front - of function_name to prevent accidental calls to the - wrong function unless you place 'conky_' in front of it - yourself. - + This function, if defined, will be called by Conky through + each iteration after drawing to the window. Requires X support. Takes + any number of optional arguments. Use this hook for drawing things on + top of what Conky draws. Conky puts 'conky_' in front of function_name + to prevent accidental calls to the wrong function unless you place + 'conky_' in front of it yourself. + @@ -486,16 +470,13 @@ - - This function, if defined, will be called by - Conky through each iteration before drawing to the - window. Requires X support. Takes any number of - optional arguments. Use this hook for drawing things on - top of what Conky draws. Conky puts 'conky_' in front - of function_name to prevent accidental calls to the - wrong function unless you place 'conky_' in front of it - yourself. - + This function, if defined, will be called by Conky through + each iteration before drawing to the window. Requires X support. Takes + any number of optional arguments. Use this hook for drawing things on + top of what Conky draws. Conky puts 'conky_' in front of function_name + to prevent accidental calls to the wrong function unless you place + 'conky_' in front of it yourself. + @@ -513,16 +494,13 @@ - - This function, if defined, will be called by - Conky at shutdown or when the configuration is - reloaded. Use this hook to clean up after yourself, - such as freeing memory which has been allocated by - external libraries via Lua. Conky puts 'conky_' in - front of function_name to prevent accidental calls to - the wrong function unless you place 'conky_' in - front of it yourself. - + This function, if defined, will be called by Conky at + shutdown or when the configuration is reloaded. Use this hook to clean + up after yourself, such as freeing memory which has been allocated by + external libraries via Lua. Conky puts 'conky_' in front of + function_name to prevent accidental calls to the wrong function unless + you place 'conky_' in front of it yourself. + @@ -531,15 +509,12 @@ - - This function, if defined, will be called by - Conky at startup or when the configuration is reloaded. - Use this hook to initialize values, or for any run-once - applications. Conky puts 'conky_' in front of - function_name to prevent accidental calls to the wrong - function unless you place 'conky_' in front of - it yourself. - + This function, if defined, will be called by Conky at + startup or when the configuration is reloaded. Use this hook to + initialize values, or for any run-once applications. Conky puts + 'conky_' in front of function_name to prevent accidental calls to the + wrong function unless you place 'conky_' in front of it yourself. + @@ -556,8 +531,8 @@ - Allow each port monitor to track at most this - many connections (if 0 or not set, default is 256) + Allow each port monitor to track at most this many + connections (if 0 or not set, default is 256) @@ -567,10 +542,9 @@ - When a line in the output contains 'width' - chars and the end isn't reached, the next char will start - on a new line. If you want to make sure that lines don't - get broken, set 'width' to 0 + When a line in the output contains 'width' chars and the end + isn't reached, the next char will start on a new line. If you want to + make sure that lines don't get broken, set 'width' to 0 @@ -581,7 +555,7 @@ Maximum size of user text buffer, i.e. text inside - conky.text section in config file (default is 16384 bytes) + conky.text section in config file (default is 16384 bytes) @@ -665,7 +639,8 @@ - MySQL user name to use when connecting to the server. Defaults to your username + MySQL user name to use when connecting to the server. + Defaults to your username @@ -674,8 +649,8 @@ - Password of the MySQL user. Place it between "-chars. When this is not set there - is no password used + Password of the MySQL user. Place it between "-chars. When + this is not set there is no password used @@ -693,8 +668,8 @@ - Music player thread update interval (defaults to - Conky's update interval) + Music player thread update interval (defaults to Conky's + update interval) @@ -713,7 +688,6 @@ Subtract (file system) buffers from used memory? - @@ -722,8 +696,8 @@ - The display that the nvidia variable will use (defaults to the value of the - display variable) + The display that the nvidia variable will use (defaults to + the value of the display variable) @@ -750,9 +724,9 @@ - Print text in the console, but use ncurses so - that conky can print the text of a new update over the old - text. (In the future this will provide more useful things) + Print text in the console, but use ncurses so that conky can + print the text of a new update over the old text. (In the future this + will provide more useful things) @@ -770,11 +744,10 @@ - When set to no, there will be no output in X - (useful when you also use things like out_to_console). If - you set it to no, make sure that it's placed before all - other X-related setting (take the first line of your - configfile to be sure). Default value is yes + When set to no, there will be no output in X (useful when + you also use things like out_to_console). If you set it to no, make + sure that it's placed before all other X-related setting (take the + first line of your configfile to be sure). Default value is yes @@ -810,8 +783,7 @@ - Manually set the WM_CLASS name. Defaults to - "Conky". + Manually set the WM_CLASS name. Defaults to "Conky". @@ -821,10 +793,10 @@ - If own_window_transparent no, set a specified - background colour (defaults to black). Takes either a hex value - (e.g. '#ffffff'), a shorthand hex value (e.g. '#fff'), or a valid - RGB name (see /usr/lib/X11/rgb.txt) + If own_window_transparent no, set a specified background + colour (defaults to black). Takes either a hex value (e.g. '#ffffff'), + a shorthand hex value (e.g. '#fff'), or a valid RGB name (see + /usr/lib/X11/rgb.txt) @@ -835,11 +807,10 @@ - If own_window is yes, you may use these window - manager hints to affect the way Conky displays. Notes: Use - own_window_type desktop as another way to implement many of - these hints implicitly. If you use own_window_type - override, window manager hints have no meaning and are + If own_window is yes, you may use these window manager hints + to affect the way Conky displays. Notes: Use own_window_type desktop + as another way to implement many of these hints implicitly. If you use + own_window_type override, window manager hints have no meaning and are ignored. @@ -849,8 +820,8 @@ - Manually set the window name. Defaults to - "conky (<hostname>)". + Manually set the window name. Defaults to "conky + (<hostname>)". @@ -859,10 +830,10 @@ - Boolean, use ARGB visual? ARGB can be used for real - transparency, note that a composite manager is required for real - transparency. This option will not work as desired (in most cases) - in conjunction with 'own_window_type override'. + Boolean, use ARGB visual? ARGB can be used for real + transparency, note that a composite manager is required for real + transparency. This option will not work as desired (in most cases) in + conjunction with 'own_window_type override'. @@ -871,7 +842,9 @@ - When ARGB visuals are enabled, this use this to modify the alpha value used. Valid range is 0-255, where 0 is 0% opacity, and 255 is 100% opacity. + When ARGB visuals are enabled, this use this to modify the + alpha value used. Valid range is 0-255, where 0 is 0% opacity, and 255 + is 100% opacity. @@ -880,8 +853,8 @@ - Boolean, set transparency? If ARGB visual is enabled, sets - background opacity to 0%. + Boolean, set transparency? If ARGB visual is enabled, sets + background opacity to 0%. @@ -890,17 +863,16 @@ - if own_window is yes, you may specify type - normal, desktop, dock, panel or override (default: normal). - Desktop windows are special windows that have no window - decorations; are always visible on your desktop; do not - appear in your pager or taskbar; and are sticky across all - workspaces. Panel windows reserve space along a desktop - edge, just like panels and taskbars, preventing maximized - windows from overlapping them. The edge is chosen based on - the alignment option. Override windows are not under the - control of the window manager. Hints are ignored. This type - of window can be useful for certain situations. + if own_window is yes, you may specify type normal, desktop, + dock, panel or override (default: normal). Desktop windows are special + windows that have no window decorations; are always visible on your + desktop; do not appear in your pager or taskbar; and are sticky across + all workspaces. Panel windows reserve space along a desktop edge, just + like panels and taskbars, preventing maximized windows from + overlapping them. The edge is chosen based on the alignment option. + Override windows are not under the control of the window manager. + Hints are ignored. This type of window can be useful for certain + situations. @@ -909,8 +881,7 @@ - Pad percentages to this many decimals (0 = no - padding) + Pad percentages to this many decimals (0 = no padding) @@ -919,12 +890,11 @@ - Default global POP3 server. Arguments are: "host - user pass [-i interval (in seconds)] [-p port] [-e 'command'] - [-r retries]". Default port is 110, default interval is 5 - minutes, and default number of retries before giving up is - 5. If the password is supplied as '*', you will be prompted - to enter the password when Conky starts. + Default global POP3 server. Arguments are: "host user pass + [-i interval (in seconds)] [-p port] [-e 'command'] [-r retries]". + Default port is 110, default interval is 5 minutes, and default number + of retries before giving up is 5. If the password is supplied as '*', + you will be prompted to enter the password when Conky starts. @@ -933,8 +903,8 @@ - Shortens units to a single character (kiB->k, - GiB->G, etc.). Default is off. + Shortens units to a single character (kiB->k, GiB->G, + etc.). Default is off. @@ -970,9 +940,9 @@ - Desired output unit of all objects displaying a - temperature. Parameters are either "fahrenheit" or - "celsius". The default unit is degree Celsius. + Desired output unit of all objects displaying a temperature. + Parameters are either "fahrenheit" or "celsius". The default unit is + degree Celsius. @@ -981,11 +951,10 @@ - Define a template for later use inside conky.text - segments. Substitute N by a digit between 0 and 9, - inclusively. The value of the variable is being inserted - into the stuff inside conky.text at the corresponding position, - but before some substitutions are applied: + Define a template for later use inside conky.text segments. + Substitute N by a digit between 0 and 9, inclusively. The value of the + variable is being inserted into the stuff inside conky.text at the + corresponding position, but before some substitutions are applied: '\n' -> newline '\\' -> backslash @@ -1001,12 +970,11 @@ - Size of the standard text buffer (default is 256 - bytes). This buffer is used for intermediary text, such as - individual lines, output from $exec vars, and various other - variables. Increasing the size of this buffer can - drastically reduce Conky's performance, but will allow for - more text display per variable. The size of this buffer + Size of the standard text buffer (default is 256 bytes). + This buffer is used for intermediary text, such as individual lines, + output from $exec vars, and various other variables. Increasing the + size of this buffer can drastically reduce Conky's performance, but + will allow for more text display per variable. The size of this buffer cannot be smaller than the default value of 256 bytes. @@ -1016,9 +984,8 @@ - If true, variables that output times output a number - that represents seconds. This doesn't affect $time, $tztime and - $utime + If true, variables that output times output a number that + represents seconds. This doesn't affect $time, $tztime and $utime @@ -1027,9 +994,9 @@ - If true, cpu in top will show usage of one - processor's power. If false, cpu in top will show the usage - of all processors' power combined. + If true, cpu in top will show usage of one processor's + power. If false, cpu in top will show the usage of all processors' + power combined. @@ -1039,8 +1006,8 @@ If true, top name shows the full command line of each - process, including arguments (whenever possible). Otherwise, - only the basename is displayed. Default value is false. + process, including arguments (whenever possible). Otherwise, only the + basename is displayed. Default value is false. @@ -1049,8 +1016,7 @@ - Width for $top name value (defaults to 15 - characters). + Width for $top name value (defaults to 15 characters). @@ -1059,8 +1025,8 @@ - Total number of times for Conky to update before - quitting. Zero makes Conky run forever + Total number of times for Conky to update before quitting. + Zero makes Conky run forever @@ -1089,7 +1055,8 @@ - One or more batteries to check in order to use update_interval_on_battery (comma separated, BAT0 default) + One or more batteries to check in order to use + update_interval_on_battery (comma separated, BAT0 default) @@ -1098,8 +1065,7 @@ - Boolean value, if true, text is rendered in upper - case + Boolean value, if true, text is rendered in upper case @@ -1108,12 +1074,11 @@ - Adds spaces around certain objects to stop them - from moving other things around. Arguments are left, right, - and none (default). The old true/false values are - deprecated and default to right/none respectively. Note - that this only helps if you are using a mono font, such as - Bitstream Vera Sans Mono. + Adds spaces around certain objects to stop them from moving + other things around. Arguments are left, right, and none (default). + The old true/false values are deprecated and default to right/none + respectively. Note that this only helps if you are using a mono font, + such as Bitstream Vera Sans Mono. @@ -1131,8 +1096,7 @@ - Alpha of Xft font. Must be a value at or between - 1 and 0. + Alpha of Xft font. Must be a value at or between 1 and 0. diff --git a/doc/conky-howto.xml b/doc/conky-howto.xml index 34520dd9..2468270b 100644 --- a/doc/conky-howto.xml +++ b/doc/conky-howto.xml @@ -1,143 +1,173 @@ - + - -Gentoo Linux Conky Howto - - - Bill Woodford - - - - Brenden Matthews - - - -This document describes how to install and configure the system monitor known -as Conky. - - - - - - -1.0 -2006-02-22 - - -Background -
-Introduction to Conky - - -

-So you have a Gentoo machine, and have already learned 30 different commands to monitor different aspects of what your computer is doing at the current moment. What do you do from here? Isn't there an easier way to monitor system performance and see what its doing, as well as the resources its using to perform all those tasks? This is what a system monitor, such as Conky, provides. -

- - -
-
-What it does - - -

-Unlike other system monitors such as top, Conky can run as a window in an X session, or by drawing to the root window (there is also an option to have Conky display information to stdout, but we won't discuss that here). It displays the information it has gathered through the use of both text, progress bars, and graphs. Also unlike top, the way it is formatted is completely user-configurable. In addition to monitoring the system itself, Conky can also give you information about several music players (such as XMMS, BMPx, Music Player Daemon, and Audacious Media Player), tell you how many new messages are in your mail spool, and plenty more. If the functionality you require isn't in Conky yet, it is a simple matter of writing a script to get the information you would like - some examples of this, which have already been done are RSS feeds, POP3 e-mail message count, local weather, boinc status, and even the status of portage. -

- - -
- - -Installing Conky -
-Base install - - -

-Gentoo provides an ebuild to quickly and easily install Conky. Pay particular attention to the the USE flags. You'll most likely want X11 support (X), and make sure you select the USE flags for any music players (other than MPD) which you want. XMMS (xmms), Audacious (audacious), BMPx (bmpx), or XMMS support via the xmms-infopipe plugin (infopipe). -

- -
-# Example line to append to /etc/portage/package.use if you don't want the default USE flags.
+    Gentoo Linux Conky Howto
+    
+        Bill Woodford
+    
+    
+        Brenden Matthews
+    
+    This document describes how to install and configure the system
+    monitor known as Conky.
+    
+    
+    
+    1.0
+    2006-02-22
+    
+        Background
+        

+            Introduction to Conky
+            
+                
So you have a Gentoo machine, and have already learned 30
+                different commands to monitor different aspects of what your
+                computer is doing at the current moment. What do you do from
+                here? Isn't there an easier way to monitor system performance
+                and see what its doing, as well as the resources its using to
+                perform all those tasks? This is what a system monitor, such
+                as Conky, provides.

+            
+        

+        

+            What it does
+            
+                
Unlike other system monitors such as top, Conky can run as
+                a window in an X session, or by drawing to the root window
+                (there is also an option to have Conky display information to
+                stdout, but we won't discuss that here). It displays the
+                information it has gathered through the use of both text,
+                progress bars, and graphs. Also unlike top, the way it is
+                formatted is completely user-configurable. In addition to
+                monitoring the system itself, Conky can also give you
+                information about several music players (such as XMMS, BMPx,
+                Music Player Daemon, and Audacious Media Player), tell you how
+                many new messages are in your mail spool, and plenty more. If
+                the functionality you require isn't in Conky yet, it is a
+                simple matter of writing a script to get the information you
+                would like - some examples of this, which have already been
+                done are RSS feeds, POP3 e-mail message count, local weather,
+                boinc status, and even the status of portage.

+            
+        

+    
+    
+        Installing Conky
+        

+            Base install
+            
+                
Gentoo provides an ebuild to quickly and easily install
+                Conky. Pay particular attention to the the USE flags. You'll
+                most likely want X11 support (
+                X), and make sure you select the USE flags for any
+                music players (other than MPD) which you want. XMMS (
+                xmms), Audacious (
+                audacious), BMPx (
+                bmpx), or XMMS support via the xmms-infopipe plugin (
+                infopipe).

+                
+# Example line to append to /etc/portage/package.use if you don't
+want the
+default USE flags.
 app-admin/conky xmms infopipe -ipv6
 

-
-

-In addition, the truetype USE flag compiles support for TrueType fonts with the use of Xft.  Most users will want this as well.
-

-
-

-Once you have your USE flags correctly set up, it's time to install Conky!
-

-
-
+                
In addition, the
+                truetypeUSE flag compiles support for TrueType fonts
+                with the use of Xft. Most users will want this as well.

+                
Once you have your USE flags correctly set up, it's time to
+                install Conky!

+                
 emerge -av conky
 

-
-

-You can test Conky to see how it will look by running the command conky in a terminal.  This will likely give you a good reference to how it will look and what you want to change, add or even remove.
-

-
-
-$ conky
+                
You can test Conky to see how it will look by running the
+                command
+                conkyin a terminal. This will likely give you a good
+                reference to how it will look and what you want to change, add
+                or even remove.

+                
+$
+conky
 

-
-

-Once you have an idea of how Conky looks, you can now move on to configuring it!
-

-
-
-
-

-

-Configuring Conky
-
-
-

-By default, Conky will look for a configuration file in the users home directory located at ~/.config/conky/conky.conf  This file contains all the configuration options, and the static text, colors and other variables which control what data is shown to the user.  Conky also provides a great sample configuration, located at /usr/share/doc/conky-version/Conkyrc.sample.gz  Make sure to replace "version" with the specific version of Conky you have installed.
-

-
-
-$ mkdir -p ~/.config/conky
-$ zcat /usr/share/conky-1.6.0/conkyrc.sample.gz >> ~/.config/conky/conky.conf
+                
Once you have an idea of how Conky looks, you can now move
+                on to configuring it!

+            
+        

+        

+            Configuring Conky
+            
+                
By default, Conky will look for a configuration file in the
+                users home directory located at
+                ~/.config/conky/conky.confThis file contains all
+                the configuration options, and the static text, colors and
+                other variables which control what data is shown to the user.
+                Conky also provides a great sample configuration, located at
+                
+                /usr/share/doc/conky-version/Conkyrc.sample.gzMake sure
+                to replace "version" with the specific version of Conky you
+                have installed.

+                
+$
+mkdir -p ~/.config/conky
+$
+zcat /usr/share/conky-1.6.0/conkyrc.sample.gz >>
+~/.config/conky/conky.conf
 

-
-
-Make sure to replace "1.6.0" with the specific version of Conky you have installed.
-
-
-

-Now, open up the sample configuration in the text editor of your choice.  You may notice that there are two seperate sections of the configuration file.  The first section of the file, contains the programs configuration options and controls how it acts.  This includes things such as the update_interval, or how often Conky will update the information on the screen.  The second section contains the actual text, graphs, and variables which are rendered on the screen.  This includes things such as the system uptime ($uptime), cpu usage ($cpu) and anything else you want to be shown.  The first section of the file starts right from the beginning, the second section is comprised of everything after the line which says "TEXT".  Comments in the file start with #, but keep in mind that even if a line is commented out in the second section of the file, the text will still be rendered to the screen.
-

-
-

-Lists of all the available configuration options and variables are kept at http://conky.sourceforge.net/config_settings.html and http://conky.sourceforge.net/variables.html.  Also, there's a few great sample configurations and screenshots of working configurations at http://conky.sourceforge.net/screenshots.html.
-

-
-
-

-
-
-Extending Conky
-

-Beyond the built-in variables
-
-
-

-So you've gotten this far, and have scoured the Conky documentation for that extra variable which Conky just doesn't seem to have...  You're in luck!  Conky provides several variables for just this reason!  $exec Will run a command every time Conky updates, $execi will run a command at a specified interval and $texeci will run a command in it's own thread at a specified interval.
-

-
-
+                Make sure to replace "1.6.0" with the specific version
+                of Conky you have installed.
+                
Now, open up the sample configuration in the text editor of
+                your choice. You may notice that there are two seperate
+                sections of the configuration file. The first section of the
+                file, contains the programs configuration options and controls
+                how it acts. This includes things such as the
+                update_interval, or how often Conky will update the
+                information on the screen. The second section contains the
+                actual text, graphs, and variables which are rendered on the
+                screen. This includes things such as the system uptime (
+                $uptime), cpu usage (
+                $cpu) and anything else you want to be shown. The first
+                section of the file starts right from the beginning, the
+                second section is comprised of everything after the line which
+                says "
+                TEXT". Comments in the file start with
+                #, but keep in mind that even if a line is commented
+                out in the second section of the file, the text will still be
+                rendered to the screen.

+                
Lists of all the available configuration options and
+                variables are kept at
+                
+                http://conky.sourceforge.net/config_settings.htmland
+                http://conky.sourceforge.net/variables.html. Also,
+                there's a few great sample configurations and screenshots of
+                working configurations at
+                http://conky.sourceforge.net/screenshots.html.

+            
+        

+    
+    
+        Extending Conky
+        

+            Beyond the built-in variables
+            
+                
So you've gotten this far, and have scoured the Conky
+                documentation for that extra variable which Conky just doesn't
+                seem to have... You're in luck! Conky provides several
+                variables for just this reason!
+                $execWill run a command every time Conky updates,
+                $execiwill run a command at a specified interval and
+                $texeciwill run a command in it's own thread at a
+                specified interval.

+                
 ${exec grep 'sudo' /var/log/messages | tail -n 4}
 ${execi 30 ~/scripts/emerge-status.sh
 ${texeci 600 ~/scripts/gmail.pl}
 

-
-
-While any command which works in a command shell will work in any of these variables, it is important to keep in mind that the commands must exit.  This means that commands like tail -f which keep running will NOT work properly.
-
-
-
-

-
+                While any command which works in a command shell will
+                work in any of these variables, it is important to keep in
+                mind that the commands must exit. This means that commands
+                like
+                tail -fwhich keep running will NOT work
+                properly.
+            
+
+ diff --git a/doc/docs.xml b/doc/docs.xml index b3ebc5c8..b58bca17 100644 --- a/doc/docs.xml +++ b/doc/docs.xml @@ -8,303 +8,252 @@ ]> - -
- brenden1@users.sourceforge.net -
- - Brenden - Matthews - - 2012-05-03 - - - conky - 1 - - - conky - A system monitor for X originally based on the - torsmo code, but more kickass. It just keeps on given'er. - Yeah. - - - - conky - - options - - - - - Description - Conky is a system monitor for X originally based on - torsmo. Since its inception, Conky has changed - significantly from its predecessor, while maintaining - simplicity and configurability. Conky can display just - about anything, either on your root desktop or in its own - window. Not only does Conky have many built-in objects, it - can also display just about any piece of information by - using scripts and other external programs. - - Conky has more than 250 built in objects, including - support for a plethora of OS stats (uname, uptime, CPU - usage, mem usage, disk usage, "top" like process stats, and - network monitoring, just to name a few), built in IMAP and - POP3 support, built in support for many popular music - players (MPD, XMMS2, BMPx, Audacious), and much much more. - Conky can display this info either as text, or using simple - progress bars and graph widgets, with different fonts and - colours. - - We are always looking for help, whether its reporting - bugs, writing patches, or writing docs. Please use the - facilities at SourceForge to make bug reports, feature - requests, and submit patches, or stop by #conky on - irc.freenode.net if you have questions or want to - contribute. - Thanks for your interest in Conky. - - - - Compiling - For users compiling from source on a binary distro, make sure you - have the X development libraries installed (Unless you configure - your build without X11). This should be a package along the lines - of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" - format for the other libs required (depending on your build - options). You should be able to see which extra packages you need - to install by reading errors that you get from running `cmake'. The - easiest way to view the available build options is to run `ccmake' or - `cmake-gui' from the source tree, but be careful when disabling - certain features as you may lose desired functionality. E.g., - with BUILD_MATH disabled you won't get errors but logarithmic - graphs will be normal graphs and gauges will miss their line. - - Conky has (for some time) been available in the - repositories of most popular distributions. Here are some - installation instructions for a few: - - Gentoo users -- Conky is in Gentoo's Portage... - simply use "emerge app-admin/conky" for - installation. - - Debian, etc. users -- Conky should be in your - repositories, and can be installed by doing "aptitude - install conky". - - Example to compile and run Conky with default - components (note that some build options may differ for - your system): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Conky has been tested to be compatible with C99 C and C++0x C++, - however it has not been tested with anything other than gcc, and is - not guaranteed to work with other compilers. - - TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead of - just `cmake'. - - - - - You Should Know - Conky is generally very good on resources. That said, - the more you try to make Conky do, the more resources it is - going to consume. - - An easy way to force Conky to reload your ~/.config/conky/conky.conf: - "killall -SIGUSR1 conky". Saves you the trouble of having to kill - and then restart. - - - - Options - Command line options override configurations defined in - configuration file. - - &command_options; - - - Configuration Settings - Default configuration file location is $HOME/.config/conky/conky.conf or - ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is - /etc, and you can find the sample config file there - (/etc/conky/conky.conf). - - You might want to copy it to $HOME/.config/conky/conky.conf and then - start modifying it. Other configs can be found at - http://conky.sf.net/ - - &config_settings; - - - Objects/Variables - Colours are parsed using XParsecolor(), there might be a - list of them: /usr/share/X11/rgb.txt. - Colour can be also in - #rrggbb format (hex). - - - Some objects may create threads, and sometimes these threads will - not be destroyed until Conky terminates. There is no way to - destroy or clean up threads while Conky is running. For example, - if you use an MPD variable, the MPD thread will keep running until - Conky dies. Some threaded objects will use one of the parameters - as a 'key', so that you only have 1 relevant thread running (for - example, the $curl, $rss and $weather objects launch one thread per - URI). - - &variables; - - - Lua API - Conky features a Lua Programming API, and also ships with Lua - bindings for some useful libraries. Note that the bindings require - tolua++, which currently only compiles against Lua 5.1. - - To use Lua Conky, you first need to make sure you have a version of Conky - with Lua support enabled (``conky -v'' will report this). Conky defines - certain global functions and variables which can be accessed from Lua - code running in Conky. Scripts must first be loaded using the lua_load - configuration option. You then call functions in Lua via Conky's $lua, - $lua_read, and Lua hooks. - - - Be careful when creating threaded objects through the Lua API. You - could wind up with a whole bunch of threads running if a thread is - created with each iteration. - - - At this time, the Lua API should not be considered stable and may - change drastically from one release to another as it matures. - - - NOTE: In order to accommodate certain features in the cairo - library's API, Conky will export a few additional functions for the - creation of certain structures. These are documented below. - - &lua; - - - Examples - - - - conky - - - Start Conky in its own window with date - and clock as text and 30 sec update - interval. - - - - conky - - - Start Conky to background at coordinates - (5, 500). - - - - conky - - - Do not start Conky, but have it output - the builtin default config file to - ~/.config/conky/conky.conf for later customising. - - - - - Files - - - - - ${sysconfdir}/conky/conky.conf - - Default system-wide configuration file. - The value of ${sysconfdir} depends on the - compile-time options (most likely /etc). - - - - ~/.config/conky/conky.conf - - Default personal configuration - file. - - - - - Bugs - Drawing to root or some other desktop window directly - doesn't work with all window managers. Especially doesn't - work well with Gnome and it has been reported that it - doesn't work with KDE either. Nautilus can be disabled from - drawing to desktop with program gconf-editor. Uncheck - show_desktop in /apps/nautilus/preferences/. There is -w - switch in Conky to set some specific window id. You might - find xwininfo -tree useful to find the window to draw to. - You can also use -o argument which makes Conky to create - its own window. If you do try running Conky in its own - window, be sure to read up on the own_window_type settings - and experiment. - - - See Also - - - https://github.com/brndnmtthws/conky - - #conky on irc.freenode.net - - - Copying - Copyright (c) 2005-2018 Brenden Matthews, Philip - Kovacs, et. al. Any original torsmo code is licensed under - the BSD license (see LICENSE.BSD for a copy). All code - written since the fork of torsmo is licensed under the GPL - (see LICENSE.GPL for a copy), except where noted - differently (such as in portmon and audacious code which are LGPL, and - prss which is an MIT-style license). - - - Authors - The Conky dev team (see AUTHORS for a full list of - contributors). - + +
+ brenden1@users.sourceforge.net +
+ + Brenden + Matthews + + 2012-05-03 + + + conky + 1 + + + conky + A system monitor for X originally based on the torsmo + code, but more kickass. It just keeps on given'er. Yeah. + + + + conky + + options + + + + + Description + Conky is a system monitor for X originally based on torsmo. + Since its inception, Conky has changed significantly from its + predecessor, while maintaining simplicity and configurability. Conky + can display just about anything, either on your root desktop or in its + own window. Not only does Conky have many built-in objects, it can + also display just about any piece of information by using scripts and + other external programs. + Conky has more than 250 built in objects, including support for + a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk + usage, "top" like process stats, and network monitoring, just to name + a few), built in IMAP and POP3 support, built in support for many + popular music players (MPD, XMMS2, BMPx, Audacious), and much much + more. Conky can display this info either as text, or using simple + progress bars and graph widgets, with different fonts and + colours. + We are always looking for help, whether its reporting bugs, + writing patches, or writing docs. Please use the facilities at + SourceForge to make bug reports, feature requests, and submit patches, + or stop by #conky on irc.freenode.net if you have questions or want to + contribute. + Thanks for your interest in Conky. + + + Compiling + For users compiling from source on a binary distro, make sure + you have the X development libraries installed (Unless you configure + your build without X11). This should be a package along the lines of + "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" format + for the other libs required (depending on your build options). You + should be able to see which extra packages you need to install by + reading errors that you get from running `cmake'. The easiest way to + view the available build options is to run `ccmake' or `cmake-gui' + from the source tree, but be careful when disabling certain features + as you may lose desired functionality. E.g., with BUILD_MATH disabled + you won't get errors but logarithmic graphs will be normal graphs and + gauges will miss their line. + Conky has (for some time) been available in the repositories of + most popular distributions. Here are some installation instructions + for a few: + Gentoo users -- Conky is in Gentoo's Portage... simply use + "emerge app-admin/conky" for installation. + Debian, etc. users -- Conky should be in your repositories, and + can be installed by doing "aptitude install conky". + Example to compile and run Conky with default components (note + that some build options may differ for your system): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Conky has been tested to be compatible with C99 C and C++0x C++, + however it has not been tested with anything other than gcc, and is + not guaranteed to work with other compilers. + TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead + of just `cmake'. + + + + You Should Know + Conky is generally very good on resources. That said, the more + you try to make Conky do, the more resources it is going to + consume. + An easy way to force Conky to reload your + ~/.config/conky/conky.conf: "killall -SIGUSR1 conky". Saves you the + trouble of having to kill and then restart. + + + Options + Command line options override configurations defined in + configuration file.&command_options; + + Configuration Settings + Default configuration file location is + $HOME/.config/conky/conky.conf or ${sysconfdir}/conky/conky.conf. On most + systems, sysconfdir is /etc, and you can find the sample config file there + (/etc/conky/conky.conf). + You might want to copy it to $HOME/.config/conky/conky.conf and then + start modifying it. Other configs can be found at + http://conky.sf.net/&config_settings; + + Objects/Variables + Colours are parsed using XParsecolor(), there might be a list of + them: /usr/share/X11/rgb.txt. Colour can be also in #rrggbb format + (hex). + Some objects may create threads, and sometimes these threads will + not be destroyed until Conky terminates. There is no way to destroy or + clean up threads while Conky is running. For example, if you use an MPD + variable, the MPD thread will keep running until Conky dies. Some threaded + objects will use one of the parameters as a 'key', so that you only have 1 + relevant thread running (for example, the $curl, $rss and $weather objects + launch one thread per URI).&variables; + + Lua API + Conky features a Lua Programming API, and also ships with Lua + bindings for some useful libraries. Note that the bindings require + tolua++, which currently only compiles against Lua 5.1. + To use Lua Conky, you first need to make sure you have a version of + Conky with Lua support enabled (``conky -v'' will report this). Conky + defines certain global functions and variables which can be accessed from + Lua code running in Conky. Scripts must first be loaded using the lua_load + configuration option. You then call functions in Lua via Conky's $lua, + $lua_read, and Lua hooks. + Be careful when creating threaded objects through the Lua API. You + could wind up with a whole bunch of threads running if a thread is created + with each iteration. + At this time, the Lua API should not be considered stable and may + change drastically from one release to another as it matures. + NOTE: In order to accommodate certain features in the cairo + library's API, Conky will export a few additional functions for the + creation of certain structures. These are documented + below.&lua; + + Examples + + + + conky + + + Start Conky in its own window with date and clock as + text and 30 sec update interval. + + + + conky + + + Start Conky to background at coordinates (5, + 500). + + + + conky + + + Do not start Conky, but have it output the builtin + default config file to ~/.config/conky/conky.conf for later + customising. + + + + + Files + + + + ${sysconfdir}/conky/conky.conf + + Default system-wide configuration file. The value of + ${sysconfdir} depends on the compile-time options (most likely + /etc). + + + + ~/.config/conky/conky.conf + + Default personal configuration file. + + + + + Bugs + Drawing to root or some other desktop window directly doesn't + work with all window managers. Especially doesn't work well with Gnome + and it has been reported that it doesn't work with KDE either. + Nautilus can be disabled from drawing to desktop with program + gconf-editor. Uncheck show_desktop in /apps/nautilus/preferences/. + There is -w switch in Conky to set some specific window id. You might + find xwininfo -tree useful to find the window to draw to. You can also + use -o argument which makes Conky to create its own window. If you do + try running Conky in its own window, be sure to read up on the + own_window_type settings and experiment. + + + See Also + https://github.com/brndnmtthws/conky + #conky on irc.freenode.net + + + Copying + Copyright (c) 2005-2018 Brenden Matthews, Philip Kovacs, et. al. + Any original torsmo code is licensed under the BSD license (see + LICENSE.BSD for a copy). All code written since the fork of torsmo is + licensed under the GPL (see LICENSE.GPL for a copy), except where + noted differently (such as in portmon and audacious code which are + LGPL, and prss which is an MIT-style license). + + + Authors + The Conky dev team (see AUTHORS for a full list of + contributors). + diff --git a/doc/lua.xml b/doc/lua.xml index 96788167..00bbee37 100644 --- a/doc/lua.xml +++ b/doc/lua.xml @@ -7,9 +7,9 @@ - This function takes a string that is evaluated as - per Conky's TEXT section, and then returns a string - with the result. + This function takes a string that is evaluated as per + Conky's TEXT section, and then returns a string with the + result. @@ -32,26 +32,23 @@ - This table contains some information about - Conky's window. The following table describes the - values contained: + This table contains some information about Conky's window. + The following table describes the values contained: drawable - + visual - + display - + width @@ -63,42 +60,37 @@ border_inner_margin - + border_outer_margin - + border_width - + text_start_x - + text_start_y - + text_width - + text_height - + - NOTE: This table is only defined when X support - is enabled. + NOTE: This table is only defined when X support is + enabled. @@ -109,14 +101,12 @@ - This table contains some information about - Conky's internal data. The following table describes - the values contained: + This table contains some information about Conky's internal + data. The following table describes the values contained: update_interval - + @@ -129,9 +119,9 @@ - A string containing the build info for this - particular instance of Conky, including the version, - build date, and architecture. + A string containing the build info for this particular + instance of Conky, including the version, build date, and + architecture. @@ -142,8 +132,8 @@ - A string containing the build date for this - particular instance of Conky. + A string containing the build date for this particular + instance of Conky. @@ -154,8 +144,8 @@ - A string containing the build architecture for - this particular instance of Conky. + A string containing the build architecture for this + particular instance of Conky. @@ -166,8 +156,8 @@ - A string containing the version of the current - instance of Conky. + A string containing the version of the current instance of + Conky. @@ -190,12 +180,11 @@ - Call this function to return a new - cairo_text_extents_t structure. A creation function for - this structure is not provided by the cairo API. After - calling this, you should use tolua.takeownership() on - the return value to ensure ownership is passed - properly. + Call this function to return a new cairo_text_extents_t + structure. A creation function for this structure is not provided + by the cairo API. After calling this, you should use + tolua.takeownership() on the return value to ensure ownership is + passed properly. @@ -206,12 +195,11 @@ - Call this function to return a new - cairo_font_extents_t structure. A creation function for - this structure is not provided by the cairo API. After - calling this, you should use tolua.takeownership() on - the return value to ensure ownership is passed - properly. + Call this function to return a new cairo_font_extents_t + structure. A creation function for this structure is not provided + by the cairo API. After calling this, you should use + tolua.takeownership() on the return value to ensure ownership is + passed properly. @@ -222,18 +210,17 @@ - Call this function to return a new cairo_matrix_t - structure. A creation function for this structure is - not provided by the cairo API. After calling this, you - should use tolua.takeownership() on the return value to - ensure ownership is passed properly. + Call this function to return a new cairo_matrix_t structure. + A creation function for this structure is not provided by the + cairo API. After calling this, you should use + tolua.takeownership() on the return value to ensure ownership is + passed properly. - + @@ -245,8 +232,7 @@ - + diff --git a/doc/variables.xml b/doc/variables.xml index 5c10f914..c262c39e 100644 --- a/doc/variables.xml +++ b/doc/variables.xml @@ -6,9 +6,10 @@ - ACPI ac adapter state. On linux, the adapter option specifies the - subfolder of /sys/class/power_supply containing the state information (tries "AC" - and "ADP1" if there is no argument given). Non-linux systems ignore it. + ACPI ac adapter state. On linux, the adapter option + specifies the subfolder of /sys/class/power_supply containing the + state information (tries "AC" and "ADP1" if there is no argument + given). Non-linux systems ignore it. @@ -36,8 +37,8 @@ - IP address for an interface, or "No Address" if - no address is assigned. + IP address for an interface, or "No Address" if no address + is assigned. @@ -47,8 +48,8 @@ - IP addresses for an interface (if one - works - like addr). Linux only. + IP addresses for an interface (if one - works like addr). + Linux only. @@ -97,8 +98,8 @@ - Sets up the connection to apcupsd daemon. Prints - nothing, defaults to localhost:3551 + Sets up the connection to apcupsd daemon. Prints nothing, + defaults to localhost:3551 @@ -170,8 +171,8 @@ - + History graph of current load. @@ -245,8 +246,7 @@ - Display APM battery life in percent (FreeBSD, OpenBSD - only) + Display APM battery life in percent (FreeBSD, OpenBSD only) @@ -255,9 +255,8 @@ - Display remaining APM battery life in hh:mm:ss or - "unknown" if AC adapterstatus is on-line or charging - (FreeBSD, OpenBSD only) + Display remaining APM battery life in hh:mm:ss or "unknown" + if AC adapterstatus is on-line or charging (FreeBSD, OpenBSD only) @@ -375,8 +374,7 @@ - Player status (Playing/Paused/Stopped/Not - running) + Player status (Playing/Paused/Stopped/Not running) @@ -386,8 +384,7 @@ - Title of current tune with optional maximum - length specifier + Title of current tune with optional maximum length specifier @@ -397,9 +394,9 @@ - Battery status and remaining percentage capacity - of ACPI or APM battery. ACPI battery number can be given as - argument (default is BAT0). + Battery status and remaining percentage capacity of ACPI or + APM battery. ACPI battery number can be given as argument (default is + BAT0). @@ -409,10 +406,9 @@ - Battery percentage remaining of ACPI battery in a - bar. ACPI battery number can be given as argument (default - is BAT0, use all to get the mean percentage remaining for - all batteries). + Battery percentage remaining of ACPI battery in a bar. ACPI + battery number can be given as argument (default is BAT0, use all to + get the mean percentage remaining for all batteries). @@ -422,10 +418,9 @@ - Battery percentage remaining for ACPI battery. - ACPI battery number can be given as argument (default is - BAT0, use all to get the mean percentage remaining for - all batteries). + Battery percentage remaining for ACPI battery. ACPI battery + number can be given as argument (default is BAT0, use all to get the + mean percentage remaining for all batteries). @@ -435,12 +430,11 @@ - Battery status and remaining percentage capacity - of ACPI or APM battery. ACPI battery number can be given as - argument (default is BAT0). This mode display a short - status, which means that C is displayed instead of - charging, D for discharging, F for full, N for not present, - E for empty and U for unknown. + Battery status and remaining percentage capacity of ACPI or + APM battery. ACPI battery number can be given as argument (default is + BAT0). This mode display a short status, which means that C is + displayed instead of charging, D for discharging, F for full, N for + not present, E for empty and U for unknown. @@ -450,12 +444,10 @@ - Battery status for ACPI battery. - ACPI battery number can be given as argument - (default is BAT0). + Battery status for ACPI battery. ACPI battery number can be + given as argument (default is BAT0). - @@ -463,9 +455,8 @@ - Battery charge/discharge time remaining of ACPI - battery. ACPI battery number can be given as argument - (default is BAT0). + Battery charge/discharge time remaining of ACPI battery. + ACPI battery number can be given as argument (default is BAT0). @@ -476,7 +467,6 @@ Let 'text_and_other_conky_vars' blink on and off. - @@ -558,9 +548,9 @@ - Reads a file and displays the contents in conky. - This is useful if you have an independent process - generating output that you want to include in conky. + Reads a file and displays the contents in conky. This is + useful if you have an independent process generating output that you + want to include in conky. @@ -570,12 +560,11 @@ - Reads a file and displays the contents in conky. - This is useful if you have an independent process - generating output that you want to include in conky. This - differs from $cat in that it parses the contents of the - file, so you can insert things like ${color red}hi!${color} - in your file and have it correctly parsed by Conky. + Reads a file and displays the contents in conky. This is + useful if you have an independent process generating output that you + want to include in conky. This differs from $cat in that it parses the + contents of the file, so you can insert things like ${color + red}hi!${color} in your file and have it correctly parsed by Conky. @@ -585,8 +574,7 @@ - PID of the first process that has string in it's - commandline + PID of the first process that has string in it's commandline @@ -595,7 +583,7 @@ - Print aaa status of cmus (all/artist/album). + Print aaa status of cmus (all/artist/album). @@ -677,7 +665,7 @@ - Random status of cmus (on/off). + Random status of cmus (on/off). @@ -686,7 +674,7 @@ - Repeat status of cmus (song/all/off). + Repeat status of cmus (song/all/off). @@ -731,7 +719,7 @@ - Print track number of current cmus song. + Print track number of current cmus song. @@ -741,10 +729,10 @@ - Change drawing color to 'color' which is a name of - a color or a hexcode preceded with # (for example #0A1B2C ). - If you use ncurses only the following colors are supported: - red,green,yellow,blue,magenta,cyan,black,white. + Change drawing color to 'color' which is a name of a color + or a hexcode preceded with # (for example #0A1B2C ). If you use + ncurses only the following colors are supported: + red,green,yellow,blue,magenta,cyan,black,white. @@ -753,8 +741,8 @@ - Change drawing color to colorN configuration - option, where N is a digit between 0 and 9, inclusively. + Change drawing color to colorN configuration option, where N + is a digit between 0 and 9, inclusively. @@ -764,13 +752,12 @@ - Places the lines of var2 to the right of the - lines of var1 separated by the chars that are put between - var1 and var2. For example: ${combine ${head /proc/cpuinfo - 2} - ${head /proc/meminfo 1}} gives as output - "cpuinfo_line1 - meminfo_line1" on line 1 and - "cpuinfo_line2 -" on line 2. $combine vars can also be - nested to place more vars next to each other. + Places the lines of var2 to the right of the lines of var1 + separated by the chars that are put between var1 and var2. For + example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/meminfo 1}} + gives as output "cpuinfo_line1 - meminfo_line1" on line 1 and + "cpuinfo_line2 -" on line 2. $combine vars can also be nested to place + more vars next to each other. @@ -807,10 +794,9 @@ - CPU usage in percents. For SMP machines, the CPU - number can be provided as an argument. ${cpu cpu0} is the - total usage, and ${cpu cpuX} (X >= 1) are individual - CPUs. + CPU usage in percents. For SMP machines, the CPU number can + be provided as an argument. ${cpu cpu0} is the total usage, and ${cpu + cpuX} (X >= 1) are individual CPUs. @@ -820,8 +806,8 @@ - Bar that shows CPU usage, height is bar's height - in pixels. See $cpu for more info on SMP. + Bar that shows CPU usage, height is bar's height in pixels. + See $cpu for more info on SMP. @@ -831,9 +817,9 @@ - Elliptical gauge that shows CPU usage, height and - width are gauge's vertical and horizontal axis - respectively. See $cpu for more info on SMP. + Elliptical gauge that shows CPU usage, height and width are + gauge's vertical and horizontal axis respectively. See $cpu for more + info on SMP. @@ -841,16 +827,14 @@ - + - CPU usage graph, with optional colours in hex, - minus the #. See $cpu for more info on SMP. Uses a - logarithmic scale (to see small numbers) when you use the - -l switch. Takes the switch '-t' to use a temperature - gradient, which makes the gradient values change depending - on the amplitude of a particular graph value (try it and - see). + CPU usage graph, with optional colours in hex, minus the #. + See $cpu for more info on SMP. Uses a logarithmic scale (to see small + numbers) when you use the -l switch. Takes the switch '-t' to use a + temperature gradient, which makes the gradient values change depending + on the amplitude of a particular graph value (try it and see). @@ -860,16 +844,13 @@ - - Download data from URI using Curl at the - specified interval. The interval may be a positive floating - point value (0 is allowed), otherwise defaults to 15 - minutes. Most useful when used in conjunction with Lua - and the Lua API. This object is threaded, and once a - thread is created it can't be explicitly destroyed. - One thread will run for each URI specified. You can use - any protocol that Curl supports. - + Download data from URI using Curl at the specified interval. + The interval may be a positive floating point value (0 is allowed), + otherwise defaults to 15 minutes. Most useful when used in conjunction + with Lua and the Lua API. This object is threaded, and once a thread + is created it can't be explicitly destroyed. One thread will run for + each URI specified. You can use any protocol that Curl supports. + @@ -877,8 +858,8 @@ - Number of the desktop on which conky is running - or the message "Not running in X" if this is the case. + Number of the desktop on which conky is running or the + message "Not running in X" if this is the case. @@ -887,8 +868,8 @@ - Name of the desktop on which conky is running or - the message "Not running in X" if this is the case. + Name of the desktop on which conky is running or the message + "Not running in X" if this is the case. @@ -897,8 +878,8 @@ - Number of desktops or the message "Not running in - X" if this is the case. + Number of desktops or the message "Not running in X" if this + is the case. @@ -908,9 +889,8 @@ - Disk protection status, if supported (needs - kernel-patch). Prints either "frozen" or "free " (note the - padding). + Disk protection status, if supported (needs kernel-patch). + Prints either "frozen" or "free " (note the padding). @@ -920,10 +900,10 @@ - Displays current disk IO. Device is optional, and - takes the form of sda for /dev/sda. A block device label can - be specified with label:foo and a block device partuuid can - be specified with partuuid:40000000-01. + Displays current disk IO. Device is optional, and takes the + form of sda for /dev/sda. A block device label can be specified with + label:foo and a block device partuuid can be specified with + partuuid:40000000-01. @@ -933,8 +913,7 @@ - Displays current disk IO for reads. Device as in - diskio. + Displays current disk IO for reads. Device as in diskio. @@ -944,8 +923,7 @@ - Displays current disk IO for writes. Device as in - diskio. + Displays current disk IO for writes. Device as in diskio. @@ -953,16 +931,15 @@ - + - Disk IO graph, colours defined in hex, minus the - #. If scale is non-zero, it becomes the scale for the - graph. Uses a logarithmic scale (to see small numbers) when - you use -l switch. Takes the switch '-t' to use a - temperature gradient, which makes the gradient values - change depending on the amplitude of a particular graph - value (try it and see). + Disk IO graph, colours defined in hex, minus the #. If scale + is non-zero, it becomes the scale for the graph. Uses a logarithmic + scale (to see small numbers) when you use -l switch. Takes the switch + '-t' to use a temperature gradient, which makes the gradient values + change depending on the amplitude of a particular graph value (try it + and see). @@ -970,15 +947,14 @@ - + - Disk IO graph for reads, colours defined in hex, - minus the #. If scale is non-zero, it becomes the scale for - the graph. Device as in diskio. Uses a logarithmic scale - (to see small numbers) when you use -l switch. Takes the - switch '-t' to use a temperature gradient, which makes the - gradient values change depending on the amplitude of a + Disk IO graph for reads, colours defined in hex, minus the + #. If scale is non-zero, it becomes the scale for the graph. Device as + in diskio. Uses a logarithmic scale (to see small numbers) when you + use -l switch. Takes the switch '-t' to use a temperature gradient, + which makes the gradient values change depending on the amplitude of a particular graph value (try it and see). @@ -987,15 +963,14 @@ - + - Disk IO graph for writes, colours defined in hex, - minus the #. If scale is non-zero, it becomes the scale for - the graph. Device as in diskio. Uses a logarithmic scale - (to see small numbers) when you use -l switch. Takes the - switch '-t' to use a temperature gradient, which makes the - gradient values change depending on the amplitude of a + Disk IO graph for writes, colours defined in hex, minus the + #. If scale is non-zero, it becomes the scale for the graph. Device as + in diskio. Uses a logarithmic scale (to see small numbers) when you + use -l switch. Takes the switch '-t' to use a temperature gradient, + which makes the gradient values change depending on the amplitude of a particular graph value (try it and see). @@ -1005,14 +980,13 @@ - The name of the distribution. It could be that some - of the untested distributions will show up wrong or as "unknown", - if that's the case post a bug on sourceforge, make sure it - contains the name of your distribution, the contents of - /proc/version and if there is a file that only exists on your - distribution, also add the path of that file in the bug. If there - is no such file, please add another way which we can use to identify - your distribution. + The name of the distribution. It could be that some of the + untested distributions will show up wrong or as "unknown", if that's + the case post a bug on sourceforge, make sure it contains the name of + your distribution, the contents of /proc/version and if there is a + file that only exists on your distribution, also add the path of that + file in the bug. If there is no such file, please add another way + which we can use to identify your distribution. @@ -1040,16 +1014,15 @@ - + - Download speed graph, colours defined in hex, - minus the #. If scale is non-zero, it becomes the scale for - the graph. Uses a logarithmic scale (to see small numbers) - when you use -l switch. Takes the switch '-t' to use a - temperature gradient, which makes the gradient values - change depending on the amplitude of a particular graph - value (try it and see). + Download speed graph, colours defined in hex, minus the #. + If scale is non-zero, it becomes the scale for the graph. Uses a + logarithmic scale (to see small numbers) when you use -l switch. Takes + the switch '-t' to use a temperature gradient, which makes the + gradient values change depending on the amplitude of a particular + graph value (try it and see). @@ -1060,9 +1033,9 @@ - Number of mails marked as draft in the specified - mailbox or mail spool if not. Only maildir type mailboxes - are supported, mbox type will return -1. + Number of mails marked as draft in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -1100,8 +1073,7 @@ - Normalized bar of available entropy for crypto - freaks + Normalized bar of available entropy for crypto freaks @@ -1110,8 +1082,8 @@ - Percentage of entropy available in comparison to - the poolsize + Percentage of entropy available in comparison to the + poolsize @@ -1120,8 +1092,7 @@ - Total size of system entropy pool for crypto - freaks + Total size of system entropy pool for crypto freaks @@ -1131,11 +1102,10 @@ - Evaluates given string according to the rules of - conky.text interpretation, i.e. parsing any contained text object - specifications into their output, any occuring '$$' into a - single '$' and so on. The output is then being parsed - again. + Evaluates given string according to the rules of conky.text + interpretation, i.e. parsing any contained text object specifications + into their output, any occuring '$$' into a single '$' and so on. The + output is then being parsed again. @@ -1145,11 +1115,11 @@ - Fetches a character's currently training skill from - the Eve Online API servers (http://www.eveonline.com/) and - displays the skill along with the remaining training time. - If the character is not actively training a skill then returns - the empty string (for use with $if_empty). + Fetches a character's currently training skill from the Eve + Online API servers (http://www.eveonline.com/) and displays the skill + along with the remaining training time. If the character is not + actively training a skill then returns the empty string (for use with + $if_empty). @@ -1159,10 +1129,9 @@ - Executes a shell command and displays the output - in conky. Warning: this takes a lot more resources than - other variables. I'd recommend coding wanted behaviour in C/C++ - and posting a patch. + Executes a shell command and displays the output in conky. + Warning: this takes a lot more resources than other variables. I'd + recommend coding wanted behaviour in C/C++ and posting a patch. @@ -1173,11 +1142,11 @@ - Same as exec, except if the first value returned is - a value between 0-100, it will use that number to draw a - horizontal bar. The height and width parameters are optional, - and default to the default_bar_height and default_bar_width - config settings, respectively. + Same as exec, except if the first value returned is a value + between 0-100, it will use that number to draw a horizontal bar. The + height and width parameters are optional, and default to the + default_bar_height and default_bar_width config settings, + respectively. @@ -1188,12 +1157,11 @@ - Same as exec, except if the first value returned is - a value between 0-100, it will use that number to draw a - round gauge (much like a vehicle speedometer). The height and - width parameters are optional, and default to the - default_gauge_height and default_gauge_width config settings, - respectively. + Same as exec, except if the first value returned is a value + between 0-100, it will use that number to draw a round gauge (much + like a vehicle speedometer). The height and width parameters are + optional, and default to the default_gauge_height and + default_gauge_width config settings, respectively. @@ -1210,36 +1178,32 @@ - Draws a horizontally scrolling graph with values - from 0-100 plotted on the vertical axis. All parameters - following the command are optional. Gradient colors can - be specified as hexadecimal values with no 0x or # - prefix. Use the -t switch to enable a temperature - gradient, so that small values are "cold" with color 1 - and large values are "hot" with color 2. Without the -t - switch, the colors produce a horizontal gradient - spanning the width of the graph. The scale parameter - defines the maximum value of the graph. Use the -l - switch to enable a logarithmic scale, which helps to see - small values. The default size for graphs can be - controlled via the default_graph_height and - default_graph_width config settings. - - If you need to execute a command with spaces, you - have a couple options: 1) wrap your command in - double-quotes, or 2) put your command into a separate - file, such as ~/bin/myscript.sh, and use that as your - execgraph command. Remember to make your script - executable! - - In the following example, we set up execgraph to - display seconds (0-59) on a graph that is 50px high and 200px - wide, using a temperature gradient with colors ranging from red - for small values (FF0000) to yellow for large values (FFFF00). - We set the scale to 60. - - ${execgraph ~/seconds.sh 50,200 FF0000 - FFFF00 60 -t} + Draws a horizontally scrolling graph with values from 0-100 + plotted on the vertical axis. All parameters following the command + are optional. Gradient colors can be specified as hexadecimal + values with no 0x or # prefix. Use the -t switch to enable a + temperature gradient, so that small values are "cold" with color 1 + and large values are "hot" with color 2. Without the -t switch, + the colors produce a horizontal gradient spanning the width of the + graph. The scale parameter defines the maximum value of the graph. + Use the -l switch to enable a logarithmic scale, which helps to + see small values. The default size for graphs can be controlled + via the default_graph_height and default_graph_width config + settings. + If you need to execute a command with spaces, you have a + couple options: 1) wrap your command in double-quotes, or 2) put + your command into a separate file, such as ~/bin/myscript.sh, and + use that as your execgraph command. Remember to make your script + executable! + In the following example, we set up execgraph to display + seconds (0-59) on a graph that is 50px high and 200px wide, using + a temperature gradient with colors ranging from red for small + values (FF0000) to yellow for large values (FFFF00). We set the + scale to 60. + + ${execgraph ~/seconds.sh 50,200 FF0000 FFFF00 60 + -t} + @@ -1250,9 +1214,9 @@ - Same as exec, but with a specific interval in - seconds. The interval can't be less than the update_interval - in your configuration. See also $texeci. + Same as exec, but with a specific interval in seconds. The + interval can't be less than the update_interval in your configuration. + See also $texeci. @@ -1303,18 +1267,16 @@ - Executes a shell command and displays the output - in conky. Warning: this takes a lot more resources than - other variables. I'd recommend coding wanted behaviour in C/C++ - and posting a patch. This differs from $exec in that it - parses the output of the command, so you can insert things - like ${color red}hi!${color} in your script and have it - correctly parsed by Conky. Caveats: Conky parses and - evaluates the output of $execp every time Conky loops, and - then destroys all the objects. If you try to use anything - like $execi within an $execp statement, it will - functionally run at the same interval that the $execp - statement runs, as it is created and destroyed at every + Executes a shell command and displays the output in conky. + Warning: this takes a lot more resources than other variables. I'd + recommend coding wanted behaviour in C/C++ and posting a patch. This + differs from $exec in that it parses the output of the command, so you + can insert things like ${color red}hi!${color} in your script and have + it correctly parsed by Conky. Caveats: Conky parses and evaluates the + output of $execp every time Conky loops, and then destroys all the + objects. If you try to use anything like $execi within an $execp + statement, it will functionally run at the same interval that the + $execp statement runs, as it is created and destroyed at every interval. @@ -1326,9 +1288,9 @@ - Same as execp, but with an interval. Note that - the output from the $execpi command is still parsed - and evaluated at every interval. + Same as execp, but with an interval. Note that the output + from the $execpi command is still parsed and evaluated at every + interval. @@ -1339,9 +1301,9 @@ - Number of mails marked as flagged in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails marked as flagged in the specified mailbox + or mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -1351,10 +1313,9 @@ - Specify a different font. This new font will - apply to the current line and everything following. You can - use a $font with no arguments to change back to the default - font (much like with $color) + Specify a different font. This new font will apply to the + current line and everything following. You can use a $font with no + arguments to change back to the default font (much like with $color) @@ -1363,8 +1324,8 @@ - Change font to fontN configuration - option, where N is a digit between 0 and 9, inclusively. + Change font to fontN configuration option, where N is a + digit between 0 and 9, inclusively. @@ -1374,19 +1335,18 @@ - Format time given in seconds. This var only works when - the times_in_seconds configuration setting is on. Format is a string - that should start and end with a "-char. The "-chars are not - part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by - weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit, - it's value will be expressed in the highest unite lower then the - one left out. Text between ()-chars will not be visible if a - replaced unit in this text is 0. If seconds is a decimal number - then you can see the numbers behind the point by using \S - followed by a number that specifies the amount of - digits behind the point that you want to see (maximum 9). - You can also place a 'x' behind \S so you have all digits behind - the point and no trailing zero's. (also maximum 9) + Format time given in seconds. This var only works when the + times_in_seconds configuration setting is on. Format is a string that + should start and end with a "-char. The "-chars are not part of the + output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by + weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit, + it's value will be expressed in the highest unite lower then the one + left out. Text between ()-chars will not be visible if a replaced unit + in this text is 0. If seconds is a decimal number then you can see the + numbers behind the point by using \S followed by a number that + specifies the amount of digits behind the point that you want to see + (maximum 9). You can also place a 'x' behind \S so you have all digits + behind the point and no trailing zero's. (also maximum 9) @@ -1397,9 +1357,9 @@ - Number of mails marked as forwarded in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails marked as forwarded in the specified mailbox + or mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -1409,8 +1369,8 @@ - Returns CPU #n's frequency in MHz. CPUs are - counted from 1. If omitted, the parameter defaults to 1. + Returns CPU #n's frequency in MHz. CPUs are counted from 1. + If omitted, the parameter defaults to 1. @@ -1420,8 +1380,8 @@ - Returns CPU #n's frequency in GHz. CPUs are - counted from 1. If omitted, the parameter defaults to 1. + Returns CPU #n's frequency in GHz. CPUs are counted from 1. + If omitted, the parameter defaults to 1. @@ -1442,9 +1402,8 @@ - Bar that shows how much space is used on a file - system. height is the height in pixels. fs is any file on - that file system. + Bar that shows how much space is used on a file system. + height is the height in pixels. fs is any file on that file system. @@ -1454,9 +1413,8 @@ - Bar that shows how much space is free on a file - system. height is the height in pixels. fs is any file on - that file system. + Bar that shows how much space is free on a file system. + height is the height in pixels. fs is any file on that file system. @@ -1476,8 +1434,8 @@ - Free percentage of space on a file system - available for users. + Free percentage of space on a file system available for + users. @@ -1526,7 +1484,8 @@ - Number of GitHub notifications. + Number of GitHub notifications. + @@ -1544,8 +1503,8 @@ - Displays the default route's interface or - "multiple"/"none" accordingly. + Displays the default route's interface or "multiple"/"none" + accordingly. @@ -1554,8 +1513,8 @@ - Displays the default gateway's IP or - "multiple"/"none" accordingly. + Displays the default gateway's IP or "multiple"/"none" + accordingly. @@ -1565,11 +1524,10 @@ - Displays temperature of a selected hard disk - drive as reported by the hddtemp daemon. Use hddtemp_host - and hddtemp_port to specify a host and port for all hddtemp - objects. If no dev parameter is given, the first disk returned - by the hddtemp daemon is used. + Displays temperature of a selected hard disk drive as + reported by the hddtemp daemon. Use hddtemp_host and hddtemp_port to + specify a host and port for all hddtemp objects. If no dev parameter + is given, the first disk returned by the hddtemp daemon is used. @@ -1579,10 +1537,10 @@ - Displays first N lines of supplied text file. The - file is checked every 'next_check' update. If next_check is - not supplied, Conky defaults to 2. Max of 30 lines can be - displayed, or until the text buffer is filled. + Displays first N lines of supplied text file. The file is + checked every 'next_check' update. If next_check is not supplied, + Conky defaults to 2. Max of 30 lines can be displayed, or until the + text buffer is filled. @@ -1602,16 +1560,15 @@ - Hwmon sensor from sysfs (Linux 2.6). Parameter - dev may be omitted if you have only one hwmon device. - Parameter type is either 'in' or 'vol' meaning voltage; - 'fan' meaning fan; 'temp' meaning temperature. Parameter n - is number of the sensor. See /sys/class/hwmon/ on your - local computer. The optional arguments 'factor' and - 'offset' allow precalculation of the raw input, which is - being modified as follows: 'input = input * factor + - offset'. Note that they have to be given as decimal values - (i.e. contain at least one decimal place). + Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be + omitted if you have only one hwmon device. Parameter type is either + 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning + temperature. Parameter n is number of the sensor. See + /sys/class/hwmon/ on your local computer. The optional arguments + 'factor' and 'offset' allow precalculation of the raw input, which is + being modified as follows: 'input = input * factor + offset'. Note + that they have to be given as decimal values (i.e. contain at least + one decimal place). @@ -1631,16 +1588,15 @@ - I2C sensor from sysfs (Linux 2.6). Parameter dev - may be omitted if you have only one I2C device. Parameter - type is either 'in' or 'vol' meaning voltage; 'fan' meaning - fan; 'temp' meaning temperature. Parameter n is number of - the sensor. See /sys/bus/i2c/devices/ on your local - computer. The optional arguments 'factor' and 'offset' - allow precalculation of the raw input, which is being - modified as follows: 'input = input * factor + offset'. - Note that they have to be given as decimal values (i.e. - contain at least one decimal place). + I2C sensor from sysfs (Linux 2.6). Parameter dev may be + omitted if you have only one I2C device. Parameter type is either 'in' + or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning + temperature. Parameter n is number of the sensor. See + /sys/bus/i2c/devices/ on your local computer. The optional arguments + 'factor' and 'offset' allow precalculation of the raw input, which is + being modified as follows: 'input = input * factor + offset'. Note + that they have to be given as decimal values (i.e. contain at least + one decimal place). @@ -1650,10 +1606,10 @@ @@ -1663,8 +1619,8 @@ @@ -1674,9 +1630,8 @@ @@ -1686,9 +1641,8 @@ @@ -1698,10 +1652,10 @@ @@ -1711,10 +1665,10 @@ @@ -1724,10 +1678,10 @@ @@ -1737,10 +1691,10 @@ @@ -1750,9 +1704,8 @@ @@ -1762,8 +1715,8 @@ @@ -1772,8 +1725,8 @@ - If running the IBM ACPI, displays the brigtness - of the laptops's LCD (0-7). + If running the IBM ACPI, displays the brigtness of the + laptops's LCD (0-7). @@ -1792,9 +1745,9 @@ - If running the IBM ACPI, displays the - temperatures from the IBM temperature sensors (N=0..7) - Sensor 0 is on the CPU, 3 is on the GPU. + If running the IBM ACPI, displays the temperatures from the + IBM temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the + GPU. @@ -1804,8 +1757,8 @@ If running the IBM ACPI, displays the status of your - ThinkLight™. Value is either 'on', 'off' or 'unknown'. - + ThinkLight™. Value is either 'on', 'off' or 'unknown'. + @@ -1813,8 +1766,8 @@ - If running the IBM ACPI, displays the "master" - volume, controlled by the volume keys (0-14). + If running the IBM ACPI, displays the "master" volume, + controlled by the volume keys (0-14). @@ -1824,11 +1777,11 @@ - Shows title of event number 'number' in the ical (RFC 5545) file - 'file'. The events are first ordered by starting time, events that started - in the past are ignored. The events that are shown are the VEVENTS, the - title that is shown is the SUMMARY and the starting time used for sorting - is DTSTART . + Shows title of event number 'number' in the ical (RFC 5545) + file 'file'. The events are first ordered by starting time, events + that started in the past are ignored. The events that are shown are + the VEVENTS, the title that is shown is the SUMMARY and the starting + time used for sorting is DTSTART . @@ -1851,8 +1804,8 @@ - Convert text from one codeset to another using - GNU iconv. Needs to be stopped with iconv_stop. + Convert text from one codeset to another using GNU iconv. + Needs to be stopped with iconv_stop. @@ -1872,8 +1825,8 @@ - if conky variable VAR is empty, display - everything between $if_empty and the matching $endif + if conky variable VAR is empty, display everything between + $if_empty and the matching $endif @@ -1883,11 +1836,10 @@ - if FILE exists, display everything between - if_existing and the matching $endif. The optional second - parameter checks for FILE containing the specified string - and prints everything between $if_existing and the matching - $endif. + if FILE exists, display everything between if_existing and + the matching $endif. The optional second parameter checks for FILE + containing the specified string and prints everything between + $if_existing and the matching $endif. @@ -1896,8 +1848,8 @@ - if there is at least one default gateway, display - everything between $if_gw and the matching $endif + if there is at least one default gateway, display everything + between $if_gw and the matching $endif @@ -1907,25 +1859,23 @@ - Evaluates the given boolean expression, printing - everything between $if_match and the matching $endif - depending on whether the evaluation returns true or not. - Valid expressions consist of a left side, an operator and a - right side. Left and right sides are being parsed for - contained text objects before evaluation. Recognised left + Evaluates the given boolean expression, printing everything + between $if_match and the matching $endif depending on whether the + evaluation returns true or not. Valid expressions consist of a left + side, an operator and a right side. Left and right sides are being + parsed for contained text objects before evaluation. Recognised left and right side types are: - doubleArgument consists of only - digits and a single dot. + doubleArgument consists of only digits and a + single dot. - longArgument consists of only - digits. + longArgument consists of only digits. - stringArgument is enclosed in - quotation marks (") - Valid operands are: '>', '<', '>=', - '<=', '==', '!='. + stringArgument is enclosed in quotation marks + (") + Valid operands are: '>', '<', '>=', '<=', + '==', '!='. @@ -1935,9 +1885,8 @@ - If mixer exists, display everything between - $if_mixer_mute and the matching $endif. If no mixer is - specified, "Vol" is used. + If mixer exists, display everything between $if_mixer_mute + and the matching $endif. If no mixer is specified, "Vol" is used. @@ -1947,8 +1896,8 @@ - if MOUNTPOINT is mounted, display everything - between $if_mounted and the matching $endif + if MOUNTPOINT is mounted, display everything between + $if_mounted and the matching $endif @@ -1957,8 +1906,8 @@ - if mpd is playing or paused, display everything - between $if_mpd_playing and the matching $endif + if mpd is playing or paused, display everything between + $if_mpd_playing and the matching $endif @@ -1969,8 +1918,8 @@ If Pulseaudio's default sink is muted, display everything between $if_pa_sink_muted and the corresponding $else or $endif. - - + + @@ -1978,21 +1927,20 @@ - If PROCESS is running, display everything - between $if_running and the corresponding $else or $endif. - Note that PROCESS may be either a full command line with - arguments (without the directory prefix), or simply the name - of an executable. For example, either of the following will - be true if there is a running process with the command line + If PROCESS is running, display everything between + $if_running and the corresponding $else or $endif. Note that PROCESS + may be either a full command line with arguments (without the + directory prefix), or simply the name of an executable. For example, + either of the following will be true if there is a running process + with the command line /usr/bin/conky -u 5: - ${if_running conky -u 5} or - ${if_running conky} - - - It is important not to include trailing spaces. For example, - ${if_running conky } will be false. + ${if_running conky -u 5}or + ${if_running conky} + It is important not to include trailing spaces. For + example, + ${if_running conky }will be false. @@ -2002,9 +1950,9 @@ - when using smapi, if the battery with index INDEX - is installed, display everything between - $if_smapi_bat_installed and the matching $endif + when using smapi, if the battery with index INDEX is + installed, display everything between $if_smapi_bat_installed and the + matching $endif @@ -2014,8 +1962,8 @@ - if INTERFACE exists and is up, display everything - between $if_up and the matching $endif + if INTERFACE exists and is up, display everything between + $if_up and the matching $endif @@ -2025,12 +1973,11 @@ - If it's the UPDATENR-th time that conky updates, - display everything between $if_updatenr and the matching - $endif. The counter resets when the highest UPDATENR is - reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr - 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the - time followed by bar 25% of the time followed by nothing + If it's the UPDATENR-th time that conky updates, display + everything between $if_updatenr and the matching $endif. The counter + resets when the highest UPDATENR is reached. Example : "{$if_updatenr + 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif" shows foo + 25% of the time followed by bar 25% of the time followed by nothing the other half of the time. @@ -2040,8 +1987,8 @@ - Display everything between $if_xmms2_connected - and the matching $endif if xmms2 is running. + Display everything between $if_xmms2_connected and the + matching $endif if xmms2 is running. @@ -2049,24 +1996,22 @@ - + - Renders an image from the path specified using - Imlib2. Takes 4 optional arguments: a position, a size, a - no-cache switch, and a cache flush interval. Changing the - x,y position will move the position of the image, and - changing the WxH will scale the image. If you specify the - no-cache flag (-n), the image will not be cached. - Alternately, you can specify the -f int switch to specify a - cache flush interval for a particular image. Example: - ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200} - will render 'cheeseburger.jpg' at (20,20) scaled to 200x200 - pixels. Conky does not make any attempt to adjust the - position (or any other formatting) of images, they are just - rendered as per the arguments passed. The only reason - $image is part of the conky.text section, is to allow for runtime - modifications, through $execp $lua_parse, or some other + Renders an image from the path specified using Imlib2. Takes + 4 optional arguments: a position, a size, a no-cache switch, and a + cache flush interval. Changing the x,y position will move the position + of the image, and changing the WxH will scale the image. If you + specify the no-cache flag (-n), the image will not be cached. + Alternately, you can specify the -f int switch to specify a cache + flush interval for a particular image. Example: ${image + /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200} will render + 'cheeseburger.jpg' at (20,20) scaled to 200x200 pixels. Conky does not + make any attempt to adjust the position (or any other formatting) of + images, they are just rendered as per the arguments passed. The only + reason $image is part of the conky.text section, is to allow for + runtime modifications, through $execp $lua_parse, or some other method. @@ -2077,15 +2022,14 @@ - Displays the number of messages in your global - IMAP inbox by default. You can define individual IMAP - inboxes separately by passing arguments to this object. - Arguments are: "host user pass [-i interval (in seconds)] - [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default - port is 143, default folder is 'INBOX', default interval is - 5 minutes, and default number of retries before giving up - is 5. If the password is supplied as '*', you will be - prompted to enter the password when Conky starts. + Displays the number of messages in your global IMAP inbox by + default. You can define individual IMAP inboxes separately by passing + arguments to this object. Arguments are: "host user pass [-i interval + (in seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]". + Default port is 143, default folder is 'INBOX', default interval is 5 + minutes, and default number of retries before giving up is 5. If the + password is supplied as '*', you will be prompted to enter the + password when Conky starts. @@ -2095,15 +2039,14 @@ - Displays the number of unseen messages in your - global IMAP inbox by default. You can define individual - IMAP inboxes separately by passing arguments to this - object. Arguments are: "host user pass [-i interval (in - seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]". - Default port is 143, default folder is 'INBOX', default - interval is 5 minutes, and default number of retries before - giving up is 5. If the password is supplied as '*', you - will be prompted to enter the password when Conky starts. + Displays the number of unseen messages in your global IMAP + inbox by default. You can define individual IMAP inboxes separately by + passing arguments to this object. Arguments are: "host user pass [-i + interval (in seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r + retries]". Default port is 143, default folder is 'INBOX', default + interval is 5 minutes, and default number of retries before giving up + is 5. If the password is supplied as '*', you will be prompted to + enter the password when Conky starts. @@ -2113,8 +2056,8 @@ - Prints the current ioscheduler used for the given - disk name (i.e. e.g. "hda" or "sdb") + Prints the current ioscheduler used for the given disk name + (i.e. e.g. "hda" or "sdb") @@ -2126,9 +2069,9 @@ Displays last N lines of the systemd journal. The optional type can be 'user' or 'system' which will show only the user or system - journal respectively. By default, all journal lines visible to the user - are shown. A maximum of 200 lines can be displayed, or until the text - buffer is filled. + journal respectively. By default, all journal lines visible to the + user are shown. A maximum of 200 lines can be displayed, or until the + text buffer is filled. @@ -2211,9 +2154,9 @@ - System load average, 1 is for past 1 minute, 2 - for past 5 minutes and 3 for past 15 minutes. Without argument, prints - all three values separated by whitespace. + System load average, 1 is for past 1 minute, 2 for past 5 + minutes and 3 for past 15 minutes. Without argument, prints all three + values separated by whitespace. @@ -2221,15 +2164,14 @@ - + - Load1 average graph, similar to xload, with - optional colours in hex, minus the #. Uses a logarithmic - scale (to see small numbers) when you use the -l switch. - Takes the switch '-t' to use a temperature gradient, which - makes the gradient values change depending on the amplitude - of a particular graph value (try it and see). + Load1 average graph, similar to xload, with optional colours + in hex, minus the #. Uses a logarithmic scale (to see small numbers) + when you use the -l switch. Takes the switch '-t' to use a temperature + gradient, which makes the gradient values change depending on the + amplitude of a particular graph value (try it and see). @@ -2239,11 +2181,10 @@ - Executes a Lua function with given parameters, - then prints the returned string. See also 'lua_load' on how - to load scripts. Conky puts 'conky_' in front of - function_name to prevent accidental calls to the wrong - function unless you put you place 'conky_' in front of it + Executes a Lua function with given parameters, then prints + the returned string. See also 'lua_load' on how to load scripts. Conky + puts 'conky_' in front of function_name to prevent accidental calls to + the wrong function unless you put you place 'conky_' in front of it yourself. @@ -2255,12 +2196,11 @@ - Executes a Lua function with given parameters and - draws a bar. Expects result value to be an integer between - 0 and 100. See also 'lua_load' on how to load scripts. - Conky puts 'conky_' in front of function_name to prevent - accidental calls to the wrong function unless you put you - place 'conky_' in front of it yourself. + Executes a Lua function with given parameters and draws a + bar. Expects result value to be an integer between 0 and 100. See also + 'lua_load' on how to load scripts. Conky puts 'conky_' in front of + function_name to prevent accidental calls to the wrong function unless + you put you place 'conky_' in front of it yourself. @@ -2271,12 +2211,11 @@ - Executes a Lua function with given parameters and - draws a gauge. Expects result value to be an integer - between 0 and 100. See also 'lua_load' on how to load - scripts. Conky puts 'conky_' in front of function_name to - prevent accidental calls to the wrong function unless you - put you place 'conky_' in front of it yourself. + Executes a Lua function with given parameters and draws a + gauge. Expects result value to be an integer between 0 and 100. See + also 'lua_load' on how to load scripts. Conky puts 'conky_' in front + of function_name to prevent accidental calls to the wrong function + unless you put you place 'conky_' in front of it yourself. @@ -2284,18 +2223,17 @@ - + - Executes a Lua function with and draws a graph. - Expects result value to be any number, and by default will - scale to show the full range. See also 'lua_load' on how to - load scripts. Takes the switch '-t' to use a temperature - gradient, which makes the gradient values change depending - on the amplitude of a particular graph value (try it and - see). Conky puts 'conky_' in front of function_name to - prevent accidental calls to the wrong function unless you - put you place 'conky_' in front of it yourself. + Executes a Lua function with and draws a graph. Expects + result value to be any number, and by default will scale to show the + full range. See also 'lua_load' on how to load scripts. Takes the + switch '-t' to use a temperature gradient, which makes the gradient + values change depending on the amplitude of a particular graph value + (try it and see). Conky puts 'conky_' in front of function_name to + prevent accidental calls to the wrong function unless you put you + place 'conky_' in front of it yourself. @@ -2305,12 +2243,11 @@ - Executes a Lua function with given parameters as - per $lua, then parses and prints the result value as per - the syntax for the conky.text section. See also 'lua_load' on - how to load scripts. Conky puts 'conky_' in front of - function_name to prevent accidental calls to the wrong - function unless you put you place 'conky_' in front of it + Executes a Lua function with given parameters as per $lua, + then parses and prints the result value as per the syntax for the + conky.text section. See also 'lua_load' on how to load scripts. Conky + puts 'conky_' in front of function_name to prevent accidental calls to + the wrong function unless you put you place 'conky_' in front of it yourself. @@ -2331,11 +2268,10 @@ - Mail count in the specified mailbox or your mail - spool if not. Both mbox and maildir type mailboxes are - supported. You can use a program like fetchmail to get - mails from some server using your favourite protocol. See - also new_mails. + Mail count in the specified mailbox or your mail spool if + not. Both mbox and maildir type mailboxes are supported. You can use a + program like fetchmail to get mails from some server using your + favourite protocol. See also new_mails. @@ -2343,13 +2279,12 @@ - + - Print a summary of recent messages in an mbox - format mailbox. mbox parameter is the filename of the - mailbox (can be encapsulated using '"', ie. ${mboxscan -n - 10 "/home/brenden/some box"} + Print a summary of recent messages in an mbox format + mailbox. mbox parameter is the filename of the mailbox (can be + encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"} @@ -2367,7 +2302,8 @@ - Amount of memory in use, including that used by system buffers and caches + Amount of memory in use, including that used by system + buffers and caches @@ -2387,7 +2323,8 @@ - Bar that shows amount of memory in use (including memory used by system buffers and caches) + Bar that shows amount of memory in use (including memory + used by system buffers and caches) @@ -2395,14 +2332,14 @@ - + - Memory usage graph including memory used by system buffers and - cache. Uses a logarithmic scale (to see small numbers) when you use - the -l switch. Takes the switch '-t' to use a temperature gradient, - which makes the gradient values change depending on the amplitude of - a particular graph value (try it and see). + Memory usage graph including memory used by system buffers + and cache. Uses a logarithmic scale (to see small numbers) when you + use the -l switch. Takes the switch '-t' to use a temperature + gradient, which makes the gradient values change depending on the + amplitude of a particular graph value (try it and see). @@ -2420,8 +2357,8 @@ - Amount of free memory including the memory that - is very easily freed (buffers/cache) + Amount of free memory including the memory that is very + easily freed (buffers/cache) @@ -2440,8 +2377,7 @@ - Gauge that shows amount of memory in use (see - cpugauge) + Gauge that shows amount of memory in use (see cpugauge) @@ -2449,14 +2385,13 @@ - + - Memory usage graph. Uses a logarithmic scale (to - see small numbers) when you use the -l switch. Takes the - switch '-t' to use a temperature gradient, which makes the - gradient values change depending on the amplitude of a - particular graph value (try it and see). + Memory usage graph. Uses a logarithmic scale (to see small + numbers) when you use the -l switch. Takes the switch '-t' to use a + temperature gradient, which makes the gradient values change depending + on the amplitude of a particular graph value (try it and see). @@ -2484,15 +2419,13 @@ - Prints the mixer value as reported by the OS. - On Linux, this variable uses the OSS emulation, so you - need the proper kernel module loaded. - Default mixer is "Vol", but you can specify one of the - available OSS controls: "Vol", "Bass", "Trebl", "Synth", - "Pcm", "Spkr", "Line", "Mic", "CD", "Mix", "Pcm2 ", "Rec", - "IGain", "OGain", "Line1", "Line2", "Line3", "Digital1", - "Digital2", "Digital3", "PhoneIn", "PhoneOut", "Video", - "Radio" and "Monitor". + Prints the mixer value as reported by the OS. On Linux, this + variable uses the OSS emulation, so you need the proper kernel module + loaded. Default mixer is "Vol", but you can specify one of the + available OSS controls: "Vol", "Bass", "Trebl", "Synth", "Pcm", + "Spkr", "Line", "Mic", "CD", "Mix", "Pcm2 ", "Rec", "IGain", "OGain", + "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", + "PhoneIn", "PhoneOut", "Video", "Radio" and "Monitor". @@ -2502,8 +2435,8 @@ - Displays mixer value in a bar as reported by the - OS. See docs for $mixer for details on arguments. + Displays mixer value in a bar as reported by the OS. See + docs for $mixer for details on arguments. @@ -2513,8 +2446,8 @@ - Prints the left channel mixer value as reported - by the OS. See docs for $mixer for details on arguments. + Prints the left channel mixer value as reported by the OS. + See docs for $mixer for details on arguments. @@ -2524,9 +2457,8 @@ - Displays the left channel mixer value in a bar as - reported by the OS. See docs for $mixer for details on - arguments. + Displays the left channel mixer value in a bar as reported + by the OS. See docs for $mixer for details on arguments. @@ -2536,8 +2468,8 @@ - Prints the right channel mixer value as reported - by the OS. See docs for $mixer for details on arguments. + Prints the right channel mixer value as reported by the OS. + See docs for $mixer for details on arguments. @@ -2547,9 +2479,8 @@ - Displays the right channel mixer value in a bar - as reported by the OS. See docs for $mixer for details on - arguments. + Displays the right channel mixer value in a bar as reported + by the OS. See docs for $mixer for details on arguments. @@ -2657,8 +2588,8 @@ - Number of the monitor on which conky is running - or the message "Not running in X" if this is the case. + Number of the monitor on which conky is running or the + message "Not running in X" if this is the case. @@ -2667,8 +2598,8 @@ - Number of monitors or the message "Not running in - X" if this is the case. + Number of monitors or the message "Not running in X" if this + is the case. @@ -2695,8 +2626,7 @@ - Artist in current MPD song must be enabled at - compile + Artist in current MPD song must be enabled at compile @@ -2806,8 +2736,8 @@ - Prints the song name in either the form "artist - - title" or file name, depending on whats available + Prints the song name in either the form "artist - title" or + file name, depending on whats available @@ -2854,8 +2784,8 @@ - Shows the first field of the first row of the - result of the query. + Shows the first field of the first row of the result of the + query. @@ -2865,8 +2795,8 @@ - Print a nameserver from /etc/resolv.conf. Index - starts at and defaults to 0. + Print a nameserver from /etc/resolv.conf. Index starts at + and defaults to 0. @@ -2877,9 +2807,8 @@ - Unread mail count in the specified mailbox or - mail spool if not. Both mbox and maildir type mailboxes are - supported. + Unread mail count in the specified mailbox or mail spool if + not. Both mbox and maildir type mailboxes are supported. @@ -2907,10 +2836,10 @@ - Shows text and parses the vars in it, but doesn't - update them. Use this for things that do not change while conky - is running, like $machine, $conky_version,... By not updating - this you can save some resources. + Shows text and parses the vars in it, but doesn't update + them. Use this for things that do not change while conky is running, + like $machine, $conky_version,... By not updating this you can save + some resources. @@ -2921,39 +2850,34 @@ - Nvidia graphics card information via the XNVCtrl - library. + Nvidia graphics card information via the XNVCtrl library. - GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0 - + GPU_ID:Optional parameter to choose the GPU to be + used as 0,1,2,3,.. Default parameter is 0 - Possible arguments: (Temperatures are - printed as float, all other values as integer. Bracketed - arguments are aliases) + Possible arguments:(Temperatures are printed as + float, all other values as integer. Bracketed arguments are aliases) - gputemp - (temp) - - + gputemp( + temp) + - gputempthreshold - (threshold) - - + gputempthreshold( + threshold) + - ambienttemp - (ambient) - - - + ambienttemp( + ambient) + - gpufreqcur - (gpufreq) - - + gpufreqcur( + gpufreq) + gpufreqmin @@ -2962,13 +2886,11 @@ gpufreqmax - - memfreqcur - (memfreq) - - + memfreqcur( + memfreq) + memfreqmin @@ -2977,13 +2899,11 @@ memfreqmax - - mtrfreqcur - (mtrfreq) - - + mtrfreqcur( + mtrfreq) + mtrfreqmin @@ -2992,13 +2912,11 @@ mtrfreqmax - - perflevelcur - (perflevel) - - + perflevelcur( + perflevel) + perflevelmin @@ -3011,7 +2929,6 @@ perfmode - gpuutil @@ -3023,35 +2940,30 @@ videoutil - + + pcieutil - - memused - (mem) - - + memused( + mem) + - memfree - (memavail) - - + memfree( + memavail) + - memmax - (memtotal) - - + memmax( + memtotal) + - memutil - (memperc) - - - + memutil( + memperc) + fanspeed @@ -3061,7 +2973,6 @@ fanlevel - imagequality @@ -3071,8 +2982,7 @@ modelname - - + @@ -3083,55 +2993,54 @@ - Same as nvidia, except it draws its output in a - horizontal bar. The height and width parameters are optional, - and default to the default_bar_height and default_bar_width - config settings, respectively. + Same as nvidia, except it draws its output in a horizontal + bar. The height and width parameters are optional, and default to the + default_bar_height and default_bar_width config settings, + respectively. - GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0 - + GPU_ID:Optional parameter to choose the GPU to be + used as 0,1,2,3,.. Default parameter is 0 - Note the following arguments are incompatible: - - - gputempthreshold - (threshold) - - - gpufreqmin - - - gpufreqmax - - - memfreqmin - - - memfreqmax - - - mtrfreqmin - - - mtrfreqmax - - - perflevelmin - - - perflevelmax - - - perfmode - - - memtotal - (memmax) - - - fanspeed - - + Note the following arguments are + incompatible: + + + gputempthreshold( + threshold) + + gpufreqmin + + + gpufreqmax + + + memfreqmin + + + memfreqmax + + + mtrfreqmin + + + mtrfreqmax + + + perflevelmin + + + perflevelmax + + + perfmode + + + memtotal( + memmax) + + fanspeed + + @@ -3143,17 +3052,15 @@ - Same as nvidiabar, except a round gauge - (much like a vehicle speedometer). The height - and width parameters are optional, and default to the - default_gauge_height and default_gauge_width config + Same as nvidiabar, except a round gauge (much like a vehicle + speedometer). The height and width parameters are optional, and + default to the default_gauge_height and default_gauge_width config settings, respectively. - GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0 - - - For possible arguments see nvidia and nvidiabar. - + GPU_ID:Optional parameter to choose the GPU to be + used as 0,1,2,3,.. Default parameter is 0 + For possible arguments see nvidia and + nvidiabar. @@ -3169,19 +3076,16 @@ - Same as nvidiabar, except a horizontally - scrolling graph with values from 0-100 plotted on the - vertical axis. The height and width parameters are - optional, and default to the default_graph_height and - default_graph_width config settings, respectively. + Same as nvidiabar, except a horizontally scrolling graph + with values from 0-100 plotted on the vertical axis. The height and + width parameters are optional, and default to the default_graph_height + and default_graph_width config settings, respectively. - GPU_ID: NOT optional. This parameter allows to choose the GPU to be used as 0,1,2,3,.. - - - For possible arguments see nvidia and nvidiabar. To learn more - about the -t -l and gradient color options, - see execgraph. - + GPU_ID:NOT optional. This parameter allows to + choose the GPU to be used as 0,1,2,3,.. + For possible arguments see nvidia and nvidiabar. To learn more + about the -t -l and gradient color options, see + execgraph. @@ -3274,7 +3178,7 @@ Pulseaudio's default card active profile. - + @@ -3283,30 +3187,27 @@ - If running on Apple powerbook/ibook, display - information on battery status. The item parameter - specifies, what information to display. Exactly one item - must be specified. Valid items are: + If running on Apple powerbook/ibook, display information on + battery status. The item parameter specifies, what information to + display. Exactly one item must be specified. Valid items are: status - + percent - + time - + @@ -3318,8 +3219,8 @@ - Directory used as rootdirectory by the process - (this will be "/" unless the process did a chroot syscall) + Directory used as rootdirectory by the process (this will be + "/" unless the process did a chroot syscall) @@ -3439,10 +3340,10 @@ - One of the chars in "RSDZTW" representing the state - of the process where R is running, S is sleeping in an - interruptible wait, D is waiting in uninterruptible disk sleep, - Z is zombie, T is traced or stopped (on a signal), and W is paging + One of the chars in "RSDZTW" representing the state of the + process where R is running, S is sleeping in an interruptible wait, D + is waiting in uninterruptible disk sleep, Z is zombie, T is traced or + stopped (on a signal), and W is paging @@ -3502,7 +3403,8 @@ - Amount of time that the process has been scheduled in kernel mode in seconds + Amount of time that the process has been scheduled in kernel + mode in seconds @@ -3512,7 +3414,8 @@ - Amount of time that the process has been scheduled in user mode in seconds + Amount of time that the process has been scheduled in user + mode in seconds @@ -3722,16 +3625,15 @@ - Platform sensor from sysfs (Linux 2.6). Parameter - dev may be omitted if you have only one platform device. - Platform type is either 'in' or 'vol' meaning voltage; - 'fan' meaning fan; 'temp' meaning temperature. Parameter n - is number of the sensor. See /sys/bus/platform/devices/ on - your local computer. The optional arguments 'factor' and - 'offset' allow precalculation of the raw input, which is - being modified as follows: 'input = input * factor + - offset'. Note that they have to be given as decimal values - (i.e. contain at least one decimal place). + Platform sensor from sysfs (Linux 2.6). Parameter dev may be + omitted if you have only one platform device. Platform type is either + 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning + temperature. Parameter n is number of the sensor. See + /sys/bus/platform/devices/ on your local computer. The optional + arguments 'factor' and 'offset' allow precalculation of the raw input, + which is being modified as follows: 'input = input * factor + offset'. + Note that they have to be given as decimal values (i.e. contain at + least one decimal place). @@ -3741,15 +3643,13 @@ - Displays the number of unseen messages in your - global POP3 inbox by default. You can define individual - POP3 inboxes separately by passing arguments to this - object. Arguments are: "host user pass [-i interval (in - seconds)] [-p port] [-e 'command'] [-r retries]". Default - port is 110, default interval is 5 minutes, and default - number of retries before giving up is 5. If the password is - supplied as '*', you will be prompted to enter the password - when Conky starts. + Displays the number of unseen messages in your global POP3 + inbox by default. You can define individual POP3 inboxes separately by + passing arguments to this object. Arguments are: "host user pass [-i + interval (in seconds)] [-p port] [-e 'command'] [-r retries]". Default + port is 110, default interval is 5 minutes, and default number of + retries before giving up is 5. If the password is supplied as '*', you + will be prompted to enter the password when Conky starts. @@ -3759,15 +3659,14 @@ - Displays the amount of space (in MiB, 2^20) used - in your global POP3 inbox by default. You can define - individual POP3 inboxes separately by passing arguments to - this object. Arguments are: "host user pass [-i interval - (in seconds)] [-p port] [-e 'command'] [-r retries]". Default - port is 110, default interval is 5 minutes, and default - number of retries before giving up is 5. If the password is - supplied as '*', you will be prompted to enter the password - when Conky starts. + Displays the amount of space (in MiB, 2^20) used in your + global POP3 inbox by default. You can define individual POP3 inboxes + separately by passing arguments to this object. Arguments are: "host + user pass [-i interval (in seconds)] [-p port] [-e 'command'] [-r + retries]". Default port is 110, default interval is 5 minutes, and + default number of retries before giving up is 5. If the password is + supplied as '*', you will be prompted to enter the password when Conky + starts. @@ -3786,9 +3685,8 @@ - Connects to a tcp port on a host (default is - localhost), reads every char available at the moment and - shows them. + Connects to a tcp port on a host (default is localhost), + reads every char available at the moment and shows them. @@ -3798,9 +3696,8 @@ - Connects to a udp port on a host (default is - localhost), reads every char available at the moment and - shows them. + Connects to a udp port on a host (default is localhost), + reads every char available at the moment and shows them. @@ -3811,9 +3708,9 @@ - Number of mails marked as replied in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails marked as replied in the specified mailbox + or mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -3824,17 +3721,14 @@ - - Download and parse RSS feeds. The interval may be - a (floating point) value greater than 0. - Action may be one of the following: feed_title, item_title (with num par), - item_desc (with num par) and item_titles (when using - this action and spaces_in_front is given conky places - that many spaces in front of each item). This object is - threaded, and once a thread is created it can't be - explicitly destroyed. One thread will run for each URI - specified. You can use any protocol that Curl - supports. + Download and parse RSS feeds. The interval may be a + (floating point) value greater than 0. Action may be one of the + following: feed_title, item_title (with num par), item_desc (with num + par) and item_titles (when using this action and spaces_in_front is + given conky places that many spaces in front of each item). This + object is threaded, and once a thread is created it can't be + explicitly destroyed. One thread will run for each URI specified. You + can use any protocol that Curl supports. @@ -3843,8 +3737,7 @@ - Running processes (not sleeping), requires Linux - 2.6 + Running processes (not sleeping), requires Linux 2.6 @@ -3863,20 +3756,18 @@ - Scroll 'text' by 'step' characters to the left - or right (set 'direction' to 'left' or 'right' or 'wait') - showing 'length' number of characters at the same time. The - text may also contain variables. 'step' is optional and - defaults to 1 if not set. 'direction' is optional and defaults - to left if not set. When direction is 'wait' then text will - scroll left and wait for 'interval' itertations at the - beginning and end of the text. If a var creates output on - multiple lines then the lines are placed behind each other - separated with a '|'-sign. If you change the textcolor inside - $scroll it will automatically have it's old value back at the - end of $scroll. The end and the start of text will be - separated by 'length' number of spaces unless direction is - 'wait'. + Scroll 'text' by 'step' characters to the left or right (set + 'direction' to 'left' or 'right' or 'wait') showing 'length' number of + characters at the same time. The text may also contain variables. + 'step' is optional and defaults to 1 if not set. 'direction' is + optional and defaults to left if not set. When direction is 'wait' + then text will scroll left and wait for 'interval' itertations at the + beginning and end of the text. If a var creates output on multiple + lines then the lines are placed behind each other separated with a + '|'-sign. If you change the textcolor inside $scroll it will + automatically have it's old value back at the end of $scroll. The end + and the start of text will be separated by 'length' number of spaces + unless direction is 'wait'. @@ -3887,9 +3778,9 @@ - Number of mails marked as seen in the specified - mailbox or mail spool if not. Only maildir type mailboxes - are supported, mbox type will return -1. + Number of mails marked as seen in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -3899,40 +3790,25 @@ - Prints info regarding System Integrity Protection (SIP) on macOS. - - If no switch is provided, prints SIP status (enabled / disabled), else, - status of the specific SIP feature corresponding to the switch provided. - - Below are shown the available switches: - - SWITCH--------------------------RESULT--------------------------STATUS - 0 apple internal YES/NO - 1 forbid untrusted kexts YES/NO - 2 forbid task-for-pid YES/NO - 3 restrict filesystem YES/NO - 4 forbid kernel-debugger YES/NO - 5 restrict dtrace YES/NO - 6 restrict nvram YES/NO - 7 forbid device-configuration YES/NO - 8 forbid any-recovery-os YES/NO - 9 forbid user-approved-kexts YES/NO - a uses unsupported configuration? (*) - - (*): If yes, prints "unsupported configuration, beware!" - Else, prints "configuration is ok". - ---------------------------------------------------------------------- - - USAGE: - conky -t '${sip_status}' # print SIP status - conky -t '${sip_status 0}' # print allows apple-internal? Yes or No? - - NOTES: - * Available for all macOS versions (even the ones prior El Capitan - where SIP was first introduced) - * If run on versions prior El Capitan SIP is unavailable, so all - you will get is "unsupported" - + Prints info regarding System Integrity Protection (SIP) on + macOS. If no switch is provided, prints SIP status (enabled / + disabled), else, status of the specific SIP feature corresponding to + the switch provided. Below are shown the available switches: + SWITCH--------------------------RESULT--------------------------STATUS + 0 apple internal YES/NO 1 forbid untrusted kexts YES/NO 2 forbid + task-for-pid YES/NO 3 restrict filesystem YES/NO 4 forbid + kernel-debugger YES/NO 5 restrict dtrace YES/NO 6 restrict nvram + YES/NO 7 forbid device-configuration YES/NO 8 forbid any-recovery-os + YES/NO 9 forbid user-approved-kexts YES/NO a uses unsupported + configuration? (*) (*): If yes, prints "unsupported configuration, + beware!" Else, prints "configuration is ok". + ---------------------------------------------------------------------- + USAGE: conky -t '${sip_status}' # print SIP status conky -t + '${sip_status 0}' # print allows apple-internal? Yes or No? NOTES: * + Available for all macOS versions (even the ones prior El Capitan where + SIP was first introduced) * If run on versions prior El Capitan SIP is + unavailable, so all you will get is "unsupported" + @@ -3952,11 +3828,10 @@ when using smapi, display contents of the - /sys/devices/platform/smapi directory. ARGS are either - '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the - corresponding files' content. This is a very raw method of - accessing the smapi values. When available, better use one - of the smapi_* variables instead. + /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or + 'bat (INDEX) (FILENAME)' to display the corresponding files' content. + This is a very raw method of accessing the smapi values. When + available, better use one of the smapi_* variables instead. @@ -3966,8 +3841,8 @@ - when using smapi, display the remaining capacity - of the battery with index INDEX as a bar. + when using smapi, display the remaining capacity of the + battery with index INDEX as a bar. @@ -3977,10 +3852,9 @@ - when using smapi, display the remaining capacity - in percent of the battery with index INDEX. This is a - separate variable because it supports the 'use_spacer' - configuration option. + when using smapi, display the remaining capacity in percent + of the battery with index INDEX. This is a separate variable because + it supports the 'use_spacer' configuration option. @@ -3990,11 +3864,10 @@ - when using smapi, display the current power of - the battery with index INDEX in watt. This is a separate - variable because the original read out value is being - converted from mW. The sign of the output reflects charging - (positive) or discharging (negative) state. + when using smapi, display the current power of the battery + with index INDEX in watt. This is a separate variable because the + original read out value is being converted from mW. The sign of the + output reflects charging (positive) or discharging (negative) state. @@ -4004,10 +3877,10 @@ - when using smapi, display the current temperature - of the battery with index INDEX in degree Celsius. This is - a separate variable because the original read out value is - being converted from milli degree Celsius. + when using smapi, display the current temperature of the + battery with index INDEX in degree Celsius. This is a separate + variable because the original read out value is being converted from + milli degree Celsius. @@ -4016,8 +3889,8 @@ - Displays the Sony VAIO fanspeed information if - sony-laptop kernel support is enabled. Linux only. + Displays the Sony VAIO fanspeed information if sony-laptop + kernel support is enabled. Linux only. @@ -4027,7 +3900,8 @@ - All words capitalized regardless. + All words capitalized regardless. + @@ -4046,8 +3920,35 @@ - Displays the data of a stock symbol. The following data - is supported: adv(Average Daily Volume), ask, asksize, bid, askrt(ask realtime), bidrt(bid realtime), bookvalue, bidsize, change, commission, changert(change realtime), ahcrt(After Hours Change realtime), ds(dividend/share), ltd(Last Trade Date), tradedate, es(earnings/share), ei(error indication), epsecy(EPS Estimate Current Year), epseny(EPS Estimate Next Year), epsenq(EPS Estimate Next Quarter), floatshares, dayslow, dayshigh, 52weeklow, 52weekhigh, hgp(Holdings Gain Percent), ag(Annualized Gain), hg(Holdings Gain), hgprt(Holdings Gain Percent realtime), hgrt(Holdings Gain realtime), moreinfo, obrt(Order Book realtime), mc(Market Capitalization), mcrt(Market Cap realtime), ebitda, c52wlow(Change From 52-week Low), pc52wlow(Percent Change From 52-week Low), cprt(change percent realtime), lts(Last Trade Size), c52whigh(Change from 52-week high), pc52whigh(percent change from 52-week high), ltp(last trade price), hl(high limit), ll(low limit), dr(day's range), drrt(day's range realtime), 50ma(50-day Moving Average), 200ma(200-day Moving Average), c200ma(Change From 200-day Moving Average), pc200ma(Percent Change From 200-day Moving Average), c50ma(Change From 50-day Moving Average), pc50ma(Percent Change From 50-day Moving Average), name, notes, open, pc(previous close), pricepaid, cip(change in percent), ps(price/sales), pb(price/book), edv(Ex-Dividend Date), per(P/E Ratio), dpd(Dividend Pay Date), perrt(P/E Ratio realtime), pegr(PEG Ratio), pepsecy(Price/EPS Estimate Current Year), pepseny(Price/EPS Estimate Next Year), symbol, sharesowned, shortratio, ltt(Last Trade Time), tradelinks, tt(Ticker Trend), 1ytp(1 yr Target Price), volume, hv(Holdings Value), hvrt(Holdings Value realtime), 52weekrange, dvc(Day's Value Change), dvcrt(Day's Value Change realtime), se(Stock Exchange), dy(Dividend Yield) + Displays the data of a stock symbol. The following data is + supported: adv(Average Daily Volume), ask, asksize, bid, askrt(ask + realtime), bidrt(bid realtime), bookvalue, bidsize, change, + commission, changert(change realtime), ahcrt(After Hours Change + realtime), ds(dividend/share), ltd(Last Trade Date), tradedate, + es(earnings/share), ei(error indication), epsecy(EPS Estimate Current + Year), epseny(EPS Estimate Next Year), epsenq(EPS Estimate Next + Quarter), floatshares, dayslow, dayshigh, 52weeklow, 52weekhigh, + hgp(Holdings Gain Percent), ag(Annualized Gain), hg(Holdings Gain), + hgprt(Holdings Gain Percent realtime), hgrt(Holdings Gain realtime), + moreinfo, obrt(Order Book realtime), mc(Market Capitalization), + mcrt(Market Cap realtime), ebitda, c52wlow(Change From 52-week Low), + pc52wlow(Percent Change From 52-week Low), cprt(change percent + realtime), lts(Last Trade Size), c52whigh(Change from 52-week high), + pc52whigh(percent change from 52-week high), ltp(last trade price), + hl(high limit), ll(low limit), dr(day's range), drrt(day's range + realtime), 50ma(50-day Moving Average), 200ma(200-day Moving Average), + c200ma(Change From 200-day Moving Average), pc200ma(Percent Change + From 200-day Moving Average), c50ma(Change From 50-day Moving + Average), pc50ma(Percent Change From 50-day Moving Average), name, + notes, open, pc(previous close), pricepaid, cip(change in percent), + ps(price/sales), pb(price/book), edv(Ex-Dividend Date), per(P/E + Ratio), dpd(Dividend Pay Date), perrt(P/E Ratio realtime), pegr(PEG + Ratio), pepsecy(Price/EPS Estimate Current Year), pepseny(Price/EPS + Estimate Next Year), symbol, sharesowned, shortratio, ltt(Last Trade + Time), tradelinks, tt(Ticker Trend), 1ytp(1 yr Target Price), volume, + hv(Holdings Value), hvrt(Holdings Value realtime), 52weekrange, + dvc(Day's Value Change), dvcrt(Day's Value Change realtime), se(Stock + Exchange), dy(Dividend Yield) @@ -4122,8 +4023,8 @@ - Puts a tab of the specified width, starting from - column 'start'. The unit is pixels for both arguments. + Puts a tab of the specified width, starting from column + 'start'. The unit is pixels for both arguments. @@ -4133,10 +4034,10 @@ - Displays last N lines of supplied text file. The - file is checked every 'next_check' update. If next_check is - not supplied, Conky defaults to 2. Max of 30 lines can be - displayed, or until the text buffer is filled. + Displays last N lines of supplied text file. The file is + checked every 'next_check' update. If next_check is not supplied, + Conky defaults to 2. Max of 30 lines can be displayed, or until the + text buffer is filled. @@ -4146,12 +4047,12 @@ - Displays the number of microseconds it takes to - get a reply on a ping to to tcp 'port' on 'host'. 'port' is optional - and has 80 as default. This works on both open and closed - ports, just make sure that the port is not behind a firewall or you - will get 'down' as answer. It's best to test a closed port instead - of an open port, you will get a quicker response. + Displays the number of microseconds it takes to get a reply + on a ping to to tcp 'port' on 'host'. 'port' is optional and has 80 as + default. This works on both open and closed ports, just make sure that + the port is not behind a firewall or you will get 'down' as answer. + It's best to test a closed port instead of an open port, you will get + a quicker response. @@ -4162,14 +4063,13 @@ - TCP port (both IPv6 and IPv4) monitor for - specified local ports. Port numbers must be in - the range 1 to 65535. Valid items are: + TCP port (both IPv6 and IPv4) monitor for specified local + ports. Port numbers must be in the range 1 to 65535. Valid items + are: count - + rip @@ -4185,8 +4085,7 @@ rservice - + lip @@ -4202,60 +4101,53 @@ lservice - + - The connection index provides you with access to - each connection in the port monitor. The monitor will - return information for index values from 0 to n-1 - connections. Values higher than n-1 are simply ignored. - For the "count" item, the connection index must be - omitted. It is required for all other items. + The connection index provides you with access to each + connection in the port monitor. The monitor will return + information for index values from 0 to n-1 connections. Values + higher than n-1 are simply ignored. For the "count" item, the + connection index must be omitted. It is required for all other + items. Examples: - ${tcp_portmon 6881 6999 - count} - + ${tcp_portmon 6881 6999 count} + ${tcp_portmon 22 22 rip 0} - + ${tcp_portmon 22 22 rip 9} - + - ${tcp_portmon 1 1024 rhost - 0} - + ${tcp_portmon 1 1024 rhost 0} + - ${tcp_portmon 1 1024 rport - 4} - + ${tcp_portmon 1 1024 rport 4} + - ${tcp_portmon 1 65535 lservice - 14} - + ${tcp_portmon 1 65535 lservice 14} + - Note that port monitor variables which share the - same port range actually refer to the same monitor, so - many references to a single port range for different - items and different indexes all use the same monitor - internally. In other words, the program avoids creating - redundant monitors. + Note that port monitor variables which share the same port + range actually refer to the same monitor, so many references to a + single port range for different items and different indexes all + use the same monitor internally. In other words, the program + avoids creating redundant monitors. @@ -4268,28 +4160,26 @@ - Evaluate the content of the templateN - configuration variable (where N is a value between 0 - and 9, inclusively), applying substitutions as - described in the documentation of the corresponding - configuration variable. The number of arguments is - optional, but must match the highest referred index in - the template. You can use the same special sequences in - each argument as the ones valid for a template - definition, e.g. to allow an argument to contain a - whitespace. Also simple nesting of templates is - possible this way. - Here are some examples of template - definitions, note they are placed between [[ ... ]] instead of ' ... ': + Evaluate the content of the templateN configuration variable + (where N is a value between 0 and 9, inclusively), applying + substitutions as described in the documentation of the + corresponding configuration variable. The number of arguments is + optional, but must match the highest referred index in the + template. You can use the same special sequences in each argument + as the ones valid for a template definition, e.g. to allow an + argument to contain a whitespace. Also simple nesting of templates + is possible this way. + Here are some examples of template definitions, note they + are placed between [[ ... ]] instead of ' ... ': template0 = [[$\1\2]] template1 = [[\1: ${fs_used \2} / ${fs_size \2}]] template2 = [[\1 \2]] - The following list shows sample usage of the - templates defined above, with the equivalent syntax - when not using any template at all: + The following list shows sample usage of the templates + defined above, with the equivalent syntax when not using any + template at all: @@ -4305,20 +4195,13 @@ ${template1 root /} - root: ${fs_free /} / ${fs_size - /} + root: ${fs_free /} / ${fs_size /} - - ${template1 - ${template2\ disk\ root} - /} - - - disk root: - ${fs_free /} / ${fs_size - /} - + ${template1 ${template2\ disk\ root} + /} + disk root: ${fs_free /} / ${fs_size + /} @@ -4333,17 +4216,15 @@ - Runs a command at an interval inside a thread and - displays the output. Same as $execi, except the command is - run inside a thread. Use this if you have a slow script to - keep Conky updating. You should make the interval slightly - longer than the time it takes your script to execute. For - example, if you have a script that take 5 seconds to - execute, you should make the interval at least 6 seconds. - See also $execi. This object will clean up the thread when - it is destroyed, so it can safely be used in a nested - fashion, though it may not produce the desired behaviour if - used this way. + Runs a command at an interval inside a thread and displays + the output. Same as $execi, except the command is run inside a thread. + Use this if you have a slow script to keep Conky updating. You should + make the interval slightly longer than the time it takes your script + to execute. For example, if you have a script that take 5 seconds to + execute, you should make the interval at least 6 seconds. See also + $execi. This object will clean up the thread when it is destroyed, so + it can safely be used in a nested fashion, though it may not produce + the desired behaviour if used this way. @@ -4354,8 +4235,7 @@ - Same as execpi, except the command is run inside - a thread. + Same as execpi, except the command is run inside a thread. @@ -4374,8 +4254,8 @@ - Local time, see man strftime to get more - information about format + Local time, see man strftime to get more information about + format @@ -4386,8 +4266,8 @@ If 'size' is a number followed by a size-unit - (kilobyte,mb,GiB,...) then it converts the size to bytes - and shows it without unit, otherwise it just shows 'size'. + (kilobyte,mb,GiB,...) then it converts the size to bytes and shows it + without unit, otherwise it just shows 'size'. @@ -4397,12 +4277,12 @@ - This takes arguments in the form:top (name) - (number) Basically, processes are ranked from highest to - lowest in terms of cpu usage, which is what (num) - represents. The types are: "name", "pid", "cpu", "mem", - "mem_res", "mem_vsize", "time", "uid", "user", "io_perc", "io_read" and - "io_write". There can be a max of 10 processes listed. + This takes arguments in the form:top (name) (number) + Basically, processes are ranked from highest to lowest in terms of cpu + usage, which is what (num) represents. The types are: "name", "pid", + "cpu", "mem", "mem_res", "mem_vsize", "time", "uid", "user", + "io_perc", "io_read" and "io_write". There can be a max of 10 + processes listed. @@ -4412,8 +4292,8 @@ - Same as top, except sorted by the amount of I/O - the process has done during the update interval + Same as top, except sorted by the amount of I/O the process + has done during the update interval @@ -4423,8 +4303,7 @@ - Same as top, except sorted by mem usage instead - of cpu + Same as top, except sorted by mem usage instead of cpu @@ -4434,8 +4313,8 @@ - Same as top, except sorted by total CPU time - instead of current CPU usage + Same as top, except sorted by total CPU time instead of + current CPU usage @@ -4445,10 +4324,9 @@ - Total download, overflows at 4 GB on Linux with - 32-bit arch and there doesn't seem to be a way to know how - many times it has already done that before conky has - started. + Total download, overflows at 4 GB on Linux with 32-bit arch + and there doesn't seem to be a way to know how many times it has + already done that before conky has started. @@ -4469,9 +4347,9 @@ - Number of mails marked as trashed in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails marked as trashed in the specified mailbox + or mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -4481,11 +4359,10 @@ - Local time for specified timezone, see man - strftime to get more information about format. The timezone - argument is specified in similar fashion as TZ environment - variable. For hints, look in /usr/share/zoneinfo. e.g. - US/Pacific, Europe/Zurich, etc. + Local time for specified timezone, see man strftime to get + more information about format. The timezone argument is specified in + similar fashion as TZ environment variable. For hints, look in + /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc. @@ -4516,9 +4393,9 @@ - Number of mails not marked as flagged in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails not marked as flagged in the specified + mailbox or mail spool if not. Only maildir type mailboxes are + supported, mbox type will return -1. @@ -4529,9 +4406,9 @@ - Number of mails not marked as forwarded in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails not marked as forwarded in the specified + mailbox or mail spool if not. Only maildir type mailboxes are + supported, mbox type will return -1. @@ -4542,9 +4419,9 @@ - Number of mails not marked as replied in the - specified mailbox or mail spool if not. Only maildir type - mailboxes are supported, mbox type will return -1. + Number of mails not marked as replied in the specified + mailbox or mail spool if not. Only maildir type mailboxes are + supported, mbox type will return -1. @@ -4555,9 +4432,9 @@ - Number of new or unseen mails in the specified - mailbox or mail spool if not. Only maildir type mailboxes - are supported, mbox type will return -1. + Number of new or unseen mails in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox + type will return -1. @@ -4595,16 +4472,15 @@ - + - Upload speed graph, colours defined in hex, minus - the #. If scale is non-zero, it becomes the scale for the - graph. Uses a logarithmic scale (to see small numbers) when - you use the -l switch. Takes the switch '-t' to use a - temperature gradient, which makes the gradient values - change depending on the amplitude of a particular graph - value (try it and see). + Upload speed graph, colours defined in hex, minus the #. If + scale is non-zero, it becomes the scale for the graph. Uses a + logarithmic scale (to see small numbers) when you use the -l switch. + Takes the switch '-t' to use a temperature gradient, which makes the + gradient values change depending on the amplitude of a particular + graph value (try it and see). @@ -4666,7 +4542,7 @@ - + Lists how long the user for the given console has been logged in for @@ -4689,10 +4565,10 @@ - IPv6 addresses for an interface, followed by - netmask if -n is specified and scope with -s. Scopes are - Global(G), Host-local(H), Link-local(L), Site-local(S), Compat(C) - and Unspecified(/). Linux only. + IPv6 addresses for an interface, followed by netmask if -n + is specified and scope with -s. Scopes are Global(G), Host-local(H), + Link-local(L), Site-local(S), Compat(C) and Unspecified(/). Linux + only. @@ -4702,8 +4578,8 @@ - Change vertical offset by N pixels. Negative - values will cause text to overlap. See also $offset. + Change vertical offset by N pixels. Negative values will + cause text to overlap. See also $offset. @@ -4713,8 +4589,8 @@ - Returns CPU #n's voltage in mV. CPUs are counted - from 1. If omitted, the parameter defaults to 1. + Returns CPU #n's voltage in mV. CPUs are counted from 1. If + omitted, the parameter defaults to 1. @@ -4724,8 +4600,8 @@ - Returns CPU #n's voltage in V. CPUs are counted - from 1. If omitted, the parameter defaults to 1. + Returns CPU #n's voltage in V. CPUs are counted from 1. If + omitted, the parameter defaults to 1. @@ -4733,8 +4609,7 @@ - + Download, parse and display METAR data. @@ -4743,29 +4618,24 @@ http://tgftp.nws.noaa.gov/data/observations/metar/stations/ - 'locID' must be a valid location identifier for - the required uri. For the NOAA site this must be a - valid ICAO (see for instance - https://pilotweb.nas.faa.gov/qryhtml/icao/). For the - weather.com site this must be a valid location ID (see - for instance + 'locID' must be a valid location identifier for the required + uri. For the NOAA site this must be a valid ICAO (see for instance + https://pilotweb.nas.faa.gov/qryhtml/icao/). For the weather.com + site this must be a valid location ID (see for instance http://aspnetresources.com/tools/locid.aspx). 'data_type' must be one of the following: last_update - The date and time stamp of the data. - The result depends on the URI used. For the - NOAA site it is date (yyyy/mm/dd) and UTC time. - For the weather.com one it is date - ([m]m/[d]d/yy) and Local Time of the - station. + The date and time stamp of the data. The result + depends on the URI used. For the NOAA site it is date + (yyyy/mm/dd) and UTC time. For the weather.com one it is + date ([m]m/[d]d/yy) and Local Time of the station. temperature - Air temperature (you can use the - 'temperature_unit' config setting to change - units) + Air temperature (you can use the 'temperature_unit' + config setting to change units) cloud_cover @@ -4793,26 +4663,24 @@ weather - Any relevant weather event (rain, snow, - etc.). This is not used if you are querying the - weather.com site since this data is aggregated - into the cloud_cover one + Any relevant weather event (rain, snow, etc.). This + is not used if you are querying the weather.com site since + this data is aggregated into the cloud_cover one icon - Weather icon (only for - www.weather.com). Can be used together with the - icon kit provided upon registering to their - service. + Weather icon (only for www.weather.com). Can be used + together with the icon kit provided upon registering to + their service. - 'delay_in_minutes' (optional, default 30) cannot - be less than 30 minutes. - This object is threaded, and once a thread is - created it can't be explicitly destroyed. One thread - will run for each URI specified. - Note that these variables are still EXPERIMENTAL - and can be subject to many future changes. + 'delay_in_minutes' (optional, default 30) cannot be less + than 30 minutes. + This object is threaded, and once a thread is created it + can't be explicitly destroyed. One thread will run for each URI + specified. + Note that these variables are still EXPERIMENTAL and can be + subject to many future changes. @@ -4820,47 +4688,46 @@ - + - Download, parse and display weather forecast data - for a given day (daytime only). + Download, parse and display weather forecast data for a + given day (daytime only). 'locID', see 'weather' above. - 'day' is a number from 0 (today) to 4 (3 days - after tomorrow). + 'day' is a number from 0 (today) to 4 (3 days after + tomorrow). 'data_type' must be one of the following: day - - + + date - - + + low - - + hi - - + icon - - + forecast - + wind_speed @@ -4879,19 +4746,18 @@ precipitation - + - 'delay_in_minutes' (optional, default 210) cannot - be lower than 210 min. - This object is threaded, and once a thread is - created it can't be explicitly destroyed. One thread - will run for each URI specified. You can use any - protocol that Curl supports. - Note that these variables are still EXPERIMENTAL - and can be subject to many future changes. - + 'delay_in_minutes' (optional, default 210) cannot be lower + than 210 min. + This object is threaded, and once a thread is created it + can't be explicitly destroyed. One thread will run for each URI + specified. You can use any protocol that Curl supports. + Note that these variables are still EXPERIMENTAL and can be + subject to many future changes. + @@ -4990,8 +4856,7 @@ - Wireless mode (Managed/Ad-Hoc/Master) (Linux - only) + Wireless mode (Managed/Ad-Hoc/Master) (Linux only) @@ -5128,8 +4993,8 @@ - Prints the song name in either the form "artist - - title" or file name, depending on whats available + Prints the song name in either the form "artist - title" or + file name, depending on whats available @@ -5138,8 +5003,7 @@ - XMMS2 status (Playing, Paused, Stopped, or - Disconnected) + XMMS2 status (Playing, Paused, Stopped, or Disconnected)