Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-02-02 12:08:33 +00:00
Code Issues Releases Activity

Remove deprecated stuff from docs and conky.c (for 1.7.3).

Browse Source
This commit is contained in:
Brenden Matthews 2009-07-28 12:43:45 -06:00
parent da4b542ae6
commit ec517ecb26
7 changed files with 215 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/config_settings.xml
View File

@ -775,7 +775,7 @@
</command> </command>
<option>seconds</option> <option>seconds</option>
</term> </term>
<listitem>Update interval <listitem>Update interval
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -785,7 +785,7 @@
</command> </command>
<option>seconds</option> <option>seconds</option>
</term> </term>
<listitem>Update interval when running on batterypower <listitem>Update interval when running on batterypower
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

2
doc/docs.xml
View File

@ -16,7 +16,7 @@
<firstname>Brenden</firstname> <firstname>Brenden</firstname>
<surname>Matthews</surname> <surname>Matthews</surname>
</author> </author>
<date>2009-07-20</date> <date>2009-07-28</date>
</refentryinfo> </refentryinfo>
<refmeta> <refmeta>
<refentrytitle>conky</refentrytitle> <refentrytitle>conky</refentrytitle>

373
doc/lua.xml
View File

@ -1,188 +1,189 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<command> <command>
<option>conky_parse(string)</option> <option>conky_parse(string)</option>
</command> </command>
<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 Conky's TEXT section, and then returns a string per Conky's TEXT section, and then returns a string
with the result.</para> with the result.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command> <command>
<option>conky_set_update_interval(number)</option> <option>conky_set_update_interval(number)</option>
</command> </command>
<option>function</option> <option>function</option>
</term> </term>
<listitem> <listitem>
<para> <para>Sets Conky's update interval (in seconds) to
Sets Conky's update interval (in seconds) to 'number'. 'number'.</para>
</para> </listitem>
</listitem> </varlistentry>
</varlistentry> <varlistentry>
<varlistentry> <term>
<term> <command>
<command> <option>conky_window</option>
<option>conky_window</option> </command>
</command> <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. The following table describes the
Conky's window. 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 requires Lua extras enabled at compile
Drawable), requires Lua 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 Lua extras enabled at compile time.</option> <option>Window's visual (Xlib Visual), requires
</member> Lua extras enabled at compile time.</option>
<member> </member>
<command>display</command> <member>
<option>Window's display (Xlib <command>display</command>
Display), requires Lua extras enabled at compile time.</option> <option>Window's display (Xlib Display),
</member> requires Lua extras enabled at compile
<member> time.</option>
<command>width</command> </member>
<option>Window width (in pixels).</option> <member>
</member> <command>width</command>
<member> <option>Window width (in pixels).</option>
<command>height</command> </member>
<option>Window height (in pixels).</option> <member>
</member> <command>height</command>
<member> <option>Window height (in pixels).</option>
<command>border_inner_margin</command> </member>
<option>Window's inner border margin (in <member>
pixels).</option> <command>border_inner_margin</command>
</member> <option>Window's inner border margin (in
<member> pixels).</option>
<command>border_outer_margin</command> </member>
<option>Window's outer border margin (in <member>
pixels).</option> <command>border_outer_margin</command>
</member> <option>Window's outer border margin (in
<member> pixels).</option>
<command>border_width</command> </member>
<option>Window's border width (in <member>
pixels).</option> <command>border_width</command>
</member> <option>Window's border width (in
<member> pixels).</option>
<command>text_start_x</command> </member>
<option>The x component of the starting <member>
coordinate of text drawing.</option> <command>text_start_x</command>
</member> <option>The x component of the starting
<member> coordinate of text drawing.</option>
<command>text_start_y</command> </member>
<option>The y component of the starting <member>
coordinate of text drawing.</option> <command>text_start_y</command>
</member> <option>The y component of the starting
<member> coordinate of text drawing.</option>
<command>text_width</command> </member>
<option>The width of the text drawing <member>
region.</option> <command>text_width</command>
</member> <option>The width of the text drawing
<member> region.</option>
<command>text_height</command> </member>
<option>The height of the text drawing <member>
region.</option> <command>text_height</command>
</member> <option>The height of the text drawing
</simplelist> region.</option>
<para>NOTE: This table is only defined when X support </member>
is enabled.</para> </simplelist>
</listitem> <para>NOTE: This table is only defined when X support
</varlistentry> is enabled.</para>
<varlistentry> </listitem>
<term> </varlistentry>
<command> <varlistentry>
<option>conky_info</option> <term>
</command> <command>
<option>table</option> <option>conky_info</option>
</term> </command>
<listitem> <option>table</option>
<para>This table contains some information about </term>
Conky's internal data. The following table describes the <listitem>
values contained:</para> <para>This table contains some information about
<simplelist> Conky's internal data. The following table describes
<member> the values contained:</para>
<command>update_interval</command> <simplelist>
<option>Conky's update interval (in seconds). <member>
</option> <command>update_interval</command>
</member> <option>Conky's update interval (in
<member> seconds).</option>
<command>uptime</command> </member>
<option>System uptime, in seconds. <member>
</option> <command>uptime</command>
</member> <option>System uptime, in seconds.</option>
</simplelist> </member>
</listitem> </simplelist>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term> <varlistentry>
<command> <term>
<option>conky_build_info</option> <command>
</command> <option>conky_build_info</option>
<option>string</option> </command>
</term> <option>string</option>
<listitem> </term>
<para>A string containing the build info for this <listitem>
particular instance of Conky, including the version, <para>A string containing the build info for this
build date, and architecture.</para> particular instance of Conky, including the version,
</listitem> build date, and architecture.</para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term> <varlistentry>
<command> <term>
<option>conky_build_date</option> <command>
</command> <option>conky_build_date</option>
<option>string</option> </command>
</term> <option>string</option>
<listitem> </term>
<para>A string containing the build date for this <listitem>
particular instance of Conky.</para> <para>A string containing the build date for this
</listitem> particular instance of Conky.</para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term> <varlistentry>
<command> <term>
<option>conky_build_arch</option> <command>
</command> <option>conky_build_arch</option>
<option>string</option> </command>
</term> <option>string</option>
<listitem> </term>
<para>A string containing the build architecture for <listitem>
this particular instance of Conky.</para> <para>A string containing the build architecture for
</listitem> this particular instance of Conky.</para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term> <varlistentry>
<command> <term>
<option>conky_version</option> <command>
</command> <option>conky_version</option>
<option>string</option> </command>
</term> <option>string</option>
<listitem> </term>
<para>A string containing the version of the current <listitem>
instance of Conky.</para> <para>A string containing the version of the current
</listitem> instance of Conky.</para>
</varlistentry> </listitem>
<varlistentry> </varlistentry>
<term> <varlistentry>
<command> <term>
<option>conky_config</option> <command>
</command> <option>conky_config</option>
<option>string</option> </command>
</term> <option>string</option>
<listitem> </term>
<para>A string containing the path of the current Conky <listitem>
configuration file.</para> <para>A string containing the path of the current Conky
</listitem> configuration file.</para>
</varlistentry> </listitem>
</varlistentry>
</variablelist> </variablelist>

