From 5cc61bd61e64d35f7e0053920b45a5cafea0db64 Mon Sep 17 00:00:00 2001
From: Jose A Ortega Ruiz <jao@gnu.org>
Date: Mon, 25 Jan 2010 04:28:50 +0100
Subject: Documentation for the Disk monitor

Ignore-this: 6ad4fcf176b34efc1527973f4f18e12

darcs-hash:20100125032850-748be-f392b8dddcd5c568eb4fd1e31783bab39eb29671.gz
---
 README | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 36b383b..73cc81b 100644
--- a/README
+++ b/README
@@ -348,6 +348,16 @@ Monitors have default aliases.
 	    `left`
 - Default template: `Batt: <left>`
 
+`Disk Disks Args RefreshRate`
+
+- aliases to `disk`
+- Disks: list of pairs of the form (device or mount point, template),
+  where the template can contain <total>, <read>, <write> for total,
+  read and write speed, respectively. Example:
+  `[("/", "<read> <write>"), ("sdb1", "<total>")]`
+- Args: the argument list (see below). `-t`/`--template` is ignored.
+- Default template: none (you must specify a template for each file system).
+
 `Thermal Zone Args RefreshRate`
 
 - aliases to the Zone: so `Zone "THRM" []` can be used in template as `%THRM%`
-- 
cgit v1.2.3