From 7d418b34ce00f69f2dba9cc9f6bb164363e9facd Mon Sep 17 00:00:00 2001
From: Ole Tange <ole@tange.dk>
Date: Thu, 28 Jul 2011 20:14:57 +0200
Subject: [PATCH] niceload: man example of Ensure enough disk cache

---
 src/niceload.pod | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/niceload.pod b/src/niceload.pod
index 9b300c4f..3637efa1 100644
--- a/src/niceload.pod
+++ b/src/niceload.pod
@@ -212,6 +212,21 @@ Run rsync but keep load below 3.4. If load reaches 7 sleep for
 B<niceload -L 3.4 -f 12 rsync -Ha /home/ /backup/home/>
 
 
+=head1 EXAMPLE: Ensure enough disk cache
+
+Assume the program B<foo> uses 2 GB files intensively. B<foo> will run
+fast if the files are in disk cache and be slow as a crawl if they are
+not in the cache.
+
+To ensure 2 GB are reserved for disk cache run:
+
+B<niceload --hard --run-mem 2g foo>
+
+This will not guarantee that the 2 GB memory will be used for the
+files for B<foo>, but it will stop B<foo> if the memory for disk cache
+is too low.
+
+
 =head1 ENVIRONMENT VARIABLES
 
 None. In future versions $NICELOAD will be able to contain default settings.