Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-26 04:17:33 +00:00
Code Issues Releases Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
doc/command_options.xml
View File

@ -7,9 +7,9 @@
<option>ALIGNMENT</option>
</term>
<listitem>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.
<para></para></listitem>
</varlistentry>
<varlistentry>
@ -18,7 +18,8 @@
<option>-b | --double-buffer</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -28,7 +29,8 @@
</command>
<option>FILE</option>
</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>
</varlistentry>
<varlistentry>
@ -37,8 +39,9 @@
<option>-C | --print-config</option>
</command>
</term>
<listitem>Print builtin default config to stdout. See also
the section EXAMPLES for more information. Only available with build flag BUILD_BUILTIN_CONFIG enabled.
<listitem>Print builtin default config to stdout. See also the section
EXAMPLES for more information. Only available with build flag
BUILD_BUILTIN_CONFIG enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
@ -56,8 +59,7 @@
<option>-D | --debug</option>
</command>
</term>
<listitem>Increase debugging output, ie. -DD for more
debugging.
<listitem>Increase debugging output, ie. -DD for more debugging.
<para></para></listitem>
</varlistentry>
<varlistentry>
@ -67,7 +69,8 @@
</command>
<option>FONT</option>
</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>
</varlistentry>
<varlistentry>
@ -95,7 +98,8 @@
<option>-o | --own-window</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -124,8 +128,7 @@
</command>
<option>TEXT</option>
</term>
<listitem>Text to render, remember single quotes, like -t '
$uptime '
<listitem>Text to render, remember single quotes, like -t ' $uptime '
<para></para></listitem>
</varlistentry>
<varlistentry>
@ -144,8 +147,8 @@
<option>-v | -V | --version</option>
</command>
</term>
<listitem>Prints version, build information and general info.
Exits after printing.
<listitem>Prints version, build information and general info. Exits
after printing.
<para></para></listitem>
</varlistentry>
<varlistentry>
@ -155,7 +158,8 @@
</command>
<option>WIN_ID</option>
</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>
</varlistentry>
<varlistentry>
@ -185,7 +189,8 @@
</command>
<option>DISPLAY</option>
</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>
</varlistentry>
<varlistentry>

410
doc/config_settings.xml
View File

