adding man page file
authorBrenden Matthews <brenden1@rty.ca>
Tue, 15 Nov 2005 18:07:31 +0000 (18:07 +0000)
committerBrenden Matthews <brenden1@rty.ca>
Tue, 15 Nov 2005 18:07:31 +0000 (18:07 +0000)
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky@412 7f574dfc-610e-0410-a909-a81674777703

doc/conky.1 [new file with mode: 0644]

diff --git a/doc/conky.1 b/doc/conky.1
new file mode 100644 (file)
index 0000000..28c6e4f
--- /dev/null
@@ -0,0 +1,815 @@
+.\" -*- coding: us-ascii -*-
+.TH conky 1 2005-11-1  
+.SH NAME
+conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
+.SH SYNOPSIS
+.ad l
+\fBconky\fR \kx
+.if (\nxu > (\n(.lu / 2)) .nr x (\n(.lu / 5)
+'in \n(.iu+\nxu
+[\fBoptions\fR]
+'in \n(.iu-\nxu
+.ad b
+.SH DESCRIPTION
+Conky is a system monitor for X originally based on the torsmo code. 
+Since it's original conception, Conky has changed a fair bit from it's predecessor. 
+Conky can display just about anything, either on your root desktop or in it's own window. 
+Conky has many built-in objects, as well as the ability to execute programs and scripts, 
+then display the output from stdout.
+.PP
+We are always looking for help, and anyone interested in becoming a developer is welcome. 
+Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
+.PP
+Thanks for your interest in Conky.
+.SH COMPILING
+For users compiling from source, make sure you have the X development libraries installed. 
+This should be a package along the lines of "libx11-dev or xorg-x11-dev". 
+.PP
+Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
+There is also usually an up-to-date ebuild within Conky's package or in CVS.
+.PP
+Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then 
+Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install. 
+.PP
+Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
+.TP 
+\fBsh autogen.sh\fR \fB# Only required if building from CVS\fR 
+.TP 
+\fB\&./configure \fR\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-enable\-xft \-\-enable\-seti \-\-enable\-double\-buffer \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-mpd \-\-enable\-mldonkey \-\-enable\-x11 \-\-enable\-portmon\fR 
+.TP 
+\fBmake\fR 
+.TP 
+\fBmake install\fR \fB# Optional\fR 
+.TP 
+\fBsrc/conky\fR 
+.PP
+Conky probably doesn't compile with compilers other than gcc and icc. 
+It doesn't compile with C89 compiler and not even with pure C99.
+It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(), 
+optarg variable with getopt() and long long (not in C89). Crashes in file system
+statistics stuff when compiled with icc, I don't know exactly why.
+.PP
+You can disable 'drawing to own window' feature in case you don't need it by passing 
+--disable-own-window to configure -script.
+.PP
+.SH "YOU SHOULD KNOW"
+Conky is generally very good on resources. However, certain objects in
+Conky are harder on resources then others. In particular, the $tail,
+$top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
+.PP
+If you do use them, please do not complain about memory or CPU usage, 
+unless you think something's seriously wrong (mem leak, etc.).
+.PP
+An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
+Saves you the trouble of having to kill and then restart.
+.PP
+IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff. 
+mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
+.SH OPTIONS
+Command line options override configurations defined in configuration file.
+.TP 
+\fB\-v | \-V\fR
+Prints version and exits
+
+.TP 
+\fB\-a \fR\fBALIGNMENT\fR
+Text alignment on screen, {top,bottom}_{left,right} or none
+
+.TP 
+\fB\-b\fR
+Use double buffering (eliminates "flicker")
+
+.TP 
+\fB\-c \fR\fBFILE\fR
+Config file to load instead of $HOME/.conkyrc
+
+.TP 
+\fB\-d\fR
+Daemonize Conky, aka fork to background
+
+.TP 
+\fB\-f \fR\fBFONT\fR
+Font to use
+
+.TP 
+\fB\-h\fR
+Prints command line help and exits
+
+.TP 
+\fB\-o\fR
+Create own window to draw
+
+.TP 
+\fB\-t \fR\fBTEXT\fR
+Text to render, remember single quotes, like -t ' $uptime '
+
+.TP 
+\fB\-u \fR\fBSECONDS\fR
+Update interval
+
+.TP 
+\fB\-w \fR\fBWIN_ID\fR
+Window id to draw
+
+.TP 
+\fB\-x \fR\fBX_COORDINATE\fR
+X position
+
+.TP 
+\fB\-y \fR\fBY_COORDINATE\fR
+Y position
+
+.SH "CONFIGURATION SETTINGS"
+Default configuration file is $HOME/.conkyrc (can be changed from
+conky.c among other things). See conkyrc.sample. If installing from Debian package, 
+this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
+.PP
+You might want to copy it to $HOME/.conkyrc and then start modifying it.
+Other configs can be found at http://conky.sf.net
+.TP 
+\fBalignment\fR
+Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
+
+.TP 
+\fBbackground\fR
+Boolean value, if true, Conky will be forked to background when started
+
+.TP 
+\fBon_bottom\fR
+Set conky on the bottom of all other applications
+
+.TP 
+\fBborder_margin\fR
+Border margin in pixels
+
+.TP 
+\fBborder_width\fR
+Border width in pixels
+
+.TP 
+\fBcpu_avg_samples\fR
+The number of samples to average for CPU monitoring
+
+.TP 
+\fBdefault_color\fR
+Default color and border color
+
+.TP 
+\fBdefault_shade_color\fR
+Default shading color and border's shading color
+
+.TP 
+\fBdefault_outline_color\fR
+Default outline color
+
+.TP 
+\fBdouble_buffer\fR
+Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
+
+.TP 
+\fBdraw_borders\fR
+Draw borders around text?
+
+.TP 
+\fBdraw_shades\fR
+Draw shades?
+
+.TP 
+\fBdraw_outline\fR
+Draw outlines?
+
+.TP 
+\fBfont\fR
+Font name in X, xfontsel can be used to get a nice font
+
+.TP 
+\fBgap_x\fR
+Gap between right or left border of screen, same as passing -x at command line
+
+.TP 
+\fBgap_y\fR
+Gap between top or bottom border of screen, same as passing -y at command line
+
+.TP 
+\fBno_buffers\fR
+Substract (file system) buffers from used memory?
+
+.TP 
+\fBmail_spool\fR
+Mail spool for mail checking
+
+.TP 
+\fBmaximum_width\fR \fBpixels\fR 
+Maximum width of window
+
+.TP 
+\fBminimum_size\fR \fBwidth (height)\fR 
+Minimum size of window
+
+.TP 
+\fBmldonkey_hostname\fR
+Hostname for mldonkey stuff, defaults to localhost
+
+.TP 
+\fBmldonkey_port\fR
+Mldonkey port, 4001 default
+
+.TP 
+\fBmldonkey_login\fR
+Mldonkey login, default none
+
+.TP 
+\fBmldonkey_password\fR
+Mldonkey password, default none
+
+.TP 
+\fBmpd_host\fR
+Host of MPD server
+
+.TP 
+\fBmpd_port\fR
+Port of MPD server
+
+.TP 
+\fBmpd_password\fR
+MPD server password
+
+.TP 
+\fBnet_avg_samples\fR
+The number of samples to average for net data
+
+.TP 
+\fBoverride_utf8_locale\fR
+Force UTF8? requires XFT
+
+.TP 
+\fBown_window\fR
+Boolean, create own window to draw?
+
+.TP 
+\fBown_window_transparent\fR
+Boolean, set pseudo-transparency?
+
+.TP 
+\fBown_window_colour\fR \fBcolour\fR 
+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)
+
+.TP 
+\fBpad_percents\fR
+Pad percentages to this many decimals (0 = no padding)
+
+.TP 
+\fBstippled_borders\fR
+Border stippling (dashing) in pixels
+
+.TP 
+\fBtotal_run_times\fR
+Total number of times for Conky to update before quitting. Zero makes Conky run forever
+
+.TP 
+\fBupdate_interval\fR
+Update interval in seconds
+
+.TP 
+\fBuppercase\fR
+Boolean value, if true, text is rendered in upper case
+
+.TP 
+\fBuse_spacer\fR
+Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
+
+.TP 
+\fBuse_xft\fR
+Use Xft (anti-aliased font and stuff)
+
+.TP 
+\fBmin_port_monitors\fR
+Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16) 
+
+.TP 
+\fBmin_port_monitor_connections\fR
+Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
+
+.TP 
+\fBTEXT\fR
+After this begins text to be formatted on screen
+
+.SH VARIABLES
+Colors are parsed using XParsecolor(), there might be a list of them:
+/usr/X11R6/lib/X11/rgb.txt. Also, 
+http://sedition.com/perl/rgb.html [http://sedition.com/perl/rgb.html].
+Color can be also in #rrggbb format (hex).
+Note that when displaying bytes, power is 1024 and not 1000 so 1M really
+means 1024*1024 bytes and not 1000*1000.
+.TP 
+\fBaddr\fR \fBinterface\fR 
+IP address for an interface
+
+.TP 
+\fBacpiacadapter\fR 
+ACPI ac adapter state.
+
+.TP 
+\fBacpifan\fR 
+ACPI fan state
+
+.TP 
+\fBacpitemp\fR 
+ACPI temperature in C.
+
+.TP 
+\fBacpitempf\fR 
+ACPI temperature in F.
+
+.TP 
+\fBadt746xcpu\fR 
+CPU temperature from therm_adt746x
+
+.TP 
+\fBadt746xfan\fR 
+Fan speed from therm_adt746x
+
+.TP 
+\fBalignr\fR \fB(num)\fR 
+Right-justify text, with space of N
+
+.TP 
+\fBalignc\fR \fB(num)\fR 
+Align text to centre
+
+.TP 
+\fBapm_adapter\fR 
+Display APM AC adapter status (FreeBSD only)
+
+.TP 
+\fBapm_battery_life\fR 
+Display APM battery life in percent (FreeBSD only)
+
+.TP 
+\fBapm_battery_time\fR 
+Display remaining APM battery life in hh:mm:ss or "unknown" if
+AC adapterstatus is on-line or charging (FreeBSD only)
+
+.TP 
+\fBbattery\fR \fB(num)\fR 
+Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
+
+.TP 
+\fBbuffers\fR 
+Amount of memory buffered
+
+.TP 
+\fBcached\fR 
+Amount of memory cached
+
+.TP 
+\fBcolor\fR \fB(color)\fR 
+Change drawing color to color
+
+.TP 
+\fBcpu\fR \fB(cpuN)\fR 
+CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. cpu0 is the total usage, and >=cpu1 are individual CPUs. 
+
+.TP 
+\fBcpubar\fR \fB(cpu number) (height),(width)\fR 
+Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
+
+.TP 
+\fBcpugraph\fR \fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR 
+CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
+
+.TP 
+\fBdiskio\fR 
+Displays current disk IO.
+
+.TP 
+\fBdiskiograph\fR \fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
+Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
+
+.TP 
+\fBdownspeed\fR \fBnet\fR 
+Download speed in kilobytes
+
+.TP 
+\fBdownspeedf\fR \fBnet\fR 
+Download speed in kilobytes with one decimal
+
+.TP 
+\fBdownspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
+Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
+
+.TP 
+\fBelse\fR 
+Text to show if any of the above are not true
+
+.TP 
+\fBexec\fR \fBcommand\fR 
+Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
+
+.TP 
+\fBexecbar\fR \fBcommand\fR 
+Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
+
+.TP 
+\fBexecgraph\fR \fBcommand\fR 
+Same as execbar, but graphs values.
+
+.TP 
+\fBexeci\fR \fBinterval command\fR 
+Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
+
+.TP 
+\fBexecibar\fR \fBinterval command\fR 
+Same as execbar, except with an interval
+
+.TP 
+\fBexecigraph\fR \fBinterval command\fR 
+Same as execigraph, but takes an interval arg graphs values
+
+.TP 
+\fBfont\fR \fBfont\fR 
+Specify a different font. Only applies to one line.
+
+.TP 
+\fBfreq\fR 
+Returns CPU frequency in MHz
+
+.TP 
+\fBfreq_g\fR 
+Returns CPU frequency in GHz
+
+.TP 
+\fBfreq_dyn\fR 
+Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
+
+.TP 
+\fBfreq_dyn_g\fR 
+Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
+
+.TP 
+\fBfs_bar\fR \fB(height),(width) fs\fR 
+Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
+
+.TP 
+\fBfs_free\fR \fB(fs)\fR 
+Free space on a file system available for users.
+
+.TP 
+\fBfs_free_perc\fR \fB(fs)\fR 
+Free percentage of space on a file system available for users.
+
+.TP 
+\fBfs_size\fR \fB(fs)\fR 
+File system size
+
+.TP 
+\fBfs_used\fR \fB(fs)\fR 
+File system used space
+
+.TP 
+\fBhead\fR \fBlogfile lines (interval)\fR 
+Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
+
+.TP 
+\fBhr\fR \fB(height)\fR 
+Horizontal line, height is the height in pixels
+
+.TP 
+\fBi2c\fR \fB(dev), type, n\fR 
+I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
+
+.TP 
+\fBi8k_ac_status\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
+
+.TP 
+\fBi8k_bios\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
+
+.TP 
+\fBi8k_buttons_status\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
+
+.TP 
+\fBi8k_cpu_temp\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in celsius, as reported by /proc/i8k.
+
+.TP 
+\fBi8k_cpu_tempf\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in farenheit, as reported by /proc/i8k.
+
+.TP 
+\fBi8k_left_fan_rpm\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
+
+.TP 
+\fBi8k_left_fan_status\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
+
+.TP 
+\fBi8k_right_fan_rpm\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
+
+.TP 
+\fBi8k_right_fan_status\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
+
+.TP 
+\fBi8k_serial\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
+
+.TP 
+\fBi8k_version\fR \fB\fR
+If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
+
+.TP 
+\fBif_running\fR \fB(process)\fR 
+if PROCESS is running, display everything if_running and the matching $endif
+
+.TP 
+\fBif_existing\fR \fB(file)\fR 
+if FILE exists, display everything between if_existing and the matching $endif
+
+.TP 
+\fBif_mounted\fR \fB(mountpoint)\fR 
+if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
+
+.TP 
+\fBkernel\fR 
+Kernel version
+
+.TP 
+\fBlinkstatus\fR \fBinterface\fR 
+Get the link status for wireless connections
+
+.TP 
+\fBloadavg\fR 
+(1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
+
+.TP 
+\fBmachine\fR 
+Machine, i686 for example
+
+.TP 
+\fBmails\fR 
+Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
+
+.TP 
+\fBmem\fR 
+Amount of memory in use
+
+.TP 
+\fBmembar\fR \fB(height),(width)\fR 
+Bar that shows amount of memory in use
+
+.TP 
+\fBmemmax\fR 
+Total amount of memory
+
+.TP 
+\fBmemperc\fR 
+Percentage of memory in use
+
+.TP 
+\fBmpd_artist\fR 
+Artist in current MPD song must be enabled at compile
+
+.TP 
+\fBmpd_album\fR 
+Album in current MPD song
+
+.TP 
+\fBmpd_bar\fR \fB(height),(width)\fR 
+Bar of mpd's progress
+
+.TP 
+\fBmpd_bitrate\fR 
+Bitrate of current song
+
+.TP 
+\fBmpd_status\fR 
+Playing, stopped, et cetera.
+
+.TP 
+\fBmpd_title\fR 
+Title of current MPD song
+
+.TP 
+\fBmpd_vol\fR 
+MPD's volume
+
+.TP 
+\fBmpd_elapsed\fR 
+Song's elapsed time
+
+.TP 
+\fBmpd_length\fR 
+Song's length
+
+.TP 
+\fBmpd_percent\fR 
+Percent of song's progress
+
+.TP 
+\fBmpd_random\fR 
+Random status (On/Off)
+
+.TP 
+\fBmpd_repeat\fR 
+Repeat status (On/Off)
+
+.TP 
+\fBmpd_track\fR 
+Prints the MPD track field
+
+.TP 
+\fBnew_mails\fR 
+Unread mail count in mail spool.
+
+.TP 
+\fBnodename\fR 
+Hostname
+
+.TP 
+\fBoutlinecolor\fR \fB(color)\fR 
+Change outline color
+
+.TP 
+\fBpre_exec\fR \fBshell command\fR 
+Executes a shell command one time before conky displays anything and puts output as text.
+
+.TP 
+\fBprocesses\fR 
+Total processes (sleeping and running)
+
+.TP 
+\fBrunning_processes\fR 
+Running processes (not sleeping), requires Linux 2.6
+
+.TP 
+\fBshadecolor\fR \fB(color)\fR 
+Change shading color
+
+.TP 
+\fBstippled_hr\fR \fB(space)\fR 
+Stippled (dashed) horizontal line
+
+.TP 
+\fBswapbar\fR \fB(height),(width)\fR 
+Bar that shows amount of swap in use
+
+.TP 
+\fBswap\fR 
+Amount of swap in use
+
+.TP 
+\fBswapmax\fR 
+Total amount of swap
+
+.TP 
+\fBswapperc\fR 
+Percentage of swap in use
+
+.TP 
+\fBsysname\fR 
+System name, Linux for example
+
+.TP 
+\fBtcp_portmon\fR \fBport_begin port_end item (index)\fR \fI(ip4 only at present)\fR 
+TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
+
+count - total number of connections in the range
+
+rip - remote ip address
+
+rhost - remote host name 
+
+rport - remote port number
+
+lip - local ip address
+
+lhost - local host name
+
+lservice - local service name from /etc/services
+
+The connection index provides you with access to each connection in the port monitor. The monitor will return information for index values from 0 to n-1 connections. Values higher than n-1 are simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items.
+
+Examples:
+
+${tcp_portmon 6881 6889 count} -
+displays the number of connections in the bittorrent port range
+
+${tcp_portmon 22 22 rip 0} -
+displays the remote host ip of the first sshd connection
+
+${tcp_portmon 22 22 rip 9} -
+displays the remote host ip of the tenth sshd connection
+
+${tcp_portmon 1 1024 rhost 0} -
+displays the remote host name of the first connection on a privileged port
+
+${tcp_portmon 1 1024 rport 4} -
+displays the remote host port of the fifth connection on a privileged port
+
+${tcp_portmon 1 65535 lservice 14} -
+displays the local service name of the fifteenth connection in the range of all ports
+
+Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally. In other words, the program avoids creating redundant monitors. 
+.TP 
+\fBtexeci\fR \fBinterval command\fR 
+Runs a command at an interval inside a thread and displays the output. Same as $execi, except the command is run inside a thread. Use this if you have a slow script to keep Conky updating. You should make the interval slightly longer then the time it takes your script to execute. For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
+
+.TP 
+\fBoffset\fR \fB(pixels)\fR 
+Move text over by N pixels. See also $voffset.
+
+.TP 
+\fBtail\fR \fBlogfile lines (interval)\fR 
+Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
+
+.TP 
+\fBtime\fR \fB(format)\fR 
+Local time, see man strftime to get more information about format
+
+.TP 
+\fBtotaldown\fR \fBnet\fR 
+Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
+
+.TP 
+\fBtop\fR \fBtype, num\fR 
+This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", and mem". There can be a max of 10 processes listed.
+
+.TP 
+\fBtop_mem\fR \fBtype, num\fR 
+Same as top, except sorted by mem usage instead of cpu
+
+.TP 
+\fBtotalup\fR \fBnet\fR 
+Total upload, this one too, may overflow
+
+.TP 
+\fBupdates\fR \fBNumber of updates\fR 
+for debugging
+
+.TP 
+\fBupspeed\fR \fBnet\fR 
+Upload speed in kilobytes
+
+.TP 
+\fBupspeedf\fR \fBnet\fR 
+Upload speed in kilobytes with one decimal
+
+.TP 
+\fBupspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
+Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
+
+.TP 
+\fBuptime\fR 
+Uptime
+
+.TP 
+\fBuptime_short\fR 
+Uptime in a shorter format
+
+.TP 
+\fBseti_prog\fR 
+Seti@home current progress
+
+.TP 
+\fBseti_progbar\fR \fB(height),(width)\fR 
+Seti@home current progress bar
+
+.TP 
+\fBseti_credit\fR 
+Seti@home total user credit
+
+.TP 
+\fBvoffset\fR \fB(pixels)\fR 
+Change verticle offset by N pixels. Negative values will cause text to overlap. See also $offset.
+
+.SH EXAMPLES
+.TP 
+conky \fB\-t '${time %D %H:%m}' \-o \-u 30\fR
+Start Conky in its own window with date and clock as text and 30 sec update interval.
+.TP 
+conky \fB\-a top_left \-x 5 \-y 500 \-d\fR
+Start Conky to background at coordinates (5, 500).
+.SH FILES
+\fB~/.conkyrc\fR default configuration file
+.SH BUGS
+Drawing to root or some other desktop window directly doesn't work with 
+all window managers. Especially doesn't work well with Gnome and it has 
+been reported that it doesn't work with KDE either. Nautilus can be 
+disabled from drawing to desktop with program gconf-editor. Uncheck 
+show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky 
+to set some specific window id. You might find xwininfo -tree useful to 
+find the window to draw to. You can also use -o argument which makes
+Conky to create its own window.
+.SH "SEE ALSO"
+http://conky.sourceforge.net [http://conky.sourceforge.net]
+.PP
+http://www.sourceforge.net/projects/conky [http://www.sourceforge.net/projects/conky]
+.PP
+#conky on irc.freenode.net
+.SH AUTHORS
+The Conky dev team. What's up now!