55
doc/variables.xml
View File

@ -1264,9 +1264,9 @@
<option>logfile lines (next_check)</option> <option>logfile lines (next_check)</option>
</term> </term>
<listitem>Displays first N lines of supplied text file. The <listitem>Displays first N lines of supplied text file. The
file is checked every 'next_check' update. If next_check file is checked every 'next_check' update. If next_check is
is not supplied, Conky defaults to 2. Max of 30 lines can be not supplied, Conky defaults to 2. Max of 30 lines can be
displayed, or until the text buffer is filled. displayed, or until the text buffer is filled.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1797,9 +1797,10 @@
</term> </term>
<listitem>Executes a Lua function with given parameters, <listitem>Executes a Lua function with given parameters,
then prints the returned string. See also 'lua_load' on how then prints the returned string. See also 'lua_load' on how
to load scripts. Conky puts 'conky_' in front of function_name to load scripts. Conky puts 'conky_' in front of
to prevent accidental calls to the wrong function unless you function_name to prevent accidental calls to the wrong
put you place 'conky_' in front of it yourself. function unless you put you place 'conky_' in front of it
yourself.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1812,10 +1813,10 @@
</term> </term>
<listitem>Executes a Lua function with given parameters and <listitem>Executes a Lua function with given parameters and
draws a bar. Expects result value to be an integer between draws a bar. Expects result value to be an integer between
0 and 100. See also 'lua_load' on how to load scripts. 0 and 100. See also 'lua_load' on how to load scripts.
Conky puts 'conky_' in front of function_name to prevent Conky puts 'conky_' in front of function_name to prevent
accidental calls to the wrong function unless you accidental calls to the wrong function unless you put you
put you place 'conky_' in front of it yourself. place 'conky_' in front of it yourself.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1829,9 +1830,9 @@
<listitem>Executes a Lua function with given parameters and <listitem>Executes a Lua function with given parameters and
draws a gauge. Expects result value to be an integer draws a gauge. Expects result value to be an integer
between 0 and 100. See also 'lua_load' on how to load between 0 and 100. See also 'lua_load' on how to load
scripts. Conky puts 'conky_' in front of function_name scripts. Conky puts 'conky_' in front of function_name to
to prevent accidental calls to the wrong function unless you prevent accidental calls to the wrong function unless you
put you place 'conky_' in front of it yourself. put you place 'conky_' in front of it yourself.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1848,9 +1849,9 @@
load scripts. Takes the switch '-t' to use a temperature load scripts. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and on the amplitude of a particular graph value (try it and
see). Conky puts 'conky_' in front of function_name see). Conky puts 'conky_' in front of function_name to
to prevent accidental calls to the wrong function unless you prevent accidental calls to the wrong function unless you
put you place 'conky_' in front of it yourself. put you place 'conky_' in front of it yourself.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1863,20 +1864,10 @@
<listitem>Executes a Lua function with given parameters as <listitem>Executes a Lua function with given parameters as
per $lua, then parses and prints the result value as per per $lua, then parses and prints the result value as per
the syntax for Conky's TEXT section. See also 'lua_load' on the syntax for Conky's TEXT section. See also 'lua_load' on
how to load scripts. Conky puts 'conky_' in front of function_name how to load scripts. Conky puts 'conky_' in front of
to prevent accidental calls to the wrong function unless you function_name to prevent accidental calls to the wrong
put you place 'conky_' in front of it yourself. function unless you put you place 'conky_' in front of it
<para /></listitem> yourself.
</varlistentry>
<varlistentry>
<term>
<command>
<option>lua_read_parse</option>
</command>
<option />
</term>
<listitem>This function is deprecated. Please use the
conky_parse() Lua function instead.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -2808,9 +2799,9 @@
<option>logfile lines (next_check)</option> <option>logfile lines (next_check)</option>
</term> </term>
<listitem>Displays last N lines of supplied text file. The <listitem>Displays last N lines of supplied text file. The
file is checked every 'next_check' update. If next_check file is checked every 'next_check' update. If next_check is
is not supplied, Conky defaults to 2. Max of 30 lines can be not supplied, Conky defaults to 2. Max of 30 lines can be
displayed, or until the text buffer is filled. displayed, or until the text buffer is filled.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

