summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 44 insertions, 27 deletions
diff --git a/README.md b/README.md
index ea593088..c5f9a582 100644
--- a/README.md
+++ b/README.md
@@ -12,8 +12,14 @@ Glances uses the PsUtil library to get information from your system.
It is developed in Python.
+Console (80x24) screenshot:
+
![screenshot](https://github.com/nicolargo/glances/raw/master/screenshot.png)
+Wide terminal (> 90x24) screenshot:
+
+![screenshot](https://github.com/nicolargo/glances/raw/master/screenshot-wide.png)
+
## Installation
Pre-requisites (information for packagers):
@@ -29,36 +35,40 @@ Pre-requisites (information for packagers):
Packages exist for Arch, Fedora, Redhat, FreeBSD...
-### From PPA (easy way for Ubuntu/Mint...)
+### From PyPi (easy and cross platform way)
-Arnaud Hartmann (thanks to him !) maintains a PPA with the latest Glances version:
+PyPi is an official Python package manager.
-The PPA is available for Ubuntu version 9.10 to 12.04.
+You first need to install pypi on your system. For example on Debian/Ubuntu:
-To install the PPA just enter:
+ $ sudo apt-get install python-pip build-essential python-dev
- $ sudo add-apt-repository ppa:arnaud-hartmann/glances-stable
- $ sudo apt-get update
+Then install the latest Glances version:
-Then install Glances:
+ $ sudo pip install glances
+
+Note: if you are behind an HTTP Proxy, you should use
- $ sudo apt-get install glances
+ $ sudo pip install --proxy=user:password@url:port glances
-### From PyPi (easy way)
+### From PPA (easy way for Ubuntu/Mint...)
-PyPi is an official Python package manager.
+Arnaud Hartmann (thanks to him !) maintains a PPA with the latest Glances version:
-You first need to install pypi on your system. For example on Debian/Ubuntu:
+The PPA is available for Ubuntu version 9.10 to 12.04.
- $ sudo apt-get install python-pip build-essential python-dev
+To install the PPA just enter:
-Then install the latest Glances version:
+ $ sudo add-apt-repository ppa:arnaud-hartmann/glances-stable
+ $ sudo apt-get update
- $ sudo pip install glances
+Then install Glances:
+
+ $ sudo apt-get install glances
### From [Homebrew](http://mxcl.github.com/homebrew/) via PyPi (OS X)
- $ brew install brew-pip
+ $ brew install brew-pip
$ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages
$ brew pip Glances
@@ -66,13 +76,15 @@ Then install the latest Glances version:
Get the latest version:
- $ wget https://github.com/downloads/nicolargo/glances/glances-1.4.tar.gz
+ $ rm -rf /tm/nicolargo-glances-*
+ $ wget -O /tmp/glances-last.tgz https://github.com/nicolargo/glances/tarball/master
-Glances use a standard GNU style installer:
+Glances use a standard GNU style installer (for a Debian like system):
$ sudo apt-get install python-setuptools build-essential python-dev
- $ tar zxvf glances-1.4.tar.gz
- $ cd glances-1.4
+ $ cd /tmp
+ $ tar zxvf glances-last.tgz
+ $ cd nicolargo-glances-*
$ sudo python setup.py install
## Running
@@ -121,8 +133,14 @@ The header shows the host name and the operating system name, version and archit
### CPU
+Short view:
+
![screenshot](https://github.com/nicolargo/glances/raw/master/doc/cpu.png)
+Long view (only available if your terminal is wide enough)
+
+![screenshot](https://github.com/nicolargo/glances/raw/master/doc/cpu-wide.png)
+
The CPU stats are shown as a percentage and for the configured refresh
time. The total CPU usage is displayed on the first line.
@@ -229,8 +247,14 @@ If disk used is > 90%, then status is set to "CRITICAL".
### Processes
+Short view:
+
![screenshot](https://github.com/nicolargo/glances/raw/master/doc/processlist.png)
+Long view (only available if your terminal is wide enough)
+
+![screenshot](https://github.com/nicolargo/glances/raw/master/doc/processlist-wide.png)
+
Glances displays a summary and a list of processes.
By default (or if you hit the 'a' key) the process list is automatically
@@ -253,6 +277,7 @@ The number of processes in the list is adapted to the screen size.
T - Traced or stopped
Z - Zombie or "hung" process
+* IO READ and WRITE: Per process IO read and write
* TIME+: Cumulative CPU time used
* NAME: Process name or command line
@@ -286,11 +311,3 @@ i18n_francais_generate.sh
To generate spanish locale execute as root or sudo :
i18n_espanol_generate.sh
-
-## Todo
-
-You are welcome to contribute to this software.
-
-* Code optimization
-* Port to FreeBSD and Mac OS X
-* Documentation for HTML and CVS export option