1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-01-13 19:22:58 +00:00

doc: tidy --wrap 79 -xml -i --indent-spaces 4

This commit is contained in:
lasers 2018-12-31 04:05:44 -06:00
parent edb7f84ecd
commit 3c1c74f541
6 changed files with 1625 additions and 1827 deletions

View File

@ -7,9 +7,9 @@
<option>ALIGNMENT</option> <option>ALIGNMENT</option>
</term> </term>
<listitem>Text alignment on screen, <listitem>Text alignment on screen,
{top,bottom,middle}_{left,right,middle} or none. Can also {top,bottom,middle}_{left,right,middle} or none. Can also be
be abbreviated with first chars of position, ie. tr for abbreviated with first chars of position, ie. tr for top_right. Only
top_right. Only available with build flag BUILD_X11 enabled. available with build flag BUILD_X11 enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -18,7 +18,8 @@
<option>-b | --double-buffer</option> <option>-b | --double-buffer</option>
</command> </command>
</term> </term>
<listitem>Use double buffering (eliminates "flicker"). Only available with build flag BUILD_X11 enabled. <listitem>Use double buffering (eliminates "flicker"). Only available
with build flag BUILD_X11 enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -28,7 +29,8 @@
</command> </command>
<option>FILE</option> <option>FILE</option>
</term> </term>
<listitem>Config file to load instead of $HOME/.config/conky/conky.conf <listitem>Config file to load instead of
$HOME/.config/conky/conky.conf
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -37,8 +39,9 @@
<option>-C | --print-config</option> <option>-C | --print-config</option>
</command> </command>
</term> </term>
<listitem>Print builtin default config to stdout. See also <listitem>Print builtin default config to stdout. See also the section
the section EXAMPLES for more information. Only available with build flag BUILD_BUILTIN_CONFIG enabled. EXAMPLES for more information. Only available with build flag
BUILD_BUILTIN_CONFIG enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -56,8 +59,7 @@
<option>-D | --debug</option> <option>-D | --debug</option>
</command> </command>
</term> </term>
<listitem>Increase debugging output, ie. -DD for more <listitem>Increase debugging output, ie. -DD for more debugging.
debugging.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -67,7 +69,8 @@
</command> </command>
<option>FONT</option> <option>FONT</option>
</term> </term>
<listitem>Font to use. Only available with build flag BUILD_X11 enabled. <listitem>Font to use. Only available with build flag BUILD_X11
enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -95,7 +98,8 @@
<option>-o | --own-window</option> <option>-o | --own-window</option>
</command> </command>
</term> </term>
<listitem>Create own window to draw. Only available with build flag BUILD_X11 enabled. <listitem>Create own window to draw. Only available with build flag
BUILD_X11 enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -124,8 +128,7 @@
</command> </command>
<option>TEXT</option> <option>TEXT</option>
</term> </term>
<listitem>Text to render, remember single quotes, like -t ' <listitem>Text to render, remember single quotes, like -t ' $uptime '
$uptime '
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -144,8 +147,8 @@
<option>-v | -V | --version</option> <option>-v | -V | --version</option>
</command> </command>
</term> </term>
<listitem>Prints version, build information and general info. <listitem>Prints version, build information and general info. Exits
Exits after printing. after printing.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -155,7 +158,8 @@
</command> </command>
<option>WIN_ID</option> <option>WIN_ID</option>
</term> </term>
<listitem>Window id to draw. Only available with build flag BUILD_X11 enabled. <listitem>Window id to draw. Only available with build flag BUILD_X11
enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -185,7 +189,8 @@
</command> </command>
<option>DISPLAY</option> <option>DISPLAY</option>
</term> </term>
<listitem>X11 display to use. Only available with build flag BUILD_X11 enabled. <listitem>X11 display to use. Only available with build flag BUILD_X11
enabled.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -5,11 +5,10 @@
<option>alignment</option> <option>alignment</option>
</command> </command>
</term> </term>
<listitem>Aligned position on screen, may be top_left, <listitem>Aligned position on screen, may be top_left, top_right,
top_right, top_middle, bottom_left, bottom_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left,
bottom_middle, middle_left, middle_middle, middle_right, or middle_middle, middle_right, or none (also can be abreviated as tl,
none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, tr, tm, bl, br, bm, ml, mm, mr). See also gap_x and gap_y.
mm, mr). See also gap_x and gap_y.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -27,8 +26,8 @@
<option>background</option> <option>background</option>
</command> </command>
</term> </term>
<listitem>Boolean value, if true, Conky will be forked to <listitem>Boolean value, if true, Conky will be forked to background
background when started. when started.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -37,8 +36,8 @@
<option>border_inner_margin</option> <option>border_inner_margin</option>
</command> </command>
</term> </term>
<listitem>Inner border margin in pixels (the margin between <listitem>Inner border margin in pixels (the margin between the border
the border and text). and text).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -47,8 +46,8 @@
<option>border_outer_margin</option> <option>border_outer_margin</option>
</command> </command>
</term> </term>
<listitem>Outer border margin in pixels (the margin between <listitem>Outer border margin in pixels (the margin between the border
the border and the edge of the window). and the edge of the window).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -67,9 +66,8 @@
</command> </command>
</term> </term>
<listitem>Predefine a color for use inside conky.text segments. <listitem>Predefine a color for use inside conky.text segments.
Substitute N by a digit between 0 and 9, inclusively. When Substitute N by a digit between 0 and 9, inclusively. When specifying
specifying the color value in hex, omit the leading hash the color value in hex, omit the leading hash (#).
(#).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -96,9 +94,10 @@
<option>console_graph_ticks</option> <option>console_graph_ticks</option>
</command> </command>
</term> </term>
<listitem>A comma-separated list of strings to use as the bars of a graph output <listitem>A comma-separated list of strings to use as the bars of a
to console/shell. The first list item is used for the minimum bar height and the graph output to console/shell. The first list item is used for the
last item is used for the maximum. Example: " ,_,=,#". minimum bar height and the last item is used for the maximum. Example:
" ,_,=,#".
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -107,8 +106,7 @@
<option>cpu_avg_samples</option> <option>cpu_avg_samples</option>
</command> </command>
</term> </term>
<listitem>The number of samples to average for CPU <listitem>The number of samples to average for CPU monitoring.
monitoring.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -117,8 +115,8 @@
<option>default_bar_height</option> <option>default_bar_height</option>
</command> </command>
</term> </term>
<listitem>Specify a default height for bars. If not specified, <listitem>Specify a default height for bars. If not specified, the
the default value is 6. default value is 6.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -127,11 +125,10 @@
<option>default_bar_width</option> <option>default_bar_width</option>
</command> </command>
</term> </term>
<listitem>Specify a default width for bars. If not specified, <listitem>Specify a default width for bars. If not specified, the
the default value is 0, which causes the bar to expand to default value is 0, which causes the bar to expand to fit the width of
fit the width of your Conky window. If you set your Conky window. If you set out_to_console = true, the default value
out_to_console = true, the default value will be 10 will be 10 for the text version of the bar.
for the text version of the bar.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -149,8 +146,8 @@
<option>default_gauge_height</option> <option>default_gauge_height</option>
</command> </command>
</term> </term>
<listitem>Specify a default height for gauges. If not specified, <listitem>Specify a default height for gauges. If not specified, the
the default value is 25. default value is 25.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -159,8 +156,8 @@
<option>default_gauge_width</option> <option>default_gauge_width</option>
</command> </command>
</term> </term>
<listitem>Specify a default width for gauges. If not specified, <listitem>Specify a default width for gauges. If not specified, the
the default value is 40. default value is 40.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -169,8 +166,8 @@
<option>default_graph_height</option> <option>default_graph_height</option>
</command> </command>
</term> </term>
<listitem>Specify a default height for graphs. If not specified, <listitem>Specify a default height for graphs. If not specified, the
the default value is 25. default value is 25.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -179,12 +176,11 @@
<option>default_graph_width</option> <option>default_graph_width</option>
</command> </command>
</term> </term>
<listitem>Specify a default width for graphs. If not specified, <listitem>Specify a default width for graphs. If not specified, the
the default value is 0, which causes the graph to expand to default value is 0, which causes the graph to expand to fit the width
fit the width of your Conky window. If you set of your Conky window. If you set out_to_console = true, the text
out_to_console = true, the text version of the graph will version of the graph will actually have no width and you will need to
actually have no width and you will need to set a set a sensible default or set the height and width of each graph
sensible default or set the height and width of each graph
individually. individually.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
@ -212,7 +208,8 @@
<option>disable_auto_reload</option> <option>disable_auto_reload</option>
</command> </command>
</term> </term>
<listitem>Enable to disable the inotify-based auto config reload feature. <listitem>Enable to disable the inotify-based auto config reload
feature.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -221,8 +218,7 @@
<option>diskio_avg_samples</option> <option>diskio_avg_samples</option>
</command> </command>
</term> </term>
<listitem>The number of samples to average for disk I/O <listitem>The number of samples to average for disk I/O monitoring.
monitoring.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -249,9 +245,9 @@
<option>double_buffer</option> <option>double_buffer</option>
</command> </command>
</term> </term>
<listitem>Use the Xdbe extension? (eliminates flicker) It <listitem>Use the Xdbe extension? (eliminates flicker) It is highly
is highly recommended to use own window with this one so recommended to use own window with this one so double buffer won't be
double buffer won't be so big. so big.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -260,10 +256,9 @@
<option>draw_blended</option> <option>draw_blended</option>
</command> </command>
</term> </term>
<listitem>Boolean, blend when rendering drawn image? <listitem>Boolean, blend when rendering drawn image? Some images blend
Some images blend incorrectly breaking alpha with ARBG visuals. This incorrectly breaking alpha with ARBG visuals. This provides a possible
provides a possible work around by disabling blending. Defaults to work around by disabling blending. Defaults to true.
true.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -308,8 +303,8 @@
<option>extra_newline</option> <option>extra_newline</option>
</command> </command>
</term> </term>
<listitem>Put an extra newline at the end when writing to <listitem>Put an extra newline at the end when writing to stdout,
stdout, useful for writing to awesome's wiboxes. useful for writing to awesome's wiboxes.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -318,8 +313,7 @@
<option>font</option> <option>font</option>
</command> </command>
</term> </term>
<listitem>Font name in X, xfontsel can be used to get a <listitem>Font name in X, xfontsel can be used to get a nice font
nice font
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -333,16 +327,15 @@
format as a font variable. format as a font variable.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command> <command>
<option>format_human_readable</option> <option>format_human_readable</option>
</command> </command>
</term> </term>
<listitem>If enabled, values which are in bytes will be <listitem>If enabled, values which are in bytes will be printed in
printed in human readable format (i.e., KiB, MiB, etc). If human readable format (i.e., KiB, MiB, etc). If disabled, the number
disabled, the number of bytes is printed instead. of bytes is printed instead.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -351,9 +344,9 @@
<option>gap_x</option> <option>gap_x</option>
</command> </command>
</term> </term>
<listitem>Gap, in pixels, between right or left border of <listitem>Gap, in pixels, between right or left border of screen, same
screen, same as passing -x at command line, e.g. gap_x 10. as passing -x at command line, e.g. gap_x 10. For other position
For other position related stuff, see 'alignment'. related stuff, see 'alignment'.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -362,9 +355,9 @@
<option>gap_y</option> <option>gap_y</option>
</command> </command>
</term> </term>
<listitem>Gap, in pixels, between top or bottom border of <listitem>Gap, in pixels, between top or bottom border of screen, same
screen, same as passing -y at command line, e.g. gap_y 10. as passing -y at command line, e.g. gap_y 10. For other position
For other position related stuff, see 'alignment'. related stuff, see 'alignment'.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -376,8 +369,7 @@
<listitem>Specify API token for GitHub notifications. <listitem>Specify API token for GitHub notifications.
<simplelist> <simplelist>
<member> <member>
https://github.com/settings/tokens/new?scopes=notifications&amp;description=conky https://github.com/settings/tokens/new?scopes=notifications&amp;description=conky</member>
</member>
</simplelist> </simplelist>
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
@ -387,8 +379,8 @@
<option>hddtemp_host</option> <option>hddtemp_host</option>
</command> </command>
</term> </term>
<listitem>Hostname to connect to for hddtemp objects. Defaults <listitem>Hostname to connect to for hddtemp objects. Defaults to
to "127.0.0.1". "127.0.0.1".
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -397,8 +389,7 @@
<option>hddtemp_port</option> <option>hddtemp_port</option>
</command> </command>
</term> </term>
<listitem>Port to use for hddtemp connections. Defaults to <listitem>Port to use for hddtemp connections. Defaults to 7634.
7634.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -407,9 +398,8 @@
<option>http_refresh</option> <option>http_refresh</option>
</command> </command>
</term> </term>
<listitem>When this is set the page generated with <listitem>When this is set the page generated with out_to_http will
out_to_http will automatically refresh each interval. Default automatically refresh each interval. Default value is no.
value is no.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -418,11 +408,10 @@
<option>if_up_strictness</option> <option>if_up_strictness</option>
</command> </command>
</term> </term>
<listitem>How strict should if_up be when testing an <listitem>How strict should if_up be when testing an interface for
interface for being up? The value is one of up, link or being up? The value is one of up, link or address, to check for the
address, to check for the interface being solely up, being interface being solely up, being up and having link or being up,
up and having link or being up, having link and an assigned having link and an assigned IP address.
IP address.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -431,13 +420,12 @@
<option>imap</option> <option>imap</option>
</command> </command>
</term> </term>
<listitem>Default global IMAP server. Arguments are: "host <listitem>Default global IMAP server. Arguments are: "host user pass
user pass [-i interval (in seconds)] [-f 'folder'] [-p port] [-i interval (in seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r
[-e 'command'] [-r retries]". Default port is 143, default retries]". Default port is 143, default folder is 'INBOX', default
folder is 'INBOX', default interval is 5 minutes, and interval is 5 minutes, and default number of retries before giving up
default number of retries before giving up is 5. If the is 5. If the password is supplied as '*', you will be prompted to
password is supplied as '*', you will be prompted to enter enter the password when Conky starts.
the password when Conky starts.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -455,11 +443,10 @@
<option>imlib_cache_size</option> <option>imlib_cache_size</option>
</command> </command>
</term> </term>
<listitem> <listitem>Imlib2 image cache size, in bytes. Defaults to 4MiB.
Imlib2 image cache size, in bytes. Defaults to Increase this value if you use $image lots. Set to 0 to disable the
4MiB. Increase this value if you use $image lots. Set image cache.
to 0 to disable the image cache.<para/> <para /></listitem>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
@ -468,16 +455,13 @@
</command> </command>
<option>function_name [function arguments]</option> <option>function_name [function arguments]</option>
</term> </term>
<listitem> <listitem>This function, if defined, will be called by Conky through
This function, if defined, will be called by each iteration after drawing to the window. Requires X support. Takes
Conky through each iteration after drawing to the any number of optional arguments. Use this hook for drawing things on
window. Requires X support. Takes any number of top of what Conky draws. Conky puts 'conky_' in front of function_name
optional arguments. Use this hook for drawing things on to prevent accidental calls to the wrong function unless you place
top of what Conky draws. Conky puts 'conky_' in front 'conky_' in front of it yourself.
of function_name to prevent accidental calls to the <para /></listitem>
wrong function unless you place 'conky_' in front of it
yourself.<para/>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
@ -486,16 +470,13 @@
</command> </command>
<option>function_name [function arguments]</option> <option>function_name [function arguments]</option>
</term> </term>
<listitem> <listitem>This function, if defined, will be called by Conky through
This function, if defined, will be called by each iteration before drawing to the window. Requires X support. Takes
Conky through each iteration before drawing to the any number of optional arguments. Use this hook for drawing things on
window. Requires X support. Takes any number of top of what Conky draws. Conky puts 'conky_' in front of function_name
optional arguments. Use this hook for drawing things on to prevent accidental calls to the wrong function unless you place
top of what Conky draws. Conky puts 'conky_' in front 'conky_' in front of it yourself.
of function_name to prevent accidental calls to the <para /></listitem>
wrong function unless you place 'conky_' in front of it
yourself.<para/>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
@ -513,16 +494,13 @@
</command> </command>
<option>function_name [function arguments]</option> <option>function_name [function arguments]</option>
</term> </term>
<listitem> <listitem>This function, if defined, will be called by Conky at
This function, if defined, will be called by shutdown or when the configuration is reloaded. Use this hook to clean
Conky at shutdown or when the configuration is up after yourself, such as freeing memory which has been allocated by
reloaded. Use this hook to clean up after yourself, external libraries via Lua. Conky puts 'conky_' in front of
such as freeing memory which has been allocated by function_name to prevent accidental calls to the wrong function unless
external libraries via Lua. Conky puts 'conky_' in you place 'conky_' in front of it yourself.
front of function_name to prevent accidental calls to <para /></listitem>
the wrong function unless you place 'conky_' in
front of it yourself.<para/>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
@ -531,15 +509,12 @@
</command> </command>
<option>function_name [function arguments]</option> <option>function_name [function arguments]</option>
</term> </term>
<listitem> <listitem>This function, if defined, will be called by Conky at
This function, if defined, will be called by startup or when the configuration is reloaded. Use this hook to
Conky at startup or when the configuration is reloaded. initialize values, or for any run-once applications. Conky puts
Use this hook to initialize values, or for any run-once 'conky_' in front of function_name to prevent accidental calls to the
applications. Conky puts 'conky_' in front of wrong function unless you place 'conky_' in front of it yourself.
function_name to prevent accidental calls to the wrong <para /></listitem>
function unless you place 'conky_' in front of
it yourself.<para/>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
@ -556,8 +531,8 @@
<option>max_port_monitor_connections</option> <option>max_port_monitor_connections</option>
</command> </command>
</term> </term>
<listitem>Allow each port monitor to track at most this <listitem>Allow each port monitor to track at most this many
many connections (if 0 or not set, default is 256) connections (if 0 or not set, default is 256)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -567,10 +542,9 @@
</command> </command>
<option>width</option> <option>width</option>
</term> </term>
<listitem>When a line in the output contains 'width' <listitem>When a line in the output contains 'width' chars and the end
chars and the end isn't reached, the next char will start isn't reached, the next char will start on a new line. If you want to
on a new line. If you want to make sure that lines don't make sure that lines don't get broken, set 'width' to 0
get broken, set 'width' to 0
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -665,7 +639,8 @@
<option>mysql_user</option> <option>mysql_user</option>
</command> </command>
</term> </term>
<listitem>MySQL user name to use when connecting to the server. Defaults to your username <listitem>MySQL user name to use when connecting to the server.
Defaults to your username
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -674,8 +649,8 @@
<option>mysql_password</option> <option>mysql_password</option>
</command> </command>
</term> </term>
<listitem>Password of the MySQL user. Place it between "-chars. When this is not set there <listitem>Password of the MySQL user. Place it between "-chars. When
is no password used this is not set there is no password used
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -693,8 +668,8 @@
<option>music_player_interval</option> <option>music_player_interval</option>
</command> </command>
</term> </term>
<listitem>Music player thread update interval (defaults to <listitem>Music player thread update interval (defaults to Conky's
Conky's update interval) update interval)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -713,7 +688,6 @@
</command> </command>
</term> </term>
<listitem>Subtract (file system) buffers from used memory? <listitem>Subtract (file system) buffers from used memory?
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -722,8 +696,8 @@
<option>nvidia_display</option> <option>nvidia_display</option>
</command> </command>
</term> </term>
<listitem>The display that the nvidia variable will use (defaults to the value of the <listitem>The display that the nvidia variable will use (defaults to
display variable) the value of the display variable)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -750,9 +724,9 @@
<option>out_to_ncurses</option> <option>out_to_ncurses</option>
</command> </command>
</term> </term>
<listitem>Print text in the console, but use ncurses so <listitem>Print text in the console, but use ncurses so that conky can
that conky can print the text of a new update over the old print the text of a new update over the old text. (In the future this
text. (In the future this will provide more useful things) will provide more useful things)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -770,11 +744,10 @@
<option>out_to_x</option> <option>out_to_x</option>
</command> </command>
</term> </term>
<listitem>When set to no, there will be no output in X <listitem>When set to no, there will be no output in X (useful when
(useful when you also use things like out_to_console). If you also use things like out_to_console). If you set it to no, make
you set it to no, make sure that it's placed before all sure that it's placed before all other X-related setting (take the
other X-related setting (take the first line of your first line of your configfile to be sure). Default value is yes
configfile to be sure). Default value is yes
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -810,8 +783,7 @@
<option>own_window_class</option> <option>own_window_class</option>
</command> </command>
</term> </term>
<listitem>Manually set the WM_CLASS name. Defaults to <listitem>Manually set the WM_CLASS name. Defaults to "Conky".
"Conky".
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -821,10 +793,10 @@
</command> </command>
<option>colour</option> <option>colour</option>
</term> </term>
<listitem>If own_window_transparent no, set a specified <listitem>If own_window_transparent no, set a specified background
background colour (defaults to black). Takes either a hex value colour (defaults to black). Takes either a hex value (e.g. '#ffffff'),
(e.g. '#ffffff'), a shorthand hex value (e.g. '#fff'), or a valid a shorthand hex value (e.g. '#fff'), or a valid RGB name (see
RGB name (see /usr/lib/X11/rgb.txt) /usr/lib/X11/rgb.txt)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -835,11 +807,10 @@
<option> <option>
undecorated,below,above,sticky,skip_taskbar,skip_pager</option> undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
</term> </term>
<listitem>If own_window is yes, you may use these window <listitem>If own_window is yes, you may use these window manager hints
manager hints to affect the way Conky displays. Notes: Use to affect the way Conky displays. Notes: Use own_window_type desktop
own_window_type desktop as another way to implement many of as another way to implement many of these hints implicitly. If you use
these hints implicitly. If you use own_window_type own_window_type override, window manager hints have no meaning and are
override, window manager hints have no meaning and are
ignored. ignored.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
@ -849,8 +820,8 @@
<option>own_window_title</option> <option>own_window_title</option>
</command> </command>
</term> </term>
<listitem>Manually set the window name. Defaults to <listitem>Manually set the window name. Defaults to "conky
"conky (&lt;hostname&gt;)". (&lt;hostname&gt;)".
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -861,8 +832,8 @@
</term> </term>
<listitem>Boolean, use ARGB visual? ARGB can be used for real <listitem>Boolean, use ARGB visual? ARGB can be used for real
transparency, note that a composite manager is required for real transparency, note that a composite manager is required for real
transparency. This option will not work as desired (in most cases) transparency. This option will not work as desired (in most cases) in
in conjunction with 'own_window_type override'. conjunction with 'own_window_type override'.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -871,7 +842,9 @@
<option>own_window_argb_value</option> <option>own_window_argb_value</option>
</command> </command>
</term> </term>
<listitem>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. <listitem>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.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -890,17 +863,16 @@
<option>own_window_type</option> <option>own_window_type</option>
</command> </command>
</term> </term>
<listitem>if own_window is yes, you may specify type <listitem>if own_window is yes, you may specify type normal, desktop,
normal, desktop, dock, panel or override (default: normal). dock, panel or override (default: normal). Desktop windows are special
Desktop windows are special windows that have no window windows that have no window decorations; are always visible on your
decorations; are always visible on your desktop; do not desktop; do not appear in your pager or taskbar; and are sticky across
appear in your pager or taskbar; and are sticky across all all workspaces. Panel windows reserve space along a desktop edge, just
workspaces. Panel windows reserve space along a desktop like panels and taskbars, preventing maximized windows from
edge, just like panels and taskbars, preventing maximized overlapping them. The edge is chosen based on the alignment option.
windows from overlapping them. The edge is chosen based on Override windows are not under the control of the window manager.
the alignment option. Override windows are not under the Hints are ignored. This type of window can be useful for certain
control of the window manager. Hints are ignored. This type situations.
of window can be useful for certain situations.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -909,8 +881,7 @@
<option>pad_percents</option> <option>pad_percents</option>
</command> </command>
</term> </term>
<listitem>Pad percentages to this many decimals (0 = no <listitem>Pad percentages to this many decimals (0 = no padding)
padding)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -919,12 +890,11 @@
<option>pop3</option> <option>pop3</option>
</command> </command>
</term> </term>
<listitem>Default global POP3 server. Arguments are: "host <listitem>Default global POP3 server. Arguments are: "host user pass
user pass [-i interval (in seconds)] [-p port] [-e 'command'] [-i interval (in seconds)] [-p port] [-e 'command'] [-r retries]".
[-r retries]". Default port is 110, default interval is 5 Default port is 110, default interval is 5 minutes, and default number
minutes, and default number of retries before giving up is of retries before giving up is 5. If the password is supplied as '*',
5. If the password is supplied as '*', you will be prompted you will be prompted to enter the password when Conky starts.
to enter the password when Conky starts.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -933,8 +903,8 @@
<option>short_units</option> <option>short_units</option>
</command> </command>
</term> </term>
<listitem>Shortens units to a single character (kiB-&gt;k, <listitem>Shortens units to a single character (kiB-&gt;k, GiB-&gt;G,
GiB-&gt;G, etc.). Default is off. etc.). Default is off.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -970,9 +940,9 @@
<option>temperature_unit</option> <option>temperature_unit</option>
</command> </command>
</term> </term>
<listitem>Desired output unit of all objects displaying a <listitem>Desired output unit of all objects displaying a temperature.
temperature. Parameters are either "fahrenheit" or Parameters are either "fahrenheit" or "celsius". The default unit is
"celsius". The default unit is degree Celsius. degree Celsius.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -981,11 +951,10 @@
<option>templateN</option> <option>templateN</option>
</command> </command>
</term> </term>
<listitem>Define a template for later use inside conky.text <listitem>Define a template for later use inside conky.text segments.
segments. Substitute N by a digit between 0 and 9, Substitute N by a digit between 0 and 9, inclusively. The value of the
inclusively. The value of the variable is being inserted variable is being inserted into the stuff inside conky.text at the
into the stuff inside conky.text at the corresponding position, corresponding position, but before some substitutions are applied:
but before some substitutions are applied:
<simplelist> <simplelist>
<member>'\n' -&gt; newline</member> <member>'\n' -&gt; newline</member>
<member>'\\' -&gt; backslash</member> <member>'\\' -&gt; backslash</member>
@ -1001,12 +970,11 @@
</command> </command>
<option>bytes</option> <option>bytes</option>
</term> </term>
<listitem>Size of the standard text buffer (default is 256 <listitem>Size of the standard text buffer (default is 256 bytes).
bytes). This buffer is used for intermediary text, such as This buffer is used for intermediary text, such as individual lines,
individual lines, output from $exec vars, and various other output from $exec vars, and various other variables. Increasing the
variables. Increasing the size of this buffer can size of this buffer can drastically reduce Conky's performance, but
drastically reduce Conky's performance, but will allow for will allow for more text display per variable. The size of this buffer
more text display per variable. The size of this buffer
cannot be smaller than the default value of 256 bytes. cannot be smaller than the default value of 256 bytes.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
@ -1016,9 +984,8 @@
<option>times_in_seconds</option> <option>times_in_seconds</option>
</command> </command>
</term> </term>
<listitem>If true, variables that output times output a number <listitem>If true, variables that output times output a number that
that represents seconds. This doesn't affect $time, $tztime and represents seconds. This doesn't affect $time, $tztime and $utime
$utime
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1027,9 +994,9 @@
<option>top_cpu_separate</option> <option>top_cpu_separate</option>
</command> </command>
</term> </term>
<listitem>If true, cpu in top will show usage of one <listitem>If true, cpu in top will show usage of one processor's
processor's power. If false, cpu in top will show the usage power. If false, cpu in top will show the usage of all processors'
of all processors' power combined. power combined.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1039,8 +1006,8 @@
</command> </command>
</term> </term>
<listitem>If true, top name shows the full command line of each <listitem>If true, top name shows the full command line of each
process, including arguments (whenever possible). Otherwise, process, including arguments (whenever possible). Otherwise, only the
only the basename is displayed. Default value is false. basename is displayed. Default value is false.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1049,8 +1016,7 @@
<option>top_name_width</option> <option>top_name_width</option>
</command> </command>
</term> </term>
<listitem>Width for $top name value (defaults to 15 <listitem>Width for $top name value (defaults to 15 characters).
characters).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1059,8 +1025,8 @@
<option>total_run_times</option> <option>total_run_times</option>
</command> </command>
</term> </term>
<listitem>Total number of times for Conky to update before <listitem>Total number of times for Conky to update before quitting.
quitting. Zero makes Conky run forever Zero makes Conky run forever
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1089,7 +1055,8 @@
<option>detect_battery</option> <option>detect_battery</option>
</command> </command>
</term> </term>
<listitem>One or more batteries to check in order to use update_interval_on_battery (comma separated, BAT0 default) <listitem>One or more batteries to check in order to use
update_interval_on_battery (comma separated, BAT0 default)
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1098,8 +1065,7 @@
<option>uppercase</option> <option>uppercase</option>
</command> </command>
</term> </term>
<listitem>Boolean value, if true, text is rendered in upper <listitem>Boolean value, if true, text is rendered in upper case
case
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1108,12 +1074,11 @@
<option>use_spacer</option> <option>use_spacer</option>
</command> </command>
</term> </term>
<listitem>Adds spaces around certain objects to stop them <listitem>Adds spaces around certain objects to stop them from moving
from moving other things around. Arguments are left, right, other things around. Arguments are left, right, and none (default).
and none (default). The old true/false values are The old true/false values are deprecated and default to right/none
deprecated and default to right/none respectively. Note respectively. Note that this only helps if you are using a mono font,
that this only helps if you are using a mono font, such as such as Bitstream Vera Sans Mono.
Bitstream Vera Sans Mono.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1131,8 +1096,7 @@
<option>xftalpha</option> <option>xftalpha</option>
</command> </command>
</term> </term>
<listitem>Alpha of Xft font. Must be a value at or between <listitem>Alpha of Xft font. Must be a value at or between 1 and 0.
1 and 0.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>

View File

@ -1,49 +1,53 @@
<?xml version='1.0' encoding="UTF-8"?> <?xml version='1.0' encoding="utf-8"?>
<!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd"> <!DOCTYPE guide SYSTEM "http://www.gentoo.org/dtd/guide.dtd">
<guide link="/doc/en/conky-howto.xml"> <guide link="/doc/en/conky-howto.xml">
<title>Gentoo Linux Conky Howto</title> <title>Gentoo Linux Conky Howto</title>
<author title="Author"> <author title="Author">
<mail link="admin@sdesign.us">Bill Woodford</mail> <mail link="admin@sdesign.us">Bill Woodford</mail>
</author> </author>
<author title="Editor"> <author title="Editor">
<mail link="brenden@diddyinc.com">Brenden Matthews</mail> <mail link="brenden@diddyinc.com">Brenden Matthews</mail>
</author> </author>
<abstract>This document describes how to install and configure the system
<abstract> monitor known as Conky.</abstract>
This document describes how to install and configure the system monitor known
as Conky.
</abstract>
<!-- The content of this document is licensed under the CC-BY-SA license --> <!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license /> <license />
<version>1.0</version> <version>1.0</version>
<date>2006-02-22</date> <date>2006-02-22</date>
<chapter> <chapter>
<title>Background</title> <title>Background</title>
<section> <section>
<title>Introduction to Conky</title> <title>Introduction to Conky</title>
<body> <body>
<p>So you have a Gentoo machine, and have already learned 30
<p> different commands to monitor different aspects of what your
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. computer is doing at the current moment. What do you do from
</p> 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.</p>
</body> </body>
</section> </section>
<section> <section>
<title>What it does</title> <title>What it does</title>
<body> <body>
<p>Unlike other system monitors such as top, Conky can run as
<p> a window in an X session, or by drawing to the root window
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. (there is also an option to have Conky display information to
</p> 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.</p>
</body> </body>
</section> </section>
</chapter> </chapter>
@ -52,68 +56,90 @@ Unlike other system monitors such as top, Conky can run as a window in an X sess
<section> <section>
<title>Base install</title> <title>Base install</title>
<body> <body>
<p>Gentoo provides an ebuild to quickly and easily install
<p> Conky. Pay particular attention to the the USE flags. You'll
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 (<c>X</c>), and make sure you select the USE flags for any music players (other than MPD) which you want. XMMS (<c>xmms</c>), Audacious (<c>audacious</c>), BMPx (<c>bmpx</c>), or XMMS support via the xmms-infopipe plugin (<c>infopipe</c>). most likely want X11 support (
</p> <c>X</c>), and make sure you select the USE flags for any
music players (other than MPD) which you want. XMMS (
<c>xmms</c>), Audacious (
<c>audacious</c>), BMPx (
<c>bmpx</c>), or XMMS support via the xmms-infopipe plugin (
<c>infopipe</c>).</p>
<pre caption="/etc/portage/package.use"> <pre caption="/etc/portage/package.use">
<comment># Example line to append to /etc/portage/package.use if you don't want the default USE flags.</comment> <comment># Example line to append to /etc/portage/package.use if you don't
want the
default USE flags.</comment>
<i>app-admin/conky xmms infopipe -ipv6</i> <i>app-admin/conky xmms infopipe -ipv6</i>
</pre> </pre>
<p>In addition, the
<p> <c>truetype</c>USE flag compiles support for TrueType fonts
In addition, the <c>truetype</c> USE flag compiles support for TrueType fonts with the use of Xft. Most users will want this as well. with the use of Xft. Most users will want this as well.</p>
</p> <p>Once you have your USE flags correctly set up, it's time to
install Conky!</p>
<p>
Once you have your USE flags correctly set up, it's time to install Conky!
</p>
<pre caption="Installing Conky"> <pre caption="Installing Conky">
<i>emerge -av conky</i> <i>emerge -av conky</i>
</pre> </pre>
<p>You can test Conky to see how it will look by running the
<p> command
You can test Conky to see how it will look by running the command <c>conky</c> 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. <c>conky</c>in a terminal. This will likely give you a good
</p> reference to how it will look and what you want to change, add
or even remove.</p>
<pre caption="Running Conky for the first time"> <pre caption="Running Conky for the first time">
$ <i>conky</i> $
<i>conky</i>
</pre> </pre>
<p>Once you have an idea of how Conky looks, you can now move
<p> on to configuring it!</p>
Once you have an idea of how Conky looks, you can now move on to configuring it!
</p>
</body> </body>
</section> </section>
<section> <section>
<title>Configuring Conky</title> <title>Configuring Conky</title>
<body> <body>
<p>By default, Conky will look for a configuration file in the
<p> users home directory located at
By default, Conky will look for a configuration file in the users home directory located at <path>~/.config/conky/conky.conf</path> 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 <path>/usr/share/doc/conky-version/Conkyrc.sample.gz</path> Make sure to replace "version" with the specific version of Conky you have installed. <path>~/.config/conky/conky.conf</path>This file contains all
</p> 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
<path>
/usr/share/doc/conky-version/Conkyrc.sample.gz</path>Make sure
to replace "version" with the specific version of Conky you
have installed.</p>
<pre caption="Copying the sample configuration to your home directory"> <pre caption="Copying the sample configuration to your home directory">
$ <i>mkdir -p ~/.config/conky</i> $
$ <i>zcat /usr/share/conky-1.6.0/conkyrc.sample.gz >> ~/.config/conky/conky.conf</i> <i>mkdir -p ~/.config/conky</i>
$
<i>zcat /usr/share/conky-1.6.0/conkyrc.sample.gz &gt;&gt;
~/.config/conky/conky.conf</i>
</pre> </pre>
<note>Make sure to replace "1.6.0" with the specific version
<note> of Conky you have installed.</note>
Make sure to replace "1.6.0" with the specific version of Conky you have installed. <p>Now, open up the sample configuration in the text editor of
</note> your choice. You may notice that there are two seperate
sections of the configuration file. The first section of the
<p> file, contains the programs configuration options and controls
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 <c>update_interval</c>, 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 (<c>$uptime</c>), cpu usage (<c>$cpu</c>) 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 "<c>TEXT</c>". Comments in the file start with <c>#</c>, 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. how it acts. This includes things such as the
</p> <c>update_interval</c>, or how often Conky will update the
information on the screen. The second section contains the
<p> actual text, graphs, and variables which are rendered on the
Lists of all the available configuration options and variables are kept at <uri>http://conky.sourceforge.net/config_settings.html</uri> and <uri>http://conky.sourceforge.net/variables.html</uri>. Also, there's a few great sample configurations and screenshots of working configurations at <uri>http://conky.sourceforge.net/screenshots.html</uri>. screen. This includes things such as the system uptime (
</p> <c>$uptime</c>), cpu usage (
<c>$cpu</c>) 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 "
<c>TEXT</c>". Comments in the file start with
<c>#</c>, 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.</p>
<p>Lists of all the available configuration options and
variables are kept at
<uri>
http://conky.sourceforge.net/config_settings.html</uri>and
<uri>http://conky.sourceforge.net/variables.html</uri>. Also,
there's a few great sample configurations and screenshots of
working configurations at
<uri>http://conky.sourceforge.net/screenshots.html</uri>.</p>
</body> </body>
</section> </section>
</chapter> </chapter>
@ -122,21 +148,25 @@ Lists of all the available configuration options and variables are kept at <uri>
<section> <section>
<title>Beyond the built-in variables</title> <title>Beyond the built-in variables</title>
<body> <body>
<p>So you've gotten this far, and have scoured the Conky
<p> documentation for that extra variable which Conky just doesn't
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! <c>$exec</c> Will run a command every time Conky updates, <c>$execi</c> will run a command at a specified interval and <c>$texeci</c> will run a command in it's own thread at a specified interval. seem to have... You're in luck! Conky provides several
</p> variables for just this reason!
<c>$exec</c>Will run a command every time Conky updates,
<c>$execi</c>will run a command at a specified interval and
<c>$texeci</c>will run a command in it's own thread at a
specified interval.</p>
<pre caption="Scripting examples"> <pre caption="Scripting examples">
<i>${exec grep 'sudo' /var/log/messages | tail -n 4}</i> <i>${exec grep 'sudo' /var/log/messages | tail -n 4}</i>
<i>${execi 30 ~/scripts/emerge-status.sh</i> <i>${execi 30 ~/scripts/emerge-status.sh</i>
<i>${texeci 600 ~/scripts/gmail.pl}</i> <i>${texeci 600 ~/scripts/gmail.pl}</i>
</pre> </pre>
<note>While any command which works in a command shell will
<note> work in any of these variables, it is important to keep in
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 <c>tail -f</c> which keep running will NOT work properly. mind that the commands must exit. This means that commands
</note> like
<c>tail -f</c>which keep running will NOT work
properly.</note>
</body> </body>
</section> </section>
</chapter> </chapter>

View File

@ -24,9 +24,8 @@
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname>conky</refname> <refname>conky</refname>
<refpurpose>A system monitor for X originally based on the <refpurpose>A system monitor for X originally based on the torsmo
torsmo code, but more kickass. It just keeps on given'er. code, but more kickass. It just keeps on given'er. Yeah.</refpurpose>
Yeah.</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
@ -38,65 +37,51 @@
</refsynopsisdiv> </refsynopsisdiv>
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para>Conky is a system monitor for X originally based on <para>Conky is a system monitor for X originally based on torsmo.
torsmo. Since its inception, Conky has changed Since its inception, Conky has changed significantly from its
significantly from its predecessor, while maintaining predecessor, while maintaining simplicity and configurability. Conky
simplicity and configurability. Conky can display just can display just about anything, either on your root desktop or in its
about anything, either on your root desktop or in its own own window. Not only does Conky have many built-in objects, it can
window. Not only does Conky have many built-in objects, it also display just about any piece of information by using scripts and
can also display just about any piece of information by other external programs.</para>
using scripts and other external programs. <para>Conky has more than 250 built in objects, including support for
</para> a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk
<para>Conky has more than 250 built in objects, including usage, "top" like process stats, and network monitoring, just to name
support for a plethora of OS stats (uname, uptime, CPU a few), built in IMAP and POP3 support, built in support for many
usage, mem usage, disk usage, "top" like process stats, and popular music players (MPD, XMMS2, BMPx, Audacious), and much much
network monitoring, just to name a few), built in IMAP and more. Conky can display this info either as text, or using simple
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 progress bars and graph widgets, with different fonts and
colours. colours.</para>
</para> <para>We are always looking for help, whether its reporting bugs,
<para>We are always looking for help, whether its reporting writing patches, or writing docs. Please use the facilities at
bugs, writing patches, or writing docs. Please use the SourceForge to make bug reports, feature requests, and submit patches,
facilities at SourceForge to make bug reports, feature or stop by #conky on irc.freenode.net if you have questions or want to
requests, and submit patches, or stop by #conky on
irc.freenode.net if you have questions or want to
contribute.</para> contribute.</para>
<para>Thanks for your interest in Conky. <para>Thanks for your interest in Conky.</para>
</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Compiling</title> <title>Compiling</title>
<para>For users compiling from source on a binary distro, make sure you <para>For users compiling from source on a binary distro, make sure
have the X development libraries installed (Unless you configure you have the X development libraries installed (Unless you configure
your build without X11). This should be a package along the lines your build without X11). This should be a package along the lines of
of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar "-dev" format
format for the other libs required (depending on your build for the other libs required (depending on your build options). You
options). You should be able to see which extra packages you need should be able to see which extra packages you need to install by
to install by reading errors that you get from running `cmake'. The reading errors that you get from running `cmake'. The easiest way to
easiest way to view the available build options is to run `ccmake' or view the available build options is to run `ccmake' or `cmake-gui'
`cmake-gui' from the source tree, but be careful when disabling from the source tree, but be careful when disabling certain features
certain features as you may lose desired functionality. E.g., as you may lose desired functionality. E.g., with BUILD_MATH disabled
with BUILD_MATH disabled you won't get errors but logarithmic you won't get errors but logarithmic graphs will be normal graphs and
graphs will be normal graphs and gauges will miss their line. gauges will miss their line.</para>
</para> <para>Conky has (for some time) been available in the repositories of
<para>Conky has (for some time) been available in the most popular distributions. Here are some installation instructions
repositories of most popular distributions. Here are some for a few:</para>
installation instructions for a few: <para>Gentoo users -- Conky is in Gentoo's Portage... simply use
</para> "emerge app-admin/conky" for installation.</para>
<para>Gentoo users -- Conky is in Gentoo's Portage... <para>Debian, etc. users -- Conky should be in your repositories, and
simply use "emerge app-admin/conky" for can be installed by doing "aptitude install conky".</para>
installation. <para>Example to compile and run Conky with default components (note
</para> that some build options may differ for your system):</para>
<para>Debian, etc. users -- Conky should be in your
repositories, and can be installed by doing "aptitude
install conky".
</para>
<para>Example to compile and run Conky with default
components (note that some build options may differ for
your system):
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
@ -131,92 +116,65 @@
</variablelist> </variablelist>
<para>Conky has been tested to be compatible with C99 C and C++0x C++, <para>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 however it has not been tested with anything other than gcc, and is
not guaranteed to work with other compilers. not guaranteed to work with other compilers.</para>
</para> <para>TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead
<para>TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead of of just `cmake'.</para>
just `cmake'.
</para>
<para></para> <para></para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>You Should Know</title> <title>You Should Know</title>
<para>Conky is generally very good on resources. That said, <para>Conky is generally very good on resources. That said, the more
the more you try to make Conky do, the more resources it is you try to make Conky do, the more resources it is going to
going to consume. consume.</para>
</para> <para>An easy way to force Conky to reload your
<para>An easy way to force Conky to reload your ~/.config/conky/conky.conf: ~/.config/conky/conky.conf: "killall -SIGUSR1 conky". Saves you the
"killall -SIGUSR1 conky". Saves you the trouble of having to kill trouble of having to kill and then restart.</para>
and then restart.
</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Options</title> <title>Options</title>
<para>Command line options override configurations defined in <para>Command line options override configurations defined in
configuration file. configuration file.</para>&command_options;</refsect1>
</para>
&command_options;
</refsect1>
<refsect1> <refsect1>
<title>Configuration Settings</title> <title>Configuration Settings</title>
<para>Default configuration file location is $HOME/.config/conky/conky.conf or <para>Default configuration file location is
${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is $HOME/.config/conky/conky.conf or ${sysconfdir}/conky/conky.conf. On most
/etc, and you can find the sample config file there systems, sysconfdir is /etc, and you can find the sample config file there
(/etc/conky/conky.conf). (/etc/conky/conky.conf).</para>
</para>
<para>You might want to copy it to $HOME/.config/conky/conky.conf and then <para>You might want to copy it to $HOME/.config/conky/conky.conf and then
start modifying it. Other configs can be found at start modifying it. Other configs can be found at
http://conky.sf.net/ http://conky.sf.net/</para>&config_settings;</refsect1>
</para>
&config_settings;
</refsect1>
<refsect1> <refsect1>
<title>Objects/Variables</title> <title>Objects/Variables</title>
<para>Colours are parsed using XParsecolor(), there might be a <para>Colours are parsed using XParsecolor(), there might be a list of
list of them: /usr/share/X11/rgb.txt. them: /usr/share/X11/rgb.txt. Colour can be also in #rrggbb format
Colour can be also in (hex).</para>
#rrggbb format (hex). <para>Some objects may create threads, and sometimes these threads will
</para> not be destroyed until Conky terminates. There is no way to destroy or
<para> clean up threads while Conky is running. For example, if you use an MPD
Some objects may create threads, and sometimes these threads will variable, the MPD thread will keep running until Conky dies. Some threaded
not be destroyed until Conky terminates. There is no way to objects will use one of the parameters as a 'key', so that you only have 1
destroy or clean up threads while Conky is running. For example, relevant thread running (for example, the $curl, $rss and $weather objects
if you use an MPD variable, the MPD thread will keep running until launch one thread per URI).</para>&variables;</refsect1>
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).
</para>
&variables;
</refsect1>
<refsect1> <refsect1>
<title>Lua API</title> <title>Lua API</title>
<para>Conky features a Lua Programming API, and also ships with Lua <para>Conky features a Lua Programming API, and also ships with Lua
bindings for some useful libraries. Note that the bindings require bindings for some useful libraries. Note that the bindings require
tolua++, which currently only compiles against Lua 5.1. tolua++, which currently only compiles against Lua 5.1.</para>
</para> <para>To use Lua Conky, you first need to make sure you have a version of
<para>To use Lua Conky, you first need to make sure you have a version of Conky Conky with Lua support enabled (``conky -v'' will report this). Conky
with Lua support enabled (``conky -v'' will report this). Conky defines defines certain global functions and variables which can be accessed from
certain global functions and variables which can be accessed from Lua Lua code running in Conky. Scripts must first be loaded using the lua_load
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, configuration option. You then call functions in Lua via Conky's $lua,
$lua_read, and Lua hooks. $lua_read, and Lua hooks.</para>
</para> <para>Be careful when creating threaded objects through the Lua API. You
<para> could wind up with a whole bunch of threads running if a thread is created
Be careful when creating threaded objects through the Lua API. You with each iteration.</para>
could wind up with a whole bunch of threads running if a thread is <para>At this time, the Lua API should not be considered stable and may
created with each iteration. change drastically from one release to another as it matures.</para>
</para> <para>NOTE: In order to accommodate certain features in the cairo
<para>
At this time, the Lua API should not be considered stable and may
change drastically from one release to another as it matures.
</para>
<para>
NOTE: In order to accommodate certain features in the cairo
library's API, Conky will export a few additional functions for the library's API, Conky will export a few additional functions for the
creation of certain structures. These are documented below. creation of certain structures. These are documented
</para> below.</para>&lua;</refsect1>
&lua;
</refsect1>
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>
<variablelist> <variablelist>
@ -225,26 +183,25 @@
<varname>conky</varname> <varname>conky</varname>
<option>-t '${time %D %H:%M}' -o -u 30</option> <option>-t '${time %D %H:%M}' -o -u 30</option>
</term> </term>
<listitem>Start Conky in its own window with date <listitem>Start Conky in its own window with date and clock as
and clock as text and 30 sec update text and 30 sec update interval.</listitem>
interval.</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<varname>conky</varname> <varname>conky</varname>
<option>-a top_left -x 5 -y 500 -d</option> <option>-a top_left -x 5 -y 500 -d</option>
</term> </term>
<listitem>Start Conky to background at coordinates <listitem>Start Conky to background at coordinates (5,
(5, 500).</listitem> 500).</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<varname>conky</varname> <varname>conky</varname>
<option>-C &gt; ~/.config/conky/conky.conf</option> <option>-C &gt; ~/.config/conky/conky.conf</option>
</term> </term>
<listitem>Do not start Conky, but have it output <listitem>Do not start Conky, but have it output the builtin
the builtin default config file to default config file to ~/.config/conky/conky.conf for later
~/.config/conky/conky.conf for later customising.</listitem> customising.</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
@ -253,54 +210,46 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<filename> <filename>${sysconfdir}/conky/conky.conf</filename>
${sysconfdir}/conky/conky.conf</filename>
</term> </term>
<listitem>Default system-wide configuration file. <listitem>Default system-wide configuration file. The value of
The value of ${sysconfdir} depends on the ${sysconfdir} depends on the compile-time options (most likely
compile-time options (most likely /etc).</listitem> /etc).</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<filename>~/.config/conky/conky.conf</filename> <filename>~/.config/conky/conky.conf</filename>
</term> </term>
<listitem>Default personal configuration <listitem>Default personal configuration file.</listitem>
file.</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Bugs</title> <title>Bugs</title>
<para>Drawing to root or some other desktop window directly <para>Drawing to root or some other desktop window directly doesn't
doesn't work with all window managers. Especially doesn't work with all window managers. Especially doesn't work well with Gnome
work well with Gnome and it has been reported that it and it has been reported that it doesn't work with KDE either.
doesn't work with KDE either. Nautilus can be disabled from Nautilus can be disabled from drawing to desktop with program
drawing to desktop with program gconf-editor. Uncheck gconf-editor. Uncheck show_desktop in /apps/nautilus/preferences/.
show_desktop in /apps/nautilus/preferences/. There is -w There is -w switch in Conky to set some specific window id. You might
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
find xwininfo -tree useful to find the window to draw to. use -o argument which makes Conky to create its own window. If you do
You can also use -o argument which makes Conky to create try running Conky in its own window, be sure to read up on the
its own window. If you do try running Conky in its own own_window_type settings and experiment.</para>
window, be sure to read up on the own_window_type settings
and experiment.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>See Also</title> <title>See Also</title>
<para> <para>https://github.com/brndnmtthws/conky</para>
<ulink url="https://github.com/brndnmtthws/conky">
https://github.com/brndnmtthws/conky</ulink>
</para>
<para>#conky on irc.freenode.net</para> <para>#conky on irc.freenode.net</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Copying</title> <title>Copying</title>
<para>Copyright (c) 2005-2018 Brenden Matthews, Philip <para>Copyright (c) 2005-2018 Brenden Matthews, Philip Kovacs, et. al.
Kovacs, et. al. Any original torsmo code is licensed under Any original torsmo code is licensed under the BSD license (see
the BSD license (see LICENSE.BSD for a copy). All code LICENSE.BSD for a copy). All code written since the fork of torsmo is
written since the fork of torsmo is licensed under the GPL licensed under the GPL (see LICENSE.GPL for a copy), except where
(see LICENSE.GPL for a copy), except where noted noted differently (such as in portmon and audacious code which are
differently (such as in portmon and audacious code which are LGPL, and LGPL, and prss which is an MIT-style license).</para>
prss which is an MIT-style license).</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Authors</title> <title>Authors</title>

View File

@ -7,9 +7,9 @@
<option>function</option> <option>function</option>
</term> </term>
<listitem> <listitem>
<para>This function takes a string that is evaluated as <para>This function takes a string that is evaluated as per
per Conky's TEXT section, and then returns a string Conky's TEXT section, and then returns a string with the
with the result.</para> result.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -32,26 +32,23 @@
<option>table</option> <option>table</option>
</term> </term>
<listitem> <listitem>
<para>This table contains some information about <para>This table contains some information about Conky's window.
Conky's window. The following table describes the The following table describes the values contained:</para>
values contained:</para>
<simplelist> <simplelist>
<member> <member>
<command>drawable</command> <command>drawable</command>
<option>Window's drawable (Xlib Drawable), <option>Window's drawable (Xlib Drawable), requires Lua
requires Lua extras enabled at compile extras enabled at compile time.</option>
time.</option>
</member> </member>
<member> <member>
<command>visual</command> <command>visual</command>
<option>Window's visual (Xlib Visual), requires <option>Window's visual (Xlib Visual), requires Lua extras
Lua extras enabled at compile time.</option> enabled at compile time.</option>
</member> </member>
<member> <member>
<command>display</command> <command>display</command>
<option>Window's display (Xlib Display), <option>Window's display (Xlib Display), requires Lua
requires Lua extras enabled at compile extras enabled at compile time.</option>
time.</option>
</member> </member>
<member> <member>
<command>width</command> <command>width</command>
@ -63,42 +60,37 @@
</member> </member>
<member> <member>
<command>border_inner_margin</command> <command>border_inner_margin</command>
<option>Window's inner border margin (in <option>Window's inner border margin (in pixels).</option>
pixels).</option>
</member> </member>
<member> <member>
<command>border_outer_margin</command> <command>border_outer_margin</command>
<option>Window's outer border margin (in <option>Window's outer border margin (in pixels).</option>
pixels).</option>
</member> </member>
<member> <member>
<command>border_width</command> <command>border_width</command>
<option>Window's border width (in <option>Window's border width (in pixels).</option>
pixels).</option>
</member> </member>
<member> <member>
<command>text_start_x</command> <command>text_start_x</command>
<option>The x component of the starting <option>The x component of the starting coordinate of text
coordinate of text drawing.</option> drawing.</option>
</member> </member>
<member> <member>
<command>text_start_y</command> <command>text_start_y</command>
<option>The y component of the starting <option>The y component of the starting coordinate of text
coordinate of text drawing.</option> drawing.</option>
</member> </member>
<member> <member>
<command>text_width</command> <command>text_width</command>
<option>The width of the text drawing <option>The width of the text drawing region.</option>
region.</option>
</member> </member>
<member> <member>
<command>text_height</command> <command>text_height</command>
<option>The height of the text drawing <option>The height of the text drawing region.</option>
region.</option>
</member> </member>
</simplelist> </simplelist>
<para>NOTE: This table is only defined when X support <para>NOTE: This table is only defined when X support is
is enabled.</para> enabled.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -109,14 +101,12 @@
<option>table</option> <option>table</option>
</term> </term>
<listitem> <listitem>
<para>This table contains some information about <para>This table contains some information about Conky's internal
Conky's internal data. The following table describes data. The following table describes the values contained:</para>
the values contained:</para>
<simplelist> <simplelist>
<member> <member>
<command>update_interval</command> <command>update_interval</command>
<option>Conky's update interval (in <option>Conky's update interval (in seconds).</option>
seconds).</option>
</member> </member>
</simplelist> </simplelist>
</listitem> </listitem>
@ -129,9 +119,9 @@
<option>string</option> <option>string</option>
</term> </term>
<listitem> <listitem>
<para>A string containing the build info for this <para>A string containing the build info for this particular
particular instance of Conky, including the version, instance of Conky, including the version, build date, and
build date, and architecture.</para> architecture.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -142,8 +132,8 @@
<option>string</option> <option>string</option>
</term> </term>
<listitem> <listitem>
<para>A string containing the build date for this <para>A string containing the build date for this particular
particular instance of Conky.</para> instance of Conky.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -154,8 +144,8 @@
<option>string</option> <option>string</option>
</term> </term>
<listitem> <listitem>
<para>A string containing the build architecture for <para>A string containing the build architecture for this
this particular instance of Conky.</para> particular instance of Conky.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -166,8 +156,8 @@
<option>string</option> <option>string</option>
</term> </term>
<listitem> <listitem>
<para>A string containing the version of the current <para>A string containing the version of the current instance of
instance of Conky.</para> Conky.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -190,12 +180,11 @@
<option>function</option> <option>function</option>
</term> </term>
<listitem> <listitem>
<para>Call this function to return a new <para>Call this function to return a new cairo_text_extents_t
cairo_text_extents_t structure. A creation function for structure. A creation function for this structure is not provided
this structure is not provided by the cairo API. After by the cairo API. After calling this, you should use
calling this, you should use tolua.takeownership() on tolua.takeownership() on the return value to ensure ownership is
the return value to ensure ownership is passed passed properly.</para>
properly.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -206,12 +195,11 @@
<option>function</option> <option>function</option>
</term> </term>
<listitem> <listitem>
<para>Call this function to return a new <para>Call this function to return a new cairo_font_extents_t
cairo_font_extents_t structure. A creation function for structure. A creation function for this structure is not provided
this structure is not provided by the cairo API. After by the cairo API. After calling this, you should use
calling this, you should use tolua.takeownership() on tolua.takeownership() on the return value to ensure ownership is
the return value to ensure ownership is passed passed properly.</para>
properly.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -222,18 +210,17 @@
<option>function</option> <option>function</option>
</term> </term>
<listitem> <listitem>
<para>Call this function to return a new cairo_matrix_t <para>Call this function to return a new cairo_matrix_t structure.
structure. A creation function for this structure is A creation function for this structure is not provided by the
not provided by the cairo API. After calling this, you cairo API. After calling this, you should use
should use tolua.takeownership() on the return value to tolua.takeownership() on the return value to ensure ownership is
ensure ownership is passed properly.</para> passed properly.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command> <command>
<option> <option>cairo_text_extents_t:destroy(structure)</option>
cairo_text_extents_t:destroy(structure)</option>
</command> </command>
<option>function</option> <option>function</option>
</term> </term>
@ -245,8 +232,7 @@
<varlistentry> <varlistentry>
<term> <term>
<command> <command>
<option> <option>cairo_font_extents_t:destroy(structure)</option>
cairo_font_extents_t:destroy(structure)</option>
</command> </command>
<option>function</option> <option>function</option>
</term> </term>

File diff suppressed because it is too large Load Diff