From c1e1ad4da5d95b50c1426f7cba879e73d3dc12a8 Mon Sep 17 00:00:00 2001
From: Alessio Sergi <al3hex@gmail.com>
Date: Wed, 2 Mar 2016 13:29:19 +0100
Subject: Use Sphinx for doc

---
 docs/aoa/fs.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 docs/aoa/fs.rst

(limited to 'docs/aoa/fs.rst')

diff --git a/docs/aoa/fs.rst b/docs/aoa/fs.rst
new file mode 100644
index 00000000..1f8bc566
--- /dev/null
+++ b/docs/aoa/fs.rst
@@ -0,0 +1,55 @@
+.. _fs:
+
+File System
+===========
+
+.. image:: ../_static/fs.png
+
+Glances displays the used and total file system disk space. The unit is
+adapted dynamically.
+
+Alerts are set for used disk space.
+
+Legend:
+
+=========== ============
+Disk usage  Status
+=========== ============
+``<50%``    ``OK``
+``>50%``    ``CAREFUL``
+``>70%``    ``WARNING``
+``>90%``    ``CRITICAL``
+=========== ============
+
+.. note::
+    Limit values can be overwritten in the configuration file under
+    the ``[filesystem]`` section.
+
+By default, the plugin only displays physical devices (hard disks, USB
+keys). To allow other file system types, you have to enable them in the
+configuration file. For example, if you want to allow the ``zfs`` file
+system:
+
+.. code-block:: ini
+
+    [fs]
+    allow=zfs
+
+Also, you can hide mount points as well (in the following ``/boot``):
+
+.. code-block:: ini
+
+     [fs]
+     hide=/boot.*
+
+RAID
+----
+
+*Availability: Linux*
+
+Thanks to the `pymdstat`_ library, if a ``RAID`` controller is detected
+on you system, its status will be displayed as well:
+
+.. image:: ../_static/raid.png
+
+.. _pymdstat: https://github.com/nicolargo/pymdstat
-- 
cgit v1.2.3