summaryrefslogtreecommitdiffstats
path: root/index.html
blob: a7f629bf2ecaabd070bb3206e9521db5f2419685 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <title>Glances by nicolargo</title>

    <link rel="stylesheet" href="stylesheets/styles.css">
    <link rel="stylesheet" href="stylesheets/pygment_trac.css">
    <script src="javascripts/scale.fix.js"></script>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
  </head>
  <body>
    <div class="wrapper">
      <header>
        <h1 class="header">Glances</h1>
        <p class="header">An eye on your system</p>

        <ul>
          <li class="download"><a class="buttons" href="https://github.com/nicolargo/glances/zipball/master">Download ZIP</a></li>
          <li class="download"><a class="buttons" href="https://github.com/nicolargo/glances/tarball/master">Download TAR</a></li>
          <li><a class="buttons github" href="https://github.com/nicolargo/glances">View On GitHub</a></li>
        </ul>

        <p class="header">This project is maintained by <a class="header name" href="https://github.com/nicolargo">nicolargo</a></p>


      </header>
      <section>
        <p><a href="https://flattr.com/thing/484466/nicolargoglances-on-GitHub"><img src="https://api.flattr.com/button/flattr-badge-large.png"</img></a>
           <a href="https://travis-ci.org/nicolargo/glances"><img src="https://travis-ci.org/nicolargo/glances.png?branch=master"</img></a></p>

<h1>Glances - An eye on your system</h1>

<p><img src="https://raw.github.com/nicolargo/glances/master/docs/images/glances-white-256.png" width="128"</img></p>

<p><strong>Glances</strong> is a cross-platform curses-based monitoring tool written in Python.</p>

<p>It uses the <a href="https://code.google.com/p/psutil/">psutil</a> library to get information from your system.</p>

<p><img src="https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png"</img></p>

<h1>Requirements</h1>

<ul>
<li>
<code>python &gt;= 2.6</code> (tested with version 2.6, 2.7, 3.2, 3.3)</li>
<li>
<code>psutil &gt;= 0.4.1</code> (recommended version &gt;= 0.6)</li>
<li>
<code>jinja</code> (optional for HTML output)</li>
<li>
<code>pysensors</code> (optional for HW monitoring support)</li>
<li>
<code>hddtemp</code> (optional for HDD temperature monitoring support)</li>
<li><code>setuptools</code></li>
</ul><h1>Installation</h1>

<h2>OS GNU/Linux</h2>

<p>Actually, Glances is available for Arch Linux, Fedora / CentOS / RHEL,
Debian (Sid/Testing), Ubuntu (13.04+) and FreeBSD, so you should be able to
install it using your favorite package manager.</p>

<p>Glances is on <a href="https://pypi.python.org/pypi">PyPI</a>. To install, simply use <a href="http://www.pip-installer.org/">pip</a>:</p>

<pre><code>pip install Glances
</code></pre>

<p>Notes: On Debian/Ubuntu, you need to install the python-dev package.</p>

<h2>OS X</h2>

<p>OS X users can also install Glances using <a href="http://mxcl.github.com/homebrew/">Homebrew</a> or <a href="https://www.macports.org/">MacPorts</a>.</p>

<h3>Homebrew</h3>

<pre><code>$ brew install brew-pip
$ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages
$ brew pip Glances
</code></pre>

<p><strong><u>Note</u></strong></p>

<p>If you get the following error:</p>

<pre><code>Error: Failed executing: pip install glances==X.X --install-option=--prefix=/usr/local/XXX/glances/X.X (.rb:)
</code></pre>

<p>Try to run:</p>

<pre><code>$ pip install glances==X.X --install-option=--prefix=/usr/local/XXX/glances/X.X
$ brew link Glances
</code></pre>

<h3>MacPorts</h3>

<pre><code>$ sudo port install glances
</code></pre>

<h2>Windows</h2>

<p>Windows only support Glances in server mode. Glances will automatically run in server mode on it.</p>

<p>Thanks to <code>Nicolas Bourges</code>, Glances can be easily installed using a Windows installer:</p>

<ul>
<li><a href="https://s3.amazonaws.com/glances/glances-1.6.1-x86.exe">glances-1.6.1-x86.exe</a> (32-bit, md5sum: 13d5be664599f80152f8f1ae47400576)</li>
<li><a href="https://s3.amazonaws.com/glances/glances-1.6.1-x64.exe">glances-1.6.1-x64.exe</a> (64-bit, md5sum: a347ec5097d6d4d5039c7233872757a8)</li>
</ul><p>Otherwise, you have to follow these steps:</p>

<ul>
<li>Install <code>Python for Windows</code>: <a href="http://www.python.org/getit/">http://www.python.org/getit/</a>
</li>
<li>Install the <code>psutil</code> library: <a href="https://code.google.com/p/psutil/downloads/list">https://code.google.com/p/psutil/downloads/list</a>
</li>
<li>Download <code>Glances</code> from here: <a href="http://nicolargo.github.io/glances/">http://nicolargo.github.io/glances/</a>
</li>
</ul><h2>Source</h2>

<p>To install Glances from source:</p>

<pre><code>$ curl -L https://github.com/nicolargo/glances/archive/vX.X.tar.gz -o glances-X.X.tar.gz
$ tar -zxvf glances-*.tar.gz
$ cd glances-*
# python setup.py install
</code></pre>

<p><strong><u>Note</u></strong></p>

<p>On Debian/Ubuntu, you have to install first <code>build-essential</code> and <code>python-dev</code>.</p>

<h2>Puppet</h2>

<p>You can install Glances using <a href="https://puppetlabs.com/puppet/what-is-puppet/">Puppet</a>: <a href="https://github.com/rverchere/puppet-glances">https://github.com/rverchere/puppet-glances</a></p>

<h1>Usage</h1>

<p>Just run:</p>

<pre><code>$ glances
</code></pre>

<h1>Documentation</h1>

<p>For complete documentation see <a href="https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst">glances-doc</a>.</p>

<h1>Author</h1>

<p>Nicolas Hennion (<a href="https://github.com/nicolargo" class="user-mention">@nicolargo</a>) <a href="mailto:nicolas@nicolargo.com">nicolas@nicolargo.com</a></p>

<h1>License</h1>

<p>LGPL. See <code>COPYING</code> for more details.</p>

      </section>
      <footer>
        <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
      </footer>
    </div>
    <!--[if !IE]><script>fixScale(document);</script><![endif]-->
		          <script type="text/javascript">
            var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
            document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
          </script>
          <script type="text/javascript">
            try {
              var pageTracker = _gat._getTracker("UA–115490–11");
            pageTracker._trackPageview();
            } catch(err) {}
          </script>

  </body>
</html>