Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-02-03 20:48:31 +00:00
Code Issues Releases Activity

Few misc doc related things.

Browse Source 
Added the (incomplete) check_docs.py, to 'synchronize' the docs with the
code, as well as vim/nano syntax stuff.

Removed some unused OBJ_* stuff from text_objects.h, and updated docs
with some missing things.  Also removed a couple deprecated objects
which were still documented.
This commit is contained in:
Brenden Matthews 2009-05-01 16:20:06 -06:00
parent e05e9ece8e
commit e8e6d1c819
6 changed files with 273 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README
View File

@ -874,6 +874,7 @@ conky(1) conky(1)
omitted, the parameter defaults to 1. omitted, the parameter defaults to 1.
<<<<<<< HEAD:README
freq_dyn (n) freq_dyn (n)
Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐ Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐
lated by counting to clock cycles to complete an instruction. lated by counting to clock cycles to complete an instruction.
@ -886,11 +887,18 @@ conky(1) conky(1)
Only available for x86/amd64. Only available for x86/amd64.
=======
>>>>>>> cb4b914... Few misc doc related things.:README
fs_bar (height),(width) fs fs_bar (height),(width) fs
Bar that shows how much space is used on a file system. height Bar that shows how much space is used on a file system. height
is the height in pixels. fs is any file on that file system. is the height in pixels. fs is any file on that file system.
fs_bar_free (height),(width) fs
Bar that shows how much space is free on a file system. height
is the height in pixels. fs is any file on that file system.
fs_free (fs) fs_free (fs)
Free space on a file system available for users. Free space on a file system available for users.
@ -900,15 +908,19 @@ conky(1) conky(1)
fs_size (fs) fs_size (fs)
File system size File system size.
fs_type (fs) fs_type (fs)
File system type File system type.
fs_used (fs) fs_used (fs)
File system used space File system used space.
fs_used_perc (fs)
Percent of file system used space.
goto x The next element will be printed at position 'x'. goto x The next element will be printed at position 'x'.
@ -1250,11 +1262,15 @@ conky(1) conky(1)
Bar that shows amount of memory in use Bar that shows amount of memory in use
<<<<<<< HEAD:README
memgauge (height),(width) memgauge (height),(width)
Gauge that shows amount of memory in use (see cpugauge) Gauge that shows amount of memory in use (see cpugauge)
memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
=======
memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
>>>>>>> cb4b914... Few misc doc related things.:README
ent colour 2) (scale) ent colour 2) (scale)
Memory usage graph. Uses a logarithmic scale (to see small num‐ Memory usage graph. Uses a logarithmic scale (to see small num‐
bers) when you use "log" instead of "normal". bers) when you use "log" instead of "normal".
@ -1648,11 +1664,18 @@ conky(1) conky(1)
Move text over by N pixels. See also $voffset. Move text over by N pixels. See also $voffset.
<<<<<<< HEAD:README
rss url delay_in_minutes action (num_par (spaces_in_front)) rss url delay_in_minutes action (num_par (spaces_in_front))
Download and parse RSS feeds. Action may be one of the follow‐ Download and parse RSS feeds. Action may be one of the follow‐
ing: feed_title, item_title (with num par), item_desc (with num ing: feed_title, item_title (with num par), item_desc (with num
par) and item_titles (when using this action and spaces_in_front par) and item_titles (when using this action and spaces_in_front
is given conky places that many spaces in front of each item). is given conky places that many spaces in front of each item).
=======
rss url delay_in_minutes action item_num
Download and parse RSS feeds. Action may be one of the follow‐
ing: feed_title, item_title (with num par), item_desc (with num
par) and item_titles.
>>>>>>> cb4b914... Few misc doc related things.:README
tab (width, (start)) tab (width, (start))
@ -1852,14 +1875,6 @@ conky(1) conky(1)
Comment in current XMMS2 song Comment in current XMMS2 song
xmms2_decoder
Decoder plugin used
xmms2_transport
Transport plugin used
xmms2_url xmms2_url
Full path to current song Full path to current song
@ -1892,6 +1907,18 @@ conky(1) conky(1)
Percent of song's progress Percent of song's progress
xmms2_date
Returns song's date.
xmms2_playlist
Returns the XMMS2 playlist.
xmms2_timesplayed
Number of times a song was played (presumably).
xmms2_status xmms2_status
XMMS2 status (Playing, Paused, Stopped, or Disconnected) XMMS2 status (Playing, Paused, Stopped, or Disconnected)
@ -1916,6 +1943,9 @@ conky(1) conky(1)
along with the remaining training time. along with the remaining training time.
endif Ends an $if block.
EXAMPLES EXAMPLES
conky -t '${time %D %H:%M}' -o -u 30 conky -t '${time %D %H:%M}' -o -u 30
Start Conky in its own window with date and clock as text and 30 Start Conky in its own window with date and clock as text and 30

