X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fvariables.xml;h=bc5c36cf18f654a13eb2cca0aff8a831738797e1;hb=0c83d64a86fcaf4741f5fdf0013df7f9e48e30ac;hp=a016be57272547c9bfde54b36901814e37a45581;hpb=d0edfa70045a10c0ceafa65d2d01b49ae5c42061;p=monky
diff --git a/doc/variables.xml b/doc/variables.xml
index a016be5..bc5c36c 100644
--- a/doc/variables.xml
+++ b/doc/variables.xml
@@ -4,8 +4,11 @@
+
- ACPI ac adapter state.
+ ACPI ac adapter state. On linux, the adapter option specifies the
+ subfolder of /sys/class/power_supply containing the state information (defaults
+ to "AC"). Other systems ignore it.
@@ -536,11 +539,25 @@
+
+
+
+
+ PID of the first process that has string in it's
+ commandline
+
+
+
+
+
- Change drawing color to color
+ Change drawing color to 'color' which is a name of
+ a color or a hexcode preceded with # (for example #0A1B2C ).
+ If you use ncurses only the following colors are supported:
+ red,green,yellow,blue,magenta,cyan,black,white.
@@ -561,7 +578,7 @@
Places the lines of var2 to the right of the
- lines of var1 seperated by the chars that are put between
+ lines of var1 separated by the chars that are put between
var1 and var2. For example: ${combine ${head /proc/cpuinfo
2} - ${head /proc/meminfo 1}} gives as output
"cpuinfo_line1 - meminfo_line1" on line 1 and
@@ -652,6 +669,24 @@
+
+
+
+
+
+ Download data from URI using Curl at the
+ specified interval. The interval may be a floating
+ point value greater than 0, otherwise defaults to 15
+ minutes. Most useful when used in conjunction with Lua
+ and the Lua API. This object is threaded, and once a
+ thread is created it can't be explicitly destroyed.
+ One thread will run for each URI specified. You can use
+ any protocol that Curl supports.
+
+
+
+
+
@@ -892,7 +927,7 @@
- Evalutates given string according to the rules of
+ Evaluates given string according to the rules of
TEXT interpretation, i.e. parsing any contained text object
specifications into their output, any occuring '$$' into a
single '$' and so on. The output is then being parsed
@@ -1077,6 +1112,28 @@
+
+
+
+
+ Format time given in seconds. This var only works when
+ the times_in_seconds configuration setting is on. Format is a string
+ that should start and end with a "-char. The "-chars are not
+ part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
+ weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
+ it's value will be expressed in the highest unite lower then the
+ one left out. Text between ()-chars will not be visible if a
+ replaced unit in this text is 0. If seconds is a decimal number
+ then you can see the numbers behind the point by using \S
+ followed by a number that specifies the amount of
+ digits behind the point that you want to see (maximum 9).
+ You can also place a 'x' behind \S so you have all digits behind
+ the point and no trailing zero's. (also maximum 9)
+
+
+
+
+
@@ -1230,12 +1287,13 @@
-
+
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.
-
+ drive as reported by the hddtemp daemon. Use hddtemp_host
+ and hddtemp_port to specify a host and port for all hddtemp
+ objects. If no dev parameter is given, the first disk returned
+ by the hddtemp daemon is used.
@@ -1243,12 +1301,12 @@
-
+
- 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.
+ Displays first N lines of supplied text file. The
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
@@ -1542,8 +1600,7 @@
digits.
stringArgument is enclosed in
- quotation mark or the checks for double and long failed
- before.
+ quotation marks (")
Valid operands are: '>', '<', '>=',
'<=', '==', '!='.
@@ -1677,9 +1734,9 @@
Displays the number of messages in your global
IMAP inbox by default. You can define individual IMAP
- inboxes seperately by passing arguments to this object.
+ inboxes separately by passing arguments to this object.
Arguments are: "host user pass [-i interval (in seconds)]
- [-f folder] [-p port] [-e command] [-r retries]". Default
+ [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
port is 143, default folder is 'INBOX', default interval is
5 minutes, and default number of retries before giving up
is 5. If the password is supplied as '*', you will be
@@ -1695,9 +1752,9 @@
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
+ IMAP inboxes separately by passing arguments to this
object. Arguments are: "host user pass [-i interval (in
- seconds)] [-f folder] [-p port] [-e command] [-r retries]".
+ seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
Default port is 143, default folder is 'INBOX', default
interval is 5 minutes, and default number of retries before
giving up is 5. If the password is supplied as '*', you
@@ -1707,6 +1764,20 @@
+
+
+
+
+
+ Loads the configfile at path, places the
+ configsettings behind the configsettings in the orginal
+ config and places the vars where the includevar
+ stood.
+
+
+
+
+
@@ -1751,7 +1822,8 @@
System load average, 1 is for past 1 minute, 2
- for past 5 minutes and 3 for past 15 minutes.
+ for past 5 minutes and 3 for past 15 minutes. Without argument, prints
+ all three values separated by whitespace.
@@ -1759,7 +1831,7 @@
-
Load1 average graph, similar to xload, with
@@ -1779,7 +1851,10 @@
Executes a Lua function with given parameters,
then prints the returned string. See also 'lua_load' on how
- to load scripts.
+ to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
@@ -1792,7 +1867,10 @@
Executes a Lua function with given parameters and
draws a bar. Expects result value to be an integer between
- 0 and 100. See also 'lua_load' on how to load scripts.
+ 0 and 100. See also 'lua_load' on how to load scripts.
+ Conky puts 'conky_' in front of function_name to prevent
+ accidental calls to the wrong function unless you put you
+ place 'conky_' in front of it yourself.
@@ -1806,7 +1884,9 @@
Executes a Lua function with given parameters and
draws a gauge. Expects result value to be an integer
between 0 and 100. See also 'lua_load' on how to load
- scripts.
+ scripts. Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
@@ -1823,7 +1903,9 @@
load scripts. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and
- see).
+ see). Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
@@ -1836,18 +1918,10 @@
Executes a Lua function with given parameters as
per $lua, then parses and prints the result value as per
the syntax for Conky's TEXT section. See also 'lua_load' on
- how to load scripts.
-
-
-
-
-
-
-
-
-
- This function is deprecated. Please use the
- conky_parse() Lua function instead.
+ how to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
@@ -2365,11 +2439,15 @@
other values as integer.
- thresholdThe thresholdtemperature at
- which the gpu slows down
+ threshold
+
+
- tempTives the gpu current
- temperature
+ temp
+
+
ambientimagequality
-
@@ -2449,6 +2527,410 @@
+
+
+
+
+ Directory used as rootdirectory by the process
+ (this will be "/" unless the process did a chroot syscall)
+
+
+
+
+
+
+
+
+
+ Command line this process was invoked with
+
+
+
+
+
+
+
+
+
+ Current working directory of the process
+
+
+
+
+
+
+
+
+
+ Contents of a environment-var of the process
+
+
+
+
+
+
+
+
+
+ List of environment-vars that the process can see
+
+
+
+
+
+
+
+
+
+ Path to executed command that started the process
+
+
+
+
+
+
+
+
+
+ The nice value of the process
+
+
+
+
+
+
+
+
+
+ List of files that the process has open
+
+
+
+
+
+
+
+
+
+ The pid of the parent of the process
+
+
+
+
+
+
+
+
+
+ The priority of the process (see 'priority' in "man 5 proc")
+
+
+
+
+
+
+
+
+
+ Total number of bytes read by the process
+
+
+
+
+
+
+
+
+
+ State of the process
+
+
+
+
+
+
+
+
+
+ One of the chars in "RSDZTW" representing the state
+ of the process where R is running, S is sleeping in an
+ interruptible wait, D is waiting in uninterruptible disk sleep,
+ Z is zombie, T is traced or stopped (on a signal), and W is paging
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDERR of the process
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDIN of the process
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDOUT of the process
+
+
+
+
+
+
+
+
+
+ Number of threads in process containing this thread
+
+
+
+
+
+
+
+
+
+ List with pid's from threads from this process
+
+
+
+
+
+
+
+
+
+ Amount of time that the process has been scheduled in kernel mode in seconds
+
+
+
+
+
+
+
+
+
+ Amount of time that the process has been scheduled in user mode in seconds
+
+
+
+
+
+
+
+
+
+ Sum of $pid_time_kernelmode and $pid_time_usermode
+
+
+
+
+
+
+
+
+
+ The real uid of the process
+
+
+
+
+
+
+
+
+
+ The effective uid of the process
+
+
+
+
+
+
+
+
+
+ The saved set uid of the process
+
+
+
+
+
+
+
+
+
+ The file system uid of the process
+
+
+
+
+
+
+
+
+
+ The real gid of the process
+
+
+
+
+
+
+
+
+
+ The effective gid of the process
+
+
+
+
+
+
+
+
+
+ The saved set gid of the process
+
+
+
+
+
+
+
+
+
+ The file system gid of the process
+
+
+
+
+
+
+
+
+
+ Peak virtual memory size of the process
+
+
+
+
+
+
+
+
+
+ Virtual memory size of the process
+
+
+
+
+
+
+
+
+
+ Locked memory size of the process
+
+
+
+
+
+
+
+
+
+ Peak resident set size ("high water mark") of the process
+
+
+
+
+
+
+
+
+
+ Resident set size of the process
+
+
+
+
+
+
+
+
+
+ Data segment size of the process
+
+
+
+
+
+
+
+
+
+ Stack segment size of the process
+
+
+
+
+
+
+
+
+
+ Text segment size of the process
+
+
+
+
+
+
+
+
+
+ Shared library code size of the process
+
+
+
+
+
+
+
+
+
+ Page table entries size of the process
+
+
+
+
+
+
+
+
+
+ Total number of bytes written by the process
+
+
+
+
+
@@ -2474,9 +2956,9 @@
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
+ POP3 inboxes separately by passing arguments to this
object. Arguments are: "host user pass [-i interval (in
- seconds)] [-p port] [-e command] [-r retries]". Default
+ seconds)] [-p port] [-e 'command'] [-r retries]". 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
@@ -2492,9 +2974,9 @@
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
+ individual POP3 inboxes separately by passing arguments to
this object. Arguments are: "host user pass [-i interval
- (in seconds)] [-p port] [-e command] [-r retries]". Default
+ (in seconds)] [-p port] [-e 'command'] [-r retries]". 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
@@ -2551,15 +3033,22 @@
-
- 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 (when using this
- action and spaces_in_front is given conky places that many
- spaces in front of each item).
-
+
+ Download and parse RSS feeds. The interval may be
+ a floating point value greater than 0, otherwise
+ defaults to 15 minutes. Action may be one of the
+ following: feed_title, item_title (with num par),
+ item_desc (with num par) and item_titles (when using
+ this action and spaces_in_front is given conky places
+ that many spaces in front of each item). This object is
+ threaded, and once a thread is created it can't be
+ explicitly destroyed. One thread will run for each URI
+ specified. You can use any protocol that Curl
+ supports.
+
@@ -2574,6 +3063,15 @@
+
+
+
+ Number of running (runnable) threads. Linux only.
+
+
+
+
+
@@ -2583,11 +3081,10 @@
may also contain variables. 'step' is optional and defaults
to 1 if not set. If a var creates output on multiple lines
then the lines are placed behind each other separated with
- a '|'-sign. The effect of $color is disabled inside scroll.
- If you want spaces between the start and the end of 'text',
- place them at the end of 'text' not at the front ("4 foobar"
- can generate "arfo" but "4 foobar " will keep the space like
- this "ar f").
+ a '|'-sign. If you change the textcolor inside $scroll it
+ will automatically have it's old value back at the end of
+ $scroll. The end and the start of text will be separated by
+ 'length' number of spaces.
@@ -2770,12 +3267,12 @@
-
+
- Displays last 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.
+ Displays last N lines of supplied text file. The
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
@@ -2784,12 +3281,11 @@
- (ip4 only at present)
- TCP port monitor for specified local ports. Port
- numbers must be in the range 1 to 65535. Valid items
- are:
+ TCP port (both IPv6 and IPv4) monitor for
+ specified local ports. Port numbers must be in
+ the range 1 to 65535. Valid items are:count
@@ -2935,14 +3431,14 @@
- ${template1
+ ${template1
${template2\ disk\ root}
- /}
+ /}
- disk root:
+ disk root:
${fs_free /} / ${fs_size
- /}
+ /}
@@ -2964,7 +3460,19 @@
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 interval at least 6 seconds.
- See also $execi.
+ See also $execi. This object will clean up the thread when
+ it is destroyed, so it can safely be used in a nested
+ fashion, though it may not produce the desired behaviour if
+ used this way.
+
+
+
+
+
+
+
+
+ Total threads
@@ -2995,7 +3503,7 @@
-
+
This takes arguments in the form:top (name)
(number) Basically, processes are ranked from highest to
@@ -3010,7 +3518,7 @@
-
+
Same as top, except sorted by the amount of I/O
the process has done during the update interval
@@ -3021,7 +3529,7 @@
-
+
Same as top, except sorted by mem usage instead
of cpu
@@ -3032,7 +3540,7 @@
-
+
Same as top, except sorted by total CPU time
instead of current CPU usage
@@ -3079,7 +3587,7 @@
-
+
Local time for specified timezone, see man
strftime to get more information about format. The timezone
@@ -3091,6 +3599,26 @@
+
+
+
+
+ Name of group with this gid
+
+
+
+
+
+
+
+
+
+ Username of user with this uid
+
+
+
+
+
@@ -3244,6 +3772,17 @@
+
+
+
+
+ Lists how long the user for the given console has been
+ logged in for
+
+
+
+
+
@@ -3289,81 +3828,92 @@
-
+
Download, parse and display METAR data.
- For the 'URI', there are two possibilities:
-
-
- http://weather.noaa.gov/pub/data/observations/metar/stations/
-
-
- http://xoap.weather.com/weather/local/
-
-
- The first one is free to use but the second requires you to
- register and obtain your partner ID and license key.
- These two must be written, separated by a space, into a file
- called .xoaprc which needs to be placed into your home directory.
-
- 'locID' must be a valid location identifier for the required
- uri. For the NOAA site this must be a valid ICAO
- (see for instance https://pilotweb.nas.faa.gov/qryhtml/icao/).
- For the weather.com site this must be a valid location ID
- (see for instance http://aspnetresources.com/tools/locid.aspx).
-
+ For the 'URI', there are two
+ possibilities:
+
+
+ http://weather.noaa.gov/pub/data/observations/metar/stations/
+
+ http://xoap.weather.com/weather/local/
+
+ The first one is free to use but the second
+ requires you to register and obtain your partner ID and
+ license key. These two must be written, separated by a
+ space, into a file called .xoaprc which needs to be
+ placed into your home directory.
+ 'locID' must be a valid location identifier for
+ the required uri. For the NOAA site this must be a
+ valid ICAO (see for instance
+ https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
+ weather.com site this must be a valid location ID (see
+ for instance
+ http://aspnetresources.com/tools/locid.aspx).'data_type' must be one of the following:last_update
-
+ The date and time stamp of the data.
+ The result depends on the URI used. For the
+ NOAA site it is date (yyyy/mm/dd) and UTC time.
+ For the weather.com one it is date
+ ([m]m/[d]d/yy) and Local Time of the
+ station.temperature
-
+ units)
cloud_cover
-
+ The highest cloud cover statuspressure
-
+ Air pressure in millibarwind_speed
-
+ Wind speed in km/hwind_dir
-
+ Wind directionwind_dir_DEG
-
+ Compass wind directionhumidity
-
+ Relative humidity in %weather
-
+ weather.com site since this data is aggregated
+ into the cloud_cover one
+
+
+ icon
+ Weather icon (only for
+ www.weather.com). Can be used together with the
+ icon kit provided upon registering to their
+ service.'delay_in_minutes' (optional, default 30) cannot
- be lower than 30 min.
+ be less than 30 minutes.
+ This object is threaded, and once a thread is
+ created it can't be explicitly destroyed. One thread
+ will run for each URI specified.Note that these variables are still EXPERIMENTAL
and can be subject to many future changes.
@@ -3371,6 +3921,87 @@
+
+
+
+
+
+ Download, parse and display weather forecast data
+ for a given day (daytime only).
+ For the 'URI', for the time being only
+ http://xoap.weather.com/weather/local/ is
+ supported. See 'weather' above for details of usage
+ 'locID', see 'weather' above.
+ 'day' is a number from 0 (today) to 4 (3 days
+ after tomorrow).
+ 'data_type' must be one of the following:
+
+
+ day
+
+
+
+ date
+
+
+
+ low
+
+
+
+ hi
+
+
+
+ icon
+
+
+
+ forecast
+
+
+
+ wind_speed
+
+
+
+ wind_dir
+
+
+
+ wind_dir_DEG
+
+
+
+ humidity
+
+
+
+ precipitation
+
+
+
+ 'delay_in_minutes' (optional, default 210) cannot
+ be lower than 210 min.
+ This object is threaded, and once a thread is
+ created it can't be explicitly destroyed. One thread
+ will run for each URI specified. You can use any
+ protocol that Curl supports.
+ Note that these variables are still EXPERIMENTAL
+ and can be subject to many future changes.
+
+
+
+
+