glances.1: sync with reality and fix several bugs (wtf)

pull/596/head
Alessio Sergi 2015-05-13 14:55:00 +02:00
parent fa51970f2a
commit 35344b9f80
1 changed files with 65 additions and 36 deletions

View File

@ -7,7 +7,7 @@ glances \- A cross-platform curses-based system monitoring tool
.SH DESCRIPTION .SH DESCRIPTION
Glances is a free (LGPL) cross-platform curses-based system monitoring tool which Glances is a free (LGPL) cross-platform curses-based system monitoring tool which
aims to present a maximum of information in a minimum of space, ideally to fit in aims to present a maximum of information in a minimum of space, ideally to fit in
a classical 80x24 terminal or higher to have additionnal information. It can adapt a classical 80x24 terminal or higher to have additional information. It can adapt
dynamically the displayed information depending on the terminal size. dynamically the displayed information depending on the terminal size.
.PP .PP
Glances can also work in client/server mode. Remote monitoring could be done via Glances can also work in client/server mode. Remote monitoring could be done via
@ -26,16 +26,16 @@ show this help message and exit
show program's version number and exit show program's version number and exit
.TP .TP
.B \-d, \-\-debug .B \-d, \-\-debug
Enable debug mode (log file is /tmp/glances.log) enable debug mode (log file is /tmp/glances.log)
.TP .TP
.B \-C CONF_FILE, \-\-config CONF_FILE .B \-C CONF_FILE, \-\-config CONF_FILE
path to the configuration file path to the configuration file
.TP .TP
.B \-b, \-\-byte .B \-\-disable-network
display network rate in byte per second [default: bit per second] disable network module
.TP .TP
.B \-\-disable-bold .B \-\-disable-ip
disable bold mode in the terminal disable IP module
.TP .TP
.B \-\-disable-diskio .B \-\-disable-diskio
disable disk I/O module disable disk I/O module
@ -43,18 +43,20 @@ disable disk I/O module
.B \-\-disable-fs .B \-\-disable-fs
disable file system module disable file system module
.TP .TP
.B \-\-disable-network
disable network module
.TP
.B \-\-disable-sensors .B \-\-disable-sensors
disable sensors module disable sensors module
.TP .TP
.B \-\-disable-hddtemp .B \-\-disable-hddtemp
disable HDDTemp module disable HDDTemp module
.TP .TP
.B \-\-disable-raid
disable RAID module
.TP
.B \-\-disable-docker
disable Docker module
.TP .TP
.B \-\-disable-left-sidebar .B \-\-disable-left-sidebar
disable network, disk IO, FS and sensors modules disable network, disk I/O, file system and sensors modules
.TP .TP
.B \-\-disable-process .B \-\-disable-process
disable process module disable process module
@ -62,26 +64,35 @@ disable process module
.B \-\-disable-log .B \-\-disable-log
disable log module disable log module
.TP .TP
.B \-\-disable-quicklook
disable quick look module
.TP
.B \-\-disable-bold
disable bold mode in the terminal
.TP
.B \-\-enable-process-extended .B \-\-enable-process-extended
enable extended stats on top process enable extended stats on top process
.TP .TP
.B \-\-enable-history .B \-\-enable-history
enable the history mode enable the history mode (matplotlib needed)
.TP .TP
B \-\-path-history PATH_HISTORY .B \-\-path-history PATH_HISTORY
set the export path for graph history set the export path for graph history
.TP .TP
.B \-\-export-csv CSV_FILE .B \-\-export-csv EXPORT_CSV
export stats to a CSV file export stats to a CSV file
.TP .TP
.B \-\-export-influxdb .B \-\-export-influxdb
export stats to an InfluxDB server export stats to an InfluxDB server (influxdb needed)
.TP .TP
.B \-\-export-statsd .B \-\-export-statsd
export stats to a Statsd server export stats to a StatsD server (statsd needed)
.TP .TP
.B \-\-export-rabbitmq .B \-\-export-rabbitmq
export stats to a RabbitMQ server export stats to a RabbitMQ server (pika needed)
.TP
.B \-c CLIENT, \-\-client CLIENT
connect to a Glances server by IPv4/IPv6 address or hostname
.TP .TP
.B \-s, \-\-server .B \-s, \-\-server
run Glances in server mode run Glances in server mode
@ -92,18 +103,15 @@ start the client browser (display list of servers)
.B \-\-disable-autodiscover .B \-\-disable-autodiscover
disable autodiscover feature disable autodiscover feature
.TP .TP
.B \-c CLIENT, \-\-client CLIENT
connect to a Glances server by IPv4/IPv6 address or hostname
.TP
.B \-p PORT, \-\-port PORT .B \-p PORT, \-\-port PORT
define the client/server TCP port [default: 61209] define the client/server TCP port [default: 61209]
.TP .TP
.B \-\-password
define a client/server password
.TP
.B \-B BIND_ADDRESS, \-\-bind BIND_ADDRESS .B \-B BIND_ADDRESS, \-\-bind BIND_ADDRESS
bind server to the given IPv4/IPv6 address or hostname bind server to the given IPv4/IPv6 address or hostname
.TP .TP
.B \-\-password
define a client/server password
.TP
.B \-\-snmp-community SNMP_COMMUNITY .B \-\-snmp-community SNMP_COMMUNITY
SNMP community SNMP community
.TP .TP
@ -120,31 +128,40 @@ SNMP username (only for SNMPv3)
SNMP authentication key (only for SNMPv3) SNMP authentication key (only for SNMPv3)
.TP .TP
.B \-\-snmp-force .B \-\-snmp-force
Force the SNMP mode (do not try Glances server) force the SNMP mode (do not try Glances server)
.TP .TP
.B \-t TIME, \-\-time TIME .B \-t TIME, \-\-time TIME
set refresh time in seconds [default: 3 sec] set refresh time in seconds [default: 3 sec]
.TP .TP
.B \-w, \-\-webserver .B \-w, \-\-webserver
run Glances in Web server mode run Glances in web server mode (bottle needed)
.TP .TP
.B \-q, \-\-quiet .B \-q, \-\-quiet
run Glances in quiet mode (nothing is displayed) run Glances in quiet mode (nothing is displayed)
.TP .TP
.B -\f PROCESS_FILTER, \-\-process\-filter PROCESS_FILTER .B \-f PROCESS_FILTER, \-\-process\-filter PROCESS_FILTER
set the process filter patern (regular expression) set the process filter pattern (regular expression)
.TP
.B \-\-process-short-name
force short name for processes name
.TP
.B \-\-hide-kernel-threads
hide kernel threads in process list
.TP
.B \-\-tree
display processes as a tree
.TP
.B \-b, \-\-byte
display network rate in byte per second [default: bit per second]
.TP .TP
.B \-1, \-\-percpu .B \-1, \-\-percpu
start Glances in per CPU mode start Glances in per CPU mode
.TP .TP
.B \-1, \-\-process-short-name .B \-\-fs-free-space
Force short name for processes name display file system free space instead of used
.TP .TP
.B \-1, \-\-fs-free-space .B \-\-theme-white
Display FS free space instead of used optimize display colors for white background
.TP
.B \-1, \-\-theme-white
Optimize display for white background
.SH INTERACTIVE COMMANDS .SH INTERACTIVE COMMANDS
You can use the following keys while in Glances: You can use the following keys while in Glances:
.TP .TP
@ -169,6 +186,9 @@ Enable/disable top extended stats
.B f .B f
Show/hide file system stats Show/hide file system stats
.TP .TP
.B F
Switch between file system used and free space
.TP
.B g .B g
Generate graphs for current history Generate graphs for current history
.TP .TP
@ -199,10 +219,10 @@ Reset history
.B s .B s
Show/hide sensors stats Show/hide sensors stats
.TP .TP
.B T .B t
Sort process by CPU times (TIME+) Sort process by CPU times (TIME+)
.TP .TP
.B t .B T
View network I/O as combination View network I/O as combination
.TP .TP
.B u .B u
@ -225,6 +245,15 @@ Show/hide processes list (for low CPU consumption)
.TP .TP
.B 1 .B 1
Switch between global CPU and per-CPU stats Switch between global CPU and per-CPU stats
.TP
.B 2
Enable/disable left sidebar
.TP
.B 3
Enable/disable the quick look module
.TP
.B /
Switch between short name/command line (processes name)
.SH EXAMPLES .SH EXAMPLES
.TP .TP
Monitor local machine (standalone mode): Monitor local machine (standalone mode):