<listitem>After this begins text to be formatted on screen.
Backslash (\) escapes newlines in the text section. This
can be useful for cleaning up config files where conky is
- used to pipe input to dzen2.
+ used to pipe input to dzen2.
<para /></listitem>
</varlistentry>
<varlistentry>
delta} then you have to write the following: alias alpha
beta gamma delta . PS: Instead of creating an alias in the
config you can also use environment variables. Example:
- Start conky like this: alpha="beta gamma delta" conky
+ Start conky like this: alpha="beta gamma delta" conky
<para /></listitem>
</varlistentry>
<varlistentry>
top_right, top_middle, bottom_left, bottom_right,
bottom_middle, middle_left, middle_right, or none (also can
be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also
- gap_x and gap_y.
+ gap_x and gap_y.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>append_file</option>
</command>
</term>
- <listitem>Append the file given as argument.
+ <listitem>Append the file given as argument.
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Boolean value, if true, Conky will be forked to
- background when started.
+ background when started.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
- <option>border_margin</option>
+ <option>border_inner_margin</option>
</command>
</term>
- <listitem>Border margin in pixels.
+ <listitem>Inner border margin in pixels (the margin between
+ the border and text).
+ <para /></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>border_outer_margin</option>
+ </command>
+ </term>
+ <listitem>Outer border margin in pixels (the margin between
+ the border and the edge of the window).
<para /></listitem>
</varlistentry>
<varlistentry>
<option>border_width</option>
</command>
</term>
- <listitem>Border width in pixels.
+ <listitem>Border width in pixels.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Predefine a color for use inside TEXT segments.
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>
</command>
</term>
<listitem>The number of samples to average for CPU
- monitoring.
+ monitoring.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Specify a default width and height for bars.
Example: 'default_bar_size 0 6'. This is particularly
useful for execbar and execibar as they do not take size
- arguments.
+ arguments.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>default_color</option>
</command>
</term>
- <listitem>Default color and border color
+ <listitem>Default color and border color
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Specify a default width and height for gauges.
Example: 'default_gauge_size 25 25'. This is particularly
useful for execgauge and execigauge as they do not take
- size arguments
+ size arguments
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Specify a default width and height for graphs.
Example: 'default_graph_size 0 25'. This is particularly
useful for execgraph and execigraph as they do not take
- size arguments
+ size arguments
<para /></listitem>
</varlistentry>
<varlistentry>
<option>default_outline_color</option>
</command>
</term>
- <listitem>Default outline color
+ <listitem>Default outline color
<para /></listitem>
</varlistentry>
<varlistentry>
<option>default_shade_color</option>
</command>
</term>
- <listitem>Default shading color and border's shading color
+ <listitem>Default shading color and border's shading color
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>The number of samples to average for disk I/O
- monitoring.
+ monitoring.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>display</option>
</command>
</term>
- <listitem>Specify an X display to connect to.
+ <listitem>Specify an X display to connect to.
<para /></listitem>
</varlistentry>
<varlistentry>
</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.
+ double buffer won't be so big.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>draw_borders</option>
</command>
</term>
- <listitem>Draw borders around text?
+ <listitem>Draw borders around text?
<para /></listitem>
</varlistentry>
<varlistentry>
<option>draw_graph_borders</option>
</command>
</term>
- <listitem>Draw borders around graphs?
+ <listitem>Draw borders around graphs?
<para /></listitem>
</varlistentry>
<varlistentry>
<option>draw_outline</option>
</command>
</term>
- <listitem>Draw outlines?
+ <listitem>Draw outlines?
<para /></listitem>
</varlistentry>
<varlistentry>
<option>draw_shades</option>
</command>
</term>
- <listitem>Draw shades?
+ <listitem>Draw shades?
+ <para /></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <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.
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Font name in X, xfontsel can be used to get a
- nice font
+ nice font
+ <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.
<para /></listitem>
</varlistentry>
<varlistentry>
</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'.
+ For other position related stuff, see 'alignment'.
<para /></listitem>
</varlistentry>
<varlistentry>
</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'.
+ For other position related stuff, see 'alignment'.
<para /></listitem>
</varlistentry>
<varlistentry>
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.
+ IP address.
<para /></listitem>
</varlistentry>
<varlistentry>
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.
+ the password when Conky starts.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>imlib_cache_flush_interval</option>
</command>
</term>
- <listitem>Interval (in seconds) to flush Imlib2 cache.
+ <listitem>Interval (in seconds) to flush Imlib2 cache.
<para /></listitem>
</varlistentry>
<varlistentry>
</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.
+ to disable the image cache.
<para /></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
+ <option>lua_draw_hook_post</option>
+ </command>
+ <option>function_name [function arguments]</option>
+ </term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>lua_draw_hook_pre</option>
+ </command>
+ <option>function_name [function arguments]</option>
+ </term>
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
<option>lua_load</option>
</command>
</term>
- <listitem>Loads the Lua scripts separated by spaces.
+ <listitem>Loads the Lua scripts separated by spaces.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>mail_spool</option>
</command>
</term>
- <listitem>Mail spool for mail checking
+ <listitem>Mail spool for mail checking
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Allow each port monitor to track at most this
- many connections (if 0 or not set, default is 256)
+ many connections (if 0 or not set, default is 256)
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Maximum number of special things, e.g. fonts,
- offsets, aligns, etc. (default is 512)
+ offsets, aligns, etc. (default is 512)
<para /></listitem>
</varlistentry>
<varlistentry>
<option>bytes</option>
</term>
<listitem>Maximum size of user text buffer, i.e. layout
- below TEXT line in config file (default is 16384 bytes)
+ below TEXT line in config file (default is 16384 bytes)
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
<option>pixels</option>
</term>
- <listitem>Maximum width of window
+ <listitem>Maximum width of window
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
<option>width (height)</option>
</term>
- <listitem>Minimum size of window
+ <listitem>Minimum size of window
<para /></listitem>
</varlistentry>
<varlistentry>
<option>mpd_host</option>
</command>
</term>
- <listitem>Host of MPD server
+ <listitem>Host of MPD server
<para /></listitem>
</varlistentry>
<varlistentry>
<option>mpd_password</option>
</command>
</term>
- <listitem>MPD server password
+ <listitem>MPD server password
<para /></listitem>
</varlistentry>
<varlistentry>
<option>mpd_port</option>
</command>
</term>
- <listitem>Port of MPD server
+ <listitem>Port of MPD server
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Music player thread update interval (defaults to
- Conky's update interval)
+ Conky's update interval)
<para /></listitem>
</varlistentry>
<varlistentry>
<option>net_avg_samples</option>
</command>
</term>
- <listitem>The number of samples to average for net data
+ <listitem>The number of samples to average for net data
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Substract (file system) buffers from used memory?
-
+
<para /></listitem>
</varlistentry>
<varlistentry>
<option>out_to_console</option>
</command>
</term>
- <listitem>Print text to stdout.
+ <listitem>Print text to stdout.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>out_to_stderr</option>
</command>
</term>
- <listitem>Print text to stderr.
+ <listitem>Print text to stderr.
<para /></listitem>
</varlistentry>
<varlistentry>
(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
+ configfile to be sure). Default value is yes
<para /></listitem>
</varlistentry>
<varlistentry>
<option>override_utf8_locale</option>
</command>
</term>
- <listitem>Force UTF8? requires XFT
+ <listitem>Force UTF8? requires XFT
<para /></listitem>
</varlistentry>
<varlistentry>
<option>overwrite_file</option>
</command>
</term>
- <listitem>Overwrite the file given as argument.
+ <listitem>Overwrite the file given as argument.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>own_window</option>
</command>
</term>
- <listitem>Boolean, create own window to draw?
+ <listitem>Boolean, create own window to draw?
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Manually set the WM_CLASS name. Defaults to
- "Conky".
+ "Conky".
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>If own_window_transparent no, set a specified
background colour (defaults to black). Takes either a hex
value (#ffffff) or a valid RGB name (see
- /usr/lib/X11/rgb.txt)
+ /usr/lib/X11/rgb.txt)
<para /></listitem>
</varlistentry>
<varlistentry>
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.
+ ignored.
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Manually set the window name. Defaults to
- "<hostname> - conky".
+ "<hostname> - conky".
<para /></listitem>
</varlistentry>
<varlistentry>
<option>own_window_transparent</option>
</command>
</term>
- <listitem>Boolean, set pseudo-transparency?
+ <listitem>Boolean, set pseudo-transparency?
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>if own_window is yes, you may specify type
- normal, desktop, dock or override (default: normal).
+ 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. Override windows are not under the control of
- the window manager. Hints are ignored. This type of window
- can be useful for certain situations.
+ 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>
</command>
</term>
<listitem>Pad percentages to this many decimals (0 = no
- padding)
+ padding)
<para /></listitem>
</varlistentry>
<varlistentry>
[-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.
+ to enter the password when Conky starts.
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Shortens units to a single character (kiB->k,
- GiB->G, etc.). Default is off.
+ GiB->G, etc.). Default is off.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>show_graph_range</option>
</command>
</term>
- <listitem>Shows the time range covered by a graph.
+ <listitem>Shows the time range covered by a graph.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>show_graph_scale</option>
</command>
</term>
- <listitem>Shows the maximum value in scaled graphs.
+ <listitem>Shows the maximum value in scaled graphs.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>stippled_borders</option>
</command>
</term>
- <listitem>Border stippling (dashing) in pixels
+ <listitem>Border stippling (dashing) in pixels
<para /></listitem>
</varlistentry>
<varlistentry>
</term>
<listitem>Desired output unit of all objects displaying a
temperature. Parameters are either "fahrenheit" or
- "celsius". The default unit is degree Celsius.
+ "celsius". The default unit is degree Celsius.
<para /></listitem>
</varlistentry>
<varlistentry>
segments. Substitute N by a digit between 0 and 9,
inclusively. The value of the variable is being inserted
into the stuff below TEXT at the corresponding position,
- but before some substitutions are applied:
+ but before some substitutions are applied:
<simplelist>
<member>'\n' -> newline</member>
<member>'\\' -> backslash</member>
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.
+ cannot be smaller than the default value of 256 bytes.
<para /></listitem>
</varlistentry>
<varlistentry>
</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.
+ of all processors' power combined.
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Width for $top name value (defaults to 15
- characters).
+ characters).
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Total number of times for Conky to update before
- quitting. Zero makes Conky run forever
+ quitting. Zero makes Conky run forever
<para /></listitem>
</varlistentry>
<varlistentry>
<command>
<option>update_interval</option>
</command>
+ <option>seconds</option>
+ </term>
+ <listitem>Update interval
+ <para /></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>update_interval_on_battery</option>
+ </command>
+ <option>seconds</option>
</term>
- <listitem>Update interval in seconds
+ <listitem>Update interval when running on batterypower
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Boolean value, if true, text is rendered in upper
- case
+ case
<para /></listitem>
</varlistentry>
<varlistentry>
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.
+ Bitstream Vera Sans Mono.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>use_xft</option>
</command>
</term>
- <listitem>Use Xft (anti-aliased font and stuff)
+ <listitem>Use Xft (anti-aliased font and stuff)
<para /></listitem>
</varlistentry>
<varlistentry>
</command>
</term>
<listitem>Alpha of Xft font. Must be a value at or between
- 1 and 0.
+ 1 and 0.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>xftfont</option>
</command>
</term>
- <listitem>Xft font to use.
+ <listitem>Xft font to use.
<para /></listitem>
</varlistentry>
</variablelist>
projects / monky / blobdiff