summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolashennion@gmail.com>2015-09-19 15:14:21 +0200
committernicolargo <nicolashennion@gmail.com>2015-09-19 15:14:21 +0200
commita912ca8e2bc15736545f61d63924f1a67a61e323 (patch)
tree241f8ff8df29c5689f9d0da00d6c9529e5e1c04c
parentc1ff999c09c26f1fc2ead0dd621c848bac7c417f (diff)
Update documentation
-rw-r--r--docs/glances-doc.rst24
-rw-r--r--docs/images/diskio.pngbin7399 -> 9638 bytes
-rw-r--r--docs/images/docker.pngbin69810 -> 38418 bytes
-rw-r--r--docs/images/fs.pngbin9962 -> 10950 bytes
-rw-r--r--docs/images/header.pngbin7607 -> 9187 bytes
-rw-r--r--docs/images/per-cpu.pngbin18923 -> 21132 bytes
-rw-r--r--docs/images/processlist-filter.pngbin0 -> 84667 bytes
-rw-r--r--docs/images/quicklook-percpu.pngbin0 -> 27582 bytes
-rw-r--r--docs/images/quicklook.pngbin7582 -> 17789 bytes
-rw-r--r--docs/images/screenshot-web.pngbin264464 -> 293155 bytes
-rw-r--r--docs/images/screenshot-wide.pngbin613972 -> 636915 bytes
-rw-r--r--docs/images/sensors.pngbin16447 -> 16125 bytes
12 files changed, 18 insertions, 6 deletions
diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst
index 267db465..bdadde92 100644
--- a/docs/glances-doc.rst
+++ b/docs/glances-doc.rst
@@ -6,7 +6,7 @@ This manual describes *Glances* version 2.5.
Copyright © 2011-2015 Nicolas Hennion <nicolas@nicolargo.com>
-May 2015
+September 2015
.. contents:: Table of Contents
@@ -147,8 +147,10 @@ Command-Line Options
-d, --debug enable debug mode
-C CONF_FILE, --config CONF_FILE
path to the configuration file
- --disable-quicklook disable quick look module
- --full-quicklook enable all but quick look and load
+ -3, --disable-quicklook
+ disable quick look module
+ -4, --full-quicklook
+ enable all but quick look and load
--disable-cpu disable CPU module
--disable-mem disable MEM module
--disable-swap disable SWAP module
@@ -161,7 +163,7 @@ Command-Line Options
--disable-hddtemp disable hddtemp module
--disable-raid disable RAID module
--disable-docker disable Docker module
- --disable-left-sidebar
+ -2, --disable-left-sidebar
disable network, disk I/O, file system and
sensors modules (py3sensors needed)
--disable-process disable process module
@@ -211,6 +213,7 @@ Command-Line Options
hide kernel threads in process list
--tree display processes as a tree
-b, --byte display network rate in byte per second
+ --fahrenheit display temperature in Fahrenheit (default is Celsius)
-1, --percpu start Glances in per CPU mode
--fs-free-space display file system free space instead of used
--theme-white optimize display colors for white background
@@ -425,6 +428,10 @@ bar view for CPU and memory (virtual and swap).
.. image:: images/quicklook.png
+If the per CPU mode is on (click '1'):
+
+.. image:: images/quicklook-percpu.png
+
*Note*: limit values can be overwritten in the configuration file under
the ``[quicklook]`` section.
@@ -589,6 +596,10 @@ Full view:
.. image:: images/processlist-wide.png
+Filtered view:
+
+.. image:: images/processlist-filter.png
+
Three views are available for processes:
* Processes summary
@@ -825,8 +836,9 @@ and run Glances with:
$ glances --export-influxdb
-InfluxDB 0.9.x also supports an optional tags configuration parameter
-specified as comma separated, key:value pairs. For example:
+InfluxDB 0.9.x or higher also supports an optional tags
+configuration parameter specified as comma separated, key:value pairs.
+For example:
.. code-block::
diff --git a/docs/images/diskio.png b/docs/images/diskio.png
index 6c67cbe8..bdc9c23e 100644
--- a/docs/images/diskio.png
+++ b/docs/images/diskio.png
Binary files differ
diff --git a/docs/images/docker.png b/docs/images/docker.png
index 4e64168e..8584d33d 100644
--- a/docs/images/docker.png
+++ b/docs/images/docker.png
Binary files differ
diff --git a/docs/images/fs.png b/docs/images/fs.png
index 17287068..d3c8464d 100644
--- a/docs/images/fs.png
+++ b/docs/images/fs.png
Binary files differ
diff --git a/docs/images/header.png b/docs/images/header.png
index f640dea2..33f1ba1d 100644
--- a/docs/images/header.png
+++ b/docs/images/header.png
Binary files differ
diff --git a/docs/images/per-cpu.png b/docs/images/per-cpu.png
index dfd0be66..fbf48aab 100644
--- a/docs/images/per-cpu.png
+++ b/docs/images/per-cpu.png
Binary files differ
diff --git a/docs/images/processlist-filter.png b/docs/images/processlist-filter.png
new file mode 100644
index 00000000..a804bf0f
--- /dev/null
+++ b/docs/images/processlist-filter.png
Binary files differ
diff --git a/docs/images/quicklook-percpu.png b/docs/images/quicklook-percpu.png
new file mode 100644
index 00000000..4956fe7f
--- /dev/null
+++ b/docs/images/quicklook-percpu.png
Binary files differ
diff --git a/docs/images/quicklook.png b/docs/images/quicklook.png
index 9606ba18..bdee804b 100644
--- a/docs/images/quicklook.png
+++ b/docs/images/quicklook.png
Binary files differ
diff --git a/docs/images/screenshot-web.png b/docs/images/screenshot-web.png
index 8467f863..5c866dbb 100644
--- a/docs/images/screenshot-web.png
+++ b/docs/images/screenshot-web.png
Binary files differ
diff --git a/docs/images/screenshot-wide.png b/docs/images/screenshot-wide.png
index 2acf5340..8106e627 100644
--- a/docs/images/screenshot-wide.png
+++ b/docs/images/screenshot-wide.png
Binary files differ
diff --git a/docs/images/sensors.png b/docs/images/sensors.png
index da1b1460..588b5936 100644
--- a/docs/images/sensors.png
+++ b/docs/images/sensors.png
Binary files differ