2
extras/nano/conky.nanorc
View File

@ -5,7 +5,7 @@
syntax "conky" "(\.*conkyrc.*$|conky.conf)" syntax "conky" "(\.*conkyrc.*$|conky.conf)"
## Configuration items ## Configuration items
color green "\<(alias|alignment|append_file|background|border_inner_margin|border_margin|border_outer_margin|border_width|color0|color1|color2|color3|color4|color5|color6|color7|color8|color9|colorN|cpu_avg_samples|default_bar_size|default_color|default_gauge_size|default_graph_size|default_outline_color|default_shade_color|diskio_avg_samples|display|double_buffer|draw_borders|draw_graph_borders|draw_outline|draw_shades|extra_newline|font|format_human_readable|gap_x|gap_y|if_up_strictness|imap|imlib_cache_flush_interval|imlib_cache_size|lua_draw_hook_post|lua_draw_hook_pre|lua_load|mail_spool|max_port_monitor_connections|max_specials|max_user_text|maximum_width|minimum_size|mpd_host|mpd_password|mpd_port|music_player_interval|net_avg_samples|no_buffers|out_to_console|out_to_stderr|out_to_x|override_utf8_locale|overwrite_file|own_window|own_window_class|own_window_colour|own_window_hints|own_window_title|own_window_transparent|own_window_type|pad_percents|pop3|sensor_device|short_units|show_graph_range|show_graph_scale|stippled_borders|temperature_unit|template|template0|template1|template2|template3|template4|template5|template6|template7|template8|template9|text|text_buffer_size|top_cpu_separate|top_name_width|total_run_times|update_interval|uppercase|use_spacer|use_xft|xftalpha|xftfont)\>" color green "\<(alias|alignment|append_file|background|border_inner_margin|border_outer_margin|border_width|color0|color1|color2|color3|color4|color5|color6|color7|color8|color9|colorN|cpu_avg_samples|default_bar_size|default_color|default_gauge_size|default_graph_size|default_outline_color|default_shade_color|diskio_avg_samples|display|double_buffer|draw_borders|draw_graph_borders|draw_outline|draw_shades|extra_newline|font|format_human_readable|gap_x|gap_y|if_up_strictness|imap|imlib_cache_flush_interval|imlib_cache_size|lua_draw_hook_post|lua_draw_hook_pre|lua_load|mail_spool|max_port_monitor_connections|max_specials|max_user_text|maximum_width|minimum_size|mpd_host|mpd_password|mpd_port|music_player_interval|net_avg_samples|no_buffers|out_to_console|out_to_stderr|out_to_x|override_utf8_locale|overwrite_file|own_window|own_window_class|own_window_colour|own_window_hints|own_window_title|own_window_transparent|own_window_type|pad_percents|pop3|sensor_device|short_units|show_graph_range|show_graph_scale|stippled_borders|temperature_unit|template|template0|template1|template2|template3|template4|template5|template6|template7|template8|template9|text|text_buffer_size|top_cpu_separate|top_name_width|total_run_times|update_interval|update_interval_on_battery|uppercase|use_spacer|use_xft|xftalpha|xftfont)\>"
## Configuration item constants ## Configuration item constants
color yellow "\<(above|below|bottom_left|bottom_right|bottom_middle|desktop|dock|no|none|normal|override|skip_pager|skip_taskbar|sticky|top_left|top_right|top_middle|middle_left|middle_right|undecorated|yes)\>" color yellow "\<(above|below|bottom_left|bottom_right|bottom_middle|desktop|dock|no|none|normal|override|skip_pager|skip_taskbar|sticky|top_left|top_right|top_middle|middle_left|middle_right|undecorated|yes)\>"

