diff options
author | Nicolargo <nicolas@nicolargo.com> | 2014-06-14 09:44:02 +0200 |
---|---|---|
committer | Nicolargo <nicolas@nicolargo.com> | 2014-06-14 09:44:02 +0200 |
commit | cf480a9b410e2d2d35eb0c7cbd8d242133797bf5 (patch) | |
tree | 90369c6e48c3a5f6c82d4da2f102ddb1abddb8c7 /README.rst | |
parent | 4881fb6c5223456ffdd2e909fb9db828b096d06c (diff) | |
parent | 8b637e91f10d41093030a2d8786ef8cdabb443e9 (diff) |
Merge v2.0 release branch
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 80 |
1 files changed, 70 insertions, 10 deletions
@@ -18,7 +18,8 @@ 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. @@ -27,16 +28,29 @@ It uses the `psutil`_ library to get information from your system. Requirements ============ +<<<<<<< HEAD - ``python >= 2.6`` (tested with version 2.6, 2.7, 3.2, 3.3, 3.4) - ``psutil >= 0.5.1`` (recommended version >= 2.0.0) +======= +- ``python >= 2.6`` (tested with version 2.6, 2.7, 3.3, 3.4) +- ``psutil >= 2.0.0`` +>>>>>>> release/v2.0 - ``setuptools`` Optional dependencies: +<<<<<<< HEAD - ``jinja2`` (for HTML output) - ``pysensors`` (for HW monitoring support) [Linux-only] - ``hddtemp`` (for HDD temperature monitoring support) - ``batinfo`` (for battery monitoring support) [Linux-only] +======= +- ``bottle`` (for Web server mode) +- ``py3sensors`` (for hardware monitoring support) [Linux-only] +- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only] +- ``batinfo`` (for battery monitoring support) [Linux-only] +- ``pysnmp`` (for SNMP support) +>>>>>>> release/v2.0 Installation ============ @@ -44,14 +58,22 @@ 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 +<<<<<<< HEAD *Note*: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the *python-dev* package. +======= +*Note*: Python headers are required to install psutil. For example, +on Debian/Ubuntu you need to install first the *python-dev* package. +>>>>>>> release/v2.0 To upgrade Glances to the latest version: @@ -59,10 +81,14 @@ To upgrade Glances to the latest version: pip install --upgrade Glances -Linux ------ +GNU/Linux +--------- +<<<<<<< HEAD At the moment, packages exist for the following distributions: +======= +At the moment, packages exist for the following GNU/Linux distributions: +>>>>>>> release/v2.0 - Arch Linux - Debian (Testing/Sid) @@ -99,7 +125,7 @@ To install Glances from ports: OS X ---- -OS X users can also install Glances using `Homebrew`_ or `MacPorts`_. +OS X users can install Glances using `Homebrew`_ or `MacPorts`_. Homebrew ```````` @@ -119,6 +145,7 @@ MacPorts Windows ------- +<<<<<<< HEAD Glances proposes a Windows client based on the `colorconsole`_ Python library. Glances version < 1.7.2 only works in server mode. @@ -127,6 +154,12 @@ 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: +======= +Glances proposes a Windows client based on the `colorconsole`_ Python +library. + +To install Glances on Windows, you have to follow these steps: +>>>>>>> release/v2.0 - Install Python for Windows: http://www.python.org/getit/ - Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads @@ -136,17 +169,22 @@ Otherwise, you have to follow these steps: Source ------ -To install Glances from source: +To install Glances version X.Y from source: .. code-block:: console - $ curl -L https://github.com/nicolargo/glances/archive/vX.X.tar.gz -o glances-X.X.tar.gz + $ curl -L https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -o glances-X.Y.tar.gz $ tar -zxvf glances-*.tar.gz $ cd glances-* # python setup.py install +<<<<<<< HEAD *Note*: Python headers are required to install psutil. For example, on Debian/Ubuntu you need to install first the *python-dev* package. +======= +*Note*: Python headers are required to install psutil. For example, +on Debian/Ubuntu you need to install first the *python-dev* package. +>>>>>>> release/v2.0 Puppet ------ @@ -156,13 +194,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 ============= @@ -186,7 +247,6 @@ LGPL. See ``COPYING`` for more details. .. _pip: http://www.pip-installer.org/ .. _Homebrew: http://brew.sh/ .. _MacPorts: https://www.macports.org/ -.. _Glances-1.7.2-win32.msi: http://glances.s3.amazonaws.com/Glances-1.7.2-win32.msi .. _colorconsole: https://pypi.python.org/pypi/colorconsole .. _Puppet: https://puppetlabs.com/puppet/what-is-puppet/ .. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst |