summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorNicolas Hennion <nicolas@nicolargo.com>2013-01-19 11:30:38 +0100
committerNicolas Hennion <nicolas@nicolargo.com>2013-01-19 11:30:38 +0100
commitc135f39cc8434f4588acd50defee6458c0232057 (patch)
tree3dd15430872da13570d87c2ee31db87d4c18d6e3 /README
parentd767f717bb0d2a11bf6a67f661d9574cc070a7be (diff)
In client/server mode Glances grabs limits from the server side
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 26 insertions, 15 deletions
diff --git a/README b/README
index 361e4ab9..6c2551ce 100644
--- a/README
+++ b/README
@@ -44,7 +44,7 @@ Check if the version is the latest one.
PyPi is an official Python package manager.
-You first need to install pypi on your system. For example on Debian/Ubuntu:
+You first need to install PyPi on your system. For example on Debian/Ubuntu:
$ sudo apt-get update
$ sudo apt-get install python-pip build-essential python-dev
@@ -53,11 +53,11 @@ Then install the latest Glances version:
$ sudo pip install Glances
-Note: if you are behind an HTTP Proxy, you should use
+Note: if you are behind an HTTP Proxy, you should use instead:
$ sudo pip install --proxy=user:password@url:port Glances
-### From [Homebrew](http://mxcl.github.com/homebrew/) via PyPi (OS X)
+### From [Homebrew](http://mxcl.github.com/homebrew/) for Mac OS X
$ brew install brew-pip
$ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages
@@ -66,10 +66,8 @@ Note: if you are behind an HTTP Proxy, you should use
If you have the following error:
Error: Failed executing: pip install glances==1.X --install-option=--prefix=/usr/local/XXX/glances/1.X (.rb:)
- This link will help resolve the above errors:
- https://github.com/mxcl/homebrew/wiki/bug-fixing-checklist
-Try to runs:
+then try to run:
$ pip install glances==1.X --install-option=--prefix=/usr/local/XXX/glances/1.X
$ brew link Glances
@@ -84,7 +82,7 @@ To install Glances on you system:
* Install the [PsUtil lib](https://code.google.com/p/psutil/downloads/list)
* Download the latest [Glances version](https://raw.github.com/nicolargo/glances/master/glances/glances.py)
-I need contributors to package Glances for Windows (for exemple using [PyInstaller](http://www.pyinstaller.org/)).
+I am looking for a contributor to package Glances for Windows (for exemple using [PyInstaller](http://www.pyinstaller.org/)).
### From source
@@ -102,6 +100,14 @@ Glances use a standard GNU style installer (for a Debian like system):
$ cd nicolargo-glances-*
$ sudo python setup.py install
+## Configuration
+
+No configuration is needed to use Glances.
+
+Furthermore, the release 1.6 introduces a configuration file to setup limits.
+
+The default configuration file is under the /etc/glances/glances.conf file.
+
## Running
### In standalone mode
@@ -126,6 +132,15 @@ where @server is the IP address or hostname of the server
Glances uses a [XML/RPC](http://docs.python.org/2/library/simplexmlrpcserver.html) server and can be used by another client software.
+In server mode, you can set the bind address (-B ADDRESS) and listenning TCP port (-p PORT).
+
+In client mode, you can set the TCP port of the server (-p port).
+
+Default binding address is 0.0.0.0 (Glances will listen on all the networks interfaces).
+ TCP port is 61209.
+
+In client/server mode, limits are set by the server.
+
## User guide
By default, stats are refreshed every second, to change this setting, you can
@@ -142,9 +157,10 @@ Importants stats are colored:
When Glances is running, you can press:
-* 'h' to display a help message with the keys you can press
* 'a' to set the automatic mode. The processes are sorted automatically
+ IF CPU IoWait > 60% sort by process "IO read and write"
+
If CPU > 70%, sort by process "CPU consumption"
If MEM > 70%, sort by process "memory size"
@@ -154,6 +170,8 @@ When Glances is running, you can press:
* 'd' disable or enable the disk IO stats
* 'e' enable the sensors module (PySensors library is needed; Linux-only)
* 'f' disable or enable the file system stats
+* 'h' to display a help message with the keys you can press and the limits
+* 'i' sort the processes list by CPU IO (need root account on some OS)
* 'l' disable or enable the logs
* 'm' sort the processes list by process MEM
* 'n' disable or enable the network interfaces stats
@@ -164,13 +182,6 @@ When Glances is running, you can press:
* '1' switch between global CPU and per core stats
* 'q' Exit
-In server mode, you can set the bind address (-B ADDRESS) and listenning TCP port (-p PORT).
-
-In client mode, you can set the TCP port of the server (-p port).
-
-Default binding address is 0.0.0.0 (Glancess will listen on all the networks interfaces).
- TCP port is 61209.
-
### Header
![screenshot](https://github.com/nicolargo/glances/raw/master/doc/header.png)