diff options
| author | Nicolargo <nicolas@nicolargo.com> | 2014-05-25 18:19:40 +0200 |
|---|---|---|
| committer | Nicolargo <nicolas@nicolargo.com> | 2014-05-25 18:19:40 +0200 |
| commit | a854f3d5d56fe7ee07759d789e0044e88cac4ca8 (patch) | |
| tree | 056972c1b532ef83f425ac754262b8cf0b3ead1c /README.rst | |
| parent | c68fc5d5c171ec040483f0725d704538f24cb305 (diff) | |
Update NEWS
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 50 |
1 files changed, 35 insertions, 15 deletions
@@ -18,7 +18,7 @@ Glances - An eye on your system .. image:: https://raw.github.com/nicolargo/glances/master/docs/images/glances-white-256.png :width: 128 -**Glances** is a cross-platform curses-based monitoring tool written in Python. +**Glances** is a cross-platform curses-based system monitoring tool written in Python. It uses the `psutil`_ library to get information from your system. @@ -34,7 +34,7 @@ Requirements Optional dependencies: - ``bottle`` (for Web Server mode) -- ``py3sensors`` (for HW monitoring support) [Linux-only] +- ``py3sensors`` (for hardware monitoring support) [Linux-only] - ``hddtemp`` (for HDD temperature monitoring support) - ``batinfo`` (for battery monitoring support) [Linux-only] @@ -44,13 +44,15 @@ Installation PyPI: The simple way -------------------- -Glances is on `PyPI`_. To install, simply use `pip`_: +Glances is on `PyPI`_. By using Pypi, you are sure to have the latest stable version. + +To install, simply use `pip`_: .. code-block:: console pip install Glances -*Note*: Python headers are required to install psutil. For example, +*Note*: Python headers are required to install PSutil. For example, on Debian/Ubuntu you need to install first the *python-dev* package. To upgrade Glances to the latest version: @@ -59,10 +61,10 @@ To upgrade Glances to the latest version: pip install --upgrade Glances -Linux ------ +GNU/Linux +--------- -At the moment, packages exist for the following distributions: +At the moment, packages exist for the following GNU/Linux distributions: - Arch Linux - Debian (Testing/Sid) @@ -120,13 +122,8 @@ Windows ------- Glances proposes a Windows client based on the `colorconsole`_ Python library. -Glances version < 1.7.2 only works in server mode. - -Thanks to Nicolas Bourges, a Windows installer is available: -- Glances-1.7.2-win32.msi_ (32-bit, MD5: dba4f6cc9f47b6806ffaeb665c093270) - -Otherwise, you have to follow these steps: +To install Glances on Windows OS, you have to follow these steps: - Install Python for Windows: http://www.python.org/getit/ - Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads @@ -156,13 +153,36 @@ You can install Glances using `Puppet`_: https://github.com/rverchere/puppet-gla Usage ===== -Just run: +For the standalone mode, just run: .. code-block:: console $ glances -and RTFM, always. + +For the Web server mode, run: + +.. code-block:: console + + $ glances -w + +and enter the URL http://<ip>:61208 in your favorite Web Browser. + +For the client/server mode, run: + +.. code-block:: console + + $ glances -s + +on the server side and run: + +.. code-block:: console + + $ glances -c <ip> + +on the client one. + +And RTFM, always. Documentation ============= |