提交 ac97f1c8 编写于 作者: N Nicolas Hennion

Update documentation for the beta phase

上级 b8a4be53
...@@ -3,6 +3,8 @@ Version 1.5 ...@@ -3,6 +3,8 @@ Version 1.5
* Add a client/server mode (XMLRPC) for remote monitoring * Add a client/server mode (XMLRPC) for remote monitoring
* Correct a bug on process IO with non root users * Correct a bug on process IO with non root users
* Add 'w' shortkey to delete finished warning message
* Add 'x' shortkey to delete finished warning/critical message
* Code and memory print optimization * Code and memory print optimization
Version 1.4.2.2 Version 1.4.2.2
......
...@@ -86,9 +86,21 @@ Try to runs: ...@@ -86,9 +86,21 @@ Try to runs:
$ pip install glances==1.X --install-option=--prefix=/usr/local/XXX/glances/1.X $ pip install glances==1.X --install-option=--prefix=/usr/local/XXX/glances/1.X
$ brew link Glances $ brew link Glances
### Concerning Windows operating system
Windows operating system only support the Glances in server mode. So if you ran Glances on Windows, it will be automaticaly running in server mode.
To install Glances on you system:
* Install [Python for Windows](http://www.python.org/getit/)
* 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/)).
### From source ### From source
Get the latest version: Get the latest version (form GitHub):
$ rm -rf /tmp/nicolargo-glances-* $ rm -rf /tmp/nicolargo-glances-*
$ wget -O /tmp/glances-last.tgz https://github.com/nicolargo/glances/tarball/master $ wget -O /tmp/glances-last.tgz https://github.com/nicolargo/glances/tarball/master
...@@ -124,6 +136,8 @@ and this one on the client: ...@@ -124,6 +136,8 @@ and this one on the client:
where @server is the IP address or hostname of the server 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.
## User guide ## User guide
By default, stats are refreshed every second, to change this setting, you can By default, stats are refreshed every second, to change this setting, you can
...@@ -155,8 +169,8 @@ When Glances is running, you can press: ...@@ -155,8 +169,8 @@ When Glances is running, you can press:
* 'm' sort the processes list by process MEM * 'm' sort the processes list by process MEM
* 'n' disable or enable the network interfaces stats * 'n' disable or enable the network interfaces stats
* 'p' sort by process name * 'p' sort by process name
* 'w' delete warning logs messages * 'w' delete finished warning logs messages
* 'x' delete warning and critical logs messages * 'x' delete finished warning and critical logs messages
* '1' switch between global CPU and per core stats * '1' switch between global CPU and per core stats
* 'q' Exit * 'q' Exit
...@@ -323,7 +337,6 @@ The number of processes in the list is adapted to the screen size. ...@@ -323,7 +337,6 @@ The number of processes in the list is adapted to the screen size.
* TIME+: Cumulative CPU time used * TIME+: Cumulative CPU time used
* NAME: Process name or command line * NAME: Process name or command line
### Logs ### Logs
![screenshot](https://github.com/nicolargo/glances/raw/master/doc/logs.png) ![screenshot](https://github.com/nicolargo/glances/raw/master/doc/logs.png)
...@@ -346,6 +359,8 @@ There is one line per alert with the following information: ...@@ -346,6 +359,8 @@ There is one line per alert with the following information:
Glances displays the current time/date and access to the embedded help screen. Glances displays the current time/date and access to the embedded help screen.
On the left, you can easely seen if you are connected to a Glances server.
## Localisation ## Localisation
Glances localization files exist for: Glances localization files exist for:
......
[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/thing/484466/nicolargoglances-on-GitHub)
=========================================== ===========================================
Glances -- Votre système en un coups d'oeil Glances -- Votre système en un coups d'oeil
=========================================== ===========================================
...@@ -7,7 +5,7 @@ Glances -- Votre système en un coups d'oeil ...@@ -7,7 +5,7 @@ Glances -- Votre système en un coups d'oeil
## Description ## Description
Glances est un logiciel libre (licence LGPL) permettant de surveiller votre Glances est un logiciel libre (licence LGPL) permettant de surveiller votre
système d'exploitation GNU/Linux ou BSD à partir d'une interface texte. système d'exploitation GNU/Linux ou BSD à partir d'une interface texte (CLI).
Glances utilise la librairie PsUtil pour récupérer les informations de Glances utilise la librairie PsUtil pour récupérer les informations de
votre système. Il est développé en Python. votre système. Il est développé en Python.
...@@ -33,7 +31,7 @@ Glances a besoin des dépendances suivantes: ...@@ -33,7 +31,7 @@ Glances a besoin des dépendances suivantes:
### Depuis le gestionnaire de paquet de votre système ### Depuis le gestionnaire de paquet de votre système
Des paquets existent pour plusieurs distributions: Arch, Fedora/Redhat... Des paquets existent pour plusieurs distributions: Debian (SID) Arch, Fedora/Redhat...
Le processus de packaging est actuellement en cours sur d'autres distribs, je Le processus de packaging est actuellement en cours sur d'autres distribs, je
vous conseille donc de rechercher Glances sur votre gestionnaire de package vous conseille donc de rechercher Glances sur votre gestionnaire de package
avant de faire une installation depuis les sources. avant de faire une installation depuis les sources.
...@@ -74,9 +72,32 @@ Le PPA propose les paquets pour les versions Ubuntu 9.10 jusqu'à 12.04. ...@@ -74,9 +72,32 @@ Le PPA propose les paquets pour les versions Ubuntu 9.10 jusqu'à 12.04.
$ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages $ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages
$ brew pip Glances $ brew pip Glances
Si vous rencontrez l'erreur suivante:
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
Essayez de finaliser l'installation avec les commandes:
$ pip install glances==1.X --install-option=--prefix=/usr/local/XXX/glances/1.X
$ brew link Glances
### Egalement sur les système Windows
Les systèmes Windows sont uniquement supportés en mode serveur. Donc si vous lancez Glances sur une machine Windows, il sera automatiquement lancé en mode serveur.
Pour installer Glances sous Windows:
* Installer [Python pour Windows](http://www.python.org/getit/)
* Installer la librairie [PsUtil](https://code.google.com/p/psutil/downloads/list)
* Télécharger la dernière version de [Glances](https://raw.github.com/nicolargo/glances/master/glances/glances.py)
Je cherche des contributeurs pouvant packager Glances pour Windows. Notamment à l'aide de [PyInstaller](http://www.pyinstaller.org/).
### Depuis les sources ### Depuis les sources
Le projet Glances est hébergé sur GitHUB: https://github.com/nicolargo/glances Le projet Glances est hébergé sur [GitHub](https://github.com/nicolargo/glances)
Pour l'installer, il suffit de suivre les instructions suivantes depuis un Pour l'installer, il suffit de suivre les instructions suivantes depuis un
terminal. terminal.
...@@ -101,8 +122,24 @@ Il suffit de saisir la commande suivante dans une console ou un terminal: ...@@ -101,8 +122,24 @@ Il suffit de saisir la commande suivante dans une console ou un terminal:
$ glances $ glances
Note: sur certaines distributions, il faut saisir glances en lieu et place Note: sur certaines distributions, il faut saisir glances.py en lieu et place
de glances.py. de glances.
### En mode client/server mode
Si vous souhaitez surveiller à distance une machine depuis une autre machine.
Il suffit de commencer par lancer Glances en mode serveur sur la machine distante:
server$ glances -s
Puis de lancer la commande suivante sur votre autre machine:
client$ glances -c @server
ou @server est l'adresse IP ou le nom d'hôte de la machine distante.
Glances utilise un serveur de type [XML/RPC](http://docs.python.org/2/library/simplexmlrpcserver.html) et peut donc être interrogé par des applications tierces.
## Guide d'utilisation ## Guide d'utilisation
...@@ -121,18 +158,24 @@ Les statistiques jugées importantes sont affichées en couleur: ...@@ -121,18 +158,24 @@ Les statistiques jugées importantes sont affichées en couleur:
Quand Glances est lancé, il est possible d'utiliser les touches suivantes: Quand Glances est lancé, il est possible d'utiliser les touches suivantes:
* 'a' pour trier la liste des processus de manière automatique: * 'h' afficher l'aide en ligne
* 'a' trier la liste des processus de manière automatique:
Si la CPU totale > 70% alors le tri se fait pas consommation CPU Si la CPU totale > 70% alors le tri se fait pas consommation CPU
si la mémoire total > 70% alors le tri se fait pas consommation MEMOIRE si la mémoire total > 70% alors le tri se fait pas consommation MEMOIRE
* 'c' pour forcer le tri par consommation CPU * 'b' passer le débit des interfaces réseaux de bit par sec à octet par sec
* 'd' pour desactiver ou activer l'affichage des entrées/sorties disques * 'c' forcer le tri par consommation CPU
* 'f' pour desactiver ou activer l'affichage de l'occupation des FS * 'd' desactiver ou activer l'affichage des entrées/sorties disques
* 'l' pour desactiver ou activer l'affichage des logs * 'f' desactiver ou activer l'affichage de l'occupation des FS
* 'm' pour forcer le tri par consommation MEMOIRE * 'l' desactiver ou activer l'affichage des logs
* 'n' pour desactiver ou activer l'affichage des interfaces réseau * 'm' forcer le tri par consommation MEMOIRE
* 'n' desactiver ou activer l'affichage des interfaces réseau
* 'p' forcer le tri par nom de processus
* 'w' supprimer les alertes finies de type WARNING
* 'x' supprimer les alertes finies de type WARNING et CRITICAL
* '1' passer des stats CPU globale à CPU détaillé
* 'q' sortir de Glances (il est également possible d'utiliser CTRL-C) * 'q' sortir de Glances (il est également possible d'utiliser CTRL-C)
Passons ensuite à la description de la fenêtre de Glances: Passons ensuite à la description de la fenêtre de Glances:
...@@ -301,4 +344,3 @@ date et l'heure courante. ...@@ -301,4 +344,3 @@ date et l'heure courante.
## Traduction ## Traduction
Glances existe en Anglais, Francais, Espagnol, Portugais. Glances existe en Anglais, Francais, Espagnol, Portugais.
- Need a packager for Windows OS (server mode only)
- Need translators contributions - Need translators contributions
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册