Conky 1.5.0 -- client/server prototype
[monky] / README
diff --git a/README b/README
index a9a2688..0b4e1fc 100644 (file)
--- a/README
+++ b/README
@@ -43,11 +43,10 @@ COMPILING
 
        ./configure     --prefix=/usr      --mandir=/usr/share/man       --in-
        fodir=/usr/share/info  --datadir=/usr/share  --sysconfdir=/etc --local-
-       statedir=/var/lib --enable-xft --enable-own-window --enable-proc-uptime
-       --enable-audacious  --enable-bmpx  --enable-seti --enable-hddtemp --en-
-       able-mpd --enable-xmms2 --enable-imlib2 --enable-portmon  --enable-ml-
-       donkey  --enable-debug  --enable-double-buffer  --enable-xdamage         --en-
-       able-x11
+       statedir=/var/lib --disable-own-window --enable-audacious --enable-bmpx
+       --disable-hddtemp --disable-mpd --enable-xmms2 --disable-portmon --dis-
+       able-network   --enable-debug   --disable-x11   --disable-double-buffer
+       --disable-xdamage --disable-xft
 
        make
 
@@ -153,10 +152,6 @@ CONFIGURATION SETTINGS
              started
 
 
-       on_bottom
-             Set Conky on the bottom of all other applications
-
-
        border_margin
              Border margin in pixels
 
@@ -173,12 +168,26 @@ CONFIGURATION SETTINGS
              Default color and border color
 
 
+       default_outline_color
+             Default outline color
+
+
        default_shade_color
              Default shading color and border's shading color
 
 
-       default_outline_color
-             Default outline color
+       dexter_client
+             Act as client and connect to libdexter server for  remote  moni-
+             toring?
+
+
+       dexter_config
+             Full path to libdexter configuration file (default search order:
+             $HOME/.dexterrc; /etc/libdexter/dexter.conf)
+
+
+       dexter_server
+             Act as server for libdexter services?
 
 
        double_buffer
@@ -195,23 +204,23 @@ CONFIGURATION SETTINGS
              Draw borders around graphs?
 
 
-       draw_shades
-             Draw shades?
-
-
        draw_outline
              Draw outlines?
 
 
+       draw_shades
+             Draw shades?
+
+
        font   Font name in X, xfontsel can be used to get a nice font
 
 
-       gap_x  Gap between right or left border of screen, same as  passing  -x
-             at command line
+       gap_x  Gap, in pixels, between right or left border of screen, same  as
+             passing -x at command line, e.g. gap_x 10
 
 
-       gap_y  Gap  between  top or bottom border of screen, same as passing -y
-             at command line
+       gap_y  Gap,  in pixels, between top or bottom border of screen, same as
+             passing -y at command line, e.g. gap_y 10.
 
 
        imap   Default global IMAP server. Arguments are: "host user  pass  [-i
@@ -221,46 +230,31 @@ CONFIGURATION SETTINGS
              ter the password when Conky starts.
 
 
-       no_buffers
-             Substract (file system) buffers from used memory?
-
-
        mail_spool
              Mail spool for mail checking
 
 
-       maximum_width pixels
-             Maximum width of window
-
-
-       minimum_size width (height)
-             Minimum size of window
-
-
-       min_port_monitors
-             Allow for the creation of at least this number of port  monitors
-             (if 0 or not set, default is 16)
-
-
-       min_port_monitor_connections
-             Allow  each port monitor to track at least this many connections
+       max_port_monitor_connections
+             Allow each port monitor to track at most this  many  connections
              (if 0 or not set, default is 256)
 
 
-       mldonkey_hostname
-             Hostname for mldonkey stuff, defaults to localhost
+       max_specials
+             Maximum  number  of special things, e.g. fonts, offsets, aligns,
+             etc. (default is 512)
 
 
-       mldonkey_port
-             Mldonkey port, 4001 default
+       max_user_text bytes
+             Maximum size of user text buffer, i.e. layout below TEXT line in
+             config file (default is 16384 bytes)
 
 
-       mldonkey_login
-             Mldonkey login, default none
+       maximum_width pixels
+             Maximum width of window
 
 
-       mldonkey_password
-             Mldonkey password, default none
+       minimum_size width (height)
+             Minimum size of window
 
 
        mpd_host
