glances/docs/glances.rst
Georgiy Timchenko 66e7916fbf Fix typos and make grammatical and stylistic edits in project documentation
Several typos were found and corrected in the project documentation. Additionally, a number of grammatical and stylistic improvements were made to enhance clarity and coherence. These changes affect the following files:

- docs/api.rst
- docs/cmds.rst
- docs/config.rst
- docs/docker.rst
- docs/glances.rst
- docs/index.rst
- docs/install.rst
- docs/quickstart.rst
- docs/support.rst

These corrections and improvements significantly enhance the readability and accuracy of the documentation, making it more accessible and comprehensible for both users and developers.
2023-12-10 22:38:38 +04:00

82 lines
1.7 KiB
ReStructuredText

:orphan:
glances
=======
SYNOPSIS
--------
**glances** [OPTIONS]
DESCRIPTION
-----------
**glances** is a cross-platform curses-based monitoring tool that aims
to present a maximum of information in a minimum of space, ideally fitting
in a classic 80x24 terminal or larger for more details. It can adapt
dynamically to the displayed information depending on the terminal size.
It can also work in client/server mode.
Remote monitoring can be performed via a terminal or web interface.
**glances** is written in Python and uses the *psutil* library to get
information from your system.
OPTIONS
-------
.. include:: cmds.rst
CONFIGURATION
-------------
.. include:: config.rst
EXAMPLES
--------
Monitor local machine (standalone mode):
$ glances
To monitor the local machine with the web interface (Web UI),
, run the following command line:
$ glances -w
then, open a web browser to the provided URL.
Monitor local machine and export stats to a CSV file:
$ glances --export csv --export-csv-file /tmp/glances.csv
Monitor local machine and export stats to an InfluxDB server with 5s
refresh time (also possible to export to OpenTSDB, Cassandra, Statsd,
ElasticSearch, RabbitMQ, and Riemann):
$ glances -t 5 --export influxdb
It is also possible to export stats to multiple endpoints:
$ glances -t 5 --export influxdb,statsd,csv
Start a Glances server (server mode):
$ glances -s
Connect Glances to a Glances server (client mode):
$ glances -c <ip_server>
Connect to a Glances server and export stats to a StatsD server:
$ glances -c <ip_server> --export statsd
Start the client browser (browser mode):
$ glances --browser
AUTHOR
------
Nicolas Hennion aka Nicolargo <contact@nicolargo.com>