1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-17 18:45:10 +00:00

vim and docs

git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@566 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2006-03-08 06:27:53 +00:00
parent 3609fe4bb5
commit fbfa58ad13
4 changed files with 49 additions and 37 deletions

77
README
View File

@ -746,6 +746,11 @@ VARIABLES
Prints the file name of the current MPD song Prints the file name of the current MPD song
mpd_smart
Prints the song name in either the form "artist - title" or file
name, depending on whats available
new_mails new_mails
Unread mail count in mail spool. Unread mail count in mail spool.
@ -817,20 +822,20 @@ VARIABLES
lservice - local service name from /etc/services lservice - local service name from /etc/services
The connection index provides you with access to each connection The connection index provides you with access to each connection
in the port monitor. The monitor will return information for in the port monitor. The monitor will return information for
index values from 0 to n-1 connections. Values higher than n-1 index values from 0 to n-1 connections. Values higher than n-1
are simply ignored. For the "count" item, the connection index are simply ignored. For the "count" item, the connection index
must be omitted. It is required for all other items. must be omitted. It is required for all other items.
Examples: Examples:
${tcp_portmon 6881 6999 count} - displays the number of connec- ${tcp_portmon 6881 6999 count} - displays the number of connec-
tions in the bittorrent port range tions in the bittorrent port range
${tcp_portmon 22 22 rip 0} - displays the remote host ip of the ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
first sshd connection first sshd connection
${tcp_portmon 22 22 rip 9} - displays the remote host ip of the ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
tenth sshd connection tenth sshd connection
${tcp_portmon 1 1024 rhost 0} - displays the remote host name of ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
@ -839,22 +844,22 @@ VARIABLES
${tcp_portmon 1 1024 rport 4} - displays the remote host port of ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
the fifth connection on a privileged port the fifth connection on a privileged port
${tcp_portmon 1 65535 lservice 14} - displays the local service ${tcp_portmon 1 65535 lservice 14} - displays the local service
name of the fifteenth connection in the range of all ports name of the fifteenth connection in the range of all ports
Note that port monitor variables which share the same port range Note that port monitor variables which share the same port range
actually refer to the same monitor, so many references to a sin- actually refer to the same monitor, so many references to a sin-
gle port range for different items and different indexes all use gle port range for different items and different indexes all use
the same monitor internally. In other words, the program avoids the same monitor internally. In other words, the program avoids
creating redundant monitors. creating redundant monitors.
texeci interval command texeci interval command
Runs a command at an interval inside a thread and displays the Runs a command at an interval inside a thread and displays the
output. Same as $execi, except the command is run inside a output. Same as $execi, except the command is run inside a
thread. Use this if you have a slow script to keep Conky updat- thread. Use this if you have a slow script to keep Conky updat-
ing. You should make the interval slightly longer then the time ing. You should make the interval slightly longer then the time
it takes your script to execute. For example, if you have a it takes your script to execute. For example, if you have a
script that take 5 seconds to execute, you should make the script that take 5 seconds to execute, you should make the
interval at least 6 seconds. See also $execi. interval at least 6 seconds. See also $execi.
@ -869,21 +874,21 @@ VARIABLES
time (format) time (format)
Local time, see man strftime to get more information about for- Local time, see man strftime to get more information about for-
mat mat
totaldown net totaldown net
Total download, overflows at 4 GB on Linux with 32-bit arch and Total download, overflows at 4 GB on Linux with 32-bit arch and
there doesn't seem to be a way to know how many times it has there doesn't seem to be a way to know how many times it has
already done that before conky has started. already done that before conky has started.
top type, num top type, num
This takes arguments in the form:top (name) (number) Basically, This takes arguments in the form:top (name) (number) Basically,
processes are ranked from highest to lowest in terms of cpu processes are ranked from highest to lowest in terms of cpu
usage, which is what (num) represents. The types are: "name", usage, which is what (num) represents. The types are: "name",
"pid", "cpu", and mem". There can be a max of 10 processes "pid", "cpu", and mem". There can be a max of 10 processes
listed. listed.
@ -907,9 +912,9 @@ VARIABLES
Upload speed in kilobytes with one decimal Upload speed in kilobytes with one decimal
upspeedgraph net (height),(width) (gradient colour 1) (gradient colour upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
2) (scale) 2) (scale)
Upload speed graph, colours defined in hex, minus the #. If Upload speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. scale is non-zero, it becomes the scale for the graph.
@ -933,7 +938,7 @@ VARIABLES
voffset (pixels) voffset (pixels)
Change vertical offset by N pixels. Negative values will cause Change vertical offset by N pixels. Negative values will cause
text to overlap. See also $offset. text to overlap. See also $offset.
@ -946,12 +951,12 @@ VARIABLES
xmms_channels xmms_channels
xmms / bmp / audacious / infopipe: number of audio channels of xmms / bmp / audacious / infopipe: number of audio channels of
current tune current tune
xmms_filename xmms_filename
xmms / bmp / audacious / infopipe: full path and filename of xmms / bmp / audacious / infopipe: full path and filename of
current tune current tune
@ -961,17 +966,17 @@ VARIABLES
xmms_length xmms_length
xmms / bmp / audacious / infopipe: total length of current tune xmms / bmp / audacious / infopipe: total length of current tune
as MM:SS as MM:SS
xmms_length_seconds xmms_length_seconds
xmms / bmp / audacious / infopipe: total length of current tune xmms / bmp / audacious / infopipe: total length of current tune
in seconds in seconds
xmms_playlist_position xmms_playlist_position
xmms / bmp / audacious / infopipe: playlist position of current xmms / bmp / audacious / infopipe: playlist position of current
tune tune
@ -980,12 +985,12 @@ VARIABLES
xmms_position xmms_position
xmms / bmp / audacious / infopipe: MM:SS position of current xmms / bmp / audacious / infopipe: MM:SS position of current
tune tune
xmms_position_seconds xmms_position_seconds
xmms / bmp / audacious / infopipe: position of current tune in xmms / bmp / audacious / infopipe: position of current tune in
seconds seconds
@ -1012,11 +1017,11 @@ FILES
BUGS BUGS
Drawing to root or some other desktop window directly doesn't work with Drawing to root or some other desktop window directly doesn't work with
all window managers. Especially doesn't work well with Gnome and it has all window managers. Especially doesn't work well with Gnome and it has
been reported that it doesn't work with KDE either. Nautilus can be been reported that it doesn't work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree Conky to set some specific window id. You might find xwininfo -tree
useful to find the window to draw to. You can also use -o argument useful to find the window to draw to. You can also use -o argument
which makes Conky to create its own window. which makes Conky to create its own window.
SEE ALSO SEE ALSO

View File

@ -674,6 +674,10 @@ Prints the MPD name field
\fBmpd_file\fR \fBmpd_file\fR
Prints the file name of the current MPD song Prints the file name of the current MPD song
.TP
\fBmpd_smart\fR
Prints the song name in either the form "artist - title" or file name, depending on whats available
.TP .TP
\fBnew_mails\fR \fBnew_mails\fR
Unread mail count in mail spool. Unread mail count in mail spool.

View File

@ -838,7 +838,7 @@
<varlistentry> <varlistentry>
<term> <term>
<command><option>mpd_smart<option></command> <command><option>mpd_smart</option></command>
</term> </term>
<listitem> <listitem>
Prints the song name in either the form "artist - title" or file name, depending on whats available Prints the song name in either the form "artist - title" or file name, depending on whats available

View File

@ -184,6 +184,9 @@ syn keyword ConkyrcVarName contained nextgroup=ConkyrcNumber,ConkyrcColour skipw
\ mpd_percent \ mpd_percent
\ mpd_status \ mpd_status
\ mpd_title \ mpd_title
\ mpd_file
\ mpd_name
\ mpd_smart
\ mpd_vol \ mpd_vol
\ new_mails \ new_mails
\ nodename \ nodename