2
extras/vim/syntax/conkyrc.vim
View File

@ -12,7 +12,7 @@ endif
syn region ConkyrcComment start=/^\s*#/ end=/$/ syn region ConkyrcComment start=/^\s*#/ end=/$/
syn keyword ConkyrcSetting alias alignment append_file background border_inner_margin border_margin border_outer_margin border_width color0 color1 color2 color3 color4 color5 color6 color7 color8 color9 colorN cpu_avg_samples default_bar_size default_color default_gauge_size default_graph_size default_outline_color default_shade_color diskio_avg_samples display double_buffer draw_borders draw_graph_borders draw_outline draw_shades extra_newline font format_human_readable gap_x gap_y if_up_strictness imap imlib_cache_flush_interval imlib_cache_size lua_draw_hook_post lua_draw_hook_pre lua_load mail_spool max_port_monitor_connections max_specials max_user_text maximum_width minimum_size mpd_host mpd_password mpd_port music_player_interval net_avg_samples no_buffers out_to_console out_to_stderr out_to_x override_utf8_locale overwrite_file own_window own_window_class own_window_colour own_window_hints own_window_title own_window_transparent own_window_type pad_percents pop3 sensor_device short_units show_graph_range show_graph_scale stippled_borders temperature_unit template template0 template1 template2 template3 template4 template5 template6 template7 template8 template9 text text_buffer_size top_cpu_separate top_name_width total_run_times update_interval uppercase use_spacer use_xft xftalpha xftfont syn keyword ConkyrcSetting alias alignment append_file background border_inner_margin border_outer_margin border_width color0 color1 color2 color3 color4 color5 color6 color7 color8 color9 colorN cpu_avg_samples default_bar_size default_color default_gauge_size default_graph_size default_outline_color default_shade_color diskio_avg_samples display double_buffer draw_borders draw_graph_borders draw_outline draw_shades extra_newline font format_human_readable gap_x gap_y if_up_strictness imap imlib_cache_flush_interval imlib_cache_size lua_draw_hook_post lua_draw_hook_pre lua_load mail_spool max_port_monitor_connections max_specials max_user_text maximum_width minimum_size mpd_host mpd_password mpd_port music_player_interval net_avg_samples no_buffers out_to_console out_to_stderr out_to_x override_utf8_locale overwrite_file own_window own_window_class own_window_colour own_window_hints own_window_title own_window_transparent own_window_type pad_percents pop3 sensor_device short_units show_graph_range show_graph_scale stippled_borders temperature_unit template template0 template1 template2 template3 template4 template5 template6 template7 template8 template9 text text_buffer_size top_cpu_separate top_name_width total_run_times update_interval update_interval_on_battery uppercase use_spacer use_xft xftalpha xftfont
syn keyword ConkyrcConstant syn keyword ConkyrcConstant
\ above \ above

9
src/conky.c
View File

@ -8175,15 +8175,6 @@ static void load_config_file(const char *f)
CONF("show_graph_range") { CONF("show_graph_range") {
show_graph_range = string_to_bool(value); show_graph_range = string_to_bool(value);
} }
CONF("border_margin") {
ERR("border_margin is deprecated, please use window.border_inner_margin instead");
if (value) {
window.border_inner_margin = strtol(value, 0, 0);
if (window.border_inner_margin < 0) window.border_inner_margin = 0;
} else {
CONF_ERR;
}
}
CONF("border_inner_margin") { CONF("border_inner_margin") {
if (value) { if (value) {
window.border_inner_margin = strtol(value, 0, 0); window.border_inner_margin = strtol(value, 0, 0);