1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-17 18:45:10 +00:00

update docs

git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@995 7f574dfc-610e-0410-a909-a81674777703
This commit is contained in:
Brenden Matthews 2008-01-06 01:36:08 +00:00
parent 35b4ed3aff
commit 8cb2b4079e
2 changed files with 39 additions and 25 deletions

36
README
View File

@ -85,43 +85,47 @@ OPTIONS
Command line options override configurations defined in configuration Command line options override configurations defined in configuration
file. file.
-v | -V -v | -V | --verbose
Prints version and exits Prints version and exits
-a ALIGNMENT -a | --alignment=ALIGNMENT
Text alignment on screen, {top,bottom}_{left,right} or none Text alignment on screen, {top,bottom}_{left,right} or none
-b Use double buffering (eliminates "flicker") -b | --double-buffer
Use double buffering (eliminates "flicker")
-c FILE -c | --config=FILE
Config file to load instead of $HOME/.conkyrc Config file to load instead of $HOME/.conkyrc
-d Daemonize Conky, aka fork to background -d | --daemonize
Daemonize Conky, aka fork to background
-f FONT -f | --font=FONT
Font to use Font to use
-h Prints command line help and exits -h | --help
Prints command line help and exits
-o Create own window to draw -o | --own-window
Create own window to draw
-t TEXT -t | --text=TEXT
Text to render, remember single quotes, like -t ' $uptime ' Text to render, remember single quotes, like -t ' $uptime '
-u SECONDS -u | --interval=SECONDS
Update interval Update interval
-w WIN_ID -w | --window-id=WIN_ID
Window id to draw Window id to draw
@ -194,6 +198,12 @@ CONFIGURATION SETTINGS
The number of samples to average for CPU monitoring The number of samples to average for CPU monitoring
top_cpu_separate
If true, cpu in top will show usage of one processor's power. If
false, cpu in top will show the usage of all processors' power
combined.
default_color default_color
Default color and border color Default color and border color
@ -1214,8 +1224,8 @@ VARIABLES
This takes arguments in the form:top (name) (number) Basically, This takes arguments in the form:top (name) (number) Basically,
processes are ranked from highest to lowest in terms of cpu us- processes are ranked from highest to lowest in terms of cpu us-
age, which is what (num) represents. The types are: "name", age, which is what (num) represents. The types are: "name",
"pid", "cpu", and "mem". There can be a max of 10 processes "pid", "cpu", "mem", and "time". There can be a max of 10 pro-
listed. cesses listed.
top_mem type, num top_mem type, num

View File

@ -77,47 +77,47 @@ mdsplib was causing way too many problems. Hopefully there'll be a better soluti
.SH OPTIONS .SH OPTIONS
Command line options override configurations defined in configuration file. Command line options override configurations defined in configuration file.
.TP .TP
\fB\*(T<\fB\-v | \-V\fR\*(T>\fR \fB\*(T<\fB\-v | \-V | \-\-verbose\fR\*(T>\fR
Prints version and exits Prints version and exits
.TP .TP
\fB\*(T<\fB\-a \fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T> \fB\*(T<\fB\-a | \-\-alignment=\fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
Text alignment on screen, {top,bottom}_{left,right} or none Text alignment on screen, {top,bottom}_{left,right} or none
.TP .TP
\fB\*(T<\fB\-b\fR\*(T>\fR \fB\*(T<\fB\-b | \-\-double\-buffer\fR\*(T>\fR
Use double buffering (eliminates "flicker") Use double buffering (eliminates "flicker")
.TP .TP
\fB\*(T<\fB\-c \fR\*(T>\fR\*(T<\fBFILE\fR\*(T> \fB\*(T<\fB\-c | \-\-config=\fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
Config file to load instead of $HOME/.conkyrc Config file to load instead of $HOME/.conkyrc
.TP .TP
\fB\*(T<\fB\-d\fR\*(T>\fR \fB\*(T<\fB\-d | \-\-daemonize\fR\*(T>\fR
Daemonize Conky, aka fork to background Daemonize Conky, aka fork to background
.TP .TP
\fB\*(T<\fB\-f \fR\*(T>\fR\*(T<\fBFONT\fR\*(T> \fB\*(T<\fB\-f | \-\-font=\fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
Font to use Font to use
.TP .TP
\fB\*(T<\fB\-h\fR\*(T>\fR \fB\*(T<\fB\-h | \-\-help\fR\*(T>\fR
Prints command line help and exits Prints command line help and exits
.TP .TP
\fB\*(T<\fB\-o\fR\*(T>\fR \fB\*(T<\fB\-o | \-\-own\-window\fR\*(T>\fR
Create own window to draw Create own window to draw
.TP .TP
\fB\*(T<\fB\-t \fR\*(T>\fR\*(T<\fBTEXT\fR\*(T> \fB\*(T<\fB\-t | \-\-text=\fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
Text to render, remember single quotes, like -t ' $uptime ' Text to render, remember single quotes, like -t ' $uptime '
.TP .TP
\fB\*(T<\fB\-u \fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T> \fB\*(T<\fB\-u | \-\-interval=\fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
Update interval Update interval
.TP .TP
\fB\*(T<\fB\-w \fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T> \fB\*(T<\fB\-w | \-\-window\-id=\fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
Window id to draw Window id to draw
.TP .TP
@ -195,6 +195,10 @@ A color variable for use inside TEXT segments
\fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
The number of samples to average for CPU monitoring The number of samples to average for CPU monitoring
.TP
\fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
If true, cpu in top will show usage of one processor's power. If false, cpu in top will show the usage of all processors' power combined.
.TP .TP
\fB\*(T<\fBdefault_color\fR\*(T>\fR \fB\*(T<\fBdefault_color\fR\*(T>\fR
Default color and border color Default color and border color
@ -1111,7 +1115,7 @@ Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't se
.TP .TP
\fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
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. 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", "mem", and "time". There can be a max of 10 processes listed.
.TP .TP
\fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>