Fix for imap docs.
authorBrenden Matthews <brenden@rty.ca>
Thu, 7 May 2009 19:16:26 +0000 (13:16 -0600)
committerBrenden Matthews <brenden@rty.ca>
Thu, 7 May 2009 19:16:26 +0000 (13:16 -0600)
README
doc/variables.xml

diff --git a/README b/README
index 618a8f2..5471a06 100644 (file)
--- a/README
+++ b/README
@@ -1122,20 +1122,22 @@ conky(1)                                                              conky(1)
               Displays the number of messages in your global IMAP inbox by de‐
               fault.  You  can  define  individual  IMAP inboxes seperately by
               passing arguments to this object. Arguments are: "host user pass
               Displays the number of messages in your global IMAP inbox by de‐
               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‐
-              tries before giving up is 5. If the password is supplied as '*',
-              you will be prompted to enter the password when Conky starts.
+              [-i  interval] [-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  prompted  to
+              enter the password when Conky starts.
 
 
        \e[1mimap_unseen (args)\e[0m
               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 object. Arguments are: "host user pass
 
 
        \e[1mimap_unseen (args)\e[0m
               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 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‐
-              tries before giving up is 5. If the password is supplied as '*',
-              you will be prompted to enter the password when Conky starts.
+              [-i interval] [-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 prompted to
+              enter the password when Conky starts.
 
 
        \e[1mioscheduler disk\e[0m
 
 
        \e[1mioscheduler disk\e[0m
index 85d033d..5070753 100644 (file)
                        <option>(args)</option>
                </term>
                <listitem>
                        <option>(args)</option>
                </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.  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 retries before giving up is 5.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
+                       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.  Arguments are: "host user pass [-i interval] [-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 prompted to enter the password when Conky starts.
                        <para></para></listitem>
        </varlistentry>
 
                        <para></para></listitem>
        </varlistentry>
 
                        <option>(args)</option>
                </term>
                <listitem>
                        <option>(args)</option>
                </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 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 retries before giving up is 5.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
+                       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 object.  Arguments are: "host user pass [-i interval] [-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 prompted to enter the password when Conky starts.
                        <para></para></listitem>
        </varlistentry>
 
                        <para></para></listitem>
        </varlistentry>