Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-01-27 00:58:36 +00:00
Code Issues Releases Activity

docs

Browse Source 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@1097 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2008-04-01 21:37:49 +00:00
parent c6c02f6cf9
commit 011f03b50d
6 changed files with 266 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README
View File

@ -10,16 +10,26 @@ SYNOPSIS
conky [options] conky [options]
DESCRIPTION DESCRIPTION
Conky is a system monitor for X originally based on torsmo. Since it's Conky is a system monitor for X originally based on torsmo. Since its
conception, Conky has changed significantly from it's predecessor. inception, Conky has changed significantly from its predecessor, while
Conky can display just about anything, either on your root desktop or maintaining simplicity and configurability. Conky can display just
in it's own window. Conky has many built-in objects, as well as the about anything, either on your root desktop or in its own window. Not
ability to execute programs and scripts, then display the output from only does Conky have many built-in objects, it can also display just
stdout. about any piece of information by using scripts and other external pro-
grams.
We are always looking for help, and anyone interested in becoming a de- Conky has more than 250 built in objects, including support for a
veloper is welcome. Please use the facilities at SourceForge to make plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
bug reports, feature requests, and submit patches. "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.
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.
Thanks for your interest in Conky. Thanks for your interest in Conky.
@ -273,13 +283,13 @@ CONFIGURATION SETTINGS
text_buffer_size bytes text_buffer_size bytes
Size of the standard text buffer (default is 128 bytes). This Size of the standard text buffer (default is 256 bytes). This
buffer is used for intermediary text, such as individual lines, buffer is used for intermediary text, such as individual lines,
output from $exec vars, and various other variables. Increasing output from $exec vars, and various other variables. Increasing
the size of this buffer can drastically reduce Conky's perfor- the size of this buffer can drastically reduce Conky's perfor-
mance, but will allow for more text display per variable. The mance, but will allow for more text display per variable. The
size of this buffer cannot be smaller than the default value of size of this buffer cannot be smaller than the default value of
128 bytes. 256 bytes.
maximum_width pixels maximum_width pixels

14
changelog2html.py
View File

@ -10,6 +10,8 @@ f = sys.argv[1]
blah = 0 blah = 0
print '<html><body>'
for i in open(f).read().splitlines(): for i in open(f).read().splitlines():
# ignore empty lines # ignore empty lines
@ -18,13 +20,15 @@ for i in open(f).read().splitlines():
print ' ' + i.strip() print ' ' + i.strip()
else: else:
s = i.split('*', 1)[1].strip() s = i.split('*', 1)[1].strip()
print ' <LI>' + s.replace('<', '&lt;').replace('>', '&gt;') print ' <li>' + s.replace('<', '&lt;').replace('>', '&gt;')
else: else:
if blah: if blah:
print '</UL>' print '</ul>'
print '<H3>%s</H3>' % i.strip() print '<h3>%s</h3>' % i.strip()
print '<UL>' print '<ul>'
blah = 1 blah = 1
if blah: if blah:
print '</UL>' print '</ul>'
print '</html></body>'

2
doc/config_settings.xml
View File

@ -233,7 +233,7 @@
<option>bytes</option> <option>bytes</option>
</term> </term>
<listitem> <listitem>
Size of the standard text buffer (default is 128 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 128 bytes. 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></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>

24
doc/conky.1
View File

@ -21,13 +21,23 @@ conky \- A system monitor for X originally based on the torsmo code, but more ki
'hy 'hy
.SH DESCRIPTION .SH DESCRIPTION
Conky is a system monitor for X originally based on torsmo. Conky is a system monitor for X originally based on torsmo.
Since it's conception, Conky has changed significantly from it's predecessor. Since its inception, Conky has changed significantly from its predecessor, while maintaining
Conky can display just about anything, either on your root desktop or in it's own window. simplicity and configurability. Conky can display just about anything, either
Conky has many built-in objects, as well as the ability to execute programs and scripts, on your root desktop or in its own window. Not only does Conky have many
then display the output from stdout. built-in objects, it can also display just about any piece of information by
using scripts and other external programs.
.PP .PP
We are always looking for help, and anyone interested in becoming a developer is welcome. Conky has more than 250 built in objects, including support for
Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches. 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.
.PP
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.
.PP .PP
Thanks for your interest in Conky. Thanks for your interest in Conky.
.SH COMPILING .SH COMPILING
@ -264,7 +274,7 @@ Maximum size of user text buffer, i.e. layout below TEXT line in config file
.TP .TP
\fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
Size of the standard text buffer (default is 128 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 128 bytes. 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.
.TP .TP
\fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T> \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>

23
doc/docs.xml
View File

@ -40,14 +40,25 @@
<title>Description</title> <title>Description</title>
<para> <para>
Conky is a system monitor for X originally based on torsmo. Conky is a system monitor for X originally based on torsmo.
Since it's conception, Conky has changed significantly from it's predecessor. Since its inception, Conky has changed significantly from its predecessor, while maintaining
Conky can display just about anything, either on your root desktop or in it's own window. simplicity and configurability. Conky can display just about anything, either
Conky has many built-in objects, as well as the ability to execute programs and scripts, on your root desktop or in its own window. Not only does Conky have many
then display the output from stdout. built-in objects, it can also display just about any piece of information by
using scripts and other external programs.
</para> </para>
<para> <para>
We are always looking for help, and anyone interested in becoming a developer is welcome. Conky has more than 250 built in objects, including support for
Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches. 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 contribute.
</para> </para>
<para> <para>
Thanks for your interest in Conky. Thanks for your interest in Conky.

2
src/conky.h
View File

@ -93,7 +93,7 @@ enum {
TOP_MEM_VSIZE, TOP_MEM_VSIZE,
}; };
#define DEFAULT_TEXT_BUFFER_SIZE 128 #define DEFAULT_TEXT_BUFFER_SIZE 256
extern unsigned int text_buffer_size; extern unsigned int text_buffer_size;
/* maximum number of special things, e.g. fonts, offsets, aligns, etc. */ /* maximum number of special things, e.g. fonts, offsets, aligns, etc. */