@ -5,11 +5,10 @@
<option>alignment</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -27,8 +26,8 @@
<option>background</option>
</command>
</term>
<listitem>Boolean value, if true, Conky will be forked to
background when started.
<listitem>Boolean value, if true, Conky will be forked to background
when started.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -37,8 +36,8 @@
<option>border_inner_margin</option>
</command>
</term>
<listitem>Inner border margin in pixels (the margin between
the border and text).
<listitem>Inner border margin in pixels (the margin between the border
and text).
<para /></listitem>
</varlistentry>
<varlistentry>
@ -47,8 +46,8 @@
<option>border_outer_margin</option>
</command>
</term>
<listitem>Outer border margin in pixels (the margin between
the border and the edge of the window).
<listitem>Outer border margin in pixels (the margin between the border
and the edge of the window).
<para /></listitem>
</varlistentry>
<varlistentry>
@ -67,9 +66,8 @@
</command>
</term>
<listitem>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 (#).
<para /></listitem>
</varlistentry>
<varlistentry>
@ -96,9 +94,10 @@
<option>console_graph_ticks</option>
</command>
</term>
<listitem>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: " ,_,=,#".
<listitem>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:
" ,_,=,#".
<para /></listitem>
</varlistentry>
<varlistentry>
@ -107,8 +106,7 @@
<option>cpu_avg_samples</option>
</command>
</term>
<listitem>The number of samples to average for CPU
monitoring.
<listitem>The number of samples to average for CPU monitoring.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -117,8 +115,8 @@
<option>default_bar_height</option>
</command>
</term>
<listitem>Specify a default height for bars. If not specified,
the default value is 6.
<listitem>Specify a default height for bars. If not specified, the
default value is 6.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -127,11 +125,10 @@
<option>default_bar_width</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -149,8 +146,8 @@
<option>default_gauge_height</option>
</command>
</term>
<listitem>Specify a default height for gauges. If not specified,
the default value is 25.
<listitem>Specify a default height for gauges. If not specified, the
default value is 25.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -159,8 +156,8 @@
<option>default_gauge_width</option>
</command>
</term>
<listitem>Specify a default width for gauges. If not specified,
the default value is 40.
<listitem>Specify a default width for gauges. If not specified, the
default value is 40.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -169,8 +166,8 @@
<option>default_graph_height</option>
</command>
</term>
<listitem>Specify a default height for graphs. If not specified,
the default value is 25.
<listitem>Specify a default height for graphs. If not specified, the
default value is 25.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -179,12 +176,11 @@
<option>default_graph_width</option>
</command>
</term>
<listitem>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
<listitem>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.
<para /></listitem>
</varlistentry>
@ -212,7 +208,8 @@
<option>disable_auto_reload</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -221,8 +218,7 @@
<option>diskio_avg_samples</option>
</command>
</term>
<listitem>The number of samples to average for disk I/O
monitoring.
<listitem>The number of samples to average for disk I/O monitoring.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -249,9 +245,9 @@
<option>double_buffer</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -260,10 +256,9 @@
<option>draw_blended</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -308,8 +303,8 @@
<option>extra_newline</option>
</command>
</term>
<listitem>Put an extra newline at the end when writing to
stdout, useful for writing to awesome's wiboxes.
<listitem>Put an extra newline at the end when writing to stdout,
useful for writing to awesome's wiboxes.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -318,8 +313,7 @@
<option>font</option>
</command>
</term>
<listitem>Font name in X, xfontsel can be used to get a
nice font
<listitem>Font name in X, xfontsel can be used to get a nice font
<para /></listitem>
</varlistentry>
<varlistentry>
@ -333,16 +327,15 @@
format as a font variable.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>format_human_readable</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -351,9 +344,9 @@
<option>gap_x</option>
</command>
</term>
<listitem>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'.
<listitem>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'.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -362,9 +355,9 @@
<option>gap_y</option>
</command>
</term>
<listitem>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'.
<listitem>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'.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -376,8 +369,7 @@
<listitem>Specify API token for GitHub notifications.
<simplelist>
<member>
https://github.com/settings/tokens/new?scopes=notifications&amp;description=conky
</member>
https://github.com/settings/tokens/new?scopes=notifications&amp;description=conky</member>
</simplelist>
<para /></listitem>
</varlistentry>
@ -387,8 +379,8 @@
<option>hddtemp_host</option>
</command>
</term>
<listitem>Hostname to connect to for hddtemp objects. Defaults
to "127.0.0.1".
<listitem>Hostname to connect to for hddtemp objects. Defaults to
"127.0.0.1".
<para /></listitem>
</varlistentry>
<varlistentry>
@ -397,8 +389,7 @@
<option>hddtemp_port</option>
</command>
</term>
<listitem>Port to use for hddtemp connections. Defaults to
7634.
<listitem>Port to use for hddtemp connections. Defaults to 7634.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -407,9 +398,8 @@
<option>http_refresh</option>
</command>
</term>
<listitem>When this is set the page generated with
out_to_http will automatically refresh each interval. Default
value is no.
<listitem>When this is set the page generated with out_to_http will
automatically refresh each interval. Default value is no.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -418,11 +408,10 @@
<option>if_up_strictness</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -431,13 +420,12 @@
<option>imap</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -455,11 +443,10 @@
<option>imlib_cache_size</option>
</command>
</term>
<listitem>
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.<para/>
</listitem>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
@ -468,16 +455,13 @@
</command>
<option>function_name [function arguments]</option>
</term>
<listitem>
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.<para/>
</listitem>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
@ -486,16 +470,13 @@
</command>
<option>function_name [function arguments]</option>
</term>
<listitem>
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.<para/>
</listitem>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
@ -513,16 +494,13 @@
</command>
<option>function_name [function arguments]</option>
</term>
<listitem>
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.<para/>
</listitem>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
@ -531,15 +509,12 @@
</command>
<option>function_name [function arguments]</option>
</term>
<listitem>
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.<para/>
</listitem>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
@ -556,8 +531,8 @@
<option>max_port_monitor_connections</option>
</command>
</term>
<listitem>Allow each port monitor to track at most this
many connections (if 0 or not set, default is 256)
<listitem>Allow each port monitor to track at most this many
connections (if 0 or not set, default is 256)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -567,10 +542,9 @@
</command>
<option>width</option>
</term>
<listitem>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
<listitem>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
<para /></listitem>
</varlistentry>
<varlistentry>
@ -665,7 +639,8 @@
<option>mysql_user</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -674,8 +649,8 @@
<option>mysql_password</option>
</command>
</term>
<listitem>Password of the MySQL user. Place it between "-chars. When this is not set there
is no password used
<listitem>Password of the MySQL user. Place it between "-chars. When
this is not set there is no password used
<para /></listitem>
</varlistentry>
<varlistentry>
@ -693,8 +668,8 @@
<option>music_player_interval</option>
</command>
</term>
<listitem>Music player thread update interval (defaults to
Conky's update interval)
<listitem>Music player thread update interval (defaults to Conky's
update interval)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -713,7 +688,6 @@
</command>
</term>
<listitem>Subtract (file system) buffers from used memory?
<para /></listitem>
</varlistentry>
<varlistentry>
@ -722,8 +696,8 @@
<option>nvidia_display</option>
</command>
</term>
<listitem>The display that the nvidia variable will use (defaults to the value of the
display variable)
<listitem>The display that the nvidia variable will use (defaults to
the value of the display variable)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -750,9 +724,9 @@
<option>out_to_ncurses</option>
</command>
</term>
<listitem>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)
<listitem>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)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -770,11 +744,10 @@
<option>out_to_x</option>
</command>
</term>
<listitem>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
<listitem>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
<para /></listitem>
</varlistentry>
<varlistentry>
@ -810,8 +783,7 @@
<option>own_window_class</option>
</command>
</term>
<listitem>Manually set the WM_CLASS name. Defaults to
"Conky".
<listitem>Manually set the WM_CLASS name. Defaults to "Conky".
<para /></listitem>
</varlistentry>
<varlistentry>
@ -821,10 +793,10 @@
</command>
<option>colour</option>
</term>
<listitem>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)
<listitem>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)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -835,11 +807,10 @@
<option>
undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
</term>
<listitem>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
<listitem>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.
<para /></listitem>
</varlistentry>
@ -849,8 +820,8 @@
<option>own_window_title</option>
</command>
</term>
<listitem>Manually set the window name. Defaults to
"conky (&lt;hostname&gt;)".
<listitem>Manually set the window name. Defaults to "conky
(&lt;hostname&gt;)".
<para /></listitem>
</varlistentry>
<varlistentry>
@ -861,8 +832,8 @@
</term>
<listitem>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'.
transparency. This option will not work as desired (in most cases) in
conjunction with 'own_window_type override'.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -871,7 +842,9 @@
<option>own_window_argb_value</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -890,17 +863,16 @@
<option>own_window_type</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -909,8 +881,7 @@
<option>pad_percents</option>
</command>
</term>
<listitem>Pad percentages to this many decimals (0 = no
padding)
<listitem>Pad percentages to this many decimals (0 = no padding)
<para /></listitem>
</varlistentry>
<varlistentry>
@ -919,12 +890,11 @@
<option>pop3</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -933,8 +903,8 @@
<option>short_units</option>
</command>
</term>
<listitem>Shortens units to a single character (kiB-&gt;k,
GiB-&gt;G, etc.). Default is off.
<listitem>Shortens units to a single character (kiB-&gt;k, GiB-&gt;G,
etc.). Default is off.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -970,9 +940,9 @@
<option>temperature_unit</option>
</command>
</term>
<listitem>Desired output unit of all objects displaying a
temperature. Parameters are either "fahrenheit" or
"celsius". The default unit is degree Celsius.
<listitem>Desired output unit of all objects displaying a temperature.
Parameters are either "fahrenheit" or "celsius". The default unit is
degree Celsius.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -981,11 +951,10 @@
<option>templateN</option>
</command>
</term>
<listitem>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:
<listitem>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:
<simplelist>
<member>'\n' -&gt; newline</member>
<member>'\\' -&gt; backslash</member>
@ -1001,12 +970,11 @@
</command>
<option>bytes</option>
</term>
<listitem>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
<listitem>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.
<para /></listitem>
</varlistentry>
@ -1016,9 +984,8 @@
<option>times_in_seconds</option>
</command>
</term>
<listitem>If true, variables that output times output a number
that represents seconds. This doesn't affect $time, $tztime and
$utime
<listitem>If true, variables that output times output a number that
represents seconds. This doesn't affect $time, $tztime and $utime
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1027,9 +994,9 @@
<option>top_cpu_separate</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1039,8 +1006,8 @@
</command>
</term>
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1049,8 +1016,7 @@
<option>top_name_width</option>
</command>
</term>
<listitem>Width for $top name value (defaults to 15
characters).
<listitem>Width for $top name value (defaults to 15 characters).
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1059,8 +1025,8 @@
<option>total_run_times</option>
</command>
</term>
<listitem>Total number of times for Conky to update before
quitting. Zero makes Conky run forever
<listitem>Total number of times for Conky to update before quitting.
Zero makes Conky run forever
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1089,7 +1055,8 @@
<option>detect_battery</option>
</command>
</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>
</varlistentry>
<varlistentry>
@ -1098,8 +1065,7 @@
<option>uppercase</option>
</command>
</term>
<listitem>Boolean value, if true, text is rendered in upper
case
<listitem>Boolean value, if true, text is rendered in upper case
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1108,12 +1074,11 @@
<option>use_spacer</option>
</command>
</term>
<listitem>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.
<listitem>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.
<para /></listitem>
</varlistentry>
<varlistentry>
@ -1131,8 +1096,7 @@
<option>xftalpha</option>
</command>
</term>
<listitem>Alpha of Xft font. Must be a value at or between
1 and 0.
<listitem>Alpha of Xft font. Must be a value at or between 1 and 0.
<para /></listitem>
</varlistentry>
</variablelist>