@@ -279,6 +273,10 @@ CONFIGURATION SETTINGS
              The number of samples to average for net data
 
 
+       no_buffers
+             Substract (file system) buffers from used memory?
+
+
        override_utf8_locale
              Force UTF8? requires XFT
 
@@ -287,6 +285,28 @@ CONFIGURATION SETTINGS
              Boolean, create own window to draw?
 
 
+       own_window_class
+             Manually set the WM_CLASS name. Defaults to "Conky".
+
+
+       own_window_colour colour
+             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)
+
+
+       own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
+             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
+             no meaning and are ignored.
+
+
+       own_window_title
+             Manually  set the window name. Defaults to "<hostname> - conky".
+
+
        own_window_transparent
              Boolean, set pseudo-transparency?
 
@@ -301,20 +321,6 @@ CONFIGURATION SETTINGS
              dow can be useful for certain situations.
 
 
-       own_window_colour colour
-             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)
-
-
-       own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
-             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
-             no meaning and are ignored.
-
-
        out_to_console
              Print text to stdout.
 
@@ -356,10 +362,6 @@ CONFIGURATION SETTINGS
              Use Xft (anti-aliased font and stuff)
 
 
-       wm_class_name
-             Manually set the WM_CLASS name. Defaults to "conky".
-
-
        xftalpha
              Alpha of Xft font. Must be a value at or between 1 and 0.
 
@@ -475,13 +477,19 @@ VARIABLES
              Player status (Playing/Paused/Stopped/Not running)
 
 
-       audacious_title
-             Title of current tune
+       audacious_title (max length)
+             Title of current tune with optional maximum length specifier
 
 
        battery (num)
-             Remaining  capacity  in ACPI or APM battery. ACPI battery number
-             can be given as argument (default is BAT0).
+             Battery  status and remaining percentage capacity of ACPI or APM
+             battery. ACPI battery number can be given as  argument  (default
+             is BAT0).
+
+
+       battery_time (num)
+             Battery  charge/discharge  time  remaining of ACPI battery. ACPI
+             battery number can be given as argument (default is BAT0).
 
 
        bmpx_artist
@@ -562,6 +570,18 @@ VARIABLES
        else   Text to show if any of the above are not true
 
 
+       entropy_avail
+             Current entropy available for crypto freaks
+
+
+       entropy_bar (height),(width)
+             Normalized bar of available entropy for crypto freaks
+
+
+       entropy_poolsize
+             Total size of system entropy pool for crypto freaks
+
+
        exec command
              Executes a shell command and displays the output in conky. warn-
              ing:  this  takes a lot more resources than other variables. I'd
@@ -701,7 +721,7 @@ VARIABLES
 
        i8k_cpu_tempf
              If running the i8k kernel driver for Inspiron laptops,  displays
-             the cpu temperature in Farenheit, as reported by /proc/i8k.
+             the cpu temperature in Fahrenheit, as reported by /proc/i8k.
 
 
        i8k_left_fan_rpm
@@ -781,7 +801,7 @@ VARIABLES
              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 110, de-
+             [-i  interval] [-p port] [-e command]". Default port is 143, de-
              fault interval is 5 minutes. If the password is supplied as '*',
              you will be prompted to enter the password when Conky starts.
 
@@ -790,7 +810,7 @@ VARIABLES
              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 110,  de-
+             [-i interval] [-p port] [-e command]". Default port is 143,  de-
              fault interval is 5 minutes. If the password is supplied as '*',
              you will be prompted to enter the password when Conky starts.
 
@@ -1109,18 +1129,6 @@ VARIABLES
              Uptime in a shorter format
 
 
-       seti_prog
-             Seti@home current progress
-
-
-       seti_progbar (height),(width)
-             Seti@home current progress bar
-
-
-       seti_credit
-             Seti@home total user credit
-
-
        voffset (pixels)
              Change  vertical  offset by N pixels. Negative values will cause
              text to overlap. See also $offset.