diff options
Diffstat (limited to 'docs/glances-doc.html')
-rw-r--r-- | docs/glances-doc.html | 149 |
1 files changed, 57 insertions, 92 deletions
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 { <div class="contents topic" id="table-of-contents"> <p class="topic-title first">Table of Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#introduction" id="id6">Introduction</a></li> -<li><a class="reference internal" href="#usage" id="id7">Usage</a><ul> -<li><a class="reference internal" href="#standalone-mode" id="id8">Standalone Mode</a></li> -<li><a class="reference internal" href="#client-server-mode" id="id9">Client/Server Mode</a></li> -<li><a class="reference internal" href="#web-server-mode" id="id10">Web Server Mode</a></li> +<li><a class="reference internal" href="#introduction" id="id5">Introduction</a></li> +<li><a class="reference internal" href="#usage" id="id6">Usage</a><ul> +<li><a class="reference internal" href="#standalone-mode" id="id7">Standalone Mode</a></li> +<li><a class="reference internal" href="#client-server-mode" id="id8">Client/Server Mode</a></li> +<li><a class="reference internal" href="#web-server-mode" id="id9">Web Server Mode</a></li> </ul> </li> -<li><a class="reference internal" href="#command-reference" id="id11">Command Reference</a><ul> -<li><a class="reference internal" href="#command-line-options" id="id12">Command-Line Options</a></li> -<li><a class="reference internal" href="#interactive-commands" id="id13">Interactive Commands</a></li> +<li><a class="reference internal" href="#command-reference" id="id10">Command Reference</a><ul> +<li><a class="reference internal" href="#command-line-options" id="id11">Command-Line Options</a></li> +<li><a class="reference internal" href="#interactive-commands" id="id12">Interactive Commands</a></li> </ul> </li> -<li><a class="reference internal" href="#configuration" id="id14">Configuration</a></li> -<li><a class="reference internal" href="#anatomy-of-the-application" id="id15">Anatomy Of The Application</a><ul> -<li><a class="reference internal" href="#legend" id="id16">Legend</a></li> -<li><a class="reference internal" href="#header" id="id17">Header</a></li> -<li><a class="reference internal" href="#cpu" id="id18">CPU</a></li> -<li><a class="reference internal" href="#load" id="id19">Load</a></li> -<li><a class="reference internal" href="#memory" id="id20">Memory</a></li> -<li><a class="reference internal" href="#network" id="id21">Network</a></li> -<li><a class="reference internal" href="#disk-i-o" id="id22">Disk I/O</a></li> -<li><a class="reference internal" href="#file-system" id="id23">File System</a></li> -<li><a class="reference internal" href="#sensors" id="id24">Sensors</a></li> -<li><a class="reference internal" href="#processes-list" id="id25">Processes List</a></li> -<li><a class="reference internal" href="#monitored-processes-list" id="id26">Monitored Processes List</a></li> -<li><a class="reference internal" href="#logs" id="id27">Logs</a></li> +<li><a class="reference internal" href="#configuration" id="id13">Configuration</a></li> +<li><a class="reference internal" href="#anatomy-of-the-application" id="id14">Anatomy Of The Application</a><ul> +<li><a class="reference internal" href="#legend" id="id15">Legend</a></li> +<li><a class="reference internal" href="#header" id="id16">Header</a></li> +<li><a class="reference internal" href="#cpu" id="id17">CPU</a></li> +<li><a class="reference internal" href="#load" id="id18">Load</a></li> +<li><a class="reference internal" href="#memory" id="id19">Memory</a></li> +<li><a class="reference internal" href="#network" id="id20">Network</a></li> +<li><a class="reference internal" href="#disk-i-o" id="id21">Disk I/O</a></li> +<li><a class="reference internal" href="#file-system" id="id22">File System</a></li> +<li><a class="reference internal" href="#sensors" id="id23">Sensors</a></li> +<li><a class="reference internal" href="#processes-list" id="id24">Processes List</a></li> +<li><a class="reference internal" href="#monitored-processes-list" id="id25">Monitored Processes List</a></li> +<li><a class="reference internal" href="#logs" id="id26">Logs</a></li> </ul> </li> -<li><a class="reference internal" href="#other-outputs" id="id28">Other Outputs</a></li> -<li><a class="reference internal" href="#api-documentation" id="id29">API Documentation</a></li> -<li><a class="reference internal" href="#id3" id="id30">Other outputs</a></li> -<li><a class="reference internal" href="#note-the-css-and-img-folders-glances-data-should-be-in-the-tmp-folder" id="id31"><em>Note</em>: The css and img folders (glances/data) should be in the /tmp folder.</a></li> -<li><a class="reference internal" href="#support" id="id32">Support</a></li> +<li><a class="reference internal" href="#other-outputs" id="id27">Other Outputs</a></li> +<li><a class="reference internal" href="#api-documentation" id="id28">API Documentation</a></li> +<li><a class="reference internal" href="#support" id="id29">Support</a></li> </ul> </div> <div class="section" id="introduction"> -<h1><a class="toc-backref" href="#id6">Introduction</a></h1> +<h1><a class="toc-backref" href="#id5">Introduction</a></h1> <p>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.</p> <img alt="images/screenshot-web.png" src="images/screenshot-web.png" /> </div> <div class="section" id="usage"> -<h1><a class="toc-backref" href="#id7">Usage</a></h1> +<h1><a class="toc-backref" href="#id6">Usage</a></h1> <div class="section" id="standalone-mode"> -<h2><a class="toc-backref" href="#id8">Standalone Mode</a></h2> +<h2><a class="toc-backref" href="#id7">Standalone Mode</a></h2> <p>Simply run:</p> <pre class="code console literal-block"> <span class="generic prompt">$</span> glances </pre> </div> <div class="section" id="client-server-mode"> -<h2><a class="toc-backref" href="#id9">Client/Server Mode</a></h2> +<h2><a class="toc-backref" href="#id8">Client/Server Mode</a></h2> <p>If you want to remotely monitor a machine, called <tt class="docutils literal">server</tt>, from another one, called <tt class="docutils literal">client</tt>, just run on the server:</p> <pre class="code console literal-block"> @@ -221,7 +219,7 @@ client, the latter will try to grab stats using the <tt class="docutils literal" v2/2c server.</p> </div> <div class="section" id="web-server-mode"> -<h2><a class="toc-backref" href="#id10">Web Server Mode</a></h2> +<h2><a class="toc-backref" href="#id9">Web Server Mode</a></h2> <p>If you want to remotely monitor a machine, called <tt class="docutils literal">server</tt>, from any device with a web browser, called <tt class="docutils literal">client</tt>, just run on the server:</p> <pre class="code console literal-block"> @@ -238,9 +236,9 @@ http://@server:61208 </div> </div> <div class="section" id="command-reference"> -<h1><a class="toc-backref" href="#id11">Command Reference</a></h1> +<h1><a class="toc-backref" href="#id10">Command Reference</a></h1> <div class="section" id="command-line-options"> -<h2><a class="toc-backref" href="#id12">Command-Line Options</a></h2> +<h2><a class="toc-backref" href="#id11">Command-Line Options</a></h2> <table class="docutils option-list" frame="void" rules="none"> <col class="option" /> <col class="description" /> @@ -342,7 +340,7 @@ file</td></tr> </table> </div> <div class="section" id="interactive-commands"> -<h2><a class="toc-backref" href="#id13">Interactive Commands</a></h2> +<h2><a class="toc-backref" href="#id12">Interactive Commands</a></h2> <p>The following commands (key pressed) are supported while in Glances:</p> <dl class="docutils"> <dt><tt class="docutils literal">a</tt></dt> @@ -393,7 +391,7 @@ file</td></tr> </div> </div> <div class="section" id="configuration"> -<h1><a class="toc-backref" href="#id14">Configuration</a></h1> +<h1><a class="toc-backref" href="#id13">Configuration</a></h1> <p><strong>Caution! Glances version 1.x configuration files are not compatible with the version 2.x.</strong></p> <p>No configuration file is mandatory to use Glances.</p> @@ -432,9 +430,9 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span> <tt class="docutils literal">~/Library/Application Support/glances/</tt>.</p> </div> <div class="section" id="anatomy-of-the-application"> -<h1><a class="toc-backref" href="#id15">Anatomy Of The Application</a></h1> +<h1><a class="toc-backref" href="#id14">Anatomy Of The Application</a></h1> <div class="section" id="legend"> -<h2><a class="toc-backref" href="#id16">Legend</a></h2> +<h2><a class="toc-backref" href="#id15">Legend</a></h2> <div class="line-block"> <div class="line"><tt class="docutils literal">GREEN</tt> stat counter is <tt class="docutils literal">"OK"</tt></div> <div class="line"><tt class="docutils literal">BLUE</tt> stat counter is <tt class="docutils literal">"CAREFUL"</tt></div> @@ -445,7 +443,7 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/</span> view.</p> </div> <div class="section" id="header"> -<h2><a class="toc-backref" href="#id17">Header</a></h2> +<h2><a class="toc-backref" href="#id16">Header</a></h2> <img alt="images/header.png" src="images/header.png" /> <p>The header shows the hostname, OS name, release version, platform architecture and system uptime (on the upper right corner). @@ -457,7 +455,7 @@ Additionally, on GNU/Linux, it also shows the kernel version.</p> <img alt="images/disconnected.png" src="images/disconnected.png" /> </div> <div class="section" id="cpu"> -<h2><a class="toc-backref" href="#id18">CPU</a></h2> +<h2><a class="toc-backref" href="#id17">CPU</a></h2> <p>Short view:</p> <img alt="images/cpu.png" src="images/cpu.png" /> <p>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.</p> the <tt class="docutils literal">[cpu]</tt> and/or <tt class="docutils literal">[percpu]</tt> sections.</p> </div> <div class="section" id="load"> -<h2><a class="toc-backref" href="#id19">Load</a></h2> +<h2><a class="toc-backref" href="#id18">Load</a></h2> <img alt="images/load.png" src="images/load.png" /> -<p>On the <em>No Sheep</em> blog, <em>Zachary Tirrell</em> defines the load average <a class="footnote-reference" href="#id4" id="id1">[1]</a>:</p> +<p>On the <em>No Sheep</em> blog, <em>Zachary Tirrell</em> defines the load average <a class="footnote-reference" href="#id3" id="id1">[1]</a>:</p> <blockquote> "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.</p> the <tt class="docutils literal">[load]</tt> section.</p> </div> <div class="section" id="memory"> -<h2><a class="toc-backref" href="#id20">Memory</a></h2> +<h2><a class="toc-backref" href="#id19">Memory</a></h2> <p>Glances uses two columns: one for the <tt class="docutils literal">RAM</tt> and one for the <tt class="docutils literal">SWAP</tt>.</p> <img alt="images/mem.png" src="images/mem.png" /> <p>If enough space is available, Glances displays extended information for @@ -515,7 +513,7 @@ the <tt class="docutils literal">RAM</tt>:</p> the <tt class="docutils literal">[memory]</tt> and/or <tt class="docutils literal">[memswap]</tt> sections.</p> </div> <div class="section" id="network"> -<h2><a class="toc-backref" href="#id21">Network</a></h2> +<h2><a class="toc-backref" href="#id20">Network</a></h2> <img alt="images/network.png" src="images/network.png" /> <p>Glances displays the network interface bit rate. The unit is adapted dynamically (bits per second, kbits per second, Mbits per second, etc).</p> @@ -526,7 +524,7 @@ and per-interface limit values in the <tt class="docutils literal">[network]</tt configuration file.</p> </div> <div class="section" id="disk-i-o"> -<h2><a class="toc-backref" href="#id22">Disk I/O</a></h2> +<h2><a class="toc-backref" href="#id21">Disk I/O</a></h2> <img alt="images/diskio.png" src="images/diskio.png" /> <p>Glances displays the disk I/O throughput. The unit is adapted dynamically.</p> <p>There is no alert on this information.</p> @@ -534,7 +532,7 @@ configuration file.</p> <tt class="docutils literal">[diskio]</tt> section in the configuration file.</p> </div> <div class="section" id="file-system"> -<h2><a class="toc-backref" href="#id23">File System</a></h2> +<h2><a class="toc-backref" href="#id22">File System</a></h2> <img alt="images/fs.png" src="images/fs.png" /> <p>Glances displays the used and total file system disk space. The unit is adapted dynamically.</p> @@ -549,9 +547,9 @@ adapted dynamically.</p> the <tt class="docutils literal">[filesystem]</tt> section.</p> </div> <div class="section" id="sensors"> -<h2><a class="toc-backref" href="#id24">Sensors</a></h2> +<h2><a class="toc-backref" href="#id23">Sensors</a></h2> <p>Glances can displays the sensors information using <cite>lm-sensors</cite>, -<cite>hddtemp</cite> and <cite>batinfo</cite> <a class="footnote-reference" href="#id5" id="id2">[2]</a>.</p> +<cite>hddtemp</cite> and <cite>batinfo</cite> <a class="footnote-reference" href="#id4" id="id2">[2]</a>.</p> <p>All of the above libraries are available only on Linux.</p> <p>As of lm-sensors, a filter is being applied in order to display temperature only.</p> @@ -561,7 +559,7 @@ temperature only.</p> the <tt class="docutils literal">[sensors]</tt> section.</p> </div> <div class="section" id="processes-list"> -<h2><a class="toc-backref" href="#id25">Processes List</a></h2> +<h2><a class="toc-backref" href="#id24">Processes List</a></h2> <p>Compact view:</p> <img alt="images/processlist.png" src="images/processlist.png" /> <p>Full view:</p> @@ -596,7 +594,7 @@ automatically sorted by:</p> <dt><tt class="docutils literal">MEM%</tt></dt> <dd>% of MEM used by the process</dd> <dt><tt class="docutils literal">VIRT</tt></dt> -<dd>Total program size aka Virtual Memory Size (VMS)</dd> +<dd>Total program size - Virtual Memory Size (VMS)</dd> <dt><tt class="docutils literal">RES</tt></dt> <dd>Resident Set Size (RSS)</dd> <dt><tt class="docutils literal">PID</tt></dt> @@ -629,11 +627,11 @@ automatically sorted by:</p> <dt><tt class="docutils literal">Z</tt></dt> <dd>Zombie</dd> </dl> -<p><em>Note</em>: limits values can be overwritten in the configuration file under +<p><em>Note</em>: limit values can be overwritten in the configuration file under the <tt class="docutils literal">[process]</tt> section.</p> </div> <div class="section" id="monitored-processes-list"> -<h2><a class="toc-backref" href="#id26">Monitored Processes List</a></h2> +<h2><a class="toc-backref" href="#id25">Monitored Processes List</a></h2> <p>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.</p> @@ -685,7 +683,7 @@ get the JSON representation of the monitored processes list.</p> </div> </div> <div class="section" id="logs"> -<h2><a class="toc-backref" href="#id27">Logs</a></h2> +<h2><a class="toc-backref" href="#id26">Logs</a></h2> <img alt="images/logs.png" src="images/logs.png" /> <p>A log messages list is displayed in the bottom of the screen if (and only if):</p> @@ -705,7 +703,7 @@ processes list alerts</li> </div> </div> <div class="section" id="other-outputs"> -<h1><a class="toc-backref" href="#id28">Other Outputs</a></h1> +<h1><a class="toc-backref" href="#id27">Other Outputs</a></h1> <p>It is possible to export statistics to CSV file.</p> <pre class="code console literal-block"> <span class="generic prompt">$</span> glances --output-csv /tmp/glances.csv @@ -717,56 +715,23 @@ processes list alerts</li> </ul> </div> <div class="section" id="api-documentation"> -<h1><a class="toc-backref" href="#id29">API Documentation</a></h1> +<h1><a class="toc-backref" href="#id28">API Documentation</a></h1> <p>Glances uses a <a class="reference external" href="http://docs.python.org/2/library/simplexmlrpcserver.html">XML-RPC server</a> and can be used by another client software.</p> -<p><<<<<<< HEAD -API documentation is available at <a class="reference external" href="https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To">https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To</a></p> -</div> -<div class="section" id="id3"> -<h1><a class="toc-backref" href="#id30">Other outputs</a></h1> -<p>Thanks to the -o (output) option, it is possible to export statistics to <cite>CSV</cite> or <cite>HTML</cite> files.</p> -<pre class="code console literal-block"> -<span class="generic prompt">$</span> glances -o CSV -f /tmp -</pre> -<p>The CSV output file is named <tt class="docutils literal">glances.csv</tt>.</p> -<p>CSV files have on line per stats:</p> -<ul class="simple"> -<li>load,load1,load5,load15</li> -<li>mem,total,used,free</li> -<li>swap,total,used,free</li> -<li>cpu,user,system,nice,idle,iowait,irq</li> -</ul> -<pre class="code console literal-block"> -<span class="generic prompt">$</span> glances -o HTML -f /tmp -</pre> -<p>The HTML output file is named <tt class="docutils literal">glances.html</tt>.</p> -</div> -<div class="section" id="note-the-css-and-img-folders-glances-data-should-be-in-the-tmp-folder"> -<h1><a class="toc-backref" href="#id31"><em>Note</em>: The css and img folders (glances/data) should be in the /tmp folder.</a></h1> -<div class="system-message"> -<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">./docs/glances-doc.rst</tt>, line 628)</p> -<p>Title underline too short.</p> -<pre class="literal-block"> -*Note*: The css and img folders (glances/data) should be in the /tmp folder. -======= -</pre> -</div> <p>API documentation is available at -<a class="reference external" href="https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to">https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to</a>. ->>>>>>> release/v2.0</p> +<a class="reference external" href="https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to">https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to</a>.</p> </div> <div class="section" id="support"> -<h1><a class="toc-backref" href="#id32">Support</a></h1> +<h1><a class="toc-backref" href="#id29">Support</a></h1> <p>To report a bug or a feature request use the bug tracking system at <a class="reference external" href="https://github.com/nicolargo/glances/issues">https://github.com/nicolargo/glances/issues</a>.</p> <p>Feel free to contribute!</p> -<table class="docutils footnote" frame="void" id="id4" rules="none"> +<table class="docutils footnote" frame="void" id="id3" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td><a class="reference external" href="http://nosheep.net/story/defining-unix-load-average/">http://nosheep.net/story/defining-unix-load-average/</a></td></tr> </tbody> </table> -<table class="docutils footnote" frame="void" id="id5" rules="none"> +<table class="docutils footnote" frame="void" id="id4" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td><a class="reference external" href="https://github.com/nicolargo/batinfo">https://github.com/nicolargo/batinfo</a></td></tr> |