unset PAGER before generating README
[monky] / doc / variables.xml
index 8b969a7..2ee6fb0 100644 (file)
     <varlistentry>
         <term>
             <command>
+                <option>cmdline_to_pid</option>
+            </command>
+            <option>string</option>
+        </term>
+        <listitem>PID of the first process that has string in it's
+       commandline
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>color</option>
             </command>
             <option>(color)</option>
             <command>
                 <option>curl</option>
             </command>
-            <option>url interval_in_minutes</option>
+            <option>url (interval_in_minutes)</option>
         </term>
         <listitem>
             <para>Download data from URI using Curl at the
             </command>
             <option>string</option>
         </term>
-        <listitem>Evalutates given string according to the rules of
+        <listitem>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
     <varlistentry>
         <term>
             <command>
+                <option>format_time</option>
+            </command>
+            <option>seconds format</option>
+        </term>
+        <listitem>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)
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>forwarded_mails</option>
             </command>
             <option>(maildir)</option>
             <command>
                 <option>hddtemp</option>
             </command>
-            <option>dev, (host,(port))</option>
+            <option>(dev)</option>
         </term>
         <listitem>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.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
         IMAP inbox by default. You can define individual IMAP
         inboxes seperately 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
         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 (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
             <option>(1|2|3)</option>
         </term>
         <listitem>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.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
             <command>
                 <option>loadgraph</option>
             </command>
-            <option>(1|2|3) (height),(width) (gradient colour 1)
+            <option>(height),(width) (gradient colour 1)
             (gradient colour 2) (scale) (-t) (-l)</option>
         </term>
         <listitem>Load1 average graph, similar to xload, with
         other values as integer. 
         <simplelist>
             <member>
-            <command>threshold</command>The thresholdtemperature at
-            which the gpu slows down</member>
+               <command>threshold</command>
+               <option>The thresholdtemperature at
+                       which the gpu slows down</option>
+            </member>
             <member>
-            <command>temp</command>Tives the gpu current
-            temperature</member>
+               <command>temp</command>
+               <option>Gives the gpu current
+                       temperature</option>
+            </member>
             <member>
                 <command>ambient</command>
                 <option>Gives current air temperature near GPU
     <varlistentry>
         <term>
             <command>
+                <option>pid_chroot</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Directory used as rootdirectory by the process
+       (this will be "/" unless the process did a chroot syscall)
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_cmdline</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Command line this process was invoked with
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_cwd</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Current working directory of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_environ</option>
+            </command>
+            <option>pid varname</option>
+        </term>
+        <listitem>Contents of a environment-var of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_environ_list</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>List of environment-vars that the process can see
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_exe</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Path to executed command that started the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_nice</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The nice value of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_openfiles</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>List of files that the process has open
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_parent</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The pid of the parent of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_priority</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The priority of the process (see 'priority' in "man 5 proc")
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_read</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Total number of bytes read by the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_state</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>State of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_state_short</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>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
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_stderr</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Filedescriptor binded to the STDERR of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_stdin</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Filedescriptor binded to the STDIN of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_stdout</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Filedescriptor binded to the STDOUT of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_threads</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Number of threads in process containing this thread
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_thread_list</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>List with pid's from threads from this process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_time_kernelmode</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_time_usermode</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Amount of time that the process has been scheduled in user mode in seconds
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_time</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_uid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The real uid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_euid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The effective uid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_suid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The saved set uid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_fsuid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The file system uid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_gid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The real gid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_egid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The effective gid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_sgid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The saved set gid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_fsgid</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>The file system gid of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmpeak</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Peak virtual memory size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmsize</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Virtual memory size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmlck</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Locked memory size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmhwm</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Peak resident set size ("high water mark") of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmrss</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Resident set size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmdata</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Data segment size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmstk</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Stack segment size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmexe</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Text segment size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmlib</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Shared library code size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_vmpte</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Page table entries size of the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>pid_write</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Total number of bytes written by the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>platform</option>
             </command>
             <option>(dev) type n (factor offset)</option>
         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 (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
         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
-        (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
     <varlistentry>
         <term>
             <command>
+                <option>running_threads</option>
+            </command>
+        </term>
+        <listitem>Number of running (runnable) threads. Linux only.
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>scroll</option>
             </command>
             <option>length (step) text</option>
                 <option>tcp_portmon</option>
             </command>
             <option>port_begin port_end item (index)</option>
-            <emphasis>(ip4 only at present)</emphasis>
         </term>
         <listitem>
-            <para>TCP port monitor for specified local ports. Port
-            numbers must be in the range 1 to 65535. Valid items
-            are:</para>
+            <para>TCP port (both IPv6 and IPv4) monitor for
+            specified local ports. Port numbers must be in
+            the range 1 to 65535. Valid items are:</para>
             <simplelist>
                 <member>
                     <command>count</command>
     <varlistentry>
         <term>
             <command>
+                <option>threads</option>
+            </command>
+        </term>
+        <listitem>Total threads
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>time</option>
             </command>
             <option>(format)</option>
             <command>
                 <option>top</option>
             </command>
-            <option>type, num</option>
+            <option>type num</option>
         </term>
         <listitem>This takes arguments in the form:top (name)
         (number) Basically, processes are ranked from highest to
             <command>
                 <option>top_io</option>
             </command>
-            <option>type, num</option>
+            <option>type num</option>
         </term>
         <listitem>Same as top, except sorted by the amount of I/O
         the process has done during the update interval 
             <command>
                 <option>top_mem</option>
             </command>
-            <option>type, num</option>
+            <option>type num</option>
         </term>
         <listitem>Same as top, except sorted by mem usage instead
         of cpu 
             <command>
                 <option>top_time</option>
             </command>
-            <option>type, num</option>
+            <option>type num</option>
         </term>
         <listitem>Same as top, except sorted by total CPU time
         instead of current CPU usage 
             <command>
                 <option>tztime</option>
             </command>
-            <option>(timezone) (format)</option>
+            <option>(timezone (format))</option>
         </term>
         <listitem>Local time for specified timezone, see man
         strftime to get more information about format. The timezone
     <varlistentry>
         <term>
             <command>
+                <option>gid_name</option>
+            </command>
+            <option>gid</option>
+        </term>
+        <listitem>Name of group with this gid
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>uid_name</option>
+            </command>
+            <option>uid</option>
+        </term>
+        <listitem>Username of user with this uid
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>unflagged_mails</option>
             </command>
             <option>(maildir)</option>
     <varlistentry>
         <term>
             <command>
+                <option>user_time</option>
+            </command>
+           <option>console</option>
+        </term>
+        <listitem>Lists how long the user for the given console has been
+        logged in for
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>utime</option>
             </command>
             <option>(format)</option>
             <simplelist>
                 <member>
                     <command>last_update</command>
-                    <option>The date and time stamp of the data.
+                    <para>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.</option>
+                    station.</para>
                 </member>
                 <member>
                     <command>temperature</command>
-                    <option>Air temperature (you can use the
+                                       <para>Air temperature (you can use the
                     'temperature_unit' config setting to change
-                    units)</option>
+                                       units)</para>
                 </member>
                 <member>
                     <command>cloud_cover</command>
-                    <option>The highest cloud cover status</option>
+                    <para>The highest cloud cover status</para>
                 </member>
                 <member>
                     <command>pressure</command>
-                    <option>Air pressure in millibar</option>
+                    <para>Air pressure in millibar</para>
                 </member>
                 <member>
                     <command>wind_speed</command>
-                    <option>Wind speed in km/h</option>
+                    <para>Wind speed in km/h</para>
                 </member>
                 <member>
                     <command>wind_dir</command>
-                    <option>Wind direction</option>
+                    <para>Wind direction</para>
                 </member>
                 <member>
                     <command>wind_dir_DEG</command>
-                    <option>Compass wind direction</option>
+                    <para>Compass wind direction</para>
                 </member>
                 <member>
                     <command>humidity</command>
-                    <option>Relative humidity in %</option>
+                    <para>Relative humidity in %</para>
                 </member>
                 <member>
                     <command>weather</command>
-                    <option>Any relevant weather event (rain, snow,
+                    <para>Any relevant weather event (rain, snow,
                     etc.). This is not used if you are querying the
                     weather.com site since this data is aggregated
-                    into the cloud_cover one</option>
+                    into the cloud_cover one</para>
                 </member>
                 <member>
                     <command>icon</command>
-                    <option>Weather icon (only for
+                    <para>Weather icon (only for
                     www.weather.com). Can be used together with the
                     icon kit provided upon registering to their
-                    service.</option>
+                    service.</para>
                 </member>
             </simplelist>
             <para>'delay_in_minutes' (optional, default 30) cannot
-            be lower than 30 min.</para>
+            be less than 30 minutes.</para>
             <para>This object is threaded, and once a thread is
             created it can't be explicitely destroyed. One thread
-            will run for each URI specified. You can use any
-            protocol that Curl supports.</para>
+            will run for each URI specified.</para>
             <para>Note that these variables are still EXPERIMENTAL
             and can be subject to many future changes.</para>
         </listitem>
             <para>'data_type' must be one of the following:</para>
             <simplelist>
                 <member>
+                    <command>day</command>
+                                       <option>Day of the week</option>
+                               </member>
+                <member>
+                    <command>date</command>
+                                       <option>Date, in the form MMM DD (ie. Jul 14)</option>
+                               </member>
+                <member>
                     <command>low</command>
                                        <option>Minimun temperature (you can use the
                     'temperature_unit' config setting to change
                     units)</option>
-               </member>
+                               </member>
                 <member>
-                    <command>high</command>
+                    <command>hi</command>
                                        <option>Maximum temperature (you can use the
                     'temperature_unit' config setting to change
                     units)</option>
-               </member>
+                               </member>
                 <member>
                     <command>icon</command>
                     <option>Weather icon. Can be used together with the
                     icon kit provided upon registering to the weather.com
                     service</option>
-               </member>
+                               </member>
                 <member>
                     <command>forecast</command>
                     <option>Weather forecast (sunny, rainy, etc.)</option>
-               </member>
+                               </member>
                 <member>
                     <command>wind_speed</command>
                     <option>Wind speed in km/h</option>
                                        precipitation (in %)</option>
                 </member>
             </simplelist>
-            <para>'delay_in_minutes' (optional, default 150) cannot
-            be lower than 150 min.</para>
+            <para>'delay_in_minutes' (optional, default 210) cannot
+            be lower than 210 min.</para>
             <para>This object is threaded, and once a thread is
             created it can't be explicitely destroyed. One thread
             will run for each URI specified. You can use any