54
check_docs.py Executable file
View File

@ -0,0 +1,54 @@
#!/usr/bin/python
#
# TODO: finish this to update nano/vim syntax files, and also handle config
# settings.
#
import os.path
import re
file_names = dict()
file_names["text_objects"] = "src/text_object.h"
file_names["conky"] = "src/conky.c"
file_names["vim_syntax"] = "extras/vim/syntax/conkyrc.vim"
file_names["nano_syntax"] = "extras/nano/conky.nanorc"
file_names["variables"] = "doc/variables.xml"
file_names["config_settings"] = "doc/config_settings.xml"
for fn in file_names.values():
if not os.path.exists(fn) or not os.path.isfile(fn):
print "'%s' doesn't exist, or isn't a file" % (fn)
exit(0)
objects = []
file = open(file_names["text_objects"], "r")
exp = re.compile("\s*OBJ_(\w*).*")
while file:
line = file.readline()
if len(line) == 0:
break
res = exp.match(line)
if res:
obj = res.group(1)
if not re.match("color\d", obj) and obj != "text":
# ignore colourN stuff
objects.append(res.group(1))
doc_objects = []
exp = re.compile("\s*<command><option>(\w*)</option></command>.*")
file = open(file_names["variables"], "r")
while file:
line = file.readline()
if len(line) == 0:
break
res = exp.match(line)
if res:
doc_objects.append(res.group(1))
if doc_objects[len(doc_objects) - 1] not in objects:
print "'%s' is documented, but doesn't seem to be an object" % (doc_objects[len(doc_objects) - 1])
for obj in objects:
if obj not in doc_objects:
print "'%s' seems to be undocumented" % (obj)

46
doc/conky.1
View File

