X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fvariables.xml;h=bc5c36cf18f654a13eb2cca0aff8a831738797e1;hb=0c83d64a86fcaf4741f5fdf0013df7f9e48e30ac;hp=0b4a4f0b4cdd1268755f9081050bb017d36afd31;hpb=37e2bb471b08873eee421b9d4c4ec5cd7b7bd514;p=monky
diff --git a/doc/variables.xml b/doc/variables.xml
index 0b4a4f0..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,13 +539,24 @@
+
+
+
+
+ PID of the first process that has string in it's
+ commandline
+
+
+
+
+ Change drawing color to 'color' which is a name of
a color or a hexcode preceded with # (for example #0A1B2C ).
- In ncurses the following colors are supported:
+ If you use ncurses only the following colors are supported:
red,green,yellow,blue,magenta,cyan,black,white.
@@ -564,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
@@ -657,7 +671,7 @@
-
+
Download data from URI using Curl at the
@@ -665,7 +679,7 @@
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 explicitely destroyed.
+ 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.
@@ -913,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
@@ -1098,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)
+
+
+
+
+
@@ -1251,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.
@@ -1563,8 +1600,7 @@
digits.
stringArgument is enclosed in
- quotation mark or the checks for double and long failed
- before.
+ quotation marks (")
Valid operands are: '>', '<', '>=',
'<=', '==', '!='.
@@ -1698,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
@@ -1716,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
@@ -1786,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.
@@ -1794,7 +1831,7 @@
-
Load1 average graph, similar to xload, with
@@ -2402,11 +2439,15 @@
other values as integer.
- thresholdThe thresholdtemperature at
- which the gpu slows down
+ threshold
+
+
- tempTives the gpu current
- temperature
+ temp
+
+
ambientimagequality
-
@@ -2486,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
+
+
+
+
+
@@ -2511,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
@@ -2529,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
@@ -2600,7 +3045,7 @@
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
- explicitely destroyed. One thread will run for each URI
+ explicitly destroyed. One thread will run for each URI
specified. You can use any protocol that Curl
supports.
@@ -2618,6 +3063,15 @@
+
+
+
+ Number of running (runnable) threads. Linux only.
+
+
+
+
+
@@ -2629,7 +3083,7 @@
then the lines are placed behind each other separated with
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 seperated by
+ $scroll. The end and the start of text will be separated by
'length' number of spaces.
@@ -2827,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
@@ -2978,14 +3431,14 @@
- ${template1
+ ${template1
${template2\ disk\ root}
- /}
+ /}
- disk root:
+ disk root:
${fs_free /} / ${fs_size
- /}
+ /}
@@ -3016,6 +3469,15 @@
+
+
+
+ Total threads
+
+
+
+
+
@@ -3041,7 +3503,7 @@
-
+
This takes arguments in the form:top (name)
(number) Basically, processes are ranked from highest to
@@ -3056,7 +3518,7 @@
-
+
Same as top, except sorted by the amount of I/O
the process has done during the update interval
@@ -3067,7 +3529,7 @@
-
+
Same as top, except sorted by mem usage instead
of cpu
@@ -3078,7 +3540,7 @@
-
+
Same as top, except sorted by total CPU time
instead of current CPU usage
@@ -3125,7 +3587,7 @@
-
+
Local time for specified timezone, see man
strftime to get more information about format. The timezone
@@ -3137,6 +3599,26 @@
+
+
+
+
+ Name of group with this gid
+
+
+
+
+
+
+
+
+
+ Username of user with this uid
+
+
+
+
+
@@ -3290,6 +3772,17 @@
+
+
+
+
+ Lists how long the user for the given console has been
+ logged in for
+
+
+
+
+
@@ -3364,67 +3857,147 @@
last_update
-
+ 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
-
+ into the cloud_cover one
icon
-
+ 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 explicitely destroyed. One thread
+ 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.
+
+
+
+
+
+
+
+
+
+
+ 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.
-
+