From 0e5974ef90fc7e80c69211e1a82a0b961115d74c Mon Sep 17 00:00:00 2001 From: Brenden Matthews Date: Fri, 10 Aug 2007 20:57:30 +0000 Subject: [PATCH] updating docs git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@911 7f574dfc-610e-0410-a909-a81674777703 --- README | 80 ++++++++++++++++++++++++++++------------------------------- doc/conky.1 | 76 +++++++++++++++++++++++++++----------------------------- 2 files changed, 74 insertions(+), 82 deletions(-) diff --git a/README b/README index 4b9ccb6..0711dbf 100644 --- a/README +++ b/README @@ -651,44 +651,6 @@ VARIABLES 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 @@ -957,10 +919,6 @@ VARIABLES kernel Kernel version - linkstatus interface - Get the link status for wireless connections - - loadavg (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes. @@ -1202,6 +1160,12 @@ VARIABLES 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)) Puts a tab of the specified width, starting from column 'start'. @@ -1290,6 +1254,38 @@ VARIABLES 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 Artist in current XMMS2 song diff --git a/doc/conky.1 b/doc/conky.1 index 6cabcc2..95ae9cf 100644 --- a/doc/conky.1 +++ b/doc/conky.1 @@ -632,42 +632,6 @@ Download speed in kilobytes with one decimal 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 \fB\*(T<\fBelse\fR\*(T>\fR Text to show if any of the above are not true @@ -877,10 +841,6 @@ Displays the number of unseen messages in your global IMAP inbox by default. You Kernel version .TP -\fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> -Get the link status for wireless connections - -.TP \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. @@ -1114,6 +1074,10 @@ Runs a command at an interval inside a thread and displays the output. Same as $ 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 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> Puts a tab of the specified width, starting from column 'start'. @@ -1190,6 +1154,38 @@ counted from 1. If omitted, the parameter 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 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR Artist in current XMMS2 song -- 1.7.9.5