Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-27 04:32:55 +00:00
Code Issues Releases Activity

updating docs

Browse Source 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@911 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2007-08-10 20:57:30 +00:00
parent dbe5ee1f3f
commit 0e5974ef90
2 changed files with 74 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
README
View File

@ -651,44 +651,6 @@ VARIABLES
scale is non-zero, it becomes the scale for the graph. scale is non-zero, it becomes the scale for the graph.
wireless_essid net
Wireless access point ESSID (Linux only)
wireless_mode net
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
wireless_bitrate net
Wireless bitrate (ie 11 Mb/s) (Linux only)
wireless_ap net
Wireless access point MAC address (Linux only)
wireless_link_qual net
Wireless link quality (Linux only)
wireless_link_qual_max net
Wireless link quality maximum value (Linux only)
wireless_link_qual_perc net
Wireless link quality in percents (Linux only)
wireless_link_bar (height), (width) net
Wireless link quality bar (Linux only)
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.
else Text to show if any of the above are not true else Text to show if any of the above are not true
@ -957,10 +919,6 @@ VARIABLES
kernel Kernel version kernel Kernel version
linkstatus interface
Get the link status for wireless connections
loadavg loadavg
(1,2,3)> System load average, 1 is for past 1 minute, 2 for past (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
5 minutes and 3 for past 15 minutes. 5 minutes and 3 for past 15 minutes.
@ -1202,6 +1160,12 @@ VARIABLES
Move text over by N pixels. See also $voffset. Move text over by N pixels. See also $voffset.
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.
tab (width, (start)) tab (width, (start))
Puts a tab of the specified width, starting from column 'start'. Puts a tab of the specified width, starting from column 'start'.
@ -1290,6 +1254,38 @@ VARIABLES
ted, the parameter defaults to 1. ted, the parameter defaults to 1.
wireless_essid net
Wireless access point ESSID (Linux only)
wireless_mode net
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
wireless_bitrate net
Wireless bitrate (ie 11 Mb/s) (Linux only)
wireless_ap net
Wireless access point MAC address (Linux only)
wireless_link_qual net
Wireless link quality (Linux only)
wireless_link_qual_max net
Wireless link quality maximum value (Linux only)
wireless_link_qual_perc net
Wireless link quality in percents (Linux only)
wireless_link_bar (height), (width) net
Wireless link quality bar (Linux only)
xmms2_artist xmms2_artist
Artist in current XMMS2 song Artist in current XMMS2 song

76
doc/conky.1
View File

@ -631,42 +631,6 @@ Download speed in kilobytes with one decimal
\fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
.TP
\fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless access point ESSID (Linux only)
.TP
\fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
.TP
\fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless bitrate (ie 11 Mb/s) (Linux only)
.TP
\fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless access point MAC address (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality maximum value (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality in percents (Linux only)
.TP
\fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T>
Wireless link quality bar (Linux only)
.TP
\fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T>
Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
.TP .TP
\fB\*(T<\fBelse\fR\*(T>\fR \fB\*(T<\fBelse\fR\*(T>\fR
Text to show if any of the above are not true Text to show if any of the above are not true
@ -876,10 +840,6 @@ Displays the number of unseen messages in your global IMAP inbox by default. You
\fB\*(T<\fBkernel\fR\*(T>\fR \fB\*(T<\fBkernel\fR\*(T>\fR
Kernel version Kernel version
.TP
\fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
Get the link status for wireless connections
.TP .TP
\fB\*(T<\fBloadavg\fR\*(T>\fR \fB\*(T<\fBloadavg\fR\*(T>\fR
(1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes. (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
@ -1113,6 +1073,10 @@ Runs a command at an interval inside a thread and displays the output. Same as $
\fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
Move text over by N pixels. See also $voffset. Move text over by N pixels. See also $voffset.
.TP
\fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T>
Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
.TP .TP
\fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
Puts a tab of the specified width, starting from column 'start'. Puts a tab of the specified width, starting from column 'start'.
@ -1189,6 +1153,38 @@ Returns CPU #n's voltage in V. CPUs are
counted from 1. If omitted, the parameter counted from 1. If omitted, the parameter
defaults to 1. defaults to 1.
.TP
\fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless access point ESSID (Linux only)
.TP
\fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
.TP
\fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless bitrate (ie 11 Mb/s) (Linux only)
.TP
\fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless access point MAC address (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality maximum value (Linux only)
.TP
\fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Wireless link quality in percents (Linux only)
.TP
\fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T>
Wireless link quality bar (Linux only)
.TP .TP
\fB\*(T<\fBxmms2_artist\fR\*(T>\fR \fB\*(T<\fBxmms2_artist\fR\*(T>\fR
Artist in current XMMS2 song Artist in current XMMS2 song