Add $nodename_short.
[monky] / doc / variables.xml
index a39a1fc..38168c1 100644 (file)
@@ -4,8 +4,11 @@
             <command>
                 <option>acpiacadapter</option>
             </command>
+            <option>(adapter)</option>
         </term>
-        <listitem>ACPI ac adapter state. 
+        <listitem>ACPI ac adapter state. On linux, the adapter option specifies the
+        subfolder of /sys/class/power_supply containing the state information (tries "AC"
+        and "ADP1" if there is no argument given). Non-linux systems ignore it.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
     <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>
             <option>var1 var2</option>
         </term>
         <listitem>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
             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.</para>
         </listitem>
     <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>
             digits.</member>
             <member>
             <command>string</command>Argument is enclosed in
-            quotation mark or the checks for double and long failed
-            before.</member>
+            quotation marks (")</member>
         </simplelist>Valid operands are: '&gt;', '&lt;', '&gt;=',
         '&lt;=', '==', '!='. 
         <para /></listitem>
         </term>
         <listitem>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
         port is 143, default folder is 'INBOX', default interval is
         </term>
         <listitem>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]".
         Default port is 143, default folder is 'INBOX', default
             <option>(device)</option>
         </term>
         <listitem>Prints the mixer value as reported by the OS.
-        Default mixer is "vol", but you can specify one of the
-        following optional arguments: "vol", "bass", "treble",
-        "synth", "pcm", "speaker", "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
-        &lt;linux/soundcard.h&gt; (on Linux), &lt;soundcard.h&gt;
-        (on OpenBSD), or &lt;sys/soundcard.h&gt; to find the exact
-        options available on your system. 
+        Default mixer is "Master", but you can specify one of the
+        available ALSA Simple mixer controls.
+        You can find the list of those available on your system
+        using amixer.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
         <listitem>Hostname 
         <para /></listitem>
     </varlistentry>
+     <varlistentry>
+        <term>
+            <command>
+                <option>nodename_short</option>
+            </command>
+        </term>
+        <listitem>Short hostname (same as 'hostname -s' shell command).
+        <para /></listitem>
+    </varlistentry>
     <varlistentry>
         <term>
             <command>
             </member>
             <member>
                 <command>imagequality</command>
-                <option>Which imagequality should be choosen by
+                <option>Which imagequality should be chosen by
                 OpenGL applications</option>
             </member>
         </simplelist>
     <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>
     <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>
         </term>
         <listitem>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
         port is 110, default interval is 5 minutes, and default
         </term>
         <listitem>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
         port is 110, default interval is 5 minutes, and default
             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.</para>
         </listitem>
     <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>
         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. 
         <para /></listitem>
     </varlistentry>
                 <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>
                         </row>
                         <row>
                             <entry>
-                                <programlisting>${template1
+                                ${template1
                                 ${template2\ disk\ root}
-                                /}</programlisting>
+                                /}
                             </entry>
                             <entry>
-                                <programlisting>disk root:
+                                disk root:
                                 ${fs_free /} / ${fs_size
-                                /}</programlisting>
+                                /}
                             </entry>
                         </row>
                     </tbody>
     <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>
             <para>'delay_in_minutes' (optional, default 30) cannot
             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
+            created it can't be explicitly destroyed. One thread
             will run for each URI specified.</para>
             <para>Note that these variables are still EXPERIMENTAL
             and can be subject to many future changes.</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
+            created it can't be explicitly destroyed. One thread
             will run for each URI specified. You can use any
             protocol that Curl supports.</para>
             <para>Note that these variables are still EXPERIMENTAL