From bfa9089e5f2540b0762a4b3a23d6c24534045f16 Mon Sep 17 00:00:00 2001 From: Nicolas Hennion Date: Tue, 11 Mar 2014 19:04:13 +0100 Subject: version 1.7.5 --- docs/_build/doctrees/environment.pickle | Bin 16564 -> 0 bytes docs/_build/doctrees/glances-doc.doctree | Bin 128835 -> 0 bytes docs/_build/doctrees/index.doctree | Bin 7193 -> 0 bytes docs/_build/html/.buildinfo | 4 - docs/_build/html/_images/battery.png | Bin 6918 -> 0 bytes docs/_build/html/_images/client-connected.png | Bin 9176 -> 0 bytes docs/_build/html/_images/client-disconnected.png | Bin 10021 -> 0 bytes docs/_build/html/_images/cpu-wide.png | Bin 6739 -> 0 bytes docs/_build/html/_images/cpu.png | Bin 4135 -> 0 bytes docs/_build/html/_images/diskio.png | Bin 4287 -> 0 bytes docs/_build/html/_images/footer.png | Bin 2953 -> 0 bytes docs/_build/html/_images/fs.png | Bin 9768 -> 0 bytes docs/_build/html/_images/hddtemp.png | Bin 2251 -> 0 bytes docs/_build/html/_images/header.png | Bin 4162 -> 0 bytes docs/_build/html/_images/load.png | Bin 3678 -> 0 bytes docs/_build/html/_images/logs.png | Bin 11975 -> 0 bytes docs/_build/html/_images/mem-wide.png | Bin 10125 -> 0 bytes docs/_build/html/_images/mem.png | Bin 7262 -> 0 bytes docs/_build/html/_images/monitored.png | Bin 12190 -> 0 bytes docs/_build/html/_images/network.png | Bin 6192 -> 0 bytes docs/_build/html/_images/per-cpu.png | Bin 7576 -> 0 bytes docs/_build/html/_images/processlist-wide.png | Bin 92079 -> 0 bytes docs/_build/html/_images/processlist.png | Bin 47129 -> 0 bytes docs/_build/html/_images/screenshot-wide.png | Bin 95179 -> 0 bytes docs/_build/html/_images/screenshot.png | Bin 115976 -> 0 bytes docs/_build/html/_images/sensors.png | Bin 4488 -> 0 bytes docs/_build/html/_sources/glances-doc.txt | 564 -- docs/_build/html/_sources/index.txt | 28 - docs/_build/html/_static/ajax-loader.gif | Bin 673 -> 0 bytes docs/_build/html/_static/basic.css | 540 -- docs/_build/html/_static/comment-bright.png | Bin 3500 -> 0 bytes docs/_build/html/_static/comment-close.png | Bin 3578 -> 0 bytes docs/_build/html/_static/comment.png | Bin 3445 -> 0 bytes docs/_build/html/_static/default.css | 256 - docs/_build/html/_static/doctools.js | 247 - docs/_build/html/_static/down-pressed.png | Bin 368 -> 0 bytes docs/_build/html/_static/down.png | Bin 363 -> 0 bytes docs/_build/html/_static/file.png | Bin 392 -> 0 bytes docs/_build/html/_static/jquery.js | 9404 ---------------------- docs/_build/html/_static/minus.png | Bin 199 -> 0 bytes docs/_build/html/_static/plus.png | Bin 199 -> 0 bytes docs/_build/html/_static/pygments.css | 62 - docs/_build/html/_static/searchtools.js | 567 -- docs/_build/html/_static/sidebar.js | 151 - docs/_build/html/_static/underscore.js | 1226 --- docs/_build/html/_static/up-pressed.png | Bin 372 -> 0 bytes docs/_build/html/_static/up.png | Bin 363 -> 0 bytes docs/_build/html/_static/websupport.js | 808 -- docs/_build/html/genindex.html | 95 - docs/_build/html/glances-doc.html | 695 -- docs/_build/html/index.html | 147 - docs/_build/html/objects.inv | Bin 205 -> 0 bytes docs/_build/html/search.html | 101 - docs/_build/html/searchindex.js | 1 - 54 files changed, 14896 deletions(-) delete mode 100644 docs/_build/doctrees/environment.pickle delete mode 100644 docs/_build/doctrees/glances-doc.doctree delete mode 100644 docs/_build/doctrees/index.doctree delete mode 100644 docs/_build/html/.buildinfo delete mode 100644 docs/_build/html/_images/battery.png delete mode 100644 docs/_build/html/_images/client-connected.png delete mode 100644 docs/_build/html/_images/client-disconnected.png delete mode 100644 docs/_build/html/_images/cpu-wide.png delete mode 100644 docs/_build/html/_images/cpu.png delete mode 100644 docs/_build/html/_images/diskio.png delete mode 100644 docs/_build/html/_images/footer.png delete mode 100644 docs/_build/html/_images/fs.png delete mode 100644 docs/_build/html/_images/hddtemp.png delete mode 100644 docs/_build/html/_images/header.png delete mode 100644 docs/_build/html/_images/load.png delete mode 100644 docs/_build/html/_images/logs.png delete mode 100644 docs/_build/html/_images/mem-wide.png delete mode 100644 docs/_build/html/_images/mem.png delete mode 100644 docs/_build/html/_images/monitored.png delete mode 100644 docs/_build/html/_images/network.png delete mode 100644 docs/_build/html/_images/per-cpu.png delete mode 100644 docs/_build/html/_images/processlist-wide.png delete mode 100644 docs/_build/html/_images/processlist.png delete mode 100644 docs/_build/html/_images/screenshot-wide.png delete mode 100644 docs/_build/html/_images/screenshot.png delete mode 100644 docs/_build/html/_images/sensors.png delete mode 100644 docs/_build/html/_sources/glances-doc.txt delete mode 100644 docs/_build/html/_sources/index.txt delete mode 100644 docs/_build/html/_static/ajax-loader.gif delete mode 100644 docs/_build/html/_static/basic.css delete mode 100644 docs/_build/html/_static/comment-bright.png delete mode 100644 docs/_build/html/_static/comment-close.png delete mode 100644 docs/_build/html/_static/comment.png delete mode 100644 docs/_build/html/_static/default.css delete mode 100644 docs/_build/html/_static/doctools.js delete mode 100644 docs/_build/html/_static/down-pressed.png delete mode 100644 docs/_build/html/_static/down.png delete mode 100644 docs/_build/html/_static/file.png delete mode 100644 docs/_build/html/_static/jquery.js delete mode 100644 docs/_build/html/_static/minus.png delete mode 100644 docs/_build/html/_static/plus.png delete mode 100644 docs/_build/html/_static/pygments.css delete mode 100644 docs/_build/html/_static/searchtools.js delete mode 100644 docs/_build/html/_static/sidebar.js delete mode 100644 docs/_build/html/_static/underscore.js delete mode 100644 docs/_build/html/_static/up-pressed.png delete mode 100644 docs/_build/html/_static/up.png delete mode 100644 docs/_build/html/_static/websupport.js delete mode 100644 docs/_build/html/genindex.html delete mode 100644 docs/_build/html/glances-doc.html delete mode 100644 docs/_build/html/index.html delete mode 100644 docs/_build/html/objects.inv delete mode 100644 docs/_build/html/search.html delete mode 100644 docs/_build/html/searchindex.js diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 4cde094f..00000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/glances-doc.doctree b/docs/_build/doctrees/glances-doc.doctree deleted file mode 100644 index 9991876d..00000000 Binary files a/docs/_build/doctrees/glances-doc.doctree and /dev/null differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree deleted file mode 100644 index 20624f9a..00000000 Binary files a/docs/_build/doctrees/index.doctree and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo deleted file mode 100644 index 32820bba..00000000 --- a/docs/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 88f9709ac94d939db26f5322044ea5df -tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/docs/_build/html/_images/battery.png b/docs/_build/html/_images/battery.png deleted file mode 100644 index 238b7b94..00000000 Binary files a/docs/_build/html/_images/battery.png and /dev/null differ diff --git a/docs/_build/html/_images/client-connected.png b/docs/_build/html/_images/client-connected.png deleted file mode 100644 index 29dac50a..00000000 Binary files a/docs/_build/html/_images/client-connected.png and /dev/null differ diff --git a/docs/_build/html/_images/client-disconnected.png b/docs/_build/html/_images/client-disconnected.png deleted file mode 100644 index 8bce9c28..00000000 Binary files a/docs/_build/html/_images/client-disconnected.png and /dev/null differ diff --git a/docs/_build/html/_images/cpu-wide.png b/docs/_build/html/_images/cpu-wide.png deleted file mode 100644 index 9c1032a0..00000000 Binary files a/docs/_build/html/_images/cpu-wide.png and /dev/null differ diff --git a/docs/_build/html/_images/cpu.png b/docs/_build/html/_images/cpu.png deleted file mode 100644 index 1d5093d3..00000000 Binary files a/docs/_build/html/_images/cpu.png and /dev/null differ diff --git a/docs/_build/html/_images/diskio.png b/docs/_build/html/_images/diskio.png deleted file mode 100644 index 67661593..00000000 Binary files a/docs/_build/html/_images/diskio.png and /dev/null differ diff --git a/docs/_build/html/_images/footer.png b/docs/_build/html/_images/footer.png deleted file mode 100644 index 1145927d..00000000 Binary files a/docs/_build/html/_images/footer.png and /dev/null differ diff --git a/docs/_build/html/_images/fs.png b/docs/_build/html/_images/fs.png deleted file mode 100644 index ec9a7622..00000000 Binary files a/docs/_build/html/_images/fs.png and /dev/null differ diff --git a/docs/_build/html/_images/hddtemp.png b/docs/_build/html/_images/hddtemp.png deleted file mode 100644 index e238efad..00000000 Binary files a/docs/_build/html/_images/hddtemp.png and /dev/null differ diff --git a/docs/_build/html/_images/header.png b/docs/_build/html/_images/header.png deleted file mode 100644 index 5b381833..00000000 Binary files a/docs/_build/html/_images/header.png and /dev/null differ diff --git a/docs/_build/html/_images/load.png b/docs/_build/html/_images/load.png deleted file mode 100644 index 48cae129..00000000 Binary files a/docs/_build/html/_images/load.png and /dev/null differ diff --git a/docs/_build/html/_images/logs.png b/docs/_build/html/_images/logs.png deleted file mode 100644 index d51f2be8..00000000 Binary files a/docs/_build/html/_images/logs.png and /dev/null differ diff --git a/docs/_build/html/_images/mem-wide.png b/docs/_build/html/_images/mem-wide.png deleted file mode 100644 index 570c022f..00000000 Binary files a/docs/_build/html/_images/mem-wide.png and /dev/null differ diff --git a/docs/_build/html/_images/mem.png b/docs/_build/html/_images/mem.png deleted file mode 100644 index 5128c6e8..00000000 Binary files a/docs/_build/html/_images/mem.png and /dev/null differ diff --git a/docs/_build/html/_images/monitored.png b/docs/_build/html/_images/monitored.png deleted file mode 100644 index 222425c6..00000000 Binary files a/docs/_build/html/_images/monitored.png and /dev/null differ diff --git a/docs/_build/html/_images/network.png b/docs/_build/html/_images/network.png deleted file mode 100644 index 3336afd1..00000000 Binary files a/docs/_build/html/_images/network.png and /dev/null differ diff --git a/docs/_build/html/_images/per-cpu.png b/docs/_build/html/_images/per-cpu.png deleted file mode 100644 index 16601447..00000000 Binary files a/docs/_build/html/_images/per-cpu.png and /dev/null differ diff --git a/docs/_build/html/_images/processlist-wide.png b/docs/_build/html/_images/processlist-wide.png deleted file mode 100644 index aa9b2446..00000000 Binary files a/docs/_build/html/_images/processlist-wide.png and /dev/null differ diff --git a/docs/_build/html/_images/processlist.png b/docs/_build/html/_images/processlist.png deleted file mode 100644 index 460e0f8c..00000000 Binary files a/docs/_build/html/_images/processlist.png and /dev/null differ diff --git a/docs/_build/html/_images/screenshot-wide.png b/docs/_build/html/_images/screenshot-wide.png deleted file mode 100644 index 41e6ae09..00000000 Binary files a/docs/_build/html/_images/screenshot-wide.png and /dev/null differ diff --git a/docs/_build/html/_images/screenshot.png b/docs/_build/html/_images/screenshot.png deleted file mode 100644 index 1940adb8..00000000 Binary files a/docs/_build/html/_images/screenshot.png and /dev/null differ diff --git a/docs/_build/html/_images/sensors.png b/docs/_build/html/_images/sensors.png deleted file mode 100644 index 8b17c0af..00000000 Binary files a/docs/_build/html/_images/sensors.png and /dev/null differ diff --git a/docs/_build/html/_sources/glances-doc.txt b/docs/_build/html/_sources/glances-doc.txt deleted file mode 100644 index 2bf47d98..00000000 --- a/docs/_build/html/_sources/glances-doc.txt +++ /dev/null @@ -1,564 +0,0 @@ -======= -Glances -======= - -This manual describes *Glances* version 1.7.4. - -Copyright © 2012-2014 Nicolas Hennion - -January 2014 - -.. contents:: Table of Contents - -Introduction -============ - -Glances is a cross-platform curses-based 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 information. - -Glances can adapt dynamically the displayed information depending on the -terminal size. It can also work in a client/server mode for remote monitoring. - -Glances is written in Python and uses the `psutil`_ library to get information from your system. - -Console (80x24) - -.. image:: images/screenshot.png - -Full view (>80x24) - -.. image:: images/screenshot-wide.png - -Usage -===== - -Standalone mode ---------------- - -Simply run: - -.. code-block:: console - - $ glances - -Client/Server mode ------------------- - -If you want to remotely monitor a machine, called ``server``, from another one, called ``client``, -just run on the server: - -.. code-block:: console - - server$ glances -s - -and on the client: - -.. code-block:: console - - client$ glances -c @server - -where ``@server`` is the IP address or hostname of the server. - -In server mode, you can set the bind address ``-B ADDRESS`` and listening TCP port ``-p PORT``. - -In client mode, you can set the TCP port of the server ``-p PORT``. - -Default binding address is ``0.0.0.0`` (Glances will listen on all the network interfaces) and TCP port is ``61209``. - -In client/server mode, limits are set by the server side. - -You can also set a password to access to the server ``-P password``. - -Glances is ``IPv6`` compatible. Just use the ``-B ::`` option to bind to all IPv6 addresses. - -Command reference -================= - -Command-line options --------------------- - --b Display network rate in Byte per second (default: bit per second) --B IP Bind server to the given IPv4/IPv6 address or hostname --c IP Connect to a Glances server by IPv4/IPv6 address or hostname --C FILE Path to the configuration file --d Disable disk I/O module --e Enable sensors module (requires pysensors, Linux-only) --f FILE Set the HTML output folder or CSV file --h Display the help and exit --m Disable mount module --n Disable network module --o OUTPUT Define additional output (available: HTML or CSV) --p PORT Define the client/server TCP port (default: 61209) --P PASSWORD Define a client/server password ---password Define a client/server password from the prompt --r Disable process list (for low CPU consumption) --s Run Glances in server mode --t SECONDS Set refresh time in seconds (default: 3 sec) --v Display the version and exit --y Enable hddtemp module (requires hddtemp) --z Do not use the bold color attribute --1 Start Glances in per-CPU mode - -Interactive commands --------------------- - -The following commands (key pressed) are supported while in Glances: - - -``a`` - Sort process list automatically - - - If CPU iowait ``>60%``, sort processes by I/O read and write - - If CPU ``>70%``, sort processes by CPU usage - - If MEM ``>70%``, sort processes by memory usage -``b`` - Switch between bit/s or Byte/s for network I/O -``c`` - Sort processes by CPU usage -``d`` - Show/hide disk I/O stats -``f`` - Show/hide file system stats -``h`` - Show/hide the help screen -``i`` - Sort processes by I/O rate (may need root privileges on some OSes) -``l`` - Show/hide log messages -``m`` - Sort processes by MEM usage -``n`` - Show/hide network stats -``p`` - Sort processes by name -``q`` - Quit -``s`` - Show/hide sensors stats (only available with -e flag) -``t`` - View network I/O as combination -``u`` - View cumulative network I/O -``w`` - Delete finished warning log messages -``x`` - Delete finished warning and critical log messages -``y`` - Show/hide hddtemp stats (only available with -y flag) -``1`` - Switch between global CPU and per-CPU stats - -Configuration -============= - -No configuration file is mandatory to use Glances. - -Furthermore a configuration file is needed for setup limits, disks or network interfaces to hide and/or monitored processes list. - -By default, the configuration file is under: - -:Linux: ``/etc/glances/glances.conf`` -:\*BSD and OS X: ``/usr/local/etc/glances/glances.conf`` -:Windows: ``%APPDATA%\glances\glances.conf`` - -On Windows XP, the ``%APPDATA%`` path is: - -.. code-block:: console - - C:\Documents and Settings\\Application Data - -Since Windows Vista and newer versions: - -.. code-block:: console - - C:\Users\\AppData\Roaming - -You can override the default configuration, located in one of the above -directories on your system, except for Windows. - -Just copy the ``glances.conf`` file to your ``$XDG_CONFIG_HOME`` directory, e.g. Linux: - -.. code-block:: console - - mkdir -p $XDG_CONFIG_HOME/glances - cp /etc/glances/glances.conf $XDG_CONFIG_HOME/glances/ - -On OS X, you should copy the configuration file to ``~/Library/Application Support/glances/``. - -Anatomy of the application -========================== - -Legend ------- - -| ``GREEN`` stat counter is ``"OK"`` -| ``BLUE`` stat counter is ``"CAREFUL"`` -| ``MAGENTA`` stat counter is ``"WARNING"`` -| ``RED`` stat counter is ``"CRITICAL"`` - -Header ------- - -.. image:: images/header.png - -The header shows the hostname, OS name, release version, platform architecture and system uptime. -On Linux, it shows also the kernel version. - -CPU ---- - -Short view: - -.. image:: images/cpu.png - -If enough horizontal space is available, extended CPU informations are displayed. - -Extended view: - -.. image:: images/cpu-wide.png - -To switch to per-CPU stats, just hit the ``1`` key: - -.. image:: images/per-cpu.png - -The CPU stats are shown as a percentage and for the configured refresh time. -The total CPU usage is displayed on the first line. - -| If user|system|nice CPU is ``<50%``, then status is set to ``"OK"`` -| If user|system|nice CPU is ``>50%``, then status is set to ``"CAREFUL"`` -| If user|system|nice CPU is ``>70%``, then status is set to ``"WARNING"`` -| If user|system|nice CPU is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[cpu]`` section. - -Load ----- - -.. image:: images/load.png - -On the *No Sheep* blog, *Zachary Tirrell* defines the average load [1]_: - - "In short it is the average sum of the number of processes - waiting in the run-queue plus the number currently executing - over 1, 5, and 15 minute time periods." - -Glances gets the number of CPU core to adapt the alerts. -Alerts on average load are only set on 5 and 15 min. -The first line also display the number of CPU core. - -| If average load is ``<0.7*core``, then status is set to ``"OK"`` -| If average load is ``>0.7*core``, then status is set to ``"CAREFUL"`` -| If average load is ``>1*core``, then status is set to ``"WARNING"`` -| If average load is ``>5*core``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[load]`` section. - -Memory ------- - -Glances uses two columns: one for the ``RAM`` and another one for the ``Swap``. - -.. image:: images/mem.png - -If enough space is available, Glances displays extended informations: - -.. image:: images/mem-wide.png - -With Glances, alerts are only set for on used memory and used swap. - -| If memory is ``<50%``, then status is set to ``"OK"`` -| If memory is ``>50%``, then status is set to ``"CAREFUL"`` -| If memory is ``>70%``, then status is set to ``"WARNING"`` -| If memory is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under the ``[memory]`` and ``[swap]`` sections. - -Network -------- - -.. image:: 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). - -Alerts are only set if the network interface maximum speed is available. - -For example, on a 100 Mbps ethernet interface, the warning status is set -if the bit rate is higher than 70 Mbps. - -| If bit rate is ``<50%``, then status is set to ``"OK"`` -| If bit rate is ``>50%``, then status is set to ``"CAREFUL"`` -| If bit rate is ``>70%``, then status is set to ``"WARNING"`` -| If bit rate is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: In the configuration file, you can define a list of network interfaces to hide. - -Sensors -------- - -Glances can displays the sensors informations trough `lm-sensors` (only available on Linux). - -As of lm-sensors, a filter is processed in order to display temperature only: - -.. image:: images/sensors.png - - -Glances can also grab hard disk temperature through the `hddtemp` daemon (see here [2]_ to install hddtemp on your system): - -.. image:: images/hddtemp.png - -To enable the lm-sensors module: - -.. code-block:: console - - $ glances -e - -To enable the hddtemp module: - -.. code-block:: console - - $ glances -y - -There is no alert on this information. - -*Note*: limit values can be overwritten in the configuration file under the ``[temperature]`` and ``[hddtemperature]`` sections. - -Disk I/O --------- - -.. image:: images/diskio.png - -Glances displays the disk I/O throughput. The unit is adapted dynamically. - -*Note*: There is no alert on this information. - -*Note*: In the configuration file, you can define a list of disk to hide. - -File system ------------ - -.. image:: images/fs.png - -Glances displays the used and total file system disk space. The unit is -adapted dynamically. - -Alerts are set for used disk space: - -| If disk used is ``<50%``, then status is set to ``"OK"`` -| If disk used is ``>50%``, then status is set to ``"CAREFUL"`` -| If disk used is ``>70%``, then status is set to ``"WARNING"`` -| If disk used is ``>90%``, then status is set to ``"CRITICAL"`` - -*Note*: limit values can be overwritten in the configuration file under ``[filesystem]`` section. - -Processes list --------------- - -Compact view: - -.. image:: images/processlist.png - -Full view: - -.. image:: images/processlist-wide.png - -Three views are available for processes: - -* Processes summary -* Optional monitored processes list (new in 1.7) -* Processes list - -The processes summary line display: - -* Tasks number (total number of processes) -* Threads number -* Running tasks number -* Sleeping tasks number -* Other tasks number (not running or sleeping) - -By default, or if you hit the ``a`` key, the processes list is automatically -sorted by CPU of memory usage. - -*Note*: limit values can be overwritten in the configuration file under the ``[process]`` section. - -The number of processes in the list is adapted to the screen size. - -``VIRT`` - Total program size (VMS) -``RES`` - Resident set size (RSS) -``CPU%`` - % of CPU used by the process -``MEM%`` - % of MEM used by the process -``PID`` - Process ID -``USER`` - User ID per process -``NI`` - Nice level of the process -``S`` - Process status -``TIME+`` - Cumulative CPU time used -``IOR/s`` - Per process IO read rate (in Byte/s) -``IOW/s`` - Per process IO write rate (in Byte/s) -``NAME`` - Process name or command line - -Process status legend: - -``R`` - running -``S`` - sleeping (may be interrupted) -``D`` - disk sleep (may not be interrupted) -``T`` - traced/stopped -``Z`` - zombie - -Monitored processes list ------------------------- - -New in version 1.7. Optional. - -The monitored processes list allows user, through the configuration file, -to group processes and quickly show if the number of running process is not good. - -.. image:: images/monitored.png - -Each item is defined by: - -* ``description``: description of the processes (max 16 chars). -* ``regex``: regular expression of the processes to monitor. -* ``command`` (optional): full path to shell command/script for extended stat. Should return a single line string. Use with caution. -* ``countmin`` (optional): minimal number of processes. A warning will be displayed if number of processes < count. -* ``countmax`` (optional): maximum number of processes. A warning will be displayed if number of processes > count. - -Up to 10 items can be defined. - -For example, if you want to monitor the Nginx processes on a Web server, the following definition should do the job: - -.. code-block:: console - - [monitor] - list_1_description=Nginx server - list_1_regex=.*nginx.* - list_1_command=nginx -v - list_1_countmin=1 - list_1_countmax=4 - -If you also want to monitor the PHP-FPM daemon processes, you should add another item: - -.. code-block:: console - - [monitor] - list_1_description=Nginx server - list_1_regex=.*nginx.* - list_1_command=nginx -v - list_1_countmin=1 - list_1_countmax=4 - list_1_description=PHP-FPM - list_1_regex=.*php-fpm.* - list_1_countmin=1 - list_1_countmax=20 - -In client/server mode, the list is defined on the server side. -A new method, called getAllMonitored, is available in the APIs and get the JSON representation of the monitored processes list. - -Alerts are set as following: - -| If number of processes is 0, then status is set to ``"CRITICAL"`` -| If number of processes is min < current < max, then status is set to ``"OK"`` -| Else status is set to ``"WARNING"`` - -Logs ----- - -.. image:: images/logs.png - -A log messages list is displayed in the bottom of the screen if (and only if): - -- at least one ``WARNING`` or ``CRITICAL`` alert was occurred -- space is available in the bottom of the console/terminal - -Each alert message displays the following information: - -1. start date -2. end date -3. alert name -4. {min/avg/max} values or number of running processes for monitored processes list alerts - -Footer ------- - -.. image:: images/footer.png - -Glances displays the current date & time and access to the embedded help screen. - -If one or mode batteries were found on your machine and if the batinfo Python library [3]_ -is installed on your system then Glances displays the available percent capacity in the middle on the footer. - -.. image:: images/battery.png - -If you have ran Glances in client mode ``-c``, you can also see if the client is connected to the server. - -If client is connected: - -.. image:: images/client-connected.png - -else: - -.. image:: images/client-disconnected.png - -On the left, you can easily see if you are connected to a Glances server. - - -API documentation -================= - -Glances uses a `XML-RPC server`_ and can be used by another client software. - -API documentation is available at https://github.com/nicolargo/glances/wiki/The-Glances-API-How-To - -Others outputs -============== - -Thanks to the -o option, it is possible to export statistics to CSV or HTML files. - -.. code-block:: console - - $ glances -o CSV -f /tmp/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,idel,iowait,irq - -.. code-block:: console - - $ glances -o HTML -f /tmp - -Note: The css and img folders (glances/data) should be in the /tmp folder - -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/ -.. [2] http://www.cyberciti.biz/tips/howto-monitor-hard-drive-temperature.html -.. [3] https://github.com/nicolargo/batinfo - -.. _psutil: https://code.google.com/p/psutil/ -.. _XML-RPC server: http://docs.python.org/2/library/simplexmlrpcserver.html diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt deleted file mode 100644 index b03349f3..00000000 --- a/docs/_build/html/_sources/index.txt +++ /dev/null @@ -1,28 +0,0 @@ -Welcome to Glances's documentation! -=================================== - -**Glances** is a cross-platform curses-based monitoring tool written in Python. - -It uses the psutil library and some internal code to get information from your system. - -.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png - -Get the code ------------- - -The `source `_ is available on GitHub. - -Contents --------- - -.. toctree:: - :maxdepth: 2 - - glances-doc - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/_build/html/_static/ajax-loader.gif b/docs/_build/html/_static/ajax-loader.gif deleted file mode 100644 index 61faf8ca..00000000 Binary files a/docs/_build/html/_static/ajax-loader.gif and /dev/null differ diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css deleted file mode 100644 index 43e8bafa..00000000 --- a/docs/_build/html/_static/basic.css +++ /dev/null @@ -1,540 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlighted { - background-color: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: #060; -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -tt.descclassname { - background-color: transparent; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/docs/_build/html/_static/comment-bright.png b/docs/_build/html/_static/comment-bright.png deleted file mode 100644 index 551517b8..00000000 Binary files a/docs/_build/html/_static/comment-bright.png and /dev/null differ diff --git a/docs/_build/html/_static/comment-close.png b/docs/_build/html/_static/comment-close.png deleted file mode 100644 index 09b54be4..00000000 Binary files a/docs/_build/html/_static/comment-close.png and /dev/null differ diff --git a/docs/_build/html/_static/comment.png b/docs/_build/html/_static/comment.png deleted file mode 100644 index 92feb52b..00000000 Binary files a/docs/_build/html/_static/comment.png and /dev/null differ diff --git a/docs/_build/html/_static/default.css b/docs/_build/html/_static/default.css deleted file mode 100644 index 21f3f509..00000000 --- a/docs/_build/html/_static/default.css +++ /dev/null @@ -1,256 +0,0 @@ -/* - * default.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- default theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: #11303d; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - background-color: #1c4e63; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 230px; -} - -div.body { - background-color: #ffffff; - color: #000000; - padding: 0 20px 30px 20px; -} - -div.footer { - color: #ffffff; - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: #ffffff; - text-decoration: underline; -} - -div.related { - background-color: #133f52; - line-height: 30px; - color: #ffffff; -} - -div.related a { - color: #ffffff; -} - -div.sphinxsidebar { -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: #ffffff; -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: #ffffff; - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: #ffffff; -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: #ffffff; -} - -div.sphinxsidebar a { - color: #98dbcc; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - - - -/* -- hyperlink styles ------------------------------------------------------ */ - -a { - color: #355f7c; - text-decoration: none; -} - -a:visited { - color: #355f7c; - text-decoration: none; -} - -a:hover { - text-decoration: underline; -} - - - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: 'Trebuchet MS', sans-serif; - background-color: #f2f2f2; - font-weight: normal; - color: #20435c; - border-bottom: 1px solid #ccc; - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { margin-top: 0; font-size: 200%; } -div.body h2 { font-size: 160%; } -div.body h3 { font-size: 140%; } -div.body h4 { font-size: 120%; } -div.body h5 { font-size: 110%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #c60f0f; - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: #c60f0f; - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -div.warning { - background-color: #ffe4e4; - border: 1px solid #f66; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - padding: 5px; - background-color: #eeffcc; - color: #333333; - line-height: 120%; - border: 1px solid #ac9; - border-left: none; - border-right: none; -} - -tt { - background-color: #ecf0f3; - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th { - background-color: #ede; -} - -.warning tt { - background: #efc2c2; -} - -.note tt { - background: #d6d6d6; -} - -.viewcode-back { - font-family: sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; -} \ No newline at end of file diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js deleted file mode 100644 index d4619fdf..00000000 --- a/docs/_build/html/_static/doctools.js +++ /dev/null @@ -1,247 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -} - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * small function to check if an array contains - * a given item. - */ -jQuery.contains = function(arr, item) { - for (var i = 0; i < arr.length; i++) { - if (arr[i] == item) - return true; - } - return false; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span = document.createElement("span"); - span.className = className; - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this); - }); - } - } - return this.each(function() { - highlight(this); - }); -}; - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated == 'undefined') - return string; - return (typeof translated == 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/docs/_build/html/_static/down-pressed.png b/docs/_build/html/_static/down-pressed.png deleted file mode 100644 index 6f7ad782..00000000 Binary files a/docs/_build/html/_static/down-pressed.png and /dev/null differ diff --git a/docs/_build/html/_static/down.png b/docs/_build/html/_static/down.png deleted file mode 100644 index 3003a887..00000000 Binary files a/docs/_build/html/_static/down.png and /dev/null differ diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png deleted file mode 100644 index d18082e3..00000000 Binary files a/docs/_build/html/_static/file.png and /dev/null differ diff --git a/docs/_build/html/_static/jquery.js b/docs/_build/html/_static/jquery.js deleted file mode 100644 index e2efc335..00000000 --- a/docs/_build/html/_static/jquery.js +++ /dev/null @@ -1,9404 +0,0 @@ -/*! - * jQuery JavaScript Library v1.7.2 - * http://jquery.com/ - * - * Copyright 2011, John Resig - * Dual licensed under the MIT or GPL Version 2 licenses. - * http://jquery.org/license - * - * Includes Sizzle.js - * http://sizzlejs.com/ - * Copyright 2011, The Dojo Foundation - * Released under the MIT, BSD, and GPL Licenses. - * - * Date: Fri Jul 5 14:07:58 UTC 2013 - */ -(function( window, undefined ) { - -// Use the correct document accordingly with window argument (sandbox) -var document = window.document, - navigator = window.navigator, - location = window.location; -var jQuery = (function() { - -// Define a local copy of jQuery -var jQuery = function( selector, context ) { - // The jQuery object is actually just the init constructor 'enhanced' - return new jQuery.fn.init( selector, context, rootjQuery ); - }, - - // Map over jQuery in case of overwrite - _jQuery = window.jQuery, - - // Map over the $ in case of overwrite - _$ = window.$, - - // A central reference to the root jQuery(document) - rootjQuery, - - // A simple way to check for HTML strings or ID strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - quickExpr = /^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/, - - // Check if a string has a non-whitespace character in it - rnotwhite = /\S/, - - // Used for trimming whitespace - trimLeft = /^\s+/, - trimRight = /\s+$/, - - // Match a standalone tag - rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>)?$/, - - // JSON RegExp - rvalidchars = /^[\],:{}\s]*$/, - rvalidescape = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, - rvalidtokens = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, - rvalidbraces = /(?:^|:|,)(?:\s*\[)+/g, - - // Useragent RegExp - rwebkit = /(webkit)[ \/]([\w.]+)/, - ropera = /(opera)(?:.*version)?[ \/]([\w.]+)/, - rmsie = /(msie) ([\w.]+)/, - rmozilla = /(mozilla)(?:.*? rv:([\w.]+))?/, - - // Matches dashed string for camelizing - rdashAlpha = /-([a-z]|[0-9])/ig, - rmsPrefix = /^-ms-/, - - // Used by jQuery.camelCase as callback to replace() - fcamelCase = function( all, letter ) { - return ( letter + "" ).toUpperCase(); - }, - - // Keep a UserAgent string for use with jQuery.browser - userAgent = navigator.userAgent, - - // For matching the engine and version of the browser - browserMatch, - - // The deferred used on DOM ready - readyList, - - // The ready event handler - DOMContentLoaded, - - // Save a reference to some core methods - toString = Object.prototype.toString, - hasOwn = Object.prototype.hasOwnProperty, - push = Array.prototype.push, - slice = Array.prototype.slice, - trim = String.prototype.trim, - indexOf = Array.prototype.indexOf, - - // [[Class]] -> type pairs - class2type = {}; - -jQuery.fn = jQuery.prototype = { - constructor: jQuery, - init: function( selector, context, rootjQuery ) { - var match, elem, ret, doc; - - // Handle $(""), $(null), or $(undefined) - if ( !selector ) { - return this; - } - - // Handle $(DOMElement) - if ( selector.nodeType ) { - this.context = this[0] = selector; - this.length = 1; - return this; - } - - // The body element only exists once, optimize finding it - if ( selector === "body" && !context && document.body ) { - this.context = document; - this[0] = document.body; - this.selector = selector; - this.length = 1; - return this; - } - - // Handle HTML strings - if ( typeof selector === "string" ) { - // Are we dealing with HTML string or an ID? - if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = quickExpr.exec( selector ); - } - - // Verify a match, and that no context was specified for #id - if ( match && (match[1] || !context) ) { - - // HANDLE: $(html) -> $(array) - if ( match[1] ) { - context = context instanceof jQuery ? context[0] : context; - doc = ( context ? context.ownerDocument || context : document ); - - // If a single string is passed in and it's a single tag - // just do a createElement and skip the rest - ret = rsingleTag.exec( selector ); - - if ( ret ) { - if ( jQuery.isPlainObject( context ) ) { - selector = [ document.createElement( ret[1] ) ]; - jQuery.fn.attr.call( selector, context, true ); - - } else { - selector = [ doc.createElement( ret[1] ) ]; - } - - } else { - ret = jQuery.buildFragment( [ match[1] ], [ doc ] ); - selector = ( ret.cacheable ? jQuery.clone(ret.fragment) : ret.fragment ).childNodes; - } - - return jQuery.merge( this, selector ); - - // HANDLE: $("#id") - } else { - elem = document.getElementById( match[2] ); - - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document #6963 - if ( elem && elem.parentNode ) { - // Handle the case where IE and Opera return items - // by name instead of ID - if ( elem.id !== match[2] ) { - return rootjQuery.find( selector ); - } - - // Otherwise, we inject the element directly into the jQuery object - this.length = 1; - this[0] = elem; - } - - this.context = document; - this.selector = selector; - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || rootjQuery ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( jQuery.isFunction( selector ) ) { - return rootjQuery.ready( selector ); - } - - if ( selector.selector !== undefined ) { - this.selector = selector.selector; - this.context = selector.context; - } - - return jQuery.makeArray( selector, this ); - }, - - // Start with an empty selector - selector: "", - - // The current version of jQuery being used - jquery: "1.7.2", - - // The default length of a jQuery object is 0 - length: 0, - - // The number of elements contained in the matched element set - size: function() { - return this.length; - }, - - toArray: function() { - return slice.call( this, 0 ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - return num == null ? - - // Return a 'clean' array - this.toArray() : - - // Return just the object - ( num < 0 ? this[ this.length + num ] : this[ num ] ); - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems, name, selector ) { - // Build a new jQuery matched element set - var ret = this.constructor(); - - if ( jQuery.isArray( elems ) ) { - push.apply( ret, elems ); - - } else { - jQuery.merge( ret, elems ); - } - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - - ret.context = this.context; - - if ( name === "find" ) { - ret.selector = this.selector + ( this.selector ? " " : "" ) + selector; - } else if ( name ) { - ret.selector = this.selector + "." + name + "(" + selector + ")"; - } - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - // (You can seed the arguments with an array of args, but this is - // only used internally.) - each: function( callback, args ) { - return jQuery.each( this, callback, args ); - }, - - ready: function( fn ) { - // Attach the listeners - jQuery.bindReady(); - - // Add the callback - readyList.add( fn ); - - return this; - }, - - eq: function( i ) { - i = +i; - return i === -1 ? - this.slice( i ) : - this.slice( i, i + 1 ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ), - "slice", slice.call(arguments).join(",") ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map(this, function( elem, i ) { - return callback.call( elem, i, elem ); - })); - }, - - end: function() { - return this.prevObject || this.constructor(null); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: [].sort, - splice: [].splice -}; - -// Give the init function the jQuery prototype for later instantiation -jQuery.fn.init.prototype = jQuery.fn; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[0] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - target = arguments[1] || {}; - // skip the boolean and the target - i = 2; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !jQuery.isFunction(target) ) { - target = {}; - } - - // extend jQuery itself if only one argument is passed - if ( length === i ) { - target = this; - --i; - } - - for ( ; i < length; i++ ) { - // Only deal with non-null/undefined values - if ( (options = arguments[ i ]) != null ) { - // Extend the base object - for ( name in options ) { - src = target[ name ]; - copy = options[ name ]; - - // Prevent never-ending loop - if ( target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { - if ( copyIsArray ) { - copyIsArray = false; - clone = src && jQuery.isArray(src) ? src : []; - - } else { - clone = src && jQuery.isPlainObject(src) ? src : {}; - } - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend({ - noConflict: function( deep ) { - if ( window.$ === jQuery ) { - window.$ = _$; - } - - if ( deep && window.jQuery === jQuery ) { - window.jQuery = _jQuery; - } - - return jQuery; - }, - - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Hold (or release) the ready event - holdReady: function( hold ) { - if ( hold ) { - jQuery.readyWait++; - } else { - jQuery.ready( true ); - } - }, - - // Handle when the DOM is ready - ready: function( wait ) { - // Either a released hold or an DOMready/load event and not yet ready - if ( (wait === true && !--jQuery.readyWait) || (wait !== true && !jQuery.isReady) ) { - // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). - if ( !document.body ) { - return setTimeout( jQuery.ready, 1 ); - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.fireWith( document, [ jQuery ] ); - - // Trigger any bound ready events - if ( jQuery.fn.trigger ) { - jQuery( document ).trigger( "ready" ).off( "ready" ); - } - } - }, - - bindReady: function() { - if ( readyList ) { - return; - } - - readyList = jQuery.Callbacks( "once memory" ); - - // Catch cases where $(document).ready() is called after the - // browser event has already occurred. - if ( document.readyState === "complete" ) { - // Handle it asynchronously to allow scripts the opportunity to delay ready - return setTimeout( jQuery.ready, 1 ); - } - - // Mozilla, Opera and webkit nightlies currently support this event - if ( document.addEventListener ) { - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false ); - - // A fallback to window.onload, that will al