From c29ddd58bf64fc81abe18ebcd2bbaf12c0e61ef5 Mon Sep 17 00:00:00 2001 From: Alessio Sergi Date: Sat, 14 Jun 2014 12:44:24 +0200 Subject: Fix leftovers from merge conflict --- docs/glances-doc.html | 149 +++++++++++++++++++------------------------------- docs/glances-doc.rst | 34 +----------- 2 files changed, 59 insertions(+), 124 deletions(-) (limited to 'docs') diff --git a/docs/glances-doc.html b/docs/glances-doc.html index 0f668877..f584c296 100644 --- a/docs/glances-doc.html +++ b/docs/glances-doc.html @@ -129,43 +129,41 @@ td.option-group {

Table of Contents

-

Introduction

+

Introduction

Glances is a cross-platform curses-based system monitoring tool which aims to present a maximum of information in a minimum of space, ideally to fit in a classical 80x24 terminal or higher to have additional @@ -183,16 +181,16 @@ information from your system.

images/screenshot-web.png
-

Usage

+

Usage

-

Standalone Mode

+

Standalone Mode

Simply run:

 $ glances
-

Client/Server Mode

+

Client/Server Mode

If you want to remotely monitor a machine, called server, from another one, called client, just run on the server:

@@ -221,7 +219,7 @@ client, the latter will try to grab stats using the
-

Web Server Mode

+

Web Server Mode

If you want to remotely monitor a machine, called server, from any device with a web browser, called client, just run on the server:

@@ -238,9 +236,9 @@ http://@server:61208
-

Command Reference

+

Command Reference

-

Command-Line Options

+

Command-Line Options

@@ -342,7 +340,7 @@ file
-

Interactive Commands

+

Interactive Commands

The following commands (key pressed) are supported while in Glances:

a
@@ -393,7 +391,7 @@ file
-

Configuration

+

Configuration

Caution! Glances version 1.x configuration files are not compatible with the version 2.x.

No configuration file is mandatory to use Glances.

@@ -432,9 +430,9 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/ ~/Library/Application Support/glances/.

-

Anatomy Of The Application

+

Anatomy Of The Application

-

Legend

+

Legend

GREEN stat counter is "OK"
BLUE stat counter is "CAREFUL"
@@ -445,7 +443,7 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/ view.

-

CPU

+

CPU

Short view:

images/cpu.png

If enough horizontal space is available, extended CPU information are @@ -478,9 +476,9 @@ time. The total CPU usage is displayed on the first line.

the [cpu] and/or [percpu] sections.

-

Load

+

Load

images/load.png -

On the No Sheep blog, Zachary Tirrell defines the load average [1]:

+

On the No Sheep blog, Zachary Tirrell defines the load average [1]:

"In short it is the average sum of the number of processes waiting in the run-queue plus the number currently executing @@ -498,7 +496,7 @@ The first line also displays the number of CPU core.

the [load] section.

-

Memory

+

Memory

Glances uses two columns: one for the RAM and one for the SWAP.

images/mem.png

If enough space is available, Glances displays extended information for @@ -515,7 +513,7 @@ the RAM:

the [memory] and/or [memswap] sections.

-

Network

+

Network

images/network.png

Glances displays the network interface bit rate. The unit is adapted dynamically (bits per second, kbits per second, Mbits per second, etc).

@@ -526,7 +524,7 @@ and per-interface limit values in the [network]
-

Disk I/O

+

Disk I/O

images/diskio.png

Glances displays the disk I/O throughput. The unit is adapted dynamically.

There is no alert on this information.

@@ -534,7 +532,7 @@ configuration file.

[diskio] section in the configuration file.

-

File System

+

File System

images/fs.png

Glances displays the used and total file system disk space. The unit is adapted dynamically.

@@ -549,9 +547,9 @@ adapted dynamically.

the [filesystem] section.

-

Sensors

+

Sensors

Glances can displays the sensors information using lm-sensors, -hddtemp and batinfo [2].

+hddtemp and batinfo [2].

All of the above libraries are available only on Linux.

As of lm-sensors, a filter is being applied in order to display temperature only.

@@ -561,7 +559,7 @@ temperature only.

the [sensors] section.

-

Processes List

+

Processes List

Compact view:

images/processlist.png

Full view:

@@ -596,7 +594,7 @@ automatically sorted by:

MEM%
% of MEM used by the process
VIRT
-
Total program size aka Virtual Memory Size (VMS)
+
Total program size - Virtual Memory Size (VMS)
RES
Resident Set Size (RSS)
PID
@@ -629,11 +627,11 @@ automatically sorted by:

Z
Zombie
-

Note: limits values can be overwritten in the configuration file under +

Note: limit values can be overwritten in the configuration file under the [process] section.

-

Monitored Processes List

+

Monitored Processes List

The monitored processes list allows user, through the configuration file, to group processes and quickly show if the number of running processes is not good.

@@ -685,7 +683,7 @@ get the JSON representation of the monitored processes list.

-

Logs

+

Logs

images/logs.png

A log messages list is displayed in the bottom of the screen if (and only if):

@@ -705,7 +703,7 @@ processes list alerts
-

Other Outputs

+

Other Outputs

It is possible to export statistics to CSV file.

 $ glances --output-csv /tmp/glances.csv
@@ -717,56 +715,23 @@ processes list alerts
-

API Documentation

+

API Documentation

Glances uses a XML-RPC server and can be used by another client software.

-

<<<<<<< HEAD -API documentation is available at https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To

-
-
-

Other outputs

-

Thanks to the -o (output) option, it is possible to export statistics to CSV or HTML files.

-
-$ glances -o CSV -f /tmp
-
-

The CSV output file is named glances.csv.

-

CSV files have on line per stats:

-
    -
  • load,load1,load5,load15
    • -
  • mem,total,used,free
    • -
  • swap,total,used,free
    • -
  • cpu,user,system,nice,idle,iowait,irq
    • -
-
-$ glances -o HTML -f /tmp
-
-

The HTML output file is named glances.html.

-
-
-

Note: The css and img folders (glances/data) should be in the /tmp folder.

-
-

System Message: WARNING/2 (./docs/glances-doc.rst, line 628)

-

Title underline too short.

-
-*Note*: The css and img folders (glances/data) should be in the /tmp folder.
-=======
-
-

API documentation is available at -https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to. ->>>>>>> release/v2.0

+https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to.

-

Support

+

Support

To report a bug or a feature request use the bug tracking system at https://github.com/nicolargo/glances/issues.

Feel free to contribute!

- +
[1]http://nosheep.net/story/defining-unix-load-average/
- +
diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst index cea11d38..2eb929ff 100644 --- a/docs/glances-doc.rst +++ b/docs/glances-doc.rst @@ -462,7 +462,7 @@ The number of processes in the list is adapted to the screen size. ``MEM%`` % of MEM used by the process ``VIRT`` - Total program size aka Virtual Memory Size (VMS) + Total program size - Virtual Memory Size (VMS) ``RES`` Resident Set Size (RSS) ``PID`` @@ -495,7 +495,7 @@ Process status legend: ``Z`` Zombie -*Note*: limits values can be overwritten in the configuration file under +*Note*: limit values can be overwritten in the configuration file under the ``[process]`` section. Monitored Processes List @@ -597,38 +597,8 @@ API Documentation Glances uses a `XML-RPC server`_ and can be used by another client software. -<<<<<<< HEAD -API documentation is available at https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To - -Other outputs -============= - -Thanks to the -o (output) option, it is possible to export statistics to `CSV` or `HTML` files. - -.. code-block:: console - - $ glances -o CSV -f /tmp - -The CSV output file is named ``glances.csv``. - -CSV files have on line per stats: - -- load,load1,load5,load15 -- mem,total,used,free -- swap,total,used,free -- cpu,user,system,nice,idle,iowait,irq - -.. code-block:: console - - $ glances -o HTML -f /tmp - -The HTML output file is named ``glances.html``. - -*Note*: The css and img folders (glances/data) should be in the /tmp folder. -======= API documentation is available at https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to. ->>>>>>> release/v2.0 Support ======= -- cgit v1.2.3
[2]https://github.com/nicolargo/batinfo