From 77f818168b3fe485f6f873c9b1ebfe45e3e81284 Mon Sep 17 00:00:00 2001 From: Brenden Matthews Date: Thu, 9 Apr 2009 20:18:19 -0600 Subject: [PATCH] Update docs. --- README | 385 +++++++++++++++++++++++----------------------- doc/conky.1 | 12 +- doc/variables.xml | 18 ++- 3 files changed, 217 insertions(+), 198 deletions(-) diff --git a/README b/README index 7844518b..79fdbdf0 100644 --- a/README +++ b/README @@ -796,26 +796,27 @@ conky(1) conky(1) execbar command 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. + tween 0-100, it will use that number for a bar. The size for + bars can be controlled via the default_bar_size config setting. execgauge command - Same as exec, except if the first value return is a value be‐ + Same as exec, except if the first value returned is a value be‐ tween 0-100, it will use that number for a gauge. The size for - the gauge is currently fixed, but you may change that for the - future conky release. + gauges can be controlled via the default_gauge_size config set‐ + ting. execgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ ent colour 2) (scale) command Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still - have to be between 0 and 100. + have to be between 0 and 100. The size for graphs can be con‐ + trolled via the default_graph_size config setting. 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 @@ -824,19 +825,23 @@ conky(1) conky(1) execigraph interval command - Same as execgraph, but takes an interval arg graphs values + Same as execgraph, but takes an interval arg and graphs values. + + + execigauge interval command + Same as execgauge, but takes an interval arg and gauges values. execp command Executes a shell command and displays the output in conky. warn‐ - ing: this takes a lot more resources than other variables. I'd + ing: 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 + 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 any‐ - thing like $execi within an $execp statement, it will function‐ + 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. @@ -844,41 +849,41 @@ conky(1) conky(1) execpi interval command Same as execp but with specific interval. Interval can't be less than update_interval in configuration. Note that the output from - the $execpi command is still parsed and evaluated at every in‐ + the $execpi command is still parsed and evaluated at every in‐ terval. 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 (n) Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐ - lated by counting to clock cycles to complete an instruction. + lated by counting to clock cycles to complete an instruction. Only available for x86/amd64. freq_dyn_g (n) Returns CPU #n's frequency in GHz (defaults to 1), but is calcu‐ - lated by counting to clock cycles to complete an instruction. + lated 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. @@ -906,23 +911,23 @@ conky(1) conky(1) gw_iface - Displays the default route's interface or "multiple"/"none" ac‐ + Displays the default route's interface or "multiple"/"none" ac‐ cordingly. - gw_ip Displays the default gateway's IP or "multiple"/"none" accord‐ + gw_ip Displays the default gateway's IP or "multiple"/"none" accord‐ ingly. 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. @@ -931,15 +936,15 @@ conky(1) conky(1) 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 + 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' meaning - temperature. Parameter n is number of the sensor. See + 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. @@ -948,70 +953,70 @@ conky(1) conky(1) 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' meaning tem‐ - perature. Parameter n is number of the sensor. See + perature. 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_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. @@ -1020,13 +1025,13 @@ conky(1) conky(1) 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). @@ -1036,14 +1041,14 @@ conky(1) conky(1) 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_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. @@ -1052,11 +1057,11 @@ conky(1) conky(1) if_match expression - Evaluates the given boolean expression, printing everything be‐ + Evaluates the given boolean expression, printing everything be‐ tween $if_match and the matching $endif depending on whether the - evaluation returns true or not. Valid expressions consist of a - left side, an operator and a right side. Left and right sides - are being parsed for contained text objects before evaluation. + evaluation returns true or not. Valid expressions consist of a + left side, an operator and a right side. Left and right sides + are being parsed for contained text objects before evaluation. Recognised left and right side types are: double: argument consists of only digits and a single dot. @@ -1068,8 +1073,8 @@ conky(1) conky(1) if_running (process) - if PROCESS is running, display everything $if_running and the - matching $endif. This uses the ``pidof'' command, so the -x + if PROCESS is running, display everything $if_running and the + matching $endif. This uses the ``pidof'' command, so the -x switch is also supported. @@ -1079,8 +1084,8 @@ conky(1) conky(1) 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 @@ -1090,17 +1095,17 @@ conky(1) conky(1) if_updatenr (updatenr) - If it's the UPDATENR-th time that conky updates, display every‐ + If it's the UPDATENR-th time that conky updates, display every‐ thing between $if_updatenr and the matching $endif. The counter - resets when the highest UPDATENR is reached. Example : + resets when the highest UPDATENR is reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr - 4}$endif" shows foo 25% of the time followed by bar 25% of the + 4}$endif" shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time. 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] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of re‐ @@ -1119,7 +1124,7 @@ conky(1) conky(1) ioscheduler disk - Prints the current ioscheduler used for the given disk name + Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb") @@ -1137,8 +1142,8 @@ conky(1) conky(1) loadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ ent colour 2) (scale) - Load1 average graph, similar to xload, with optional colours in - hex, minus the #. Uses a logarithmic scale (to see small num‐ + Load1 average graph, similar to xload, with optional colours in + hex, minus the #. Uses a logarithmic scale (to see small num‐ bers) when you use "log" instead of "normal". @@ -1151,9 +1156,9 @@ conky(1) conky(1) 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. @@ -1163,32 +1168,32 @@ conky(1) conky(1) seen_mails (maildir) (interval) - Number of mails marked as seen in the specified mailbox or mail - spool if not. Only maildir type mailboxes are supported, mbox + Number of mails marked as seen in the specified mailbox or mail + spool if not. Only maildir type mailboxes are supported, mbox type will return -1. unseen_mails (maildir) (interval) - Number of new or unseen mails in the specified mailbox or mail - spool if not. Only maildir type mailboxes are supported, mbox + Number of new or unseen mails in the specified mailbox or mail + spool if not. Only maildir type mailboxes are supported, mbox type will return -1. flagged_mails (maildir) (interval) - Number of mails marked as flagged in the specified mailbox or - mail spool if not. Only maildir type mailboxes are supported, + Number of mails marked as flagged in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. unflagged_mails (maildir) (interval) - Number of mails not marked as flagged in the specified mailbox + Number of mails not marked as flagged in the specified mailbox or mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. forwarded_mails (maildir) (interval) - Number of mails marked as forwarded in the specified mailbox or - mail spool if not. Only maildir type mailboxes are supported, + Number of mails marked as forwarded in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. @@ -1199,33 +1204,33 @@ conky(1) conky(1) replied_mails (maildir) (interval) - Number of mails marked as replied in the specified mailbox or - mail spool if not. Only maildir type mailboxes are supported, + Number of mails marked as replied in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. unreplied_mails (maildir) (interval) - Number of mails not marked as replied in the specified mailbox + Number of mails not marked as replied in the specified mailbox or mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. draft_mails (maildir) (interval) Number of mails marked as draft in the specified mailbox or mail - spool if not. Only maildir type mailboxes are supported, mbox + spool if not. Only maildir type mailboxes are supported, mbox type will return -1. trashed_mails (maildir) (interval) - Number of mails marked as trashed in the specified mailbox or - mail spool if not. Only maildir type mailboxes are supported, + Number of mails marked as trashed in the specified mailbox or + mail spool if not. Only maildir type mailboxes are supported, mbox type will return -1. 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"} @@ -1240,14 +1245,14 @@ conky(1) conky(1) Gauge that shows amount of memory in use (see cpugauge) - memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ + memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ ent colour 2) (scale) - Memory usage graph. Uses a logarithmic scale (to see small num‐ + Memory usage graph. Uses a logarithmic scale (to see small num‐ bers) when you use "log" instead of "normal". memeasyfree - Amount of free memory including the memory that is very easily + Amount of free memory including the memory that is very easily freed (buffers/cache) @@ -1263,39 +1268,39 @@ conky(1) conky(1) mixer (device) - Prints the mixer value as reported by the OS. Default mixer is - "vol", but you can specify one of the following optional argu‐ + Prints the mixer value as reported by the OS. Default mixer is + "vol", but you can specify one of the following optional argu‐ ments: "vol", "bass", "treble", "synth", "pcm", "speaker", - "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", + "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of - SOUND_DEVICE_NAMES in (on Linux), (on Linux), (on OpenBSD), or to find the exact op‐ tions available on your system. mixerbar (device) - Displays mixer value in a bar as reported by the OS. See docs + Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments. mixerr (device) - Prints the right channel mixer value as reported by the OS. See + Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments. mixerrbar (device) - Displays the right channel mixer value in a bar as reported by + Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments. mixerl (device) - Prints the left channel mixer value as reported by the OS. See + Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments. mixerlbar (device) - Displays the left channel mixer value in a bar as reported by + Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments. @@ -1417,12 +1422,12 @@ conky(1) conky(1) if_mpd_playing - if mpd is playing or paused, display everything between + if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif nameserver (index) - Print a nameserver from /etc/resolv.conf. Index starts at and + Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0. @@ -1431,8 +1436,8 @@ conky(1) conky(1) nvidia threshold temp ambient gpufreq memfreq imagequality - Nvidia graficcard support for the XNVCtrl library. Each option - can be shortened to the least significant part. Temperatures + Nvidia graficcard support for the XNVCtrl library. Each option + can be shortened to the least significant part. Temperatures are printed as float, all other values as integer. threshold: the thresholdtemperature at which the gpu slows down @@ -1450,25 +1455,25 @@ conky(1) conky(1) 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' - meaning temperature. Parameter n is number of the sensor. See + 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' + meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer. @@ -1483,13 +1488,13 @@ conky(1) conky(1) 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] [-r re‐ + 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] [-r re‐ tries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password - is supplied as '*', you will be prompted to enter the password + is supplied as '*', you will be prompted to enter the password when Conky starts. @@ -1507,14 +1512,14 @@ conky(1) conky(1) scroll length (step) text - Scroll 'text' by 'step' characters showing 'length' number of - characters at the same time. The text may also contain vari‐ + Scroll 'text' by 'step' characters showing 'length' number of + characters at the same time. The text may also contain vari‐ ables. 'step' is optional and defaults to 1 if not set. If a var - creates output on multiple lines then the lines are placed be‐ - hind each other separated with a '|'-sign. Do NOT use vars that - change colors or otherwise affect the design inside a scrolling - text. If you want spaces between the start and the end of - 'text', place them at the end of 'text' not at the front ("foo‐ + creates output on multiple lines then the lines are placed be‐ + hind each other separated with a '|'-sign. Do NOT use vars that + change colors or otherwise affect the design inside a scrolling + text. If you want spaces between the start and the end of + 'text', place them at the end of 'text' not at the front ("foo‐ bar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo"). @@ -1524,35 +1529,35 @@ conky(1) conky(1) 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_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. 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_power INDEX - when using smapi, display the current power of the battery with - index INDEX in watt. This is a separate variable because the - original read out value is being converted from mW. The sign of - the output reflects charging (positive) or discharging (nega‐ + when using smapi, display the current power of the battery with + index INDEX in watt. This is a separate variable because the + original read out value is being converted from mW. The sign of + the output reflects charging (positive) or discharging (nega‐ tive) state. smapi_bat_temp INDEX when using smapi, display the current temperature of the battery - with index INDEX in degree Celsius. This is a separate variable + with index INDEX in degree Celsius. This is a separate variable because the original read out value is being converted from mil‐ li degree Celsius. @@ -1597,36 +1602,36 @@ conky(1) conky(1) 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. @@ -1635,8 +1640,8 @@ conky(1) conky(1) 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. @@ -1652,14 +1657,14 @@ conky(1) conky(1) templateN (arg1) (arg2) (arg3 ...) - Evaluate the content of the templateN configuration variable + Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively), applying sub‐ - stitutions as described in the documentation of the correspond‐ - ing configuration variable. The number of arguments is option‐ - al, but must match the highest referred index in the template. - You can use the same special sequences in each argument as the - ones valid for a template definition, e.g. to allow an argument - to contain a whitespace. Also simple nesting of templates is + stitutions as described in the documentation of the correspond‐ + ing configuration variable. The number of arguments is option‐ + al, but must match the highest referred index in the template. + You can use the same special sequences in each argument as the + ones valid for a template definition, e.g. to allow an argument + to contain a whitespace. Also simple nesting of templates is possible this way. Here are some examples of template definitions: @@ -1668,7 +1673,7 @@ conky(1) conky(1) template1 \1: ${fs_used \2} / ${fs_size \2} template2 \1 \2 - The following list shows sample usage of the templates defined + The following list shows sample usage of the templates defined above, with the equivalent syntax when not using any template at all: @@ -1681,7 +1686,7 @@ conky(1) conky(1) 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 @@ -1690,23 +1695,23 @@ conky(1) conky(1) 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", "mem_res", "mem_vsize", and "time". There + 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", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed. @@ -1715,7 +1720,7 @@ conky(1) conky(1) top_time type, num - Same as top, except sorted by total CPU time instead of current + Same as top, except sorted by total CPU time instead of current CPU usage @@ -1737,9 +1742,9 @@ conky(1) conky(1) upspeedgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net) - Upload speed graph, colours defined in hex, minus the #. If - scale is non-zero, it becomes the scale for the graph. Uses a - logarithmic scale (to see small numbers) when you use "log" in‐ + Upload speed graph, colours defined in hex, minus the #. If + scale is non-zero, it becomes the scale for the graph. Uses a + logarithmic scale (to see small numbers) when you use "log" in‐ stead of "normal". @@ -1767,12 +1772,12 @@ conky(1) conky(1) 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. @@ -1891,12 +1896,12 @@ conky(1) conky(1) if_xmms2_connected - Display everything between $if_xmms2_connected and the matching + Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running. eve api_userid api_key character_id - Fetches your currently training skill from the Eve Online API + Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time. @@ -1915,13 +1920,13 @@ conky(1) conky(1) 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. If you do try running Conky - in its own window, be sure to read up on the own_window_type settings + in its own window, be sure to read up on the own_window_type settings and experiment. SEE ALSO @@ -1932,11 +1937,11 @@ conky(1) conky(1) #conky on irc.freenode.net COPYING - Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al. Any + Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al. Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy). All code written since the fork of torsmo is licensed un‐ der the GPL (see LICENSE.GPL for a copy), except where noted different‐ - ly (such as in portmon code, timed thread code, and audacious code + ly (such as in portmon code, timed thread code, and audacious code which are LGPL, and prss which is an MIT-style license). AUTHORS diff --git a/doc/conky.1 b/doc/conky.1 index 3ee4758b..29b01e42 100644 --- a/doc/conky.1 +++ b/doc/conky.1 @@ -696,15 +696,15 @@ Executes a shell command and displays the output in conky. warning: this takes a .TP \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> -Same as exec, except if the first value return is a value between 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. +Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for bars can be controlled via the default_bar_size config setting. .TP \fB\*(T<\fBexecgauge\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> -Same as exec, except if the first value return is a value between 0-100, it will use that number for a gauge. The size for the gauge is currently fixed, but you may change that for the future conky release. +Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting. .TP \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T> -Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. +Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. The size for graphs can be controlled via the default_graph_size config setting. .TP \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> @@ -716,7 +716,11 @@ Same as execbar, except with an interval .TP \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> -Same as execgraph, but takes an interval arg graphs values +Same as execgraph, but takes an interval arg and graphs values. + +.TP +\fB\*(T<\fBexecigauge\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> +Same as execgauge, but takes an interval arg and gauges values. .TP \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> diff --git a/doc/variables.xml b/doc/variables.xml index 6e59d690..14204e31 100644 --- a/doc/variables.xml +++ b/doc/variables.xml @@ -611,7 +611,7 @@ - Same as exec, except if the first value return is a value between 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. + Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for bars can be controlled via the default_bar_size config setting. @@ -621,7 +621,7 @@ - Same as exec, except if the first value return is a value between 0-100, it will use that number for a gauge. The size for the gauge is currently fixed, but you may change that for the future conky release. + Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting. @@ -631,7 +631,7 @@ - Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. + Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. The size for graphs can be controlled via the default_graph_size config setting. @@ -661,7 +661,17 @@ - Same as execgraph, but takes an interval arg graphs values + Same as execgraph, but takes an interval arg and graphs values. + + + + + + + + + + Same as execgauge, but takes an interval arg and gauges values.