From adcf34d5f769cc271bb9d0880c573aa2424fbdc3 Mon Sep 17 00:00:00 2001 From: Brenden Matthews Date: Sat, 22 Mar 2008 02:52:50 +0000 Subject: [PATCH] clarifying docs on $execp git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@1026 7f574dfc-610e-0410-a909-a81674777703 --- README | 235 +++++++++++++++++++++++----------------------- doc/conky.1 | 1 + doc/variables.xml | 1 + 3 files changed, 122 insertions(+), 115 deletions(-) diff --git a/README b/README index 93651047..88920738 100644 --- a/README +++ b/README @@ -726,11 +726,16 @@ VARIABLES recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your - script and have it correctly parsed by Conky. + script and have it correctly parsed by Conky. Caveats: Conky + parses and evaluates the output of $execp every time Conky + loops, and then destroys all the objects. If you try to use any- + thing like $execi within an $execp statement, it will function- + ally run at the same interval that the $execp statement runs, as + it is created and destroyed at every interval. execbar command - Same as exec, except if the first value return is a value be- + Same as exec, except if the first value return is a value be- tween 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future. @@ -740,7 +745,7 @@ VARIABLES execi interval command - Same as exec but with specific interval. Interval can't be less + Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci @@ -753,36 +758,36 @@ VARIABLES font (font) - Specify a different font. This new font will apply to the cur- - rent line and everything following. You can use a $font with no - arguments to change back to the default font (much like with + Specify a different font. This new font will apply to the cur- + rent line and everything following. You can use a $font with no + arguments to change back to the default font (much like with $color) freq (n) - Returns CPU #n's frequency in MHz. CPUs are counted from 1. If + Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1. freq_g (n) - Returns CPU #n's frequency in GHz. CPUs are counted from 1. If + Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1. freq_dyn - Returns CPU frequency in MHz, but is calculated by counting to - clock cycles to complete an instruction. Only available for + Returns CPU frequency in MHz, but is calculated by counting to + clock cycles to complete an instruction. Only available for x86/amd64. freq_dyn_g - Returns CPU frequency in GHz, but is calculated by counting to - clock cycles to complete an instruction. Only available for + Returns CPU frequency in GHz, but is calculated by counting to + clock cycles to complete an instruction. Only available for x86/amd64. 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. @@ -810,14 +815,14 @@ VARIABLES hddtemp dev, (host,(port)) - Displays temperature of a selected hard disk drive as reported - by the hddtemp daemon running on host:port. Default host is + Displays temperature of a selected hard disk drive as reported + by the hddtemp daemon running on host:port. Default host is 127.0.0.1, default port is 7634. head logfile lines (interval) - Displays first N lines of supplied text text file. If interval - is not supplied, Conky assumes 2x Conky's interval. Max of 30 + Displays first N lines of supplied text text file. If interval + is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled. @@ -826,16 +831,16 @@ VARIABLES hwmon (dev) type n - Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit- - ted if you have only one hwmon device. Parameter type is either - 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel- - sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n - is number of the sensor. See /sys/class/hwmon/ on your local + Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit- + ted if you have only one hwmon device. Parameter type is either + 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel- + sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n + is number of the sensor. See /sys/class/hwmon/ on your local computer. iconv_start codeset_from codeset_to - Convert text from one codeset to another using GNU iconv. Needs + Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop. @@ -844,75 +849,75 @@ VARIABLES i2c (dev) type n - I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted - if you have only one I2C device. Parameter type is either 'in' + I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted + if you have only one I2C device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or - 'tempf' (Fahrenheit) meaning temperature. Parameter n is number + 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer. i8k_ac_status - If running the i8k kernel driver for Inspiron laptops, displays - whether ac power is on, as listed in /proc/i8k (translated to - human-readable). Beware that this is by default not enabled by + If running the i8k kernel driver for Inspiron laptops, displays + whether ac power is on, as listed in /proc/i8k (translated to + human-readable). Beware that this is by default not enabled by i8k itself. i8k_bios - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k. i8k_buttons_status - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k. i8k_cpu_temp - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k. i8k_cpu_tempf - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k. i8k_left_fan_rpm - If running the i8k kernel driver for Inspiron laptops, displays - the left fan's rate of rotation, in revolutions per minute as + If running the i8k kernel driver for Inspiron laptops, displays + the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order. i8k_left_fan_status - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human- - readable). Beware, some laptops i8k reports these fans in re- + readable). Beware, some laptops i8k reports these fans in re- verse order. i8k_right_fan_rpm - If running the i8k kernel driver for Inspiron laptops, displays - the right fan's rate of rotation, in revolutions per minute as + If running the i8k kernel driver for Inspiron laptops, displays + the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order. i8k_right_fan_status - If running the i8k kernel driver for Inspiron laptops, displays - the right fan status as listed in /proc/i8k (translated to hu- - man-readable). Beware, some laptops i8k reports these fans in + If running the i8k kernel driver for Inspiron laptops, displays + the right fan status as listed in /proc/i8k (translated to hu- + man-readable). Beware, some laptops i8k reports these fans in reverse order. i8k_serial - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k. i8k_version - If running the i8k kernel driver for Inspiron laptops, displays + If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k. @@ -921,13 +926,13 @@ VARIABLES ibm_temps N - If running the IBM ACPI, displays the temperatures from the IBM + If running the IBM ACPI, displays the temperatures from the IBM temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the GPU. ibm_volume - If running the IBM ACPI, displays the "master" volume, con- + If running the IBM ACPI, displays the "master" volume, con- trolled by the volume keys (0-14). @@ -937,19 +942,19 @@ VARIABLES if_empty (var) - if conky variable VAR is empty, display everything between + if conky variable VAR is empty, display everything between $if_empty and the matching $endif if_running (process) - if PROCESS is running, display everything $if_running and the + if PROCESS is running, display everything $if_running and the matching $endif if_existing file (string) - if FILE exists, display everything between if_existing and the - matching $endif. The optional second paramater checks for FILE - containing the specified string and prints everything between + if FILE exists, display everything between if_existing and the + matching $endif. The optional second paramater checks for FILE + containing the specified string and prints everything between $if_existing and the matching $endif. @@ -959,8 +964,8 @@ VARIABLES if_smapi_bat_installed (INDEX) - when using smapi, if the battery with index INDEX is installed, - display everything between $if_smapi_bat_installed and the + when using smapi, if the battery with index INDEX is installed, + display everything between $if_smapi_bat_installed and the matching $endif @@ -971,9 +976,9 @@ VARIABLES imap_messages (args) Displays the number of messages in your global IMAP inbox by de- - fault. You can define individual IMAP inboxes seperately by + fault. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass - [-i interval] [-p port] [-e command]". Default port is 143, de- + [-i interval] [-p port] [-e command]". Default port is 143, de- fault interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts. @@ -982,7 +987,7 @@ VARIABLES Displays the number of unseen messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass - [-i interval] [-p port] [-e command]". Default port is 143, de- + [-i interval] [-p port] [-e command]". Default port is 143, de- fault interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts. @@ -1000,16 +1005,16 @@ VARIABLES mails (mailbox) (interval) - Mail count in the specified mailbox or your mail spool if not. - Both mbox and maildir type mailboxes are supported. You can use - a program like fetchmail to get mails from some server using + Mail count in the specified mailbox or your mail spool if not. + Both mbox and maildir type mailboxes are supported. You can use + a program like fetchmail to get mails from some server using your favourite protocol. See also new_mails. mboxscan (-n number of messages to print) (-fw from width) (-sw subject width) mbox - Print a summary of recent messages in an mbox format mailbox. - mbox parameter is the filename of the mailbox (can be encapsu- + Print a summary of recent messages in an mbox format mailbox. + mbox parameter is the filename of the mailbox (can be encapsu- lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"} @@ -1107,26 +1112,26 @@ VARIABLES pb_battery item If running on Apple powerbook/ibook, display information on bat- - tery status. The item parameter specifies, what information to + tery status. The item parameter specifies, what information to display. Exactly one item must be specified. Valid items are: status: Display if battery is fully charged, charging, discharg- ing or absent (running on AC) - percent: Display charge of battery in percent, if charging or - discharging. Nothing will be displayed, if battery is fully + percent: Display charge of battery in percent, if charging or + discharging. Nothing will be displayed, if battery is fully charged or absent. time: Display the time remaining until the battery will be fully - charged or discharged at current rate. Nothing is displayed, if - battery is absent or if it's present but fully charged and not + charged or discharged at current rate. Nothing is displayed, if + battery is absent or if it's present but fully charged and not discharging. platform (dev) type n - Platform sensor from sysfs (Linux 2.6). Parameter dev may be - omitted if you have only one platform device. Platform type is - either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' + Platform sensor from sysfs (Linux 2.6). Parameter dev may be + omitted if you have only one platform device. Platform type is + either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter - n is number of the sensor. See /sys/bus/platform/devices/ on + n is number of the sensor. See /sys/bus/platform/devices/ on your local computer. @@ -1134,17 +1139,17 @@ VARIABLES Displays the number of unseen messages in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass - [-i interval] [-p port] [-e command]". Default port is 110, de- + [-i interval] [-p port] [-e command]". Default port is 110, de- fault interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts. pop3_used (args) - Displays the amount of space (in MiB, 2^20) used in your global - POP3 inbox by default. You can define individual POP3 inboxes - seperately by passing arguments to this object. Arguments are: - "host user pass [-i interval] [-p port] [-e command]". Default - port is 110, default interval is 5 minutes. If the password is + Displays the amount of space (in MiB, 2^20) used in your global + POP3 inbox by default. You can define individual POP3 inboxes + seperately by passing arguments to this object. Arguments are: + "host user pass [-i interval] [-p port] [-e command]". Default + port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts. @@ -1167,21 +1172,21 @@ VARIABLES smapi (ARGS) - when using smapi, display contents of the /sys/devices/plat- - form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN- - DEX) (FILENAME)' to display the corresponding files' content. - This is a very raw method of accessing the smapi values. When + when using smapi, display contents of the /sys/devices/plat- + form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN- + DEX) (FILENAME)' to display the corresponding files' content. + This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead. smapi_bat_perc (INDEX) - when using smapi, display the remaining capacity in percent of - the battery with index INDEX. This is a separate variable be- + when using smapi, display the remaining capacity in percent of + the battery with index INDEX. This is a separate variable be- cause it supports the 'use_spacer' configuration option. smapi_bat_bar (INDEX),(height),(width) - when using smapi, display the remaining capacity of the battery + when using smapi, display the remaining capacity of the battery with index INDEX as a bar. @@ -1225,36 +1230,36 @@ VARIABLES The connection index provides you with access to each connection in the port monitor. The monitor will return information for in- dex values from 0 to n-1 connections. Values higher than n-1 are - simply ignored. For the "count" item, the connection index must + simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items. 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 - ${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 - ${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 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of the first connection on a privileged port ${tcp_portmon 1 1024 rport 4} - displays the remote host port of 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 Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a sin- 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. texeci interval command - Runs a command at an interval inside a thread and displays the - output. Same as $execi, except the command is run inside a - thread. Use this if you have a slow script to keep Conky updat- - ing. You should make the interval slightly longer then the time - it takes your script to execute. For example, if you have a - script that take 5 seconds to execute, you should make the in- + Runs a command at an interval inside a thread and displays the + output. Same as $execi, except the command is run inside a + thread. Use this if you have a slow script to keep Conky updat- + ing. You should make the interval slightly longer then the time + it takes your script to execute. For example, if you have a + script that take 5 seconds to execute, you should make the in- terval at least 6 seconds. See also $execi. @@ -1263,8 +1268,8 @@ VARIABLES 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 + 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. @@ -1279,7 +1284,7 @@ VARIABLES 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 @@ -1288,23 +1293,23 @@ VARIABLES tztime (timezone) (format) - Local time for specified timezone, see man strftime to get more - information about format. The timezone argument is specified in - similar fashion as TZ environment variable. For hints, look in + Local time for specified timezone, see man strftime to get more + information about format. The timezone argument is specified in + similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc. 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 al- ready done that before conky has started. top type, num - This takes arguments in the form:top (name) (number) Basically, - processes are ranked from highest to lowest in terms of cpu us- - age, which is what (num) represents. The types are: "name", - "pid", "cpu", "mem", and "time". There can be a max of 10 pro- + This takes arguments in the form:top (name) (number) Basically, + processes are ranked from highest to lowest in terms of cpu us- + age, which is what (num) represents. The types are: "name", + "pid", "cpu", "mem", and "time". There can be a max of 10 pro- cesses listed. @@ -1328,9 +1333,9 @@ VARIABLES 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) - 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. @@ -1358,12 +1363,12 @@ VARIABLES 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. voltage_mv (n) - Returns CPU #n's voltage in mV. CPUs are counted from 1. If + Returns CPU #n's voltage in mV. CPUs are counted from 1. If omitted, the parameter defaults to 1. @@ -1491,11 +1496,11 @@ FILES BUGS 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 - been reported that it doesn't work with KDE either. Nautilus can be - disabled from drawing to desktop with program gconf-editor. Uncheck - show_desktop in /apps/nautilus/preferences/. There is -w switch in - 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 + been reported that it doesn't work with KDE either. Nautilus can be + disabled from drawing to desktop with program gconf-editor. Uncheck + show_desktop in /apps/nautilus/preferences/. There is -w switch in + 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 which makes Conky to create its own window. SEE ALSO diff --git a/doc/conky.1 b/doc/conky.1 index 5ad053bf..e9bed583 100644 --- a/doc/conky.1 +++ b/doc/conky.1 @@ -678,6 +678,7 @@ Executes a shell command and displays the output in conky. warning: this takes a .TP \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky. +Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects. If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval. .TP \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> diff --git a/doc/variables.xml b/doc/variables.xml index ef422aed..6253781c 100644 --- a/doc/variables.xml +++ b/doc/variables.xml @@ -654,6 +654,7 @@ Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky. + Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects. If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval.