nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-11-29 07:30:58 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #470 from desbma/doc

Browse Source 
Doc fixes
This commit is contained in:
Nicolas Hennion 2015-01-01 22:49:39 +01:00
commit 03d5cccb31
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/glances-doc.rst
View File

@ -117,6 +117,8 @@ and on the client enter the following URL in your favorite web browser:
where ``@server`` is the IP address or hostname of the server.
To change the refresh rate of the page, just add the period in seconds between refreshes at the end of the URL, ie. to refresh every 10s, use ``http://@server:61208/10``.
The Glances web interface follows responsive web design principles.
Screenshot from Chrome on Android
@ -226,7 +228,7 @@ The following commands (key pressed) are supported while in Glances:
``F``
Switch between FS used and free space
``g``
Generate hraphs for current history
Generate graphs for current history
``h``
Show/hide the help screen
``i``
@ -240,7 +242,7 @@ The following commands (key pressed) are supported while in Glances:
``p``
Sort processes by name
``q`` or ``ESC``
Quit the current Glances session
Quit the current Glances session
``r``
Reset history
``s``
@ -273,7 +275,7 @@ In the Glances client browser (accessible through the --browser command line arg
``DOWN``
Down in the servers list
``q`` or ``ESC``
Quit Glances
Quit Glances
Configuration
=============
@ -582,7 +584,7 @@ In standalone mode, additionals informations are provided for the top process:
* CPU affinity (number of cores used by the process)
* Extended memory information (swap, shared, text, lib, data and dirty on Linux)
* Open threads, files and network sessions (TCP and UDP)
* IO nice level
* IO nice level
The extended stats feature could be enabled using the --enable-process-extended option (command line) or the ``e`` key (curses interface).
@ -736,12 +738,12 @@ Glances will generate stats as:
APIs Documentations
===================
Glances includes a `XML-RPC server`_ and a `RESTFULL-JSON`_ API which and can be used by another client software.
Glances includes a `XML-RPC server`_ and a `RESTFUL-JSON`_ API which and can be used by another client software.
APIs documentations are available at:
- XML-RPC: https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to
- RESTFULL-JSON: https://github.com/nicolargo/glances/wiki/The-Glances-RESTFULL-JSON-API
- RESTFUL-JSON: https://github.com/nicolargo/glances/wiki/The-Glances-RESTFULL-JSON-API
Support
=======
@ -759,5 +761,5 @@ Feel free to contribute !
.. _psutil: https://code.google.com/p/psutil/
.. _XML-RPC server: http://docs.python.org/2/library/simplexmlrpcserver.html
.. _RESTFULL-JSON: http://jsonapi.org/
.. _RESTFUL-JSON: http://jsonapi.org/
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users

4
glances/README.txt
View File

@ -1,6 +1,6 @@
You are in the main Glances's source folder. This page is **ONLY** for developpers purposes.
If you are lookink for user manual, please follow this link: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
If you are looking for the user manual, please follow this link: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
===
@ -35,4 +35,4 @@ outputs/
exports/
=> Glances export interfaces
glances_csv.py The CSV export module
...
...