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

2
doc/docs.xml
View File

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

373
doc/lua.xml
View File

@ -1,188 +1,189 @@
<variablelist>
<varlistentry>
<term>
<command>
<option>conky_parse(string)</option>
</command>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_set_update_interval(number)</option>
</command>
<option>function</option>
</term>
<listitem>
<para>
Sets Conky's update interval (in seconds) to 'number'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_window</option>
</command>
<option>table</option>
</term>
<listitem>
<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>
</member>
<member>
<command>visual</command>
<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>
</member>
<member>
<command>width</command>
<option>Window width (in pixels).</option>
</member>
<member>
<command>height</command>
<option>Window height (in pixels).</option>
</member>
<member>
<command>border_inner_margin</command>
<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>
</member>
<member>
<command>border_width</command>
<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>
</member>
<member>
<command>text_start_y</command>
<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>
</member>
<member>
<command>text_height</command>
<option>The height of the text drawing
region.</option>
</member>
</simplelist>
<para>NOTE: This table is only defined when X support
is enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_info</option>
</command>
<option>table</option>
</term>
<listitem>
<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>
</member>
<member>
<command>uptime</command>
<option>System uptime, in seconds.
</option>
</member>
</simplelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_info</option>
</command>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_date</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the build date for this
particular instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_arch</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the build architecture for
this particular instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_version</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the version of the current
instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_config</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the path of the current Conky
configuration file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_parse(string)</option>
</command>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_set_update_interval(number)</option>
</command>
<option>function</option>
</term>
<listitem>
<para>Sets Conky's update interval (in seconds) to
'number'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_window</option>
</command>
<option>table</option>
</term>
<listitem>
<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>
</member>
<member>
<command>visual</command>
<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>
</member>
<member>
<command>width</command>
<option>Window width (in pixels).</option>
</member>
<member>
<command>height</command>
<option>Window height (in pixels).</option>
</member>
<member>
<command>border_inner_margin</command>
<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>
</member>
<member>
<command>border_width</command>
<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>
</member>
<member>
<command>text_start_y</command>
<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>
</member>
<member>
<command>text_height</command>
<option>The height of the text drawing
region.</option>
</member>
</simplelist>
<para>NOTE: This table is only defined when X support
is enabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_info</option>
</command>
<option>table</option>
</term>
<listitem>
<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>
</member>
<member>
<command>uptime</command>
<option>System uptime, in seconds.</option>
</member>
</simplelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_info</option>
</command>
<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>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_date</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the build date for this
particular instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_build_arch</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the build architecture for
this particular instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_version</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the version of the current
instance of Conky.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>conky_config</option>
</command>
<option>string</option>
</term>
<listitem>
<para>A string containing the path of the current Conky
configuration file.</para>
</listitem>
</varlistentry>
</variablelist>

55
doc/variables.xml
View File

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

2
extras/nano/conky.nanorc
View File

@ -5,7 +5,7 @@
syntax "conky" "(\.*conkyrc.*$|conky.conf)"
## 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
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 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
\ above

9
src/conky.c
View File

@ -8175,15 +8175,6 @@ static void load_config_file(const char *f)
CONF("show_graph_range") {
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") {
if (value) {
window.border_inner_margin = strtol(value, 0, 0);