@ -747,18 +747,14 @@ Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the para
\fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1. Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
.TP
\fB\*(T<\fBfreq_dyn\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
.TP
\fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
.TP .TP
\fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T> \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system. Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
.TP
\fB\*(T<\fBfs_bar_free\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
Bar that shows how much space is free on a file system. height is the height in pixels. fs is any file on that file system.
.TP .TP
\fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
Free space on a file system available for users. Free space on a file system available for users.
@ -769,15 +765,19 @@ Free percentage of space on a file system available for users.
.TP .TP
\fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
File system size File system size.
.TP .TP
\fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> \fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
File system type File system type.
.TP .TP
\fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
File system used space File system used space.
.TP
\fB\*(T<\fBfs_used_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
Percent of file system used space.
.TP .TP
\fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T> \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
@ -1631,14 +1631,6 @@ Genre in current XMMS2 song
\fB\*(T<\fBxmms2_comment\fR\*(T>\fR \fB\*(T<\fBxmms2_comment\fR\*(T>\fR
Comment in current XMMS2 song Comment in current XMMS2 song
.TP
\fB\*(T<\fBxmms2_decoder\fR\*(T>\fR
Decoder plugin used
.TP
\fB\*(T<\fBxmms2_transport\fR\*(T>\fR
Transport plugin used
.TP .TP
\fB\*(T<\fBxmms2_url\fR\*(T>\fR \fB\*(T<\fBxmms2_url\fR\*(T>\fR
Full path to current song Full path to current song
@ -1671,6 +1663,18 @@ Size of current song
\fB\*(T<\fBxmms2_percent\fR\*(T>\fR \fB\*(T<\fBxmms2_percent\fR\*(T>\fR
Percent of song's progress Percent of song's progress
.TP
\fB\*(T<\fBxmms2_date\fR\*(T>\fR
Returns song's date.
.TP
\fB\*(T<\fBxmms2_playlist\fR\*(T>\fR
Returns the XMMS2 playlist.
.TP
\fB\*(T<\fBxmms2_timesplayed\fR\*(T>\fR
Number of times a song was played (presumably).
.TP .TP
\fB\*(T<\fBxmms2_status\fR\*(T>\fR \fB\*(T<\fBxmms2_status\fR\*(T>\fR
XMMS2 status (Playing, Paused, Stopped, or Disconnected) XMMS2 status (Playing, Paused, Stopped, or Disconnected)
@ -1691,6 +1695,10 @@ Display everything between $if_xmms2_connected and the matching $endif if xmms2
\fB\*(T<\fBeve\fR\*(T>\fR \*(T<\fBapi_userid api_key character_id\fR\*(T> \fB\*(T<\fBeve\fR\*(T>\fR \*(T<\fBapi_userid api_key character_id\fR\*(T>
Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time. Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
.TP
\fB\*(T<\fBendif\fR\*(T>\fR
Ends an $if block.
.SH EXAMPLES .SH EXAMPLES
.TP .TP
\*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T> \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>

101
doc/variables.xml
View File

@ -735,26 +735,6 @@
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<command><option>freq_dyn</option></command>
<option>(n)</option>
</term>
<listitem>
Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>freq_dyn_g</option></command>
<option>(n)</option>
</term>
<listitem>
Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
<para></para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command><option>fs_bar</option></command> <command><option>fs_bar</option></command>
@ -765,6 +745,16 @@
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<command><option>fs_bar_free</option></command>
<option>(height),(width) fs</option>
</term>
<listitem>
Bar that shows how much space is free on a file system. height is the height in pixels. fs is any file on that file system.
<para></para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command><option>fs_free</option></command> <command><option>fs_free</option></command>
@ -791,7 +781,7 @@
<option>(fs)</option> <option>(fs)</option>
</term> </term>
<listitem> <listitem>
File system size File system size.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -801,7 +791,7 @@
<option>(fs)</option> <option>(fs)</option>
</term> </term>
<listitem> <listitem>
File system type File system type.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -811,7 +801,17 @@
<option>(fs)</option> <option>(fs)</option>
</term> </term>
<listitem> <listitem>
File system used space File system used space.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>fs_used_perc</option></command>
<option>(fs)</option>
</term>
<listitem>
Percent of file system used space.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -2607,24 +2607,6 @@
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<command><option>xmms2_decoder</option></command>
</term>
<listitem>
Decoder plugin used
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>xmms2_transport</option></command>
</term>
<listitem>
Transport plugin used
<para></para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command><option>xmms2_url</option></command> <command><option>xmms2_url</option></command>
@ -2697,6 +2679,33 @@
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<command><option>xmms2_date</option></command>
</term>
<listitem>
Returns song's date.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>xmms2_playlist</option></command>
</term>
<listitem>
Returns the XMMS2 playlist.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command><option>xmms2_timesplayed</option></command>
</term>
<listitem>
Number of times a song was played (presumably).
<para></para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<command><option>xmms2_status</option></command> <command><option>xmms2_status</option></command>
@ -2743,4 +2752,14 @@
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>
<command><option>endif</option></command>
<option></option>
</term>
<listitem>
Ends an $if block.
<para></para></listitem>
</varlistentry>
</variablelist> </variablelist>

19
src/conky.c
View File

@ -667,9 +667,6 @@ static void free_text_objects(struct text_object *root)
case OBJ_trashed_mails: case OBJ_trashed_mails:
free(data.local_mail.box); free(data.local_mail.box);
break; break;
case OBJ_imap:
free(info.mail);
break;
case OBJ_imap_unseen: case OBJ_imap_unseen:
if (!obj->global_mode) { if (!obj->global_mode) {
free(data.mail); free(data.mail);
@ -680,9 +677,6 @@ static void free_text_objects(struct text_object *root)
free(data.mail); free(data.mail);
} }
break; break;
case OBJ_pop3:
free(info.mail);
break;
case OBJ_pop3_unseen: case OBJ_pop3_unseen:
if (!obj->global_mode) { if (!obj->global_mode) {
free(data.mail); free(data.mail);
@ -932,9 +926,6 @@ static void free_text_objects(struct text_object *root)
case OBJ_mpd_vol: case OBJ_mpd_vol:
case OBJ_mpd_bitrate: case OBJ_mpd_bitrate:
case OBJ_mpd_status: case OBJ_mpd_status:
case OBJ_mpd_host:
case OBJ_mpd_port:
case OBJ_mpd_password:
case OBJ_mpd_bar: case OBJ_mpd_bar:
case OBJ_mpd_elapsed: case OBJ_mpd_elapsed:
case OBJ_mpd_length: case OBJ_mpd_length:
@ -2147,16 +2138,6 @@ static struct text_object *construct_text_object(const char *s,
END OBJ(swapbar, INFO_MEM) END OBJ(swapbar, INFO_MEM)
scan_bar(arg, &obj->data.pair.a, &obj->data.pair.b); scan_bar(arg, &obj->data.pair.a, &obj->data.pair.b);
END OBJ(sysname, 0) END OBJ(sysname, 0)
#ifdef __linux__
END OBJ(temp1, INFO_SYSFS)
obj->type = OBJ_i2c;
obj->data.sysfs.fd = open_i2c_sensor(0, "temp", 1,
&obj->data.sysfs.arg, obj->data.sysfs.devtype);
END OBJ(temp2, INFO_SYSFS)
obj->type = OBJ_i2c;
obj->data.sysfs.fd = open_i2c_sensor(0, "temp", 2,
&obj->data.sysfs.arg, obj->data.sysfs.devtype);
#endif
END OBJ(time, 0) END OBJ(time, 0)
obj->data.s = strndup(arg ? arg : "%F %T", text_buffer_size); obj->data.s = strndup(arg ? arg : "%F %T", text_buffer_size);
END OBJ(utime, 0) END OBJ(utime, 0)

10
src/text_object.h
View File

@ -205,8 +205,6 @@ enum text_object_type {
OBJ_memgraph, OBJ_memgraph,
OBJ_memmax, OBJ_memmax,
OBJ_memperc, OBJ_memperc,
OBJ_mem_res,
OBJ_mem_vsize,
OBJ_mixer, OBJ_mixer,
OBJ_mixerl, OBJ_mixerl,
OBJ_mixerr, OBJ_mixerr,
@ -232,8 +230,6 @@ enum text_object_type {
OBJ_swapmax, OBJ_swapmax,
OBJ_swapperc, OBJ_swapperc,
OBJ_sysname, OBJ_sysname,
OBJ_temp1, /* i2c is used instead in these */
OBJ_temp2,
OBJ_text, OBJ_text,
OBJ_time, OBJ_time,
OBJ_utime, OBJ_utime,
@ -250,10 +246,8 @@ enum text_object_type {
OBJ_user_terms, OBJ_user_terms,
OBJ_user_times, OBJ_user_times,
OBJ_user_number, OBJ_user_number,
OBJ_imap,
OBJ_imap_messages, OBJ_imap_messages,
OBJ_imap_unseen, OBJ_imap_unseen,
OBJ_pop3,
OBJ_pop3_unseen, OBJ_pop3_unseen,
OBJ_pop3_used, OBJ_pop3_used,
#if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \ #if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \
@ -278,9 +272,6 @@ enum text_object_type {
OBJ_mpd_vol, OBJ_mpd_vol,
OBJ_mpd_bitrate, OBJ_mpd_bitrate,
OBJ_mpd_status, OBJ_mpd_status,
OBJ_mpd_host,
OBJ_mpd_port,
OBJ_mpd_password,
OBJ_mpd_bar, OBJ_mpd_bar,
OBJ_mpd_elapsed, OBJ_mpd_elapsed,
OBJ_mpd_length, OBJ_mpd_length,
@ -304,7 +295,6 @@ enum text_object_type {
OBJ_moc_bitrate, OBJ_moc_bitrate,
OBJ_moc_rate, OBJ_moc_rate,
#endif #endif
OBJ_music_player_interval,
#ifdef XMMS2 #ifdef XMMS2
OBJ_xmms2_artist, OBJ_xmms2_artist,
OBJ_xmms2_album, OBJ_xmms2_album,