188
doc/conky-howto.xml
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">
<guide link="/doc/en/conky-howto.xml">
<title>Gentoo Linux Conky Howto</title>
<author title="Author">
<mail link="admin@sdesign.us">Bill Woodford</mail>
</author>
<author title="Editor">
<mail link="brenden@diddyinc.com">Brenden Matthews</mail>
</author>
<abstract>
This document describes how to install and configure the system monitor known
as Conky.
</abstract>
<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 -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license />
<version>1.0</version>
<date>2006-02-22</date>
<chapter>
<title>Background</title>
<section>
<title>Introduction to Conky</title>
<body>
<p>
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.
</p>
<p>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.</p>
</body>
</section>
<section>
<title>What it does</title>
<body>
<p>
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.
</p>
<p>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.</p>
</body>
</section>
</chapter>
@ -52,68 +56,90 @@ Unlike other system monitors such as top, Conky can run as a window in an X sess
<section>
<title>Base install</title>
<body>
<p>
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>).
</p>
<p>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>).</p>
<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>
</pre>
<p>
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.
</p>
<p>
Once you have your USE flags correctly set up, it's time to install Conky!
</p>
<p>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.</p>
<p>Once you have your USE flags correctly set up, it's time to
install Conky!</p>
<pre caption="Installing Conky">
<i>emerge -av conky</i>
</pre>
<p>
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.
</p>
<p>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.</p>
<pre caption="Running Conky for the first time">
$ <i>conky</i>
$
<i>conky</i>
</pre>
<p>
Once you have an idea of how Conky looks, you can now move on to configuring it!
</p>
<p>Once you have an idea of how Conky looks, you can now move
on to configuring it!</p>
</body>
</section>
<section>
<title>Configuring Conky</title>
<body>
<p>
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.
</p>
<p>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.</p>
<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>
<note>
Make sure to replace "1.6.0" with the specific version of Conky you have installed.
</note>
<p>
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.
</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>
<note>Make sure to replace "1.6.0" with the specific version
of Conky you have installed.</note>
<p>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.</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>
</section>
</chapter>
@ -122,21 +148,25 @@ Lists of all the available configuration options and variables are kept at <uri>
<section>
<title>Beyond the built-in variables</title>
<body>
<p>
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.
</p>
<p>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.</p>
<pre caption="Scripting examples">
<i>${exec grep 'sudo' /var/log/messages | tail -n 4}</i>
<i>${execi 30 ~/scripts/emerge-status.sh</i>
<i>${texeci 600 ~/scripts/gmail.pl}</i>
</pre>
<note>
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.
</note>
<note>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.</note>
</body>
</section>
</chapter>

271
doc/docs.xml
View File

@ -24,9 +24,8 @@
</refmeta>
<refnamediv>
<refname>conky</refname>
<refpurpose>A system monitor for X originally based on the
torsmo code, but more kickass. It just keeps on given'er.
Yeah.</refpurpose>
<refpurpose>A system monitor for X originally based on the torsmo
code, but more kickass. It just keeps on given'er. Yeah.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
@ -38,65 +37,51 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>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.
</para>
<para>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
<para>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.</para>
<para>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.
</para>
<para>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
colours.</para>
<para>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.</para>
<para>Thanks for your interest in Conky.
</para>
<para>Thanks for your interest in Conky.</para>
</refsect1>
<refsect1>
<title>Compiling</title>
<para>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.
</para>
<para>Conky has (for some time) been available in the
repositories of most popular distributions. Here are some
installation instructions for a few:
</para>
<para>Gentoo users -- Conky is in Gentoo's Portage...
simply use "emerge app-admin/conky" for
installation.
</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>
<para>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.</para>
<para>Conky has (for some time) been available in the repositories of
most popular distributions. Here are some installation instructions
for a few:</para>
<para>Gentoo users -- Conky is in Gentoo's Portage... simply use
"emerge app-admin/conky" for installation.</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>
<varlistentry>
<term>
@ -131,92 +116,65 @@
</variablelist>
<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
not guaranteed to work with other compilers.
</para>
<para>TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead of
just `cmake'.
</para>
not guaranteed to work with other compilers.</para>
<para>TIP: Try configuring Conky with `ccmake' or `cmake-gui' instead
of just `cmake'.</para>
<para></para>
</refsect1>
<refsect1>
<title>You Should Know</title>
<para>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.
</para>
<para>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.
</para>
<para>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.</para>
<para>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.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>Command line options override configurations defined in
configuration file.
</para>
&command_options;
</refsect1>
configuration file.</para>&command_options;</refsect1>
<refsect1>
<title>Configuration Settings</title>
<para>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).
</para>
<para>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).</para>
<para>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/
</para>
&config_settings;
</refsect1>
http://conky.sf.net/</para>&config_settings;</refsect1>
<refsect1>
<title>Objects/Variables</title>
<para>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).
</para>
<para>
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).
</para>
&variables;
</refsect1>
<para>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).</para>
<para>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).</para>&variables;</refsect1>
<refsect1>
<title>Lua API</title>
<para>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.
</para>
<para>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
tolua++, which currently only compiles against Lua 5.1.</para>
<para>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.
</para>
<para>
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.
</para>
<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
$lua_read, and Lua hooks.</para>
<para>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.</para>
<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
creation of certain structures. These are documented below.
</para>
&lua;
</refsect1>
creation of certain structures. These are documented
below.</para>&lua;</refsect1>
<refsect1>
<title>Examples</title>
<variablelist>
@ -225,26 +183,25 @@
<varname>conky</varname>
<option>-t '${time %D %H:%M}' -o -u 30</option>
</term>
<listitem>Start Conky in its own window with date
and clock as text and 30 sec update
interval.</listitem>
<listitem>Start Conky in its own window with date and clock as
text and 30 sec update interval.</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>conky</varname>
<option>-a top_left -x 5 -y 500 -d</option>
</term>
<listitem>Start Conky to background at coordinates
(5, 500).</listitem>
<listitem>Start Conky to background at coordinates (5,
500).</listitem>
</varlistentry>
<varlistentry>
<term>
<varname>conky</varname>
<option>-C &gt; ~/.config/conky/conky.conf</option>
</term>
<listitem>Do not start Conky, but have it output
the builtin default config file to
~/.config/conky/conky.conf for later customising.</listitem>
<listitem>Do not start Conky, but have it output the builtin
default config file to ~/.config/conky/conky.conf for later
customising.</listitem>
</varlistentry>
</variablelist>
</refsect1>
@ -253,54 +210,46 @@
<variablelist>
<varlistentry>
<term>
<filename>
${sysconfdir}/conky/conky.conf</filename>
<filename>${sysconfdir}/conky/conky.conf</filename>
</term>
<listitem>Default system-wide configuration file.
The value of ${sysconfdir} depends on the
compile-time options (most likely /etc).</listitem>
<listitem>Default system-wide configuration file. The value of
${sysconfdir} depends on the compile-time options (most likely
/etc).</listitem>
</varlistentry>
<varlistentry>
<term>
<filename>~/.config/conky/conky.conf</filename>
</term>
<listitem>Default personal configuration
file.</listitem>
<listitem>Default personal configuration file.</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Bugs</title>
<para>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.</para>
<para>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.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<ulink url="https://github.com/brndnmtthws/conky">
https://github.com/brndnmtthws/conky</ulink>
</para>
<para>https://github.com/brndnmtthws/conky</para>
<para>#conky on irc.freenode.net</para>
</refsect1>
<refsect1>
<title>Copying</title>
<para>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).</para>
<para>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).</para>
</refsect1>
<refsect1>
<title>Authors</title>

116
doc/lua.xml
View File

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

1890
doc/variables.xml
View File

File diff suppressed because it is too large Load Diff