summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2016-11-05 18:13:59 +0100
committernicolargo <nicolas@nicolargo.com>2016-11-05 18:13:59 +0100
commit74a0188848008a203a2275754dfd0be16c08162b (patch)
tree3eb9084cf47d95ec0d36b80781a6b04301cb6035 /docs
parent65121f7796c1577863cf59b96e46c75fef544e83 (diff)
Update documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/cmds.rst149
-rw-r--r--docs/man/glances.1161
2 files changed, 185 insertions, 125 deletions
diff --git a/docs/cmds.rst b/docs/cmds.rst
index 9b9fd2b0..0b3e5876 100644
--- a/docs/cmds.rst
+++ b/docs/cmds.rst
@@ -22,94 +22,110 @@ Command-Line Options
path to the configuration file
-.. option:: -3, --disable-quicklook
+.. option:: --disable-alert
- disable quick look module
+ disable alert/log module
-.. option:: -4, --full-quicklook
+.. option:: --disable-amps
- disable all but quick look and load
+ disable application monitoring process module
.. option:: --disable-cpu
disable CPU module
-.. option:: --disable-mem
+.. option:: --disable-diskio
- disable memory module
+ disable disk I/O module
-.. option:: --disable-swap
+.. option:: --disable-docker
- disable swap module
+ disable Docker module
-.. option:: --disable-load
+.. option:: --disable-folders
- disable load module
+ disable folders module
-.. option:: --disable-network
+.. option:: --disable-fs
- disable network module
+ disable file system module
+
+.. option:: --disable-hddtemp
+
+ disable HD temperature module
.. option:: --disable-ip
disable IP module
-.. option:: --disable-diskio
+.. option:: --disable-irq
- disable disk I/O module
+ disable IRQ module
-.. option:: --disable-fs
+.. option:: --disable-load
+
+ disable load module
+
+.. option:: --disable-mem
- disable filesystem module
+ disable memory module
-.. option:: --disable-folder
+.. option:: --disable-memswap
- disable folder module
+ disable memory swap module
-.. option:: --disable-irq
+.. option:: --disable-network
- disable IRQ module
+ disable network module
-.. option:: --disable-sensors
+.. option:: --disable-ports
- disable sensors module
+ disable Ports module
-.. option:: --disable-hddtemp
+.. option:: --disable-process
- disable HD temperature module
+ disable process module
.. option:: --disable-raid
disable RAID module
-.. option:: --disable-docker
+.. option:: --disable-sensors
- disable Docker module
+ disable sensors module
-.. option:: --disable-ports
+.. option:: --disable-wifi
- disable Ports module
+ disable Wifi module
-.. option:: -5, --disable-top
+.. option:: -0, --disable-irix
- disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
+ task's CPU usage will be divided by the total number of CPUs
+
+.. option:: -1, --percpu
+
+ start Glances in per CPU mode
.. option:: -2, --disable-left-sidebar
disable network, disk I/O, FS and sensors modules (py3sensors lib
needed)
-.. option:: --disable-process
+.. option:: -3, --disable-quicklook
- disable process module
+ disable quick look module
-.. option:: --disable-amps
+.. option:: -4, --full-quicklook
- disable application monitoring process module
+ disable all but quick look and load
-.. option:: --disable-log
+.. option:: -5, --disable-top
- disable log module
+ disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
+
+.. option:: --enable-history
+
+ enable the history mode (matplotlib lib needed)
.. option:: --disable-bold
@@ -123,11 +139,11 @@ Command-Line Options
enable extended stats on top process
-.. option:: --enable-history
+.. option:: --export-graph
- enable the history mode (matplotlib lib needed)
+ export stats to graph
-.. option:: --path-history PATH_HISTORY
+.. option:: --path-graph PATH_GRAPH
set the export path for graph history
@@ -135,37 +151,41 @@ Command-Line Options
export stats to a CSV file
-.. option:: --export-influxdb
-
- export stats to an InfluxDB server (influxdb lib needed)
-
.. option:: --export-cassandra
export stats to a Cassandra/Scylla server (cassandra lib needed)
-.. option:: --export-opentsdb
+.. option:: --export-couchdb
- export stats to an OpenTSDB server (potsdb lib needed)
+ export stats to a CouchDB server (couchdb lib needed)
-.. option:: --export-statsd
+.. option:: --export-elasticsearch
- export stats to a StatsD server (statsd lib needed)
+ export stats to an Elasticsearch server (elasticsearch lib needed)
+
+.. option:: --export-influxdb
+
+ export stats to an InfluxDB server (influxdb lib needed)
+
+.. option:: --export-opentsdb
+
+ export stats to an OpenTSDB server (potsdb lib needed)
.. option:: --export-rabbitmq
export stats to RabbitMQ broker (pika lib needed)
-.. option:: --export-riemann
+.. option:: --export-statsd
- export stats to Riemann server (bernhard lib needed)
+ export stats to a StatsD server (statsd lib needed)
-.. option:: --export-elasticsearch
+.. option:: --export-riemann
- export stats to an Elasticsearch server (elasticsearch lib needed)
+ export stats to Riemann server (bernhard lib needed)
-.. option:: --export-couchdb
+.. option:: --export-zeromq
- export stats to a CouchDB server (couchdb lib needed)
+ export stats to a ZeroMQ server (zmq lib needed)
.. option:: -c CLIENT, --client CLIENT
@@ -231,6 +251,14 @@ Command-Line Options
run Glances in web server mode (bottle lib needed)
+.. option:: --cached-time CACHED_TIME
+
+ set the server cache time [default: 1 sec]
+
+.. option:: open-web-browser
+
+ try to open the Web UI in the default Web browser
+
.. option:: -q, --quiet
do not display the curses interface
@@ -243,10 +271,6 @@ Command-Line Options
force short name for processes name
-.. option:: -0, --disable-irix
-
- task's CPU usage will be divided by the total number of CPUs
-
.. option:: --hide-kernel-threads
hide kernel threads in process list
@@ -271,10 +295,6 @@ Command-Line Options
display temperature in Fahrenheit (default is Celsius)
-.. option:: -1, --percpu
-
- start Glances in per CPU mode
-
.. option:: --fs-free-space
display FS free space instead of used
@@ -283,6 +303,10 @@ Command-Line Options
optimize display colors for white background
+.. option:: --disable-check-update
+
+ disable online Glances version ckeck
+
Interactive Commands
--------------------
@@ -398,6 +422,9 @@ The following commands (key pressed) are supported while in Glances:
``w``
Delete finished warning log messages
+``W``
+ Show/hide Wifi module
+
``x``
Delete finished warning and critical log messages
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 366b7a98..497651e3 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Oct 30, 2016" "2.8_DEVELOP" "Glances"
+.TH "GLANCES" "1" "Nov 05, 2016" "2.8_DEVELOP" "Glances"
.SH NAME
glances \- An eye on your system
.
@@ -68,13 +68,13 @@ path to the configuration file
.UNINDENT
.INDENT 0.0
.TP
-.B \-3, \-\-disable\-quicklook
-disable quick look module
+.B \-\-disable\-alert
+disable alert/log module
.UNINDENT
.INDENT 0.0
.TP
-.B \-4, \-\-full\-quicklook
-disable all but quick look and load
+.B \-\-disable\-amps
+disable application monitoring process module
.UNINDENT
.INDENT 0.0
.TP
@@ -83,23 +83,28 @@ disable CPU module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-mem
-disable memory module
+.B \-\-disable\-diskio
+disable disk I/O module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-swap
-disable swap module
+.B \-\-disable\-docker
+disable Docker module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-load
-disable load module
+.B \-\-disable\-folders
+disable folders module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-network
-disable network module
+.B \-\-disable\-fs
+disable file system module
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-disable\-hddtemp
+disable HD temperature module
.UNINDENT
.INDENT 0.0
.TP
@@ -108,33 +113,38 @@ disable IP module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-diskio
-disable disk I/O module
+.B \-\-disable\-irq
+disable IRQ module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-fs
-disable filesystem module
+.B \-\-disable\-load
+disable load module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-folder
-disable folder module
+.B \-\-disable\-mem
+disable memory module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-irq
-disable IRQ module
+.B \-\-disable\-memswap
+disable memory swap module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-sensors
-disable sensors module
+.B \-\-disable\-network
+disable network module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-hddtemp
-disable HD temperature module
+.B \-\-disable\-ports
+disable Ports module
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-disable\-process
+disable process module
.UNINDENT
.INDENT 0.0
.TP
@@ -143,18 +153,23 @@ disable RAID module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-docker
-disable Docker module
+.B \-\-disable\-sensors
+disable sensors module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-ports
-disable Ports module
+.B \-\-disable\-wifi
+disable Wifi module
.UNINDENT
.INDENT 0.0
.TP
-.B \-5, \-\-disable\-top
-disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
+.B \-0, \-\-disable\-irix
+task\(aqs CPU usage will be divided by the total number of CPUs
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-1, \-\-percpu
+start Glances in per CPU mode
.UNINDENT
.INDENT 0.0
.TP
@@ -164,18 +179,23 @@ needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-process
-disable process module
+.B \-3, \-\-disable\-quicklook
+disable quick look module
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-amps
-disable application monitoring process module
+.B \-4, \-\-full\-quicklook
+disable all but quick look and load
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-5, \-\-disable\-top
+disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-disable\-log
-disable log module
+.B \-\-enable\-history
+enable the history mode (matplotlib lib needed)
.UNINDENT
.INDENT 0.0
.TP
@@ -194,12 +214,12 @@ enable extended stats on top process
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-enable\-history
-enable the history mode (matplotlib lib needed)
+.B \-\-export\-graph
+export stats to graph
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-path\-history PATH_HISTORY
+.B \-\-path\-graph PATH_GRAPH
set the export path for graph history
.UNINDENT
.INDENT 0.0
@@ -209,23 +229,28 @@ export stats to a CSV file
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-influxdb
-export stats to an InfluxDB server (influxdb lib needed)
+.B \-\-export\-cassandra
+export stats to a Cassandra/Scylla server (cassandra lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-cassandra
-export stats to a Cassandra/Scylla server (cassandra lib needed)
+.B \-\-export\-couchdb
+export stats to a CouchDB server (couchdb lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-opentsdb
-export stats to an OpenTSDB server (potsdb lib needed)
+.B \-\-export\-elasticsearch
+export stats to an Elasticsearch server (elasticsearch lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-statsd
-export stats to a StatsD server (statsd lib needed)
+.B \-\-export\-influxdb
+export stats to an InfluxDB server (influxdb lib needed)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-export\-opentsdb
+export stats to an OpenTSDB server (potsdb lib needed)
.UNINDENT
.INDENT 0.0
.TP
@@ -234,18 +259,18 @@ export stats to RabbitMQ broker (pika lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-riemann
-export stats to Riemann server (bernhard lib needed)
+.B \-\-export\-statsd
+export stats to a StatsD server (statsd lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-elasticsearch
-export stats to an Elasticsearch server (elasticsearch lib needed)
+.B \-\-export\-riemann
+export stats to Riemann server (bernhard lib needed)
.UNINDENT
.INDENT 0.0
.TP
-.B \-\-export\-couchdb
-export stats to a CouchDB server (couchdb lib needed)
+.B \-\-export\-zeromq
+export stats to a ZeroMQ server (zmq lib needed)
.UNINDENT
.INDENT 0.0
.TP
@@ -329,6 +354,16 @@ run Glances in web server mode (bottle lib needed)
.UNINDENT
.INDENT 0.0
.TP
+.B \-\-cached\-time CACHED_TIME
+set the server cache time [default: 1 sec]
+.UNINDENT
+.INDENT 0.0
+.TP
+.B open\-web\-browser
+try to open the Web UI in the default Web browser
+.UNINDENT
+.INDENT 0.0
+.TP
.B \-q, \-\-quiet
do not display the curses interface
.UNINDENT
@@ -344,11 +379,6 @@ force short name for processes name
.UNINDENT
.INDENT 0.0
.TP
-.B \-0, \-\-disable\-irix
-task\(aqs CPU usage will be divided by the total number of CPUs
-.UNINDENT
-.INDENT 0.0
-.TP
.B \-\-hide\-kernel\-threads
hide kernel threads in process list
.UNINDENT
@@ -379,11 +409,6 @@ display temperature in Fahrenheit (default is Celsius)
.UNINDENT
.INDENT 0.0
.TP
-.B \-1, \-\-percpu
-start Glances in per CPU mode
-.UNINDENT
-.INDENT 0.0
-.TP
.B \-\-fs\-free\-space
display FS free space instead of used
.UNINDENT
@@ -392,6 +417,11 @@ display FS free space instead of used
.B \-\-theme\-white
optimize display colors for white background
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-disable\-check\-update
+disable online Glances version ckeck
+.UNINDENT
.SH INTERACTIVE COMMANDS
.sp
The following commands (key pressed) are supported while in Glances:
@@ -511,6 +541,9 @@ View cumulative network I/O
.B \fBw\fP
Delete finished warning log messages
.TP
+.B \fBW\fP
+Show/hide Wifi module
+.TP
.B \fBx\fP
Delete finished warning and critical log messages
.TP