* Add option to specify number of retries for IMAP/POP3 stuff (via -r)
[monky] / README
diff --git a/README b/README
index 26939f8..7060cc7 100644 (file)
--- a/README
+++ b/README
@@ -243,10 +243,11 @@ conky(1)                                                        conky(1)
 
 
        1mimap  22mDefault global IMAP server. Arguments are: "host user  pass  [-i
-             interval]  [-f  folder] [-p port] [-e command]". Default port is
-             143, default folder is ’INBOX’, default interval is  5  minutes.
-             If  the password is supplied as ’*’, you will be prompted to en‐
-             ter the password when Conky starts.
+             interval]  [-f folder] [-p port] [-e command] [-r retries]". De‐
+             fault 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.
 
 
        1mmail_spool0m
@@ -254,12 +255,12 @@ conky(1)                                                        conky(1)
 
 
        1mmax_port_monitor_connections0m
-             Allow each port monitor to track at most this  many  connections
+             Allow  each  port monitor to track at most this many connections
              (if 0 or not set, default is 256)
 
 
        1mmax_specials0m
-             Maximum  number  of special things, e.g. fonts, offsets, aligns,
+             Maximum number of special things, e.g. fonts,  offsets,  aligns,
              etc. (default is 512)
 
 
@@ -269,12 +270,12 @@ conky(1)                                                        conky(1)
 
 
        1mtext_buffer_size bytes0m
-             Size  of  the  standard text buffer (default is 256 bytes). This
-             buffer is used for intermediary text, such as individual  lines,
-             output  from $exec vars, and various other variables. Increasing
-             the size of this buffer can drastically reduce  Conky’s  perfor‐
-             mance,  but  will  allow for more text display per variable. The
-             size of this buffer cannot be smaller than the default value  of
+             Size of the standard text buffer (default is  256  bytes).  This
+             buffer  is used for intermediary text, such as individual lines,
+             output from $exec vars, and various other variables.  Increasing
+             the  size  of this buffer can drastically reduce Conky’s perfor‐
+             mance, but will allow for more text display  per  variable.  The
+             size  of this buffer cannot be smaller than the default value of
              256 bytes.
 
 
@@ -299,7 +300,7 @@ conky(1)                                                          conky(1)
 
 
        1mmusic_player_interval0m
-             Music  player thread update interval (defaults to Conky’s update
+             Music player thread update interval (defaults to Conky’s        update
              interval)
 
 
@@ -324,21 +325,21 @@ conky(1)                                                        conky(1)
 
 
        1mown_window_colour colour0m
-             If own_window_transparent no, set a specified background  colour
-             (defaults  to  black).  Takes  either a hex value (#ffffff) or a
+             If  own_window_transparent no, set a specified background colour
+             (defaults to black). Takes either a hex  value  (#ffffff)  or  a
              valid RGB name (see /usr/lib/X11/rgb.txt)
 
 
        1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager0m
-             If own_window is yes, you may use these window manager hints  to
+             If  own_window is yes, you may use these window manager hints to
              affect the way Conky displays.  Notes: Use own_window_type desk‐
-             top as another way to implement many of these hints  implicitly.
-             If  you  use own_window_type override, window manager hints have
+             top  as another way to implement many of these hints implicitly.
+             If you use own_window_type override, window manager  hints  have
              no meaning and are ignored.
 
 
        1mown_window_title0m
-             Manually set the window name. Defaults to "<hostname> -  conky".
+             Manually  set the window name. Defaults to "<hostname> - conky".
 
 
        1mown_window_transparent0m
@@ -349,8 +350,8 @@ conky(1)                                                          conky(1)
              if own_window is yes, you may specify type normal, desktop, dock
              or override (default: normal).  Desktop windows are special win‐
              dows that have no window decorations; are always visible on your
-             desktop; do not appear in your pager or taskbar; and are  sticky
-             across  all workspaces.  Override windows are not under the con‐
+             desktop;  do not appear in your pager or taskbar; and are sticky
+             across all workspaces.  Override windows are not under the  con‐
              trol of the window manager. Hints are ignored. This type of win‐
              dow can be useful for certain situations.
 
@@ -363,10 +364,11 @@ conky(1)                                                        conky(1)
              Pad percentages to this many decimals (0 = no padding)
 
 
-       1mpop3  22mDefault  global  POP3 server. Arguments are: "host user pass [-i
-             interval] [-p port] [-e command]". Default port is 110,  default
-             interval  is  5 minutes. If the password is supplied as ’*’, you
-             will be prompted to enter the password when Conky starts.
+       1mpop3  22mDefault global POP3 server. Arguments are: "host user  pass  [-i
+             interval]  [-p port] [-e command] [-r retries]". Default port is
+             110, 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.
 
 
        1mshort_units0m
@@ -983,8 +985,9 @@ 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
-             [-i  interval] [-p port] [-e command]". Default port is 143, de‐
-             fault interval is 5 minutes. If the password is supplied as ’*’,
+             [-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.
 
 
@@ -992,8 +995,9 @@ conky(1)                                                          conky(1)
              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]". Default port is 143,  de‐
-             fault interval is 5 minutes. If the password is supplied as ’*’,
+             [-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.
 
 
@@ -1161,11 +1165,15 @@ conky(1)                                                              conky(1)
 
        1mnvidia threshold temp gpufreq memfreq imagequality0m
              Nvidia graficcard support for the XNVCtrl library.  Each  option
-             gives back one integer value: (threshold): the thresholdtempera‐
-             ture at which the gpu slows down (temp): gives the  gpu  current
-             temperature  (gpufreq):  gives  the  current gpu frequency (mem‐
-             freq): gives the current mem frequency (imagequality): which im‐
-             agequality should be choosen by OpenGL applications
+             can  be  shortened  to the least significant part.  Temperatures
+             are printed as float, all other values as integer.
+
+             1mthreshold22m: the thresholdtemperature at which the gpu slows down
+             1mtemp22m: gives the gpu current temperature
+             1mgpufreq22m: gives the current gpu frequency
+             1mmemfreq22m: gives the current mem frequency
+             1mimagequality22m: which imagequality should be choosen by OpenGL ap‐
+             plications
 
 
        1moutlinecolor (color)0m
@@ -1201,19 +1209,21 @@ conky(1)                                                              conky(1)
              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 object. Arguments are: "host user pass
-             [-i  interval] [-p port] [-e command]". Default port is 110, de‐
-             fault interval is 5 minutes. If the password is supplied as ’*’,
+             [-i interval] [-p port] [-e command] [-r retries]". Default port
+             is 110, 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.
 
 
        1mpop3_used (args)0m
-             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 this object. Arguments are:
-             "host user pass [-i interval] [-p port] [-e  command]".  Default
-             port  is  110, default interval is 5 minutes. If the password is
-             supplied as ’*’, you will be prompted to enter the password when
-             Conky starts.
+             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 this object.  Arguments  are:
+             "host  user  pass  [-i  interval] [-p port] [-e command] [-r re‐
+             tries]". 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
+             when Conky starts.
 
 
        1mpre_exec shell command0m